@osdk/client 2.8.0-beta.1 → 2.8.0-beta.10

package/build/cjs/public/unstable-do-not-use.d.cts

@@ -1,13 +1,17 @@
-import { ObjectOrInterfaceDefinition, PropertyKeys, Augment, ObjectTypeDefinition, InterfaceDefinition, WirePropertyTypes, WhereClause, DerivedProperty, ObjectSet, LinkNames, BaseObjectSet, CompileTimeMetadata, PrimaryKeyType, Osdk, SimplePropertyDef, AggregateOpts, AggregationsResults, QueryDefinition, ActionDefinition, ActionEditResponse, ActionValidationResponse } from '@osdk/api';
+import { ObjectOrInterfaceDefinition, PropertyKeys, Augment, ObjectSet, ObjectTypeDefinition, InterfaceDefinition, WirePropertyTypes, WhereClause, DerivedProperty, LinkNames, BaseObjectSet, CompileTimeMetadata, PrimaryKeyType, Osdk, SimplePropertyDef, AggregateOpts, AggregationsResults, QueryDefinition, ActionDefinition, ActionEditResponse, ActionValidationResponse } from '@osdk/api';
+import { MinimalObjectSet } from '@osdk/api/unstable';
+import { ObjectSet as ObjectSet$1 } from '@osdk/foundry.ontologies';
 import { C as Client, Q as QueryReturnType, A as ActionSignatureFromDef } from '../Client-Cmx6x_V1.cjs';
 export { a as QueryParameterType } from '../Client-Cmx6x_V1.cjs';
 export { a as createClientWithTransaction } from '../createClient-BPK4om7e.cjs';
 import '@osdk/shared.client';
-import '@osdk/api/unstable';
 import '@osdk/shared.client2';
 
 declare function augment<Q extends ObjectOrInterfaceDefinition, T extends PropertyKeys<Q>>(type: Q, ...properties: T[]): Augment<Q, T>;
 
