@osdk/react 0.10.0-beta.1 → 0.10.0-beta.11

package/build/browser/new/useOsdkAggregation.js

@@ -14,9 +14,12 @@
  * limitations under the License.
  */
 
+import { computeObjectSetCacheKey } from "@osdk/client/unstable-do-not-use";
 import React from "react";
-import { makeExternalStore } from "./makeExternalStore.js";
+import { makeExternalStore, makeExternalStoreAsync } from "./makeExternalStore.js";
 import { OsdkContext2 } from "./OsdkContext2.js";
+const EMPTY_WHERE = {};
+
 /**
  * React hook for performing aggregations on OSDK object sets.
  *
@@ -29,6 +32,7 @@ import { OsdkContext2 } from "./OsdkContext2.js";
  *
  * @example
  * ```tsx
+ * // Basic aggregation without ObjectSet
  * const { data, isLoading, error } = useOsdkAggregation(Employee, {
  *   where: { department: "Engineering" },
  *   aggregate: {
@@ -39,45 +43,79 @@ import { OsdkContext2 } from "./OsdkContext2.js";
  *     }
  *   }
  * });
+ *
+ * // With a pivoted ObjectSet
+ * const pivotedSet = useMemo(() => $(Employee).pivotTo("primaryOffice"), []);
+ * const { data } = useOsdkAggregation(Office, {
+ *   objectSet: pivotedSet,
+ *   aggregate: { $select: { $count: "unordered" } }
+ * });
  * ```
  */
-export function useOsdkAggregation(type, {
-  where = {},
-  withProperties,
-  aggregate,
-  dedupeIntervalMs
-}) {
+
+export function useOsdkAggregation(type, options) {
+  const {
+    where = EMPTY_WHERE,
+    withProperties,
+    intersectWith,
+    aggregate,
+    dedupeIntervalMs
+  } = options;
+  const objectSet = "objectSet" in options ? options.objectSet : undefined;
   const {
     observableClient
   } = React.useContext(OsdkContext2);
-  const canonWhere = observableClient.canonicalizeWhereClause(where ?? {});
+  const canonWhere = observableClient.canonicalizeWhereClause(where);
+  const stableCanonWhere = React.useMemo(() => canonWhere, [JSON.stringify(canonWhere)]);
+  const objectSetRef = React.useRef(objectSet);
+  objectSetRef.current = objectSet;
+  const objectSetKeyString = objectSet ? computeObjectSetCacheKey(objectSet) : undefined;
   const stableWithProperties = React.useMemo(() => withProperties, [JSON.stringify(withProperties)]);
   const stableAggregate = React.useMemo(() => aggregate, [JSON.stringify(aggregate)]);
+  const stableIntersectWith = React.useMemo(() => intersectWith, [JSON.stringify(intersectWith)]);
   const {
     subscribe,
     getSnapShot
-  } = React.useMemo(() => makeExternalStore(observer => observableClient.observeAggregation({
-    type: type,
-    where: canonWhere,
-    withProperties: stableWithProperties,
-    aggregate: stableAggregate,
-    dedupeInterval: dedupeIntervalMs ?? 2_000
-  }, observer), process.env.NODE_ENV !== "production" ? `aggregation ${type.apiName} ${JSON.stringify(canonWhere)}` : void 0), [observableClient, type.apiName, type.type, canonWhere, stableWithProperties, stableAggregate, dedupeIntervalMs]);
+  } = React.useMemo(() => {
+    if (objectSetKeyString && objectSetRef.current) {
+      return makeExternalStoreAsync(observer => observableClient.observeAggregation({
+        type: type,
+        objectSet: objectSetRef.current,
+        where: stableCanonWhere,
+        withProperties: stableWithProperties,
+        intersectWith: stableIntersectWith,
+        aggregate: stableAggregate,
+        dedupeInterval: dedupeIntervalMs ?? 2_000
+      }, observer), process.env.NODE_ENV !== "production" ? `aggregation ${type.apiName} ${objectSetKeyString} ${JSON.stringify(stableCanonWhere)}` : void 0);
+    }
+    return makeExternalStore(observer =>
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
+    observableClient.observeAggregation({
+      type: type,
+      where: stableCanonWhere,
+      withProperties: stableWithProperties,
+      intersectWith: stableIntersectWith,
+      aggregate: stableAggregate,
+      dedupeInterval: dedupeIntervalMs ?? 2_000
+    }, observer), process.env.NODE_ENV !== "production" ? `aggregation ${type.apiName} ${JSON.stringify(stableCanonWhere)}` : void 0);
+  }, [observableClient, type.apiName, type.type, objectSetKeyString, stableCanonWhere, stableWithProperties, stableIntersectWith, stableAggregate, dedupeIntervalMs]);
   const payload = React.useSyncExternalStore(subscribe, getSnapShot);
-  let error;
-  if (payload && "error" in payload && payload.error) {
-    error = payload.error;
-  } else if (payload?.status === "error") {
-    error = new Error("Failed to execute aggregation");
-  }
   const refetch = React.useCallback(async () => {
     await observableClient.invalidateObjectType(type.apiName);
   }, [observableClient, type.apiName]);
-  return {
-    data: payload?.result,
-    isLoading: payload?.status === "loading" || payload?.status === "init" || !payload,
-    error,
-    refetch
-  };
+  return React.useMemo(() => {
+    let error;
+    if (payload && "error" in payload && payload.error) {
+      error = payload.error;
+    } else if (payload?.status === "error") {
+      error = new Error("Failed to execute aggregation");
+    }
+    return {
+      data: payload?.result,
+      isLoading: payload?.status === "loading" || payload?.status === "init" || !payload,
+      error,
+      refetch
+    };
+  }, [payload, refetch]);
 }
 //# sourceMappingURL=useOsdkAggregation.js.map

package/build/browser/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  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":[]}
+{"version":3,"file":"useOsdkAggregation.js","names":["computeObjectSetCacheKey","React","makeExternalStore","makeExternalStoreAsync","OsdkContext2","EMPTY_WHERE","useOsdkAggregation","type","options","where","withProperties","intersectWith","aggregate","dedupeIntervalMs","objectSet","undefined","observableClient","useContext","canonWhere","canonicalizeWhereClause","stableCanonWhere","useMemo","JSON","stringify","objectSetRef","useRef","current","objectSetKeyString","stableWithProperties","stableAggregate","stableIntersectWith","subscribe","getSnapShot","observer","observeAggregation","dedupeInterval","process","env","NODE_ENV","apiName","payload","useSyncExternalStore","refetch","useCallback","invalidateObjectType","error","status","Error","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  ObjectSet,\n  SimplePropertyDef,\n  WhereClause,\n} from \"@osdk/api\";\nimport type { ObjectTypeDefinition } from \"@osdk/client\";\nimport type { ObserveAggregationArgs } from \"@osdk/client/unstable-do-not-use\";\nimport { computeObjectSetCacheKey } from \"@osdk/client/unstable-do-not-use\";\nimport React from \"react\";\nimport {\n  makeExternalStore,\n  makeExternalStoreAsync,\n} from \"./makeExternalStore.js\";\nimport { OsdkContext2 } from \"./OsdkContext2.js\";\n\ninterface UseOsdkAggregationBaseOptions<\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   * Intersect the main query with additional filtered object sets.\n   * Each entry creates a separate object set with its own where clause,\n   * and the final result is the intersection of all sets.\n   */\n  intersectWith?: Array<{\n    where: WhereClause<T, RDPs>;\n  }>;\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 UseOsdkAggregationOptions<\n  T extends ObjectOrInterfaceDefinition,\n  A extends AggregateOpts<T>,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> extends UseOsdkAggregationBaseOptions<T, A, RDPs> {}\n\nexport interface UseOsdkAggregationOptionsWithObjectSet<\n  T extends ObjectTypeDefinition,\n  A extends AggregateOpts<T>,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> extends UseOsdkAggregationBaseOptions<T, A, RDPs> {\n  /**\n   * The ObjectSet to aggregate on. Enables aggregation on pivoted, filtered, or composed ObjectSets.\n   */\n  objectSet: ObjectSet<T>;\n}\n\nconst EMPTY_WHERE = {};\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 * // Basic aggregation without ObjectSet\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 * // With a pivoted ObjectSet\n * const pivotedSet = useMemo(() => $(Employee).pivotTo(\"primaryOffice\"), []);\n * const { data } = useOsdkAggregation(Office, {\n *   objectSet: pivotedSet,\n *   aggregate: { $select: { $count: \"unordered\" } }\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  options: UseOsdkAggregationOptions<Q, A, RDPs>,\n): UseOsdkAggregationResult<Q, A>;\nexport function useOsdkAggregation<\n  Q extends ObjectTypeDefinition,\n  const A extends AggregateOpts<Q>,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n>(\n  type: Q,\n  options: UseOsdkAggregationOptionsWithObjectSet<Q, A, RDPs>,\n): UseOsdkAggregationResult<Q, A>;\nexport function useOsdkAggregation<\n  Q extends ObjectTypeDefinition,\n  const A extends AggregateOpts<Q>,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n>(\n  type: Q,\n  options:\n    | UseOsdkAggregationOptions<Q, A, RDPs>\n    | UseOsdkAggregationOptionsWithObjectSet<Q, A, RDPs>,\n): UseOsdkAggregationResult<Q, A> {\n  const {\n    where = EMPTY_WHERE,\n    withProperties,\n    intersectWith,\n    aggregate,\n    dedupeIntervalMs,\n  } = options;\n  const objectSet = \"objectSet\" in options ? options.objectSet : undefined;\n\n  const { observableClient } = React.useContext(OsdkContext2);\n\n  const canonWhere = observableClient.canonicalizeWhereClause<Q>(where);\n\n  const stableCanonWhere = React.useMemo(\n    () => canonWhere,\n    [JSON.stringify(canonWhere)],\n  );\n\n  const objectSetRef = React.useRef(objectSet);\n  objectSetRef.current = objectSet;\n\n  const objectSetKeyString = objectSet\n    ? computeObjectSetCacheKey(objectSet)\n    : undefined;\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 stableIntersectWith = React.useMemo(\n    () => intersectWith,\n    [JSON.stringify(intersectWith)],\n  );\n\n  const { subscribe, getSnapShot } = React.useMemo(\n    () => {\n      if (objectSetKeyString && objectSetRef.current) {\n        return makeExternalStoreAsync<ObserveAggregationArgs<Q, A>>(\n          (observer) =>\n            observableClient.observeAggregation(\n              {\n                type: type,\n                objectSet: objectSetRef.current!,\n                where: stableCanonWhere,\n                withProperties: stableWithProperties,\n                intersectWith: stableIntersectWith,\n                aggregate: stableAggregate,\n                dedupeInterval: dedupeIntervalMs ?? 2_000,\n              },\n              observer,\n            ),\n          process.env.NODE_ENV !== \"production\"\n            ? `aggregation ${type.apiName} ${objectSetKeyString} ${\n              JSON.stringify(stableCanonWhere)\n            }`\n            : void 0,\n        );\n      }\n      return makeExternalStore<ObserveAggregationArgs<Q, A>>(\n        (observer) =>\n          // eslint-disable-next-line @typescript-eslint/no-deprecated\n          observableClient.observeAggregation(\n            {\n              type: type,\n              where: stableCanonWhere,\n              withProperties: stableWithProperties,\n              intersectWith: stableIntersectWith,\n              aggregate: stableAggregate,\n              dedupeInterval: dedupeIntervalMs ?? 2_000,\n            },\n            observer,\n          ),\n        process.env.NODE_ENV !== \"production\"\n          ? `aggregation ${type.apiName} ${JSON.stringify(stableCanonWhere)}`\n          : void 0,\n      );\n    },\n    [\n      observableClient,\n      type.apiName,\n      type.type,\n      objectSetKeyString,\n      stableCanonWhere,\n      stableWithProperties,\n      stableIntersectWith,\n      stableAggregate,\n      dedupeIntervalMs,\n    ],\n  );\n\n  const payload = React.useSyncExternalStore(subscribe, getSnapShot);\n\n  const refetch = React.useCallback(async () => {\n    await observableClient.invalidateObjectType(type.apiName);\n  }, [observableClient, type.apiName]);\n\n  return React.useMemo(() => {\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    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  }, [payload, refetch]);\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAaA,SAASA,wBAAwB,QAAQ,kCAAkC;AAC3E,OAAOC,KAAK,MAAM,OAAO;AACzB,SACEC,iBAAiB,EACjBC,sBAAsB,QACjB,wBAAwB;AAC/B,SAASC,YAAY,QAAQ,mBAAmB;AA0DhD,MAAMC,WAAW,GAAG,CAAC,CAAC;;AAkBtB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAiBA,OAAO,SAASC,kBAAkBA,CAKhCC,IAAO,EACPC,OAEsD,EACtB;EAChC,MAAM;IACJC,KAAK,GAAGJ,WAAW;IACnBK,cAAc;IACdC,aAAa;IACbC,SAAS;IACTC;EACF,CAAC,GAAGL,OAAO;EACX,MAAMM,SAAS,GAAG,WAAW,IAAIN,OAAO,GAAGA,OAAO,CAACM,SAAS,GAAGC,SAAS;EAExE,MAAM;IAAEC;EAAiB,CAAC,GAAGf,KAAK,CAACgB,UAAU,CAACb,YAAY,CAAC;EAE3D,MAAMc,UAAU,GAAGF,gBAAgB,CAACG,uBAAuB,CAAIV,KAAK,CAAC;EAErE,MAAMW,gBAAgB,GAAGnB,KAAK,CAACoB,OAAO,CACpC,MAAMH,UAAU,EAChB,CAACI,IAAI,CAACC,SAAS,CAACL,UAAU,CAAC,CAC7B,CAAC;EAED,MAAMM,YAAY,GAAGvB,KAAK,CAACwB,MAAM,CAACX,SAAS,CAAC;EAC5CU,YAAY,CAACE,OAAO,GAAGZ,SAAS;EAEhC,MAAMa,kBAAkB,GAAGb,SAAS,GAChCd,wBAAwB,CAACc,SAAS,CAAC,GACnCC,SAAS;EAEb,MAAMa,oBAAoB,GAAG3B,KAAK,CAACoB,OAAO,CACxC,MAAMX,cAAc,EACpB,CAACY,IAAI,CAACC,SAAS,CAACb,cAAc,CAAC,CACjC,CAAC;EAED,MAAMmB,eAAe,GAAG5B,KAAK,CAACoB,OAAO,CACnC,MAAMT,SAAS,EACf,CAACU,IAAI,CAACC,SAAS,CAACX,SAAS,CAAC,CAC5B,CAAC;EAED,MAAMkB,mBAAmB,GAAG7B,KAAK,CAACoB,OAAO,CACvC,MAAMV,aAAa,EACnB,CAACW,IAAI,CAACC,SAAS,CAACZ,aAAa,CAAC,CAChC,CAAC;EAED,MAAM;IAAEoB,SAAS;IAAEC;EAAY,CAAC,GAAG/B,KAAK,CAACoB,OAAO,CAC9C,MAAM;IACJ,IAAIM,kBAAkB,IAAIH,YAAY,CAACE,OAAO,EAAE;MAC9C,OAAOvB,sBAAsB,CAC1B8B,QAAQ,IACPjB,gBAAgB,CAACkB,kBAAkB,CACjC;QACE3B,IAAI,EAAEA,IAAI;QACVO,SAAS,EAAEU,YAAY,CAACE,OAAQ;QAChCjB,KAAK,EAAEW,gBAAgB;QACvBV,cAAc,EAAEkB,oBAAoB;QACpCjB,aAAa,EAAEmB,mBAAmB;QAClClB,SAAS,EAAEiB,eAAe;QAC1BM,cAAc,EAAEtB,gBAAgB,IAAI;MACtC,CAAC,EACDoB,QACF,CAAC,EACHG,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,GACjC,eAAe/B,IAAI,CAACgC,OAAO,IAAIZ,kBAAkB,IACjDL,IAAI,CAACC,SAAS,CAACH,gBAAgB,CAAC,EAChC,GACA,KAAK,CACX,CAAC;IACH;IACA,OAAOlB,iBAAiB,CACrB+B,QAAQ;IACP;IACAjB,gBAAgB,CAACkB,kBAAkB,CACjC;MACE3B,IAAI,EAAEA,IAAI;MACVE,KAAK,EAAEW,gBAAgB;MACvBV,cAAc,EAAEkB,oBAAoB;MACpCjB,aAAa,EAAEmB,mBAAmB;MAClClB,SAAS,EAAEiB,eAAe;MAC1BM,cAAc,EAAEtB,gBAAgB,IAAI;IACtC,CAAC,EACDoB,QACF,CAAC,EACHG,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,GACjC,eAAe/B,IAAI,CAACgC,OAAO,IAAIjB,IAAI,CAACC,SAAS,CAACH,gBAAgB,CAAC,EAAE,GACjE,KAAK,CACX,CAAC;EACH,CAAC,EACD,CACEJ,gBAAgB,EAChBT,IAAI,CAACgC,OAAO,EACZhC,IAAI,CAACA,IAAI,EACToB,kBAAkB,EAClBP,gBAAgB,EAChBQ,oBAAoB,EACpBE,mBAAmB,EACnBD,eAAe,EACfhB,gBAAgB,CAEpB,CAAC;EAED,MAAM2B,OAAO,GAAGvC,KAAK,CAACwC,oBAAoB,CAACV,SAAS,EAAEC,WAAW,CAAC;EAElE,MAAMU,OAAO,GAAGzC,KAAK,CAAC0C,WAAW,CAAC,YAAY;IAC5C,MAAM3B,gBAAgB,CAAC4B,oBAAoB,CAACrC,IAAI,CAACgC,OAAO,CAAC;EAC3D,CAAC,EAAE,CAACvB,gBAAgB,EAAET,IAAI,CAACgC,OAAO,CAAC,CAAC;EAEpC,OAAOtC,KAAK,CAACoB,OAAO,CAAC,MAAM;IACzB,IAAIwB,KAAwB;IAC5B,IAAIL,OAAO,IAAI,OAAO,IAAIA,OAAO,IAAIA,OAAO,CAACK,KAAK,EAAE;MAClDA,KAAK,GAAGL,OAAO,CAACK,KAAK;IACvB,CAAC,MAAM,IAAIL,OAAO,EAAEM,MAAM,KAAK,OAAO,EAAE;MACtCD,KAAK,GAAG,IAAIE,KAAK,CAAC,+BAA+B,CAAC;IACpD;IAEA,OAAO;MACLC,IAAI,EAAER,OAAO,EAAES,MAA+C;MAC9DC,SAAS,EAAEV,OAAO,EAAEM,MAAM,KAAK,SAAS,IAAIN,OAAO,EAAEM,MAAM,KAAK,MAAM,IACjE,CAACN,OAAO;MACbK,KAAK;MACLH;IACF,CAAC;EACH,CAAC,EAAE,CAACF,OAAO,EAAEE,OAAO,CAAC,CAAC;AACxB","ignoreList":[]}

package/build/browser/new/useOsdkFunction.js

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 
+import { getWireObjectSet } from "@osdk/client/unstable-do-not-use";
 import React from "react";
 import { makeExternalStore } from "./makeExternalStore.js";
 import { OsdkContext2 } from "./OsdkContext2.js";
@@ -63,10 +64,12 @@ export function useOsdkFunction(queryDef, options = {}) {
   } = options;
   const stableParams = React.useMemo(() => params, [JSON.stringify(params)]);
   const stableDependsOn = React.useMemo(() => dependsOn, [JSON.stringify(dependsOn?.map(d => typeof d === "string" ? d : d.apiName))]);
-  const stableDependsOnObjects = React.useMemo(() => dependsOnObjects, [JSON.stringify(dependsOnObjects?.map(o => ({
-    $apiName: o.$apiName,
-    $primaryKey: o.$primaryKey
-  })))]);
+  const stableDependsOnObjects = React.useMemo(() => dependsOnObjects, [JSON.stringify(dependsOnObjects?.map(item => "$apiName" in item ? {
+    $apiName: item.$apiName,
+    $primaryKey: item.$primaryKey
+  } : {
+    __objectSet: getWireObjectSet(item)
+  }))]);
 
   // Record<string, unknown> required as typing is figured out at runtime
   const paramsForApi = stableParams;
@@ -86,16 +89,18 @@ export function useOsdkFunction(queryDef, options = {}) {
     }, observer), process.env.NODE_ENV !== "production" ? `function ${queryDef.apiName} ${JSON.stringify(stableParams)}` : void 0);
   }, [observableClient, queryDef.apiName, queryDef.version, paramsForApi, stableDependsOn, stableDependsOnObjects, dedupeIntervalMs, enabled]);
   const payload = React.useSyncExternalStore(subscribe, getSnapShot);
