@osdk/api 2.1.0-beta.28 → 2.1.0-beta.29

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

@@ -0,0 +1,155 @@
+/*
+ * 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 { describe, expectTypeOf, it, test, vi } from "vitest";
+const Employee = {
+  type: "object",
+  apiName: "Employee"
+};
+describe("ObjectSet", () => {
+  const fauxObjectSet = {
+    where: vi.fn(() => {
+      return fauxObjectSet;
+    }),
+    withProperties: vi.fn(() => {
+      return fauxObjectSet;
+    }),
+    fetchPage: vi.fn(() => Promise.resolve()),
+    asyncIter: vi.fn(() => {
+      return {};
+    })
+  };
+  describe("normal", () => {
+    test("select none", async () => {
+      await fauxObjectSet.fetchPage();
+      expectTypeOf().toEqualTypeOf();
+    });
+    test("select one", async () => {
+      await fauxObjectSet.fetchPage({
+        "$select": ["fullName"]
+      });
+      expectTypeOf().toEqualTypeOf();
+    });
+  });
+  describe(".withProperties", () => {
+    test("single property", async () => {
+      const withA = fauxObjectSet.withProperties({
+        "a": base => {
+          return base.pivotTo("lead").aggregate("class:exactDistinct");
+        }
+      });
+      expectTypeOf(withA).toEqualTypeOf();
+      await withA.fetchPage();
+      expectTypeOf().toEqualTypeOf();
+      expectTypeOf().toEqualTypeOf();
+    });
+    test("multiple properties", async () => {
+      const withFamily = fauxObjectSet.withProperties({
+        "mom": base => base.pivotTo("lead").aggregate("$count"),
+        "dad": base => base.pivotTo("lead").selectProperty("fullName"),
+        "sister": base => base.pivotTo("lead").aggregate("class:collectList")
+      });
+      expectTypeOf(withFamily).toEqualTypeOf();
+      await withFamily.fetchPage();
+      expectTypeOf().toEqualTypeOf();
+      expectTypeOf().toEqualTypeOf();
+      expectTypeOf().toEqualTypeOf();
+      expectTypeOf().toEqualTypeOf();
+    });
+    describe("called in succession", () => {
+      test("independently", () => {
+        const withMom = fauxObjectSet.withProperties({
+          "mom": base => base.pivotTo("lead").aggregate("$count")
+        });
+        const withParents = withMom.withProperties({
+          "dad": base => base.pivotTo("lead").selectProperty("fullName")
+        });
+        expectTypeOf(withParents).toEqualTypeOf();
+      });
+      test.todo("with calculated properties");
+    });
+    describe("fetch functions return correct Osdk.Instance", () => {
+      const withFamily = fauxObjectSet.withProperties({
+        "mom": base => base.pivotTo("lead").aggregate("$count"),
+        "dad": base => base.pivotTo("lead").selectProperty("fullName"),
+        "sister": base => base.pivotTo("lead").aggregate("class:collectList")
+      });
+      it("works with .where", async () => {
+        const where = withFamily.where({
+          "mom": 1
+        });
+        await where.fetchPage();
+        expectTypeOf().toEqualTypeOf();
+        expectTypeOf().toEqualTypeOf();
+      });
+      it("works with .async", () => {
+        withFamily.asyncIter();
+        expectTypeOf().toEqualTypeOf();
+      });
+      it("Works with no select", async () => {
+        await withFamily.fetchPage();
+        expectTypeOf().toEqualTypeOf();
+      });
+      it("Works with selecting all RDPs", async () => {
+        await withFamily.fetchPage({
+          $select: ["mom", "dad", "sister"]
+        });
+        expectTypeOf().toEqualTypeOf();
+        expectTypeOf().toEqualTypeOf();
+      });
+      it("Works with selecting some RDPs", async () => {
+        await withFamily.fetchPage({
+          $select: ["mom"]
+        });
+        expectTypeOf().toEqualTypeOf();
+      });
+      it("Works with selecting all non-RDP's", async () => {
+        await withFamily.fetchPage({
+          $select: ["class", "fullName"]
+        });
+        expectTypeOf().toEqualTypeOf();
+        expectTypeOf().toEqualTypeOf();
+      });
+      it("Works with selecting some non-RDP's", async () => {
+        await withFamily.fetchPage({
+          $select: ["class"]
+        });
+        expectTypeOf().toEqualTypeOf();
+      });
+      it("Works with selecting a mix", async () => {
+        await withFamily.fetchPage({
+          $select: ["class", "mom"]
+        });
+        expectTypeOf().toEqualTypeOf();
+      });
+    });
+    it("allows extracting the type", () => {
+      fauxObjectSet.withProperties({
+        "mom": base => base.pivotTo("lead").aggregate("$count")
+      });
+      expectTypeOf().toEqualTypeOf();
+      fauxObjectSet.withProperties({
+        "mom": base => base.pivotTo("lead").aggregate("$count")
+      });
+    });
+    it("Defining the Type", () => {
+      fauxObjectSet.withProperties({
+        "mom": base => base.pivotTo("lead").aggregate("$count")
+      });
+    });
+  });
+});
+//# sourceMappingURL=ObjectSet.test.js.map

package/build/esm/objectSet/ObjectSet.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ObjectSet.test.js","names":["describe","expectTypeOf","it","test","vi","Employee","type","apiName","fauxObjectSet","where","fn","withProperties","fetchPage","Promise","resolve","asyncIter","toEqualTypeOf","withA","base","pivotTo","aggregate","withFamily","selectProperty","withMom","withParents","todo","$select"],"sources":["ObjectSet.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 { describe, expectTypeOf, it, test, vi } from \"vitest\";\n\nimport type {\n  ObjectMetadata as $ObjectMetadata,\n  ObjectSet as $ObjectSet,\n  ObjectTypeDefinition as $ObjectTypeDefinition,\n  Osdk,\n  PropertyDef as $PropertyDef,\n  PropertyKeys,\n  PropertyValueWireToClient as $PropType,\n  SingleLinkAccessor as $SingleLinkAccessor,\n} from \"../index.js\";\n\nnamespace Employee {\n  export type PropertyKeys =\n    | \"fullName\"\n    | \"class\";\n\n  export interface Links {\n    readonly lead: $SingleLinkAccessor<Employee>;\n    readonly peeps: Employee.ObjectSet;\n  }\n\n  export interface Props {\n    readonly class: $PropType[\"string\"] | undefined;\n    readonly fullName: $PropType[\"string\"] | undefined;\n  }\n  export type StrictProps = Props;\n\n  export interface ObjectSet extends $ObjectSet<Employee, Employee.ObjectSet> {}\n}\n\ninterface Employee extends $ObjectTypeDefinition {\n  type: \"object\";\n  apiName: \"Employee\";\n  __DefinitionMetadata?: {\n    objectSet: Employee.ObjectSet;\n    props: Employee.Props;\n    linksType: Employee.Links;\n    strictProps: Employee.StrictProps;\n    apiName: \"Employee\";\n    description: \"A full-time or part-time \\n\\n employee of our firm\";\n    displayName: \"Employee\";\n    icon: {\n      type: \"blueprint\";\n      color: \"blue\";\n      name: \"person\";\n    };\n    implements: [\"FooInterface\"];\n    interfaceMap: {\n      FooInterface: {\n        fooSpt: \"fullName\";\n      };\n    };\n    inverseInterfaceMap: {\n      FooInterface: {\n        fullName: \"fooSpt\";\n      };\n    };\n    links: {\n      lead: $ObjectMetadata.Link<Employee, false>;\n      peeps: $ObjectMetadata.Link<Employee, true>;\n    };\n    pluralDisplayName: \"Employees\";\n    primaryKeyApiName: \"employeeId\";\n    primaryKeyType: \"integer\";\n    properties: {\n      class: $PropertyDef<\"string\", \"nullable\", \"single\">;\n      fullName: $PropertyDef<\"string\", \"nullable\", \"single\">;\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\nconst Employee: Employee = {\n  type: \"object\",\n  apiName: \"Employee\",\n};\n\ndescribe(\"ObjectSet\", () => {\n  const fauxObjectSet = {\n    where: vi.fn(() => {\n      return fauxObjectSet;\n    }),\n    withProperties: vi.fn(() => {\n      return fauxObjectSet;\n    }),\n    fetchPage: vi.fn(() => Promise.resolve()),\n    asyncIter: vi.fn(() => {\n      return {};\n    }),\n  } as any as Employee.ObjectSet;\n\n  describe(\"normal\", () => {\n    test(\"select none\", async () => {\n      const result = await fauxObjectSet.fetchPage();\n      expectTypeOf<typeof result.data[0]>().toEqualTypeOf<\n        Osdk.Instance<Employee, never>\n      >();\n    });\n\n    test(\"select one\", async () => {\n      const result = await fauxObjectSet.fetchPage({ \"$select\": [\"fullName\"] });\n      expectTypeOf<typeof result.data[0]>().toEqualTypeOf<\n        Osdk.Instance<Employee, never, \"fullName\">\n      >();\n    });\n  });\n\n  describe(\".withProperties\", () => {\n    test(\"single property\", async () => {\n      const withA = fauxObjectSet.withProperties({\n        \"a\": (base) => {\n          return base.pivotTo(\"lead\").aggregate(\"class:exactDistinct\");\n        },\n      });\n\n      expectTypeOf(withA).toEqualTypeOf<\n        $ObjectSet<Employee, {\n          a: \"integer\" | undefined;\n        }>\n      >();\n\n      const withAResults = await withA.fetchPage();\n\n      expectTypeOf<typeof withAResults[\"data\"][0]>().toEqualTypeOf<\n        Osdk.Instance<Employee, never, PropertyKeys<Employee>, {\n          a: \"integer\" | undefined;\n        }>\n      >();\n\n      expectTypeOf<typeof withAResults[\"data\"][0][\"a\"]>()\n        .toEqualTypeOf<number | undefined>();\n    });\n\n    test(\"multiple properties\", async () => {\n      const withFamily = fauxObjectSet.withProperties({\n        \"mom\": (base) => base.pivotTo(\"lead\").aggregate(\"$count\"),\n        \"dad\": (base) => base.pivotTo(\"lead\").selectProperty(\"fullName\"),\n        \"sister\": (base) => base.pivotTo(\"lead\").aggregate(\"class:collectList\"),\n      });\n      expectTypeOf(withFamily).toEqualTypeOf<\n        $ObjectSet<Employee, {\n          mom: \"integer\" | undefined;\n          dad: \"string\" | undefined;\n          sister: \"string\"[] | undefined;\n        }>\n      >();\n\n      const withFamilyResults = await withFamily.fetchPage();\n\n      expectTypeOf<typeof withFamilyResults[\"data\"][0]>().toEqualTypeOf<\n        Osdk.Instance<Employee, never, PropertyKeys<Employee>, {\n          mom: \"integer\" | undefined;\n          dad: \"string\" | undefined;\n          sister: \"string\"[] | undefined;\n        }>\n      >();\n\n      expectTypeOf<typeof withFamilyResults[\"data\"][0][\"mom\"]>()\n        .toEqualTypeOf<number | undefined>();\n      expectTypeOf<typeof withFamilyResults[\"data\"][0][\"dad\"]>()\n        .toEqualTypeOf<string | undefined>();\n      expectTypeOf<typeof withFamilyResults[\"data\"][0][\"sister\"]>()\n        .toEqualTypeOf<string[] | undefined>();\n    });\n\n    describe(\"called in succession\", () => {\n      test(\"independently\", () => {\n        const withMom = fauxObjectSet.withProperties({\n          \"mom\": (base) => base.pivotTo(\"lead\").aggregate(\"$count\"),\n        });\n\n        const withParents = withMom.withProperties({\n          \"dad\": (base) => base.pivotTo(\"lead\").selectProperty(\"fullName\"),\n        });\n\n        expectTypeOf(withParents).toEqualTypeOf<\n          $ObjectSet<Employee, {\n            mom: \"integer\" | undefined;\n            dad: \"string\" | undefined;\n          }>\n        >();\n      });\n\n      test.todo(\"with calculated properties\");\n    });\n\n    describe(\"fetch functions return correct Osdk.Instance\", () => {\n      const withFamily = fauxObjectSet.withProperties({\n        \"mom\": (base) => base.pivotTo(\"lead\").aggregate(\"$count\"),\n        \"dad\": (base) => base.pivotTo(\"lead\").selectProperty(\"fullName\"),\n        \"sister\": (base) => base.pivotTo(\"lead\").aggregate(\"class:collectList\"),\n      });\n\n      it(\"works with .where\", async () => {\n        const where = withFamily.where({ \"mom\": 1 });\n        const whereResults = await where.fetchPage();\n\n        expectTypeOf<typeof where>().toEqualTypeOf<typeof withFamily>();\n        expectTypeOf<typeof whereResults[\"data\"][0]>()\n          .toEqualTypeOf<\n            Osdk.Instance<Employee, never, PropertyKeys<Employee>, {\n              mom: \"integer\" | undefined;\n              dad: \"string\" | undefined;\n              sister: \"string\"[] | undefined;\n            }>\n          >();\n      });\n\n      it(\"works with .async\", () => {\n        const asyncIter = withFamily.asyncIter();\n        expectTypeOf<typeof asyncIter>().toEqualTypeOf<\n          AsyncIterableIterator<\n            Osdk.Instance<Employee, never, PropertyKeys<Employee>, {\n              mom: \"integer\" | undefined;\n              dad: \"string\" | undefined;\n              sister: \"string\"[] | undefined;\n            }>\n          >\n        >();\n      });\n\n      it(\"Works with no select\", async () => {\n        const withFamilyResults = await withFamily.fetchPage();\n\n        expectTypeOf<typeof withFamilyResults[\"data\"][0]>()\n          .toEqualTypeOf<\n            Osdk.Instance<Employee, never, PropertyKeys<Employee>, {\n              mom: \"integer\" | undefined;\n              dad: \"string\" | undefined;\n              sister: \"string\"[] | undefined;\n            }>\n          >();\n      });\n\n      it(\"Works with selecting all RDPs\", async () => {\n        const withFamilyResults = await withFamily.fetchPage({\n          $select: [\"mom\", \"dad\", \"sister\"],\n        });\n\n        expectTypeOf<typeof withFamilyResults[\"data\"][0]>()\n          .toEqualTypeOf<\n            Osdk.Instance<Employee, never, never, {\n              mom: \"integer\" | undefined;\n              dad: \"string\" | undefined;\n              sister: \"string\"[] | undefined;\n            }>\n          >();\n\n        expectTypeOf<typeof withFamilyResults[\"data\"][0][\"mom\"]>()\n          .toEqualTypeOf<number | undefined>();\n      });\n\n      it(\"Works with selecting some RDPs\", async () => {\n        const withFamilyResults = await withFamily.fetchPage({\n          $select: [\"mom\"],\n        });\n\n        expectTypeOf<typeof withFamilyResults[\"data\"][0]>()\n          .toEqualTypeOf<\n            Osdk.Instance<Employee, never, never, {\n              mom: \"integer\" | undefined;\n            }>\n          >();\n      });\n\n      it(\"Works with selecting all non-RDP's\", async () => {\n        const withFamilyResults = await withFamily.fetchPage({\n          $select: [\"class\", \"fullName\"],\n        });\n\n        expectTypeOf<typeof withFamilyResults[\"data\"][0]>()\n          .toEqualTypeOf<\n            Osdk.Instance<Employee, never, PropertyKeys<Employee>, {}>\n          >();\n        expectTypeOf<typeof withFamilyResults[\"data\"][0][\"class\"]>()\n          .toEqualTypeOf<\n            string | undefined\n          >();\n      });\n\n      it(\"Works with selecting some non-RDP's\", async () => {\n        const withFamilyResults = await withFamily.fetchPage({\n          $select: [\"class\"],\n        });\n\n        expectTypeOf<typeof withFamilyResults[\"data\"][0]>()\n          .toEqualTypeOf<\n            Osdk.Instance<Employee, never, \"class\", {}>\n          >();\n      });\n\n      it(\"Works with selecting a mix\", async () => {\n        const withFamilyResults = await withFamily.fetchPage({\n          $select: [\"class\", \"mom\"],\n        });\n\n        expectTypeOf<typeof withFamilyResults[\"data\"][0]>()\n          .toEqualTypeOf<\n            Osdk.Instance<\n              Employee,\n              never,\n              \"class\",\n              { mom: \"integer\" | undefined }\n            >\n          >();\n      });\n    });\n\n    it(\"allows extracting the type\", () => {\n      const objectSet = fauxObjectSet.withProperties({\n        \"mom\": (base) => base.pivotTo(\"lead\").aggregate(\"$count\"),\n      });\n\n      type ObjectSetType = typeof objectSet;\n\n      expectTypeOf<ObjectSetType>().toEqualTypeOf<\n        $ObjectSet<Employee, {\n          mom: \"integer\" | undefined;\n        }>\n      >();\n\n      const objectSet2 = fauxObjectSet.withProperties({\n        \"mom\": (base) => base.pivotTo(\"lead\").aggregate(\"$count\"),\n      }) satisfies ObjectSetType;\n    });\n\n    it(\"Defining the Type\", () => {\n      type ObjectSetType = $ObjectSet<\n        Employee,\n        {\n          mom: \"integer\" | undefined;\n        }\n      >;\n\n      fauxObjectSet.withProperties({\n        \"mom\": (base) => base.pivotTo(\"lead\").aggregate(\"$count\"),\n      }) satisfies ObjectSetType;\n    });\n  });\n});\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAASA,QAAQ,EAAEC,YAAY,EAAEC,EAAE,EAAEC,IAAI,EAAEC,EAAE,QAAQ,QAAQ;AA8E7D,MAAMC,QAAkB,GAAG;EACzBC,IAAI,EAAE,QAAQ;EACdC,OAAO,EAAE;AACX,CAAC;AAEDP,QAAQ,CAAC,WAAW,EAAE,MAAM;EAC1B,MAAMQ,aAAa,GAAG;IACpBC,KAAK,EAAEL,EAAE,CAACM,EAAE,CAAC,MAAM;MACjB,OAAOF,aAAa;IACtB,CAAC,CAAC;IACFG,cAAc,EAAEP,EAAE,CAACM,EAAE,CAAC,MAAM;MAC1B,OAAOF,aAAa;IACtB,CAAC,CAAC;IACFI,SAAS,EAAER,EAAE,CAACM,EAAE,CAAC,MAAMG,OAAO,CAACC,OAAO,CAAC,CAAC,CAAC;IACzCC,SAAS,EAAEX,EAAE,CAACM,EAAE,CAAC,MAAM;MACrB,OAAO,CAAC,CAAC;IACX,CAAC;EACH,CAA8B;EAE9BV,QAAQ,CAAC,QAAQ,EAAE,MAAM;IACvBG,IAAI,CAAC,aAAa,EAAE,YAAY;MACf,MAAMK,aAAa,CAACI,SAAS,CAAC,CAAC;MAC9CX,YAAY,CAAwB,CAAC,CAACe,aAAa,CAEjD,CAAC;IACL,CAAC,CAAC;IAEFb,IAAI,CAAC,YAAY,EAAE,YAAY;MACd,MAAMK,aAAa,CAACI,SAAS,CAAC;QAAE,SAAS,EAAE,CAAC,UAAU;MAAE,CAAC,CAAC;MACzEX,YAAY,CAAwB,CAAC,CAACe,aAAa,CAEjD,CAAC;IACL,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFhB,QAAQ,CAAC,iBAAiB,EAAE,MAAM;IAChCG,IAAI,CAAC,iBAAiB,EAAE,YAAY;MAClC,MAAMc,KAAK,GAAGT,aAAa,CAACG,cAAc,CAAC;QACzC,GAAG,EAAGO,IAAI,IAAK;UACb,OAAOA,IAAI,CAACC,OAAO,CAAC,MAAM,CAAC,CAACC,SAAS,CAAC,qBAAqB,CAAC;QAC9D;MACF,CAAC,CAAC;MAEFnB,YAAY,CAACgB,KAAK,CAAC,CAACD,aAAa,CAI/B,CAAC;MAEkB,MAAMC,KAAK,CAACL,SAAS,CAAC,CAAC;MAE5CX,YAAY,CAAiC,CAAC,CAACe,aAAa,CAI1D,CAAC;MAEHf,YAAY,CAAsC,CAAC,CAChDe,aAAa,CAAqB,CAAC;IACxC,CAAC,CAAC;IAEFb,IAAI,CAAC,qBAAqB,EAAE,YAAY;MACtC,MAAMkB,UAAU,GAAGb,aAAa,CAACG,cAAc,CAAC;QAC9C,KAAK,EAAGO,IAAI,IAAKA,IAAI,CAACC,OAAO,CAAC,MAAM,CAAC,CAACC,SAAS,CAAC,QAAQ,CAAC;QACzD,KAAK,EAAGF,IAAI,IAAKA,IAAI,CAACC,OAAO,CAAC,MAAM,CAAC,CAACG,cAAc,CAAC,UAAU,CAAC;QAChE,QAAQ,EAAGJ,IAAI,IAAKA,IAAI,CAACC,OAAO,CAAC,MAAM,CAAC,CAACC,SAAS,CAAC,mBAAmB;MACxE,CAAC,CAAC;MACFnB,YAAY,CAACoB,UAAU,CAAC,CAACL,aAAa,CAMpC,CAAC;MAEuB,MAAMK,UAAU,CAACT,SAAS,CAAC,CAAC;MAEtDX,YAAY,CAAsC,CAAC,CAACe,aAAa,CAM/D,CAAC;MAEHf,YAAY,CAA6C,CAAC,CACvDe,aAAa,CAAqB,CAAC;MACtCf,YAAY,CAA6C,CAAC,CACvDe,aAAa,CAAqB,CAAC;MACtCf,YAAY,CAAgD,CAAC,CAC1De,aAAa,CAAuB,CAAC;IAC1C,CAAC,CAAC;IAEFhB,QAAQ,CAAC,sBAAsB,EAAE,MAAM;MACrCG,IAAI,CAAC,eAAe,EAAE,MAAM;QAC1B,MAAMoB,OAAO,GAAGf,aAAa,CAACG,cAAc,CAAC;UAC3C,KAAK,EAAGO,IAAI,IAAKA,IAAI,CAACC,OAAO,CAAC,MAAM,CAAC,CAACC,SAAS,CAAC,QAAQ;QAC1D,CAAC,CAAC;QAEF,MAAMI,WAAW,GAAGD,OAAO,CAACZ,cAAc,CAAC;UACzC,KAAK,EAAGO,IAAI,IAAKA,IAAI,CAACC,OAAO,CAAC,MAAM,CAAC,CAACG,cAAc,CAAC,UAAU;QACjE,CAAC,CAAC;QAEFrB,YAAY,CAACuB,WAAW,CAAC,CAACR,aAAa,CAKrC,CAAC;MACL,CAAC,CAAC;MAEFb,IAAI,CAACsB,IAAI,CAAC,4BAA4B,CAAC;IACzC,CAAC,CAAC;IAEFzB,QAAQ,CAAC,8CAA8C,EAAE,MAAM;MAC7D,MAAMqB,UAAU,GAAGb,aAAa,CAACG,cAAc,CAAC;QAC9C,KAAK,EAAGO,IAAI,IAAKA,IAAI,CAACC,OAAO,CAAC,MAAM,CAAC,CAACC,SAAS,CAAC,QAAQ,CAAC;QACzD,KAAK,EAAGF,IAAI,IAAKA,IAAI,CAACC,OAAO,CAAC,MAAM,CAAC,CAACG,cAAc,CAAC,UAAU,CAAC;QAChE,QAAQ,EAAGJ,IAAI,IAAKA,IAAI,CAACC,OAAO,CAAC,MAAM,CAAC,CAACC,SAAS,CAAC,mBAAmB;MACxE,CAAC,CAAC;MAEFlB,EAAE,CAAC,mBAAmB,EAAE,YAAY;QAClC,MAAMO,KAAK,GAAGY,UAAU,CAACZ,KAAK,CAAC;UAAE,KAAK,EAAE;QAAE,CAAC,CAAC;QACvB,MAAMA,KAAK,CAACG,SAAS,CAAC,CAAC;QAE5CX,YAAY,CAAe,CAAC,CAACe,aAAa,CAAoB,CAAC;QAC/Df,YAAY,CAAiC,CAAC,CAC3Ce,aAAa,CAMZ,CAAC;MACP,CAAC,CAAC;MAEFd,EAAE,CAAC,mBAAmB,EAAE,MAAM;QACVmB,UAAU,CAACN,SAAS,CAAC,CAAC;QACxCd,YAAY,CAAmB,CAAC,CAACe,aAAa,CAQ5C,CAAC;MACL,CAAC,CAAC;MAEFd,EAAE,CAAC,sBAAsB,EAAE,YAAY;QACX,MAAMmB,UAAU,CAACT,SAAS,CAAC,CAAC;QAEtDX,YAAY,CAAsC,CAAC,CAChDe,aAAa,CAMZ,CAAC;MACP,CAAC,CAAC;MAEFd,EAAE,CAAC,+BAA+B,EAAE,YAAY;QACpB,MAAMmB,UAAU,CAACT,SAAS,CAAC;UACnDc,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ;QAClC,CAAC,CAAC;QAEFzB,YAAY,CAAsC,CAAC,CAChDe,aAAa,CAMZ,CAAC;QAELf,YAAY,CAA6C,CAAC,CACvDe,aAAa,CAAqB,CAAC;MACxC,CAAC,CAAC;MAEFd,EAAE,CAAC,gCAAgC,EAAE,YAAY;QACrB,MAAMmB,UAAU,CAACT,SAAS,CAAC;UACnDc,OAAO,EAAE,CAAC,KAAK;QACjB,CAAC,CAAC;QAEFzB,YAAY,CAAsC,CAAC,CAChDe,aAAa,CAIZ,CAAC;MACP,CAAC,CAAC;MAEFd,EAAE,CAAC,oCAAoC,EAAE,YAAY;QACzB,MAAMmB,UAAU,CAACT,SAAS,CAAC;UACnDc,OAAO,EAAE,CAAC,OAAO,EAAE,UAAU;QAC/B,CAAC,CAAC;QAEFzB,YAAY,CAAsC,CAAC,CAChDe,aAAa,CAEZ,CAAC;QACLf,YAAY,CAA+C,CAAC,CACzDe,aAAa,CAEZ,CAAC;MACP,CAAC,CAAC;MAEFd,EAAE,CAAC,qCAAqC,EAAE,YAAY;QAC1B,MAAMmB,UAAU,CAACT,SAAS,CAAC;UACnDc,OAAO,EAAE,CAAC,OAAO;QACnB,CAAC,CAAC;QAEFzB,YAAY,CAAsC,CAAC,CAChDe,aAAa,CAEZ,CAAC;MACP,CAAC,CAAC;MAEFd,EAAE,CAAC,4BAA4B,EAAE,YAAY;QACjB,MAAMmB,UAAU,CAACT,SAAS,CAAC;UACnDc,OAAO,EAAE,CAAC,OAAO,EAAE,KAAK;QAC1B,CAAC,CAAC;QAEFzB,YAAY,CAAsC,CAAC,CAChDe,aAAa,CAOZ,CAAC;MACP,CAAC,CAAC;IACJ,CAAC,CAAC;IAEFd,EAAE,CAAC,4BAA4B,EAAE,MAAM;MACnBM,aAAa,CAACG,cAAc,CAAC;QAC7C,KAAK,EAAGO,IAAI,IAAKA,IAAI,CAACC,OAAO,CAAC,MAAM,CAAC,CAACC,SAAS,CAAC,QAAQ;MAC1D,CAAC,CAAC;MAIFnB,YAAY,CAAgB,CAAC,CAACe,aAAa,CAIzC,CAAC;MAEgBR,aAAa,CAACG,cAAc,CAAC;QAC9C,KAAK,EAAGO,IAAI,IAAKA,IAAI,CAACC,OAAO,CAAC,MAAM,CAAC,CAACC,SAAS,CAAC,QAAQ;MAC1D,CAAC,CAAC;IACJ,CAAC,CAAC;IAEFlB,EAAE,CAAC,mBAAmB,EAAE,MAAM;MAQ5BM,aAAa,CAACG,cAAc,CAAC;QAC3B,KAAK,EAAGO,IAAI,IAAKA,IAAI,CAACC,OAAO,CAAC,MAAM,CAAC,CAACC,SAAS,CAAC,QAAQ;MAC1D,CAAC,CAAC;IACJ,CAAC,CAAC;EACJ,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}

package/build/esm/ontology/ObjectOrInterface.js

@@ -1,2 +1,17 @@
-export {};
+/*
+ * Copyright 2023 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.
+ */
+export let ObjectOrInterfaceDefinition;
 //# sourceMappingURL=ObjectOrInterface.js.map

