@osdk/client 2.4.0-beta.9 → 2.4.0

package/build/esm/util/extractObjectOrInterfaceType.js

@@ -0,0 +1,96 @@
+/*
+ * 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
+* Returns the resultant interface or object type of the object set
+*/
+export async function extractObjectOrInterfaceType(clientCtx, objectSet) {
+  switch (objectSet.type) {
+    case "searchAround":
+      {
+        const def = await extractObjectOrInterfaceType(clientCtx, objectSet.objectSet);
+        if (def === undefined) {
+          return undefined;
+        }
+        const objOrInterfaceDef = def.type === "object" ? await clientCtx.ontologyProvider.getObjectDefinition(def.apiName) : await clientCtx.ontologyProvider.getInterfaceDefinition(def.apiName);
+        const linkDef = objOrInterfaceDef.links[objectSet.link];
+        !linkDef ? process.env.NODE_ENV !== "production" ? invariant(false, `Missing link definition for '${objectSet.link}'`) : invariant(false) : void 0;
+        return objOrInterfaceDef.type === "object" ? {
+          apiName: objOrInterfaceDef.links[objectSet.link].targetType,
+          type: "object"
+        } : {
+          apiName: objOrInterfaceDef.links[objectSet.link].targetTypeApiName,
+          type: objOrInterfaceDef.links[objectSet.link].targetType
+        };
+      }
+    case "withProperties":
+      {
+        return extractObjectOrInterfaceType(clientCtx, objectSet.objectSet);
+      }
+    case "methodInput":
+      return undefined;
+    case "base":
+      return {
+        type: "object",
+        apiName: objectSet.objectType
+      };
+    case "interfaceBase":
+      return {
+        type: "interface",
+        apiName: objectSet.interfaceType
+      };
+    case "filter":
+    case "asBaseObjectTypes":
+    case "asType":
+    case "nearestNeighbors":
+      return extractObjectOrInterfaceType(clientCtx, objectSet.objectSet);
+    case "intersect":
+    case "subtract":
+    case "union":
+      const objectSets = objectSet.objectSets;
+      const objectSetTypes = await Promise.all(objectSets.map(os => extractObjectOrInterfaceType(clientCtx, os)));
+      const filteredObjectTypes = objectSetTypes.filter(Boolean);
+      const firstObjectType = filteredObjectTypes[0];
+      !filteredObjectTypes.every(val => {
+        return val?.apiName === firstObjectType?.apiName && val?.type === firstObjectType?.type;
+      }) ? process.env.NODE_ENV !== "production" ? invariant(false, "Can only have one object type when doing intersects, subtract, union") : invariant(false) : void 0;
+      return filteredObjectTypes[0];
+    case "static":
+    case "reference":
+      // Static and reference object sets are always intersected with a base object set, so we can just return undefined.
+      return undefined;
+    case "interfaceLinkSearchAround":
+      const def = await extractObjectOrInterfaceType(clientCtx, objectSet.objectSet);
+      if (def === undefined) {
+        return undefined;
+      }
+      const objOrInterfaceDef = def.type === "object" ? await clientCtx.ontologyProvider.getObjectDefinition(def.apiName) : await clientCtx.ontologyProvider.getInterfaceDefinition(def.apiName);
+      const linkDef = objOrInterfaceDef.links[objectSet.interfaceLink];
+      !linkDef ? process.env.NODE_ENV !== "production" ? invariant(false, `Missing link definition for '${objectSet.interfaceLink}'`) : invariant(false) : void 0;
+      return objOrInterfaceDef.type === "object" ? {
+        apiName: objOrInterfaceDef.links[objectSet.interfaceLink].targetType,
+        type: "object"
+      } : {
+        apiName: objOrInterfaceDef.links[objectSet.interfaceLink].targetTypeApiName,
+        type: objOrInterfaceDef.links[objectSet.interfaceLink].targetType
+      };
+    // We don't have to worry about new object sets being added and doing a runtime break and breaking people since the OSDK is always constructing these.
+    default:
+      process.env.NODE_ENV !== "production" ? invariant(false, `Unsupported object set type for deriving object or interface type,`) : invariant(false);
+  }
+}
+//# sourceMappingURL=extractObjectOrInterfaceType.js.map

package/build/esm/util/extractObjectOrInterfaceType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extractObjectOrInterfaceType.js","names":["invariant","extractObjectOrInterfaceType","clientCtx","objectSet","type","def","undefined","objOrInterfaceDef","ontologyProvider","getObjectDefinition","apiName","getInterfaceDefinition","linkDef","links","link","process","env","NODE_ENV","targetType","targetTypeApiName","objectType","interfaceType","objectSets","objectSetTypes","Promise","all","map","os","filteredObjectTypes","filter","Boolean","firstObjectType","every","val","interfaceLink"],"sources":["extractObjectOrInterfaceType.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 { ObjectOrInterfaceDefinition } from \"@osdk/api\";\nimport type { ObjectSet } from \"@osdk/foundry.ontologies\";\nimport invariant from \"tiny-invariant\";\nimport type { MinimalClient } from \"../MinimalClientContext.js\";\n\n/* @internal\n* Returns the resultant interface or object type of the object set\n*/\nexport async function extractObjectOrInterfaceType(\n  clientCtx: MinimalClient,\n  objectSet: ObjectSet,\n): Promise<\n  ObjectOrInterfaceDefinition | undefined\n> {\n  switch (objectSet.type) {\n    case \"searchAround\": {\n      const def = await extractObjectOrInterfaceType(\n        clientCtx,\n        objectSet.objectSet,\n      );\n      if (def === undefined) {\n        return undefined;\n      }\n      const objOrInterfaceDef = def.type === \"object\"\n        ? await clientCtx.ontologyProvider.getObjectDefinition(\n          def.apiName,\n        )\n        : await clientCtx.ontologyProvider.getInterfaceDefinition(\n          def.apiName,\n        );\n      const linkDef = objOrInterfaceDef.links[objectSet.link];\n      invariant(linkDef, `Missing link definition for '${objectSet.link}'`);\n\n      return objOrInterfaceDef.type === \"object\"\n        ? {\n          apiName: objOrInterfaceDef.links[objectSet.link].targetType,\n          type: \"object\",\n        }\n        : {\n          apiName: objOrInterfaceDef.links[objectSet.link].targetTypeApiName,\n          type: objOrInterfaceDef.links[objectSet.link].targetType,\n        };\n    }\n    case \"withProperties\": {\n      return extractObjectOrInterfaceType(\n        clientCtx,\n        objectSet.objectSet,\n      );\n    }\n    case \"methodInput\":\n      return undefined;\n    case \"base\":\n      return { type: \"object\", apiName: objectSet.objectType };\n    case \"interfaceBase\":\n      return { type: \"interface\", apiName: objectSet.interfaceType };\n    case \"filter\":\n    case \"asBaseObjectTypes\":\n    case \"asType\":\n    case \"nearestNeighbors\":\n      return extractObjectOrInterfaceType(\n        clientCtx,\n        objectSet.objectSet,\n      );\n    case \"intersect\":\n    case \"subtract\":\n    case \"union\":\n      const objectSets = objectSet.objectSets;\n      const objectSetTypes = await Promise.all(\n        objectSets.map((os) =>\n          extractObjectOrInterfaceType(\n            clientCtx,\n            os,\n          )\n        ),\n      );\n\n      const filteredObjectTypes = objectSetTypes.filter(Boolean);\n      const firstObjectType = filteredObjectTypes[0];\n      invariant(\n        filteredObjectTypes.every(val => {\n          return val?.apiName === firstObjectType?.apiName\n            && val?.type === firstObjectType?.type;\n        }),\n        \"Can only have one object type when doing intersects, subtract, union\",\n      );\n\n      return filteredObjectTypes[0];\n    case \"static\":\n    case \"reference\":\n      // Static and reference object sets are always intersected with a base object set, so we can just return undefined.\n      return undefined;\n    case \"interfaceLinkSearchAround\":\n      const def = await extractObjectOrInterfaceType(\n        clientCtx,\n        objectSet.objectSet,\n      );\n      if (def === undefined) {\n        return undefined;\n      }\n      const objOrInterfaceDef = def.type === \"object\"\n        ? await clientCtx.ontologyProvider.getObjectDefinition(\n          def.apiName,\n        )\n        : await clientCtx.ontologyProvider.getInterfaceDefinition(\n          def.apiName,\n        );\n      const linkDef = objOrInterfaceDef.links[objectSet.interfaceLink];\n      invariant(\n        linkDef,\n        `Missing link definition for '${objectSet.interfaceLink}'`,\n      );\n      return objOrInterfaceDef.type === \"object\"\n        ? {\n          apiName: objOrInterfaceDef.links[objectSet.interfaceLink].targetType,\n          type: \"object\",\n        }\n        : {\n          apiName:\n            objOrInterfaceDef.links[objectSet.interfaceLink].targetTypeApiName,\n          type: objOrInterfaceDef.links[objectSet.interfaceLink].targetType,\n        };\n    // We don't have to worry about new object sets being added and doing a runtime break and breaking people since the OSDK is always constructing these.\n    default:\n      const _: never = objectSet;\n      invariant(\n        false,\n        `Unsupported object set type for deriving object or interface type,`,\n      );\n  }\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAIA,OAAOA,SAAS,MAAM,gBAAgB;AAGtC;AACA;AACA;AACA,OAAO,eAAeC,4BAA4BA,CAChDC,SAAwB,EACxBC,SAAoB,EAGpB;EACA,QAAQA,SAAS,CAACC,IAAI;IACpB,KAAK,cAAc;MAAE;QACnB,MAAMC,GAAG,GAAG,MAAMJ,4BAA4B,CAC5CC,SAAS,EACTC,SAAS,CAACA,SACZ,CAAC;QACD,IAAIE,GAAG,KAAKC,SAAS,EAAE;UACrB,OAAOA,SAAS;QAClB;QACA,MAAMC,iBAAiB,GAAGF,GAAG,CAACD,IAAI,KAAK,QAAQ,GAC3C,MAAMF,SAAS,CAACM,gBAAgB,CAACC,mBAAmB,CACpDJ,GAAG,CAACK,OACN,CAAC,GACC,MAAMR,SAAS,CAACM,gBAAgB,CAACG,sBAAsB,CACvDN,GAAG,CAACK,OACN,CAAC;QACH,MAAME,OAAO,GAAGL,iBAAiB,CAACM,KAAK,CAACV,SAAS,CAACW,IAAI,CAAC;QACvD,CAAUF,OAAO,GAAAG,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAAjBjB,SAAS,QAAU,gCAAgCG,SAAS,CAACW,IAAI,GAAG,IAApEd,SAAS;QAET,OAAOO,iBAAiB,CAACH,IAAI,KAAK,QAAQ,GACtC;UACAM,OAAO,EAAEH,iBAAiB,CAACM,KAAK,CAACV,SAAS,CAACW,IAAI,CAAC,CAACI,UAAU;UAC3Dd,IAAI,EAAE;QACR,CAAC,GACC;UACAM,OAAO,EAAEH,iBAAiB,CAACM,KAAK,CAACV,SAAS,CAACW,IAAI,CAAC,CAACK,iBAAiB;UAClEf,IAAI,EAAEG,iBAAiB,CAACM,KAAK,CAACV,SAAS,CAACW,IAAI,CAAC,CAACI;QAChD,CAAC;MACL;IACA,KAAK,gBAAgB;MAAE;QACrB,OAAOjB,4BAA4B,CACjCC,SAAS,EACTC,SAAS,CAACA,SACZ,CAAC;MACH;IACA,KAAK,aAAa;MAChB,OAAOG,SAAS;IAClB,KAAK,MAAM;MACT,OAAO;QAAEF,IAAI,EAAE,QAAQ;QAAEM,OAAO,EAAEP,SAAS,CAACiB;MAAW,CAAC;IAC1D,KAAK,eAAe;MAClB,OAAO;QAAEhB,IAAI,EAAE,WAAW;QAAEM,OAAO,EAAEP,SAAS,CAACkB;MAAc,CAAC;IAChE,KAAK,QAAQ;IACb,KAAK,mBAAmB;IACxB,KAAK,QAAQ;IACb,KAAK,kBAAkB;MACrB,OAAOpB,4BAA4B,CACjCC,SAAS,EACTC,SAAS,CAACA,SACZ,CAAC;IACH,KAAK,WAAW;IAChB,KAAK,UAAU;IACf,KAAK,OAAO;MACV,MAAMmB,UAAU,GAAGnB,SAAS,CAACmB,UAAU;MACvC,MAAMC,cAAc,GAAG,MAAMC,OAAO,CAACC,GAAG,CACtCH,UAAU,CAACI,GAAG,CAAEC,EAAE,IAChB1B,4BAA4B,CAC1BC,SAAS,EACTyB,EACF,CACF,CACF,CAAC;MAED,MAAMC,mBAAmB,GAAGL,cAAc,CAACM,MAAM,CAACC,OAAO,CAAC;MAC1D,MAAMC,eAAe,GAAGH,mBAAmB,CAAC,CAAC,CAAC;MAC9C,CACEA,mBAAmB,CAACI,KAAK,CAACC,GAAG,IAAI;QAC/B,OAAOA,GAAG,EAAEvB,OAAO,KAAKqB,eAAe,EAAErB,OAAO,IAC3CuB,GAAG,EAAE7B,IAAI,KAAK2B,eAAe,EAAE3B,IAAI;MAC1C,CAAC,CAAC,GAAAW,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAJJjB,SAAS,QAKP,sEAAsE,IALxEA,SAAS;MAQT,OAAO4B,mBAAmB,CAAC,CAAC,CAAC;IAC/B,KAAK,QAAQ;IACb,KAAK,WAAW;MACd;MACA,OAAOtB,SAAS;IAClB,KAAK,2BAA2B;MAC9B,MAAMD,GAAG,GAAG,MAAMJ,4BAA4B,CAC5CC,SAAS,EACTC,SAAS,CAACA,SACZ,CAAC;MACD,IAAIE,GAAG,KAAKC,SAAS,EAAE;QACrB,OAAOA,SAAS;MAClB;MACA,MAAMC,iBAAiB,GAAGF,GAAG,CAACD,IAAI,KAAK,QAAQ,GAC3C,MAAMF,SAAS,CAACM,gBAAgB,CAACC,mBAAmB,CACpDJ,GAAG,CAACK,OACN,CAAC,GACC,MAAMR,SAAS,CAACM,gBAAgB,CAACG,sBAAsB,CACvDN,GAAG,CAACK,OACN,CAAC;MACH,MAAME,OAAO,GAAGL,iBAAiB,CAACM,KAAK,CAACV,SAAS,CAAC+B,aAAa,CAAC;MAChE,CACEtB,OAAO,GAAAG,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBADTjB,SAAS,QAEP,gCAAgCG,SAAS,CAAC+B,aAAa,GAAG,IAF5DlC,SAAS;MAIT,OAAOO,iBAAiB,CAACH,IAAI,KAAK,QAAQ,GACtC;QACAM,OAAO,EAAEH,iBAAiB,CAACM,KAAK,CAACV,SAAS,CAAC+B,aAAa,CAAC,CAAChB,UAAU;QACpEd,IAAI,EAAE;MACR,CAAC,GACC;QACAM,OAAO,EACLH,iBAAiB,CAACM,KAAK,CAACV,SAAS,CAAC+B,aAAa,CAAC,CAACf,iBAAiB;QACpEf,IAAI,EAAEG,iBAAiB,CAACM,KAAK,CAACV,SAAS,CAAC+B,aAAa,CAAC,CAAChB;MACzD,CAAC;IACL;IACA;MAEEH,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAAAjB,SAAS,QAEP,oEAAoE,IAFtEA,SAAS;EAIb;AACF","ignoreList":[]}