+declare function isObjectSet(o: object): o is ObjectSet<ObjectOrInterfaceDefinition>;
+declare function getWireObjectSet(objectSet: ObjectSet<any> | MinimalObjectSet<any>): ObjectSet$1;
+
 /**
  * Represents the current state of an observation.
  *
@@ -130,6 +134,7 @@ interface Unsubscribable$1 {
 declare namespace ObserveLinks {
     interface Options<Q extends ObjectTypeDefinition | InterfaceDefinition, L extends keyof CompileTimeMetadata<Q>["links"] & string> extends CommonObserveOptions, ObserveOptions {
         srcType: Pick<Q, "type" | "apiName">;
+        sourceUnderlyingObjectType: string;
         pk: PrimaryKeyType<Q>;
         linkName: L;
         where?: WhereClause<CompileTimeMetadata<Q>["links"][L]["targetType"]>;
@@ -148,7 +153,7 @@ declare namespace ObserveLinks {
     }
 }
 interface ObserveLinks {
-    observeLinks<T extends ObjectTypeDefinition | InterfaceDefinition, L extends keyof CompileTimeMetadata<T>["links"] & string>(objects: Osdk.Instance<T> | ReadonlyArray<Osdk.Instance<T>>, linkName: L, options: Omit<ObserveLinks.Options<T, L>, "srcType" | "pk">, subFn: Observer<ObserveLinks.CallbackArgs<CompileTimeMetadata<T>["links"][L]["targetType"]>>): Unsubscribable$1;
+    observeLinks<T extends ObjectTypeDefinition | InterfaceDefinition, L extends keyof CompileTimeMetadata<T>["links"] & string>(objects: Osdk.Instance<T> | ReadonlyArray<Osdk.Instance<T>>, linkName: L, options: Omit<ObserveLinks.Options<T, L>, "srcType" | "pk" | "sourceUnderlyingObjectType">, subFn: Observer<ObserveLinks.CallbackArgs<CompileTimeMetadata<T>["links"][L]["targetType"]>>): Unsubscribable$1;
 }
 
 interface OptimisticBuilder {
@@ -157,7 +162,7 @@ interface OptimisticBuilder {
     deleteObject: <T extends ObjectTypeDefinition>(value: Osdk.Instance<T>) => this;
 }
 
-type OrderBy<Q extends ObjectTypeDefinition | InterfaceDefinition> = {
+type OrderBy<Q extends ObjectOrInterfaceDefinition> = {
     [K in PropertyKeys<Q>]?: "asc" | "desc" | undefined;
 };
 interface ObserveListOptions<Q extends ObjectOrInterfaceDefinition, RDPs extends Record<string, SimplePropertyDef> = {}> extends CommonObserveOptions, ObserveOptions {
@@ -208,13 +213,13 @@ interface ObserveListOptions<Q extends ObjectOrInterfaceDefinition, RDPs extends
     }>;
     pivotTo?: string;
 }
-interface ObserveObjectCallbackArgs<T extends ObjectTypeDefinition> {
+interface ObserveObjectCallbackArgs<T extends ObjectOrInterfaceDefinition> {
     object: Osdk.Instance<T> | undefined;
     isOptimistic: boolean;
     status: Status;
     lastUpdated: number;
 }
-interface ObserveObjectsCallbackArgs<T extends ObjectTypeDefinition | InterfaceDefinition, RDPs extends Record<string, WirePropertyTypes | undefined | Array<WirePropertyTypes>> = {}> {
+interface ObserveObjectsCallbackArgs<T extends ObjectOrInterfaceDefinition, RDPs extends Record<string, WirePropertyTypes | undefined | Array<WirePropertyTypes>> = {}> {
     resolvedList: Array<Osdk.Instance<T, "$allBaseProperties", PropertyKeys<T>, RDPs>>;
     isOptimistic: boolean;
     lastUpdated: number;
@@ -223,7 +228,7 @@ interface ObserveObjectsCallbackArgs<T extends ObjectTypeDefinition | InterfaceD
     status: Status;
     totalCount?: string;
 }
-interface ObserveObjectSetArgs<T extends ObjectTypeDefinition | InterfaceDefinition, RDPs extends Record<string, WirePropertyTypes | undefined | Array<WirePropertyTypes>> = {}> {
+interface ObserveObjectSetArgs<T extends ObjectOrInterfaceDefinition, RDPs extends Record<string, WirePropertyTypes | undefined | Array<WirePropertyTypes>> = {}> {
     resolvedList: Array<Osdk.Instance<T, "$allBaseProperties", PropertyKeys<T>, RDPs>>;
     isOptimistic: boolean;
     lastUpdated: number;
@@ -233,7 +238,7 @@ interface ObserveObjectSetArgs<T extends ObjectTypeDefinition | InterfaceDefinit
     objectSet: ObjectSet<T, RDPs>;
     totalCount?: string;
 }
-interface ObserveAggregationOptions<T extends ObjectOrInterfaceDefinition, A extends AggregateOpts<T>, RDPs extends Record<string, SimplePropertyDef> = {}> extends CommonObserveOptions, ObserveOptions {
+interface ObserveAggregationBaseOptions<T extends ObjectOrInterfaceDefinition, A extends AggregateOpts<T>, RDPs extends Record<string, SimplePropertyDef> = {}> extends CommonObserveOptions, ObserveOptions {
     type: T;
     where?: WhereClause<T, RDPs>;
     withProperties?: DerivedProperty.Clause<T>;
@@ -242,6 +247,21 @@ interface ObserveAggregationOptions<T extends ObjectOrInterfaceDefinition, A ext
     }>;
     aggregate: A;
 }
+/**
+ * Options for observeAggregation without an ObjectSet (synchronous).
+ */
+interface ObserveAggregationOptions<T extends ObjectOrInterfaceDefinition, A extends AggregateOpts<T>, RDPs extends Record<string, SimplePropertyDef> = {}> extends ObserveAggregationBaseOptions<T, A, RDPs> {
+    objectSet?: undefined;
+}
+/**
+ * Options for observeAggregation with an ObjectSet (asynchronous).
+ *
+ * When objectSet is provided, the aggregation is performed on that ObjectSet
+ * instead of the base type, enabling aggregation on pivoted or filtered sets.
+ */
+interface ObserveAggregationOptionsWithObjectSet<T extends ObjectOrInterfaceDefinition, A extends AggregateOpts<T>, RDPs extends Record<string, SimplePropertyDef> = {}> extends ObserveAggregationBaseOptions<T, A, RDPs> {
+    objectSet: ObjectSet<T>;
+}
 interface ObserveAggregationArgs<T extends ObjectOrInterfaceDefinition, A extends AggregateOpts<T>> {
     result: AggregationsResults<T, A> | undefined;
     status: Status;
@@ -255,10 +275,14 @@ interface ObserveFunctionOptions extends CommonObserveOptions {
      */
     dependsOn?: Array<ObjectTypeDefinition | string>;
     /**
-     * Specific object instances this function depends on.
+     * Specific object instances or ObjectSets this function depends on.
      * When these objects change, the function will refetch.
+     *
+     * For ObjectSets, the object type is extracted asynchronously and added
+     * to the dependency list. Changes to any object of that type will trigger
+     * a refetch.
      */
-    dependsOnObjects?: Array<Osdk.Instance<ObjectTypeDefinition>>;
+    dependsOnObjects?: Array<Osdk.Instance<ObjectTypeDefinition> | ObjectSet<ObjectTypeDefinition>>;
 }
 interface ObserveFunctionCallbackArgs<Q extends QueryDefinition<unknown>> {
     result: QueryReturnType<CompileTimeMetadata<Q>["output"]> | undefined;
@@ -283,9 +307,9 @@ declare namespace ObservableClient {
  */
 interface ObservableClient extends ObserveLinks {
     /**
-     * Observe a single object with automatic updates when it changes.
+     * Observe a single object or interface instance with automatic updates when it changes.
      *
-     * @param apiName - The object type definition or name
+     * @param apiName - The object type or interface definition, or its API name
      * @param pk - The object's primary key
      * @param options - Observation options including deduplication interval
      * @param subFn - Observer that receives object state updates
@@ -297,7 +321,7 @@ interface ObservableClient extends ObserveLinks {
      * - Updates when the object changes
      * - Error state if fetch fails
      */
-    observeObject<T extends ObjectTypeDefinition>(apiName: T["apiName"] | T, pk: PrimaryKeyType<T>, options: ObserveOptions, subFn: Observer<ObserveObjectCallbackArgs<T>>): Unsubscribable;
+    observeObject<T extends ObjectOrInterfaceDefinition>(apiName: T["apiName"] | T, pk: PrimaryKeyType<T>, options: ObserveOptions, subFn: Observer<ObserveObjectCallbackArgs<T>>): Unsubscribable;
     /**
      * Observe a filtered and sorted collection of objects.
      *
@@ -311,7 +335,7 @@ interface ObservableClient extends ObserveLinks {
      * - Pagination via fetchMore() in the payload
      * - Automatic updates when any matching object changes
      */
-    observeList<T extends ObjectTypeDefinition | InterfaceDefinition, RDPs extends Record<string, SimplePropertyDef> = {}>(options: ObserveListOptions<T, RDPs>, subFn: Observer<ObserveObjectsCallbackArgs<T, RDPs>>): Unsubscribable;
+    observeList<T extends ObjectOrInterfaceDefinition, RDPs extends Record<string, SimplePropertyDef> = {}>(options: ObserveListOptions<T, RDPs>, subFn: Observer<ObserveObjectsCallbackArgs<T, RDPs>>): Unsubscribable;
     /**
      * Observe an ObjectSet with automatic updates when matching objects change.
      *
@@ -329,20 +353,34 @@ interface ObservableClient extends ObserveLinks {
      */
     observeObjectSet<T extends ObjectTypeDefinition, RDPs extends Record<string, WirePropertyTypes | undefined | Array<WirePropertyTypes>> = {}>(baseObjectSet: ObjectSet<T>, options: ObserveObjectSetOptions<T, RDPs>, subFn: Observer<ObserveObjectSetArgs<T, RDPs>>): Unsubscribable;
     /**
-     * Observe an aggregation query with automatic updates when underlying data changes.
+     * @deprecated Use the async overload with `objectSet` parameter instead.
+     * Pass `objectSet: client(YourType)` to get the base object set.
+     */
+    observeAggregation<T extends ObjectOrInterfaceDefinition, A extends AggregateOpts<T>, RDPs extends Record<string, SimplePropertyDef> = {}>(options: ObserveAggregationOptions<T, A, RDPs>, subFn: Observer<ObserveAggregationArgs<T, A>>): Unsubscribable;
+    /**
+     * Observe an aggregation query on a custom ObjectSet with automatic updates.
      *
-     * @param options - Aggregation configuration including where, aggregate spec, and derived properties
+     * This overload accepts an ObjectSet parameter, enabling aggregation on pivoted,
+     * filtered, or composed ObjectSets. Returns a Promise because invalidation type
+     * computation is async (requires lookups for link targets).
+     *
+     * @param options - Aggregation configuration including objectSet, where, aggregate spec
      * @param subFn - Observer that receives aggregation result updates
-     * @returns Subscription that can be unsubscribed to stop updates
+     * @returns Promise resolving to subscription that can be unsubscribed
      *
-     * Supports:
-     * - Filtering with where clauses
-     * - Derived properties (RDPs) via withProperties
-     * - Set intersections
-     * - GroupBy and metric aggregations
-     * - Automatic updates when source data changes
+     * @example
+     * ```typescript
+     * const sub = await observableClient.observeAggregation(
+     *   {
+     *     type: Office,
+     *     objectSet: $(Employee).pivotTo("primaryOffice"),
+     *     aggregate: { $select: { $count: "unordered" } }
+     *   },
+     *   observer
+     * );
+     * ```
      */
-    observeAggregation<T extends ObjectOrInterfaceDefinition, A extends AggregateOpts<T>, RDPs extends Record<string, SimplePropertyDef> = {}>(options: ObserveAggregationOptions<T, A, RDPs>, subFn: Observer<ObserveAggregationArgs<T, A>>): Unsubscribable;
+    observeAggregation<T extends ObjectOrInterfaceDefinition, A extends AggregateOpts<T>, RDPs extends Record<string, SimplePropertyDef> = {}>(options: ObserveAggregationOptionsWithObjectSet<T, A, RDPs>, subFn: Observer<ObserveAggregationArgs<T, A>>): Promise<Unsubscribable>;
     /**
      * Observe a function execution with automatic updates.
      *
@@ -424,7 +462,7 @@ interface ObservableClient extends ObserveLinks {
      * @param primaryKey - Object primary key
      */
     invalidateFunctionsByObject(apiName: string, primaryKey: string | number): Promise<void>;
-    canonicalizeWhereClause: <T extends ObjectTypeDefinition | InterfaceDefinition, RDPs extends Record<string, SimplePropertyDef> = {}>(where: WhereClause<T, RDPs>) => Canonical<WhereClause<T, RDPs>>;
+    canonicalizeWhereClause: <T extends ObjectOrInterfaceDefinition, RDPs extends Record<string, SimplePropertyDef> = {}>(where: WhereClause<T, RDPs>) => Canonical<WhereClause<T, RDPs>>;
 }
 declare function createObservableClient(client: Client): ObservableClient;
 interface Unsubscribable {
@@ -440,4 +478,4 @@ interface OsdkConfig {
 }
 declare function getOsdkConfig(ontologyRid: string): OsdkConfig;
 
-export { ActionSignatureFromDef, ObservableClient, type ObserveAggregationArgs, type ObserveFunctionCallbackArgs, type ObserveFunctionOptions, ObserveLinks, type ObserveObjectCallbackArgs, type ObserveObjectSetArgs, type ObserveObjectsCallbackArgs, type Observer, type OsdkConfig, QueryReturnType, type Unsubscribable, augment, computeObjectSetCacheKey, createObservableClient, getMetaTagContent, getOsdkConfig };
+export { ActionSignatureFromDef, ObservableClient, type ObserveAggregationArgs, type ObserveFunctionCallbackArgs, type ObserveFunctionOptions, ObserveLinks, type ObserveObjectCallbackArgs, type ObserveObjectSetArgs, type ObserveObjectsCallbackArgs, type Observer, type OsdkConfig, QueryReturnType, type Unsubscribable, augment, computeObjectSetCacheKey, createObservableClient, getMetaTagContent, getOsdkConfig, getWireObjectSet, isObjectSet };

package/build/esm/Client.js

@@ -21,7 +21,7 @@
 export const additionalContext = Symbol("additionalContext");
 
 // BEGIN: THIS IS GENERATED CODE. DO NOT EDIT.
-const MaxOsdkVersion = "2.7.0";
+const MaxOsdkVersion = "2.8.0";
 // END: THIS IS GENERATED CODE. DO NOT EDIT.
 
 const ErrorMessage = Symbol("ErrorMessage");

package/build/esm/Client.js.map

@@ -1 +1 @@
-{"version":3,"file":"Client.js","names":["additionalContext","Symbol","MaxOsdkVersion","ErrorMessage"],"sources":["Client.ts"],"sourcesContent":["/*\n * Copyright 2023 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  ActionDefinition,\n  ActionMetadata,\n  CompileTimeMetadata,\n  InterfaceDefinition,\n  InterfaceMetadata,\n  ObjectMetadata,\n  ObjectSet,\n  ObjectTypeDefinition,\n  QueryDefinition,\n  QueryMetadata,\n  VersionBound,\n} from \"@osdk/api\";\nimport type {\n  Experiment,\n  ExperimentFns,\n  MinimalObjectSet,\n} from \"@osdk/api/unstable\";\nimport type { SharedClient } from \"@osdk/shared.client2\";\nimport type { ActionSignatureFromDef } from \"./actions/applyAction.js\";\nimport type { MinimalClient } from \"./MinimalClientContext.js\";\nimport type { QuerySignatureFromDef } from \"./queries/types.js\";\nimport type { SatisfiesSemver } from \"./SatisfiesSemver.js\";\n\n// eslint-disable-next-line @typescript-eslint/consistent-type-imports\ntype OldSharedClient = import(\"@osdk/shared.client\").SharedClient;\n\nexport type CheckVersionBound<Q> = Q extends VersionBound<infer V> ? (\n    SatisfiesSemver<V, MaxOsdkVersion> extends true ? Q\n      : Q & {\n        [ErrorMessage]:\n          `Your SDK requires a semver compatible version with ${V}. You have ${MaxOsdkVersion}. Update your package.json`;\n      }\n  )\n  : Q;\n\nexport interface Client extends SharedClient, OldSharedClient {\n  <Q extends ObjectTypeDefinition>(\n    o: Q,\n  ): unknown extends CompileTimeMetadata<Q>[\"objectSet\"] ? ObjectSet<Q>\n    : CompileTimeMetadata<Q>[\"objectSet\"];\n\n  <Q extends (InterfaceDefinition)>(\n    o: Q,\n  ): unknown extends CompileTimeMetadata<Q>[\"objectSet\"] ? MinimalObjectSet<Q>\n    : CompileTimeMetadata<Q>[\"objectSet\"];\n\n  <Q extends ActionDefinition<any>>(\n    o: Q,\n  ): ActionSignatureFromDef<Q>;\n\n  <Q extends QueryDefinition<any>>(\n    o: Q,\n  ): QuerySignatureFromDef<Q>;\n\n  <Q extends Experiment<\"2.0.8\"> | Experiment<\"2.1.0\"> | Experiment<\"2.2.0\">>(\n    experiment: Q,\n  ): ExperimentFns<Q>;\n\n  fetchMetadata<\n    Q extends (\n      | ObjectTypeDefinition\n      | InterfaceDefinition\n      | ActionDefinition<any>\n      | QueryDefinition<any>\n    ),\n  >(o: Q): Promise<\n    Q extends ObjectTypeDefinition ? ObjectMetadata\n      : Q extends InterfaceDefinition ? InterfaceMetadata\n      : Q extends ActionDefinition<any> ? ActionMetadata\n      : Q extends QueryDefinition<any> ? QueryMetadata\n      : never\n  >;\n\n  /** @internal */\n  [additionalContext]: MinimalClient;\n}\n\n// DO NOT EXPORT FROM PACKAGE\n/** @internal */\nexport const additionalContext: unique symbol = Symbol(\"additionalContext\");\n\n// BEGIN: THIS IS GENERATED CODE. DO NOT EDIT.\nconst MaxOsdkVersion = \"2.7.0\";\n// END: THIS IS GENERATED CODE. DO NOT EDIT.\nexport type MaxOsdkVersion = typeof MaxOsdkVersion;\nconst ErrorMessage: unique symbol = Symbol(\"ErrorMessage\");\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AA0BA;;AAsDA;AACA;AACA,OAAO,MAAMA,iBAAgC,GAAGC,MAAM,CAAC,mBAAmB,CAAC;;AAE3E;AACA,MAAMC,cAAc,GAAG,OAAO;AAC9B;;AAEA,MAAMC,YAA2B,GAAGF,MAAM,CAAC,cAAc,CAAC","ignoreList":[]}
+{"version":3,"file":"Client.js","names":["additionalContext","Symbol","MaxOsdkVersion","ErrorMessage"],"sources":["Client.ts"],"sourcesContent":["/*\n * Copyright 2023 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  ActionDefinition,\n  ActionMetadata,\n  CompileTimeMetadata,\n  InterfaceDefinition,\n  InterfaceMetadata,\n  ObjectMetadata,\n  ObjectSet,\n  ObjectTypeDefinition,\n  QueryDefinition,\n  QueryMetadata,\n  VersionBound,\n} from \"@osdk/api\";\nimport type {\n  Experiment,\n  ExperimentFns,\n  MinimalObjectSet,\n} from \"@osdk/api/unstable\";\nimport type { SharedClient } from \"@osdk/shared.client2\";\nimport type { ActionSignatureFromDef } from \"./actions/applyAction.js\";\nimport type { MinimalClient } from \"./MinimalClientContext.js\";\nimport type { QuerySignatureFromDef } from \"./queries/types.js\";\nimport type { SatisfiesSemver } from \"./SatisfiesSemver.js\";\n\n// eslint-disable-next-line @typescript-eslint/consistent-type-imports\ntype OldSharedClient = import(\"@osdk/shared.client\").SharedClient;\n\nexport type CheckVersionBound<Q> = Q extends VersionBound<infer V> ? (\n    SatisfiesSemver<V, MaxOsdkVersion> extends true ? Q\n      : Q & {\n        [ErrorMessage]:\n          `Your SDK requires a semver compatible version with ${V}. You have ${MaxOsdkVersion}. Update your package.json`;\n      }\n  )\n  : Q;\n\nexport interface Client extends SharedClient, OldSharedClient {\n  <Q extends ObjectTypeDefinition>(\n    o: Q,\n  ): unknown extends CompileTimeMetadata<Q>[\"objectSet\"] ? ObjectSet<Q>\n    : CompileTimeMetadata<Q>[\"objectSet\"];\n\n  <Q extends (InterfaceDefinition)>(\n    o: Q,\n  ): unknown extends CompileTimeMetadata<Q>[\"objectSet\"] ? MinimalObjectSet<Q>\n    : CompileTimeMetadata<Q>[\"objectSet\"];\n\n  <Q extends ActionDefinition<any>>(\n    o: Q,\n  ): ActionSignatureFromDef<Q>;\n\n  <Q extends QueryDefinition<any>>(\n    o: Q,\n  ): QuerySignatureFromDef<Q>;\n\n  <Q extends Experiment<\"2.0.8\"> | Experiment<\"2.1.0\"> | Experiment<\"2.2.0\">>(\n    experiment: Q,\n  ): ExperimentFns<Q>;\n\n  fetchMetadata<\n    Q extends (\n      | ObjectTypeDefinition\n      | InterfaceDefinition\n      | ActionDefinition<any>\n      | QueryDefinition<any>\n    ),\n  >(o: Q): Promise<\n    Q extends ObjectTypeDefinition ? ObjectMetadata\n      : Q extends InterfaceDefinition ? InterfaceMetadata\n      : Q extends ActionDefinition<any> ? ActionMetadata\n      : Q extends QueryDefinition<any> ? QueryMetadata\n      : never\n  >;\n\n  /** @internal */\n  [additionalContext]: MinimalClient;\n}\n\n// DO NOT EXPORT FROM PACKAGE\n/** @internal */\nexport const additionalContext: unique symbol = Symbol(\"additionalContext\");\n\n// BEGIN: THIS IS GENERATED CODE. DO NOT EDIT.\nconst MaxOsdkVersion = \"2.8.0\";\n// END: THIS IS GENERATED CODE. DO NOT EDIT.\nexport type MaxOsdkVersion = typeof MaxOsdkVersion;\nconst ErrorMessage: unique symbol = Symbol(\"ErrorMessage\");\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AA0BA;;AAsDA;AACA;AACA,OAAO,MAAMA,iBAAgC,GAAGC,MAAM,CAAC,mBAAmB,CAAC;;AAE3E;AACA,MAAMC,cAAc,GAAG,OAAO;AAC9B;;AAEA,MAAMC,YAA2B,GAAGF,MAAM,CAAC,cAAc,CAAC","ignoreList":[]}

package/build/esm/actions/applyAction.js

@@ -42,7 +42,8 @@ export async function applyAction(client, action, parameters, options = {}) {
         returnEdits: options?.$returnEdits ? "ALL_V2_WITH_DELETIONS" : "NONE"
       }
     }, {
-      branch: client.branch
+      branch: client.branch,
+      transactionId: client.transactionId
     });
     if (options?.$validateOnly) {
       return response.validation;

package/build/esm/actions/applyAction.js.map

@@ -1 +1 @@
-{"version":3,"file":"applyAction.js","names":["OntologiesV2","addUserAgentAndRequestContextHeaders","augmentRequestContext","toDataValue","ActionValidationError","applyAction","client","action","parameters","options","clientWithHeaders","finalMethodCall","Array","isArray","response","Actions","applyBatch","ontologyRid","apiName","requests","remapBatchActionParams","ontologyProvider","getActionDefinition","returnEdits","$returnEdits","branch","edits","type","remapActionResponse","undefined","apply","remapActionParams","mode","$validateOnly","validation","result","params","actionMetadata","parameterMap","key","value","Object","entries","remappedParams","Promise","all","map","param","editResponses","remappedActionResponse","deletedLinksCount","deletedObjectsCount","addedLinks","deletedLinks","addedObjects","deletedObjects","modifiedObjects","editedObjectTypes","editedObjectTypesSet","Set","edit","osdkEdit","linkTypeApiNameAtoB","linkTypeApiNameBtoA","aSideObject","bSideObject","push","add","objectType","primaryKey","process","env","NODE_ENV","console","warn","JSON","stringify"],"sources":["applyAction.ts"],"sourcesContent":["/*\n * Copyright 2023 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  ActionDefinition,\n  ActionEditResponse,\n  ActionMetadata,\n  ActionParam,\n  ActionReturnTypeForOptions,\n  ApplyActionOptions,\n  ApplyBatchActionOptions,\n  CompileTimeMetadata as CompileTimeActionMetadata,\n  DataValueClientToWire,\n} from \"@osdk/api\";\nimport type {\n  BatchApplyActionResponseV2,\n  DataValue,\n  SyncApplyActionResponseV2,\n} from \"@osdk/foundry.ontologies\";\nimport * as OntologiesV2 from \"@osdk/foundry.ontologies\";\nimport type { MinimalClient } from \"../MinimalClientContext.js\";\nimport { addUserAgentAndRequestContextHeaders } from \"../util/addUserAgentAndRequestContextHeaders.js\";\nimport { augmentRequestContext } from \"../util/augmentRequestContext.js\";\nimport type { NOOP } from \"../util/NOOP.js\";\nimport type { NullableProps } from \"../util/NullableProps.js\";\nimport type { PartialBy } from \"../util/partialBy.js\";\nimport { toDataValue } from \"../util/toDataValue.js\";\nimport { ActionValidationError } from \"./ActionValidationError.js\";\n\ntype BaseType<APD extends Pick<ActionMetadata.Parameter<any>, \"type\">> =\n  APD[\"type\"] extends ActionMetadata.DataType.Object<infer TTargetType>\n    ? ActionParam.ObjectType<TTargetType>\n    : APD[\"type\"] extends ActionMetadata.DataType.ObjectSet<infer TTargetType>\n      ? ActionParam.ObjectSetType<TTargetType>\n    : APD[\"type\"] extends ActionMetadata.DataType.Struct<infer TStructType>\n      ? ActionParam.StructType<TStructType>\n    : APD[\"type\"] extends keyof DataValueClientToWire\n      ? ActionParam.PrimitiveType<APD[\"type\"]>\n    : never;\n\ntype MaybeArrayType<APD extends ActionMetadata.Parameter<any>> =\n  APD[\"multiplicity\"] extends true ? Array<BaseType<APD>>\n    : BaseType<APD>;\n\ntype NotOptionalParams<X extends ActionParametersDefinition> = {\n  [P in keyof X]: MaybeArrayType<X[P]>;\n};\n\nexport type OsdkActionParameters<\n  X extends ActionParametersDefinition,\n> = NullableProps<X> extends never ? NotOptionalParams<X>\n  : PartialBy<NotOptionalParams<X>, NullableProps<X>>;\n\nexport type ActionSignatureFromDef<\n  T extends ActionDefinition<any>,\n> = {\n  applyAction:\n    [CompileTimeActionMetadata<T>[\"signatures\"][\"applyAction\"]] extends [never]\n      ? ActionSignature<CompileTimeActionMetadata<T>[\"parameters\"]>\n      : CompileTimeActionMetadata<T>[\"signatures\"][\"applyAction\"];\n\n  batchApplyAction:\n    [CompileTimeActionMetadata<T>[\"signatures\"][\"batchApplyAction\"]] extends\n      [never] ? BatchActionSignature<CompileTimeActionMetadata<T>[\"parameters\"]>\n      : CompileTimeActionMetadata<T>[\"signatures\"][\"batchApplyAction\"];\n};\n\ntype ActionParametersDefinition = Record<\n  any,\n  ActionMetadata.Parameter<any>\n>;\n\nexport type ActionSignature<\n  X extends Record<any, ActionMetadata.Parameter<any>>,\n> = <\n  A extends NOOP<OsdkActionParameters<X>>,\n  OP extends ApplyActionOptions,\n>(\n  args: A,\n  options?: OP,\n) => Promise<\n  ActionReturnTypeForOptions<OP>\n>;\n\nexport type BatchActionSignature<\n  X extends Record<any, ActionMetadata.Parameter<any>>,\n> = <\n  A extends NOOP<OsdkActionParameters<X>>[],\n  OP extends ApplyBatchActionOptions,\n>(\n  args: A,\n  options?: OP,\n) => Promise<\n  ActionReturnTypeForOptions<OP>\n>;\n\nexport async function applyAction<\n  AD extends ActionDefinition<any>,\n  P extends\n    | OsdkActionParameters<CompileTimeActionMetadata<AD>[\"parameters\"]>\n    | OsdkActionParameters<CompileTimeActionMetadata<AD>[\"parameters\"]>[],\n  Op extends P extends OsdkActionParameters<\n    CompileTimeActionMetadata<AD>[\"parameters\"]\n  >[] ? ApplyBatchActionOptions\n    : ApplyActionOptions,\n>(\n  client: MinimalClient,\n  action: AD,\n  parameters?: P,\n  options: Op = {} as Op,\n): Promise<\n  ActionReturnTypeForOptions<Op>\n> {\n  const clientWithHeaders = addUserAgentAndRequestContextHeaders(\n    augmentRequestContext(client, _ => ({ finalMethodCall: \"applyAction\" })),\n    action,\n  );\n  if (Array.isArray(parameters)) {\n    const response = await OntologiesV2.Actions.applyBatch(\n      clientWithHeaders,\n      await client.ontologyRid,\n      action.apiName,\n      {\n        requests: parameters\n          ? await remapBatchActionParams(\n            parameters,\n            client,\n            await client.ontologyProvider.getActionDefinition(action.apiName),\n          )\n          : [],\n        options: {\n          returnEdits: options?.$returnEdits ? \"ALL\" : \"NONE\",\n        },\n      },\n      { branch: client.branch },\n    );\n\n    const edits = response.edits;\n    return (options?.$returnEdits\n      ? edits?.type === \"edits\" ? remapActionResponse(response) : edits\n      : undefined) as ActionReturnTypeForOptions<Op>;\n  } else {\n    const response = await OntologiesV2.Actions.apply(\n      clientWithHeaders,\n      await client.ontologyRid,\n      action.apiName,\n      {\n        parameters: await remapActionParams(\n          parameters as OsdkActionParameters<\n            CompileTimeActionMetadata<AD>[\"parameters\"]\n          >,\n          client,\n          await client.ontologyProvider.getActionDefinition(action.apiName),\n        ),\n        options: {\n          mode: (options as ApplyActionOptions)?.$validateOnly\n            ? \"VALIDATE_ONLY\"\n            : \"VALIDATE_AND_EXECUTE\",\n          returnEdits: options\n              ?.$returnEdits\n            ? \"ALL_V2_WITH_DELETIONS\"\n            : \"NONE\",\n        },\n      },\n      { branch: client.branch },\n    );\n\n    if ((options as ApplyActionOptions)?.$validateOnly) {\n      return response.validation as ActionReturnTypeForOptions<Op>;\n    }\n\n    if (response.validation && response.validation?.result === \"INVALID\") {\n      const validation = response.validation;\n      throw new ActionValidationError(validation);\n    }\n\n    const edits = response.edits;\n    return (options?.$returnEdits\n      ? edits?.type === \"edits\" ? remapActionResponse(response) : edits\n      : undefined) as ActionReturnTypeForOptions<Op>;\n  }\n}\n\nasync function remapActionParams<AD extends ActionDefinition<any>>(\n  params:\n    | OsdkActionParameters<CompileTimeActionMetadata<AD>[\"parameters\"]>\n    | undefined,\n  client: MinimalClient,\n  actionMetadata: ActionMetadata,\n): Promise<Record<string, DataValue>> {\n  if (params == null) {\n    return {};\n  }\n\n  const parameterMap: { [parameterName: string]: unknown } = {};\n  for (const [key, value] of Object.entries(params)) {\n    parameterMap[key] = await toDataValue(value, client, actionMetadata);\n  }\n\n  return parameterMap;\n}\n\nasync function remapBatchActionParams<\n  AD extends ActionDefinition<any>,\n>(\n  params: OsdkActionParameters<CompileTimeActionMetadata<AD>[\"parameters\"]>[],\n  client: MinimalClient,\n  actionMetadata: ActionMetadata,\n) {\n  const remappedParams = await Promise.all(params.map(\n    async param => {\n      return {\n        parameters: await remapActionParams<AD>(param, client, actionMetadata),\n      };\n    },\n  ));\n\n  return remappedParams;\n}\n\nexport function remapActionResponse(\n  response: SyncApplyActionResponseV2 | BatchApplyActionResponseV2,\n): ActionEditResponse | undefined {\n  const editResponses = response?.edits;\n  if (editResponses?.type === \"edits\") {\n    const remappedActionResponse: ActionEditResponse = {\n      type: editResponses.type,\n      deletedLinksCount: editResponses.deletedLinksCount,\n      deletedObjectsCount: editResponses.deletedObjectsCount,\n      addedLinks: [],\n      deletedLinks: [],\n      addedObjects: [],\n      deletedObjects: [],\n      modifiedObjects: [],\n      editedObjectTypes: [],\n    };\n\n    const editedObjectTypesSet = new Set<string>();\n    for (const edit of editResponses.edits) {\n      if (edit.type === \"addLink\" || edit.type === \"deleteLink\") {\n        const osdkEdit = {\n          linkTypeApiNameAtoB: edit.linkTypeApiNameAtoB,\n          linkTypeApiNameBtoA: edit.linkTypeApiNameBtoA,\n          aSideObject: edit.aSideObject,\n          bSideObject: edit.bSideObject,\n        };\n        edit.type === \"addLink\"\n          ? remappedActionResponse.addedLinks.push(\n            osdkEdit,\n          )\n          : remappedActionResponse.deletedLinks?.push(osdkEdit);\n        editedObjectTypesSet.add(edit.aSideObject.objectType);\n        editedObjectTypesSet.add(edit.bSideObject.objectType);\n      } else if (\n        edit.type === \"addObject\" || edit.type === \"deleteObject\"\n        || edit.type === \"modifyObject\"\n      ) {\n        const osdkEdit = {\n          objectType: edit.objectType,\n          primaryKey: edit.primaryKey,\n        };\n        if (edit.type === \"addObject\") {\n          remappedActionResponse.addedObjects.push(osdkEdit);\n        } else if (edit.type === \"deleteObject\") {\n          remappedActionResponse.deletedObjects?.push(osdkEdit);\n        } else if (edit.type === \"modifyObject\") {\n          remappedActionResponse.modifiedObjects.push(osdkEdit);\n        }\n        editedObjectTypesSet.add(edit.objectType);\n      } else {\n        if (process.env.NODE_ENV !== \"production\") {\n          // eslint-disable-next-line no-console\n          console.warn(\n            `Unexpected edit type: ${JSON.stringify(edit)}`,\n          );\n        }\n      }\n    }\n    remappedActionResponse.editedObjectTypes = [...editedObjectTypesSet];\n    return remappedActionResponse;\n  }\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAkBA,OAAO,KAAKA,YAAY,MAAM,0BAA0B;AAExD,SAASC,oCAAoC,QAAQ,iDAAiD;AACtG,SAASC,qBAAqB,QAAQ,kCAAkC;AAIxE,SAASC,WAAW,QAAQ,wBAAwB;AACpD,SAASC,qBAAqB,QAAQ,4BAA4B;AAqElE,OAAO,eAAeC,WAAWA,CAU/BC,MAAqB,EACrBC,MAAU,EACVC,UAAc,EACdC,OAAW,GAAG,CAAC,CAAO,EAGtB;EACA,MAAMC,iBAAiB,GAAGT,oCAAoC,CAC5DC,qBAAqB,CAACI,MAAM,EAAE,OAAM;IAAEK,eAAe,EAAE;EAAc,CAAC,CAAC,CAAC,EACxEJ,MACF,CAAC;EACD,IAAIK,KAAK,CAACC,OAAO,CAACL,UAAU,CAAC,EAAE;IAC7B,MAAMM,QAAQ,GAAG,MAAMd,YAAY,CAACe,OAAO,CAACC,UAAU,CACpDN,iBAAiB,EACjB,MAAMJ,MAAM,CAACW,WAAW,EACxBV,MAAM,CAACW,OAAO,EACd;MACEC,QAAQ,EAAEX,UAAU,GAChB,MAAMY,sBAAsB,CAC5BZ,UAAU,EACVF,MAAM,EACN,MAAMA,MAAM,CAACe,gBAAgB,CAACC,mBAAmB,CAACf,MAAM,CAACW,OAAO,CAClE,CAAC,GACC,EAAE;MACNT,OAAO,EAAE;QACPc,WAAW,EAAEd,OAAO,EAAEe,YAAY,GAAG,KAAK,GAAG;MAC/C;IACF,CAAC,EACD;MAAEC,MAAM,EAAEnB,MAAM,CAACmB;IAAO,CAC1B,CAAC;IAED,MAAMC,KAAK,GAAGZ,QAAQ,CAACY,KAAK;IAC5B,OAAQjB,OAAO,EAAEe,YAAY,GACzBE,KAAK,EAAEC,IAAI,KAAK,OAAO,GAAGC,mBAAmB,CAACd,QAAQ,CAAC,GAAGY,KAAK,GAC/DG,SAAS;EACf,CAAC,MAAM;IACL,MAAMf,QAAQ,GAAG,MAAMd,YAAY,CAACe,OAAO,CAACe,KAAK,CAC/CpB,iBAAiB,EACjB,MAAMJ,MAAM,CAACW,WAAW,EACxBV,MAAM,CAACW,OAAO,EACd;MACEV,UAAU,EAAE,MAAMuB,iBAAiB,CACjCvB,UAAU,EAGVF,MAAM,EACN,MAAMA,MAAM,CAACe,gBAAgB,CAACC,mBAAmB,CAACf,MAAM,CAACW,OAAO,CAClE,CAAC;MACDT,OAAO,EAAE;QACPuB,IAAI,EAAGvB,OAAO,EAAyBwB,aAAa,GAChD,eAAe,GACf,sBAAsB;QAC1BV,WAAW,EAAEd,OAAO,EACde,YAAY,GACd,uBAAuB,GACvB;MACN;IACF,CAAC,EACD;MAAEC,MAAM,EAAEnB,MAAM,CAACmB;IAAO,CAC1B,CAAC;IAED,IAAKhB,OAAO,EAAyBwB,aAAa,EAAE;MAClD,OAAOnB,QAAQ,CAACoB,UAAU;IAC5B;IAEA,IAAIpB,QAAQ,CAACoB,UAAU,IAAIpB,QAAQ,CAACoB,UAAU,EAAEC,MAAM,KAAK,SAAS,EAAE;MACpE,MAAMD,UAAU,GAAGpB,QAAQ,CAACoB,UAAU;MACtC,MAAM,IAAI9B,qBAAqB,CAAC8B,UAAU,CAAC;IAC7C;IAEA,MAAMR,KAAK,GAAGZ,QAAQ,CAACY,KAAK;IAC5B,OAAQjB,OAAO,EAAEe,YAAY,GACzBE,KAAK,EAAEC,IAAI,KAAK,OAAO,GAAGC,mBAAmB,CAACd,QAAQ,CAAC,GAAGY,KAAK,GAC/DG,SAAS;EACf;AACF;AAEA,eAAeE,iBAAiBA,CAC9BK,MAEa,EACb9B,MAAqB,EACrB+B,cAA8B,EACM;EACpC,IAAID,MAAM,IAAI,IAAI,EAAE;IAClB,OAAO,CAAC,CAAC;EACX;EAEA,MAAME,YAAkD,GAAG,CAAC,CAAC;EAC7D,KAAK,MAAM,CAACC,GAAG,EAAEC,KAAK,CAAC,IAAIC,MAAM,CAACC,OAAO,CAACN,MAAM,CAAC,EAAE;IACjDE,YAAY,CAACC,GAAG,CAAC,GAAG,MAAMpC,WAAW,CAACqC,KAAK,EAAElC,MAAM,EAAE+B,cAAc,CAAC;EACtE;EAEA,OAAOC,YAAY;AACrB;AAEA,eAAelB,sBAAsBA,CAGnCgB,MAA2E,EAC3E9B,MAAqB,EACrB+B,cAA8B,EAC9B;EACA,MAAMM,cAAc,GAAG,MAAMC,OAAO,CAACC,GAAG,CAACT,MAAM,CAACU,GAAG,CACjD,MAAMC,KAAK,IAAI;IACb,OAAO;MACLvC,UAAU,EAAE,MAAMuB,iBAAiB,CAAKgB,KAAK,EAAEzC,MAAM,EAAE+B,cAAc;IACvE,CAAC;EACH,CACF,CAAC,CAAC;EAEF,OAAOM,cAAc;AACvB;AAEA,OAAO,SAASf,mBAAmBA,CACjCd,QAAgE,EAChC;EAChC,MAAMkC,aAAa,GAAGlC,QAAQ,EAAEY,KAAK;EACrC,IAAIsB,aAAa,EAAErB,IAAI,KAAK,OAAO,EAAE;IACnC,MAAMsB,sBAA0C,GAAG;MACjDtB,IAAI,EAAEqB,aAAa,CAACrB,IAAI;MACxBuB,iBAAiB,EAAEF,aAAa,CAACE,iBAAiB;MAClDC,mBAAmB,EAAEH,aAAa,CAACG,mBAAmB;MACtDC,UAAU,EAAE,EAAE;MACdC,YAAY,EAAE,EAAE;MAChBC,YAAY,EAAE,EAAE;MAChBC,cAAc,EAAE,EAAE;MAClBC,eAAe,EAAE,EAAE;MACnBC,iBAAiB,EAAE;IACrB,CAAC;IAED,MAAMC,oBAAoB,GAAG,IAAIC,GAAG,CAAS,CAAC;IAC9C,KAAK,MAAMC,IAAI,IAAIZ,aAAa,CAACtB,KAAK,EAAE;MACtC,IAAIkC,IAAI,CAACjC,IAAI,KAAK,SAAS,IAAIiC,IAAI,CAACjC,IAAI,KAAK,YAAY,EAAE;QACzD,MAAMkC,QAAQ,GAAG;UACfC,mBAAmB,EAAEF,IAAI,CAACE,mBAAmB;UAC7CC,mBAAmB,EAAEH,IAAI,CAACG,mBAAmB;UAC7CC,WAAW,EAAEJ,IAAI,CAACI,WAAW;UAC7BC,WAAW,EAAEL,IAAI,CAACK;QACpB,CAAC;QACDL,IAAI,CAACjC,IAAI,KAAK,SAAS,GACnBsB,sBAAsB,CAACG,UAAU,CAACc,IAAI,CACtCL,QACF,CAAC,GACCZ,sBAAsB,CAACI,YAAY,EAAEa,IAAI,CAACL,QAAQ,CAAC;QACvDH,oBAAoB,CAACS,GAAG,CAACP,IAAI,CAACI,WAAW,CAACI,UAAU,CAAC;QACrDV,oBAAoB,CAACS,GAAG,CAACP,IAAI,CAACK,WAAW,CAACG,UAAU,CAAC;MACvD,CAAC,MAAM,IACLR,IAAI,CAACjC,IAAI,KAAK,WAAW,IAAIiC,IAAI,CAACjC,IAAI,KAAK,cAAc,IACtDiC,IAAI,CAACjC,IAAI,KAAK,cAAc,EAC/B;QACA,MAAMkC,QAAQ,GAAG;UACfO,UAAU,EAAER,IAAI,CAACQ,UAAU;UAC3BC,UAAU,EAAET,IAAI,CAACS;QACnB,CAAC;QACD,IAAIT,IAAI,CAACjC,IAAI,KAAK,WAAW,EAAE;UAC7BsB,sBAAsB,CAACK,YAAY,CAACY,IAAI,CAACL,QAAQ,CAAC;QACpD,CAAC,MAAM,IAAID,IAAI,CAACjC,IAAI,KAAK,cAAc,EAAE;UACvCsB,sBAAsB,CAACM,cAAc,EAAEW,IAAI,CAACL,QAAQ,CAAC;QACvD,CAAC,MAAM,IAAID,IAAI,CAACjC,IAAI,KAAK,cAAc,EAAE;UACvCsB,sBAAsB,CAACO,eAAe,CAACU,IAAI,CAACL,QAAQ,CAAC;QACvD;QACAH,oBAAoB,CAACS,GAAG,CAACP,IAAI,CAACQ,UAAU,CAAC;MAC3C,CAAC,MAAM;QACL,IAAIE,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,EAAE;UACzC;UACAC,OAAO,CAACC,IAAI,CACV,yBAAyBC,IAAI,CAACC,SAAS,CAAChB,IAAI,CAAC,EAC/C,CAAC;QACH;MACF;IACF;IACAX,sBAAsB,CAACQ,iBAAiB,GAAG,CAAC,GAAGC,oBAAoB,CAAC;IACpE,OAAOT,sBAAsB;EAC/B;AACF","ignoreList":[]}
+{"version":3,"file":"applyAction.js","names":["OntologiesV2","addUserAgentAndRequestContextHeaders","augmentRequestContext","toDataValue","ActionValidationError","applyAction","client","action","parameters","options","clientWithHeaders","finalMethodCall","Array","isArray","response","Actions","applyBatch","ontologyRid","apiName","requests","remapBatchActionParams","ontologyProvider","getActionDefinition","returnEdits","$returnEdits","branch","edits","type","remapActionResponse","undefined","apply","remapActionParams","mode","$validateOnly","transactionId","validation","result","params","actionMetadata","parameterMap","key","value","Object","entries","remappedParams","Promise","all","map","param","editResponses","remappedActionResponse","deletedLinksCount","deletedObjectsCount","addedLinks","deletedLinks","addedObjects","deletedObjects","modifiedObjects","editedObjectTypes","editedObjectTypesSet","Set","edit","osdkEdit","linkTypeApiNameAtoB","linkTypeApiNameBtoA","aSideObject","bSideObject","push","add","objectType","primaryKey","process","env","NODE_ENV","console","warn","JSON","stringify"],"sources":["applyAction.ts"],"sourcesContent":["/*\n * Copyright 2023 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  ActionDefinition,\n  ActionEditResponse,\n  ActionMetadata,\n  ActionParam,\n  ActionReturnTypeForOptions,\n  ApplyActionOptions,\n  ApplyBatchActionOptions,\n  CompileTimeMetadata as CompileTimeActionMetadata,\n  DataValueClientToWire,\n} from \"@osdk/api\";\nimport type {\n  BatchApplyActionResponseV2,\n  DataValue,\n  SyncApplyActionResponseV2,\n} from \"@osdk/foundry.ontologies\";\nimport * as OntologiesV2 from \"@osdk/foundry.ontologies\";\nimport type { MinimalClient } from \"../MinimalClientContext.js\";\nimport { addUserAgentAndRequestContextHeaders } from \"../util/addUserAgentAndRequestContextHeaders.js\";\nimport { augmentRequestContext } from \"../util/augmentRequestContext.js\";\nimport type { NOOP } from \"../util/NOOP.js\";\nimport type { NullableProps } from \"../util/NullableProps.js\";\nimport type { PartialBy } from \"../util/partialBy.js\";\nimport { toDataValue } from \"../util/toDataValue.js\";\nimport { ActionValidationError } from \"./ActionValidationError.js\";\n\ntype BaseType<APD extends Pick<ActionMetadata.Parameter<any>, \"type\">> =\n  APD[\"type\"] extends ActionMetadata.DataType.Object<infer TTargetType>\n    ? ActionParam.ObjectType<TTargetType>\n    : APD[\"type\"] extends ActionMetadata.DataType.ObjectSet<infer TTargetType>\n      ? ActionParam.ObjectSetType<TTargetType>\n    : APD[\"type\"] extends ActionMetadata.DataType.Struct<infer TStructType>\n      ? ActionParam.StructType<TStructType>\n    : APD[\"type\"] extends keyof DataValueClientToWire\n      ? ActionParam.PrimitiveType<APD[\"type\"]>\n    : never;\n\ntype MaybeArrayType<APD extends ActionMetadata.Parameter<any>> =\n  APD[\"multiplicity\"] extends true ? Array<BaseType<APD>>\n    : BaseType<APD>;\n\ntype NotOptionalParams<X extends ActionParametersDefinition> = {\n  [P in keyof X]: MaybeArrayType<X[P]>;\n};\n\nexport type OsdkActionParameters<\n  X extends ActionParametersDefinition,\n> = NullableProps<X> extends never ? NotOptionalParams<X>\n  : PartialBy<NotOptionalParams<X>, NullableProps<X>>;\n\nexport type ActionSignatureFromDef<\n  T extends ActionDefinition<any>,\n> = {\n  applyAction:\n    [CompileTimeActionMetadata<T>[\"signatures\"][\"applyAction\"]] extends [never]\n      ? ActionSignature<CompileTimeActionMetadata<T>[\"parameters\"]>\n      : CompileTimeActionMetadata<T>[\"signatures\"][\"applyAction\"];\n\n  batchApplyAction:\n    [CompileTimeActionMetadata<T>[\"signatures\"][\"batchApplyAction\"]] extends\n      [never] ? BatchActionSignature<CompileTimeActionMetadata<T>[\"parameters\"]>\n      : CompileTimeActionMetadata<T>[\"signatures\"][\"batchApplyAction\"];\n};\n\ntype ActionParametersDefinition = Record<\n  any,\n  ActionMetadata.Parameter<any>\n>;\n\nexport type ActionSignature<\n  X extends Record<any, ActionMetadata.Parameter<any>>,\n> = <\n  A extends NOOP<OsdkActionParameters<X>>,\n  OP extends ApplyActionOptions,\n>(\n  args: A,\n  options?: OP,\n) => Promise<\n  ActionReturnTypeForOptions<OP>\n>;\n\nexport type BatchActionSignature<\n  X extends Record<any, ActionMetadata.Parameter<any>>,\n> = <\n  A extends NOOP<OsdkActionParameters<X>>[],\n  OP extends ApplyBatchActionOptions,\n>(\n  args: A,\n  options?: OP,\n) => Promise<\n  ActionReturnTypeForOptions<OP>\n>;\n\nexport async function applyAction<\n  AD extends ActionDefinition<any>,\n  P extends\n    | OsdkActionParameters<CompileTimeActionMetadata<AD>[\"parameters\"]>\n    | OsdkActionParameters<CompileTimeActionMetadata<AD>[\"parameters\"]>[],\n  Op extends P extends OsdkActionParameters<\n    CompileTimeActionMetadata<AD>[\"parameters\"]\n  >[] ? ApplyBatchActionOptions\n    : ApplyActionOptions,\n>(\n  client: MinimalClient,\n  action: AD,\n  parameters?: P,\n  options: Op = {} as Op,\n): Promise<\n  ActionReturnTypeForOptions<Op>\n> {\n  const clientWithHeaders = addUserAgentAndRequestContextHeaders(\n    augmentRequestContext(client, _ => ({ finalMethodCall: \"applyAction\" })),\n    action,\n  );\n  if (Array.isArray(parameters)) {\n    const response = await OntologiesV2.Actions.applyBatch(\n      clientWithHeaders,\n      await client.ontologyRid,\n      action.apiName,\n      {\n        requests: parameters\n          ? await remapBatchActionParams(\n            parameters,\n            client,\n            await client.ontologyProvider.getActionDefinition(action.apiName),\n          )\n          : [],\n        options: {\n          returnEdits: options?.$returnEdits ? \"ALL\" : \"NONE\",\n        },\n      },\n      { branch: client.branch },\n    );\n\n    const edits = response.edits;\n    return (options?.$returnEdits\n      ? edits?.type === \"edits\" ? remapActionResponse(response) : edits\n      : undefined) as ActionReturnTypeForOptions<Op>;\n  } else {\n    const response = await OntologiesV2.Actions.apply(\n      clientWithHeaders,\n      await client.ontologyRid,\n      action.apiName,\n      {\n        parameters: await remapActionParams(\n          parameters as OsdkActionParameters<\n            CompileTimeActionMetadata<AD>[\"parameters\"]\n          >,\n          client,\n          await client.ontologyProvider.getActionDefinition(action.apiName),\n        ),\n        options: {\n          mode: (options as ApplyActionOptions)?.$validateOnly\n            ? \"VALIDATE_ONLY\"\n            : \"VALIDATE_AND_EXECUTE\",\n          returnEdits: options\n              ?.$returnEdits\n            ? \"ALL_V2_WITH_DELETIONS\"\n            : \"NONE\",\n        },\n      },\n      { branch: client.branch, transactionId: client.transactionId },\n    );\n\n    if ((options as ApplyActionOptions)?.$validateOnly) {\n      return response.validation as ActionReturnTypeForOptions<Op>;\n    }\n\n    if (response.validation && response.validation?.result === \"INVALID\") {\n      const validation = response.validation;\n      throw new ActionValidationError(validation);\n    }\n\n    const edits = response.edits;\n    return (options?.$returnEdits\n      ? edits?.type === \"edits\" ? remapActionResponse(response) : edits\n      : undefined) as ActionReturnTypeForOptions<Op>;\n  }\n}\n\nasync function remapActionParams<AD extends ActionDefinition<any>>(\n  params:\n    | OsdkActionParameters<CompileTimeActionMetadata<AD>[\"parameters\"]>\n    | undefined,\n  client: MinimalClient,\n  actionMetadata: ActionMetadata,\n): Promise<Record<string, DataValue>> {\n  if (params == null) {\n    return {};\n  }\n\n  const parameterMap: { [parameterName: string]: unknown } = {};\n  for (const [key, value] of Object.entries(params)) {\n    parameterMap[key] = await toDataValue(value, client, actionMetadata);\n  }\n\n  return parameterMap;\n}\n\nasync function remapBatchActionParams<\n  AD extends ActionDefinition<any>,\n>(\n  params: OsdkActionParameters<CompileTimeActionMetadata<AD>[\"parameters\"]>[],\n  client: MinimalClient,\n  actionMetadata: ActionMetadata,\n) {\n  const remappedParams = await Promise.all(params.map(\n    async param => {\n      return {\n        parameters: await remapActionParams<AD>(param, client, actionMetadata),\n      };\n    },\n  ));\n\n  return remappedParams;\n}\n\nexport function remapActionResponse(\n  response: SyncApplyActionResponseV2 | BatchApplyActionResponseV2,\n): ActionEditResponse | undefined {\n  const editResponses = response?.edits;\n  if (editResponses?.type === \"edits\") {\n    const remappedActionResponse: ActionEditResponse = {\n      type: editResponses.type,\n      deletedLinksCount: editResponses.deletedLinksCount,\n      deletedObjectsCount: editResponses.deletedObjectsCount,\n      addedLinks: [],\n      deletedLinks: [],\n      addedObjects: [],\n      deletedObjects: [],\n      modifiedObjects: [],\n      editedObjectTypes: [],\n    };\n\n    const editedObjectTypesSet = new Set<string>();\n    for (const edit of editResponses.edits) {\n      if (edit.type === \"addLink\" || edit.type === \"deleteLink\") {\n        const osdkEdit = {\n          linkTypeApiNameAtoB: edit.linkTypeApiNameAtoB,\n          linkTypeApiNameBtoA: edit.linkTypeApiNameBtoA,\n          aSideObject: edit.aSideObject,\n          bSideObject: edit.bSideObject,\n        };\n        edit.type === \"addLink\"\n          ? remappedActionResponse.addedLinks.push(\n            osdkEdit,\n          )\n          : remappedActionResponse.deletedLinks?.push(osdkEdit);\n        editedObjectTypesSet.add(edit.aSideObject.objectType);\n        editedObjectTypesSet.add(edit.bSideObject.objectType);\n      } else if (\n        edit.type === \"addObject\" || edit.type === \"deleteObject\"\n        || edit.type === \"modifyObject\"\n      ) {\n        const osdkEdit = {\n          objectType: edit.objectType,\n          primaryKey: edit.primaryKey,\n        };\n        if (edit.type === \"addObject\") {\n          remappedActionResponse.addedObjects.push(osdkEdit);\n        } else if (edit.type === \"deleteObject\") {\n          remappedActionResponse.deletedObjects?.push(osdkEdit);\n        } else if (edit.type === \"modifyObject\") {\n          remappedActionResponse.modifiedObjects.push(osdkEdit);\n        }\n        editedObjectTypesSet.add(edit.objectType);\n      } else {\n        if (process.env.NODE_ENV !== \"production\") {\n          // eslint-disable-next-line no-console\n          console.warn(\n            `Unexpected edit type: ${JSON.stringify(edit)}`,\n          );\n        }\n      }\n    }\n    remappedActionResponse.editedObjectTypes = [...editedObjectTypesSet];\n    return remappedActionResponse;\n  }\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAkBA,OAAO,KAAKA,YAAY,MAAM,0BAA0B;AAExD,SAASC,oCAAoC,QAAQ,iDAAiD;AACtG,SAASC,qBAAqB,QAAQ,kCAAkC;AAIxE,SAASC,WAAW,QAAQ,wBAAwB;AACpD,SAASC,qBAAqB,QAAQ,4BAA4B;AAqElE,OAAO,eAAeC,WAAWA,CAU/BC,MAAqB,EACrBC,MAAU,EACVC,UAAc,EACdC,OAAW,GAAG,CAAC,CAAO,EAGtB;EACA,MAAMC,iBAAiB,GAAGT,oCAAoC,CAC5DC,qBAAqB,CAACI,MAAM,EAAE,OAAM;IAAEK,eAAe,EAAE;EAAc,CAAC,CAAC,CAAC,EACxEJ,MACF,CAAC;EACD,IAAIK,KAAK,CAACC,OAAO,CAACL,UAAU,CAAC,EAAE;IAC7B,MAAMM,QAAQ,GAAG,MAAMd,YAAY,CAACe,OAAO,CAACC,UAAU,CACpDN,iBAAiB,EACjB,MAAMJ,MAAM,CAACW,WAAW,EACxBV,MAAM,CAACW,OAAO,EACd;MACEC,QAAQ,EAAEX,UAAU,GAChB,MAAMY,sBAAsB,CAC5BZ,UAAU,EACVF,MAAM,EACN,MAAMA,MAAM,CAACe,gBAAgB,CAACC,mBAAmB,CAACf,MAAM,CAACW,OAAO,CAClE,CAAC,GACC,EAAE;MACNT,OAAO,EAAE;QACPc,WAAW,EAAEd,OAAO,EAAEe,YAAY,GAAG,KAAK,GAAG;MAC/C;IACF,CAAC,EACD;MAAEC,MAAM,EAAEnB,MAAM,CAACmB;IAAO,CAC1B,CAAC;IAED,MAAMC,KAAK,GAAGZ,QAAQ,CAACY,KAAK;IAC5B,OAAQjB,OAAO,EAAEe,YAAY,GACzBE,KAAK,EAAEC,IAAI,KAAK,OAAO,GAAGC,mBAAmB,CAACd,QAAQ,CAAC,GAAGY,KAAK,GAC/DG,SAAS;EACf,CAAC,MAAM;IACL,MAAMf,QAAQ,GAAG,MAAMd,YAAY,CAACe,OAAO,CAACe,KAAK,CAC/CpB,iBAAiB,EACjB,MAAMJ,MAAM,CAACW,WAAW,EACxBV,MAAM,CAACW,OAAO,EACd;MACEV,UAAU,EAAE,MAAMuB,iBAAiB,CACjCvB,UAAU,EAGVF,MAAM,EACN,MAAMA,MAAM,CAACe,gBAAgB,CAACC,mBAAmB,CAACf,MAAM,CAACW,OAAO,CAClE,CAAC;MACDT,OAAO,EAAE;QACPuB,IAAI,EAAGvB,OAAO,EAAyBwB,aAAa,GAChD,eAAe,GACf,sBAAsB;QAC1BV,WAAW,EAAEd,OAAO,EACde,YAAY,GACd,uBAAuB,GACvB;MACN;IACF,CAAC,EACD;MAAEC,MAAM,EAAEnB,MAAM,CAACmB,MAAM;MAAES,aAAa,EAAE5B,MAAM,CAAC4B;IAAc,CAC/D,CAAC;IAED,IAAKzB,OAAO,EAAyBwB,aAAa,EAAE;MAClD,OAAOnB,QAAQ,CAACqB,UAAU;IAC5B;IAEA,IAAIrB,QAAQ,CAACqB,UAAU,IAAIrB,QAAQ,CAACqB,UAAU,EAAEC,MAAM,KAAK,SAAS,EAAE;MACpE,MAAMD,UAAU,GAAGrB,QAAQ,CAACqB,UAAU;MACtC,MAAM,IAAI/B,qBAAqB,CAAC+B,UAAU,CAAC;IAC7C;IAEA,MAAMT,KAAK,GAAGZ,QAAQ,CAACY,KAAK;IAC5B,OAAQjB,OAAO,EAAEe,YAAY,GACzBE,KAAK,EAAEC,IAAI,KAAK,OAAO,GAAGC,mBAAmB,CAACd,QAAQ,CAAC,GAAGY,KAAK,GAC/DG,SAAS;EACf;AACF;AAEA,eAAeE,iBAAiBA,CAC9BM,MAEa,EACb/B,MAAqB,EACrBgC,cAA8B,EACM;EACpC,IAAID,MAAM,IAAI,IAAI,EAAE;IAClB,OAAO,CAAC,CAAC;EACX;EAEA,MAAME,YAAkD,GAAG,CAAC,CAAC;EAC7D,KAAK,MAAM,CAACC,GAAG,EAAEC,KAAK,CAAC,IAAIC,MAAM,CAACC,OAAO,CAACN,MAAM,CAAC,EAAE;IACjDE,YAAY,CAACC,GAAG,CAAC,GAAG,MAAMrC,WAAW,CAACsC,KAAK,EAAEnC,MAAM,EAAEgC,cAAc,CAAC;EACtE;EAEA,OAAOC,YAAY;AACrB;AAEA,eAAenB,sBAAsBA,CAGnCiB,MAA2E,EAC3E/B,MAAqB,EACrBgC,cAA8B,EAC9B;EACA,MAAMM,cAAc,GAAG,MAAMC,OAAO,CAACC,GAAG,CAACT,MAAM,CAACU,GAAG,CACjD,MAAMC,KAAK,IAAI;IACb,OAAO;MACLxC,UAAU,EAAE,MAAMuB,iBAAiB,CAAKiB,KAAK,EAAE1C,MAAM,EAAEgC,cAAc;IACvE,CAAC;EACH,CACF,CAAC,CAAC;EAEF,OAAOM,cAAc;AACvB;AAEA,OAAO,SAAShB,mBAAmBA,CACjCd,QAAgE,EAChC;EAChC,MAAMmC,aAAa,GAAGnC,QAAQ,EAAEY,KAAK;EACrC,IAAIuB,aAAa,EAAEtB,IAAI,KAAK,OAAO,EAAE;IACnC,MAAMuB,sBAA0C,GAAG;MACjDvB,IAAI,EAAEsB,aAAa,CAACtB,IAAI;MACxBwB,iBAAiB,EAAEF,aAAa,CAACE,iBAAiB;MAClDC,mBAAmB,EAAEH,aAAa,CAACG,mBAAmB;MACtDC,UAAU,EAAE,EAAE;MACdC,YAAY,EAAE,EAAE;MAChBC,YAAY,EAAE,EAAE;MAChBC,cAAc,EAAE,EAAE;MAClBC,eAAe,EAAE,EAAE;MACnBC,iBAAiB,EAAE;IACrB,CAAC;IAED,MAAMC,oBAAoB,GAAG,IAAIC,GAAG,CAAS,CAAC;IAC9C,KAAK,MAAMC,IAAI,IAAIZ,aAAa,CAACvB,KAAK,EAAE;MACtC,IAAImC,IAAI,CAAClC,IAAI,KAAK,SAAS,IAAIkC,IAAI,CAAClC,IAAI,KAAK,YAAY,EAAE;QACzD,MAAMmC,QAAQ,GAAG;UACfC,mBAAmB,EAAEF,IAAI,CAACE,mBAAmB;UAC7CC,mBAAmB,EAAEH,IAAI,CAACG,mBAAmB;UAC7CC,WAAW,EAAEJ,IAAI,CAACI,WAAW;UAC7BC,WAAW,EAAEL,IAAI,CAACK;QACpB,CAAC;QACDL,IAAI,CAAClC,IAAI,KAAK,SAAS,GACnBuB,sBAAsB,CAACG,UAAU,CAACc,IAAI,CACtCL,QACF,CAAC,GACCZ,sBAAsB,CAACI,YAAY,EAAEa,IAAI,CAACL,QAAQ,CAAC;QACvDH,oBAAoB,CAACS,GAAG,CAACP,IAAI,CAACI,WAAW,CAACI,UAAU,CAAC;QACrDV,oBAAoB,CAACS,GAAG,CAACP,IAAI,CAACK,WAAW,CAACG,UAAU,CAAC;MACvD,CAAC,MAAM,IACLR,IAAI,CAAClC,IAAI,KAAK,WAAW,IAAIkC,IAAI,CAAClC,IAAI,KAAK,cAAc,IACtDkC,IAAI,CAAClC,IAAI,KAAK,cAAc,EAC/B;QACA,MAAMmC,QAAQ,GAAG;UACfO,UAAU,EAAER,IAAI,CAACQ,UAAU;UAC3BC,UAAU,EAAET,IAAI,CAACS;QACnB,CAAC;QACD,IAAIT,IAAI,CAAClC,IAAI,KAAK,WAAW,EAAE;UAC7BuB,sBAAsB,CAACK,YAAY,CAACY,IAAI,CAACL,QAAQ,CAAC;QACpD,CAAC,MAAM,IAAID,IAAI,CAAClC,IAAI,KAAK,cAAc,EAAE;UACvCuB,sBAAsB,CAACM,cAAc,EAAEW,IAAI,CAACL,QAAQ,CAAC;QACvD,CAAC,MAAM,IAAID,IAAI,CAAClC,IAAI,KAAK,cAAc,EAAE;UACvCuB,sBAAsB,CAACO,eAAe,CAACU,IAAI,CAACL,QAAQ,CAAC;QACvD;QACAH,oBAAoB,CAACS,GAAG,CAACP,IAAI,CAACQ,UAAU,CAAC;MAC3C,CAAC,MAAM;QACL,IAAIE,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,EAAE;UACzC;UACAC,OAAO,CAACC,IAAI,CACV,yBAAyBC,IAAI,CAACC,SAAS,CAAChB,IAAI,CAAC,EAC/C,CAAC;QACH;MACF;IACF;IACAX,sBAAsB,CAACQ,iBAAiB,GAAG,CAAC,GAAGC,oBAAoB,CAAC;IACpE,OAAOT,sBAAsB;EAC/B;AACF","ignoreList":[]}

package/build/esm/derivedProperties/createWithPropertiesObjectSet.test.js

@@ -150,6 +150,107 @@ describe(createWithPropertiesObjectSet, () => {
         }
       `);
     });
+    it("subtract produces correct wire format", () => {
+      const map = new Map();
+      const deriveObjectSet = createWithPropertiesObjectSet(Employee, {
+        type: "methodInput"
+      }, map, true);
+      const result = {
+        "derivedPropertyName": base => base.pivotTo("lead").selectProperty("employeeId").subtract(base.selectProperty("employeeId"))
+      }["derivedPropertyName"](deriveObjectSet);
+      const definition = map.get(result);
+      expect(definition).toMatchInlineSnapshot(`
+        {
+          "left": {
+            "objectSet": {
+              "link": "lead",
+              "objectSet": {
+                "type": "methodInput",
+              },
+              "type": "searchAround",
+            },
+            "operation": {
+              "selectedPropertyApiName": "employeeId",
+              "type": "get",
+            },
+            "type": "selection",
+          },
+          "right": {
+            "apiName": "employeeId",
+            "type": "property",
+          },
+          "type": "subtract",
+        }
+      `);
+    });
+    it("divide produces correct wire format", () => {
+      const map = new Map();
+      const deriveObjectSet = createWithPropertiesObjectSet(Employee, {
+        type: "methodInput"
+      }, map, true);
+      const result = {
+        "derivedPropertyName": base => base.pivotTo("lead").selectProperty("employeeId").divide(base.selectProperty("employeeId"))
+      }["derivedPropertyName"](deriveObjectSet);
+      const definition = map.get(result);
+      expect(definition).toMatchInlineSnapshot(`
+        {
+          "left": {
+            "objectSet": {
+              "link": "lead",
+              "objectSet": {
+                "type": "methodInput",
+              },
+              "type": "searchAround",
+            },
+            "operation": {
+              "selectedPropertyApiName": "employeeId",
+              "type": "get",
+            },
+            "type": "selection",
+          },
+          "right": {
+            "apiName": "employeeId",
+            "type": "property",
+          },
+          "type": "divide",
+        }
+      `);
+    });
+    it("multiply produces correct wire format", () => {
+      const map = new Map();
+      const deriveObjectSet = createWithPropertiesObjectSet(Employee, {
+        type: "methodInput"
+      }, map, true);
+      const result = {
+        "derivedPropertyName": base => base.pivotTo("lead").selectProperty("employeeId").multiply(base.selectProperty("employeeId"))
+      }["derivedPropertyName"](deriveObjectSet);
+      const definition = map.get(result);
+      expect(definition).toMatchInlineSnapshot(`
+        {
+          "properties": [
+            {
+              "objectSet": {
+                "link": "lead",
+                "objectSet": {
+                  "type": "methodInput",
+                },
+                "type": "searchAround",
+              },
+              "operation": {
+                "selectedPropertyApiName": "employeeId",
+                "type": "get",
+              },
+              "type": "selection",
+            },
+            {
+              "apiName": "employeeId",
+              "type": "property",
+            },
+          ],
+          "type": "multiply",
+        }
+      `);
+    });
 
     // TODO: Add test for literal
     it("can handle nested definitions in an expression", () => {

package/build/esm/derivedProperties/createWithPropertiesObjectSet.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"createWithPropertiesObjectSet.test.js","names":["Employee","describe","expect","it","createWithPropertiesObjectSet","map","Map","deriveObjectSet","type","result","base","pivotTo","selectProperty","definition","get","toMatchInlineSnapshot","clause","aggregate","percentile","limit","secondResult","secondDefinition","add","extractPart","min"],"sources":["createWithPropertiesObjectSet.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 { DerivedProperty } from \"@osdk/api\";\nimport { Employee } from \"@osdk/client.test.ontology\";\nimport type { DerivedPropertyDefinition } from \"@osdk/foundry.ontologies\";\nimport { describe, expect, it } from \"vitest\";\nimport { createWithPropertiesObjectSet } from \"./createWithPropertiesObjectSet.js\";\n\ndescribe(createWithPropertiesObjectSet, () => {\n  it(\"correctly creates basic object set with derived properties\", () => {\n    const map = new Map<any, DerivedPropertyDefinition>();\n    const deriveObjectSet = createWithPropertiesObjectSet(Employee, {\n      type: \"methodInput\",\n    }, map);\n\n    const clause = {\n      \"derivedPropertyName\": (base) =>\n        base.pivotTo(\"lead\").selectProperty(\"employeeId\"),\n    } satisfies DerivedProperty.Clause<Employee>;\n\n    const result = clause[\"derivedPropertyName\"](deriveObjectSet);\n    const definition = map.get(result);\n    expect(definition).toMatchInlineSnapshot(`\n        {\n          \"objectSet\": {\n            \"link\": \"lead\",\n            \"objectSet\": {\n              \"type\": \"methodInput\",\n            },\n            \"type\": \"searchAround\",\n          },\n          \"operation\": {\n            \"selectedPropertyApiName\": \"employeeId\",\n            \"type\": \"get\",\n          },\n          \"type\": \"selection\",\n        }\n      `);\n  });\n\n  it(\"correctly allows select property off the base object set\", () => {\n    const map = new Map<any, DerivedPropertyDefinition>();\n    const deriveObjectSet = createWithPropertiesObjectSet(\n      Employee,\n      {\n        type: \"methodInput\",\n      },\n      map,\n      true,\n    );\n\n    const clause = {\n      \"derivedPropertyName\": (base) => base.selectProperty(\"employeeId\"),\n    } satisfies DerivedProperty.Clause<Employee>;\n\n    const result = clause[\"derivedPropertyName\"](deriveObjectSet);\n    const definition = map.get(result);\n    expect(definition).toMatchInlineSnapshot(`\n      {\n        \"apiName\": \"employeeId\",\n        \"type\": \"property\",\n      }\n    `);\n  });\n\n  it(\"correctly handles multiple definitions in one clause\", () => {\n    const map = new Map<any, DerivedPropertyDefinition>();\n    const deriveObjectSet = createWithPropertiesObjectSet(Employee, {\n      type: \"methodInput\",\n    }, map);\n\n    const clause: DerivedProperty.Clause<Employee> = {\n      \"derivedPropertyName\": (base) =>\n        base.pivotTo(\"lead\").aggregate(\"employeeId:approximatePercentile\", {\n          percentile: 0.5,\n        }),\n\n      \"secondaryDerivedPropertyName\": (base) =>\n        base.pivotTo(\"lead\").aggregate(\"fullName:collectSet\", {\n          limit: 10,\n        }),\n    };\n\n    const result = clause[\"derivedPropertyName\"](deriveObjectSet);\n    const definition = map.get(result);\n\n    const secondResult = clause[\"secondaryDerivedPropertyName\"](\n      deriveObjectSet,\n    );\n    const secondDefinition = map.get(secondResult);\n\n    expect(definition).toMatchInlineSnapshot(`\n        {\n          \"objectSet\": {\n            \"link\": \"lead\",\n            \"objectSet\": {\n              \"type\": \"methodInput\",\n            },\n            \"type\": \"searchAround\",\n          },\n          \"operation\": {\n            \"approximatePercentile\": 0.5,\n            \"selectedPropertyApiName\": \"employeeId\",\n            \"type\": \"approximatePercentile\",\n          },\n          \"type\": \"selection\",\n        }\n      `);\n\n    expect(secondDefinition).toMatchInlineSnapshot(`\n        {\n          \"objectSet\": {\n            \"link\": \"lead\",\n            \"objectSet\": {\n              \"type\": \"methodInput\",\n            },\n            \"type\": \"searchAround\",\n          },\n          \"operation\": {\n            \"limit\": 10,\n            \"selectedPropertyApiName\": \"fullName\",\n            \"type\": \"collectSet\",\n          },\n          \"type\": \"selection\",\n        }\n      `);\n  });\n\n  describe(\"expressions\", () => {\n    it(\"can handle expressions referencing other property keys\", () => {\n      const map = new Map<any, DerivedPropertyDefinition>();\n      const deriveObjectSet = createWithPropertiesObjectSet(\n        Employee,\n        {\n          type: \"methodInput\",\n        },\n        map,\n        true,\n      );\n\n      const clause: DerivedProperty.Clause<Employee> = {\n        \"derivedPropertyName\": (base) =>\n          base.pivotTo(\"lead\").selectProperty(\"employeeId\").add(\n            base.selectProperty(\"employeeId\"),\n          ),\n        // \"secondaryDerivedPropertyName\": (base) =>\n        //   base.pivotTo(\"lead\").aggregate(\"employeeId:avg\").divide(\"employeeId\", 2),\n      };\n\n      const result = clause[\"derivedPropertyName\"](deriveObjectSet);\n      const definition = map.get(result);\n\n      expect(definition).toMatchInlineSnapshot(`\n        {\n          \"properties\": [\n            {\n              \"objectSet\": {\n                \"link\": \"lead\",\n                \"objectSet\": {\n                  \"type\": \"methodInput\",\n                },\n                \"type\": \"searchAround\",\n              },\n              \"operation\": {\n                \"selectedPropertyApiName\": \"employeeId\",\n                \"type\": \"get\",\n              },\n              \"type\": \"selection\",\n            },\n            {\n              \"apiName\": \"employeeId\",\n              \"type\": \"property\",\n            },\n          ],\n          \"type\": \"add\",\n        }\n      `);\n    });\n\n    // TODO: Add test for literal\n    it(\"can handle nested definitions in an expression\", () => {\n      const map = new Map<any, DerivedPropertyDefinition>();\n      const deriveObjectSet = createWithPropertiesObjectSet(Employee, {\n        type: \"methodInput\",\n      }, map);\n\n      const clause: DerivedProperty.Clause<Employee> = {\n        \"derivedPropertyName\": (base) =>\n          base.pivotTo(\"lead\").selectProperty(\"employeeId\").add(\n            base.pivotTo(\"lead\").selectProperty(\"employeeId\"),\n          ),\n      };\n\n      const result = clause[\"derivedPropertyName\"](deriveObjectSet);\n      const definition = map.get(result);\n\n      expect(definition).toMatchInlineSnapshot(`\n        {\n          \"properties\": [\n            {\n              \"objectSet\": {\n                \"link\": \"lead\",\n                \"objectSet\": {\n                  \"type\": \"methodInput\",\n                },\n                \"type\": \"searchAround\",\n              },\n              \"operation\": {\n                \"selectedPropertyApiName\": \"employeeId\",\n                \"type\": \"get\",\n              },\n              \"type\": \"selection\",\n            },\n            {\n              \"objectSet\": {\n                \"link\": \"lead\",\n                \"objectSet\": {\n                  \"type\": \"methodInput\",\n                },\n                \"type\": \"searchAround\",\n              },\n              \"operation\": {\n                \"selectedPropertyApiName\": \"employeeId\",\n                \"type\": \"get\",\n              },\n              \"type\": \"selection\",\n            },\n          ],\n          \"type\": \"add\",\n        }\n      `);\n    });\n  });\n\n  it(\"handles datetime expressions\", () => {\n    const map = new Map<any, DerivedPropertyDefinition>();\n    const deriveObjectSet = createWithPropertiesObjectSet(Employee, {\n      type: \"methodInput\",\n    }, map);\n\n    const clause: DerivedProperty.Clause<Employee> = {\n      \"derivedPropertyName\": (base) =>\n        base.pivotTo(\"lead\").selectProperty(\"startDate\").extractPart(\"MONTHS\"),\n      \"secondaryDerivedPropertyName\": (base) =>\n        base.pivotTo(\"lead\").selectProperty(\"startDate\").min(\n          base.pivotTo(\"lead\").selectProperty(\"startDate\"),\n        ),\n    };\n\n    const result = clause[\"derivedPropertyName\"](deriveObjectSet);\n    const definition = map.get(result);\n\n    expect(definition).toMatchInlineSnapshot(`\n      {\n        \"part\": \"MONTHS\",\n        \"property\": {\n          \"objectSet\": {\n            \"link\": \"lead\",\n            \"objectSet\": {\n              \"type\": \"methodInput\",\n            },\n            \"type\": \"searchAround\",\n          },\n          \"operation\": {\n            \"selectedPropertyApiName\": \"startDate\",\n            \"type\": \"get\",\n          },\n          \"type\": \"selection\",\n        },\n        \"type\": \"extract\",\n      }\n    `);\n  });\n});\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA,SAASA,QAAQ,QAAQ,4BAA4B;AAErD,SAASC,QAAQ,EAAEC,MAAM,EAAEC,EAAE,QAAQ,QAAQ;AAC7C,SAASC,6BAA6B,QAAQ,oCAAoC;AAElFH,QAAQ,CAACG,6BAA6B,EAAE,MAAM;EAC5CD,EAAE,CAAC,4DAA4D,EAAE,MAAM;IACrE,MAAME,GAAG,GAAG,IAAIC,GAAG,CAAiC,CAAC;IACrD,MAAMC,eAAe,GAAGH,6BAA6B,CAACJ,QAAQ,EAAE;MAC9DQ,IAAI,EAAE;IACR,CAAC,EAAEH,GAAG,CAAC;IAOP,MAAMI,MAAM,GALG;MACb,qBAAqB,EAAGC,IAAI,IAC1BA,IAAI,CAACC,OAAO,CAAC,MAAM,CAAC,CAACC,cAAc,CAAC,YAAY;IACpD,CAAC,CAEqB,qBAAqB,CAAC,CAACL,eAAe,CAAC;IAC7D,MAAMM,UAAU,GAAGR,GAAG,CAACS,GAAG,CAACL,MAAM,CAAC;IAClCP,MAAM,CAACW,UAAU,CAAC,CAACE,qBAAqB,CAAC;AAC7C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,CAAC;EACN,CAAC,CAAC;EAEFZ,EAAE,CAAC,0DAA0D,EAAE,MAAM;IACnE,MAAME,GAAG,GAAG,IAAIC,GAAG,CAAiC,CAAC;IACrD,MAAMC,eAAe,GAAGH,6BAA6B,CACnDJ,QAAQ,EACR;MACEQ,IAAI,EAAE;IACR,CAAC,EACDH,GAAG,EACH,IACF,CAAC;IAMD,MAAMI,MAAM,GAJG;MACb,qBAAqB,EAAGC,IAAI,IAAKA,IAAI,CAACE,cAAc,CAAC,YAAY;IACnE,CAAC,CAEqB,qBAAqB,CAAC,CAACL,eAAe,CAAC;IAC7D,MAAMM,UAAU,GAAGR,GAAG,CAACS,GAAG,CAACL,MAAM,CAAC;IAClCP,MAAM,CAACW,UAAU,CAAC,CAACE,qBAAqB,CAAC;AAC7C;AACA;AACA;AACA;AACA,KAAK,CAAC;EACJ,CAAC,CAAC;EAEFZ,EAAE,CAAC,sDAAsD,EAAE,MAAM;IAC/D,MAAME,GAAG,GAAG,IAAIC,GAAG,CAAiC,CAAC;IACrD,MAAMC,eAAe,GAAGH,6BAA6B,CAACJ,QAAQ,EAAE;MAC9DQ,IAAI,EAAE;IACR,CAAC,EAAEH,GAAG,CAAC;IAEP,MAAMW,MAAwC,GAAG;MAC/C,qBAAqB,EAAGN,IAAI,IAC1BA,IAAI,CAACC,OAAO,CAAC,MAAM,CAAC,CAACM,SAAS,CAAC,kCAAkC,EAAE;QACjEC,UAAU,EAAE;MACd,CAAC,CAAC;MAEJ,8BAA8B,EAAGR,IAAI,IACnCA,IAAI,CAACC,OAAO,CAAC,MAAM,CAAC,CAACM,SAAS,CAAC,qBAAqB,EAAE;QACpDE,KAAK,EAAE;MACT,CAAC;IACL,CAAC;IAED,MAAMV,MAAM,GAAGO,MAAM,CAAC,qBAAqB,CAAC,CAACT,eAAe,CAAC;IAC7D,MAAMM,UAAU,GAAGR,GAAG,CAACS,GAAG,CAACL,MAAM,CAAC;IAElC,MAAMW,YAAY,GAAGJ,MAAM,CAAC,8BAA8B,CAAC,CACzDT,eACF,CAAC;IACD,MAAMc,gBAAgB,GAAGhB,GAAG,CAACS,GAAG,CAACM,YAAY,CAAC;IAE9ClB,MAAM,CAACW,UAAU,CAAC,CAACE,qBAAqB,CAAC;AAC7C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,CAAC;IAEJb,MAAM,CAACmB,gBAAgB,CAAC,CAACN,qBAAqB,CAAC;AACnD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,CAAC;EACN,CAAC,CAAC;EAEFd,QAAQ,CAAC,aAAa,EAAE,MAAM;IAC5BE,EAAE,CAAC,wDAAwD,EAAE,MAAM;MACjE,MAAME,GAAG,GAAG,IAAIC,GAAG,CAAiC,CAAC;MACrD,MAAMC,eAAe,GAAGH,6BAA6B,CACnDJ,QAAQ,EACR;QACEQ,IAAI,EAAE;MACR,CAAC,EACDH,GAAG,EACH,IACF,CAAC;MAWD,MAAMI,MAAM,GATqC;QAC/C,qBAAqB,EAAGC,IAAI,IAC1BA,IAAI,CAACC,OAAO,CAAC,MAAM,CAAC,CAACC,cAAc,CAAC,YAAY,CAAC,CAACU,GAAG,CACnDZ,IAAI,CAACE,cAAc,CAAC,YAAY,CAClC;QACF;QACA;MACF,CAAC,CAEqB,qBAAqB,CAAC,CAACL,eAAe,CAAC;MAC7D,MAAMM,UAAU,GAAGR,GAAG,CAACS,GAAG,CAACL,MAAM,CAAC;MAElCP,MAAM,CAACW,UAAU,CAAC,CAACE,qBAAqB,CAAC;AAC/C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,CAAC;IACJ,CAAC,CAAC;;IAEF;IACAZ,EAAE,CAAC,gDAAgD,EAAE,MAAM;MACzD,MAAME,GAAG,GAAG,IAAIC,GAAG,CAAiC,CAAC;MACrD,MAAMC,eAAe,GAAGH,6BAA6B,CAACJ,QAAQ,EAAE;QAC9DQ,IAAI,EAAE;MACR,CAAC,EAAEH,GAAG,CAAC;MASP,MAAMI,MAAM,GAPqC;QAC/C,qBAAqB,EAAGC,IAAI,IAC1BA,IAAI,CAACC,OAAO,CAAC,MAAM,CAAC,CAACC,cAAc,CAAC,YAAY,CAAC,CAACU,GAAG,CACnDZ,IAAI,CAACC,OAAO,CAAC,MAAM,CAAC,CAACC,cAAc,CAAC,YAAY,CAClD;MACJ,CAAC,CAEqB,qBAAqB,CAAC,CAACL,eAAe,CAAC;MAC7D,MAAMM,UAAU,GAAGR,GAAG,CAACS,GAAG,CAACL,MAAM,CAAC;MAElCP,MAAM,CAACW,UAAU,CAAC,CAACE,qBAAqB,CAAC;AAC/C;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,CAAC;IACJ,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFZ,EAAE,CAAC,8BAA8B,EAAE,MAAM;IACvC,MAAME,GAAG,GAAG,IAAIC,GAAG,CAAiC,CAAC;IACrD,MAAMC,eAAe,GAAGH,6BAA6B,CAACJ,QAAQ,EAAE;MAC9DQ,IAAI,EAAE;IACR,CAAC,EAAEH,GAAG,CAAC;IAWP,MAAMI,MAAM,GATqC;MAC/C,qBAAqB,EAAGC,IAAI,IAC1BA,IAAI,CAACC,OAAO,CAAC,MAAM,CAAC,CAACC,cAAc,CAAC,WAAW,CAAC,CAACW,WAAW,CAAC,QAAQ,CAAC;MACxE,8BAA8B,EAAGb,IAAI,IACnCA,IAAI,CAACC,OAAO,CAAC,MAAM,CAAC,CAACC,cAAc,CAAC,WAAW,CAAC,CAACY,GAAG,CAClDd,IAAI,CAACC,OAAO,CAAC,MAAM,CAAC,CAACC,cAAc,CAAC,WAAW,CACjD;IACJ,CAAC,CAEqB,qBAAqB,CAAC,CAACL,eAAe,CAAC;IAC7D,MAAMM,UAAU,GAAGR,GAAG,CAACS,GAAG,CAACL,MAAM,CAAC;IAElCP,MAAM,CAACW,UAAU,CAAC,CAACE,qBAAqB,CAAC;AAC7C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,KAAK,CAAC;EACJ,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}
+{"version":3,"file":"createWithPropertiesObjectSet.test.js","names":["Employee","describe","expect","it","createWithPropertiesObjectSet","map","Map","deriveObjectSet","type","result","base","pivotTo","selectProperty","definition","get","toMatchInlineSnapshot","clause","aggregate","percentile","limit","secondResult","secondDefinition","add","subtract","divide","multiply","extractPart","min"],"sources":["createWithPropertiesObjectSet.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 { DerivedProperty } from \"@osdk/api\";\nimport { Employee } from \"@osdk/client.test.ontology\";\nimport type { DerivedPropertyDefinition } from \"@osdk/foundry.ontologies\";\nimport { describe, expect, it } from \"vitest\";\nimport { createWithPropertiesObjectSet } from \"./createWithPropertiesObjectSet.js\";\n\ndescribe(createWithPropertiesObjectSet, () => {\n  it(\"correctly creates basic object set with derived properties\", () => {\n    const map = new Map<any, DerivedPropertyDefinition>();\n    const deriveObjectSet = createWithPropertiesObjectSet(Employee, {\n      type: \"methodInput\",\n    }, map);\n\n    const clause = {\n      \"derivedPropertyName\": (base) =>\n        base.pivotTo(\"lead\").selectProperty(\"employeeId\"),\n    } satisfies DerivedProperty.Clause<Employee>;\n\n    const result = clause[\"derivedPropertyName\"](deriveObjectSet);\n    const definition = map.get(result);\n    expect(definition).toMatchInlineSnapshot(`\n        {\n          \"objectSet\": {\n            \"link\": \"lead\",\n            \"objectSet\": {\n              \"type\": \"methodInput\",\n            },\n            \"type\": \"searchAround\",\n          },\n          \"operation\": {\n            \"selectedPropertyApiName\": \"employeeId\",\n            \"type\": \"get\",\n          },\n          \"type\": \"selection\",\n        }\n      `);\n  });\n\n  it(\"correctly allows select property off the base object set\", () => {\n    const map = new Map<any, DerivedPropertyDefinition>();\n    const deriveObjectSet = createWithPropertiesObjectSet(\n      Employee,\n      {\n        type: \"methodInput\",\n      },\n      map,\n      true,\n    );\n\n    const clause = {\n      \"derivedPropertyName\": (base) => base.selectProperty(\"employeeId\"),\n    } satisfies DerivedProperty.Clause<Employee>;\n\n    const result = clause[\"derivedPropertyName\"](deriveObjectSet);\n    const definition = map.get(result);\n    expect(definition).toMatchInlineSnapshot(`\n      {\n        \"apiName\": \"employeeId\",\n        \"type\": \"property\",\n      }\n    `);\n  });\n\n  it(\"correctly handles multiple definitions in one clause\", () => {\n    const map = new Map<any, DerivedPropertyDefinition>();\n    const deriveObjectSet = createWithPropertiesObjectSet(Employee, {\n      type: \"methodInput\",\n    }, map);\n\n    const clause: DerivedProperty.Clause<Employee> = {\n      \"derivedPropertyName\": (base) =>\n        base.pivotTo(\"lead\").aggregate(\"employeeId:approximatePercentile\", {\n          percentile: 0.5,\n        }),\n\n      \"secondaryDerivedPropertyName\": (base) =>\n        base.pivotTo(\"lead\").aggregate(\"fullName:collectSet\", {\n          limit: 10,\n        }),\n    };\n\n    const result = clause[\"derivedPropertyName\"](deriveObjectSet);\n    const definition = map.get(result);\n\n    const secondResult = clause[\"secondaryDerivedPropertyName\"](\n      deriveObjectSet,\n    );\n    const secondDefinition = map.get(secondResult);\n\n    expect(definition).toMatchInlineSnapshot(`\n        {\n          \"objectSet\": {\n            \"link\": \"lead\",\n            \"objectSet\": {\n              \"type\": \"methodInput\",\n            },\n            \"type\": \"searchAround\",\n          },\n          \"operation\": {\n            \"approximatePercentile\": 0.5,\n            \"selectedPropertyApiName\": \"employeeId\",\n            \"type\": \"approximatePercentile\",\n          },\n          \"type\": \"selection\",\n        }\n      `);\n\n    expect(secondDefinition).toMatchInlineSnapshot(`\n        {\n          \"objectSet\": {\n            \"link\": \"lead\",\n            \"objectSet\": {\n              \"type\": \"methodInput\",\n            },\n            \"type\": \"searchAround\",\n          },\n          \"operation\": {\n            \"limit\": 10,\n            \"selectedPropertyApiName\": \"fullName\",\n            \"type\": \"collectSet\",\n          },\n          \"type\": \"selection\",\n        }\n      `);\n  });\n\n  describe(\"expressions\", () => {\n    it(\"can handle expressions referencing other property keys\", () => {\n      const map = new Map<any, DerivedPropertyDefinition>();\n      const deriveObjectSet = createWithPropertiesObjectSet(\n        Employee,\n        {\n          type: \"methodInput\",\n        },\n        map,\n        true,\n      );\n\n      const clause: DerivedProperty.Clause<Employee> = {\n        \"derivedPropertyName\": (base) =>\n          base.pivotTo(\"lead\").selectProperty(\"employeeId\").add(\n            base.selectProperty(\"employeeId\"),\n          ),\n        // \"secondaryDerivedPropertyName\": (base) =>\n        //   base.pivotTo(\"lead\").aggregate(\"employeeId:avg\").divide(\"employeeId\", 2),\n      };\n\n      const result = clause[\"derivedPropertyName\"](deriveObjectSet);\n      const definition = map.get(result);\n\n      expect(definition).toMatchInlineSnapshot(`\n        {\n          \"properties\": [\n            {\n              \"objectSet\": {\n                \"link\": \"lead\",\n                \"objectSet\": {\n                  \"type\": \"methodInput\",\n                },\n                \"type\": \"searchAround\",\n              },\n              \"operation\": {\n                \"selectedPropertyApiName\": \"employeeId\",\n                \"type\": \"get\",\n              },\n              \"type\": \"selection\",\n            },\n            {\n              \"apiName\": \"employeeId\",\n              \"type\": \"property\",\n            },\n          ],\n          \"type\": \"add\",\n        }\n      `);\n    });\n\n    it(\"subtract produces correct wire format\", () => {\n      const map = new Map<any, DerivedPropertyDefinition>();\n      const deriveObjectSet = createWithPropertiesObjectSet(\n        Employee,\n        { type: \"methodInput\" },\n        map,\n        true,\n      );\n\n      const clause: DerivedProperty.Clause<Employee> = {\n        \"derivedPropertyName\": (base) =>\n          base.pivotTo(\"lead\").selectProperty(\"employeeId\").subtract(\n            base.selectProperty(\"employeeId\"),\n          ),\n      };\n\n      const result = clause[\"derivedPropertyName\"](deriveObjectSet);\n      const definition = map.get(result);\n\n      expect(definition).toMatchInlineSnapshot(`\n        {\n          \"left\": {\n            \"objectSet\": {\n              \"link\": \"lead\",\n              \"objectSet\": {\n                \"type\": \"methodInput\",\n              },\n              \"type\": \"searchAround\",\n            },\n            \"operation\": {\n              \"selectedPropertyApiName\": \"employeeId\",\n              \"type\": \"get\",\n            },\n            \"type\": \"selection\",\n          },\n          \"right\": {\n            \"apiName\": \"employeeId\",\n            \"type\": \"property\",\n          },\n          \"type\": \"subtract\",\n        }\n      `);\n    });\n\n    it(\"divide produces correct wire format\", () => {\n      const map = new Map<any, DerivedPropertyDefinition>();\n      const deriveObjectSet = createWithPropertiesObjectSet(\n        Employee,\n        { type: \"methodInput\" },\n        map,\n        true,\n      );\n\n      const clause: DerivedProperty.Clause<Employee> = {\n        \"derivedPropertyName\": (base) =>\n          base.pivotTo(\"lead\").selectProperty(\"employeeId\").divide(\n            base.selectProperty(\"employeeId\"),\n          ),\n      };\n\n      const result = clause[\"derivedPropertyName\"](deriveObjectSet);\n      const definition = map.get(result);\n\n      expect(definition).toMatchInlineSnapshot(`\n        {\n          \"left\": {\n            \"objectSet\": {\n              \"link\": \"lead\",\n              \"objectSet\": {\n                \"type\": \"methodInput\",\n              },\n              \"type\": \"searchAround\",\n            },\n            \"operation\": {\n              \"selectedPropertyApiName\": \"employeeId\",\n              \"type\": \"get\",\n            },\n            \"type\": \"selection\",\n          },\n          \"right\": {\n            \"apiName\": \"employeeId\",\n            \"type\": \"property\",\n          },\n          \"type\": \"divide\",\n        }\n      `);\n    });\n\n    it(\"multiply produces correct wire format\", () => {\n      const map = new Map<any, DerivedPropertyDefinition>();\n      const deriveObjectSet = createWithPropertiesObjectSet(\n        Employee,\n        { type: \"methodInput\" },\n        map,\n        true,\n      );\n\n      const clause: DerivedProperty.Clause<Employee> = {\n        \"derivedPropertyName\": (base) =>\n          base.pivotTo(\"lead\").selectProperty(\"employeeId\").multiply(\n            base.selectProperty(\"employeeId\"),\n          ),\n      };\n\n      const result = clause[\"derivedPropertyName\"](deriveObjectSet);\n      const definition = map.get(result);\n\n      expect(definition).toMatchInlineSnapshot(`\n        {\n          \"properties\": [\n            {\n              \"objectSet\": {\n                \"link\": \"lead\",\n                \"objectSet\": {\n                  \"type\": \"methodInput\",\n                },\n                \"type\": \"searchAround\",\n              },\n              \"operation\": {\n                \"selectedPropertyApiName\": \"employeeId\",\n                \"type\": \"get\",\n              },\n              \"type\": \"selection\",\n            },\n            {\n              \"apiName\": \"employeeId\",\n              \"type\": \"property\",\n            },\n          ],\n          \"type\": \"multiply\",\n        }\n      `);\n    });\n\n    // TODO: Add test for literal\n    it(\"can handle nested definitions in an expression\", () => {\n      const map = new Map<any, DerivedPropertyDefinition>();\n      const deriveObjectSet = createWithPropertiesObjectSet(Employee, {\n        type: \"methodInput\",\n      }, map);\n\n      const clause: DerivedProperty.Clause<Employee> = {\n        \"derivedPropertyName\": (base) =>\n          base.pivotTo(\"lead\").selectProperty(\"employeeId\").add(\n            base.pivotTo(\"lead\").selectProperty(\"employeeId\"),\n          ),\n      };\n\n      const result = clause[\"derivedPropertyName\"](deriveObjectSet);\n      const definition = map.get(result);\n\n      expect(definition).toMatchInlineSnapshot(`\n        {\n          \"properties\": [\n            {\n              \"objectSet\": {\n                \"link\": \"lead\",\n                \"objectSet\": {\n                  \"type\": \"methodInput\",\n                },\n                \"type\": \"searchAround\",\n              },\n              \"operation\": {\n                \"selectedPropertyApiName\": \"employeeId\",\n                \"type\": \"get\",\n              },\n              \"type\": \"selection\",\n            },\n            {\n              \"objectSet\": {\n                \"link\": \"lead\",\n                \"objectSet\": {\n                  \"type\": \"methodInput\",\n                },\n                \"type\": \"searchAround\",\n              },\n              \"operation\": {\n                \"selectedPropertyApiName\": \"employeeId\",\n                \"type\": \"get\",\n              },\n              \"type\": \"selection\",\n            },\n          ],\n          \"type\": \"add\",\n        }\n      `);\n    });\n  });\n\n  it(\"handles datetime expressions\", () => {\n    const map = new Map<any, DerivedPropertyDefinition>();\n    const deriveObjectSet = createWithPropertiesObjectSet(Employee, {\n      type: \"methodInput\",\n    }, map);\n\n    const clause: DerivedProperty.Clause<Employee> = {\n      \"derivedPropertyName\": (base) =>\n        base.pivotTo(\"lead\").selectProperty(\"startDate\").extractPart(\"MONTHS\"),\n      \"secondaryDerivedPropertyName\": (base) =>\n        base.pivotTo(\"lead\").selectProperty(\"startDate\").min(\n          base.pivotTo(\"lead\").selectProperty(\"startDate\"),\n        ),\n    };\n\n    const result = clause[\"derivedPropertyName\"](deriveObjectSet);\n    const definition = map.get(result);\n\n    expect(definition).toMatchInlineSnapshot(`\n      {\n        \"part\": \"MONTHS\",\n        \"property\": {\n          \"objectSet\": {\n            \"link\": \"lead\",\n            \"objectSet\": {\n              \"type\": \"methodInput\",\n            },\n            \"type\": \"searchAround\",\n          },\n          \"operation\": {\n            \"selectedPropertyApiName\": \"startDate\",\n            \"type\": \"get\",\n          },\n          \"type\": \"selection\",\n        },\n        \"type\": \"extract\",\n      }\n    `);\n  });\n});\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA,SAASA,QAAQ,QAAQ,4BAA4B;AAErD,SAASC,QAAQ,EAAEC,MAAM,EAAEC,EAAE,QAAQ,QAAQ;AAC7C,SAASC,6BAA6B,QAAQ,oCAAoC;AAElFH,QAAQ,CAACG,6BAA6B,EAAE,MAAM;EAC5CD,EAAE,CAAC,4DAA4D,EAAE,MAAM;IACrE,MAAME,GAAG,GAAG,IAAIC,GAAG,CAAiC,CAAC;IACrD,MAAMC,eAAe,GAAGH,6BAA6B,CAACJ,QAAQ,EAAE;MAC9DQ,IAAI,EAAE;IACR,CAAC,EAAEH,GAAG,CAAC;IAOP,MAAMI,MAAM,GALG;MACb,qBAAqB,EAAGC,IAAI,IAC1BA,IAAI,CAACC,OAAO,CAAC,MAAM,CAAC,CAACC,cAAc,CAAC,YAAY;IACpD,CAAC,CAEqB,qBAAqB,CAAC,CAACL,eAAe,CAAC;IAC7D,MAAMM,UAAU,GAAGR,GAAG,CAACS,GAAG,CAACL,MAAM,CAAC;IAClCP,MAAM,CAACW,UAAU,CAAC,CAACE,qBAAqB,CAAC;AAC7C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,CAAC;EACN,CAAC,CAAC;EAEFZ,EAAE,CAAC,0DAA0D,EAAE,MAAM;IACnE,MAAME,GAAG,GAAG,IAAIC,GAAG,CAAiC,CAAC;IACrD,MAAMC,eAAe,GAAGH,6BAA6B,CACnDJ,QAAQ,EACR;MACEQ,IAAI,EAAE;IACR,CAAC,EACDH,GAAG,EACH,IACF,CAAC;IAMD,MAAMI,MAAM,GAJG;MACb,qBAAqB,EAAGC,IAAI,IAAKA,IAAI,CAACE,cAAc,CAAC,YAAY;IACnE,CAAC,CAEqB,qBAAqB,CAAC,CAACL,eAAe,CAAC;IAC7D,MAAMM,UAAU,GAAGR,GAAG,CAACS,GAAG,CAACL,MAAM,CAAC;IAClCP,MAAM,CAACW,UAAU,CAAC,CAACE,qBAAqB,CAAC;AAC7C;AACA;AACA;AACA;AACA,KAAK,CAAC;EACJ,CAAC,CAAC;EAEFZ,EAAE,CAAC,sDAAsD,EAAE,MAAM;IAC/D,MAAME,GAAG,GAAG,IAAIC,GAAG,CAAiC,CAAC;IACrD,MAAMC,eAAe,GAAGH,6BAA6B,CAACJ,QAAQ,EAAE;MAC9DQ,IAAI,EAAE;IACR,CAAC,EAAEH,GAAG,CAAC;IAEP,MAAMW,MAAwC,GAAG;MAC/C,qBAAqB,EAAGN,IAAI,IAC1BA,IAAI,CAACC,OAAO,CAAC,MAAM,CAAC,CAACM,SAAS,CAAC,kCAAkC,EAAE;QACjEC,UAAU,EAAE;MACd,CAAC,CAAC;MAEJ,8BAA8B,EAAGR,IAAI,IACnCA,IAAI,CAACC,OAAO,CAAC,MAAM,CAAC,CAACM,SAAS,CAAC,qBAAqB,EAAE;QACpDE,KAAK,EAAE;MACT,CAAC;IACL,CAAC;IAED,MAAMV,MAAM,GAAGO,MAAM,CAAC,qBAAqB,CAAC,CAACT,eAAe,CAAC;IAC7D,MAAMM,UAAU,GAAGR,GAAG,CAACS,GAAG,CAACL,MAAM,CAAC;IAElC,MAAMW,YAAY,GAAGJ,MAAM,CAAC,8BAA8B,CAAC,CACzDT,eACF,CAAC;IACD,MAAMc,gBAAgB,GAAGhB,GAAG,CAACS,GAAG,CAACM,YAAY,CAAC;IAE9ClB,MAAM,CAACW,UAAU,CAAC,CAACE,qBAAqB,CAAC;AAC7C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,CAAC;IAEJb,MAAM,CAACmB,gBAAgB,CAAC,CAACN,qBAAqB,CAAC;AACnD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,CAAC;EACN,CAAC,CAAC;EAEFd,QAAQ,CAAC,aAAa,EAAE,MAAM;IAC5BE,EAAE,CAAC,wDAAwD,EAAE,MAAM;MACjE,MAAME,GAAG,GAAG,IAAIC,GAAG,CAAiC,CAAC;MACrD,MAAMC,eAAe,GAAGH,6BAA6B,CACnDJ,QAAQ,EACR;QACEQ,IAAI,EAAE;MACR,CAAC,EACDH,GAAG,EACH,IACF,CAAC;MAWD,MAAMI,MAAM,GATqC;QAC/C,qBAAqB,EAAGC,IAAI,IAC1BA,IAAI,CAACC,OAAO,CAAC,MAAM,CAAC,CAACC,cAAc,CAAC,YAAY,CAAC,CAACU,GAAG,CACnDZ,IAAI,CAACE,cAAc,CAAC,YAAY,CAClC;QACF;QACA;MACF,CAAC,CAEqB,qBAAqB,CAAC,CAACL,eAAe,CAAC;MAC7D,MAAMM,UAAU,GAAGR,GAAG,CAACS,GAAG,CAACL,MAAM,CAAC;MAElCP,MAAM,CAACW,UAAU,CAAC,CAACE,qBAAqB,CAAC;AAC/C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,CAAC;IACJ,CAAC,CAAC;IAEFZ,EAAE,CAAC,uCAAuC,EAAE,MAAM;MAChD,MAAME,GAAG,GAAG,IAAIC,GAAG,CAAiC,CAAC;MACrD,MAAMC,eAAe,GAAGH,6BAA6B,CACnDJ,QAAQ,EACR;QAAEQ,IAAI,EAAE;MAAc,CAAC,EACvBH,GAAG,EACH,IACF,CAAC;MASD,MAAMI,MAAM,GAPqC;QAC/C,qBAAqB,EAAGC,IAAI,IAC1BA,IAAI,CAACC,OAAO,CAAC,MAAM,CAAC,CAACC,cAAc,CAAC,YAAY,CAAC,CAACW,QAAQ,CACxDb,IAAI,CAACE,cAAc,CAAC,YAAY,CAClC;MACJ,CAAC,CAEqB,qBAAqB,CAAC,CAACL,eAAe,CAAC;MAC7D,MAAMM,UAAU,GAAGR,GAAG,CAACS,GAAG,CAACL,MAAM,CAAC;MAElCP,MAAM,CAACW,UAAU,CAAC,CAACE,qBAAqB,CAAC;AAC/C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,CAAC;IACJ,CAAC,CAAC;IAEFZ,EAAE,CAAC,qCAAqC,EAAE,MAAM;MAC9C,MAAME,GAAG,GAAG,IAAIC,GAAG,CAAiC,CAAC;MACrD,MAAMC,eAAe,GAAGH,6BAA6B,CACnDJ,QAAQ,EACR;QAAEQ,IAAI,EAAE;MAAc,CAAC,EACvBH,GAAG,EACH,IACF,CAAC;MASD,MAAMI,MAAM,GAPqC;QAC/C,qBAAqB,EAAGC,IAAI,IAC1BA,IAAI,CAACC,OAAO,CAAC,MAAM,CAAC,CAACC,cAAc,CAAC,YAAY,CAAC,CAACY,MAAM,CACtDd,IAAI,CAACE,cAAc,CAAC,YAAY,CAClC;MACJ,CAAC,CAEqB,qBAAqB,CAAC,CAACL,eAAe,CAAC;MAC7D,MAAMM,UAAU,GAAGR,GAAG,CAACS,GAAG,CAACL,MAAM,CAAC;MAElCP,MAAM,CAACW,UAAU,CAAC,CAACE,qBAAqB,CAAC;AAC/C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,CAAC;IACJ,CAAC,CAAC;IAEFZ,EAAE,CAAC,uCAAuC,EAAE,MAAM;MAChD,MAAME,GAAG,GAAG,IAAIC,GAAG,CAAiC,CAAC;MACrD,MAAMC,eAAe,GAAGH,6BAA6B,CACnDJ,QAAQ,EACR;QAAEQ,IAAI,EAAE;MAAc,CAAC,EACvBH,GAAG,EACH,IACF,CAAC;MASD,MAAMI,MAAM,GAPqC;QAC/C,qBAAqB,EAAGC,IAAI,IAC1BA,IAAI,CAACC,OAAO,CAAC,MAAM,CAAC,CAACC,cAAc,CAAC,YAAY,CAAC,CAACa,QAAQ,CACxDf,IAAI,CAACE,cAAc,CAAC,YAAY,CAClC;MACJ,CAAC,CAEqB,qBAAqB,CAAC,CAACL,eAAe,CAAC;MAC7D,MAAMM,UAAU,GAAGR,GAAG,CAACS,GAAG,CAACL,MAAM,CAAC;MAElCP,MAAM,CAACW,UAAU,CAAC,CAACE,qBAAqB,CAAC;AAC/C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,CAAC;IACJ,CAAC,CAAC;;IAEF;IACAZ,EAAE,CAAC,gDAAgD,EAAE,MAAM;MACzD,MAAME,GAAG,GAAG,IAAIC,GAAG,CAAiC,CAAC;MACrD,MAAMC,eAAe,GAAGH,6BAA6B,CAACJ,QAAQ,EAAE;QAC9DQ,IAAI,EAAE;MACR,CAAC,EAAEH,GAAG,CAAC;MASP,MAAMI,MAAM,GAPqC;QAC/C,qBAAqB,EAAGC,IAAI,IAC1BA,IAAI,CAACC,OAAO,CAAC,MAAM,CAAC,CAACC,cAAc,CAAC,YAAY,CAAC,CAACU,GAAG,CACnDZ,IAAI,CAACC,OAAO,CAAC,MAAM,CAAC,CAACC,cAAc,CAAC,YAAY,CAClD;MACJ,CAAC,CAEqB,qBAAqB,CAAC,CAACL,eAAe,CAAC;MAC7D,MAAMM,UAAU,GAAGR,GAAG,CAACS,GAAG,CAACL,MAAM,CAAC;MAElCP,MAAM,CAACW,UAAU,CAAC,CAACE,qBAAqB,CAAC;AAC/C;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,CAAC;IACJ,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFZ,EAAE,CAAC,8BAA8B,EAAE,MAAM;IACvC,MAAME,GAAG,GAAG,IAAIC,GAAG,CAAiC,CAAC;IACrD,MAAMC,eAAe,GAAGH,6BAA6B,CAACJ,QAAQ,EAAE;MAC9DQ,IAAI,EAAE;IACR,CAAC,EAAEH,GAAG,CAAC;IAWP,MAAMI,MAAM,GATqC;MAC/C,qBAAqB,EAAGC,IAAI,IAC1BA,IAAI,CAACC,OAAO,CAAC,MAAM,CAAC,CAACC,cAAc,CAAC,WAAW,CAAC,CAACc,WAAW,CAAC,QAAQ,CAAC;MACxE,8BAA8B,EAAGhB,IAAI,IACnCA,IAAI,CAACC,OAAO,CAAC,MAAM,CAAC,CAACC,cAAc,CAAC,WAAW,CAAC,CAACe,GAAG,CAClDjB,IAAI,CAACC,OAAO,CAAC,MAAM,CAAC,CAACC,cAAc,CAAC,WAAW,CACjD;IACJ,CAAC,CAEqB,qBAAqB,CAAC,CAACL,eAAe,CAAC;IAC7D,MAAMM,UAAU,GAAGR,GAAG,CAACS,GAAG,CAACL,MAAM,CAAC;IAElCP,MAAM,CAACW,UAAU,CAAC,CAACE,qBAAqB,CAAC;AAC7C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,KAAK,CAAC;EACJ,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}

package/build/esm/derivedProperties/derivedPropertyDefinitionFactory.js

@@ -64,7 +64,7 @@ export function derivedPropertyDefinitionFactory(wireDefinition, definitionMap)
     },
     divide(value) {
       return derivedPropertyDefinitionFactory({
-        "type": "subtract",
+        "type": "divide",
         "left": wireDefinition,
         "right": getDefinitionFromMap(value, definitionMap)
       }, definitionMap);

package/build/esm/derivedProperties/derivedPropertyDefinitionFactory.js.map

@@ -1 +1 @@
-{"version":3,"file":"derivedPropertyDefinitionFactory.js","names":["invariant","derivedPropertyDefinitionFactory","wireDefinition","definitionMap","definition","abs","type","property","negate","max","value","properties","getDefinitionFromMap","min","add","subtract","multiply","divide","extractPart","part","set","arg","get","process","env","NODE_ENV"],"sources":["derivedPropertyDefinitionFactory.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 { DerivedProperty } from \"@osdk/api\";\nimport type { DerivedPropertyDefinition } from \"@osdk/foundry.ontologies\";\nimport invariant from \"tiny-invariant\";\n\n/** @internal */\nexport function derivedPropertyDefinitionFactory(\n  wireDefinition: DerivedPropertyDefinition,\n  definitionMap: Map<any, DerivedPropertyDefinition>,\n): DerivedProperty.NumericPropertyDefinition<any, any> & {\n  extractPart: DerivedProperty.DatetimePropertyDefinition<\n    any,\n    any\n  >[\"extractPart\"];\n} {\n  type RemoveSymbolKeys<T> = {\n    [K in keyof T as K extends symbol ? never : K]: T[K];\n  };\n\n  const definition:\n    & RemoveSymbolKeys<DerivedProperty.NumericPropertyDefinition<any, any>>\n    & {\n      extractPart: DerivedProperty.DatetimePropertyDefinition<\n        any,\n        any\n      >[\"extractPart\"];\n    } = {\n      abs() {\n        return derivedPropertyDefinitionFactory({\n          type: \"absoluteValue\",\n          property: wireDefinition,\n        }, definitionMap);\n      },\n      negate() {\n        return derivedPropertyDefinitionFactory({\n          type: \"negate\",\n          property: wireDefinition,\n        }, definitionMap);\n      },\n      max(value) {\n        return derivedPropertyDefinitionFactory({\n          type: \"greatest\",\n          properties: [\n            wireDefinition,\n            getDefinitionFromMap(value, definitionMap),\n          ],\n        }, definitionMap);\n      },\n      min(value) {\n        return derivedPropertyDefinitionFactory({\n          type: \"least\",\n          properties: [\n            wireDefinition,\n            getDefinitionFromMap(value, definitionMap),\n          ],\n        }, definitionMap);\n      },\n      add(\n        value,\n      ) {\n        return derivedPropertyDefinitionFactory({\n          type: \"add\",\n          properties: [\n            wireDefinition,\n            getDefinitionFromMap(value, definitionMap),\n          ],\n        }, definitionMap);\n      },\n      subtract(\n        value,\n      ) {\n        return derivedPropertyDefinitionFactory({\n          \"type\": \"subtract\",\n          \"left\": wireDefinition,\n          \"right\": getDefinitionFromMap(value, definitionMap),\n        }, definitionMap);\n      },\n      multiply(\n        value,\n      ) {\n        return derivedPropertyDefinitionFactory({\n          type: \"multiply\",\n          properties: [\n            wireDefinition,\n            getDefinitionFromMap(value, definitionMap),\n          ],\n        }, definitionMap);\n      },\n      divide(\n        value,\n      ) {\n        return derivedPropertyDefinitionFactory({\n          \"type\": \"subtract\",\n          \"left\": wireDefinition,\n          \"right\": getDefinitionFromMap(value, definitionMap),\n        }, definitionMap);\n      },\n      extractPart: (part) => {\n        return derivedPropertyDefinitionFactory({\n          type: \"extract\",\n          part,\n          property: wireDefinition,\n        }, definitionMap);\n      },\n    };\n\n  definitionMap.set(definition, wireDefinition);\n  return definition as any;\n}\n\nconst getDefinitionFromMap = (\n  arg: string | number | DerivedProperty.Definition<any, any>,\n  definitionMap: Map<any, DerivedPropertyDefinition>,\n): DerivedPropertyDefinition => {\n  if (typeof arg === \"object\") {\n    const definition = definitionMap.get(arg);\n    invariant(definition, \"Derived Property is not defined\");\n    return definition;\n  } else if (typeof arg === \"number\") {\n    invariant(false, \"Literals for derived properties are not yet supported\");\n  }\n  invariant(false, \"Invalid argument type for a derived property\");\n};\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAIA,OAAOA,SAAS,MAAM,gBAAgB;;AAEtC;AACA,OAAO,SAASC,gCAAgCA,CAC9CC,cAAyC,EACzCC,aAAkD,EAMlD;EAKA,MAAMC,UAOH,GAAG;IACFC,GAAGA,CAAA,EAAG;MACJ,OAAOJ,gCAAgC,CAAC;QACtCK,IAAI,EAAE,eAAe;QACrBC,QAAQ,EAAEL;MACZ,CAAC,EAAEC,aAAa,CAAC;IACnB,CAAC;IACDK,MAAMA,CAAA,EAAG;MACP,OAAOP,gCAAgC,CAAC;QACtCK,IAAI,EAAE,QAAQ;QACdC,QAAQ,EAAEL;MACZ,CAAC,EAAEC,aAAa,CAAC;IACnB,CAAC;IACDM,GAAGA,CAACC,KAAK,EAAE;MACT,OAAOT,gCAAgC,CAAC;QACtCK,IAAI,EAAE,UAAU;QAChBK,UAAU,EAAE,CACVT,cAAc,EACdU,oBAAoB,CAACF,KAAK,EAAEP,aAAa,CAAC;MAE9C,CAAC,EAAEA,aAAa,CAAC;IACnB,CAAC;IACDU,GAAGA,CAACH,KAAK,EAAE;MACT,OAAOT,gCAAgC,CAAC;QACtCK,IAAI,EAAE,OAAO;QACbK,UAAU,EAAE,CACVT,cAAc,EACdU,oBAAoB,CAACF,KAAK,EAAEP,aAAa,CAAC;MAE9C,CAAC,EAAEA,aAAa,CAAC;IACnB,CAAC;IACDW,GAAGA,CACDJ,KAAK,EACL;MACA,OAAOT,gCAAgC,CAAC;QACtCK,IAAI,EAAE,KAAK;QACXK,UAAU,EAAE,CACVT,cAAc,EACdU,oBAAoB,CAACF,KAAK,EAAEP,aAAa,CAAC;MAE9C,CAAC,EAAEA,aAAa,CAAC;IACnB,CAAC;IACDY,QAAQA,CACNL,KAAK,EACL;MACA,OAAOT,gCAAgC,CAAC;QACtC,MAAM,EAAE,UAAU;QAClB,MAAM,EAAEC,cAAc;QACtB,OAAO,EAAEU,oBAAoB,CAACF,KAAK,EAAEP,aAAa;MACpD,CAAC,EAAEA,aAAa,CAAC;IACnB,CAAC;IACDa,QAAQA,CACNN,KAAK,EACL;MACA,OAAOT,gCAAgC,CAAC;QACtCK,IAAI,EAAE,UAAU;QAChBK,UAAU,EAAE,CACVT,cAAc,EACdU,oBAAoB,CAACF,KAAK,EAAEP,aAAa,CAAC;MAE9C,CAAC,EAAEA,aAAa,CAAC;IACnB,CAAC;IACDc,MAAMA,CACJP,KAAK,EACL;MACA,OAAOT,gCAAgC,CAAC;QACtC,MAAM,EAAE,UAAU;QAClB,MAAM,EAAEC,cAAc;QACtB,OAAO,EAAEU,oBAAoB,CAACF,KAAK,EAAEP,aAAa;MACpD,CAAC,EAAEA,aAAa,CAAC;IACnB,CAAC;IACDe,WAAW,EAAGC,IAAI,IAAK;MACrB,OAAOlB,gCAAgC,CAAC;QACtCK,IAAI,EAAE,SAAS;QACfa,IAAI;QACJZ,QAAQ,EAAEL;MACZ,CAAC,EAAEC,aAAa,CAAC;IACnB;EACF,CAAC;EAEHA,aAAa,CAACiB,GAAG,CAAChB,UAAU,EAAEF,cAAc,CAAC;EAC7C,OAAOE,UAAU;AACnB;AAEA,MAAMQ,oBAAoB,GAAGA,CAC3BS,GAA2D,EAC3DlB,aAAkD,KACpB;EAC9B,IAAI,OAAOkB,GAAG,KAAK,QAAQ,EAAE;IAC3B,MAAMjB,UAAU,GAAGD,aAAa,CAACmB,GAAG,CAACD,GAAG,CAAC;IACzC,CAAUjB,UAAU,GAAAmB,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAApBzB,SAAS,QAAa,iCAAiC,IAAvDA,SAAS;IACT,OAAOI,UAAU;EACnB,CAAC,MAAM,IAAI,OAAOiB,GAAG,KAAK,QAAQ,EAAE;IAClCE,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAAAzB,SAAS,QAAQ,uDAAuD,IAAxEA,SAAS;EACX;EACAuB,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAAAzB,SAAS,QAAQ,8CAA8C,IAA/DA,SAAS;AACX,CAAC","ignoreList":[]}
+{"version":3,"file":"derivedPropertyDefinitionFactory.js","names":["invariant","derivedPropertyDefinitionFactory","wireDefinition","definitionMap","definition","abs","type","property","negate","max","value","properties","getDefinitionFromMap","min","add","subtract","multiply","divide","extractPart","part","set","arg","get","process","env","NODE_ENV"],"sources":["derivedPropertyDefinitionFactory.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 { DerivedProperty } from \"@osdk/api\";\nimport type { DerivedPropertyDefinition } from \"@osdk/foundry.ontologies\";\nimport invariant from \"tiny-invariant\";\n\n/** @internal */\nexport function derivedPropertyDefinitionFactory(\n  wireDefinition: DerivedPropertyDefinition,\n  definitionMap: Map<any, DerivedPropertyDefinition>,\n): DerivedProperty.NumericPropertyDefinition<any, any> & {\n  extractPart: DerivedProperty.DatetimePropertyDefinition<\n    any,\n    any\n  >[\"extractPart\"];\n} {\n  type RemoveSymbolKeys<T> = {\n    [K in keyof T as K extends symbol ? never : K]: T[K];\n  };\n\n  const definition:\n    & RemoveSymbolKeys<DerivedProperty.NumericPropertyDefinition<any, any>>\n    & {\n      extractPart: DerivedProperty.DatetimePropertyDefinition<\n        any,\n        any\n      >[\"extractPart\"];\n    } = {\n      abs() {\n        return derivedPropertyDefinitionFactory({\n          type: \"absoluteValue\",\n          property: wireDefinition,\n        }, definitionMap);\n      },\n      negate() {\n        return derivedPropertyDefinitionFactory({\n          type: \"negate\",\n          property: wireDefinition,\n        }, definitionMap);\n      },\n      max(value) {\n        return derivedPropertyDefinitionFactory({\n          type: \"greatest\",\n          properties: [\n            wireDefinition,\n            getDefinitionFromMap(value, definitionMap),\n          ],\n        }, definitionMap);\n      },\n      min(value) {\n        return derivedPropertyDefinitionFactory({\n          type: \"least\",\n          properties: [\n            wireDefinition,\n            getDefinitionFromMap(value, definitionMap),\n          ],\n        }, definitionMap);\n      },\n      add(\n        value,\n      ) {\n        return derivedPropertyDefinitionFactory({\n          type: \"add\",\n          properties: [\n            wireDefinition,\n            getDefinitionFromMap(value, definitionMap),\n          ],\n        }, definitionMap);\n      },\n      subtract(\n        value,\n      ) {\n        return derivedPropertyDefinitionFactory({\n          \"type\": \"subtract\",\n          \"left\": wireDefinition,\n          \"right\": getDefinitionFromMap(value, definitionMap),\n        }, definitionMap);\n      },\n      multiply(\n        value,\n      ) {\n        return derivedPropertyDefinitionFactory({\n          type: \"multiply\",\n          properties: [\n            wireDefinition,\n            getDefinitionFromMap(value, definitionMap),\n          ],\n        }, definitionMap);\n      },\n      divide(\n        value,\n      ) {\n        return derivedPropertyDefinitionFactory({\n          \"type\": \"divide\",\n          \"left\": wireDefinition,\n          \"right\": getDefinitionFromMap(value, definitionMap),\n        }, definitionMap);\n      },\n      extractPart: (part) => {\n        return derivedPropertyDefinitionFactory({\n          type: \"extract\",\n          part,\n          property: wireDefinition,\n        }, definitionMap);\n      },\n    };\n\n  definitionMap.set(definition, wireDefinition);\n  return definition as any;\n}\n\nconst getDefinitionFromMap = (\n  arg: string | number | DerivedProperty.Definition<any, any>,\n  definitionMap: Map<any, DerivedPropertyDefinition>,\n): DerivedPropertyDefinition => {\n  if (typeof arg === \"object\") {\n    const definition = definitionMap.get(arg);\n    invariant(definition, \"Derived Property is not defined\");\n    return definition;\n  } else if (typeof arg === \"number\") {\n    invariant(false, \"Literals for derived properties are not yet supported\");\n  }\n  invariant(false, \"Invalid argument type for a derived property\");\n};\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAIA,OAAOA,SAAS,MAAM,gBAAgB;;AAEtC;AACA,OAAO,SAASC,gCAAgCA,CAC9CC,cAAyC,EACzCC,aAAkD,EAMlD;EAKA,MAAMC,UAOH,GAAG;IACFC,GAAGA,CAAA,EAAG;MACJ,OAAOJ,gCAAgC,CAAC;QACtCK,IAAI,EAAE,eAAe;QACrBC,QAAQ,EAAEL;MACZ,CAAC,EAAEC,aAAa,CAAC;IACnB,CAAC;IACDK,MAAMA,CAAA,EAAG;MACP,OAAOP,gCAAgC,CAAC;QACtCK,IAAI,EAAE,QAAQ;QACdC,QAAQ,EAAEL;MACZ,CAAC,EAAEC,aAAa,CAAC;IACnB,CAAC;IACDM,GAAGA,CAACC,KAAK,EAAE;MACT,OAAOT,gCAAgC,CAAC;QACtCK,IAAI,EAAE,UAAU;QAChBK,UAAU,EAAE,CACVT,cAAc,EACdU,oBAAoB,CAACF,KAAK,EAAEP,aAAa,CAAC;MAE9C,CAAC,EAAEA,aAAa,CAAC;IACnB,CAAC;IACDU,GAAGA,CAACH,KAAK,EAAE;MACT,OAAOT,gCAAgC,CAAC;QACtCK,IAAI,EAAE,OAAO;QACbK,UAAU,EAAE,CACVT,cAAc,EACdU,oBAAoB,CAACF,KAAK,EAAEP,aAAa,CAAC;MAE9C,CAAC,EAAEA,aAAa,CAAC;IACnB,CAAC;IACDW,GAAGA,CACDJ,KAAK,EACL;MACA,OAAOT,gCAAgC,CAAC;QACtCK,IAAI,EAAE,KAAK;QACXK,UAAU,EAAE,CACVT,cAAc,EACdU,oBAAoB,CAACF,KAAK,EAAEP,aAAa,CAAC;MAE9C,CAAC,EAAEA,aAAa,CAAC;IACnB,CAAC;IACDY,QAAQA,CACNL,KAAK,EACL;MACA,OAAOT,gCAAgC,CAAC;QACtC,MAAM,EAAE,UAAU;QAClB,MAAM,EAAEC,cAAc;QACtB,OAAO,EAAEU,oBAAoB,CAACF,KAAK,EAAEP,aAAa;MACpD,CAAC,EAAEA,aAAa,CAAC;IACnB,CAAC;IACDa,QAAQA,CACNN,KAAK,EACL;MACA,OAAOT,gCAAgC,CAAC;QACtCK,IAAI,EAAE,UAAU;QAChBK,UAAU,EAAE,CACVT,cAAc,EACdU,oBAAoB,CAACF,KAAK,EAAEP,aAAa,CAAC;MAE9C,CAAC,EAAEA,aAAa,CAAC;IACnB,CAAC;IACDc,MAAMA,CACJP,KAAK,EACL;MACA,OAAOT,gCAAgC,CAAC;QACtC,MAAM,EAAE,QAAQ;QAChB,MAAM,EAAEC,cAAc;QACtB,OAAO,EAAEU,oBAAoB,CAACF,KAAK,EAAEP,aAAa;MACpD,CAAC,EAAEA,aAAa,CAAC;IACnB,CAAC;IACDe,WAAW,EAAGC,IAAI,IAAK;MACrB,OAAOlB,gCAAgC,CAAC;QACtCK,IAAI,EAAE,SAAS;QACfa,IAAI;QACJZ,QAAQ,EAAEL;MACZ,CAAC,EAAEC,aAAa,CAAC;IACnB;EACF,CAAC;EAEHA,aAAa,CAACiB,GAAG,CAAChB,UAAU,EAAEF,cAAc,CAAC;EAC7C,OAAOE,UAAU;AACnB;AAEA,MAAMQ,oBAAoB,GAAGA,CAC3BS,GAA2D,EAC3DlB,aAAkD,KACpB;EAC9B,IAAI,OAAOkB,GAAG,KAAK,QAAQ,EAAE;IAC3B,MAAMjB,UAAU,GAAGD,aAAa,CAACmB,GAAG,CAACD,GAAG,CAAC;IACzC,CAAUjB,UAAU,GAAAmB,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAApBzB,SAAS,QAAa,iCAAiC,IAAvDA,SAAS;IACT,OAAOI,UAAU;EACnB,CAAC,MAAM,IAAI,OAAOiB,GAAG,KAAK,QAAQ,EAAE;IAClCE,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAAAzB,SAAS,QAAQ,uDAAuD,IAAxEA,SAAS;EACX;EACAuB,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAAAzB,SAAS,QAAQ,8CAA8C,IAA/DA,SAAS;AACX,CAAC","ignoreList":[]}

package/build/esm/internal/conversions/modernToLegacyWhereClause.js

@@ -65,7 +65,7 @@ export function modernToLegacyWhereClauseInner(whereClause, objectOrInterface, r
   return handleWherePair(parts[0], objectOrInterface, undefined, rdpNames);
 }
 function handleWherePair([fieldName, filter], objectOrInterface, structFieldSelector, rdpNames) {
-  !(filter != null) ? process.env.NODE_ENV !== "production" ? invariant(false, "Defined key values are only allowed when they are not undefined.") : invariant(false) : void 0;
+  !(filter != null) ? process.env.NODE_ENV !== "production" ? invariant(false, `Cannot filter on property "${fieldName}" with an undefined or null value. ` + `If the value might be undefined, check it before adding to the where clause.`) : invariant(false) : void 0;
   const isRdp = !structFieldSelector && rdpNames?.has(fieldName);
   const propertyIdentifier = isRdp ? {
     type: "property",