@osdk/react 0.4.0-beta.1 → 0.4.0-beta.3

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

@@ -1 +0,0 @@
-{"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":[]}

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

@@ -1 +0,0 @@
-{"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":[]}

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

@@ -1,26 +0,0 @@
-import type { ObjectTypeDefinition, Osdk, WhereClause } from "@osdk/client";
-export interface UseOsdkListOptions<T extends ObjectTypeDefinition> {
-	where: WhereClause<T>;
-	/**
-	* The number of milliseconds to wait after the last observed list change.
-	*
-	* Two uses of `useOsdkList` with the where clause will only trigger one
-	* network request if the second is within `dedupeIntervalMs`.
-	*/
-	dedupeIntervalMs?: number;
-}
-export interface UseOsdkListResult<T extends ObjectTypeDefinition> {
-	fetchMore: (() => Promise<unknown>) | undefined;
-	data: Osdk.Instance<T>[];
-	isLoading: boolean;
-	error: undefined;
-	/**
-	* Refers to whether the ordered list of objects (only considering the $primaryKey)
-	* is optimistic or not.
-	*
-	* If you need to know if the contents of the list are optimistic you can
-	* do that on a per object basis with useOsdkObject
-	*/
-	isOptimistic: boolean;
-}
-export declare function useOsdkList<T extends ObjectTypeDefinition>(type: T, opts: UseOsdkListOptions<T>): UseOsdkListResult<T>;

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

@@ -1 +0,0 @@
-{"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"}