@osdk/client 2.3.1 → 2.4.0-beta.10

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

@@ -1,4 +1,4 @@
-import { ObjectOrInterfaceDefinition, PropertyKeys, Augment, ObjectTypeDefinition, Osdk, PrimaryKeyType, InterfaceDefinition, WhereClause, ActionDefinition } from '@osdk/api';
+import { ObjectOrInterfaceDefinition, PropertyKeys, Augment, ObjectTypeDefinition, Osdk, PrimaryKeyType, InterfaceDefinition, WhereClause, ActionDefinition, ActionValidationResponse } from '@osdk/api';
 import { C as Client, A as ActionSignatureFromDef } from '../Client-CgL2LKN9.cjs';
 export { a as createClientWithTransaction } from '../createClient-DJq2ecGM.cjs';
 import '@osdk/shared.client';
@@ -64,6 +64,7 @@ interface ObservableClient {
     observeObject<T extends ObjectTypeDefinition>(apiName: T["apiName"] | T, pk: PrimaryKeyType<T>, options: ObserveOptions, subFn: Observer<ObserveObjectArgs<T>>): Unsubscribable;
     observeList<T extends ObjectTypeDefinition | InterfaceDefinition>(options: ObserveListOptions<T>, subFn: Observer<ObserveObjectsArgs<T>>): Unsubscribable;
     applyAction: <Q extends ActionDefinition<any>>(action: Q, args: Parameters<ActionSignatureFromDef<Q>["applyAction"]>[0] | Array<Parameters<ActionSignatureFromDef<Q>["applyAction"]>[0]>, opts?: ObservableClient.ApplyActionOptions) => Promise<unknown>;
+    validateAction: <Q extends ActionDefinition<any>>(action: Q, args: Parameters<ActionSignatureFromDef<Q>["applyAction"]>[0]) => Promise<ActionValidationResponse>;
     canonicalizeWhereClause: <T extends ObjectTypeDefinition | InterfaceDefinition>(where: WhereClause<T>) => Canonical<WhereClause<T>>;
 }
 declare function createObservableClient(client: Client): ObservableClient;

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.3.1";
+const MaxOsdkVersion = "2.4.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.3.1\";\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.4.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/derivedProperties/createWithPropertiesObjectSet.js

@@ -16,6 +16,7 @@
 
 import invariant from "tiny-invariant";
 import { modernToLegacyWhereClause } from "../internal/conversions/modernToLegacyWhereClause.js";
+import { derivedPropertyDefinitionFactory } from "./derivedPropertyDefinitionFactory.js";
 /** @internal */
 export function createWithPropertiesObjectSet(objectType, objectSet, definitionMap, fromBaseObjectSet = false) {
   return {
@@ -80,9 +81,48 @@ export function createWithPropertiesObjectSet(objectType, objectSet, definitionM
         objectSet: objectSet,
         operation: aggregationOperationDefinition
       };
-      const selectorResult = {};
+      const selectorResult = derivedPropertyDefinitionFactory(wrappedObjectSet, definitionMap);
       definitionMap.set(selectorResult, wrappedObjectSet);
       return selectorResult;
+    },
+    selectProperty: name => {
+      if (fromBaseObjectSet) {
+        const wrappedObjectSet = {
+          type: "property",
+          apiName: name
+        };
+        const selectorResult = derivedPropertyDefinitionFactory(wrappedObjectSet, definitionMap);
+        definitionMap.set(selectorResult, wrappedObjectSet);
+        return selectorResult;
+      }
+      const wrappedObjectSet = {
+        type: "selection",
+        objectSet: objectSet,
+        operation: {
+          type: "get",
+          selectedPropertyApiName: name
+        }
+      };
+      const selectorResult = derivedPropertyDefinitionFactory(wrappedObjectSet, definitionMap);
+      definitionMap.set(selectorResult, wrappedObjectSet);
+      return selectorResult;
+    },
+    constant: {
+      double: () => {
+        process.env.NODE_ENV !== "production" ? invariant(false, "Not supported") : invariant(false);
+      },
+      integer: () => {
+        process.env.NODE_ENV !== "production" ? invariant(false, "Not supported") : invariant(false);
+      },
+      long: () => {
+        process.env.NODE_ENV !== "production" ? invariant(false, "Not supported") : invariant(false);
+      },
+      datetime: () => {
+        process.env.NODE_ENV !== "production" ? invariant(false, "Not supported") : invariant(false);
+      },
+      timestamp: () => {
+        process.env.NODE_ENV !== "production" ? invariant(false, "Not supported") : invariant(false);
+      }
     }
   };
 }

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

