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

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @osdkkit/react
 
+## 0.8.0-beta.4
+
+### Minor Changes
+
+- 9961f06: fix order by via key stabilization
+
+### Patch Changes
+
+- Updated dependencies [9961f06]
+  - @osdk/client@2.6.0-beta.12
+  - @osdk/api@2.6.0-beta.12
+
+## 0.8.0-beta.3
+
+### Minor Changes
+
+- c5a3815: Add new auto fetch more behavior to useOsdkObjects
+
+### Patch Changes
+
+- Updated dependencies [c5a3815]
+  - @osdk/client@2.6.0-beta.11
+  - @osdk/api@2.6.0-beta.11
+
 ## 0.8.0-beta.2
 
 ### Minor Changes

package/build/browser/intellisense.test.helpers/useOsdkObjectsWithPivot.js

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2025 Palantir Technologies, Inc. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// WARNING!
+// WARNING!
+// This file is used for tests that check intellisense. Editing this file by hand will likely
+// break tests that have hard coded line numbers and line offsets.
+
+import { Employee } from "@osdk/client.test.ontology";
+import { useOsdkObjects } from "@osdk/react/experimental";
+function TestComponent() {
+  const {
+    data
+  } = useOsdkObjects(Employee, {
+    pivotTo: "lead"
+  });
+
+  // Line 31: Check that data has the correct pivoted type
+  data?.[0];
+  return null;
+}
+//# sourceMappingURL=useOsdkObjectsWithPivot.js.map

package/build/browser/intellisense.test.helpers/useOsdkObjectsWithPivot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useOsdkObjectsWithPivot.js","names":["Employee","useOsdkObjects","TestComponent","data","pivotTo"],"sources":["useOsdkObjectsWithPivot.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\n// WARNING!\n// WARNING!\n// This file is used for tests that check intellisense. Editing this file by hand will likely\n// break tests that have hard coded line numbers and line offsets.\n\nimport { Employee } from \"@osdk/client.test.ontology\";\nimport { useOsdkObjects } from \"@osdk/react/experimental\";\n\ndeclare const MyComponent: () => void;\n\nfunction TestComponent() {\n  const { data } = useOsdkObjects(Employee, {\n    pivotTo: \"lead\",\n  });\n\n  // Line 31: Check that data has the correct pivoted type\n  const firstItem = data?.[0];\n\n  return null;\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;;AAEA,SAASA,QAAQ,QAAQ,4BAA4B;AACrD,SAASC,cAAc,QAAQ,0BAA0B;AAIzD,SAASC,aAAaA,CAAA,EAAG;EACvB,MAAM;IAAEC;EAAK,CAAC,GAAGF,cAAc,CAACD,QAAQ,EAAE;IACxCI,OAAO,EAAE;EACX,CAAC,CAAC;;EAEF;EACkBD,IAAI,GAAG,CAAC,CAAC;EAE3B,OAAO,IAAI;AACb","ignoreList":[]}

package/build/browser/intellisense.test.helpers/useOsdkObjectsWithProperties.js

@@ -0,0 +1,34 @@
+/*
+ * Copyright 2025 Palantir Technologies, Inc. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// WARNING!
+// WARNING!
+// This file is used for tests that check intellisense. Editing this file by hand will likely
+// break tests that have hard coded line numbers and line offsets.
+
+import { Employee } from "@osdk/client.test.ontology";
+import { useOsdkObjects } from "@osdk/react/experimental";
+function TestComponent() {
+  const {
+    data
+  } = useOsdkObjects(Employee, {
+    withProperties: {
+      constantValue: employee => employee.constant.integer(42)
+    }
+  });
+  return null;
+}
+//# sourceMappingURL=useOsdkObjectsWithProperties.js.map

package/build/browser/intellisense.test.helpers/useOsdkObjectsWithProperties.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useOsdkObjectsWithProperties.js","names":["Employee","useOsdkObjects","TestComponent","data","withProperties","constantValue","employee","constant","integer"],"sources":["useOsdkObjectsWithProperties.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\n// WARNING!\n// WARNING!\n// This file is used for tests that check intellisense. Editing this file by hand will likely\n// break tests that have hard coded line numbers and line offsets.\n\nimport type { DerivedProperty } from \"@osdk/api\";\nimport { Employee } from \"@osdk/client.test.ontology\";\nimport { useOsdkObjects } from \"@osdk/react/experimental\";\n\nfunction TestComponent() {\n  const withProps: DerivedProperty.Clause<typeof Employee> = {\n    constantValue: (employee) => employee.constant.integer(42),\n  };\n\n  const { data } = useOsdkObjects(Employee, {\n    withProperties: withProps,\n  });\n\n  return null;\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;;AAGA,SAASA,QAAQ,QAAQ,4BAA4B;AACrD,SAASC,cAAc,QAAQ,0BAA0B;AAEzD,SAASC,aAAaA,CAAA,EAAG;EAKvB,MAAM;IAAEC;EAAK,CAAC,GAAGF,cAAc,CAACD,QAAQ,EAAE;IACxCI,cAAc,EAL2C;MACzDC,aAAa,EAAGC,QAAQ,IAAKA,QAAQ,CAACC,QAAQ,CAACC,OAAO,CAAC,EAAE;IAC3D;EAIA,CAAC,CAAC;EAEF,OAAO,IAAI;AACb","ignoreList":[]}

package/build/browser/intellisense.test.js

@@ -0,0 +1,148 @@
+/*
+ * Copyright 2025 Palantir Technologies, Inc. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { startTsServer } from "@osdk/client/internal-node";
+import { findUpSync } from "find-up";
+import * as path from "node:path";
+import invariant from "tiny-invariant";
+import * as ts from "typescript";
+import { afterEach, beforeAll, beforeEach, describe, expect, it, vi } from "vitest";
+
+// it needs to be hoisted because its referenced from our mocked WebSocket
+// which must be hoisted to work
+const rootLogger = await vi.hoisted(async () => {
+  const pino = (await import("pino")).pino;
+  const pinoPretty = await import("pino-pretty");
+  const {
+    EventEmitter
+  } = await import("node:events");
+  return Promise.resolve(pino({
+    level: "info"
+  }, pinoPretty.build({
+    sync: true,
+    timestampKey: undefined,
+    errorLikeObjectKeys: ["error", "err", "exception"],
+    errorProps: "stack,cause,properties",
+    ignore: "time,hostname,pid",
+    destination: new class extends EventEmitter {
+      write(a) {
+        // remove trailing newline since console.log adds one
+        if (a.at(-1) === "\n") a = a.slice(0, -1);
+
+        // This lets the test framework aggregate the logs per test, whereas direct to stdout does not
+        console.log(a);
+      }
+    }()
+  })));
+});
+
+/**
+ * @vitest-environment node
+ * @vitest-pool forks
+ */
+describe("intellisense", () => {
+  let packagesDir;
+  let reactPackagePath;
+  beforeAll(() => {
+    const reactPackageJson = findUpSync("package.json", {
+      cwd: import.meta.dirname
+    });
+    console.log({
+      reactPackageJson
+    });
+    !(reactPackageJson != null) ? process.env.NODE_ENV !== "production" ? invariant(false) : invariant(false) : void 0;
+    packagesDir = path.join(path.dirname(reactPackageJson), "..");
+    reactPackagePath = path.join(packagesDir, "react");
+  });
+  let tsServer;
+  let intellisenseFilePath;
+  beforeEach(async a => {
+    intellisenseFilePath = path.join(reactPackagePath, "src", "intellisense.test.helpers", `${a.task.name}.ts`);
+    console.log(intellisenseFilePath);
+    expect(ts.sys.fileExists(intellisenseFilePath)).toBeTruthy();
+    try {
+      tsServer = await startTsServer(rootLogger);
+      await tsServer.sendOpenRequest({
+        file: intellisenseFilePath
+      });
+    } catch (error) {
+      if (tsServer) {
+        try {
+          tsServer.stop();
+        } catch {
+          // Ignore cleanup errors
+        }
+        tsServer = undefined;
+      }
+      throw error;
+    }
+  });
+  afterEach(async () => {
+    if (tsServer) {
+      tsServer.stop();
+      tsServer = undefined;
+    }
+  });
+  it("useOsdkObjectsWithPivot", {
+    timeout: 40_000
+  }, async () => {
+    expect(ts.sys.fileExists(intellisenseFilePath)).toBeTruthy();
+    !tsServer ? process.env.NODE_ENV !== "production" ? invariant(false) : invariant(false) : void 0;
+    const {
+      resp
+    } = await tsServer.sendCompletionsRequest({
+      file: intellisenseFilePath,
+      line: 29,
+      offset: 15,
+      triggerKind: ts.CompletionTriggerKind.Invoked
+    });
+    const completions = resp.body?.entries.map(e => e.name) ?? [];
+    expect(completions).toContain("lead");
+    const {
+      resp: typeResp
+    } = await tsServer.sendQuickInfoRequest({
+      file: intellisenseFilePath,
+      line: 33,
+      offset: 10
+    });
+    expect(typeResp.body?.displayString).toBeDefined();
+    expect(typeResp.body?.displayString).toContain("Employee");
+  });
+  it("useOsdkObjectsWithProperties", {
+    timeout: 40_000
+  }, async () => {
+    expect(ts.sys.fileExists(intellisenseFilePath)).toBeTruthy();
+    !tsServer ? process.env.NODE_ENV !== "production" ? invariant(false) : invariant(false) : void 0;
+    const {
+      resp
+    } = await tsServer.sendQuickInfoRequest({
+      file: intellisenseFilePath,
+      line: 27,
+      offset: 10
+    });
+    expect(resp.body?.displayString).toContain("DerivedProperty.Clause");
+    const {
+      resp: dataResp
+    } = await tsServer.sendQuickInfoRequest({
+      file: intellisenseFilePath,
+      line: 31,
+      offset: 11
+    });
+    expect(dataResp.body?.displayString).toBeDefined();
+    expect(dataResp.body?.displayString).toContain("Osdk.Instance<Employee");
+  });
+});
+//# sourceMappingURL=intellisense.test.js.map