-  const error = payload?.error ?? (payload?.status === "error" ? new Error("Failed to execute function") : undefined);
   const refetch = React.useCallback(() => {
     void observableClient.invalidateFunction(queryDef, paramsForApi);
   }, [observableClient, queryDef, paramsForApi]);
-  return {
-    data: payload?.result,
-    isLoading: payload?.status === "loading",
-    error,
-    lastUpdated: payload?.lastUpdated ?? 0,
-    refetch
-  };
+  return React.useMemo(() => {
+    const error = payload?.error ?? (payload?.status === "error" ? new Error("Failed to execute function") : undefined);
+    return {
+      data: payload?.result,
+      isLoading: payload?.status === "loading",
+      error,
+      lastUpdated: payload?.lastUpdated ?? 0,
+      refetch
+    };
+  }, [payload, refetch]);
 }
 //# sourceMappingURL=useOsdkFunction.js.map

package/build/browser/new/useOsdkFunction.js.map

@@ -1 +1 @@
-{"version":3,"file":"useOsdkFunction.js","names":["React","makeExternalStore","OsdkContext2","useOsdkFunction","queryDef","options","observableClient","useContext","params","dependsOn","dependsOnObjects","dedupeIntervalMs","enabled","stableParams","useMemo","JSON","stringify","stableDependsOn","map","d","apiName","stableDependsOnObjects","o","$apiName","$primaryKey","paramsForApi","subscribe","getSnapShot","unsubscribe","process","env","NODE_ENV","observer","observeFunction","dedupeInterval","version","payload","useSyncExternalStore","error","status","Error","undefined","refetch","useCallback","invalidateFunction","data","result","isLoading","lastUpdated"],"sources":["useOsdkFunction.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  CompileTimeMetadata,\n  ObjectTypeDefinition,\n  Osdk,\n  QueryDefinition,\n} from \"@osdk/api\";\nimport type {\n  ObserveFunctionCallbackArgs,\n  QueryParameterType,\n  QueryReturnType,\n} from \"@osdk/client/unstable-do-not-use\";\nimport React from \"react\";\nimport { makeExternalStore } from \"./makeExternalStore.js\";\nimport { OsdkContext2 } from \"./OsdkContext2.js\";\n\nexport interface UseOsdkFunctionOptions<Q extends QueryDefinition<unknown>> {\n  /**\n   * Parameters to pass to the function.\n   * Must include all required parameters; optional parameters can be omitted.\n   */\n  params?: CompileTimeMetadata<Q>[\"parameters\"] extends Record<string, never>\n    ? undefined\n    : QueryParameterType<CompileTimeMetadata<Q>[\"parameters\"]>;\n\n  /**\n   * Object types this function depends on.\n   * When actions modify objects of these types, the function will automatically refetch.\n   *\n   * @example\n   * ```tsx\n   * // Refetch when any Employee object changes\n   * { dependsOn: [Employee] }\n   * ```\n   */\n  dependsOn?: Array<ObjectTypeDefinition | string>;\n\n  /**\n   * Specific object instances this function depends on.\n   * When any of these specific objects change, the function will refetch.\n   * More fine-grained than dependsOn for precise invalidation control.\n   *\n   * @example\n   * ```tsx\n   * // Refetch when this specific employee changes\n   * { dependsOnObjects: [employee] }\n   * ```\n   */\n  dependsOnObjects?: Array<Osdk.Instance<ObjectTypeDefinition>>;\n\n  /**\n   * The number of milliseconds to dedupe identical function calls.\n   * Two calls with the same function and params will share results\n   * if the second call is within this interval of the first.\n   * @default 2000\n   */\n  dedupeIntervalMs?: number;\n\n  /**\n   * Whether to enable the query. When false, the query will not execute.\n   * Useful for:\n   * - Dependent queries that need to wait for other data\n   * - Conditional queries based on component state\n   *\n   * @default true\n   * @example\n   * // Dependent query - wait for required data\n   * const { data: employee } = useOsdkObject(Employee, employeeId);\n   * const { data: report } = useOsdkFunction(getEmployeeReport, {\n   *   params: { employeeId: employee?.$primaryKey },\n   *   enabled: !!employee\n   * });\n   */\n  enabled?: boolean;\n}\n\nexport interface UseOsdkFunctionResult<Q extends QueryDefinition<unknown>> {\n  /**\n   * The function result, or undefined if not yet loaded or on error.\n   */\n  data: QueryReturnType<CompileTimeMetadata<Q>[\"output\"]> | undefined;\n\n  /**\n   * True while the function is executing.\n   */\n  isLoading: boolean;\n\n  /**\n   * Error if the function execution failed.\n   */\n  error: Error | undefined;\n\n  /**\n   * Timestamp (ms since epoch) of when the result was last fetched.\n   */\n  lastUpdated: number;\n\n  /**\n   * Manually refetch the function.\n   * Useful for \"pull to refresh\" or retry patterns.\n   */\n  refetch: () => void;\n}\n\ndeclare const process: {\n  env: {\n    NODE_ENV: \"development\" | \"production\";\n  };\n};\n\n/**\n * React hook for executing and observing OSDK functions.\n *\n * Provides automatic caching, deduplication, and reactive updates for function calls.\n * Functions are automatically re-fetched when dependencies change (configured via options).\n *\n * @param queryDef - The QueryDefinition to execute\n * @param options - Configuration options for the function call\n * @returns Object containing result, loading state, error, and refetch function\n *\n * @example Basic usage\n * ```tsx\n * const { data, isLoading, error } = useOsdkFunction(getEmployeeStats, {\n *   params: { departmentId: \"engineering\" }\n * });\n * ```\n *\n * @example With dependency tracking\n * ```tsx\n * const { data, refetch } = useOsdkFunction(calculateMetrics, {\n *   params: { startDate, endDate },\n *   dependsOn: [Employee, Project],\n * });\n * ```\n *\n * @example With specific object dependencies\n * ```tsx\n * const { data } = useOsdkFunction(getEmployeeReport, {\n *   params: { employeeId: employee.$primaryKey },\n *   dependsOnObjects: [employee],\n * });\n * ```\n */\nexport function useOsdkFunction<Q extends QueryDefinition<unknown>>(\n  queryDef: Q,\n  options: UseOsdkFunctionOptions<Q> = {},\n): UseOsdkFunctionResult<Q> {\n  const { observableClient } = React.useContext(OsdkContext2);\n  const {\n    params,\n    dependsOn,\n    dependsOnObjects,\n    dedupeIntervalMs,\n    enabled = true,\n  } = options;\n\n  const stableParams = React.useMemo(\n    () => params,\n    [JSON.stringify(params)],\n  );\n  const stableDependsOn = React.useMemo(\n    () => dependsOn,\n    [JSON.stringify(\n      dependsOn?.map(d => typeof d === \"string\" ? d : d.apiName),\n    )],\n  );\n  const stableDependsOnObjects = React.useMemo(\n    () => dependsOnObjects,\n    [JSON.stringify(\n      dependsOnObjects?.map(o => ({\n        $apiName: o.$apiName,\n        $primaryKey: o.$primaryKey,\n      })),\n    )],\n  );\n\n  // Record<string, unknown> required as typing is figured out at runtime\n  const paramsForApi = stableParams as Record<string, unknown> | undefined;\n\n  const { subscribe, getSnapShot } = React.useMemo(\n    () => {\n      if (!enabled) {\n        return makeExternalStore<ObserveFunctionCallbackArgs<Q>>(\n          () => ({ unsubscribe: () => {} }),\n          process.env.NODE_ENV !== \"production\"\n            ? `function ${queryDef.apiName} ${\n              JSON.stringify(stableParams)\n            } [DISABLED]`\n            : void 0,\n        );\n      }\n      return makeExternalStore<ObserveFunctionCallbackArgs<Q>>(\n        (observer) =>\n          observableClient.observeFunction(\n            queryDef,\n            paramsForApi,\n            {\n              dependsOn: stableDependsOn,\n              dependsOnObjects: stableDependsOnObjects,\n              dedupeInterval: dedupeIntervalMs ?? 2_000,\n            },\n            observer,\n          ),\n        process.env.NODE_ENV !== \"production\"\n          ? `function ${queryDef.apiName} ${JSON.stringify(stableParams)}`\n          : void 0,\n      );\n    },\n    [\n      observableClient,\n      queryDef.apiName,\n      queryDef.version,\n      paramsForApi,\n      stableDependsOn,\n      stableDependsOnObjects,\n      dedupeIntervalMs,\n      enabled,\n    ],\n  );\n\n  const payload = React.useSyncExternalStore(subscribe, getSnapShot);\n\n  const error = payload?.error\n    ?? (payload?.status === \"error\"\n      ? new Error(\"Failed to execute function\")\n      : undefined);\n\n  const refetch = React.useCallback(() => {\n    void observableClient.invalidateFunction(queryDef, paramsForApi);\n  }, [observableClient, queryDef, paramsForApi]);\n\n  return {\n    data: payload?.result as\n      | QueryReturnType<CompileTimeMetadata<Q>[\"output\"]>\n      | undefined,\n    isLoading: payload?.status === \"loading\",\n    error,\n    lastUpdated: payload?.lastUpdated ?? 0,\n    refetch,\n  };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAaA,OAAOA,KAAK,MAAM,OAAO;AACzB,SAASC,iBAAiB,QAAQ,wBAAwB;AAC1D,SAASC,YAAY,QAAQ,mBAAmB;AAgGhD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;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,eAAeA,CAC7BC,QAAW,EACXC,OAAkC,GAAG,CAAC,CAAC,EACb;EAC1B,MAAM;IAAEC;EAAiB,CAAC,GAAGN,KAAK,CAACO,UAAU,CAACL,YAAY,CAAC;EAC3D,MAAM;IACJM,MAAM;IACNC,SAAS;IACTC,gBAAgB;IAChBC,gBAAgB;IAChBC,OAAO,GAAG;EACZ,CAAC,GAAGP,OAAO;EAEX,MAAMQ,YAAY,GAAGb,KAAK,CAACc,OAAO,CAChC,MAAMN,MAAM,EACZ,CAACO,IAAI,CAACC,SAAS,CAACR,MAAM,CAAC,CACzB,CAAC;EACD,MAAMS,eAAe,GAAGjB,KAAK,CAACc,OAAO,CACnC,MAAML,SAAS,EACf,CAACM,IAAI,CAACC,SAAS,CACbP,SAAS,EAAES,GAAG,CAACC,CAAC,IAAI,OAAOA,CAAC,KAAK,QAAQ,GAAGA,CAAC,GAAGA,CAAC,CAACC,OAAO,CAC3D,CAAC,CACH,CAAC;EACD,MAAMC,sBAAsB,GAAGrB,KAAK,CAACc,OAAO,CAC1C,MAAMJ,gBAAgB,EACtB,CAACK,IAAI,CAACC,SAAS,CACbN,gBAAgB,EAAEQ,GAAG,CAACI,CAAC,KAAK;IAC1BC,QAAQ,EAAED,CAAC,CAACC,QAAQ;IACpBC,WAAW,EAAEF,CAAC,CAACE;EACjB,CAAC,CAAC,CACJ,CAAC,CACH,CAAC;;EAED;EACA,MAAMC,YAAY,GAAGZ,YAAmD;EAExE,MAAM;IAAEa,SAAS;IAAEC;EAAY,CAAC,GAAG3B,KAAK,CAACc,OAAO,CAC9C,MAAM;IACJ,IAAI,CAACF,OAAO,EAAE;MACZ,OAAOX,iBAAiB,CACtB,OAAO;QAAE2B,WAAW,EAAEA,CAAA,KAAM,CAAC;MAAE,CAAC,CAAC,EACjCC,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,GACjC,YAAY3B,QAAQ,CAACgB,OAAO,IAC5BL,IAAI,CAACC,SAAS,CAACH,YAAY,CAAC,aACjB,GACX,KAAK,CACX,CAAC;IACH;IACA,OAAOZ,iBAAiB,CACrB+B,QAAQ,IACP1B,gBAAgB,CAAC2B,eAAe,CAC9B7B,QAAQ,EACRqB,YAAY,EACZ;MACEhB,SAAS,EAAEQ,eAAe;MAC1BP,gBAAgB,EAAEW,sBAAsB;MACxCa,cAAc,EAAEvB,gBAAgB,IAAI;IACtC,CAAC,EACDqB,QACF,CAAC,EACHH,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,GACjC,YAAY3B,QAAQ,CAACgB,OAAO,IAAIL,IAAI,CAACC,SAAS,CAACH,YAAY,CAAC,EAAE,GAC9D,KAAK,CACX,CAAC;EACH,CAAC,EACD,CACEP,gBAAgB,EAChBF,QAAQ,CAACgB,OAAO,EAChBhB,QAAQ,CAAC+B,OAAO,EAChBV,YAAY,EACZR,eAAe,EACfI,sBAAsB,EACtBV,gBAAgB,EAChBC,OAAO,CAEX,CAAC;EAED,MAAMwB,OAAO,GAAGpC,KAAK,CAACqC,oBAAoB,CAACX,SAAS,EAAEC,WAAW,CAAC;EAElE,MAAMW,KAAK,GAAGF,OAAO,EAAEE,KAAK,KACtBF,OAAO,EAAEG,MAAM,KAAK,OAAO,GAC3B,IAAIC,KAAK,CAAC,4BAA4B,CAAC,GACvCC,SAAS,CAAC;EAEhB,MAAMC,OAAO,GAAG1C,KAAK,CAAC2C,WAAW,CAAC,MAAM;IACtC,KAAKrC,gBAAgB,CAACsC,kBAAkB,CAACxC,QAAQ,EAAEqB,YAAY,CAAC;EAClE,CAAC,EAAE,CAACnB,gBAAgB,EAAEF,QAAQ,EAAEqB,YAAY,CAAC,CAAC;EAE9C,OAAO;IACLoB,IAAI,EAAET,OAAO,EAAEU,MAEF;IACbC,SAAS,EAAEX,OAAO,EAAEG,MAAM,KAAK,SAAS;IACxCD,KAAK;IACLU,WAAW,EAAEZ,OAAO,EAAEY,WAAW,IAAI,CAAC;IACtCN;EACF,CAAC;AACH","ignoreList":[]}
+{"version":3,"file":"useOsdkFunction.js","names":["getWireObjectSet","React","makeExternalStore","OsdkContext2","useOsdkFunction","queryDef","options","observableClient","useContext","params","dependsOn","dependsOnObjects","dedupeIntervalMs","enabled","stableParams","useMemo","JSON","stringify","stableDependsOn","map","d","apiName","stableDependsOnObjects","item","$apiName","$primaryKey","__objectSet","paramsForApi","subscribe","getSnapShot","unsubscribe","process","env","NODE_ENV","observer","observeFunction","dedupeInterval","version","payload","useSyncExternalStore","refetch","useCallback","invalidateFunction","error","status","Error","undefined","data","result","isLoading","lastUpdated"],"sources":["useOsdkFunction.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  CompileTimeMetadata,\n  ObjectSet,\n  ObjectTypeDefinition,\n  Osdk,\n  QueryDefinition,\n} from \"@osdk/api\";\nimport type {\n  ObserveFunctionCallbackArgs,\n  QueryParameterType,\n} from \"@osdk/client/unstable-do-not-use\";\nimport { getWireObjectSet } from \"@osdk/client/unstable-do-not-use\";\nimport React from \"react\";\nimport { makeExternalStore } from \"./makeExternalStore.js\";\nimport { OsdkContext2 } from \"./OsdkContext2.js\";\n\nexport interface UseOsdkFunctionOptions<Q extends QueryDefinition<unknown>> {\n  /**\n   * Parameters to pass to the function.\n   * Must include all required parameters; optional parameters can be omitted.\n   */\n  params?: CompileTimeMetadata<Q>[\"parameters\"] extends Record<string, never>\n    ? undefined\n    : QueryParameterType<CompileTimeMetadata<Q>[\"parameters\"]>;\n\n  /**\n   * Object types this function depends on.\n   * When actions modify objects of these types, the function will automatically refetch.\n   *\n   * @example\n   * ```tsx\n   * // Refetch when any Employee object changes\n   * { dependsOn: [Employee] }\n   * ```\n   */\n  dependsOn?: Array<ObjectTypeDefinition | string>;\n\n  /**\n   * Specific object instances or ObjectSets this function depends on.\n   * When any of these specific objects change, the function will refetch.\n   * More fine-grained than dependsOn for precise invalidation control.\n   *\n   * For ObjectSets, the object type is extracted asynchronously and changes\n   * to any object of that type will trigger a refetch.\n   *\n   * @example\n   * ```tsx\n   * // Refetch when this specific employee changes\n   * { dependsOnObjects: [employee] }\n   *\n   * // Refetch when any object in the ObjectSet's type changes\n   * { dependsOnObjects: [employeeObjectSet] }\n   * ```\n   */\n  dependsOnObjects?: Array<\n    Osdk.Instance<ObjectTypeDefinition> | ObjectSet<ObjectTypeDefinition>\n  >;\n\n  /**\n   * The number of milliseconds to dedupe identical function calls.\n   * Two calls with the same function and params will share results\n   * if the second call is within this interval of the first.\n   * @default 2000\n   */\n  dedupeIntervalMs?: number;\n\n  /**\n   * Whether to enable the query. When false, the query will not execute.\n   * Useful for:\n   * - Dependent queries that need to wait for other data\n   * - Conditional queries based on component state\n   *\n   * @default true\n   * @example\n   * // Dependent query - wait for required data\n   * const { data: employee } = useOsdkObject(Employee, employeeId);\n   * const { data: report } = useOsdkFunction(getEmployeeReport, {\n   *   params: { employeeId: employee?.$primaryKey },\n   *   enabled: !!employee\n   * });\n   */\n  enabled?: boolean;\n}\n\nexport interface UseOsdkFunctionResult<Q extends QueryDefinition<unknown>> {\n  /**\n   * The function result, or undefined if not yet loaded or on error.\n   */\n  data:\n    | (CompileTimeMetadata<Q>[\"signature\"] extends (...args: never[]) => infer R\n      ? Awaited<R>\n      : never)\n    | undefined;\n\n  /**\n   * True while the function is executing.\n   */\n  isLoading: boolean;\n\n  /**\n   * Error if the function execution failed.\n   */\n  error: Error | undefined;\n\n  /**\n   * Timestamp (ms since epoch) of when the result was last fetched.\n   */\n  lastUpdated: number;\n\n  /**\n   * Manually refetch the function.\n   * Useful for \"pull to refresh\" or retry patterns.\n   */\n  refetch: () => void;\n}\n\ndeclare const process: {\n  env: {\n    NODE_ENV: \"development\" | \"production\";\n  };\n};\n\n/**\n * React hook for executing and observing OSDK functions.\n *\n * Provides automatic caching, deduplication, and reactive updates for function calls.\n * Functions are automatically re-fetched when dependencies change (configured via options).\n *\n * @param queryDef - The QueryDefinition to execute\n * @param options - Configuration options for the function call\n * @returns Object containing result, loading state, error, and refetch function\n *\n * @example Basic usage\n * ```tsx\n * const { data, isLoading, error } = useOsdkFunction(getEmployeeStats, {\n *   params: { departmentId: \"engineering\" }\n * });\n * ```\n *\n * @example With dependency tracking\n * ```tsx\n * const { data, refetch } = useOsdkFunction(calculateMetrics, {\n *   params: { startDate, endDate },\n *   dependsOn: [Employee, Project],\n * });\n * ```\n *\n * @example With specific object dependencies\n * ```tsx\n * const { data } = useOsdkFunction(getEmployeeReport, {\n *   params: { employeeId: employee.$primaryKey },\n *   dependsOnObjects: [employee],\n * });\n * ```\n */\nexport function useOsdkFunction<Q extends QueryDefinition<unknown>>(\n  queryDef: Q,\n  options: UseOsdkFunctionOptions<Q> = {},\n): UseOsdkFunctionResult<Q> {\n  const { observableClient } = React.useContext(OsdkContext2);\n  const {\n    params,\n    dependsOn,\n    dependsOnObjects,\n    dedupeIntervalMs,\n    enabled = true,\n  } = options;\n\n  const stableParams = React.useMemo(\n    () => params,\n    [JSON.stringify(params)],\n  );\n  const stableDependsOn = React.useMemo(\n    () => dependsOn,\n    [JSON.stringify(\n      dependsOn?.map(d => typeof d === \"string\" ? d : d.apiName),\n    )],\n  );\n  const stableDependsOnObjects = React.useMemo(\n    () => dependsOnObjects,\n    [JSON.stringify(\n      dependsOnObjects?.map(item =>\n        \"$apiName\" in item\n          ? { $apiName: item.$apiName, $primaryKey: item.$primaryKey }\n          : { __objectSet: getWireObjectSet(item) }\n      ),\n    )],\n  );\n\n  // Record<string, unknown> required as typing is figured out at runtime\n  const paramsForApi = stableParams as Record<string, unknown> | undefined;\n\n  const { subscribe, getSnapShot } = React.useMemo(\n    () => {\n      if (!enabled) {\n        return makeExternalStore<ObserveFunctionCallbackArgs<Q>>(\n          () => ({ unsubscribe: () => {} }),\n          process.env.NODE_ENV !== \"production\"\n            ? `function ${queryDef.apiName} ${\n              JSON.stringify(stableParams)\n            } [DISABLED]`\n            : void 0,\n        );\n      }\n      return makeExternalStore<ObserveFunctionCallbackArgs<Q>>(\n        (observer) =>\n          observableClient.observeFunction(\n            queryDef,\n            paramsForApi,\n            {\n              dependsOn: stableDependsOn,\n              dependsOnObjects: stableDependsOnObjects,\n              dedupeInterval: dedupeIntervalMs ?? 2_000,\n            },\n            observer,\n          ),\n        process.env.NODE_ENV !== \"production\"\n          ? `function ${queryDef.apiName} ${JSON.stringify(stableParams)}`\n          : void 0,\n      );\n    },\n    [\n      observableClient,\n      queryDef.apiName,\n      queryDef.version,\n      paramsForApi,\n      stableDependsOn,\n      stableDependsOnObjects,\n      dedupeIntervalMs,\n      enabled,\n    ],\n  );\n\n  const payload = React.useSyncExternalStore(subscribe, getSnapShot);\n\n  const refetch = React.useCallback(() => {\n    void observableClient.invalidateFunction(queryDef, paramsForApi);\n  }, [observableClient, queryDef, paramsForApi]);\n\n  return React.useMemo(() => {\n    const error = payload?.error\n      ?? (payload?.status === \"error\"\n        ? new Error(\"Failed to execute function\")\n        : undefined);\n\n    return {\n      data: payload?.result as UseOsdkFunctionResult<Q>[\"data\"],\n      isLoading: payload?.status === \"loading\",\n      error,\n      lastUpdated: payload?.lastUpdated ?? 0,\n      refetch,\n    };\n  }, [payload, refetch]);\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAaA,SAASA,gBAAgB,QAAQ,kCAAkC;AACnE,OAAOC,KAAK,MAAM,OAAO;AACzB,SAASC,iBAAiB,QAAQ,wBAAwB;AAC1D,SAASC,YAAY,QAAQ,mBAAmB;AA4GhD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;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,eAAeA,CAC7BC,QAAW,EACXC,OAAkC,GAAG,CAAC,CAAC,EACb;EAC1B,MAAM;IAAEC;EAAiB,CAAC,GAAGN,KAAK,CAACO,UAAU,CAACL,YAAY,CAAC;EAC3D,MAAM;IACJM,MAAM;IACNC,SAAS;IACTC,gBAAgB;IAChBC,gBAAgB;IAChBC,OAAO,GAAG;EACZ,CAAC,GAAGP,OAAO;EAEX,MAAMQ,YAAY,GAAGb,KAAK,CAACc,OAAO,CAChC,MAAMN,MAAM,EACZ,CAACO,IAAI,CAACC,SAAS,CAACR,MAAM,CAAC,CACzB,CAAC;EACD,MAAMS,eAAe,GAAGjB,KAAK,CAACc,OAAO,CACnC,MAAML,SAAS,EACf,CAACM,IAAI,CAACC,SAAS,CACbP,SAAS,EAAES,GAAG,CAACC,CAAC,IAAI,OAAOA,CAAC,KAAK,QAAQ,GAAGA,CAAC,GAAGA,CAAC,CAACC,OAAO,CAC3D,CAAC,CACH,CAAC;EACD,MAAMC,sBAAsB,GAAGrB,KAAK,CAACc,OAAO,CAC1C,MAAMJ,gBAAgB,EACtB,CAACK,IAAI,CAACC,SAAS,CACbN,gBAAgB,EAAEQ,GAAG,CAACI,IAAI,IACxB,UAAU,IAAIA,IAAI,GACd;IAAEC,QAAQ,EAAED,IAAI,CAACC,QAAQ;IAAEC,WAAW,EAAEF,IAAI,CAACE;EAAY,CAAC,GAC1D;IAAEC,WAAW,EAAE1B,gBAAgB,CAACuB,IAAI;EAAE,CAC5C,CACF,CAAC,CACH,CAAC;;EAED;EACA,MAAMI,YAAY,GAAGb,YAAmD;EAExE,MAAM;IAAEc,SAAS;IAAEC;EAAY,CAAC,GAAG5B,KAAK,CAACc,OAAO,CAC9C,MAAM;IACJ,IAAI,CAACF,OAAO,EAAE;MACZ,OAAOX,iBAAiB,CACtB,OAAO;QAAE4B,WAAW,EAAEA,CAAA,KAAM,CAAC;MAAE,CAAC,CAAC,EACjCC,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,GACjC,YAAY5B,QAAQ,CAACgB,OAAO,IAC5BL,IAAI,CAACC,SAAS,CAACH,YAAY,CAAC,aACjB,GACX,KAAK,CACX,CAAC;IACH;IACA,OAAOZ,iBAAiB,CACrBgC,QAAQ,IACP3B,gBAAgB,CAAC4B,eAAe,CAC9B9B,QAAQ,EACRsB,YAAY,EACZ;MACEjB,SAAS,EAAEQ,eAAe;MAC1BP,gBAAgB,EAAEW,sBAAsB;MACxCc,cAAc,EAAExB,gBAAgB,IAAI;IACtC,CAAC,EACDsB,QACF,CAAC,EACHH,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,GACjC,YAAY5B,QAAQ,CAACgB,OAAO,IAAIL,IAAI,CAACC,SAAS,CAACH,YAAY,CAAC,EAAE,GAC9D,KAAK,CACX,CAAC;EACH,CAAC,EACD,CACEP,gBAAgB,EAChBF,QAAQ,CAACgB,OAAO,EAChBhB,QAAQ,CAACgC,OAAO,EAChBV,YAAY,EACZT,eAAe,EACfI,sBAAsB,EACtBV,gBAAgB,EAChBC,OAAO,CAEX,CAAC;EAED,MAAMyB,OAAO,GAAGrC,KAAK,CAACsC,oBAAoB,CAACX,SAAS,EAAEC,WAAW,CAAC;EAElE,MAAMW,OAAO,GAAGvC,KAAK,CAACwC,WAAW,CAAC,MAAM;IACtC,KAAKlC,gBAAgB,CAACmC,kBAAkB,CAACrC,QAAQ,EAAEsB,YAAY,CAAC;EAClE,CAAC,EAAE,CAACpB,gBAAgB,EAAEF,QAAQ,EAAEsB,YAAY,CAAC,CAAC;EAE9C,OAAO1B,KAAK,CAACc,OAAO,CAAC,MAAM;IACzB,MAAM4B,KAAK,GAAGL,OAAO,EAAEK,KAAK,KACtBL,OAAO,EAAEM,MAAM,KAAK,OAAO,GAC3B,IAAIC,KAAK,CAAC,4BAA4B,CAAC,GACvCC,SAAS,CAAC;IAEhB,OAAO;MACLC,IAAI,EAAET,OAAO,EAAEU,MAA0C;MACzDC,SAAS,EAAEX,OAAO,EAAEM,MAAM,KAAK,SAAS;MACxCD,KAAK;MACLO,WAAW,EAAEZ,OAAO,EAAEY,WAAW,IAAI,CAAC;MACtCV;IACF,CAAC;EACH,CAAC,EAAE,CAACF,OAAO,EAAEE,OAAO,CAAC,CAAC;AACxB","ignoreList":[]}

package/build/browser/new/useOsdkObject.js

@@ -24,13 +24,21 @@ import { OsdkContext2 } from "./OsdkContext2.js";
  */
 
 /**
- * Loads an object by type and primary key.
+ * Loads an object or interface instance by type and primary key.
  *
- * @param type
- * @param primaryKey
+ * @param type The object type or interface definition
+ * @param primaryKey The primary key of the object
  * @param enabled Enable or disable the query (defaults to true)
  */
 
+/**
+ * Loads an object or interface instance by type and primary key with options.
+ *
+ * @param type The object type or interface definition
+ * @param primaryKey The primary key of the object
+ * @param options Options including $select, enabled, and $loadPropertySecurityMetadata
+ */
+
 /*
     Implementation of useOsdkObject
  */
@@ -44,13 +52,18 @@ export function useOsdkObject(...args) {
   // so we must use type assertions after runtime discrimination
   const isInstanceSignature = "$objectType" in args[0];
 
-  // Extract enabled flag - 2nd param for instance signature, 3rd for type signature
-  const enabled = isInstanceSignature ? typeof args[1] === "boolean" ? args[1] : true : typeof args[2] === "boolean" ? args[2] : true;
+  // Extract options object if provided (3rd arg is an object with $select or enabled)
+  const optionsArg = !isInstanceSignature && args[2] != null && typeof args[2] === "object" ? args[2] : undefined;
 
-  // TODO: Figure out what the correct default behavior is for the various scenarios
+  // Extract enabled flag - 2nd param for instance signature, 3rd for type signature
+  const enabled = isInstanceSignature ? typeof args[1] === "boolean" ? args[1] : true : optionsArg ? optionsArg.enabled ?? true : typeof args[2] === "boolean" ? args[2] : true;
+  const selectArg = optionsArg?.$select;
+  const loadPropertySecurityMetadata = optionsArg?.$loadPropertySecurityMetadata;
   const mode = isInstanceSignature ? "offline" : undefined;
-  const objectType = isInstanceSignature ? args[0].$objectType : args[0].apiName;
+  const typeOrApiName = isInstanceSignature ? args[0].$objectType : args[0];
   const primaryKey = isInstanceSignature ? args[0].$primaryKey : args[1];
+  const apiNameString = typeof typeOrApiName === "string" ? typeOrApiName : typeOrApiName.apiName;
+  const stableSelect = React.useMemo(() => selectArg, [JSON.stringify(selectArg)]);
   const {
     subscribe,
     getSnapShot
@@ -58,27 +71,36 @@ export function useOsdkObject(...args) {
     if (!enabled) {
       return makeExternalStore(() => ({
         unsubscribe: () => {}
-      }), `object ${objectType} ${primaryKey} [DISABLED]`);
+      }), `object ${apiNameString} ${primaryKey} [DISABLED]`);
     }
-    return makeExternalStore(observer => observableClient.observeObject(objectType, primaryKey, {
-      mode
-    }, observer), `object ${objectType} ${primaryKey}`);
-  }, [enabled, observableClient, objectType, primaryKey, mode]);
+    return makeExternalStore(observer => observableClient.observeObject(typeOrApiName, primaryKey, {
+      mode,
+      ...(stableSelect ? {
+        select: stableSelect
+      } : {}),
+      ...(loadPropertySecurityMetadata ? {
+        $loadPropertySecurityMetadata: loadPropertySecurityMetadata
+      } : {})
+    }, observer), `object ${apiNameString} ${primaryKey}`);
+  }, [enabled, observableClient, typeOrApiName, apiNameString, primaryKey, mode, stableSelect, loadPropertySecurityMetadata]);
   const payload = React.useSyncExternalStore(subscribe, getSnapShot);
