@osdk/react 0.9.0-beta.6 → 0.9.0-beta.8

package/AGENTS.md

@@ -0,0 +1,253 @@
+# @osdk/react - AI Agent Instructions
+
+## Critical Rules
+
+1. **Use `OsdkProvider2`** - Not `OsdkProvider`. All modern hooks require `OsdkProvider2`.
+2. **Import from `@osdk/react/experimental`** - Not `@osdk/react`. The main entry point only has legacy hooks.
+3. **Never conditionally call hooks** - Use the `enabled` option instead.
+4. **Keep rendering during loading** - No early returns like `if (isLoading) return <Spinner />`. Show loading indicators while rendering existing data.
+
+## Exports
+
+**Stable** (`@osdk/react`):
+
+- `OsdkProvider` - Legacy provider
+- `useOsdkClient` - Access client
+- `useOsdkMetadata` - Fetch metadata
+
+**Experimental** (`@osdk/react/experimental`):
+
+- `OsdkProvider2` - Modern provider (use this)
+- `useOsdkObjects` - Query lists of objects
+- `useOsdkObject` - Query single object by type+key or instance
+- `useOsdkAction` - Execute and validate actions
+- `useLinks` - Navigate object relationships
+- `useObjectSet` - Advanced set operations (union, intersect, subtract, pivot)
+- `useOsdkAggregation` - Server-side aggregations with groupBy/select
+- `useCurrentFoundryUser`, `useFoundryUser`, `useFoundryUsersList` - Platform APIs
+- `useOsdkClient`, `useOsdkMetadata` - Also available from experimental
+
+## Correct Patterns
+
+### Loading States
+
+```tsx
+import { Todo } from "@my/osdk";
+import { useOsdkObjects } from "@osdk/react/experimental";
+
+function TodoList() {
+  const { data, isLoading, error } = useOsdkObjects(Todo);
+
+  return (
+    <div>
+      {isLoading && <LoadingIndicator />}
+      {error && <ErrorMessage error={error} />}
+      {data?.map(todo => <TodoItem key={todo.$primaryKey} todo={todo} />)}
+    </div>
+  );
+}
+```
+
+### Single Object (useOsdkObject)
+
+```tsx
+import { Employee } from "@my/osdk";
+import { useOsdkObject } from "@osdk/react/experimental";
+
+// By type + primary key (enabled is 3rd positional param)
+const { object, isLoading, error, isOptimistic } = useOsdkObject(
+  Employee,
+  "employee-123",
+  true, // enabled (optional, defaults to true)
+);
+
+// By existing instance (enabled is 2nd positional param)
+const { object: refreshed } = useOsdkObject(existingEmployee, true);
+```
+
+### Conditional Fetching
+
+```tsx
+// useOsdkObjects uses options object
+const { data: reports } = useOsdkObjects(Employee, {
+  where: { managerId: selectedManagerId },
+  enabled: !!selectedManagerId,
+});
+
+// useOsdkObject uses positional enabled parameter
+const { object: manager } = useOsdkObject(Employee, managerId, !!managerId);
+```
+
+### Actions (useOsdkAction)
+
+```tsx
+import { $Actions } from "@my/osdk";
+import { useOsdkAction } from "@osdk/react/experimental";
+
+function CompleteTodoButton({ todo }) {
+  const {
+    applyAction,
+    validateAction,
+    isPending,
+    isValidating,
+    error,
+    data,
+    validationResult,
+  } = useOsdkAction($Actions.completeTodo);
+
+  // Validate before applying
+  const handleValidate = async () => {
+    const result = await validateAction({ todo, isComplete: true });
+  };
+
+  // Apply the action
+  const handleComplete = async () => {
+    await applyAction({ todo, isComplete: true });
+  };
+
+  // With optimistic update (use $ prefix for client options)
+  const handleOptimistic = async () => {
+    await applyAction({
+      todo,
+      isComplete: true,
+      $optimisticUpdate: (ctx) => {
+        ctx.updateObject(todo, { isComplete: true });
+      },
+    });
+  };
+
+  return (
+    <button onClick={handleComplete} disabled={isPending}>
+      Complete
+    </button>
+  );
+}
+```
+
+### Links (useLinks)
+
+```tsx
+import { useLinks } from "@osdk/react/experimental";
+
+// Single object
+const { links, isLoading, hasMore, fetchMore, error } = useLinks(
+  employee,
+  "directReports",
+  { pageSize: 20 },
+);
+
+// Multiple objects (returns all linked objects)
+const { links: allReports } = useLinks(
+  [employee1, employee2],
+  "directReports",
+);
+```
+
+### Object Set Operations (useObjectSet)
+
+```tsx
+import { Employee } from "@my/osdk";
+import { useObjectSet } from "@osdk/react/experimental";
+
+const { data, isLoading, fetchMore, objectSet } = useObjectSet(
+  Employee.all(),
+  {
+    where: { department: "Engineering" },
+    orderBy: { hireDate: "desc" },
+    pageSize: 50,
+    union: [otherObjectSet],
+    intersect: [anotherObjectSet],
+    autoFetchMore: 100, // fetch until 100 items
+    streamUpdates: true,
+    enabled: true,
+  },
+);
+```
+
+### Aggregations (useOsdkAggregation)
+
+```tsx
+import { Employee } from "@my/osdk";
+import { useOsdkAggregation } from "@osdk/react/experimental";
+
+const { data, isLoading, error, refetch } = useOsdkAggregation(Employee, {
+  where: { department: "Engineering" },
+  aggregate: {
+    groupBy: { department: "exact" },
+    select: {
+      avgSalary: { $avg: "salary" },
+      count: { $count: {} },
+    },
+  },
+});
+```
+
+## Anti-Patterns
+
+### Wrong: Conditional Hook Call
+
+```tsx
+if (shouldLoad) {
+  const { data } = useOsdkObjects(Todo); // NEVER do this
+}
+```
+
+### Wrong: Early Return During Loading
+
+```tsx
+if (isLoading) return <Spinner />; // Causes UI flashing
+if (!data) return null; // Loses state
+```
+
+### Wrong: Importing from Main Entry
+
+```tsx
+import { useOsdkObjects } from "@osdk/react"; // WRONG - doesn't exist here
+```
+
+### Wrong: Using OsdkProvider Instead of OsdkProvider2
+
+```tsx
+<OsdkProvider client={client}> // WRONG - new hooks won't work
+```
+
+### Wrong: Using options object for useOsdkObject enabled
+
+```tsx
+// WRONG - enabled is positional, not in options
+const { object } = useOsdkObject(Employee, id, { enabled: false });
+
+// CORRECT
+const { object } = useOsdkObject(Employee, id, false);
+```
+
+## Hook Options Reference
+
+**useOsdkObjects / useObjectSet:**
+
+- `where` - Filter conditions
+- `orderBy` - Sort order (`{ field: "asc" | "desc" }`)
+- `pageSize` - Results per page
+- `withProperties` - Derived properties
+- `enabled` - Enable/disable query
+- `autoFetchMore` - Auto-pagination (`true` | `number`)
+- `dedupeIntervalMs` - Request deduplication
+- `streamUpdates` - WebSocket updates
+
+**useObjectSet additional:**
+
+- `union`, `intersect`, `subtract` - Set operations
+- `pivotTo` - Pivot to linked type
+
+**useOsdkObject:**
+
+- `enabled` is a **positional parameter**, not in options
+
+**useLinks:**
+
+- `where`, `pageSize`, `enabled`
+- `mode` - `"force"` | `"offline"`
+
+**useOsdkAction:**
+
+- `$optimisticUpdate` - Passed to action with `$` prefix

package/CHANGELOG.md

@@ -1,5 +1,36 @@
 # @osdkkit/react
 
+## 0.9.0-beta.8
+
+### Minor Changes
+
+- 74e3ba7: Preserve aggregate option literal types in useOsdkAggregation using const type parameter
+
+### Patch Changes
+
+- Updated dependencies [3fc5fe6]
+- Updated dependencies [bb9d25c]
+  - @osdk/client@2.7.0-beta.12
+  - @osdk/api@2.7.0-beta.12
+
+## 0.9.0-beta.7
+
+### Minor Changes
+
+- acf6331: Include AGENTS.md and docs directory in published package for improved AI assistant support
+- 6cfe14a: add new useOsdkFunction hook and supporting client infrastructure
+- 38d5958: fix order by via key stabilization
+- 56ba08f: support interfaces for osdk react hooks
+
+### Patch Changes
+
+- Updated dependencies [6cfe14a]
+- Updated dependencies [ec6ad57]
+- Updated dependencies [38d5958]
+- Updated dependencies [d5cfc38]
+  - @osdk/client@2.7.0-beta.11
+  - @osdk/api@2.7.0-beta.11
+
 ## 0.9.0-beta.6
 
 ### Minor Changes

