@osdk/react 0.9.3 → 0.10.0-beta.10

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

@@ -1 +1 @@
-{"version":3,"file":"useLinks.js","names":["React","makeExternalStore","OsdkContext2","emptyArray","Object","freeze","useLinks","objects","linkName","options","observableClient","useContext","enabled","otherOptions","stableWhere","useMemo","where","JSON","stringify","stableOrderBy","orderBy","objectsKey","undefined","arr","Array","isArray","map","obj","$apiName","$primaryKey","join","objectsArray","subscribe","getSnapShot","unsubscribe","observer","observeLinks","pageSize","mode","payload","useSyncExternalStore","links","resolvedList","isLoading","status","isOptimistic","error","fetchMore","hasMore"],"sources":["useLinks.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n  LinkedType,\n  LinkNames,\n  ObjectOrInterfaceDefinition,\n} from \"@osdk/api\";\nimport type { Osdk, PropertyKeys, WhereClause } from \"@osdk/client\";\nimport type { ObserveLinks } from \"@osdk/client/unstable-do-not-use\";\nimport React from \"react\";\nimport { makeExternalStore } from \"./makeExternalStore.js\";\nimport { OsdkContext2 } from \"./OsdkContext2.js\";\n\nexport interface UseLinksOptions<\n  T extends ObjectOrInterfaceDefinition,\n> {\n  /**\n   * Standard OSDK Where clause for filtering linked objects\n   */\n  where?: WhereClause<T>;\n\n  /**\n   * The preferred page size for the links list.\n   */\n  pageSize?: number;\n\n  /** Sorting options for the linked objects */\n  orderBy?: {\n    [K in PropertyKeys<T>]?: \"asc\" | \"desc\";\n  };\n\n  /**\n   * The mode to use for fetching data.\n   * - undefined: Fetch data if not already in cache\n   * - \"force\": Always fetch fresh data\n   * - \"offline\": Only use cached data, don't make network requests\n   */\n  mode?: \"force\" | \"offline\";\n\n  /**\n   * Enable or disable the query.\n   *\n   * When `false`, the query will not automatically execute. It will still\n   * return any cached data, but will not fetch from the server.\n   *\n   * This is useful for:\n   * - Lazy/on-demand queries that should wait for user interaction\n   * - Dependent queries that need data from another query first\n   * - Conditional queries based on component state\n   *\n   * @default true\n   * @example\n   * // Dependent query - wait for employee data\n   * const { object: employee } = useOsdkObject(Employee, employeeId);\n   * const { links: reports } = useLinks(employee, \"reports\", {\n   *   enabled: !!employee\n   * });\n   */\n  enabled?: boolean;\n}\n\nexport interface UseLinksResult<\n  Q extends ObjectOrInterfaceDefinition,\n> {\n  links: Osdk.Instance<Q>[] | undefined;\n  isLoading: boolean;\n  error: Error | undefined;\n\n  /**\n   * Refers to whether the links are optimistic or not.\n   */\n  isOptimistic: boolean;\n\n  /**\n   * Fetch more linked objects if pagination is supported\n   */\n  fetchMore: (() => Promise<unknown>) | undefined;\n\n  /**\n   * Indicates if there are more linked objects available to fetch\n   */\n  hasMore: boolean;\n}\n\nconst emptyArray = Object.freeze([]);\n\n/**\n * Hook to observe links from an object or array of objects.\n *\n * @param objects The source object(s) to observe links from\n * @param linkName The name of the link to observe\n * @param options Optional configuration for the link query\n * @returns UseLinksResult with links data and metadata\n */\nexport function useLinks<\n  T extends ObjectOrInterfaceDefinition,\n  L extends LinkNames<T>,\n>(\n  objects: Osdk.Instance<T> | Array<Osdk.Instance<T>> | undefined,\n  linkName: L,\n  options: UseLinksOptions<LinkedType<T, L>> = {},\n): UseLinksResult<LinkedType<T, L>> {\n  const { observableClient } = React.useContext(OsdkContext2);\n\n  const { enabled = true, ...otherOptions } = options;\n\n  const stableWhere = React.useMemo(\n    () => otherOptions.where,\n    [JSON.stringify(otherOptions.where)],\n  );\n\n  const stableOrderBy = React.useMemo(\n    () => otherOptions.orderBy,\n    [JSON.stringify(otherOptions.orderBy)],\n  );\n\n  const objectsKey = React.useMemo(() => {\n    if (objects === undefined) return \"\";\n    const arr = Array.isArray(objects) ? objects : [objects];\n    return arr.map(obj => `${obj.$apiName}:${obj.$primaryKey}`).join(\",\");\n  }, [objects]);\n\n  // Convert single object to array for consistent handling\n  const objectsArray: ReadonlyArray<Osdk.Instance<T>> = React.useMemo(() => {\n    return objects === undefined\n      ? emptyArray\n      : Array.isArray(objects)\n      ? objects\n      : [objects];\n  }, [objectsKey, objects]);\n\n  const { subscribe, getSnapShot } = React.useMemo(\n    () => {\n      if (!enabled) {\n        return makeExternalStore<ObserveLinks.CallbackArgs<T>>(\n          () => ({ unsubscribe: () => {} }),\n          `links ${linkName} for ${objectsKey} [DISABLED]`,\n        );\n      }\n      return makeExternalStore<ObserveLinks.CallbackArgs<T>>(\n        (observer) =>\n          observableClient.observeLinks(\n            objectsArray,\n            linkName,\n            {\n              linkName,\n              where: stableWhere,\n              pageSize: otherOptions.pageSize,\n              orderBy: stableOrderBy,\n              mode: otherOptions.mode,\n            },\n            observer,\n          ),\n        `links ${linkName} for ${objectsKey}`,\n      );\n    },\n    [\n      enabled,\n      observableClient,\n      objectsArray,\n      objectsKey,\n      linkName,\n      stableWhere,\n      otherOptions.pageSize,\n      stableOrderBy,\n      otherOptions.mode,\n    ],\n  );\n\n  const payload = React.useSyncExternalStore(\n    subscribe,\n    getSnapShot,\n  );\n\n  return {\n    links: payload?.resolvedList,\n    isLoading: enabled\n      ? (payload?.status === \"loading\" || payload?.status === \"init\"\n        || !payload)\n      : false,\n    isOptimistic: payload?.isOptimistic ?? false,\n    error: payload?.error,\n    fetchMore: payload?.hasMore ? payload?.fetchMore : undefined,\n    hasMore: payload?.hasMore ?? false,\n  };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AASA,OAAOA,KAAK,MAAM,OAAO;AACzB,SAASC,iBAAiB,QAAQ,wBAAwB;AAC1D,SAASC,YAAY,QAAQ,mBAAmB;AAyEhD,MAAMC,UAAU,GAAGC,MAAM,CAACC,MAAM,CAAC,EAAE,CAAC;;AAEpC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,QAAQA,CAItBC,OAA+D,EAC/DC,QAAW,EACXC,OAA0C,GAAG,CAAC,CAAC,EACb;EAClC,MAAM;IAAEC;EAAiB,CAAC,GAAGV,KAAK,CAACW,UAAU,CAACT,YAAY,CAAC;EAE3D,MAAM;IAAEU,OAAO,GAAG,IAAI;IAAE,GAAGC;EAAa,CAAC,GAAGJ,OAAO;EAEnD,MAAMK,WAAW,GAAGd,KAAK,CAACe,OAAO,CAC/B,MAAMF,YAAY,CAACG,KAAK,EACxB,CAACC,IAAI,CAACC,SAAS,CAACL,YAAY,CAACG,KAAK,CAAC,CACrC,CAAC;EAED,MAAMG,aAAa,GAAGnB,KAAK,CAACe,OAAO,CACjC,MAAMF,YAAY,CAACO,OAAO,EAC1B,CAACH,IAAI,CAACC,SAAS,CAACL,YAAY,CAACO,OAAO,CAAC,CACvC,CAAC;EAED,MAAMC,UAAU,GAAGrB,KAAK,CAACe,OAAO,CAAC,MAAM;IACrC,IAAIR,OAAO,KAAKe,SAAS,EAAE,OAAO,EAAE;IACpC,MAAMC,GAAG,GAAGC,KAAK,CAACC,OAAO,CAAClB,OAAO,CAAC,GAAGA,OAAO,GAAG,CAACA,OAAO,CAAC;IACxD,OAAOgB,GAAG,CAACG,GAAG,CAACC,GAAG,IAAI,GAAGA,GAAG,CAACC,QAAQ,IAAID,GAAG,CAACE,WAAW,EAAE,CAAC,CAACC,IAAI,CAAC,GAAG,CAAC;EACvE,CAAC,EAAE,CAACvB,OAAO,CAAC,CAAC;;EAEb;EACA,MAAMwB,YAA6C,GAAG/B,KAAK,CAACe,OAAO,CAAC,MAAM;IACxE,OAAOR,OAAO,KAAKe,SAAS,GACxBnB,UAAU,GACVqB,KAAK,CAACC,OAAO,CAAClB,OAAO,CAAC,GACtBA,OAAO,GACP,CAACA,OAAO,CAAC;EACf,CAAC,EAAE,CAACc,UAAU,EAAEd,OAAO,CAAC,CAAC;EAEzB,MAAM;IAAEyB,SAAS;IAAEC;EAAY,CAAC,GAAGjC,KAAK,CAACe,OAAO,CAC9C,MAAM;IACJ,IAAI,CAACH,OAAO,EAAE;MACZ,OAAOX,iBAAiB,CACtB,OAAO;QAAEiC,WAAW,EAAEA,CAAA,KAAM,CAAC;MAAE,CAAC,CAAC,EACjC,SAAS1B,QAAQ,QAAQa,UAAU,aACrC,CAAC;IACH;IACA,OAAOpB,iBAAiB,CACrBkC,QAAQ,IACPzB,gBAAgB,CAAC0B,YAAY,CAC3BL,YAAY,EACZvB,QAAQ,EACR;MACEA,QAAQ;MACRQ,KAAK,EAAEF,WAAW;MAClBuB,QAAQ,EAAExB,YAAY,CAACwB,QAAQ;MAC/BjB,OAAO,EAAED,aAAa;MACtBmB,IAAI,EAAEzB,YAAY,CAACyB;IACrB,CAAC,EACDH,QACF,CAAC,EACH,SAAS3B,QAAQ,QAAQa,UAAU,EACrC,CAAC;EACH,CAAC,EACD,CACET,OAAO,EACPF,gBAAgB,EAChBqB,YAAY,EACZV,UAAU,EACVb,QAAQ,EACRM,WAAW,EACXD,YAAY,CAACwB,QAAQ,EACrBlB,aAAa,EACbN,YAAY,CAACyB,IAAI,CAErB,CAAC;EAED,MAAMC,OAAO,GAAGvC,KAAK,CAACwC,oBAAoB,CACxCR,SAAS,EACTC,WACF,CAAC;EAED,OAAO;IACLQ,KAAK,EAAEF,OAAO,EAAEG,YAAY;IAC5BC,SAAS,EAAE/B,OAAO,GACb2B,OAAO,EAAEK,MAAM,KAAK,SAAS,IAAIL,OAAO,EAAEK,MAAM,KAAK,MAAM,IACzD,CAACL,OAAO,GACX,KAAK;IACTM,YAAY,EAAEN,OAAO,EAAEM,YAAY,IAAI,KAAK;IAC5CC,KAAK,EAAEP,OAAO,EAAEO,KAAK;IACrBC,SAAS,EAAER,OAAO,EAAES,OAAO,GAAGT,OAAO,EAAEQ,SAAS,GAAGzB,SAAS;IAC5D0B,OAAO,EAAET,OAAO,EAAES,OAAO,IAAI;EAC/B,CAAC;AACH","ignoreList":[]}
+{"version":3,"file":"useLinks.js","names":["React","makeExternalStore","OsdkContext2","emptyArray","Object","freeze","emptyMap","Map","useLinks","objects","linkName","options","observableClient","useContext","enabled","otherOptions","stableWhere","useMemo","where","JSON","stringify","stableOrderBy","orderBy","stableSelect","$select","objectsKey","undefined","arr","Array","isArray","map","obj","$apiName","$primaryKey","join","objectsArray","subscribe","getSnapShot","unsubscribe","observer","observeLinks","pageSize","mode","dedupeInterval","dedupeIntervalMs","select","payload","useSyncExternalStore","links","resolvedList","linkedObjectsBySourcePrimaryKey","isLoading","status","isOptimistic","error","fetchMore","hasMore"],"sources":["useLinks.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n  LinkedType,\n  LinkNames,\n  ObjectOrInterfaceDefinition,\n} from \"@osdk/api\";\nimport type { Osdk, PropertyKeys, WhereClause } from \"@osdk/client\";\nimport type { ObserveLinks } from \"@osdk/client/unstable-do-not-use\";\nimport React from \"react\";\nimport { makeExternalStore } from \"./makeExternalStore.js\";\nimport { OsdkContext2 } from \"./OsdkContext2.js\";\n\nexport interface UseLinksOptions<\n  T extends ObjectOrInterfaceDefinition,\n> {\n  /**\n   * Standard OSDK Where clause for filtering linked objects\n   */\n  where?: WhereClause<T>;\n\n  /**\n   * The preferred page size for the links list.\n   */\n  pageSize?: number;\n\n  /** Sorting options for the linked objects */\n  orderBy?: {\n    [K in PropertyKeys<T>]?: \"asc\" | \"desc\";\n  };\n\n  /**\n   * Restrict which properties are returned for each linked object.\n   * When provided, only the specified properties will be fetched,\n   * reducing payload sizes for list views.\n   */\n  $select?: readonly PropertyKeys<T>[];\n\n  /**\n   * The mode to use for fetching data.\n   * - undefined: Fetch data if not already in cache\n   * - \"force\": Always fetch fresh data\n   * - \"offline\": Only use cached data, don't make network requests\n   */\n  mode?: \"force\" | \"offline\";\n\n  /**\n   * The number of milliseconds to wait after the last observed link change.\n   *\n   * Two uses of `useLinks` 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   * This is useful for:\n   * - Lazy/on-demand queries that should wait for user interaction\n   * - Dependent queries that need data from another query first\n   * - Conditional queries based on component state\n   *\n   * @default true\n   * @example\n   * // Dependent query - wait for employee data\n   * const { object: employee } = useOsdkObject(Employee, employeeId);\n   * const { links: reports } = useLinks(employee, \"reports\", {\n   *   enabled: !!employee\n   * });\n   */\n  enabled?: boolean;\n}\n\nexport interface UseLinksResult<\n  Q extends ObjectOrInterfaceDefinition,\n> {\n  links: Osdk.Instance<Q>[] | undefined;\n\n  /**\n   * Maps each source object's primary key to its linked object instances.\n   * Useful when observing links from multiple source objects to determine\n   * which source links to which targets.\n   */\n  linkedObjectsBySourcePrimaryKey: ReadonlyMap<\n    string | number,\n    ReadonlyArray<Osdk.Instance<Q>>\n  >;\n\n  isLoading: boolean;\n  error: Error | undefined;\n\n  /**\n   * Refers to whether the links are optimistic or not.\n   */\n  isOptimistic: boolean;\n\n  /**\n   * Fetch more linked objects if pagination is supported\n   */\n  fetchMore: (() => Promise<unknown>) | undefined;\n\n  /**\n   * Indicates if there are more linked objects available to fetch\n   */\n  hasMore: boolean;\n}\n\nconst emptyArray = Object.freeze([]);\nconst emptyMap: ReadonlyMap<string | number, ReadonlyArray<never>> = new Map();\n\n/**\n * Hook to observe links from an object or array of objects.\n *\n * @param objects The source object(s) to observe links from\n * @param linkName The name of the link to observe\n * @param options Optional configuration for the link query\n * @returns UseLinksResult with links data and metadata\n */\nexport function useLinks<\n  T extends ObjectOrInterfaceDefinition,\n  L extends LinkNames<T>,\n>(\n  objects: Osdk.Instance<T> | Array<Osdk.Instance<T>> | undefined,\n  linkName: L,\n  options: UseLinksOptions<LinkedType<T, L>> = {},\n): UseLinksResult<LinkedType<T, L>> {\n  const { observableClient } = React.useContext(OsdkContext2);\n\n  const { enabled = true, ...otherOptions } = options;\n\n  const stableWhere = React.useMemo(\n    () => otherOptions.where,\n    [JSON.stringify(otherOptions.where)],\n  );\n\n  const stableOrderBy = React.useMemo(\n    () => otherOptions.orderBy,\n    [JSON.stringify(otherOptions.orderBy)],\n  );\n\n  const stableSelect = React.useMemo(\n    () => otherOptions.$select,\n    [JSON.stringify(otherOptions.$select)],\n  );\n\n  const objectsKey = React.useMemo(() => {\n    if (objects === undefined) return \"\";\n    const arr = Array.isArray(objects) ? objects : [objects];\n    return arr.map(obj => `${obj.$apiName}:${obj.$primaryKey}`).join(\",\");\n  }, [objects]);\n\n  // Convert single object to array for consistent handling\n  const objectsArray: ReadonlyArray<Osdk.Instance<T>> = React.useMemo(() => {\n    return objects === undefined\n      ? emptyArray\n      : Array.isArray(objects)\n      ? objects\n      : [objects];\n  }, [objectsKey, objects]);\n\n  const { subscribe, getSnapShot } = React.useMemo(\n    () => {\n      if (!enabled) {\n        return makeExternalStore<ObserveLinks.CallbackArgs<T>>(\n          () => ({ unsubscribe: () => {} }),\n          `links ${linkName} for ${objectsKey} [DISABLED]`,\n        );\n      }\n      return makeExternalStore<ObserveLinks.CallbackArgs<T>>(\n        (observer) =>\n          observableClient.observeLinks(\n            objectsArray,\n            linkName,\n            {\n              linkName,\n              where: stableWhere,\n              pageSize: otherOptions.pageSize,\n              orderBy: stableOrderBy,\n              mode: otherOptions.mode,\n              dedupeInterval: otherOptions.dedupeIntervalMs ?? 2_000,\n              ...(stableSelect ? { select: stableSelect } : {}),\n            },\n            observer,\n          ),\n        `links ${linkName} for ${objectsKey}`,\n      );\n    },\n    [\n      enabled,\n      observableClient,\n      objectsArray,\n      objectsKey,\n      linkName,\n      stableWhere,\n      otherOptions.pageSize,\n      stableOrderBy,\n      otherOptions.mode,\n      otherOptions.dedupeIntervalMs,\n      stableSelect,\n    ],\n  );\n\n  const payload = React.useSyncExternalStore(\n    subscribe,\n    getSnapShot,\n  );\n\n  return React.useMemo(() => ({\n    links: payload?.resolvedList,\n    linkedObjectsBySourcePrimaryKey: payload?.linkedObjectsBySourcePrimaryKey\n      ?? emptyMap,\n    isLoading: enabled\n      ? (payload?.status === \"loading\" || payload?.status === \"init\"\n        || !payload)\n      : false,\n    isOptimistic: payload?.isOptimistic ?? false,\n    error: payload?.error,\n    fetchMore: payload?.hasMore ? payload?.fetchMore : undefined,\n    hasMore: payload?.hasMore ?? false,\n  }), [payload, enabled]);\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;AAmGhD,MAAMC,UAAU,GAAGC,MAAM,CAACC,MAAM,CAAC,EAAE,CAAC;AACpC,MAAMC,QAA4D,GAAG,IAAIC,GAAG,CAAC,CAAC;;AAE9E;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,QAAQA,CAItBC,OAA+D,EAC/DC,QAAW,EACXC,OAA0C,GAAG,CAAC,CAAC,EACb;EAClC,MAAM;IAAEC;EAAiB,CAAC,GAAGZ,KAAK,CAACa,UAAU,CAACX,YAAY,CAAC;EAE3D,MAAM;IAAEY,OAAO,GAAG,IAAI;IAAE,GAAGC;EAAa,CAAC,GAAGJ,OAAO;EAEnD,MAAMK,WAAW,GAAGhB,KAAK,CAACiB,OAAO,CAC/B,MAAMF,YAAY,CAACG,KAAK,EACxB,CAACC,IAAI,CAACC,SAAS,CAACL,YAAY,CAACG,KAAK,CAAC,CACrC,CAAC;EAED,MAAMG,aAAa,GAAGrB,KAAK,CAACiB,OAAO,CACjC,MAAMF,YAAY,CAACO,OAAO,EAC1B,CAACH,IAAI,CAACC,SAAS,CAACL,YAAY,CAACO,OAAO,CAAC,CACvC,CAAC;EAED,MAAMC,YAAY,GAAGvB,KAAK,CAACiB,OAAO,CAChC,MAAMF,YAAY,CAACS,OAAO,EAC1B,CAACL,IAAI,CAACC,SAAS,CAACL,YAAY,CAACS,OAAO,CAAC,CACvC,CAAC;EAED,MAAMC,UAAU,GAAGzB,KAAK,CAACiB,OAAO,CAAC,MAAM;IACrC,IAAIR,OAAO,KAAKiB,SAAS,EAAE,OAAO,EAAE;IACpC,MAAMC,GAAG,GAAGC,KAAK,CAACC,OAAO,CAACpB,OAAO,CAAC,GAAGA,OAAO,GAAG,CAACA,OAAO,CAAC;IACxD,OAAOkB,GAAG,CAACG,GAAG,CAACC,GAAG,IAAI,GAAGA,GAAG,CAACC,QAAQ,IAAID,GAAG,CAACE,WAAW,EAAE,CAAC,CAACC,IAAI,CAAC,GAAG,CAAC;EACvE,CAAC,EAAE,CAACzB,OAAO,CAAC,CAAC;;EAEb;EACA,MAAM0B,YAA6C,GAAGnC,KAAK,CAACiB,OAAO,CAAC,MAAM;IACxE,OAAOR,OAAO,KAAKiB,SAAS,GACxBvB,UAAU,GACVyB,KAAK,CAACC,OAAO,CAACpB,OAAO,CAAC,GACtBA,OAAO,GACP,CAACA,OAAO,CAAC;EACf,CAAC,EAAE,CAACgB,UAAU,EAAEhB,OAAO,CAAC,CAAC;EAEzB,MAAM;IAAE2B,SAAS;IAAEC;EAAY,CAAC,GAAGrC,KAAK,CAACiB,OAAO,CAC9C,MAAM;IACJ,IAAI,CAACH,OAAO,EAAE;MACZ,OAAOb,iBAAiB,CACtB,OAAO;QAAEqC,WAAW,EAAEA,CAAA,KAAM,CAAC;MAAE,CAAC,CAAC,EACjC,SAAS5B,QAAQ,QAAQe,UAAU,aACrC,CAAC;IACH;IACA,OAAOxB,iBAAiB,CACrBsC,QAAQ,IACP3B,gBAAgB,CAAC4B,YAAY,CAC3BL,YAAY,EACZzB,QAAQ,EACR;MACEA,QAAQ;MACRQ,KAAK,EAAEF,WAAW;MAClByB,QAAQ,EAAE1B,YAAY,CAAC0B,QAAQ;MAC/BnB,OAAO,EAAED,aAAa;MACtBqB,IAAI,EAAE3B,YAAY,CAAC2B,IAAI;MACvBC,cAAc,EAAE5B,YAAY,CAAC6B,gBAAgB,IAAI,KAAK;MACtD,IAAIrB,YAAY,GAAG;QAAEsB,MAAM,EAAEtB;MAAa,CAAC,GAAG,CAAC,CAAC;IAClD,CAAC,EACDgB,QACF,CAAC,EACH,SAAS7B,QAAQ,QAAQe,UAAU,EACrC,CAAC;EACH,CAAC,EACD,CACEX,OAAO,EACPF,gBAAgB,EAChBuB,YAAY,EACZV,UAAU,EACVf,QAAQ,EACRM,WAAW,EACXD,YAAY,CAAC0B,QAAQ,EACrBpB,aAAa,EACbN,YAAY,CAAC2B,IAAI,EACjB3B,YAAY,CAAC6B,gBAAgB,EAC7BrB,YAAY,CAEhB,CAAC;EAED,MAAMuB,OAAO,GAAG9C,KAAK,CAAC+C,oBAAoB,CACxCX,SAAS,EACTC,WACF,CAAC;EAED,OAAOrC,KAAK,CAACiB,OAAO,CAAC,OAAO;IAC1B+B,KAAK,EAAEF,OAAO,EAAEG,YAAY;IAC5BC,+BAA+B,EAAEJ,OAAO,EAAEI,+BAA+B,IACpE5C,QAAQ;IACb6C,SAAS,EAAErC,OAAO,GACbgC,OAAO,EAAEM,MAAM,KAAK,SAAS,IAAIN,OAAO,EAAEM,MAAM,KAAK,MAAM,IACzD,CAACN,OAAO,GACX,KAAK;IACTO,YAAY,EAAEP,OAAO,EAAEO,YAAY,IAAI,KAAK;IAC5CC,KAAK,EAAER,OAAO,EAAEQ,KAAK;IACrBC,SAAS,EAAET,OAAO,EAAEU,OAAO,GAAGV,OAAO,EAAES,SAAS,GAAG7B,SAAS;IAC5D8B,OAAO,EAAEV,OAAO,EAAEU,OAAO,IAAI;EAC/B,CAAC,CAAC,EAAE,CAACV,OAAO,EAAEhC,OAAO,CAAC,CAAC;AACzB","ignoreList":[]}

package/build/browser/new/useObjectSet.js

@@ -18,6 +18,7 @@ import { computeObjectSetCacheKey } from "@osdk/client/unstable-do-not-use";
 import React from "react";
 import { makeExternalStore } from "./makeExternalStore.js";
 import { OsdkContext2 } from "./OsdkContext2.js";
+const OBJECT_TYPE_PLACEHOLDER = "$__OBJECT__TYPE__PLACEHOLDER";
 /**
  * React hook for observing and interacting with OSDK object sets.
  *
@@ -40,7 +41,7 @@ export function useObjectSet(baseObjectSet, options = {}) {
   } = options;
 
   // Track object type to detect when we switch to a different object type
-  const objectTypeKey = baseObjectSet.$objectSetInternals.def.apiName;
+  const objectTypeKey = enabled ? baseObjectSet.$objectSetInternals.def.apiName : OBJECT_TYPE_PLACEHOLDER;
   const previousObjectTypeRef = React.useRef(objectTypeKey);
   const previousCompletedPayloadRef = React.useRef();
   const objectTypeChanged = previousObjectTypeRef.current !== objectTypeKey;
@@ -59,7 +60,8 @@ export function useObjectSet(baseObjectSet, options = {}) {
     subtract: otherOptions.subtract,
     pivotTo: otherOptions.pivotTo,
     pageSize: otherOptions.pageSize,
-    orderBy: otherOptions.orderBy
+    orderBy: otherOptions.orderBy,
+    select: otherOptions.$select
   });
   const {
     subscribe,
@@ -83,7 +85,8 @@ export function useObjectSet(baseObjectSet, options = {}) {
         orderBy: otherOptions.orderBy,
         dedupeInterval: otherOptions.dedupeIntervalMs ?? 2_000,
         autoFetchMore: otherOptions.autoFetchMore,
-        streamUpdates
+        streamUpdates,
+        select: otherOptions.$select
       }, observer);
       return subscription;
     }, process.env.NODE_ENV !== "production" ? `objectSet ${stableKey}` : void 0, initialValue);

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

@@ -1 +1 @@
-{"version":3,"file":"useObjectSet.js","names":["computeObjectSetCacheKey","React","makeExternalStore","OsdkContext2","useObjectSet","baseObjectSet","options","observableClient","useContext","enabled","streamUpdates","otherOptions","objectTypeKey","$objectSetInternals","def","apiName","previousObjectTypeRef","useRef","previousCompletedPayloadRef","objectTypeChanged","current","undefined","stableKey","where","withProperties","union","intersect","subtract","pivotTo","pageSize","orderBy","subscribe","getSnapShot","useMemo","unsubscribe","process","env","NODE_ENV","initialValue","observer","subscription","observeObjectSet","dedupeInterval","dedupeIntervalMs","autoFetchMore","payload","useSyncExternalStore","isPayloadCompleted","lastLoaded","data","resolvedList","isLoading","error","fetchMore","hasMore","objectSet","totalCount","status"],"sources":["useObjectSet.tsx"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n  DerivedProperty,\n  LinkNames,\n  ObjectOrInterfaceDefinition,\n  ObjectSet,\n  Osdk,\n  PropertyKeys,\n  SimplePropertyDef,\n  WhereClause,\n} from \"@osdk/api\";\n\nimport {\n  computeObjectSetCacheKey,\n  type ObserveObjectSetArgs,\n} from \"@osdk/client/unstable-do-not-use\";\nimport React from \"react\";\nimport { makeExternalStore, type Snapshot } from \"./makeExternalStore.js\";\nimport { OsdkContext2 } from \"./OsdkContext2.js\";\n\nexport interface UseObjectSetOptions<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> {\n  /**\n   * Where clause for filtering\n   */\n  where?: WhereClause<Q, RDPs>;\n\n  /**\n   * Derived properties to add to the object set\n   */\n  withProperties?: { [K in keyof RDPs]: DerivedProperty.Creator<Q, RDPs[K]> };\n\n  /**\n   * Object sets to union with\n   */\n  union?: ObjectSet<Q>[];\n\n  /**\n   * Object sets to intersect with\n   */\n  intersect?: ObjectSet<Q>[];\n\n  /**\n   * Object sets to subtract from\n   */\n  subtract?: ObjectSet<Q>[];\n\n  /**\n   * Link to pivot to (changes the type)\n   */\n  pivotTo?: LinkNames<Q>;\n\n  /**\n   * The preferred page size for the list\n   */\n  pageSize?: number;\n\n  /**\n   * Sort order for the results\n   */\n  orderBy?: {\n    [K in PropertyKeys<Q>]?: \"asc\" | \"desc\";\n  };\n\n  /**\n   * Minimum time between fetch requests in milliseconds (defaults to 2000ms)\n   */\n  dedupeIntervalMs?: number;\n\n  /**\n   * Automatically fetch additional pages on initial load.\n   *\n   * - `true`: Fetch all available pages automatically\n   * - `number`: Fetch pages until at least this many items are loaded\n   * - `undefined` (default): Only fetch the first page, user must call fetchMore()\n   */\n  autoFetchMore?: boolean | number;\n\n  /**\n   * Enable streaming updates via websocket subscription.\n   * When true, the object set will automatically update when matching objects are\n   * added, updated, or removed.\n   *\n   * @default false\n   */\n  streamUpdates?: boolean;\n\n  /**\n   * Enable or disable the query.\n   *\n   * When `false`, the query will not automatically execute. It will still\n   * return any cached data, but will not fetch from the server.\n   *\n   * This is useful for:\n   * - Lazy/on-demand queries that should wait for user interaction\n   * - Dependent queries that need data from another query first\n   * - Conditional queries based on component state\n   *\n   * @default true\n   * @example\n   * // Dependent query - wait for filter selection\n   * const { data: filteredObjects } = useObjectSet(MyObject.all(), {\n   *   where: { status: selectedStatus },\n   *   enabled: !!selectedStatus\n   * });\n   */\n  enabled?: boolean;\n}\n\nexport interface UseObjectSetResult<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> {\n  /**\n   * The fetched data with derived properties\n   */\n  data:\n    | Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs>[]\n    | undefined;\n\n  /**\n   * Whether data is currently being loaded\n   */\n  isLoading: boolean;\n\n  /**\n   * Any error that occurred during fetching\n   */\n  error: Error | undefined;\n\n  /**\n   * Function to fetch more pages (undefined if no more pages)\n   */\n  fetchMore: (() => Promise<void>) | undefined;\n\n  /**\n   * The final ObjectSet after all transformations\n   */\n  objectSet: ObjectSet<Q, RDPs>;\n\n  /**\n   * The total count of objects matching the query (if available from the API)\n   */\n  totalCount?: string;\n}\n\ndeclare const process: {\n  env: {\n    NODE_ENV: \"development\" | \"production\";\n  };\n};\n\n/**\n * React hook for observing and interacting with OSDK object sets.\n *\n * @typeParam Q - The object type definition\n * @typeParam BaseRDPs - Derived properties that already exist on the input ObjectSet\n * @typeParam RDPs - New derived properties to be added via options.withProperties\n *\n * @param baseObjectSet - The ObjectSet to observe (may already have derived properties)\n * @param options - Options for filtering, sorting, and adding new derived properties\n * @returns Object set data with both existing and new derived properties\n */\nexport function useObjectSet<\n  Q extends ObjectOrInterfaceDefinition,\n  BaseRDPs extends Record<string, SimplePropertyDef> = never,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n>(\n  baseObjectSet: ObjectSet<Q, BaseRDPs>,\n  options: UseObjectSetOptions<Q, RDPs> = {},\n): UseObjectSetResult<Q, RDPs> {\n  const { observableClient } = React.useContext(OsdkContext2);\n\n  const { enabled = true, streamUpdates, ...otherOptions } = options;\n\n  // Track object type to detect when we switch to a different object type\n  const objectTypeKey = baseObjectSet.$objectSetInternals.def.apiName;\n  const previousObjectTypeRef = React.useRef<string>(objectTypeKey);\n  const previousCompletedPayloadRef = React.useRef<\n    Snapshot<ObserveObjectSetArgs<Q, RDPs>> | undefined\n  >();\n\n  const objectTypeChanged = previousObjectTypeRef.current !== objectTypeKey;\n  if (objectTypeChanged) {\n    previousObjectTypeRef.current = objectTypeKey;\n    previousCompletedPayloadRef.current = undefined;\n  }\n\n  // Compute a stable cache key for the ObjectSet and options\n  // dedupeIntervalMs and enabled are excluded as they don't affect the data\n  const stableKey = computeObjectSetCacheKey(baseObjectSet, {\n    where: otherOptions.where,\n    withProperties: otherOptions.withProperties,\n    union: otherOptions.union,\n    intersect: otherOptions.intersect,\n    subtract: otherOptions.subtract,\n    pivotTo: otherOptions.pivotTo,\n    pageSize: otherOptions.pageSize,\n    orderBy: otherOptions.orderBy,\n  });\n\n  const { subscribe, getSnapShot } = React.useMemo(\n    () => {\n      if (!enabled) {\n        return makeExternalStore<ObserveObjectSetArgs<Q, RDPs>>(\n          () => ({ unsubscribe: () => {} }),\n          process.env.NODE_ENV !== \"production\"\n            ? `objectSet ${stableKey} [DISABLED]`\n            : void 0,\n        );\n      }\n\n      const initialValue = objectTypeChanged\n        ? undefined\n        : previousCompletedPayloadRef.current;\n\n      return makeExternalStore<ObserveObjectSetArgs<Q, RDPs>>(\n        (observer) => {\n          const subscription = observableClient.observeObjectSet(\n            baseObjectSet as ObjectSet<Q>,\n            {\n              where: otherOptions.where,\n              withProperties: otherOptions.withProperties,\n              union: otherOptions.union,\n              intersect: otherOptions.intersect,\n              subtract: otherOptions.subtract,\n              pivotTo: otherOptions.pivotTo,\n              pageSize: otherOptions.pageSize,\n              orderBy: otherOptions.orderBy,\n              dedupeInterval: otherOptions.dedupeIntervalMs ?? 2_000,\n              autoFetchMore: otherOptions.autoFetchMore,\n              streamUpdates,\n            },\n            observer,\n          );\n          return subscription;\n        },\n        process.env.NODE_ENV !== \"production\"\n          ? `objectSet ${stableKey}`\n          : void 0,\n        initialValue,\n      );\n    },\n    [enabled, observableClient, stableKey, streamUpdates, objectTypeChanged],\n  );\n\n  const payload = React.useSyncExternalStore(subscribe, getSnapShot);\n  if (payload && isPayloadCompleted(payload)) {\n    previousCompletedPayloadRef.current = payload;\n  }\n\n  return React.useMemo(() => {\n    const lastLoaded = isPayloadCompleted(payload)\n      ? payload\n      : previousCompletedPayloadRef.current;\n    return {\n      data: lastLoaded?.resolvedList as Osdk.Instance<\n        Q,\n        \"$allBaseProperties\",\n        PropertyKeys<Q>,\n        RDPs\n      >[],\n      isLoading: !isPayloadCompleted(payload),\n      error: lastLoaded && \"error\" in lastLoaded ? lastLoaded.error : undefined,\n      fetchMore: payload?.hasMore ? payload.fetchMore : undefined,\n      objectSet: payload?.objectSet as ObjectSet<Q, RDPs> || baseObjectSet,\n      totalCount: lastLoaded?.totalCount,\n    };\n  }, [payload, baseObjectSet]);\n}\n\nfunction isPayloadCompleted<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef>,\n>(\n  payload: Snapshot<ObserveObjectSetArgs<Q, RDPs>>,\n): boolean {\n  if (payload != null && \"error\" in payload) {\n    return true;\n  }\n\n  if (payload?.status == null) {\n    return false;\n  }\n\n  switch (payload.status) {\n    case \"loaded\":\n    case \"error\":\n      return true;\n    case \"loading\":\n    case \"init\":\n      return false;\n    default:\n      payload.status satisfies never;\n      return false;\n  }\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAaA,SACEA,wBAAwB,QAEnB,kCAAkC;AACzC,OAAOC,KAAK,MAAM,OAAO;AACzB,SAASC,iBAAiB,QAAuB,wBAAwB;AACzE,SAASC,YAAY,QAAQ,mBAAmB;AAwIhD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,YAAYA,CAK1BC,aAAqC,EACrCC,OAAqC,GAAG,CAAC,CAAC,EACb;EAC7B,MAAM;IAAEC;EAAiB,CAAC,GAAGN,KAAK,CAACO,UAAU,CAACL,YAAY,CAAC;EAE3D,MAAM;IAAEM,OAAO,GAAG,IAAI;IAAEC,aAAa;IAAE,GAAGC;EAAa,CAAC,GAAGL,OAAO;;EAElE;EACA,MAAMM,aAAa,GAAGP,aAAa,CAACQ,mBAAmB,CAACC,GAAG,CAACC,OAAO;EACnE,MAAMC,qBAAqB,GAAGf,KAAK,CAACgB,MAAM,CAASL,aAAa,CAAC;EACjE,MAAMM,2BAA2B,GAAGjB,KAAK,CAACgB,MAAM,CAE9C,CAAC;EAEH,MAAME,iBAAiB,GAAGH,qBAAqB,CAACI,OAAO,KAAKR,aAAa;EACzE,IAAIO,iBAAiB,EAAE;IACrBH,qBAAqB,CAACI,OAAO,GAAGR,aAAa;IAC7CM,2BAA2B,CAACE,OAAO,GAAGC,SAAS;EACjD;;EAEA;EACA;EACA,MAAMC,SAAS,GAAGtB,wBAAwB,CAACK,aAAa,EAAE;IACxDkB,KAAK,EAAEZ,YAAY,CAACY,KAAK;IACzBC,cAAc,EAAEb,YAAY,CAACa,cAAc;IAC3CC,KAAK,EAAEd,YAAY,CAACc,KAAK;IACzBC,SAAS,EAAEf,YAAY,CAACe,SAAS;IACjCC,QAAQ,EAAEhB,YAAY,CAACgB,QAAQ;IAC/BC,OAAO,EAAEjB,YAAY,CAACiB,OAAO;IAC7BC,QAAQ,EAAElB,YAAY,CAACkB,QAAQ;IAC/BC,OAAO,EAAEnB,YAAY,CAACmB;EACxB,CAAC,CAAC;EAEF,MAAM;IAAEC,SAAS;IAAEC;EAAY,CAAC,GAAG/B,KAAK,CAACgC,OAAO,CAC9C,MAAM;IACJ,IAAI,CAACxB,OAAO,EAAE;MACZ,OAAOP,iBAAiB,CACtB,OAAO;QAAEgC,WAAW,EAAEA,CAAA,KAAM,CAAC;MAAE,CAAC,CAAC,EACjCC,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,GACjC,aAAaf,SAAS,aAAa,GACnC,KAAK,CACX,CAAC;IACH;IAEA,MAAMgB,YAAY,GAAGnB,iBAAiB,GAClCE,SAAS,GACTH,2BAA2B,CAACE,OAAO;IAEvC,OAAOlB,iBAAiB,CACrBqC,QAAQ,IAAK;MACZ,MAAMC,YAAY,GAAGjC,gBAAgB,CAACkC,gBAAgB,CACpDpC,aAAa,EACb;QACEkB,KAAK,EAAEZ,YAAY,CAACY,KAAK;QACzBC,cAAc,EAAEb,YAAY,CAACa,cAAc;QAC3CC,KAAK,EAAEd,YAAY,CAACc,KAAK;QACzBC,SAAS,EAAEf,YAAY,CAACe,SAAS;QACjCC,QAAQ,EAAEhB,YAAY,CAACgB,QAAQ;QAC/BC,OAAO,EAAEjB,YAAY,CAACiB,OAAO;QAC7BC,QAAQ,EAAElB,YAAY,CAACkB,QAAQ;QAC/BC,OAAO,EAAEnB,YAAY,CAACmB,OAAO;QAC7BY,cAAc,EAAE/B,YAAY,CAACgC,gBAAgB,IAAI,KAAK;QACtDC,aAAa,EAAEjC,YAAY,CAACiC,aAAa;QACzClC;MACF,CAAC,EACD6B,QACF,CAAC;MACD,OAAOC,YAAY;IACrB,CAAC,EACDL,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,GACjC,aAAaf,SAAS,EAAE,GACxB,KAAK,CAAC,EACVgB,YACF,CAAC;EACH,CAAC,EACD,CAAC7B,OAAO,EAAEF,gBAAgB,EAAEe,SAAS,EAAEZ,aAAa,EAAES,iBAAiB,CACzE,CAAC;EAED,MAAM0B,OAAO,GAAG5C,KAAK,CAAC6C,oBAAoB,CAACf,SAAS,EAAEC,WAAW,CAAC;EAClE,IAAIa,OAAO,IAAIE,kBAAkB,CAACF,OAAO,CAAC,EAAE;IAC1C3B,2BAA2B,CAACE,OAAO,GAAGyB,OAAO;EAC/C;EAEA,OAAO5C,KAAK,CAACgC,OAAO,CAAC,MAAM;IACzB,MAAMe,UAAU,GAAGD,kBAAkB,CAACF,OAAO,CAAC,GAC1CA,OAAO,GACP3B,2BAA2B,CAACE,OAAO;IACvC,OAAO;MACL6B,IAAI,EAAED,UAAU,EAAEE,YAKf;MACHC,SAAS,EAAE,CAACJ,kBAAkB,CAACF,OAAO,CAAC;MACvCO,KAAK,EAAEJ,UAAU,IAAI,OAAO,IAAIA,UAAU,GAAGA,UAAU,CAACI,KAAK,GAAG/B,SAAS;MACzEgC,SAAS,EAAER,OAAO,EAAES,OAAO,GAAGT,OAAO,CAACQ,SAAS,GAAGhC,SAAS;MAC3DkC,SAAS,EAAEV,OAAO,EAAEU,SAAS,IAA0BlD,aAAa;MACpEmD,UAAU,EAAER,UAAU,EAAEQ;IAC1B,CAAC;EACH,CAAC,EAAE,CAACX,OAAO,EAAExC,aAAa,CAAC,CAAC;AAC9B;AAEA,SAAS0C,kBAAkBA,CAIzBF,OAAgD,EACvC;EACT,IAAIA,OAAO,IAAI,IAAI,IAAI,OAAO,IAAIA,OAAO,EAAE;IACzC,OAAO,IAAI;EACb;EAEA,IAAIA,OAAO,EAAEY,MAAM,IAAI,IAAI,EAAE;IAC3B,OAAO,KAAK;EACd;EAEA,QAAQZ,OAAO,CAACY,MAAM;IACpB,KAAK,QAAQ;IACb,KAAK,OAAO;MACV,OAAO,IAAI;IACb,KAAK,SAAS;IACd,KAAK,MAAM;MACT,OAAO,KAAK;IACd;MACEZ,OAAO,CAACY,MAAM;MACd,OAAO,KAAK;EAChB;AACF","ignoreList":[]}
+{"version":3,"file":"useObjectSet.js","names":["computeObjectSetCacheKey","React","makeExternalStore","OsdkContext2","OBJECT_TYPE_PLACEHOLDER","useObjectSet","baseObjectSet","options","observableClient","useContext","enabled","streamUpdates","otherOptions","objectTypeKey","$objectSetInternals","def","apiName","previousObjectTypeRef","useRef","previousCompletedPayloadRef","objectTypeChanged","current","undefined","stableKey","where","withProperties","union","intersect","subtract","pivotTo","pageSize","orderBy","select","$select","subscribe","getSnapShot","useMemo","unsubscribe","process","env","NODE_ENV","initialValue","observer","subscription","observeObjectSet","dedupeInterval","dedupeIntervalMs","autoFetchMore","payload","useSyncExternalStore","isPayloadCompleted","lastLoaded","data","resolvedList","isLoading","error","fetchMore","hasMore","objectSet","totalCount","status"],"sources":["useObjectSet.tsx"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n  DerivedProperty,\n  LinkNames,\n  ObjectOrInterfaceDefinition,\n  ObjectSet,\n  Osdk,\n  PropertyKeys,\n  SimplePropertyDef,\n  WhereClause,\n} from \"@osdk/api\";\n\nimport {\n  computeObjectSetCacheKey,\n  type ObserveObjectSetArgs,\n} from \"@osdk/client/unstable-do-not-use\";\nimport React from \"react\";\nimport { makeExternalStore, type Snapshot } from \"./makeExternalStore.js\";\nimport { OsdkContext2 } from \"./OsdkContext2.js\";\n\nexport interface UseObjectSetOptions<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> {\n  /**\n   * Where clause for filtering\n   */\n  where?: WhereClause<Q, RDPs>;\n\n  /**\n   * Derived properties to add to the object set\n   */\n  withProperties?: { [K in keyof RDPs]: DerivedProperty.Creator<Q, RDPs[K]> };\n\n  /**\n   * Object sets to union with\n   */\n  union?: ObjectSet<Q>[];\n\n  /**\n   * Object sets to intersect with\n   */\n  intersect?: ObjectSet<Q>[];\n\n  /**\n   * Object sets to subtract from\n   */\n  subtract?: ObjectSet<Q>[];\n\n  /**\n   * Link to pivot to (changes the type)\n   */\n  pivotTo?: LinkNames<Q>;\n\n  /**\n   * The preferred page size for the list\n   */\n  pageSize?: number;\n\n  /**\n   * Sort order for the results\n   */\n  orderBy?: {\n    [K in PropertyKeys<Q>]?: \"asc\" | \"desc\";\n  };\n\n  /**\n   * Minimum time between fetch requests in milliseconds (defaults to 2000ms)\n   */\n  dedupeIntervalMs?: number;\n\n  /**\n   * Automatically fetch additional pages on initial load.\n   *\n   * - `true`: Fetch all available pages automatically\n   * - `number`: Fetch pages until at least this many items are loaded\n   * - `undefined` (default): Only fetch the first page, user must call fetchMore()\n   */\n  autoFetchMore?: boolean | number;\n\n  /**\n   * Enable streaming updates via websocket subscription.\n   * When true, the object set will automatically update when matching objects are\n   * added, updated, or removed.\n   *\n   * @default false\n   */\n  streamUpdates?: boolean;\n\n  /**\n   * 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  $select?: readonly PropertyKeys<Q>[];\n\n  /**\n   * Enable or disable the query.\n   *\n   * When `false`, the query will not automatically execute. It will still\n   * return any cached data, but will not fetch from the server.\n   *\n   * This is useful for:\n   * - Lazy/on-demand queries that should wait for user interaction\n   * - Dependent queries that need data from another query first\n   * - Conditional queries based on component state\n   *\n   * @default true\n   * @example\n   * // Dependent query - wait for filter selection\n   * const { data: filteredObjects } = useObjectSet(MyObject.all(), {\n   *   where: { status: selectedStatus },\n   *   enabled: !!selectedStatus\n   * });\n   */\n  enabled?: boolean;\n}\n\nexport interface UseObjectSetResult<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> {\n  /**\n   * The fetched data with derived properties\n   */\n  data:\n    | Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs>[]\n    | undefined;\n\n  /**\n   * Whether data is currently being loaded\n   */\n  isLoading: boolean;\n\n  /**\n   * Any error that occurred during fetching\n   */\n  error: Error | undefined;\n\n  /**\n   * Function to fetch more pages (undefined if no more pages)\n   */\n  fetchMore: (() => Promise<void>) | undefined;\n\n  /**\n   * The final ObjectSet after all transformations\n   */\n  objectSet: ObjectSet<Q, RDPs>;\n\n  /**\n   * The total count of objects matching the query (if available from the API)\n   */\n  totalCount?: string;\n}\n\ndeclare const process: {\n  env: {\n    NODE_ENV: \"development\" | \"production\";\n  };\n};\n\nconst OBJECT_TYPE_PLACEHOLDER = \"$__OBJECT__TYPE__PLACEHOLDER\";\n/**\n * React hook for observing and interacting with OSDK object sets.\n *\n * @typeParam Q - The object type definition\n * @typeParam BaseRDPs - Derived properties that already exist on the input ObjectSet\n * @typeParam RDPs - New derived properties to be added via options.withProperties\n *\n * @param baseObjectSet - The ObjectSet to observe (may already have derived properties)\n * @param options - Options for filtering, sorting, and adding new derived properties\n * @returns Object set data with both existing and new derived properties\n */\nexport function useObjectSet<\n  Q extends ObjectOrInterfaceDefinition,\n  BaseRDPs extends Record<string, SimplePropertyDef> = never,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n>(\n  baseObjectSet: ObjectSet<Q, BaseRDPs>,\n  options: UseObjectSetOptions<Q, RDPs> = {},\n): UseObjectSetResult<Q, RDPs> {\n  const { observableClient } = React.useContext(OsdkContext2);\n\n  const { enabled = true, streamUpdates, ...otherOptions } = options;\n\n  // Track object type to detect when we switch to a different object type\n  const objectTypeKey = enabled\n    ? baseObjectSet.$objectSetInternals.def.apiName\n    : OBJECT_TYPE_PLACEHOLDER;\n\n  const previousObjectTypeRef = React.useRef<string>(objectTypeKey);\n  const previousCompletedPayloadRef = React.useRef<\n    Snapshot<ObserveObjectSetArgs<Q, RDPs>> | undefined\n  >();\n\n  const objectTypeChanged = previousObjectTypeRef.current !== objectTypeKey;\n  if (objectTypeChanged) {\n    previousObjectTypeRef.current = objectTypeKey;\n    previousCompletedPayloadRef.current = undefined;\n  }\n\n  // Compute a stable cache key for the ObjectSet and options\n  // dedupeIntervalMs and enabled are excluded as they don't affect the data\n  const stableKey = computeObjectSetCacheKey(baseObjectSet, {\n    where: otherOptions.where,\n    withProperties: otherOptions.withProperties,\n    union: otherOptions.union,\n    intersect: otherOptions.intersect,\n    subtract: otherOptions.subtract,\n    pivotTo: otherOptions.pivotTo,\n    pageSize: otherOptions.pageSize,\n    orderBy: otherOptions.orderBy,\n    select: otherOptions.$select,\n  });\n\n  const { subscribe, getSnapShot } = React.useMemo(\n    () => {\n      if (!enabled) {\n        return makeExternalStore<ObserveObjectSetArgs<Q, RDPs>>(\n          () => ({ unsubscribe: () => {} }),\n          process.env.NODE_ENV !== \"production\"\n            ? `objectSet ${stableKey} [DISABLED]`\n            : void 0,\n        );\n      }\n\n      const initialValue = objectTypeChanged\n        ? undefined\n        : previousCompletedPayloadRef.current;\n\n      return makeExternalStore<ObserveObjectSetArgs<Q, RDPs>>(\n        (observer) => {\n          const subscription = observableClient.observeObjectSet(\n            baseObjectSet as ObjectSet<Q>,\n            {\n              where: otherOptions.where,\n              withProperties: otherOptions.withProperties,\n              union: otherOptions.union,\n              intersect: otherOptions.intersect,\n              subtract: otherOptions.subtract,\n              pivotTo: otherOptions.pivotTo,\n              pageSize: otherOptions.pageSize,\n              orderBy: otherOptions.orderBy,\n              dedupeInterval: otherOptions.dedupeIntervalMs ?? 2_000,\n              autoFetchMore: otherOptions.autoFetchMore,\n              streamUpdates,\n              select: otherOptions.$select,\n            },\n            observer,\n          );\n          return subscription;\n        },\n        process.env.NODE_ENV !== \"production\"\n          ? `objectSet ${stableKey}`\n          : void 0,\n        initialValue,\n      );\n    },\n    [enabled, observableClient, stableKey, streamUpdates, objectTypeChanged],\n  );\n\n  const payload = React.useSyncExternalStore(subscribe, getSnapShot);\n  if (payload && isPayloadCompleted(payload)) {\n    previousCompletedPayloadRef.current = payload;\n  }\n\n  return React.useMemo(() => {\n    const lastLoaded = isPayloadCompleted(payload)\n      ? payload\n      : previousCompletedPayloadRef.current;\n    return {\n      data: lastLoaded?.resolvedList as Osdk.Instance<\n        Q,\n        \"$allBaseProperties\",\n        PropertyKeys<Q>,\n        RDPs\n      >[],\n      isLoading: !isPayloadCompleted(payload),\n      error: lastLoaded && \"error\" in lastLoaded ? lastLoaded.error : undefined,\n      fetchMore: payload?.hasMore ? payload.fetchMore : undefined,\n      objectSet: payload?.objectSet as ObjectSet<Q, RDPs> || baseObjectSet,\n      totalCount: lastLoaded?.totalCount,\n    };\n  }, [payload, baseObjectSet]);\n}\n\nfunction isPayloadCompleted<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef>,\n>(\n  payload: Snapshot<ObserveObjectSetArgs<Q, RDPs>>,\n): boolean {\n  if (payload != null && \"error\" in payload) {\n    return true;\n  }\n\n  if (payload?.status == null) {\n    return false;\n  }\n\n  switch (payload.status) {\n    case \"loaded\":\n    case \"error\":\n      return true;\n    case \"loading\":\n    case \"init\":\n      return false;\n    default:\n      payload.status satisfies never;\n      return false;\n  }\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAaA,SACEA,wBAAwB,QAEnB,kCAAkC;AACzC,OAAOC,KAAK,MAAM,OAAO;AACzB,SAASC,iBAAiB,QAAuB,wBAAwB;AACzE,SAASC,YAAY,QAAQ,mBAAmB;AA+IhD,MAAMC,uBAAuB,GAAG,8BAA8B;AAC9D;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,YAAYA,CAK1BC,aAAqC,EACrCC,OAAqC,GAAG,CAAC,CAAC,EACb;EAC7B,MAAM;IAAEC;EAAiB,CAAC,GAAGP,KAAK,CAACQ,UAAU,CAACN,YAAY,CAAC;EAE3D,MAAM;IAAEO,OAAO,GAAG,IAAI;IAAEC,aAAa;IAAE,GAAGC;EAAa,CAAC,GAAGL,OAAO;;EAElE;EACA,MAAMM,aAAa,GAAGH,OAAO,GACzBJ,aAAa,CAACQ,mBAAmB,CAACC,GAAG,CAACC,OAAO,GAC7CZ,uBAAuB;EAE3B,MAAMa,qBAAqB,GAAGhB,KAAK,CAACiB,MAAM,CAASL,aAAa,CAAC;EACjE,MAAMM,2BAA2B,GAAGlB,KAAK,CAACiB,MAAM,CAE9C,CAAC;EAEH,MAAME,iBAAiB,GAAGH,qBAAqB,CAACI,OAAO,KAAKR,aAAa;EACzE,IAAIO,iBAAiB,EAAE;IACrBH,qBAAqB,CAACI,OAAO,GAAGR,aAAa;IAC7CM,2BAA2B,CAACE,OAAO,GAAGC,SAAS;EACjD;;EAEA;EACA;EACA,MAAMC,SAAS,GAAGvB,wBAAwB,CAACM,aAAa,EAAE;IACxDkB,KAAK,EAAEZ,YAAY,CAACY,KAAK;IACzBC,cAAc,EAAEb,YAAY,CAACa,cAAc;IAC3CC,KAAK,EAAEd,YAAY,CAACc,KAAK;IACzBC,SAAS,EAAEf,YAAY,CAACe,SAAS;IACjCC,QAAQ,EAAEhB,YAAY,CAACgB,QAAQ;IAC/BC,OAAO,EAAEjB,YAAY,CAACiB,OAAO;IAC7BC,QAAQ,EAAElB,YAAY,CAACkB,QAAQ;IAC/BC,OAAO,EAAEnB,YAAY,CAACmB,OAAO;IAC7BC,MAAM,EAAEpB,YAAY,CAACqB;EACvB,CAAC,CAAC;EAEF,MAAM;IAAEC,SAAS;IAAEC;EAAY,CAAC,GAAGlC,KAAK,CAACmC,OAAO,CAC9C,MAAM;IACJ,IAAI,CAAC1B,OAAO,EAAE;MACZ,OAAOR,iBAAiB,CACtB,OAAO;QAAEmC,WAAW,EAAEA,CAAA,KAAM,CAAC;MAAE,CAAC,CAAC,EACjCC,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,GACjC,aAAajB,SAAS,aAAa,GACnC,KAAK,CACX,CAAC;IACH;IAEA,MAAMkB,YAAY,GAAGrB,iBAAiB,GAClCE,SAAS,GACTH,2BAA2B,CAACE,OAAO;IAEvC,OAAOnB,iBAAiB,CACrBwC,QAAQ,IAAK;MACZ,MAAMC,YAAY,GAAGnC,gBAAgB,CAACoC,gBAAgB,CACpDtC,aAAa,EACb;QACEkB,KAAK,EAAEZ,YAAY,CAACY,KAAK;QACzBC,cAAc,EAAEb,YAAY,CAACa,cAAc;QAC3CC,KAAK,EAAEd,YAAY,CAACc,KAAK;QACzBC,SAAS,EAAEf,YAAY,CAACe,SAAS;QACjCC,QAAQ,EAAEhB,YAAY,CAACgB,QAAQ;QAC/BC,OAAO,EAAEjB,YAAY,CAACiB,OAAO;QAC7BC,QAAQ,EAAElB,YAAY,CAACkB,QAAQ;QAC/BC,OAAO,EAAEnB,YAAY,CAACmB,OAAO;QAC7Bc,cAAc,EAAEjC,YAAY,CAACkC,gBAAgB,IAAI,KAAK;QACtDC,aAAa,EAAEnC,YAAY,CAACmC,aAAa;QACzCpC,aAAa;QACbqB,MAAM,EAAEpB,YAAY,CAACqB;MACvB,CAAC,EACDS,QACF,CAAC;MACD,OAAOC,YAAY;IACrB,CAAC,EACDL,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,GACjC,aAAajB,SAAS,EAAE,GACxB,KAAK,CAAC,EACVkB,YACF,CAAC;EACH,CAAC,EACD,CAAC/B,OAAO,EAAEF,gBAAgB,EAAEe,SAAS,EAAEZ,aAAa,EAAES,iBAAiB,CACzE,CAAC;EAED,MAAM4B,OAAO,GAAG/C,KAAK,CAACgD,oBAAoB,CAACf,SAAS,EAAEC,WAAW,CAAC;EAClE,IAAIa,OAAO,IAAIE,kBAAkB,CAACF,OAAO,CAAC,EAAE;IAC1C7B,2BAA2B,CAACE,OAAO,GAAG2B,OAAO;EAC/C;EAEA,OAAO/C,KAAK,CAACmC,OAAO,CAAC,MAAM;IACzB,MAAMe,UAAU,GAAGD,kBAAkB,CAACF,OAAO,CAAC,GAC1CA,OAAO,GACP7B,2BAA2B,CAACE,OAAO;IACvC,OAAO;MACL+B,IAAI,EAAED,UAAU,EAAEE,YAKf;MACHC,SAAS,EAAE,CAACJ,kBAAkB,CAACF,OAAO,CAAC;MACvCO,KAAK,EAAEJ,UAAU,IAAI,OAAO,IAAIA,UAAU,GAAGA,UAAU,CAACI,KAAK,GAAGjC,SAAS;MACzEkC,SAAS,EAAER,OAAO,EAAES,OAAO,GAAGT,OAAO,CAACQ,SAAS,GAAGlC,SAAS;MAC3DoC,SAAS,EAAEV,OAAO,EAAEU,SAAS,IAA0BpD,aAAa;MACpEqD,UAAU,EAAER,UAAU,EAAEQ;IAC1B,CAAC;EACH,CAAC,EAAE,CAACX,OAAO,EAAE1C,aAAa,CAAC,CAAC;AAC9B;AAEA,SAAS4C,kBAAkBA,CAIzBF,OAAgD,EACvC;EACT,IAAIA,OAAO,IAAI,IAAI,IAAI,OAAO,IAAIA,OAAO,EAAE;IACzC,OAAO,IAAI;EACb;EAEA,IAAIA,OAAO,EAAEY,MAAM,IAAI,IAAI,EAAE;IAC3B,OAAO,KAAK;EACd;EAEA,QAAQZ,OAAO,CAACY,MAAM;IACpB,KAAK,QAAQ;IACb,KAAK,OAAO;MACV,OAAO,IAAI;IACb,KAAK,SAAS;IACd,KAAK,MAAM;MACT,OAAO,KAAK;IACd;MACEZ,OAAO,CAACY,MAAM;MACd,OAAO,KAAK;EAChB;AACF","ignoreList":[]}

package/build/browser/new/useOsdkAction.js

@@ -135,7 +135,7 @@ export function useOsdkAction(actionDef) {
       }
     };
   }, []);
