@seamapi/react 4.10.0 → 4.11.0

package/lib/seam/index.d.ts

@@ -12,6 +12,7 @@ export * from './devices/use-device-providers.js';
 export * from './devices/use-devices.js';
 export * from './SeamProvider.js';
 export * from './use-seam-client.js';
+export * from './use-seam-infinite-query.js';
 export * from './use-seam-mutation.js';
 export * from './use-seam-mutation-without-workspace.js';
 export * from './use-seam-query.js';

package/lib/seam/index.js

@@ -12,6 +12,7 @@ export * from './devices/use-device-providers.js';
 export * from './devices/use-devices.js';
 export * from './SeamProvider.js';
 export * from './use-seam-client.js';
+export * from './use-seam-infinite-query.js';
 export * from './use-seam-mutation.js';
 export * from './use-seam-mutation-without-workspace.js';
 export * from './use-seam-query.js';

package/lib/seam/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/lib/seam/index.ts"],"names":[],"mappings":"AAAA,cAAc,mCAAmC,CAAA;AACjD,cAAc,oCAAoC,CAAA;AAClD,cAAc,0CAA0C,CAAA;AACxD,cAAc,0CAA0C,CAAA;AACxD,cAAc,iDAAiD,CAAA;AAC/D,cAAc,0CAA0C,CAAA;AACxD,cAAc,yCAAyC,CAAA;AACvD,cAAc,kDAAkD,CAAA;AAChE,cAAc,+CAA+C,CAAA;AAC7D,cAAc,yBAAyB,CAAA;AACvC,cAAc,mCAAmC,CAAA;AACjD,cAAc,0BAA0B,CAAA;AACxC,cAAc,mBAAmB,CAAA;AACjC,cAAc,sBAAsB,CAAA;AACpC,cAAc,wBAAwB,CAAA;AACtC,cAAc,0CAA0C,CAAA;AACxD,cAAc,qBAAqB,CAAA;AACnC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,uCAAuC,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/lib/seam/index.ts"],"names":[],"mappings":"AAAA,cAAc,mCAAmC,CAAA;AACjD,cAAc,oCAAoC,CAAA;AAClD,cAAc,0CAA0C,CAAA;AACxD,cAAc,0CAA0C,CAAA;AACxD,cAAc,iDAAiD,CAAA;AAC/D,cAAc,0CAA0C,CAAA;AACxD,cAAc,yCAAyC,CAAA;AACvD,cAAc,kDAAkD,CAAA;AAChE,cAAc,+CAA+C,CAAA;AAC7D,cAAc,yBAAyB,CAAA;AACvC,cAAc,mCAAmC,CAAA;AACjD,cAAc,0BAA0B,CAAA;AACxC,cAAc,mBAAmB,CAAA;AACjC,cAAc,sBAAsB,CAAA;AACpC,cAAc,8BAA8B,CAAA;AAC5C,cAAc,wBAAwB,CAAA;AACtC,cAAc,0CAA0C,CAAA;AACxD,cAAc,qBAAqB,CAAA;AACnC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,uCAAuC,CAAA"}

package/lib/seam/use-seam-infinite-query.d.ts

@@ -0,0 +1,11 @@
+import type { SeamHttpApiError, SeamHttpEndpointPaginatedQueryPaths, SeamHttpEndpoints, SeamPageCursor } from '@seamapi/http/connect';
+import { type UseInfiniteQueryOptions, type UseInfiniteQueryResult } from '@tanstack/react-query';
+export type UseSeamInfiniteQueryParameters<T extends SeamHttpEndpointPaginatedQueryPaths> = Parameters<SeamHttpEndpoints[T]>[0];
+export type UseSeamInfiniteQueryResult<T extends SeamHttpEndpointPaginatedQueryPaths> = UseInfiniteQueryResult<QueryData<T>, SeamHttpApiError>;
+export declare function useSeamInfiniteQuery<T extends SeamHttpEndpointPaginatedQueryPaths>(endpointPath: T, parameters?: UseSeamInfiniteQueryParameters<T>, options?: Parameters<SeamHttpEndpoints[T]>[1] & QueryOptions<QueryData<T>, SeamHttpApiError>): UseSeamInfiniteQueryResult<T>;
+interface QueryData<T extends SeamHttpEndpointPaginatedQueryPaths> {
+    data: Awaited<ReturnType<SeamHttpEndpoints[T]>>;
+    nextPageCursor: SeamPageCursor | null;
+}
+type QueryOptions<X, Y> = Omit<UseInfiniteQueryOptions<X, Y>, 'queryKey' | 'queryFn' | 'initialPageParam' | 'getNextPageParam'>;
+export {};