package/build/browser/intellisense.test.js

@@ -90,7 +90,7 @@ describe("intellisense", () => {
       throw error;
     }
   });
-  afterEach(async () => {
+  afterEach(() => {
     if (tsServer) {
       tsServer.stop();
       tsServer = undefined;

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

@@ -1 +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":[]}
+{"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(() => {\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,MAAM;IACd,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/useLinks.js.map

@@ -1 +1 @@
-{"version":3,"file":"useLinks.js","names":["React","makeExternalStore","OsdkContext2","emptyArray","Object","freeze","useLinks","objects","linkName","options","observableClient","useContext","enabled","otherOptions","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: enabled\n      ? (payload?.status === \"loading\" || payload?.status === \"init\"\n        || !payload)\n      : false,\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,EAAEzB,OAAO,GACbqB,OAAO,EAAEK,MAAM,KAAK,SAAS,IAAIL,OAAO,EAAEK,MAAM,KAAK,MAAM,IACzD,CAACL,OAAO,GACX,KAAK;IACTM,YAAY,EAAEN,OAAO,EAAEM,YAAY,IAAI,KAAK;IAC5CC,KAAK,EAAEP,OAAO,EAAEO,KAAK;IACrBC,SAAS,EAAER,OAAO,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 {\n  LinkedType,\n  LinkNames,\n  ObjectOrInterfaceDefinition,\n} from \"@osdk/api\";\nimport type { Osdk, PropertyKeys, WhereClause } from \"@osdk/client\";\nimport type { ObserveLinks } from \"@osdk/client/unstable-do-not-use\";\nimport React from \"react\";\nimport { makeExternalStore } from \"./makeExternalStore.js\";\nimport { OsdkContext2 } from \"./OsdkContext2.js\";\n\nexport interface UseLinksOptions<\n  T extends ObjectOrInterfaceDefinition,\n> {\n  /**\n   * Standard OSDK Where clause for filtering linked objects\n   */\n  where?: WhereClause<T>;\n\n  /**\n   * The preferred page size for the links list.\n   */\n  pageSize?: number;\n\n  /** Sorting options for the linked objects */\n  orderBy?: {\n    [K in PropertyKeys<T>]?: \"asc\" | \"desc\";\n  };\n\n  /**\n   * The mode to use for fetching data.\n   * - undefined: Fetch data if not already in cache\n   * - \"force\": Always fetch fresh data\n   * - \"offline\": Only use cached data, don't make network requests\n   */\n  mode?: \"force\" | \"offline\";\n\n  /**\n   * Enable or disable the query.\n   *\n   * When `false`, the query will not automatically execute. It will still\n   * return any cached data, but will not fetch from the server.\n   *\n   * This is useful for:\n   * - Lazy/on-demand queries that should wait for user interaction\n   * - Dependent queries that need data from another query first\n   * - Conditional queries based on component state\n   *\n   * @default true\n   * @example\n   * // Dependent query - wait for employee data\n   * const { object: employee } = useOsdkObject(Employee, employeeId);\n   * const { links: reports } = useLinks(employee, \"reports\", {\n   *   enabled: !!employee\n   * });\n   */\n  enabled?: boolean;\n}\n\nexport interface UseLinksResult<\n  Q extends ObjectOrInterfaceDefinition,\n> {\n  links: Osdk.Instance<Q>[] | undefined;\n  isLoading: boolean;\n  error: Error | undefined;\n\n  /**\n   * Refers to whether the links are optimistic or not.\n   */\n  isOptimistic: boolean;\n\n  /**\n   * Fetch more linked objects if pagination is supported\n   */\n  fetchMore: (() => Promise<unknown>) | undefined;\n\n  /**\n   * Indicates if there are more linked objects available to fetch\n   */\n  hasMore: boolean;\n}\n\nconst emptyArray = Object.freeze([]);\n\n/**\n * Hook to observe links from an object or array of objects.\n *\n * @param objects The source object(s) to observe links from\n * @param linkName The name of the link to observe\n * @param options Optional configuration for the link query\n * @returns UseLinksResult with links data and metadata\n */\nexport function useLinks<\n  T extends ObjectOrInterfaceDefinition,\n  L extends LinkNames<T>,\n>(\n  objects: Osdk.Instance<T> | Array<Osdk.Instance<T>> | undefined,\n  linkName: L,\n  options: UseLinksOptions<LinkedType<T, L>> = {},\n): UseLinksResult<LinkedType<T, L>> {\n  const { observableClient } = React.useContext(OsdkContext2);\n\n  const { enabled = true, ...otherOptions } = options;\n\n  // 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: enabled\n      ? (payload?.status === \"loading\" || payload?.status === \"init\"\n        || !payload)\n      : false,\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;;AASA,OAAOA,KAAK,MAAM,OAAO;AACzB,SAASC,iBAAiB,QAAQ,wBAAwB;AAC1D,SAASC,YAAY,QAAQ,mBAAmB;AAyEhD,MAAMC,UAAU,GAAGC,MAAM,CAACC,MAAM,CAAC,EAAE,CAAC;;AAEpC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,QAAQA,CAItBC,OAA+D,EAC/DC,QAAW,EACXC,OAA0C,GAAG,CAAC,CAAC,EACb;EAClC,MAAM;IAAEC;EAAiB,CAAC,GAAGV,KAAK,CAACW,UAAU,CAACT,YAAY,CAAC;EAE3D,MAAM;IAAEU,OAAO,GAAG,IAAI;IAAE,GAAGC;EAAa,CAAC,GAAGJ,OAAO;;EAEnD;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,EAAEzB,OAAO,GACbqB,OAAO,EAAEK,MAAM,KAAK,SAAS,IAAIL,OAAO,EAAEK,MAAM,KAAK,MAAM,IACzD,CAACL,OAAO,GACX,KAAK;IACTM,YAAY,EAAEN,OAAO,EAAEM,YAAY,IAAI,KAAK;IAC5CC,KAAK,EAAEP,OAAO,EAAEO,KAAK;IACrBC,SAAS,EAAER,OAAO,EAAEQ,SAAS;IAC7BC,OAAO,EAAET,OAAO,EAAES,OAAO,IAAI;EAC/B,CAAC;AACH","ignoreList":[]}

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

@@ -1 +1 @@
-{"version":3,"file":"useOsdkAggregation.js","names":["React","makeExternalStore","OsdkContext2","useOsdkAggregation","type","where","withProperties","aggregate","dedupeIntervalMs","observableClient","useContext","canonWhere","canonicalizeWhereClause","stableWithProperties","useMemo","JSON","stringify","stableAggregate","subscribe","getSnapShot","observer","observeAggregation","dedupeInterval","process","env","NODE_ENV","apiName","payload","useSyncExternalStore","error","status","Error","refetch","useCallback","invalidateObjectType","data","result","isLoading"],"sources":["useOsdkAggregation.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n  AggregateOpts,\n  AggregationsResults,\n  DerivedProperty,\n  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\" || payload?.status === \"init\"\n      || !payload,\n    error,\n    refetch,\n  };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;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,IAAIH,OAAO,EAAEG,MAAM,KAAK,MAAM,IACjE,CAACH,OAAO;IACbE,KAAK;IACLG;EACF,CAAC;AACH","ignoreList":[]}
+{"version":3,"file":"useOsdkAggregation.js","names":["React","makeExternalStore","OsdkContext2","useOsdkAggregation","type","where","withProperties","aggregate","dedupeIntervalMs","observableClient","useContext","canonWhere","canonicalizeWhereClause","stableWithProperties","useMemo","JSON","stringify","stableAggregate","subscribe","getSnapShot","observer","observeAggregation","dedupeInterval","process","env","NODE_ENV","apiName","payload","useSyncExternalStore","error","status","Error","refetch","useCallback","invalidateObjectType","data","result","isLoading"],"sources":["useOsdkAggregation.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n  AggregateOpts,\n  AggregationsResults,\n  DerivedProperty,\n  ObjectOrInterfaceDefinition,\n  WhereClause,\n} from \"@osdk/api\";\nimport type { ObserveAggregationArgs } from \"@osdk/client/unstable-do-not-use\";\nimport React from \"react\";\nimport { makeExternalStore } from \"./makeExternalStore.js\";\nimport { OsdkContext2 } from \"./OsdkContext2.js\";\nimport type { InferRdpTypes } from \"./types.js\";\n\nexport interface UseOsdkAggregationOptions<\n  T extends ObjectOrInterfaceDefinition,\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 ObjectOrInterfaceDefinition,\n  A extends AggregateOpts<T>,\n> {\n  data: AggregationsResults<T, A> | undefined;\n  isLoading: boolean;\n  error: Error | undefined;\n  refetch: () => void;\n}\n\ndeclare const process: {\n  env: {\n    NODE_ENV: \"development\" | \"production\";\n  };\n};\n\n/**\n * React hook for performing aggregations on OSDK object sets.\n *\n * Executes server-side aggregations with groupBy and metric calculations on filtered object sets.\n * Supports runtime derived properties and where clauses.\n *\n * @param type - The object or interface type to aggregate\n * @param options - Aggregation configuration including where clause, aggregation spec, and optional derived properties\n * @returns Object containing aggregation results, loading state, error state, and refetch function\n *\n * @example\n * ```tsx\n * const { data, isLoading, error } = useOsdkAggregation(Employee, {\n *   where: { department: \"Engineering\" },\n *   aggregate: {\n *     groupBy: { department: \"exact\" },\n *     select: {\n *       avgSalary: { $avg: \"salary\" },\n *       count: { $count: {} }\n *     }\n *   }\n * });\n * ```\n */\nexport function useOsdkAggregation<\n  Q extends ObjectOrInterfaceDefinition,\n  const A extends AggregateOpts<Q>,\n  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\" || payload?.status === \"init\"\n      || !payload,\n    error,\n    refetch,\n  };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;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,IAAIH,OAAO,EAAEG,MAAM,KAAK,MAAM,IACjE,CAACH,OAAO;IACbE,KAAK;IACLG;EACF,CAAC;AACH","ignoreList":[]}

package/build/browser/new/useOsdkFunction.js

@@ -0,0 +1,101 @@
+/*
+ * 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 executing and observing OSDK functions.
+ *
+ * Provides automatic caching, deduplication, and reactive updates for function calls.
+ * Functions are automatically re-fetched when dependencies change (configured via options).
+ *
+ * @param queryDef - The QueryDefinition to execute
+ * @param options - Configuration options for the function call
+ * @returns Object containing result, loading state, error, and refetch function
+ *
+ * @example Basic usage
+ * ```tsx
+ * const { data, isLoading, error } = useOsdkFunction(getEmployeeStats, {
+ *   params: { departmentId: "engineering" }
+ * });
+ * ```
+ *
+ * @example With dependency tracking
+ * ```tsx
+ * const { data, refetch } = useOsdkFunction(calculateMetrics, {
+ *   params: { startDate, endDate },
+ *   dependsOn: [Employee, Project],
+ * });
+ * ```
+ *
+ * @example With specific object dependencies
+ * ```tsx
+ * const { data } = useOsdkFunction(getEmployeeReport, {
+ *   params: { employeeId: employee.$primaryKey },
+ *   dependsOnObjects: [employee],
+ * });
+ * ```
+ */
+export function useOsdkFunction(queryDef, options = {}) {
+  const {
+    observableClient
+  } = React.useContext(OsdkContext2);
+  const {
+    params,
+    dependsOn,
+    dependsOnObjects,
+    dedupeIntervalMs,
+    enabled = true
+  } = options;
+  const stableParams = React.useMemo(() => params, [JSON.stringify(params)]);
+  const stableDependsOn = React.useMemo(() => dependsOn, [JSON.stringify(dependsOn?.map(d => typeof d === "string" ? d : d.apiName))]);
+  const stableDependsOnObjects = React.useMemo(() => dependsOnObjects, [JSON.stringify(dependsOnObjects?.map(o => ({
+    $apiName: o.$apiName,
+    $primaryKey: o.$primaryKey
+  })))]);
+
+  // Record<string, unknown> required as typing is figured out at runtime
+  const paramsForApi = stableParams;
+  const {
+    subscribe,
+    getSnapShot
+  } = React.useMemo(() => {
+    if (!enabled) {
+      return makeExternalStore(() => ({
+        unsubscribe: () => {}
+      }), process.env.NODE_ENV !== "production" ? `function ${queryDef.apiName} ${JSON.stringify(stableParams)} [DISABLED]` : void 0);
+    }
+    return makeExternalStore(observer => observableClient.observeFunction(queryDef, paramsForApi, {
+      dependsOn: stableDependsOn,
+      dependsOnObjects: stableDependsOnObjects,
+      dedupeInterval: dedupeIntervalMs ?? 2_000
+    }, observer), process.env.NODE_ENV !== "production" ? `function ${queryDef.apiName} ${JSON.stringify(stableParams)}` : void 0);
+  }, [observableClient, queryDef.apiName, queryDef.version, paramsForApi, stableDependsOn, stableDependsOnObjects, dedupeIntervalMs, enabled]);
+  const payload = React.useSyncExternalStore(subscribe, getSnapShot);
+  const error = payload?.error ?? (payload?.status === "error" ? new Error("Failed to execute function") : undefined);
+  const refetch = React.useCallback(() => {
+    void observableClient.invalidateFunction(queryDef, paramsForApi);
+  }, [observableClient, queryDef, paramsForApi]);
+  return {
+    data: payload?.result,
+    isLoading: payload?.status === "loading",
+    error,
+    lastUpdated: payload?.lastUpdated ?? 0,
+    refetch
+  };
+}
+//# sourceMappingURL=useOsdkFunction.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useOsdkFunction.js","names":["React","makeExternalStore","OsdkContext2","useOsdkFunction","queryDef","options","observableClient","useContext","params","dependsOn","dependsOnObjects","dedupeIntervalMs","enabled","stableParams","useMemo","JSON","stringify","stableDependsOn","map","d","apiName","stableDependsOnObjects","o","$apiName","$primaryKey","paramsForApi","subscribe","getSnapShot","unsubscribe","process","env","NODE_ENV","observer","observeFunction","dedupeInterval","version","payload","useSyncExternalStore","error","status","Error","undefined","refetch","useCallback","invalidateFunction","data","result","isLoading","lastUpdated"],"sources":["useOsdkFunction.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n  CompileTimeMetadata,\n  ObjectTypeDefinition,\n  Osdk,\n  QueryDefinition,\n} from \"@osdk/api\";\nimport type {\n  ObserveFunctionCallbackArgs,\n  QueryParameterType,\n  QueryReturnType,\n} from \"@osdk/client/unstable-do-not-use\";\nimport React from \"react\";\nimport { makeExternalStore } from \"./makeExternalStore.js\";\nimport { OsdkContext2 } from \"./OsdkContext2.js\";\n\nexport interface UseOsdkFunctionOptions<Q extends QueryDefinition<unknown>> {\n  /**\n   * Parameters to pass to the function.\n   * Must include all required parameters; optional parameters can be omitted.\n   */\n  params?: CompileTimeMetadata<Q>[\"parameters\"] extends Record<string, never>\n    ? undefined\n    : QueryParameterType<CompileTimeMetadata<Q>[\"parameters\"]>;\n\n  /**\n   * Object types this function depends on.\n   * When actions modify objects of these types, the function will automatically refetch.\n   *\n   * @example\n   * ```tsx\n   * // Refetch when any Employee object changes\n   * { dependsOn: [Employee] }\n   * ```\n   */\n  dependsOn?: Array<ObjectTypeDefinition | string>;\n\n  /**\n   * Specific object instances this function depends on.\n   * When any of these specific objects change, the function will refetch.\n   * More fine-grained than dependsOn for precise invalidation control.\n   *\n   * @example\n   * ```tsx\n   * // Refetch when this specific employee changes\n   * { dependsOnObjects: [employee] }\n   * ```\n   */\n  dependsOnObjects?: Array<Osdk.Instance<ObjectTypeDefinition>>;\n\n  /**\n   * The number of milliseconds to dedupe identical function calls.\n   * Two calls with the same function and params will share results\n   * if the second call is within this interval of the first.\n   * @default 2000\n   */\n  dedupeIntervalMs?: number;\n\n  /**\n   * Whether to enable the query. When false, the query will not execute.\n   * Useful for:\n   * - Dependent queries that need to wait for other data\n   * - Conditional queries based on component state\n   *\n   * @default true\n   * @example\n   * // Dependent query - wait for required data\n   * const { data: employee } = useOsdkObject(Employee, employeeId);\n   * const { data: report } = useOsdkFunction(getEmployeeReport, {\n   *   params: { employeeId: employee?.$primaryKey },\n   *   enabled: !!employee\n   * });\n   */\n  enabled?: boolean;\n}\n\nexport interface UseOsdkFunctionResult<Q extends QueryDefinition<unknown>> {\n  /**\n   * The function result, or undefined if not yet loaded or on error.\n   */\n  data: QueryReturnType<CompileTimeMetadata<Q>[\"output\"]> | undefined;\n\n  /**\n   * True while the function is executing.\n   */\n  isLoading: boolean;\n\n  /**\n   * Error if the function execution failed.\n   */\n  error: Error | undefined;\n\n  /**\n   * Timestamp (ms since epoch) of when the result was last fetched.\n   */\n  lastUpdated: number;\n\n  /**\n   * Manually refetch the function.\n   * Useful for \"pull to refresh\" or retry patterns.\n   */\n  refetch: () => void;\n}\n\ndeclare const process: {\n  env: {\n    NODE_ENV: \"development\" | \"production\";\n  };\n};\n\n/**\n * React hook for executing and observing OSDK functions.\n *\n * Provides automatic caching, deduplication, and reactive updates for function calls.\n * Functions are automatically re-fetched when dependencies change (configured via options).\n *\n * @param queryDef - The QueryDefinition to execute\n * @param options - Configuration options for the function call\n * @returns Object containing result, loading state, error, and refetch function\n *\n * @example Basic usage\n * ```tsx\n * const { data, isLoading, error } = useOsdkFunction(getEmployeeStats, {\n *   params: { departmentId: \"engineering\" }\n * });\n * ```\n *\n * @example With dependency tracking\n * ```tsx\n * const { data, refetch } = useOsdkFunction(calculateMetrics, {\n *   params: { startDate, endDate },\n *   dependsOn: [Employee, Project],\n * });\n * ```\n *\n * @example With specific object dependencies\n * ```tsx\n * const { data } = useOsdkFunction(getEmployeeReport, {\n *   params: { employeeId: employee.$primaryKey },\n *   dependsOnObjects: [employee],\n * });\n * ```\n */\nexport function useOsdkFunction<Q extends QueryDefinition<unknown>>(\n  queryDef: Q,\n  options: UseOsdkFunctionOptions<Q> = {},\n): UseOsdkFunctionResult<Q> {\n  const { observableClient } = React.useContext(OsdkContext2);\n  const {\n    params,\n    dependsOn,\n    dependsOnObjects,\n    dedupeIntervalMs,\n    enabled = true,\n  } = options;\n\n  const stableParams = React.useMemo(\n    () => params,\n    [JSON.stringify(params)],\n  );\n  const stableDependsOn = React.useMemo(\n    () => dependsOn,\n    [JSON.stringify(\n      dependsOn?.map(d => typeof d === \"string\" ? d : d.apiName),\n    )],\n  );\n  const stableDependsOnObjects = React.useMemo(\n    () => dependsOnObjects,\n    [JSON.stringify(\n      dependsOnObjects?.map(o => ({\n        $apiName: o.$apiName,\n        $primaryKey: o.$primaryKey,\n      })),\n    )],\n  );\n\n  // Record<string, unknown> required as typing is figured out at runtime\n  const paramsForApi = stableParams as Record<string, unknown> | undefined;\n\n  const { subscribe, getSnapShot } = React.useMemo(\n    () => {\n      if (!enabled) {\n        return makeExternalStore<ObserveFunctionCallbackArgs<Q>>(\n          () => ({ unsubscribe: () => {} }),\n          process.env.NODE_ENV !== \"production\"\n            ? `function ${queryDef.apiName} ${\n              JSON.stringify(stableParams)\n            } [DISABLED]`\n            : void 0,\n        );\n      }\n      return makeExternalStore<ObserveFunctionCallbackArgs<Q>>(\n        (observer) =>\n          observableClient.observeFunction(\n            queryDef,\n            paramsForApi,\n            {\n              dependsOn: stableDependsOn,\n              dependsOnObjects: stableDependsOnObjects,\n              dedupeInterval: dedupeIntervalMs ?? 2_000,\n            },\n            observer,\n          ),\n        process.env.NODE_ENV !== \"production\"\n          ? `function ${queryDef.apiName} ${JSON.stringify(stableParams)}`\n          : void 0,\n      );\n    },\n    [\n      observableClient,\n      queryDef.apiName,\n      queryDef.version,\n      paramsForApi,\n      stableDependsOn,\n      stableDependsOnObjects,\n      dedupeIntervalMs,\n      enabled,\n    ],\n  );\n\n  const payload = React.useSyncExternalStore(subscribe, getSnapShot);\n\n  const error = payload?.error\n    ?? (payload?.status === \"error\"\n      ? new Error(\"Failed to execute function\")\n      : undefined);\n\n  const refetch = React.useCallback(() => {\n    void observableClient.invalidateFunction(queryDef, paramsForApi);\n  }, [observableClient, queryDef, paramsForApi]);\n\n  return {\n    data: payload?.result as\n      | QueryReturnType<CompileTimeMetadata<Q>[\"output\"]>\n      | undefined,\n    isLoading: payload?.status === \"loading\",\n    error,\n    lastUpdated: payload?.lastUpdated ?? 0,\n    refetch,\n  };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAaA,OAAOA,KAAK,MAAM,OAAO;AACzB,SAASC,iBAAiB,QAAQ,wBAAwB;AAC1D,SAASC,YAAY,QAAQ,mBAAmB;AAgGhD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,eAAeA,CAC7BC,QAAW,EACXC,OAAkC,GAAG,CAAC,CAAC,EACb;EAC1B,MAAM;IAAEC;EAAiB,CAAC,GAAGN,KAAK,CAACO,UAAU,CAACL,YAAY,CAAC;EAC3D,MAAM;IACJM,MAAM;IACNC,SAAS;IACTC,gBAAgB;IAChBC,gBAAgB;IAChBC,OAAO,GAAG;EACZ,CAAC,GAAGP,OAAO;EAEX,MAAMQ,YAAY,GAAGb,KAAK,CAACc,OAAO,CAChC,MAAMN,MAAM,EACZ,CAACO,IAAI,CAACC,SAAS,CAACR,MAAM,CAAC,CACzB,CAAC;EACD,MAAMS,eAAe,GAAGjB,KAAK,CAACc,OAAO,CACnC,MAAML,SAAS,EACf,CAACM,IAAI,CAACC,SAAS,CACbP,SAAS,EAAES,GAAG,CAACC,CAAC,IAAI,OAAOA,CAAC,KAAK,QAAQ,GAAGA,CAAC,GAAGA,CAAC,CAACC,OAAO,CAC3D,CAAC,CACH,CAAC;EACD,MAAMC,sBAAsB,GAAGrB,KAAK,CAACc,OAAO,CAC1C,MAAMJ,gBAAgB,EACtB,CAACK,IAAI,CAACC,SAAS,CACbN,gBAAgB,EAAEQ,GAAG,CAACI,CAAC,KAAK;IAC1BC,QAAQ,EAAED,CAAC,CAACC,QAAQ;IACpBC,WAAW,EAAEF,CAAC,CAACE;EACjB,CAAC,CAAC,CACJ,CAAC,CACH,CAAC;;EAED;EACA,MAAMC,YAAY,GAAGZ,YAAmD;EAExE,MAAM;IAAEa,SAAS;IAAEC;EAAY,CAAC,GAAG3B,KAAK,CAACc,OAAO,CAC9C,MAAM;IACJ,IAAI,CAACF,OAAO,EAAE;MACZ,OAAOX,iBAAiB,CACtB,OAAO;QAAE2B,WAAW,EAAEA,CAAA,KAAM,CAAC;MAAE,CAAC,CAAC,EACjCC,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,GACjC,YAAY3B,QAAQ,CAACgB,OAAO,IAC5BL,IAAI,CAACC,SAAS,CAACH,YAAY,CAAC,aACjB,GACX,KAAK,CACX,CAAC;IACH;IACA,OAAOZ,iBAAiB,CACrB+B,QAAQ,IACP1B,gBAAgB,CAAC2B,eAAe,CAC9B7B,QAAQ,EACRqB,YAAY,EACZ;MACEhB,SAAS,EAAEQ,eAAe;MAC1BP,gBAAgB,EAAEW,sBAAsB;MACxCa,cAAc,EAAEvB,gBAAgB,IAAI;IACtC,CAAC,EACDqB,QACF,CAAC,EACHH,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,GACjC,YAAY3B,QAAQ,CAACgB,OAAO,IAAIL,IAAI,CAACC,SAAS,CAACH,YAAY,CAAC,EAAE,GAC9D,KAAK,CACX,CAAC;EACH,CAAC,EACD,CACEP,gBAAgB,EAChBF,QAAQ,CAACgB,OAAO,EAChBhB,QAAQ,CAAC+B,OAAO,EAChBV,YAAY,EACZR,eAAe,EACfI,sBAAsB,EACtBV,gBAAgB,EAChBC,OAAO,CAEX,CAAC;EAED,MAAMwB,OAAO,GAAGpC,KAAK,CAACqC,oBAAoB,CAACX,SAAS,EAAEC,WAAW,CAAC;EAElE,MAAMW,KAAK,GAAGF,OAAO,EAAEE,KAAK,KACtBF,OAAO,EAAEG,MAAM,KAAK,OAAO,GAC3B,IAAIC,KAAK,CAAC,4BAA4B,CAAC,GACvCC,SAAS,CAAC;EAEhB,MAAMC,OAAO,GAAG1C,KAAK,CAAC2C,WAAW,CAAC,MAAM;IACtC,KAAKrC,gBAAgB,CAACsC,kBAAkB,CAACxC,QAAQ,EAAEqB,YAAY,CAAC;EAClE,CAAC,EAAE,CAACnB,gBAAgB,EAAEF,QAAQ,EAAEqB,YAAY,CAAC,CAAC;EAE9C,OAAO;IACLoB,IAAI,EAAET,OAAO,EAAEU,MAEF;IACbC,SAAS,EAAEX,OAAO,EAAEG,MAAM,KAAK,SAAS;IACxCD,KAAK;IACLU,WAAW,EAAEZ,OAAO,EAAEY,WAAW,IAAI,CAAC;IACtCN;EACF,CAAC;AACH","ignoreList":[]}

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

@@ -1 +1 @@
-{"version":3,"file":"useOsdkObjects.js","names":["React","makeExternalStore","OsdkContext2","useOsdkObjects","type","options","pageSize","orderBy","dedupeIntervalMs","where","streamUpdates","withProperties","autoFetchMore","intersectWith","pivotTo","enabled","observableClient","useContext","canonWhere","canonicalizeWhereClause","stableWithProperties","useMemo","JSON","stringify","stableIntersectWith","stableOrderBy","subscribe","getSnapShot","unsubscribe","process","env","NODE_ENV","apiName","observer","observeList","dedupeInterval","listPayload","useSyncExternalStore","error","status","Error","fetchMore","hasMore","undefined","data","resolvedList","isLoading","isOptimistic"],"sources":["useOsdkObjects.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  LinkedType,\n  LinkNames,\n  ObjectTypeDefinition,\n  Osdk,\n  PropertyKeys,\n  SimplePropertyDef,\n  WhereClause,\n} from \"@osdk/api\";\nimport type { ObserveObjectsCallbackArgs } 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 UseOsdkObjectsOptions<\n  T extends ObjectTypeDefinition | InterfaceDefinition,\n  WithProps extends DerivedProperty.Clause<T> | undefined = undefined,\n> {\n  /**\n   * Standard OSDK Where with RDP support\n   */\n  where?: WhereClause<T, InferRdpTypes<T, WithProps>>;\n\n  /**\n   *  The preferred page size for the list.\n   */\n  pageSize?: number;\n\n  /** */\n  orderBy?: {\n    [K in PropertyKeys<T>]?: \"asc\" | \"desc\";\n  };\n\n  /**\n   * Define derived properties (RDPs) to be computed server-side and attached to each object.\n   * These properties will be available on the returned objects alongside their regular properties.\n   */\n  withProperties?: WithProps;\n\n  /**\n   * Intersect the results with additional object sets.\n   * Each element defines a where clause for an object set to intersect with.\n   * The final result will only include objects that match ALL conditions.\n   */\n  intersectWith?: Array<{\n    where: WhereClause<T, InferRdpTypes<T, WithProps>>;\n  }>;\n\n  /**\n   * Pivot to related objects through a link.\n   * This changes the return type from T to the linked object type.\n   */\n  pivotTo?: LinkNames<T>;\n\n  /**\n   * Causes the list to automatically fetch more as soon as the previous page\n   * has been loaded. If a number is provided, it will continue to automatically\n   * fetch more until the list is at least that long.\n   *\n   * - `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   * Note: When using `autoFetchMore: true` with large datasets, the initial\n   * load may take significant time. Consider using a specific number instead\n   * or implementing virtual scrolling.\n   *\n   * @example\n   * // Fetch all todos at once\n   * const { data } = useOsdkObjects(Todo, { autoFetchMore: true })\n   *\n   * @example\n   * // Fetch at least 100 todos (with 25 per page, fetches 4 pages)\n   * const { data } = useOsdkObjects(Todo, {\n   *   autoFetchMore: 100,\n   *   pageSize: 25\n   * })\n   */\n  autoFetchMore?: boolean | number;\n\n  /**\n   * Upon a list being revalidated, this option determines how the component\n   * will be re-rendered with the data.\n   *\n   * An example to help understand the options:\n   *\n   * Suppose pageSize is 10 and we have called `fetchMore()` twice. The list is\n   * now 30 items long.\n   *\n   * Upon revalidation, we get the first 10 items of the list. The options behave\n   * as follows:\n   *\n   * - `\"in-place\"`: The first 10 items of the list are replaced with the new 10\n   *   items. The list is now 30 items long, but only the first 10 items are valid.\n   * - `\"wait\"`: The old list is returned until after the next 20 items are loaded\n   *   (which will happen automatically). The list is now 30 items long.\n   * - `\"reset\"`: The entire list is replaced with the new 10 items. The list is\n   *   now 10 items long.\n   */\n  // invalidationMode?: \"in-place\" | \"wait\" | \"reset\";\n\n  /**\n   * The number of milliseconds to wait after the last observed list change.\n   *\n   * Two uses of `useOsdkObjects` with the where clause will only trigger one\n   * network request if the second is within `dedupeIntervalMs`.\n   */\n  dedupeIntervalMs?: number;\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 parent data\n   * const { data: employee } = useOsdkObject(Employee, employeeId);\n   * const { data: reports } = useOsdkObjects(Employee, {\n   *   where: { managerId: employee?.id },\n   *   enabled: !!employee\n   * });\n   */\n  enabled?: boolean;\n}\n\nexport interface UseOsdkListResult<\n  T extends ObjectTypeDefinition | InterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> {\n  fetchMore: (() => Promise<void>) | undefined;\n  data:\n    | Osdk.Instance<T, \"$allBaseProperties\", PropertyKeys<T>, RDPs>[]\n    | undefined;\n  isLoading: boolean;\n\n  error: Error | undefined;\n\n  /**\n   * Refers to whether the ordered list of objects (only considering the $primaryKey)\n   * is optimistic or not.\n   *\n   * If you need to know if the contents of the list are optimistic you can\n   * do that on a per object basis with useOsdkObject\n   */\n  isOptimistic: boolean;\n}\n\ndeclare const process: {\n  env: {\n    NODE_ENV: \"development\" | \"production\";\n  };\n};\n\nexport function useOsdkObjects<\n  Q extends ObjectTypeDefinition,\n  L extends LinkNames<Q>,\n>(\n  type: Q,\n  options: UseOsdkObjectsOptions<Q> & { pivotTo: L },\n): UseOsdkListResult<LinkedType<Q, L>>;\n\nexport function useOsdkObjects<\n  Q extends ObjectTypeDefinition | InterfaceDefinition,\n  WP extends DerivedProperty.Clause<Q> | undefined,\n>(\n  type: Q,\n  options?: UseOsdkObjectsOptions<Q, WP>,\n): UseOsdkListResult<Q, InferRdpTypes<Q, WP>>;\n\nexport function useOsdkObjects<\n  Q extends ObjectTypeDefinition | InterfaceDefinition,\n  WP extends DerivedProperty.Clause<Q> | undefined,\n>(\n  type: Q,\n  options?: UseOsdkObjectsOptions<Q, WP>,\n):\n  | UseOsdkListResult<Q, InferRdpTypes<Q, WP>>\n  | UseOsdkListResult<LinkedType<Q, LinkNames<Q>>>\n{\n  const {\n    pageSize,\n    orderBy,\n    dedupeIntervalMs,\n    where = {},\n    streamUpdates,\n    withProperties,\n    autoFetchMore,\n    intersectWith,\n    pivotTo,\n    enabled = true,\n  } = options ?? {};\n  const { observableClient } = React.useContext(OsdkContext2);\n\n  /*  We want the canonical where clause so that the use of `React.useMemo`\n      is stable. No real added cost as we canonicalize internal to\n      the ObservableClient anyway.\n   */\n  const canonWhere = observableClient.canonicalizeWhereClause<\n    Q,\n    InferRdpTypes<Q, WP>\n  >(where ?? {});\n\n  const stableWithProperties = React.useMemo(\n    () => withProperties,\n    [JSON.stringify(withProperties)],\n  );\n\n  const stableIntersectWith = React.useMemo(\n    () => intersectWith,\n    [JSON.stringify(intersectWith)],\n  );\n\n  const stableOrderBy = React.useMemo(\n    () => orderBy,\n    [JSON.stringify(orderBy)],\n  );\n\n  const { subscribe, getSnapShot } = React.useMemo(\n    () => {\n      if (!enabled) {\n        return makeExternalStore<\n          ObserveObjectsCallbackArgs<Q, InferRdpTypes<Q, WP>>\n        >(\n          () => ({ unsubscribe: () => {} }),\n          process.env.NODE_ENV !== \"production\"\n            ? `list ${type.apiName} ${JSON.stringify(canonWhere)} [DISABLED]`\n            : void 0,\n        );\n      }\n      return makeExternalStore<\n        ObserveObjectsCallbackArgs<Q, InferRdpTypes<Q, WP>>\n      >(\n        (observer) =>\n          observableClient.observeList({\n            type,\n            where: canonWhere,\n            dedupeInterval: dedupeIntervalMs ?? 2_000,\n            pageSize,\n            orderBy: stableOrderBy,\n            streamUpdates,\n            withProperties: stableWithProperties,\n            autoFetchMore,\n            ...(stableIntersectWith\n              ? { intersectWith: stableIntersectWith }\n              : {}),\n            ...(pivotTo ? { pivotTo } : {}),\n          }, observer),\n        process.env.NODE_ENV !== \"production\"\n          ? `list ${type.apiName} ${JSON.stringify(canonWhere)}`\n          : void 0,\n      );\n    },\n    [\n      enabled,\n      observableClient,\n      type,\n      canonWhere,\n      dedupeIntervalMs,\n      pageSize,\n      stableOrderBy,\n      streamUpdates,\n      stableWithProperties,\n      autoFetchMore,\n      stableIntersectWith,\n      pivotTo,\n    ],\n  );\n\n  const listPayload = React.useSyncExternalStore(subscribe, getSnapShot);\n\n  let error: Error | undefined;\n  if (listPayload && \"error\" in listPayload && listPayload.error) {\n    error = listPayload.error;\n  } else if (listPayload?.status === \"error\") {\n    error = new Error(\"Failed to load objects\");\n  }\n\n  return {\n    fetchMore: listPayload?.hasMore ? listPayload.fetchMore : undefined,\n    error,\n    data: listPayload?.resolvedList,\n    isLoading: enabled\n      ? (listPayload?.status === \"loading\" || listPayload?.status === \"init\"\n        || !listPayload)\n      : false,\n    isOptimistic: listPayload?.isOptimistic ?? false,\n  };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAcA,OAAOA,KAAK,MAAM,OAAO;AACzB,SAASC,iBAAiB,QAAQ,wBAAwB;AAC1D,SAASC,YAAY,QAAQ,mBAAmB;AAuKhD,OAAO,SAASC,cAAcA,CAI5BC,IAAO,EACPC,OAAsC,EAIxC;EACE,MAAM;IACJC,QAAQ;IACRC,OAAO;IACPC,gBAAgB;IAChBC,KAAK,GAAG,CAAC,CAAC;IACVC,aAAa;IACbC,cAAc;IACdC,aAAa;IACbC,aAAa;IACbC,OAAO;IACPC,OAAO,GAAG;EACZ,CAAC,GAAGV,OAAO,IAAI,CAAC,CAAC;EACjB,MAAM;IAAEW;EAAiB,CAAC,GAAGhB,KAAK,CAACiB,UAAU,CAACf,YAAY,CAAC;;EAE3D;AACF;AACA;AACA;EACE,MAAMgB,UAAU,GAAGF,gBAAgB,CAACG,uBAAuB,CAGzDV,KAAK,IAAI,CAAC,CAAC,CAAC;EAEd,MAAMW,oBAAoB,GAAGpB,KAAK,CAACqB,OAAO,CACxC,MAAMV,cAAc,EACpB,CAACW,IAAI,CAACC,SAAS,CAACZ,cAAc,CAAC,CACjC,CAAC;EAED,MAAMa,mBAAmB,GAAGxB,KAAK,CAACqB,OAAO,CACvC,MAAMR,aAAa,EACnB,CAACS,IAAI,CAACC,SAAS,CAACV,aAAa,CAAC,CAChC,CAAC;EAED,MAAMY,aAAa,GAAGzB,KAAK,CAACqB,OAAO,CACjC,MAAMd,OAAO,EACb,CAACe,IAAI,CAACC,SAAS,CAAChB,OAAO,CAAC,CAC1B,CAAC;EAED,MAAM;IAAEmB,SAAS;IAAEC;EAAY,CAAC,GAAG3B,KAAK,CAACqB,OAAO,CAC9C,MAAM;IACJ,IAAI,CAACN,OAAO,EAAE;MACZ,OAAOd,iBAAiB,CAGtB,OAAO;QAAE2B,WAAW,EAAEA,CAAA,KAAM,CAAC;MAAE,CAAC,CAAC,EACjCC,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,GACjC,QAAQ3B,IAAI,CAAC4B,OAAO,IAAIV,IAAI,CAACC,SAAS,CAACL,UAAU,CAAC,aAAa,GAC/D,KAAK,CACX,CAAC;IACH;IACA,OAAOjB,iBAAiB,CAGrBgC,QAAQ,IACPjB,gBAAgB,CAACkB,WAAW,CAAC;MAC3B9B,IAAI;MACJK,KAAK,EAAES,UAAU;MACjBiB,cAAc,EAAE3B,gBAAgB,IAAI,KAAK;MACzCF,QAAQ;MACRC,OAAO,EAAEkB,aAAa;MACtBf,aAAa;MACbC,cAAc,EAAES,oBAAoB;MACpCR,aAAa;MACb,IAAIY,mBAAmB,GACnB;QAAEX,aAAa,EAAEW;MAAoB,CAAC,GACtC,CAAC,CAAC,CAAC;MACP,IAAIV,OAAO,GAAG;QAAEA;MAAQ,CAAC,GAAG,CAAC,CAAC;IAChC,CAAC,EAAEmB,QAAQ,CAAC,EACdJ,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,GACjC,QAAQ3B,IAAI,CAAC4B,OAAO,IAAIV,IAAI,CAACC,SAAS,CAACL,UAAU,CAAC,EAAE,GACpD,KAAK,CACX,CAAC;EACH,CAAC,EACD,CACEH,OAAO,EACPC,gBAAgB,EAChBZ,IAAI,EACJc,UAAU,EACVV,gBAAgB,EAChBF,QAAQ,EACRmB,aAAa,EACbf,aAAa,EACbU,oBAAoB,EACpBR,aAAa,EACbY,mBAAmB,EACnBV,OAAO,CAEX,CAAC;EAED,MAAMsB,WAAW,GAAGpC,KAAK,CAACqC,oBAAoB,CAACX,SAAS,EAAEC,WAAW,CAAC;EAEtE,IAAIW,KAAwB;EAC5B,IAAIF,WAAW,IAAI,OAAO,IAAIA,WAAW,IAAIA,WAAW,CAACE,KAAK,EAAE;IAC9DA,KAAK,GAAGF,WAAW,CAACE,KAAK;EAC3B,CAAC,MAAM,IAAIF,WAAW,EAAEG,MAAM,KAAK,OAAO,EAAE;IAC1CD,KAAK,GAAG,IAAIE,KAAK,CAAC,wBAAwB,CAAC;EAC7C;EAEA,OAAO;IACLC,SAAS,EAAEL,WAAW,EAAEM,OAAO,GAAGN,WAAW,CAACK,SAAS,GAAGE,SAAS;IACnEL,KAAK;IACLM,IAAI,EAAER,WAAW,EAAES,YAAY;IAC/BC,SAAS,EAAE/B,OAAO,GACbqB,WAAW,EAAEG,MAAM,KAAK,SAAS,IAAIH,WAAW,EAAEG,MAAM,KAAK,MAAM,IACjE,CAACH,WAAW,GACf,KAAK;IACTW,YAAY,EAAEX,WAAW,EAAEW,YAAY,IAAI;EAC7C,CAAC;AACH","ignoreList":[]}
+{"version":3,"file":"useOsdkObjects.js","names":["React","makeExternalStore","OsdkContext2","useOsdkObjects","type","options","pageSize","orderBy","dedupeIntervalMs","where","streamUpdates","withProperties","autoFetchMore","intersectWith","pivotTo","enabled","observableClient","useContext","canonWhere","canonicalizeWhereClause","stableWithProperties","useMemo","JSON","stringify","stableIntersectWith","stableOrderBy","subscribe","getSnapShot","unsubscribe","process","env","NODE_ENV","apiName","observer","observeList","dedupeInterval","listPayload","useSyncExternalStore","error","status","Error","fetchMore","hasMore","undefined","data","resolvedList","isLoading","isOptimistic"],"sources":["useOsdkObjects.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  LinkedType,\n  LinkNames,\n  ObjectOrInterfaceDefinition,\n  Osdk,\n  PropertyKeys,\n  SimplePropertyDef,\n  WhereClause,\n} from \"@osdk/api\";\nimport type { ObserveObjectsCallbackArgs } 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 UseOsdkObjectsOptions<\n  T extends ObjectOrInterfaceDefinition,\n  WithProps extends DerivedProperty.Clause<T> | undefined = undefined,\n> {\n  /**\n   * Standard OSDK Where with RDP support\n   */\n  where?: WhereClause<T, InferRdpTypes<T, WithProps>>;\n\n  /**\n   *  The preferred page size for the list.\n   */\n  pageSize?: number;\n\n  /** */\n  orderBy?: {\n    [K in PropertyKeys<T>]?: \"asc\" | \"desc\";\n  };\n\n  /**\n   * Define derived properties (RDPs) to be computed server-side and attached to each object.\n   * These properties will be available on the returned objects alongside their regular properties.\n   */\n  withProperties?: WithProps;\n\n  /**\n   * Intersect the results with additional object sets.\n   * Each element defines a where clause for an object set to intersect with.\n   * The final result will only include objects that match ALL conditions.\n   */\n  intersectWith?: Array<{\n    where: WhereClause<T, InferRdpTypes<T, WithProps>>;\n  }>;\n\n  /**\n   * Pivot to related objects through a link.\n   * This changes the return type from T to the linked object type.\n   */\n  pivotTo?: LinkNames<T>;\n\n  /**\n   * Causes the list to automatically fetch more as soon as the previous page\n   * has been loaded. If a number is provided, it will continue to automatically\n   * fetch more until the list is at least that long.\n   *\n   * - `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   * Note: When using `autoFetchMore: true` with large datasets, the initial\n   * load may take significant time. Consider using a specific number instead\n   * or implementing virtual scrolling.\n   *\n   * @example\n   * // Fetch all todos at once\n   * const { data } = useOsdkObjects(Todo, { autoFetchMore: true })\n   *\n   * @example\n   * // Fetch at least 100 todos (with 25 per page, fetches 4 pages)\n   * const { data } = useOsdkObjects(Todo, {\n   *   autoFetchMore: 100,\n   *   pageSize: 25\n   * })\n   */\n  autoFetchMore?: boolean | number;\n\n  /**\n   * Upon a list being revalidated, this option determines how the component\n   * will be re-rendered with the data.\n   *\n   * An example to help understand the options:\n   *\n   * Suppose pageSize is 10 and we have called `fetchMore()` twice. The list is\n   * now 30 items long.\n   *\n   * Upon revalidation, we get the first 10 items of the list. The options behave\n   * as follows:\n   *\n   * - `\"in-place\"`: The first 10 items of the list are replaced with the new 10\n   *   items. The list is now 30 items long, but only the first 10 items are valid.\n   * - `\"wait\"`: The old list is returned until after the next 20 items are loaded\n   *   (which will happen automatically). The list is now 30 items long.\n   * - `\"reset\"`: The entire list is replaced with the new 10 items. The list is\n   *   now 10 items long.\n   */\n  // invalidationMode?: \"in-place\" | \"wait\" | \"reset\";\n\n  /**\n   * The number of milliseconds to wait after the last observed list change.\n   *\n   * Two uses of `useOsdkObjects` with the where clause will only trigger one\n   * network request if the second is within `dedupeIntervalMs`.\n   */\n  dedupeIntervalMs?: number;\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 parent data\n   * const { data: employee } = useOsdkObject(Employee, employeeId);\n   * const { data: reports } = useOsdkObjects(Employee, {\n   *   where: { managerId: employee?.id },\n   *   enabled: !!employee\n   * });\n   */\n  enabled?: boolean;\n}\n\nexport interface UseOsdkListResult<\n  T extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> {\n  fetchMore: (() => Promise<void>) | undefined;\n  data:\n    | Osdk.Instance<T, \"$allBaseProperties\", PropertyKeys<T>, RDPs>[]\n    | undefined;\n  isLoading: boolean;\n\n  error: Error | undefined;\n\n  /**\n   * Refers to whether the ordered list of objects (only considering the $primaryKey)\n   * is optimistic or not.\n   *\n   * If you need to know if the contents of the list are optimistic you can\n   * do that on a per object basis with useOsdkObject\n   */\n  isOptimistic: boolean;\n}\n\ndeclare const process: {\n  env: {\n    NODE_ENV: \"development\" | \"production\";\n  };\n};\n\nexport function useOsdkObjects<\n  Q extends ObjectOrInterfaceDefinition,\n  L extends LinkNames<Q>,\n>(\n  type: Q,\n  options: UseOsdkObjectsOptions<Q> & { pivotTo: L },\n): UseOsdkListResult<LinkedType<Q, L>>;\n\nexport function useOsdkObjects<\n  Q extends ObjectOrInterfaceDefinition,\n  WP extends DerivedProperty.Clause<Q> | undefined,\n>(\n  type: Q,\n  options?: UseOsdkObjectsOptions<Q, WP>,\n): UseOsdkListResult<Q, InferRdpTypes<Q, WP>>;\n\nexport function useOsdkObjects<\n  Q extends ObjectOrInterfaceDefinition,\n  WP extends DerivedProperty.Clause<Q> | undefined,\n>(\n  type: Q,\n  options?: UseOsdkObjectsOptions<Q, WP>,\n):\n  | UseOsdkListResult<Q, InferRdpTypes<Q, WP>>\n  | UseOsdkListResult<LinkedType<Q, LinkNames<Q>>>\n{\n  const {\n    pageSize,\n    orderBy,\n    dedupeIntervalMs,\n    where = {},\n    streamUpdates,\n    withProperties,\n    autoFetchMore,\n    intersectWith,\n    pivotTo,\n    enabled = true,\n  } = options ?? {};\n  const { observableClient } = React.useContext(OsdkContext2);\n\n  /*  We want the canonical where clause so that the use of `React.useMemo`\n      is stable. No real added cost as we canonicalize internal to\n      the ObservableClient anyway.\n   */\n  const canonWhere = observableClient.canonicalizeWhereClause<\n    Q,\n    InferRdpTypes<Q, WP>\n  >(where ?? {});\n\n  const stableWithProperties = React.useMemo(\n    () => withProperties,\n    [JSON.stringify(withProperties)],\n  );\n\n  const stableIntersectWith = React.useMemo(\n    () => intersectWith,\n    [JSON.stringify(intersectWith)],\n  );\n\n  const stableOrderBy = React.useMemo(\n    () => orderBy,\n    [JSON.stringify(orderBy)],\n  );\n\n  const { subscribe, getSnapShot } = React.useMemo(\n    () => {\n      if (!enabled) {\n        return makeExternalStore<\n          ObserveObjectsCallbackArgs<Q, InferRdpTypes<Q, WP>>\n        >(\n          () => ({ unsubscribe: () => {} }),\n          process.env.NODE_ENV !== \"production\"\n            ? `list ${type.apiName} ${JSON.stringify(canonWhere)} [DISABLED]`\n            : void 0,\n        );\n      }\n      return makeExternalStore<\n        ObserveObjectsCallbackArgs<Q, InferRdpTypes<Q, WP>>\n      >(\n        (observer) =>\n          observableClient.observeList({\n            type,\n            where: canonWhere,\n            dedupeInterval: dedupeIntervalMs ?? 2_000,\n            pageSize,\n            orderBy: stableOrderBy,\n            streamUpdates,\n            withProperties: stableWithProperties,\n            autoFetchMore,\n            ...(stableIntersectWith\n              ? { intersectWith: stableIntersectWith }\n              : {}),\n            ...(pivotTo ? { pivotTo } : {}),\n          }, observer),\n        process.env.NODE_ENV !== \"production\"\n          ? `list ${type.apiName} ${JSON.stringify(canonWhere)}`\n          : void 0,\n      );\n    },\n    [\n      enabled,\n      observableClient,\n      type,\n      canonWhere,\n      dedupeIntervalMs,\n      pageSize,\n      stableOrderBy,\n      streamUpdates,\n      stableWithProperties,\n      autoFetchMore,\n      stableIntersectWith,\n      pivotTo,\n    ],\n  );\n\n  const listPayload = React.useSyncExternalStore(subscribe, getSnapShot);\n\n  let error: Error | undefined;\n  if (listPayload && \"error\" in listPayload && listPayload.error) {\n    error = listPayload.error;\n  } else if (listPayload?.status === \"error\") {\n    error = new Error(\"Failed to load objects\");\n  }\n\n  return {\n    fetchMore: listPayload?.hasMore ? listPayload.fetchMore : undefined,\n    error,\n    data: listPayload?.resolvedList,\n    isLoading: enabled\n      ? (listPayload?.status === \"loading\" || listPayload?.status === \"init\"\n        || !listPayload)\n      : false,\n    isOptimistic: listPayload?.isOptimistic ?? false,\n  };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAaA,OAAOA,KAAK,MAAM,OAAO;AACzB,SAASC,iBAAiB,QAAQ,wBAAwB;AAC1D,SAASC,YAAY,QAAQ,mBAAmB;AAuKhD,OAAO,SAASC,cAAcA,CAI5BC,IAAO,EACPC,OAAsC,EAIxC;EACE,MAAM;IACJC,QAAQ;IACRC,OAAO;IACPC,gBAAgB;IAChBC,KAAK,GAAG,CAAC,CAAC;IACVC,aAAa;IACbC,cAAc;IACdC,aAAa;IACbC,aAAa;IACbC,OAAO;IACPC,OAAO,GAAG;EACZ,CAAC,GAAGV,OAAO,IAAI,CAAC,CAAC;EACjB,MAAM;IAAEW;EAAiB,CAAC,GAAGhB,KAAK,CAACiB,UAAU,CAACf,YAAY,CAAC;;EAE3D;AACF;AACA;AACA;EACE,MAAMgB,UAAU,GAAGF,gBAAgB,CAACG,uBAAuB,CAGzDV,KAAK,IAAI,CAAC,CAAC,CAAC;EAEd,MAAMW,oBAAoB,GAAGpB,KAAK,CAACqB,OAAO,CACxC,MAAMV,cAAc,EACpB,CAACW,IAAI,CAACC,SAAS,CAACZ,cAAc,CAAC,CACjC,CAAC;EAED,MAAMa,mBAAmB,GAAGxB,KAAK,CAACqB,OAAO,CACvC,MAAMR,aAAa,EACnB,CAACS,IAAI,CAACC,SAAS,CAACV,aAAa,CAAC,CAChC,CAAC;EAED,MAAMY,aAAa,GAAGzB,KAAK,CAACqB,OAAO,CACjC,MAAMd,OAAO,EACb,CAACe,IAAI,CAACC,SAAS,CAAChB,OAAO,CAAC,CAC1B,CAAC;EAED,MAAM;IAAEmB,SAAS;IAAEC;EAAY,CAAC,GAAG3B,KAAK,CAACqB,OAAO,CAC9C,MAAM;IACJ,IAAI,CAACN,OAAO,EAAE;MACZ,OAAOd,iBAAiB,CAGtB,OAAO;QAAE2B,WAAW,EAAEA,CAAA,KAAM,CAAC;MAAE,CAAC,CAAC,EACjCC,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,GACjC,QAAQ3B,IAAI,CAAC4B,OAAO,IAAIV,IAAI,CAACC,SAAS,CAACL,UAAU,CAAC,aAAa,GAC/D,KAAK,CACX,CAAC;IACH;IACA,OAAOjB,iBAAiB,CAGrBgC,QAAQ,IACPjB,gBAAgB,CAACkB,WAAW,CAAC;MAC3B9B,IAAI;MACJK,KAAK,EAAES,UAAU;MACjBiB,cAAc,EAAE3B,gBAAgB,IAAI,KAAK;MACzCF,QAAQ;MACRC,OAAO,EAAEkB,aAAa;MACtBf,aAAa;MACbC,cAAc,EAAES,oBAAoB;MACpCR,aAAa;MACb,IAAIY,mBAAmB,GACnB;QAAEX,aAAa,EAAEW;MAAoB,CAAC,GACtC,CAAC,CAAC,CAAC;MACP,IAAIV,OAAO,GAAG;QAAEA;MAAQ,CAAC,GAAG,CAAC,CAAC;IAChC,CAAC,EAAEmB,QAAQ,CAAC,EACdJ,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,GACjC,QAAQ3B,IAAI,CAAC4B,OAAO,IAAIV,IAAI,CAACC,SAAS,CAACL,UAAU,CAAC,EAAE,GACpD,KAAK,CACX,CAAC;EACH,CAAC,EACD,CACEH,OAAO,EACPC,gBAAgB,EAChBZ,IAAI,EACJc,UAAU,EACVV,gBAAgB,EAChBF,QAAQ,EACRmB,aAAa,EACbf,aAAa,EACbU,oBAAoB,EACpBR,aAAa,EACbY,mBAAmB,EACnBV,OAAO,CAEX,CAAC;EAED,MAAMsB,WAAW,GAAGpC,KAAK,CAACqC,oBAAoB,CAACX,SAAS,EAAEC,WAAW,CAAC;EAEtE,IAAIW,KAAwB;EAC5B,IAAIF,WAAW,IAAI,OAAO,IAAIA,WAAW,IAAIA,WAAW,CAACE,KAAK,EAAE;IAC9DA,KAAK,GAAGF,WAAW,CAACE,KAAK;EAC3B,CAAC,MAAM,IAAIF,WAAW,EAAEG,MAAM,KAAK,OAAO,EAAE;IAC1CD,KAAK,GAAG,IAAIE,KAAK,CAAC,wBAAwB,CAAC;EAC7C;EAEA,OAAO;IACLC,SAAS,EAAEL,WAAW,EAAEM,OAAO,GAAGN,WAAW,CAACK,SAAS,GAAGE,SAAS;IACnEL,KAAK;IACLM,IAAI,EAAER,WAAW,EAAES,YAAY;IAC/BC,SAAS,EAAE/B,OAAO,GACbqB,WAAW,EAAEG,MAAM,KAAK,SAAS,IAAIH,WAAW,EAAEG,MAAM,KAAK,MAAM,IACjE,CAACH,WAAW,GACf,KAAK;IACTW,YAAY,EAAEX,WAAW,EAAEW,YAAY,IAAI;EAC7C,CAAC;AACH","ignoreList":[]}

package/build/browser/public/experimental.js

@@ -22,6 +22,7 @@ export { useLinks } from "../new/useLinks.js";
 export { useObjectSet } from "../new/useObjectSet.js";
 export { useOsdkAction } from "../new/useOsdkAction.js";
 export { useOsdkAggregation } from "../new/useOsdkAggregation.js";
+export { useOsdkFunction } from "../new/useOsdkFunction.js";
 export { useOsdkObject } from "../new/useOsdkObject.js";
 export { useOsdkObjects } from "../new/useOsdkObjects.js";
 export { useOsdkClient } from "../useOsdkClient.js";