package/build/browser/intellisense.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"intellisense.test.js","names":["startTsServer","findUpSync","path","invariant","ts","afterEach","beforeAll","beforeEach","describe","expect","it","vi","rootLogger","hoisted","pino","pinoPretty","EventEmitter","Promise","resolve","level","build","sync","timestampKey","undefined","errorLikeObjectKeys","errorProps","ignore","destination","write","a","at","slice","console","log","packagesDir","reactPackagePath","reactPackageJson","cwd","import","meta","dirname","process","env","NODE_ENV","join","tsServer","intellisenseFilePath","task","name","sys","fileExists","toBeTruthy","sendOpenRequest","file","error","stop","timeout","resp","sendCompletionsRequest","line","offset","triggerKind","CompletionTriggerKind","Invoked","completions","body","entries","map","e","toContain","typeResp","sendQuickInfoRequest","displayString","toBeDefined","dataResp"],"sources":["intellisense.test.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 { Logger } from \"@osdk/api\";\nimport type { TsServer } from \"@osdk/client/internal-node\";\nimport { startTsServer } from \"@osdk/client/internal-node\";\nimport { findUpSync } from \"find-up\";\nimport * as path from \"node:path\";\nimport invariant from \"tiny-invariant\";\nimport * as ts from \"typescript\";\nimport {\n  afterEach,\n  beforeAll,\n  beforeEach,\n  describe,\n  expect,\n  it,\n  vi,\n} from \"vitest\";\n\n// it needs to be hoisted because its referenced from our mocked WebSocket\n// which must be hoisted to work\nconst rootLogger = await vi.hoisted(async (): Promise<Logger> => {\n  const pino = (await import(\"pino\")).pino;\n  const pinoPretty = await import(\"pino-pretty\");\n  const { EventEmitter } = await import(\"node:events\");\n  class PinoConsoleLogDestination extends EventEmitter {\n    write(a: string) {\n      // remove trailing newline since console.log adds one\n      if (a.at(-1) === \"\\n\") a = a.slice(0, -1);\n\n      // This lets the test framework aggregate the logs per test, whereas direct to stdout does not\n      console.log(a);\n    }\n  }\n  return Promise.resolve(pino(\n    { level: \"info\" },\n    (pinoPretty.build)({\n      sync: true,\n      timestampKey: undefined,\n      errorLikeObjectKeys: [\"error\", \"err\", \"exception\"],\n      errorProps: \"stack,cause,properties\",\n      ignore: \"time,hostname,pid\",\n      destination: new PinoConsoleLogDestination(),\n    }),\n  ));\n});\n\n/**\n * @vitest-environment node\n * @vitest-pool forks\n */\ndescribe(\"intellisense\", () => {\n  let packagesDir: string;\n  let reactPackagePath: string;\n\n  beforeAll(() => {\n    const reactPackageJson = findUpSync(\"package.json\", {\n      cwd: import.meta.dirname,\n    });\n    console.log({ reactPackageJson });\n    invariant(reactPackageJson != null);\n    packagesDir = path.join(\n      path.dirname(reactPackageJson),\n      \"..\",\n    );\n\n    reactPackagePath = path.join(packagesDir, \"react\");\n  });\n\n  let tsServer: TsServer | undefined;\n  let intellisenseFilePath: string;\n\n  beforeEach(async (a) => {\n    intellisenseFilePath = path.join(\n      reactPackagePath,\n      \"src\",\n      \"intellisense.test.helpers\",\n      `${a.task.name}.ts`,\n    );\n\n    console.log(intellisenseFilePath);\n\n    expect(ts.sys.fileExists(intellisenseFilePath)).toBeTruthy();\n\n    try {\n      tsServer = await startTsServer(rootLogger);\n      await tsServer.sendOpenRequest({ file: intellisenseFilePath });\n    } catch (error) {\n      if (tsServer) {\n        try {\n          tsServer.stop();\n        } catch {\n          // Ignore cleanup errors\n        }\n        tsServer = undefined;\n      }\n      throw error;\n    }\n  });\n\n  afterEach(async () => {\n    if (tsServer) {\n      tsServer.stop();\n      tsServer = undefined;\n    }\n  });\n\n  it(\"useOsdkObjectsWithPivot\", { timeout: 40_000 }, async () => {\n    expect(ts.sys.fileExists(intellisenseFilePath)).toBeTruthy();\n    invariant(tsServer);\n\n    const { resp } = await tsServer.sendCompletionsRequest({\n      file: intellisenseFilePath,\n      line: 29,\n      offset: 15,\n      triggerKind: ts.CompletionTriggerKind.Invoked,\n    });\n\n    const completions = resp.body?.entries.map(e => e.name) ?? [];\n    expect(completions).toContain(\"lead\");\n\n    const { resp: typeResp } = await tsServer.sendQuickInfoRequest({\n      file: intellisenseFilePath,\n      line: 33,\n      offset: 10,\n    });\n\n    expect(typeResp.body?.displayString).toBeDefined();\n    expect(typeResp.body?.displayString).toContain(\"Employee\");\n  });\n\n  it(\"useOsdkObjectsWithProperties\", { timeout: 40_000 }, async () => {\n    expect(ts.sys.fileExists(intellisenseFilePath)).toBeTruthy();\n    invariant(tsServer);\n\n    const { resp } = await tsServer.sendQuickInfoRequest({\n      file: intellisenseFilePath,\n      line: 27,\n      offset: 10,\n    });\n\n    expect(resp.body?.displayString).toContain(\"DerivedProperty.Clause\");\n\n    const { resp: dataResp } = await tsServer.sendQuickInfoRequest({\n      file: intellisenseFilePath,\n      line: 31,\n      offset: 11,\n    });\n\n    expect(dataResp.body?.displayString).toBeDefined();\n    expect(dataResp.body?.displayString).toContain(\"Osdk.Instance<Employee\");\n  });\n});\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAIA,SAASA,aAAa,QAAQ,4BAA4B;AAC1D,SAASC,UAAU,QAAQ,SAAS;AACpC,OAAO,KAAKC,IAAI,MAAM,WAAW;AACjC,OAAOC,SAAS,MAAM,gBAAgB;AACtC,OAAO,KAAKC,EAAE,MAAM,YAAY;AAChC,SACEC,SAAS,EACTC,SAAS,EACTC,UAAU,EACVC,QAAQ,EACRC,MAAM,EACNC,EAAE,EACFC,EAAE,QACG,QAAQ;;AAEf;AACA;AACA,MAAMC,UAAU,GAAG,MAAMD,EAAE,CAACE,OAAO,CAAC,YAA6B;EAC/D,MAAMC,IAAI,GAAG,CAAC,MAAM,MAAM,CAAC,MAAM,CAAC,EAAEA,IAAI;EACxC,MAAMC,UAAU,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC;EAC9C,MAAM;IAAEC;EAAa,CAAC,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC;EAUpD,OAAOC,OAAO,CAACC,OAAO,CAACJ,IAAI,CACzB;IAAEK,KAAK,EAAE;EAAO,CAAC,EAChBJ,UAAU,CAACK,KAAK,CAAE;IACjBC,IAAI,EAAE,IAAI;IACVC,YAAY,EAAEC,SAAS;IACvBC,mBAAmB,EAAE,CAAC,OAAO,EAAE,KAAK,EAAE,WAAW,CAAC;IAClDC,UAAU,EAAE,wBAAwB;IACpCC,MAAM,EAAE,mBAAmB;IAC3BC,WAAW,EAAE,IAjBjB,cAAwCX,YAAY,CAAC;MACnDY,KAAKA,CAACC,CAAS,EAAE;QACf;QACA,IAAIA,CAAC,CAACC,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,EAAED,CAAC,GAAGA,CAAC,CAACE,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;;QAEzC;QACAC,OAAO,CAACC,GAAG,CAACJ,CAAC,CAAC;MAChB;IACF,CAAC,CAS8C;EAC7C,CAAC,CACH,CAAC,CAAC;AACJ,CAAC,CAAC;;AAEF;AACA;AACA;AACA;AACArB,QAAQ,CAAC,cAAc,EAAE,MAAM;EAC7B,IAAI0B,WAAmB;EACvB,IAAIC,gBAAwB;EAE5B7B,SAAS,CAAC,MAAM;IACd,MAAM8B,gBAAgB,GAAGnC,UAAU,CAAC,cAAc,EAAE;MAClDoC,GAAG,EAAEC,MAAM,CAACC,IAAI,CAACC;IACnB,CAAC,CAAC;IACFR,OAAO,CAACC,GAAG,CAAC;MAAEG;IAAiB,CAAC,CAAC;IACjC,EAAUA,gBAAgB,IAAI,IAAI,IAAAK,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAAlCxC,SAAS,UAATA,SAAS;IACT+B,WAAW,GAAGhC,IAAI,CAAC0C,IAAI,CACrB1C,IAAI,CAACsC,OAAO,CAACJ,gBAAgB,CAAC,EAC9B,IACF,CAAC;IAEDD,gBAAgB,GAAGjC,IAAI,CAAC0C,IAAI,CAACV,WAAW,EAAE,OAAO,CAAC;EACpD,CAAC,CAAC;EAEF,IAAIW,QAA8B;EAClC,IAAIC,oBAA4B;EAEhCvC,UAAU,CAAC,MAAOsB,CAAC,IAAK;IACtBiB,oBAAoB,GAAG5C,IAAI,CAAC0C,IAAI,CAC9BT,gBAAgB,EAChB,KAAK,EACL,2BAA2B,EAC3B,GAAGN,CAAC,CAACkB,IAAI,CAACC,IAAI,KAChB,CAAC;IAEDhB,OAAO,CAACC,GAAG,CAACa,oBAAoB,CAAC;IAEjCrC,MAAM,CAACL,EAAE,CAAC6C,GAAG,CAACC,UAAU,CAACJ,oBAAoB,CAAC,CAAC,CAACK,UAAU,CAAC,CAAC;IAE5D,IAAI;MACFN,QAAQ,GAAG,MAAM7C,aAAa,CAACY,UAAU,CAAC;MAC1C,MAAMiC,QAAQ,CAACO,eAAe,CAAC;QAAEC,IAAI,EAAEP;MAAqB,CAAC,CAAC;IAChE,CAAC,CAAC,OAAOQ,KAAK,EAAE;MACd,IAAIT,QAAQ,EAAE;QACZ,IAAI;UACFA,QAAQ,CAACU,IAAI,CAAC,CAAC;QACjB,CAAC,CAAC,MAAM;UACN;QAAA;QAEFV,QAAQ,GAAGtB,SAAS;MACtB;MACA,MAAM+B,KAAK;IACb;EACF,CAAC,CAAC;EAEFjD,SAAS,CAAC,YAAY;IACpB,IAAIwC,QAAQ,EAAE;MACZA,QAAQ,CAACU,IAAI,CAAC,CAAC;MACfV,QAAQ,GAAGtB,SAAS;IACtB;EACF,CAAC,CAAC;EAEFb,EAAE,CAAC,yBAAyB,EAAE;IAAE8C,OAAO,EAAE;EAAO,CAAC,EAAE,YAAY;IAC7D/C,MAAM,CAACL,EAAE,CAAC6C,GAAG,CAACC,UAAU,CAACJ,oBAAoB,CAAC,CAAC,CAACK,UAAU,CAAC,CAAC;IAC5D,CAAUN,QAAQ,GAAAJ,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAAlBxC,SAAS,UAATA,SAAS;IAET,MAAM;MAAEsD;IAAK,CAAC,GAAG,MAAMZ,QAAQ,CAACa,sBAAsB,CAAC;MACrDL,IAAI,EAAEP,oBAAoB;MAC1Ba,IAAI,EAAE,EAAE;MACRC,MAAM,EAAE,EAAE;MACVC,WAAW,EAAEzD,EAAE,CAAC0D,qBAAqB,CAACC;IACxC,CAAC,CAAC;IAEF,MAAMC,WAAW,GAAGP,IAAI,CAACQ,IAAI,EAAEC,OAAO,CAACC,GAAG,CAACC,CAAC,IAAIA,CAAC,CAACpB,IAAI,CAAC,IAAI,EAAE;IAC7DvC,MAAM,CAACuD,WAAW,CAAC,CAACK,SAAS,CAAC,MAAM,CAAC;IAErC,MAAM;MAAEZ,IAAI,EAAEa;IAAS,CAAC,GAAG,MAAMzB,QAAQ,CAAC0B,oBAAoB,CAAC;MAC7DlB,IAAI,EAAEP,oBAAoB;MAC1Ba,IAAI,EAAE,EAAE;MACRC,MAAM,EAAE;IACV,CAAC,CAAC;IAEFnD,MAAM,CAAC6D,QAAQ,CAACL,IAAI,EAAEO,aAAa,CAAC,CAACC,WAAW,CAAC,CAAC;IAClDhE,MAAM,CAAC6D,QAAQ,CAACL,IAAI,EAAEO,aAAa,CAAC,CAACH,SAAS,CAAC,UAAU,CAAC;EAC5D,CAAC,CAAC;EAEF3D,EAAE,CAAC,8BAA8B,EAAE;IAAE8C,OAAO,EAAE;EAAO,CAAC,EAAE,YAAY;IAClE/C,MAAM,CAACL,EAAE,CAAC6C,GAAG,CAACC,UAAU,CAACJ,oBAAoB,CAAC,CAAC,CAACK,UAAU,CAAC,CAAC;IAC5D,CAAUN,QAAQ,GAAAJ,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAAlBxC,SAAS,UAATA,SAAS;IAET,MAAM;MAAEsD;IAAK,CAAC,GAAG,MAAMZ,QAAQ,CAAC0B,oBAAoB,CAAC;MACnDlB,IAAI,EAAEP,oBAAoB;MAC1Ba,IAAI,EAAE,EAAE;MACRC,MAAM,EAAE;IACV,CAAC,CAAC;IAEFnD,MAAM,CAACgD,IAAI,CAACQ,IAAI,EAAEO,aAAa,CAAC,CAACH,SAAS,CAAC,wBAAwB,CAAC;IAEpE,MAAM;MAAEZ,IAAI,EAAEiB;IAAS,CAAC,GAAG,MAAM7B,QAAQ,CAAC0B,oBAAoB,CAAC;MAC7DlB,IAAI,EAAEP,oBAAoB;MAC1Ba,IAAI,EAAE,EAAE;MACRC,MAAM,EAAE;IACV,CAAC,CAAC;IAEFnD,MAAM,CAACiE,QAAQ,CAACT,IAAI,EAAEO,aAAa,CAAC,CAACC,WAAW,CAAC,CAAC;IAClDhE,MAAM,CAACiE,QAAQ,CAACT,IAAI,EAAEO,aAAa,CAAC,CAACH,SAAS,CAAC,wBAAwB,CAAC;EAC1E,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}

package/build/browser/new/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","names":[],"sources":["types.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n  DerivedProperty,\n  InterfaceDefinition,\n  ObjectTypeDefinition,\n} from \"@osdk/api\";\n\nexport type InferRdpTypes<\n  Q extends ObjectTypeDefinition | InterfaceDefinition,\n  WP extends DerivedProperty.Clause<Q> | undefined,\n> = WP extends DerivedProperty.Clause<Q> ? {\n    [K in keyof WP]: WP[K] extends DerivedProperty.Creator<Q, infer T> ? T\n      : never;\n  }\n  : {};\n"],"mappings":"","ignoreList":[]}