@@ -1 +1 @@
-{"version":3,"file":"createWithPropertiesObjectSet.js","names":["invariant","modernToLegacyWhereClause","createWithPropertiesObjectSet","objectType","objectSet","definitionMap","fromBaseObjectSet","pivotTo","link","type","where","clause","aggregate","aggregation","opt","splitAggregation","split","length","process","env","NODE_ENV","aggregationPropertyName","aggregationOperation","aggregationOperationDefinition","selectedPropertyApiName","approximatePercentile","percentile","limit","undefined","wrappedObjectSet","operation","selectorResult","set"],"sources":["createWithPropertiesObjectSet.ts"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { DerivedProperty, ObjectOrInterfaceDefinition } from \"@osdk/api\";\nimport type {\n  DerivedPropertyDefinition,\n  ObjectSet as WireObjectSet,\n  SelectedPropertyOperation,\n} from \"@osdk/foundry.ontologies\";\nimport invariant from \"tiny-invariant\";\nimport { modernToLegacyWhereClause } from \"../internal/conversions/modernToLegacyWhereClause.js\";\n\ntype WithConstSelect<Q extends ObjectOrInterfaceDefinition> =\n  DerivedProperty.AggregateBuilder<Q, false>;\n\n/** @internal */\nexport function createWithPropertiesObjectSet<\n  Q extends ObjectOrInterfaceDefinition,\n>(\n  objectType: Q,\n  objectSet: WireObjectSet,\n  definitionMap: Map<any, DerivedPropertyDefinition>,\n  fromBaseObjectSet: boolean = false,\n): WithConstSelect<Q> {\n  return {\n    pivotTo: (link) => {\n      return createWithPropertiesObjectSet(objectType, {\n        type: \"searchAround\",\n        objectSet,\n        link,\n      }, definitionMap);\n    },\n    where: (clause) => {\n      return createWithPropertiesObjectSet(objectType, {\n        type: \"filter\",\n        objectSet: objectSet,\n        where: modernToLegacyWhereClause(clause, objectType),\n      }, definitionMap);\n    },\n    aggregate: (aggregation: string, opt: any) => {\n      const splitAggregation = aggregation.split(\":\");\n      invariant(\n        splitAggregation.length === 2 || splitAggregation[0] === \"$count\",\n        \"Invalid aggregation format\",\n      );\n      const [aggregationPropertyName, aggregationOperation] = splitAggregation;\n      let aggregationOperationDefinition: SelectedPropertyOperation;\n      switch (aggregationOperation) {\n        case \"sum\":\n        case \"avg\":\n        case \"min\":\n        case \"max\":\n        case \"exactDistinct\":\n        case \"approximateDistinct\":\n          aggregationOperationDefinition = {\n            type: aggregationOperation,\n            selectedPropertyApiName: aggregationPropertyName,\n          };\n          break;\n        case \"approximatePercentile\":\n          aggregationOperationDefinition = {\n            type: \"approximatePercentile\",\n            selectedPropertyApiName: aggregationPropertyName,\n            approximatePercentile: opt?.percentile ?? .5,\n          };\n          break;\n        case \"collectSet\":\n        case \"collectList\":\n          aggregationOperationDefinition = {\n            type: aggregationOperation,\n            selectedPropertyApiName: aggregationPropertyName,\n            limit: opt?.limit ?? 100,\n          };\n          break;\n        case undefined:\n          if (aggregationPropertyName === \"$count\") {\n            aggregationOperationDefinition = {\n              type: \"count\",\n            };\n            break;\n          }\n        default:\n          invariant(\n            false,\n            \"Invalid aggregation operation \" + aggregationOperation,\n          );\n      }\n      const wrappedObjectSet: DerivedPropertyDefinition = {\n        type: \"selection\",\n        objectSet: objectSet,\n        operation: aggregationOperationDefinition,\n      };\n      const selectorResult = {} as DerivedProperty.Definition<any, any>;\n      definitionMap.set(selectorResult, wrappedObjectSet);\n      return selectorResult as any;\n    },\n  };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAQA,OAAOA,SAAS,MAAM,gBAAgB;AACtC,SAASC,yBAAyB,QAAQ,sDAAsD;AAKhG;AACA,OAAO,SAASC,6BAA6BA,CAG3CC,UAAa,EACbC,SAAwB,EACxBC,aAAkD,EAClDC,iBAA0B,GAAG,KAAK,EACd;EACpB,OAAO;IACLC,OAAO,EAAGC,IAAI,IAAK;MACjB,OAAON,6BAA6B,CAACC,UAAU,EAAE;QAC/CM,IAAI,EAAE,cAAc;QACpBL,SAAS;QACTI;MACF,CAAC,EAAEH,aAAa,CAAC;IACnB,CAAC;IACDK,KAAK,EAAGC,MAAM,IAAK;MACjB,OAAOT,6BAA6B,CAACC,UAAU,EAAE;QAC/CM,IAAI,EAAE,QAAQ;QACdL,SAAS,EAAEA,SAAS;QACpBM,KAAK,EAAET,yBAAyB,CAACU,MAAM,EAAER,UAAU;MACrD,CAAC,EAAEE,aAAa,CAAC;IACnB,CAAC;IACDO,SAAS,EAAEA,CAACC,WAAmB,EAAEC,GAAQ,KAAK;MAC5C,MAAMC,gBAAgB,GAAGF,WAAW,CAACG,KAAK,CAAC,GAAG,CAAC;MAC/C,EACED,gBAAgB,CAACE,MAAM,KAAK,CAAC,IAAIF,gBAAgB,CAAC,CAAC,CAAC,KAAK,QAAQ,IAAAG,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBADnEpB,SAAS,QAEP,4BAA4B,IAF9BA,SAAS;MAIT,MAAM,CAACqB,uBAAuB,EAAEC,oBAAoB,CAAC,GAAGP,gBAAgB;MACxE,IAAIQ,8BAAyD;MAC7D,QAAQD,oBAAoB;QAC1B,KAAK,KAAK;QACV,KAAK,KAAK;QACV,KAAK,KAAK;QACV,KAAK,KAAK;QACV,KAAK,eAAe;QACpB,KAAK,qBAAqB;UACxBC,8BAA8B,GAAG;YAC/Bd,IAAI,EAAEa,oBAAoB;YAC1BE,uBAAuB,EAAEH;UAC3B,CAAC;UACD;QACF,KAAK,uBAAuB;UAC1BE,8BAA8B,GAAG;YAC/Bd,IAAI,EAAE,uBAAuB;YAC7Be,uBAAuB,EAAEH,uBAAuB;YAChDI,qBAAqB,EAAEX,GAAG,EAAEY,UAAU,IAAI;UAC5C,CAAC;UACD;QACF,KAAK,YAAY;QACjB,KAAK,aAAa;UAChBH,8BAA8B,GAAG;YAC/Bd,IAAI,EAAEa,oBAAoB;YAC1BE,uBAAuB,EAAEH,uBAAuB;YAChDM,KAAK,EAAEb,GAAG,EAAEa,KAAK,IAAI;UACvB,CAAC;UACD;QACF,KAAKC,SAAS;UACZ,IAAIP,uBAAuB,KAAK,QAAQ,EAAE;YACxCE,8BAA8B,GAAG;cAC/Bd,IAAI,EAAE;YACR,CAAC;YACD;UACF;QACF;UACES,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAAApB,SAAS,QAEP,gCAAgC,GAAGsB,oBAAoB,IAFzDtB,SAAS;MAIb;MACA,MAAM6B,gBAA2C,GAAG;QAClDpB,IAAI,EAAE,WAAW;QACjBL,SAAS,EAAEA,SAAS;QACpB0B,SAAS,EAAEP;MACb,CAAC;MACD,MAAMQ,cAAc,GAAG,CAAC,CAAyC;MACjE1B,aAAa,CAAC2B,GAAG,CAACD,cAAc,EAAEF,gBAAgB,CAAC;MACnD,OAAOE,cAAc;IACvB;EACF,CAAC;AACH","ignoreList":[]}
+{"version":3,"file":"createWithPropertiesObjectSet.js","names":["invariant","modernToLegacyWhereClause","derivedPropertyDefinitionFactory","createWithPropertiesObjectSet","objectType","objectSet","definitionMap","fromBaseObjectSet","pivotTo","link","type","where","clause","aggregate","aggregation","opt","splitAggregation","split","length","process","env","NODE_ENV","aggregationPropertyName","aggregationOperation","aggregationOperationDefinition","selectedPropertyApiName","approximatePercentile","percentile","limit","undefined","wrappedObjectSet","operation","selectorResult","set","selectProperty","name","apiName","constant","double","integer","long","datetime","timestamp"],"sources":["createWithPropertiesObjectSet.ts"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { DerivedProperty, ObjectOrInterfaceDefinition } from \"@osdk/api\";\nimport type {\n  DerivedPropertyDefinition,\n  ObjectSet as WireObjectSet,\n  SelectedPropertyOperation,\n} from \"@osdk/foundry.ontologies\";\nimport invariant from \"tiny-invariant\";\nimport { modernToLegacyWhereClause } from \"../internal/conversions/modernToLegacyWhereClause.js\";\nimport { derivedPropertyDefinitionFactory } from \"./derivedPropertyDefinitionFactory.js\";\n\ntype WithConstSelect<Q extends ObjectOrInterfaceDefinition> =\n  & DerivedProperty.SelectPropertyBuilder<Q, false>\n  & {\n    constant: DerivedProperty.Builder<Q, true>[\"constant\"];\n  };\n\n/** @internal */\nexport function createWithPropertiesObjectSet<\n  Q extends ObjectOrInterfaceDefinition,\n>(\n  objectType: Q,\n  objectSet: WireObjectSet,\n  definitionMap: Map<any, DerivedPropertyDefinition>,\n  fromBaseObjectSet: boolean = false,\n): WithConstSelect<Q> {\n  return {\n    pivotTo: (link) => {\n      return createWithPropertiesObjectSet(objectType, {\n        type: \"searchAround\",\n        objectSet,\n        link,\n      }, definitionMap);\n    },\n    where: (clause) => {\n      return createWithPropertiesObjectSet(objectType, {\n        type: \"filter\",\n        objectSet: objectSet,\n        where: modernToLegacyWhereClause(clause, objectType),\n      }, definitionMap);\n    },\n    aggregate: (aggregation: string, opt: any) => {\n      const splitAggregation = aggregation.split(\":\");\n      invariant(\n        splitAggregation.length === 2 || splitAggregation[0] === \"$count\",\n        \"Invalid aggregation format\",\n      );\n      const [aggregationPropertyName, aggregationOperation] = splitAggregation;\n      let aggregationOperationDefinition: SelectedPropertyOperation;\n      switch (aggregationOperation) {\n        case \"sum\":\n        case \"avg\":\n        case \"min\":\n        case \"max\":\n        case \"exactDistinct\":\n        case \"approximateDistinct\":\n          aggregationOperationDefinition = {\n            type: aggregationOperation,\n            selectedPropertyApiName: aggregationPropertyName,\n          };\n          break;\n        case \"approximatePercentile\":\n          aggregationOperationDefinition = {\n            type: \"approximatePercentile\",\n            selectedPropertyApiName: aggregationPropertyName,\n            approximatePercentile: opt?.percentile ?? .5,\n          };\n          break;\n        case \"collectSet\":\n        case \"collectList\":\n          aggregationOperationDefinition = {\n            type: aggregationOperation,\n            selectedPropertyApiName: aggregationPropertyName,\n            limit: opt?.limit ?? 100,\n          };\n          break;\n        case undefined:\n          if (aggregationPropertyName === \"$count\") {\n            aggregationOperationDefinition = {\n              type: \"count\",\n            };\n            break;\n          }\n        default:\n          invariant(\n            false,\n            \"Invalid aggregation operation \" + aggregationOperation,\n          );\n      }\n      const wrappedObjectSet: DerivedPropertyDefinition = {\n        type: \"selection\",\n        objectSet: objectSet,\n        operation: aggregationOperationDefinition,\n      };\n      const selectorResult: DerivedProperty.Definition<any, any> =\n        derivedPropertyDefinitionFactory(wrappedObjectSet, definitionMap);\n      definitionMap.set(selectorResult, wrappedObjectSet);\n      return selectorResult as any;\n    },\n    selectProperty: (name) => {\n      if (fromBaseObjectSet) {\n        const wrappedObjectSet: DerivedPropertyDefinition = {\n          type: \"property\",\n          apiName: name,\n        };\n        const selectorResult: DerivedProperty.Definition<any, any> =\n          derivedPropertyDefinitionFactory(wrappedObjectSet, definitionMap);\n        definitionMap.set(selectorResult, wrappedObjectSet);\n        return selectorResult as any;\n      }\n      const wrappedObjectSet: DerivedPropertyDefinition = {\n        type: \"selection\",\n        objectSet: objectSet,\n        operation: {\n          type: \"get\",\n          selectedPropertyApiName: name,\n        },\n      };\n      const selectorResult: DerivedProperty.Definition<any, any> =\n        derivedPropertyDefinitionFactory(wrappedObjectSet, definitionMap);\n      definitionMap.set(selectorResult, wrappedObjectSet);\n      return selectorResult as any;\n    },\n    constant: {\n      double: (value) => {\n        invariant(false, \"Not supported\");\n      },\n      integer: (value) => {\n        invariant(false, \"Not supported\");\n      },\n      long: (value) => {\n        invariant(false, \"Not supported\");\n      },\n      datetime: (value) => {\n        invariant(false, \"Not supported\");\n      },\n      timestamp: (value) => {\n        invariant(false, \"Not supported\");\n      },\n    },\n  };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAQA,OAAOA,SAAS,MAAM,gBAAgB;AACtC,SAASC,yBAAyB,QAAQ,sDAAsD;AAChG,SAASC,gCAAgC,QAAQ,uCAAuC;AAQxF;AACA,OAAO,SAASC,6BAA6BA,CAG3CC,UAAa,EACbC,SAAwB,EACxBC,aAAkD,EAClDC,iBAA0B,GAAG,KAAK,EACd;EACpB,OAAO;IACLC,OAAO,EAAGC,IAAI,IAAK;MACjB,OAAON,6BAA6B,CAACC,UAAU,EAAE;QAC/CM,IAAI,EAAE,cAAc;QACpBL,SAAS;QACTI;MACF,CAAC,EAAEH,aAAa,CAAC;IACnB,CAAC;IACDK,KAAK,EAAGC,MAAM,IAAK;MACjB,OAAOT,6BAA6B,CAACC,UAAU,EAAE;QAC/CM,IAAI,EAAE,QAAQ;QACdL,SAAS,EAAEA,SAAS;QACpBM,KAAK,EAAEV,yBAAyB,CAACW,MAAM,EAAER,UAAU;MACrD,CAAC,EAAEE,aAAa,CAAC;IACnB,CAAC;IACDO,SAAS,EAAEA,CAACC,WAAmB,EAAEC,GAAQ,KAAK;MAC5C,MAAMC,gBAAgB,GAAGF,WAAW,CAACG,KAAK,CAAC,GAAG,CAAC;MAC/C,EACED,gBAAgB,CAACE,MAAM,KAAK,CAAC,IAAIF,gBAAgB,CAAC,CAAC,CAAC,KAAK,QAAQ,IAAAG,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBADnErB,SAAS,QAEP,4BAA4B,IAF9BA,SAAS;MAIT,MAAM,CAACsB,uBAAuB,EAAEC,oBAAoB,CAAC,GAAGP,gBAAgB;MACxE,IAAIQ,8BAAyD;MAC7D,QAAQD,oBAAoB;QAC1B,KAAK,KAAK;QACV,KAAK,KAAK;QACV,KAAK,KAAK;QACV,KAAK,KAAK;QACV,KAAK,eAAe;QACpB,KAAK,qBAAqB;UACxBC,8BAA8B,GAAG;YAC/Bd,IAAI,EAAEa,oBAAoB;YAC1BE,uBAAuB,EAAEH;UAC3B,CAAC;UACD;QACF,KAAK,uBAAuB;UAC1BE,8BAA8B,GAAG;YAC/Bd,IAAI,EAAE,uBAAuB;YAC7Be,uBAAuB,EAAEH,uBAAuB;YAChDI,qBAAqB,EAAEX,GAAG,EAAEY,UAAU,IAAI;UAC5C,CAAC;UACD;QACF,KAAK,YAAY;QACjB,KAAK,aAAa;UAChBH,8BAA8B,GAAG;YAC/Bd,IAAI,EAAEa,oBAAoB;YAC1BE,uBAAuB,EAAEH,uBAAuB;YAChDM,KAAK,EAAEb,GAAG,EAAEa,KAAK,IAAI;UACvB,CAAC;UACD;QACF,KAAKC,SAAS;UACZ,IAAIP,uBAAuB,KAAK,QAAQ,EAAE;YACxCE,8BAA8B,GAAG;cAC/Bd,IAAI,EAAE;YACR,CAAC;YACD;UACF;QACF;UACES,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAAArB,SAAS,QAEP,gCAAgC,GAAGuB,oBAAoB,IAFzDvB,SAAS;MAIb;MACA,MAAM8B,gBAA2C,GAAG;QAClDpB,IAAI,EAAE,WAAW;QACjBL,SAAS,EAAEA,SAAS;QACpB0B,SAAS,EAAEP;MACb,CAAC;MACD,MAAMQ,cAAoD,GACxD9B,gCAAgC,CAAC4B,gBAAgB,EAAExB,aAAa,CAAC;MACnEA,aAAa,CAAC2B,GAAG,CAACD,cAAc,EAAEF,gBAAgB,CAAC;MACnD,OAAOE,cAAc;IACvB,CAAC;IACDE,cAAc,EAAGC,IAAI,IAAK;MACxB,IAAI5B,iBAAiB,EAAE;QACrB,MAAMuB,gBAA2C,GAAG;UAClDpB,IAAI,EAAE,UAAU;UAChB0B,OAAO,EAAED;QACX,CAAC;QACD,MAAMH,cAAoD,GACxD9B,gCAAgC,CAAC4B,gBAAgB,EAAExB,aAAa,CAAC;QACnEA,aAAa,CAAC2B,GAAG,CAACD,cAAc,EAAEF,gBAAgB,CAAC;QACnD,OAAOE,cAAc;MACvB;MACA,MAAMF,gBAA2C,GAAG;QAClDpB,IAAI,EAAE,WAAW;QACjBL,SAAS,EAAEA,SAAS;QACpB0B,SAAS,EAAE;UACTrB,IAAI,EAAE,KAAK;UACXe,uBAAuB,EAAEU;QAC3B;MACF,CAAC;MACD,MAAMH,cAAoD,GACxD9B,gCAAgC,CAAC4B,gBAAgB,EAAExB,aAAa,CAAC;MACnEA,aAAa,CAAC2B,GAAG,CAACD,cAAc,EAAEF,gBAAgB,CAAC;MACnD,OAAOE,cAAc;IACvB,CAAC;IACDK,QAAQ,EAAE;MACRC,MAAM,EAAEA,CAAA,KAAW;QACjBnB,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAAArB,SAAS,QAAQ,eAAe,IAAhCA,SAAS;MACX,CAAC;MACDuC,OAAO,EAAEA,CAAA,KAAW;QAClBpB,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAAArB,SAAS,QAAQ,eAAe,IAAhCA,SAAS;MACX,CAAC;MACDwC,IAAI,EAAEA,CAAA,KAAW;QACfrB,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAAArB,SAAS,QAAQ,eAAe,IAAhCA,SAAS;MACX,CAAC;MACDyC,QAAQ,EAAEA,CAAA,KAAW;QACnBtB,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAAArB,SAAS,QAAQ,eAAe,IAAhCA,SAAS;MACX,CAAC;MACD0C,SAAS,EAAEA,CAAA,KAAW;QACpBvB,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAAArB,SAAS,QAAQ,eAAe,IAAhCA,SAAS;MACX;IACF;EACF,CAAC;AACH","ignoreList":[]}

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

@@ -24,23 +24,39 @@ describe(createWithPropertiesObjectSet, () => {
       type: "methodInput"
     }, map);
     const result = {
-      "derivedPropertyName": base => base.pivotTo("lead").aggregate("employeeId:avg")
+      "derivedPropertyName": base => base.pivotTo("lead").selectProperty("employeeId")
     }["derivedPropertyName"](deriveObjectSet);
     const definition = map.get(result);
     expect(definition).toMatchInlineSnapshot(`
-      {
-        "objectSet": {
-          "link": "lead",
+        {
           "objectSet": {
-            "type": "methodInput",
+            "link": "lead",
+            "objectSet": {
+              "type": "methodInput",
+            },
+            "type": "searchAround",
           },
-          "type": "searchAround",
-        },
-        "operation": {
-          "selectedPropertyApiName": "employeeId",
-          "type": "avg",
-        },
-        "type": "selection",
+          "operation": {
+            "selectedPropertyApiName": "employeeId",
+            "type": "get",
+          },
+          "type": "selection",
+        }
+      `);
+  });
+  it("correctly allows select property off the base object set", () => {
+    const map = new Map();
+    const deriveObjectSet = createWithPropertiesObjectSet(Employee, {
+      type: "methodInput"
+    }, map, true);
+    const result = {
+      "derivedPropertyName": base => base.selectProperty("employeeId")
+    }["derivedPropertyName"](deriveObjectSet);
+    const definition = map.get(result);
+    expect(definition).toMatchInlineSnapshot(`
+      {
+        "apiName": "employeeId",
+        "type": "property",
       }
     `);
   });