package/build/esm/ontology/ObjectOrInterface.js.map

@@ -1 +1 @@
-{"version":3,"file":"ObjectOrInterface.js","names":[],"sources":["ObjectOrInterface.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 { InterfaceDefinition } from \"./InterfaceDefinition.js\";\nimport type { ObjectTypeDefinition } from \"./ObjectTypeDefinition.js\";\n\nexport type ObjectOrInterfaceDefinition =\n  | ObjectTypeDefinition\n  | InterfaceDefinition;\n\nexport type PropertyKeys<\n  O extends ObjectOrInterfaceDefinition,\n> = keyof NonNullable<O[\"__DefinitionMetadata\"]>[\"properties\"] & string;\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"ObjectOrInterface.js","names":["ObjectOrInterfaceDefinition"],"sources":["ObjectOrInterface.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 { InterfaceDefinition } from \"./InterfaceDefinition.js\";\nimport type { ObjectTypeDefinition } from \"./ObjectTypeDefinition.js\";\nimport type { SimplePropertyDef } from \"./SimplePropertyDef.js\";\n\nexport type ObjectOrInterfaceDefinition =\n  | ObjectTypeDefinition\n  | InterfaceDefinition;\n\nexport namespace ObjectOrInterfaceDefinition {\n  export type WithDerivedProperties<\n    K extends ObjectOrInterfaceDefinition,\n    D extends Record<string, SimplePropertyDef>,\n  > = {\n    __DefinitionMetadata: {\n      properties: {\n        [T in keyof D]: SimplePropertyDef.ToPropertyDef<D[T]>;\n      };\n      props: {\n        [T in keyof D]: SimplePropertyDef.ToRuntimeProperty<D[T]>;\n      };\n    };\n  } & K;\n}\n\nexport type PropertyKeys<\n  O extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> =\n  & (keyof NonNullable<O[\"__DefinitionMetadata\"]>[\"properties\"] | keyof RDPs)\n  & string;\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAdA,WAwBiBA,2BAA2B","ignoreList":[]}

package/build/esm/ontology/SimplePropertyDef.js

@@ -0,0 +1,17 @@
+/*
+ * Copyright 2023 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.
+ */
+export let SimplePropertyDef;
+//# sourceMappingURL=SimplePropertyDef.js.map

package/build/esm/ontology/SimplePropertyDef.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SimplePropertyDef.js","names":["SimplePropertyDef"],"sources":["SimplePropertyDef.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 { GetClientPropertyValueFromWire } from \"../mapping/PropertyValueMapping.js\";\nimport type { ObjectMetadata, PropertyDef } from \"./ObjectTypeDefinition.js\";\nimport type { WirePropertyTypes } from \"./WirePropertyTypes.js\";\n\nexport type SimplePropertyDef =\n  | WirePropertyTypes\n  | undefined\n  | Array<WirePropertyTypes>;\n\nexport namespace SimplePropertyDef {\n  export type Make<\n    T extends WirePropertyTypes,\n    N extends boolean | undefined,\n    M extends boolean | undefined,\n  > =\n    // while it is cleaner to just do this as the union of two conditionals, it\n    // actually makes it so that it can't be derived inline which we want\n    // to keep things simple so instead of :\n    // | (P[\"multiplicity\"] extends true ? Array<P[\"type\"]> : P[\"type\"])\n    // | (P[\"nullable\"] extends true ? undefined : never);\n    // we do:\n    M extends true ? N extends true ? Array<T> | undefined\n      : Array<T>\n      : N extends true ? T | undefined\n      : T;\n\n  export type FromPropertyMetadata<\n    P extends ObjectMetadata.Property,\n  > = Make<P[\"type\"], P[\"nullable\"], P[\"multiplicity\"]>;\n\n  // exported for testing\n  export type ExtractMultiplicity<\n    T extends\n      | WirePropertyTypes\n      | undefined\n      | Array<WirePropertyTypes>,\n  > = NonNullable<T> extends Array<any> ? \"array\" : \"single\";\n\n  // exported for testing\n  export type ExtractWirePropertyType<\n    T extends SimplePropertyDef,\n  > = T extends Array<infer Z> ? NonNullable<Z> : NonNullable<T>;\n\n  // exported for testing\n  export type ExtractNullable<\n    T extends SimplePropertyDef,\n  > = [undefined] extends [T] ? \"nullable\"\n    : [[undefined]] extends [T] ? \"nullable\"\n    : \"non-nullable\";\n\n  export type ToPropertyDef<S extends SimplePropertyDef> = PropertyDef<\n    SimplePropertyDef.ExtractWirePropertyType<S>,\n    SimplePropertyDef.ExtractNullable<S>,\n    SimplePropertyDef.ExtractMultiplicity<S>\n  >;\n\n  export type ExtractRuntimeBaseType<S extends SimplePropertyDef> =\n    GetClientPropertyValueFromWire<\n      SimplePropertyDef.ExtractWirePropertyType<S>\n    >;\n\n  export type ToRuntimeProperty<S extends SimplePropertyDef> =\n    ExtractMultiplicity<S> extends \"array\"\n      ? ExtractNullable<S> extends \"nullable\"\n        ? Array<ExtractRuntimeBaseType<S>> | undefined\n      : Array<ExtractRuntimeBaseType<S>>\n      : ExtractNullable<S> extends \"nullable\"\n        ? ExtractRuntimeBaseType<S> | undefined\n      : ExtractRuntimeBaseType<S>;\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAdA,WAyBiBA,iBAAiB","ignoreList":[]}