package/build/esm/util/extractObjectOrInterfaceType.test.js

@@ -0,0 +1,135 @@
+/*
+ * 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, expect, it } from "vitest";
+import { extractObjectOrInterfaceType } from "./extractObjectOrInterfaceType.js";
+describe("extractRdpDefinition", () => {
+  const mockClientCtx = {
+    ontologyProvider: {
+      getObjectDefinition: objectType => {
+        if (objectType === "BaseType") {
+          return {
+            links: {
+              testLink1: {
+                targetType: "SecondType",
+                "multiplicity": "many"
+              }
+            }
+          };
+        } else if (objectType === "SecondType") {
+          return {
+            links: {
+              testLink2: {
+                targetType: "ThirdType",
+                "multiplicity": "many"
+              }
+            }
+          };
+        } else if (objectType === "ThirdType") {
+          return {
+            properties: {
+              testProperty: {
+                type: "attachment"
+              }
+            }
+          };
+        } else {
+          throw new Error(`Missing definition for '${objectType}'`);
+        }
+      },
+      getInterfaceDefinition: interfaceType => {
+        if (interfaceType === "interface1") {
+          return {
+            links: {
+              linkToInterface2: {
+                targetType: "interface",
+                targetTypeApiName: "interface2",
+                multiplicity: false
+              }
+            }
+          };
+        } else if (interfaceType === "interface1") {
+          return {
+            links: {
+              linkToInterface1: {
+                targetType: "interface",
+                targetTypeApiName: "interface1",
+                multiplicity: false
+              }
+            }
+          };
+        } else {
+          throw new Error(`Missing definition for '${interfaceType}'`);
+        }
+      }
+    }
+  };
+  const objectSetInterfaceToInterface = {
+    type: "interfaceLinkSearchAround",
+    objectSet: {
+      type: "interfaceBase",
+      interfaceType: "interface1"
+    },
+    interfaceLink: "linkToInterface2"
+  };
+  it("handles 'withProperties' object set type", async () => {
+    const result = await extractObjectOrInterfaceType(mockClientCtx, objectSetInterfaceToInterface);
+    expect(result).toEqual({
+      apiName: "interface2",
+      type: "interface"
+    });
+  });
+  it("handles `intersection` object set type and nested static and reference object sets", async () => {
+    const result = await extractObjectOrInterfaceType(mockClientCtx, {
+      type: "intersect",
+      objectSets: [{
+        type: "interfaceLinkSearchAround",
+        objectSet: {
+          type: "interfaceBase",
+          interfaceType: "interface1"
+        },
+        interfaceLink: "linkToInterface2"
+      }, {
+        type: "static",
+        "objects": ["object1", "object2"]
+      }, {
+        type: "reference",
+        "reference": "rid.os.1234"
+      }]
+    });
+    expect(result).toEqual({
+      apiName: "interface2",
+      type: "interface"
+    });
+  });
+  it("throes with intersect, subtract, or union having different child object types", async () => {
+    await expect(extractObjectOrInterfaceType(mockClientCtx, {
+      type: "intersect",
+      objectSets: [{
+        type: "interfaceLinkSearchAround",
+        objectSet: {
+          type: "interfaceBase",
+          interfaceType: "interface1"
+        },
+        interfaceLink: "linkToInterface2"
+      }, {
+        type: "interfaceBase",
+        interfaceType: "interface1"
+      }]
+    })).rejects.toThrowErrorMatchingInlineSnapshot(`[Error: Invariant failed: Can only have one object type when doing intersects, subtract, union]`);
+  });
+});
+//# sourceMappingURL=extractObjectOrInterfaceType.test.js.map

package/build/esm/util/extractObjectOrInterfaceType.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extractObjectOrInterfaceType.test.js","names":["describe","expect","it","extractObjectOrInterfaceType","mockClientCtx","ontologyProvider","getObjectDefinition","objectType","links","testLink1","targetType","testLink2","properties","testProperty","type","Error","getInterfaceDefinition","interfaceType","linkToInterface2","targetTypeApiName","multiplicity","linkToInterface1","objectSetInterfaceToInterface","objectSet","interfaceLink","result","toEqual","apiName","objectSets","rejects","toThrowErrorMatchingInlineSnapshot"],"sources":["extractObjectOrInterfaceType.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 { InterfaceMetadata, ObjectMetadata } from \"@osdk/api\";\nimport type { ObjectSet } from \"@osdk/foundry.ontologies\";\nimport { describe, expect, it } from \"vitest\";\nimport type { MinimalClient } from \"../MinimalClientContext.js\";\nimport { extractObjectOrInterfaceType } from \"./extractObjectOrInterfaceType.js\";\n\ndescribe(\"extractRdpDefinition\", () => {\n  const mockClientCtx = {\n    ontologyProvider: {\n      getObjectDefinition: (objectType: string) => {\n        if (objectType === \"BaseType\") {\n          return {\n            links: {\n              testLink1: {\n                targetType: \"SecondType\",\n                \"multiplicity\": \"many\",\n              } satisfies ObjectMetadata.Link<any, any>,\n            },\n          };\n        } else if (objectType === \"SecondType\") {\n          return {\n            links: {\n              testLink2: {\n                targetType: \"ThirdType\",\n                \"multiplicity\": \"many\",\n              } satisfies ObjectMetadata.Link<any, any>,\n            },\n          };\n        } else if (objectType === \"ThirdType\") {\n          return {\n            properties: {\n              testProperty: {\n                type: \"attachment\",\n              } satisfies ObjectMetadata.Property,\n            },\n          };\n        } else {\n          throw new Error(`Missing definition for '${objectType}'`);\n        }\n      },\n      getInterfaceDefinition: (interfaceType: string) => {\n        if (interfaceType === \"interface1\") {\n          return {\n            links: {\n              linkToInterface2: {\n                targetType: \"interface\",\n                targetTypeApiName: \"interface2\",\n                multiplicity: false,\n              } satisfies InterfaceMetadata.Link<any, any>,\n            },\n          };\n        } else if (interfaceType === \"interface1\") {\n          return {\n            links: {\n              linkToInterface1: {\n                targetType: \"interface\",\n                targetTypeApiName: \"interface1\",\n                multiplicity: false,\n              } satisfies InterfaceMetadata.Link<any, any>,\n            },\n          };\n        } else {\n          throw new Error(`Missing definition for '${interfaceType}'`);\n        }\n      },\n    } as any,\n  } as MinimalClient;\n\n  const objectSetInterfaceToInterface: ObjectSet = {\n    type: \"interfaceLinkSearchAround\",\n    objectSet: {\n      type: \"interfaceBase\",\n      interfaceType: \"interface1\",\n    },\n    interfaceLink: \"linkToInterface2\",\n  };\n\n  it(\"handles 'withProperties' object set type\", async () => {\n    const result = await extractObjectOrInterfaceType(\n      mockClientCtx,\n      objectSetInterfaceToInterface,\n    );\n\n    expect(result).toEqual({ apiName: \"interface2\", type: \"interface\" });\n  });\n\n  it(\"handles `intersection` object set type and nested static and reference object sets\", async () => {\n    const intersectionObjectSet: ObjectSet = {\n      type: \"intersect\",\n      objectSets: [\n        {\n          type: \"interfaceLinkSearchAround\",\n          objectSet: {\n            type: \"interfaceBase\",\n            interfaceType: \"interface1\",\n          },\n          interfaceLink: \"linkToInterface2\",\n        },\n        { type: \"static\", \"objects\": [\"object1\", \"object2\"] },\n        { type: \"reference\", \"reference\": \"rid.os.1234\" },\n      ],\n    };\n\n    const result = await extractObjectOrInterfaceType(\n      mockClientCtx,\n      intersectionObjectSet,\n    );\n\n    expect(result).toEqual({ apiName: \"interface2\", type: \"interface\" });\n  });\n\n  it(\"throes with intersect, subtract, or union having different child object types\", async () => {\n    const intersectionObjectSet: ObjectSet = {\n      type: \"intersect\",\n      objectSets: [\n        {\n          type: \"interfaceLinkSearchAround\",\n          objectSet: {\n            type: \"interfaceBase\",\n            interfaceType: \"interface1\",\n          },\n          interfaceLink: \"linkToInterface2\",\n        },\n        { type: \"interfaceBase\", interfaceType: \"interface1\" },\n      ],\n    };\n\n    await expect(\n      extractObjectOrInterfaceType(mockClientCtx, intersectionObjectSet),\n    ).rejects.toThrowErrorMatchingInlineSnapshot(\n      `[Error: Invariant failed: Can only have one object type when doing intersects, subtract, union]`,\n    );\n  });\n});\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAIA,SAASA,QAAQ,EAAEC,MAAM,EAAEC,EAAE,QAAQ,QAAQ;AAE7C,SAASC,4BAA4B,QAAQ,mCAAmC;AAEhFH,QAAQ,CAAC,sBAAsB,EAAE,MAAM;EACrC,MAAMI,aAAa,GAAG;IACpBC,gBAAgB,EAAE;MAChBC,mBAAmB,EAAGC,UAAkB,IAAK;QAC3C,IAAIA,UAAU,KAAK,UAAU,EAAE;UAC7B,OAAO;YACLC,KAAK,EAAE;cACLC,SAAS,EAAE;gBACTC,UAAU,EAAE,YAAY;gBACxB,cAAc,EAAE;cAClB;YACF;UACF,CAAC;QACH,CAAC,MAAM,IAAIH,UAAU,KAAK,YAAY,EAAE;UACtC,OAAO;YACLC,KAAK,EAAE;cACLG,SAAS,EAAE;gBACTD,UAAU,EAAE,WAAW;gBACvB,cAAc,EAAE;cAClB;YACF;UACF,CAAC;QACH,CAAC,MAAM,IAAIH,UAAU,KAAK,WAAW,EAAE;UACrC,OAAO;YACLK,UAAU,EAAE;cACVC,YAAY,EAAE;gBACZC,IAAI,EAAE;cACR;YACF;UACF,CAAC;QACH,CAAC,MAAM;UACL,MAAM,IAAIC,KAAK,CAAC,2BAA2BR,UAAU,GAAG,CAAC;QAC3D;MACF,CAAC;MACDS,sBAAsB,EAAGC,aAAqB,IAAK;QACjD,IAAIA,aAAa,KAAK,YAAY,EAAE;UAClC,OAAO;YACLT,KAAK,EAAE;cACLU,gBAAgB,EAAE;gBAChBR,UAAU,EAAE,WAAW;gBACvBS,iBAAiB,EAAE,YAAY;gBAC/BC,YAAY,EAAE;cAChB;YACF;UACF,CAAC;QACH,CAAC,MAAM,IAAIH,aAAa,KAAK,YAAY,EAAE;UACzC,OAAO;YACLT,KAAK,EAAE;cACLa,gBAAgB,EAAE;gBAChBX,UAAU,EAAE,WAAW;gBACvBS,iBAAiB,EAAE,YAAY;gBAC/BC,YAAY,EAAE;cAChB;YACF;UACF,CAAC;QACH,CAAC,MAAM;UACL,MAAM,IAAIL,KAAK,CAAC,2BAA2BE,aAAa,GAAG,CAAC;QAC9D;MACF;IACF;EACF,CAAkB;EAElB,MAAMK,6BAAwC,GAAG;IAC/CR,IAAI,EAAE,2BAA2B;IACjCS,SAAS,EAAE;MACTT,IAAI,EAAE,eAAe;MACrBG,aAAa,EAAE;IACjB,CAAC;IACDO,aAAa,EAAE;EACjB,CAAC;EAEDtB,EAAE,CAAC,0CAA0C,EAAE,YAAY;IACzD,MAAMuB,MAAM,GAAG,MAAMtB,4BAA4B,CAC/CC,aAAa,EACbkB,6BACF,CAAC;IAEDrB,MAAM,CAACwB,MAAM,CAAC,CAACC,OAAO,CAAC;MAAEC,OAAO,EAAE,YAAY;MAAEb,IAAI,EAAE;IAAY,CAAC,CAAC;EACtE,CAAC,CAAC;EAEFZ,EAAE,CAAC,oFAAoF,EAAE,YAAY;IAiBnG,MAAMuB,MAAM,GAAG,MAAMtB,4BAA4B,CAC/CC,aAAa,EAjB0B;MACvCU,IAAI,EAAE,WAAW;MACjBc,UAAU,EAAE,CACV;QACEd,IAAI,EAAE,2BAA2B;QACjCS,SAAS,EAAE;UACTT,IAAI,EAAE,eAAe;UACrBG,aAAa,EAAE;QACjB,CAAC;QACDO,aAAa,EAAE;MACjB,CAAC,EACD;QAAEV,IAAI,EAAE,QAAQ;QAAE,SAAS,EAAE,CAAC,SAAS,EAAE,SAAS;MAAE,CAAC,EACrD;QAAEA,IAAI,EAAE,WAAW;QAAE,WAAW,EAAE;MAAc,CAAC;IAErD,CAKA,CAAC;IAEDb,MAAM,CAACwB,MAAM,CAAC,CAACC,OAAO,CAAC;MAAEC,OAAO,EAAE,YAAY;MAAEb,IAAI,EAAE;IAAY,CAAC,CAAC;EACtE,CAAC,CAAC;EAEFZ,EAAE,CAAC,+EAA+E,EAAE,YAAY;IAgB9F,MAAMD,MAAM,CACVE,4BAA4B,CAACC,aAAa,EAhBH;MACvCU,IAAI,EAAE,WAAW;MACjBc,UAAU,EAAE,CACV;QACEd,IAAI,EAAE,2BAA2B;QACjCS,SAAS,EAAE;UACTT,IAAI,EAAE,eAAe;UACrBG,aAAa,EAAE;QACjB,CAAC;QACDO,aAAa,EAAE;MACjB,CAAC,EACD;QAAEV,IAAI,EAAE,eAAe;QAAEG,aAAa,EAAE;MAAa,CAAC;IAE1D,CAGmE,CACnE,CAAC,CAACY,OAAO,CAACC,kCAAkC,CAC1C,iGACF,CAAC;EACH,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}

package/build/esm/util/interfaceUtils.js

@@ -18,4 +18,14 @@
 export function isInterfaceActionParam(o) {
   return o != null && typeof o === "object" && "$objectType" in o && "$primaryKey" in o;
 }
+
+/** @internal */
+export function isInterfaceQueryParam(o) {
+  return o != null && typeof o === "object" && "$objectType" in o && "$primaryKey" in o;
+}
+
+/** @internal */
+export function isInterfaceSpecifier(o) {
+  return o != null && typeof o === "object" && "$objectType" in o && "$primaryKey" in o && o.$objectType !== o.$apiName;
+}
 //# sourceMappingURL=interfaceUtils.js.map

