zapier-platform-core 17.7.2 → 17.8.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zapier-platform-core",
-  "version": "17.7.2",
+  "version": "17.8.0",
   "description": "The core SDK for CLI apps in the Zapier Developer Platform.",
   "repository": "zapier/zapier-platform",
   "homepage": "https://platform.zapier.com/",
@@ -63,7 +63,7 @@
     "node-fetch": "2.7.0",
     "oauth-sign": "0.9.0",
     "semver": "7.7.1",
-    "zapier-platform-schema": "17.7.2"
+    "zapier-platform-schema": "17.8.0"
   },
   "devDependencies": {
     "@types/node-fetch": "^2.6.11",

package/src/checks/search-is-array-or-envelope.js

@@ -33,10 +33,11 @@ const searchIsArrayOrEnvelope = {
         }
         if (
           !_.isString(results.paging_token) &&
-          !_.isNull(results.paging_token)
+          !_.isNull(results.paging_token) &&
+          !_.isUndefined(results.paging_token)
         ) {
           return [
-            `"paging_token" must be a string or null, got: ${typeof results.paging_token}`,
+            `"paging_token" must be a string or null or undefined, got: ${typeof results.paging_token}`,
           ];
         }
         // pass to array check below

package/types/functions.d.ts

@@ -171,7 +171,7 @@ export type CreatePerformGet<
  *
  * When `canPaginate` is true for the search, the object shape is required.
  */
-type SearchResult<T> = T[] | { results: T[]; paging_token: string };
+type SearchResult<T> = T[] | { results: T[]; paging_token: string | null | undefined };
 
 /**
  * Search for objects on a partner API.

package/types/functions.test-d.ts

@@ -1,5 +1,5 @@
 import { expectAssignable, expectType } from 'tsd';
-import type { PollingTriggerPerform } from './functions';
+import type { PollingTriggerPerform, SearchPerform } from './functions';
 import { Bundle, ZObject } from './custom';
 import { InferInputData } from './inputs';
 import { defineInputFields } from './typeHelpers';
@@ -62,3 +62,73 @@ expectType<
     bundle: Bundle<{ key1: string; key2?: number | undefined }>,
   ) => Promise<{ id: string; name: string }[]>
 >(simplePerformWithInputFieldsAndAutomaticInference);
+
+//
+// SearchResult<T> and SearchPerform tests
+//
+
+// Test SearchResult<T> with simple array return
+const simpleSearchPerform = (async (z, bundle) => {
+  return [{ id: '1', name: 'test' }];
+}) satisfies SearchPerform;
+
+expectAssignable<SearchPerform<{}, { id: string; name: string }>>(
+  simpleSearchPerform,
+);
+
+// Test SearchResult<T> with paginated object return
+const paginatedSearchPerform = (async (z, bundle) => {
+  return {
+    results: [{ id: '1', name: 'test' }],
+    paging_token: 'next-page-token',
+  };
+}) satisfies SearchPerform;
+
+expectAssignable<SearchPerform<{}, { id: string; name: string }>>(
+  paginatedSearchPerform,
+);
+
+// Test SearchResult<T> with null paging_token
+const nullPagingTokenSearchPerform = (async (z, bundle) => {
+  return {
+    results: [{ id: '1', name: 'test' }],
+    paging_token: null,
+  };
+}) satisfies SearchPerform;
+
+expectAssignable<SearchPerform<{}, { id: string; name: string }>>(
+  nullPagingTokenSearchPerform,
+);
+
+// Test SearchResult<T> with undefined paging_token
+const undefinedPagingTokenSearchPerform = (async (z, bundle) => {
+  return {
+    results: [{ id: '1', name: 'test' }],
+    paging_token: undefined,
+  };
+}) satisfies SearchPerform;
+
+expectAssignable<SearchPerform<{}, { id: string; name: string }>>(
+  undefinedPagingTokenSearchPerform,
+);
+
+// Test SearchResult<T> with empty results array
+const emptyResultsSearchPerform = (async (z, bundle) => {
+  return {
+    results: [],
+    paging_token: 'next-page-token',
+  };
+}) satisfies SearchPerform;
+
+expectAssignable<SearchPerform<{}, { id: string; name: string }>>(
+  emptyResultsSearchPerform,
+);
+
+// Test SearchResult<T> with empty array return
+const emptyArraySearchPerform = (async (z, bundle) => {
+  return [];
+}) satisfies SearchPerform;
+
+expectAssignable<SearchPerform<{}, { id: string; name: string }>>(
+  emptyArraySearchPerform,
+);