🐛 type errors when defining filters

Pretty odd bug. If filters is defined and the list doesn't take a type parameter, then filter defines the return type. 

Fixed this by creating an overload - one with type parameters and one without

Author: Crhistian Ramirez

.eslintrc.js

@@ -28,6 +28,9 @@ module.exports = {
         "@typescript-eslint/member-delimiter-style": "off",
         "@typescript-eslint/type-annotation-spacing": "off",
 
+        // we need in order to define overloads
+        'no-dupe-class-members': 'off',
+
         // kind of noisy and low value
         "@typescript-eslint/explicit-function-return-type": "off",
         "@typescript-eslint/no-use-before-define": "off",

codegen/hooks.ts

@@ -125,6 +125,7 @@ function findTypeForOperationProps(prop: Param, operation: Operation) {
     // we're updating the behavior of filters so that we get better type inference
     // instead of accepting dot-referenced xp values such as { 'xp.color': 'red' }
     // we will now expect { xp: { color: 'red' } }
+    prop['isFilter'] = true
     prop.description =
       'An object whose keys match the model, and the values are the values to filter by'
     return `Filters<Required<T${operation.returnType}>>`

codegen/templates/api/_RESOURCE_.ts.hbs

@@ -30,7 +30,9 @@ class {{resource.id}} {
     * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation).
     * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
     */
-    public async {{name}}{{#if hasReturnType}}{{#if isList}}<T{{returnType}} extends {{returnType}}>{{else}}<T{{returnType}} extends {{returnType}}>{{/if}}{{/if}}({{#allParams}}{{#unless isQueryParam}}{{#if isBodyParam}}{{#if ../isPatch}}{{name}}: PartialDeep<{{typescriptType}}>, {{else}}{{name}}: {{typescriptType}},{{/if}}{{else}}{{name}}: {{typescriptType}}, {{/if}}{{/unless}}{{/allParams}} {{#if hasQueryParams}}listOptions: { {{#queryParams}}{{name}}?: {{typescriptType}}{{#unless @last}}, {{/unless}}{{/queryParams}} } = {}, {{/if}}requestOptions: RequestOptions = {} ): Promise<{{#if hasReturnType}}RequiredDeep<{{#if isList}}{{#if isFacetList}}ListPageWithFacets<T{{returnType}}>{{else}}ListPage<T{{returnType}}>{{/if}}{{else}}T{{returnType}}{{/if}}>{{else}}void{{/if}}> {
+    public async {{name}}({{#allParams}}{{#unless isQueryParam}}{{#if isBodyParam}}{{#if ../isPatch}}{{name}}: PartialDeep<{{typescriptType}}>, {{else}}{{name}}: {{typescriptType}},{{/if}}{{else}}{{name}}: {{typescriptType}}, {{/if}}{{/unless}}{{/allParams}}{{#if hasQueryParams}}listOptions?: { {{#queryParams}}{{#unless isFilter}}{{name}}?: {{typescriptType}}{{/unless}}{{#if isFilter}}filters?: Filters<Required<{{../returnType}}>>{{/if}}{{#unless @last}}, {{/unless}}{{/queryParams}} }, {{/if}}requestOptions?: RequestOptions ): Promise<{{#if hasReturnType}}RequiredDeep<{{#if isList}}{{#if isFacetList}}ListPageWithFacets<{{returnType}}>{{else}}ListPage<{{returnType}}>{{/if}}{{else}}{{returnType}}{{/if}}>{{else}}void{{/if}}>;
+    public async {{name}}{{#if hasReturnType}}{{#if isList}}<T{{returnType}} extends {{returnType}}>{{else}}<T{{returnType}} extends {{returnType}}>{{/if}}{{/if}}({{#allParams}}{{#unless isQueryParam}}{{#if isBodyParam}}{{#if ../isPatch}}{{name}}: PartialDeep<{{typescriptType}}>, {{else}}{{name}}: {{typescriptType}},{{/if}}{{else}}{{name}}: {{typescriptType}}, {{/if}}{{/unless}}{{/allParams}}{{#if hasQueryParams}}listOptions?: { {{#queryParams}}{{#unless isFilter}}{{name}}?: {{typescriptType}}{{/unless}}{{#if isFilter}}filters?: Filters<Required<T{{../returnType}}>>{{/if}}{{#unless @last}}, {{/unless}}{{/queryParams}} }, {{/if}}requestOptions?: RequestOptions ): Promise<{{#if hasReturnType}}RequiredDeep<{{#if isList}}{{#if isFacetList}}ListPageWithFacets<T{{returnType}}>{{else}}ListPage<T{{returnType}}>{{/if}}{{else}}T{{returnType}}{{/if}}>{{else}}void{{/if}}>;
+    public async {{name}}{{#if hasReturnType}}{{#if isList}}<T{{returnType}} extends {{returnType}}>{{else}}<T{{returnType}} extends {{returnType}}>{{/if}}{{/if}}({{#allParams}}{{#unless isQueryParam}}{{#if isBodyParam}}{{#if ../isPatch}}{{name}}: PartialDeep<{{typescriptType}}>, {{else}}{{name}}: {{typescriptType}},{{/if}}{{else}}{{name}}: {{typescriptType}}, {{/if}}{{/unless}}{{/allParams}}{{#if hasQueryParams}}listOptions: { {{#queryParams}}{{#unless isFilter}}{{name}}?: {{typescriptType}}{{/unless}}{{#if isFilter}}filters?: Filters<Required<T{{../returnType}}>>{{/if}}{{#unless @last}}, {{/unless}}{{/queryParams}} } = {}, {{/if}}requestOptions: RequestOptions = {} ): Promise<{{#if hasReturnType}}RequiredDeep<{{#if isList}}{{#if isFacetList}}ListPageWithFacets<T{{returnType}}>{{else}}ListPage<T{{returnType}}>{{/if}}{{else}}T{{returnType}}{{/if}}>{{else}}void{{/if}}>{
         const impersonating = this.impersonating;
         this.impersonating = false;
         return await http.{{verb}}(`{{parameterizePath path}}`, { ...requestOptions, {{#if hasBodyParam}}data: {{bodyParam.name}}, {{/if}}impersonating, params: { {{#if hasQueryParams}}...listOptions, {{/if}} {{#if hasFilters}}filters: listOptions.filters, {{/if}} } } )