@osdk/client 2.1.0-rc.32 → 2.2.0-beta.1

package/CHANGELOG.md

@@ -1,15 +1,5 @@
 # @osdk/client
 
-## 2.1.0-rc.32
-
-### Patch Changes
-
-- 55c05f2: Remove runtime derived properties from external types.
-- Updated dependencies [55c05f2]
-  - @osdk/api@2.1.0-rc.32
-  - @osdk/generator-converters@2.1.0-rc.32
-  - @osdk/client.unstable@2.1.0-rc.32
-
 ## 2.1.0-beta.31
 
 ### Minor Changes

package/build/browser/derivedProperties/createWithPropertiesObjectSet.js

@@ -0,0 +1,106 @@
+/*
+ * Copyright 2024 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";
+import { modernToLegacyWhereClause } from "../internal/conversions/modernToLegacyWhereClause.js";
+const idCounter = 0;
+
+/** @internal */
+export function createWithPropertiesObjectSet(objectType, objectSet, definitionMap) {
+  return {
+    pivotTo: link => {
+      return createWithPropertiesObjectSet(objectType, {
+        type: "searchAround",
+        objectSet,
+        link
+      }, definitionMap);
+    },
+    where: clause => {
+      return createWithPropertiesObjectSet(objectType, {
+        type: "filter",
+        objectSet: objectSet,
+        where: modernToLegacyWhereClause(clause, objectType)
+      }, definitionMap);
+    },
+    aggregate: (aggregation, opt) => {
+      const splitAggregation = aggregation.split(":");
+      !(splitAggregation.length === 2 || splitAggregation[0] === "$count") ? process.env.NODE_ENV !== "production" ? invariant(false, "Invalid aggregation format") : invariant(false) : void 0;
+      const [aggregationPropertyName, aggregationOperation] = splitAggregation;
+      let aggregationOperationDefinition;
+      switch (aggregationOperation) {
+        case "sum":
+        case "avg":
+        case "min":
+        case "max":
+        case "exactDistinct":
+        case "approximateDistinct":
+          aggregationOperationDefinition = {
+            type: aggregationOperation,
+            selectedPropertyApiName: aggregationPropertyName
+          };
+          break;
+        case "approximatePercentile":
+          aggregationOperationDefinition = {
+            type: "approximatePercentile",
+            selectedPropertyApiName: aggregationPropertyName,
+            approximatePercentile: opt?.percentile ?? .5
+          };
+          break;
+        case "collectSet":
+        case "collectList":
+          aggregationOperationDefinition = {
+            type: aggregationOperation,
+            selectedPropertyApiName: aggregationPropertyName,
+            limit: opt?.limit ?? 100
+          };
+          break;
+        case undefined:
+          if (aggregationPropertyName === "$count") {
+            aggregationOperationDefinition = {
+              type: "count"
+            };
+            break;
+          }
+        default:
+          process.env.NODE_ENV !== "production" ? invariant(false, "Invalid aggregation operation " + aggregationOperation) : invariant(false);
+      }
+      const selectorResult = {
+        type: {}
+      };
+      definitionMap.set(selectorResult, {
+        type: "selection",
+        objectSet: objectSet,
+        operation: aggregationOperationDefinition
+      });
+      return selectorResult;
+    },
+    selectProperty: name => {
+      const selectorResult = {
+        type: {}
+      };
+      definitionMap.set(selectorResult, {
+        type: "selection",
+        objectSet: objectSet,
+        operation: {
+          type: "get",
+          selectedPropertyApiName: name
+        }
+      });
+      return selectorResult;
+    }
+  };
+}
+//# sourceMappingURL=createWithPropertiesObjectSet.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"createWithPropertiesObjectSet.js","names":["invariant","modernToLegacyWhereClause","idCounter","createWithPropertiesObjectSet","objectType","objectSet","definitionMap","pivotTo","link","type","where","clause","aggregate","aggregation","opt","splitAggregation","split","length","process","env","NODE_ENV","aggregationPropertyName","aggregationOperation","aggregationOperationDefinition","selectedPropertyApiName","approximatePercentile","percentile","limit","undefined","selectorResult","set","operation","selectProperty","name"],"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\nconst idCounter = 0;\n\n/** @internal */\nexport function createWithPropertiesObjectSet<\n  Q extends ObjectOrInterfaceDefinition,\n>(\n  objectType: Q,\n  objectSet: WireObjectSet,\n  definitionMap: Map<any, DerivedPropertyDefinition>,\n): DerivedProperty.SelectPropertyBuilder<Q, false> {\n  const base: DerivedProperty.SelectPropertyBuilder<Q, false> = {\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 selectorResult: DerivedProperty.SelectorResult<any> = { type: {} };\n      definitionMap.set(selectorResult, {\n        type: \"selection\",\n        objectSet: objectSet,\n        operation: aggregationOperationDefinition,\n      });\n      return selectorResult;\n    },\n    selectProperty: (name) => {\n      const selectorResult: DerivedProperty.SelectorResult<any> = { type: {} };\n      definitionMap.set(selectorResult, {\n        type: \"selection\",\n        objectSet: objectSet,\n        operation: {\n          type: \"get\",\n          selectedPropertyApiName: name,\n        },\n      });\n      return selectorResult;\n    },\n  };\n\n  return base;\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;AAEhG,MAAMC,SAAS,GAAG,CAAC;;AAEnB;AACA,OAAO,SAASC,6BAA6BA,CAG3CC,UAAa,EACbC,SAAwB,EACxBC,aAAkD,EACD;EAsFjD,OArF8D;IAC5DC,OAAO,EAAGC,IAAI,IAAK;MACjB,OAAOL,6BAA6B,CAACC,UAAU,EAAE;QAC/CK,IAAI,EAAE,cAAc;QACpBJ,SAAS;QACTG;MACF,CAAC,EAAEF,aAAa,CAAC;IACnB,CAAC;IACDI,KAAK,EAAGC,MAAM,IAAK;MACjB,OAAOR,6BAA6B,CAACC,UAAU,EAAE;QAC/CK,IAAI,EAAE,QAAQ;QACdJ,SAAS,EAAEA,SAAS;QACpBK,KAAK,EAAET,yBAAyB,CAACU,MAAM,EAAEP,UAAU;MACrD,CAAC,EAAEE,aAAa,CAAC;IACnB,CAAC;IACDM,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,cAAmD,GAAG;QAAEpB,IAAI,EAAE,CAAC;MAAE,CAAC;MACxEH,aAAa,CAACwB,GAAG,CAACD,cAAc,EAAE;QAChCpB,IAAI,EAAE,WAAW;QACjBJ,SAAS,EAAEA,SAAS;QACpB0B,SAAS,EAAER;MACb,CAAC,CAAC;MACF,OAAOM,cAAc;IACvB,CAAC;IACDG,cAAc,EAAGC,IAAI,IAAK;MACxB,MAAMJ,cAAmD,GAAG;QAAEpB,IAAI,EAAE,CAAC;MAAE,CAAC;MACxEH,aAAa,CAACwB,GAAG,CAACD,cAAc,EAAE;QAChCpB,IAAI,EAAE,WAAW;QACjBJ,SAAS,EAAEA,SAAS;QACpB0B,SAAS,EAAE;UACTtB,IAAI,EAAE,KAAK;UACXe,uBAAuB,EAAES;QAC3B;MACF,CAAC,CAAC;MACF,OAAOJ,cAAc;IACvB;EACF,CAAC;AAGH","ignoreList":[]}

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

