@osdk/react 0.9.0-beta.2 → 0.9.0-beta.4

package/build/browser/utils/usePlatformQuery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"usePlatformQuery.js","names":["React","makeExternalStore","usePlatformQuery","query","queryName","enabled","observerRef","useRef","handleQuery","useCallback","observer","current","next","status","data","undefined","then","catch","err","error","subscribe","getSnapShot","useMemo","unsubscribe","process","env","NODE_ENV","payload","useSyncExternalStore","Error","isLoading","refetch"],"sources":["usePlatformQuery.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 { Observer } from \"@osdk/client/unstable-do-not-use\";\nimport React from \"react\";\nimport { makeExternalStore } from \"../new/makeExternalStore.js\";\n\nexport interface UseQueryOptions<T> {\n  /**\n   * Enable or disable the query.\n   *\n   * When `false`, the query will not automatically execute.\n   *\n   * This is useful for:\n   * - Lazy/on-demand queries that should wait for user interaction\n   * - Dependent queries that need data from another query first\n   * - Conditional queries based on component state\n   *\n   * @default true\n   * });\n   */\n  enabled?: boolean;\n  queryName: string;\n  query: () => Promise<T>;\n}\n\nexport interface QueryResult<T> {\n  data: T | undefined;\n  isLoading: boolean;\n  error: Error | undefined;\n  refetch: () => void;\n}\n\ninterface QueryPayload<T> {\n  data: T | undefined;\n  status: \"loading\" | \"success\" | \"error\";\n}\n\nexport function usePlatformQuery<T>(\n  { query, queryName, enabled = true }: UseQueryOptions<T>,\n): QueryResult<T> {\n  const observerRef = React.useRef<Observer<QueryPayload<T> | undefined>>();\n\n  const handleQuery = React.useCallback(() => {\n    const observer = observerRef.current;\n    if (observer == null) return;\n\n    observer.next({\n      status: \"loading\",\n      data: undefined,\n    });\n\n    query()\n      .then((data) => {\n        observer.next({\n          status: \"success\",\n          data,\n        });\n      })\n      .catch((err: unknown) => {\n        observer.error(err);\n      });\n  }, [query]);\n\n  const { subscribe, getSnapShot } = React.useMemo(\n    () => {\n      if (!enabled) {\n        return makeExternalStore<QueryPayload<T>>(\n          () => ({ unsubscribe: () => {} }),\n          process.env.NODE_ENV !== \"production\"\n            ? `${queryName} Query [DISABLED]`\n            : undefined,\n        );\n      }\n\n      return makeExternalStore<QueryPayload<T>>(\n        (observer: Observer<QueryPayload<T> | undefined>) => {\n          observerRef.current = observer;\n          handleQuery();\n          return {\n            unsubscribe: () => {\n              observerRef.current = undefined;\n            },\n          };\n        },\n        queryName,\n      );\n    },\n    [enabled, queryName, handleQuery],\n  );\n\n  const payload = React.useSyncExternalStore(subscribe, getSnapShot);\n\n  let error: Error | undefined;\n  if (payload && \"error\" in payload && payload.error != null) {\n    error = payload.error;\n  } else if (payload?.status === \"error\") {\n    error = new Error(`Failed to query platform API: ${queryName}`);\n  }\n\n  return {\n    data: payload?.data,\n    isLoading: payload?.status === \"loading\",\n    error,\n    refetch: handleQuery,\n  };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA,OAAOA,KAAK,MAAM,OAAO;AACzB,SAASC,iBAAiB,QAAQ,6BAA6B;AAiC/D,OAAO,SAASC,gBAAgBA,CAC9B;EAAEC,KAAK;EAAEC,SAAS;EAAEC,OAAO,GAAG;AAAyB,CAAC,EACxC;EAChB,MAAMC,WAAW,GAAGN,KAAK,CAACO,MAAM,CAAwC,CAAC;EAEzE,MAAMC,WAAW,GAAGR,KAAK,CAACS,WAAW,CAAC,MAAM;IAC1C,MAAMC,QAAQ,GAAGJ,WAAW,CAACK,OAAO;IACpC,IAAID,QAAQ,IAAI,IAAI,EAAE;IAEtBA,QAAQ,CAACE,IAAI,CAAC;MACZC,MAAM,EAAE,SAAS;MACjBC,IAAI,EAAEC;IACR,CAAC,CAAC;IAEFZ,KAAK,CAAC,CAAC,CACJa,IAAI,CAAEF,IAAI,IAAK;MACdJ,QAAQ,CAACE,IAAI,CAAC;QACZC,MAAM,EAAE,SAAS;QACjBC;MACF,CAAC,CAAC;IACJ,CAAC,CAAC,CACDG,KAAK,CAAEC,GAAY,IAAK;MACvBR,QAAQ,CAACS,KAAK,CAACD,GAAG,CAAC;IACrB,CAAC,CAAC;EACN,CAAC,EAAE,CAACf,KAAK,CAAC,CAAC;EAEX,MAAM;IAAEiB,SAAS;IAAEC;EAAY,CAAC,GAAGrB,KAAK,CAACsB,OAAO,CAC9C,MAAM;IACJ,IAAI,CAACjB,OAAO,EAAE;MACZ,OAAOJ,iBAAiB,CACtB,OAAO;QAAEsB,WAAW,EAAEA,CAAA,KAAM,CAAC;MAAE,CAAC,CAAC,EACjCC,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,GACjC,GAAGtB,SAAS,mBAAmB,GAC/BW,SACN,CAAC;IACH;IAEA,OAAOd,iBAAiB,CACrBS,QAA+C,IAAK;MACnDJ,WAAW,CAACK,OAAO,GAAGD,QAAQ;MAC9BF,WAAW,CAAC,CAAC;MACb,OAAO;QACLe,WAAW,EAAEA,CAAA,KAAM;UACjBjB,WAAW,CAACK,OAAO,GAAGI,SAAS;QACjC;MACF,CAAC;IACH,CAAC,EACDX,SACF,CAAC;EACH,CAAC,EACD,CAACC,OAAO,EAAED,SAAS,EAAEI,WAAW,CAClC,CAAC;EAED,MAAMmB,OAAO,GAAG3B,KAAK,CAAC4B,oBAAoB,CAACR,SAAS,EAAEC,WAAW,CAAC;EAElE,IAAIF,KAAwB;EAC5B,IAAIQ,OAAO,IAAI,OAAO,IAAIA,OAAO,IAAIA,OAAO,CAACR,KAAK,IAAI,IAAI,EAAE;IAC1DA,KAAK,GAAGQ,OAAO,CAACR,KAAK;EACvB,CAAC,MAAM,IAAIQ,OAAO,EAAEd,MAAM,KAAK,OAAO,EAAE;IACtCM,KAAK,GAAG,IAAIU,KAAK,CAAC,iCAAiCzB,SAAS,EAAE,CAAC;EACjE;EAEA,OAAO;IACLU,IAAI,EAAEa,OAAO,EAAEb,IAAI;IACnBgB,SAAS,EAAEH,OAAO,EAAEd,MAAM,KAAK,SAAS;IACxCM,KAAK;IACLY,OAAO,EAAEvB;EACX,CAAC;AACH","ignoreList":[]}

