@osdk/react 0.9.0-beta.8 → 0.9.0-rc.11

package/build/cjs/public/experimental.d.cts

@@ -3,7 +3,7 @@ import { ObservableClient, ActionSignatureFromDef, QueryParameterType, QueryRetu
 import React from 'react';
 import { User, ListUsersResponse } from '@osdk/foundry.admin';
 import { UserStatus } from '@osdk/foundry.core';
-import { ObjectOrInterfaceDefinition, LinkNames, LinkedType, ObjectTypeDefinition, SimplePropertyDef, ObjectSet, WhereClause as WhereClause$1, DerivedProperty, PropertyKeys as PropertyKeys$1, Osdk as Osdk$1, InterfaceDefinition, AggregateOpts, AggregationsResults, QueryDefinition, CompileTimeMetadata, PrimaryKeyType } from '@osdk/api';
+import { ObjectOrInterfaceDefinition, LinkNames, LinkedType, ObjectTypeDefinition, SimplePropertyDef, ObjectSet, WhereClause as WhereClause$1, DerivedProperty, PropertyKeys as PropertyKeys$1, Osdk as Osdk$1, AggregateOpts, AggregationsResults, QueryDefinition, CompileTimeMetadata, PrimaryKeyType } from '@osdk/api';
 export { U as UseOsdkMetadataResult, u as useOsdkClient, a as useOsdkMetadata } from '../useOsdkMetadata-DFZhnhGZ.cjs';
 
 interface OsdkProviderOptions {
@@ -294,6 +294,10 @@ interface UseObjectSetResult<Q extends ObjectTypeDefinition, RDPs extends Record
      * The final ObjectSet after all transformations
      */
     objectSet: ObjectSet<Q, RDPs>;
+    /**
+     * The total count of objects matching the query (if available from the API)
+     */
+    totalCount?: string;
 }
 /**
  * React hook for observing and interacting with OSDK object sets.
@@ -332,20 +336,18 @@ interface UseOsdkActionResult<Q extends ActionDefinition<any>> {
 }
 declare function useOsdkAction<Q extends ActionDefinition<any>>(actionDef: Q): UseOsdkActionResult<Q>;
 
-type InferRdpTypes<Q extends ObjectTypeDefinition | InterfaceDefinition, WP extends DerivedProperty.Clause<Q> | undefined> = WP extends DerivedProperty.Clause<Q> ? {
-    [K in keyof WP]: WP[K] extends DerivedProperty.Creator<Q, infer T> ? T : never;
-} : {};
-
-interface UseOsdkAggregationOptions<T extends ObjectOrInterfaceDefinition, A extends AggregateOpts<T>, WithProps extends DerivedProperty.Clause<T> | undefined = undefined> {
+interface UseOsdkAggregationOptions<T extends ObjectOrInterfaceDefinition, A extends AggregateOpts<T>, RDPs extends Record<string, SimplePropertyDef> = {}> {
     /**
      * Standard OSDK Where clause to filter objects before aggregation
      */
-    where?: WhereClause$1<T, InferRdpTypes<T, WithProps>>;
+    where?: WhereClause$1<T, RDPs>;
     /**
      * Define derived properties (RDPs) to be computed server-side.
      * The derived properties can be used in the where clause and aggregation groupBy/select.
      */
-    withProperties?: WithProps;
+    withProperties?: {
+        [K in keyof RDPs]: DerivedProperty.Creator<T, RDPs[K]>;
+    };
     /**
      * Aggregation options including groupBy and select
      */
@@ -388,7 +390,7 @@ interface UseOsdkAggregationResult<T extends ObjectOrInterfaceDefinition, A exte
  * });
  * ```
  */
-declare function useOsdkAggregation<Q extends ObjectOrInterfaceDefinition, const A extends AggregateOpts<Q>, WP extends DerivedProperty.Clause<Q> | undefined = undefined>(type: Q, { where, withProperties, aggregate, dedupeIntervalMs, }: UseOsdkAggregationOptions<Q, A, WP>): UseOsdkAggregationResult<Q, A>;
+declare function useOsdkAggregation<Q extends ObjectOrInterfaceDefinition, const A extends AggregateOpts<Q>, RDPs extends Record<string, SimplePropertyDef> = {}>(type: Q, { where, withProperties, aggregate, dedupeIntervalMs, }: UseOsdkAggregationOptions<Q, A, RDPs>): UseOsdkAggregationResult<Q, A>;
 
 interface UseOsdkFunctionOptions<Q extends QueryDefinition<unknown>> {
     /**
@@ -525,31 +527,70 @@ declare function useOsdkObject<Q extends ObjectTypeDefinition>(obj: Osdk$1.Insta
  */
 declare function useOsdkObject<Q extends ObjectTypeDefinition>(type: Q, primaryKey: PrimaryKeyType<Q>, enabled?: boolean): UseOsdkObjectResult<Q>;
 
-interface UseOsdkObjectsOptions<T extends ObjectOrInterfaceDefinition, WithProps extends DerivedProperty.Clause<T> | undefined = undefined> {
+interface UseOsdkObjectsOptions<T extends ObjectOrInterfaceDefinition, RDPs extends Record<string, SimplePropertyDef> = {}> {
     /**
-     * Standard OSDK Where with RDP support
+     * Fetch objects by their RIDs (Resource Identifiers).
+     * When provided, starts with a static objectset containing these RIDs.
+     * Can be combined with `where` to filter the RID set, and with `orderBy` to sort results.
+     *
+     * @example
+     * // Fetch specific objects by RID
+     * useOsdkObjects(Employee, { rids: ['ri.foo.123', 'ri.foo.456'] })
+     *
+     * @example
+     * // Fetch specific objects by RID, filtered by status
+     * useOsdkObjects(Employee, {
+     *   rids: ['ri.foo.123', 'ri.foo.456', 'ri.foo.789'],
+     *   where: { status: 'active' }
+     * })
      */
-    where?: WhereClause$1<T, InferRdpTypes<T, WithProps>>;
+    rids?: readonly string[];
     /**
-     *  The preferred page size for the list.
+     * Standard OSDK Where clause with RDP support.
+     * When used with `rids`, filters the RID set.
+     * When used alone, filters all objects of the type.
+     */
+    where?: WhereClause$1<T, RDPs>;
+    /**
+     * Sort results by one or more properties.
      */
-    pageSize?: number;
-    /** */
     orderBy?: {
         [K in PropertyKeys$1<T>]?: "asc" | "desc";
     };
+    /**
+     * The preferred page size for the list.
+     */
+    pageSize?: number;
     /**
      * Define derived properties (RDPs) to be computed server-side and attached to each object.
      * These properties will be available on the returned objects alongside their regular properties.
      */
-    withProperties?: WithProps;
+    withProperties?: {
+        [K in keyof RDPs]: DerivedProperty.Creator<T, RDPs[K]>;
+    };
+    /**
+     * The number of milliseconds to wait after the last observed list change.
+     *
+     * Two uses of `useOsdkObjects` with the same parameters will only trigger one
+     * network request if the second is within `dedupeIntervalMs`.
+     */
+    dedupeIntervalMs?: number;
+    /**
+     * Enable or disable the query.
+     *
+     * When `false`, the query will not automatically execute. It will still
+     * return any cached data, but will not fetch from the server.
+     *
+     * @default true
+     */
+    enabled?: boolean;
     /**
      * Intersect the results with additional object sets.
      * Each element defines a where clause for an object set to intersect with.
      * The final result will only include objects that match ALL conditions.
      */
     intersectWith?: Array<{
-        where: WhereClause$1<T, InferRdpTypes<T, WithProps>>;
+        where: WhereClause$1<T, RDPs>;
     }>;
     /**
      * Pivot to related objects through a link.
@@ -564,76 +605,26 @@ interface UseOsdkObjectsOptions<T extends ObjectOrInterfaceDefinition, WithProps
      * - `true`: Fetch all available pages automatically
      * - `number`: Fetch pages until at least this many items are loaded
      * - `undefined` (default): Only fetch the first page, user must call fetchMore()
-     *
-     * Note: When using `autoFetchMore: true` with large datasets, the initial
-     * load may take significant time. Consider using a specific number instead
-     * or implementing virtual scrolling.
-     *
-     * @example
-     * // Fetch all todos at once
-     * const { data } = useOsdkObjects(Todo, { autoFetchMore: true })
-     *
-     * @example
-     * // Fetch at least 100 todos (with 25 per page, fetches 4 pages)
-     * const { data } = useOsdkObjects(Todo, {
-     *   autoFetchMore: 100,
-     *   pageSize: 25
-     * })
      */
     autoFetchMore?: boolean | number;
+    streamUpdates?: boolean;
+}
+interface UseOsdkListResult<T extends ObjectOrInterfaceDefinition, RDPs extends Record<string, SimplePropertyDef> = {}> {
     /**
-     * Upon a list being revalidated, this option determines how the component
-     * will be re-rendered with the data.
-     *
-     * An example to help understand the options:
-     *
-     * Suppose pageSize is 10 and we have called `fetchMore()` twice. The list is
-     * now 30 items long.
-     *
-     * Upon revalidation, we get the first 10 items of the list. The options behave
-     * as follows:
-     *
-     * - `"in-place"`: The first 10 items of the list are replaced with the new 10
-     *   items. The list is now 30 items long, but only the first 10 items are valid.
-     * - `"wait"`: The old list is returned until after the next 20 items are loaded
-     *   (which will happen automatically). The list is now 30 items long.
-     * - `"reset"`: The entire list is replaced with the new 10 items. The list is
-     *   now 10 items long.
+     * Function to fetch more pages (undefined if no more pages)
      */
+    fetchMore: (() => Promise<void>) | undefined;
     /**
-     * The number of milliseconds to wait after the last observed list change.
-     *
-     * Two uses of `useOsdkObjects` with the where clause will only trigger one
-     * network request if the second is within `dedupeIntervalMs`.
+     * The fetched data with derived properties
      */
-    dedupeIntervalMs?: number;
-    streamUpdates?: boolean;
+    data: Osdk$1.Instance<T, "$allBaseProperties", PropertyKeys$1<T>, RDPs>[] | undefined;
     /**
-     * Enable or disable the query.
-     *
-     * When `false`, the query will not automatically execute. It will still
-     * return any cached data, but will not fetch from the server.
-     *
-     * This is useful for:
-     * - Lazy/on-demand queries that should wait for user interaction
-     * - Dependent queries that need data from another query first
-     * - Conditional queries based on component state
-     *
-     * @default true
-     * @example
-     * // Dependent query - wait for parent data
-     * const { data: employee } = useOsdkObject(Employee, employeeId);
-     * const { data: reports } = useOsdkObjects(Employee, {
-     *   where: { managerId: employee?.id },
-     *   enabled: !!employee
-     * });
+     * Whether data is currently being loaded
      */
-    enabled?: boolean;
-}
-interface UseOsdkListResult<T extends ObjectOrInterfaceDefinition, RDPs extends Record<string, SimplePropertyDef> = {}> {
-    fetchMore: (() => Promise<void>) | undefined;
-    data: Osdk$1.Instance<T, "$allBaseProperties", PropertyKeys$1<T>, RDPs>[] | undefined;
     isLoading: boolean;
+    /**
+     * Any error that occurred during fetching
+     */
     error: Error | undefined;
     /**
      * Refers to whether the ordered list of objects (only considering the $primaryKey)
@@ -643,11 +634,15 @@ interface UseOsdkListResult<T extends ObjectOrInterfaceDefinition, RDPs extends
      * do that on a per object basis with useOsdkObject
      */
     isOptimistic: boolean;
+    /**
+     * The total count of objects matching the query (if available from the API)
+     */
+    totalCount?: string;
 }
 declare function useOsdkObjects<Q extends ObjectOrInterfaceDefinition, L extends LinkNames<Q>>(type: Q, options: UseOsdkObjectsOptions<Q> & {
     pivotTo: L;
 }): UseOsdkListResult<LinkedType<Q, L>>;
-declare function useOsdkObjects<Q extends ObjectOrInterfaceDefinition, WP extends DerivedProperty.Clause<Q> | undefined>(type: Q, options?: UseOsdkObjectsOptions<Q, WP>): UseOsdkListResult<Q, InferRdpTypes<Q, WP>>;
+declare function useOsdkObjects<Q extends ObjectOrInterfaceDefinition, RDPs extends Record<string, SimplePropertyDef> = {}>(type: Q, options?: UseOsdkObjectsOptions<Q, RDPs>): UseOsdkListResult<Q, RDPs>;
 
 interface DebouncedCallback<TArgs extends readonly unknown[]> {
     (...args: TArgs): void;
@@ -684,4 +679,4 @@ interface DebouncedCallback<TArgs extends readonly unknown[]> {
  */
 declare function useDebouncedCallback<TArgs extends readonly unknown[]>(callback: (...args: TArgs) => void | Promise<void>, delay: number): DebouncedCallback<TArgs>;
 
-export { OsdkProvider2, type UseOsdkAggregationResult, type UseOsdkFunctionOptions, type UseOsdkFunctionResult, type UseOsdkListResult, useCurrentFoundryUser, useDebouncedCallback, useFoundryUser, useFoundryUsersList, useLinks, useObjectSet, useOsdkAction, useOsdkAggregation, useOsdkFunction, useOsdkObject, useOsdkObjects };
+export { OsdkProvider2, type UseOsdkAggregationResult, type UseOsdkFunctionOptions, type UseOsdkFunctionResult, type UseOsdkListResult, type UseOsdkObjectsOptions, useCurrentFoundryUser, useDebouncedCallback, useFoundryUser, useFoundryUsersList, useLinks, useObjectSet, useOsdkAction, useOsdkAggregation, useOsdkFunction, useOsdkObject, useOsdkObjects };

package/build/esm/intellisense.test.helpers/useOsdkObjectsWithProperties.js

@@ -26,7 +26,7 @@ function TestComponent() {
     data
   } = useOsdkObjects(Employee, {
     withProperties: {
-      constantValue: employee => employee.constant.integer(42)
+      constantValue: employee => employee.selectProperty("class")
     }
   });
   return null;

package/build/esm/intellisense.test.helpers/useOsdkObjectsWithProperties.js.map

@@ -1 +1 @@
-{"version":3,"file":"useOsdkObjectsWithProperties.js","names":["Employee","useOsdkObjects","TestComponent","data","withProperties","constantValue","employee","constant","integer"],"sources":["useOsdkObjectsWithProperties.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n// WARNING!\n// WARNING!\n// This file is used for tests that check intellisense. Editing this file by hand will likely\n// break tests that have hard coded line numbers and line offsets.\n\nimport type { DerivedProperty } from \"@osdk/api\";\nimport { Employee } from \"@osdk/client.test.ontology\";\nimport { useOsdkObjects } from \"@osdk/react/experimental\";\n\nfunction TestComponent() {\n  const withProps: DerivedProperty.Clause<typeof Employee> = {\n    constantValue: (employee) => employee.constant.integer(42),\n  };\n\n  const { data } = useOsdkObjects(Employee, {\n    withProperties: withProps,\n  });\n\n  return null;\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;;AAGA,SAASA,QAAQ,QAAQ,4BAA4B;AACrD,SAASC,cAAc,QAAQ,0BAA0B;AAEzD,SAASC,aAAaA,CAAA,EAAG;EAKvB,MAAM;IAAEC;EAAK,CAAC,GAAGF,cAAc,CAACD,QAAQ,EAAE;IACxCI,cAAc,EAL2C;MACzDC,aAAa,EAAGC,QAAQ,IAAKA,QAAQ,CAACC,QAAQ,CAACC,OAAO,CAAC,EAAE;IAC3D;EAIA,CAAC,CAAC;EAEF,OAAO,IAAI;AACb","ignoreList":[]}
+{"version":3,"file":"useOsdkObjectsWithProperties.js","names":["Employee","useOsdkObjects","TestComponent","data","withProperties","constantValue","employee","selectProperty"],"sources":["useOsdkObjectsWithProperties.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n// WARNING!\n// WARNING!\n// This file is used for tests that check intellisense. Editing this file by hand will likely\n// break tests that have hard coded line numbers and line offsets.\n\nimport type { DerivedProperty } from \"@osdk/api\";\nimport { Employee } from \"@osdk/client.test.ontology\";\nimport { useOsdkObjects } from \"@osdk/react/experimental\";\n\nfunction TestComponent() {\n  const withProps: DerivedProperty.Clause<typeof Employee> = {\n    constantValue: (employee) => employee.selectProperty(\"class\"),\n  };\n\n  const { data } = useOsdkObjects(Employee, {\n    withProperties: withProps,\n  });\n\n  return null;\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;;AAGA,SAASA,QAAQ,QAAQ,4BAA4B;AACrD,SAASC,cAAc,QAAQ,0BAA0B;AAEzD,SAASC,aAAaA,CAAA,EAAG;EAKvB,MAAM;IAAEC;EAAK,CAAC,GAAGF,cAAc,CAACD,QAAQ,EAAE;IACxCI,cAAc,EAL2C;MACzDC,aAAa,EAAGC,QAAQ,IAAKA,QAAQ,CAACC,cAAc,CAAC,OAAO;IAC9D;EAIA,CAAC,CAAC;EAEF,OAAO,IAAI;AACb","ignoreList":[]}

package/build/esm/new/useLinks.js

@@ -35,11 +35,18 @@ export function useLinks(objects, linkName, options = {}) {
     enabled = true,
     ...otherOptions
   } = options;
+  const stableWhere = React.useMemo(() => otherOptions.where, [JSON.stringify(otherOptions.where)]);
+  const stableOrderBy = React.useMemo(() => otherOptions.orderBy, [JSON.stringify(otherOptions.orderBy)]);
+  const objectsKey = React.useMemo(() => {
+    if (objects === undefined) return "";
+    const arr = Array.isArray(objects) ? objects : [objects];
+    return arr.map(obj => `${obj.$apiName}:${obj.$primaryKey}`).join(",");
+  }, [objects]);
 
   // Convert single object to array for consistent handling
   const objectsArray = React.useMemo(() => {
     return objects === undefined ? emptyArray : Array.isArray(objects) ? objects : [objects];
-  }, [objects]);
+  }, [objectsKey, objects]);
   const {
     subscribe,
     getSnapShot
@@ -47,23 +54,23 @@ export function useLinks(objects, linkName, options = {}) {
     if (!enabled) {
       return makeExternalStore(() => ({
         unsubscribe: () => {}
-      }), `links ${linkName} for ${objectsArray.map(obj => `${obj.$apiName}:${obj.$primaryKey}`).join(",")} [DISABLED]`);
+      }), `links ${linkName} for ${objectsKey} [DISABLED]`);
     }
     return makeExternalStore(observer => observableClient.observeLinks(objectsArray, linkName, {
       linkName,
-      where: otherOptions.where,
+      where: stableWhere,
       pageSize: otherOptions.pageSize,
-      orderBy: otherOptions.orderBy,
+      orderBy: stableOrderBy,
       mode: otherOptions.mode
-    }, observer), `links ${linkName} for ${objectsArray.map(obj => `${obj.$apiName}:${obj.$primaryKey}`).join(",")}`);
-  }, [enabled, observableClient, objectsArray, linkName, otherOptions.where, otherOptions.pageSize, otherOptions.orderBy, otherOptions.mode]);
+    }, observer), `links ${linkName} for ${objectsKey}`);
+  }, [enabled, observableClient, objectsArray, objectsKey, linkName, stableWhere, otherOptions.pageSize, stableOrderBy, otherOptions.mode]);
   const payload = React.useSyncExternalStore(subscribe, getSnapShot);
   return {
     links: payload?.resolvedList,
     isLoading: enabled ? payload?.status === "loading" || payload?.status === "init" || !payload : false,
     isOptimistic: payload?.isOptimistic ?? false,
     error: payload?.error,
-    fetchMore: payload?.fetchMore,
+    fetchMore: payload?.hasMore ? payload?.fetchMore : undefined,
     hasMore: payload?.hasMore ?? false
   };
 }

package/build/esm/new/useLinks.js.map

@@ -1 +1 @@
-{"version":3,"file":"useLinks.js","names":["React","makeExternalStore","OsdkContext2","emptyArray","Object","freeze","useLinks","objects","linkName","options","observableClient","useContext","enabled","otherOptions","objectsArray","useMemo","undefined","Array","isArray","subscribe","getSnapShot","unsubscribe","map","obj","$apiName","$primaryKey","join","observer","observeLinks","where","pageSize","orderBy","mode","payload","useSyncExternalStore","links","resolvedList","isLoading","status","isOptimistic","error","fetchMore","hasMore"],"sources":["useLinks.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n  LinkedType,\n  LinkNames,\n  ObjectOrInterfaceDefinition,\n} from \"@osdk/api\";\nimport type { Osdk, PropertyKeys, WhereClause } from \"@osdk/client\";\nimport type { ObserveLinks } from \"@osdk/client/unstable-do-not-use\";\nimport React from \"react\";\nimport { makeExternalStore } from \"./makeExternalStore.js\";\nimport { OsdkContext2 } from \"./OsdkContext2.js\";\n\nexport interface UseLinksOptions<\n  T extends ObjectOrInterfaceDefinition,\n> {\n  /**\n   * Standard OSDK Where clause for filtering linked objects\n   */\n  where?: WhereClause<T>;\n\n  /**\n   * The preferred page size for the links list.\n   */\n  pageSize?: number;\n\n  /** Sorting options for the linked objects */\n  orderBy?: {\n    [K in PropertyKeys<T>]?: \"asc\" | \"desc\";\n  };\n\n  /**\n   * The mode to use for fetching data.\n   * - undefined: Fetch data if not already in cache\n   * - \"force\": Always fetch fresh data\n   * - \"offline\": Only use cached data, don't make network requests\n   */\n  mode?: \"force\" | \"offline\";\n\n  /**\n   * Enable or disable the query.\n   *\n   * When `false`, the query will not automatically execute. It will still\n   * return any cached data, but will not fetch from the server.\n   *\n   * This is useful for:\n   * - Lazy/on-demand queries that should wait for user interaction\n   * - Dependent queries that need data from another query first\n   * - Conditional queries based on component state\n   *\n   * @default true\n   * @example\n   * // Dependent query - wait for employee data\n   * const { object: employee } = useOsdkObject(Employee, employeeId);\n   * const { links: reports } = useLinks(employee, \"reports\", {\n   *   enabled: !!employee\n   * });\n   */\n  enabled?: boolean;\n}\n\nexport interface UseLinksResult<\n  Q extends ObjectOrInterfaceDefinition,\n> {\n  links: Osdk.Instance<Q>[] | undefined;\n  isLoading: boolean;\n  error: Error | undefined;\n\n  /**\n   * Refers to whether the links are optimistic or not.\n   */\n  isOptimistic: boolean;\n\n  /**\n   * Fetch more linked objects if pagination is supported\n   */\n  fetchMore: (() => Promise<unknown>) | undefined;\n\n  /**\n   * Indicates if there are more linked objects available to fetch\n   */\n  hasMore: boolean;\n}\n\nconst emptyArray = Object.freeze([]);\n\n/**\n * Hook to observe links from an object or array of objects.\n *\n * @param objects The source object(s) to observe links from\n * @param linkName The name of the link to observe\n * @param options Optional configuration for the link query\n * @returns UseLinksResult with links data and metadata\n */\nexport function useLinks<\n  T extends ObjectOrInterfaceDefinition,\n  L extends LinkNames<T>,\n>(\n  objects: Osdk.Instance<T> | Array<Osdk.Instance<T>> | undefined,\n  linkName: L,\n  options: UseLinksOptions<LinkedType<T, L>> = {},\n): UseLinksResult<LinkedType<T, L>> {\n  const { observableClient } = React.useContext(OsdkContext2);\n\n  const { enabled = true, ...otherOptions } = options;\n\n  // Convert single object to array for consistent handling\n  const objectsArray: ReadonlyArray<Osdk.Instance<T>> = React.useMemo(() => {\n    return objects === undefined\n      ? emptyArray\n      : Array.isArray(objects)\n      ? objects\n      : [objects];\n  }, [objects]);\n\n  const { subscribe, getSnapShot } = React.useMemo(\n    () => {\n      if (!enabled) {\n        return makeExternalStore<ObserveLinks.CallbackArgs<T>>(\n          () => ({ unsubscribe: () => {} }),\n          `links ${linkName} for ${\n            objectsArray.map(obj => `${obj.$apiName}:${obj.$primaryKey}`).join(\n              \",\",\n            )\n          } [DISABLED]`,\n        );\n      }\n      return makeExternalStore<ObserveLinks.CallbackArgs<T>>(\n        (observer) =>\n          observableClient.observeLinks(\n            objectsArray,\n            linkName,\n            {\n              linkName,\n              where: otherOptions.where,\n              pageSize: otherOptions.pageSize,\n              orderBy: otherOptions.orderBy,\n              mode: otherOptions.mode,\n            },\n            observer,\n          ),\n        `links ${linkName} for ${\n          objectsArray.map(obj => `${obj.$apiName}:${obj.$primaryKey}`).join(\n            \",\",\n          )\n        }`,\n      );\n    },\n    [\n      enabled,\n      observableClient,\n      objectsArray,\n      linkName,\n      otherOptions.where,\n      otherOptions.pageSize,\n      otherOptions.orderBy,\n      otherOptions.mode,\n    ],\n  );\n\n  const payload = React.useSyncExternalStore(\n    subscribe,\n    getSnapShot,\n  );\n\n  return {\n    links: payload?.resolvedList,\n    isLoading: enabled\n      ? (payload?.status === \"loading\" || payload?.status === \"init\"\n        || !payload)\n      : false,\n    isOptimistic: payload?.isOptimistic ?? false,\n    error: payload?.error,\n    fetchMore: payload?.fetchMore,\n    hasMore: payload?.hasMore ?? false,\n  };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AASA,OAAOA,KAAK,MAAM,OAAO;AACzB,SAASC,iBAAiB,QAAQ,wBAAwB;AAC1D,SAASC,YAAY,QAAQ,mBAAmB;AAyEhD,MAAMC,UAAU,GAAGC,MAAM,CAACC,MAAM,CAAC,EAAE,CAAC;;AAEpC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,QAAQA,CAItBC,OAA+D,EAC/DC,QAAW,EACXC,OAA0C,GAAG,CAAC,CAAC,EACb;EAClC,MAAM;IAAEC;EAAiB,CAAC,GAAGV,KAAK,CAACW,UAAU,CAACT,YAAY,CAAC;EAE3D,MAAM;IAAEU,OAAO,GAAG,IAAI;IAAE,GAAGC;EAAa,CAAC,GAAGJ,OAAO;;EAEnD;EACA,MAAMK,YAA6C,GAAGd,KAAK,CAACe,OAAO,CAAC,MAAM;IACxE,OAAOR,OAAO,KAAKS,SAAS,GACxBb,UAAU,GACVc,KAAK,CAACC,OAAO,CAACX,OAAO,CAAC,GACtBA,OAAO,GACP,CAACA,OAAO,CAAC;EACf,CAAC,EAAE,CAACA,OAAO,CAAC,CAAC;EAEb,MAAM;IAAEY,SAAS;IAAEC;EAAY,CAAC,GAAGpB,KAAK,CAACe,OAAO,CAC9C,MAAM;IACJ,IAAI,CAACH,OAAO,EAAE;MACZ,OAAOX,iBAAiB,CACtB,OAAO;QAAEoB,WAAW,EAAEA,CAAA,KAAM,CAAC;MAAE,CAAC,CAAC,EACjC,SAASb,QAAQ,QACfM,YAAY,CAACQ,GAAG,CAACC,GAAG,IAAI,GAAGA,GAAG,CAACC,QAAQ,IAAID,GAAG,CAACE,WAAW,EAAE,CAAC,CAACC,IAAI,CAChE,GACF,CAAC,aAEL,CAAC;IACH;IACA,OAAOzB,iBAAiB,CACrB0B,QAAQ,IACPjB,gBAAgB,CAACkB,YAAY,CAC3Bd,YAAY,EACZN,QAAQ,EACR;MACEA,QAAQ;MACRqB,KAAK,EAAEhB,YAAY,CAACgB,KAAK;MACzBC,QAAQ,EAAEjB,YAAY,CAACiB,QAAQ;MAC/BC,OAAO,EAAElB,YAAY,CAACkB,OAAO;MAC7BC,IAAI,EAAEnB,YAAY,CAACmB;IACrB,CAAC,EACDL,QACF,CAAC,EACH,SAASnB,QAAQ,QACfM,YAAY,CAACQ,GAAG,CAACC,GAAG,IAAI,GAAGA,GAAG,CAACC,QAAQ,IAAID,GAAG,CAACE,WAAW,EAAE,CAAC,CAACC,IAAI,CAChE,GACF,CAAC,EAEL,CAAC;EACH,CAAC,EACD,CACEd,OAAO,EACPF,gBAAgB,EAChBI,YAAY,EACZN,QAAQ,EACRK,YAAY,CAACgB,KAAK,EAClBhB,YAAY,CAACiB,QAAQ,EACrBjB,YAAY,CAACkB,OAAO,EACpBlB,YAAY,CAACmB,IAAI,CAErB,CAAC;EAED,MAAMC,OAAO,GAAGjC,KAAK,CAACkC,oBAAoB,CACxCf,SAAS,EACTC,WACF,CAAC;EAED,OAAO;IACLe,KAAK,EAAEF,OAAO,EAAEG,YAAY;IAC5BC,SAAS,EAAEzB,OAAO,GACbqB,OAAO,EAAEK,MAAM,KAAK,SAAS,IAAIL,OAAO,EAAEK,MAAM,KAAK,MAAM,IACzD,CAACL,OAAO,GACX,KAAK;IACTM,YAAY,EAAEN,OAAO,EAAEM,YAAY,IAAI,KAAK;IAC5CC,KAAK,EAAEP,OAAO,EAAEO,KAAK;IACrBC,SAAS,EAAER,OAAO,EAAEQ,SAAS;IAC7BC,OAAO,EAAET,OAAO,EAAES,OAAO,IAAI;EAC/B,CAAC;AACH","ignoreList":[]}
+{"version":3,"file":"useLinks.js","names":["React","makeExternalStore","OsdkContext2","emptyArray","Object","freeze","useLinks","objects","linkName","options","observableClient","useContext","enabled","otherOptions","stableWhere","useMemo","where","JSON","stringify","stableOrderBy","orderBy","objectsKey","undefined","arr","Array","isArray","map","obj","$apiName","$primaryKey","join","objectsArray","subscribe","getSnapShot","unsubscribe","observer","observeLinks","pageSize","mode","payload","useSyncExternalStore","links","resolvedList","isLoading","status","isOptimistic","error","fetchMore","hasMore"],"sources":["useLinks.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n  LinkedType,\n  LinkNames,\n  ObjectOrInterfaceDefinition,\n} from \"@osdk/api\";\nimport type { Osdk, PropertyKeys, WhereClause } from \"@osdk/client\";\nimport type { ObserveLinks } from \"@osdk/client/unstable-do-not-use\";\nimport React from \"react\";\nimport { makeExternalStore } from \"./makeExternalStore.js\";\nimport { OsdkContext2 } from \"./OsdkContext2.js\";\n\nexport interface UseLinksOptions<\n  T extends ObjectOrInterfaceDefinition,\n> {\n  /**\n   * Standard OSDK Where clause for filtering linked objects\n   */\n  where?: WhereClause<T>;\n\n  /**\n   * The preferred page size for the links list.\n   */\n  pageSize?: number;\n\n  /** Sorting options for the linked objects */\n  orderBy?: {\n    [K in PropertyKeys<T>]?: \"asc\" | \"desc\";\n  };\n\n  /**\n   * The mode to use for fetching data.\n   * - undefined: Fetch data if not already in cache\n   * - \"force\": Always fetch fresh data\n   * - \"offline\": Only use cached data, don't make network requests\n   */\n  mode?: \"force\" | \"offline\";\n\n  /**\n   * Enable or disable the query.\n   *\n   * When `false`, the query will not automatically execute. It will still\n   * return any cached data, but will not fetch from the server.\n   *\n   * This is useful for:\n   * - Lazy/on-demand queries that should wait for user interaction\n   * - Dependent queries that need data from another query first\n   * - Conditional queries based on component state\n   *\n   * @default true\n   * @example\n   * // Dependent query - wait for employee data\n   * const { object: employee } = useOsdkObject(Employee, employeeId);\n   * const { links: reports } = useLinks(employee, \"reports\", {\n   *   enabled: !!employee\n   * });\n   */\n  enabled?: boolean;\n}\n\nexport interface UseLinksResult<\n  Q extends ObjectOrInterfaceDefinition,\n> {\n  links: Osdk.Instance<Q>[] | undefined;\n  isLoading: boolean;\n  error: Error | undefined;\n\n  /**\n   * Refers to whether the links are optimistic or not.\n   */\n  isOptimistic: boolean;\n\n  /**\n   * Fetch more linked objects if pagination is supported\n   */\n  fetchMore: (() => Promise<unknown>) | undefined;\n\n  /**\n   * Indicates if there are more linked objects available to fetch\n   */\n  hasMore: boolean;\n}\n\nconst emptyArray = Object.freeze([]);\n\n/**\n * Hook to observe links from an object or array of objects.\n *\n * @param objects The source object(s) to observe links from\n * @param linkName The name of the link to observe\n * @param options Optional configuration for the link query\n * @returns UseLinksResult with links data and metadata\n */\nexport function useLinks<\n  T extends ObjectOrInterfaceDefinition,\n  L extends LinkNames<T>,\n>(\n  objects: Osdk.Instance<T> | Array<Osdk.Instance<T>> | undefined,\n  linkName: L,\n  options: UseLinksOptions<LinkedType<T, L>> = {},\n): UseLinksResult<LinkedType<T, L>> {\n  const { observableClient } = React.useContext(OsdkContext2);\n\n  const { enabled = true, ...otherOptions } = options;\n\n  const stableWhere = React.useMemo(\n    () => otherOptions.where,\n    [JSON.stringify(otherOptions.where)],\n  );\n\n  const stableOrderBy = React.useMemo(\n    () => otherOptions.orderBy,\n    [JSON.stringify(otherOptions.orderBy)],\n  );\n\n  const objectsKey = React.useMemo(() => {\n    if (objects === undefined) return \"\";\n    const arr = Array.isArray(objects) ? objects : [objects];\n    return arr.map(obj => `${obj.$apiName}:${obj.$primaryKey}`).join(\",\");\n  }, [objects]);\n\n  // Convert single object to array for consistent handling\n  const objectsArray: ReadonlyArray<Osdk.Instance<T>> = React.useMemo(() => {\n    return objects === undefined\n      ? emptyArray\n      : Array.isArray(objects)\n      ? objects\n      : [objects];\n  }, [objectsKey, objects]);\n\n  const { subscribe, getSnapShot } = React.useMemo(\n    () => {\n      if (!enabled) {\n        return makeExternalStore<ObserveLinks.CallbackArgs<T>>(\n          () => ({ unsubscribe: () => {} }),\n          `links ${linkName} for ${objectsKey} [DISABLED]`,\n        );\n      }\n      return makeExternalStore<ObserveLinks.CallbackArgs<T>>(\n        (observer) =>\n          observableClient.observeLinks(\n            objectsArray,\n            linkName,\n            {\n              linkName,\n              where: stableWhere,\n              pageSize: otherOptions.pageSize,\n              orderBy: stableOrderBy,\n              mode: otherOptions.mode,\n            },\n            observer,\n          ),\n        `links ${linkName} for ${objectsKey}`,\n      );\n    },\n    [\n      enabled,\n      observableClient,\n      objectsArray,\n      objectsKey,\n      linkName,\n      stableWhere,\n      otherOptions.pageSize,\n      stableOrderBy,\n      otherOptions.mode,\n    ],\n  );\n\n  const payload = React.useSyncExternalStore(\n    subscribe,\n    getSnapShot,\n  );\n\n  return {\n    links: payload?.resolvedList,\n    isLoading: enabled\n      ? (payload?.status === \"loading\" || payload?.status === \"init\"\n        || !payload)\n      : false,\n    isOptimistic: payload?.isOptimistic ?? false,\n    error: payload?.error,\n    fetchMore: payload?.hasMore ? payload?.fetchMore : undefined,\n    hasMore: payload?.hasMore ?? false,\n  };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AASA,OAAOA,KAAK,MAAM,OAAO;AACzB,SAASC,iBAAiB,QAAQ,wBAAwB;AAC1D,SAASC,YAAY,QAAQ,mBAAmB;AAyEhD,MAAMC,UAAU,GAAGC,MAAM,CAACC,MAAM,CAAC,EAAE,CAAC;;AAEpC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,QAAQA,CAItBC,OAA+D,EAC/DC,QAAW,EACXC,OAA0C,GAAG,CAAC,CAAC,EACb;EAClC,MAAM;IAAEC;EAAiB,CAAC,GAAGV,KAAK,CAACW,UAAU,CAACT,YAAY,CAAC;EAE3D,MAAM;IAAEU,OAAO,GAAG,IAAI;IAAE,GAAGC;EAAa,CAAC,GAAGJ,OAAO;EAEnD,MAAMK,WAAW,GAAGd,KAAK,CAACe,OAAO,CAC/B,MAAMF,YAAY,CAACG,KAAK,EACxB,CAACC,IAAI,CAACC,SAAS,CAACL,YAAY,CAACG,KAAK,CAAC,CACrC,CAAC;EAED,MAAMG,aAAa,GAAGnB,KAAK,CAACe,OAAO,CACjC,MAAMF,YAAY,CAACO,OAAO,EAC1B,CAACH,IAAI,CAACC,SAAS,CAACL,YAAY,CAACO,OAAO,CAAC,CACvC,CAAC;EAED,MAAMC,UAAU,GAAGrB,KAAK,CAACe,OAAO,CAAC,MAAM;IACrC,IAAIR,OAAO,KAAKe,SAAS,EAAE,OAAO,EAAE;IACpC,MAAMC,GAAG,GAAGC,KAAK,CAACC,OAAO,CAAClB,OAAO,CAAC,GAAGA,OAAO,GAAG,CAACA,OAAO,CAAC;IACxD,OAAOgB,GAAG,CAACG,GAAG,CAACC,GAAG,IAAI,GAAGA,GAAG,CAACC,QAAQ,IAAID,GAAG,CAACE,WAAW,EAAE,CAAC,CAACC,IAAI,CAAC,GAAG,CAAC;EACvE,CAAC,EAAE,CAACvB,OAAO,CAAC,CAAC;;EAEb;EACA,MAAMwB,YAA6C,GAAG/B,KAAK,CAACe,OAAO,CAAC,MAAM;IACxE,OAAOR,OAAO,KAAKe,SAAS,GACxBnB,UAAU,GACVqB,KAAK,CAACC,OAAO,CAAClB,OAAO,CAAC,GACtBA,OAAO,GACP,CAACA,OAAO,CAAC;EACf,CAAC,EAAE,CAACc,UAAU,EAAEd,OAAO,CAAC,CAAC;EAEzB,MAAM;IAAEyB,SAAS;IAAEC;EAAY,CAAC,GAAGjC,KAAK,CAACe,OAAO,CAC9C,MAAM;IACJ,IAAI,CAACH,OAAO,EAAE;MACZ,OAAOX,iBAAiB,CACtB,OAAO;QAAEiC,WAAW,EAAEA,CAAA,KAAM,CAAC;MAAE,CAAC,CAAC,EACjC,SAAS1B,QAAQ,QAAQa,UAAU,aACrC,CAAC;IACH;IACA,OAAOpB,iBAAiB,CACrBkC,QAAQ,IACPzB,gBAAgB,CAAC0B,YAAY,CAC3BL,YAAY,EACZvB,QAAQ,EACR;MACEA,QAAQ;MACRQ,KAAK,EAAEF,WAAW;MAClBuB,QAAQ,EAAExB,YAAY,CAACwB,QAAQ;MAC/BjB,OAAO,EAAED,aAAa;MACtBmB,IAAI,EAAEzB,YAAY,CAACyB;IACrB,CAAC,EACDH,QACF,CAAC,EACH,SAAS3B,QAAQ,QAAQa,UAAU,EACrC,CAAC;EACH,CAAC,EACD,CACET,OAAO,EACPF,gBAAgB,EAChBqB,YAAY,EACZV,UAAU,EACVb,QAAQ,EACRM,WAAW,EACXD,YAAY,CAACwB,QAAQ,EACrBlB,aAAa,EACbN,YAAY,CAACyB,IAAI,CAErB,CAAC;EAED,MAAMC,OAAO,GAAGvC,KAAK,CAACwC,oBAAoB,CACxCR,SAAS,EACTC,WACF,CAAC;EAED,OAAO;IACLQ,KAAK,EAAEF,OAAO,EAAEG,YAAY;IAC5BC,SAAS,EAAE/B,OAAO,GACb2B,OAAO,EAAEK,MAAM,KAAK,SAAS,IAAIL,OAAO,EAAEK,MAAM,KAAK,MAAM,IACzD,CAACL,OAAO,GACX,KAAK;IACTM,YAAY,EAAEN,OAAO,EAAEM,YAAY,IAAI,KAAK;IAC5CC,KAAK,EAAEP,OAAO,EAAEO,KAAK;IACrBC,SAAS,EAAER,OAAO,EAAES,OAAO,GAAGT,OAAO,EAAEQ,SAAS,GAAGzB,SAAS;IAC5D0B,OAAO,EAAET,OAAO,EAAES,OAAO,IAAI;EAC/B,CAAC;AACH","ignoreList":[]}

package/build/esm/new/useObjectSet.js

@@ -97,8 +97,9 @@ export function useObjectSet(baseObjectSet, options = {}) {
     data: payload?.resolvedList,
     isLoading: payload?.status === "loading" || !payload && true || false,
     error: payload && "error" in payload ? payload.error : undefined,
-    fetchMore: payload?.fetchMore,
-    objectSet: payload?.objectSet || baseObjectSet
+    fetchMore: payload?.hasMore ? payload.fetchMore : undefined,
+    objectSet: payload?.objectSet || baseObjectSet,
+    totalCount: payload?.totalCount
   };
 }
 //# sourceMappingURL=useObjectSet.js.map

package/build/esm/new/useObjectSet.js.map

@@ -1 +1 @@
-{"version":3,"file":"useObjectSet.js","names":["computeObjectSetCacheKey","React","makeExternalStore","OsdkContext2","useObjectSet","baseObjectSet","options","observableClient","useContext","enabled","streamUpdates","otherOptions","objectTypeKey","$objectSetInternals","def","apiName","previousObjectTypeRef","useRef","previousPayloadRef","objectTypeChanged","current","stableKey","where","withProperties","union","intersect","subtract","pivotTo","pageSize","orderBy","subscribe","getSnapShot","useMemo","unsubscribe","process","env","NODE_ENV","initialValue","undefined","observer","subscription","observeObjectSet","dedupeInterval","dedupeIntervalMs","autoFetchMore","payload","useSyncExternalStore","useEffect","data","resolvedList","isLoading","status","error","fetchMore","objectSet"],"sources":["useObjectSet.tsx"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n  DerivedProperty,\n  LinkNames,\n  ObjectSet,\n  ObjectTypeDefinition,\n  Osdk,\n  PropertyKeys,\n  SimplePropertyDef,\n  WhereClause,\n} from \"@osdk/api\";\n\nimport {\n  computeObjectSetCacheKey,\n  type ObserveObjectSetArgs,\n} from \"@osdk/client/unstable-do-not-use\";\nimport React from \"react\";\nimport { makeExternalStore, type Snapshot } from \"./makeExternalStore.js\";\nimport { OsdkContext2 } from \"./OsdkContext2.js\";\n\nexport interface UseObjectSetOptions<\n  Q extends ObjectTypeDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> {\n  /**\n   * Where clause for filtering\n   */\n  where?: WhereClause<Q, RDPs>;\n\n  /**\n   * Derived properties to add to the object set\n   */\n  withProperties?: { [K in keyof RDPs]: DerivedProperty.Creator<Q, RDPs[K]> };\n\n  /**\n   * Object sets to union with\n   */\n  union?: ObjectSet<Q>[];\n\n  /**\n   * Object sets to intersect with\n   */\n  intersect?: ObjectSet<Q>[];\n\n  /**\n   * Object sets to subtract from\n   */\n  subtract?: ObjectSet<Q>[];\n\n  /**\n   * Link to pivot to (changes the type)\n   */\n  pivotTo?: LinkNames<Q>;\n\n  /**\n   * The preferred page size for the list\n   */\n  pageSize?: number;\n\n  /**\n   * Sort order for the results\n   */\n  orderBy?: {\n    [K in PropertyKeys<Q>]?: \"asc\" | \"desc\";\n  };\n\n  /**\n   * Minimum time between fetch requests in milliseconds (defaults to 2000ms)\n   */\n  dedupeIntervalMs?: number;\n\n  /**\n   * Automatically fetch additional pages on initial load.\n   *\n   * - `true`: Fetch all available pages automatically\n   * - `number`: Fetch pages until at least this many items are loaded\n   * - `undefined` (default): Only fetch the first page, user must call fetchMore()\n   */\n  autoFetchMore?: boolean | number;\n\n  /**\n   * Enable streaming updates via websocket subscription.\n   * When true, the object set will automatically update when matching objects are\n   * added, updated, or removed.\n   *\n   * @default false\n   */\n  streamUpdates?: boolean;\n\n  /**\n   * Enable or disable the query.\n   *\n   * When `false`, the query will not automatically execute. It will still\n   * return any cached data, but will not fetch from the server.\n   *\n   * This is useful for:\n   * - Lazy/on-demand queries that should wait for user interaction\n   * - Dependent queries that need data from another query first\n   * - Conditional queries based on component state\n   *\n   * @default true\n   * @example\n   * // Dependent query - wait for filter selection\n   * const { data: filteredObjects } = useObjectSet(MyObject.all(), {\n   *   where: { status: selectedStatus },\n   *   enabled: !!selectedStatus\n   * });\n   */\n  enabled?: boolean;\n}\n\nexport interface UseObjectSetResult<\n  Q extends ObjectTypeDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> {\n  /**\n   * The fetched data with derived properties\n   */\n  data:\n    | Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs>[]\n    | undefined;\n\n  /**\n   * Whether data is currently being loaded\n   */\n  isLoading: boolean;\n\n  /**\n   * Any error that occurred during fetching\n   */\n  error: Error | undefined;\n\n  /**\n   * Function to fetch more pages (undefined if no more pages)\n   */\n  fetchMore: (() => Promise<void>) | undefined;\n\n  /**\n   * The final ObjectSet after all transformations\n   */\n  objectSet: ObjectSet<Q, RDPs>;\n}\n\ndeclare const process: {\n  env: {\n    NODE_ENV: \"development\" | \"production\";\n  };\n};\n\n/**\n * React hook for observing and interacting with OSDK object sets.\n *\n * @typeParam Q - The object type definition\n * @typeParam BaseRDPs - Derived properties that already exist on the input ObjectSet\n * @typeParam RDPs - New derived properties to be added via options.withProperties\n *\n * @param baseObjectSet - The ObjectSet to observe (may already have derived properties)\n * @param options - Options for filtering, sorting, and adding new derived properties\n * @returns Object set data with both existing and new derived properties\n */\nexport function useObjectSet<\n  Q extends ObjectTypeDefinition,\n  BaseRDPs extends Record<string, SimplePropertyDef> = never,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n>(\n  baseObjectSet: ObjectSet<Q, BaseRDPs>,\n  options: UseObjectSetOptions<Q, RDPs> = {},\n): UseObjectSetResult<Q, RDPs> {\n  const { observableClient } = React.useContext(OsdkContext2);\n\n  const { enabled = true, streamUpdates, ...otherOptions } = options;\n\n  // Track object type to detect when we switch to a different object type\n  const objectTypeKey = baseObjectSet.$objectSetInternals.def.apiName;\n  const previousObjectTypeRef = React.useRef<string>(objectTypeKey);\n  const previousPayloadRef = React.useRef<\n    Snapshot<ObserveObjectSetArgs<Q, RDPs>> | undefined\n  >();\n\n  const objectTypeChanged = previousObjectTypeRef.current !== objectTypeKey;\n  if (objectTypeChanged) {\n    previousObjectTypeRef.current = objectTypeKey;\n  }\n\n  // Compute a stable cache key for the ObjectSet and options\n  // dedupeIntervalMs and enabled are excluded as they don't affect the data\n  const stableKey = computeObjectSetCacheKey(baseObjectSet, {\n    where: otherOptions.where,\n    withProperties: otherOptions.withProperties,\n    union: otherOptions.union,\n    intersect: otherOptions.intersect,\n    subtract: otherOptions.subtract,\n    pivotTo: otherOptions.pivotTo,\n    pageSize: otherOptions.pageSize,\n    orderBy: otherOptions.orderBy,\n  });\n\n  const { subscribe, getSnapShot } = React.useMemo(\n    () => {\n      if (!enabled) {\n        return makeExternalStore<ObserveObjectSetArgs<Q, RDPs>>(\n          () => ({ unsubscribe: () => {} }),\n          process.env.NODE_ENV !== \"production\"\n            ? `objectSet ${stableKey} [DISABLED]`\n            : void 0,\n        );\n      }\n\n      const initialValue = objectTypeChanged\n        ? undefined\n        : previousPayloadRef.current;\n\n      return makeExternalStore<ObserveObjectSetArgs<Q, RDPs>>(\n        (observer) => {\n          const subscription = observableClient.observeObjectSet(\n            baseObjectSet as ObjectSet<Q>,\n            {\n              where: otherOptions.where,\n              withProperties: otherOptions.withProperties,\n              union: otherOptions.union,\n              intersect: otherOptions.intersect,\n              subtract: otherOptions.subtract,\n              pivotTo: otherOptions.pivotTo,\n              pageSize: otherOptions.pageSize,\n              orderBy: otherOptions.orderBy,\n              dedupeInterval: otherOptions.dedupeIntervalMs ?? 2_000,\n              autoFetchMore: otherOptions.autoFetchMore,\n              streamUpdates,\n            },\n            observer,\n          );\n          return subscription;\n        },\n        process.env.NODE_ENV !== \"production\"\n          ? `objectSet ${stableKey}`\n          : void 0,\n        initialValue,\n      );\n    },\n    [enabled, observableClient, stableKey, streamUpdates, objectTypeChanged],\n  );\n\n  const payload = React.useSyncExternalStore(subscribe, getSnapShot);\n  React.useEffect(() => {\n    if (payload) {\n      previousPayloadRef.current = payload;\n    }\n  }, [payload]);\n\n  return {\n    data: payload?.resolvedList as Osdk.Instance<\n      Q,\n      \"$allBaseProperties\",\n      PropertyKeys<Q>,\n      RDPs\n    >[],\n    isLoading: payload?.status === \"loading\" || (!payload && true) || false,\n    error: payload && \"error\" in payload\n      ? payload.error\n      : undefined,\n    fetchMore: payload?.fetchMore,\n    objectSet: payload?.objectSet as ObjectSet<Q, RDPs> || baseObjectSet,\n  };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAaA,SACEA,wBAAwB,QAEnB,kCAAkC;AACzC,OAAOC,KAAK,MAAM,OAAO;AACzB,SAASC,iBAAiB,QAAuB,wBAAwB;AACzE,SAASC,YAAY,QAAQ,mBAAmB;AAmIhD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,YAAYA,CAK1BC,aAAqC,EACrCC,OAAqC,GAAG,CAAC,CAAC,EACb;EAC7B,MAAM;IAAEC;EAAiB,CAAC,GAAGN,KAAK,CAACO,UAAU,CAACL,YAAY,CAAC;EAE3D,MAAM;IAAEM,OAAO,GAAG,IAAI;IAAEC,aAAa;IAAE,GAAGC;EAAa,CAAC,GAAGL,OAAO;;EAElE;EACA,MAAMM,aAAa,GAAGP,aAAa,CAACQ,mBAAmB,CAACC,GAAG,CAACC,OAAO;EACnE,MAAMC,qBAAqB,GAAGf,KAAK,CAACgB,MAAM,CAASL,aAAa,CAAC;EACjE,MAAMM,kBAAkB,GAAGjB,KAAK,CAACgB,MAAM,CAErC,CAAC;EAEH,MAAME,iBAAiB,GAAGH,qBAAqB,CAACI,OAAO,KAAKR,aAAa;EACzE,IAAIO,iBAAiB,EAAE;IACrBH,qBAAqB,CAACI,OAAO,GAAGR,aAAa;EAC/C;;EAEA;EACA;EACA,MAAMS,SAAS,GAAGrB,wBAAwB,CAACK,aAAa,EAAE;IACxDiB,KAAK,EAAEX,YAAY,CAACW,KAAK;IACzBC,cAAc,EAAEZ,YAAY,CAACY,cAAc;IAC3CC,KAAK,EAAEb,YAAY,CAACa,KAAK;IACzBC,SAAS,EAAEd,YAAY,CAACc,SAAS;IACjCC,QAAQ,EAAEf,YAAY,CAACe,QAAQ;IAC/BC,OAAO,EAAEhB,YAAY,CAACgB,OAAO;IAC7BC,QAAQ,EAAEjB,YAAY,CAACiB,QAAQ;IAC/BC,OAAO,EAAElB,YAAY,CAACkB;EACxB,CAAC,CAAC;EAEF,MAAM;IAAEC,SAAS;IAAEC;EAAY,CAAC,GAAG9B,KAAK,CAAC+B,OAAO,CAC9C,MAAM;IACJ,IAAI,CAACvB,OAAO,EAAE;MACZ,OAAOP,iBAAiB,CACtB,OAAO;QAAE+B,WAAW,EAAEA,CAAA,KAAM,CAAC;MAAE,CAAC,CAAC,EACjCC,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,GACjC,aAAaf,SAAS,aAAa,GACnC,KAAK,CACX,CAAC;IACH;IAEA,MAAMgB,YAAY,GAAGlB,iBAAiB,GAClCmB,SAAS,GACTpB,kBAAkB,CAACE,OAAO;IAE9B,OAAOlB,iBAAiB,CACrBqC,QAAQ,IAAK;MACZ,MAAMC,YAAY,GAAGjC,gBAAgB,CAACkC,gBAAgB,CACpDpC,aAAa,EACb;QACEiB,KAAK,EAAEX,YAAY,CAACW,KAAK;QACzBC,cAAc,EAAEZ,YAAY,CAACY,cAAc;QAC3CC,KAAK,EAAEb,YAAY,CAACa,KAAK;QACzBC,SAAS,EAAEd,YAAY,CAACc,SAAS;QACjCC,QAAQ,EAAEf,YAAY,CAACe,QAAQ;QAC/BC,OAAO,EAAEhB,YAAY,CAACgB,OAAO;QAC7BC,QAAQ,EAAEjB,YAAY,CAACiB,QAAQ;QAC/BC,OAAO,EAAElB,YAAY,CAACkB,OAAO;QAC7Ba,cAAc,EAAE/B,YAAY,CAACgC,gBAAgB,IAAI,KAAK;QACtDC,aAAa,EAAEjC,YAAY,CAACiC,aAAa;QACzClC;MACF,CAAC,EACD6B,QACF,CAAC;MACD,OAAOC,YAAY;IACrB,CAAC,EACDN,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,GACjC,aAAaf,SAAS,EAAE,GACxB,KAAK,CAAC,EACVgB,YACF,CAAC;EACH,CAAC,EACD,CAAC5B,OAAO,EAAEF,gBAAgB,EAAEc,SAAS,EAAEX,aAAa,EAAES,iBAAiB,CACzE,CAAC;EAED,MAAM0B,OAAO,GAAG5C,KAAK,CAAC6C,oBAAoB,CAAChB,SAAS,EAAEC,WAAW,CAAC;EAClE9B,KAAK,CAAC8C,SAAS,CAAC,MAAM;IACpB,IAAIF,OAAO,EAAE;MACX3B,kBAAkB,CAACE,OAAO,GAAGyB,OAAO;IACtC;EACF,CAAC,EAAE,CAACA,OAAO,CAAC,CAAC;EAEb,OAAO;IACLG,IAAI,EAAEH,OAAO,EAAEI,YAKZ;IACHC,SAAS,EAAEL,OAAO,EAAEM,MAAM,KAAK,SAAS,IAAK,CAACN,OAAO,IAAI,IAAK,IAAI,KAAK;IACvEO,KAAK,EAAEP,OAAO,IAAI,OAAO,IAAIA,OAAO,GAChCA,OAAO,CAACO,KAAK,GACbd,SAAS;IACbe,SAAS,EAAER,OAAO,EAAEQ,SAAS;IAC7BC,SAAS,EAAET,OAAO,EAAES,SAAS,IAA0BjD;EACzD,CAAC;AACH","ignoreList":[]}
+{"version":3,"file":"useObjectSet.js","names":["computeObjectSetCacheKey","React","makeExternalStore","OsdkContext2","useObjectSet","baseObjectSet","options","observableClient","useContext","enabled","streamUpdates","otherOptions","objectTypeKey","$objectSetInternals","def","apiName","previousObjectTypeRef","useRef","previousPayloadRef","objectTypeChanged","current","stableKey","where","withProperties","union","intersect","subtract","pivotTo","pageSize","orderBy","subscribe","getSnapShot","useMemo","unsubscribe","process","env","NODE_ENV","initialValue","undefined","observer","subscription","observeObjectSet","dedupeInterval","dedupeIntervalMs","autoFetchMore","payload","useSyncExternalStore","useEffect","data","resolvedList","isLoading","status","error","fetchMore","hasMore","objectSet","totalCount"],"sources":["useObjectSet.tsx"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n  DerivedProperty,\n  LinkNames,\n  ObjectSet,\n  ObjectTypeDefinition,\n  Osdk,\n  PropertyKeys,\n  SimplePropertyDef,\n  WhereClause,\n} from \"@osdk/api\";\n\nimport {\n  computeObjectSetCacheKey,\n  type ObserveObjectSetArgs,\n} from \"@osdk/client/unstable-do-not-use\";\nimport React from \"react\";\nimport { makeExternalStore, type Snapshot } from \"./makeExternalStore.js\";\nimport { OsdkContext2 } from \"./OsdkContext2.js\";\n\nexport interface UseObjectSetOptions<\n  Q extends ObjectTypeDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> {\n  /**\n   * Where clause for filtering\n   */\n  where?: WhereClause<Q, RDPs>;\n\n  /**\n   * Derived properties to add to the object set\n   */\n  withProperties?: { [K in keyof RDPs]: DerivedProperty.Creator<Q, RDPs[K]> };\n\n  /**\n   * Object sets to union with\n   */\n  union?: ObjectSet<Q>[];\n\n  /**\n   * Object sets to intersect with\n   */\n  intersect?: ObjectSet<Q>[];\n\n  /**\n   * Object sets to subtract from\n   */\n  subtract?: ObjectSet<Q>[];\n\n  /**\n   * Link to pivot to (changes the type)\n   */\n  pivotTo?: LinkNames<Q>;\n\n  /**\n   * The preferred page size for the list\n   */\n  pageSize?: number;\n\n  /**\n   * Sort order for the results\n   */\n  orderBy?: {\n    [K in PropertyKeys<Q>]?: \"asc\" | \"desc\";\n  };\n\n  /**\n   * Minimum time between fetch requests in milliseconds (defaults to 2000ms)\n   */\n  dedupeIntervalMs?: number;\n\n  /**\n   * Automatically fetch additional pages on initial load.\n   *\n   * - `true`: Fetch all available pages automatically\n   * - `number`: Fetch pages until at least this many items are loaded\n   * - `undefined` (default): Only fetch the first page, user must call fetchMore()\n   */\n  autoFetchMore?: boolean | number;\n\n  /**\n   * Enable streaming updates via websocket subscription.\n   * When true, the object set will automatically update when matching objects are\n   * added, updated, or removed.\n   *\n   * @default false\n   */\n  streamUpdates?: boolean;\n\n  /**\n   * Enable or disable the query.\n   *\n   * When `false`, the query will not automatically execute. It will still\n   * return any cached data, but will not fetch from the server.\n   *\n   * This is useful for:\n   * - Lazy/on-demand queries that should wait for user interaction\n   * - Dependent queries that need data from another query first\n   * - Conditional queries based on component state\n   *\n   * @default true\n   * @example\n   * // Dependent query - wait for filter selection\n   * const { data: filteredObjects } = useObjectSet(MyObject.all(), {\n   *   where: { status: selectedStatus },\n   *   enabled: !!selectedStatus\n   * });\n   */\n  enabled?: boolean;\n}\n\nexport interface UseObjectSetResult<\n  Q extends ObjectTypeDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> {\n  /**\n   * The fetched data with derived properties\n   */\n  data:\n    | Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs>[]\n    | undefined;\n\n  /**\n   * Whether data is currently being loaded\n   */\n  isLoading: boolean;\n\n  /**\n   * Any error that occurred during fetching\n   */\n  error: Error | undefined;\n\n  /**\n   * Function to fetch more pages (undefined if no more pages)\n   */\n  fetchMore: (() => Promise<void>) | undefined;\n\n  /**\n   * The final ObjectSet after all transformations\n   */\n  objectSet: ObjectSet<Q, RDPs>;\n\n  /**\n   * The total count of objects matching the query (if available from the API)\n   */\n  totalCount?: string;\n}\n\ndeclare const process: {\n  env: {\n    NODE_ENV: \"development\" | \"production\";\n  };\n};\n\n/**\n * React hook for observing and interacting with OSDK object sets.\n *\n * @typeParam Q - The object type definition\n * @typeParam BaseRDPs - Derived properties that already exist on the input ObjectSet\n * @typeParam RDPs - New derived properties to be added via options.withProperties\n *\n * @param baseObjectSet - The ObjectSet to observe (may already have derived properties)\n * @param options - Options for filtering, sorting, and adding new derived properties\n * @returns Object set data with both existing and new derived properties\n */\nexport function useObjectSet<\n  Q extends ObjectTypeDefinition,\n  BaseRDPs extends Record<string, SimplePropertyDef> = never,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n>(\n  baseObjectSet: ObjectSet<Q, BaseRDPs>,\n  options: UseObjectSetOptions<Q, RDPs> = {},\n): UseObjectSetResult<Q, RDPs> {\n  const { observableClient } = React.useContext(OsdkContext2);\n\n  const { enabled = true, streamUpdates, ...otherOptions } = options;\n\n  // Track object type to detect when we switch to a different object type\n  const objectTypeKey = baseObjectSet.$objectSetInternals.def.apiName;\n  const previousObjectTypeRef = React.useRef<string>(objectTypeKey);\n  const previousPayloadRef = React.useRef<\n    Snapshot<ObserveObjectSetArgs<Q, RDPs>> | undefined\n  >();\n\n  const objectTypeChanged = previousObjectTypeRef.current !== objectTypeKey;\n  if (objectTypeChanged) {\n    previousObjectTypeRef.current = objectTypeKey;\n  }\n\n  // Compute a stable cache key for the ObjectSet and options\n  // dedupeIntervalMs and enabled are excluded as they don't affect the data\n  const stableKey = computeObjectSetCacheKey(baseObjectSet, {\n    where: otherOptions.where,\n    withProperties: otherOptions.withProperties,\n    union: otherOptions.union,\n    intersect: otherOptions.intersect,\n    subtract: otherOptions.subtract,\n    pivotTo: otherOptions.pivotTo,\n    pageSize: otherOptions.pageSize,\n    orderBy: otherOptions.orderBy,\n  });\n\n  const { subscribe, getSnapShot } = React.useMemo(\n    () => {\n      if (!enabled) {\n        return makeExternalStore<ObserveObjectSetArgs<Q, RDPs>>(\n          () => ({ unsubscribe: () => {} }),\n          process.env.NODE_ENV !== \"production\"\n            ? `objectSet ${stableKey} [DISABLED]`\n            : void 0,\n        );\n      }\n\n      const initialValue = objectTypeChanged\n        ? undefined\n        : previousPayloadRef.current;\n\n      return makeExternalStore<ObserveObjectSetArgs<Q, RDPs>>(\n        (observer) => {\n          const subscription = observableClient.observeObjectSet(\n            baseObjectSet as ObjectSet<Q>,\n            {\n              where: otherOptions.where,\n              withProperties: otherOptions.withProperties,\n              union: otherOptions.union,\n              intersect: otherOptions.intersect,\n              subtract: otherOptions.subtract,\n              pivotTo: otherOptions.pivotTo,\n              pageSize: otherOptions.pageSize,\n              orderBy: otherOptions.orderBy,\n              dedupeInterval: otherOptions.dedupeIntervalMs ?? 2_000,\n              autoFetchMore: otherOptions.autoFetchMore,\n              streamUpdates,\n            },\n            observer,\n          );\n          return subscription;\n        },\n        process.env.NODE_ENV !== \"production\"\n          ? `objectSet ${stableKey}`\n          : void 0,\n        initialValue,\n      );\n    },\n    [enabled, observableClient, stableKey, streamUpdates, objectTypeChanged],\n  );\n\n  const payload = React.useSyncExternalStore(subscribe, getSnapShot);\n  React.useEffect(() => {\n    if (payload) {\n      previousPayloadRef.current = payload;\n    }\n  }, [payload]);\n\n  return {\n    data: payload?.resolvedList as Osdk.Instance<\n      Q,\n      \"$allBaseProperties\",\n      PropertyKeys<Q>,\n      RDPs\n    >[],\n    isLoading: payload?.status === \"loading\" || (!payload && true) || false,\n    error: payload && \"error\" in payload\n      ? payload.error\n      : undefined,\n    fetchMore: payload?.hasMore ? payload.fetchMore : undefined,\n    objectSet: payload?.objectSet as ObjectSet<Q, RDPs> || baseObjectSet,\n    totalCount: payload?.totalCount,\n  };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAaA,SACEA,wBAAwB,QAEnB,kCAAkC;AACzC,OAAOC,KAAK,MAAM,OAAO;AACzB,SAASC,iBAAiB,QAAuB,wBAAwB;AACzE,SAASC,YAAY,QAAQ,mBAAmB;AAwIhD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,YAAYA,CAK1BC,aAAqC,EACrCC,OAAqC,GAAG,CAAC,CAAC,EACb;EAC7B,MAAM;IAAEC;EAAiB,CAAC,GAAGN,KAAK,CAACO,UAAU,CAACL,YAAY,CAAC;EAE3D,MAAM;IAAEM,OAAO,GAAG,IAAI;IAAEC,aAAa;IAAE,GAAGC;EAAa,CAAC,GAAGL,OAAO;;EAElE;EACA,MAAMM,aAAa,GAAGP,aAAa,CAACQ,mBAAmB,CAACC,GAAG,CAACC,OAAO;EACnE,MAAMC,qBAAqB,GAAGf,KAAK,CAACgB,MAAM,CAASL,aAAa,CAAC;EACjE,MAAMM,kBAAkB,GAAGjB,KAAK,CAACgB,MAAM,CAErC,CAAC;EAEH,MAAME,iBAAiB,GAAGH,qBAAqB,CAACI,OAAO,KAAKR,aAAa;EACzE,IAAIO,iBAAiB,EAAE;IACrBH,qBAAqB,CAACI,OAAO,GAAGR,aAAa;EAC/C;;EAEA;EACA;EACA,MAAMS,SAAS,GAAGrB,wBAAwB,CAACK,aAAa,EAAE;IACxDiB,KAAK,EAAEX,YAAY,CAACW,KAAK;IACzBC,cAAc,EAAEZ,YAAY,CAACY,cAAc;IAC3CC,KAAK,EAAEb,YAAY,CAACa,KAAK;IACzBC,SAAS,EAAEd,YAAY,CAACc,SAAS;IACjCC,QAAQ,EAAEf,YAAY,CAACe,QAAQ;IAC/BC,OAAO,EAAEhB,YAAY,CAACgB,OAAO;IAC7BC,QAAQ,EAAEjB,YAAY,CAACiB,QAAQ;IAC/BC,OAAO,EAAElB,YAAY,CAACkB;EACxB,CAAC,CAAC;EAEF,MAAM;IAAEC,SAAS;IAAEC;EAAY,CAAC,GAAG9B,KAAK,CAAC+B,OAAO,CAC9C,MAAM;IACJ,IAAI,CAACvB,OAAO,EAAE;MACZ,OAAOP,iBAAiB,CACtB,OAAO;QAAE+B,WAAW,EAAEA,CAAA,KAAM,CAAC;MAAE,CAAC,CAAC,EACjCC,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,GACjC,aAAaf,SAAS,aAAa,GACnC,KAAK,CACX,CAAC;IACH;IAEA,MAAMgB,YAAY,GAAGlB,iBAAiB,GAClCmB,SAAS,GACTpB,kBAAkB,CAACE,OAAO;IAE9B,OAAOlB,iBAAiB,CACrBqC,QAAQ,IAAK;MACZ,MAAMC,YAAY,GAAGjC,gBAAgB,CAACkC,gBAAgB,CACpDpC,aAAa,EACb;QACEiB,KAAK,EAAEX,YAAY,CAACW,KAAK;QACzBC,cAAc,EAAEZ,YAAY,CAACY,cAAc;QAC3CC,KAAK,EAAEb,YAAY,CAACa,KAAK;QACzBC,SAAS,EAAEd,YAAY,CAACc,SAAS;QACjCC,QAAQ,EAAEf,YAAY,CAACe,QAAQ;QAC/BC,OAAO,EAAEhB,YAAY,CAACgB,OAAO;QAC7BC,QAAQ,EAAEjB,YAAY,CAACiB,QAAQ;QAC/BC,OAAO,EAAElB,YAAY,CAACkB,OAAO;QAC7Ba,cAAc,EAAE/B,YAAY,CAACgC,gBAAgB,IAAI,KAAK;QACtDC,aAAa,EAAEjC,YAAY,CAACiC,aAAa;QACzClC;MACF,CAAC,EACD6B,QACF,CAAC;MACD,OAAOC,YAAY;IACrB,CAAC,EACDN,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,GACjC,aAAaf,SAAS,EAAE,GACxB,KAAK,CAAC,EACVgB,YACF,CAAC;EACH,CAAC,EACD,CAAC5B,OAAO,EAAEF,gBAAgB,EAAEc,SAAS,EAAEX,aAAa,EAAES,iBAAiB,CACzE,CAAC;EAED,MAAM0B,OAAO,GAAG5C,KAAK,CAAC6C,oBAAoB,CAAChB,SAAS,EAAEC,WAAW,CAAC;EAClE9B,KAAK,CAAC8C,SAAS,CAAC,MAAM;IACpB,IAAIF,OAAO,EAAE;MACX3B,kBAAkB,CAACE,OAAO,GAAGyB,OAAO;IACtC;EACF,CAAC,EAAE,CAACA,OAAO,CAAC,CAAC;EAEb,OAAO;IACLG,IAAI,EAAEH,OAAO,EAAEI,YAKZ;IACHC,SAAS,EAAEL,OAAO,EAAEM,MAAM,KAAK,SAAS,IAAK,CAACN,OAAO,IAAI,IAAK,IAAI,KAAK;IACvEO,KAAK,EAAEP,OAAO,IAAI,OAAO,IAAIA,OAAO,GAChCA,OAAO,CAACO,KAAK,GACbd,SAAS;IACbe,SAAS,EAAER,OAAO,EAAES,OAAO,GAAGT,OAAO,CAACQ,SAAS,GAAGf,SAAS;IAC3DiB,SAAS,EAAEV,OAAO,EAAEU,SAAS,IAA0BlD,aAAa;IACpEmD,UAAU,EAAEX,OAAO,EAAEW;EACvB,CAAC;AACH","ignoreList":[]}

package/build/esm/new/useOsdkAggregation.js.map

@@ -1 +1 @@
-{"version":3,"file":"useOsdkAggregation.js","names":["React","makeExternalStore","OsdkContext2","useOsdkAggregation","type","where","withProperties","aggregate","dedupeIntervalMs","observableClient","useContext","canonWhere","canonicalizeWhereClause","stableWithProperties","useMemo","JSON","stringify","stableAggregate","subscribe","getSnapShot","observer","observeAggregation","dedupeInterval","process","env","NODE_ENV","apiName","payload","useSyncExternalStore","error","status","Error","refetch","useCallback","invalidateObjectType","data","result","isLoading"],"sources":["useOsdkAggregation.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n  AggregateOpts,\n  AggregationsResults,\n  DerivedProperty,\n  ObjectOrInterfaceDefinition,\n  WhereClause,\n} from \"@osdk/api\";\nimport type { ObserveAggregationArgs } from \"@osdk/client/unstable-do-not-use\";\nimport React from \"react\";\nimport { makeExternalStore } from \"./makeExternalStore.js\";\nimport { OsdkContext2 } from \"./OsdkContext2.js\";\nimport type { InferRdpTypes } from \"./types.js\";\n\nexport interface UseOsdkAggregationOptions<\n  T extends ObjectOrInterfaceDefinition,\n  A extends AggregateOpts<T>,\n  WithProps extends DerivedProperty.Clause<T> | undefined = undefined,\n> {\n  /**\n   * Standard OSDK Where clause to filter objects before aggregation\n   */\n  where?: WhereClause<T, InferRdpTypes<T, WithProps>>;\n\n  /**\n   * Define derived properties (RDPs) to be computed server-side.\n   * The derived properties can be used in the where clause and aggregation groupBy/select.\n   */\n  withProperties?: WithProps;\n\n  /**\n   * Aggregation options including groupBy and select\n   */\n  aggregate: A;\n\n  /**\n   * The number of milliseconds to wait after the last observed aggregation change.\n   *\n   * Two uses of `useOsdkAggregation` with the same parameters will only trigger one\n   * network request if the second is within `dedupeIntervalMs`.\n   */\n  dedupeIntervalMs?: number;\n}\n\nexport interface UseOsdkAggregationResult<\n  T extends ObjectOrInterfaceDefinition,\n  A extends AggregateOpts<T>,\n> {\n  data: AggregationsResults<T, A> | undefined;\n  isLoading: boolean;\n  error: Error | undefined;\n  refetch: () => void;\n}\n\ndeclare const process: {\n  env: {\n    NODE_ENV: \"development\" | \"production\";\n  };\n};\n\n/**\n * React hook for performing aggregations on OSDK object sets.\n *\n * Executes server-side aggregations with groupBy and metric calculations on filtered object sets.\n * Supports runtime derived properties and where clauses.\n *\n * @param type - The object or interface type to aggregate\n * @param options - Aggregation configuration including where clause, aggregation spec, and optional derived properties\n * @returns Object containing aggregation results, loading state, error state, and refetch function\n *\n * @example\n * ```tsx\n * const { data, isLoading, error } = useOsdkAggregation(Employee, {\n *   where: { department: \"Engineering\" },\n *   aggregate: {\n *     groupBy: { department: \"exact\" },\n *     select: {\n *       avgSalary: { $avg: \"salary\" },\n *       count: { $count: {} }\n *     }\n *   }\n * });\n * ```\n */\nexport function useOsdkAggregation<\n  Q extends ObjectOrInterfaceDefinition,\n  const A extends AggregateOpts<Q>,\n  WP extends DerivedProperty.Clause<Q> | undefined = undefined,\n>(\n  type: Q,\n  {\n    where = {},\n    withProperties,\n    aggregate,\n    dedupeIntervalMs,\n  }: UseOsdkAggregationOptions<Q, A, WP>,\n): UseOsdkAggregationResult<Q, A> {\n  const { observableClient } = React.useContext(OsdkContext2);\n\n  const canonWhere = observableClient.canonicalizeWhereClause<Q>(where ?? {});\n\n  const stableWithProperties = React.useMemo(\n    () => withProperties,\n    [JSON.stringify(withProperties)],\n  );\n\n  const stableAggregate = React.useMemo(\n    () => aggregate,\n    [JSON.stringify(aggregate)],\n  );\n\n  const { subscribe, getSnapShot } = React.useMemo(\n    () =>\n      makeExternalStore<ObserveAggregationArgs<Q, A>>(\n        (observer) =>\n          observableClient.observeAggregation(\n            {\n              type: type,\n              where: canonWhere,\n              withProperties: stableWithProperties,\n              aggregate: stableAggregate,\n              dedupeInterval: dedupeIntervalMs ?? 2_000,\n            },\n            observer,\n          ),\n        process.env.NODE_ENV !== \"production\"\n          ? `aggregation ${type.apiName} ${JSON.stringify(canonWhere)}`\n          : void 0,\n      ),\n    [\n      observableClient,\n      type.apiName,\n      type.type,\n      canonWhere,\n      stableWithProperties,\n      stableAggregate,\n      dedupeIntervalMs,\n    ],\n  );\n\n  const payload = React.useSyncExternalStore(subscribe, getSnapShot);\n\n  let error: Error | undefined;\n  if (payload && \"error\" in payload && payload.error) {\n    error = payload.error;\n  } else if (payload?.status === \"error\") {\n    error = new Error(\"Failed to execute aggregation\");\n  }\n\n  const refetch = React.useCallback(async () => {\n    await observableClient.invalidateObjectType(type.apiName);\n  }, [observableClient, type.apiName]);\n\n  return {\n    data: payload?.result as AggregationsResults<Q, A> | undefined,\n    isLoading: payload?.status === \"loading\" || payload?.status === \"init\"\n      || !payload,\n    error,\n    refetch,\n  };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAUA,OAAOA,KAAK,MAAM,OAAO;AACzB,SAASC,iBAAiB,QAAQ,wBAAwB;AAC1D,SAASC,YAAY,QAAQ,mBAAmB;AAiDhD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,kBAAkBA,CAKhCC,IAAO,EACP;EACEC,KAAK,GAAG,CAAC,CAAC;EACVC,cAAc;EACdC,SAAS;EACTC;AACmC,CAAC,EACN;EAChC,MAAM;IAAEC;EAAiB,CAAC,GAAGT,KAAK,CAACU,UAAU,CAACR,YAAY,CAAC;EAE3D,MAAMS,UAAU,GAAGF,gBAAgB,CAACG,uBAAuB,CAAIP,KAAK,IAAI,CAAC,CAAC,CAAC;EAE3E,MAAMQ,oBAAoB,GAAGb,KAAK,CAACc,OAAO,CACxC,MAAMR,cAAc,EACpB,CAACS,IAAI,CAACC,SAAS,CAACV,cAAc,CAAC,CACjC,CAAC;EAED,MAAMW,eAAe,GAAGjB,KAAK,CAACc,OAAO,CACnC,MAAMP,SAAS,EACf,CAACQ,IAAI,CAACC,SAAS,CAACT,SAAS,CAAC,CAC5B,CAAC;EAED,MAAM;IAAEW,SAAS;IAAEC;EAAY,CAAC,GAAGnB,KAAK,CAACc,OAAO,CAC9C,MACEb,iBAAiB,CACdmB,QAAQ,IACPX,gBAAgB,CAACY,kBAAkB,CACjC;IACEjB,IAAI,EAAEA,IAAI;IACVC,KAAK,EAAEM,UAAU;IACjBL,cAAc,EAAEO,oBAAoB;IACpCN,SAAS,EAAEU,eAAe;IAC1BK,cAAc,EAAEd,gBAAgB,IAAI;EACtC,CAAC,EACDY,QACF,CAAC,EACHG,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,GACjC,eAAerB,IAAI,CAACsB,OAAO,IAAIX,IAAI,CAACC,SAAS,CAACL,UAAU,CAAC,EAAE,GAC3D,KAAK,CACX,CAAC,EACH,CACEF,gBAAgB,EAChBL,IAAI,CAACsB,OAAO,EACZtB,IAAI,CAACA,IAAI,EACTO,UAAU,EACVE,oBAAoB,EACpBI,eAAe,EACfT,gBAAgB,CAEpB,CAAC;EAED,MAAMmB,OAAO,GAAG3B,KAAK,CAAC4B,oBAAoB,CAACV,SAAS,EAAEC,WAAW,CAAC;EAElE,IAAIU,KAAwB;EAC5B,IAAIF,OAAO,IAAI,OAAO,IAAIA,OAAO,IAAIA,OAAO,CAACE,KAAK,EAAE;IAClDA,KAAK,GAAGF,OAAO,CAACE,KAAK;EACvB,CAAC,MAAM,IAAIF,OAAO,EAAEG,MAAM,KAAK,OAAO,EAAE;IACtCD,KAAK,GAAG,IAAIE,KAAK,CAAC,+BAA+B,CAAC;EACpD;EAEA,MAAMC,OAAO,GAAGhC,KAAK,CAACiC,WAAW,CAAC,YAAY;IAC5C,MAAMxB,gBAAgB,CAACyB,oBAAoB,CAAC9B,IAAI,CAACsB,OAAO,CAAC;EAC3D,CAAC,EAAE,CAACjB,gBAAgB,EAAEL,IAAI,CAACsB,OAAO,CAAC,CAAC;EAEpC,OAAO;IACLS,IAAI,EAAER,OAAO,EAAES,MAA+C;IAC9DC,SAAS,EAAEV,OAAO,EAAEG,MAAM,KAAK,SAAS,IAAIH,OAAO,EAAEG,MAAM,KAAK,MAAM,IACjE,CAACH,OAAO;IACbE,KAAK;IACLG;EACF,CAAC;AACH","ignoreList":[]}
+{"version":3,"file":"useOsdkAggregation.js","names":["React","makeExternalStore","OsdkContext2","useOsdkAggregation","type","where","withProperties","aggregate","dedupeIntervalMs","observableClient","useContext","canonWhere","canonicalizeWhereClause","stableWithProperties","useMemo","JSON","stringify","stableAggregate","subscribe","getSnapShot","observer","observeAggregation","dedupeInterval","process","env","NODE_ENV","apiName","payload","useSyncExternalStore","error","status","Error","refetch","useCallback","invalidateObjectType","data","result","isLoading"],"sources":["useOsdkAggregation.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n  AggregateOpts,\n  AggregationsResults,\n  DerivedProperty,\n  ObjectOrInterfaceDefinition,\n  SimplePropertyDef,\n  WhereClause,\n} from \"@osdk/api\";\nimport type { ObserveAggregationArgs } from \"@osdk/client/unstable-do-not-use\";\nimport React from \"react\";\nimport { makeExternalStore } from \"./makeExternalStore.js\";\nimport { OsdkContext2 } from \"./OsdkContext2.js\";\n\nexport interface UseOsdkAggregationOptions<\n  T extends ObjectOrInterfaceDefinition,\n  A extends AggregateOpts<T>,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> {\n  /**\n   * Standard OSDK Where clause to filter objects before aggregation\n   */\n  where?: WhereClause<T, RDPs>;\n\n  /**\n   * Define derived properties (RDPs) to be computed server-side.\n   * The derived properties can be used in the where clause and aggregation groupBy/select.\n   */\n  withProperties?: { [K in keyof RDPs]: DerivedProperty.Creator<T, RDPs[K]> };\n\n  /**\n   * Aggregation options including groupBy and select\n   */\n  aggregate: A;\n\n  /**\n   * The number of milliseconds to wait after the last observed aggregation change.\n   *\n   * Two uses of `useOsdkAggregation` with the same parameters will only trigger one\n   * network request if the second is within `dedupeIntervalMs`.\n   */\n  dedupeIntervalMs?: number;\n}\n\nexport interface UseOsdkAggregationResult<\n  T extends ObjectOrInterfaceDefinition,\n  A extends AggregateOpts<T>,\n> {\n  data: AggregationsResults<T, A> | undefined;\n  isLoading: boolean;\n  error: Error | undefined;\n  refetch: () => void;\n}\n\ndeclare const process: {\n  env: {\n    NODE_ENV: \"development\" | \"production\";\n  };\n};\n\n/**\n * React hook for performing aggregations on OSDK object sets.\n *\n * Executes server-side aggregations with groupBy and metric calculations on filtered object sets.\n * Supports runtime derived properties and where clauses.\n *\n * @param type - The object or interface type to aggregate\n * @param options - Aggregation configuration including where clause, aggregation spec, and optional derived properties\n * @returns Object containing aggregation results, loading state, error state, and refetch function\n *\n * @example\n * ```tsx\n * const { data, isLoading, error } = useOsdkAggregation(Employee, {\n *   where: { department: \"Engineering\" },\n *   aggregate: {\n *     groupBy: { department: \"exact\" },\n *     select: {\n *       avgSalary: { $avg: \"salary\" },\n *       count: { $count: {} }\n *     }\n *   }\n * });\n * ```\n */\nexport function useOsdkAggregation<\n  Q extends ObjectOrInterfaceDefinition,\n  const A extends AggregateOpts<Q>,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n>(\n  type: Q,\n  {\n    where = {},\n    withProperties,\n    aggregate,\n    dedupeIntervalMs,\n  }: UseOsdkAggregationOptions<Q, A, RDPs>,\n): UseOsdkAggregationResult<Q, A> {\n  const { observableClient } = React.useContext(OsdkContext2);\n\n  const canonWhere = observableClient.canonicalizeWhereClause<Q>(where ?? {});\n\n  const stableWithProperties = React.useMemo(\n    () => withProperties,\n    [JSON.stringify(withProperties)],\n  );\n\n  const stableAggregate = React.useMemo(\n    () => aggregate,\n    [JSON.stringify(aggregate)],\n  );\n\n  const { subscribe, getSnapShot } = React.useMemo(\n    () =>\n      makeExternalStore<ObserveAggregationArgs<Q, A>>(\n        (observer) =>\n          observableClient.observeAggregation(\n            {\n              type: type,\n              where: canonWhere,\n              withProperties: stableWithProperties,\n              aggregate: stableAggregate,\n              dedupeInterval: dedupeIntervalMs ?? 2_000,\n            },\n            observer,\n          ),\n        process.env.NODE_ENV !== \"production\"\n          ? `aggregation ${type.apiName} ${JSON.stringify(canonWhere)}`\n          : void 0,\n      ),\n    [\n      observableClient,\n      type.apiName,\n      type.type,\n      canonWhere,\n      stableWithProperties,\n      stableAggregate,\n      dedupeIntervalMs,\n    ],\n  );\n\n  const payload = React.useSyncExternalStore(subscribe, getSnapShot);\n\n  let error: Error | undefined;\n  if (payload && \"error\" in payload && payload.error) {\n    error = payload.error;\n  } else if (payload?.status === \"error\") {\n    error = new Error(\"Failed to execute aggregation\");\n  }\n\n  const refetch = React.useCallback(async () => {\n    await observableClient.invalidateObjectType(type.apiName);\n  }, [observableClient, type.apiName]);\n\n  return {\n    data: payload?.result as AggregationsResults<Q, A> | undefined,\n    isLoading: payload?.status === \"loading\" || payload?.status === \"init\"\n      || !payload,\n    error,\n    refetch,\n  };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAWA,OAAOA,KAAK,MAAM,OAAO;AACzB,SAASC,iBAAiB,QAAQ,wBAAwB;AAC1D,SAASC,YAAY,QAAQ,mBAAmB;AAgDhD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,kBAAkBA,CAKhCC,IAAO,EACP;EACEC,KAAK,GAAG,CAAC,CAAC;EACVC,cAAc;EACdC,SAAS;EACTC;AACqC,CAAC,EACR;EAChC,MAAM;IAAEC;EAAiB,CAAC,GAAGT,KAAK,CAACU,UAAU,CAACR,YAAY,CAAC;EAE3D,MAAMS,UAAU,GAAGF,gBAAgB,CAACG,uBAAuB,CAAIP,KAAK,IAAI,CAAC,CAAC,CAAC;EAE3E,MAAMQ,oBAAoB,GAAGb,KAAK,CAACc,OAAO,CACxC,MAAMR,cAAc,EACpB,CAACS,IAAI,CAACC,SAAS,CAACV,cAAc,CAAC,CACjC,CAAC;EAED,MAAMW,eAAe,GAAGjB,KAAK,CAACc,OAAO,CACnC,MAAMP,SAAS,EACf,CAACQ,IAAI,CAACC,SAAS,CAACT,SAAS,CAAC,CAC5B,CAAC;EAED,MAAM;IAAEW,SAAS;IAAEC;EAAY,CAAC,GAAGnB,KAAK,CAACc,OAAO,CAC9C,MACEb,iBAAiB,CACdmB,QAAQ,IACPX,gBAAgB,CAACY,kBAAkB,CACjC;IACEjB,IAAI,EAAEA,IAAI;IACVC,KAAK,EAAEM,UAAU;IACjBL,cAAc,EAAEO,oBAAoB;IACpCN,SAAS,EAAEU,eAAe;IAC1BK,cAAc,EAAEd,gBAAgB,IAAI;EACtC,CAAC,EACDY,QACF,CAAC,EACHG,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,GACjC,eAAerB,IAAI,CAACsB,OAAO,IAAIX,IAAI,CAACC,SAAS,CAACL,UAAU,CAAC,EAAE,GAC3D,KAAK,CACX,CAAC,EACH,CACEF,gBAAgB,EAChBL,IAAI,CAACsB,OAAO,EACZtB,IAAI,CAACA,IAAI,EACTO,UAAU,EACVE,oBAAoB,EACpBI,eAAe,EACfT,gBAAgB,CAEpB,CAAC;EAED,MAAMmB,OAAO,GAAG3B,KAAK,CAAC4B,oBAAoB,CAACV,SAAS,EAAEC,WAAW,CAAC;EAElE,IAAIU,KAAwB;EAC5B,IAAIF,OAAO,IAAI,OAAO,IAAIA,OAAO,IAAIA,OAAO,CAACE,KAAK,EAAE;IAClDA,KAAK,GAAGF,OAAO,CAACE,KAAK;EACvB,CAAC,MAAM,IAAIF,OAAO,EAAEG,MAAM,KAAK,OAAO,EAAE;IACtCD,KAAK,GAAG,IAAIE,KAAK,CAAC,+BAA+B,CAAC;EACpD;EAEA,MAAMC,OAAO,GAAGhC,KAAK,CAACiC,WAAW,CAAC,YAAY;IAC5C,MAAMxB,gBAAgB,CAACyB,oBAAoB,CAAC9B,IAAI,CAACsB,OAAO,CAAC;EAC3D,CAAC,EAAE,CAACjB,gBAAgB,EAAEL,IAAI,CAACsB,OAAO,CAAC,CAAC;EAEpC,OAAO;IACLS,IAAI,EAAER,OAAO,EAAES,MAA+C;IAC9DC,SAAS,EAAEV,OAAO,EAAEG,MAAM,KAAK,SAAS,IAAIH,OAAO,EAAEG,MAAM,KAAK,MAAM,IACjE,CAACH,OAAO;IACbE,KAAK;IACLG;EACF,CAAC;AACH","ignoreList":[]}

package/build/esm/new/useOsdkObjects.js

@@ -18,27 +18,24 @@ import React from "react";
 import { makeExternalStore } from "./makeExternalStore.js";
 import { OsdkContext2 } from "./OsdkContext2.js";
 export function useOsdkObjects(type, options) {
+  const {
+    observableClient
+  } = React.useContext(OsdkContext2);
   const {
     pageSize,
-    orderBy,
     dedupeIntervalMs,
-    where = {},
-    streamUpdates,
     withProperties,
+    enabled = true,
+    rids,
+    where,
+    orderBy,
+    streamUpdates,
     autoFetchMore,
     intersectWith,
-    pivotTo,
-    enabled = true
+    pivotTo
   } = options ?? {};
-  const {
-    observableClient
-  } = React.useContext(OsdkContext2);
-
-  /*  We want the canonical where clause so that the use of `React.useMemo`
-      is stable. No real added cost as we canonicalize internal to
-      the ObservableClient anyway.
-   */
   const canonWhere = observableClient.canonicalizeWhereClause(where ?? {});
+  const stableRids = React.useMemo(() => rids, [JSON.stringify(rids)]);
   const stableWithProperties = React.useMemo(() => withProperties, [JSON.stringify(withProperties)]);
   const stableIntersectWith = React.useMemo(() => intersectWith, [JSON.stringify(intersectWith)]);
   const stableOrderBy = React.useMemo(() => orderBy, [JSON.stringify(orderBy)]);
@@ -49,10 +46,11 @@ export function useOsdkObjects(type, options) {
     if (!enabled) {
       return makeExternalStore(() => ({
         unsubscribe: () => {}
-      }), process.env.NODE_ENV !== "production" ? `list ${type.apiName} ${JSON.stringify(canonWhere)} [DISABLED]` : void 0);
+      }), process.env.NODE_ENV !== "production" ? `list ${type.apiName} [DISABLED]` : void 0);
     }
     return makeExternalStore(observer => observableClient.observeList({
       type,
+      rids: stableRids,
       where: canonWhere,
       dedupeInterval: dedupeIntervalMs ?? 2_000,
       pageSize,
@@ -66,8 +64,8 @@ export function useOsdkObjects(type, options) {
       ...(pivotTo ? {
         pivotTo
       } : {})
-    }, observer), process.env.NODE_ENV !== "production" ? `list ${type.apiName} ${JSON.stringify(canonWhere)}` : void 0);
-  }, [enabled, observableClient, type, canonWhere, dedupeIntervalMs, pageSize, stableOrderBy, streamUpdates, stableWithProperties, autoFetchMore, stableIntersectWith, pivotTo]);
+    }, observer), process.env.NODE_ENV !== "production" ? `list ${type.apiName} ${stableRids ? `[${stableRids.length} rids]` : ""} ${JSON.stringify(canonWhere)}` : void 0);
+  }, [enabled, observableClient, type, stableRids, canonWhere, dedupeIntervalMs, pageSize, stableOrderBy, streamUpdates, stableWithProperties, autoFetchMore, stableIntersectWith, pivotTo]);
   const listPayload = React.useSyncExternalStore(subscribe, getSnapShot);
   let error;
   if (listPayload && "error" in listPayload && listPayload.error) {
@@ -80,7 +78,8 @@ export function useOsdkObjects(type, options) {
     error,
     data: listPayload?.resolvedList,
     isLoading: enabled ? listPayload?.status === "loading" || listPayload?.status === "init" || !listPayload : false,
-    isOptimistic: listPayload?.isOptimistic ?? false
+    isOptimistic: listPayload?.isOptimistic ?? false,
+    totalCount: listPayload?.totalCount
   };
 }
 //# sourceMappingURL=useOsdkObjects.js.map