-  return {
+  return React.useMemo(() => ({
     applyAction,
     validateAction,
     error,
@@ -143,6 +143,6 @@ export function useOsdkAction(actionDef) {
     isPending,
     isValidating,
     validationResult
-  };
+  }), [applyAction, validateAction, error, data, isPending, isValidating, validationResult]);
 }
 //# sourceMappingURL=useOsdkAction.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"useOsdkAction.js","names":["ActionValidationError","React","OsdkContext2","useOsdkAction","actionDef","observableClient","useContext","error","setError","useState","data","setData","isPending","setPending","isValidating","setValidating","validationResult","setValidationResult","abortControllerRef","useRef","applyAction","useCallback","hookArgs","current","abort","undefined","Array","isArray","updates","args","map","a","$optimisticUpdate","push","r","optimisticUpdate","ctx","update","e","actionValidation","unknown","validateAction","abortController","AbortController","result","signal","aborted","Error","name","useEffect"],"sources":["useOsdkAction.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  ActionDefinition,\n  ActionEditResponse,\n  ActionValidationResponse,\n} from \"@osdk/client\";\nimport { ActionValidationError } from \"@osdk/client\";\nimport type {\n  ActionSignatureFromDef,\n  ObservableClient,\n} from \"@osdk/client/unstable-do-not-use\";\nimport React from \"react\";\nimport { OsdkContext2 } from \"./OsdkContext2.js\";\n\ntype ApplyActionParams<Q extends ActionDefinition<any>> =\n  & Parameters<ActionSignatureFromDef<Q>[\"applyAction\"]>[0]\n  & {\n    [K in keyof ObservableClient.ApplyActionOptions as `$${K}`]:\n      ObservableClient.ApplyActionOptions[K];\n  };\n\nexport interface UseOsdkActionResult<Q extends ActionDefinition<any>> {\n  applyAction: (\n    args: ApplyActionParams<Q> | Array<ApplyActionParams<Q>>,\n  ) => Promise<ActionEditResponse | undefined>;\n\n  error:\n    | undefined\n    | Partial<{\n      actionValidation: ActionValidationError;\n      unknown: unknown;\n    }>;\n  data: ActionEditResponse | undefined;\n\n  isPending: boolean;\n  isValidating: boolean;\n\n  /**\n   * Validates the action with the provided arguments without executing it.\n   * Calling this function again before the previous validation finishes will cancel\n   * the first validation and start a new one.\n   * @param args The action arguments to validate\n   * @returns A promise that resolves to the validation response, or undefined if aborted\n   */\n  validateAction: (\n    args: Parameters<ActionSignatureFromDef<Q>[\"applyAction\"]>[0],\n  ) => Promise<ActionValidationResponse | undefined>;\n\n  validationResult?: ActionValidationResponse;\n}\n\nexport function useOsdkAction<Q extends ActionDefinition<any>>(\n  actionDef: Q,\n): UseOsdkActionResult<Q> {\n  const { observableClient } = React.useContext(OsdkContext2);\n  const [error, setError] = React.useState<UseOsdkActionResult<Q>[\"error\"]>();\n  const [data, setData] = React.useState<ActionEditResponse | undefined>();\n  const [isPending, setPending] = React.useState(false);\n  const [isValidating, setValidating] = React.useState(false);\n  const [validationResult, setValidationResult] = React.useState<\n    ActionValidationResponse | undefined\n  >();\n  const abortControllerRef = React.useRef<AbortController | null>(null);\n\n  const applyAction = React.useCallback(async function applyAction(\n    hookArgs: ApplyActionParams<Q> | Array<ApplyActionParams<Q>>,\n  ) {\n    try {\n      // If validation is in progress, abort it\n      if (isValidating && abortControllerRef.current) {\n        abortControllerRef.current.abort();\n        setValidating(false);\n      }\n\n      setPending(true);\n      setError(undefined);\n\n      if (Array.isArray(hookArgs)) {\n        const updates: Array<\n          ObservableClient.ApplyActionOptions[\"optimisticUpdate\"]\n        > = [];\n        const args = hookArgs.map(a => {\n          const { $optimisticUpdate, ...args } = a;\n          if ($optimisticUpdate) {\n            updates.push($optimisticUpdate);\n          }\n          return args;\n        });\n\n        const r = await observableClient.applyAction(actionDef, args, {\n          optimisticUpdate: (ctx) => {\n            for (const update of updates) {\n              update?.(ctx);\n            }\n          },\n        });\n        setData(r);\n        return r;\n      } else {\n        const { $optimisticUpdate, ...args } = hookArgs;\n\n        const r = await observableClient.applyAction(actionDef, args, {\n          optimisticUpdate: $optimisticUpdate,\n        });\n        setData(r);\n        return r;\n      }\n    } catch (e) {\n      if (e instanceof ActionValidationError) {\n        setError({\n          actionValidation: e,\n        });\n      } else {\n        setError({ unknown: e });\n      }\n    } finally {\n      setPending(false);\n    }\n  }, [observableClient, actionDef, isValidating]);\n\n  const validateAction = React.useCallback(async function validateAction(\n    args: Parameters<ActionSignatureFromDef<Q>[\"applyAction\"]>[0],\n  ): Promise<ActionValidationResponse | undefined> {\n    try {\n      // Check if action is being applied\n      if (isPending) {\n        return undefined;\n      }\n\n      // Abort any existing validation\n      if (abortControllerRef.current) {\n        abortControllerRef.current.abort();\n      }\n\n      // Create new AbortController\n      const abortController = new AbortController();\n      abortControllerRef.current = abortController;\n\n      setValidating(true);\n      setError(undefined);\n\n      const result = await observableClient.validateAction(actionDef, args);\n\n      // Check if aborted\n      if (abortController.signal.aborted) {\n        return undefined;\n      }\n\n      setValidationResult(result);\n      return result;\n    } catch (e) {\n      // Check if it was aborted\n      if (e instanceof Error && e.name === \"AbortError\") {\n        return undefined;\n      }\n\n      if (e instanceof ActionValidationError) {\n        setError({\n          actionValidation: e,\n        });\n      } else {\n        setError({ unknown: e });\n      }\n      throw e;\n    } finally {\n      setValidating(false);\n    }\n  }, [observableClient, actionDef, isPending]);\n\n  // Cleanup on unmount\n  React.useEffect(() => {\n    return () => {\n      if (abortControllerRef.current) {\n        abortControllerRef.current.abort();\n      }\n    };\n  }, []);\n\n  return {\n    applyAction,\n    validateAction,\n    error,\n    data,\n    isPending,\n    isValidating,\n    validationResult,\n  };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAOA,SAASA,qBAAqB,QAAQ,cAAc;AAKpD,OAAOC,KAAK,MAAM,OAAO;AACzB,SAASC,YAAY,QAAQ,mBAAmB;AAuChD,OAAO,SAASC,aAAaA,CAC3BC,SAAY,EACY;EACxB,MAAM;IAAEC;EAAiB,CAAC,GAAGJ,KAAK,CAACK,UAAU,CAACJ,YAAY,CAAC;EAC3D,MAAM,CAACK,KAAK,EAAEC,QAAQ,CAAC,GAAGP,KAAK,CAACQ,QAAQ,CAAkC,CAAC;EAC3E,MAAM,CAACC,IAAI,EAAEC,OAAO,CAAC,GAAGV,KAAK,CAACQ,QAAQ,CAAiC,CAAC;EACxE,MAAM,CAACG,SAAS,EAAEC,UAAU,CAAC,GAAGZ,KAAK,CAACQ,QAAQ,CAAC,KAAK,CAAC;EACrD,MAAM,CAACK,YAAY,EAAEC,aAAa,CAAC,GAAGd,KAAK,CAACQ,QAAQ,CAAC,KAAK,CAAC;EAC3D,MAAM,CAACO,gBAAgB,EAAEC,mBAAmB,CAAC,GAAGhB,KAAK,CAACQ,QAAQ,CAE5D,CAAC;EACH,MAAMS,kBAAkB,GAAGjB,KAAK,CAACkB,MAAM,CAAyB,IAAI,CAAC;EAErE,MAAMC,WAAW,GAAGnB,KAAK,CAACoB,WAAW,CAAC,gBACpCC,QAA4D,EAC5D;IACA,IAAI;MACF;MACA,IAAIR,YAAY,IAAII,kBAAkB,CAACK,OAAO,EAAE;QAC9CL,kBAAkB,CAACK,OAAO,CAACC,KAAK,CAAC,CAAC;QAClCT,aAAa,CAAC,KAAK,CAAC;MACtB;MAEAF,UAAU,CAAC,IAAI,CAAC;MAChBL,QAAQ,CAACiB,SAAS,CAAC;MAEnB,IAAIC,KAAK,CAACC,OAAO,CAACL,QAAQ,CAAC,EAAE;QAC3B,MAAMM,OAEL,GAAG,EAAE;QACN,MAAMC,IAAI,GAAGP,QAAQ,CAACQ,GAAG,CAACC,CAAC,IAAI;UAC7B,MAAM;YAAEC,iBAAiB;YAAE,GAAGH;UAAK,CAAC,GAAGE,CAAC;UACxC,IAAIC,iBAAiB,EAAE;YACrBJ,OAAO,CAACK,IAAI,CAACD,iBAAiB,CAAC;UACjC;UACA,OAAOH,IAAI;QACb,CAAC,CAAC;QAEF,MAAMK,CAAC,GAAG,MAAM7B,gBAAgB,CAACe,WAAW,CAAChB,SAAS,EAAEyB,IAAI,EAAE;UAC5DM,gBAAgB,EAAGC,GAAG,IAAK;YACzB,KAAK,MAAMC,MAAM,IAAIT,OAAO,EAAE;cAC5BS,MAAM,GAAGD,GAAG,CAAC;YACf;UACF;QACF,CAAC,CAAC;QACFzB,OAAO,CAACuB,CAAC,CAAC;QACV,OAAOA,CAAC;MACV,CAAC,MAAM;QACL,MAAM;UAAEF,iBAAiB;UAAE,GAAGH;QAAK,CAAC,GAAGP,QAAQ;QAE/C,MAAMY,CAAC,GAAG,MAAM7B,gBAAgB,CAACe,WAAW,CAAChB,SAAS,EAAEyB,IAAI,EAAE;UAC5DM,gBAAgB,EAAEH;QACpB,CAAC,CAAC;QACFrB,OAAO,CAACuB,CAAC,CAAC;QACV,OAAOA,CAAC;MACV;IACF,CAAC,CAAC,OAAOI,CAAC,EAAE;MACV,IAAIA,CAAC,YAAYtC,qBAAqB,EAAE;QACtCQ,QAAQ,CAAC;UACP+B,gBAAgB,EAAED;QACpB,CAAC,CAAC;MACJ,CAAC,MAAM;QACL9B,QAAQ,CAAC;UAAEgC,OAAO,EAAEF;QAAE,CAAC,CAAC;MAC1B;IACF,CAAC,SAAS;MACRzB,UAAU,CAAC,KAAK,CAAC;IACnB;EACF,CAAC,EAAE,CAACR,gBAAgB,EAAED,SAAS,EAAEU,YAAY,CAAC,CAAC;EAE/C,MAAM2B,cAAc,GAAGxC,KAAK,CAACoB,WAAW,CAAC,gBACvCQ,IAA6D,EACd;IAC/C,IAAI;MACF;MACA,IAAIjB,SAAS,EAAE;QACb,OAAOa,SAAS;MAClB;;MAEA;MACA,IAAIP,kBAAkB,CAACK,OAAO,EAAE;QAC9BL,kBAAkB,CAACK,OAAO,CAACC,KAAK,CAAC,CAAC;MACpC;;MAEA;MACA,MAAMkB,eAAe,GAAG,IAAIC,eAAe,CAAC,CAAC;MAC7CzB,kBAAkB,CAACK,OAAO,GAAGmB,eAAe;MAE5C3B,aAAa,CAAC,IAAI,CAAC;MACnBP,QAAQ,CAACiB,SAAS,CAAC;MAEnB,MAAMmB,MAAM,GAAG,MAAMvC,gBAAgB,CAACoC,cAAc,CAACrC,SAAS,EAAEyB,IAAI,CAAC;;MAErE;MACA,IAAIa,eAAe,CAACG,MAAM,CAACC,OAAO,EAAE;QAClC,OAAOrB,SAAS;MAClB;MAEAR,mBAAmB,CAAC2B,MAAM,CAAC;MAC3B,OAAOA,MAAM;IACf,CAAC,CAAC,OAAON,CAAC,EAAE;MACV;MACA,IAAIA,CAAC,YAAYS,KAAK,IAAIT,CAAC,CAACU,IAAI,KAAK,YAAY,EAAE;QACjD,OAAOvB,SAAS;MAClB;MAEA,IAAIa,CAAC,YAAYtC,qBAAqB,EAAE;QACtCQ,QAAQ,CAAC;UACP+B,gBAAgB,EAAED;QACpB,CAAC,CAAC;MACJ,CAAC,MAAM;QACL9B,QAAQ,CAAC;UAAEgC,OAAO,EAAEF;QAAE,CAAC,CAAC;MAC1B;MACA,MAAMA,CAAC;IACT,CAAC,SAAS;MACRvB,aAAa,CAAC,KAAK,CAAC;IACtB;EACF,CAAC,EAAE,CAACV,gBAAgB,EAAED,SAAS,EAAEQ,SAAS,CAAC,CAAC;;EAE5C;EACAX,KAAK,CAACgD,SAAS,CAAC,MAAM;IACpB,OAAO,MAAM;MACX,IAAI/B,kBAAkB,CAACK,OAAO,EAAE;QAC9BL,kBAAkB,CAACK,OAAO,CAACC,KAAK,CAAC,CAAC;MACpC;IACF,CAAC;EACH,CAAC,EAAE,EAAE,CAAC;EAEN,OAAO;IACLJ,WAAW;IACXqB,cAAc;IACdlC,KAAK;IACLG,IAAI;IACJE,SAAS;IACTE,YAAY;IACZE;EACF,CAAC;AACH","ignoreList":[]}