package/build/cjs/{chunk-OVBG5VXE.cjs → chunk-V32JHU3O.cjs}

@@ -6,7 +6,11 @@ function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
 
 var React3__default = /*#__PURE__*/_interopDefault(React3);
 
-// src/useOsdkClient.ts
+var __defProp = Object.defineProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
 function fakeClientFn(..._args) {
   throw new Error("This is not a real client. Did you forget to <OsdkContext.Provider>?");
 }
@@ -44,7 +48,8 @@ function useOsdkMetadata(type) {
 }
 
 exports.OsdkContext = OsdkContext;
+exports.__export = __export;
 exports.useOsdkClient = useOsdkClient;
 exports.useOsdkMetadata = useOsdkMetadata;
-//# sourceMappingURL=chunk-OVBG5VXE.cjs.map
-//# sourceMappingURL=chunk-OVBG5VXE.cjs.map
+//# sourceMappingURL=chunk-V32JHU3O.cjs.map
+//# sourceMappingURL=chunk-V32JHU3O.cjs.map

package/build/cjs/chunk-V32JHU3O.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/OsdkContext.ts","../../src/useOsdkClient.ts","../../src/useOsdkMetadata.ts"],"names":["React","error"],"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;AACY,IAAA,WAAA,2CAAiC,aAAc,CAAA;AAAA,EAC1D,MAAQ,EAAA;AACV,CAAC;;;ACPM,SAAS,aAAgB,GAAA;AAC9B,EAAOA,OAAAA,uBAAAA,CAAM,UAAW,CAAA,WAAW,CAAE,CAAA,MAAA;AACvC;ACFO,SAAS,gBAAgB,IAAM,EAAA;AACpC,EAAA,MAAM,SAAS,aAAc,EAAA;AAC7B,EAAA,MAAM,CAAC,QAAU,EAAA,WAAW,CAAIA,GAAAA,uBAAAA,CAAM,SAAS,MAAS,CAAA;AACxD,EAAA,MAAM,CAAC,KAAA,EAAO,QAAQ,CAAA,GAAIA,wBAAM,QAAS,EAAA;AACzC,EAAI,IAAA,CAAC,QAAY,IAAA,CAAC,KAAO,EAAA;AACvB,IAAA,MAAA,CAAO,aAAc,CAAA,IAAI,CAAE,CAAA,IAAA,CAAK,CAAmB,eAAA,KAAA;AACjD,MAAA,WAAA,CAAY,eAAe,CAAA;AAAA,KAC5B,CAAA,CAAE,KAAM,CAAA,CAAAC,MAAS,KAAA;AAChB,MAAA,MAAM,eAAeA,MAAiB,YAAA,KAAA,GAAQA,MAAM,CAAA,OAAA,GAAU,OAAOA,MAAK,CAAA;AAC1E,MAAA,QAAA,CAAS,YAAY,CAAA;AAAA,KACtB,CAAA;AACD,IAAO,OAAA;AAAA,MACL,OAAS,EAAA;AAAA,KACX;AAAA;AAEF,EAAO,OAAA;AAAA,IACL,OAAS,EAAA,KAAA;AAAA,IACT,QAAA;AAAA,IACA;AAAA,GACF;AACF","file":"chunk-V32JHU3O.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 OsdkContext = /*#__PURE__*/React.createContext({\n  client: fakeClient\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 { OsdkContext } from \"./OsdkContext.js\";\nexport function useOsdkClient() {\n  return React.useContext(OsdkContext).client;\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 { useOsdkClient } from \"./useOsdkClient.js\";\nexport function useOsdkMetadata(type) {\n  const client = useOsdkClient();\n  const [metadata, setMetadata] = React.useState(undefined);\n  const [error, setError] = React.useState();\n  if (!metadata && !error) {\n    client.fetchMetadata(type).then(fetchedMetadata => {\n      setMetadata(fetchedMetadata);\n    }).catch(error => {\n      const errorMessage = error instanceof Error ? error.message : String(error);\n      setError(errorMessage);\n    });\n    return {\n      loading: true\n    };\n  }\n  return {\n    loading: false,\n    metadata,\n    error\n  };\n}"]}