package/build/esm/ontology/SimplePropertyDef.test.js

@@ -0,0 +1,48 @@
+/*
+ * 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 { describe, expectTypeOf, it, test } from "vitest";
+describe("Type conversion", () => {
+  test("SimplePropertyDef.ExtractMultiplicity", () => {
+    expectTypeOf().toEqualTypeOf();
+    expectTypeOf().toEqualTypeOf();
+    expectTypeOf().toEqualTypeOf();
+    expectTypeOf().toEqualTypeOf();
+  });
+  test("SimplePropertyDef.ExtractNullable", () => {
+    expectTypeOf().toEqualTypeOf();
+    expectTypeOf().toEqualTypeOf();
+    expectTypeOf().toEqualTypeOf();
+    expectTypeOf().toEqualTypeOf();
+  });
+  test("SimplePropertyDef.ExtractWirePropertyType", () => {
+    expectTypeOf().toEqualTypeOf();
+    expectTypeOf().toEqualTypeOf();
+    expectTypeOf().toEqualTypeOf();
+    expectTypeOf().toEqualTypeOf();
+  });
+  it("SimplePropertyDef.FromPropertyMetadata", () => {
+    expectTypeOf().toEqualTypeOf();
+    expectTypeOf().toEqualTypeOf();
+    expectTypeOf().toEqualTypeOf();
+    expectTypeOf().toEqualTypeOf();
+  });
+  test(".ToRuntimeProperty", () => {
+    expectTypeOf().toEqualTypeOf();
+    expectTypeOf().toEqualTypeOf();
+  });
+});
+//# sourceMappingURL=SimplePropertyDef.test.js.map

package/build/esm/ontology/SimplePropertyDef.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SimplePropertyDef.test.js","names":["describe","expectTypeOf","it","test","toEqualTypeOf"],"sources":["SimplePropertyDef.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 { describe, expectTypeOf, it, test } from \"vitest\";\nimport type { PropertyDef } from \"./ObjectTypeDefinition.js\";\nimport type { SimplePropertyDef } from \"./SimplePropertyDef.js\";\n\ndescribe(\"Type conversion\", () => {\n  test(\"SimplePropertyDef.ExtractMultiplicity\", () => {\n    expectTypeOf<SimplePropertyDef.ExtractMultiplicity<\"string\"[]>>()\n      .toEqualTypeOf<\"array\">();\n    expectTypeOf<\n      SimplePropertyDef.ExtractMultiplicity<\"string\"[] | undefined>\n    >()\n      .toEqualTypeOf<\"array\">();\n\n    expectTypeOf<SimplePropertyDef.ExtractMultiplicity<\"string\">>()\n      .toEqualTypeOf<\"single\">();\n    expectTypeOf<SimplePropertyDef.ExtractMultiplicity<\"string\" | undefined>>()\n      .toEqualTypeOf<\"single\">();\n  });\n\n  test(\"SimplePropertyDef.ExtractNullable\", () => {\n    expectTypeOf<SimplePropertyDef.ExtractNullable<\"string\"[]>>()\n      .toEqualTypeOf<\"non-nullable\">();\n    expectTypeOf<SimplePropertyDef.ExtractNullable<\"string\"[] | undefined>>()\n      .toEqualTypeOf<\"nullable\">();\n    expectTypeOf<SimplePropertyDef.ExtractNullable<\"string\">>()\n      .toEqualTypeOf<\"non-nullable\">();\n    expectTypeOf<SimplePropertyDef.ExtractNullable<\"string\" | undefined>>()\n      .toEqualTypeOf<\"nullable\">();\n  });\n\n  test(\"SimplePropertyDef.ExtractWirePropertyType\", () => {\n    expectTypeOf<SimplePropertyDef.ExtractWirePropertyType<\"string\"[]>>()\n      .toEqualTypeOf<\"string\">();\n    expectTypeOf<\n      SimplePropertyDef.ExtractWirePropertyType<\"string\"[] | undefined>\n    >()\n      .toEqualTypeOf<\"string\">();\n    expectTypeOf<SimplePropertyDef.ExtractWirePropertyType<\"string\">>()\n      .toEqualTypeOf<\"string\">();\n    expectTypeOf<\n      SimplePropertyDef.ExtractWirePropertyType<\"string\" | undefined>\n    >()\n      .toEqualTypeOf<\"string\">();\n  });\n\n  it(\"SimplePropertyDef.FromPropertyMetadata\", () => {\n    expectTypeOf<\n      SimplePropertyDef.FromPropertyMetadata<\n        PropertyDef<\"string\", \"nullable\", \"array\">\n      >\n    >()\n      .toEqualTypeOf<\"string\"[] | undefined>();\n\n    expectTypeOf<\n      SimplePropertyDef.FromPropertyMetadata<\n        PropertyDef<\"string\", \"non-nullable\", \"array\">\n      >\n    >()\n      .toEqualTypeOf<\"string\"[]>();\n\n    expectTypeOf<\n      SimplePropertyDef.FromPropertyMetadata<\n        PropertyDef<\"string\", \"non-nullable\", \"single\">\n      >\n    >()\n      .toEqualTypeOf<\"string\">();\n\n    expectTypeOf<\n      SimplePropertyDef.FromPropertyMetadata<\n        PropertyDef<\"string\", \"nullable\", \"single\">\n      >\n    >()\n      .toEqualTypeOf<\"string\" | undefined>();\n  });\n\n  test(\".ToRuntimeProperty\", () => {\n    expectTypeOf<SimplePropertyDef.ToRuntimeProperty<\"string\">>()\n      .toEqualTypeOf<string>();\n\n    expectTypeOf<SimplePropertyDef.ToRuntimeProperty<\"string\" | undefined>>()\n      .toEqualTypeOf<string | undefined>();\n  });\n});\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAASA,QAAQ,EAAEC,YAAY,EAAEC,EAAE,EAAEC,IAAI,QAAQ,QAAQ;AAIzDH,QAAQ,CAAC,iBAAiB,EAAE,MAAM;EAChCG,IAAI,CAAC,uCAAuC,EAAE,MAAM;IAClDF,YAAY,CAAoD,CAAC,CAC9DG,aAAa,CAAU,CAAC;IAC3BH,YAAY,CAEV,CAAC,CACAG,aAAa,CAAU,CAAC;IAE3BH,YAAY,CAAkD,CAAC,CAC5DG,aAAa,CAAW,CAAC;IAC5BH,YAAY,CAA8D,CAAC,CACxEG,aAAa,CAAW,CAAC;EAC9B,CAAC,CAAC;EAEFD,IAAI,CAAC,mCAAmC,EAAE,MAAM;IAC9CF,YAAY,CAAgD,CAAC,CAC1DG,aAAa,CAAiB,CAAC;IAClCH,YAAY,CAA4D,CAAC,CACtEG,aAAa,CAAa,CAAC;IAC9BH,YAAY,CAA8C,CAAC,CACxDG,aAAa,CAAiB,CAAC;IAClCH,YAAY,CAA0D,CAAC,CACpEG,aAAa,CAAa,CAAC;EAChC,CAAC,CAAC;EAEFD,IAAI,CAAC,2CAA2C,EAAE,MAAM;IACtDF,YAAY,CAAwD,CAAC,CAClEG,aAAa,CAAW,CAAC;IAC5BH,YAAY,CAEV,CAAC,CACAG,aAAa,CAAW,CAAC;IAC5BH,YAAY,CAAsD,CAAC,CAChEG,aAAa,CAAW,CAAC;IAC5BH,YAAY,CAEV,CAAC,CACAG,aAAa,CAAW,CAAC;EAC9B,CAAC,CAAC;EAEFF,EAAE,CAAC,wCAAwC,EAAE,MAAM;IACjDD,YAAY,CAIV,CAAC,CACAG,aAAa,CAAyB,CAAC;IAE1CH,YAAY,CAIV,CAAC,CACAG,aAAa,CAAa,CAAC;IAE9BH,YAAY,CAIV,CAAC,CACAG,aAAa,CAAW,CAAC;IAE5BH,YAAY,CAIV,CAAC,CACAG,aAAa,CAAuB,CAAC;EAC1C,CAAC,CAAC;EAEFD,IAAI,CAAC,oBAAoB,EAAE,MAAM;IAC/BF,YAAY,CAAgD,CAAC,CAC1DG,aAAa,CAAS,CAAC;IAE1BH,YAAY,CAA4D,CAAC,CACtEG,aAAa,CAAqB,CAAC;EACxC,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}

package/build/types/OsdkObjectFrom.d.ts

@@ -4,6 +4,7 @@ import type { UnionIfTrue } from "./object/FetchPageResult.js";
 import type { InterfaceDefinition } from "./ontology/InterfaceDefinition.js";
 import type { ObjectOrInterfaceDefinition, PropertyKeys } from "./ontology/ObjectOrInterface.js";
 import type { CompileTimeMetadata, ObjectTypeDefinition } from "./ontology/ObjectTypeDefinition.js";
+import type { SimplePropertyDef } from "./ontology/SimplePropertyDef.js";
 import type { OsdkBase } from "./OsdkBase.js";
 type SpecialOsdkPropParams = "$all" | "$rid" | "$strict" | "$notStrict";
 type ValidOsdkPropParams<Q extends ObjectOrInterfaceDefinition> = SpecialOsdkPropParams | PropertyKeys<Q>;
@@ -50,8 +51,9 @@ type ExtractPropsKeysFromOldPropsStyle<
 export type IsAny<T> = unknown extends T ? [keyof T] extends [never] ? false : true : false;
 export type GetPropsKeys<
 	Q extends ObjectOrInterfaceDefinition,
-	P extends PropertyKeys<Q>
-> = IsNever<P> extends true ? PropertyKeys<Q> : IsAny<P> extends true ? PropertyKeys<Q> : P;
+	P extends PropertyKeys<Q>,
+	N extends boolean = false
+> = IsNever<P> extends true ? N extends true ? never : PropertyKeys<Q> : IsAny<P> extends true ? PropertyKeys<Q> : P;
 /**
 * Use `Osdk.Instance` or `YourType.OsdkInstance`
 */