-  let error;
-  if (payload && "error" in payload && payload.error) {
-    error = payload.error;
-  } else if (payload?.status === "error") {
-    error = new Error("Failed to load object");
-  }
-  return {
-    object: payload?.object,
-    isLoading: enabled ? payload?.status === "loading" || payload?.status === "init" || !payload : false,
-    isOptimistic: !!payload?.isOptimistic,
-    error,
-    forceUpdate: () => {
-      throw new Error("not implemented");
+  const forceUpdate = React.useCallback(() => {
+    throw new Error("not implemented");
+  }, []);
+  return React.useMemo(() => {
+    let error;
+    if (payload && "error" in payload && payload.error) {
+      error = payload.error;
+    } else if (payload?.status === "error") {
+      error = new Error("Failed to load object");
     }
-  };
+    return {
+      object: payload?.object,
+      isLoading: enabled ? payload?.status === "loading" || payload?.status === "init" || !payload : false,
+      isOptimistic: !!payload?.isOptimistic,
+      error,
+      forceUpdate
+    };
+  }, [payload, enabled, forceUpdate]);
 }
 //# sourceMappingURL=useOsdkObject.js.map

package/build/browser/new/useOsdkObject.js.map

@@ -1 +1 @@
-{"version":3,"file":"useOsdkObject.js","names":["React","makeExternalStore","OsdkContext2","useOsdkObject","args","observableClient","useContext","isInstanceSignature","enabled","mode","undefined","objectType","$objectType","apiName","primaryKey","$primaryKey","subscribe","getSnapShot","useMemo","unsubscribe","observer","observeObject","payload","useSyncExternalStore","error","status","Error","object","isLoading","isOptimistic","forceUpdate"],"sources":["useOsdkObject.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 { ObjectTypeDefinition, Osdk, PrimaryKeyType } from \"@osdk/api\";\nimport type { ObserveObjectCallbackArgs } from \"@osdk/client/unstable-do-not-use\";\nimport React from \"react\";\nimport { makeExternalStore } from \"./makeExternalStore.js\";\nimport { OsdkContext2 } from \"./OsdkContext2.js\";\n\nexport interface UseOsdkObjectResult<Q extends ObjectTypeDefinition> {\n  object: Osdk.Instance<Q> | undefined;\n  isLoading: boolean;\n\n  error: Error | undefined;\n\n  /**\n   * Refers to whether the object is optimistic or not.\n   */\n  isOptimistic: boolean;\n  forceUpdate: () => void;\n}\n\n/**\n * @param obj an existing `Osdk.Instance` object to get metadata for.\n * @param enabled Enable or disable the query (defaults to true)\n */\nexport function useOsdkObject<Q extends ObjectTypeDefinition>(\n  obj: Osdk.Instance<Q>,\n  enabled?: boolean,\n): UseOsdkObjectResult<Q>;\n/**\n * Loads an object by type and primary key.\n *\n * @param type\n * @param primaryKey\n * @param enabled Enable or disable the query (defaults to true)\n */\nexport function useOsdkObject<Q extends ObjectTypeDefinition>(\n  type: Q,\n  primaryKey: PrimaryKeyType<Q>,\n  enabled?: boolean,\n): UseOsdkObjectResult<Q>;\n/*\n    Implementation of useOsdkObject\n */\nexport function useOsdkObject<Q extends ObjectTypeDefinition>(\n  ...args:\n    | [obj: Osdk.Instance<Q>, enabled?: boolean]\n    | [type: Q, primaryKey: PrimaryKeyType<Q>, enabled?: boolean]\n): UseOsdkObjectResult<Q> {\n  const { observableClient } = React.useContext(OsdkContext2);\n\n  // Check if first arg is an instance to discriminate signatures\n  // TypeScript cannot narrow rest parameter unions with optional parameters,\n  // so we must use type assertions after runtime discrimination\n  const isInstanceSignature = \"$objectType\" in args[0];\n\n  // Extract enabled flag - 2nd param for instance signature, 3rd for type signature\n  const enabled = isInstanceSignature\n    ? (typeof args[1] === \"boolean\" ? args[1] : true)\n    : (typeof args[2] === \"boolean\" ? args[2] : true);\n\n  // TODO: Figure out what the correct default behavior is for the various scenarios\n  const mode = isInstanceSignature ? \"offline\" : undefined;\n  const objectType = isInstanceSignature\n    ? (args[0] as Osdk.Instance<Q>).$objectType\n    : (args[0] as Q).apiName;\n  const primaryKey = isInstanceSignature\n    ? (args[0] as Osdk.Instance<Q>).$primaryKey\n    : (args[1] as PrimaryKeyType<Q>);\n\n  const { subscribe, getSnapShot } = React.useMemo(\n    () => {\n      if (!enabled) {\n        return makeExternalStore<ObserveObjectCallbackArgs<Q>>(\n          () => ({ unsubscribe: () => {} }),\n          `object ${objectType} ${primaryKey} [DISABLED]`,\n        );\n      }\n      return makeExternalStore<ObserveObjectCallbackArgs<Q>>(\n        (observer) =>\n          observableClient.observeObject(\n            objectType,\n            primaryKey,\n            {\n              mode,\n            },\n            observer,\n          ),\n        `object ${objectType} ${primaryKey}`,\n      );\n    },\n    [enabled, observableClient, objectType, primaryKey, mode],\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 load object\");\n  }\n\n  return {\n    object: payload?.object as Osdk.Instance<Q> | undefined,\n    isLoading: enabled\n      ? (payload?.status === \"loading\" || payload?.status === \"init\"\n        || !payload)\n      : false,\n    isOptimistic: !!payload?.isOptimistic,\n    error,\n    forceUpdate: () => {\n      throw new Error(\"not implemented\");\n    },\n  };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAIA,OAAOA,KAAK,MAAM,OAAO;AACzB,SAASC,iBAAiB,QAAQ,wBAAwB;AAC1D,SAASC,YAAY,QAAQ,mBAAmB;;AAehD;AACA;AACA;AACA;;AAKA;AACA;AACA;AACA;AACA;AACA;AACA;;AAMA;AACA;AACA;AACA,OAAO,SAASC,aAAaA,CAC3B,GAAGC,IAE4D,EACvC;EACxB,MAAM;IAAEC;EAAiB,CAAC,GAAGL,KAAK,CAACM,UAAU,CAACJ,YAAY,CAAC;;EAE3D;EACA;EACA;EACA,MAAMK,mBAAmB,GAAG,aAAa,IAAIH,IAAI,CAAC,CAAC,CAAC;;EAEpD;EACA,MAAMI,OAAO,GAAGD,mBAAmB,GAC9B,OAAOH,IAAI,CAAC,CAAC,CAAC,KAAK,SAAS,GAAGA,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,GAC7C,OAAOA,IAAI,CAAC,CAAC,CAAC,KAAK,SAAS,GAAGA,IAAI,CAAC,CAAC,CAAC,GAAG,IAAK;;EAEnD;EACA,MAAMK,IAAI,GAAGF,mBAAmB,GAAG,SAAS,GAAGG,SAAS;EACxD,MAAMC,UAAU,GAAGJ,mBAAmB,GACjCH,IAAI,CAAC,CAAC,CAAC,CAAsBQ,WAAW,GACxCR,IAAI,CAAC,CAAC,CAAC,CAAOS,OAAO;EAC1B,MAAMC,UAAU,GAAGP,mBAAmB,GACjCH,IAAI,CAAC,CAAC,CAAC,CAAsBW,WAAW,GACxCX,IAAI,CAAC,CAAC,CAAuB;EAElC,MAAM;IAAEY,SAAS;IAAEC;EAAY,CAAC,GAAGjB,KAAK,CAACkB,OAAO,CAC9C,MAAM;IACJ,IAAI,CAACV,OAAO,EAAE;MACZ,OAAOP,iBAAiB,CACtB,OAAO;QAAEkB,WAAW,EAAEA,CAAA,KAAM,CAAC;MAAE,CAAC,CAAC,EACjC,UAAUR,UAAU,IAAIG,UAAU,aACpC,CAAC;IACH;IACA,OAAOb,iBAAiB,CACrBmB,QAAQ,IACPf,gBAAgB,CAACgB,aAAa,CAC5BV,UAAU,EACVG,UAAU,EACV;MACEL;IACF,CAAC,EACDW,QACF,CAAC,EACH,UAAUT,UAAU,IAAIG,UAAU,EACpC,CAAC;EACH,CAAC,EACD,CAACN,OAAO,EAAEH,gBAAgB,EAAEM,UAAU,EAAEG,UAAU,EAAEL,IAAI,CAC1D,CAAC;EAED,MAAMa,OAAO,GAAGtB,KAAK,CAACuB,oBAAoB,CAACP,SAAS,EAAEC,WAAW,CAAC;EAElE,IAAIO,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,uBAAuB,CAAC;EAC5C;EAEA,OAAO;IACLC,MAAM,EAAEL,OAAO,EAAEK,MAAsC;IACvDC,SAAS,EAAEpB,OAAO,GACbc,OAAO,EAAEG,MAAM,KAAK,SAAS,IAAIH,OAAO,EAAEG,MAAM,KAAK,MAAM,IACzD,CAACH,OAAO,GACX,KAAK;IACTO,YAAY,EAAE,CAAC,CAACP,OAAO,EAAEO,YAAY;IACrCL,KAAK;IACLM,WAAW,EAAEA,CAAA,KAAM;MACjB,MAAM,IAAIJ,KAAK,CAAC,iBAAiB,CAAC;IACpC;EACF,CAAC;AACH","ignoreList":[]}
+{"version":3,"file":"useOsdkObject.js","names":["React","makeExternalStore","OsdkContext2","useOsdkObject","args","observableClient","useContext","isInstanceSignature","optionsArg","undefined","enabled","selectArg","$select","loadPropertySecurityMetadata","$loadPropertySecurityMetadata","mode","typeOrApiName","$objectType","primaryKey","$primaryKey","apiNameString","apiName","stableSelect","useMemo","JSON","stringify","subscribe","getSnapShot","unsubscribe","observer","observeObject","select","payload","useSyncExternalStore","forceUpdate","useCallback","Error","error","status","object","isLoading","isOptimistic"],"sources":["useOsdkObject.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  ObjectOrInterfaceDefinition,\n  Osdk,\n  PrimaryKeyType,\n  PropertyKeys,\n} from \"@osdk/api\";\nimport type { ObserveObjectCallbackArgs } from \"@osdk/client/unstable-do-not-use\";\nimport React from \"react\";\nimport { makeExternalStore } from \"./makeExternalStore.js\";\nimport { OsdkContext2 } from \"./OsdkContext2.js\";\n\nexport interface UseOsdkObjectResult<\n  Q extends ObjectOrInterfaceDefinition,\n> {\n  object: Osdk.Instance<Q> | undefined;\n  isLoading: boolean;\n\n  error: Error | undefined;\n\n  /**\n   * Refers to whether the object is optimistic or not.\n   */\n  isOptimistic: boolean;\n  forceUpdate: () => void;\n}\n\n/**\n * @param obj an existing `Osdk.Instance` object to get metadata for.\n * @param enabled Enable or disable the query (defaults to true)\n */\nexport function useOsdkObject<\n  Q extends ObjectOrInterfaceDefinition,\n>(\n  obj: Osdk.Instance<Q>,\n  enabled?: boolean,\n): UseOsdkObjectResult<Q>;\n/**\n * Loads an object or interface instance by type and primary key.\n *\n * @param type The object type or interface definition\n * @param primaryKey The primary key of the object\n * @param enabled Enable or disable the query (defaults to true)\n */\nexport function useOsdkObject<\n  Q extends ObjectOrInterfaceDefinition,\n>(\n  type: Q,\n  primaryKey: PrimaryKeyType<Q>,\n  enabled?: boolean,\n): UseOsdkObjectResult<Q>;\n/**\n * Loads an object or interface instance by type and primary key with options.\n *\n * @param type The object type or interface definition\n * @param primaryKey The primary key of the object\n * @param options Options including $select, enabled, and $loadPropertySecurityMetadata\n */\nexport function useOsdkObject<\n  Q extends ObjectOrInterfaceDefinition,\n>(\n  type: Q,\n  primaryKey: PrimaryKeyType<Q>,\n  options?: {\n    $select?: readonly PropertyKeys<Q>[];\n    enabled?: boolean;\n    $loadPropertySecurityMetadata?: boolean;\n  },\n): UseOsdkObjectResult<Q>;\n/*\n    Implementation of useOsdkObject\n */\nexport function useOsdkObject<\n  Q extends ObjectOrInterfaceDefinition,\n>(\n  ...args:\n    | [obj: Osdk.Instance<Q>, enabled?: boolean]\n    | [type: Q, primaryKey: PrimaryKeyType<Q>, enabled?: boolean]\n    | [\n      type: Q,\n      primaryKey: PrimaryKeyType<Q>,\n      options?: {\n        $select?: readonly PropertyKeys<Q>[];\n        enabled?: boolean;\n        $loadPropertySecurityMetadata?: boolean;\n      },\n    ]\n): UseOsdkObjectResult<Q> {\n  const { observableClient } = React.useContext(OsdkContext2);\n\n  // Check if first arg is an instance to discriminate signatures\n  // TypeScript cannot narrow rest parameter unions with optional parameters,\n  // so we must use type assertions after runtime discrimination\n  const isInstanceSignature = \"$objectType\" in args[0];\n\n  // Extract options object if provided (3rd arg is an object with $select or enabled)\n  const optionsArg = !isInstanceSignature\n      && args[2] != null\n      && typeof args[2] === \"object\"\n    ? args[2] as {\n      $select?: readonly string[];\n      enabled?: boolean;\n      $loadPropertySecurityMetadata?: boolean;\n    }\n    : undefined;\n\n  // Extract enabled flag - 2nd param for instance signature, 3rd for type signature\n  const enabled = isInstanceSignature\n    ? (typeof args[1] === \"boolean\" ? args[1] : true)\n    : optionsArg\n    ? (optionsArg.enabled ?? true)\n    : (typeof args[2] === \"boolean\" ? args[2] : true);\n\n  const selectArg = optionsArg?.$select;\n  const loadPropertySecurityMetadata = optionsArg\n    ?.$loadPropertySecurityMetadata;\n\n  const mode = isInstanceSignature ? \"offline\" : undefined;\n\n  const typeOrApiName = isInstanceSignature\n    ? (args[0] as Osdk.Instance<Q>).$objectType\n    : (args[0] as Q);\n\n  const primaryKey = isInstanceSignature\n    ? (args[0] as Osdk.Instance<Q>).$primaryKey\n    : (args[1] as PrimaryKeyType<Q>);\n\n  const apiNameString = typeof typeOrApiName === \"string\"\n    ? typeOrApiName\n    : typeOrApiName.apiName;\n\n  const stableSelect = React.useMemo(\n    () => selectArg,\n    [JSON.stringify(selectArg)],\n  );\n\n  const { subscribe, getSnapShot } = React.useMemo(\n    () => {\n      if (!enabled) {\n        return makeExternalStore<ObserveObjectCallbackArgs<Q>>(\n          () => ({ unsubscribe: () => {} }),\n          `object ${apiNameString} ${primaryKey} [DISABLED]`,\n        );\n      }\n      return makeExternalStore<ObserveObjectCallbackArgs<Q>>(\n        (observer) =>\n          observableClient.observeObject(\n            typeOrApiName,\n            primaryKey,\n            {\n              mode,\n              ...(stableSelect ? { select: stableSelect } : {}),\n              ...(loadPropertySecurityMetadata\n                ? {\n                  $loadPropertySecurityMetadata: loadPropertySecurityMetadata,\n                }\n                : {}),\n            },\n            observer,\n          ),\n        `object ${apiNameString} ${primaryKey}`,\n      );\n    },\n    [\n      enabled,\n      observableClient,\n      typeOrApiName,\n      apiNameString,\n      primaryKey,\n      mode,\n      stableSelect,\n      loadPropertySecurityMetadata,\n    ],\n  );\n\n  const payload = React.useSyncExternalStore(subscribe, getSnapShot);\n\n  const forceUpdate = React.useCallback(() => {\n    throw new Error(\"not implemented\");\n  }, []);\n\n  return React.useMemo(() => {\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 load object\");\n    }\n\n    return {\n      object: payload?.object as Osdk.Instance<Q> | undefined,\n      isLoading: enabled\n        ? (payload?.status === \"loading\" || payload?.status === \"init\"\n          || !payload)\n        : false,\n      isOptimistic: !!payload?.isOptimistic,\n      error,\n      forceUpdate,\n    };\n  }, [payload, enabled, forceUpdate]);\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;;AAiBhD;AACA;AACA;AACA;;AAOA;AACA;AACA;AACA;AACA;AACA;AACA;;AAQA;AACA;AACA;AACA;AACA;AACA;AACA;;AAYA;AACA;AACA;AACA,OAAO,SAASC,aAAaA,CAG3B,GAAGC,IAWA,EACqB;EACxB,MAAM;IAAEC;EAAiB,CAAC,GAAGL,KAAK,CAACM,UAAU,CAACJ,YAAY,CAAC;;EAE3D;EACA;EACA;EACA,MAAMK,mBAAmB,GAAG,aAAa,IAAIH,IAAI,CAAC,CAAC,CAAC;;EAEpD;EACA,MAAMI,UAAU,GAAG,CAACD,mBAAmB,IAChCH,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,IACf,OAAOA,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,GAC9BA,IAAI,CAAC,CAAC,CAAC,GAKPK,SAAS;;EAEb;EACA,MAAMC,OAAO,GAAGH,mBAAmB,GAC9B,OAAOH,IAAI,CAAC,CAAC,CAAC,KAAK,SAAS,GAAGA,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,GAC9CI,UAAU,GACTA,UAAU,CAACE,OAAO,IAAI,IAAI,GAC1B,OAAON,IAAI,CAAC,CAAC,CAAC,KAAK,SAAS,GAAGA,IAAI,CAAC,CAAC,CAAC,GAAG,IAAK;EAEnD,MAAMO,SAAS,GAAGH,UAAU,EAAEI,OAAO;EACrC,MAAMC,4BAA4B,GAAGL,UAAU,EAC3CM,6BAA6B;EAEjC,MAAMC,IAAI,GAAGR,mBAAmB,GAAG,SAAS,GAAGE,SAAS;EAExD,MAAMO,aAAa,GAAGT,mBAAmB,GACpCH,IAAI,CAAC,CAAC,CAAC,CAAsBa,WAAW,GACxCb,IAAI,CAAC,CAAC,CAAO;EAElB,MAAMc,UAAU,GAAGX,mBAAmB,GACjCH,IAAI,CAAC,CAAC,CAAC,CAAsBe,WAAW,GACxCf,IAAI,CAAC,CAAC,CAAuB;EAElC,MAAMgB,aAAa,GAAG,OAAOJ,aAAa,KAAK,QAAQ,GACnDA,aAAa,GACbA,aAAa,CAACK,OAAO;EAEzB,MAAMC,YAAY,GAAGtB,KAAK,CAACuB,OAAO,CAChC,MAAMZ,SAAS,EACf,CAACa,IAAI,CAACC,SAAS,CAACd,SAAS,CAAC,CAC5B,CAAC;EAED,MAAM;IAAEe,SAAS;IAAEC;EAAY,CAAC,GAAG3B,KAAK,CAACuB,OAAO,CAC9C,MAAM;IACJ,IAAI,CAACb,OAAO,EAAE;MACZ,OAAOT,iBAAiB,CACtB,OAAO;QAAE2B,WAAW,EAAEA,CAAA,KAAM,CAAC;MAAE,CAAC,CAAC,EACjC,UAAUR,aAAa,IAAIF,UAAU,aACvC,CAAC;IACH;IACA,OAAOjB,iBAAiB,CACrB4B,QAAQ,IACPxB,gBAAgB,CAACyB,aAAa,CAC5Bd,aAAa,EACbE,UAAU,EACV;MACEH,IAAI;MACJ,IAAIO,YAAY,GAAG;QAAES,MAAM,EAAET;MAAa,CAAC,GAAG,CAAC,CAAC,CAAC;MACjD,IAAIT,4BAA4B,GAC5B;QACAC,6BAA6B,EAAED;MACjC,CAAC,GACC,CAAC,CAAC;IACR,CAAC,EACDgB,QACF,CAAC,EACH,UAAUT,aAAa,IAAIF,UAAU,EACvC,CAAC;EACH,CAAC,EACD,CACER,OAAO,EACPL,gBAAgB,EAChBW,aAAa,EACbI,aAAa,EACbF,UAAU,EACVH,IAAI,EACJO,YAAY,EACZT,4BAA4B,CAEhC,CAAC;EAED,MAAMmB,OAAO,GAAGhC,KAAK,CAACiC,oBAAoB,CAACP,SAAS,EAAEC,WAAW,CAAC;EAElE,MAAMO,WAAW,GAAGlC,KAAK,CAACmC,WAAW,CAAC,MAAM;IAC1C,MAAM,IAAIC,KAAK,CAAC,iBAAiB,CAAC;EACpC,CAAC,EAAE,EAAE,CAAC;EAEN,OAAOpC,KAAK,CAACuB,OAAO,CAAC,MAAM;IACzB,IAAIc,KAAwB;IAC5B,IAAIL,OAAO,IAAI,OAAO,IAAIA,OAAO,IAAIA,OAAO,CAACK,KAAK,EAAE;MAClDA,KAAK,GAAGL,OAAO,CAACK,KAAK;IACvB,CAAC,MAAM,IAAIL,OAAO,EAAEM,MAAM,KAAK,OAAO,EAAE;MACtCD,KAAK,GAAG,IAAID,KAAK,CAAC,uBAAuB,CAAC;IAC5C;IAEA,OAAO;MACLG,MAAM,EAAEP,OAAO,EAAEO,MAAsC;MACvDC,SAAS,EAAE9B,OAAO,GACbsB,OAAO,EAAEM,MAAM,KAAK,SAAS,IAAIN,OAAO,EAAEM,MAAM,KAAK,MAAM,IACzD,CAACN,OAAO,GACX,KAAK;MACTS,YAAY,EAAE,CAAC,CAACT,OAAO,EAAES,YAAY;MACrCJ,KAAK;MACLH;IACF,CAAC;EACH,CAAC,EAAE,CAACF,OAAO,EAAEtB,OAAO,EAAEwB,WAAW,CAAC,CAAC;AACrC","ignoreList":[]}

package/build/browser/new/useOsdkObjects.js

@@ -17,6 +17,7 @@
 import React from "react";
 import { makeExternalStore } from "./makeExternalStore.js";
 import { OsdkContext2 } from "./OsdkContext2.js";
+const EMPTY_WHERE = {};
 export function useOsdkObjects(type, options) {
   const {
     observableClient
@@ -32,13 +33,17 @@ export function useOsdkObjects(type, options) {
     streamUpdates,
     autoFetchMore,
     intersectWith,
-    pivotTo
+    pivotTo,
+    $select,
+    $loadPropertySecurityMetadata
   } = options ?? {};
-  const canonWhere = observableClient.canonicalizeWhereClause(where ?? {});
+  const canonWhere = observableClient.canonicalizeWhereClause(where ?? EMPTY_WHERE);
+  const stableCanonWhere = React.useMemo(() => canonWhere, [JSON.stringify(canonWhere)]);
   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)]);
+  const stableSelect = React.useMemo(() => $select, [JSON.stringify($select)]);
   const {
     subscribe,
     getSnapShot
@@ -51,7 +56,7 @@ export function useOsdkObjects(type, options) {
     return makeExternalStore(observer => observableClient.observeList({
       type,
       rids: stableRids,
-      where: canonWhere,
+      where: stableCanonWhere,
       dedupeInterval: dedupeIntervalMs ?? 2_000,
       pageSize,
       orderBy: stableOrderBy,
@@ -63,23 +68,31 @@ export function useOsdkObjects(type, options) {
       } : {}),
       ...(pivotTo ? {
         pivotTo
+      } : {}),
+      ...(stableSelect ? {
+        select: stableSelect
+      } : {}),
+      ...($loadPropertySecurityMetadata ? {
+        $loadPropertySecurityMetadata
       } : {})
-    }, 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]);
+    }, observer), process.env.NODE_ENV !== "production" ? `list ${type.apiName} ${stableRids ? `[${stableRids.length} rids]` : ""} ${JSON.stringify(stableCanonWhere)}` : void 0);
+  }, [enabled, observableClient, type.apiName, type.type, stableRids, stableCanonWhere, dedupeIntervalMs, pageSize, stableOrderBy, streamUpdates, stableWithProperties, autoFetchMore, stableIntersectWith, pivotTo, stableSelect, $loadPropertySecurityMetadata]);
   const listPayload = React.useSyncExternalStore(subscribe, getSnapShot);