package/build/cjs/index.cjs

@@ -1,6 +1,6 @@
 'use strict';
 
-var chunkOVBG5VXE_cjs = require('./chunk-OVBG5VXE.cjs');
+var chunkV32JHU3O_cjs = require('./chunk-V32JHU3O.cjs');
 var React = require('react');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
@@ -11,7 +11,7 @@ function OsdkProvider({
   children,
   client
 }) {
-  return /* @__PURE__ */ React__default.default.createElement(chunkOVBG5VXE_cjs.OsdkContext.Provider, {
+  return /* @__PURE__ */ React__default.default.createElement(chunkV32JHU3O_cjs.OsdkContext.Provider, {
     value: {
       client
     }
@@ -20,11 +20,11 @@ function OsdkProvider({
 
 Object.defineProperty(exports, "useOsdkClient", {
   enumerable: true,
-  get: function () { return chunkOVBG5VXE_cjs.useOsdkClient; }
+  get: function () { return chunkV32JHU3O_cjs.useOsdkClient; }
 });
 Object.defineProperty(exports, "useOsdkMetadata", {
   enumerable: true,
-  get: function () { return chunkOVBG5VXE_cjs.useOsdkMetadata; }
+  get: function () { return chunkV32JHU3O_cjs.useOsdkMetadata; }
 });
 exports.OsdkProvider = OsdkProvider;
 //# sourceMappingURL=index.cjs.map