package/build/esm/util/interfaceUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"interfaceUtils.js","names":["isInterfaceActionParam","o"],"sources":["interfaceUtils.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 { ActionParam } from \"@osdk/api\";\n\n/** @internal */\nexport function isInterfaceActionParam(\n  o: any,\n): o is ActionParam.InterfaceType<any> {\n  return o != null && typeof o === \"object\"\n    && \"$objectType\" in o && \"$primaryKey\" in o;\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAIA;AACA,OAAO,SAASA,sBAAsBA,CACpCC,CAAM,EAC+B;EACrC,OAAOA,CAAC,IAAI,IAAI,IAAI,OAAOA,CAAC,KAAK,QAAQ,IACpC,aAAa,IAAIA,CAAC,IAAI,aAAa,IAAIA,CAAC;AAC/C","ignoreList":[]}
+{"version":3,"file":"interfaceUtils.js","names":["isInterfaceActionParam","o","isInterfaceQueryParam","isInterfaceSpecifier","$objectType","$apiName"],"sources":["interfaceUtils.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 { ActionParam, PrimaryKeyTypes, QueryParam } from \"@osdk/api\";\n\n/** @internal */\nexport function isInterfaceActionParam(\n  o: any,\n): o is ActionParam.InterfaceType<any> {\n  return o != null && typeof o === \"object\"\n    && \"$objectType\" in o && \"$primaryKey\" in o;\n}\n\n/** @internal */\nexport function isInterfaceQueryParam(\n  o: any,\n): o is QueryParam.InterfaceType<any> {\n  return o != null && typeof o === \"object\"\n    && \"$objectType\" in o && \"$primaryKey\" in o;\n}\n\n/** @internal */\nexport function isInterfaceSpecifier(\n  o: any,\n): o is {\n  $apiName: string;\n  $objectType: string;\n  $primaryKey: PrimaryKeyTypes;\n} {\n  return o != null && typeof o === \"object\"\n    && \"$objectType\" in o && \"$primaryKey\" in o && o.$objectType !== o.$apiName;\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAIA;AACA,OAAO,SAASA,sBAAsBA,CACpCC,CAAM,EAC+B;EACrC,OAAOA,CAAC,IAAI,IAAI,IAAI,OAAOA,CAAC,KAAK,QAAQ,IACpC,aAAa,IAAIA,CAAC,IAAI,aAAa,IAAIA,CAAC;AAC/C;;AAEA;AACA,OAAO,SAASC,qBAAqBA,CACnCD,CAAM,EAC8B;EACpC,OAAOA,CAAC,IAAI,IAAI,IAAI,OAAOA,CAAC,KAAK,QAAQ,IACpC,aAAa,IAAIA,CAAC,IAAI,aAAa,IAAIA,CAAC;AAC/C;;AAEA;AACA,OAAO,SAASE,oBAAoBA,CAClCF,CAAM,EAKN;EACA,OAAOA,CAAC,IAAI,IAAI,IAAI,OAAOA,CAAC,KAAK,QAAQ,IACpC,aAAa,IAAIA,CAAC,IAAI,aAAa,IAAIA,CAAC,IAAIA,CAAC,CAACG,WAAW,KAAKH,CAAC,CAACI,QAAQ;AAC/E","ignoreList":[]}

package/build/esm/util/objectSpecifierUtils.js

@@ -26,6 +26,18 @@ export function createObjectSpecifierFromPrimaryKey(objectDef, primaryKey) {
   return `${objectDef.apiName}:${primaryKey}`;
 }
 
+/**
+ * Creates an Object Specifier. An ObjectSpecifier is a string that uniquely identifies an object in the system,
+ * even when loading an interface object where primary key uniqueness is not guaranteed.
+ *
+ * @param objectDef - An Object Type Definition
+ * @param primaryKey - The value you want to use as the primary key
+ * @returns An Object Specifier
+ */
+export function createObjectSpecifierFromInterfaceSpecifier(interfaceDef, interfaceSpecifier) {
+  return `${interfaceSpecifier.objectTypeApiName}:${interfaceSpecifier.primaryKeyValue}`;
+}
+
 /**
  * Extracts the primary key from an ObjectSpecifier on an OSDK object.
  *

package/build/esm/util/objectSpecifierUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"objectSpecifierUtils.js","names":["createObjectSpecifierFromPrimaryKey","objectDef","primaryKey","apiName","extractPrimaryKeyFromObjectSpecifier","ObjectSpecifier","split","extractObjectTypeFromObjectSpecifier"],"sources":["objectSpecifierUtils.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 {\n  ObjectSpecifier,\n  ObjectTypeDefinition,\n  PrimaryKeyType,\n} from \"@osdk/api\";\n\n/**\n * Creates an Object Specifier. An ObjectSpecifier is a string that uniquely identifies an object in the system,\n * even when loading an interface object where primary key uniqueness is not guaranteed.\n *\n * @param objectDef - An Object Type Definition\n * @param primaryKey - The value you want to use as the primary key\n * @returns An Object Specifier\n */\nexport function createObjectSpecifierFromPrimaryKey<\n  Q extends ObjectTypeDefinition,\n>(objectDef: Q, primaryKey: PrimaryKeyType<Q>): ObjectSpecifier<Q> {\n  return `${objectDef.apiName}:${primaryKey}` as ObjectSpecifier<Q>;\n}\n\n/**\n * Extracts the primary key from an ObjectSpecifier on an OSDK object.\n *\n * @param ObjectSpecifier\n * @returns A string representing the primary key\n */\nexport function extractPrimaryKeyFromObjectSpecifier(\n  ObjectSpecifier: ObjectSpecifier<any>,\n): string {\n  return ObjectSpecifier.split(\":\")[1];\n}\n\n/**\n * Extracts the object type from an ObjectSpecifier on an OSDK object.\n *\n * @param ObjectSpecifier\n * @returns The object type extracted from the ObjectSpecifier\n */\nexport function extractObjectTypeFromObjectSpecifier(\n  ObjectSpecifier: ObjectSpecifier<any>,\n): string {\n  return ObjectSpecifier.split(\":\")[0];\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAQA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASA,mCAAmCA,CAEjDC,SAAY,EAAEC,UAA6B,EAAsB;EACjE,OAAO,GAAGD,SAAS,CAACE,OAAO,IAAID,UAAU,EAAE;AAC7C;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASE,oCAAoCA,CAClDC,eAAqC,EAC7B;EACR,OAAOA,eAAe,CAACC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AACtC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,oCAAoCA,CAClDF,eAAqC,EAC7B;EACR,OAAOA,eAAe,CAACC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AACtC","ignoreList":[]}
+{"version":3,"file":"objectSpecifierUtils.js","names":["createObjectSpecifierFromPrimaryKey","objectDef","primaryKey","apiName","createObjectSpecifierFromInterfaceSpecifier","interfaceDef","interfaceSpecifier","objectTypeApiName","primaryKeyValue","extractPrimaryKeyFromObjectSpecifier","ObjectSpecifier","split","extractObjectTypeFromObjectSpecifier"],"sources":["objectSpecifierUtils.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 {\n  InterfaceDefinition,\n  ObjectSpecifier,\n  ObjectTypeDefinition,\n  PrimaryKeyType,\n} from \"@osdk/api\";\n\n/**\n * Creates an Object Specifier. An ObjectSpecifier is a string that uniquely identifies an object in the system,\n * even when loading an interface object where primary key uniqueness is not guaranteed.\n *\n * @param objectDef - An Object Type Definition\n * @param primaryKey - The value you want to use as the primary key\n * @returns An Object Specifier\n */\nexport function createObjectSpecifierFromPrimaryKey<\n  Q extends ObjectTypeDefinition,\n>(objectDef: Q, primaryKey: PrimaryKeyType<Q>): ObjectSpecifier<Q> {\n  return `${objectDef.apiName}:${primaryKey}` as ObjectSpecifier<Q>;\n}\n\n/**\n * Creates an Object Specifier. An ObjectSpecifier is a string that uniquely identifies an object in the system,\n * even when loading an interface object where primary key uniqueness is not guaranteed.\n *\n * @param objectDef - An Object Type Definition\n * @param primaryKey - The value you want to use as the primary key\n * @returns An Object Specifier\n */\nexport function createObjectSpecifierFromInterfaceSpecifier<\n  Q extends InterfaceDefinition,\n>(\n  interfaceDef: Q,\n  interfaceSpecifier: {\n    objectTypeApiName: string;\n    primaryKeyValue: PrimaryKeyType<Q>;\n  },\n): ObjectSpecifier<Q> {\n  return `${interfaceSpecifier.objectTypeApiName}:${interfaceSpecifier.primaryKeyValue}` as ObjectSpecifier<\n    Q\n  >;\n}\n\n/**\n * Extracts the primary key from an ObjectSpecifier on an OSDK object.\n *\n * @param ObjectSpecifier\n * @returns A string representing the primary key\n */\nexport function extractPrimaryKeyFromObjectSpecifier(\n  ObjectSpecifier: ObjectSpecifier<any>,\n): string {\n  return ObjectSpecifier.split(\":\")[1];\n}\n\n/**\n * Extracts the object type from an ObjectSpecifier on an OSDK object.\n *\n * @param ObjectSpecifier\n * @returns The object type extracted from the ObjectSpecifier\n */\nexport function extractObjectTypeFromObjectSpecifier(\n  ObjectSpecifier: ObjectSpecifier<any>,\n): string {\n  return ObjectSpecifier.split(\":\")[0];\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AASA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASA,mCAAmCA,CAEjDC,SAAY,EAAEC,UAA6B,EAAsB;EACjE,OAAO,GAAGD,SAAS,CAACE,OAAO,IAAID,UAAU,EAAE;AAC7C;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASE,2CAA2CA,CAGzDC,YAAe,EACfC,kBAGC,EACmB;EACpB,OAAO,GAAGA,kBAAkB,CAACC,iBAAiB,IAAID,kBAAkB,CAACE,eAAe,EAAE;AAGxF;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,oCAAoCA,CAClDC,eAAqC,EAC7B;EACR,OAAOA,eAAe,CAACC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AACtC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,oCAAoCA,CAClDF,eAAqC,EAC7B;EACR,OAAOA,eAAe,CAACC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AACtC","ignoreList":[]}

package/build/esm/util/toDataValue.js

@@ -14,10 +14,9 @@
  * limitations under the License.
  */
 
-import { NULL_VALUE } from "@osdk/api";
 import * as OntologiesV2 from "@osdk/foundry.ontologies";
 import { isAttachmentFile, isAttachmentUpload } from "../object/AttachmentUpload.js";
-import { isMediaReference, isMediaUpload } from "../object/mediaUpload.js";
+import { isMediaReference } from "../object/mediaUpload.js";
 import { getWireObjectSet, isObjectSet } from "../objectSet/createObjectSet.js";
 import { isInterfaceActionParam } from "./interfaceUtils.js";
 import { isObjectSpecifiersObject } from "./isObjectSpecifiersObject.js";
@@ -38,9 +37,6 @@ export async function toDataValue(value, client, actionMetadata) {
     // Null values are not allowed with OSDK types, but leaving here as an override.
     return value;
   }
-  if (value === NULL_VALUE) {
-    return null;
-  }
 
   // arrays and sets are both sent over the wire as arrays
   if (Array.isArray(value) || value instanceof Set) {
@@ -70,16 +66,6 @@ export async function toDataValue(value, client, actionMetadata) {
     return await toDataValue(attachment.rid, client, actionMetadata);
   }
 
-  // new media item upload interface, very similar to how attachments work above
-
-  if (isMediaUpload(value)) {
-    const mediaRef = await OntologiesV2.MediaReferenceProperties.uploadMedia(client, await client.ontologyRid, actionMetadata.apiName, value.data, {
-      mediaItemPath: value.path,
-      preview: true
-    });
-    return await toDataValue(mediaRef, client, actionMetadata);
-  }
-
   // objects just send the JSON'd primaryKey
   if (isOntologyObjectV2(value)) {
     return await toDataValue(value.__primaryKey, client, actionMetadata);

package/build/esm/util/toDataValue.js.map

@@ -1 +1 @@
-{"version":3,"file":"toDataValue.js","names":["NULL_VALUE","OntologiesV2","isAttachmentFile","isAttachmentUpload","isMediaReference","isMediaUpload","getWireObjectSet","isObjectSet","isInterfaceActionParam","isObjectSpecifiersObject","isOntologyObjectV2","isPoint","isWireObjectSet","toDataValue","value","client","actionMetadata","Array","isArray","Set","values","from","some","dataValue","converted","push","promiseArray","innerValue","Promise","all","attachment","Attachments","upload","data","filename","name","rid","mediaRef","MediaReferenceProperties","uploadMedia","ontologyRid","apiName","mediaItemPath","path","preview","__primaryKey","$primaryKey","coordinates","objectTypeApiName","$objectType","primaryKeyValue","Object","entries","reduce","promisedAcc","key","structValue","acc","resolve"],"sources":["toDataValue.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 { NULL_VALUE } from \"@osdk/api\";\nimport type { ActionMetadata } from \"@osdk/api\";\nimport { type DataValue } from \"@osdk/foundry.ontologies\";\nimport * as OntologiesV2 from \"@osdk/foundry.ontologies\";\nimport type { MinimalClient } from \"../MinimalClientContext.js\";\nimport {\n  isAttachmentFile,\n  isAttachmentUpload,\n} from \"../object/AttachmentUpload.js\";\nimport { isMediaReference, isMediaUpload } from \"../object/mediaUpload.js\";\nimport { getWireObjectSet, isObjectSet } from \"../objectSet/createObjectSet.js\";\nimport { isInterfaceActionParam } from \"./interfaceUtils.js\";\nimport { isObjectSpecifiersObject } from \"./isObjectSpecifiersObject.js\";\nimport { isOntologyObjectV2 } from \"./isOntologyObjectV2.js\";\nimport { isPoint } from \"./isPoint.js\";\nimport { isWireObjectSet } from \"./WireObjectSet.js\";\n\n/**\n * Marshall user-facing data into the wire DataValue type\n *\n * @see DataValue for the expected payloads\n * @internal\n */\nexport async function toDataValue(\n  value: unknown,\n  client: MinimalClient,\n  actionMetadata: ActionMetadata,\n): Promise<DataValue> {\n  if (value == null) {\n    // typeof null is 'object' so do this first\n    // Sending null over the wire clears the data, whereas undefined is dropped at request time.\n    // Null values are not allowed with OSDK types, but leaving here as an override.\n    return value;\n  }\n\n  if (value === NULL_VALUE) {\n    return null;\n  }\n\n  // arrays and sets are both sent over the wire as arrays\n  if (Array.isArray(value) || value instanceof Set) {\n    const values = Array.from(value);\n    if (\n      values.some((dataValue) =>\n        isAttachmentUpload(dataValue) || isAttachmentFile(dataValue)\n      )\n    ) {\n      const converted = [];\n      for (const value of values) {\n        converted.push(await toDataValue(value, client, actionMetadata));\n      }\n      return converted;\n    }\n    const promiseArray = Array.from(\n      value,\n      async (innerValue) =>\n        await toDataValue(innerValue, client, actionMetadata),\n    );\n    return Promise.all(promiseArray);\n  }\n\n  // For uploads, we need to upload ourselves first to get the RID of the attachment\n  if (isAttachmentUpload(value)) {\n    const attachment = await OntologiesV2.Attachments.upload(\n      client,\n      value.data,\n      {\n        filename: value.name,\n      },\n    );\n    return await toDataValue(attachment.rid, client, actionMetadata);\n  }\n\n  if (isAttachmentFile(value)) {\n    const attachment = await OntologiesV2.Attachments.upload(\n      client,\n      value,\n      {\n        filename: value.name as string,\n      },\n    );\n    return await toDataValue(attachment.rid, client, actionMetadata);\n  }\n\n  // new media item upload interface, very similar to how attachments work above\n\n  if (isMediaUpload(value)) {\n    const mediaRef = await OntologiesV2.MediaReferenceProperties\n      .uploadMedia(\n        client,\n        await client.ontologyRid,\n        actionMetadata.apiName,\n        value.data,\n        {\n          mediaItemPath: value.path,\n          preview: true,\n        },\n      );\n    return await toDataValue(mediaRef, client, actionMetadata);\n  }\n\n  // objects just send the JSON'd primaryKey\n  if (isOntologyObjectV2(value)) {\n    return await toDataValue(value.__primaryKey, client, actionMetadata);\n  }\n\n  if (isObjectSpecifiersObject(value)) {\n    return await toDataValue(value.$primaryKey, client, actionMetadata);\n  }\n\n  if (isPoint(value)) {\n    return await toDataValue(\n      `${value.coordinates[1]},${value.coordinates[0]}`,\n      client,\n      actionMetadata,\n    );\n  }\n\n  // object set (the rid as a string (passes through the last return), or the ObjectSet definition directly)\n  if (isWireObjectSet(value)) {\n    return value;\n  }\n  if (isObjectSet(value)) {\n    return getWireObjectSet(value);\n  }\n\n  if (isMediaReference(value)) {\n    return value;\n  }\n\n  if (isInterfaceActionParam(value)) {\n    return {\n      objectTypeApiName: value.$objectType,\n      primaryKeyValue: value.$primaryKey,\n    };\n  }\n\n  // TODO (during queries implementation)\n  // two dimensional aggregation\n  // three dimensional aggregation\n\n  // struct\n  if (typeof value === \"object\") {\n    return Object.entries(value).reduce(\n      async (promisedAcc, [key, structValue]) => {\n        const acc = await promisedAcc;\n        acc[key] = await toDataValue(structValue, client, actionMetadata);\n        return acc;\n      },\n      Promise.resolve({} as { [key: string]: DataValue }),\n    );\n  }\n\n  // expected to pass through - boolean, byte, date, decimal, float, double, integer, long, short, string, timestamp, object type reference\n  return value;\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAASA,UAAU,QAAQ,WAAW;AAGtC,OAAO,KAAKC,YAAY,MAAM,0BAA0B;AAExD,SACEC,gBAAgB,EAChBC,kBAAkB,QACb,+BAA+B;AACtC,SAASC,gBAAgB,EAAEC,aAAa,QAAQ,0BAA0B;AAC1E,SAASC,gBAAgB,EAAEC,WAAW,QAAQ,iCAAiC;AAC/E,SAASC,sBAAsB,QAAQ,qBAAqB;AAC5D,SAASC,wBAAwB,QAAQ,+BAA+B;AACxE,SAASC,kBAAkB,QAAQ,yBAAyB;AAC5D,SAASC,OAAO,QAAQ,cAAc;AACtC,SAASC,eAAe,QAAQ,oBAAoB;;AAEpD;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeC,WAAWA,CAC/BC,KAAc,EACdC,MAAqB,EACrBC,cAA8B,EACV;EACpB,IAAIF,KAAK,IAAI,IAAI,EAAE;IACjB;IACA;IACA;IACA,OAAOA,KAAK;EACd;EAEA,IAAIA,KAAK,KAAKd,UAAU,EAAE;IACxB,OAAO,IAAI;EACb;;EAEA;EACA,IAAIiB,KAAK,CAACC,OAAO,CAACJ,KAAK,CAAC,IAAIA,KAAK,YAAYK,GAAG,EAAE;IAChD,MAAMC,MAAM,GAAGH,KAAK,CAACI,IAAI,CAACP,KAAK,CAAC;IAChC,IACEM,MAAM,CAACE,IAAI,CAAEC,SAAS,IACpBpB,kBAAkB,CAACoB,SAAS,CAAC,IAAIrB,gBAAgB,CAACqB,SAAS,CAC7D,CAAC,EACD;MACA,MAAMC,SAAS,GAAG,EAAE;MACpB,KAAK,MAAMV,KAAK,IAAIM,MAAM,EAAE;QAC1BI,SAAS,CAACC,IAAI,CAAC,MAAMZ,WAAW,CAACC,KAAK,EAAEC,MAAM,EAAEC,cAAc,CAAC,CAAC;MAClE;MACA,OAAOQ,SAAS;IAClB;IACA,MAAME,YAAY,GAAGT,KAAK,CAACI,IAAI,CAC7BP,KAAK,EACL,MAAOa,UAAU,IACf,MAAMd,WAAW,CAACc,UAAU,EAAEZ,MAAM,EAAEC,cAAc,CACxD,CAAC;IACD,OAAOY,OAAO,CAACC,GAAG,CAACH,YAAY,CAAC;EAClC;;EAEA;EACA,IAAIvB,kBAAkB,CAACW,KAAK,CAAC,EAAE;IAC7B,MAAMgB,UAAU,GAAG,MAAM7B,YAAY,CAAC8B,WAAW,CAACC,MAAM,CACtDjB,MAAM,EACND,KAAK,CAACmB,IAAI,EACV;MACEC,QAAQ,EAAEpB,KAAK,CAACqB;IAClB,CACF,CAAC;IACD,OAAO,MAAMtB,WAAW,CAACiB,UAAU,CAACM,GAAG,EAAErB,MAAM,EAAEC,cAAc,CAAC;EAClE;EAEA,IAAId,gBAAgB,CAACY,KAAK,CAAC,EAAE;IAC3B,MAAMgB,UAAU,GAAG,MAAM7B,YAAY,CAAC8B,WAAW,CAACC,MAAM,CACtDjB,MAAM,EACND,KAAK,EACL;MACEoB,QAAQ,EAAEpB,KAAK,CAACqB;IAClB,CACF,CAAC;IACD,OAAO,MAAMtB,WAAW,CAACiB,UAAU,CAACM,GAAG,EAAErB,MAAM,EAAEC,cAAc,CAAC;EAClE;;EAEA;;EAEA,IAAIX,aAAa,CAACS,KAAK,CAAC,EAAE;IACxB,MAAMuB,QAAQ,GAAG,MAAMpC,YAAY,CAACqC,wBAAwB,CACzDC,WAAW,CACVxB,MAAM,EACN,MAAMA,MAAM,CAACyB,WAAW,EACxBxB,cAAc,CAACyB,OAAO,EACtB3B,KAAK,CAACmB,IAAI,EACV;MACES,aAAa,EAAE5B,KAAK,CAAC6B,IAAI;MACzBC,OAAO,EAAE;IACX,CACF,CAAC;IACH,OAAO,MAAM/B,WAAW,CAACwB,QAAQ,EAAEtB,MAAM,EAAEC,cAAc,CAAC;EAC5D;;EAEA;EACA,IAAIN,kBAAkB,CAACI,KAAK,CAAC,EAAE;IAC7B,OAAO,MAAMD,WAAW,CAACC,KAAK,CAAC+B,YAAY,EAAE9B,MAAM,EAAEC,cAAc,CAAC;EACtE;EAEA,IAAIP,wBAAwB,CAACK,KAAK,CAAC,EAAE;IACnC,OAAO,MAAMD,WAAW,CAACC,KAAK,CAACgC,WAAW,EAAE/B,MAAM,EAAEC,cAAc,CAAC;EACrE;EAEA,IAAIL,OAAO,CAACG,KAAK,CAAC,EAAE;IAClB,OAAO,MAAMD,WAAW,CACtB,GAAGC,KAAK,CAACiC,WAAW,CAAC,CAAC,CAAC,IAAIjC,KAAK,CAACiC,WAAW,CAAC,CAAC,CAAC,EAAE,EACjDhC,MAAM,EACNC,cACF,CAAC;EACH;;EAEA;EACA,IAAIJ,eAAe,CAACE,KAAK,CAAC,EAAE;IAC1B,OAAOA,KAAK;EACd;EACA,IAAIP,WAAW,CAACO,KAAK,CAAC,EAAE;IACtB,OAAOR,gBAAgB,CAACQ,KAAK,CAAC;EAChC;EAEA,IAAIV,gBAAgB,CAACU,KAAK,CAAC,EAAE;IAC3B,OAAOA,KAAK;EACd;EAEA,IAAIN,sBAAsB,CAACM,KAAK,CAAC,EAAE;IACjC,OAAO;MACLkC,iBAAiB,EAAElC,KAAK,CAACmC,WAAW;MACpCC,eAAe,EAAEpC,KAAK,CAACgC;IACzB,CAAC;EACH;;EAEA;EACA;EACA;;EAEA;EACA,IAAI,OAAOhC,KAAK,KAAK,QAAQ,EAAE;IAC7B,OAAOqC,MAAM,CAACC,OAAO,CAACtC,KAAK,CAAC,CAACuC,MAAM,CACjC,OAAOC,WAAW,EAAE,CAACC,GAAG,EAAEC,WAAW,CAAC,KAAK;MACzC,MAAMC,GAAG,GAAG,MAAMH,WAAW;MAC7BG,GAAG,CAACF,GAAG,CAAC,GAAG,MAAM1C,WAAW,CAAC2C,WAAW,EAAEzC,MAAM,EAAEC,cAAc,CAAC;MACjE,OAAOyC,GAAG;IACZ,CAAC,EACD7B,OAAO,CAAC8B,OAAO,CAAC,CAAC,CAAiC,CACpD,CAAC;EACH;;EAEA;EACA,OAAO5C,KAAK;AACd","ignoreList":[]}
+{"version":3,"file":"toDataValue.js","names":["OntologiesV2","isAttachmentFile","isAttachmentUpload","isMediaReference","getWireObjectSet","isObjectSet","isInterfaceActionParam","isObjectSpecifiersObject","isOntologyObjectV2","isPoint","isWireObjectSet","toDataValue","value","client","actionMetadata","Array","isArray","Set","values","from","some","dataValue","converted","push","promiseArray","innerValue","Promise","all","attachment","Attachments","upload","data","filename","name","rid","__primaryKey","$primaryKey","coordinates","objectTypeApiName","$objectType","primaryKeyValue","Object","entries","reduce","promisedAcc","key","structValue","acc","resolve"],"sources":["toDataValue.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 { ActionMetadata } from \"@osdk/api\";\nimport { type DataValue } from \"@osdk/foundry.ontologies\";\nimport * as OntologiesV2 from \"@osdk/foundry.ontologies\";\nimport type { MinimalClient } from \"../MinimalClientContext.js\";\nimport {\n  isAttachmentFile,\n  isAttachmentUpload,\n} from \"../object/AttachmentUpload.js\";\nimport { isMediaReference } from \"../object/mediaUpload.js\";\nimport { getWireObjectSet, isObjectSet } from \"../objectSet/createObjectSet.js\";\nimport { isInterfaceActionParam } from \"./interfaceUtils.js\";\nimport { isObjectSpecifiersObject } from \"./isObjectSpecifiersObject.js\";\nimport { isOntologyObjectV2 } from \"./isOntologyObjectV2.js\";\nimport { isPoint } from \"./isPoint.js\";\nimport { isWireObjectSet } from \"./WireObjectSet.js\";\n\n/**\n * Marshall user-facing data into the wire DataValue type\n *\n * @see DataValue for the expected payloads\n * @internal\n */\nexport async function toDataValue(\n  value: unknown,\n  client: MinimalClient,\n  actionMetadata: ActionMetadata,\n): Promise<DataValue> {\n  if (value == null) {\n    // typeof null is 'object' so do this first\n    // Sending null over the wire clears the data, whereas undefined is dropped at request time.\n    // Null values are not allowed with OSDK types, but leaving here as an override.\n    return value;\n  }\n\n  // arrays and sets are both sent over the wire as arrays\n  if (Array.isArray(value) || value instanceof Set) {\n    const values = Array.from(value);\n    if (\n      values.some((dataValue) =>\n        isAttachmentUpload(dataValue) || isAttachmentFile(dataValue)\n      )\n    ) {\n      const converted = [];\n      for (const value of values) {\n        converted.push(await toDataValue(value, client, actionMetadata));\n      }\n      return converted;\n    }\n    const promiseArray = Array.from(\n      value,\n      async (innerValue) =>\n        await toDataValue(innerValue, client, actionMetadata),\n    );\n    return Promise.all(promiseArray);\n  }\n\n  // For uploads, we need to upload ourselves first to get the RID of the attachment\n  if (isAttachmentUpload(value)) {\n    const attachment = await OntologiesV2.Attachments.upload(\n      client,\n      value.data,\n      {\n        filename: value.name,\n      },\n    );\n    return await toDataValue(attachment.rid, client, actionMetadata);\n  }\n\n  if (isAttachmentFile(value)) {\n    const attachment = await OntologiesV2.Attachments.upload(\n      client,\n      value,\n      {\n        filename: value.name as string,\n      },\n    );\n    return await toDataValue(attachment.rid, client, actionMetadata);\n  }\n\n  // objects just send the JSON'd primaryKey\n  if (isOntologyObjectV2(value)) {\n    return await toDataValue(value.__primaryKey, client, actionMetadata);\n  }\n\n  if (isObjectSpecifiersObject(value)) {\n    return await toDataValue(value.$primaryKey, client, actionMetadata);\n  }\n\n  if (isPoint(value)) {\n    return await toDataValue(\n      `${value.coordinates[1]},${value.coordinates[0]}`,\n      client,\n      actionMetadata,\n    );\n  }\n\n  // object set (the rid as a string (passes through the last return), or the ObjectSet definition directly)\n  if (isWireObjectSet(value)) {\n    return value;\n  }\n  if (isObjectSet(value)) {\n    return getWireObjectSet(value);\n  }\n\n  if (isMediaReference(value)) {\n    return value;\n  }\n\n  if (isInterfaceActionParam(value)) {\n    return {\n      objectTypeApiName: value.$objectType,\n      primaryKeyValue: value.$primaryKey,\n    };\n  }\n\n  // TODO (during queries implementation)\n  // two dimensional aggregation\n  // three dimensional aggregation\n\n  // struct\n  if (typeof value === \"object\") {\n    return Object.entries(value).reduce(\n      async (promisedAcc, [key, structValue]) => {\n        const acc = await promisedAcc;\n        acc[key] = await toDataValue(structValue, client, actionMetadata);\n        return acc;\n      },\n      Promise.resolve({} as { [key: string]: DataValue }),\n    );\n  }\n\n  // expected to pass through - boolean, byte, date, decimal, float, double, integer, long, short, string, timestamp, object type reference\n  return value;\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAIA,OAAO,KAAKA,YAAY,MAAM,0BAA0B;AAExD,SACEC,gBAAgB,EAChBC,kBAAkB,QACb,+BAA+B;AACtC,SAASC,gBAAgB,QAAQ,0BAA0B;AAC3D,SAASC,gBAAgB,EAAEC,WAAW,QAAQ,iCAAiC;AAC/E,SAASC,sBAAsB,QAAQ,qBAAqB;AAC5D,SAASC,wBAAwB,QAAQ,+BAA+B;AACxE,SAASC,kBAAkB,QAAQ,yBAAyB;AAC5D,SAASC,OAAO,QAAQ,cAAc;AACtC,SAASC,eAAe,QAAQ,oBAAoB;;AAEpD;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeC,WAAWA,CAC/BC,KAAc,EACdC,MAAqB,EACrBC,cAA8B,EACV;EACpB,IAAIF,KAAK,IAAI,IAAI,EAAE;IACjB;IACA;IACA;IACA,OAAOA,KAAK;EACd;;EAEA;EACA,IAAIG,KAAK,CAACC,OAAO,CAACJ,KAAK,CAAC,IAAIA,KAAK,YAAYK,GAAG,EAAE;IAChD,MAAMC,MAAM,GAAGH,KAAK,CAACI,IAAI,CAACP,KAAK,CAAC;IAChC,IACEM,MAAM,CAACE,IAAI,CAAEC,SAAS,IACpBnB,kBAAkB,CAACmB,SAAS,CAAC,IAAIpB,gBAAgB,CAACoB,SAAS,CAC7D,CAAC,EACD;MACA,MAAMC,SAAS,GAAG,EAAE;MACpB,KAAK,MAAMV,KAAK,IAAIM,MAAM,EAAE;QAC1BI,SAAS,CAACC,IAAI,CAAC,MAAMZ,WAAW,CAACC,KAAK,EAAEC,MAAM,EAAEC,cAAc,CAAC,CAAC;MAClE;MACA,OAAOQ,SAAS;IAClB;IACA,MAAME,YAAY,GAAGT,KAAK,CAACI,IAAI,CAC7BP,KAAK,EACL,MAAOa,UAAU,IACf,MAAMd,WAAW,CAACc,UAAU,EAAEZ,MAAM,EAAEC,cAAc,CACxD,CAAC;IACD,OAAOY,OAAO,CAACC,GAAG,CAACH,YAAY,CAAC;EAClC;;EAEA;EACA,IAAItB,kBAAkB,CAACU,KAAK,CAAC,EAAE;IAC7B,MAAMgB,UAAU,GAAG,MAAM5B,YAAY,CAAC6B,WAAW,CAACC,MAAM,CACtDjB,MAAM,EACND,KAAK,CAACmB,IAAI,EACV;MACEC,QAAQ,EAAEpB,KAAK,CAACqB;IAClB,CACF,CAAC;IACD,OAAO,MAAMtB,WAAW,CAACiB,UAAU,CAACM,GAAG,EAAErB,MAAM,EAAEC,cAAc,CAAC;EAClE;EAEA,IAAIb,gBAAgB,CAACW,KAAK,CAAC,EAAE;IAC3B,MAAMgB,UAAU,GAAG,MAAM5B,YAAY,CAAC6B,WAAW,CAACC,MAAM,CACtDjB,MAAM,EACND,KAAK,EACL;MACEoB,QAAQ,EAAEpB,KAAK,CAACqB;IAClB,CACF,CAAC;IACD,OAAO,MAAMtB,WAAW,CAACiB,UAAU,CAACM,GAAG,EAAErB,MAAM,EAAEC,cAAc,CAAC;EAClE;;EAEA;EACA,IAAIN,kBAAkB,CAACI,KAAK,CAAC,EAAE;IAC7B,OAAO,MAAMD,WAAW,CAACC,KAAK,CAACuB,YAAY,EAAEtB,MAAM,EAAEC,cAAc,CAAC;EACtE;EAEA,IAAIP,wBAAwB,CAACK,KAAK,CAAC,EAAE;IACnC,OAAO,MAAMD,WAAW,CAACC,KAAK,CAACwB,WAAW,EAAEvB,MAAM,EAAEC,cAAc,CAAC;EACrE;EAEA,IAAIL,OAAO,CAACG,KAAK,CAAC,EAAE;IAClB,OAAO,MAAMD,WAAW,CACtB,GAAGC,KAAK,CAACyB,WAAW,CAAC,CAAC,CAAC,IAAIzB,KAAK,CAACyB,WAAW,CAAC,CAAC,CAAC,EAAE,EACjDxB,MAAM,EACNC,cACF,CAAC;EACH;;EAEA;EACA,IAAIJ,eAAe,CAACE,KAAK,CAAC,EAAE;IAC1B,OAAOA,KAAK;EACd;EACA,IAAIP,WAAW,CAACO,KAAK,CAAC,EAAE;IACtB,OAAOR,gBAAgB,CAACQ,KAAK,CAAC;EAChC;EAEA,IAAIT,gBAAgB,CAACS,KAAK,CAAC,EAAE;IAC3B,OAAOA,KAAK;EACd;EAEA,IAAIN,sBAAsB,CAACM,KAAK,CAAC,EAAE;IACjC,OAAO;MACL0B,iBAAiB,EAAE1B,KAAK,CAAC2B,WAAW;MACpCC,eAAe,EAAE5B,KAAK,CAACwB;IACzB,CAAC;EACH;;EAEA;EACA;EACA;;EAEA;EACA,IAAI,OAAOxB,KAAK,KAAK,QAAQ,EAAE;IAC7B,OAAO6B,MAAM,CAACC,OAAO,CAAC9B,KAAK,CAAC,CAAC+B,MAAM,CACjC,OAAOC,WAAW,EAAE,CAACC,GAAG,EAAEC,WAAW,CAAC,KAAK;MACzC,MAAMC,GAAG,GAAG,MAAMH,WAAW;MAC7BG,GAAG,CAACF,GAAG,CAAC,GAAG,MAAMlC,WAAW,CAACmC,WAAW,EAAEjC,MAAM,EAAEC,cAAc,CAAC;MACjE,OAAOiC,GAAG;IACZ,CAAC,EACDrB,OAAO,CAACsB,OAAO,CAAC,CAAC,CAAiC,CACpD,CAAC;EACH;;EAEA;EACA,OAAOpC,KAAK;AACd","ignoreList":[]}

package/build/esm/util/toDataValue.test.js

@@ -14,28 +14,25 @@
  * limitations under the License.
  */
 
-import { NULL_VALUE } from "@osdk/api";
 import { Employee, Task } from "@osdk/client.test.ontology";
-import { LegacyFauxFoundry, MockOntologiesV2, startNodeApiServer, stubData } from "@osdk/shared.test";
+import { LegacyFauxFoundry, startNodeApiServer, stubData } from "@osdk/shared.test";
 import { beforeAll, describe, expect, it, vi } from "vitest";
 import { createClient } from "../createClient.js";
 import { createMinimalClient } from "../createMinimalClient.js";
 import { createAttachmentUpload } from "../object/AttachmentUpload.js";
-import { isMediaReference } from "../object/mediaUpload.js";
 import { getWireObjectSet } from "../objectSet/createObjectSet.js";
 import { toDataValue } from "./toDataValue.js";
 describe(toDataValue, () => {
   let client;
   let clientCtx;
   let mockActionMetadata;
-  let apiServer;
   vi.fn();
   beforeAll(() => {
     const testSetup = startNodeApiServer(new LegacyFauxFoundry(), createClient);
     ({
       client
     } = testSetup);
-    apiServer = testSetup.apiServer;
+    testSetup.apiServer;
     clientCtx = createMinimalClient({
       ontologyRid: testSetup.fauxFoundry.defaultOntologyRid
     }, testSetup.fauxFoundry.baseUrl, testSetup.auth, {});
@@ -143,35 +140,6 @@ describe(toDataValue, () => {
     const converted = await toDataValue(file, clientCtx, mockActionMetadata);
     expect(converted).toMatch(/ri\.attachments.main.attachment\.[a-z0-9\-]+/i);
   });
-  it("converts media uploads correctly", async () => {
-    const file = {
-      data: new Blob([JSON.stringify({
-        name: "Hello World"
-      }, null, 2)], {
-        type: "application/json"
-      }),
-      path: "file.txt"
-    };
-
-    // TODO: Mock MediaUpload properly in FauxFoundry
-    apiServer.boundary(async () => {
-      apiServer.use(MockOntologiesV2.MediaReferenceProperties.uploadMedia("https://stack.palantir.com", () => {
-        return {
-          mimeType: "application/json",
-          reference: {
-            type: "mediaSetViewItem",
-            mediaSetViewItem: {
-              mediaItemRid: "media-item-rid",
-              mediaSetRid: "media-set-rid",
-              mediaSetViewRid: "media-set-view-rid"
-            }
-          }
-        };
-      }));
-      const converted = await toDataValue(file, clientCtx, mockActionMetadata);
-      expect(isMediaReference(converted)).toBe(true);
-    });
-  });
   it("converts media reference correctly", async () => {
     const mediaReference = {
       mimeType: "application/json",
@@ -187,13 +155,5 @@ describe(toDataValue, () => {
     const converted = await toDataValue(mediaReference, clientCtx, mockActionMetadata);
     expect(converted).toEqual(mediaReference);
   });
-  it("Converts NULL_VALUE to null", async () => {
-    const converted = await toDataValue(NULL_VALUE, clientCtx, mockActionMetadata);
-    expect(converted).toBeNull();
-  });
-  it("Converts NULL_VALUE equivalents to null", async () => {
-    const converted = await toDataValue(Symbol.for("NULL_VALUE"), clientCtx, mockActionMetadata);
-    expect(converted).toEqual(null);
-  });
 });
 //# sourceMappingURL=toDataValue.test.js.map

package/build/esm/util/toDataValue.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"toDataValue.test.js","names":["NULL_VALUE","Employee","Task","LegacyFauxFoundry","MockOntologiesV2","startNodeApiServer","stubData","beforeAll","describe","expect","it","vi","createClient","createMinimalClient","createAttachmentUpload","isMediaReference","getWireObjectSet","toDataValue","client","clientCtx","mockActionMetadata","apiServer","fn","testSetup","ontologyRid","fauxFoundry","defaultOntologyRid","baseUrl","auth","apiName","close","basic","null","undefined","boolean","date","integer","string","timestamp","convertedBasic","toEqual","attachment","attachmentArray","attachmentSet","Set","recursiveConversion","inner","employee","employee1","ontologyConversion","__primaryKey","task","fetchOne","$primaryKey","clientObjectSet","where","id","definition","expected","objectSetConversion","toMatchInlineSnapshot","definitionConversion","blob","Blob","JSON","stringify","attachmentUpload","converted","toMatch","file","Object","assign","name","type","data","path","boundary","use","MediaReferenceProperties","uploadMedia","mimeType","reference","mediaSetViewItem","mediaItemRid","mediaSetRid","mediaSetViewRid","toBe","mediaReference","toBeNull","Symbol","for"],"sources":["toDataValue.test.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 { NULL_VALUE } from \"@osdk/api\";\nimport type { ActionMetadata, MediaUpload } from \"@osdk/api\";\nimport { Employee, Task } from \"@osdk/client.test.ontology\";\nimport type { MediaReference } from \"@osdk/foundry.core\";\nimport type { SetupServer } from \"@osdk/shared.test\";\nimport {\n  LegacyFauxFoundry,\n  MockOntologiesV2,\n  startNodeApiServer,\n  stubData,\n} from \"@osdk/shared.test\";\nimport type { MockedFunction } from \"vitest\";\nimport { beforeAll, describe, expect, it, vi } from \"vitest\";\nimport type { Client } from \"../Client.js\";\nimport { createClient } from \"../createClient.js\";\nimport { createMinimalClient } from \"../createMinimalClient.js\";\nimport type { MinimalClient } from \"../MinimalClientContext.js\";\nimport { createAttachmentUpload } from \"../object/AttachmentUpload.js\";\nimport { isMediaReference } from \"../object/mediaUpload.js\";\nimport { getWireObjectSet } from \"../objectSet/createObjectSet.js\";\nimport { toDataValue } from \"./toDataValue.js\";\n\ndescribe(toDataValue, () => {\n  let client: Client;\n  let clientCtx: MinimalClient;\n  let mockActionMetadata: ActionMetadata;\n  let apiServer: SetupServer;\n\n  const mockFetch: MockedFunction<typeof globalThis.fetch> = vi.fn();\n\n  beforeAll(() => {\n    const testSetup = startNodeApiServer(new LegacyFauxFoundry(), createClient);\n    ({ client } = testSetup);\n\n    apiServer = testSetup.apiServer;\n\n    clientCtx = createMinimalClient(\n      { ontologyRid: testSetup.fauxFoundry.defaultOntologyRid },\n      testSetup.fauxFoundry.baseUrl,\n      testSetup.auth,\n      {},\n    );\n\n    // toDataValue only needs the apiName right now, update this if that changes\n    const fakeActionMetadata = {\n      apiName: \"createUnstructuredImageExampleObject\",\n    };\n    mockActionMetadata = fakeActionMetadata as ActionMetadata;\n\n    return () => {\n      testSetup.apiServer.close();\n    };\n  });\n\n  it(\"converts passthrough values correctly\", async () => {\n    // basic pass through types\n    const basic = {\n      null: undefined,\n      boolean: false,\n      date: \"2024-01-01\",\n      integer: 0,\n      string: \"string\",\n      timestamp: \"2024-01-01T00:00:00Z\",\n    };\n    const convertedBasic = await toDataValue(\n      basic,\n      clientCtx,\n      mockActionMetadata,\n    );\n    expect(convertedBasic).toEqual(basic);\n  });\n\n  it(\"recursively converts arrays and sets into array types\", async () => {\n    const attachment = \"rid\";\n    const attachmentArray = [attachment];\n    const attachmentSet = new Set(attachmentArray);\n\n    const recursiveConversion = await toDataValue(\n      {\n        attachment,\n        attachmentArray,\n        attachmentSet,\n      },\n      clientCtx,\n      mockActionMetadata,\n    );\n\n    expect(recursiveConversion).toEqual({\n      attachment: \"rid\",\n      attachmentArray: [\"rid\"],\n      attachmentSet: [\"rid\"],\n    });\n  });\n\n  it(\"recursively handles structs\", async () => {\n    const struct = {\n      inner: {\n        attachment: \"rid\",\n      },\n    };\n\n    const recursiveConversion = await toDataValue(\n      struct,\n      clientCtx,\n      mockActionMetadata,\n    );\n\n    expect(recursiveConversion).toEqual({\n      inner: { attachment: \"rid\" },\n    });\n  });\n\n  it(\"maps an ontology object into just its primary key\", async () => {\n    const employee = stubData.employee1;\n    const ontologyConversion = await toDataValue(\n      employee,\n      clientCtx,\n      mockActionMetadata,\n    );\n    expect(ontologyConversion).toEqual(\n      stubData.employee1.__primaryKey,\n    );\n  });\n\n  it(\"maps an ontology object into just its primary key with osdk wrapper\", async () => {\n    const task = await client(Employee).fetchOne(50030);\n    const ontologyConversion = await toDataValue(\n      task,\n      clientCtx,\n      mockActionMetadata,\n    );\n    expect(ontologyConversion).toEqual(\n      task.$primaryKey,\n    );\n  });\n\n  it(\"passes through object set definitions\", async () => {\n    const clientObjectSet = client(Task).where({ id: 0 });\n    const definition = getWireObjectSet(clientObjectSet);\n\n    const expected = `\n    {\n      \"objectSet\": {\n        \"objectType\": \"Task\",\n        \"type\": \"base\",\n      },\n      \"type\": \"filter\",\n      \"where\": {\n        \"field\": \"id\",\n        \"type\": \"eq\",\n        \"value\": 0,\n      },\n    }\n  `;\n    const objectSetConversion = await toDataValue(\n      clientObjectSet,\n      clientCtx,\n      mockActionMetadata,\n    );\n    expect(objectSetConversion).toMatchInlineSnapshot(\n      expected,\n    );\n\n    const definitionConversion = await toDataValue(\n      definition,\n      clientCtx,\n      mockActionMetadata,\n    );\n    expect(definitionConversion).toMatchInlineSnapshot(expected);\n  });\n\n  it(\"converts blob attachment uploads correctly\", async () => {\n    const blob = new Blob([JSON.stringify({ \"hi\": \"mom\" })]);\n    const attachmentUpload = createAttachmentUpload(blob, \"file1.txt\");\n    const converted = await toDataValue(\n      attachmentUpload,\n      clientCtx,\n      mockActionMetadata,\n    );\n\n    expect(converted).toMatch(/ri\\.attachments.main.attachment\\.[a-z0-9\\-]+/i);\n  });\n\n  it(\"converts file attachment uploads correctly\", async () => {\n    // Mimics the Web file API (https://developer.mozilla.org/en-US/docs/Web/API/File). The File constructor is only available in Node 19.2.0 and above\n    const file = Object.assign(\n      new Blob([\n        JSON.stringify({ name: \"Hello World\" }, null, 2),\n      ], {\n        type: \"application/json\",\n      }),\n      { name: \"file1.txt\" },\n    );\n\n    const converted = await toDataValue(file, clientCtx, mockActionMetadata);\n    expect(converted).toMatch(/ri\\.attachments.main.attachment\\.[a-z0-9\\-]+/i);\n  });\n\n  it(\"converts media uploads correctly\", async () => {\n    const file: MediaUpload = {\n      data: new Blob([\n        JSON.stringify({ name: \"Hello World\" }, null, 2),\n      ], {\n        type: \"application/json\",\n      }),\n      path: \"file.txt\",\n    };\n\n    // TODO: Mock MediaUpload properly in FauxFoundry\n    apiServer.boundary(async () => {\n      apiServer.use(\n        MockOntologiesV2.MediaReferenceProperties.uploadMedia(\n          \"https://stack.palantir.com\",\n          () => {\n            return {\n              mimeType: \"application/json\",\n              reference: {\n                type: \"mediaSetViewItem\",\n                mediaSetViewItem: {\n                  mediaItemRid: \"media-item-rid\",\n                  mediaSetRid: \"media-set-rid\",\n                  mediaSetViewRid: \"media-set-view-rid\",\n                },\n              },\n            };\n          },\n        ),\n      );\n      const converted = await toDataValue(file, clientCtx, mockActionMetadata);\n      expect(isMediaReference(converted)).toBe(true);\n    });\n  });\n\n  it(\"converts media reference correctly\", async () => {\n    const mediaReference: MediaReference = {\n      mimeType: \"application/json\",\n      reference: {\n        type: \"mediaSetViewItem\",\n        mediaSetViewItem: {\n          mediaItemRid: \"media-item-rid\",\n          mediaSetRid: \"media-set-rid\",\n          mediaSetViewRid: \"media-set-view-rid\",\n        },\n      },\n    };\n\n    const converted = await toDataValue(\n      mediaReference,\n      clientCtx,\n      mockActionMetadata,\n    );\n    expect(converted).toEqual(mediaReference);\n  });\n\n  it(\"Converts NULL_VALUE to null\", async () => {\n    const converted = await toDataValue(\n      NULL_VALUE,\n      clientCtx,\n      mockActionMetadata,\n    );\n    expect(converted).toBeNull();\n  });\n\n  it(\"Converts NULL_VALUE equivalents to null\", async () => {\n    const clearData = Symbol.for(\"NULL_VALUE\") as symbol & {\n      __type: \"NULL_VALUE\";\n    };\n    const converted = await toDataValue(\n      clearData,\n      clientCtx,\n      mockActionMetadata,\n    );\n    expect(converted).toEqual(null);\n  });\n});\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAASA,UAAU,QAAQ,WAAW;AAEtC,SAASC,QAAQ,EAAEC,IAAI,QAAQ,4BAA4B;AAG3D,SACEC,iBAAiB,EACjBC,gBAAgB,EAChBC,kBAAkB,EAClBC,QAAQ,QACH,mBAAmB;AAE1B,SAASC,SAAS,EAAEC,QAAQ,EAAEC,MAAM,EAAEC,EAAE,EAAEC,EAAE,QAAQ,QAAQ;AAE5D,SAASC,YAAY,QAAQ,oBAAoB;AACjD,SAASC,mBAAmB,QAAQ,2BAA2B;AAE/D,SAASC,sBAAsB,QAAQ,+BAA+B;AACtE,SAASC,gBAAgB,QAAQ,0BAA0B;AAC3D,SAASC,gBAAgB,QAAQ,iCAAiC;AAClE,SAASC,WAAW,QAAQ,kBAAkB;AAE9CT,QAAQ,CAACS,WAAW,EAAE,MAAM;EAC1B,IAAIC,MAAc;EAClB,IAAIC,SAAwB;EAC5B,IAAIC,kBAAkC;EACtC,IAAIC,SAAsB;EAEiCV,EAAE,CAACW,EAAE,CAAC,CAAC;EAElEf,SAAS,CAAC,MAAM;IACd,MAAMgB,SAAS,GAAGlB,kBAAkB,CAAC,IAAIF,iBAAiB,CAAC,CAAC,EAAES,YAAY,CAAC;IAC3E,CAAC;MAAEM;IAAO,CAAC,GAAGK,SAAS;IAEvBF,SAAS,GAAGE,SAAS,CAACF,SAAS;IAE/BF,SAAS,GAAGN,mBAAmB,CAC7B;MAAEW,WAAW,EAAED,SAAS,CAACE,WAAW,CAACC;IAAmB,CAAC,EACzDH,SAAS,CAACE,WAAW,CAACE,OAAO,EAC7BJ,SAAS,CAACK,IAAI,EACd,CAAC,CACH,CAAC;;IAED;;IAIAR,kBAAkB,GAHS;MACzBS,OAAO,EAAE;IACX,CACyD;IAEzD,OAAO,MAAM;MACXN,SAAS,CAACF,SAAS,CAACS,KAAK,CAAC,CAAC;IAC7B,CAAC;EACH,CAAC,CAAC;EAEFpB,EAAE,CAAC,uCAAuC,EAAE,YAAY;IACtD;IACA,MAAMqB,KAAK,GAAG;MACZC,IAAI,EAAEC,SAAS;MACfC,OAAO,EAAE,KAAK;MACdC,IAAI,EAAE,YAAY;MAClBC,OAAO,EAAE,CAAC;MACVC,MAAM,EAAE,QAAQ;MAChBC,SAAS,EAAE;IACb,CAAC;IACD,MAAMC,cAAc,GAAG,MAAMtB,WAAW,CACtCc,KAAK,EACLZ,SAAS,EACTC,kBACF,CAAC;IACDX,MAAM,CAAC8B,cAAc,CAAC,CAACC,OAAO,CAACT,KAAK,CAAC;EACvC,CAAC,CAAC;EAEFrB,EAAE,CAAC,uDAAuD,EAAE,YAAY;IACtE,MAAM+B,UAAU,GAAG,KAAK;IACxB,MAAMC,eAAe,GAAG,CAACD,UAAU,CAAC;IACpC,MAAME,aAAa,GAAG,IAAIC,GAAG,CAACF,eAAe,CAAC;IAE9C,MAAMG,mBAAmB,GAAG,MAAM5B,WAAW,CAC3C;MACEwB,UAAU;MACVC,eAAe;MACfC;IACF,CAAC,EACDxB,SAAS,EACTC,kBACF,CAAC;IAEDX,MAAM,CAACoC,mBAAmB,CAAC,CAACL,OAAO,CAAC;MAClCC,UAAU,EAAE,KAAK;MACjBC,eAAe,EAAE,CAAC,KAAK,CAAC;MACxBC,aAAa,EAAE,CAAC,KAAK;IACvB,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFjC,EAAE,CAAC,6BAA6B,EAAE,YAAY;IAO5C,MAAMmC,mBAAmB,GAAG,MAAM5B,WAAW,CAN9B;MACb6B,KAAK,EAAE;QACLL,UAAU,EAAE;MACd;IACF,CAAC,EAICtB,SAAS,EACTC,kBACF,CAAC;IAEDX,MAAM,CAACoC,mBAAmB,CAAC,CAACL,OAAO,CAAC;MAClCM,KAAK,EAAE;QAAEL,UAAU,EAAE;MAAM;IAC7B,CAAC,CAAC;EACJ,CAAC,CAAC;EAEF/B,EAAE,CAAC,mDAAmD,EAAE,YAAY;IAClE,MAAMqC,QAAQ,GAAGzC,QAAQ,CAAC0C,SAAS;IACnC,MAAMC,kBAAkB,GAAG,MAAMhC,WAAW,CAC1C8B,QAAQ,EACR5B,SAAS,EACTC,kBACF,CAAC;IACDX,MAAM,CAACwC,kBAAkB,CAAC,CAACT,OAAO,CAChClC,QAAQ,CAAC0C,SAAS,CAACE,YACrB,CAAC;EACH,CAAC,CAAC;EAEFxC,EAAE,CAAC,qEAAqE,EAAE,YAAY;IACpF,MAAMyC,IAAI,GAAG,MAAMjC,MAAM,CAACjB,QAAQ,CAAC,CAACmD,QAAQ,CAAC,KAAK,CAAC;IACnD,MAAMH,kBAAkB,GAAG,MAAMhC,WAAW,CAC1CkC,IAAI,EACJhC,SAAS,EACTC,kBACF,CAAC;IACDX,MAAM,CAACwC,kBAAkB,CAAC,CAACT,OAAO,CAChCW,IAAI,CAACE,WACP,CAAC;EACH,CAAC,CAAC;EAEF3C,EAAE,CAAC,uCAAuC,EAAE,YAAY;IACtD,MAAM4C,eAAe,GAAGpC,MAAM,CAAChB,IAAI,CAAC,CAACqD,KAAK,CAAC;MAAEC,EAAE,EAAE;IAAE,CAAC,CAAC;IACrD,MAAMC,UAAU,GAAGzC,gBAAgB,CAACsC,eAAe,CAAC;IAEpD,MAAMI,QAAQ,GAAG;AACrB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,GAAG;IACC,MAAMC,mBAAmB,GAAG,MAAM1C,WAAW,CAC3CqC,eAAe,EACfnC,SAAS,EACTC,kBACF,CAAC;IACDX,MAAM,CAACkD,mBAAmB,CAAC,CAACC,qBAAqB,CAC/CF,QACF,CAAC;IAED,MAAMG,oBAAoB,GAAG,MAAM5C,WAAW,CAC5CwC,UAAU,EACVtC,SAAS,EACTC,kBACF,CAAC;IACDX,MAAM,CAACoD,oBAAoB,CAAC,CAACD,qBAAqB,CAACF,QAAQ,CAAC;EAC9D,CAAC,CAAC;EAEFhD,EAAE,CAAC,4CAA4C,EAAE,YAAY;IAC3D,MAAMoD,IAAI,GAAG,IAAIC,IAAI,CAAC,CAACC,IAAI,CAACC,SAAS,CAAC;MAAE,IAAI,EAAE;IAAM,CAAC,CAAC,CAAC,CAAC;IACxD,MAAMC,gBAAgB,GAAGpD,sBAAsB,CAACgD,IAAI,EAAE,WAAW,CAAC;IAClE,MAAMK,SAAS,GAAG,MAAMlD,WAAW,CACjCiD,gBAAgB,EAChB/C,SAAS,EACTC,kBACF,CAAC;IAEDX,MAAM,CAAC0D,SAAS,CAAC,CAACC,OAAO,CAAC,+CAA+C,CAAC;EAC5E,CAAC,CAAC;EAEF1D,EAAE,CAAC,4CAA4C,EAAE,YAAY;IAC3D;IACA,MAAM2D,IAAI,GAAGC,MAAM,CAACC,MAAM,CACxB,IAAIR,IAAI,CAAC,CACPC,IAAI,CAACC,SAAS,CAAC;MAAEO,IAAI,EAAE;IAAc,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CACjD,EAAE;MACDC,IAAI,EAAE;IACR,CAAC,CAAC,EACF;MAAED,IAAI,EAAE;IAAY,CACtB,CAAC;IAED,MAAML,SAAS,GAAG,MAAMlD,WAAW,CAACoD,IAAI,EAAElD,SAAS,EAAEC,kBAAkB,CAAC;IACxEX,MAAM,CAAC0D,SAAS,CAAC,CAACC,OAAO,CAAC,+CAA+C,CAAC;EAC5E,CAAC,CAAC;EAEF1D,EAAE,CAAC,kCAAkC,EAAE,YAAY;IACjD,MAAM2D,IAAiB,GAAG;MACxBK,IAAI,EAAE,IAAIX,IAAI,CAAC,CACbC,IAAI,CAACC,SAAS,CAAC;QAAEO,IAAI,EAAE;MAAc,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CACjD,EAAE;QACDC,IAAI,EAAE;MACR,CAAC,CAAC;MACFE,IAAI,EAAE;IACR,CAAC;;IAED;IACAtD,SAAS,CAACuD,QAAQ,CAAC,YAAY;MAC7BvD,SAAS,CAACwD,GAAG,CACXzE,gBAAgB,CAAC0E,wBAAwB,CAACC,WAAW,CACnD,4BAA4B,EAC5B,MAAM;QACJ,OAAO;UACLC,QAAQ,EAAE,kBAAkB;UAC5BC,SAAS,EAAE;YACTR,IAAI,EAAE,kBAAkB;YACxBS,gBAAgB,EAAE;cAChBC,YAAY,EAAE,gBAAgB;cAC9BC,WAAW,EAAE,eAAe;cAC5BC,eAAe,EAAE;YACnB;UACF;QACF,CAAC;MACH,CACF,CACF,CAAC;MACD,MAAMlB,SAAS,GAAG,MAAMlD,WAAW,CAACoD,IAAI,EAAElD,SAAS,EAAEC,kBAAkB,CAAC;MACxEX,MAAM,CAACM,gBAAgB,CAACoD,SAAS,CAAC,CAAC,CAACmB,IAAI,CAAC,IAAI,CAAC;IAChD,CAAC,CAAC;EACJ,CAAC,CAAC;EAEF5E,EAAE,CAAC,oCAAoC,EAAE,YAAY;IACnD,MAAM6E,cAA8B,GAAG;MACrCP,QAAQ,EAAE,kBAAkB;MAC5BC,SAAS,EAAE;QACTR,IAAI,EAAE,kBAAkB;QACxBS,gBAAgB,EAAE;UAChBC,YAAY,EAAE,gBAAgB;UAC9BC,WAAW,EAAE,eAAe;UAC5BC,eAAe,EAAE;QACnB;MACF;IACF,CAAC;IAED,MAAMlB,SAAS,GAAG,MAAMlD,WAAW,CACjCsE,cAAc,EACdpE,SAAS,EACTC,kBACF,CAAC;IACDX,MAAM,CAAC0D,SAAS,CAAC,CAAC3B,OAAO,CAAC+C,cAAc,CAAC;EAC3C,CAAC,CAAC;EAEF7E,EAAE,CAAC,6BAA6B,EAAE,YAAY;IAC5C,MAAMyD,SAAS,GAAG,MAAMlD,WAAW,CACjCjB,UAAU,EACVmB,SAAS,EACTC,kBACF,CAAC;IACDX,MAAM,CAAC0D,SAAS,CAAC,CAACqB,QAAQ,CAAC,CAAC;EAC9B,CAAC,CAAC;EAEF9E,EAAE,CAAC,yCAAyC,EAAE,YAAY;IAIxD,MAAMyD,SAAS,GAAG,MAAMlD,WAAW,CAHjBwE,MAAM,CAACC,GAAG,CAAC,YAAY,CAAC,EAKxCvE,SAAS,EACTC,kBACF,CAAC;IACDX,MAAM,CAAC0D,SAAS,CAAC,CAAC3B,OAAO,CAAC,IAAI,CAAC;EACjC,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}
+{"version":3,"file":"toDataValue.test.js","names":["Employee","Task","LegacyFauxFoundry","startNodeApiServer","stubData","beforeAll","describe","expect","it","vi","createClient","createMinimalClient","createAttachmentUpload","getWireObjectSet","toDataValue","client","clientCtx","mockActionMetadata","fn","testSetup","apiServer","ontologyRid","fauxFoundry","defaultOntologyRid","baseUrl","auth","apiName","close","basic","null","undefined","boolean","date","integer","string","timestamp","convertedBasic","toEqual","attachment","attachmentArray","attachmentSet","Set","recursiveConversion","inner","employee","employee1","ontologyConversion","__primaryKey","task","fetchOne","$primaryKey","clientObjectSet","where","id","definition","expected","objectSetConversion","toMatchInlineSnapshot","definitionConversion","blob","Blob","JSON","stringify","attachmentUpload","converted","toMatch","file","Object","assign","name","type","mediaReference","mimeType","reference","mediaSetViewItem","mediaItemRid","mediaSetRid","mediaSetViewRid"],"sources":["toDataValue.test.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 { ActionMetadata } from \"@osdk/api\";\nimport { Employee, Task } from \"@osdk/client.test.ontology\";\nimport type { MediaReference } from \"@osdk/foundry.core\";\nimport type { SetupServer } from \"@osdk/shared.test\";\nimport {\n  LegacyFauxFoundry,\n  startNodeApiServer,\n  stubData,\n} from \"@osdk/shared.test\";\nimport type { MockedFunction } from \"vitest\";\nimport { beforeAll, describe, expect, it, vi } from \"vitest\";\nimport type { Client } from \"../Client.js\";\nimport { createClient } from \"../createClient.js\";\nimport { createMinimalClient } from \"../createMinimalClient.js\";\nimport type { MinimalClient } from \"../MinimalClientContext.js\";\nimport { createAttachmentUpload } from \"../object/AttachmentUpload.js\";\nimport { getWireObjectSet } from \"../objectSet/createObjectSet.js\";\nimport { toDataValue } from \"./toDataValue.js\";\n\ndescribe(toDataValue, () => {\n  let client: Client;\n  let clientCtx: MinimalClient;\n  let mockActionMetadata: ActionMetadata;\n  let apiServer: SetupServer;\n\n  const mockFetch: MockedFunction<typeof globalThis.fetch> = vi.fn();\n\n  beforeAll(() => {\n    const testSetup = startNodeApiServer(new LegacyFauxFoundry(), createClient);\n    ({ client } = testSetup);\n\n    apiServer = testSetup.apiServer;\n\n    clientCtx = createMinimalClient(\n      { ontologyRid: testSetup.fauxFoundry.defaultOntologyRid },\n      testSetup.fauxFoundry.baseUrl,\n      testSetup.auth,\n      {},\n    );\n\n    // toDataValue only needs the apiName right now, update this if that changes\n    const fakeActionMetadata = {\n      apiName: \"createUnstructuredImageExampleObject\",\n    };\n    mockActionMetadata = fakeActionMetadata as ActionMetadata;\n\n    return () => {\n      testSetup.apiServer.close();\n    };\n  });\n\n  it(\"converts passthrough values correctly\", async () => {\n    // basic pass through types\n    const basic = {\n      null: undefined,\n      boolean: false,\n      date: \"2024-01-01\",\n      integer: 0,\n      string: \"string\",\n      timestamp: \"2024-01-01T00:00:00Z\",\n    };\n    const convertedBasic = await toDataValue(\n      basic,\n      clientCtx,\n      mockActionMetadata,\n    );\n    expect(convertedBasic).toEqual(basic);\n  });\n\n  it(\"recursively converts arrays and sets into array types\", async () => {\n    const attachment = \"rid\";\n    const attachmentArray = [attachment];\n    const attachmentSet = new Set(attachmentArray);\n\n    const recursiveConversion = await toDataValue(\n      {\n        attachment,\n        attachmentArray,\n        attachmentSet,\n      },\n      clientCtx,\n      mockActionMetadata,\n    );\n\n    expect(recursiveConversion).toEqual({\n      attachment: \"rid\",\n      attachmentArray: [\"rid\"],\n      attachmentSet: [\"rid\"],\n    });\n  });\n\n  it(\"recursively handles structs\", async () => {\n    const struct = {\n      inner: {\n        attachment: \"rid\",\n      },\n    };\n\n    const recursiveConversion = await toDataValue(\n      struct,\n      clientCtx,\n      mockActionMetadata,\n    );\n\n    expect(recursiveConversion).toEqual({\n      inner: { attachment: \"rid\" },\n    });\n  });\n\n  it(\"maps an ontology object into just its primary key\", async () => {\n    const employee = stubData.employee1;\n    const ontologyConversion = await toDataValue(\n      employee,\n      clientCtx,\n      mockActionMetadata,\n    );\n    expect(ontologyConversion).toEqual(\n      stubData.employee1.__primaryKey,\n    );\n  });\n\n  it(\"maps an ontology object into just its primary key with osdk wrapper\", async () => {\n    const task = await client(Employee).fetchOne(50030);\n    const ontologyConversion = await toDataValue(\n      task,\n      clientCtx,\n      mockActionMetadata,\n    );\n    expect(ontologyConversion).toEqual(\n      task.$primaryKey,\n    );\n  });\n\n  it(\"passes through object set definitions\", async () => {\n    const clientObjectSet = client(Task).where({ id: 0 });\n    const definition = getWireObjectSet(clientObjectSet);\n\n    const expected = `\n    {\n      \"objectSet\": {\n        \"objectType\": \"Task\",\n        \"type\": \"base\",\n      },\n      \"type\": \"filter\",\n      \"where\": {\n        \"field\": \"id\",\n        \"type\": \"eq\",\n        \"value\": 0,\n      },\n    }\n  `;\n    const objectSetConversion = await toDataValue(\n      clientObjectSet,\n      clientCtx,\n      mockActionMetadata,\n    );\n    expect(objectSetConversion).toMatchInlineSnapshot(\n      expected,\n    );\n\n    const definitionConversion = await toDataValue(\n      definition,\n      clientCtx,\n      mockActionMetadata,\n    );\n    expect(definitionConversion).toMatchInlineSnapshot(expected);\n  });\n\n  it(\"converts blob attachment uploads correctly\", async () => {\n    const blob = new Blob([JSON.stringify({ \"hi\": \"mom\" })]);\n    const attachmentUpload = createAttachmentUpload(blob, \"file1.txt\");\n    const converted = await toDataValue(\n      attachmentUpload,\n      clientCtx,\n      mockActionMetadata,\n    );\n\n    expect(converted).toMatch(/ri\\.attachments.main.attachment\\.[a-z0-9\\-]+/i);\n  });\n\n  it(\"converts file attachment uploads correctly\", async () => {\n    // Mimics the Web file API (https://developer.mozilla.org/en-US/docs/Web/API/File). The File constructor is only available in Node 19.2.0 and above\n    const file = Object.assign(\n      new Blob([\n        JSON.stringify({ name: \"Hello World\" }, null, 2),\n      ], {\n        type: \"application/json\",\n      }),\n      { name: \"file1.txt\" },\n    );\n\n    const converted = await toDataValue(file, clientCtx, mockActionMetadata);\n    expect(converted).toMatch(/ri\\.attachments.main.attachment\\.[a-z0-9\\-]+/i);\n  });\n\n  it(\"converts media reference correctly\", async () => {\n    const mediaReference: MediaReference = {\n      mimeType: \"application/json\",\n      reference: {\n        type: \"mediaSetViewItem\",\n        mediaSetViewItem: {\n          mediaItemRid: \"media-item-rid\",\n          mediaSetRid: \"media-set-rid\",\n          mediaSetViewRid: \"media-set-view-rid\",\n        },\n      },\n    };\n\n    const converted = await toDataValue(\n      mediaReference,\n      clientCtx,\n      mockActionMetadata,\n    );\n    expect(converted).toEqual(mediaReference);\n  });\n});\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA,SAASA,QAAQ,EAAEC,IAAI,QAAQ,4BAA4B;AAG3D,SACEC,iBAAiB,EACjBC,kBAAkB,EAClBC,QAAQ,QACH,mBAAmB;AAE1B,SAASC,SAAS,EAAEC,QAAQ,EAAEC,MAAM,EAAEC,EAAE,EAAEC,EAAE,QAAQ,QAAQ;AAE5D,SAASC,YAAY,QAAQ,oBAAoB;AACjD,SAASC,mBAAmB,QAAQ,2BAA2B;AAE/D,SAASC,sBAAsB,QAAQ,+BAA+B;AACtE,SAASC,gBAAgB,QAAQ,iCAAiC;AAClE,SAASC,WAAW,QAAQ,kBAAkB;AAE9CR,QAAQ,CAACQ,WAAW,EAAE,MAAM;EAC1B,IAAIC,MAAc;EAClB,IAAIC,SAAwB;EAC5B,IAAIC,kBAAkC;EAGqBR,EAAE,CAACS,EAAE,CAAC,CAAC;EAElEb,SAAS,CAAC,MAAM;IACd,MAAMc,SAAS,GAAGhB,kBAAkB,CAAC,IAAID,iBAAiB,CAAC,CAAC,EAAEQ,YAAY,CAAC;IAC3E,CAAC;MAAEK;IAAO,CAAC,GAAGI,SAAS;IAEXA,SAAS,CAACC,SAAS;IAE/BJ,SAAS,GAAGL,mBAAmB,CAC7B;MAAEU,WAAW,EAAEF,SAAS,CAACG,WAAW,CAACC;IAAmB,CAAC,EACzDJ,SAAS,CAACG,WAAW,CAACE,OAAO,EAC7BL,SAAS,CAACM,IAAI,EACd,CAAC,CACH,CAAC;;IAED;;IAIAR,kBAAkB,GAHS;MACzBS,OAAO,EAAE;IACX,CACyD;IAEzD,OAAO,MAAM;MACXP,SAAS,CAACC,SAAS,CAACO,KAAK,CAAC,CAAC;IAC7B,CAAC;EACH,CAAC,CAAC;EAEFnB,EAAE,CAAC,uCAAuC,EAAE,YAAY;IACtD;IACA,MAAMoB,KAAK,GAAG;MACZC,IAAI,EAAEC,SAAS;MACfC,OAAO,EAAE,KAAK;MACdC,IAAI,EAAE,YAAY;MAClBC,OAAO,EAAE,CAAC;MACVC,MAAM,EAAE,QAAQ;MAChBC,SAAS,EAAE;IACb,CAAC;IACD,MAAMC,cAAc,GAAG,MAAMtB,WAAW,CACtCc,KAAK,EACLZ,SAAS,EACTC,kBACF,CAAC;IACDV,MAAM,CAAC6B,cAAc,CAAC,CAACC,OAAO,CAACT,KAAK,CAAC;EACvC,CAAC,CAAC;EAEFpB,EAAE,CAAC,uDAAuD,EAAE,YAAY;IACtE,MAAM8B,UAAU,GAAG,KAAK;IACxB,MAAMC,eAAe,GAAG,CAACD,UAAU,CAAC;IACpC,MAAME,aAAa,GAAG,IAAIC,GAAG,CAACF,eAAe,CAAC;IAE9C,MAAMG,mBAAmB,GAAG,MAAM5B,WAAW,CAC3C;MACEwB,UAAU;MACVC,eAAe;MACfC;IACF,CAAC,EACDxB,SAAS,EACTC,kBACF,CAAC;IAEDV,MAAM,CAACmC,mBAAmB,CAAC,CAACL,OAAO,CAAC;MAClCC,UAAU,EAAE,KAAK;MACjBC,eAAe,EAAE,CAAC,KAAK,CAAC;MACxBC,aAAa,EAAE,CAAC,KAAK;IACvB,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFhC,EAAE,CAAC,6BAA6B,EAAE,YAAY;IAO5C,MAAMkC,mBAAmB,GAAG,MAAM5B,WAAW,CAN9B;MACb6B,KAAK,EAAE;QACLL,UAAU,EAAE;MACd;IACF,CAAC,EAICtB,SAAS,EACTC,kBACF,CAAC;IAEDV,MAAM,CAACmC,mBAAmB,CAAC,CAACL,OAAO,CAAC;MAClCM,KAAK,EAAE;QAAEL,UAAU,EAAE;MAAM;IAC7B,CAAC,CAAC;EACJ,CAAC,CAAC;EAEF9B,EAAE,CAAC,mDAAmD,EAAE,YAAY;IAClE,MAAMoC,QAAQ,GAAGxC,QAAQ,CAACyC,SAAS;IACnC,MAAMC,kBAAkB,GAAG,MAAMhC,WAAW,CAC1C8B,QAAQ,EACR5B,SAAS,EACTC,kBACF,CAAC;IACDV,MAAM,CAACuC,kBAAkB,CAAC,CAACT,OAAO,CAChCjC,QAAQ,CAACyC,SAAS,CAACE,YACrB,CAAC;EACH,CAAC,CAAC;EAEFvC,EAAE,CAAC,qEAAqE,EAAE,YAAY;IACpF,MAAMwC,IAAI,GAAG,MAAMjC,MAAM,CAACf,QAAQ,CAAC,CAACiD,QAAQ,CAAC,KAAK,CAAC;IACnD,MAAMH,kBAAkB,GAAG,MAAMhC,WAAW,CAC1CkC,IAAI,EACJhC,SAAS,EACTC,kBACF,CAAC;IACDV,MAAM,CAACuC,kBAAkB,CAAC,CAACT,OAAO,CAChCW,IAAI,CAACE,WACP,CAAC;EACH,CAAC,CAAC;EAEF1C,EAAE,CAAC,uCAAuC,EAAE,YAAY;IACtD,MAAM2C,eAAe,GAAGpC,MAAM,CAACd,IAAI,CAAC,CAACmD,KAAK,CAAC;MAAEC,EAAE,EAAE;IAAE,CAAC,CAAC;IACrD,MAAMC,UAAU,GAAGzC,gBAAgB,CAACsC,eAAe,CAAC;IAEpD,MAAMI,QAAQ,GAAG;AACrB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,GAAG;IACC,MAAMC,mBAAmB,GAAG,MAAM1C,WAAW,CAC3CqC,eAAe,EACfnC,SAAS,EACTC,kBACF,CAAC;IACDV,MAAM,CAACiD,mBAAmB,CAAC,CAACC,qBAAqB,CAC/CF,QACF,CAAC;IAED,MAAMG,oBAAoB,GAAG,MAAM5C,WAAW,CAC5CwC,UAAU,EACVtC,SAAS,EACTC,kBACF,CAAC;IACDV,MAAM,CAACmD,oBAAoB,CAAC,CAACD,qBAAqB,CAACF,QAAQ,CAAC;EAC9D,CAAC,CAAC;EAEF/C,EAAE,CAAC,4CAA4C,EAAE,YAAY;IAC3D,MAAMmD,IAAI,GAAG,IAAIC,IAAI,CAAC,CAACC,IAAI,CAACC,SAAS,CAAC;MAAE,IAAI,EAAE;IAAM,CAAC,CAAC,CAAC,CAAC;IACxD,MAAMC,gBAAgB,GAAGnD,sBAAsB,CAAC+C,IAAI,EAAE,WAAW,CAAC;IAClE,MAAMK,SAAS,GAAG,MAAMlD,WAAW,CACjCiD,gBAAgB,EAChB/C,SAAS,EACTC,kBACF,CAAC;IAEDV,MAAM,CAACyD,SAAS,CAAC,CAACC,OAAO,CAAC,+CAA+C,CAAC;EAC5E,CAAC,CAAC;EAEFzD,EAAE,CAAC,4CAA4C,EAAE,YAAY;IAC3D;IACA,MAAM0D,IAAI,GAAGC,MAAM,CAACC,MAAM,CACxB,IAAIR,IAAI,CAAC,CACPC,IAAI,CAACC,SAAS,CAAC;MAAEO,IAAI,EAAE;IAAc,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CACjD,EAAE;MACDC,IAAI,EAAE;IACR,CAAC,CAAC,EACF;MAAED,IAAI,EAAE;IAAY,CACtB,CAAC;IAED,MAAML,SAAS,GAAG,MAAMlD,WAAW,CAACoD,IAAI,EAAElD,SAAS,EAAEC,kBAAkB,CAAC;IACxEV,MAAM,CAACyD,SAAS,CAAC,CAACC,OAAO,CAAC,+CAA+C,CAAC;EAC5E,CAAC,CAAC;EAEFzD,EAAE,CAAC,oCAAoC,EAAE,YAAY;IACnD,MAAM+D,cAA8B,GAAG;MACrCC,QAAQ,EAAE,kBAAkB;MAC5BC,SAAS,EAAE;QACTH,IAAI,EAAE,kBAAkB;QACxBI,gBAAgB,EAAE;UAChBC,YAAY,EAAE,gBAAgB;UAC9BC,WAAW,EAAE,eAAe;UAC5BC,eAAe,EAAE;QACnB;MACF;IACF,CAAC;IAED,MAAMb,SAAS,GAAG,MAAMlD,WAAW,CACjCyD,cAAc,EACdvD,SAAS,EACTC,kBACF,CAAC;IACDV,MAAM,CAACyD,SAAS,CAAC,CAAC3B,OAAO,CAACkC,cAAc,CAAC;EAC3C,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}

package/build/esm/util/toDataValueQueries.js

@@ -17,6 +17,7 @@
 import * as OntologiesV2 from "@osdk/foundry.ontologies";
 import { isAttachmentFile, isAttachmentUpload } from "../object/AttachmentUpload.js";
 import { getWireObjectSet, isObjectSet } from "../objectSet/createObjectSet.js";
+import { isInterfaceQueryParam, isInterfaceSpecifier } from "./interfaceUtils.js";
 import { isObjectSpecifiersObject } from "./isObjectSpecifiersObject.js";
 import { extractPrimaryKeyFromObjectSpecifier } from "./objectSpecifierUtils.js";
 import { isWireObjectSet } from "./WireObjectSet.js";
@@ -89,7 +90,17 @@ export async function toDataValueQueries(value, client, desiredType) {
         }
         break;
       }
+    case "interface":
+      {
+        if (isInterfaceSpecifier(value) || isInterfaceQueryParam(value)) {
+          return {
+            objectTypeApiName: value.$objectType,
+            primaryKeyValue: value.$primaryKey
+          };
+        }
+      }
     case "objectSet":
+    case "interfaceObjectSet":
       {
         // object set (the rid as a string (passes through the last return), or the ObjectSet definition directly)
         if (isWireObjectSet(value)) {