@osdk/react 0.8.0 → 0.9.0-beta.10

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

@@ -1,7 +1,9 @@
-import { Client, ObjectTypeDefinition, Osdk, InterfaceDefinition, WhereClause, PropertyKeys, ActionDefinition, ActionValidationError, ActionValidationResponse } from '@osdk/client';
-import { ObservableClient, ActionSignatureFromDef } from '@osdk/client/unstable-do-not-use';
+import { Client, Osdk, WhereClause, PropertyKeys, ActionDefinition, ActionEditResponse, ActionValidationError, ActionValidationResponse } from '@osdk/client';
+import { ObservableClient, ActionSignatureFromDef, QueryParameterType, QueryReturnType } from '@osdk/client/unstable-do-not-use';
 import React from 'react';
-import { LinkNames, LinkedType, ObjectTypeDefinition as ObjectTypeDefinition$1, SimplePropertyDef, ObjectSet, WhereClause as WhereClause$1, DerivedProperty, PropertyKeys as PropertyKeys$1, Osdk as Osdk$1, InterfaceDefinition as InterfaceDefinition$1, AggregateOpts, AggregationsResults, PrimaryKeyType } from '@osdk/api';
+import { User, ListUsersResponse } from '@osdk/foundry.admin';
+import { UserStatus } from '@osdk/foundry.core';
+import { ObjectOrInterfaceDefinition, LinkNames, LinkedType, ObjectTypeDefinition, SimplePropertyDef, ObjectSet, WhereClause as WhereClause$1, DerivedProperty, PropertyKeys as PropertyKeys$1, Osdk as Osdk$1, AggregateOpts, AggregationsResults, QueryDefinition, CompileTimeMetadata, PrimaryKeyType } from '@osdk/api';
 export { U as UseOsdkMetadataResult, u as useOsdkClient, a as useOsdkMetadata } from '../useOsdkMetadata-DFZhnhGZ.cjs';
 
 interface OsdkProviderOptions {
@@ -11,7 +13,121 @@ interface OsdkProviderOptions {
 }
 declare function OsdkProvider2({ children, client, observableClient, }: OsdkProviderOptions): React.JSX.Element;
 
-interface UseLinksOptions<T extends ObjectTypeDefinition | InterfaceDefinition> {
+interface UseCurrentFoundryUserOptions {
+    /**
+     * Enable or disable the query.
+     *
+     * When `false`, the query will not automatically execute.
+     *
+     * This is useful for:
+     * - Lazy/on-demand queries that should wait for user interaction
+     * - Dependent queries that need data from another query first
+     * - Conditional queries based on component state
+     *
+     * @default true
+     * });
+     */
+    enabled?: boolean;
+}
+interface UseCurrentFoundryUserResult {
+    currentUser: User | undefined;
+    isLoading: boolean;
+    error: Error | undefined;
+    refetch: () => void;
+}
+/**
+ * Get the currently signed in User.
+ * @param options Options to control the query.
+ */
+declare function useCurrentFoundryUser({ enabled }?: UseCurrentFoundryUserOptions): UseCurrentFoundryUserResult;
+
+interface UseFoundryUserOptions {
+    /**
+     * Enable or disable the query.
+     *
+     * When `false`, the query will not automatically execute.
+     *
+     * This is useful for:
+     * - Lazy/on-demand queries that should wait for user interaction
+     * - Dependent queries that need data from another query first
+     * - Conditional queries based on component state
+     *
+     * @default true
+     * });
+     */
+    enabled?: boolean;
+    /**
+     * The default status of the users returned in the list.
+     *
+     * @default "ACTIVE"
+     */
+    status?: UserStatus;
+}
+interface UseFoundryUserResult {
+    user: User | undefined;
+    isLoading: boolean;
+    error: Error | undefined;
+    refetch: () => void;
+}
+/**
+ * Get the User with the specified id.
+ * @param userId A Foundry User ID.
+ * @param options Options to control the query.
+ */
+declare function useFoundryUser(userId: string, { enabled, status }?: UseFoundryUserOptions): UseFoundryUserResult;
+
+interface UseFoundryUsersListOptions {
+    /**
+     * Enable or disable the query.
+     *
+     * When `false`, the query will not automatically execute.
+     *
+     * This is useful for:
+     * - Lazy/on-demand queries that should wait for user interaction
+     * - Dependent queries that need data from another query first
+     * - Conditional queries based on component state
+     *
+     * @default true
+     * });
+     */
+    enabled?: boolean;
+    /**
+     * The default status of the users returned in the list.
+     *
+     * @default "ACTIVE"
+     */
+    include?: UserStatus;
+    /**
+     * The preferred page size for the list.
+     *
+     * @default 1000
+     */
+    pageSize?: number;
+    /**
+     * The page token indicates where to start paging. This should be omitted from the first page's request.
+     * To fetch the next page, clients should take the value from the nextPageToken field of the previous
+     * response and use it to populate the pageToken field of the next request.
+     */
+    pageToken?: string;
+}
+interface UseFoundryUsersListResult {
+    users: ListUsersResponse["data"] | undefined;
+    /**
+     * The page token to be used for the next page of users. If this is undefined, there are no more
+     * pages of users to load.
+     */
+    nextPageToken: string | undefined;
+    isLoading: boolean;
+    error: Error | undefined;
+    refetch: () => void;
+}
+/**
+ * Lists all Users. This is a paged endpoint. Each page may be smaller or larger than the requested page size.
+ * @param options Options to control the query.
+ */
+declare function useFoundryUsersList({ enabled, include, pageSize, pageToken }?: UseFoundryUsersListOptions): UseFoundryUsersListResult;
+
+interface UseLinksOptions<T extends ObjectOrInterfaceDefinition> {
     /**
      * Standard OSDK Where clause for filtering linked objects
      */
@@ -52,7 +168,7 @@ interface UseLinksOptions<T extends ObjectTypeDefinition | InterfaceDefinition>
      */
     enabled?: boolean;
 }
-interface UseLinksResult<Q extends ObjectTypeDefinition | InterfaceDefinition> {
+interface UseLinksResult<Q extends ObjectOrInterfaceDefinition> {
     links: Osdk.Instance<Q>[] | undefined;
     isLoading: boolean;
     error: Error | undefined;
@@ -77,9 +193,9 @@ interface UseLinksResult<Q extends ObjectTypeDefinition | InterfaceDefinition> {
  * @param options Optional configuration for the link query
  * @returns UseLinksResult with links data and metadata
  */
-declare function useLinks<T extends ObjectTypeDefinition, L extends LinkNames<T>>(objects: Osdk.Instance<T> | Array<Osdk.Instance<T>> | undefined, linkName: L, options?: UseLinksOptions<LinkedType<T, L>>): UseLinksResult<LinkedType<T, L>>;
+declare function useLinks<T extends ObjectOrInterfaceDefinition, L extends LinkNames<T>>(objects: Osdk.Instance<T> | Array<Osdk.Instance<T>> | undefined, linkName: L, options?: UseLinksOptions<LinkedType<T, L>>): UseLinksResult<LinkedType<T, L>>;
 
-interface UseObjectSetOptions<Q extends ObjectTypeDefinition$1, RDPs extends Record<string, SimplePropertyDef> = {}> {
+interface UseObjectSetOptions<Q extends ObjectTypeDefinition, RDPs extends Record<string, SimplePropertyDef> = {}> {
     /**
      * Where clause for filtering
      */
@@ -157,7 +273,7 @@ interface UseObjectSetOptions<Q extends ObjectTypeDefinition$1, RDPs extends Rec
      */
     enabled?: boolean;
 }
-interface UseObjectSetResult<Q extends ObjectTypeDefinition$1, RDPs extends Record<string, SimplePropertyDef> = {}> {
+interface UseObjectSetResult<Q extends ObjectTypeDefinition, RDPs extends Record<string, SimplePropertyDef> = {}> {
     /**
      * The fetched data with derived properties
      */
@@ -178,6 +294,10 @@ interface UseObjectSetResult<Q extends ObjectTypeDefinition$1, RDPs extends Reco
      * The final ObjectSet after all transformations
      */
     objectSet: ObjectSet<Q, RDPs>;
+    /**
+     * The total count of objects matching the query (if available from the API)
+     */
+    totalCount?: string;
 }
 /**
  * React hook for observing and interacting with OSDK object sets.
@@ -190,18 +310,18 @@ interface UseObjectSetResult<Q extends ObjectTypeDefinition$1, RDPs extends Reco
  * @param options - Options for filtering, sorting, and adding new derived properties
  * @returns Object set data with both existing and new derived properties
  */
-declare function useObjectSet<Q extends ObjectTypeDefinition$1, BaseRDPs extends Record<string, SimplePropertyDef> = never, RDPs extends Record<string, SimplePropertyDef> = {}>(baseObjectSet: ObjectSet<Q, BaseRDPs>, options?: UseObjectSetOptions<Q, RDPs>): UseObjectSetResult<Q, RDPs>;
+declare function useObjectSet<Q extends ObjectTypeDefinition, BaseRDPs extends Record<string, SimplePropertyDef> = never, RDPs extends Record<string, SimplePropertyDef> = {}>(baseObjectSet: ObjectSet<Q, BaseRDPs>, options?: UseObjectSetOptions<Q, RDPs>): UseObjectSetResult<Q, RDPs>;
 
 type ApplyActionParams<Q extends ActionDefinition<any>> = Parameters<ActionSignatureFromDef<Q>["applyAction"]>[0] & {
     [K in keyof ObservableClient.ApplyActionOptions as `$${K}`]: ObservableClient.ApplyActionOptions[K];
 };
 interface UseOsdkActionResult<Q extends ActionDefinition<any>> {
-    applyAction: (args: ApplyActionParams<Q> | Array<ApplyActionParams<Q>>) => Promise<unknown>;
+    applyAction: (args: ApplyActionParams<Q> | Array<ApplyActionParams<Q>>) => Promise<ActionEditResponse | undefined>;
     error: undefined | Partial<{
         actionValidation: ActionValidationError;
         unknown: unknown;
     }>;
-    data: unknown;
+    data: ActionEditResponse | undefined;
     isPending: boolean;
     isValidating: boolean;
     /**
@@ -216,20 +336,18 @@ interface UseOsdkActionResult<Q extends ActionDefinition<any>> {
 }
 declare function useOsdkAction<Q extends ActionDefinition<any>>(actionDef: Q): UseOsdkActionResult<Q>;
 
-type InferRdpTypes<Q extends ObjectTypeDefinition$1 | InterfaceDefinition$1, WP extends DerivedProperty.Clause<Q> | undefined> = WP extends DerivedProperty.Clause<Q> ? {
-    [K in keyof WP]: WP[K] extends DerivedProperty.Creator<Q, infer T> ? T : never;
-} : {};
-
-interface UseOsdkAggregationOptions<T extends ObjectTypeDefinition, A extends AggregateOpts<T>, WithProps extends DerivedProperty.Clause<T> | undefined = undefined> {
+interface UseOsdkAggregationOptions<T extends ObjectOrInterfaceDefinition, A extends AggregateOpts<T>, RDPs extends Record<string, SimplePropertyDef> = {}> {
     /**
      * Standard OSDK Where clause to filter objects before aggregation
      */
-    where?: WhereClause$1<T, InferRdpTypes<T, WithProps>>;
+    where?: WhereClause$1<T, RDPs>;
     /**
      * Define derived properties (RDPs) to be computed server-side.
      * The derived properties can be used in the where clause and aggregation groupBy/select.
      */
-    withProperties?: WithProps;
+    withProperties?: {
+        [K in keyof RDPs]: DerivedProperty.Creator<T, RDPs[K]>;
+    };
     /**
      * Aggregation options including groupBy and select
      */
@@ -242,7 +360,7 @@ interface UseOsdkAggregationOptions<T extends ObjectTypeDefinition, A extends Ag
      */
     dedupeIntervalMs?: number;
 }
-interface UseOsdkAggregationResult<T extends ObjectTypeDefinition, A extends AggregateOpts<T>> {
+interface UseOsdkAggregationResult<T extends ObjectOrInterfaceDefinition, A extends AggregateOpts<T>> {
     data: AggregationsResults<T, A> | undefined;
     isLoading: boolean;
     error: Error | undefined;
@@ -272,9 +390,120 @@ interface UseOsdkAggregationResult<T extends ObjectTypeDefinition, A extends Agg
  * });
  * ```
  */
-declare function useOsdkAggregation<Q extends ObjectTypeDefinition, A extends AggregateOpts<Q>, WP extends DerivedProperty.Clause<Q> | undefined = undefined>(type: Q, { where, withProperties, aggregate, dedupeIntervalMs, }: UseOsdkAggregationOptions<Q, A, WP>): UseOsdkAggregationResult<Q, A>;
+declare function useOsdkAggregation<Q extends ObjectOrInterfaceDefinition, const A extends AggregateOpts<Q>, RDPs extends Record<string, SimplePropertyDef> = {}>(type: Q, { where, withProperties, aggregate, dedupeIntervalMs, }: UseOsdkAggregationOptions<Q, A, RDPs>): UseOsdkAggregationResult<Q, A>;
+
+interface UseOsdkFunctionOptions<Q extends QueryDefinition<unknown>> {
+    /**
+     * Parameters to pass to the function.
+     * Must include all required parameters; optional parameters can be omitted.
+     */
+    params?: CompileTimeMetadata<Q>["parameters"] extends Record<string, never> ? undefined : QueryParameterType<CompileTimeMetadata<Q>["parameters"]>;
+    /**
+     * Object types this function depends on.
+     * When actions modify objects of these types, the function will automatically refetch.
+     *
+     * @example
+     * ```tsx
+     * // Refetch when any Employee object changes
+     * { dependsOn: [Employee] }
+     * ```
+     */
+    dependsOn?: Array<ObjectTypeDefinition | string>;
+    /**
+     * Specific object instances this function depends on.
+     * When any of these specific objects change, the function will refetch.
+     * More fine-grained than dependsOn for precise invalidation control.
+     *
+     * @example
+     * ```tsx
+     * // Refetch when this specific employee changes
+     * { dependsOnObjects: [employee] }
+     * ```
+     */
+    dependsOnObjects?: Array<Osdk$1.Instance<ObjectTypeDefinition>>;
+    /**
+     * The number of milliseconds to dedupe identical function calls.
+     * Two calls with the same function and params will share results
+     * if the second call is within this interval of the first.
+     * @default 2000
+     */
+    dedupeIntervalMs?: number;
+    /**
+     * Whether to enable the query. When false, the query will not execute.
+     * Useful for:
+     * - Dependent queries that need to wait for other data
+     * - Conditional queries based on component state
+     *
+     * @default true
+     * @example
+     * // Dependent query - wait for required data
+     * const { data: employee } = useOsdkObject(Employee, employeeId);
+     * const { data: report } = useOsdkFunction(getEmployeeReport, {
+     *   params: { employeeId: employee?.$primaryKey },
+     *   enabled: !!employee
+     * });
+     */
+    enabled?: boolean;
+}
+interface UseOsdkFunctionResult<Q extends QueryDefinition<unknown>> {
+    /**
+     * The function result, or undefined if not yet loaded or on error.
+     */
+    data: QueryReturnType<CompileTimeMetadata<Q>["output"]> | undefined;
+    /**
+     * True while the function is executing.
+     */
+    isLoading: boolean;
+    /**
+     * Error if the function execution failed.
+     */
+    error: Error | undefined;
+    /**
+     * Timestamp (ms since epoch) of when the result was last fetched.
+     */
+    lastUpdated: number;
+    /**
+     * Manually refetch the function.
+     * Useful for "pull to refresh" or retry patterns.
+     */
+    refetch: () => void;
+}
+/**
+ * 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],
+ * });
+ * ```
+ */
+declare function useOsdkFunction<Q extends QueryDefinition<unknown>>(queryDef: Q, options?: UseOsdkFunctionOptions<Q>): UseOsdkFunctionResult<Q>;
 
-interface UseOsdkObjectResult<Q extends ObjectTypeDefinition$1> {
+interface UseOsdkObjectResult<Q extends ObjectTypeDefinition> {
     object: Osdk$1.Instance<Q> | undefined;
     isLoading: boolean;
     error: Error | undefined;
@@ -288,7 +517,7 @@ interface UseOsdkObjectResult<Q extends ObjectTypeDefinition$1> {
  * @param obj an existing `Osdk.Instance` object to get metadata for.
  * @param enabled Enable or disable the query (defaults to true)
  */
-declare function useOsdkObject<Q extends ObjectTypeDefinition$1>(obj: Osdk$1.Instance<Q>, enabled?: boolean): UseOsdkObjectResult<Q>;
+declare function useOsdkObject<Q extends ObjectTypeDefinition>(obj: Osdk$1.Instance<Q>, enabled?: boolean): UseOsdkObjectResult<Q>;
 /**
  * Loads an object by type and primary key.
  *
@@ -296,13 +525,13 @@ declare function useOsdkObject<Q extends ObjectTypeDefinition$1>(obj: Osdk$1.Ins
  * @param primaryKey
  * @param enabled Enable or disable the query (defaults to true)
  */
-declare function useOsdkObject<Q extends ObjectTypeDefinition$1>(type: Q, primaryKey: PrimaryKeyType<Q>, enabled?: boolean): UseOsdkObjectResult<Q>;
+declare function useOsdkObject<Q extends ObjectTypeDefinition>(type: Q, primaryKey: PrimaryKeyType<Q>, enabled?: boolean): UseOsdkObjectResult<Q>;
 
-interface UseOsdkObjectsOptions<T extends ObjectTypeDefinition$1 | InterfaceDefinition$1, WithProps extends DerivedProperty.Clause<T> | undefined = undefined> {
+interface UseOsdkObjectsOptions<T extends ObjectOrInterfaceDefinition, RDPs extends Record<string, SimplePropertyDef> = {}> {
     /**
      * Standard OSDK Where with RDP support
      */
-    where?: WhereClause$1<T, InferRdpTypes<T, WithProps>>;
+    where?: WhereClause$1<T, RDPs>;
     /**
      *  The preferred page size for the list.
      */
@@ -315,14 +544,16 @@ interface UseOsdkObjectsOptions<T extends ObjectTypeDefinition$1 | InterfaceDefi
      * Define derived properties (RDPs) to be computed server-side and attached to each object.
      * These properties will be available on the returned objects alongside their regular properties.
      */
-    withProperties?: WithProps;
+    withProperties?: {
+        [K in keyof RDPs]: DerivedProperty.Creator<T, RDPs[K]>;
+    };
     /**
      * Intersect the results with additional object sets.
      * Each element defines a where clause for an object set to intersect with.
      * The final result will only include objects that match ALL conditions.
      */
     intersectWith?: Array<{
-        where: WhereClause$1<T, InferRdpTypes<T, WithProps>>;
+        where: WhereClause$1<T, RDPs>;
     }>;
     /**
      * Pivot to related objects through a link.
@@ -403,10 +634,22 @@ interface UseOsdkObjectsOptions<T extends ObjectTypeDefinition$1 | InterfaceDefi
      */
     enabled?: boolean;
 }
-interface UseOsdkListResult<T extends ObjectTypeDefinition$1 | InterfaceDefinition$1> {
+interface UseOsdkListResult<T extends ObjectOrInterfaceDefinition, RDPs extends Record<string, SimplePropertyDef> = {}> {
+    /**
+     * Function to fetch more pages (undefined if no more pages)
+     */
     fetchMore: (() => Promise<void>) | undefined;
-    data: Osdk$1.Instance<T>[] | undefined;
+    /**
+     * The fetched data with derived properties
+     */
+    data: Osdk$1.Instance<T, "$allBaseProperties", PropertyKeys$1<T>, RDPs>[] | undefined;
+    /**
+     * Whether data is currently being loaded
+     */
     isLoading: boolean;
+    /**
+     * Any error that occurred during fetching
+     */
     error: Error | undefined;
     /**
      * Refers to whether the ordered list of objects (only considering the $primaryKey)
@@ -416,11 +659,15 @@ interface UseOsdkListResult<T extends ObjectTypeDefinition$1 | InterfaceDefiniti
      * do that on a per object basis with useOsdkObject
      */
     isOptimistic: boolean;
+    /**
+     * The total count of objects matching the query (if available from the API)
+     */
+    totalCount?: string;
 }
-declare function useOsdkObjects<Q extends ObjectTypeDefinition$1, L extends LinkNames<Q>>(type: Q, options: UseOsdkObjectsOptions<Q> & {
+declare function useOsdkObjects<Q extends ObjectOrInterfaceDefinition, L extends LinkNames<Q>>(type: Q, options: UseOsdkObjectsOptions<Q> & {
     pivotTo: L;
 }): UseOsdkListResult<LinkedType<Q, L>>;
-declare function useOsdkObjects<Q extends ObjectTypeDefinition$1 | InterfaceDefinition$1, WP extends DerivedProperty.Clause<Q> | undefined>(type: Q, options?: UseOsdkObjectsOptions<Q, WP>): UseOsdkListResult<Q>;
+declare function useOsdkObjects<Q extends ObjectOrInterfaceDefinition, RDPs extends Record<string, SimplePropertyDef> = {}>(type: Q, options?: UseOsdkObjectsOptions<Q, RDPs>): UseOsdkListResult<Q, RDPs>;
 
 interface DebouncedCallback<TArgs extends readonly unknown[]> {
     (...args: TArgs): void;
@@ -457,4 +704,4 @@ interface DebouncedCallback<TArgs extends readonly unknown[]> {
  */
 declare function useDebouncedCallback<TArgs extends readonly unknown[]>(callback: (...args: TArgs) => void | Promise<void>, delay: number): DebouncedCallback<TArgs>;
 
-export { OsdkProvider2, type UseOsdkAggregationResult, type UseOsdkListResult, useDebouncedCallback, useLinks, useObjectSet, useOsdkAction, useOsdkAggregation, useOsdkObject, useOsdkObjects };
+export { OsdkProvider2, type UseOsdkAggregationResult, type UseOsdkFunctionOptions, type UseOsdkFunctionResult, type UseOsdkListResult, useCurrentFoundryUser, useDebouncedCallback, useFoundryUser, useFoundryUsersList, useLinks, useObjectSet, useOsdkAction, useOsdkAggregation, useOsdkFunction, useOsdkObject, useOsdkObjects };

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

@@ -26,7 +26,7 @@ function TestComponent() {
     data
   } = useOsdkObjects(Employee, {
     withProperties: {
-      constantValue: employee => employee.selectProperty("class")
+      constantValue: employee => employee.constant.integer(42)
     }
   });
   return null;

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

@@ -1 +1 @@
-{"version":3,"file":"useOsdkObjectsWithProperties.js","names":["Employee","useOsdkObjects","TestComponent","data","withProperties","constantValue","employee","selectProperty"],"sources":["useOsdkObjectsWithProperties.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n// WARNING!\n// WARNING!\n// This file is used for tests that check intellisense. Editing this file by hand will likely\n// break tests that have hard coded line numbers and line offsets.\n\nimport type { DerivedProperty } from \"@osdk/api\";\nimport { Employee } from \"@osdk/client.test.ontology\";\nimport { useOsdkObjects } from \"@osdk/react/experimental\";\n\nfunction TestComponent() {\n  const withProps: DerivedProperty.Clause<typeof Employee> = {\n    constantValue: (employee) => employee.selectProperty(\"class\"),\n  };\n\n  const { data } = useOsdkObjects(Employee, {\n    withProperties: withProps,\n  });\n\n  return null;\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;;AAGA,SAASA,QAAQ,QAAQ,4BAA4B;AACrD,SAASC,cAAc,QAAQ,0BAA0B;AAEzD,SAASC,aAAaA,CAAA,EAAG;EAKvB,MAAM;IAAEC;EAAK,CAAC,GAAGF,cAAc,CAACD,QAAQ,EAAE;IACxCI,cAAc,EAL2C;MACzDC,aAAa,EAAGC,QAAQ,IAAKA,QAAQ,CAACC,cAAc,CAAC,OAAO;IAC9D;EAIA,CAAC,CAAC;EAEF,OAAO,IAAI;AACb","ignoreList":[]}
+{"version":3,"file":"useOsdkObjectsWithProperties.js","names":["Employee","useOsdkObjects","TestComponent","data","withProperties","constantValue","employee","constant","integer"],"sources":["useOsdkObjectsWithProperties.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n// WARNING!\n// WARNING!\n// This file is used for tests that check intellisense. Editing this file by hand will likely\n// break tests that have hard coded line numbers and line offsets.\n\nimport type { DerivedProperty } from \"@osdk/api\";\nimport { Employee } from \"@osdk/client.test.ontology\";\nimport { useOsdkObjects } from \"@osdk/react/experimental\";\n\nfunction TestComponent() {\n  const withProps: DerivedProperty.Clause<typeof Employee> = {\n    constantValue: (employee) => employee.constant.integer(42),\n  };\n\n  const { data } = useOsdkObjects(Employee, {\n    withProperties: withProps,\n  });\n\n  return null;\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;;AAGA,SAASA,QAAQ,QAAQ,4BAA4B;AACrD,SAASC,cAAc,QAAQ,0BAA0B;AAEzD,SAASC,aAAaA,CAAA,EAAG;EAKvB,MAAM;IAAEC;EAAK,CAAC,GAAGF,cAAc,CAACD,QAAQ,EAAE;IACxCI,cAAc,EAL2C;MACzDC,aAAa,EAAGC,QAAQ,IAAKA,QAAQ,CAACC,QAAQ,CAACC,OAAO,CAAC,EAAE;IAC3D;EAIA,CAAC,CAAC;EAEF,OAAO,IAAI;AACb","ignoreList":[]}

package/build/esm/intellisense.test.js

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

package/build/esm/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/esm/new/platform-apis/admin/useCurrentFoundryUser.js

@@ -0,0 +1,44 @@
+/*
+ * 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 { Users } from "@osdk/foundry.admin";
+import React from "react";
+import { usePlatformQuery } from "../../../utils/usePlatformQuery.js";
+import { OsdkContext2 } from "../../OsdkContext2.js";
+/**
+ * Get the currently signed in User.
+ * @param options Options to control the query.
+ */
+export function useCurrentFoundryUser({
+  enabled = true
+} = {}) {
+  const {
+    client
+  } = React.useContext(OsdkContext2);
+  const handleQuery = React.useCallback(() => Users.getCurrent(client), [client]);
+  const query = usePlatformQuery({
+    query: handleQuery,
+    enabled,
+    queryName: "foundry-current-user"
+  });
+  return {
+    currentUser: query.data,
+    isLoading: query.isLoading,
+    error: query.error,
+    refetch: query.refetch
+  };
+}
+//# sourceMappingURL=useCurrentFoundryUser.js.map

package/build/esm/new/platform-apis/admin/useCurrentFoundryUser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useCurrentFoundryUser.js","names":["Users","React","usePlatformQuery","OsdkContext2","useCurrentFoundryUser","enabled","client","useContext","handleQuery","useCallback","getCurrent","query","queryName","currentUser","data","isLoading","error","refetch"],"sources":["useCurrentFoundryUser.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 User, Users } from \"@osdk/foundry.admin\";\nimport React from \"react\";\nimport { usePlatformQuery } from \"../../../utils/usePlatformQuery.js\";\nimport { OsdkContext2 } from \"../../OsdkContext2.js\";\n\nexport interface UseCurrentFoundryUserOptions {\n  /**\n   * Enable or disable the query.\n   *\n   * When `false`, the query will not automatically execute.\n   *\n   * This is useful for:\n   * - Lazy/on-demand queries that should wait for user interaction\n   * - Dependent queries that need data from another query first\n   * - Conditional queries based on component state\n   *\n   * @default true\n   * });\n   */\n  enabled?: boolean;\n}\n\nexport interface UseCurrentFoundryUserResult {\n  currentUser: User | undefined;\n  isLoading: boolean;\n\n  error: Error | undefined;\n\n  refetch: () => void;\n}\n\n/**\n * Get the currently signed in User.\n * @param options Options to control the query.\n */\nexport function useCurrentFoundryUser(\n  { enabled = true }: UseCurrentFoundryUserOptions = {},\n): UseCurrentFoundryUserResult {\n  const { client } = React.useContext(OsdkContext2);\n\n  const handleQuery = React.useCallback(\n    () => Users.getCurrent(client),\n    [client],\n  );\n\n  const query = usePlatformQuery({\n    query: handleQuery,\n    enabled,\n    queryName: \"foundry-current-user\",\n  });\n\n  return {\n    currentUser: query.data,\n    isLoading: query.isLoading,\n    error: query.error,\n    refetch: query.refetch,\n  };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAAoBA,KAAK,QAAQ,qBAAqB;AACtD,OAAOC,KAAK,MAAM,OAAO;AACzB,SAASC,gBAAgB,QAAQ,oCAAoC;AACrE,SAASC,YAAY,QAAQ,uBAAuB;AA4BpD;AACA;AACA;AACA;AACA,OAAO,SAASC,qBAAqBA,CACnC;EAAEC,OAAO,GAAG;AAAmC,CAAC,GAAG,CAAC,CAAC,EACxB;EAC7B,MAAM;IAAEC;EAAO,CAAC,GAAGL,KAAK,CAACM,UAAU,CAACJ,YAAY,CAAC;EAEjD,MAAMK,WAAW,GAAGP,KAAK,CAACQ,WAAW,CACnC,MAAMT,KAAK,CAACU,UAAU,CAACJ,MAAM,CAAC,EAC9B,CAACA,MAAM,CACT,CAAC;EAED,MAAMK,KAAK,GAAGT,gBAAgB,CAAC;IAC7BS,KAAK,EAAEH,WAAW;IAClBH,OAAO;IACPO,SAAS,EAAE;EACb,CAAC,CAAC;EAEF,OAAO;IACLC,WAAW,EAAEF,KAAK,CAACG,IAAI;IACvBC,SAAS,EAAEJ,KAAK,CAACI,SAAS;IAC1BC,KAAK,EAAEL,KAAK,CAACK,KAAK;IAClBC,OAAO,EAAEN,KAAK,CAACM;EACjB,CAAC;AACH","ignoreList":[]}

package/build/esm/new/platform-apis/admin/useFoundryUser.js

@@ -0,0 +1,50 @@
+/*
+ * 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 { Users } from "@osdk/foundry.admin";
+import React from "react";
+import { usePlatformQuery } from "../../../utils/usePlatformQuery.js";
+import { OsdkContext2 } from "../../OsdkContext2.js";
+/**
+ * Get the User with the specified id.
+ * @param userId A Foundry User ID.
+ * @param options Options to control the query.
+ */
+export function useFoundryUser(userId, {
+  enabled = true,
+  status = "ACTIVE"
+} = {}) {
+  const {
+    client
+  } = React.useContext(OsdkContext2);
+  const handleQuery = React.useCallback(() => {
+    return Users.get(client, userId, {
+      status
+    });
+  }, [client, userId, status]);
+  const query = usePlatformQuery({
+    query: handleQuery,
+    enabled,
+    queryName: "foundry-user"
+  });
+  return {
+    user: query.data,
+    isLoading: query.isLoading,
+    error: query.error,
+    refetch: query.refetch
+  };
+}
+//# sourceMappingURL=useFoundryUser.js.map

package/build/esm/new/platform-apis/admin/useFoundryUser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useFoundryUser.js","names":["Users","React","usePlatformQuery","OsdkContext2","useFoundryUser","userId","enabled","status","client","useContext","handleQuery","useCallback","get","query","queryName","user","data","isLoading","error","refetch"],"sources":["useFoundryUser.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 User, Users } from \"@osdk/foundry.admin\";\nimport type { UserStatus } from \"@osdk/foundry.core\";\nimport React from \"react\";\nimport { usePlatformQuery } from \"../../../utils/usePlatformQuery.js\";\nimport { OsdkContext2 } from \"../../OsdkContext2.js\";\n\nexport interface UseFoundryUserOptions {\n  /**\n   * Enable or disable the query.\n   *\n   * When `false`, the query will not automatically execute.\n   *\n   * This is useful for:\n   * - Lazy/on-demand queries that should wait for user interaction\n   * - Dependent queries that need data from another query first\n   * - Conditional queries based on component state\n   *\n   * @default true\n   * });\n   */\n  enabled?: boolean;\n\n  /**\n   * The default status of the users returned in the list.\n   *\n   * @default \"ACTIVE\"\n   */\n  status?: UserStatus;\n}\n\nexport interface UseFoundryUserResult {\n  user: User | undefined;\n  isLoading: boolean;\n\n  error: Error | undefined;\n\n  refetch: () => void;\n}\n\n/**\n * Get the User with the specified id.\n * @param userId A Foundry User ID.\n * @param options Options to control the query.\n */\nexport function useFoundryUser(\n  userId: string,\n  { enabled = true, status = \"ACTIVE\" }: UseFoundryUserOptions = {},\n): UseFoundryUserResult {\n  const { client } = React.useContext(OsdkContext2);\n\n  const handleQuery = React.useCallback(() => {\n    return Users.get(client, userId, { status });\n  }, [client, userId, status]);\n\n  const query = usePlatformQuery({\n    query: handleQuery,\n    enabled,\n    queryName: \"foundry-user\",\n  });\n\n  return {\n    user: query.data,\n    isLoading: query.isLoading,\n    error: query.error,\n    refetch: query.refetch,\n  };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAAoBA,KAAK,QAAQ,qBAAqB;AAEtD,OAAOC,KAAK,MAAM,OAAO;AACzB,SAASC,gBAAgB,QAAQ,oCAAoC;AACrE,SAASC,YAAY,QAAQ,uBAAuB;AAmCpD;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,cAAcA,CAC5BC,MAAc,EACd;EAAEC,OAAO,GAAG,IAAI;EAAEC,MAAM,GAAG;AAAgC,CAAC,GAAG,CAAC,CAAC,EAC3C;EACtB,MAAM;IAAEC;EAAO,CAAC,GAAGP,KAAK,CAACQ,UAAU,CAACN,YAAY,CAAC;EAEjD,MAAMO,WAAW,GAAGT,KAAK,CAACU,WAAW,CAAC,MAAM;IAC1C,OAAOX,KAAK,CAACY,GAAG,CAACJ,MAAM,EAAEH,MAAM,EAAE;MAAEE;IAAO,CAAC,CAAC;EAC9C,CAAC,EAAE,CAACC,MAAM,EAAEH,MAAM,EAAEE,MAAM,CAAC,CAAC;EAE5B,MAAMM,KAAK,GAAGX,gBAAgB,CAAC;IAC7BW,KAAK,EAAEH,WAAW;IAClBJ,OAAO;IACPQ,SAAS,EAAE;EACb,CAAC,CAAC;EAEF,OAAO;IACLC,IAAI,EAAEF,KAAK,CAACG,IAAI;IAChBC,SAAS,EAAEJ,KAAK,CAACI,SAAS;IAC1BC,KAAK,EAAEL,KAAK,CAACK,KAAK;IAClBC,OAAO,EAAEN,KAAK,CAACM;EACjB,CAAC;AACH","ignoreList":[]}