@osdk/react 0.3.0-rc.4 → 0.4.0-beta.2

package/CHANGELOG.md

@@ -1,10 +1,16 @@
 # @osdkkit/react
 
-## 0.3.0-rc.4
+## 0.4.0-beta.2
+
+### Minor Changes
+
+- fe0cc43: Experimental react changes
 
 ### Patch Changes
 
-- 66a8ee4: Adding support for react caching work.
+- Updated dependencies [fe0cc43]
+  - @osdk/client@2.2.0-beta.4
+  - @osdk/api@2.2.0-beta.4
 
 ## 0.3.0-beta.3
 

package/build/browser/new/makeExternalStore.js

@@ -14,22 +14,18 @@
  * limitations under the License.
  */
 
-export function makeExternalStore(createObservation, name) {
+export function makeExternalStore(createObservation) {
   let lastResult;
   function getSnapShot() {
     return lastResult;
   }
   return {
     subscribe: function subscribe(notifyUpdate) {
-      // eslint-disable-next-line no-console
-      console.log("Subscribing", name);
       const obs = createObservation(payload => {
         lastResult = payload;
         notifyUpdate();
       });
       return () => {
-        // eslint-disable-next-line no-console
-        console.log("Unsubscribing", name);
         obs.unsubscribe();
       };
     },

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

@@ -1 +1 @@
-{"version":3,"file":"makeExternalStore.js","names":["makeExternalStore","createObservation","name","lastResult","getSnapShot","subscribe","notifyUpdate","console","log","obs","payload","unsubscribe"],"sources":["makeExternalStore.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 { Unsubscribable } from \"@osdk/client/unstable-do-not-use\";\n\nexport function makeExternalStore<X>(\n  createObservation: (callback: (x: X | undefined) => void) => Unsubscribable,\n  name?: string,\n): {\n  subscribe: (notifyUpdate: () => void) => () => void;\n  getSnapShot: () => X | undefined;\n} {\n  let lastResult: X | undefined;\n\n  function getSnapShot(): X | undefined {\n    return lastResult;\n  }\n\n  function subscribe(notifyUpdate: () => void) {\n    // eslint-disable-next-line no-console\n    console.log(\"Subscribing\", name);\n    const obs = createObservation((payload) => {\n      lastResult = payload;\n      notifyUpdate();\n    });\n\n    return (): void => {\n      // eslint-disable-next-line no-console\n      console.log(\"Unsubscribing\", name);\n      obs.unsubscribe();\n    };\n  }\n\n  return {\n    subscribe,\n    getSnapShot,\n  };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAIA,OAAO,SAASA,iBAAiBA,CAC/BC,iBAA2E,EAC3EC,IAAa,EAIb;EACA,IAAIC,UAAyB;EAE7B,SAASC,WAAWA,CAAA,EAAkB;IACpC,OAAOD,UAAU;EACnB;EAiBA,OAAO;IACLE,SAAS,EAhBX,SAASA,SAASA,CAACC,YAAwB,EAAE;MAC3C;MACAC,OAAO,CAACC,GAAG,CAAC,aAAa,EAAEN,IAAI,CAAC;MAChC,MAAMO,GAAG,GAAGR,iBAAiB,CAAES,OAAO,IAAK;QACzCP,UAAU,GAAGO,OAAO;QACpBJ,YAAY,CAAC,CAAC;MAChB,CAAC,CAAC;MAEF,OAAO,MAAY;QACjB;QACAC,OAAO,CAACC,GAAG,CAAC,eAAe,EAAEN,IAAI,CAAC;QAClCO,GAAG,CAACE,WAAW,CAAC,CAAC;MACnB,CAAC;IACH,CAGW;IACTP;EACF,CAAC;AACH","ignoreList":[]}
+{"version":3,"file":"makeExternalStore.js","names":["makeExternalStore","createObservation","lastResult","getSnapShot","subscribe","notifyUpdate","obs","payload","unsubscribe"],"sources":["makeExternalStore.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 { Unsubscribable } from \"@osdk/client/unstable-do-not-use\";\n\nexport function makeExternalStore<X>(\n  createObservation: (callback: (x: X | undefined) => void) => Unsubscribable,\n  name?: string,\n): {\n  subscribe: (notifyUpdate: () => void) => () => void;\n  getSnapShot: () => X | undefined;\n} {\n  let lastResult: X | undefined;\n\n  function getSnapShot(): X | undefined {\n    return lastResult;\n  }\n\n  function subscribe(notifyUpdate: () => void) {\n    const obs = createObservation((payload) => {\n      lastResult = payload;\n      notifyUpdate();\n    });\n\n    return (): void => {\n      obs.unsubscribe();\n    };\n  }\n\n  return {\n    subscribe,\n    getSnapShot,\n  };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAIA,OAAO,SAASA,iBAAiBA,CAC/BC,iBAA2E,EAK3E;EACA,IAAIC,UAAyB;EAE7B,SAASC,WAAWA,CAAA,EAAkB;IACpC,OAAOD,UAAU;EACnB;EAaA,OAAO;IACLE,SAAS,EAZX,SAASA,SAASA,CAACC,YAAwB,EAAE;MAC3C,MAAMC,GAAG,GAAGL,iBAAiB,CAAEM,OAAO,IAAK;QACzCL,UAAU,GAAGK,OAAO;QACpBF,YAAY,CAAC,CAAC;MAChB,CAAC,CAAC;MAEF,OAAO,MAAY;QACjBC,GAAG,CAACE,WAAW,CAAC,CAAC;MACnB,CAAC;IACH,CAGW;IACTL;EACF,CAAC;AACH","ignoreList":[]}

package/build/browser/new/useOsdkAction.js

@@ -23,9 +23,18 @@ export function useOsdkAction(actionDef) {
   } = React.useContext(OsdkContext2);
   const [error, setError] = React.useState();
   const [data, setData] = React.useState();
-  const applyAction = React.useCallback(async function (args, opts) {
+  const [isPending, setPending] = React.useState(false);
+  const applyAction = React.useCallback(async function (hookArgs) {
+    const {
+      $optimisticUpdate,
+      ...args
+    } = hookArgs;
     try {
-      const r = await store.applyAction(actionDef, args, opts);
+      setPending(true);
+      setError(undefined);
+      const r = await store.applyAction(actionDef, args, {
+        optimisticUpdate: $optimisticUpdate
+      });
       setData(r);
       return r;
     } catch (e) {
@@ -38,12 +47,15 @@ export function useOsdkAction(actionDef) {
           unknown: e
         });
       }
+    } finally {
+      setPending(false);
     }
   }, [store, setError]);
   return {
     applyAction,
     error,
-    data
+    data,
+    isPending
   };
 }
 //# sourceMappingURL=useOsdkAction.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"useOsdkAction.js","names":["ActionValidationError","React","OsdkContext2","useOsdkAction","actionDef","store","useContext","error","setError","useState","data","setData","applyAction","useCallback","args","opts","r","e","actionValidation","unknown"],"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 { ActionDefinition } 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\nexport interface UseOsdkActionResult<Q extends ActionDefinition<any>> {\n  applyAction: (\n    args: Parameters<ActionSignatureFromDef<Q>[\"applyAction\"]>[0],\n    opts: ObservableClient.ApplyActionOptions,\n  ) => Promise<unknown>;\n\n  error:\n    | undefined\n    | Partial<{\n      actionValidation: ActionValidationError;\n      unknown: unknown;\n    }>;\n  data: unknown;\n}\n\nexport function useOsdkAction<Q extends ActionDefinition<any>>(\n  actionDef: Q,\n): UseOsdkActionResult<Q> {\n  const { store } = React.useContext(OsdkContext2);\n  const [error, setError] = React.useState<UseOsdkActionResult<Q>[\"error\"]>();\n  const [data, setData] = React.useState<unknown>();\n\n  const applyAction = React.useCallback(async function applyAction(\n    args: Parameters<ActionSignatureFromDef<Q>[\"applyAction\"]>[0],\n    opts: ObservableClient.ApplyActionOptions,\n  ) {\n    try {\n      const r = await store.applyAction(actionDef, args, opts);\n      setData(r);\n      return r;\n    } catch (e) {\n      if (e instanceof ActionValidationError) {\n        setError({\n          actionValidation: e,\n        });\n      } else {\n        setError({ unknown: e });\n      }\n    }\n  }, [store, setError]);\n\n  return { applyAction, error, data };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA,SAASA,qBAAqB,QAAQ,cAAc;AAKpD,OAAOC,KAAK,MAAM,OAAO;AACzB,SAASC,YAAY,QAAQ,mBAAmB;AAiBhD,OAAO,SAASC,aAAaA,CAC3BC,SAAY,EACY;EACxB,MAAM;IAAEC;EAAM,CAAC,GAAGJ,KAAK,CAACK,UAAU,CAACJ,YAAY,CAAC;EAChD,MAAM,CAACK,KAAK,EAAEC,QAAQ,CAAC,GAAGP,KAAK,CAACQ,QAAQ,CAAkC,CAAC;EAC3E,MAAM,CAACC,IAAI,EAAEC,OAAO,CAAC,GAAGV,KAAK,CAACQ,QAAQ,CAAU,CAAC;EAEjD,MAAMG,WAAW,GAAGX,KAAK,CAACY,WAAW,CAAC,gBACpCC,IAA6D,EAC7DC,IAAyC,EACzC;IACA,IAAI;MACF,MAAMC,CAAC,GAAG,MAAMX,KAAK,CAACO,WAAW,CAACR,SAAS,EAAEU,IAAI,EAAEC,IAAI,CAAC;MACxDJ,OAAO,CAACK,CAAC,CAAC;MACV,OAAOA,CAAC;IACV,CAAC,CAAC,OAAOC,CAAC,EAAE;MACV,IAAIA,CAAC,YAAYjB,qBAAqB,EAAE;QACtCQ,QAAQ,CAAC;UACPU,gBAAgB,EAAED;QACpB,CAAC,CAAC;MACJ,CAAC,MAAM;QACLT,QAAQ,CAAC;UAAEW,OAAO,EAAEF;QAAE,CAAC,CAAC;MAC1B;IACF;EACF,CAAC,EAAE,CAACZ,KAAK,EAAEG,QAAQ,CAAC,CAAC;EAErB,OAAO;IAAEI,WAAW;IAAEL,KAAK;IAAEG;EAAK,CAAC;AACrC","ignoreList":[]}
+{"version":3,"file":"useOsdkAction.js","names":["ActionValidationError","React","OsdkContext2","useOsdkAction","actionDef","store","useContext","error","setError","useState","data","setData","isPending","setPending","applyAction","useCallback","hookArgs","$optimisticUpdate","args","undefined","r","optimisticUpdate","e","actionValidation","unknown"],"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 { ActionDefinition } 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>,\n  ) => Promise<unknown>;\n\n  error:\n    | undefined\n    | Partial<{\n      actionValidation: ActionValidationError;\n      unknown: unknown;\n    }>;\n  data: unknown;\n\n  isPending: boolean;\n}\n\nexport function useOsdkAction<Q extends ActionDefinition<any>>(\n  actionDef: Q,\n): UseOsdkActionResult<Q> {\n  const { store } = React.useContext(OsdkContext2);\n  const [error, setError] = React.useState<UseOsdkActionResult<Q>[\"error\"]>();\n  const [data, setData] = React.useState<unknown>();\n  const [isPending, setPending] = React.useState(false);\n\n  const applyAction = React.useCallback(async function applyAction(\n    hookArgs: ApplyActionParams<Q>,\n  ) {\n    const { $optimisticUpdate, ...args } = hookArgs;\n    try {\n      setPending(true);\n      setError(undefined);\n      const r = await store.applyAction(actionDef, args, {\n        optimisticUpdate: $optimisticUpdate,\n      });\n      setData(r);\n      return r;\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  }, [store, setError]);\n\n  return { applyAction, error, data, isPending };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA,SAASA,qBAAqB,QAAQ,cAAc;AAKpD,OAAOC,KAAK,MAAM,OAAO;AACzB,SAASC,YAAY,QAAQ,mBAAmB;AAyBhD,OAAO,SAASC,aAAaA,CAC3BC,SAAY,EACY;EACxB,MAAM;IAAEC;EAAM,CAAC,GAAGJ,KAAK,CAACK,UAAU,CAACJ,YAAY,CAAC;EAChD,MAAM,CAACK,KAAK,EAAEC,QAAQ,CAAC,GAAGP,KAAK,CAACQ,QAAQ,CAAkC,CAAC;EAC3E,MAAM,CAACC,IAAI,EAAEC,OAAO,CAAC,GAAGV,KAAK,CAACQ,QAAQ,CAAU,CAAC;EACjD,MAAM,CAACG,SAAS,EAAEC,UAAU,CAAC,GAAGZ,KAAK,CAACQ,QAAQ,CAAC,KAAK,CAAC;EAErD,MAAMK,WAAW,GAAGb,KAAK,CAACc,WAAW,CAAC,gBACpCC,QAA8B,EAC9B;IACA,MAAM;MAAEC,iBAAiB;MAAE,GAAGC;IAAK,CAAC,GAAGF,QAAQ;IAC/C,IAAI;MACFH,UAAU,CAAC,IAAI,CAAC;MAChBL,QAAQ,CAACW,SAAS,CAAC;MACnB,MAAMC,CAAC,GAAG,MAAMf,KAAK,CAACS,WAAW,CAACV,SAAS,EAAEc,IAAI,EAAE;QACjDG,gBAAgB,EAAEJ;MACpB,CAAC,CAAC;MACFN,OAAO,CAACS,CAAC,CAAC;MACV,OAAOA,CAAC;IACV,CAAC,CAAC,OAAOE,CAAC,EAAE;MACV,IAAIA,CAAC,YAAYtB,qBAAqB,EAAE;QACtCQ,QAAQ,CAAC;UACPe,gBAAgB,EAAED;QACpB,CAAC,CAAC;MACJ,CAAC,MAAM;QACLd,QAAQ,CAAC;UAAEgB,OAAO,EAAEF;QAAE,CAAC,CAAC;MAC1B;IACF,CAAC,SAAS;MACRT,UAAU,CAAC,KAAK,CAAC;IACnB;EACF,CAAC,EAAE,CAACR,KAAK,EAAEG,QAAQ,CAAC,CAAC;EAErB,OAAO;IAAEM,WAAW;IAAEP,KAAK;IAAEG,IAAI;IAAEE;EAAU,CAAC;AAChD","ignoreList":[]}

package/build/browser/new/useOsdkList.js

@@ -17,17 +17,33 @@
 import React from "react";
 import { makeExternalStore } from "./makeExternalStore.js";
 import { OsdkContext2 } from "./OsdkContext2.js";
-export function useOsdkList(type, opts) {
+export function useOsdkList(objectType, {
+  pageSize,
+  orderBy,
+  dedupeIntervalMs,
+  where,
+  streamUpdates
+}) {
   const {
     store
   } = React.useContext(OsdkContext2);
-  const where = store.canonicalizeWhereClause(opts.where);
+
+  /*  We want the canonical where clause so that the use of `React.useMemo`
+      is stable. No real added cost as we canonicalize internal to
+      the ObservableClient anyway.
+   */
+  const canonWhere = store.canonicalizeWhereClause(where ?? {});
   const {
     subscribe,
     getSnapShot
-  } = React.useMemo(() => makeExternalStore(x => store.observeList(type, where, {
-    dedupeInterval: opts.dedupeIntervalMs ?? 2_000
-  }, x), `list ${type.apiName} ${JSON.stringify(where)}`), [store, type, where, opts.dedupeIntervalMs]);
+  } = React.useMemo(() => makeExternalStore(x => store.observeList({
+    objectType,
+    where: canonWhere,
+    dedupeInterval: dedupeIntervalMs ?? 2_000,
+    pageSize,
+    orderBy,
+    streamUpdates
+  }, x), process.env.NODE_ENV !== "production" ? `list ${objectType.apiName} ${JSON.stringify(canonWhere)}` : void 0), [store, objectType, canonWhere, dedupeIntervalMs]);
   const listPayload = React.useSyncExternalStore(subscribe, getSnapShot);
   return {
     fetchMore: listPayload?.fetchMore,

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

@@ -1 +1 @@
-{"version":3,"file":"useOsdkList.js","names":["React","makeExternalStore","OsdkContext2","useOsdkList","type","opts","store","useContext","where","canonicalizeWhereClause","subscribe","getSnapShot","useMemo","x","observeList","dedupeInterval","dedupeIntervalMs","apiName","JSON","stringify","listPayload","useSyncExternalStore","fetchMore","data","resolvedList","isLoading","status","error","undefined","isOptimistic"],"sources":["useOsdkList.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { ObjectTypeDefinition, Osdk, WhereClause } from \"@osdk/client\";\nimport type { ListPayload } from \"@osdk/client/unstable-do-not-use\";\nimport React from \"react\";\nimport { makeExternalStore } from \"./makeExternalStore.js\";\nimport { OsdkContext2 } from \"./OsdkContext2.js\";\n\nexport interface UseOsdkListOptions<T extends ObjectTypeDefinition> {\n  where: WhereClause<T>;\n\n  /**\n   * The number of milliseconds to wait after the last observed list change.\n   *\n   * Two uses of `useOsdkList` with the where clause will only trigger one\n   * network request if the second is within `dedupeIntervalMs`.\n   */\n  dedupeIntervalMs?: number;\n}\nexport interface UseOsdkListResult<T extends ObjectTypeDefinition> {\n  fetchMore: (() => Promise<unknown>) | undefined;\n  data: Osdk.Instance<T>[];\n  isLoading: boolean;\n\n  // FIXME populate error!\n  error: undefined;\n\n  /**\n   * Refers to whether the ordered list of objects (only considering the $primaryKey)\n   * is optimistic or not.\n   *\n   * If you need to know if the contents of the list are optimistic you can\n   * do that on a per object basis with useOsdkObject\n   */\n  isOptimistic: boolean;\n}\n\nexport function useOsdkList<T extends ObjectTypeDefinition>(\n  type: T,\n  opts: UseOsdkListOptions<T>,\n): UseOsdkListResult<T> {\n  const { store } = React.useContext(OsdkContext2);\n  const where = store.canonicalizeWhereClause(opts.where);\n\n  const { subscribe, getSnapShot } = React.useMemo(\n    () =>\n      makeExternalStore<ListPayload>((x) =>\n        store.observeList(\n          type,\n          where,\n          {\n            dedupeInterval: opts.dedupeIntervalMs ?? 2_000,\n          },\n          x,\n        ), `list ${type.apiName} ${JSON.stringify(where)}`),\n    [store, type, where, opts.dedupeIntervalMs],\n  );\n\n  const listPayload = React.useSyncExternalStore(subscribe, getSnapShot);\n\n  return {\n    fetchMore: listPayload?.fetchMore,\n    data: listPayload?.resolvedList as Osdk.Instance<T>[],\n    isLoading: listPayload?.status === \"loading\",\n    error: undefined,\n    isOptimistic: listPayload?.isOptimistic ?? false,\n  };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAIA,OAAOA,KAAK,MAAM,OAAO;AACzB,SAASC,iBAAiB,QAAQ,wBAAwB;AAC1D,SAASC,YAAY,QAAQ,mBAAmB;AA+BhD,OAAO,SAASC,WAAWA,CACzBC,IAAO,EACPC,IAA2B,EACL;EACtB,MAAM;IAAEC;EAAM,CAAC,GAAGN,KAAK,CAACO,UAAU,CAACL,YAAY,CAAC;EAChD,MAAMM,KAAK,GAAGF,KAAK,CAACG,uBAAuB,CAACJ,IAAI,CAACG,KAAK,CAAC;EAEvD,MAAM;IAAEE,SAAS;IAAEC;EAAY,CAAC,GAAGX,KAAK,CAACY,OAAO,CAC9C,MACEX,iBAAiB,CAAeY,CAAC,IAC/BP,KAAK,CAACQ,WAAW,CACfV,IAAI,EACJI,KAAK,EACL;IACEO,cAAc,EAAEV,IAAI,CAACW,gBAAgB,IAAI;EAC3C,CAAC,EACDH,CACF,CAAC,EAAE,QAAQT,IAAI,CAACa,OAAO,IAAIC,IAAI,CAACC,SAAS,CAACX,KAAK,CAAC,EAAE,CAAC,EACvD,CAACF,KAAK,EAAEF,IAAI,EAAEI,KAAK,EAAEH,IAAI,CAACW,gBAAgB,CAC5C,CAAC;EAED,MAAMI,WAAW,GAAGpB,KAAK,CAACqB,oBAAoB,CAACX,SAAS,EAAEC,WAAW,CAAC;EAEtE,OAAO;IACLW,SAAS,EAAEF,WAAW,EAAEE,SAAS;IACjCC,IAAI,EAAEH,WAAW,EAAEI,YAAkC;IACrDC,SAAS,EAAEL,WAAW,EAAEM,MAAM,KAAK,SAAS;IAC5CC,KAAK,EAAEC,SAAS;IAChBC,YAAY,EAAET,WAAW,EAAES,YAAY,IAAI;EAC7C,CAAC;AACH","ignoreList":[]}
+{"version":3,"file":"useOsdkList.js","names":["React","makeExternalStore","OsdkContext2","useOsdkList","objectType","pageSize","orderBy","dedupeIntervalMs","where","streamUpdates","store","useContext","canonWhere","canonicalizeWhereClause","subscribe","getSnapShot","useMemo","x","observeList","dedupeInterval","process","env","NODE_ENV","apiName","JSON","stringify","listPayload","useSyncExternalStore","fetchMore","data","resolvedList","isLoading","status","error","undefined","isOptimistic"],"sources":["useOsdkList.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  ObjectTypeDefinition,\n  Osdk,\n  PropertyKeys,\n  WhereClause,\n} from \"@osdk/client\";\nimport type { ListPayload } from \"@osdk/client/unstable-do-not-use\";\nimport React from \"react\";\nimport { makeExternalStore } from \"./makeExternalStore.js\";\nimport { OsdkContext2 } from \"./OsdkContext2.js\";\n\nexport interface UseOsdkListOptions<T extends ObjectTypeDefinition> {\n  /**\n   * Standard OSDK Where\n   */\n  where?: WhereClause<T>;\n\n  /**\n   *  The preferred page size for the list.\n   */\n  pageSize?: number;\n\n  /** */\n  orderBy?: {\n    [K in PropertyKeys<T>]?: \"asc\" | \"desc\";\n  };\n\n  /**\n   * Causes the list to automatically fetch more as soon as the previous page\n   * has been loaded. If a number is provided, it will continue to automatically\n   * fetch more until the list is at least that long.\n   */\n  // autoFetchMore?: boolean | number;\n\n  /**\n   * Upon a list being revalidated, this option determines how the component\n   * will be re-rendered with the data.\n   *\n   * An example to help understand the options:\n   *\n   * Suppose pageSize is 10 and we have called `fetchMore()` twice. The list is\n   * now 30 items long.\n   *\n   * Upon revalidation, we get the first 10 items of the list. The options behave\n   * as follows:\n   *\n   * - `\"in-place\"`: The first 10 items of the list are replaced with the new 10\n   *   items. The list is now 30 items long, but only the first 10 items are valid.\n   * - `\"wait\"`: The old list is returned until after the next 20 items are loaded\n   *   (which will happen automatically). The list is now 30 items long.\n   * - `\"reset\"`: The entire list is replaced with the new 10 items. The list is\n   *   now 10 items long.\n   */\n  // invalidationMode?: \"in-place\" | \"wait\" | \"reset\";\n\n  /**\n   * The number of milliseconds to wait after the last observed list change.\n   *\n   * Two uses of `useOsdkList` with the where clause will only trigger one\n   * network request if the second is within `dedupeIntervalMs`.\n   */\n  dedupeIntervalMs?: number;\n\n  /**\n   * If provided, the list will be considered this length for the purposes of\n   * `invalidationMode` when using the `wait` option. If not provided,\n   * the internal expectedLength will be determined by the number of times\n   * `fetchMore` has been called.\n   */\n  // expectedLength?: number | undefined;\n\n  streamUpdates?: boolean;\n}\n\nexport interface UseOsdkListResult<T extends ObjectTypeDefinition> {\n  fetchMore: (() => Promise<unknown>) | undefined;\n  data: Osdk.Instance<T>[];\n  isLoading: boolean;\n\n  // FIXME populate error!\n  error: undefined;\n\n  /**\n   * Refers to whether the ordered list of objects (only considering the $primaryKey)\n   * is optimistic or not.\n   *\n   * If you need to know if the contents of the list are optimistic you can\n   * do that on a per object basis with useOsdkObject\n   */\n  isOptimistic: boolean;\n}\n\ndeclare const process: {\n  env: {\n    NODE_ENV: \"development\" | \"production\";\n  };\n};\n\nexport function useOsdkList<T extends ObjectTypeDefinition>(\n  objectType: T,\n  { pageSize, orderBy, dedupeIntervalMs, where, streamUpdates }:\n    UseOsdkListOptions<T>,\n): UseOsdkListResult<T> {\n  const { store } = React.useContext(OsdkContext2);\n\n  /*  We want the canonical where clause so that the use of `React.useMemo`\n      is stable. No real added cost as we canonicalize internal to\n      the ObservableClient anyway.\n   */\n  const canonWhere = store.canonicalizeWhereClause(where ?? {});\n\n  const { subscribe, getSnapShot } = React.useMemo(\n    () =>\n      makeExternalStore<ListPayload>(\n        (x) =>\n          store.observeList({\n            objectType,\n            where: canonWhere,\n            dedupeInterval: dedupeIntervalMs ?? 2_000,\n            pageSize,\n            orderBy,\n            streamUpdates,\n          }, x),\n        process.env.NODE_ENV !== \"production\"\n          ? `list ${objectType.apiName} ${JSON.stringify(canonWhere)}`\n          : void 0,\n      ),\n    [store, objectType, canonWhere, dedupeIntervalMs],\n  );\n\n  const listPayload = React.useSyncExternalStore(subscribe, getSnapShot);\n\n  return {\n    fetchMore: listPayload?.fetchMore,\n    data: listPayload?.resolvedList as Osdk.Instance<T>[],\n    isLoading: listPayload?.status === \"loading\",\n    error: undefined,\n    isOptimistic: listPayload?.isOptimistic ?? 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;AAyFhD,OAAO,SAASC,WAAWA,CACzBC,UAAa,EACb;EAAEC,QAAQ;EAAEC,OAAO;EAAEC,gBAAgB;EAAEC,KAAK;EAAEC;AACxB,CAAC,EACD;EACtB,MAAM;IAAEC;EAAM,CAAC,GAAGV,KAAK,CAACW,UAAU,CAACT,YAAY,CAAC;;EAEhD;AACF;AACA;AACA;EACE,MAAMU,UAAU,GAAGF,KAAK,CAACG,uBAAuB,CAACL,KAAK,IAAI,CAAC,CAAC,CAAC;EAE7D,MAAM;IAAEM,SAAS;IAAEC;EAAY,CAAC,GAAGf,KAAK,CAACgB,OAAO,CAC9C,MACEf,iBAAiB,CACdgB,CAAC,IACAP,KAAK,CAACQ,WAAW,CAAC;IAChBd,UAAU;IACVI,KAAK,EAAEI,UAAU;IACjBO,cAAc,EAAEZ,gBAAgB,IAAI,KAAK;IACzCF,QAAQ;IACRC,OAAO;IACPG;EACF,CAAC,EAAEQ,CAAC,CAAC,EACPG,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,GACjC,QAAQlB,UAAU,CAACmB,OAAO,IAAIC,IAAI,CAACC,SAAS,CAACb,UAAU,CAAC,EAAE,GAC1D,KAAK,CACX,CAAC,EACH,CAACF,KAAK,EAAEN,UAAU,EAAEQ,UAAU,EAAEL,gBAAgB,CAClD,CAAC;EAED,MAAMmB,WAAW,GAAG1B,KAAK,CAAC2B,oBAAoB,CAACb,SAAS,EAAEC,WAAW,CAAC;EAEtE,OAAO;IACLa,SAAS,EAAEF,WAAW,EAAEE,SAAS;IACjCC,IAAI,EAAEH,WAAW,EAAEI,YAAkC;IACrDC,SAAS,EAAEL,WAAW,EAAEM,MAAM,KAAK,SAAS;IAC5CC,KAAK,EAAEC,SAAS;IAChBC,YAAY,EAAET,WAAW,EAAES,YAAY,IAAI;EAC7C,CAAC;AACH","ignoreList":[]}

package/build/cjs/public/experimental.cjs

@@ -38,9 +38,18 @@ function useOsdkAction(actionDef) {
   } = React3__default.default.useContext(OsdkContext2);
   const [error, setError] = React3__default.default.useState();
   const [data, setData] = React3__default.default.useState();
-  const applyAction = React3__default.default.useCallback(async function applyAction2(args, opts) {
+  const [isPending, setPending] = React3__default.default.useState(false);
+  const applyAction = React3__default.default.useCallback(async function applyAction2(hookArgs) {
+    const {
+      $optimisticUpdate,
+      ...args
+    } = hookArgs;
     try {
-      const r = await store.applyAction(actionDef, args, opts);
+      setPending(true);
+      setError(void 0);
+      const r = await store.applyAction(actionDef, args, {
+        optimisticUpdate: $optimisticUpdate
+      });
       setData(r);
       return r;
     } catch (e) {
@@ -53,12 +62,15 @@ function useOsdkAction(actionDef) {
           unknown: e
         });
       }
+    } finally {
+      setPending(false);
     }
   }, [store, setError]);
   return {
     applyAction,
     error,
-    data
+    data,
+    isPending
   };
 }
 
@@ -69,13 +81,11 @@ function makeExternalStore(createObservation, name) {
     return lastResult;
   }
   function subscribe(notifyUpdate) {
-    console.log("Subscribing", name);
     const obs = createObservation((payload) => {
       lastResult = payload;
       notifyUpdate();
     });
     return () => {
-      console.log("Unsubscribing", name);
       obs.unsubscribe();
     };
   }
@@ -86,17 +96,28 @@ function makeExternalStore(createObservation, name) {
 }
 
 // src/new/useOsdkList.ts
-function useOsdkList(type, opts) {
+function useOsdkList(objectType, {
+  pageSize,
+  orderBy,
+  dedupeIntervalMs,
+  where,
+  streamUpdates
+}) {
   const {
     store
   } = React3__default.default.useContext(OsdkContext2);
-  const where = store.canonicalizeWhereClause(opts.where);
+  const canonWhere = store.canonicalizeWhereClause(where ?? {});
   const {
     subscribe,
     getSnapShot
-  } = React3__default.default.useMemo(() => makeExternalStore((x) => store.observeList(type, where, {
-    dedupeInterval: opts.dedupeIntervalMs ?? 2e3
-  }, x), `list ${type.apiName} ${JSON.stringify(where)}`), [store, type, where, opts.dedupeIntervalMs]);
+  } = React3__default.default.useMemo(() => makeExternalStore((x) => store.observeList({
+    objectType,
+    where: canonWhere,
+    dedupeInterval: dedupeIntervalMs ?? 2e3,
+    pageSize,
+    orderBy,
+    streamUpdates
+  }, x), process.env.NODE_ENV !== "production" ? `list ${objectType.apiName} ${JSON.stringify(canonWhere)}` : undefined), [store, objectType, canonWhere, dedupeIntervalMs]);
   const listPayload = React3__default.default.useSyncExternalStore(subscribe, getSnapShot);
   return {
     fetchMore: listPayload?.fetchMore,
@@ -118,7 +139,7 @@ function useOsdkObject(...args) {
     getSnapShot
   } = React3__default.default.useMemo(() => makeExternalStore((payload2) => store.observeObject(objectType, primaryKey, {
     mode
-  }, payload2), `object ${objectType} ${primaryKey}`), [store, objectType, primaryKey, mode]);
+  }, payload2)), [store, objectType, primaryKey, mode]);
   const payload = React3__default.default.useSyncExternalStore(subscribe, getSnapShot);
   return {
     object: payload?.object,

package/build/cjs/public/experimental.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/new/OsdkContext2.ts","../../../src/new/OsdkProvider2.tsx","../../../src/new/useOsdkAction.ts","../../../src/new/makeExternalStore.ts","../../../src/new/useOsdkList.ts","../../../src/new/useOsdkObject.ts"],"names":["React","applyAction","ActionValidationError","payload"],"mappings":";;;;;;;;;;AAiBA,SAAS,gBAAgB,KAAO,EAAA;AAC9B,EAAM,MAAA,IAAI,MAAM,sEAAsE,CAAA;AACxF;AACA,IAAM,UAAA,GAAa,MAAO,CAAA,MAAA,CAAO,YAAc,EAAA;AAAA,EAC7C,aAAe,EAAA;AACjB,CAAC,CAAA;AACM,IAAM,YAAA,2CAAkC,aAAc,CAAA;AAAA,EAC3D,MAAQ,EAAA,UAAA;AAAA,EACR,KAAO,EAAA;AACT,CAAC,CAAA;;;ACRM,SAAS,aAAc,CAAA;AAAA,EAC5B,QAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAG,EAAA;AACD,EAAA,uBAAoBA,uBAAAA,CAAM,aAAc,CAAA,YAAA,CAAa,QAAU,EAAA;AAAA,IAC7D,KAAO,EAAA;AAAA,MACL,MAAA;AAAA,MACA;AAAA;AACF,KACC,QAAQ,CAAA;AACb;ACVO,SAAS,cAAc,SAAW,EAAA;AACvC,EAAM,MAAA;AAAA,IACJ;AAAA,GACF,GAAIA,uBAAM,CAAA,UAAA,CAAW,YAAY,CAAA;AACjC,EAAA,MAAM,CAAC,KAAA,EAAO,QAAQ,CAAA,GAAIA,wBAAM,QAAS,EAAA;AACzC,EAAA,MAAM,CAAC,IAAA,EAAM,OAAO,CAAA,GAAIA,wBAAM,QAAS,EAAA;AACvC,EAAA,MAAM,cAAcA,uBAAM,CAAA,WAAA,CAAY,eAAeC,YAAAA,CAAY,MAAM,IAAM,EAAA;AAC3E,IAAI,IAAA;AACF,MAAA,MAAM,IAAI,MAAM,KAAA,CAAM,WAAY,CAAA,SAAA,EAAW,MAAM,IAAI,CAAA;AACvD,MAAA,OAAA,CAAQ,CAAC,CAAA;AACT,MAAO,OAAA,CAAA;AAAA,aACA,CAAG,EAAA;AACV,MAAA,IAAI,aAAaC,4BAAuB,EAAA;AACtC,QAAS,QAAA,CAAA;AAAA,UACP,gBAAkB,EAAA;AAAA,SACnB,CAAA;AAAA,OACI,MAAA;AACL,QAAS,QAAA,CAAA;AAAA,UACP,OAAS,EAAA;AAAA,SACV,CAAA;AAAA;AACH;AACF,GACC,EAAA,CAAC,KAAO,EAAA,QAAQ,CAAC,CAAA;AACpB,EAAO,OAAA;AAAA,IACL,WAAA;AAAA,IACA,KAAA;AAAA,IACA;AAAA,GACF;AACF;;;AC/BO,SAAS,iBAAA,CAAkB,mBAAmB,IAAM,EAAA;AACzD,EAAI,IAAA,UAAA;AACJ,EAAA,SAAS,WAAc,GAAA;AACrB,IAAO,OAAA,UAAA;AAAA;AAET,EAAA,SAAS,UAAU,YAAc,EAAA;AAE/B,IAAQ,OAAA,CAAA,GAAA,CAAI,eAAe,IAAI,CAAA;AAC/B,IAAM,MAAA,GAAA,GAAM,kBAAkB,CAAW,OAAA,KAAA;AACvC,MAAa,UAAA,GAAA,OAAA;AACb,MAAa,YAAA,EAAA;AAAA,KACd,CAAA;AACD,IAAA,OAAO,MAAM;AAEX,MAAQ,OAAA,CAAA,GAAA,CAAI,iBAAiB,IAAI,CAAA;AACjC,MAAA,GAAA,CAAI,WAAY,EAAA;AAAA,KAClB;AAAA;AAEF,EAAO,OAAA;AAAA,IACL,SAAA;AAAA,IACA;AAAA,GACF;AACF;;;ACnBO,SAAS,WAAA,CAAY,MAAM,IAAM,EAAA;AACtC,EAAM,MAAA;AAAA,IACJ;AAAA,GACF,GAAIF,uBAAM,CAAA,UAAA,CAAW,YAAY,CAAA;AACjC,EAAA,MAAM,KAAQ,GAAA,KAAA,CAAM,uBAAwB,CAAA,IAAA,CAAK,KAAK,CAAA;AACtD,EAAM,MAAA;AAAA,IACJ,SAAA;AAAA,IACA;AAAA,GACF,GAAIA,wBAAM,OAAQ,CAAA,MAAM,kBAAkB,CAAK,CAAA,KAAA,KAAA,CAAM,WAAY,CAAA,IAAA,EAAM,KAAO,EAAA;AAAA,IAC5E,cAAA,EAAgB,KAAK,gBAAoB,IAAA;AAAA,KACxC,CAAC,CAAA,EAAG,QAAQ,IAAK,CAAA,OAAO,IAAI,IAAK,CAAA,SAAA,CAAU,KAAK,CAAC,CAAA,CAAE,GAAG,CAAC,KAAA,EAAO,MAAM,KAAO,EAAA,IAAA,CAAK,gBAAgB,CAAC,CAAA;AACpG,EAAA,MAAM,WAAcA,GAAAA,uBAAAA,CAAM,oBAAqB,CAAA,SAAA,EAAW,WAAW,CAAA;AACrE,EAAO,OAAA;AAAA,IACL,WAAW,WAAa,EAAA,SAAA;AAAA,IACxB,MAAM,WAAa,EAAA,YAAA;AAAA,IACnB,SAAA,EAAW,aAAa,MAAW,KAAA,SAAA;AAAA,IACnC,KAAO,EAAA,SAAA;AAAA,IACP,YAAA,EAAc,aAAa,YAAgB,IAAA;AAAA,GAC7C;AACF;ACJO,SAAS,iBAAiB,IAAM,EAAA;AACrC,EAAM,MAAA;AAAA,IACJ;AAAA,GACF,GAAIA,uBAAM,CAAA,UAAA,CAAW,YAAY,CAAA;AAGjC,EAAA,MAAM,IAAO,GAAA,IAAA,CAAK,MAAW,KAAA,CAAA,GAAI,SAAY,GAAA,SAAA;AAC7C,EAAM,MAAA,UAAA,GAAa,IAAK,CAAA,MAAA,KAAW,CAAI,GAAA,IAAA,CAAK,CAAC,CAAE,CAAA,WAAA,GAAc,IAAK,CAAA,CAAC,CAAE,CAAA,OAAA;AACrE,EAAM,MAAA,UAAA,GAAa,KAAK,MAAW,KAAA,CAAA,GAAI,KAAK,CAAC,CAAA,CAAE,WAAc,GAAA,IAAA,CAAK,CAAC,CAAA;AACnE,EAAM,MAAA;AAAA,IACJ,SAAA;AAAA,IACA;AAAA,GACF,GAAIA,uBAAM,CAAA,OAAA,CAAQ,MAAM,iBAAA,CAAkB,CAAAG,QAAW,KAAA,KAAA,CAAM,aAAc,CAAA,UAAA,EAAY,UAAY,EAAA;AAAA,IAC/F;AAAA,GACCA,EAAAA,QAAO,CAAG,EAAA,CAAA,OAAA,EAAU,UAAU,CAAI,CAAA,EAAA,UAAU,CAAE,CAAA,CAAA,EAAG,CAAC,KAAA,EAAO,UAAY,EAAA,UAAA,EAAY,IAAI,CAAC,CAAA;AACzF,EAAA,MAAM,OAAUH,GAAAA,uBAAAA,CAAM,oBAAqB,CAAA,SAAA,EAAW,WAAW,CAAA;AACjE,EAAO,OAAA;AAAA,IACL,QAAQ,OAAS,EAAA,MAAA;AAAA,IACjB,SAAA,EAAW,SAAS,MAAW,KAAA,SAAA;AAAA,IAC/B,YAAA,EAAc,SAAS,YAAgB,IAAA,KAAA;AAAA,IACvC,aAAa,MAAM;AACjB,MAAM,MAAA,iBAAA;AAAA;AACR,GACF;AACF","file":"experimental.cjs","sourcesContent":["/*\n * Copyright 2024 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 React from \"react\";\nfunction fakeClientFn(..._args) {\n  throw new Error(\"This is not a real client. Did you forget to <OsdkContext.Provider>?\");\n}\nconst fakeClient = Object.assign(fakeClientFn, {\n  fetchMetadata: fakeClientFn\n});\nexport const OsdkContext2 = /*#__PURE__*/React.createContext({\n  client: fakeClient,\n  store: undefined\n});","/*\n * Copyright 2024 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 React from \"react\";\nimport { OsdkContext2 } from \"./OsdkContext2.js\";\nexport function OsdkProvider2({\n  children,\n  client,\n  store\n}) {\n  return /*#__PURE__*/React.createElement(OsdkContext2.Provider, {\n    value: {\n      client,\n      store\n    }\n  }, children);\n}","/*\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 { ActionValidationError } from \"@osdk/client\";\nimport React from \"react\";\nimport { OsdkContext2 } from \"./OsdkContext2.js\";\nexport function useOsdkAction(actionDef) {\n  const {\n    store\n  } = React.useContext(OsdkContext2);\n  const [error, setError] = React.useState();\n  const [data, setData] = React.useState();\n  const applyAction = React.useCallback(async function applyAction(args, opts) {\n    try {\n      const r = await store.applyAction(actionDef, args, opts);\n      setData(r);\n      return r;\n    } catch (e) {\n      if (e instanceof ActionValidationError) {\n        setError({\n          actionValidation: e\n        });\n      } else {\n        setError({\n          unknown: e\n        });\n      }\n    }\n  }, [store, setError]);\n  return {\n    applyAction,\n    error,\n    data\n  };\n}","/*\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\nexport function makeExternalStore(createObservation, name) {\n  let lastResult;\n  function getSnapShot() {\n    return lastResult;\n  }\n  function subscribe(notifyUpdate) {\n    // eslint-disable-next-line no-console\n    console.log(\"Subscribing\", name);\n    const obs = createObservation(payload => {\n      lastResult = payload;\n      notifyUpdate();\n    });\n    return () => {\n      // eslint-disable-next-line no-console\n      console.log(\"Unsubscribing\", name);\n      obs.unsubscribe();\n    };\n  }\n  return {\n    subscribe,\n    getSnapShot\n  };\n}","/*\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 React from \"react\";\nimport { makeExternalStore } from \"./makeExternalStore.js\";\nimport { OsdkContext2 } from \"./OsdkContext2.js\";\nexport function useOsdkList(type, opts) {\n  const {\n    store\n  } = React.useContext(OsdkContext2);\n  const where = store.canonicalizeWhereClause(opts.where);\n  const {\n    subscribe,\n    getSnapShot\n  } = React.useMemo(() => makeExternalStore(x => store.observeList(type, where, {\n    dedupeInterval: opts.dedupeIntervalMs ?? 2_000\n  }, x), `list ${type.apiName} ${JSON.stringify(where)}`), [store, type, where, opts.dedupeIntervalMs]);\n  const listPayload = React.useSyncExternalStore(subscribe, getSnapShot);\n  return {\n    fetchMore: listPayload?.fetchMore,\n    data: listPayload?.resolvedList,\n    isLoading: listPayload?.status === \"loading\",\n    error: undefined,\n    isOptimistic: listPayload?.isOptimistic ?? false\n  };\n}","/*\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 React from \"react\";\nimport { makeExternalStore } from \"./makeExternalStore.js\";\nimport { OsdkContext2 } from \"./OsdkContext2.js\";\n\n/**\n * @param obj an existing `Osdk.Instance` object to get metadata for.\n */\n\n/**\n * Loads an object by type and primary key.\n *\n * @param type\n * @param primaryKey\n */\n\n/*\n    Implementation of useOsdkObject\n */\nexport function useOsdkObject(...args) {\n  const {\n    store\n  } = React.useContext(OsdkContext2);\n\n  // TODO: Figure out what the correct default behavior is for the various scenarios\n  const mode = args.length === 1 ? \"offline\" : undefined;\n  const objectType = args.length === 1 ? args[0].$objectType : args[0].apiName;\n  const primaryKey = args.length === 1 ? args[0].$primaryKey : args[1];\n  const {\n    subscribe,\n    getSnapShot\n  } = React.useMemo(() => makeExternalStore(payload => store.observeObject(objectType, primaryKey, {\n    mode\n  }, payload), `object ${objectType} ${primaryKey}`), [store, objectType, primaryKey, mode]);\n  const payload = React.useSyncExternalStore(subscribe, getSnapShot);\n  return {\n    object: payload?.object,\n    isLoading: payload?.status === \"loading\",\n    isOptimistic: payload?.isOptimistic ?? false,\n    forceUpdate: () => {\n      throw \"not implemented\";\n    }\n  };\n}"]}
+{"version":3,"sources":["../../../src/new/OsdkContext2.ts","../../../src/new/OsdkProvider2.tsx","../../../src/new/useOsdkAction.ts","../../../src/new/makeExternalStore.ts","../../../src/new/useOsdkList.ts","../../../src/new/useOsdkObject.ts"],"names":["React","applyAction","ActionValidationError","payload"],"mappings":";;;;;;;;;;AAiBA,SAAS,gBAAgB,KAAO,EAAA;AAC9B,EAAM,MAAA,IAAI,MAAM,sEAAsE,CAAA;AACxF;AACA,IAAM,UAAA,GAAa,MAAO,CAAA,MAAA,CAAO,YAAc,EAAA;AAAA,EAC7C,aAAe,EAAA;AACjB,CAAC,CAAA;AACM,IAAM,YAAA,2CAAkC,aAAc,CAAA;AAAA,EAC3D,MAAQ,EAAA,UAAA;AAAA,EACR,KAAO,EAAA;AACT,CAAC,CAAA;;;ACRM,SAAS,aAAc,CAAA;AAAA,EAC5B,QAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAG,EAAA;AACD,EAAA,uBAAoBA,uBAAAA,CAAM,aAAc,CAAA,YAAA,CAAa,QAAU,EAAA;AAAA,IAC7D,KAAO,EAAA;AAAA,MACL,MAAA;AAAA,MACA;AAAA;AACF,KACC,QAAQ,CAAA;AACb;ACVO,SAAS,cAAc,SAAW,EAAA;AACvC,EAAM,MAAA;AAAA,IACJ;AAAA,GACF,GAAIA,uBAAM,CAAA,UAAA,CAAW,YAAY,CAAA;AACjC,EAAA,MAAM,CAAC,KAAA,EAAO,QAAQ,CAAA,GAAIA,wBAAM,QAAS,EAAA;AACzC,EAAA,MAAM,CAAC,IAAA,EAAM,OAAO,CAAA,GAAIA,wBAAM,QAAS,EAAA;AACvC,EAAA,MAAM,CAAC,SAAW,EAAA,UAAU,CAAIA,GAAAA,uBAAAA,CAAM,SAAS,KAAK,CAAA;AACpD,EAAA,MAAM,WAAcA,GAAAA,uBAAAA,CAAM,WAAY,CAAA,eAAeC,aAAY,QAAU,EAAA;AACzE,IAAM,MAAA;AAAA,MACJ,iBAAA;AAAA,MACA,GAAG;AAAA,KACD,GAAA,QAAA;AACJ,IAAI,IAAA;AACF,MAAA,UAAA,CAAW,IAAI,CAAA;AACf,MAAA,QAAA,CAAS,KAAS,CAAA,CAAA;AAClB,MAAA,MAAM,CAAI,GAAA,MAAM,KAAM,CAAA,WAAA,CAAY,WAAW,IAAM,EAAA;AAAA,QACjD,gBAAkB,EAAA;AAAA,OACnB,CAAA;AACD,MAAA,OAAA,CAAQ,CAAC,CAAA;AACT,MAAO,OAAA,CAAA;AAAA,aACA,CAAG,EAAA;AACV,MAAA,IAAI,aAAaC,4BAAuB,EAAA;AACtC,QAAS,QAAA,CAAA;AAAA,UACP,gBAAkB,EAAA;AAAA,SACnB,CAAA;AAAA,OACI,MAAA;AACL,QAAS,QAAA,CAAA;AAAA,UACP,OAAS,EAAA;AAAA,SACV,CAAA;AAAA;AACH,KACA,SAAA;AACA,MAAA,UAAA,CAAW,KAAK,CAAA;AAAA;AAClB,GACC,EAAA,CAAC,KAAO,EAAA,QAAQ,CAAC,CAAA;AACpB,EAAO,OAAA;AAAA,IACL,WAAA;AAAA,IACA,KAAA;AAAA,IACA,IAAA;AAAA,IACA;AAAA,GACF;AACF;;;AC3CO,SAAS,iBAAA,CAAkB,mBAAmB,IAAM,EAAA;AACzD,EAAI,IAAA,UAAA;AACJ,EAAA,SAAS,WAAc,GAAA;AACrB,IAAO,OAAA,UAAA;AAAA;AAET,EAAA,SAAS,UAAU,YAAc,EAAA;AAC/B,IAAM,MAAA,GAAA,GAAM,kBAAkB,CAAW,OAAA,KAAA;AACvC,MAAa,UAAA,GAAA,OAAA;AACb,MAAa,YAAA,EAAA;AAAA,KACd,CAAA;AACD,IAAA,OAAO,MAAM;AACX,MAAA,GAAA,CAAI,WAAY,EAAA;AAAA,KAClB;AAAA;AAEF,EAAO,OAAA;AAAA,IACL,SAAA;AAAA,IACA;AAAA,GACF;AACF;;;ACfO,SAAS,YAAY,UAAY,EAAA;AAAA,EACtC,QAAA;AAAA,EACA,OAAA;AAAA,EACA,gBAAA;AAAA,EACA,KAAA;AAAA,EACA;AACF,CAAG,EAAA;AACD,EAAM,MAAA;AAAA,IACJ;AAAA,GACF,GAAIF,uBAAM,CAAA,UAAA,CAAW,YAAY,CAAA;AAMjC,EAAA,MAAM,UAAa,GAAA,KAAA,CAAM,uBAAwB,CAAA,KAAA,IAAS,EAAE,CAAA;AAC5D,EAAM,MAAA;AAAA,IACJ,SAAA;AAAA,IACA;AAAA,MACEA,uBAAM,CAAA,OAAA,CAAQ,MAAM,iBAAkB,CAAA,CAAA,CAAA,KAAK,MAAM,WAAY,CAAA;AAAA,IAC/D,UAAA;AAAA,IACA,KAAO,EAAA,UAAA;AAAA,IACP,gBAAgB,gBAAoB,IAAA,GAAA;AAAA,IACpC,QAAA;AAAA,IACA,OAAA;AAAA,IACA;AAAA,GACF,EAAG,CAAC,CAAG,EAAA,OAAA,CAAQ,IAAI,QAAa,KAAA,YAAA,GAAe,CAAQ,KAAA,EAAA,UAAA,CAAW,OAAO,CAAA,CAAA,EAAI,KAAK,SAAU,CAAA,UAAU,CAAC,CAAA,CAAA,GAAK,SAAM,CAAA,EAAG,CAAC,KAAO,EAAA,UAAA,EAAY,UAAY,EAAA,gBAAgB,CAAC,CAAA;AACtK,EAAA,MAAM,WAAcA,GAAAA,uBAAAA,CAAM,oBAAqB,CAAA,SAAA,EAAW,WAAW,CAAA;AACrE,EAAO,OAAA;AAAA,IACL,WAAW,WAAa,EAAA,SAAA;AAAA,IACxB,MAAM,WAAa,EAAA,YAAA;AAAA,IACnB,SAAA,EAAW,aAAa,MAAW,KAAA,SAAA;AAAA,IACnC,KAAO,EAAA,SAAA;AAAA,IACP,YAAA,EAAc,aAAa,YAAgB,IAAA;AAAA,GAC7C;AACF;ACpBO,SAAS,iBAAiB,IAAM,EAAA;AACrC,EAAM,MAAA;AAAA,IACJ;AAAA,GACF,GAAIA,uBAAM,CAAA,UAAA,CAAW,YAAY,CAAA;AAGjC,EAAA,MAAM,IAAO,GAAA,IAAA,CAAK,MAAW,KAAA,CAAA,GAAI,SAAY,GAAA,SAAA;AAC7C,EAAM,MAAA,UAAA,GAAa,IAAK,CAAA,MAAA,KAAW,CAAI,GAAA,IAAA,CAAK,CAAC,CAAE,CAAA,WAAA,GAAc,IAAK,CAAA,CAAC,CAAE,CAAA,OAAA;AACrE,EAAM,MAAA,UAAA,GAAa,KAAK,MAAW,KAAA,CAAA,GAAI,KAAK,CAAC,CAAA,CAAE,WAAc,GAAA,IAAA,CAAK,CAAC,CAAA;AACnE,EAAM,MAAA;AAAA,IACJ,SAAA;AAAA,IACA;AAAA,GACF,GAAIA,uBAAM,CAAA,OAAA,CAAQ,MAAM,iBAAA,CAAkB,CAAAG,QAAW,KAAA,KAAA,CAAM,aAAc,CAAA,UAAA,EAAY,UAAY,EAAA;AAAA,IAC/F;AAAA,GACCA,EAAAA,QAAO,CAAuC,CAAA,EAAG,CAAC,KAAA,EAAO,UAAY,EAAA,UAAA,EAAY,IAAI,CAAC,CAAA;AACzF,EAAA,MAAM,OAAUH,GAAAA,uBAAAA,CAAM,oBAAqB,CAAA,SAAA,EAAW,WAAW,CAAA;AACjE,EAAO,OAAA;AAAA,IACL,QAAQ,OAAS,EAAA,MAAA;AAAA,IACjB,SAAA,EAAW,SAAS,MAAW,KAAA,SAAA;AAAA,IAC/B,YAAA,EAAc,SAAS,YAAgB,IAAA,KAAA;AAAA,IACvC,aAAa,MAAM;AACjB,MAAM,MAAA,iBAAA;AAAA;AACR,GACF;AACF","file":"experimental.cjs","sourcesContent":["/*\n * Copyright 2024 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 React from \"react\";\nfunction fakeClientFn(..._args) {\n  throw new Error(\"This is not a real client. Did you forget to <OsdkContext.Provider>?\");\n}\nconst fakeClient = Object.assign(fakeClientFn, {\n  fetchMetadata: fakeClientFn\n});\nexport const OsdkContext2 = /*#__PURE__*/React.createContext({\n  client: fakeClient,\n  store: undefined\n});","/*\n * Copyright 2024 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 React from \"react\";\nimport { OsdkContext2 } from \"./OsdkContext2.js\";\nexport function OsdkProvider2({\n  children,\n  client,\n  store\n}) {\n  return /*#__PURE__*/React.createElement(OsdkContext2.Provider, {\n    value: {\n      client,\n      store\n    }\n  }, children);\n}","/*\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 { ActionValidationError } from \"@osdk/client\";\nimport React from \"react\";\nimport { OsdkContext2 } from \"./OsdkContext2.js\";\nexport function useOsdkAction(actionDef) {\n  const {\n    store\n  } = React.useContext(OsdkContext2);\n  const [error, setError] = React.useState();\n  const [data, setData] = React.useState();\n  const [isPending, setPending] = React.useState(false);\n  const applyAction = React.useCallback(async function applyAction(hookArgs) {\n    const {\n      $optimisticUpdate,\n      ...args\n    } = hookArgs;\n    try {\n      setPending(true);\n      setError(undefined);\n      const r = await store.applyAction(actionDef, args, {\n        optimisticUpdate: $optimisticUpdate\n      });\n      setData(r);\n      return r;\n    } catch (e) {\n      if (e instanceof ActionValidationError) {\n        setError({\n          actionValidation: e\n        });\n      } else {\n        setError({\n          unknown: e\n        });\n      }\n    } finally {\n      setPending(false);\n    }\n  }, [store, setError]);\n  return {\n    applyAction,\n    error,\n    data,\n    isPending\n  };\n}","/*\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\nexport function makeExternalStore(createObservation, name) {\n  let lastResult;\n  function getSnapShot() {\n    return lastResult;\n  }\n  function subscribe(notifyUpdate) {\n    const obs = createObservation(payload => {\n      lastResult = payload;\n      notifyUpdate();\n    });\n    return () => {\n      obs.unsubscribe();\n    };\n  }\n  return {\n    subscribe,\n    getSnapShot\n  };\n}","/*\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 React from \"react\";\nimport { makeExternalStore } from \"./makeExternalStore.js\";\nimport { OsdkContext2 } from \"./OsdkContext2.js\";\nexport function useOsdkList(objectType, {\n  pageSize,\n  orderBy,\n  dedupeIntervalMs,\n  where,\n  streamUpdates\n}) {\n  const {\n    store\n  } = React.useContext(OsdkContext2);\n\n  /*  We want the canonical where clause so that the use of `React.useMemo`\n      is stable. No real added cost as we canonicalize internal to\n      the ObservableClient anyway.\n   */\n  const canonWhere = store.canonicalizeWhereClause(where ?? {});\n  const {\n    subscribe,\n    getSnapShot\n  } = React.useMemo(() => makeExternalStore(x => store.observeList({\n    objectType,\n    where: canonWhere,\n    dedupeInterval: dedupeIntervalMs ?? 2_000,\n    pageSize,\n    orderBy,\n    streamUpdates\n  }, x), process.env.NODE_ENV !== \"production\" ? `list ${objectType.apiName} ${JSON.stringify(canonWhere)}` : void 0), [store, objectType, canonWhere, dedupeIntervalMs]);\n  const listPayload = React.useSyncExternalStore(subscribe, getSnapShot);\n  return {\n    fetchMore: listPayload?.fetchMore,\n    data: listPayload?.resolvedList,\n    isLoading: listPayload?.status === \"loading\",\n    error: undefined,\n    isOptimistic: listPayload?.isOptimistic ?? false\n  };\n}","/*\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 React from \"react\";\nimport { makeExternalStore } from \"./makeExternalStore.js\";\nimport { OsdkContext2 } from \"./OsdkContext2.js\";\n\n/**\n * @param obj an existing `Osdk.Instance` object to get metadata for.\n */\n\n/**\n * Loads an object by type and primary key.\n *\n * @param type\n * @param primaryKey\n */\n\n/*\n    Implementation of useOsdkObject\n */\nexport function useOsdkObject(...args) {\n  const {\n    store\n  } = React.useContext(OsdkContext2);\n\n  // TODO: Figure out what the correct default behavior is for the various scenarios\n  const mode = args.length === 1 ? \"offline\" : undefined;\n  const objectType = args.length === 1 ? args[0].$objectType : args[0].apiName;\n  const primaryKey = args.length === 1 ? args[0].$primaryKey : args[1];\n  const {\n    subscribe,\n    getSnapShot\n  } = React.useMemo(() => makeExternalStore(payload => store.observeObject(objectType, primaryKey, {\n    mode\n  }, payload), `object ${objectType} ${primaryKey}`), [store, objectType, primaryKey, mode]);\n  const payload = React.useSyncExternalStore(subscribe, getSnapShot);\n  return {\n    object: payload?.object,\n    isLoading: payload?.status === \"loading\",\n    isOptimistic: payload?.isOptimistic ?? false,\n    forceUpdate: () => {\n      throw \"not implemented\";\n    }\n  };\n}"]}

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

@@ -1,4 +1,4 @@
-import { Client, ActionDefinition, ActionValidationError, ObjectTypeDefinition, WhereClause, Osdk } from '@osdk/client';
+import { Client, ActionDefinition, ActionValidationError, ObjectTypeDefinition, WhereClause, PropertyKeys, Osdk } from '@osdk/client';
 import { ObservableClient, ActionSignatureFromDef } from '@osdk/client/unstable-do-not-use';
 import React from 'react';
 import { ObjectTypeDefinition as ObjectTypeDefinition$1, Osdk as Osdk$1, PrimaryKeyType } from '@osdk/api';
@@ -11,18 +11,57 @@ interface OsdkProviderOptions {
 }
 declare function OsdkProvider2({ children, client, store, }: OsdkProviderOptions): React.JSX.Element;
 
+type ApplyActionParams<Q extends ActionDefinition<any>> = Parameters<ActionSignatureFromDef<Q>["applyAction"]>[0] & {
+    [K in keyof ObservableClient.ApplyActionOptions as `$${K}`]: ObservableClient.ApplyActionOptions[K];
+};
 interface UseOsdkActionResult<Q extends ActionDefinition<any>> {
-    applyAction: (args: Parameters<ActionSignatureFromDef<Q>["applyAction"]>[0], opts: ObservableClient.ApplyActionOptions) => Promise<unknown>;
+    applyAction: (args: ApplyActionParams<Q>) => Promise<unknown>;
     error: undefined | Partial<{
         actionValidation: ActionValidationError;
         unknown: unknown;
     }>;
     data: unknown;
+    isPending: boolean;
 }
 declare function useOsdkAction<Q extends ActionDefinition<any>>(actionDef: Q): UseOsdkActionResult<Q>;
 
 interface UseOsdkListOptions<T extends ObjectTypeDefinition> {
-    where: WhereClause<T>;
+    /**
+     * Standard OSDK Where
+     */
+    where?: WhereClause<T>;
+    /**
+     *  The preferred page size for the list.
+     */
+    pageSize?: number;
+    /** */
+    orderBy?: {
+        [K in PropertyKeys<T>]?: "asc" | "desc";
+    };
+    /**
+     * Causes the list to automatically fetch more as soon as the previous page
+     * has been loaded. If a number is provided, it will continue to automatically
+     * fetch more until the list is at least that long.
+     */
+    /**
+     * Upon a list being revalidated, this option determines how the component
+     * will be re-rendered with the data.
+     *
+     * An example to help understand the options:
+     *
+     * Suppose pageSize is 10 and we have called `fetchMore()` twice. The list is
+     * now 30 items long.
+     *
+     * Upon revalidation, we get the first 10 items of the list. The options behave
+     * as follows:
+     *
+     * - `"in-place"`: The first 10 items of the list are replaced with the new 10
+     *   items. The list is now 30 items long, but only the first 10 items are valid.
+     * - `"wait"`: The old list is returned until after the next 20 items are loaded
+     *   (which will happen automatically). The list is now 30 items long.
+     * - `"reset"`: The entire list is replaced with the new 10 items. The list is
+     *   now 10 items long.
+     */
     /**
      * The number of milliseconds to wait after the last observed list change.
      *
@@ -30,6 +69,13 @@ interface UseOsdkListOptions<T extends ObjectTypeDefinition> {
      * network request if the second is within `dedupeIntervalMs`.
      */
     dedupeIntervalMs?: number;
+    /**
+     * If provided, the list will be considered this length for the purposes of
+     * `invalidationMode` when using the `wait` option. If not provided,
+     * the internal expectedLength will be determined by the number of times
+     * `fetchMore` has been called.
+     */
+    streamUpdates?: boolean;
 }
 interface UseOsdkListResult<T extends ObjectTypeDefinition> {
     fetchMore: (() => Promise<unknown>) | undefined;
@@ -45,7 +91,7 @@ interface UseOsdkListResult<T extends ObjectTypeDefinition> {
      */
     isOptimistic: boolean;
 }
-declare function useOsdkList<T extends ObjectTypeDefinition>(type: T, opts: UseOsdkListOptions<T>): UseOsdkListResult<T>;
+declare function useOsdkList<T extends ObjectTypeDefinition>(objectType: T, { pageSize, orderBy, dedupeIntervalMs, where, streamUpdates }: UseOsdkListOptions<T>): UseOsdkListResult<T>;
 
 interface UseOsdkObjectResult<Q extends ObjectTypeDefinition$1> {
     object: Osdk$1.Instance<Q> | undefined;

package/build/esm/new/makeExternalStore.js

@@ -14,22 +14,18 @@
  * limitations under the License.
  */
 
-export function makeExternalStore(createObservation, name) {
+export function makeExternalStore(createObservation) {
   let lastResult;
   function getSnapShot() {
     return lastResult;
   }
   return {
     subscribe: function subscribe(notifyUpdate) {
-      // eslint-disable-next-line no-console
-      console.log("Subscribing", name);
       const obs = createObservation(payload => {
         lastResult = payload;
         notifyUpdate();
       });
       return () => {
-        // eslint-disable-next-line no-console
-        console.log("Unsubscribing", name);
         obs.unsubscribe();
       };
     },

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

@@ -1 +1 @@
-{"version":3,"file":"makeExternalStore.js","names":["makeExternalStore","createObservation","name","lastResult","getSnapShot","subscribe","notifyUpdate","console","log","obs","payload","unsubscribe"],"sources":["makeExternalStore.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 { Unsubscribable } from \"@osdk/client/unstable-do-not-use\";\n\nexport function makeExternalStore<X>(\n  createObservation: (callback: (x: X | undefined) => void) => Unsubscribable,\n  name?: string,\n): {\n  subscribe: (notifyUpdate: () => void) => () => void;\n  getSnapShot: () => X | undefined;\n} {\n  let lastResult: X | undefined;\n\n  function getSnapShot(): X | undefined {\n    return lastResult;\n  }\n\n  function subscribe(notifyUpdate: () => void) {\n    // eslint-disable-next-line no-console\n    console.log(\"Subscribing\", name);\n    const obs = createObservation((payload) => {\n      lastResult = payload;\n      notifyUpdate();\n    });\n\n    return (): void => {\n      // eslint-disable-next-line no-console\n      console.log(\"Unsubscribing\", name);\n      obs.unsubscribe();\n    };\n  }\n\n  return {\n    subscribe,\n    getSnapShot,\n  };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAIA,OAAO,SAASA,iBAAiBA,CAC/BC,iBAA2E,EAC3EC,IAAa,EAIb;EACA,IAAIC,UAAyB;EAE7B,SAASC,WAAWA,CAAA,EAAkB;IACpC,OAAOD,UAAU;EACnB;EAiBA,OAAO;IACLE,SAAS,EAhBX,SAASA,SAASA,CAACC,YAAwB,EAAE;MAC3C;MACAC,OAAO,CAACC,GAAG,CAAC,aAAa,EAAEN,IAAI,CAAC;MAChC,MAAMO,GAAG,GAAGR,iBAAiB,CAAES,OAAO,IAAK;QACzCP,UAAU,GAAGO,OAAO;QACpBJ,YAAY,CAAC,CAAC;MAChB,CAAC,CAAC;MAEF,OAAO,MAAY;QACjB;QACAC,OAAO,CAACC,GAAG,CAAC,eAAe,EAAEN,IAAI,CAAC;QAClCO,GAAG,CAACE,WAAW,CAAC,CAAC;MACnB,CAAC;IACH,CAGW;IACTP;EACF,CAAC;AACH","ignoreList":[]}
+{"version":3,"file":"makeExternalStore.js","names":["makeExternalStore","createObservation","lastResult","getSnapShot","subscribe","notifyUpdate","obs","payload","unsubscribe"],"sources":["makeExternalStore.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 { Unsubscribable } from \"@osdk/client/unstable-do-not-use\";\n\nexport function makeExternalStore<X>(\n  createObservation: (callback: (x: X | undefined) => void) => Unsubscribable,\n  name?: string,\n): {\n  subscribe: (notifyUpdate: () => void) => () => void;\n  getSnapShot: () => X | undefined;\n} {\n  let lastResult: X | undefined;\n\n  function getSnapShot(): X | undefined {\n    return lastResult;\n  }\n\n  function subscribe(notifyUpdate: () => void) {\n    const obs = createObservation((payload) => {\n      lastResult = payload;\n      notifyUpdate();\n    });\n\n    return (): void => {\n      obs.unsubscribe();\n    };\n  }\n\n  return {\n    subscribe,\n    getSnapShot,\n  };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAIA,OAAO,SAASA,iBAAiBA,CAC/BC,iBAA2E,EAK3E;EACA,IAAIC,UAAyB;EAE7B,SAASC,WAAWA,CAAA,EAAkB;IACpC,OAAOD,UAAU;EACnB;EAaA,OAAO;IACLE,SAAS,EAZX,SAASA,SAASA,CAACC,YAAwB,EAAE;MAC3C,MAAMC,GAAG,GAAGL,iBAAiB,CAAEM,OAAO,IAAK;QACzCL,UAAU,GAAGK,OAAO;QACpBF,YAAY,CAAC,CAAC;MAChB,CAAC,CAAC;MAEF,OAAO,MAAY;QACjBC,GAAG,CAACE,WAAW,CAAC,CAAC;MACnB,CAAC;IACH,CAGW;IACTL;EACF,CAAC;AACH","ignoreList":[]}

package/build/esm/new/useOsdkAction.js

@@ -23,9 +23,18 @@ export function useOsdkAction(actionDef) {
   } = React.useContext(OsdkContext2);
   const [error, setError] = React.useState();
   const [data, setData] = React.useState();
-  const applyAction = React.useCallback(async function (args, opts) {
+  const [isPending, setPending] = React.useState(false);
+  const applyAction = React.useCallback(async function (hookArgs) {
+    const {
+      $optimisticUpdate,
+      ...args
+    } = hookArgs;
     try {
-      const r = await store.applyAction(actionDef, args, opts);
+      setPending(true);
+      setError(undefined);
+      const r = await store.applyAction(actionDef, args, {
+        optimisticUpdate: $optimisticUpdate
+      });
       setData(r);
       return r;
     } catch (e) {
@@ -38,12 +47,15 @@ export function useOsdkAction(actionDef) {
           unknown: e
         });
       }
+    } finally {
+      setPending(false);
     }
   }, [store, setError]);
   return {
     applyAction,
     error,
-    data
+    data,
+    isPending
   };
 }
 //# sourceMappingURL=useOsdkAction.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"useOsdkAction.js","names":["ActionValidationError","React","OsdkContext2","useOsdkAction","actionDef","store","useContext","error","setError","useState","data","setData","applyAction","useCallback","args","opts","r","e","actionValidation","unknown"],"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 { ActionDefinition } 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\nexport interface UseOsdkActionResult<Q extends ActionDefinition<any>> {\n  applyAction: (\n    args: Parameters<ActionSignatureFromDef<Q>[\"applyAction\"]>[0],\n    opts: ObservableClient.ApplyActionOptions,\n  ) => Promise<unknown>;\n\n  error:\n    | undefined\n    | Partial<{\n      actionValidation: ActionValidationError;\n      unknown: unknown;\n    }>;\n  data: unknown;\n}\n\nexport function useOsdkAction<Q extends ActionDefinition<any>>(\n  actionDef: Q,\n): UseOsdkActionResult<Q> {\n  const { store } = React.useContext(OsdkContext2);\n  const [error, setError] = React.useState<UseOsdkActionResult<Q>[\"error\"]>();\n  const [data, setData] = React.useState<unknown>();\n\n  const applyAction = React.useCallback(async function applyAction(\n    args: Parameters<ActionSignatureFromDef<Q>[\"applyAction\"]>[0],\n    opts: ObservableClient.ApplyActionOptions,\n  ) {\n    try {\n      const r = await store.applyAction(actionDef, args, opts);\n      setData(r);\n      return r;\n    } catch (e) {\n      if (e instanceof ActionValidationError) {\n        setError({\n          actionValidation: e,\n        });\n      } else {\n        setError({ unknown: e });\n      }\n    }\n  }, [store, setError]);\n\n  return { applyAction, error, data };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA,SAASA,qBAAqB,QAAQ,cAAc;AAKpD,OAAOC,KAAK,MAAM,OAAO;AACzB,SAASC,YAAY,QAAQ,mBAAmB;AAiBhD,OAAO,SAASC,aAAaA,CAC3BC,SAAY,EACY;EACxB,MAAM;IAAEC;EAAM,CAAC,GAAGJ,KAAK,CAACK,UAAU,CAACJ,YAAY,CAAC;EAChD,MAAM,CAACK,KAAK,EAAEC,QAAQ,CAAC,GAAGP,KAAK,CAACQ,QAAQ,CAAkC,CAAC;EAC3E,MAAM,CAACC,IAAI,EAAEC,OAAO,CAAC,GAAGV,KAAK,CAACQ,QAAQ,CAAU,CAAC;EAEjD,MAAMG,WAAW,GAAGX,KAAK,CAACY,WAAW,CAAC,gBACpCC,IAA6D,EAC7DC,IAAyC,EACzC;IACA,IAAI;MACF,MAAMC,CAAC,GAAG,MAAMX,KAAK,CAACO,WAAW,CAACR,SAAS,EAAEU,IAAI,EAAEC,IAAI,CAAC;MACxDJ,OAAO,CAACK,CAAC,CAAC;MACV,OAAOA,CAAC;IACV,CAAC,CAAC,OAAOC,CAAC,EAAE;MACV,IAAIA,CAAC,YAAYjB,qBAAqB,EAAE;QACtCQ,QAAQ,CAAC;UACPU,gBAAgB,EAAED;QACpB,CAAC,CAAC;MACJ,CAAC,MAAM;QACLT,QAAQ,CAAC;UAAEW,OAAO,EAAEF;QAAE,CAAC,CAAC;MAC1B;IACF;EACF,CAAC,EAAE,CAACZ,KAAK,EAAEG,QAAQ,CAAC,CAAC;EAErB,OAAO;IAAEI,WAAW;IAAEL,KAAK;IAAEG;EAAK,CAAC;AACrC","ignoreList":[]}
+{"version":3,"file":"useOsdkAction.js","names":["ActionValidationError","React","OsdkContext2","useOsdkAction","actionDef","store","useContext","error","setError","useState","data","setData","isPending","setPending","applyAction","useCallback","hookArgs","$optimisticUpdate","args","undefined","r","optimisticUpdate","e","actionValidation","unknown"],"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 { ActionDefinition } 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>,\n  ) => Promise<unknown>;\n\n  error:\n    | undefined\n    | Partial<{\n      actionValidation: ActionValidationError;\n      unknown: unknown;\n    }>;\n  data: unknown;\n\n  isPending: boolean;\n}\n\nexport function useOsdkAction<Q extends ActionDefinition<any>>(\n  actionDef: Q,\n): UseOsdkActionResult<Q> {\n  const { store } = React.useContext(OsdkContext2);\n  const [error, setError] = React.useState<UseOsdkActionResult<Q>[\"error\"]>();\n  const [data, setData] = React.useState<unknown>();\n  const [isPending, setPending] = React.useState(false);\n\n  const applyAction = React.useCallback(async function applyAction(\n    hookArgs: ApplyActionParams<Q>,\n  ) {\n    const { $optimisticUpdate, ...args } = hookArgs;\n    try {\n      setPending(true);\n      setError(undefined);\n      const r = await store.applyAction(actionDef, args, {\n        optimisticUpdate: $optimisticUpdate,\n      });\n      setData(r);\n      return r;\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  }, [store, setError]);\n\n  return { applyAction, error, data, isPending };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA,SAASA,qBAAqB,QAAQ,cAAc;AAKpD,OAAOC,KAAK,MAAM,OAAO;AACzB,SAASC,YAAY,QAAQ,mBAAmB;AAyBhD,OAAO,SAASC,aAAaA,CAC3BC,SAAY,EACY;EACxB,MAAM;IAAEC;EAAM,CAAC,GAAGJ,KAAK,CAACK,UAAU,CAACJ,YAAY,CAAC;EAChD,MAAM,CAACK,KAAK,EAAEC,QAAQ,CAAC,GAAGP,KAAK,CAACQ,QAAQ,CAAkC,CAAC;EAC3E,MAAM,CAACC,IAAI,EAAEC,OAAO,CAAC,GAAGV,KAAK,CAACQ,QAAQ,CAAU,CAAC;EACjD,MAAM,CAACG,SAAS,EAAEC,UAAU,CAAC,GAAGZ,KAAK,CAACQ,QAAQ,CAAC,KAAK,CAAC;EAErD,MAAMK,WAAW,GAAGb,KAAK,CAACc,WAAW,CAAC,gBACpCC,QAA8B,EAC9B;IACA,MAAM;MAAEC,iBAAiB;MAAE,GAAGC;IAAK,CAAC,GAAGF,QAAQ;IAC/C,IAAI;MACFH,UAAU,CAAC,IAAI,CAAC;MAChBL,QAAQ,CAACW,SAAS,CAAC;MACnB,MAAMC,CAAC,GAAG,MAAMf,KAAK,CAACS,WAAW,CAACV,SAAS,EAAEc,IAAI,EAAE;QACjDG,gBAAgB,EAAEJ;MACpB,CAAC,CAAC;MACFN,OAAO,CAACS,CAAC,CAAC;MACV,OAAOA,CAAC;IACV,CAAC,CAAC,OAAOE,CAAC,EAAE;MACV,IAAIA,CAAC,YAAYtB,qBAAqB,EAAE;QACtCQ,QAAQ,CAAC;UACPe,gBAAgB,EAAED;QACpB,CAAC,CAAC;MACJ,CAAC,MAAM;QACLd,QAAQ,CAAC;UAAEgB,OAAO,EAAEF;QAAE,CAAC,CAAC;MAC1B;IACF,CAAC,SAAS;MACRT,UAAU,CAAC,KAAK,CAAC;IACnB;EACF,CAAC,EAAE,CAACR,KAAK,EAAEG,QAAQ,CAAC,CAAC;EAErB,OAAO;IAAEM,WAAW;IAAEP,KAAK;IAAEG,IAAI;IAAEE;EAAU,CAAC;AAChD","ignoreList":[]}

package/build/esm/new/useOsdkList.js

@@ -17,17 +17,33 @@
 import React from "react";
 import { makeExternalStore } from "./makeExternalStore.js";
 import { OsdkContext2 } from "./OsdkContext2.js";
-export function useOsdkList(type, opts) {
+export function useOsdkList(objectType, {
+  pageSize,
+  orderBy,
+  dedupeIntervalMs,
+  where,
+  streamUpdates
+}) {
   const {
     store
   } = React.useContext(OsdkContext2);
-  const where = store.canonicalizeWhereClause(opts.where);
+
+  /*  We want the canonical where clause so that the use of `React.useMemo`
+      is stable. No real added cost as we canonicalize internal to
+      the ObservableClient anyway.
+   */
+  const canonWhere = store.canonicalizeWhereClause(where ?? {});
   const {
     subscribe,
     getSnapShot
-  } = React.useMemo(() => makeExternalStore(x => store.observeList(type, where, {
-    dedupeInterval: opts.dedupeIntervalMs ?? 2_000
-  }, x), `list ${type.apiName} ${JSON.stringify(where)}`), [store, type, where, opts.dedupeIntervalMs]);
+  } = React.useMemo(() => makeExternalStore(x => store.observeList({
+    objectType,
+    where: canonWhere,
+    dedupeInterval: dedupeIntervalMs ?? 2_000,
+    pageSize,
+    orderBy,
+    streamUpdates
+  }, x), process.env.NODE_ENV !== "production" ? `list ${objectType.apiName} ${JSON.stringify(canonWhere)}` : void 0), [store, objectType, canonWhere, dedupeIntervalMs]);
   const listPayload = React.useSyncExternalStore(subscribe, getSnapShot);
   return {
     fetchMore: listPayload?.fetchMore,

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

@@ -1 +1 @@
-{"version":3,"file":"useOsdkList.js","names":["React","makeExternalStore","OsdkContext2","useOsdkList","type","opts","store","useContext","where","canonicalizeWhereClause","subscribe","getSnapShot","useMemo","x","observeList","dedupeInterval","dedupeIntervalMs","apiName","JSON","stringify","listPayload","useSyncExternalStore","fetchMore","data","resolvedList","isLoading","status","error","undefined","isOptimistic"],"sources":["useOsdkList.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { ObjectTypeDefinition, Osdk, WhereClause } from \"@osdk/client\";\nimport type { ListPayload } from \"@osdk/client/unstable-do-not-use\";\nimport React from \"react\";\nimport { makeExternalStore } from \"./makeExternalStore.js\";\nimport { OsdkContext2 } from \"./OsdkContext2.js\";\n\nexport interface UseOsdkListOptions<T extends ObjectTypeDefinition> {\n  where: WhereClause<T>;\n\n  /**\n   * The number of milliseconds to wait after the last observed list change.\n   *\n   * Two uses of `useOsdkList` with the where clause will only trigger one\n   * network request if the second is within `dedupeIntervalMs`.\n   */\n  dedupeIntervalMs?: number;\n}\nexport interface UseOsdkListResult<T extends ObjectTypeDefinition> {\n  fetchMore: (() => Promise<unknown>) | undefined;\n  data: Osdk.Instance<T>[];\n  isLoading: boolean;\n\n  // FIXME populate error!\n  error: undefined;\n\n  /**\n   * Refers to whether the ordered list of objects (only considering the $primaryKey)\n   * is optimistic or not.\n   *\n   * If you need to know if the contents of the list are optimistic you can\n   * do that on a per object basis with useOsdkObject\n   */\n  isOptimistic: boolean;\n}\n\nexport function useOsdkList<T extends ObjectTypeDefinition>(\n  type: T,\n  opts: UseOsdkListOptions<T>,\n): UseOsdkListResult<T> {\n  const { store } = React.useContext(OsdkContext2);\n  const where = store.canonicalizeWhereClause(opts.where);\n\n  const { subscribe, getSnapShot } = React.useMemo(\n    () =>\n      makeExternalStore<ListPayload>((x) =>\n        store.observeList(\n          type,\n          where,\n          {\n            dedupeInterval: opts.dedupeIntervalMs ?? 2_000,\n          },\n          x,\n        ), `list ${type.apiName} ${JSON.stringify(where)}`),\n    [store, type, where, opts.dedupeIntervalMs],\n  );\n\n  const listPayload = React.useSyncExternalStore(subscribe, getSnapShot);\n\n  return {\n    fetchMore: listPayload?.fetchMore,\n    data: listPayload?.resolvedList as Osdk.Instance<T>[],\n    isLoading: listPayload?.status === \"loading\",\n    error: undefined,\n    isOptimistic: listPayload?.isOptimistic ?? false,\n  };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAIA,OAAOA,KAAK,MAAM,OAAO;AACzB,SAASC,iBAAiB,QAAQ,wBAAwB;AAC1D,SAASC,YAAY,QAAQ,mBAAmB;AA+BhD,OAAO,SAASC,WAAWA,CACzBC,IAAO,EACPC,IAA2B,EACL;EACtB,MAAM;IAAEC;EAAM,CAAC,GAAGN,KAAK,CAACO,UAAU,CAACL,YAAY,CAAC;EAChD,MAAMM,KAAK,GAAGF,KAAK,CAACG,uBAAuB,CAACJ,IAAI,CAACG,KAAK,CAAC;EAEvD,MAAM;IAAEE,SAAS;IAAEC;EAAY,CAAC,GAAGX,KAAK,CAACY,OAAO,CAC9C,MACEX,iBAAiB,CAAeY,CAAC,IAC/BP,KAAK,CAACQ,WAAW,CACfV,IAAI,EACJI,KAAK,EACL;IACEO,cAAc,EAAEV,IAAI,CAACW,gBAAgB,IAAI;EAC3C,CAAC,EACDH,CACF,CAAC,EAAE,QAAQT,IAAI,CAACa,OAAO,IAAIC,IAAI,CAACC,SAAS,CAACX,KAAK,CAAC,EAAE,CAAC,EACvD,CAACF,KAAK,EAAEF,IAAI,EAAEI,KAAK,EAAEH,IAAI,CAACW,gBAAgB,CAC5C,CAAC;EAED,MAAMI,WAAW,GAAGpB,KAAK,CAACqB,oBAAoB,CAACX,SAAS,EAAEC,WAAW,CAAC;EAEtE,OAAO;IACLW,SAAS,EAAEF,WAAW,EAAEE,SAAS;IACjCC,IAAI,EAAEH,WAAW,EAAEI,YAAkC;IACrDC,SAAS,EAAEL,WAAW,EAAEM,MAAM,KAAK,SAAS;IAC5CC,KAAK,EAAEC,SAAS;IAChBC,YAAY,EAAET,WAAW,EAAES,YAAY,IAAI;EAC7C,CAAC;AACH","ignoreList":[]}
+{"version":3,"file":"useOsdkList.js","names":["React","makeExternalStore","OsdkContext2","useOsdkList","objectType","pageSize","orderBy","dedupeIntervalMs","where","streamUpdates","store","useContext","canonWhere","canonicalizeWhereClause","subscribe","getSnapShot","useMemo","x","observeList","dedupeInterval","process","env","NODE_ENV","apiName","JSON","stringify","listPayload","useSyncExternalStore","fetchMore","data","resolvedList","isLoading","status","error","undefined","isOptimistic"],"sources":["useOsdkList.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  ObjectTypeDefinition,\n  Osdk,\n  PropertyKeys,\n  WhereClause,\n} from \"@osdk/client\";\nimport type { ListPayload } from \"@osdk/client/unstable-do-not-use\";\nimport React from \"react\";\nimport { makeExternalStore } from \"./makeExternalStore.js\";\nimport { OsdkContext2 } from \"./OsdkContext2.js\";\n\nexport interface UseOsdkListOptions<T extends ObjectTypeDefinition> {\n  /**\n   * Standard OSDK Where\n   */\n  where?: WhereClause<T>;\n\n  /**\n   *  The preferred page size for the list.\n   */\n  pageSize?: number;\n\n  /** */\n  orderBy?: {\n    [K in PropertyKeys<T>]?: \"asc\" | \"desc\";\n  };\n\n  /**\n   * Causes the list to automatically fetch more as soon as the previous page\n   * has been loaded. If a number is provided, it will continue to automatically\n   * fetch more until the list is at least that long.\n   */\n  // autoFetchMore?: boolean | number;\n\n  /**\n   * Upon a list being revalidated, this option determines how the component\n   * will be re-rendered with the data.\n   *\n   * An example to help understand the options:\n   *\n   * Suppose pageSize is 10 and we have called `fetchMore()` twice. The list is\n   * now 30 items long.\n   *\n   * Upon revalidation, we get the first 10 items of the list. The options behave\n   * as follows:\n   *\n   * - `\"in-place\"`: The first 10 items of the list are replaced with the new 10\n   *   items. The list is now 30 items long, but only the first 10 items are valid.\n   * - `\"wait\"`: The old list is returned until after the next 20 items are loaded\n   *   (which will happen automatically). The list is now 30 items long.\n   * - `\"reset\"`: The entire list is replaced with the new 10 items. The list is\n   *   now 10 items long.\n   */\n  // invalidationMode?: \"in-place\" | \"wait\" | \"reset\";\n\n  /**\n   * The number of milliseconds to wait after the last observed list change.\n   *\n   * Two uses of `useOsdkList` with the where clause will only trigger one\n   * network request if the second is within `dedupeIntervalMs`.\n   */\n  dedupeIntervalMs?: number;\n\n  /**\n   * If provided, the list will be considered this length for the purposes of\n   * `invalidationMode` when using the `wait` option. If not provided,\n   * the internal expectedLength will be determined by the number of times\n   * `fetchMore` has been called.\n   */\n  // expectedLength?: number | undefined;\n\n  streamUpdates?: boolean;\n}\n\nexport interface UseOsdkListResult<T extends ObjectTypeDefinition> {\n  fetchMore: (() => Promise<unknown>) | undefined;\n  data: Osdk.Instance<T>[];\n  isLoading: boolean;\n\n  // FIXME populate error!\n  error: undefined;\n\n  /**\n   * Refers to whether the ordered list of objects (only considering the $primaryKey)\n   * is optimistic or not.\n   *\n   * If you need to know if the contents of the list are optimistic you can\n   * do that on a per object basis with useOsdkObject\n   */\n  isOptimistic: boolean;\n}\n\ndeclare const process: {\n  env: {\n    NODE_ENV: \"development\" | \"production\";\n  };\n};\n\nexport function useOsdkList<T extends ObjectTypeDefinition>(\n  objectType: T,\n  { pageSize, orderBy, dedupeIntervalMs, where, streamUpdates }:\n    UseOsdkListOptions<T>,\n): UseOsdkListResult<T> {\n  const { store } = React.useContext(OsdkContext2);\n\n  /*  We want the canonical where clause so that the use of `React.useMemo`\n      is stable. No real added cost as we canonicalize internal to\n      the ObservableClient anyway.\n   */\n  const canonWhere = store.canonicalizeWhereClause(where ?? {});\n\n  const { subscribe, getSnapShot } = React.useMemo(\n    () =>\n      makeExternalStore<ListPayload>(\n        (x) =>\n          store.observeList({\n            objectType,\n            where: canonWhere,\n            dedupeInterval: dedupeIntervalMs ?? 2_000,\n            pageSize,\n            orderBy,\n            streamUpdates,\n          }, x),\n        process.env.NODE_ENV !== \"production\"\n          ? `list ${objectType.apiName} ${JSON.stringify(canonWhere)}`\n          : void 0,\n      ),\n    [store, objectType, canonWhere, dedupeIntervalMs],\n  );\n\n  const listPayload = React.useSyncExternalStore(subscribe, getSnapShot);\n\n  return {\n    fetchMore: listPayload?.fetchMore,\n    data: listPayload?.resolvedList as Osdk.Instance<T>[],\n    isLoading: listPayload?.status === \"loading\",\n    error: undefined,\n    isOptimistic: listPayload?.isOptimistic ?? 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;AAyFhD,OAAO,SAASC,WAAWA,CACzBC,UAAa,EACb;EAAEC,QAAQ;EAAEC,OAAO;EAAEC,gBAAgB;EAAEC,KAAK;EAAEC;AACxB,CAAC,EACD;EACtB,MAAM;IAAEC;EAAM,CAAC,GAAGV,KAAK,CAACW,UAAU,CAACT,YAAY,CAAC;;EAEhD;AACF;AACA;AACA;EACE,MAAMU,UAAU,GAAGF,KAAK,CAACG,uBAAuB,CAACL,KAAK,IAAI,CAAC,CAAC,CAAC;EAE7D,MAAM;IAAEM,SAAS;IAAEC;EAAY,CAAC,GAAGf,KAAK,CAACgB,OAAO,CAC9C,MACEf,iBAAiB,CACdgB,CAAC,IACAP,KAAK,CAACQ,WAAW,CAAC;IAChBd,UAAU;IACVI,KAAK,EAAEI,UAAU;IACjBO,cAAc,EAAEZ,gBAAgB,IAAI,KAAK;IACzCF,QAAQ;IACRC,OAAO;IACPG;EACF,CAAC,EAAEQ,CAAC,CAAC,EACPG,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,GACjC,QAAQlB,UAAU,CAACmB,OAAO,IAAIC,IAAI,CAACC,SAAS,CAACb,UAAU,CAAC,EAAE,GAC1D,KAAK,CACX,CAAC,EACH,CAACF,KAAK,EAAEN,UAAU,EAAEQ,UAAU,EAAEL,gBAAgB,CAClD,CAAC;EAED,MAAMmB,WAAW,GAAG1B,KAAK,CAAC2B,oBAAoB,CAACb,SAAS,EAAEC,WAAW,CAAC;EAEtE,OAAO;IACLa,SAAS,EAAEF,WAAW,EAAEE,SAAS;IACjCC,IAAI,EAAEH,WAAW,EAAEI,YAAkC;IACrDC,SAAS,EAAEL,WAAW,EAAEM,MAAM,KAAK,SAAS;IAC5CC,KAAK,EAAEC,SAAS;IAChBC,YAAY,EAAET,WAAW,EAAES,YAAY,IAAI;EAC7C,CAAC;AACH","ignoreList":[]}

package/build/types/new/useOsdkAction.d.ts

@@ -1,12 +1,15 @@
 import type { ActionDefinition } from "@osdk/client";
 import { ActionValidationError } from "@osdk/client";
 import type { ActionSignatureFromDef, ObservableClient } from "@osdk/client/unstable-do-not-use";
+type ApplyActionParams<Q extends ActionDefinition<any>> = Parameters<ActionSignatureFromDef<Q>["applyAction"]>[0] & { [K in keyof ObservableClient.ApplyActionOptions as `$${K}`] : ObservableClient.ApplyActionOptions[K] };
 export interface UseOsdkActionResult<Q extends ActionDefinition<any>> {
-	applyAction: (args: Parameters<ActionSignatureFromDef<Q>["applyAction"]>[0], opts: ObservableClient.ApplyActionOptions) => Promise<unknown>;
+	applyAction: (args: ApplyActionParams<Q>) => Promise<unknown>;
 	error: undefined | Partial<{
 		actionValidation: ActionValidationError
 		unknown: unknown
 	}>;
 	data: unknown;
+	isPending: boolean;
 }
 export declare function useOsdkAction<Q extends ActionDefinition<any>>(actionDef: Q): UseOsdkActionResult<Q>;
+export {};

package/build/types/new/useOsdkAction.d.ts.map

@@ -1 +1 @@
-{"mappings":"AAgBA,cAAc,wBAAwB,cAAe;AACrD,SAAS,6BAA6B,cAAe;AACrD,cACE,wBACA,wBACK,kCAAmC;AAI1C,iBAAiB,oBAAoB,UAAU,uBAAuB;CACpE,cACEA,MAAM,WAAW,uBAAuB,GAAG,gBAAgB,IAC3DC,MAAM,iBAAiB,uBACpB;CAEL,mBAEI,QAAQ;EACR,kBAAkB;EAClB;CACD;CACH;AACD;AAED,OAAO,iBAAS,cAAc,UAAU,uBACtCC,WAAW,IACV,oBAAoB","names":["args: Parameters<ActionSignatureFromDef<Q>[\"applyAction\"]>[0]","opts: ObservableClient.ApplyActionOptions","actionDef: Q"],"sources":["../../../src/new/useOsdkAction.ts"],"version":3,"file":"useOsdkAction.d.ts"}
+{"mappings":"AAgBA,cAAc,wBAAwB,cAAe;AACrD,SAAS,6BAA6B,cAAe;AACrD,cACE,wBACA,wBACK,kCAAmC;KAIrC,kBAAkB,UAAU,yBAC7B,WAAW,uBAAuB,GAAG,gBAAgB,QAEpD,WAAW,iBAAiB,0BAA0B,OACrD,iBAAiB,mBAAmB;AAG1C,iBAAiB,oBAAoB,UAAU,uBAAuB;CACpE,cACEA,MAAM,kBAAkB,OACrB;CAEL,mBAEI,QAAQ;EACR,kBAAkB;EAClB;CACD;CACH;CAEA;AACD;AAED,OAAO,iBAAS,cAAc,UAAU,uBACtCC,WAAW,IACV,oBAAoB","names":["args: ApplyActionParams<Q>","actionDef: Q"],"sources":["../../../src/new/useOsdkAction.ts"],"version":3,"file":"useOsdkAction.d.ts"}

package/build/types/new/useOsdkList.d.ts

@@ -1,6 +1,39 @@
-import type { ObjectTypeDefinition, Osdk, WhereClause } from "@osdk/client";
+import type { ObjectTypeDefinition, Osdk, PropertyKeys, WhereClause } from "@osdk/client";
 export interface UseOsdkListOptions<T extends ObjectTypeDefinition> {
-	where: WhereClause<T>;
+	/**
+	* Standard OSDK Where
+	*/
+	where?: WhereClause<T>;
+	/**
+	*  The preferred page size for the list.
+	*/
+	pageSize?: number;
+	/** */
+	orderBy?: { [K in PropertyKeys<T>]? : "asc" | "desc" };
+	/**
+	* Causes the list to automatically fetch more as soon as the previous page
+	* has been loaded. If a number is provided, it will continue to automatically
+	* fetch more until the list is at least that long.
+	*/
+	/**
+	* Upon a list being revalidated, this option determines how the component
+	* will be re-rendered with the data.
+	*
+	* An example to help understand the options:
+	*
+	* Suppose pageSize is 10 and we have called `fetchMore()` twice. The list is
+	* now 30 items long.
+	*
+	* Upon revalidation, we get the first 10 items of the list. The options behave
+	* as follows:
+	*
+	* - `"in-place"`: The first 10 items of the list are replaced with the new 10
+	*   items. The list is now 30 items long, but only the first 10 items are valid.
+	* - `"wait"`: The old list is returned until after the next 20 items are loaded
+	*   (which will happen automatically). The list is now 30 items long.
+	* - `"reset"`: The entire list is replaced with the new 10 items. The list is
+	*   now 10 items long.
+	*/
 	/**
 	* The number of milliseconds to wait after the last observed list change.
 	*
@@ -8,6 +41,13 @@ export interface UseOsdkListOptions<T extends ObjectTypeDefinition> {
 	* network request if the second is within `dedupeIntervalMs`.
 	*/
 	dedupeIntervalMs?: number;
+	/**
+	* If provided, the list will be considered this length for the purposes of
+	* `invalidationMode` when using the `wait` option. If not provided,
+	* the internal expectedLength will be determined by the number of times
+	* `fetchMore` has been called.
+	*/
+	streamUpdates?: boolean;
 }
 export interface UseOsdkListResult<T extends ObjectTypeDefinition> {
 	fetchMore: (() => Promise<unknown>) | undefined;
@@ -23,4 +63,4 @@ export interface UseOsdkListResult<T extends ObjectTypeDefinition> {
 	*/
 	isOptimistic: boolean;
 }
-export declare function useOsdkList<T extends ObjectTypeDefinition>(type: T, opts: UseOsdkListOptions<T>): UseOsdkListResult<T>;
+export declare function useOsdkList<T extends ObjectTypeDefinition>(objectType: T, { pageSize, orderBy, dedupeIntervalMs, where, streamUpdates }: UseOsdkListOptions<T>): UseOsdkListResult<T>;

package/build/types/new/useOsdkList.d.ts.map

@@ -1 +1 @@
-{"mappings":"AAgBA,cAAc,sBAAsB,MAAM,mBAAmB,cAAe;AAM5E,iBAAiB,mBAAmB,UAAU,sBAAsB;CAClE,OAAO,YAAY;;;;;;;CAQnB;AACD;AACD,iBAAiB,kBAAkB,UAAU,sBAAsB;CACjE,kBAAkB;CAClB,MAAM,KAAK,SAAS;CACpB;CAGA;;;;;;;;CASA;AACD;AAED,OAAO,iBAAS,YAAY,UAAU,sBACpCA,MAAM,GACNC,MAAM,mBAAmB,KACxB,kBAAkB","names":["type: T","opts: UseOsdkListOptions<T>"],"sources":["../../../src/new/useOsdkList.ts"],"version":3,"file":"useOsdkList.d.ts"}
+{"mappings":"AAgBA,cACE,sBACA,MACA,cACA,mBACK,cAAe;AAMtB,iBAAiB,mBAAmB,UAAU,sBAAsB;;;;CAIlE,QAAQ,YAAY;;;;CAKpB;;CAGA,aACG,KAAK,aAAa,OAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqCnC;;;;;;;CAUA;AACD;AAED,iBAAiB,kBAAkB,UAAU,sBAAsB;CACjE,kBAAkB;CAClB,MAAM,KAAK,SAAS;CACpB;CAGA;;;;;;;;CASA;AACD;AAQD,OAAO,iBAAS,YAAY,UAAU,sBACpCA,YAAY,GACZ,EAAE,UAAU,SAAS,kBAAkB,OAAO,eACvB,EAArB,mBAAmB,KACpB,kBAAkB","names":["objectType: T"],"sources":["../../../src/new/useOsdkList.ts"],"version":3,"file":"useOsdkList.d.ts"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@osdk/react",
-  "version": "0.3.0-rc.4",
+  "version": "0.4.0-beta.2",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
@@ -49,10 +49,10 @@
     "p-defer": "^4.0.1",
     "react": "^18.0.0",
     "typescript": "~5.5.4",
-    "@osdk/api": "2.1.0-rc.32",
-    "@osdk/client": "2.1.0-rc.32",
-    "@osdk/monorepo.api-extractor": "~0.0.0",
-    "@osdk/monorepo.tsconfig": "~0.0.0"
+    "@osdk/api": "2.2.0-beta.4",
+    "@osdk/client": "2.2.0-beta.4",
+    "@osdk/monorepo.tsconfig": "~0.1.0-beta.1",
+    "@osdk/monorepo.api-extractor": "~0.1.0-beta.1"
   },
   "publishConfig": {
     "access": "public"