@@ -0,0 +1,100 @@
+/*
+ * 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 { Employee } from "@osdk/client.test.ontology";
+import { describe, expect, it } from "vitest";
+import { createWithPropertiesObjectSet } from "./createWithPropertiesObjectSet.js";
+describe(createWithPropertiesObjectSet, () => {
+  it("correctly creates basic object set with derived properties", () => {
+    const map = new Map();
+    const deriveObjectSet = createWithPropertiesObjectSet(Employee, {
+      type: "methodInput"
+    }, map);
+    const result = {
+      "derivedPropertyName": base => base.pivotTo("lead").selectProperty("employeeId")
+    }["derivedPropertyName"](deriveObjectSet);
+    const definition = map.get(result);
+    expect(definition).toMatchInlineSnapshot(`
+        {
+          "objectSet": {
+            "link": "lead",
+            "objectSet": {
+              "type": "methodInput",
+            },
+            "type": "searchAround",
+          },
+          "operation": {
+            "selectedPropertyApiName": "employeeId",
+            "type": "get",
+          },
+          "type": "selection",
+        }
+      `);
+  });
+  it("correctly handles multiple definitions in one clause", () => {
+    const map = new Map();
+    const deriveObjectSet = createWithPropertiesObjectSet(Employee, {
+      type: "methodInput"
+    }, map);
+    const clause = {
+      "derivedPropertyName": base => base.pivotTo("lead").aggregate("startDate:approximatePercentile", {
+        percentile: 0.5
+      }),
+      "secondaryDerivedPropertyName": base => base.pivotTo("lead").aggregate("fullName:collectSet", {
+        limit: 10
+      })
+    };
+    const result = clause["derivedPropertyName"](deriveObjectSet);
+    const definition = map.get(result);
+    const secondResult = clause["secondaryDerivedPropertyName"](deriveObjectSet);
+    const secondDefinition = map.get(secondResult);
+    expect(definition).toMatchInlineSnapshot(`
+        {
+          "objectSet": {
+            "link": "lead",
+            "objectSet": {
+              "type": "methodInput",
+            },
+            "type": "searchAround",
+          },
+          "operation": {
+            "approximatePercentile": 0.5,
+            "selectedPropertyApiName": "startDate",
+            "type": "approximatePercentile",
+          },
+          "type": "selection",
+        }
+      `);
+    expect(secondDefinition).toMatchInlineSnapshot(`
+        {
+          "objectSet": {
+            "link": "lead",
+            "objectSet": {
+              "type": "methodInput",
+            },
+            "type": "searchAround",
+          },
+          "operation": {
+            "limit": 10,
+            "selectedPropertyApiName": "fullName",
+            "type": "collectSet",
+          },
+          "type": "selection",
+        }
+      `);
+  });
+});
+//# sourceMappingURL=createWithPropertiesObjectSet.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"createWithPropertiesObjectSet.test.js","names":["Employee","describe","expect","it","createWithPropertiesObjectSet","map","Map","deriveObjectSet","type","result","base","pivotTo","selectProperty","definition","get","toMatchInlineSnapshot","clause","aggregate","percentile","limit","secondResult","secondDefinition"],"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 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(\"startDate: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\": \"startDate\",\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,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,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,iCAAiC,EAAE;QAChEC,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;AACJ,CAAC,CAAC","ignoreList":[]}

package/build/browser/objectSet/ObjectSet.test.js

@@ -410,6 +410,232 @@ describe("ObjectSet", () => {
       });
     });
   });
+  describe("Derived Properties Object Set", () => {
+    it("does not allow aggregate or selectProperty before a link type is selected", () => {
+      client(Employee).withProperties({
+        "derivedPropertyName": base =>
+        // @ts-expect-error
+        base.aggregate("employeeId:exactDistinct")
+      });
+      client(Employee).withProperties({
+        "derivedPropertyName": base =>
+        // @ts-expect-error
+        base.selectProperty("employeeId")
+      });
+    });
+    it("does not allow selectProperty when a many link was selected at any point", () => {
+      client(Employee).withProperties({
+        "derivedPropertyName": base => {
+          // @ts-expect-error
+          base.pivotTo("peeps").selectProperty("employeeId");
+
+          // @ts-expect-error
+          base.pivotTo("lead").pivotTo("peeps").selectProperty("employeeId");
+          return base.pivotTo("lead").selectProperty("employeeId");
+        }
+      });
+    });
+    it("enforces a return only of correct type", () => {
+      client(Employee).withProperties({
+        // @ts-expect-error
+        "derivedPropertyName": base => {
+          return base.pivotTo("peeps");
+        },
+        // @ts-expect-error
+        "derivedPropertyName2": () => {
+          return {
+            incorrect: "type"
+          };
+        }
+      });
+    });
+
+    // Executed code fails since we're providing bad strings to the function
+    it.fails("correctly narrows types of aggregate function", () => {
+      client(Employee).withProperties({
+        "derivedPropertyName": base => {
+          // @ts-expect-error
+          base.pivotTo("lead").aggregate("notAProperty:sum");
+
+          // @ts-expect-error
+          base.pivotTo("lead").aggregate(":avg");
+
+          // @ts-expect-error
+          base.pivotTo("lead").aggregate("employeeId:notAnOp");
+
+          // @ts-expect-error
+          base.pivotTo("lead").aggregate("");
+          base.pivotTo("lead").aggregate("employeeId:collectList");
+          return base.pivotTo("lead").aggregate("employeeId:sum");
+        }
+      });
+    });
+
+    // Executed code fails since we're providing bad strings to the function
+    it("correctly narrows types of options for aggregate functions", () => {
+      const objectSet = client(Employee).withProperties({
+        "derivedPropertyName": base => {
+          // @ts-expect-error
+          base.pivotTo("lead").aggregate("employeeId:approximateDistinct", {
+            limit: 1
+          });
+          base.pivotTo("lead").aggregate("employeeId:collectList", {
+            limit: 1
+          });
+          base.pivotTo("lead").aggregate("employeeId:collectSet", {
+            limit: 1
+          });
+          base.pivotTo("lead").aggregate("employeeId:collectList", {
+            // @ts-expect-error
+            percentile: 1
+          });
+          return base.pivotTo("lead").aggregate("employeeId:approximatePercentile", {
+            percentile: 0.5
+          });
+        }
+      });
+      expectTypeOf(objectSet).branded.toEqualTypeOf();
+    });
+    it("correctly narrows types of selectProperty function", () => {
+      client(Employee).withProperties({
+        "derivedPropertyName": base => {
+          // @ts-expect-error
+          base.pivotTo("lead").selectProperty("notAProperty");
+          return base.pivotTo("lead").selectProperty("employeeStatus");
+        }
+      });
+    });
+    it("propagates derived property type to future object set operations with correct types", () => {
+      client(Employee).withProperties({
+        "derivedPropertyName": base => base.pivotTo("lead").aggregate("employeeId:sum")
+        // @ts-expect-error
+      }).where({
+        "notAProperty": {
+          "$eq": 3
+        }
+      });
+      const numericAggregationObjectSet = client(Employee).withProperties({
+        "derivedPropertyName": base => base.pivotTo("lead").aggregate("employeeId:sum")
+      }).where({
+        "derivedPropertyName": {
+          "$eq": 3
+        }
+      });
+      expectTypeOf(numericAggregationObjectSet).toEqualTypeOf();
+      client(Employee).withProperties({
+        "derivedPropertyName": base => base.pivotTo("lead").aggregate("employeeId:collectList")
+      }).where({
+        "derivedPropertyName": {
+          "$isNull": false
+        }
+      })
+      // @ts-expect-error
+      .where({
+        "derivedPropertyName": {
+          "$eq": [1, 2]
+        }
+      });
+      const setAggregationObjectSet = client(Employee).withProperties({
+        "derivedPropertyName": base => base.pivotTo("lead").aggregate("fullName:collectSet")
+      });
+      setAggregationObjectSet.where({
+        "derivedPropertyName": {
+          "$isNull": false
+        }
+      });
+      setAggregationObjectSet.where({
+        // @ts-expect-error
+        "derivedPropertyName": {
+          "$eq": [1, 2]
+        }
+      });
+      expectTypeOf(setAggregationObjectSet).toEqualTypeOf();
+      const selectPropertyObjectSet = client(Employee).withProperties({
+        "derivedPropertyName": base => base.pivotTo("lead").selectProperty("employeeId")
+      }).where({
+        "derivedPropertyName": {
+          "$eq": 3
+        }
+      });
+      expectTypeOf(selectPropertyObjectSet).toEqualTypeOf();
+      client(Employee).withProperties({
+        "derivedPropertyName": base => base.pivotTo("lead").selectProperty("startDate")
+      }).where({
+        "derivedPropertyName": {
+          "$eq": "datetimeFilter"
+        }
+      });
+    });
+    it("correctly types multiple property definitions in one clause", () => {
+      const objectSet = client(Employee).withProperties({
+        "derivedPropertyName": base => base.pivotTo("lead").aggregate("employeeId:sum"),
+        "derivedPropertyName2": base => base.pivotTo("lead").selectProperty("fullName")
+      }).where({
+        "derivedPropertyName": {
+          "$eq": 3
+        }
+      }).where({
+        "derivedPropertyName2": {
+          "$eq": "name"
+        }
+      });
+      expectTypeOf(objectSet).toEqualTypeOf();
+    });
+    it("ensures other properties are consistently typed", () => {
+      client(Employee).withProperties({
+        "derivedPropertyName": base => base.pivotTo("lead").selectProperty("employeeId")
+      }).where({
+        "fullName": {
+          "$eq": "A"
+        }
+      });
+      client(Employee).withProperties({
+        "derivedPropertyName": base => base.pivotTo("lead").selectProperty("employeeId")
+      }).where({
+        "employeeId": {
+          "$eq": 2
+        }
+      });
+    });
+    it("allows fetching derived properties with correctly typed Osdk.Instance types", async () => {
+      const objectWithRdp = await client(Employee).withProperties({
+        "derivedPropertyName": base => base.pivotTo("lead").selectProperty("employeeId")
+      }).fetchOne(50035);
+      expectTypeOf(objectWithRdp.derivedPropertyName).toEqualTypeOf();
+      expect(objectWithRdp.derivedPropertyName).toBe(1);
+      const objectWithUndefinedRdp = await client(Employee).withProperties({
+        "derivedPropertyName": base => base.pivotTo("lead").selectProperty("employeeId")
+      }).fetchOne(50036);
+      expect(objectWithUndefinedRdp.derivedPropertyName).toBeUndefined();
+    });
+  });
+  describe.each(["fetchOne", "fetchOneWithErrors"])("%s", k => {
+    describe("strictNonNull: false", () => {
+      describe("includeRid: true", () => {
+        it("returns bad data", async () => {
+          // Look at this
+          const opts = {
+            $__EXPERIMENTAL_strictNonNull: false,
+            $includeRid: true
+          };
+          const result = k === "fetchOne" ? await client(Employee).fetchOne(50033, opts) : (await client(Employee).fetchOneWithErrors(50033, opts)).value;
+          expect(result).not.toBeUndefined();
+          expectTypeOf(result).branded.toEqualTypeOf();
+        });
+      });
+      describe("includeRid: false", () => {
+        it("returns bad data", async () => {
+          const opts = {
+            $__EXPERIMENTAL_strictNonNull: false,
+            $includeRid: false
+          };
+          const result = k === "fetchOne" ? await client(Employee).fetchOne(50033, opts) : (await client(Employee).fetchOneWithErrors(50033, opts)).value;
+          expect(result).not.toBeUndefined();
+          expectTypeOf(result).branded.toEqualTypeOf();
+        });
+      });
+    });
+  });
   describe("conversions", () => {
     describe("strictNonNull: false", () => {
       it("returns bad data", async () => {