@@ -64,8 +66,9 @@ export declare namespace Osdk {
 	type Instance<
 		Q extends ObjectOrInterfaceDefinition,
 		OPTIONS extends never | "$rid" = never,
-		P extends PropertyKeys<Q> = PropertyKeys<Q>
-	> = OsdkBase<Q> & Pick<CompileTimeMetadata<Q>["props"], GetPropsKeys<Q, P>> & {
+		P extends PropertyKeys<Q> = PropertyKeys<Q>,
+		R extends Record<string, SimplePropertyDef> = {}
+	> = OsdkBase<Q> & Pick<CompileTimeMetadata<Q>["props"], GetPropsKeys<Q, P, [R] extends [{}] ? false : true>> & ([R] extends [never] ? {} : { [A in keyof R] : SimplePropertyDef.ToRuntimeProperty<R[A]> }) & {
 		readonly $link: Q extends { linksType?: any } ? Q["linksType"] : Q extends ObjectTypeDefinition ? OsdkObjectLinksObject<Q> : never;
 		readonly $as: <NEW_Q extends ValidToFrom<Q>>(type: NEW_Q | string) => Osdk.Instance<NEW_Q, OPTIONS, ConvertProps<Q, NEW_Q, P>>;
 		readonly $clone: <NEW_PROPS extends PropertyKeys<Q>>(updatedObject?: Osdk.Instance<Q, any, NEW_PROPS> | { [K in NEW_PROPS]? : CompileTimeMetadata<Q>["props"][K] }) => Osdk.Instance<Q, OPTIONS, P | NEW_PROPS>;

package/build/types/aggregate/AggregatableKeys.d.ts

@@ -1,9 +1,16 @@
+import type { NumericWithPropAggregateOption, StringWithPropAggregateOption } from "../derivedProperties/WithPropertiesAggregationOptions.js";
 import type { GetWirePropertyValueFromClient } from "../mapping/PropertyValueMapping.js";
 import type { ObjectOrInterfaceDefinition, PropertyKeys } from "../ontology/ObjectOrInterface.js";
 import type { CompileTimeMetadata } from "../ontology/ObjectTypeDefinition.js";
 export type StringAggregateOption = "approximateDistinct" | "exactDistinct";
 export type NumericAggregateOption = "min" | "max" | "sum" | "avg" | "approximateDistinct" | "exactDistinct";
-type AGG_FOR_TYPE<T> = number extends T ? NumericAggregateOption : string extends T ? StringAggregateOption : never;
-export type ValidAggregationKeys<Q extends ObjectOrInterfaceDefinition> = keyof ({ [KK in AggregatableKeys<Q> as `${KK & string}:${AGG_FOR_TYPE<GetWirePropertyValueFromClient<CompileTimeMetadata<Q>["properties"][KK]["type"]>>}`]? : any } & { $count?: any });
+type AGG_FOR_TYPE<
+	T,
+	U extends boolean
+> = number extends T ? U extends true ? NumericAggregateOption : NumericWithPropAggregateOption : string extends T ? U extends true ? StringAggregateOption : StringWithPropAggregateOption : never;
+export type ValidAggregationKeys<
+	Q extends ObjectOrInterfaceDefinition,
+	R extends "aggregate" | "withPropertiesAggregate" = "aggregate"
+> = keyof ({ [KK in AggregatableKeys<Q> as `${KK & string}:${AGG_FOR_TYPE<GetWirePropertyValueFromClient<CompileTimeMetadata<Q>["properties"][KK]["type"]>, R extends "aggregate" ? true : false>}`]? : any } & { $count?: any });
 export type AggregatableKeys<Q extends ObjectOrInterfaceDefinition> = keyof { [P in PropertyKeys<Q>] : any };
 export {};

package/build/types/derivedProperties/DerivedProperty.d.ts

@@ -0,0 +1,42 @@
+import type { ValidAggregationKeys } from "../aggregate/AggregatableKeys.js";
+import type { WhereClause } from "../aggregate/WhereClause.js";
+import type { ObjectOrInterfaceDefinition, PropertyKeys } from "../ontology/ObjectOrInterface.js";
+import type { CompileTimeMetadata } from "../ontology/ObjectTypeDefinition.js";
+import type { SimplePropertyDef } from "../ontology/SimplePropertyDef.js";
+import type { LinkedType, LinkNames } from "../util/LinkUtils.js";
+import type { CollectWithPropAggregations } from "./WithPropertiesAggregationOptions.js";
+export declare namespace DerivedProperty {
+	type SelectorResult<T extends SimplePropertyDef> = { type: T };
+	type Clause<Q extends ObjectOrInterfaceDefinition> = { [key: string]: Selector<Q, SimplePropertyDef> };
+	type Selector<
+		Q extends ObjectOrInterfaceDefinition,
+		T extends SimplePropertyDef
+	> = (baseObjectSet: DerivedProperty.Builder<Q, false>) => SelectorResult<T>;
+	interface Builder<
+		Q extends ObjectOrInterfaceDefinition,
+		CONSTRAINED extends boolean
+	> extends Filterable<Q, CONSTRAINED>, Pivotable<Q, CONSTRAINED> {}
+	interface AggregateBuilder<
+		Q extends ObjectOrInterfaceDefinition,
+		CONSTRAINED extends boolean
+	> extends Builder<Q, CONSTRAINED>, Aggregatable<Q> {}
+	interface SelectPropertyBuilder<
+		Q extends ObjectOrInterfaceDefinition,
+		CONSTRAINED extends boolean
+	> extends AggregateBuilder<Q, CONSTRAINED>, Selectable<Q> {}
+}
+type BuilderTypeFromConstraint<
+	Q extends ObjectOrInterfaceDefinition,
+	CONSTRAINED extends boolean
+> = CONSTRAINED extends true ? DerivedProperty.AggregateBuilder<Q, true> : DerivedProperty.SelectPropertyBuilder<Q, false>;
+type Filterable<
+	Q extends ObjectOrInterfaceDefinition,
+	CONSTRAINED extends boolean
+> = { readonly where: (clause: WhereClause<Q>) => BuilderTypeFromConstraint<Q, CONSTRAINED> };
+type Pivotable<
+	Q extends ObjectOrInterfaceDefinition,
+	CONSTRAINED extends boolean
+> = { readonly pivotTo: <L extends LinkNames<Q>>(type: L) => CONSTRAINED extends true ? DerivedProperty.AggregateBuilder<LinkedType<Q, L>, true> : NonNullable<CompileTimeMetadata<Q>["links"][L]["multiplicity"]> extends true ? DerivedProperty.AggregateBuilder<LinkedType<Q, L>, true> : DerivedProperty.SelectPropertyBuilder<LinkedType<Q, L>, false> };
+type Aggregatable<Q extends ObjectOrInterfaceDefinition> = { readonly aggregate: <V extends ValidAggregationKeys<Q, "withPropertiesAggregate">>(aggregationSpecifier: V, opts?: V extends `${any}:${infer P}` ? P extends CollectWithPropAggregations ? { limit: number } : P extends "approximatePercentile" ? { percentile: number } : never : never) => DerivedProperty.SelectorResult<V extends `${infer N}:${infer P}` ? P extends CollectWithPropAggregations ? Array<CompileTimeMetadata<Q>["properties"][N]["type"]> | undefined : P extends "approximateDistinct" | "exactDistinct" | "$count" ? "integer" | undefined : "double" | undefined : V extends "$count" ? "integer" | undefined : never> };
+type Selectable<Q extends ObjectOrInterfaceDefinition> = { readonly selectProperty: <R extends PropertyKeys<Q>>(propertyName: R) => DerivedProperty.SelectorResult<SimplePropertyDef.Make<CompileTimeMetadata<Q>["properties"][R]["type"], CompileTimeMetadata<Q>["properties"][R]["nullable"], CompileTimeMetadata<Q>["properties"][R]["multiplicity"]>> };
+export {};

package/build/types/derivedProperties/WithPropertiesAggregationOptions.d.ts

@@ -0,0 +1,4 @@
+export type CollectWithPropAggregations = "collectSet" | "collectList";
+export type BaseWithPropAggregations = "approximateDistinct" | "exactDistinct" | "approximatePercentile";
+export type StringWithPropAggregateOption = BaseWithPropAggregations | CollectWithPropAggregations;
+export type NumericWithPropAggregateOption = "min" | "max" | "sum" | "avg" | BaseWithPropAggregations | CollectWithPropAggregations;

package/build/types/index.d.ts

@@ -12,6 +12,7 @@ export { DistanceUnitMapping } from "./aggregate/WhereClause.js";
 export type  { GeoFilter_Intersects, GeoFilter_Within, PossibleWhereClauseFilters, WhereClause } from "./aggregate/WhereClause.js";
 export type  { OsdkObjectPropertyType } from "./Definitions.js";
 export type  { OsdkObjectLinksObject, SingleLinkAccessor } from "./definitions/LinkDefinitions.js";
+export type  { DerivedProperty } from "./derivedProperties/DerivedProperty.js";
 export { DurationMapping } from "./groupby/GroupByClause.js";
 export type  { AllGroupByValues, GroupByClause, GroupByRange } from "./groupby/GroupByClause.js";
 export type  { AllowedBucketKeyTypes, AllowedBucketTypes, DataValueClientToWire, DataValueWireToClient } from "./mapping/DataValueMapping.js";

package/build/types/object/FetchPageResult.d.ts

@@ -1,4 +1,5 @@
 import type { ObjectOrInterfaceDefinition, PropertyKeys } from "../ontology/ObjectOrInterface.js";
+import type { SimplePropertyDef } from "../ontology/SimplePropertyDef.js";
 import type { ExtractOptions, IsNever, Osdk } from "../OsdkObjectFrom.js";
 import type { PageResult } from "../PageResult.js";
 import type { NullabilityAdherence } from "./FetchPageArgs.js";
@@ -30,8 +31,9 @@ export type FetchPageResult<
 */
 export type SingleOsdkResult<
 	Q extends ObjectOrInterfaceDefinition,
-	L extends PropertyKeys<Q>,
+	L extends PropertyKeys<Q> | (keyof RDPs & string),
 	R extends boolean,
-	S extends NullabilityAdherence
-> = Osdk.Instance<Q, ExtractOptions<R, S>, L>;
+	S extends NullabilityAdherence,
+	RDPs extends Record<string, SimplePropertyDef> = {}
+> = Osdk.Instance<Q, ExtractOptions<R, S>, PropertyKeys<Q> extends L ? PropertyKeys<Q> : PropertyKeys<Q> & L, { [K in Extract<keyof RDPs, L>] : RDPs[K] }>;
 export type IsAny<T> = unknown extends T ? [keyof T] extends [never] ? false : true : false;

package/build/types/objectSet/ObjectSet.d.ts

@@ -2,19 +2,31 @@ import type { AggregateOpts } from "../aggregate/AggregateOpts.js";
 import type { AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy } from "../aggregate/AggregateOptsThatErrors.js";
 import type { AggregationsResults } from "../aggregate/AggregationsResults.js";
 import type { WhereClause } from "../aggregate/WhereClause.js";
+import type { DerivedProperty } from "../derivedProperties/DerivedProperty.js";
 import type { AsyncIterArgs, Augments, FetchPageArgs, NullabilityAdherence, SelectArg } from "../object/FetchPageArgs.js";
-import type { SingleOsdkResult } from "../object/FetchPageResult.js";
 import type { Result } from "../object/Result.js";
-import type { InterfaceDefinition } from "../ontology/InterfaceDefinition.js";
 import type { ObjectOrInterfaceDefinition, PropertyKeys } from "../ontology/ObjectOrInterface.js";
 import type { CompileTimeMetadata, ObjectTypeDefinition } from "../ontology/ObjectTypeDefinition.js";
+import type { SimplePropertyDef } from "../ontology/SimplePropertyDef.js";
 import type { PrimaryKeyType } from "../OsdkBase.js";
 import type { ExtractOptions, Osdk } from "../OsdkObjectFrom.js";
 import type { PageResult } from "../PageResult.js";
 import type { LinkedType, LinkNames } from "../util/LinkUtils.js";
 import type { BaseObjectSet } from "./BaseObjectSet.js";
 import type { ObjectSetListener, ObjectSetListenerOptions } from "./ObjectSetListener.js";
-export interface MinimalObjectSet<Q extends ObjectOrInterfaceDefinition> extends BaseObjectSet<Q> {
+type MergeObjectSet<
+	Q extends ObjectOrInterfaceDefinition,
+	D extends ObjectSet<Q> | Record<string, SimplePropertyDef> = {}
+> = D extends Record<string, SimplePropertyDef> ? ObjectOrInterfaceDefinition.WithDerivedProperties<Q, D> : Q;
+type ExtractRdp<D extends ObjectSet<any, any> | Record<string, SimplePropertyDef>> = D extends Record<string, SimplePropertyDef> ? D : {};
+export interface MinimalObjectSet<
+	Q extends ObjectOrInterfaceDefinition,
+	RDPs extends Record<string, SimplePropertyDef> = {}
+> extends BaseObjectSet<Q>, FetchPage<Q, RDPs>, AsyncIter<Q, RDPs>, Where<Q, RDPs> {}
+interface FetchPage<
+	Q extends ObjectOrInterfaceDefinition,
+	RDPs extends Record<string, SimplePropertyDef> = {}
+> {
 	/**
 	* Gets a page of objects of this type, with a result wrapper
 	* @param args - Args to specify next page token and page size, if applicable
@@ -28,11 +40,11 @@ export interface MinimalObjectSet<Q extends ObjectOrInterfaceDefinition> extends
 	* @returns a page of objects
 	*/
 	readonly fetchPage: <
-		L extends PropertyKeys<Q>,
+		L extends PropertyKeys<Q, RDPs>,
 		R extends boolean,
 		const A extends Augments,
 		S extends NullabilityAdherence = NullabilityAdherence.Default
-	>(args?: FetchPageArgs<Q, L, R, A, S>) => Promise<PageResult<PropertyKeys<Q> extends L ? Osdk.Instance<Q, ExtractOptions<R, S>> : Osdk.Instance<Q, ExtractOptions<R, S>, L>>>;
+	>(args?: FetchPageArgs<Q, L, R, A, S>) => Promise<PageResult<Osdk.Instance<Q, ExtractOptions<R, S>, PropertyKeys<Q> extends L ? PropertyKeys<Q> : PropertyKeys<Q> & L, { [K in Extract<keyof RDPs, L>] : RDPs[K] }>>>;
 	/**
 	* Gets a page of objects of this type, with a result wrapper
 	* @param args - Args to specify next page token and page size, if applicable
@@ -48,11 +60,16 @@ export interface MinimalObjectSet<Q extends ObjectOrInterfaceDefinition> extends
 	* @returns a page of objects, wrapped in a result wrapper
 	*/
 	readonly fetchPageWithErrors: <
-		L extends PropertyKeys<Q>,
+		L extends PropertyKeys<Q, RDPs>,
 		R extends boolean,
 		const A extends Augments,
 		S extends NullabilityAdherence = NullabilityAdherence.Default
-	>(args?: FetchPageArgs<Q, L, R, A, S>) => Promise<Result<PageResult<Osdk.Instance<Q, ExtractOptions<R, S>, L>>>>;
+	>(args?: FetchPageArgs<Q, L, R, A, S>) => Promise<Result<PageResult<Osdk.Instance<Q, ExtractOptions<R, S>, PropertyKeys<Q> extends L ? PropertyKeys<Q> : PropertyKeys<Q> & L, { [K in Extract<keyof RDPs, L>] : RDPs[K] }>>>>;
+}
+interface Where<
+	Q extends ObjectOrInterfaceDefinition,
+	RDPs extends Record<string, SimplePropertyDef> = {}
+> {
 	/**
 	* Allows you to filter an object set with a given clause
 	* @param clause - Takes a filter clause
@@ -63,7 +80,12 @@ export interface MinimalObjectSet<Q extends ObjectOrInterfaceDefinition> extends
 	});
 	* @returns an objectSet
 	*/
-	readonly where: (clause: WhereClause<Q>) => this;
+	readonly where: (clause: WhereClause<MergeObjectSet<Q, RDPs>>) => this;
+}
+interface AsyncIter<
+	Q extends ObjectOrInterfaceDefinition,
+	RDPs extends Record<string, SimplePropertyDef> = {}
+> {
 	/**
 	* Returns an async iterator to load all objects of this type
 	* @example
@@ -73,17 +95,23 @@ export interface MinimalObjectSet<Q extends ObjectOrInterfaceDefinition> extends
 	* @returns an async iterator to load all objects
 	*/
 	readonly asyncIter: <
-		L extends PropertyKeys<Q>,
+		L extends PropertyKeys<Q, RDPs>,
 		R extends boolean,
 		const A extends Augments,
 		S extends NullabilityAdherence = NullabilityAdherence.Default
-	>(args?: AsyncIterArgs<Q, L, R, A, S>) => AsyncIterableIterator<SingleOsdkResult<Q, L, R, S>>;
+	>(args?: AsyncIterArgs<Q, L, R, A, S>) => AsyncIterableIterator<Osdk.Instance<Q, ExtractOptions<R, S>, PropertyKeys<Q> extends L ? PropertyKeys<Q> : PropertyKeys<Q> & L, { [K in Extract<keyof RDPs, L>] : RDPs[K] }>>;
+}
+interface WithProperties<
+	Q extends ObjectOrInterfaceDefinition = any,
+	RDPs extends Record<string, SimplePropertyDef> = {}
+> {
+	readonly withProperties: <NEW extends Record<string, SimplePropertyDef>>(clause: { [K in keyof NEW] : DerivedProperty.Selector<Q, NEW[K]> }) => ObjectSet<Q, { [NN in keyof NEW | keyof RDPs] : NN extends keyof NEW ? NEW[NN] : NN extends keyof RDPs ? RDPs[NN] : never }>;
 }
-export interface InterfaceObjectSet<Q extends InterfaceDefinition> extends MinimalObjectSet<Q> {}
 export interface ObjectSet<
 	Q extends ObjectOrInterfaceDefinition = any,
-	_UNUSED = any
-> extends MinimalObjectSet<Q> {
+	UNUSED_OR_RDP extends ObjectSet<Q, any> | Record<string, SimplePropertyDef> = ObjectSet<Q, any>
+> extends ObjectSetCleanedTypes<Q, ExtractRdp<UNUSED_OR_RDP>, MergeObjectSet<Q, UNUSED_OR_RDP>> {}
+interface Aggregate<Q extends ObjectOrInterfaceDefinition> {
 	/**
 	* Aggregate on a field in an object type
 	* @param req - an aggregation request where you can select fields and choose how to aggregate, e.g., max, min, avg, and also choose
@@ -108,6 +136,8 @@ export interface ObjectSet<
 	* @returns aggregation results, sorted in the groups based on the groupBy clause (if applicable)
 	*/
 	readonly aggregate: <AO extends AggregateOpts<Q>>(req: AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy<Q, AO>) => Promise<AggregationsResults<Q, AO>>;
+}
+interface SetArithmetic<Q extends ObjectOrInterfaceDefinition> {
 	/**
 	* Unions object sets together
 	* @param objectSets - objectSets you want to union with
@@ -138,28 +168,37 @@ export interface ObjectSet<
 	* @returns the subtract object set
 	*/
 	readonly subtract: (...objectSets: ReadonlyArray<CompileTimeMetadata<Q>["objectSet"]>) => this;
+}
+interface PivotTo<Q extends ObjectOrInterfaceDefinition> {
 	/**
 	* Pivots the object set over to all its linked objects of the specified type
 	* @param type - The linked object type you want to pivot to
 	* @returns an object set of the specified linked type
 	*/
 	readonly pivotTo: <L extends LinkNames<Q>>(type: L) => CompileTimeMetadata<LinkedType<Q, L>>["objectSet"];
+}
+interface FetchOne<
+	Q extends ObjectOrInterfaceDefinition,
+	RDPs extends Record<string, SimplePropertyDef>
+> {
 	/**
 	* Fetches one object with the specified primary key, without a result wrapper
 	*/
 	readonly fetchOne: Q extends ObjectTypeDefinition ? <
-		const L extends PropertyKeys<Q>,
+		const L extends PropertyKeys<Q, RDPs>,
 		const R extends boolean,
 		const S extends false | "throw" = NullabilityAdherence.Default
-	>(primaryKey: PrimaryKeyType<Q>, options?: SelectArg<Q, L, R, S>) => Promise<Osdk.Instance<Q, ExtractOptions<R, S>, L>> : never;
+	>(primaryKey: PrimaryKeyType<Q>, options?: SelectArg<Q, L, R, S>) => Promise<Osdk.Instance<Q, ExtractOptions<R, S>, PropertyKeys<Q> extends L ? PropertyKeys<Q> : PropertyKeys<Q> & L, { [K in Extract<keyof RDPs, L>] : RDPs[K] }>> : never;
 	/**
 	* Fetches one object with the specified primary key, with a result wrapper
 	*/
 	readonly fetchOneWithErrors: Q extends ObjectTypeDefinition ? <
-		L extends PropertyKeys<Q>,
+		L extends PropertyKeys<Q, RDPs>,
 		R extends boolean,
 		S extends false | "throw" = NullabilityAdherence.Default
-	>(primaryKey: PrimaryKeyType<Q>, options?: SelectArg<Q, L, R, S>) => Promise<Result<Osdk.Instance<Q, ExtractOptions<R, S>, L>>> : never;
+	>(primaryKey: PrimaryKeyType<Q>, options?: SelectArg<Q, L, R, S>) => Promise<Result<Osdk.Instance<Q, ExtractOptions<R, S>, PropertyKeys<Q> extends L ? PropertyKeys<Q> : PropertyKeys<Q> & L, { [K in Extract<keyof RDPs, L>] : RDPs[K] }>>> : never;
+}
+interface Subscribe<Q extends ObjectOrInterfaceDefinition> {
 	/**
 	* Request updates when the objects in an object set are added, updated, or removed.
 	* @param listener - The handlers to be executed during the lifecycle of the subscription.
@@ -168,3 +207,9 @@ export interface ObjectSet<
 	*/
 	readonly subscribe: <const P extends PropertyKeys<Q>>(listener: ObjectSetListener<Q, P>, opts?: ObjectSetListenerOptions<Q, P>) => { unsubscribe: () => void };
 }
+interface ObjectSetCleanedTypes<
+	Q extends ObjectOrInterfaceDefinition,
+	D extends Record<string, SimplePropertyDef>,
+	MERGED extends ObjectOrInterfaceDefinition
+> extends MinimalObjectSet<Q, D>, WithProperties<Q, D>, Aggregate<MERGED>, SetArithmetic<MERGED>, PivotTo<MERGED>, FetchOne<Q, D>, Subscribe<MERGED> {}
+export {};

package/build/types/objectSet/ObjectSet.test.d.ts

@@ -0,0 +1 @@
+export {};