@@ -96,5 +112,122 @@ describe(createWithPropertiesObjectSet, () => {
         }
       `);
   });
+  describe("expressions", () => {
+    it("can handle expressions referencing other property keys", () => {
+      const map = new Map();
+      const deriveObjectSet = createWithPropertiesObjectSet(Employee, {
+        type: "methodInput"
+      }, map, true);
+      const result = {
+        "derivedPropertyName": base => base.pivotTo("lead").selectProperty("employeeId").add(base.selectProperty("employeeId"))
+        // "secondaryDerivedPropertyName": (base) =>
+        //   base.pivotTo("lead").aggregate("employeeId:avg").divide("employeeId", 2),
+      }["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": "add",
+        }
+      `);
+    });
+
+    // TODO: Add test for literal
+    it("can handle nested definitions in an expression", () => {
+      const map = new Map();
+      const deriveObjectSet = createWithPropertiesObjectSet(Employee, {
+        type: "methodInput"
+      }, map);
+      const result = {
+        "derivedPropertyName": base => base.pivotTo("lead").selectProperty("employeeId").add(base.pivotTo("lead").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",
+            },
+            {
+              "objectSet": {
+                "link": "lead",
+                "objectSet": {
+                  "type": "methodInput",
+                },
+                "type": "searchAround",
+              },
+              "operation": {
+                "selectedPropertyApiName": "employeeId",
+                "type": "get",
+              },
+              "type": "selection",
+            },
+          ],
+          "type": "add",
+        }
+      `);
+    });
+  });
+  it("handles datetime expressions", () => {
+    const map = new Map();
+    const deriveObjectSet = createWithPropertiesObjectSet(Employee, {
+      type: "methodInput"
+    }, map);
+    const result = {
+      "derivedPropertyName": base => base.pivotTo("lead").selectProperty("startDate").extractPart("MONTHS"),
+      "secondaryDerivedPropertyName": base => base.pivotTo("lead").selectProperty("startDate").min(base.pivotTo("lead").selectProperty("startDate"))
+    }["derivedPropertyName"](deriveObjectSet);
+    const definition = map.get(result);
+    expect(definition).toMatchInlineSnapshot(`
+      {
+        "part": "MONTHS",
+        "property": {
+          "objectSet": {
+            "link": "lead",
+            "objectSet": {
+              "type": "methodInput",
+            },
+            "type": "searchAround",
+          },
+          "operation": {
+            "selectedPropertyApiName": "startDate",
+            "type": "get",
+          },
+          "type": "selection",
+        },
+        "type": "extract",
+      }
+    `);
+  });
 });
 //# sourceMappingURL=createWithPropertiesObjectSet.test.js.map

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","aggregate","definition","get","toMatchInlineSnapshot","clause","percentile","limit","secondResult","secondDefinition"],"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\").aggregate(\"employeeId:avg\"),\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\": \"avg\",\n        },\n        \"type\": \"selection\",\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"],"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,SAAS,CAAC,gBAAgB;IACnD,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,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,CAACC,SAAS,CAAC,kCAAkC,EAAE;QACjEK,UAAU,EAAE;MACd,CAAC,CAAC;MAEJ,8BAA8B,EAAGP,IAAI,IACnCA,IAAI,CAACC,OAAO,CAAC,MAAM,CAAC,CAACC,SAAS,CAAC,qBAAqB,EAAE;QACpDM,KAAK,EAAE;MACT,CAAC;IACL,CAAC;IAED,MAAMT,MAAM,GAAGO,MAAM,CAAC,qBAAqB,CAAC,CAACT,eAAe,CAAC;IAC7D,MAAMM,UAAU,GAAGR,GAAG,CAACS,GAAG,CAACL,MAAM,CAAC;IAElC,MAAMU,YAAY,GAAGH,MAAM,CAAC,8BAA8B,CAAC,CACzDT,eACF,CAAC;IACD,MAAMa,gBAAgB,GAAGf,GAAG,CAACS,GAAG,CAACK,YAAY,CAAC;IAE9CjB,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,CAACkB,gBAAgB,CAAC,CAACL,qBAAqB,CAAC;AACnD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,CAAC;EACN,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","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":[]}

package/build/esm/derivedProperties/derivedPropertyDefinitionFactory.js

@@ -0,0 +1,93 @@
+/*
+ * Copyright 2025 Palantir Technologies, Inc. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import invariant from "tiny-invariant";
+
+/** @internal */
+export function derivedPropertyDefinitionFactory(wireDefinition, definitionMap) {
+  const definition = {
+    abs() {
+      return derivedPropertyDefinitionFactory({
+        type: "absoluteValue",
+        property: wireDefinition
+      }, definitionMap);
+    },
+    negate() {
+      return derivedPropertyDefinitionFactory({
+        type: "negate",
+        property: wireDefinition
+      }, definitionMap);
+    },
+    max(value) {
+      return derivedPropertyDefinitionFactory({
+        type: "greatest",
+        properties: [wireDefinition, getDefinitionFromMap(value, definitionMap)]
+      }, definitionMap);
+    },
+    min(value) {
+      return derivedPropertyDefinitionFactory({
+        type: "least",
+        properties: [wireDefinition, getDefinitionFromMap(value, definitionMap)]
+      }, definitionMap);
+    },
+    add(value) {
+      return derivedPropertyDefinitionFactory({
+        type: "add",
+        properties: [wireDefinition, getDefinitionFromMap(value, definitionMap)]
+      }, definitionMap);
+    },
+    subtract(value) {
+      return derivedPropertyDefinitionFactory({
+        "type": "subtract",
+        "left": wireDefinition,
+        "right": getDefinitionFromMap(value, definitionMap)
+      }, definitionMap);
+    },
+    multiply(value) {
+      return derivedPropertyDefinitionFactory({
+        type: "multiply",
+        properties: [wireDefinition, getDefinitionFromMap(value, definitionMap)]
+      }, definitionMap);
+    },
+    divide(value) {
+      return derivedPropertyDefinitionFactory({
+        "type": "subtract",
+        "left": wireDefinition,
+        "right": getDefinitionFromMap(value, definitionMap)
+      }, definitionMap);
+    },
+    extractPart: part => {
+      return derivedPropertyDefinitionFactory({
+        type: "extract",
+        part,
+        property: wireDefinition
+      }, definitionMap);
+    }
+  };
+  definitionMap.set(definition, wireDefinition);
+  return definition;
+}
+const getDefinitionFromMap = (arg, definitionMap) => {
+  if (typeof arg === "object") {
+    const definition = definitionMap.get(arg);
+    !definition ? process.env.NODE_ENV !== "production" ? invariant(false, "Derived Property is not defined") : invariant(false) : void 0;
+    return definition;
+  } else if (typeof arg === "number") {
+    process.env.NODE_ENV !== "production" ? invariant(false, "Literals for derived properties are not yet supported") : invariant(false);
+  }
+  process.env.NODE_ENV !== "production" ? invariant(false, "Invalid argument type for a derived property") : invariant(false);
+};
+//# sourceMappingURL=derivedPropertyDefinitionFactory.js.map

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

@@ -0,0 +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":[]}

package/build/esm/fetchMetadata.test.js

@@ -125,6 +125,20 @@ describe("FetchMetadata", () => {
             "nullable": true,
             "type": "string",
           },
+          "skillSet": {
+            "description": "The skills of the employee",
+            "displayName": undefined,
+            "multiplicity": false,
+            "nullable": true,
+            "type": "string",
+          },
+          "skillSetEmbedding": {
+            "description": "Vectorized skill set",
+            "displayName": undefined,
+            "multiplicity": false,
+            "nullable": true,
+            "type": "vector",
+          },
           "startDate": {
             "description": "The date the employee was hired (most recently, if they were re-hired)",
             "displayName": undefined,

package/build/esm/fetchMetadata.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"fetchMetadata.test.js","names":["$Actions","$Interfaces","$Objects","$Queries","LegacyFauxFoundry","startNodeApiServer","beforeAll","describe","expect","expectTypeOf","it","createClient","client","testSetup","apiServer","close","objectMetadata","fetchMetadata","Employee","toEqualTypeOf","toMatchInlineSnapshot","interfaceMetadata","FooInterface","actionMetadata","moveOffice","queryMetadata","queryAcceptsObject"],"sources":["fetchMetadata.test.ts"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n  ActionMetadata,\n  InterfaceMetadata,\n  ObjectMetadata,\n  QueryMetadata,\n} from \"@osdk/api\";\nimport {\n  $Actions,\n  $Interfaces,\n  $Objects,\n  $Queries,\n} from \"@osdk/client.test.ontology\";\nimport { LegacyFauxFoundry, startNodeApiServer } from \"@osdk/shared.test\";\nimport { beforeAll, describe, expect, expectTypeOf, it } from \"vitest\";\nimport type { Client } from \"./Client.js\";\nimport { createClient } from \"./createClient.js\";\n\ndescribe(\"FetchMetadata\", () => {\n  let client: Client;\n\n  beforeAll(() => {\n    const testSetup = startNodeApiServer(new LegacyFauxFoundry(), createClient);\n    ({ client } = testSetup);\n    return () => {\n      testSetup.apiServer.close();\n    };\n  });\n\n  it(\"fetches object metadata correctly\", async () => {\n    const objectMetadata = await client.fetchMetadata($Objects.Employee);\n\n    expectTypeOf(objectMetadata).toEqualTypeOf<\n      ObjectMetadata\n    >();\n\n    expect(objectMetadata).toMatchInlineSnapshot(`\n      {\n        \"apiName\": \"Employee\",\n        \"description\": \"A full-time or part-time \n\n       employee of our firm\",\n        \"displayName\": \"Employee\",\n        \"icon\": {\n          \"color\": \"blue\",\n          \"name\": \"person\",\n          \"type\": \"blueprint\",\n        },\n        \"implements\": [\n          \"FooInterface\",\n        ],\n        \"interfaceMap\": {\n          \"FooInterface\": {\n            \"fooSpt\": \"fullName\",\n          },\n        },\n        \"inverseInterfaceMap\": {\n          \"FooInterface\": {\n            \"fullName\": \"fooSpt\",\n          },\n        },\n        \"links\": {\n          \"lead\": {\n            \"multiplicity\": false,\n            \"targetType\": \"Employee\",\n          },\n          \"officeLink\": {\n            \"multiplicity\": false,\n            \"targetType\": \"Office\",\n          },\n          \"peeps\": {\n            \"multiplicity\": true,\n            \"targetType\": \"Employee\",\n          },\n        },\n        \"pluralDisplayName\": \"Employees\",\n        \"primaryKeyApiName\": \"employeeId\",\n        \"primaryKeyType\": \"integer\",\n        \"properties\": {\n          \"class\": {\n            \"description\": \"\",\n            \"displayName\": undefined,\n            \"multiplicity\": false,\n            \"nullable\": true,\n            \"type\": \"string\",\n          },\n          \"employeeId\": {\n            \"description\": undefined,\n            \"displayName\": undefined,\n            \"multiplicity\": false,\n            \"nullable\": false,\n            \"type\": \"integer\",\n          },\n          \"employeeLocation\": {\n            \"description\": \"Geotime series reference of the location of the employee\",\n            \"displayName\": undefined,\n            \"multiplicity\": false,\n            \"nullable\": true,\n            \"type\": \"geotimeSeriesReference\",\n          },\n          \"employeeSensor\": {\n            \"description\": \"TimeSeries sensor of the status of the employee\",\n            \"displayName\": undefined,\n            \"multiplicity\": false,\n            \"nullable\": true,\n            \"type\": \"sensorTimeseries\",\n          },\n          \"employeeStatus\": {\n            \"description\": \"TimeSeries of the status of the employee\",\n            \"displayName\": undefined,\n            \"multiplicity\": false,\n            \"nullable\": true,\n            \"type\": \"stringTimeseries\",\n          },\n          \"fullName\": {\n            \"description\": undefined,\n            \"displayName\": undefined,\n            \"multiplicity\": false,\n            \"nullable\": true,\n            \"type\": \"string\",\n          },\n          \"office\": {\n            \"description\": \"The unique \"ID\" of the employee's \\\\\"primary\\\\\" assigned office.\n       This is some more text.\",\n            \"displayName\": undefined,\n            \"multiplicity\": false,\n            \"nullable\": true,\n            \"type\": \"string\",\n          },\n          \"startDate\": {\n            \"description\": \"The date the employee was hired (most recently, if they were re-hired)\",\n            \"displayName\": undefined,\n            \"multiplicity\": false,\n            \"nullable\": true,\n            \"type\": \"datetime\",\n          },\n        },\n        \"rid\": \"ri.ontology.main.object-type.401ac022-89eb-4591-8b7e-0a912b9efb44\",\n        \"status\": \"ACTIVE\",\n        \"titleProperty\": \"fullName\",\n        \"type\": \"object\",\n        \"visibility\": \"NORMAL\",\n      }\n    `);\n  });\n\n  it(\"fetches interface metadata correctly\", async () => {\n    const interfaceMetadata = await client.fetchMetadata(\n      $Interfaces.FooInterface,\n    );\n\n    expectTypeOf(interfaceMetadata).toEqualTypeOf<\n      InterfaceMetadata\n    >();\n\n    expect(interfaceMetadata).toMatchInlineSnapshot(`\n      {\n        \"apiName\": \"FooInterface\",\n        \"description\": \"Interface for Foo\",\n        \"displayName\": \"Foo Interface\",\n        \"implementedBy\": [\n          \"Employee\",\n          \"Person\",\n        ],\n        \"implements\": [],\n        \"links\": {},\n        \"properties\": {\n          \"fooSpt\": {\n            \"description\": \"A foo\",\n            \"displayName\": \"Foo\",\n            \"multiplicity\": false,\n            \"nullable\": true,\n            \"type\": \"string\",\n          },\n        },\n        \"rid\": \"ri.interface.main.interface.1\",\n        \"type\": \"interface\",\n      }\n    `);\n  });\n\n  it(\"fetches action metadata correctly\", async () => {\n    const actionMetadata = await client.fetchMetadata(\n      $Actions.moveOffice,\n    );\n\n    expectTypeOf(actionMetadata).toEqualTypeOf<ActionMetadata>();\n\n    expect(actionMetadata).toMatchInlineSnapshot(`\n      {\n        \"apiName\": \"moveOffice\",\n        \"description\": \"Update an office's physical location\",\n        \"displayName\": \"move-office\",\n        \"modifiedEntities\": {\n          \"Office\": {\n            \"created\": false,\n            \"modified\": true,\n          },\n        },\n        \"parameters\": {\n          \"newAddress\": {\n            \"description\": \"The office's new physical address (not necessarily shipping address)\",\n            \"multiplicity\": false,\n            \"nullable\": true,\n            \"type\": \"string\",\n          },\n          \"newCapacity\": {\n            \"description\": \"The maximum seated-at-desk capacity of the new office (maximum fire-safe capacity may be higher)\",\n            \"multiplicity\": false,\n            \"nullable\": true,\n            \"type\": \"integer\",\n          },\n          \"officeId\": {\n            \"description\": undefined,\n            \"multiplicity\": false,\n            \"nullable\": false,\n            \"type\": \"string\",\n          },\n          \"officeNames\": {\n            \"description\": \"A list of all office names\",\n            \"multiplicity\": true,\n            \"nullable\": true,\n            \"type\": \"integer\",\n          },\n        },\n        \"rid\": \"ri.ontology.main.action-type.9f84017d-cf17-4fa8-84c3-8e01e5d594f2\",\n        \"status\": \"ACTIVE\",\n        \"type\": \"action\",\n      }\n    `);\n  });\n\n  it(\"fetches query metadata correctly\", async () => {\n    const queryMetadata = await client.fetchMetadata(\n      $Queries.queryAcceptsObject,\n    );\n\n    expectTypeOf(queryMetadata).toEqualTypeOf<QueryMetadata>();\n\n    expect(queryMetadata).toMatchInlineSnapshot(`\n      {\n        \"apiName\": \"queryAcceptsObject\",\n        \"description\": \"description of the query that takes object types\",\n        \"displayName\": \"QueryAcceptsObject\",\n        \"output\": {\n          \"nullable\": false,\n          \"object\": \"Employee\",\n          \"type\": \"object\",\n        },\n        \"parameters\": {\n          \"object\": {\n            \"description\": undefined,\n            \"nullable\": false,\n            \"object\": \"Employee\",\n            \"type\": \"object\",\n          },\n        },\n        \"rid\": \"ri.function-registry.main.function.9b55870a-63c7-4d48-8f06-9627c0805968\",\n        \"type\": \"query\",\n        \"version\": \"0.11.0\",\n      }\n    `);\n  });\n});\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAQA,SACEA,QAAQ,EACRC,WAAW,EACXC,QAAQ,EACRC,QAAQ,QACH,4BAA4B;AACnC,SAASC,iBAAiB,EAAEC,kBAAkB,QAAQ,mBAAmB;AACzE,SAASC,SAAS,EAAEC,QAAQ,EAAEC,MAAM,EAAEC,YAAY,EAAEC,EAAE,QAAQ,QAAQ;AAEtE,SAASC,YAAY,QAAQ,mBAAmB;AAEhDJ,QAAQ,CAAC,eAAe,EAAE,MAAM;EAC9B,IAAIK,MAAc;EAElBN,SAAS,CAAC,MAAM;IACd,MAAMO,SAAS,GAAGR,kBAAkB,CAAC,IAAID,iBAAiB,CAAC,CAAC,EAAEO,YAAY,CAAC;IAC3E,CAAC;MAAEC;IAAO,CAAC,GAAGC,SAAS;IACvB,OAAO,MAAM;MACXA,SAAS,CAACC,SAAS,CAACC,KAAK,CAAC,CAAC;IAC7B,CAAC;EACH,CAAC,CAAC;EAEFL,EAAE,CAAC,mCAAmC,EAAE,YAAY;IAClD,MAAMM,cAAc,GAAG,MAAMJ,MAAM,CAACK,aAAa,CAACf,QAAQ,CAACgB,QAAQ,CAAC;IAEpET,YAAY,CAACO,cAAc,CAAC,CAACG,aAAa,CAExC,CAAC;IAEHX,MAAM,CAACQ,cAAc,CAAC,CAACI,qBAAqB,CAAC;AACjD;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;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;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;AACA;AACA;AACA;AACA;AACA;AACA;AACA,KAAK,CAAC;EACJ,CAAC,CAAC;EAEFV,EAAE,CAAC,sCAAsC,EAAE,YAAY;IACrD,MAAMW,iBAAiB,GAAG,MAAMT,MAAM,CAACK,aAAa,CAClDhB,WAAW,CAACqB,YACd,CAAC;IAEDb,YAAY,CAACY,iBAAiB,CAAC,CAACF,aAAa,CAE3C,CAAC;IAEHX,MAAM,CAACa,iBAAiB,CAAC,CAACD,qBAAqB,CAAC;AACpD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,KAAK,CAAC;EACJ,CAAC,CAAC;EAEFV,EAAE,CAAC,mCAAmC,EAAE,YAAY;IAClD,MAAMa,cAAc,GAAG,MAAMX,MAAM,CAACK,aAAa,CAC/CjB,QAAQ,CAACwB,UACX,CAAC;IAEDf,YAAY,CAACc,cAAc,CAAC,CAACJ,aAAa,CAAiB,CAAC;IAE5DX,MAAM,CAACe,cAAc,CAAC,CAACH,qBAAqB,CAAC;AACjD;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;AACA;AACA;AACA;AACA;AACA;AACA;AACA,KAAK,CAAC;EACJ,CAAC,CAAC;EAEFV,EAAE,CAAC,kCAAkC,EAAE,YAAY;IACjD,MAAMe,aAAa,GAAG,MAAMb,MAAM,CAACK,aAAa,CAC9Cd,QAAQ,CAACuB,kBACX,CAAC;IAEDjB,YAAY,CAACgB,aAAa,CAAC,CAACN,aAAa,CAAgB,CAAC;IAE1DX,MAAM,CAACiB,aAAa,CAAC,CAACL,qBAAqB,CAAC;AAChD;AACA;AACA;AACA;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":"fetchMetadata.test.js","names":["$Actions","$Interfaces","$Objects","$Queries","LegacyFauxFoundry","startNodeApiServer","beforeAll","describe","expect","expectTypeOf","it","createClient","client","testSetup","apiServer","close","objectMetadata","fetchMetadata","Employee","toEqualTypeOf","toMatchInlineSnapshot","interfaceMetadata","FooInterface","actionMetadata","moveOffice","queryMetadata","queryAcceptsObject"],"sources":["fetchMetadata.test.ts"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n  ActionMetadata,\n  InterfaceMetadata,\n  ObjectMetadata,\n  QueryMetadata,\n} from \"@osdk/api\";\nimport {\n  $Actions,\n  $Interfaces,\n  $Objects,\n  $Queries,\n} from \"@osdk/client.test.ontology\";\nimport { LegacyFauxFoundry, startNodeApiServer } from \"@osdk/shared.test\";\nimport { beforeAll, describe, expect, expectTypeOf, it } from \"vitest\";\nimport type { Client } from \"./Client.js\";\nimport { createClient } from \"./createClient.js\";\n\ndescribe(\"FetchMetadata\", () => {\n  let client: Client;\n\n  beforeAll(() => {\n    const testSetup = startNodeApiServer(new LegacyFauxFoundry(), createClient);\n    ({ client } = testSetup);\n    return () => {\n      testSetup.apiServer.close();\n    };\n  });\n\n  it(\"fetches object metadata correctly\", async () => {\n    const objectMetadata = await client.fetchMetadata($Objects.Employee);\n\n    expectTypeOf(objectMetadata).toEqualTypeOf<\n      ObjectMetadata\n    >();\n\n    expect(objectMetadata).toMatchInlineSnapshot(`\n      {\n        \"apiName\": \"Employee\",\n        \"description\": \"A full-time or part-time \n\n       employee of our firm\",\n        \"displayName\": \"Employee\",\n        \"icon\": {\n          \"color\": \"blue\",\n          \"name\": \"person\",\n          \"type\": \"blueprint\",\n        },\n        \"implements\": [\n          \"FooInterface\",\n        ],\n        \"interfaceMap\": {\n          \"FooInterface\": {\n            \"fooSpt\": \"fullName\",\n          },\n        },\n        \"inverseInterfaceMap\": {\n          \"FooInterface\": {\n            \"fullName\": \"fooSpt\",\n          },\n        },\n        \"links\": {\n          \"lead\": {\n            \"multiplicity\": false,\n            \"targetType\": \"Employee\",\n          },\n          \"officeLink\": {\n            \"multiplicity\": false,\n            \"targetType\": \"Office\",\n          },\n          \"peeps\": {\n            \"multiplicity\": true,\n            \"targetType\": \"Employee\",\n          },\n        },\n        \"pluralDisplayName\": \"Employees\",\n        \"primaryKeyApiName\": \"employeeId\",\n        \"primaryKeyType\": \"integer\",\n        \"properties\": {\n          \"class\": {\n            \"description\": \"\",\n            \"displayName\": undefined,\n            \"multiplicity\": false,\n            \"nullable\": true,\n            \"type\": \"string\",\n          },\n          \"employeeId\": {\n            \"description\": undefined,\n            \"displayName\": undefined,\n            \"multiplicity\": false,\n            \"nullable\": false,\n            \"type\": \"integer\",\n          },\n          \"employeeLocation\": {\n            \"description\": \"Geotime series reference of the location of the employee\",\n            \"displayName\": undefined,\n            \"multiplicity\": false,\n            \"nullable\": true,\n            \"type\": \"geotimeSeriesReference\",\n          },\n          \"employeeSensor\": {\n            \"description\": \"TimeSeries sensor of the status of the employee\",\n            \"displayName\": undefined,\n            \"multiplicity\": false,\n            \"nullable\": true,\n            \"type\": \"sensorTimeseries\",\n          },\n          \"employeeStatus\": {\n            \"description\": \"TimeSeries of the status of the employee\",\n            \"displayName\": undefined,\n            \"multiplicity\": false,\n            \"nullable\": true,\n            \"type\": \"stringTimeseries\",\n          },\n          \"fullName\": {\n            \"description\": undefined,\n            \"displayName\": undefined,\n            \"multiplicity\": false,\n            \"nullable\": true,\n            \"type\": \"string\",\n          },\n          \"office\": {\n            \"description\": \"The unique \"ID\" of the employee's \\\\\"primary\\\\\" assigned office.\n       This is some more text.\",\n            \"displayName\": undefined,\n            \"multiplicity\": false,\n            \"nullable\": true,\n            \"type\": \"string\",\n          },\n          \"skillSet\": {\n            \"description\": \"The skills of the employee\",\n            \"displayName\": undefined,\n            \"multiplicity\": false,\n            \"nullable\": true,\n            \"type\": \"string\",\n          },\n          \"skillSetEmbedding\": {\n            \"description\": \"Vectorized skill set\",\n            \"displayName\": undefined,\n            \"multiplicity\": false,\n            \"nullable\": true,\n            \"type\": \"vector\",\n          },\n          \"startDate\": {\n            \"description\": \"The date the employee was hired (most recently, if they were re-hired)\",\n            \"displayName\": undefined,\n            \"multiplicity\": false,\n            \"nullable\": true,\n            \"type\": \"datetime\",\n          },\n        },\n        \"rid\": \"ri.ontology.main.object-type.401ac022-89eb-4591-8b7e-0a912b9efb44\",\n        \"status\": \"ACTIVE\",\n        \"titleProperty\": \"fullName\",\n        \"type\": \"object\",\n        \"visibility\": \"NORMAL\",\n      }\n    `);\n  });\n\n  it(\"fetches interface metadata correctly\", async () => {\n    const interfaceMetadata = await client.fetchMetadata(\n      $Interfaces.FooInterface,\n    );\n\n    expectTypeOf(interfaceMetadata).toEqualTypeOf<\n      InterfaceMetadata\n    >();\n\n    expect(interfaceMetadata).toMatchInlineSnapshot(`\n      {\n        \"apiName\": \"FooInterface\",\n        \"description\": \"Interface for Foo\",\n        \"displayName\": \"Foo Interface\",\n        \"implementedBy\": [\n          \"Employee\",\n          \"Person\",\n        ],\n        \"implements\": [],\n        \"links\": {},\n        \"properties\": {\n          \"fooSpt\": {\n            \"description\": \"A foo\",\n            \"displayName\": \"Foo\",\n            \"multiplicity\": false,\n            \"nullable\": true,\n            \"type\": \"string\",\n          },\n        },\n        \"rid\": \"ri.interface.main.interface.1\",\n        \"type\": \"interface\",\n      }\n    `);\n  });\n\n  it(\"fetches action metadata correctly\", async () => {\n    const actionMetadata = await client.fetchMetadata(\n      $Actions.moveOffice,\n    );\n\n    expectTypeOf(actionMetadata).toEqualTypeOf<ActionMetadata>();\n\n    expect(actionMetadata).toMatchInlineSnapshot(`\n      {\n        \"apiName\": \"moveOffice\",\n        \"description\": \"Update an office's physical location\",\n        \"displayName\": \"move-office\",\n        \"modifiedEntities\": {\n          \"Office\": {\n            \"created\": false,\n            \"modified\": true,\n          },\n        },\n        \"parameters\": {\n          \"newAddress\": {\n            \"description\": \"The office's new physical address (not necessarily shipping address)\",\n            \"multiplicity\": false,\n            \"nullable\": true,\n            \"type\": \"string\",\n          },\n          \"newCapacity\": {\n            \"description\": \"The maximum seated-at-desk capacity of the new office (maximum fire-safe capacity may be higher)\",\n            \"multiplicity\": false,\n            \"nullable\": true,\n            \"type\": \"integer\",\n          },\n          \"officeId\": {\n            \"description\": undefined,\n            \"multiplicity\": false,\n            \"nullable\": false,\n            \"type\": \"string\",\n          },\n          \"officeNames\": {\n            \"description\": \"A list of all office names\",\n            \"multiplicity\": true,\n            \"nullable\": true,\n            \"type\": \"integer\",\n          },\n        },\n        \"rid\": \"ri.ontology.main.action-type.9f84017d-cf17-4fa8-84c3-8e01e5d594f2\",\n        \"status\": \"ACTIVE\",\n        \"type\": \"action\",\n      }\n    `);\n  });\n\n  it(\"fetches query metadata correctly\", async () => {\n    const queryMetadata = await client.fetchMetadata(\n      $Queries.queryAcceptsObject,\n    );\n\n    expectTypeOf(queryMetadata).toEqualTypeOf<QueryMetadata>();\n\n    expect(queryMetadata).toMatchInlineSnapshot(`\n      {\n        \"apiName\": \"queryAcceptsObject\",\n        \"description\": \"description of the query that takes object types\",\n        \"displayName\": \"QueryAcceptsObject\",\n        \"output\": {\n          \"nullable\": false,\n          \"object\": \"Employee\",\n          \"type\": \"object\",\n        },\n        \"parameters\": {\n          \"object\": {\n            \"description\": undefined,\n            \"nullable\": false,\n            \"object\": \"Employee\",\n            \"type\": \"object\",\n          },\n        },\n        \"rid\": \"ri.function-registry.main.function.9b55870a-63c7-4d48-8f06-9627c0805968\",\n        \"type\": \"query\",\n        \"version\": \"0.11.0\",\n      }\n    `);\n  });\n});\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAQA,SACEA,QAAQ,EACRC,WAAW,EACXC,QAAQ,EACRC,QAAQ,QACH,4BAA4B;AACnC,SAASC,iBAAiB,EAAEC,kBAAkB,QAAQ,mBAAmB;AACzE,SAASC,SAAS,EAAEC,QAAQ,EAAEC,MAAM,EAAEC,YAAY,EAAEC,EAAE,QAAQ,QAAQ;AAEtE,SAASC,YAAY,QAAQ,mBAAmB;AAEhDJ,QAAQ,CAAC,eAAe,EAAE,MAAM;EAC9B,IAAIK,MAAc;EAElBN,SAAS,CAAC,MAAM;IACd,MAAMO,SAAS,GAAGR,kBAAkB,CAAC,IAAID,iBAAiB,CAAC,CAAC,EAAEO,YAAY,CAAC;IAC3E,CAAC;MAAEC;IAAO,CAAC,GAAGC,SAAS;IACvB,OAAO,MAAM;MACXA,SAAS,CAACC,SAAS,CAACC,KAAK,CAAC,CAAC;IAC7B,CAAC;EACH,CAAC,CAAC;EAEFL,EAAE,CAAC,mCAAmC,EAAE,YAAY;IAClD,MAAMM,cAAc,GAAG,MAAMJ,MAAM,CAACK,aAAa,CAACf,QAAQ,CAACgB,QAAQ,CAAC;IAEpET,YAAY,CAACO,cAAc,CAAC,CAACG,aAAa,CAExC,CAAC;IAEHX,MAAM,CAACQ,cAAc,CAAC,CAACI,qBAAqB,CAAC;AACjD;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;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;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;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,KAAK,CAAC;EACJ,CAAC,CAAC;EAEFV,EAAE,CAAC,sCAAsC,EAAE,YAAY;IACrD,MAAMW,iBAAiB,GAAG,MAAMT,MAAM,CAACK,aAAa,CAClDhB,WAAW,CAACqB,YACd,CAAC;IAEDb,YAAY,CAACY,iBAAiB,CAAC,CAACF,aAAa,CAE3C,CAAC;IAEHX,MAAM,CAACa,iBAAiB,CAAC,CAACD,qBAAqB,CAAC;AACpD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,KAAK,CAAC;EACJ,CAAC,CAAC;EAEFV,EAAE,CAAC,mCAAmC,EAAE,YAAY;IAClD,MAAMa,cAAc,GAAG,MAAMX,MAAM,CAACK,aAAa,CAC/CjB,QAAQ,CAACwB,UACX,CAAC;IAEDf,YAAY,CAACc,cAAc,CAAC,CAACJ,aAAa,CAAiB,CAAC;IAE5DX,MAAM,CAACe,cAAc,CAAC,CAACH,qBAAqB,CAAC;AACjD;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;AACA;AACA;AACA;AACA;AACA;AACA;AACA,KAAK,CAAC;EACJ,CAAC,CAAC;EAEFV,EAAE,CAAC,kCAAkC,EAAE,YAAY;IACjD,MAAMe,aAAa,GAAG,MAAMb,MAAM,CAACK,aAAa,CAC9Cd,QAAQ,CAACuB,kBACX,CAAC;IAEDjB,YAAY,CAACgB,aAAa,CAAC,CAACN,aAAa,CAAgB,CAAC;IAE1DX,MAAM,CAACiB,aAAa,CAAC,CAACL,qBAAqB,CAAC;AAChD;AACA;AACA;AACA;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/index.js

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-export { isOk } from "@osdk/api";
+export { isOk, NULL_VALUE } from "@osdk/api";
 export { PalantirApiError } from "@osdk/shared.net.errors";
 export { ActionValidationError } from "./actions/ActionValidationError.js";
 export { createClient } from "./createClient.js";

package/build/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["isOk","PalantirApiError","ActionValidationError","createClient","createPlatformClient","createAttachmentUpload","extractDate","extractDateInLocalTime","extractDateInUTC"],"sources":["index.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\nexport type {\n  ActionDefinition,\n  ActionEditResponse,\n  ActionMetadata,\n  ActionParam,\n  ActionReturnTypeForOptions,\n  ActionValidationResponse,\n  ApplyActionOptions,\n  ApplyBatchActionOptions,\n  Attachment,\n  CompileTimeMetadata,\n  InterfaceDefinition,\n  Logger,\n  ObjectMetadata,\n  ObjectSet,\n  ObjectSpecifier,\n  ObjectTypeDefinition,\n  Osdk,\n  OsdkObject,\n  OsdkObjectCreatePropertyType,\n  OsdkObjectPropertyType,\n  PageResult,\n  PropertyDef,\n  PropertyKeys,\n  PropertyValueWireToClient,\n  QueryDefinition,\n  QueryParam,\n  QueryResult,\n  Range,\n  Result,\n  SingleLinkAccessor,\n  ThreeDimensionalAggregation,\n  TwoDimensionalAggregation,\n  VersionBound,\n  WhereClause,\n} from \"@osdk/api\";\nexport { isOk } from \"@osdk/api\";\nexport { PalantirApiError } from \"@osdk/shared.net.errors\";\n\nexport { ActionValidationError } from \"./actions/ActionValidationError.js\";\nexport type { Client } from \"./Client.js\";\nexport { createClient } from \"./createClient.js\";\nexport { createPlatformClient } from \"./createPlatformClient.js\";\nexport type { PlatformClient } from \"./createPlatformClient.js\";\nexport { createAttachmentUpload } from \"./object/AttachmentUpload.js\";\nexport type { ResultOrError } from \"./ResultOrError.js\";\n\nexport {\n  extractDate,\n  extractDateInLocalTime,\n  extractDateInUTC,\n} from \"./util/datetimeConverters.js\";\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAsCA,SAASA,IAAI,QAAQ,WAAW;AAChC,SAASC,gBAAgB,QAAQ,yBAAyB;AAE1D,SAASC,qBAAqB,QAAQ,oCAAoC;AAE1E,SAASC,YAAY,QAAQ,mBAAmB;AAChD,SAASC,oBAAoB,QAAQ,2BAA2B;AAEhE,SAASC,sBAAsB,QAAQ,8BAA8B;AAGrE,SACEC,WAAW,EACXC,sBAAsB,EACtBC,gBAAgB,QACX,8BAA8B","ignoreList":[]}
+{"version":3,"file":"index.js","names":["isOk","NULL_VALUE","PalantirApiError","ActionValidationError","createClient","createPlatformClient","createAttachmentUpload","extractDate","extractDateInLocalTime","extractDateInUTC"],"sources":["index.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\nexport type {\n  ActionDefinition,\n  ActionEditResponse,\n  ActionMetadata,\n  ActionParam,\n  ActionReturnTypeForOptions,\n  ActionValidationResponse,\n  ApplyActionOptions,\n  ApplyBatchActionOptions,\n  Attachment,\n  CompileTimeMetadata,\n  InterfaceDefinition,\n  Logger,\n  ObjectMetadata,\n  ObjectSet,\n  ObjectSpecifier,\n  ObjectTypeDefinition,\n  Osdk,\n  OsdkObject,\n  OsdkObjectCreatePropertyType,\n  OsdkObjectPropertyType,\n  PageResult,\n  PropertyDef,\n  PropertyKeys,\n  PropertyValueWireToClient,\n  QueryDefinition,\n  QueryParam,\n  QueryResult,\n  Range,\n  Result,\n  SingleLinkAccessor,\n  ThreeDimensionalAggregation,\n  TwoDimensionalAggregation,\n  VersionBound,\n  WhereClause,\n} from \"@osdk/api\";\nexport { isOk, NULL_VALUE } from \"@osdk/api\";\nexport { PalantirApiError } from \"@osdk/shared.net.errors\";\n\nexport { ActionValidationError } from \"./actions/ActionValidationError.js\";\nexport type { Client } from \"./Client.js\";\nexport { createClient } from \"./createClient.js\";\nexport { createPlatformClient } from \"./createPlatformClient.js\";\nexport type { PlatformClient } from \"./createPlatformClient.js\";\nexport { createAttachmentUpload } from \"./object/AttachmentUpload.js\";\nexport type { ResultOrError } from \"./ResultOrError.js\";\n\nexport {\n  extractDate,\n  extractDateInLocalTime,\n  extractDateInUTC,\n} from \"./util/datetimeConverters.js\";\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAsCA,SAASA,IAAI,EAAEC,UAAU,QAAQ,WAAW;AAC5C,SAASC,gBAAgB,QAAQ,yBAAyB;AAE1D,SAASC,qBAAqB,QAAQ,oCAAoC;AAE1E,SAASC,YAAY,QAAQ,mBAAmB;AAChD,SAASC,oBAAoB,QAAQ,2BAA2B;AAEhE,SAASC,sBAAsB,QAAQ,8BAA8B;AAGrE,SACEC,WAAW,EACXC,sBAAsB,EACtBC,gBAAgB,QACX,8BAA8B","ignoreList":[]}

package/build/esm/intellisense.test.js

@@ -113,7 +113,7 @@ describe("intellisense", () => {
       triggerKind: ts.CompletionTriggerKind.Invoked
     });
     expect(resp.body?.entries.length).toBeGreaterThan(2);
-    expect(resp.body?.entries.map(e => e.name)).toEqual(["class", "employeeId", "employeeLocation", "employeeSensor", "employeeStatus", "fullName", "office", "startDate"]);
+    expect(resp.body?.entries.map(e => e.name)).toEqual(["class", "employeeId", "employeeLocation", "employeeSensor", "employeeStatus", "fullName", "office", "skillSet", "skillSetEmbedding", "startDate"]);
     const {
       resp: resp2
     } = await tsServer.sendQuickInfoRequest({