Allow paginating customer / gift card searches

Author: paulomarg

.changeset/gentle-doors-complain.md

@@ -0,0 +1,5 @@
+---
+"@shopify/shopify-api": patch
+---
+
+Enabled returning the full response object in `Customer.search()` and `GiftCard.search()`, so that apps can paginate through the results.

.eslintignore

@@ -3,3 +3,4 @@ rollup.config.cjs
 .eslintrc.cjs
 node_modules/
 dist/
+packages/shopify-api/rest/admin

.prettierignore

@@ -0,0 +1 @@
+packages/shopify-api/rest/admin

packages/shopify-api/rest/admin/2022-10/customer.ts

@@ -6,6 +6,7 @@ import {Base, FindAllResponse} from '../../base';
 import {ResourcePath, ResourceNames} from '../../types';
 import {Session} from '../../../lib/session/session';
 import {ApiVersion} from '../../../lib/types';
+import {logger} from '../../../lib/logger';
 
 import {Metafield} from './metafield';
 
@@ -51,6 +52,7 @@ interface SearchArgs {
   query?: unknown;
   limit?: unknown;
   fields?: unknown;
+  returnObject?: boolean;
 }
 interface AccountActivationUrlArgs {
   [key: string]: unknown;
@@ -193,9 +195,17 @@ export class Customer extends Base {
       query = null,
       limit = null,
       fields = null,
+      returnObject = false,
       ...otherArgs
-    }: SearchArgs
+    }: SearchArgs,
   ): Promise<unknown> {
+    if (!returnObject) {
+      logger(this.config).deprecated(
+        '10.0.0',
+        'The search() method will start returning the full response, similar to all(). Pass in returnObject: true to get the full response before the next major release.',
+      );
+    }
+
     const response = await this.request<Customer>({
       http_method: "get",
       operation: "search",
@@ -206,7 +216,7 @@ export class Customer extends Base {
       entity: null,
     });
 
-    return response ? response.body : null;
+    return returnObject ? response : response?.body;
   }
 
   public async account_activation_url(

packages/shopify-api/rest/admin/2022-10/gift_card.ts

@@ -6,6 +6,7 @@ import {Base, FindAllResponse} from '../../base';
 import {ResourcePath, ResourceNames} from '../../types';
 import {Session} from '../../../lib/session/session';
 import {ApiVersion} from '../../../lib/types';
+import {logger} from '../../../lib/logger';
 
 interface FindArgs {
   session: Session;
@@ -35,6 +36,7 @@ interface SearchArgs {
   created_at_max?: unknown;
   updated_at_min?: unknown;
   updated_at_max?: unknown;
+  returnObject?: boolean;
 }
 interface DisableArgs {
   [key: string]: unknown;
@@ -126,9 +128,17 @@ export class GiftCard extends Base {
       created_at_max = null,
       updated_at_min = null,
       updated_at_max = null,
+      returnObject = false,
       ...otherArgs
     }: SearchArgs
   ): Promise<unknown> {
+    if (!returnObject) {
+      logger(this.config).deprecated(
+        '10.0.0',
+        'The search() method will start returning the full response, similar to all(). Pass in returnObject: true to get the full response before the next major release.',
+      );
+    }
+
     const response = await this.request<GiftCard>({
       http_method: "get",
       operation: "search",
@@ -139,7 +149,7 @@ export class GiftCard extends Base {
       entity: null,
     });
 
-    return response ? response.body : null;
+    return returnObject ? response : response?.body;
   }
 
   public async disable(

packages/shopify-api/rest/admin/2023-01/customer.ts

@@ -6,6 +6,7 @@ import {Base, FindAllResponse} from '../../base';
 import {ResourcePath, ResourceNames} from '../../types';
 import {Session} from '../../../lib/session/session';
 import {ApiVersion} from '../../../lib/types';
+import {logger} from '../../../lib/logger';
 
 import {Metafield} from './metafield';
 
@@ -51,6 +52,7 @@ interface SearchArgs {
   query?: unknown;
   limit?: unknown;
   fields?: unknown;
+  returnObject?: boolean;
 }
 interface AccountActivationUrlArgs {
   [key: string]: unknown;
@@ -193,9 +195,17 @@ export class Customer extends Base {
       query = null,
       limit = null,
       fields = null,
+      returnObject = false,
       ...otherArgs
     }: SearchArgs
   ): Promise<unknown> {
+    if (!returnObject) {
+      logger(this.config).deprecated(
+        '10.0.0',
+        'The search() method will start returning the full response, similar to all(). Pass in returnObject: true to get the full response before the next major release.',
+      );
+    }
+
     const response = await this.request<Customer>({
       http_method: "get",
       operation: "search",
@@ -206,7 +216,7 @@ export class Customer extends Base {
       entity: null,
     });
 
-    return response ? response.body : null;
+    return returnObject ? response : response?.body;
   }
 
   public async account_activation_url(

packages/shopify-api/rest/admin/2023-01/gift_card.ts

@@ -6,6 +6,7 @@ import {Base, FindAllResponse} from '../../base';
 import {ResourcePath, ResourceNames} from '../../types';
 import {Session} from '../../../lib/session/session';
 import {ApiVersion} from '../../../lib/types';
+import {logger} from '../../../lib/logger';
 
 interface FindArgs {
   session: Session;
@@ -35,6 +36,7 @@ interface SearchArgs {
   created_at_max?: unknown;
   updated_at_min?: unknown;
   updated_at_max?: unknown;
+  returnObject?: boolean;
 }
 interface DisableArgs {
   [key: string]: unknown;
@@ -126,9 +128,17 @@ export class GiftCard extends Base {
       created_at_max = null,
       updated_at_min = null,
       updated_at_max = null,
+      returnObject = false,
       ...otherArgs
     }: SearchArgs
   ): Promise<unknown> {
+    if (!returnObject) {
+      logger(this.config).deprecated(
+        '10.0.0',
+        'The search() method will start returning the full response, similar to all(). Pass in returnObject: true to get the full response before the next major release.',
+      );
+    }
+
     const response = await this.request<GiftCard>({
       http_method: "get",
       operation: "search",
@@ -139,7 +149,7 @@ export class GiftCard extends Base {
       entity: null,
     });
 
-    return response ? response.body : null;
+    return returnObject ? response : response?.body;
   }
 
   public async disable(

packages/shopify-api/rest/admin/2023-04/customer.ts

@@ -6,6 +6,7 @@ import {Base, FindAllResponse} from '../../base';
 import {ResourcePath, ResourceNames} from '../../types';
 import {Session} from '../../../lib/session/session';
 import {ApiVersion} from '../../../lib/types';
+import {logger} from '../../../lib/logger';
 
 import {Metafield} from './metafield';
 
@@ -51,6 +52,7 @@ interface SearchArgs {
   query?: unknown;
   limit?: unknown;
   fields?: unknown;
+  returnObject?: boolean;
 }
 interface AccountActivationUrlArgs {
   [key: string]: unknown;
@@ -193,9 +195,17 @@ export class Customer extends Base {
       query = null,
       limit = null,
       fields = null,
+      returnObject = false,
       ...otherArgs
     }: SearchArgs
   ): Promise<unknown> {
+    if (!returnObject) {
+      logger(this.config).deprecated(
+        '10.0.0',
+        'The search() method will start returning the full response, similar to all(). Pass in returnObject: true to get the full response before the next major release.',
+      );
+    }
+
     const response = await this.request<Customer>({
       http_method: "get",
       operation: "search",
@@ -206,7 +216,7 @@ export class Customer extends Base {
       entity: null,
     });
 
-    return response ? response.body : null;
+    return returnObject ? response : response?.body;
   }
 
   public async account_activation_url(

packages/shopify-api/rest/admin/2023-04/gift_card.ts

@@ -6,6 +6,7 @@ import {Base, FindAllResponse} from '../../base';
 import {ResourcePath, ResourceNames} from '../../types';
 import {Session} from '../../../lib/session/session';
 import {ApiVersion} from '../../../lib/types';
+import {logger} from '../../../lib/logger';
 
 interface FindArgs {
   session: Session;
@@ -35,6 +36,7 @@ interface SearchArgs {
   created_at_max?: unknown;
   updated_at_min?: unknown;
   updated_at_max?: unknown;
+  returnObject?: boolean;
 }
 interface DisableArgs {
   [key: string]: unknown;
@@ -126,9 +128,17 @@ export class GiftCard extends Base {
       created_at_max = null,
       updated_at_min = null,
       updated_at_max = null,
+      returnObject = false,
       ...otherArgs
     }: SearchArgs
   ): Promise<unknown> {
+    if (!returnObject) {
+      logger(this.config).deprecated(
+        '10.0.0',
+        'The search() method will start returning the full response, similar to all(). Pass in returnObject: true to get the full response before the next major release.',
+      );
+    }
+
     const response = await this.request<GiftCard>({
       http_method: "get",
       operation: "search",
@@ -139,7 +149,7 @@ export class GiftCard extends Base {
       entity: null,
     });
 
-    return response ? response.body : null;
+    return returnObject ? response : response?.body;
   }
 
   public async disable(

packages/shopify-api/rest/admin/2023-07/customer.ts

@@ -6,6 +6,7 @@ import {Base, FindAllResponse} from '../../base';
 import {ResourcePath, ResourceNames} from '../../types';
 import {Session} from '../../../lib/session/session';
 import {ApiVersion} from '../../../lib/types';
+import {logger} from '../../../lib/logger';
 
 import {Metafield} from './metafield';
 
@@ -51,6 +52,7 @@ interface SearchArgs {
   query?: unknown;
   limit?: unknown;
   fields?: unknown;
+  returnObject?: boolean;
 }
 interface AccountActivationUrlArgs {
   [key: string]: unknown;
@@ -193,9 +195,17 @@ export class Customer extends Base {
       query = null,
       limit = null,
       fields = null,
+      returnObject = false,
       ...otherArgs
     }: SearchArgs
   ): Promise<unknown> {
+    if (!returnObject) {
+      logger(this.config).deprecated(
+        '10.0.0',
+        'The search() method will start returning the full response, similar to all(). Pass in returnObject: true to get the full response before the next major release.',
+      );
+    }
+
     const response = await this.request<Customer>({
       http_method: "get",
       operation: "search",
@@ -206,7 +216,7 @@ export class Customer extends Base {
       entity: null,
     });
 
-    return response ? response.body : null;
+    return returnObject ? response : response?.body;
   }
 
   public async account_activation_url(

packages/shopify-api/rest/admin/2023-07/gift_card.ts

@@ -6,6 +6,7 @@ import {Base, FindAllResponse} from '../../base';
 import {ResourcePath, ResourceNames} from '../../types';
 import {Session} from '../../../lib/session/session';
 import {ApiVersion} from '../../../lib/types';
+import {logger} from '../../../lib/logger';
 
 interface FindArgs {
   session: Session;
@@ -35,6 +36,7 @@ interface SearchArgs {
   created_at_max?: unknown;
   updated_at_min?: unknown;
   updated_at_max?: unknown;
+  returnObject?: boolean;
 }
 interface DisableArgs {
   [key: string]: unknown;
@@ -126,9 +128,17 @@ export class GiftCard extends Base {
       created_at_max = null,
       updated_at_min = null,
       updated_at_max = null,
+      returnObject = false,
       ...otherArgs
     }: SearchArgs
   ): Promise<unknown> {
+    if (!returnObject) {
+      logger(this.config).deprecated(
+        '10.0.0',
+        'The search() method will start returning the full response, similar to all(). Pass in returnObject: true to get the full response before the next major release.',
+      );
+    }
+
     const response = await this.request<GiftCard>({
       http_method: "get",
       operation: "search",
@@ -139,7 +149,7 @@ export class GiftCard extends Base {
       entity: null,
     });
 
-    return response ? response.body : null;
+    return returnObject ? response : response?.body;
   }
 
   public async disable(