package/lib/seam/use-seam-infinite-query.js

@@ -0,0 +1,42 @@
+import { useInfiniteQuery, } from '@tanstack/react-query';
+import { useSeamClient } from '../../lib/seam/use-seam-client.js';
+export function useSeamInfiniteQuery(endpointPath, parameters, options = {}) {
+    const { endpointClient: client, queryKeyPrefixes } = useSeamClient();
+    return useInfiniteQuery({
+        enabled: client != null,
+        ...options,
+        queryKey: [
+            ...queryKeyPrefixes,
+            ...endpointPath.split('/').filter((v) => v !== ''),
+            parameters,
+        ],
+        initialPageParam: null,
+        getNextPageParam: (lastPage) => lastPage.nextPageCursor,
+        queryFn: async ({ pageParam }) => {
+            if (client == null)
+                return {
+                    data: [],
+                    nextPageCursor: null,
+                };
+            // Using @ts-expect-error over any is preferred, but not possible here because TypeScript will run out of memory.
+            // Type assertion is needed here for performance reasons. The types are correct at runtime.
+            const endpoint = client[endpointPath];
+            const request = endpoint(parameters, options);
+            const pages = client.createPaginator(request);
+            if (pageParam == null) {
+                const [data, { nextPageCursor }] = await pages.firstPage();
+                return {
+                    data: data,
+                    nextPageCursor,
+                };
+            }
+            // Type assertion is needed for pageParam since the Seam API expects a branded PageCursor type.
+            const [data, { nextPageCursor }] = await pages.nextPage(pageParam);
+            return {
+                data: data,
+                nextPageCursor,
+            };
+        },
+    });
+}
+//# sourceMappingURL=use-seam-infinite-query.js.map

package/lib/seam/use-seam-infinite-query.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-seam-infinite-query.js","sourceRoot":"","sources":["../../src/lib/seam/use-seam-infinite-query.ts"],"names":[],"mappings":"AAOA,OAAO,EACL,gBAAgB,GAGjB,MAAM,uBAAuB,CAAA;AAE9B,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAA;AAU3D,MAAM,UAAU,oBAAoB,CAGlC,YAAe,EACf,UAA8C,EAC9C,UACiD,EAAE;IAEnD,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,gBAAgB,EAAE,GAAG,aAAa,EAAE,CAAA;IACpE,OAAO,gBAAgB,CAAC;QACtB,OAAO,EAAE,MAAM,IAAI,IAAI;QACvB,GAAG,OAAO;QACV,QAAQ,EAAE;YACR,GAAG,gBAAgB;YACnB,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC;YAClD,UAAU;SACX;QACD,gBAAgB,EAAE,IAAI;QACtB,gBAAgB,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,cAAc;QACvD,OAAO,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;YAC/B,IAAI,MAAM,IAAI,IAAI;gBAChB,OAAO;oBACL,IAAI,EAAE,EAA+C;oBACrD,cAAc,EAAE,IAAI;iBACrB,CAAA;YACH,iHAAiH;YACjH,2FAA2F;YAC3F,MAAM,QAAQ,GAAG,MAAM,CAAC,YAAY,CAA0B,CAAA;YAC9D,MAAM,OAAO,GAAG,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC,CAAA;YAC7C,MAAM,KAAK,GAAG,MAAM,CAAC,eAAe,CAAC,OAAoC,CAAC,CAAA;YAC1E,IAAI,SAAS,IAAI,IAAI,EAAE,CAAC;gBACtB,MAAM,CAAC,IAAI,EAAE,EAAE,cAAc,EAAE,CAAC,GAAG,MAAM,KAAK,CAAC,SAAS,EAAE,CAAA;gBAC1D,OAAO;oBACL,IAAI,EAAE,IAAiD;oBACvD,cAAc;iBACf,CAAA;YACH,CAAC;YACD,+FAA+F;YAC/F,MAAM,CAAC,IAAI,EAAE,EAAE,cAAc,EAAE,CAAC,GAAG,MAAM,KAAK,CAAC,QAAQ,CACrD,SAA2B,CAC5B,CAAA;YACD,OAAO;gBACL,IAAI,EAAE,IAAiD;gBACvD,cAAc;aACf,CAAA;QACH,CAAC;KACF,CAAC,CAAA;AACJ,CAAC"}