package/build/browser/new/useLinks.js

@@ -31,6 +31,10 @@ export function useLinks(objects, linkName, options = {}) {
   const {
     observableClient
   } = React.useContext(OsdkContext2);
+  const {
+    enabled = true,
+    ...otherOptions
+  } = options;
 
   // Convert single object to array for consistent handling
   const objectsArray = React.useMemo(() => {
@@ -40,14 +44,19 @@ export function useLinks(objects, linkName, options = {}) {
     subscribe,
     getSnapShot
   } = React.useMemo(() => {
+    if (!enabled) {
+      return makeExternalStore(() => ({
+        unsubscribe: () => {}
+      }), `links ${linkName} for ${objectsArray.map(obj => `${obj.$apiName}:${obj.$primaryKey}`).join(",")} [DISABLED]`);
+    }
     return makeExternalStore(observer => observableClient.observeLinks(objectsArray, linkName, {
       linkName,
-      where: options.where,
-      pageSize: options.pageSize,
-      orderBy: options.orderBy,
-      mode: options.mode
+      where: otherOptions.where,
+      pageSize: otherOptions.pageSize,
+      orderBy: otherOptions.orderBy,
+      mode: otherOptions.mode
     }, observer), `links ${linkName} for ${objectsArray.map(obj => `${obj.$apiName}:${obj.$primaryKey}`).join(",")}`);
-  }, [observableClient, objectsArray, linkName, options.where, options.pageSize, options.orderBy, options.mode]);
+  }, [enabled, observableClient, objectsArray, linkName, otherOptions.where, otherOptions.pageSize, otherOptions.orderBy, otherOptions.mode]);
   const payload = React.useSyncExternalStore(subscribe, getSnapShot);
   return {
     links: payload?.resolvedList,

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

@@ -1 +1 @@
-{"version":3,"file":"useLinks.js","names":["React","makeExternalStore","OsdkContext2","emptyArray","Object","freeze","useLinks","objects","linkName","options","observableClient","useContext","objectsArray","useMemo","undefined","Array","isArray","subscribe","getSnapShot","observer","observeLinks","where","pageSize","orderBy","mode","map","obj","$apiName","$primaryKey","join","payload","useSyncExternalStore","links","resolvedList","isLoading","status","isOptimistic","error","fetchMore","hasMore"],"sources":["useLinks.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { LinkedType, LinkNames } from \"@osdk/api\";\nimport type {\n  InterfaceDefinition,\n  ObjectTypeDefinition,\n  Osdk,\n  PropertyKeys,\n  WhereClause,\n} from \"@osdk/client\";\nimport type { ObserveLinks } from \"@osdk/client/unstable-do-not-use\";\nimport React from \"react\";\nimport { makeExternalStore } from \"./makeExternalStore.js\";\nimport { OsdkContext2 } from \"./OsdkContext2.js\";\n\nexport interface UseLinksOptions<\n  T extends ObjectTypeDefinition | InterfaceDefinition,\n> {\n  /**\n   * Standard OSDK Where clause for filtering linked objects\n   */\n  where?: WhereClause<T>;\n\n  /**\n   * The preferred page size for the links list.\n   */\n  pageSize?: number;\n\n  /** Sorting options for the linked objects */\n  orderBy?: {\n    [K in PropertyKeys<T>]?: \"asc\" | \"desc\";\n  };\n\n  /**\n   * The mode to use for fetching data.\n   * - undefined: Fetch data if not already in cache\n   * - \"force\": Always fetch fresh data\n   * - \"offline\": Only use cached data, don't make network requests\n   */\n  mode?: \"force\" | \"offline\";\n}\n\nexport interface UseLinksResult<\n  Q extends ObjectTypeDefinition | InterfaceDefinition,\n> {\n  links: Osdk.Instance<Q>[] | undefined;\n  isLoading: boolean;\n  error: Error | undefined;\n\n  /**\n   * Refers to whether the links are optimistic or not.\n   */\n  isOptimistic: boolean;\n\n  /**\n   * Fetch more linked objects if pagination is supported\n   */\n  fetchMore: (() => Promise<unknown>) | undefined;\n\n  /**\n   * Indicates if there are more linked objects available to fetch\n   */\n  hasMore: boolean;\n}\n\nconst emptyArray = Object.freeze([]);\n\n/**\n * Hook to observe links from an object or array of objects.\n *\n * @param objects The source object(s) to observe links from\n * @param linkName The name of the link to observe\n * @param options Optional configuration for the link query\n * @returns UseLinksResult with links data and metadata\n */\nexport function useLinks<\n  T extends ObjectTypeDefinition,\n  L extends LinkNames<T>,\n>(\n  objects: Osdk.Instance<T> | Array<Osdk.Instance<T>> | undefined,\n  linkName: L,\n  options: UseLinksOptions<LinkedType<T, L>> = {},\n): UseLinksResult<LinkedType<T, L>> {\n  const { observableClient } = React.useContext(OsdkContext2);\n\n  // Convert single object to array for consistent handling\n  const objectsArray: ReadonlyArray<Osdk.Instance<T>> = React.useMemo(() => {\n    return objects === undefined\n      ? emptyArray\n      : Array.isArray(objects)\n      ? objects\n      : [objects];\n  }, [objects]);\n\n  const { subscribe, getSnapShot } = React.useMemo(\n    () => {\n      return makeExternalStore<ObserveLinks.CallbackArgs<T>>(\n        (observer) =>\n          observableClient.observeLinks(\n            objectsArray,\n            linkName,\n            {\n              linkName,\n              where: options.where,\n              pageSize: options.pageSize,\n              orderBy: options.orderBy,\n              mode: options.mode,\n            },\n            observer,\n          ),\n        `links ${linkName} for ${\n          objectsArray.map(obj => `${obj.$apiName}:${obj.$primaryKey}`).join(\n            \",\",\n          )\n        }`,\n      );\n    },\n    [\n      observableClient,\n      objectsArray,\n      linkName,\n      options.where,\n      options.pageSize,\n      options.orderBy,\n      options.mode,\n    ],\n  );\n\n  const payload = React.useSyncExternalStore(\n    subscribe,\n    getSnapShot,\n  );\n\n  return {\n    links: payload?.resolvedList,\n    isLoading: payload?.status === \"loading\",\n    isOptimistic: payload?.isOptimistic ?? false,\n    error: payload?.error,\n    fetchMore: payload?.fetchMore,\n    hasMore: payload?.hasMore ?? false,\n  };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAWA,OAAOA,KAAK,MAAM,OAAO;AACzB,SAASC,iBAAiB,QAAQ,wBAAwB;AAC1D,SAASC,YAAY,QAAQ,mBAAmB;AAoDhD,MAAMC,UAAU,GAAGC,MAAM,CAACC,MAAM,CAAC,EAAE,CAAC;;AAEpC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,QAAQA,CAItBC,OAA+D,EAC/DC,QAAW,EACXC,OAA0C,GAAG,CAAC,CAAC,EACb;EAClC,MAAM;IAAEC;EAAiB,CAAC,GAAGV,KAAK,CAACW,UAAU,CAACT,YAAY,CAAC;;EAE3D;EACA,MAAMU,YAA6C,GAAGZ,KAAK,CAACa,OAAO,CAAC,MAAM;IACxE,OAAON,OAAO,KAAKO,SAAS,GACxBX,UAAU,GACVY,KAAK,CAACC,OAAO,CAACT,OAAO,CAAC,GACtBA,OAAO,GACP,CAACA,OAAO,CAAC;EACf,CAAC,EAAE,CAACA,OAAO,CAAC,CAAC;EAEb,MAAM;IAAEU,SAAS;IAAEC;EAAY,CAAC,GAAGlB,KAAK,CAACa,OAAO,CAC9C,MAAM;IACJ,OAAOZ,iBAAiB,CACrBkB,QAAQ,IACPT,gBAAgB,CAACU,YAAY,CAC3BR,YAAY,EACZJ,QAAQ,EACR;MACEA,QAAQ;MACRa,KAAK,EAAEZ,OAAO,CAACY,KAAK;MACpBC,QAAQ,EAAEb,OAAO,CAACa,QAAQ;MAC1BC,OAAO,EAAEd,OAAO,CAACc,OAAO;MACxBC,IAAI,EAAEf,OAAO,CAACe;IAChB,CAAC,EACDL,QACF,CAAC,EACH,SAASX,QAAQ,QACfI,YAAY,CAACa,GAAG,CAACC,GAAG,IAAI,GAAGA,GAAG,CAACC,QAAQ,IAAID,GAAG,CAACE,WAAW,EAAE,CAAC,CAACC,IAAI,CAChE,GACF,CAAC,EAEL,CAAC;EACH,CAAC,EACD,CACEnB,gBAAgB,EAChBE,YAAY,EACZJ,QAAQ,EACRC,OAAO,CAACY,KAAK,EACbZ,OAAO,CAACa,QAAQ,EAChBb,OAAO,CAACc,OAAO,EACfd,OAAO,CAACe,IAAI,CAEhB,CAAC;EAED,MAAMM,OAAO,GAAG9B,KAAK,CAAC+B,oBAAoB,CACxCd,SAAS,EACTC,WACF,CAAC;EAED,OAAO;IACLc,KAAK,EAAEF,OAAO,EAAEG,YAAY;IAC5BC,SAAS,EAAEJ,OAAO,EAAEK,MAAM,KAAK,SAAS;IACxCC,YAAY,EAAEN,OAAO,EAAEM,YAAY,IAAI,KAAK;IAC5CC,KAAK,EAAEP,OAAO,EAAEO,KAAK;IACrBC,SAAS,EAAER,OAAO,EAAEQ,SAAS;IAC7BC,OAAO,EAAET,OAAO,EAAES,OAAO,IAAI;EAC/B,CAAC;AACH","ignoreList":[]}
+{"version":3,"file":"useLinks.js","names":["React","makeExternalStore","OsdkContext2","emptyArray","Object","freeze","useLinks","objects","linkName","options","observableClient","useContext","enabled","otherOptions","objectsArray","useMemo","undefined","Array","isArray","subscribe","getSnapShot","unsubscribe","map","obj","$apiName","$primaryKey","join","observer","observeLinks","where","pageSize","orderBy","mode","payload","useSyncExternalStore","links","resolvedList","isLoading","status","isOptimistic","error","fetchMore","hasMore"],"sources":["useLinks.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { LinkedType, LinkNames } from \"@osdk/api\";\nimport type {\n  InterfaceDefinition,\n  ObjectTypeDefinition,\n  Osdk,\n  PropertyKeys,\n  WhereClause,\n} from \"@osdk/client\";\nimport type { ObserveLinks } from \"@osdk/client/unstable-do-not-use\";\nimport React from \"react\";\nimport { makeExternalStore } from \"./makeExternalStore.js\";\nimport { OsdkContext2 } from \"./OsdkContext2.js\";\n\nexport interface UseLinksOptions<\n  T extends ObjectTypeDefinition | InterfaceDefinition,\n> {\n  /**\n   * Standard OSDK Where clause for filtering linked objects\n   */\n  where?: WhereClause<T>;\n\n  /**\n   * The preferred page size for the links list.\n   */\n  pageSize?: number;\n\n  /** Sorting options for the linked objects */\n  orderBy?: {\n    [K in PropertyKeys<T>]?: \"asc\" | \"desc\";\n  };\n\n  /**\n   * The mode to use for fetching data.\n   * - undefined: Fetch data if not already in cache\n   * - \"force\": Always fetch fresh data\n   * - \"offline\": Only use cached data, don't make network requests\n   */\n  mode?: \"force\" | \"offline\";\n\n  /**\n   * Enable or disable the query.\n   *\n   * When `false`, the query will not automatically execute. It will still\n   * return any cached data, but will not fetch from the server.\n   *\n   * This is useful for:\n   * - Lazy/on-demand queries that should wait for user interaction\n   * - Dependent queries that need data from another query first\n   * - Conditional queries based on component state\n   *\n   * @default true\n   * @example\n   * // Dependent query - wait for employee data\n   * const { object: employee } = useOsdkObject(Employee, employeeId);\n   * const { links: reports } = useLinks(employee, \"reports\", {\n   *   enabled: !!employee\n   * });\n   */\n  enabled?: boolean;\n}\n\nexport interface UseLinksResult<\n  Q extends ObjectTypeDefinition | InterfaceDefinition,\n> {\n  links: Osdk.Instance<Q>[] | undefined;\n  isLoading: boolean;\n  error: Error | undefined;\n\n  /**\n   * Refers to whether the links are optimistic or not.\n   */\n  isOptimistic: boolean;\n\n  /**\n   * Fetch more linked objects if pagination is supported\n   */\n  fetchMore: (() => Promise<unknown>) | undefined;\n\n  /**\n   * Indicates if there are more linked objects available to fetch\n   */\n  hasMore: boolean;\n}\n\nconst emptyArray = Object.freeze([]);\n\n/**\n * Hook to observe links from an object or array of objects.\n *\n * @param objects The source object(s) to observe links from\n * @param linkName The name of the link to observe\n * @param options Optional configuration for the link query\n * @returns UseLinksResult with links data and metadata\n */\nexport function useLinks<\n  T extends ObjectTypeDefinition,\n  L extends LinkNames<T>,\n>(\n  objects: Osdk.Instance<T> | Array<Osdk.Instance<T>> | undefined,\n  linkName: L,\n  options: UseLinksOptions<LinkedType<T, L>> = {},\n): UseLinksResult<LinkedType<T, L>> {\n  const { observableClient } = React.useContext(OsdkContext2);\n\n  const { enabled = true, ...otherOptions } = options;\n\n  // Convert single object to array for consistent handling\n  const objectsArray: ReadonlyArray<Osdk.Instance<T>> = React.useMemo(() => {\n    return objects === undefined\n      ? emptyArray\n      : Array.isArray(objects)\n      ? objects\n      : [objects];\n  }, [objects]);\n\n  const { subscribe, getSnapShot } = React.useMemo(\n    () => {\n      if (!enabled) {\n        return makeExternalStore<ObserveLinks.CallbackArgs<T>>(\n          () => ({ unsubscribe: () => {} }),\n          `links ${linkName} for ${\n            objectsArray.map(obj => `${obj.$apiName}:${obj.$primaryKey}`).join(\n              \",\",\n            )\n          } [DISABLED]`,\n        );\n      }\n      return makeExternalStore<ObserveLinks.CallbackArgs<T>>(\n        (observer) =>\n          observableClient.observeLinks(\n            objectsArray,\n            linkName,\n            {\n              linkName,\n              where: otherOptions.where,\n              pageSize: otherOptions.pageSize,\n              orderBy: otherOptions.orderBy,\n              mode: otherOptions.mode,\n            },\n            observer,\n          ),\n        `links ${linkName} for ${\n          objectsArray.map(obj => `${obj.$apiName}:${obj.$primaryKey}`).join(\n            \",\",\n          )\n        }`,\n      );\n    },\n    [\n      enabled,\n      observableClient,\n      objectsArray,\n      linkName,\n      otherOptions.where,\n      otherOptions.pageSize,\n      otherOptions.orderBy,\n      otherOptions.mode,\n    ],\n  );\n\n  const payload = React.useSyncExternalStore(\n    subscribe,\n    getSnapShot,\n  );\n\n  return {\n    links: payload?.resolvedList,\n    isLoading: payload?.status === \"loading\",\n    isOptimistic: payload?.isOptimistic ?? false,\n    error: payload?.error,\n    fetchMore: payload?.fetchMore,\n    hasMore: payload?.hasMore ?? false,\n  };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAWA,OAAOA,KAAK,MAAM,OAAO;AACzB,SAASC,iBAAiB,QAAQ,wBAAwB;AAC1D,SAASC,YAAY,QAAQ,mBAAmB;AAyEhD,MAAMC,UAAU,GAAGC,MAAM,CAACC,MAAM,CAAC,EAAE,CAAC;;AAEpC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,QAAQA,CAItBC,OAA+D,EAC/DC,QAAW,EACXC,OAA0C,GAAG,CAAC,CAAC,EACb;EAClC,MAAM;IAAEC;EAAiB,CAAC,GAAGV,KAAK,CAACW,UAAU,CAACT,YAAY,CAAC;EAE3D,MAAM;IAAEU,OAAO,GAAG,IAAI;IAAE,GAAGC;EAAa,CAAC,GAAGJ,OAAO;;EAEnD;EACA,MAAMK,YAA6C,GAAGd,KAAK,CAACe,OAAO,CAAC,MAAM;IACxE,OAAOR,OAAO,KAAKS,SAAS,GACxBb,UAAU,GACVc,KAAK,CAACC,OAAO,CAACX,OAAO,CAAC,GACtBA,OAAO,GACP,CAACA,OAAO,CAAC;EACf,CAAC,EAAE,CAACA,OAAO,CAAC,CAAC;EAEb,MAAM;IAAEY,SAAS;IAAEC;EAAY,CAAC,GAAGpB,KAAK,CAACe,OAAO,CAC9C,MAAM;IACJ,IAAI,CAACH,OAAO,EAAE;MACZ,OAAOX,iBAAiB,CACtB,OAAO;QAAEoB,WAAW,EAAEA,CAAA,KAAM,CAAC;MAAE,CAAC,CAAC,EACjC,SAASb,QAAQ,QACfM,YAAY,CAACQ,GAAG,CAACC,GAAG,IAAI,GAAGA,GAAG,CAACC,QAAQ,IAAID,GAAG,CAACE,WAAW,EAAE,CAAC,CAACC,IAAI,CAChE,GACF,CAAC,aAEL,CAAC;IACH;IACA,OAAOzB,iBAAiB,CACrB0B,QAAQ,IACPjB,gBAAgB,CAACkB,YAAY,CAC3Bd,YAAY,EACZN,QAAQ,EACR;MACEA,QAAQ;MACRqB,KAAK,EAAEhB,YAAY,CAACgB,KAAK;MACzBC,QAAQ,EAAEjB,YAAY,CAACiB,QAAQ;MAC/BC,OAAO,EAAElB,YAAY,CAACkB,OAAO;MAC7BC,IAAI,EAAEnB,YAAY,CAACmB;IACrB,CAAC,EACDL,QACF,CAAC,EACH,SAASnB,QAAQ,QACfM,YAAY,CAACQ,GAAG,CAACC,GAAG,IAAI,GAAGA,GAAG,CAACC,QAAQ,IAAID,GAAG,CAACE,WAAW,EAAE,CAAC,CAACC,IAAI,CAChE,GACF,CAAC,EAEL,CAAC;EACH,CAAC,EACD,CACEd,OAAO,EACPF,gBAAgB,EAChBI,YAAY,EACZN,QAAQ,EACRK,YAAY,CAACgB,KAAK,EAClBhB,YAAY,CAACiB,QAAQ,EACrBjB,YAAY,CAACkB,OAAO,EACpBlB,YAAY,CAACmB,IAAI,CAErB,CAAC;EAED,MAAMC,OAAO,GAAGjC,KAAK,CAACkC,oBAAoB,CACxCf,SAAS,EACTC,WACF,CAAC;EAED,OAAO;IACLe,KAAK,EAAEF,OAAO,EAAEG,YAAY;IAC5BC,SAAS,EAAEJ,OAAO,EAAEK,MAAM,KAAK,SAAS;IACxCC,YAAY,EAAEN,OAAO,EAAEM,YAAY,IAAI,KAAK;IAC5CC,KAAK,EAAEP,OAAO,EAAEO,KAAK;IACrBC,SAAS,EAAER,OAAO,EAAEQ,SAAS;IAC7BC,OAAO,EAAET,OAAO,EAAES,OAAO,IAAI;EAC/B,CAAC;AACH","ignoreList":[]}

package/build/browser/new/useObjectSet.js

@@ -33,38 +33,50 @@ export function useObjectSet(baseObjectSet, options = {}) {
   const {
     observableClient
   } = React.useContext(OsdkContext2);
+  const {
+    enabled = true,
+    streamUpdates,
+    ...otherOptions
+  } = options;
 
   // Compute a stable cache key for the ObjectSet and options
-  // dedupeIntervalMs is excluded as it doesn't affect the data, only the refresh rate
+  // dedupeIntervalMs and enabled are excluded as they don't affect the data
   const stableKey = computeObjectSetCacheKey(baseObjectSet, {
-    where: options.where,
-    withProperties: options.withProperties,
-    union: options.union,
-    intersect: options.intersect,
-    subtract: options.subtract,
-    pivotTo: options.pivotTo,
-    pageSize: options.pageSize,
-    orderBy: options.orderBy
+    where: otherOptions.where,
+    withProperties: otherOptions.withProperties,
+    union: otherOptions.union,
+    intersect: otherOptions.intersect,
+    subtract: otherOptions.subtract,
+    pivotTo: otherOptions.pivotTo,
+    pageSize: otherOptions.pageSize,
+    orderBy: otherOptions.orderBy
   });
   const {
     subscribe,
     getSnapShot
   } = React.useMemo(() => {
+    if (!enabled) {
+      return makeExternalStore(() => ({
+        unsubscribe: () => {}
+      }), process.env.NODE_ENV !== "production" ? `objectSet ${stableKey} [DISABLED]` : void 0);
+    }
     return makeExternalStore(observer => {
       const subscription = observableClient.observeObjectSet(baseObjectSet, {
-        where: options.where,
-        withProperties: options.withProperties,
-        union: options.union,
-        intersect: options.intersect,
-        subtract: options.subtract,
-        pivotTo: options.pivotTo,
-        pageSize: options.pageSize,
-        orderBy: options.orderBy,
-        dedupeInterval: options.dedupeIntervalMs ?? 2_000
+        where: otherOptions.where,
+        withProperties: otherOptions.withProperties,
+        union: otherOptions.union,
+        intersect: otherOptions.intersect,
+        subtract: otherOptions.subtract,
+        pivotTo: otherOptions.pivotTo,
+        pageSize: otherOptions.pageSize,
+        orderBy: otherOptions.orderBy,
+        dedupeInterval: otherOptions.dedupeIntervalMs ?? 2_000,
+        autoFetchMore: otherOptions.autoFetchMore,
+        streamUpdates
       }, observer);
       return subscription;
     }, process.env.NODE_ENV !== "production" ? `objectSet ${stableKey}` : void 0);
-  }, [observableClient, stableKey]);
+  }, [enabled, observableClient, stableKey, streamUpdates]);
   const payload = React.useSyncExternalStore(subscribe, getSnapShot);
   return {
     data: payload?.resolvedList,

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

@@ -1 +1 @@
-{"version":3,"file":"useObjectSet.js","names":["computeObjectSetCacheKey","React","makeExternalStore","OsdkContext2","useObjectSet","baseObjectSet","options","observableClient","useContext","stableKey","where","withProperties","union","intersect","subtract","pivotTo","pageSize","orderBy","subscribe","getSnapShot","useMemo","observer","subscription","observeObjectSet","dedupeInterval","dedupeIntervalMs","process","env","NODE_ENV","payload","useSyncExternalStore","data","resolvedList","isLoading","status","error","undefined","fetchMore","objectSet"],"sources":["useObjectSet.tsx"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n  DerivedProperty,\n  LinkNames,\n  ObjectSet,\n  ObjectTypeDefinition,\n  Osdk,\n  PropertyKeys,\n  SimplePropertyDef,\n  WhereClause,\n} from \"@osdk/api\";\n\nimport {\n  computeObjectSetCacheKey,\n  type ObserveObjectSetArgs,\n} from \"@osdk/client/unstable-do-not-use\";\nimport React from \"react\";\nimport { makeExternalStore } from \"./makeExternalStore.js\";\nimport { OsdkContext2 } from \"./OsdkContext2.js\";\n\nexport interface UseObjectSetOptions<\n  Q extends ObjectTypeDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> {\n  /**\n   * Where clause for filtering\n   */\n  where?: WhereClause<Q, RDPs>;\n\n  /**\n   * Derived properties to add to the object set\n   */\n  withProperties?: { [K in keyof RDPs]: DerivedProperty.Creator<Q, RDPs[K]> };\n\n  /**\n   * Object sets to union with\n   */\n  union?: ObjectSet<Q>[];\n\n  /**\n   * Object sets to intersect with\n   */\n  intersect?: ObjectSet<Q>[];\n\n  /**\n   * Object sets to subtract from\n   */\n  subtract?: ObjectSet<Q>[];\n\n  /**\n   * Link to pivot to (changes the type)\n   */\n  pivotTo?: LinkNames<Q>;\n\n  /**\n   * The preferred page size for the list\n   */\n  pageSize?: number;\n\n  /**\n   * Sort order for the results\n   */\n  orderBy?: {\n    [K in PropertyKeys<Q>]?: \"asc\" | \"desc\";\n  };\n\n  /**\n   * Minimum time between fetch requests in milliseconds (defaults to 2000ms)\n   */\n  dedupeIntervalMs?: number;\n}\n\nexport interface UseObjectSetResult<\n  Q extends ObjectTypeDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> {\n  /**\n   * The fetched data with derived properties\n   */\n  data:\n    | Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs>[]\n    | undefined;\n\n  /**\n   * Whether data is currently being loaded\n   */\n  isLoading: boolean;\n\n  /**\n   * Any error that occurred during fetching\n   */\n  error: Error | undefined;\n\n  /**\n   * Function to fetch more pages (undefined if no more pages)\n   */\n  fetchMore: (() => Promise<void>) | undefined;\n\n  /**\n   * The final ObjectSet after all transformations\n   */\n  objectSet: ObjectSet<Q, RDPs>;\n}\n\ndeclare const process: {\n  env: {\n    NODE_ENV: \"development\" | \"production\";\n  };\n};\n\n/**\n * React hook for observing and interacting with OSDK object sets.\n *\n * @typeParam Q - The object type definition\n * @typeParam BaseRDPs - Derived properties that already exist on the input ObjectSet\n * @typeParam RDPs - New derived properties to be added via options.withProperties\n *\n * @param baseObjectSet - The ObjectSet to observe (may already have derived properties)\n * @param options - Options for filtering, sorting, and adding new derived properties\n * @returns Object set data with both existing and new derived properties\n */\nexport function useObjectSet<\n  Q extends ObjectTypeDefinition,\n  BaseRDPs extends Record<string, SimplePropertyDef> = never,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n>(\n  baseObjectSet: ObjectSet<Q, BaseRDPs>,\n  options: UseObjectSetOptions<Q, RDPs> = {},\n): UseObjectSetResult<Q, RDPs> {\n  const { observableClient } = React.useContext(OsdkContext2);\n\n  // Compute a stable cache key for the ObjectSet and options\n  // dedupeIntervalMs is excluded as it doesn't affect the data, only the refresh rate\n  const stableKey = computeObjectSetCacheKey(baseObjectSet, {\n    where: options.where,\n    withProperties: options.withProperties,\n    union: options.union,\n    intersect: options.intersect,\n    subtract: options.subtract,\n    pivotTo: options.pivotTo,\n    pageSize: options.pageSize,\n    orderBy: options.orderBy,\n  });\n\n  const { subscribe, getSnapShot } = React.useMemo(\n    () => {\n      return makeExternalStore<ObserveObjectSetArgs<Q, RDPs>>(\n        (observer) => {\n          const subscription = observableClient.observeObjectSet(\n            baseObjectSet as ObjectSet<Q>,\n            {\n              where: options.where,\n              withProperties: options.withProperties,\n              union: options.union,\n              intersect: options.intersect,\n              subtract: options.subtract,\n              pivotTo: options.pivotTo,\n              pageSize: options.pageSize,\n              orderBy: options.orderBy,\n              dedupeInterval: options.dedupeIntervalMs ?? 2_000,\n            },\n            observer,\n          );\n          return subscription;\n        },\n        process.env.NODE_ENV !== \"production\"\n          ? `objectSet ${stableKey}`\n          : void 0,\n      );\n    },\n    [observableClient, stableKey],\n  );\n\n  const payload = React.useSyncExternalStore(subscribe, getSnapShot);\n\n  return {\n    data: payload?.resolvedList as Osdk.Instance<\n      Q,\n      \"$allBaseProperties\",\n      PropertyKeys<Q>,\n      RDPs\n    >[],\n    isLoading: payload?.status === \"loading\" || (!payload && true) || false,\n    error: payload && \"error\" in payload\n      ? payload.error\n      : undefined,\n    fetchMore: payload?.fetchMore,\n    objectSet: payload?.objectSet as ObjectSet<Q, RDPs> || baseObjectSet,\n  };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAaA,SACEA,wBAAwB,QAEnB,kCAAkC;AACzC,OAAOC,KAAK,MAAM,OAAO;AACzB,SAASC,iBAAiB,QAAQ,wBAAwB;AAC1D,SAASC,YAAY,QAAQ,mBAAmB;AA4FhD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,YAAYA,CAK1BC,aAAqC,EACrCC,OAAqC,GAAG,CAAC,CAAC,EACb;EAC7B,MAAM;IAAEC;EAAiB,CAAC,GAAGN,KAAK,CAACO,UAAU,CAACL,YAAY,CAAC;;EAE3D;EACA;EACA,MAAMM,SAAS,GAAGT,wBAAwB,CAACK,aAAa,EAAE;IACxDK,KAAK,EAAEJ,OAAO,CAACI,KAAK;IACpBC,cAAc,EAAEL,OAAO,CAACK,cAAc;IACtCC,KAAK,EAAEN,OAAO,CAACM,KAAK;IACpBC,SAAS,EAAEP,OAAO,CAACO,SAAS;IAC5BC,QAAQ,EAAER,OAAO,CAACQ,QAAQ;IAC1BC,OAAO,EAAET,OAAO,CAACS,OAAO;IACxBC,QAAQ,EAAEV,OAAO,CAACU,QAAQ;IAC1BC,OAAO,EAAEX,OAAO,CAACW;EACnB,CAAC,CAAC;EAEF,MAAM;IAAEC,SAAS;IAAEC;EAAY,CAAC,GAAGlB,KAAK,CAACmB,OAAO,CAC9C,MAAM;IACJ,OAAOlB,iBAAiB,CACrBmB,QAAQ,IAAK;MACZ,MAAMC,YAAY,GAAGf,gBAAgB,CAACgB,gBAAgB,CACpDlB,aAAa,EACb;QACEK,KAAK,EAAEJ,OAAO,CAACI,KAAK;QACpBC,cAAc,EAAEL,OAAO,CAACK,cAAc;QACtCC,KAAK,EAAEN,OAAO,CAACM,KAAK;QACpBC,SAAS,EAAEP,OAAO,CAACO,SAAS;QAC5BC,QAAQ,EAAER,OAAO,CAACQ,QAAQ;QAC1BC,OAAO,EAAET,OAAO,CAACS,OAAO;QACxBC,QAAQ,EAAEV,OAAO,CAACU,QAAQ;QAC1BC,OAAO,EAAEX,OAAO,CAACW,OAAO;QACxBO,cAAc,EAAElB,OAAO,CAACmB,gBAAgB,IAAI;MAC9C,CAAC,EACDJ,QACF,CAAC;MACD,OAAOC,YAAY;IACrB,CAAC,EACDI,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,GACjC,aAAanB,SAAS,EAAE,GACxB,KAAK,CACX,CAAC;EACH,CAAC,EACD,CAACF,gBAAgB,EAAEE,SAAS,CAC9B,CAAC;EAED,MAAMoB,OAAO,GAAG5B,KAAK,CAAC6B,oBAAoB,CAACZ,SAAS,EAAEC,WAAW,CAAC;EAElE,OAAO;IACLY,IAAI,EAAEF,OAAO,EAAEG,YAKZ;IACHC,SAAS,EAAEJ,OAAO,EAAEK,MAAM,KAAK,SAAS,IAAK,CAACL,OAAO,IAAI,IAAK,IAAI,KAAK;IACvEM,KAAK,EAAEN,OAAO,IAAI,OAAO,IAAIA,OAAO,GAChCA,OAAO,CAACM,KAAK,GACbC,SAAS;IACbC,SAAS,EAAER,OAAO,EAAEQ,SAAS;IAC7BC,SAAS,EAAET,OAAO,EAAES,SAAS,IAA0BjC;EACzD,CAAC;AACH","ignoreList":[]}
+{"version":3,"file":"useObjectSet.js","names":["computeObjectSetCacheKey","React","makeExternalStore","OsdkContext2","useObjectSet","baseObjectSet","options","observableClient","useContext","enabled","streamUpdates","otherOptions","stableKey","where","withProperties","union","intersect","subtract","pivotTo","pageSize","orderBy","subscribe","getSnapShot","useMemo","unsubscribe","process","env","NODE_ENV","observer","subscription","observeObjectSet","dedupeInterval","dedupeIntervalMs","autoFetchMore","payload","useSyncExternalStore","data","resolvedList","isLoading","status","error","undefined","fetchMore","objectSet"],"sources":["useObjectSet.tsx"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n  DerivedProperty,\n  LinkNames,\n  ObjectSet,\n  ObjectTypeDefinition,\n  Osdk,\n  PropertyKeys,\n  SimplePropertyDef,\n  WhereClause,\n} from \"@osdk/api\";\n\nimport {\n  computeObjectSetCacheKey,\n  type ObserveObjectSetArgs,\n} from \"@osdk/client/unstable-do-not-use\";\nimport React from \"react\";\nimport { makeExternalStore } from \"./makeExternalStore.js\";\nimport { OsdkContext2 } from \"./OsdkContext2.js\";\n\nexport interface UseObjectSetOptions<\n  Q extends ObjectTypeDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> {\n  /**\n   * Where clause for filtering\n   */\n  where?: WhereClause<Q, RDPs>;\n\n  /**\n   * Derived properties to add to the object set\n   */\n  withProperties?: { [K in keyof RDPs]: DerivedProperty.Creator<Q, RDPs[K]> };\n\n  /**\n   * Object sets to union with\n   */\n  union?: ObjectSet<Q>[];\n\n  /**\n   * Object sets to intersect with\n   */\n  intersect?: ObjectSet<Q>[];\n\n  /**\n   * Object sets to subtract from\n   */\n  subtract?: ObjectSet<Q>[];\n\n  /**\n   * Link to pivot to (changes the type)\n   */\n  pivotTo?: LinkNames<Q>;\n\n  /**\n   * The preferred page size for the list\n   */\n  pageSize?: number;\n\n  /**\n   * Sort order for the results\n   */\n  orderBy?: {\n    [K in PropertyKeys<Q>]?: \"asc\" | \"desc\";\n  };\n\n  /**\n   * Minimum time between fetch requests in milliseconds (defaults to 2000ms)\n   */\n  dedupeIntervalMs?: number;\n\n  /**\n   * Automatically fetch additional pages on initial load.\n   *\n   * - `true`: Fetch all available pages automatically\n   * - `number`: Fetch pages until at least this many items are loaded\n   * - `undefined` (default): Only fetch the first page, user must call fetchMore()\n   */\n  autoFetchMore?: boolean | number;\n\n  /**\n   * Enable streaming updates via websocket subscription.\n   * When true, the object set will automatically update when matching objects are\n   * added, updated, or removed.\n   *\n   * @default false\n   */\n  streamUpdates?: boolean;\n\n  /**\n   * Enable or disable the query.\n   *\n   * When `false`, the query will not automatically execute. It will still\n   * return any cached data, but will not fetch from the server.\n   *\n   * This is useful for:\n   * - Lazy/on-demand queries that should wait for user interaction\n   * - Dependent queries that need data from another query first\n   * - Conditional queries based on component state\n   *\n   * @default true\n   * @example\n   * // Dependent query - wait for filter selection\n   * const { data: filteredObjects } = useObjectSet(MyObject.all(), {\n   *   where: { status: selectedStatus },\n   *   enabled: !!selectedStatus\n   * });\n   */\n  enabled?: boolean;\n}\n\nexport interface UseObjectSetResult<\n  Q extends ObjectTypeDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> {\n  /**\n   * The fetched data with derived properties\n   */\n  data:\n    | Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs>[]\n    | undefined;\n\n  /**\n   * Whether data is currently being loaded\n   */\n  isLoading: boolean;\n\n  /**\n   * Any error that occurred during fetching\n   */\n  error: Error | undefined;\n\n  /**\n   * Function to fetch more pages (undefined if no more pages)\n   */\n  fetchMore: (() => Promise<void>) | undefined;\n\n  /**\n   * The final ObjectSet after all transformations\n   */\n  objectSet: ObjectSet<Q, RDPs>;\n}\n\ndeclare const process: {\n  env: {\n    NODE_ENV: \"development\" | \"production\";\n  };\n};\n\n/**\n * React hook for observing and interacting with OSDK object sets.\n *\n * @typeParam Q - The object type definition\n * @typeParam BaseRDPs - Derived properties that already exist on the input ObjectSet\n * @typeParam RDPs - New derived properties to be added via options.withProperties\n *\n * @param baseObjectSet - The ObjectSet to observe (may already have derived properties)\n * @param options - Options for filtering, sorting, and adding new derived properties\n * @returns Object set data with both existing and new derived properties\n */\nexport function useObjectSet<\n  Q extends ObjectTypeDefinition,\n  BaseRDPs extends Record<string, SimplePropertyDef> = never,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n>(\n  baseObjectSet: ObjectSet<Q, BaseRDPs>,\n  options: UseObjectSetOptions<Q, RDPs> = {},\n): UseObjectSetResult<Q, RDPs> {\n  const { observableClient } = React.useContext(OsdkContext2);\n\n  const { enabled = true, streamUpdates, ...otherOptions } = options;\n\n  // Compute a stable cache key for the ObjectSet and options\n  // dedupeIntervalMs and enabled are excluded as they don't affect the data\n  const stableKey = computeObjectSetCacheKey(baseObjectSet, {\n    where: otherOptions.where,\n    withProperties: otherOptions.withProperties,\n    union: otherOptions.union,\n    intersect: otherOptions.intersect,\n    subtract: otherOptions.subtract,\n    pivotTo: otherOptions.pivotTo,\n    pageSize: otherOptions.pageSize,\n    orderBy: otherOptions.orderBy,\n  });\n\n  const { subscribe, getSnapShot } = React.useMemo(\n    () => {\n      if (!enabled) {\n        return makeExternalStore<ObserveObjectSetArgs<Q, RDPs>>(\n          () => ({ unsubscribe: () => {} }),\n          process.env.NODE_ENV !== \"production\"\n            ? `objectSet ${stableKey} [DISABLED]`\n            : void 0,\n        );\n      }\n      return makeExternalStore<ObserveObjectSetArgs<Q, RDPs>>(\n        (observer) => {\n          const subscription = observableClient.observeObjectSet(\n            baseObjectSet as ObjectSet<Q>,\n            {\n              where: otherOptions.where,\n              withProperties: otherOptions.withProperties,\n              union: otherOptions.union,\n              intersect: otherOptions.intersect,\n              subtract: otherOptions.subtract,\n              pivotTo: otherOptions.pivotTo,\n              pageSize: otherOptions.pageSize,\n              orderBy: otherOptions.orderBy,\n              dedupeInterval: otherOptions.dedupeIntervalMs ?? 2_000,\n              autoFetchMore: otherOptions.autoFetchMore,\n              streamUpdates,\n            },\n            observer,\n          );\n          return subscription;\n        },\n        process.env.NODE_ENV !== \"production\"\n          ? `objectSet ${stableKey}`\n          : void 0,\n      );\n    },\n    [enabled, observableClient, stableKey, streamUpdates],\n  );\n\n  const payload = React.useSyncExternalStore(subscribe, getSnapShot);\n\n  return {\n    data: payload?.resolvedList as Osdk.Instance<\n      Q,\n      \"$allBaseProperties\",\n      PropertyKeys<Q>,\n      RDPs\n    >[],\n    isLoading: payload?.status === \"loading\" || (!payload && true) || false,\n    error: payload && \"error\" in payload\n      ? payload.error\n      : undefined,\n    fetchMore: payload?.fetchMore,\n    objectSet: payload?.objectSet as ObjectSet<Q, RDPs> || baseObjectSet,\n  };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAaA,SACEA,wBAAwB,QAEnB,kCAAkC;AACzC,OAAOC,KAAK,MAAM,OAAO;AACzB,SAASC,iBAAiB,QAAQ,wBAAwB;AAC1D,SAASC,YAAY,QAAQ,mBAAmB;AAmIhD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,YAAYA,CAK1BC,aAAqC,EACrCC,OAAqC,GAAG,CAAC,CAAC,EACb;EAC7B,MAAM;IAAEC;EAAiB,CAAC,GAAGN,KAAK,CAACO,UAAU,CAACL,YAAY,CAAC;EAE3D,MAAM;IAAEM,OAAO,GAAG,IAAI;IAAEC,aAAa;IAAE,GAAGC;EAAa,CAAC,GAAGL,OAAO;;EAElE;EACA;EACA,MAAMM,SAAS,GAAGZ,wBAAwB,CAACK,aAAa,EAAE;IACxDQ,KAAK,EAAEF,YAAY,CAACE,KAAK;IACzBC,cAAc,EAAEH,YAAY,CAACG,cAAc;IAC3CC,KAAK,EAAEJ,YAAY,CAACI,KAAK;IACzBC,SAAS,EAAEL,YAAY,CAACK,SAAS;IACjCC,QAAQ,EAAEN,YAAY,CAACM,QAAQ;IAC/BC,OAAO,EAAEP,YAAY,CAACO,OAAO;IAC7BC,QAAQ,EAAER,YAAY,CAACQ,QAAQ;IAC/BC,OAAO,EAAET,YAAY,CAACS;EACxB,CAAC,CAAC;EAEF,MAAM;IAAEC,SAAS;IAAEC;EAAY,CAAC,GAAGrB,KAAK,CAACsB,OAAO,CAC9C,MAAM;IACJ,IAAI,CAACd,OAAO,EAAE;MACZ,OAAOP,iBAAiB,CACtB,OAAO;QAAEsB,WAAW,EAAEA,CAAA,KAAM,CAAC;MAAE,CAAC,CAAC,EACjCC,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,GACjC,aAAaf,SAAS,aAAa,GACnC,KAAK,CACX,CAAC;IACH;IACA,OAAOV,iBAAiB,CACrB0B,QAAQ,IAAK;MACZ,MAAMC,YAAY,GAAGtB,gBAAgB,CAACuB,gBAAgB,CACpDzB,aAAa,EACb;QACEQ,KAAK,EAAEF,YAAY,CAACE,KAAK;QACzBC,cAAc,EAAEH,YAAY,CAACG,cAAc;QAC3CC,KAAK,EAAEJ,YAAY,CAACI,KAAK;QACzBC,SAAS,EAAEL,YAAY,CAACK,SAAS;QACjCC,QAAQ,EAAEN,YAAY,CAACM,QAAQ;QAC/BC,OAAO,EAAEP,YAAY,CAACO,OAAO;QAC7BC,QAAQ,EAAER,YAAY,CAACQ,QAAQ;QAC/BC,OAAO,EAAET,YAAY,CAACS,OAAO;QAC7BW,cAAc,EAAEpB,YAAY,CAACqB,gBAAgB,IAAI,KAAK;QACtDC,aAAa,EAAEtB,YAAY,CAACsB,aAAa;QACzCvB;MACF,CAAC,EACDkB,QACF,CAAC;MACD,OAAOC,YAAY;IACrB,CAAC,EACDJ,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,GACjC,aAAaf,SAAS,EAAE,GACxB,KAAK,CACX,CAAC;EACH,CAAC,EACD,CAACH,OAAO,EAAEF,gBAAgB,EAAEK,SAAS,EAAEF,aAAa,CACtD,CAAC;EAED,MAAMwB,OAAO,GAAGjC,KAAK,CAACkC,oBAAoB,CAACd,SAAS,EAAEC,WAAW,CAAC;EAElE,OAAO;IACLc,IAAI,EAAEF,OAAO,EAAEG,YAKZ;IACHC,SAAS,EAAEJ,OAAO,EAAEK,MAAM,KAAK,SAAS,IAAK,CAACL,OAAO,IAAI,IAAK,IAAI,KAAK;IACvEM,KAAK,EAAEN,OAAO,IAAI,OAAO,IAAIA,OAAO,GAChCA,OAAO,CAACM,KAAK,GACbC,SAAS;IACbC,SAAS,EAAER,OAAO,EAAEQ,SAAS;IAC7BC,SAAS,EAAET,OAAO,EAAES,SAAS,IAA0BtC;EACzD,CAAC;AACH","ignoreList":[]}

package/build/browser/new/useOsdkAggregation.js

@@ -0,0 +1,83 @@
+/*
+ * Copyright 2025 Palantir Technologies, Inc. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import React from "react";
+import { makeExternalStore } from "./makeExternalStore.js";
+import { OsdkContext2 } from "./OsdkContext2.js";
+/**
+ * React hook for performing aggregations on OSDK object sets.
+ *
+ * Executes server-side aggregations with groupBy and metric calculations on filtered object sets.
+ * Supports runtime derived properties and where clauses.
+ *
+ * @param type - The object or interface type to aggregate
+ * @param options - Aggregation configuration including where clause, aggregation spec, and optional derived properties
+ * @returns Object containing aggregation results, loading state, error state, and refetch function
+ *
+ * @example
+ * ```tsx
+ * const { data, isLoading, error } = useOsdkAggregation(Employee, {
+ *   where: { department: "Engineering" },
+ *   aggregate: {
+ *     groupBy: { department: "exact" },
+ *     select: {
+ *       avgSalary: { $avg: "salary" },
+ *       count: { $count: {} }
+ *     }
+ *   }
+ * });
+ * ```
+ */
+export function useOsdkAggregation(type, {
+  where = {},
+  withProperties,
+  aggregate,
+  dedupeIntervalMs
+}) {
+  const {
+    observableClient
+  } = React.useContext(OsdkContext2);
+  const canonWhere = observableClient.canonicalizeWhereClause(where ?? {});
+  const stableWithProperties = React.useMemo(() => withProperties, [JSON.stringify(withProperties)]);
+  const stableAggregate = React.useMemo(() => aggregate, [JSON.stringify(aggregate)]);
+  const {
+    subscribe,
+    getSnapShot
+  } = React.useMemo(() => makeExternalStore(observer => observableClient.observeAggregation({
+    type: type,
+    where: canonWhere,
+    withProperties: stableWithProperties,
+    aggregate: stableAggregate,
+    dedupeInterval: dedupeIntervalMs ?? 2_000
+  }, observer), process.env.NODE_ENV !== "production" ? `aggregation ${type.apiName} ${JSON.stringify(canonWhere)}` : void 0), [observableClient, type.apiName, type.type, canonWhere, stableWithProperties, stableAggregate, dedupeIntervalMs]);
+  const payload = React.useSyncExternalStore(subscribe, getSnapShot);
+  let error;
+  if (payload && "error" in payload && payload.error) {
+    error = payload.error;
+  } else if (payload?.status === "error") {
+    error = new Error("Failed to execute aggregation");
+  }
+  const refetch = React.useCallback(async () => {
+    await observableClient.invalidateObjectType(type.apiName);
+  }, [observableClient, type.apiName]);
+  return {
+    data: payload?.result,
+    isLoading: payload?.status === "loading",
+    error,
+    refetch
+  };
+}
+//# sourceMappingURL=useOsdkAggregation.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useOsdkAggregation.js","names":["React","makeExternalStore","OsdkContext2","useOsdkAggregation","type","where","withProperties","aggregate","dedupeIntervalMs","observableClient","useContext","canonWhere","canonicalizeWhereClause","stableWithProperties","useMemo","JSON","stringify","stableAggregate","subscribe","getSnapShot","observer","observeAggregation","dedupeInterval","process","env","NODE_ENV","apiName","payload","useSyncExternalStore","error","status","Error","refetch","useCallback","invalidateObjectType","data","result","isLoading"],"sources":["useOsdkAggregation.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n  AggregateOpts,\n  AggregationsResults,\n  DerivedProperty,\n  WhereClause,\n} from \"@osdk/api\";\nimport type { ObjectTypeDefinition } from \"@osdk/client\";\nimport type { ObserveAggregationArgs } from \"@osdk/client/unstable-do-not-use\";\nimport React from \"react\";\nimport { makeExternalStore } from \"./makeExternalStore.js\";\nimport { OsdkContext2 } from \"./OsdkContext2.js\";\nimport type { InferRdpTypes } from \"./types.js\";\n\nexport interface UseOsdkAggregationOptions<\n  T extends ObjectTypeDefinition,\n  A extends AggregateOpts<T>,\n  WithProps extends DerivedProperty.Clause<T> | undefined = undefined,\n> {\n  /**\n   * Standard OSDK Where clause to filter objects before aggregation\n   */\n  where?: WhereClause<T, InferRdpTypes<T, WithProps>>;\n\n  /**\n   * Define derived properties (RDPs) to be computed server-side.\n   * The derived properties can be used in the where clause and aggregation groupBy/select.\n   */\n  withProperties?: WithProps;\n\n  /**\n   * Aggregation options including groupBy and select\n   */\n  aggregate: A;\n\n  /**\n   * The number of milliseconds to wait after the last observed aggregation change.\n   *\n   * Two uses of `useOsdkAggregation` with the same parameters will only trigger one\n   * network request if the second is within `dedupeIntervalMs`.\n   */\n  dedupeIntervalMs?: number;\n}\n\nexport interface UseOsdkAggregationResult<\n  T extends ObjectTypeDefinition,\n  A extends AggregateOpts<T>,\n> {\n  data: AggregationsResults<T, A> | undefined;\n  isLoading: boolean;\n  error: Error | undefined;\n  refetch: () => void;\n}\n\ndeclare const process: {\n  env: {\n    NODE_ENV: \"development\" | \"production\";\n  };\n};\n\n/**\n * React hook for performing aggregations on OSDK object sets.\n *\n * Executes server-side aggregations with groupBy and metric calculations on filtered object sets.\n * Supports runtime derived properties and where clauses.\n *\n * @param type - The object or interface type to aggregate\n * @param options - Aggregation configuration including where clause, aggregation spec, and optional derived properties\n * @returns Object containing aggregation results, loading state, error state, and refetch function\n *\n * @example\n * ```tsx\n * const { data, isLoading, error } = useOsdkAggregation(Employee, {\n *   where: { department: \"Engineering\" },\n *   aggregate: {\n *     groupBy: { department: \"exact\" },\n *     select: {\n *       avgSalary: { $avg: \"salary\" },\n *       count: { $count: {} }\n *     }\n *   }\n * });\n * ```\n */\nexport function useOsdkAggregation<\n  Q extends ObjectTypeDefinition,\n  A extends AggregateOpts<Q>,\n  WP extends DerivedProperty.Clause<Q> | undefined = undefined,\n>(\n  type: Q,\n  {\n    where = {},\n    withProperties,\n    aggregate,\n    dedupeIntervalMs,\n  }: UseOsdkAggregationOptions<Q, A, WP>,\n): UseOsdkAggregationResult<Q, A> {\n  const { observableClient } = React.useContext(OsdkContext2);\n\n  const canonWhere = observableClient.canonicalizeWhereClause<Q>(where ?? {});\n\n  const stableWithProperties = React.useMemo(\n    () => withProperties,\n    [JSON.stringify(withProperties)],\n  );\n\n  const stableAggregate = React.useMemo(\n    () => aggregate,\n    [JSON.stringify(aggregate)],\n  );\n\n  const { subscribe, getSnapShot } = React.useMemo(\n    () =>\n      makeExternalStore<ObserveAggregationArgs<Q, A>>(\n        (observer) =>\n          observableClient.observeAggregation(\n            {\n              type: type,\n              where: canonWhere,\n              withProperties: stableWithProperties,\n              aggregate: stableAggregate,\n              dedupeInterval: dedupeIntervalMs ?? 2_000,\n            },\n            observer,\n          ),\n        process.env.NODE_ENV !== \"production\"\n          ? `aggregation ${type.apiName} ${JSON.stringify(canonWhere)}`\n          : void 0,\n      ),\n    [\n      observableClient,\n      type.apiName,\n      type.type,\n      canonWhere,\n      stableWithProperties,\n      stableAggregate,\n      dedupeIntervalMs,\n    ],\n  );\n\n  const payload = React.useSyncExternalStore(subscribe, getSnapShot);\n\n  let error: Error | undefined;\n  if (payload && \"error\" in payload && payload.error) {\n    error = payload.error;\n  } else if (payload?.status === \"error\") {\n    error = new Error(\"Failed to execute aggregation\");\n  }\n\n  const refetch = React.useCallback(async () => {\n    await observableClient.invalidateObjectType(type.apiName);\n  }, [observableClient, type.apiName]);\n\n  return {\n    data: payload?.result as AggregationsResults<Q, A> | undefined,\n    isLoading: payload?.status === \"loading\",\n    error,\n    refetch,\n  };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAUA,OAAOA,KAAK,MAAM,OAAO;AACzB,SAASC,iBAAiB,QAAQ,wBAAwB;AAC1D,SAASC,YAAY,QAAQ,mBAAmB;AAiDhD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,kBAAkBA,CAKhCC,IAAO,EACP;EACEC,KAAK,GAAG,CAAC,CAAC;EACVC,cAAc;EACdC,SAAS;EACTC;AACmC,CAAC,EACN;EAChC,MAAM;IAAEC;EAAiB,CAAC,GAAGT,KAAK,CAACU,UAAU,CAACR,YAAY,CAAC;EAE3D,MAAMS,UAAU,GAAGF,gBAAgB,CAACG,uBAAuB,CAAIP,KAAK,IAAI,CAAC,CAAC,CAAC;EAE3E,MAAMQ,oBAAoB,GAAGb,KAAK,CAACc,OAAO,CACxC,MAAMR,cAAc,EACpB,CAACS,IAAI,CAACC,SAAS,CAACV,cAAc,CAAC,CACjC,CAAC;EAED,MAAMW,eAAe,GAAGjB,KAAK,CAACc,OAAO,CACnC,MAAMP,SAAS,EACf,CAACQ,IAAI,CAACC,SAAS,CAACT,SAAS,CAAC,CAC5B,CAAC;EAED,MAAM;IAAEW,SAAS;IAAEC;EAAY,CAAC,GAAGnB,KAAK,CAACc,OAAO,CAC9C,MACEb,iBAAiB,CACdmB,QAAQ,IACPX,gBAAgB,CAACY,kBAAkB,CACjC;IACEjB,IAAI,EAAEA,IAAI;IACVC,KAAK,EAAEM,UAAU;IACjBL,cAAc,EAAEO,oBAAoB;IACpCN,SAAS,EAAEU,eAAe;IAC1BK,cAAc,EAAEd,gBAAgB,IAAI;EACtC,CAAC,EACDY,QACF,CAAC,EACHG,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,GACjC,eAAerB,IAAI,CAACsB,OAAO,IAAIX,IAAI,CAACC,SAAS,CAACL,UAAU,CAAC,EAAE,GAC3D,KAAK,CACX,CAAC,EACH,CACEF,gBAAgB,EAChBL,IAAI,CAACsB,OAAO,EACZtB,IAAI,CAACA,IAAI,EACTO,UAAU,EACVE,oBAAoB,EACpBI,eAAe,EACfT,gBAAgB,CAEpB,CAAC;EAED,MAAMmB,OAAO,GAAG3B,KAAK,CAAC4B,oBAAoB,CAACV,SAAS,EAAEC,WAAW,CAAC;EAElE,IAAIU,KAAwB;EAC5B,IAAIF,OAAO,IAAI,OAAO,IAAIA,OAAO,IAAIA,OAAO,CAACE,KAAK,EAAE;IAClDA,KAAK,GAAGF,OAAO,CAACE,KAAK;EACvB,CAAC,MAAM,IAAIF,OAAO,EAAEG,MAAM,KAAK,OAAO,EAAE;IACtCD,KAAK,GAAG,IAAIE,KAAK,CAAC,+BAA+B,CAAC;EACpD;EAEA,MAAMC,OAAO,GAAGhC,KAAK,CAACiC,WAAW,CAAC,YAAY;IAC5C,MAAMxB,gBAAgB,CAACyB,oBAAoB,CAAC9B,IAAI,CAACsB,OAAO,CAAC;EAC3D,CAAC,EAAE,CAACjB,gBAAgB,EAAEL,IAAI,CAACsB,OAAO,CAAC,CAAC;EAEpC,OAAO;IACLS,IAAI,EAAER,OAAO,EAAES,MAA+C;IAC9DC,SAAS,EAAEV,OAAO,EAAEG,MAAM,KAAK,SAAS;IACxCD,KAAK;IACLG;EACF,CAAC;AACH","ignoreList":[]}