+{"version":3,"file":"useOsdkAction.js","names":["ActionValidationError","React","OsdkContext2","useOsdkAction","actionDef","observableClient","useContext","error","setError","useState","data","setData","isPending","setPending","isValidating","setValidating","validationResult","setValidationResult","abortControllerRef","useRef","applyAction","useCallback","hookArgs","current","abort","undefined","Array","isArray","updates","args","map","a","$optimisticUpdate","push","r","optimisticUpdate","ctx","update","e","actionValidation","unknown","validateAction","abortController","AbortController","result","signal","aborted","Error","name","useEffect","useMemo"],"sources":["useOsdkAction.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  ActionDefinition,\n  ActionEditResponse,\n  ActionValidationResponse,\n} from \"@osdk/client\";\nimport { ActionValidationError } from \"@osdk/client\";\nimport type {\n  ActionSignatureFromDef,\n  ObservableClient,\n} from \"@osdk/client/unstable-do-not-use\";\nimport React from \"react\";\nimport { OsdkContext2 } from \"./OsdkContext2.js\";\n\ntype ApplyActionParams<Q extends ActionDefinition<any>> =\n  & Parameters<ActionSignatureFromDef<Q>[\"applyAction\"]>[0]\n  & {\n    [K in keyof ObservableClient.ApplyActionOptions as `$${K}`]:\n      ObservableClient.ApplyActionOptions[K];\n  };\n\nexport interface UseOsdkActionResult<Q extends ActionDefinition<any>> {\n  applyAction: (\n    args: ApplyActionParams<Q> | Array<ApplyActionParams<Q>>,\n  ) => Promise<ActionEditResponse | undefined>;\n\n  error:\n    | undefined\n    | Partial<{\n      actionValidation: ActionValidationError;\n      unknown: unknown;\n    }>;\n  data: ActionEditResponse | undefined;\n\n  isPending: boolean;\n  isValidating: boolean;\n\n  /**\n   * Validates the action with the provided arguments without executing it.\n   * Calling this function again before the previous validation finishes will cancel\n   * the first validation and start a new one.\n   * @param args The action arguments to validate\n   * @returns A promise that resolves to the validation response, or undefined if aborted\n   */\n  validateAction: (\n    args: Parameters<ActionSignatureFromDef<Q>[\"applyAction\"]>[0],\n  ) => Promise<ActionValidationResponse | undefined>;\n\n  validationResult?: ActionValidationResponse;\n}\n\nexport function useOsdkAction<Q extends ActionDefinition<any>>(\n  actionDef: Q,\n): UseOsdkActionResult<Q> {\n  const { observableClient } = React.useContext(OsdkContext2);\n  const [error, setError] = React.useState<UseOsdkActionResult<Q>[\"error\"]>();\n  const [data, setData] = React.useState<ActionEditResponse | undefined>();\n  const [isPending, setPending] = React.useState(false);\n  const [isValidating, setValidating] = React.useState(false);\n  const [validationResult, setValidationResult] = React.useState<\n    ActionValidationResponse | undefined\n  >();\n  const abortControllerRef = React.useRef<AbortController | null>(null);\n\n  const applyAction = React.useCallback(async function applyAction(\n    hookArgs: ApplyActionParams<Q> | Array<ApplyActionParams<Q>>,\n  ) {\n    try {\n      // If validation is in progress, abort it\n      if (isValidating && abortControllerRef.current) {\n        abortControllerRef.current.abort();\n        setValidating(false);\n      }\n\n      setPending(true);\n      setError(undefined);\n\n      if (Array.isArray(hookArgs)) {\n        const updates: Array<\n          ObservableClient.ApplyActionOptions[\"optimisticUpdate\"]\n        > = [];\n        const args = hookArgs.map(a => {\n          const { $optimisticUpdate, ...args } = a;\n          if ($optimisticUpdate) {\n            updates.push($optimisticUpdate);\n          }\n          return args;\n        });\n\n        const r = await observableClient.applyAction(actionDef, args, {\n          optimisticUpdate: (ctx) => {\n            for (const update of updates) {\n              update?.(ctx);\n            }\n          },\n        });\n        setData(r);\n        return r;\n      } else {\n        const { $optimisticUpdate, ...args } = hookArgs;\n\n        const r = await observableClient.applyAction(actionDef, args, {\n          optimisticUpdate: $optimisticUpdate,\n        });\n        setData(r);\n        return r;\n      }\n    } catch (e) {\n      if (e instanceof ActionValidationError) {\n        setError({\n          actionValidation: e,\n        });\n      } else {\n        setError({ unknown: e });\n      }\n    } finally {\n      setPending(false);\n    }\n  }, [observableClient, actionDef, isValidating]);\n\n  const validateAction = React.useCallback(async function validateAction(\n    args: Parameters<ActionSignatureFromDef<Q>[\"applyAction\"]>[0],\n  ): Promise<ActionValidationResponse | undefined> {\n    try {\n      // Check if action is being applied\n      if (isPending) {\n        return undefined;\n      }\n\n      // Abort any existing validation\n      if (abortControllerRef.current) {\n        abortControllerRef.current.abort();\n      }\n\n      // Create new AbortController\n      const abortController = new AbortController();\n      abortControllerRef.current = abortController;\n\n      setValidating(true);\n      setError(undefined);\n\n      const result = await observableClient.validateAction(actionDef, args);\n\n      // Check if aborted\n      if (abortController.signal.aborted) {\n        return undefined;\n      }\n\n      setValidationResult(result);\n      return result;\n    } catch (e) {\n      // Check if it was aborted\n      if (e instanceof Error && e.name === \"AbortError\") {\n        return undefined;\n      }\n\n      if (e instanceof ActionValidationError) {\n        setError({\n          actionValidation: e,\n        });\n      } else {\n        setError({ unknown: e });\n      }\n      throw e;\n    } finally {\n      setValidating(false);\n    }\n  }, [observableClient, actionDef, isPending]);\n\n  // Cleanup on unmount\n  React.useEffect(() => {\n    return () => {\n      if (abortControllerRef.current) {\n        abortControllerRef.current.abort();\n      }\n    };\n  }, []);\n\n  return React.useMemo(() => ({\n    applyAction,\n    validateAction,\n    error,\n    data,\n    isPending,\n    isValidating,\n    validationResult,\n  }), [\n    applyAction,\n    validateAction,\n    error,\n    data,\n    isPending,\n    isValidating,\n    validationResult,\n  ]);\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAOA,SAASA,qBAAqB,QAAQ,cAAc;AAKpD,OAAOC,KAAK,MAAM,OAAO;AACzB,SAASC,YAAY,QAAQ,mBAAmB;AAuChD,OAAO,SAASC,aAAaA,CAC3BC,SAAY,EACY;EACxB,MAAM;IAAEC;EAAiB,CAAC,GAAGJ,KAAK,CAACK,UAAU,CAACJ,YAAY,CAAC;EAC3D,MAAM,CAACK,KAAK,EAAEC,QAAQ,CAAC,GAAGP,KAAK,CAACQ,QAAQ,CAAkC,CAAC;EAC3E,MAAM,CAACC,IAAI,EAAEC,OAAO,CAAC,GAAGV,KAAK,CAACQ,QAAQ,CAAiC,CAAC;EACxE,MAAM,CAACG,SAAS,EAAEC,UAAU,CAAC,GAAGZ,KAAK,CAACQ,QAAQ,CAAC,KAAK,CAAC;EACrD,MAAM,CAACK,YAAY,EAAEC,aAAa,CAAC,GAAGd,KAAK,CAACQ,QAAQ,CAAC,KAAK,CAAC;EAC3D,MAAM,CAACO,gBAAgB,EAAEC,mBAAmB,CAAC,GAAGhB,KAAK,CAACQ,QAAQ,CAE5D,CAAC;EACH,MAAMS,kBAAkB,GAAGjB,KAAK,CAACkB,MAAM,CAAyB,IAAI,CAAC;EAErE,MAAMC,WAAW,GAAGnB,KAAK,CAACoB,WAAW,CAAC,gBACpCC,QAA4D,EAC5D;IACA,IAAI;MACF;MACA,IAAIR,YAAY,IAAII,kBAAkB,CAACK,OAAO,EAAE;QAC9CL,kBAAkB,CAACK,OAAO,CAACC,KAAK,CAAC,CAAC;QAClCT,aAAa,CAAC,KAAK,CAAC;MACtB;MAEAF,UAAU,CAAC,IAAI,CAAC;MAChBL,QAAQ,CAACiB,SAAS,CAAC;MAEnB,IAAIC,KAAK,CAACC,OAAO,CAACL,QAAQ,CAAC,EAAE;QAC3B,MAAMM,OAEL,GAAG,EAAE;QACN,MAAMC,IAAI,GAAGP,QAAQ,CAACQ,GAAG,CAACC,CAAC,IAAI;UAC7B,MAAM;YAAEC,iBAAiB;YAAE,GAAGH;UAAK,CAAC,GAAGE,CAAC;UACxC,IAAIC,iBAAiB,EAAE;YACrBJ,OAAO,CAACK,IAAI,CAACD,iBAAiB,CAAC;UACjC;UACA,OAAOH,IAAI;QACb,CAAC,CAAC;QAEF,MAAMK,CAAC,GAAG,MAAM7B,gBAAgB,CAACe,WAAW,CAAChB,SAAS,EAAEyB,IAAI,EAAE;UAC5DM,gBAAgB,EAAGC,GAAG,IAAK;YACzB,KAAK,MAAMC,MAAM,IAAIT,OAAO,EAAE;cAC5BS,MAAM,GAAGD,GAAG,CAAC;YACf;UACF;QACF,CAAC,CAAC;QACFzB,OAAO,CAACuB,CAAC,CAAC;QACV,OAAOA,CAAC;MACV,CAAC,MAAM;QACL,MAAM;UAAEF,iBAAiB;UAAE,GAAGH;QAAK,CAAC,GAAGP,QAAQ;QAE/C,MAAMY,CAAC,GAAG,MAAM7B,gBAAgB,CAACe,WAAW,CAAChB,SAAS,EAAEyB,IAAI,EAAE;UAC5DM,gBAAgB,EAAEH;QACpB,CAAC,CAAC;QACFrB,OAAO,CAACuB,CAAC,CAAC;QACV,OAAOA,CAAC;MACV;IACF,CAAC,CAAC,OAAOI,CAAC,EAAE;MACV,IAAIA,CAAC,YAAYtC,qBAAqB,EAAE;QACtCQ,QAAQ,CAAC;UACP+B,gBAAgB,EAAED;QACpB,CAAC,CAAC;MACJ,CAAC,MAAM;QACL9B,QAAQ,CAAC;UAAEgC,OAAO,EAAEF;QAAE,CAAC,CAAC;MAC1B;IACF,CAAC,SAAS;MACRzB,UAAU,CAAC,KAAK,CAAC;IACnB;EACF,CAAC,EAAE,CAACR,gBAAgB,EAAED,SAAS,EAAEU,YAAY,CAAC,CAAC;EAE/C,MAAM2B,cAAc,GAAGxC,KAAK,CAACoB,WAAW,CAAC,gBACvCQ,IAA6D,EACd;IAC/C,IAAI;MACF;MACA,IAAIjB,SAAS,EAAE;QACb,OAAOa,SAAS;MAClB;;MAEA;MACA,IAAIP,kBAAkB,CAACK,OAAO,EAAE;QAC9BL,kBAAkB,CAACK,OAAO,CAACC,KAAK,CAAC,CAAC;MACpC;;MAEA;MACA,MAAMkB,eAAe,GAAG,IAAIC,eAAe,CAAC,CAAC;MAC7CzB,kBAAkB,CAACK,OAAO,GAAGmB,eAAe;MAE5C3B,aAAa,CAAC,IAAI,CAAC;MACnBP,QAAQ,CAACiB,SAAS,CAAC;MAEnB,MAAMmB,MAAM,GAAG,MAAMvC,gBAAgB,CAACoC,cAAc,CAACrC,SAAS,EAAEyB,IAAI,CAAC;;MAErE;MACA,IAAIa,eAAe,CAACG,MAAM,CAACC,OAAO,EAAE;QAClC,OAAOrB,SAAS;MAClB;MAEAR,mBAAmB,CAAC2B,MAAM,CAAC;MAC3B,OAAOA,MAAM;IACf,CAAC,CAAC,OAAON,CAAC,EAAE;MACV;MACA,IAAIA,CAAC,YAAYS,KAAK,IAAIT,CAAC,CAACU,IAAI,KAAK,YAAY,EAAE;QACjD,OAAOvB,SAAS;MAClB;MAEA,IAAIa,CAAC,YAAYtC,qBAAqB,EAAE;QACtCQ,QAAQ,CAAC;UACP+B,gBAAgB,EAAED;QACpB,CAAC,CAAC;MACJ,CAAC,MAAM;QACL9B,QAAQ,CAAC;UAAEgC,OAAO,EAAEF;QAAE,CAAC,CAAC;MAC1B;MACA,MAAMA,CAAC;IACT,CAAC,SAAS;MACRvB,aAAa,CAAC,KAAK,CAAC;IACtB;EACF,CAAC,EAAE,CAACV,gBAAgB,EAAED,SAAS,EAAEQ,SAAS,CAAC,CAAC;;EAE5C;EACAX,KAAK,CAACgD,SAAS,CAAC,MAAM;IACpB,OAAO,MAAM;MACX,IAAI/B,kBAAkB,CAACK,OAAO,EAAE;QAC9BL,kBAAkB,CAACK,OAAO,CAACC,KAAK,CAAC,CAAC;MACpC;IACF,CAAC;EACH,CAAC,EAAE,EAAE,CAAC;EAEN,OAAOvB,KAAK,CAACiD,OAAO,CAAC,OAAO;IAC1B9B,WAAW;IACXqB,cAAc;IACdlC,KAAK;IACLG,IAAI;IACJE,SAAS;IACTE,YAAY;IACZE;EACF,CAAC,CAAC,EAAE,CACFI,WAAW,EACXqB,cAAc,EACdlC,KAAK,EACLG,IAAI,EACJE,SAAS,EACTE,YAAY,EACZE,gBAAgB,CACjB,CAAC;AACJ","ignoreList":[]}

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

@@ -31,6 +31,14 @@ import { OsdkContext2 } from "./OsdkContext2.js";
  * @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 and enabled
+ */
+
 /*
     Implementation of useOsdkObject
  */
@@ -44,12 +52,17 @@ export function useOsdkObject(...args) {
   // so we must use type assertions after runtime discrimination
   const isInstanceSignature = "$objectType" in args[0];
 
+  // 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;
+
   // 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;
+  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 mode = isInstanceSignature ? "offline" : undefined;
   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
@@ -60,24 +73,30 @@ export function useOsdkObject(...args) {
       }), `object ${apiNameString} ${primaryKey} [DISABLED]`);
     }
     return makeExternalStore(observer => observableClient.observeObject(typeOrApiName, primaryKey, {
-      mode
+      mode,
+      ...(stableSelect ? {
+        select: stableSelect
+      } : {})
     }, observer), `object ${apiNameString} ${primaryKey}`);
-  }, [enabled, observableClient, typeOrApiName, apiNameString, primaryKey, mode]);
+  }, [enabled, observableClient, typeOrApiName, apiNameString, primaryKey, mode, stableSelect]);
   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