💥 revert filters to work how they did previously

Found out that the filter types weren't being enforced unless inlined. Essentially rendering the feature useless.

This is because object literals undergo a special treatement called "excess property checks", if a property that doesn't exist is added it throws an error. This is what we want, but only happens if you inline your object.

Author: Crhistian Ramirez

README.md

@@ -118,14 +118,14 @@ Let's run through a couple scenarios and what the call will look like with the S
 My products where `xp.Featured` is `true`
 
 ```javascript
-Me.ListProducts({ filters: { xp: { Featured: true } } })
+Me.ListProducts({ filters: { 'xp.Featued': true } })
   .then(productList => console.log(productList));
 ```
 
 My orders submitted after April 20th, 2018
 
 ```javascript
-Me.ListOrders({ filters: { DateSubmitted: '>2019-04-20' } })
+Me.ListOrders({ filters: { DateSubmitted: '>2020-04-20' } })
   .then(orderList => console.log(orderList))
 ```
 
@@ -146,7 +146,7 @@ Users.List('my-mock-buyerid', { filters: { LastName: 'Smith*|*Jones' } })
 Products where xp.Color is not red *and* not blue
 
 ```javascript
-Products.List({ filters: { xp: { Color: ['!red', '!blue'] } } })
+Products.List({ filters: { 'xp.Color': ['!red', '!blue'] } })
     .then(productList => console.log(productList));
 ```
 

codegen/hooks.ts

@@ -38,11 +38,12 @@ const postFormatOperation: PostFormatOperationHook = function(operation) {
   })
 
   if (operation.isList) {
-    // add ListPage and ListPageWithFacets to fileImports
+    // add list models to file imports
     operation.fileImports = [
       operation.isFacetList ? 'ListPageWithFacets' : 'ListPage',
       'Searchable',
       'Sortable',
+      'Filters',
       ...operation.fileImports,
     ]
   }
@@ -120,13 +121,7 @@ function findTypeForOperationProps(prop: Param, operation: Operation) {
   }
 
   if (prop.name === 'filters') {
-    // 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}>>`
+    return `Filters`
   }
 
   if (prop.isEnum && !prop.isCustomType) {

codegen/templates/api/_RESOURCE_.ts.hbs

@@ -3,7 +3,6 @@ import { {{this}} } from '../models/{{this}}';
 {{/resource.fileImports}}
 import { PartialDeep } from '../models/PartialDeep';
 import { RequiredDeep } from '../models/RequiredDeep';
-import { Filters } from '../models/Filters';
 import { RequestOptions } from '../models/RequestOptions';
 import http from '../utils/HttpClient';
 import OrderCloudError from '../utils/OrderCloudError';
@@ -31,12 +30,10 @@ class {{resource.id}} {
     * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
     * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs.
     */
-    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}}>{
+    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}}>{
         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}} } } )
+        return await http.{{verb}}(`{{parameterizePath path}}`, { ...requestOptions, {{#if hasBodyParam}}data: {{bodyParam.name}}, {{/if}}impersonating, {{#if hasQueryParams}}params: listOptions {{/if}} } )
         .catch(ex => {
             if(ex.response) {
                 throw new OrderCloudError(ex)

codegen/templates/models/Filters.ts

@@ -4,19 +4,13 @@
  * ex: an order list call with { xp: { hasPaid: '!*' } } would return a list of orders where xp.hasPaid is null or undefined
  * https://ordercloud.io/features/advanced-querying#filtering
  */
-type FilterProp = string | string[] | boolean | undefined
-type Primitive = string | boolean | number
+type FilterProp = string | string[] | number | boolean | undefined
 
 /**
  * Used on list calls to filter a list of items
  * https://ordercloud.io/features/advanced-querying#filtering
  */
-export type Filters<T> = T extends object
-  ? FiltersObj<T>
-  : T extends Primitive
-  ? FilterProp
-  : any
 
-type FiltersObj<T extends object> = {
-  -readonly [prop in keyof T]?: Filters<T[prop]>
+export type Filters = {
+  [key: string]: FilterProp
 }