package/lib/seam/use-seam-mutation-without-workspace.d.ts

@@ -2,7 +2,7 @@ import type { SeamHttpApiError, SeamHttpEndpointsWithoutWorkspace, SeamHttpEndpo
 import { type UseMutationOptions, type UseMutationResult } from '@tanstack/react-query';
 export type UseSeamMutationWithoutWorkspaceVariables<T extends SeamHttpEndpointWithoutWorkspaceMutationPaths> = Parameters<SeamHttpEndpointsWithoutWorkspace[T]>[0];
 export type UseSeamMutationWithoutWorkspaceResult<T extends SeamHttpEndpointWithoutWorkspaceMutationPaths> = UseMutationResult<MutationData<T>, SeamHttpApiError, UseSeamMutationWithoutWorkspaceVariables<T>>;
-export declare function UseSeamMutationWithoutWorkspace<T extends SeamHttpEndpointWithoutWorkspaceMutationPaths>(endpointPath: T, options?: Parameters<SeamHttpEndpointsWithoutWorkspace[T]>[1] & MutationOptions<MutationData<T>, SeamHttpApiError, UseSeamMutationWithoutWorkspaceVariables<T>>): UseSeamMutationWithoutWorkspaceResult<T>;
+export declare function useSeamMutationWithoutWorkspace<T extends SeamHttpEndpointWithoutWorkspaceMutationPaths>(endpointPath: T, options?: Parameters<SeamHttpEndpointsWithoutWorkspace[T]>[1] & MutationOptions<MutationData<T>, SeamHttpApiError, UseSeamMutationWithoutWorkspaceVariables<T>>): UseSeamMutationWithoutWorkspaceResult<T>;
 type MutationData<T extends SeamHttpEndpointWithoutWorkspaceMutationPaths> = Awaited<ReturnType<SeamHttpEndpointsWithoutWorkspace[T]>>;
 type MutationOptions<X, Y, Z> = Omit<UseMutationOptions<X, Y, Z>, 'mutationFn'>;
 export {};

package/lib/seam/use-seam-mutation-without-workspace.js

@@ -1,6 +1,6 @@
 import { useMutation, } from '@tanstack/react-query';
 import { NullSeamClientError, useSeamClient } from '../../lib/seam/use-seam-client.js';
-export function UseSeamMutationWithoutWorkspace(endpointPath, options = {}) {
+export function useSeamMutationWithoutWorkspace(endpointPath, options = {}) {
     const { endpointClient: client } = useSeamClient();
     return useMutation({
         ...options,

package/lib/version.d.ts

@@ -1,2 +1,2 @@
-declare const seamapiReactVersion = "4.10.0";
+declare const seamapiReactVersion = "4.11.0";
 export default seamapiReactVersion;

package/lib/version.js

@@ -1,3 +1,3 @@
-const seamapiReactVersion = '4.10.0';
+const seamapiReactVersion = '4.11.0';
 export default seamapiReactVersion;
 //# sourceMappingURL=version.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/react",
-  "version": "4.10.0",
+  "version": "4.11.0",
   "description": "Seam Components.",
   "type": "module",
   "main": "index.js",
@@ -145,7 +145,7 @@
     "@rxfork/r2wc-react-to-web-component": "^2.4.0",
     "@seamapi/fake-devicedb": "^1.6.1",
     "@seamapi/fake-seam-connect": "^1.76.0",
-    "@seamapi/http": "^1.40.0",
+    "@seamapi/http": "^1.40.1",
     "@seamapi/types": "^1.395.3",
     "@storybook/addon-designs": "^7.0.1",
     "@storybook/addon-essentials": "^7.0.2",

package/src/lib/seam/index.ts

@@ -12,6 +12,7 @@ export * from './devices/use-device-providers.js'
 export * from './devices/use-devices.js'
 export * from './SeamProvider.js'
 export * from './use-seam-client.js'
+export * from './use-seam-infinite-query.js'
 export * from './use-seam-mutation.js'
 export * from './use-seam-mutation-without-workspace.js'
 export * from './use-seam-query.js'

package/src/lib/seam/use-seam-infinite-query.ts

@@ -0,0 +1,81 @@
+import type {
+  SeamHttpApiError,
+  SeamHttpEndpointPaginatedQueryPaths,
+  SeamHttpEndpoints,
+  SeamHttpRequest,
+  SeamPageCursor,
+} from '@seamapi/http/connect'
+import {
+  useInfiniteQuery,
+  type UseInfiniteQueryOptions,
+  type UseInfiniteQueryResult,
+} from '@tanstack/react-query'
+
+import { useSeamClient } from 'lib/seam/use-seam-client.js'
+
+export type UseSeamInfiniteQueryParameters<
+  T extends SeamHttpEndpointPaginatedQueryPaths,
+> = Parameters<SeamHttpEndpoints[T]>[0]
+
+export type UseSeamInfiniteQueryResult<
+  T extends SeamHttpEndpointPaginatedQueryPaths,
+> = UseInfiniteQueryResult<QueryData<T>, SeamHttpApiError>
+
+export function useSeamInfiniteQuery<
+  T extends SeamHttpEndpointPaginatedQueryPaths,
+>(
+  endpointPath: T,
+  parameters?: UseSeamInfiniteQueryParameters<T>,
+  options: Parameters<SeamHttpEndpoints[T]>[1] &
+    QueryOptions<QueryData<T>, SeamHttpApiError> = {}
+): UseSeamInfiniteQueryResult<T> {
+  const { endpointClient: client, queryKeyPrefixes } = useSeamClient()
+  return useInfiniteQuery({
+    enabled: client != null,
+    ...options,
+    queryKey: [
+      ...queryKeyPrefixes,
+      ...endpointPath.split('/').filter((v) => v !== ''),
+      parameters,
+    ],
+    initialPageParam: null,
+    getNextPageParam: (lastPage) => lastPage.nextPageCursor,
+    queryFn: async ({ pageParam }) => {
+      if (client == null)
+        return {
+          data: [] as Awaited<ReturnType<SeamHttpEndpoints[T]>>,
+          nextPageCursor: null,
+        }
+      // Using @ts-expect-error over any is preferred, but not possible here because TypeScript will run out of memory.
+      // Type assertion is needed here for performance reasons. The types are correct at runtime.
+      const endpoint = client[endpointPath] as (...args: any) => any
+      const request = endpoint(parameters, options)
+      const pages = client.createPaginator(request as SeamHttpRequest<any, any>)
+      if (pageParam == null) {
+        const [data, { nextPageCursor }] = await pages.firstPage()
+        return {
+          data: data as Awaited<ReturnType<SeamHttpEndpoints[T]>>,
+          nextPageCursor,
+        }
+      }
+      // Type assertion is needed for pageParam since the Seam API expects a branded PageCursor type.
+      const [data, { nextPageCursor }] = await pages.nextPage(
+        pageParam as SeamPageCursor
+      )
+      return {
+        data: data as Awaited<ReturnType<SeamHttpEndpoints[T]>>,
+        nextPageCursor,
+      }
+    },
+  })
+}
+
+interface QueryData<T extends SeamHttpEndpointPaginatedQueryPaths> {
+  data: Awaited<ReturnType<SeamHttpEndpoints[T]>>
+  nextPageCursor: SeamPageCursor | null
+}
+
+type QueryOptions<X, Y> = Omit<
+  UseInfiniteQueryOptions<X, Y>,
+  'queryKey' | 'queryFn' | 'initialPageParam' | 'getNextPageParam'
+>

package/src/lib/seam/use-seam-mutation-without-workspace.ts

@@ -23,7 +23,7 @@ export type UseSeamMutationWithoutWorkspaceResult<
   UseSeamMutationWithoutWorkspaceVariables<T>
 >
 
-export function UseSeamMutationWithoutWorkspace<
+export function useSeamMutationWithoutWorkspace<
   T extends SeamHttpEndpointWithoutWorkspaceMutationPaths,
 >(
   endpointPath: T,

package/src/lib/version.ts

@@ -1,3 +1,3 @@
-const seamapiReactVersion = '4.10.0'
+const seamapiReactVersion = '4.11.0'
 
 export default seamapiReactVersion