-  let error;
-  if (listPayload && "error" in listPayload && listPayload.error) {
-    error = listPayload.error;
-  } else if (listPayload?.status === "error") {
-    error = new Error("Failed to load objects");
-  }
-  return {
-    fetchMore: listPayload?.hasMore ? listPayload.fetchMore : undefined,
-    error,
-    data: listPayload?.resolvedList,
-    isLoading: enabled ? listPayload?.status === "loading" || listPayload?.status === "init" || !listPayload : false,
-    isOptimistic: listPayload?.isOptimistic ?? false,
-    totalCount: listPayload?.totalCount
-  };
+  return React.useMemo(() => {
+    let error;
+    if (listPayload && "error" in listPayload && listPayload.error) {
+      error = listPayload.error;
+    } else if (listPayload?.status === "error") {
+      error = new Error("Failed to load objects");
+    }
+    return {
+      fetchMore: listPayload?.hasMore ? listPayload.fetchMore : undefined,
+      error,
+      data: listPayload?.resolvedList,
+      isLoading: enabled ? listPayload?.status === "loading" || listPayload?.status === "init" || !listPayload : false,
+      isOptimistic: listPayload?.isOptimistic ?? false,
+      totalCount: listPayload?.totalCount
+    };
+  }, [listPayload, enabled]);
 }
 //# sourceMappingURL=useOsdkObjects.js.map

package/build/browser/new/useOsdkObjects.js.map

@@ -1 +1 @@
-{"version":3,"file":"useOsdkObjects.js","names":["React","makeExternalStore","OsdkContext2","useOsdkObjects","type","options","observableClient","useContext","pageSize","dedupeIntervalMs","withProperties","enabled","rids","where","orderBy","streamUpdates","autoFetchMore","intersectWith","pivotTo","canonWhere","canonicalizeWhereClause","stableRids","useMemo","JSON","stringify","stableWithProperties","stableIntersectWith","stableOrderBy","subscribe","getSnapShot","unsubscribe","process","env","NODE_ENV","apiName","observer","observeList","dedupeInterval","length","listPayload","useSyncExternalStore","error","status","Error","fetchMore","hasMore","undefined","data","resolvedList","isLoading","isOptimistic","totalCount"],"sources":["useOsdkObjects.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  DerivedProperty,\n  LinkedType,\n  LinkNames,\n  ObjectOrInterfaceDefinition,\n  Osdk,\n  PropertyKeys,\n  SimplePropertyDef,\n  WhereClause,\n} from \"@osdk/api\";\nimport type { ObserveObjectsCallbackArgs } from \"@osdk/client/unstable-do-not-use\";\nimport React from \"react\";\nimport { makeExternalStore } from \"./makeExternalStore.js\";\nimport { OsdkContext2 } from \"./OsdkContext2.js\";\n\nexport interface UseOsdkObjectsOptions<\n  T extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> {\n  /**\n   * Fetch objects by their RIDs (Resource Identifiers).\n   * When provided, starts with a static objectset containing these RIDs.\n   * Can be combined with `where` to filter the RID set, and with `orderBy` to sort results.\n   *\n   * @example\n   * // Fetch specific objects by RID\n   * useOsdkObjects(Employee, { rids: ['ri.foo.123', 'ri.foo.456'] })\n   *\n   * @example\n   * // Fetch specific objects by RID, filtered by status\n   * useOsdkObjects(Employee, {\n   *   rids: ['ri.foo.123', 'ri.foo.456', 'ri.foo.789'],\n   *   where: { status: 'active' }\n   * })\n   */\n  rids?: readonly string[];\n\n  /**\n   * Standard OSDK Where clause with RDP support.\n   * When used with `rids`, filters the RID set.\n   * When used alone, filters all objects of the type.\n   */\n  where?: WhereClause<T, RDPs>;\n\n  /**\n   * Sort results by one or more properties.\n   */\n  orderBy?: {\n    [K in PropertyKeys<T>]?: \"asc\" | \"desc\";\n  };\n\n  /**\n   * The preferred page size for the list.\n   */\n  pageSize?: number;\n\n  /**\n   * Define derived properties (RDPs) to be computed server-side and attached to each object.\n   * These properties will be available on the returned objects alongside their regular properties.\n   */\n  withProperties?: { [K in keyof RDPs]: DerivedProperty.Creator<T, RDPs[K]> };\n\n  /**\n   * The number of milliseconds to wait after the last observed list change.\n   *\n   * Two uses of `useOsdkObjects` with the same parameters will only trigger one\n   * network request if the second is within `dedupeIntervalMs`.\n   */\n  dedupeIntervalMs?: number;\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   * @default true\n   */\n  enabled?: boolean;\n\n  /**\n   * Intersect the results with additional object sets.\n   * Each element defines a where clause for an object set to intersect with.\n   * The final result will only include objects that match ALL conditions.\n   */\n  intersectWith?: Array<{\n    where: WhereClause<T, RDPs>;\n  }>;\n\n  /**\n   * Pivot to related objects through a link.\n   * This changes the return type from T to the linked object type.\n   */\n  pivotTo?: LinkNames<T>;\n\n  /**\n   * Causes the list to automatically fetch more as soon as the previous page\n   * has been loaded. If a number is provided, it will continue to automatically\n   * fetch more until the list is at least that long.\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  streamUpdates?: boolean;\n}\n\nexport interface UseOsdkListResult<\n  T extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> {\n  /**\n   * Function to fetch more pages (undefined if no more pages)\n   */\n  fetchMore: (() => Promise<void>) | undefined;\n\n  /**\n   * The fetched data with derived properties\n   */\n  data:\n    | Osdk.Instance<T, \"$allBaseProperties\", PropertyKeys<T>, 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   * Refers to whether the ordered list of objects (only considering the $primaryKey)\n   * is optimistic or not.\n   *\n   * If you need to know if the contents of the list are optimistic you can\n   * do that on a per object basis with useOsdkObject\n   */\n  isOptimistic: boolean;\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\nexport function useOsdkObjects<\n  Q extends ObjectOrInterfaceDefinition,\n  L extends LinkNames<Q>,\n>(\n  type: Q,\n  options: UseOsdkObjectsOptions<Q> & { pivotTo: L },\n): UseOsdkListResult<LinkedType<Q, L>>;\n\nexport function useOsdkObjects<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n>(\n  type: Q,\n  options?: UseOsdkObjectsOptions<Q, RDPs>,\n): UseOsdkListResult<Q, RDPs>;\n\nexport function useOsdkObjects<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n>(\n  type: Q,\n  options?: UseOsdkObjectsOptions<Q, RDPs>,\n):\n  | UseOsdkListResult<Q, RDPs>\n  | UseOsdkListResult<LinkedType<Q, LinkNames<Q>>>\n{\n  const { observableClient } = React.useContext(OsdkContext2);\n\n  const {\n    pageSize,\n    dedupeIntervalMs,\n    withProperties,\n    enabled = true,\n    rids,\n    where,\n    orderBy,\n    streamUpdates,\n    autoFetchMore,\n    intersectWith,\n    pivotTo,\n  } = options ?? {};\n\n  const canonWhere = observableClient.canonicalizeWhereClause<\n    Q,\n    RDPs\n  >(where ?? {});\n\n  const stableRids = React.useMemo(\n    () => rids,\n    [JSON.stringify(rids)],\n  );\n\n  const stableWithProperties = React.useMemo(\n    () => withProperties,\n    [JSON.stringify(withProperties)],\n  );\n\n  const stableIntersectWith = React.useMemo(\n    () => intersectWith,\n    [JSON.stringify(intersectWith)],\n  );\n\n  const stableOrderBy = React.useMemo(\n    () => orderBy,\n    [JSON.stringify(orderBy)],\n  );\n\n  const { subscribe, getSnapShot } = React.useMemo(\n    () => {\n      if (!enabled) {\n        return makeExternalStore<\n          ObserveObjectsCallbackArgs<Q, RDPs>\n        >(\n          () => ({ unsubscribe: () => {} }),\n          process.env.NODE_ENV !== \"production\"\n            ? `list ${type.apiName} [DISABLED]`\n            : void 0,\n        );\n      }\n\n      return makeExternalStore<\n        ObserveObjectsCallbackArgs<Q, RDPs>\n      >(\n        (observer) =>\n          observableClient.observeList({\n            type,\n            rids: stableRids,\n            where: canonWhere,\n            dedupeInterval: dedupeIntervalMs ?? 2_000,\n            pageSize,\n            orderBy: stableOrderBy,\n            streamUpdates,\n            withProperties: stableWithProperties,\n            autoFetchMore,\n            ...(stableIntersectWith\n              ? { intersectWith: stableIntersectWith }\n              : {}),\n            ...(pivotTo ? { pivotTo } : {}),\n          }, observer),\n        process.env.NODE_ENV !== \"production\"\n          ? `list ${type.apiName} ${\n            stableRids ? `[${stableRids.length} rids]` : \"\"\n          } ${JSON.stringify(canonWhere)}`\n          : void 0,\n      );\n    },\n    [\n      enabled,\n      observableClient,\n      type,\n      stableRids,\n      canonWhere,\n      dedupeIntervalMs,\n      pageSize,\n      stableOrderBy,\n      streamUpdates,\n      stableWithProperties,\n      autoFetchMore,\n      stableIntersectWith,\n      pivotTo,\n    ],\n  );\n\n  const listPayload = React.useSyncExternalStore(subscribe, getSnapShot);\n\n  let error: Error | undefined;\n  if (listPayload && \"error\" in listPayload && listPayload.error) {\n    error = listPayload.error;\n  } else if (listPayload?.status === \"error\") {\n    error = new Error(\"Failed to load objects\");\n  }\n\n  return {\n    fetchMore: listPayload?.hasMore ? listPayload.fetchMore : undefined,\n    error,\n    data: listPayload?.resolvedList,\n    isLoading: enabled\n      ? (listPayload?.status === \"loading\" || listPayload?.status === \"init\"\n        || !listPayload)\n      : false,\n    isOptimistic: listPayload?.isOptimistic ?? false,\n    totalCount: listPayload?.totalCount,\n  };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAaA,OAAOA,KAAK,MAAM,OAAO;AACzB,SAASC,iBAAiB,QAAQ,wBAAwB;AAC1D,SAASC,YAAY,QAAQ,mBAAmB;AA+JhD,OAAO,SAASC,cAAcA,CAI5BC,IAAO,EACPC,OAAwC,EAI1C;EACE,MAAM;IAAEC;EAAiB,CAAC,GAAGN,KAAK,CAACO,UAAU,CAACL,YAAY,CAAC;EAE3D,MAAM;IACJM,QAAQ;IACRC,gBAAgB;IAChBC,cAAc;IACdC,OAAO,GAAG,IAAI;IACdC,IAAI;IACJC,KAAK;IACLC,OAAO;IACPC,aAAa;IACbC,aAAa;IACbC,aAAa;IACbC;EACF,CAAC,GAAGb,OAAO,IAAI,CAAC,CAAC;EAEjB,MAAMc,UAAU,GAAGb,gBAAgB,CAACc,uBAAuB,CAGzDP,KAAK,IAAI,CAAC,CAAC,CAAC;EAEd,MAAMQ,UAAU,GAAGrB,KAAK,CAACsB,OAAO,CAC9B,MAAMV,IAAI,EACV,CAACW,IAAI,CAACC,SAAS,CAACZ,IAAI,CAAC,CACvB,CAAC;EAED,MAAMa,oBAAoB,GAAGzB,KAAK,CAACsB,OAAO,CACxC,MAAMZ,cAAc,EACpB,CAACa,IAAI,CAACC,SAAS,CAACd,cAAc,CAAC,CACjC,CAAC;EAED,MAAMgB,mBAAmB,GAAG1B,KAAK,CAACsB,OAAO,CACvC,MAAML,aAAa,EACnB,CAACM,IAAI,CAACC,SAAS,CAACP,aAAa,CAAC,CAChC,CAAC;EAED,MAAMU,aAAa,GAAG3B,KAAK,CAACsB,OAAO,CACjC,MAAMR,OAAO,EACb,CAACS,IAAI,CAACC,SAAS,CAACV,OAAO,CAAC,CAC1B,CAAC;EAED,MAAM;IAAEc,SAAS;IAAEC;EAAY,CAAC,GAAG7B,KAAK,CAACsB,OAAO,CAC9C,MAAM;IACJ,IAAI,CAACX,OAAO,EAAE;MACZ,OAAOV,iBAAiB,CAGtB,OAAO;QAAE6B,WAAW,EAAEA,CAAA,KAAM,CAAC;MAAE,CAAC,CAAC,EACjCC,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,GACjC,QAAQ7B,IAAI,CAAC8B,OAAO,aAAa,GACjC,KAAK,CACX,CAAC;IACH;IAEA,OAAOjC,iBAAiB,CAGrBkC,QAAQ,IACP7B,gBAAgB,CAAC8B,WAAW,CAAC;MAC3BhC,IAAI;MACJQ,IAAI,EAAES,UAAU;MAChBR,KAAK,EAAEM,UAAU;MACjBkB,cAAc,EAAE5B,gBAAgB,IAAI,KAAK;MACzCD,QAAQ;MACRM,OAAO,EAAEa,aAAa;MACtBZ,aAAa;MACbL,cAAc,EAAEe,oBAAoB;MACpCT,aAAa;MACb,IAAIU,mBAAmB,GACnB;QAAET,aAAa,EAAES;MAAoB,CAAC,GACtC,CAAC,CAAC,CAAC;MACP,IAAIR,OAAO,GAAG;QAAEA;MAAQ,CAAC,GAAG,CAAC,CAAC;IAChC,CAAC,EAAEiB,QAAQ,CAAC,EACdJ,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,GACjC,QAAQ7B,IAAI,CAAC8B,OAAO,IACpBb,UAAU,GAAG,IAAIA,UAAU,CAACiB,MAAM,QAAQ,GAAG,EAAE,IAC7Cf,IAAI,CAACC,SAAS,CAACL,UAAU,CAAC,EAAE,GAC9B,KAAK,CACX,CAAC;EACH,CAAC,EACD,CACER,OAAO,EACPL,gBAAgB,EAChBF,IAAI,EACJiB,UAAU,EACVF,UAAU,EACVV,gBAAgB,EAChBD,QAAQ,EACRmB,aAAa,EACbZ,aAAa,EACbU,oBAAoB,EACpBT,aAAa,EACbU,mBAAmB,EACnBR,OAAO,CAEX,CAAC;EAED,MAAMqB,WAAW,GAAGvC,KAAK,CAACwC,oBAAoB,CAACZ,SAAS,EAAEC,WAAW,CAAC;EAEtE,IAAIY,KAAwB;EAC5B,IAAIF,WAAW,IAAI,OAAO,IAAIA,WAAW,IAAIA,WAAW,CAACE,KAAK,EAAE;IAC9DA,KAAK,GAAGF,WAAW,CAACE,KAAK;EAC3B,CAAC,MAAM,IAAIF,WAAW,EAAEG,MAAM,KAAK,OAAO,EAAE;IAC1CD,KAAK,GAAG,IAAIE,KAAK,CAAC,wBAAwB,CAAC;EAC7C;EAEA,OAAO;IACLC,SAAS,EAAEL,WAAW,EAAEM,OAAO,GAAGN,WAAW,CAACK,SAAS,GAAGE,SAAS;IACnEL,KAAK;IACLM,IAAI,EAAER,WAAW,EAAES,YAAY;IAC/BC,SAAS,EAAEtC,OAAO,GACb4B,WAAW,EAAEG,MAAM,KAAK,SAAS,IAAIH,WAAW,EAAEG,MAAM,KAAK,MAAM,IACjE,CAACH,WAAW,GACf,KAAK;IACTW,YAAY,EAAEX,WAAW,EAAEW,YAAY,IAAI,KAAK;IAChDC,UAAU,EAAEZ,WAAW,EAAEY;EAC3B,CAAC;AACH","ignoreList":[]}
+{"version":3,"file":"useOsdkObjects.js","names":["React","makeExternalStore","OsdkContext2","EMPTY_WHERE","useOsdkObjects","type","options","observableClient","useContext","pageSize","dedupeIntervalMs","withProperties","enabled","rids","where","orderBy","streamUpdates","autoFetchMore","intersectWith","pivotTo","$select","$loadPropertySecurityMetadata","canonWhere","canonicalizeWhereClause","stableCanonWhere","useMemo","JSON","stringify","stableRids","stableWithProperties","stableIntersectWith","stableOrderBy","stableSelect","subscribe","getSnapShot","unsubscribe","process","env","NODE_ENV","apiName","observer","observeList","dedupeInterval","select","length","listPayload","useSyncExternalStore","error","status","Error","fetchMore","hasMore","undefined","data","resolvedList","isLoading","isOptimistic","totalCount"],"sources":["useOsdkObjects.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  DerivedProperty,\n  LinkedType,\n  LinkNames,\n  ObjectOrInterfaceDefinition,\n  Osdk,\n  PropertyKeys,\n  SimplePropertyDef,\n  WhereClause,\n} from \"@osdk/api\";\nimport type { ObserveObjectsCallbackArgs } from \"@osdk/client/unstable-do-not-use\";\nimport React from \"react\";\nimport { makeExternalStore } from \"./makeExternalStore.js\";\nimport { OsdkContext2 } from \"./OsdkContext2.js\";\n\nexport interface UseOsdkObjectsOptions<\n  T extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> {\n  /**\n   * Fetch objects by their RIDs (Resource Identifiers).\n   * When provided, starts with a static objectset containing these RIDs.\n   * Can be combined with `where` to filter the RID set, and with `orderBy` to sort results.\n   *\n   * @example\n   * // Fetch specific objects by RID\n   * useOsdkObjects(Employee, { rids: ['ri.foo.123', 'ri.foo.456'] })\n   *\n   * @example\n   * // Fetch specific objects by RID, filtered by status\n   * useOsdkObjects(Employee, {\n   *   rids: ['ri.foo.123', 'ri.foo.456', 'ri.foo.789'],\n   *   where: { status: 'active' }\n   * })\n   */\n  rids?: readonly string[];\n\n  /**\n   * Standard OSDK Where clause with RDP support.\n   * When used with `rids`, filters the RID set.\n   * When used alone, filters all objects of the type.\n   */\n  where?: WhereClause<T, RDPs>;\n\n  /**\n   * Sort results by one or more properties.\n   */\n  orderBy?: {\n    [K in PropertyKeys<T>]?: \"asc\" | \"desc\";\n  };\n\n  /**\n   * The preferred page size for the list.\n   */\n  pageSize?: number;\n\n  /**\n   * Define derived properties (RDPs) to be computed server-side and attached to each object.\n   * These properties will be available on the returned objects alongside their regular properties.\n   */\n  withProperties?: { [K in keyof RDPs]: DerivedProperty.Creator<T, RDPs[K]> };\n\n  /**\n   * The number of milliseconds to wait after the last observed list change.\n   *\n   * Two uses of `useOsdkObjects` with the same parameters will only trigger one\n   * network request if the second is within `dedupeIntervalMs`.\n   */\n  dedupeIntervalMs?: number;\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   * @default true\n   */\n  enabled?: boolean;\n\n  /**\n   * Intersect the results with additional object sets.\n   * Each element defines a where clause for an object set to intersect with.\n   * The final result will only include objects that match ALL conditions.\n   */\n  intersectWith?: Array<{\n    where: WhereClause<T, RDPs>;\n  }>;\n\n  /**\n   * Pivot to related objects through a link.\n   * This changes the return type from T to the linked object type.\n   */\n  pivotTo?: LinkNames<T>;\n\n  /**\n   * Causes the list to automatically fetch more as soon as the previous page\n   * has been loaded. If a number is provided, it will continue to automatically\n   * fetch more until the list is at least that long.\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  streamUpdates?: boolean;\n\n  /**\n   * Restrict which properties are returned for each object.\n   * When provided, only the specified properties will be fetched,\n   * reducing payload sizes for list views.\n   *\n   * @example\n   * // Only fetch name and status properties\n   * useOsdkObjects(Employee, { $select: [\"name\", \"status\"] })\n   */\n  $select?: readonly PropertyKeys<T>[];\n\n  /**\n   * When true, loads per-property security metadata (marking requirements)\n   * alongside each object. The returned objects will have `$propertySecurities`\n   * populated with conjunctive/disjunctive marking requirements per property.\n   */\n  $loadPropertySecurityMetadata?: boolean;\n}\n\nexport interface UseOsdkListResult<\n  T extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n  EXTRA_OPTIONS extends never | \"$rid\" = never,\n> {\n  /**\n   * Function to fetch more pages (undefined if no more pages)\n   */\n  fetchMore: (() => Promise<void>) | undefined;\n\n  /**\n   * The fetched data with derived properties\n   */\n  data:\n    | Osdk.Instance<\n      T,\n      \"$allBaseProperties\" | EXTRA_OPTIONS,\n      PropertyKeys<T>,\n      RDPs\n    >[]\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   * Refers to whether the ordered list of objects (only considering the $primaryKey)\n   * is optimistic or not.\n   *\n   * If you need to know if the contents of the list are optimistic you can\n   * do that on a per object basis with useOsdkObject\n   */\n  isOptimistic: boolean;\n\n  /**\n   * The total count of objects matching the query (if available from the API)\n   */\n  totalCount?: string;\n}\n\nconst EMPTY_WHERE = {};\n\ndeclare const process: {\n  env: {\n    NODE_ENV: \"development\" | \"production\";\n  };\n};\n\nexport function useOsdkObjects<\n  Q extends ObjectOrInterfaceDefinition,\n  L extends LinkNames<Q>,\n>(\n  type: Q,\n  options: UseOsdkObjectsOptions<Q> & { pivotTo: L; rids: readonly string[] },\n): UseOsdkListResult<LinkedType<Q, L>, {}, \"$rid\">;\n\nexport function useOsdkObjects<\n  Q extends ObjectOrInterfaceDefinition,\n  L extends LinkNames<Q>,\n>(\n  type: Q,\n  options: UseOsdkObjectsOptions<Q> & { pivotTo: L },\n): UseOsdkListResult<LinkedType<Q, L>>;\n\nexport function useOsdkObjects<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n>(\n  type: Q,\n  options: UseOsdkObjectsOptions<Q, RDPs> & { rids: readonly string[] },\n): UseOsdkListResult<Q, RDPs, \"$rid\">;\n\nexport function useOsdkObjects<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n>(\n  type: Q,\n  options?: UseOsdkObjectsOptions<Q, RDPs>,\n): UseOsdkListResult<Q, RDPs>;\n\nexport function useOsdkObjects<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n>(\n  type: Q,\n  options?: UseOsdkObjectsOptions<Q, RDPs>,\n):\n  | UseOsdkListResult<Q, RDPs>\n  | UseOsdkListResult<Q, RDPs, \"$rid\">\n  | UseOsdkListResult<LinkedType<Q, LinkNames<Q>>>\n  | UseOsdkListResult<LinkedType<Q, LinkNames<Q>>, {}, \"$rid\">\n{\n  const { observableClient } = React.useContext(OsdkContext2);\n\n  const {\n    pageSize,\n    dedupeIntervalMs,\n    withProperties,\n    enabled = true,\n    rids,\n    where,\n    orderBy,\n    streamUpdates,\n    autoFetchMore,\n    intersectWith,\n    pivotTo,\n    $select,\n    $loadPropertySecurityMetadata,\n  } = options ?? {};\n\n  const canonWhere = observableClient.canonicalizeWhereClause<\n    Q,\n    RDPs\n  >(where ?? EMPTY_WHERE);\n\n  const stableCanonWhere = React.useMemo(\n    () => canonWhere,\n    [JSON.stringify(canonWhere)],\n  );\n\n  const stableRids = React.useMemo(\n    () => rids,\n    [JSON.stringify(rids)],\n  );\n\n  const stableWithProperties = React.useMemo(\n    () => withProperties,\n    [JSON.stringify(withProperties)],\n  );\n\n  const stableIntersectWith = React.useMemo(\n    () => intersectWith,\n    [JSON.stringify(intersectWith)],\n  );\n\n  const stableOrderBy = React.useMemo(\n    () => orderBy,\n    [JSON.stringify(orderBy)],\n  );\n\n  const stableSelect = React.useMemo(\n    () => $select,\n    [JSON.stringify($select)],\n  );\n\n  const { subscribe, getSnapShot } = React.useMemo(\n    () => {\n      if (!enabled) {\n        return makeExternalStore<\n          ObserveObjectsCallbackArgs<Q, RDPs>\n        >(\n          () => ({ unsubscribe: () => {} }),\n          process.env.NODE_ENV !== \"production\"\n            ? `list ${type.apiName} [DISABLED]`\n            : void 0,\n        );\n      }\n\n      return makeExternalStore<\n        ObserveObjectsCallbackArgs<Q, RDPs>\n      >(\n        (observer) =>\n          observableClient.observeList({\n            type,\n            rids: stableRids,\n            where: stableCanonWhere,\n            dedupeInterval: dedupeIntervalMs ?? 2_000,\n            pageSize,\n            orderBy: stableOrderBy,\n            streamUpdates,\n            withProperties: stableWithProperties,\n            autoFetchMore,\n            ...(stableIntersectWith\n              ? { intersectWith: stableIntersectWith }\n              : {}),\n            ...(pivotTo ? { pivotTo } : {}),\n            ...(stableSelect ? { select: stableSelect } : {}),\n            ...($loadPropertySecurityMetadata\n              ? { $loadPropertySecurityMetadata }\n              : {}),\n          }, observer),\n        process.env.NODE_ENV !== \"production\"\n          ? `list ${type.apiName} ${\n            stableRids ? `[${stableRids.length} rids]` : \"\"\n          } ${JSON.stringify(stableCanonWhere)}`\n          : void 0,\n      );\n    },\n    [\n      enabled,\n      observableClient,\n      type.apiName,\n      type.type,\n      stableRids,\n      stableCanonWhere,\n      dedupeIntervalMs,\n      pageSize,\n      stableOrderBy,\n      streamUpdates,\n      stableWithProperties,\n      autoFetchMore,\n      stableIntersectWith,\n      pivotTo,\n      stableSelect,\n      $loadPropertySecurityMetadata,\n    ],\n  );\n\n  const listPayload = React.useSyncExternalStore(subscribe, getSnapShot);\n\n  return React.useMemo(() => {\n    let error: Error | undefined;\n    if (listPayload && \"error\" in listPayload && listPayload.error) {\n      error = listPayload.error;\n    } else if (listPayload?.status === \"error\") {\n      error = new Error(\"Failed to load objects\");\n    }\n\n    return {\n      fetchMore: listPayload?.hasMore ? listPayload.fetchMore : undefined,\n      error,\n      data: listPayload?.resolvedList,\n      isLoading: enabled\n        ? (listPayload?.status === \"loading\" || listPayload?.status === \"init\"\n          || !listPayload)\n        : false,\n      isOptimistic: listPayload?.isOptimistic ?? false,\n      totalCount: listPayload?.totalCount,\n    };\n  }, [listPayload, enabled]);\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAaA,OAAOA,KAAK,MAAM,OAAO;AACzB,SAASC,iBAAiB,QAAQ,wBAAwB;AAC1D,SAASC,YAAY,QAAQ,mBAAmB;AAiKhD,MAAMC,WAAW,GAAG,CAAC,CAAC;AAwCtB,OAAO,SAASC,cAAcA,CAI5BC,IAAO,EACPC,OAAwC,EAM1C;EACE,MAAM;IAAEC;EAAiB,CAAC,GAAGP,KAAK,CAACQ,UAAU,CAACN,YAAY,CAAC;EAE3D,MAAM;IACJO,QAAQ;IACRC,gBAAgB;IAChBC,cAAc;IACdC,OAAO,GAAG,IAAI;IACdC,IAAI;IACJC,KAAK;IACLC,OAAO;IACPC,aAAa;IACbC,aAAa;IACbC,aAAa;IACbC,OAAO;IACPC,OAAO;IACPC;EACF,CAAC,GAAGf,OAAO,IAAI,CAAC,CAAC;EAEjB,MAAMgB,UAAU,GAAGf,gBAAgB,CAACgB,uBAAuB,CAGzDT,KAAK,IAAIX,WAAW,CAAC;EAEvB,MAAMqB,gBAAgB,GAAGxB,KAAK,CAACyB,OAAO,CACpC,MAAMH,UAAU,EAChB,CAACI,IAAI,CAACC,SAAS,CAACL,UAAU,CAAC,CAC7B,CAAC;EAED,MAAMM,UAAU,GAAG5B,KAAK,CAACyB,OAAO,CAC9B,MAAMZ,IAAI,EACV,CAACa,IAAI,CAACC,SAAS,CAACd,IAAI,CAAC,CACvB,CAAC;EAED,MAAMgB,oBAAoB,GAAG7B,KAAK,CAACyB,OAAO,CACxC,MAAMd,cAAc,EACpB,CAACe,IAAI,CAACC,SAAS,CAAChB,cAAc,CAAC,CACjC,CAAC;EAED,MAAMmB,mBAAmB,GAAG9B,KAAK,CAACyB,OAAO,CACvC,MAAMP,aAAa,EACnB,CAACQ,IAAI,CAACC,SAAS,CAACT,aAAa,CAAC,CAChC,CAAC;EAED,MAAMa,aAAa,GAAG/B,KAAK,CAACyB,OAAO,CACjC,MAAMV,OAAO,EACb,CAACW,IAAI,CAACC,SAAS,CAACZ,OAAO,CAAC,CAC1B,CAAC;EAED,MAAMiB,YAAY,GAAGhC,KAAK,CAACyB,OAAO,CAChC,MAAML,OAAO,EACb,CAACM,IAAI,CAACC,SAAS,CAACP,OAAO,CAAC,CAC1B,CAAC;EAED,MAAM;IAAEa,SAAS;IAAEC;EAAY,CAAC,GAAGlC,KAAK,CAACyB,OAAO,CAC9C,MAAM;IACJ,IAAI,CAACb,OAAO,EAAE;MACZ,OAAOX,iBAAiB,CAGtB,OAAO;QAAEkC,WAAW,EAAEA,CAAA,KAAM,CAAC;MAAE,CAAC,CAAC,EACjCC,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,GACjC,QAAQjC,IAAI,CAACkC,OAAO,aAAa,GACjC,KAAK,CACX,CAAC;IACH;IAEA,OAAOtC,iBAAiB,CAGrBuC,QAAQ,IACPjC,gBAAgB,CAACkC,WAAW,CAAC;MAC3BpC,IAAI;MACJQ,IAAI,EAAEe,UAAU;MAChBd,KAAK,EAAEU,gBAAgB;MACvBkB,cAAc,EAAEhC,gBAAgB,IAAI,KAAK;MACzCD,QAAQ;MACRM,OAAO,EAAEgB,aAAa;MACtBf,aAAa;MACbL,cAAc,EAAEkB,oBAAoB;MACpCZ,aAAa;MACb,IAAIa,mBAAmB,GACnB;QAAEZ,aAAa,EAAEY;MAAoB,CAAC,GACtC,CAAC,CAAC,CAAC;MACP,IAAIX,OAAO,GAAG;QAAEA;MAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;MAC/B,IAAIa,YAAY,GAAG;QAAEW,MAAM,EAAEX;MAAa,CAAC,GAAG,CAAC,CAAC,CAAC;MACjD,IAAIX,6BAA6B,GAC7B;QAAEA;MAA8B,CAAC,GACjC,CAAC,CAAC;IACR,CAAC,EAAEmB,QAAQ,CAAC,EACdJ,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,GACjC,QAAQjC,IAAI,CAACkC,OAAO,IACpBX,UAAU,GAAG,IAAIA,UAAU,CAACgB,MAAM,QAAQ,GAAG,EAAE,IAC7ClB,IAAI,CAACC,SAAS,CAACH,gBAAgB,CAAC,EAAE,GACpC,KAAK,CACX,CAAC;EACH,CAAC,EACD,CACEZ,OAAO,EACPL,gBAAgB,EAChBF,IAAI,CAACkC,OAAO,EACZlC,IAAI,CAACA,IAAI,EACTuB,UAAU,EACVJ,gBAAgB,EAChBd,gBAAgB,EAChBD,QAAQ,EACRsB,aAAa,EACbf,aAAa,EACba,oBAAoB,EACpBZ,aAAa,EACba,mBAAmB,EACnBX,OAAO,EACPa,YAAY,EACZX,6BAA6B,CAEjC,CAAC;EAED,MAAMwB,WAAW,GAAG7C,KAAK,CAAC8C,oBAAoB,CAACb,SAAS,EAAEC,WAAW,CAAC;EAEtE,OAAOlC,KAAK,CAACyB,OAAO,CAAC,MAAM;IACzB,IAAIsB,KAAwB;IAC5B,IAAIF,WAAW,IAAI,OAAO,IAAIA,WAAW,IAAIA,WAAW,CAACE,KAAK,EAAE;MAC9DA,KAAK,GAAGF,WAAW,CAACE,KAAK;IAC3B,CAAC,MAAM,IAAIF,WAAW,EAAEG,MAAM,KAAK,OAAO,EAAE;MAC1CD,KAAK,GAAG,IAAIE,KAAK,CAAC,wBAAwB,CAAC;IAC7C;IAEA,OAAO;MACLC,SAAS,EAAEL,WAAW,EAAEM,OAAO,GAAGN,WAAW,CAACK,SAAS,GAAGE,SAAS;MACnEL,KAAK;MACLM,IAAI,EAAER,WAAW,EAAES,YAAY;MAC/BC,SAAS,EAAE3C,OAAO,GACbiC,WAAW,EAAEG,MAAM,KAAK,SAAS,IAAIH,WAAW,EAAEG,MAAM,KAAK,MAAM,IACjE,CAACH,WAAW,GACf,KAAK;MACTW,YAAY,EAAEX,WAAW,EAAEW,YAAY,IAAI,KAAK;MAChDC,UAAU,EAAEZ,WAAW,EAAEY;IAC3B,CAAC;EACH,CAAC,EAAE,CAACZ,WAAW,EAAEjC,OAAO,CAAC,CAAC;AAC5B","ignoreList":[]}