@osdk/client 2.4.0-beta.11 → 2.4.0-beta.13

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @osdk/client
 
+## 2.4.0-beta.13
+
+### Minor Changes
+
+- 4bc848b: Add interface link support.
+
+### Patch Changes
+
+- Updated dependencies [4bc848b]
+  - @osdk/generator-converters@2.4.0-beta.13
+  - @osdk/api@2.4.0-beta.13
+  - @osdk/client.unstable@2.4.0-beta.13
+
+## 2.4.0-beta.12
+
+### Minor Changes
+
+- 402eb67: Fix hydrate to support interface object sets.
+
+### Patch Changes
+
+- @osdk/api@2.4.0-beta.12
+- @osdk/client.unstable@2.4.0-beta.12
+- @osdk/generator-converters@2.4.0-beta.12
+
 ## 2.4.0-beta.11
 
 ### Patch Changes

package/build/browser/fetchMetadata.test.js

@@ -168,7 +168,13 @@ describe("FetchMetadata", () => {
           "Person",
         ],
         "implements": [],
-        "links": {},
+        "links": {
+          "toBar": {
+            "multiplicity": true,
+            "targetType": "interface",
+            "targetTypeApiName": "BarInterface",
+          },
+        },
         "properties": {
           "fooSpt": {
             "description": "A foo",

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

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

package/build/browser/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["isOk","NULL_VALUE","PalantirApiError","ActionValidationError","createClient","createPlatformClient","createAttachmentUpload","extractDate","extractDateInLocalTime","extractDateInUTC"],"sources":["index.ts"],"sourcesContent":["/*\n * Copyright 2023 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nexport type {\n  ActionDefinition,\n  ActionEditResponse,\n  ActionMetadata,\n  ActionParam,\n  ActionReturnTypeForOptions,\n  ActionValidationResponse,\n  ApplyActionOptions,\n  ApplyBatchActionOptions,\n  Attachment,\n  CompileTimeMetadata,\n  InterfaceDefinition,\n  Logger,\n  ObjectMetadata,\n  ObjectSet,\n  ObjectSpecifier,\n  ObjectTypeDefinition,\n  Osdk,\n  OsdkObject,\n  OsdkObjectCreatePropertyType,\n  OsdkObjectPropertyType,\n  PageResult,\n  PropertyDef,\n  PropertyKeys,\n  PropertyValueWireToClient,\n  QueryDefinition,\n  QueryParam,\n  QueryResult,\n  Range,\n  Result,\n  SingleLinkAccessor,\n  ThreeDimensionalAggregation,\n  TwoDimensionalAggregation,\n  VersionBound,\n  WhereClause,\n} from \"@osdk/api\";\nexport { isOk, NULL_VALUE } from \"@osdk/api\";\nexport { PalantirApiError } from \"@osdk/shared.net.errors\";\n\nexport { ActionValidationError } from \"./actions/ActionValidationError.js\";\nexport type { Client } from \"./Client.js\";\nexport { createClient } from \"./createClient.js\";\nexport { createPlatformClient } from \"./createPlatformClient.js\";\nexport type { PlatformClient } from \"./createPlatformClient.js\";\nexport { createAttachmentUpload } from \"./object/AttachmentUpload.js\";\nexport type { ResultOrError } from \"./ResultOrError.js\";\n\nexport {\n  extractDate,\n  extractDateInLocalTime,\n  extractDateInUTC,\n} from \"./util/datetimeConverters.js\";\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAsCA,SAASA,IAAI,EAAEC,UAAU,QAAQ,WAAW;AAC5C,SAASC,gBAAgB,QAAQ,yBAAyB;AAE1D,SAASC,qBAAqB,QAAQ,oCAAoC;AAE1E,SAASC,YAAY,QAAQ,mBAAmB;AAChD,SAASC,oBAAoB,QAAQ,2BAA2B;AAEhE,SAASC,sBAAsB,QAAQ,8BAA8B;AAGrE,SACEC,WAAW,EACXC,sBAAsB,EACtBC,gBAAgB,QACX,8BAA8B","ignoreList":[]}
+{"version":3,"file":"index.js","names":["isOk","NULL_VALUE","PalantirApiError","ActionValidationError","createClient","createPlatformClient","createAttachmentUpload","extractDate","extractDateInLocalTime","extractDateInUTC"],"sources":["index.ts"],"sourcesContent":["/*\n * Copyright 2023 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nexport type {\n  ActionDefinition,\n  ActionEditResponse,\n  ActionMetadata,\n  ActionParam,\n  ActionReturnTypeForOptions,\n  ActionValidationResponse,\n  ApplyActionOptions,\n  ApplyBatchActionOptions,\n  Attachment,\n  CompileTimeMetadata,\n  InterfaceDefinition,\n  InterfaceMetadata,\n  Logger,\n  ObjectMetadata,\n  ObjectSet,\n  ObjectSpecifier,\n  ObjectTypeDefinition,\n  Osdk,\n  OsdkObject,\n  OsdkObjectCreatePropertyType,\n  OsdkObjectPropertyType,\n  PageResult,\n  PropertyDef,\n  PropertyKeys,\n  PropertyValueWireToClient,\n  QueryDefinition,\n  QueryParam,\n  QueryResult,\n  Range,\n  Result,\n  SingleLinkAccessor,\n  ThreeDimensionalAggregation,\n  TwoDimensionalAggregation,\n  VersionBound,\n  WhereClause,\n} from \"@osdk/api\";\nexport { isOk, NULL_VALUE } from \"@osdk/api\";\nexport { PalantirApiError } from \"@osdk/shared.net.errors\";\n\nexport { ActionValidationError } from \"./actions/ActionValidationError.js\";\nexport type { Client } from \"./Client.js\";\nexport { createClient } from \"./createClient.js\";\nexport { createPlatformClient } from \"./createPlatformClient.js\";\nexport type { PlatformClient } from \"./createPlatformClient.js\";\nexport { createAttachmentUpload } from \"./object/AttachmentUpload.js\";\nexport type { ResultOrError } from \"./ResultOrError.js\";\n\nexport {\n  extractDate,\n  extractDateInLocalTime,\n  extractDateInUTC,\n} from \"./util/datetimeConverters.js\";\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAuCA,SAASA,IAAI,EAAEC,UAAU,QAAQ,WAAW;AAC5C,SAASC,gBAAgB,QAAQ,yBAAyB;AAE1D,SAASC,qBAAqB,QAAQ,oCAAoC;AAE1E,SAASC,YAAY,QAAQ,mBAAmB;AAChD,SAASC,oBAAoB,QAAQ,2BAA2B;AAEhE,SAASC,sBAAsB,QAAQ,8BAA8B;AAGrE,SACEC,WAAW,EACXC,sBAAsB,EACtBC,gBAAgB,QACX,8BAA8B","ignoreList":[]}

package/build/browser/object/convertWireToOsdkObjects.js

@@ -72,11 +72,12 @@ export async function convertWireToOsdkObjects(client, objects, interfaceApiName
  */
 export async function convertWireToOsdkObjects2(client, objects, interfaceApiName, derivedPropertyTypeByName, forceRemoveRid = false, selectedProps, strictNonNull = false, interfaceToObjectTypeMappings = {}) {
   fixObjectPropertiesInPlace(objects, forceRemoveRid);
+  const isInterfaceScoped = Object.keys(interfaceToObjectTypeMappings).length > 0;
   const ret = [];
   for (const rawObj of objects) {
     const objectDef = await client.ontologyProvider.getObjectDefinition(rawObj.$apiName);
     !objectDef ? process.env.NODE_ENV !== "production" ? invariant(false, `Missing definition for '${rawObj.$apiName}'`) : invariant(false) : void 0;
-    const interfaceToObjMapping = interfaceApiName ? interfaceToObjectTypeMappings[interfaceApiName][rawObj.$apiName] : undefined;
+    const interfaceToObjMapping = interfaceApiName && isInterfaceScoped ? interfaceToObjectTypeMappings[interfaceApiName][rawObj.$apiName] : undefined;
     const ifaceSelected = interfaceApiName && interfaceToObjMapping ? selectedProps ? Object.keys(interfaceToObjMapping).filter(val => {
       selectedProps?.includes(interfaceToObjMapping[val]);
     }) : [...Object.values(interfaceToObjMapping), objectDef.primaryKeyApiName] : undefined;
@@ -97,7 +98,7 @@ export async function convertWireToOsdkObjects2(client, objects, interfaceApiNam
       continue;
     }
     let osdkObject = createOsdkObject(client, objectDef, rawObj, derivedPropertyTypeByName);
-    if (interfaceApiName) osdkObject = osdkObject.$as(interfaceApiName);
+    if (interfaceApiName && isInterfaceScoped) osdkObject = osdkObject.$as(interfaceApiName);
     ret.push(osdkObject);
   }
   return ret;

package/build/browser/object/convertWireToOsdkObjects.js.map

@@ -1 +1 @@
-{"version":3,"file":"convertWireToOsdkObjects.js","names":["invariant","createOsdkObject","convertWireToOsdkObjects","client","objects","interfaceApiName","forceRemoveRid","derivedPropertyTypesByName","selectedProps","strictNonNull","fixObjectPropertiesInPlace","ifaceDef","ontologyProvider","getInterfaceDefinition","undefined","ifaceSelected","Object","keys","properties","ret","rawObj","objectDef","getObjectDefinition","$apiName","process","env","NODE_ENV","objProps","conforming","invariantInterfacesAsViews","apiName","isConforming","reframeAsObjectInPlace","convertInterfacePropNamesToObjectPropNames","Error","osdkObject","$as","push","convertWireToOsdkObjects2","derivedPropertyTypeByName","interfaceToObjectTypeMappings","interfaceToObjMapping","filter","val","includes","values","primaryKeyApiName","ifacePropsToMap","map","ifaceProp","interfaceMap","newProps","sptProp","regularProp","entries","value","assign","$primaryKey","def","obj","propsToCheck","propName","nullable","logger","debug","$objectType","warning","warn","console","error","objs","__rid","$rid","__apiName","__primaryKey","$title","__title"],"sources":["convertWireToOsdkObjects.ts"],"sourcesContent":["/*\n * Copyright 2023 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n  InterfaceMetadata,\n  NullabilityAdherence,\n  ObjectMetadata,\n} from \"@osdk/api\";\nimport type {\n  InterfaceToObjectTypeMappings,\n  InterfaceTypeApiName,\n  OntologyObjectV2,\n} from \"@osdk/foundry.ontologies\";\nimport invariant from \"tiny-invariant\";\nimport type { DerivedPropertyRuntimeMetadata } from \"../derivedProperties/derivedPropertyRuntimeMetadata.js\";\nimport type { MinimalClient } from \"../MinimalClientContext.js\";\nimport {\n  type FetchedObjectTypeDefinition,\n} from \"../ontology/OntologyProvider.js\";\nimport { createOsdkObject } from \"./convertWireToOsdkObjects/createOsdkObject.js\";\nimport type { InterfaceHolder } from \"./convertWireToOsdkObjects/InterfaceHolder.js\";\nimport type { ObjectHolder } from \"./convertWireToOsdkObjects/ObjectHolder.js\";\nimport type { SimpleOsdkProperties } from \"./SimpleOsdkProperties.js\";\n\n/**\n * If interfaceApiName is not undefined, converts the instances of the\n * interface into their respective\n * underlying concrete types and then returns the $as() representation\n * for the consumers.\n *\n * Otherwise just does the conversion\n *\n * May mutate in place for performance reasons. If you need a clean copy,\n * keep it first.\n *\n * However, you must use the returned value, which will be whatever is correct.\n *\n * @internal\n * @param interfaceApiName - if undefined\n */\nexport async function convertWireToOsdkObjects(\n  client: MinimalClient,\n  objects: OntologyObjectV2[],\n  interfaceApiName: string | undefined,\n  forceRemoveRid: boolean = false,\n  derivedPropertyTypesByName: DerivedPropertyRuntimeMetadata,\n  selectedProps?: ReadonlyArray<string>,\n  strictNonNull: NullabilityAdherence = false,\n): Promise<Array<ObjectHolder | InterfaceHolder>> {\n  // remove the __ prefixed properties and convert them to $ prefixed.\n  // updates in place\n  fixObjectPropertiesInPlace(objects, forceRemoveRid);\n\n  const ifaceDef = interfaceApiName\n    ? await client.ontologyProvider.getInterfaceDefinition(interfaceApiName)\n    : undefined;\n  const ifaceSelected = ifaceDef\n    ? (selectedProps ?? Object.keys(ifaceDef.properties))\n    : undefined;\n\n  const ret = [];\n  for (const rawObj of objects) {\n    const objectDef = await client.ontologyProvider.getObjectDefinition(\n      rawObj.$apiName,\n    );\n    invariant(objectDef, `Missing definition for '${rawObj.$apiName}'`);\n\n    // default value for when we are checking an object\n    let objProps;\n\n    let conforming = true;\n    if (ifaceDef && ifaceSelected) {\n      // API returns interface spt names but we cache by real values\n      invariantInterfacesAsViews(objectDef, ifaceDef.apiName, client);\n\n      conforming &&= isConforming(client, ifaceDef, rawObj, ifaceSelected);\n\n      reframeAsObjectInPlace(objectDef, ifaceDef.apiName, rawObj);\n\n      objProps = convertInterfacePropNamesToObjectPropNames(\n        objectDef,\n        ifaceDef.apiName,\n        ifaceSelected,\n      );\n    } else {\n      objProps = selectedProps ?? Object.keys(objectDef.properties);\n    }\n\n    conforming &&= isConforming(client, objectDef, rawObj, objProps);\n\n    if (strictNonNull === \"throw\" && !conforming) {\n      throw new Error(\n        \"Unable to safely convert objects as some non nullable properties are null\",\n      );\n    } else if (strictNonNull === \"drop\" && !conforming) {\n      continue;\n    }\n\n    let osdkObject: ObjectHolder | InterfaceHolder = createOsdkObject(\n      client,\n      objectDef,\n      rawObj,\n      derivedPropertyTypesByName,\n    );\n    if (interfaceApiName) osdkObject = osdkObject.$as(interfaceApiName);\n\n    ret.push(osdkObject);\n  }\n\n  return ret;\n}\n\nexport async function convertWireToOsdkObjects2(\n  client: MinimalClient,\n  objects: OntologyObjectV2[],\n  interfaceApiName: string,\n  derivedPropertyTypeByName: DerivedPropertyRuntimeMetadata,\n  forceRemoveRid?: boolean,\n  selectedProps?: ReadonlyArray<string>,\n  strictNonNull?: NullabilityAdherence,\n  interfaceToObjectTypeMappings?: Record<\n    InterfaceTypeApiName,\n    InterfaceToObjectTypeMappings\n  >,\n): Promise<Array<InterfaceHolder>>;\nexport async function convertWireToOsdkObjects2(\n  client: MinimalClient,\n  objects: OntologyObjectV2[],\n  interfaceApiName: undefined,\n  derivedPropertyTypeByName: DerivedPropertyRuntimeMetadata,\n  forceRemoveRid?: boolean,\n  selectedProps?: ReadonlyArray<string>,\n  strictNonNull?: NullabilityAdherence,\n  interfaceToObjectTypeMappings?: Record<\n    InterfaceTypeApiName,\n    InterfaceToObjectTypeMappings\n  >,\n): Promise<Array<ObjectHolder>>;\nexport async function convertWireToOsdkObjects2(\n  client: MinimalClient,\n  objects: OntologyObjectV2[],\n  interfaceApiName: string | undefined,\n  derivedPropertyTypeByName: DerivedPropertyRuntimeMetadata,\n  forceRemoveRid?: boolean,\n  selectedProps?: ReadonlyArray<string>,\n  strictNonNull?: NullabilityAdherence,\n  interfaceToObjectTypeMappings?: Record<\n    InterfaceTypeApiName,\n    InterfaceToObjectTypeMappings\n  >,\n): Promise<Array<ObjectHolder | InterfaceHolder>>;\n/**\n * @internal\n */\nexport async function convertWireToOsdkObjects2(\n  client: MinimalClient,\n  objects: OntologyObjectV2[],\n  interfaceApiName: string | undefined,\n  derivedPropertyTypeByName: DerivedPropertyRuntimeMetadata,\n  forceRemoveRid: boolean = false,\n  selectedProps?: ReadonlyArray<string>,\n  strictNonNull: NullabilityAdherence = false,\n  interfaceToObjectTypeMappings: Record<\n    InterfaceTypeApiName,\n    InterfaceToObjectTypeMappings\n  > = {},\n): Promise<Array<ObjectHolder | InterfaceHolder>> {\n  fixObjectPropertiesInPlace(objects, forceRemoveRid);\n\n  const ret = [];\n  for (const rawObj of objects) {\n    const objectDef = await client.ontologyProvider.getObjectDefinition(\n      rawObj.$apiName,\n    );\n    invariant(objectDef, `Missing definition for '${rawObj.$apiName}'`);\n\n    const interfaceToObjMapping = interfaceApiName\n      ? interfaceToObjectTypeMappings[interfaceApiName as InterfaceTypeApiName][\n        rawObj.$apiName\n      ]\n      : undefined;\n\n    const ifaceSelected = interfaceApiName && interfaceToObjMapping\n      ? (selectedProps\n        ? Object.keys(interfaceToObjMapping).filter(\n          val => {\n            selectedProps?.includes(interfaceToObjMapping[val]);\n          },\n        )\n        : [\n          ...Object.values(interfaceToObjMapping),\n          objectDef.primaryKeyApiName,\n        ])\n      : undefined;\n\n    // default value for when we are checking an object\n    let objProps;\n\n    let conforming = true;\n    if (interfaceApiName && ifaceSelected) {\n      invariantInterfacesAsViews(objectDef, interfaceApiName, client);\n\n      objProps = ifaceSelected;\n    } else {\n      objProps = selectedProps ?? Object.keys(objectDef.properties);\n    }\n\n    conforming &&= isConforming(client, objectDef, rawObj, objProps);\n\n    if (strictNonNull === \"throw\" && !conforming) {\n      throw new Error(\n        \"Unable to safely convert objects as some non nullable properties are null\",\n      );\n    } else if (strictNonNull === \"drop\" && !conforming) {\n      continue;\n    }\n\n    let osdkObject: ObjectHolder | InterfaceHolder = createOsdkObject(\n      client,\n      objectDef,\n      rawObj,\n      derivedPropertyTypeByName,\n    );\n    if (interfaceApiName) osdkObject = osdkObject.$as(interfaceApiName);\n\n    ret.push(osdkObject);\n  }\n\n  return ret;\n}\n\n/**\n * @internal\n *\n * Utility function that lets us take down selected property names from an interface\n * and convert them to an array of property names on an object.\n */\nexport function convertInterfacePropNamesToObjectPropNames(\n  objectDef: FetchedObjectTypeDefinition,\n  interfaceApiName: string,\n  ifacePropsToMap: readonly string[],\n): string[] {\n  return ifacePropsToMap.map((ifaceProp) =>\n    objectDef.interfaceMap[interfaceApiName][ifaceProp]\n  );\n}\n\n/**\n * Takes a raw object from the wire (contextually as an interface) and\n * updates the fields to reflect the underlying objectDef instead\n * @param objectDef\n * @param interfaceApiName\n * @param client\n * @param rawObj\n */\nfunction reframeAsObjectInPlace(\n  objectDef: FetchedObjectTypeDefinition,\n  interfaceApiName: string,\n  rawObj: OntologyObjectV2,\n) {\n  const newProps: Record<string, any> = {};\n  for (\n    const [sptProp, regularProp] of Object.entries(\n      objectDef.interfaceMap[interfaceApiName],\n    )\n  ) {\n    if (sptProp in rawObj) {\n      const value = rawObj[sptProp];\n      delete rawObj[sptProp];\n      if (value !== undefined) {\n        newProps[regularProp] = value;\n      }\n    }\n  }\n  Object.assign(rawObj, newProps);\n\n  if (!(objectDef.primaryKeyApiName in rawObj)) {\n    rawObj[objectDef.primaryKeyApiName] = rawObj.$primaryKey;\n  }\n}\n\nfunction isConforming(\n  client: MinimalClient,\n  def:\n    | InterfaceMetadata\n    | ObjectMetadata,\n  obj: OntologyObjectV2,\n  propsToCheck: readonly string[],\n) {\n  for (const propName of propsToCheck) {\n    if (\n      propName in def.properties && def.properties[propName].nullable === false\n      && obj[propName] == null\n    ) {\n      if (process.env.NODE_ENV !== \"production\") {\n        client.logger?.debug(\n          {\n            obj: {\n              $apiName: obj[\"$apiName\"],\n              $objectType: obj[\"$objectType\"],\n              $primaryKey: obj[\"$primaryKey\"],\n            },\n          },\n          `Found object that does not conform to its definition. Expected ${def.apiName}'s ${propName} to not be null.`,\n        );\n      }\n      return false;\n    }\n  }\n  return true;\n}\n\nfunction invariantInterfacesAsViews(\n  objectDef: FetchedObjectTypeDefinition,\n  interfaceApiName: string,\n  client: MinimalClient,\n): asserts objectDef is typeof objectDef & { interfaceMap: {} } {\n  if (objectDef.interfaceMap?.[interfaceApiName] == null) {\n    const warning =\n      \"Interfaces are only supported 'as views' but your metadata object is missing the correct information. This suggests your interfaces have not been migrated to the newer version yet and you cannot use this version of the SDK.\";\n    if (client.logger) {\n      client.logger.warn(warning);\n    } else {\n      // eslint-disable-next-line no-console\n      console.error(`WARNING! ${warning}`);\n    }\n    throw new Error(warning);\n  }\n}\n\nfunction fixObjectPropertiesInPlace(\n  objs: OntologyObjectV2[],\n  forceRemoveRid: boolean,\n): asserts objs is SimpleOsdkProperties[] {\n  for (const obj of objs) {\n    if (forceRemoveRid) {\n      delete obj.__rid;\n    }\n\n    if (obj.__rid) {\n      obj.$rid = obj.__rid;\n      delete obj.__rid;\n    }\n\n    // Backend returns as __apiName but we want to stick to $ structure\n    obj.$apiName ??= obj.__apiName;\n\n    // for now these are the same but when we start doing interface projections the $objectType will always be underlying and\n    // the $apiName will be for the current view (in current designs)\n    obj.$objectType = obj.$apiName;\n\n    // copying over for now as its always returned. In the future, this should just be inferred from underlying\n    obj.$primaryKey ??= obj.__primaryKey;\n    obj.$title ??= obj.__title;\n\n    // we don't want people to use these\n    delete obj.__apiName;\n    delete obj.__primaryKey;\n    delete obj.__title;\n  }\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAYA,OAAOA,SAAS,MAAM,gBAAgB;AAMtC,SAASC,gBAAgB,QAAQ,gDAAgD;AAKjF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeC,wBAAwBA,CAC5CC,MAAqB,EACrBC,OAA2B,EAC3BC,gBAAoC,EACpCC,cAAuB,GAAG,KAAK,EAC/BC,0BAA0D,EAC1DC,aAAqC,EACrCC,aAAmC,GAAG,KAAK,EACK;EAChD;EACA;EACAC,0BAA0B,CAACN,OAAO,EAAEE,cAAc,CAAC;EAEnD,MAAMK,QAAQ,GAAGN,gBAAgB,GAC7B,MAAMF,MAAM,CAACS,gBAAgB,CAACC,sBAAsB,CAACR,gBAAgB,CAAC,GACtES,SAAS;EACb,MAAMC,aAAa,GAAGJ,QAAQ,GACzBH,aAAa,IAAIQ,MAAM,CAACC,IAAI,CAACN,QAAQ,CAACO,UAAU,CAAC,GAClDJ,SAAS;EAEb,MAAMK,GAAG,GAAG,EAAE;EACd,KAAK,MAAMC,MAAM,IAAIhB,OAAO,EAAE;IAC5B,MAAMiB,SAAS,GAAG,MAAMlB,MAAM,CAACS,gBAAgB,CAACU,mBAAmB,CACjEF,MAAM,CAACG,QACT,CAAC;IACD,CAAUF,SAAS,GAAAG,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAAnB1B,SAAS,QAAY,2BAA2BoB,MAAM,CAACG,QAAQ,GAAG,IAAlEvB,SAAS;;IAET;IACA,IAAI2B,QAAQ;IAEZ,IAAIC,UAAU,GAAG,IAAI;IACrB,IAAIjB,QAAQ,IAAII,aAAa,EAAE;MAC7B;MACAc,0BAA0B,CAACR,SAAS,EAAEV,QAAQ,CAACmB,OAAO,EAAE3B,MAAM,CAAC;MAE/DyB,UAAU,KAAKG,YAAY,CAAC5B,MAAM,EAAEQ,QAAQ,EAAES,MAAM,EAAEL,aAAa,CAAC;MAEpEiB,sBAAsB,CAACX,SAAS,EAAEV,QAAQ,CAACmB,OAAO,EAAEV,MAAM,CAAC;MAE3DO,QAAQ,GAAGM,0CAA0C,CACnDZ,SAAS,EACTV,QAAQ,CAACmB,OAAO,EAChBf,aACF,CAAC;IACH,CAAC,MAAM;MACLY,QAAQ,GAAGnB,aAAa,IAAIQ,MAAM,CAACC,IAAI,CAACI,SAAS,CAACH,UAAU,CAAC;IAC/D;IAEAU,UAAU,KAAKG,YAAY,CAAC5B,MAAM,EAAEkB,SAAS,EAAED,MAAM,EAAEO,QAAQ,CAAC;IAEhE,IAAIlB,aAAa,KAAK,OAAO,IAAI,CAACmB,UAAU,EAAE;MAC5C,MAAM,IAAIM,KAAK,CACb,2EACF,CAAC;IACH,CAAC,MAAM,IAAIzB,aAAa,KAAK,MAAM,IAAI,CAACmB,UAAU,EAAE;MAClD;IACF;IAEA,IAAIO,UAA0C,GAAGlC,gBAAgB,CAC/DE,MAAM,EACNkB,SAAS,EACTD,MAAM,EACNb,0BACF,CAAC;IACD,IAAIF,gBAAgB,EAAE8B,UAAU,GAAGA,UAAU,CAACC,GAAG,CAAC/B,gBAAgB,CAAC;IAEnEc,GAAG,CAACkB,IAAI,CAACF,UAAU,CAAC;EACtB;EAEA,OAAOhB,GAAG;AACZ;AAyCA;AACA;AACA;AACA,OAAO,eAAemB,yBAAyBA,CAC7CnC,MAAqB,EACrBC,OAA2B,EAC3BC,gBAAoC,EACpCkC,yBAAyD,EACzDjC,cAAuB,GAAG,KAAK,EAC/BE,aAAqC,EACrCC,aAAmC,GAAG,KAAK,EAC3C+B,6BAGC,GAAG,CAAC,CAAC,EAC0C;EAChD9B,0BAA0B,CAACN,OAAO,EAAEE,cAAc,CAAC;EAEnD,MAAMa,GAAG,GAAG,EAAE;EACd,KAAK,MAAMC,MAAM,IAAIhB,OAAO,EAAE;IAC5B,MAAMiB,SAAS,GAAG,MAAMlB,MAAM,CAACS,gBAAgB,CAACU,mBAAmB,CACjEF,MAAM,CAACG,QACT,CAAC;IACD,CAAUF,SAAS,GAAAG,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAAnB1B,SAAS,QAAY,2BAA2BoB,MAAM,CAACG,QAAQ,GAAG,IAAlEvB,SAAS;IAET,MAAMyC,qBAAqB,GAAGpC,gBAAgB,GAC1CmC,6BAA6B,CAACnC,gBAAgB,CAAyB,CACvEe,MAAM,CAACG,QAAQ,CAChB,GACCT,SAAS;IAEb,MAAMC,aAAa,GAAGV,gBAAgB,IAAIoC,qBAAqB,GAC1DjC,aAAa,GACZQ,MAAM,CAACC,IAAI,CAACwB,qBAAqB,CAAC,CAACC,MAAM,CACzCC,GAAG,IAAI;MACLnC,aAAa,EAAEoC,QAAQ,CAACH,qBAAqB,CAACE,GAAG,CAAC,CAAC;IACrD,CACF,CAAC,GACC,CACA,GAAG3B,MAAM,CAAC6B,MAAM,CAACJ,qBAAqB,CAAC,EACvCpB,SAAS,CAACyB,iBAAiB,CAC5B,GACDhC,SAAS;;IAEb;IACA,IAAIa,QAAQ;IAEZ,IAAIC,UAAU,GAAG,IAAI;IACrB,IAAIvB,gBAAgB,IAAIU,aAAa,EAAE;MACrCc,0BAA0B,CAACR,SAAS,EAAEhB,gBAAgB,EAAEF,MAAM,CAAC;MAE/DwB,QAAQ,GAAGZ,aAAa;IAC1B,CAAC,MAAM;MACLY,QAAQ,GAAGnB,aAAa,IAAIQ,MAAM,CAACC,IAAI,CAACI,SAAS,CAACH,UAAU,CAAC;IAC/D;IAEAU,UAAU,KAAKG,YAAY,CAAC5B,MAAM,EAAEkB,SAAS,EAAED,MAAM,EAAEO,QAAQ,CAAC;IAEhE,IAAIlB,aAAa,KAAK,OAAO,IAAI,CAACmB,UAAU,EAAE;MAC5C,MAAM,IAAIM,KAAK,CACb,2EACF,CAAC;IACH,CAAC,MAAM,IAAIzB,aAAa,KAAK,MAAM,IAAI,CAACmB,UAAU,EAAE;MAClD;IACF;IAEA,IAAIO,UAA0C,GAAGlC,gBAAgB,CAC/DE,MAAM,EACNkB,SAAS,EACTD,MAAM,EACNmB,yBACF,CAAC;IACD,IAAIlC,gBAAgB,EAAE8B,UAAU,GAAGA,UAAU,CAACC,GAAG,CAAC/B,gBAAgB,CAAC;IAEnEc,GAAG,CAACkB,IAAI,CAACF,UAAU,CAAC;EACtB;EAEA,OAAOhB,GAAG;AACZ;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASc,0CAA0CA,CACxDZ,SAAsC,EACtChB,gBAAwB,EACxB0C,eAAkC,EACxB;EACV,OAAOA,eAAe,CAACC,GAAG,CAAEC,SAAS,IACnC5B,SAAS,CAAC6B,YAAY,CAAC7C,gBAAgB,CAAC,CAAC4C,SAAS,CACpD,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASjB,sBAAsBA,CAC7BX,SAAsC,EACtChB,gBAAwB,EACxBe,MAAwB,EACxB;EACA,MAAM+B,QAA6B,GAAG,CAAC,CAAC;EACxC,KACE,MAAM,CAACC,OAAO,EAAEC,WAAW,CAAC,IAAIrC,MAAM,CAACsC,OAAO,CAC5CjC,SAAS,CAAC6B,YAAY,CAAC7C,gBAAgB,CACzC,CAAC,EACD;IACA,IAAI+C,OAAO,IAAIhC,MAAM,EAAE;MACrB,MAAMmC,KAAK,GAAGnC,MAAM,CAACgC,OAAO,CAAC;MAC7B,OAAOhC,MAAM,CAACgC,OAAO,CAAC;MACtB,IAAIG,KAAK,KAAKzC,SAAS,EAAE;QACvBqC,QAAQ,CAACE,WAAW,CAAC,GAAGE,KAAK;MAC/B;IACF;EACF;EACAvC,MAAM,CAACwC,MAAM,CAACpC,MAAM,EAAE+B,QAAQ,CAAC;EAE/B,IAAI,EAAE9B,SAAS,CAACyB,iBAAiB,IAAI1B,MAAM,CAAC,EAAE;IAC5CA,MAAM,CAACC,SAAS,CAACyB,iBAAiB,CAAC,GAAG1B,MAAM,CAACqC,WAAW;EAC1D;AACF;AAEA,SAAS1B,YAAYA,CACnB5B,MAAqB,EACrBuD,GAEkB,EAClBC,GAAqB,EACrBC,YAA+B,EAC/B;EACA,KAAK,MAAMC,QAAQ,IAAID,YAAY,EAAE;IACnC,IACEC,QAAQ,IAAIH,GAAG,CAACxC,UAAU,IAAIwC,GAAG,CAACxC,UAAU,CAAC2C,QAAQ,CAAC,CAACC,QAAQ,KAAK,KAAK,IACtEH,GAAG,CAACE,QAAQ,CAAC,IAAI,IAAI,EACxB;MACA,IAAIrC,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,EAAE;QACzCvB,MAAM,CAAC4D,MAAM,EAAEC,KAAK,CAClB;UACEL,GAAG,EAAE;YACHpC,QAAQ,EAAEoC,GAAG,CAAC,UAAU,CAAC;YACzBM,WAAW,EAAEN,GAAG,CAAC,aAAa,CAAC;YAC/BF,WAAW,EAAEE,GAAG,CAAC,aAAa;UAChC;QACF,CAAC,EACD,kEAAkED,GAAG,CAAC5B,OAAO,MAAM+B,QAAQ,kBAC7F,CAAC;MACH;MACA,OAAO,KAAK;IACd;EACF;EACA,OAAO,IAAI;AACb;AAEA,SAAShC,0BAA0BA,CACjCR,SAAsC,EACtChB,gBAAwB,EACxBF,MAAqB,EACyC;EAC9D,IAAIkB,SAAS,CAAC6B,YAAY,GAAG7C,gBAAgB,CAAC,IAAI,IAAI,EAAE;IACtD,MAAM6D,OAAO,GACX,iOAAiO;IACnO,IAAI/D,MAAM,CAAC4D,MAAM,EAAE;MACjB5D,MAAM,CAAC4D,MAAM,CAACI,IAAI,CAACD,OAAO,CAAC;IAC7B,CAAC,MAAM;MACL;MACAE,OAAO,CAACC,KAAK,CAAC,YAAYH,OAAO,EAAE,CAAC;IACtC;IACA,MAAM,IAAIhC,KAAK,CAACgC,OAAO,CAAC;EAC1B;AACF;AAEA,SAASxD,0BAA0BA,CACjC4D,IAAwB,EACxBhE,cAAuB,EACiB;EACxC,KAAK,MAAMqD,GAAG,IAAIW,IAAI,EAAE;IACtB,IAAIhE,cAAc,EAAE;MAClB,OAAOqD,GAAG,CAACY,KAAK;IAClB;IAEA,IAAIZ,GAAG,CAACY,KAAK,EAAE;MACbZ,GAAG,CAACa,IAAI,GAAGb,GAAG,CAACY,KAAK;MACpB,OAAOZ,GAAG,CAACY,KAAK;IAClB;;IAEA;IACAZ,GAAG,CAACpC,QAAQ,KAAKoC,GAAG,CAACc,SAAS;;IAE9B;IACA;IACAd,GAAG,CAACM,WAAW,GAAGN,GAAG,CAACpC,QAAQ;;IAE9B;IACAoC,GAAG,CAACF,WAAW,KAAKE,GAAG,CAACe,YAAY;IACpCf,GAAG,CAACgB,MAAM,KAAKhB,GAAG,CAACiB,OAAO;;IAE1B;IACA,OAAOjB,GAAG,CAACc,SAAS;IACpB,OAAOd,GAAG,CAACe,YAAY;IACvB,OAAOf,GAAG,CAACiB,OAAO;EACpB;AACF","ignoreList":[]}
+{"version":3,"file":"convertWireToOsdkObjects.js","names":["invariant","createOsdkObject","convertWireToOsdkObjects","client","objects","interfaceApiName","forceRemoveRid","derivedPropertyTypesByName","selectedProps","strictNonNull","fixObjectPropertiesInPlace","ifaceDef","ontologyProvider","getInterfaceDefinition","undefined","ifaceSelected","Object","keys","properties","ret","rawObj","objectDef","getObjectDefinition","$apiName","process","env","NODE_ENV","objProps","conforming","invariantInterfacesAsViews","apiName","isConforming","reframeAsObjectInPlace","convertInterfacePropNamesToObjectPropNames","Error","osdkObject","$as","push","convertWireToOsdkObjects2","derivedPropertyTypeByName","interfaceToObjectTypeMappings","isInterfaceScoped","length","interfaceToObjMapping","filter","val","includes","values","primaryKeyApiName","ifacePropsToMap","map","ifaceProp","interfaceMap","newProps","sptProp","regularProp","entries","value","assign","$primaryKey","def","obj","propsToCheck","propName","nullable","logger","debug","$objectType","warning","warn","console","error","objs","__rid","$rid","__apiName","__primaryKey","$title","__title"],"sources":["convertWireToOsdkObjects.ts"],"sourcesContent":["/*\n * Copyright 2023 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n  InterfaceMetadata,\n  NullabilityAdherence,\n  ObjectMetadata,\n} from \"@osdk/api\";\nimport type {\n  InterfaceToObjectTypeMappings,\n  InterfaceTypeApiName,\n  OntologyObjectV2,\n} from \"@osdk/foundry.ontologies\";\nimport invariant from \"tiny-invariant\";\nimport type { DerivedPropertyRuntimeMetadata } from \"../derivedProperties/derivedPropertyRuntimeMetadata.js\";\nimport type { MinimalClient } from \"../MinimalClientContext.js\";\nimport {\n  type FetchedObjectTypeDefinition,\n} from \"../ontology/OntologyProvider.js\";\nimport { createOsdkObject } from \"./convertWireToOsdkObjects/createOsdkObject.js\";\nimport type { InterfaceHolder } from \"./convertWireToOsdkObjects/InterfaceHolder.js\";\nimport type { ObjectHolder } from \"./convertWireToOsdkObjects/ObjectHolder.js\";\nimport type { SimpleOsdkProperties } from \"./SimpleOsdkProperties.js\";\n\n/**\n * If interfaceApiName is not undefined, converts the instances of the\n * interface into their respective\n * underlying concrete types and then returns the $as() representation\n * for the consumers.\n *\n * Otherwise just does the conversion\n *\n * May mutate in place for performance reasons. If you need a clean copy,\n * keep it first.\n *\n * However, you must use the returned value, which will be whatever is correct.\n *\n * @internal\n * @param interfaceApiName - if undefined\n */\nexport async function convertWireToOsdkObjects(\n  client: MinimalClient,\n  objects: OntologyObjectV2[],\n  interfaceApiName: string | undefined,\n  forceRemoveRid: boolean = false,\n  derivedPropertyTypesByName: DerivedPropertyRuntimeMetadata,\n  selectedProps?: ReadonlyArray<string>,\n  strictNonNull: NullabilityAdherence = false,\n): Promise<Array<ObjectHolder | InterfaceHolder>> {\n  // remove the __ prefixed properties and convert them to $ prefixed.\n  // updates in place\n  fixObjectPropertiesInPlace(objects, forceRemoveRid);\n\n  const ifaceDef = interfaceApiName\n    ? await client.ontologyProvider.getInterfaceDefinition(interfaceApiName)\n    : undefined;\n  const ifaceSelected = ifaceDef\n    ? (selectedProps ?? Object.keys(ifaceDef.properties))\n    : undefined;\n\n  const ret = [];\n  for (const rawObj of objects) {\n    const objectDef = await client.ontologyProvider.getObjectDefinition(\n      rawObj.$apiName,\n    );\n    invariant(objectDef, `Missing definition for '${rawObj.$apiName}'`);\n\n    // default value for when we are checking an object\n    let objProps;\n\n    let conforming = true;\n    if (ifaceDef && ifaceSelected) {\n      // API returns interface spt names but we cache by real values\n      invariantInterfacesAsViews(objectDef, ifaceDef.apiName, client);\n\n      conforming &&= isConforming(client, ifaceDef, rawObj, ifaceSelected);\n\n      reframeAsObjectInPlace(objectDef, ifaceDef.apiName, rawObj);\n\n      objProps = convertInterfacePropNamesToObjectPropNames(\n        objectDef,\n        ifaceDef.apiName,\n        ifaceSelected,\n      );\n    } else {\n      objProps = selectedProps ?? Object.keys(objectDef.properties);\n    }\n\n    conforming &&= isConforming(client, objectDef, rawObj, objProps);\n\n    if (strictNonNull === \"throw\" && !conforming) {\n      throw new Error(\n        \"Unable to safely convert objects as some non nullable properties are null\",\n      );\n    } else if (strictNonNull === \"drop\" && !conforming) {\n      continue;\n    }\n\n    let osdkObject: ObjectHolder | InterfaceHolder = createOsdkObject(\n      client,\n      objectDef,\n      rawObj,\n      derivedPropertyTypesByName,\n    );\n    if (interfaceApiName) osdkObject = osdkObject.$as(interfaceApiName);\n\n    ret.push(osdkObject);\n  }\n\n  return ret;\n}\n\nexport async function convertWireToOsdkObjects2(\n  client: MinimalClient,\n  objects: OntologyObjectV2[],\n  interfaceApiName: string,\n  derivedPropertyTypeByName: DerivedPropertyRuntimeMetadata,\n  forceRemoveRid?: boolean,\n  selectedProps?: ReadonlyArray<string>,\n  strictNonNull?: NullabilityAdherence,\n  interfaceToObjectTypeMappings?: Record<\n    InterfaceTypeApiName,\n    InterfaceToObjectTypeMappings\n  >,\n): Promise<Array<InterfaceHolder>>;\nexport async function convertWireToOsdkObjects2(\n  client: MinimalClient,\n  objects: OntologyObjectV2[],\n  interfaceApiName: undefined,\n  derivedPropertyTypeByName: DerivedPropertyRuntimeMetadata,\n  forceRemoveRid?: boolean,\n  selectedProps?: ReadonlyArray<string>,\n  strictNonNull?: NullabilityAdherence,\n  interfaceToObjectTypeMappings?: Record<\n    InterfaceTypeApiName,\n    InterfaceToObjectTypeMappings\n  >,\n): Promise<Array<ObjectHolder>>;\nexport async function convertWireToOsdkObjects2(\n  client: MinimalClient,\n  objects: OntologyObjectV2[],\n  interfaceApiName: string | undefined,\n  derivedPropertyTypeByName: DerivedPropertyRuntimeMetadata,\n  forceRemoveRid?: boolean,\n  selectedProps?: ReadonlyArray<string>,\n  strictNonNull?: NullabilityAdherence,\n  interfaceToObjectTypeMappings?: Record<\n    InterfaceTypeApiName,\n    InterfaceToObjectTypeMappings\n  >,\n): Promise<Array<ObjectHolder | InterfaceHolder>>;\n/**\n * @internal\n */\nexport async function convertWireToOsdkObjects2(\n  client: MinimalClient,\n  objects: OntologyObjectV2[],\n  interfaceApiName: string | undefined,\n  derivedPropertyTypeByName: DerivedPropertyRuntimeMetadata,\n  forceRemoveRid: boolean = false,\n  selectedProps?: ReadonlyArray<string>,\n  strictNonNull: NullabilityAdherence = false,\n  interfaceToObjectTypeMappings: Record<\n    InterfaceTypeApiName,\n    InterfaceToObjectTypeMappings\n  > = {},\n): Promise<Array<ObjectHolder | InterfaceHolder>> {\n  fixObjectPropertiesInPlace(objects, forceRemoveRid);\n\n  const isInterfaceScoped =\n    Object.keys(interfaceToObjectTypeMappings).length > 0;\n  const ret = [];\n  for (const rawObj of objects) {\n    const objectDef = await client.ontologyProvider.getObjectDefinition(\n      rawObj.$apiName,\n    );\n    invariant(objectDef, `Missing definition for '${rawObj.$apiName}'`);\n\n    const interfaceToObjMapping = (interfaceApiName\n        && isInterfaceScoped)\n      ? interfaceToObjectTypeMappings[\n        interfaceApiName as InterfaceTypeApiName\n      ][\n        rawObj.$apiName\n      ]\n      : undefined;\n\n    const ifaceSelected = interfaceApiName && interfaceToObjMapping\n      ? (selectedProps\n        ? Object.keys(interfaceToObjMapping).filter(\n          val => {\n            selectedProps?.includes(interfaceToObjMapping[val]);\n          },\n        )\n        : [\n          ...Object.values(interfaceToObjMapping),\n          objectDef.primaryKeyApiName,\n        ])\n      : undefined;\n\n    // default value for when we are checking an object\n    let objProps;\n\n    let conforming = true;\n    if (interfaceApiName && ifaceSelected) {\n      invariantInterfacesAsViews(objectDef, interfaceApiName, client);\n\n      objProps = ifaceSelected;\n    } else {\n      objProps = selectedProps ?? Object.keys(objectDef.properties);\n    }\n\n    conforming &&= isConforming(client, objectDef, rawObj, objProps);\n\n    if (strictNonNull === \"throw\" && !conforming) {\n      throw new Error(\n        \"Unable to safely convert objects as some non nullable properties are null\",\n      );\n    } else if (strictNonNull === \"drop\" && !conforming) {\n      continue;\n    }\n\n    let osdkObject: ObjectHolder | InterfaceHolder = createOsdkObject(\n      client,\n      objectDef,\n      rawObj,\n      derivedPropertyTypeByName,\n    );\n    if (\n      interfaceApiName && isInterfaceScoped\n    ) osdkObject = osdkObject.$as(interfaceApiName);\n\n    ret.push(osdkObject);\n  }\n\n  return ret;\n}\n\n/**\n * @internal\n *\n * Utility function that lets us take down selected property names from an interface\n * and convert them to an array of property names on an object.\n */\nexport function convertInterfacePropNamesToObjectPropNames(\n  objectDef: FetchedObjectTypeDefinition,\n  interfaceApiName: string,\n  ifacePropsToMap: readonly string[],\n): string[] {\n  return ifacePropsToMap.map((ifaceProp) =>\n    objectDef.interfaceMap[interfaceApiName][ifaceProp]\n  );\n}\n\n/**\n * Takes a raw object from the wire (contextually as an interface) and\n * updates the fields to reflect the underlying objectDef instead\n * @param objectDef\n * @param interfaceApiName\n * @param client\n * @param rawObj\n */\nfunction reframeAsObjectInPlace(\n  objectDef: FetchedObjectTypeDefinition,\n  interfaceApiName: string,\n  rawObj: OntologyObjectV2,\n) {\n  const newProps: Record<string, any> = {};\n  for (\n    const [sptProp, regularProp] of Object.entries(\n      objectDef.interfaceMap[interfaceApiName],\n    )\n  ) {\n    if (sptProp in rawObj) {\n      const value = rawObj[sptProp];\n      delete rawObj[sptProp];\n      if (value !== undefined) {\n        newProps[regularProp] = value;\n      }\n    }\n  }\n  Object.assign(rawObj, newProps);\n\n  if (!(objectDef.primaryKeyApiName in rawObj)) {\n    rawObj[objectDef.primaryKeyApiName] = rawObj.$primaryKey;\n  }\n}\n\nfunction isConforming(\n  client: MinimalClient,\n  def:\n    | InterfaceMetadata\n    | ObjectMetadata,\n  obj: OntologyObjectV2,\n  propsToCheck: readonly string[],\n) {\n  for (const propName of propsToCheck) {\n    if (\n      propName in def.properties && def.properties[propName].nullable === false\n      && obj[propName] == null\n    ) {\n      if (process.env.NODE_ENV !== \"production\") {\n        client.logger?.debug(\n          {\n            obj: {\n              $apiName: obj[\"$apiName\"],\n              $objectType: obj[\"$objectType\"],\n              $primaryKey: obj[\"$primaryKey\"],\n            },\n          },\n          `Found object that does not conform to its definition. Expected ${def.apiName}'s ${propName} to not be null.`,\n        );\n      }\n      return false;\n    }\n  }\n  return true;\n}\n\nfunction invariantInterfacesAsViews(\n  objectDef: FetchedObjectTypeDefinition,\n  interfaceApiName: string,\n  client: MinimalClient,\n): asserts objectDef is typeof objectDef & { interfaceMap: {} } {\n  if (objectDef.interfaceMap?.[interfaceApiName] == null) {\n    const warning =\n      \"Interfaces are only supported 'as views' but your metadata object is missing the correct information. This suggests your interfaces have not been migrated to the newer version yet and you cannot use this version of the SDK.\";\n    if (client.logger) {\n      client.logger.warn(warning);\n    } else {\n      // eslint-disable-next-line no-console\n      console.error(`WARNING! ${warning}`);\n    }\n    throw new Error(warning);\n  }\n}\n\nfunction fixObjectPropertiesInPlace(\n  objs: OntologyObjectV2[],\n  forceRemoveRid: boolean,\n): asserts objs is SimpleOsdkProperties[] {\n  for (const obj of objs) {\n    if (forceRemoveRid) {\n      delete obj.__rid;\n    }\n\n    if (obj.__rid) {\n      obj.$rid = obj.__rid;\n      delete obj.__rid;\n    }\n\n    // Backend returns as __apiName but we want to stick to $ structure\n    obj.$apiName ??= obj.__apiName;\n\n    // for now these are the same but when we start doing interface projections the $objectType will always be underlying and\n    // the $apiName will be for the current view (in current designs)\n    obj.$objectType = obj.$apiName;\n\n    // copying over for now as its always returned. In the future, this should just be inferred from underlying\n    obj.$primaryKey ??= obj.__primaryKey;\n    obj.$title ??= obj.__title;\n\n    // we don't want people to use these\n    delete obj.__apiName;\n    delete obj.__primaryKey;\n    delete obj.__title;\n  }\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAYA,OAAOA,SAAS,MAAM,gBAAgB;AAMtC,SAASC,gBAAgB,QAAQ,gDAAgD;AAKjF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeC,wBAAwBA,CAC5CC,MAAqB,EACrBC,OAA2B,EAC3BC,gBAAoC,EACpCC,cAAuB,GAAG,KAAK,EAC/BC,0BAA0D,EAC1DC,aAAqC,EACrCC,aAAmC,GAAG,KAAK,EACK;EAChD;EACA;EACAC,0BAA0B,CAACN,OAAO,EAAEE,cAAc,CAAC;EAEnD,MAAMK,QAAQ,GAAGN,gBAAgB,GAC7B,MAAMF,MAAM,CAACS,gBAAgB,CAACC,sBAAsB,CAACR,gBAAgB,CAAC,GACtES,SAAS;EACb,MAAMC,aAAa,GAAGJ,QAAQ,GACzBH,aAAa,IAAIQ,MAAM,CAACC,IAAI,CAACN,QAAQ,CAACO,UAAU,CAAC,GAClDJ,SAAS;EAEb,MAAMK,GAAG,GAAG,EAAE;EACd,KAAK,MAAMC,MAAM,IAAIhB,OAAO,EAAE;IAC5B,MAAMiB,SAAS,GAAG,MAAMlB,MAAM,CAACS,gBAAgB,CAACU,mBAAmB,CACjEF,MAAM,CAACG,QACT,CAAC;IACD,CAAUF,SAAS,GAAAG,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAAnB1B,SAAS,QAAY,2BAA2BoB,MAAM,CAACG,QAAQ,GAAG,IAAlEvB,SAAS;;IAET;IACA,IAAI2B,QAAQ;IAEZ,IAAIC,UAAU,GAAG,IAAI;IACrB,IAAIjB,QAAQ,IAAII,aAAa,EAAE;MAC7B;MACAc,0BAA0B,CAACR,SAAS,EAAEV,QAAQ,CAACmB,OAAO,EAAE3B,MAAM,CAAC;MAE/DyB,UAAU,KAAKG,YAAY,CAAC5B,MAAM,EAAEQ,QAAQ,EAAES,MAAM,EAAEL,aAAa,CAAC;MAEpEiB,sBAAsB,CAACX,SAAS,EAAEV,QAAQ,CAACmB,OAAO,EAAEV,MAAM,CAAC;MAE3DO,QAAQ,GAAGM,0CAA0C,CACnDZ,SAAS,EACTV,QAAQ,CAACmB,OAAO,EAChBf,aACF,CAAC;IACH,CAAC,MAAM;MACLY,QAAQ,GAAGnB,aAAa,IAAIQ,MAAM,CAACC,IAAI,CAACI,SAAS,CAACH,UAAU,CAAC;IAC/D;IAEAU,UAAU,KAAKG,YAAY,CAAC5B,MAAM,EAAEkB,SAAS,EAAED,MAAM,EAAEO,QAAQ,CAAC;IAEhE,IAAIlB,aAAa,KAAK,OAAO,IAAI,CAACmB,UAAU,EAAE;MAC5C,MAAM,IAAIM,KAAK,CACb,2EACF,CAAC;IACH,CAAC,MAAM,IAAIzB,aAAa,KAAK,MAAM,IAAI,CAACmB,UAAU,EAAE;MAClD;IACF;IAEA,IAAIO,UAA0C,GAAGlC,gBAAgB,CAC/DE,MAAM,EACNkB,SAAS,EACTD,MAAM,EACNb,0BACF,CAAC;IACD,IAAIF,gBAAgB,EAAE8B,UAAU,GAAGA,UAAU,CAACC,GAAG,CAAC/B,gBAAgB,CAAC;IAEnEc,GAAG,CAACkB,IAAI,CAACF,UAAU,CAAC;EACtB;EAEA,OAAOhB,GAAG;AACZ;AAyCA;AACA;AACA;AACA,OAAO,eAAemB,yBAAyBA,CAC7CnC,MAAqB,EACrBC,OAA2B,EAC3BC,gBAAoC,EACpCkC,yBAAyD,EACzDjC,cAAuB,GAAG,KAAK,EAC/BE,aAAqC,EACrCC,aAAmC,GAAG,KAAK,EAC3C+B,6BAGC,GAAG,CAAC,CAAC,EAC0C;EAChD9B,0BAA0B,CAACN,OAAO,EAAEE,cAAc,CAAC;EAEnD,MAAMmC,iBAAiB,GACrBzB,MAAM,CAACC,IAAI,CAACuB,6BAA6B,CAAC,CAACE,MAAM,GAAG,CAAC;EACvD,MAAMvB,GAAG,GAAG,EAAE;EACd,KAAK,MAAMC,MAAM,IAAIhB,OAAO,EAAE;IAC5B,MAAMiB,SAAS,GAAG,MAAMlB,MAAM,CAACS,gBAAgB,CAACU,mBAAmB,CACjEF,MAAM,CAACG,QACT,CAAC;IACD,CAAUF,SAAS,GAAAG,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAAnB1B,SAAS,QAAY,2BAA2BoB,MAAM,CAACG,QAAQ,GAAG,IAAlEvB,SAAS;IAET,MAAM2C,qBAAqB,GAAItC,gBAAgB,IACxCoC,iBAAiB,GACpBD,6BAA6B,CAC7BnC,gBAAgB,CACjB,CACCe,MAAM,CAACG,QAAQ,CAChB,GACCT,SAAS;IAEb,MAAMC,aAAa,GAAGV,gBAAgB,IAAIsC,qBAAqB,GAC1DnC,aAAa,GACZQ,MAAM,CAACC,IAAI,CAAC0B,qBAAqB,CAAC,CAACC,MAAM,CACzCC,GAAG,IAAI;MACLrC,aAAa,EAAEsC,QAAQ,CAACH,qBAAqB,CAACE,GAAG,CAAC,CAAC;IACrD,CACF,CAAC,GACC,CACA,GAAG7B,MAAM,CAAC+B,MAAM,CAACJ,qBAAqB,CAAC,EACvCtB,SAAS,CAAC2B,iBAAiB,CAC5B,GACDlC,SAAS;;IAEb;IACA,IAAIa,QAAQ;IAEZ,IAAIC,UAAU,GAAG,IAAI;IACrB,IAAIvB,gBAAgB,IAAIU,aAAa,EAAE;MACrCc,0BAA0B,CAACR,SAAS,EAAEhB,gBAAgB,EAAEF,MAAM,CAAC;MAE/DwB,QAAQ,GAAGZ,aAAa;IAC1B,CAAC,MAAM;MACLY,QAAQ,GAAGnB,aAAa,IAAIQ,MAAM,CAACC,IAAI,CAACI,SAAS,CAACH,UAAU,CAAC;IAC/D;IAEAU,UAAU,KAAKG,YAAY,CAAC5B,MAAM,EAAEkB,SAAS,EAAED,MAAM,EAAEO,QAAQ,CAAC;IAEhE,IAAIlB,aAAa,KAAK,OAAO,IAAI,CAACmB,UAAU,EAAE;MAC5C,MAAM,IAAIM,KAAK,CACb,2EACF,CAAC;IACH,CAAC,MAAM,IAAIzB,aAAa,KAAK,MAAM,IAAI,CAACmB,UAAU,EAAE;MAClD;IACF;IAEA,IAAIO,UAA0C,GAAGlC,gBAAgB,CAC/DE,MAAM,EACNkB,SAAS,EACTD,MAAM,EACNmB,yBACF,CAAC;IACD,IACElC,gBAAgB,IAAIoC,iBAAiB,EACrCN,UAAU,GAAGA,UAAU,CAACC,GAAG,CAAC/B,gBAAgB,CAAC;IAE/Cc,GAAG,CAACkB,IAAI,CAACF,UAAU,CAAC;EACtB;EAEA,OAAOhB,GAAG;AACZ;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASc,0CAA0CA,CACxDZ,SAAsC,EACtChB,gBAAwB,EACxB4C,eAAkC,EACxB;EACV,OAAOA,eAAe,CAACC,GAAG,CAAEC,SAAS,IACnC9B,SAAS,CAAC+B,YAAY,CAAC/C,gBAAgB,CAAC,CAAC8C,SAAS,CACpD,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASnB,sBAAsBA,CAC7BX,SAAsC,EACtChB,gBAAwB,EACxBe,MAAwB,EACxB;EACA,MAAMiC,QAA6B,GAAG,CAAC,CAAC;EACxC,KACE,MAAM,CAACC,OAAO,EAAEC,WAAW,CAAC,IAAIvC,MAAM,CAACwC,OAAO,CAC5CnC,SAAS,CAAC+B,YAAY,CAAC/C,gBAAgB,CACzC,CAAC,EACD;IACA,IAAIiD,OAAO,IAAIlC,MAAM,EAAE;MACrB,MAAMqC,KAAK,GAAGrC,MAAM,CAACkC,OAAO,CAAC;MAC7B,OAAOlC,MAAM,CAACkC,OAAO,CAAC;MACtB,IAAIG,KAAK,KAAK3C,SAAS,EAAE;QACvBuC,QAAQ,CAACE,WAAW,CAAC,GAAGE,KAAK;MAC/B;IACF;EACF;EACAzC,MAAM,CAAC0C,MAAM,CAACtC,MAAM,EAAEiC,QAAQ,CAAC;EAE/B,IAAI,EAAEhC,SAAS,CAAC2B,iBAAiB,IAAI5B,MAAM,CAAC,EAAE;IAC5CA,MAAM,CAACC,SAAS,CAAC2B,iBAAiB,CAAC,GAAG5B,MAAM,CAACuC,WAAW;EAC1D;AACF;AAEA,SAAS5B,YAAYA,CACnB5B,MAAqB,EACrByD,GAEkB,EAClBC,GAAqB,EACrBC,YAA+B,EAC/B;EACA,KAAK,MAAMC,QAAQ,IAAID,YAAY,EAAE;IACnC,IACEC,QAAQ,IAAIH,GAAG,CAAC1C,UAAU,IAAI0C,GAAG,CAAC1C,UAAU,CAAC6C,QAAQ,CAAC,CAACC,QAAQ,KAAK,KAAK,IACtEH,GAAG,CAACE,QAAQ,CAAC,IAAI,IAAI,EACxB;MACA,IAAIvC,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,EAAE;QACzCvB,MAAM,CAAC8D,MAAM,EAAEC,KAAK,CAClB;UACEL,GAAG,EAAE;YACHtC,QAAQ,EAAEsC,GAAG,CAAC,UAAU,CAAC;YACzBM,WAAW,EAAEN,GAAG,CAAC,aAAa,CAAC;YAC/BF,WAAW,EAAEE,GAAG,CAAC,aAAa;UAChC;QACF,CAAC,EACD,kEAAkED,GAAG,CAAC9B,OAAO,MAAMiC,QAAQ,kBAC7F,CAAC;MACH;MACA,OAAO,KAAK;IACd;EACF;EACA,OAAO,IAAI;AACb;AAEA,SAASlC,0BAA0BA,CACjCR,SAAsC,EACtChB,gBAAwB,EACxBF,MAAqB,EACyC;EAC9D,IAAIkB,SAAS,CAAC+B,YAAY,GAAG/C,gBAAgB,CAAC,IAAI,IAAI,EAAE;IACtD,MAAM+D,OAAO,GACX,iOAAiO;IACnO,IAAIjE,MAAM,CAAC8D,MAAM,EAAE;MACjB9D,MAAM,CAAC8D,MAAM,CAACI,IAAI,CAACD,OAAO,CAAC;IAC7B,CAAC,MAAM;MACL;MACAE,OAAO,CAACC,KAAK,CAAC,YAAYH,OAAO,EAAE,CAAC;IACtC;IACA,MAAM,IAAIlC,KAAK,CAACkC,OAAO,CAAC;EAC1B;AACF;AAEA,SAAS1D,0BAA0BA,CACjC8D,IAAwB,EACxBlE,cAAuB,EACiB;EACxC,KAAK,MAAMuD,GAAG,IAAIW,IAAI,EAAE;IACtB,IAAIlE,cAAc,EAAE;MAClB,OAAOuD,GAAG,CAACY,KAAK;IAClB;IAEA,IAAIZ,GAAG,CAACY,KAAK,EAAE;MACbZ,GAAG,CAACa,IAAI,GAAGb,GAAG,CAACY,KAAK;MACpB,OAAOZ,GAAG,CAACY,KAAK;IAClB;;IAEA;IACAZ,GAAG,CAACtC,QAAQ,KAAKsC,GAAG,CAACc,SAAS;;IAE9B;IACA;IACAd,GAAG,CAACM,WAAW,GAAGN,GAAG,CAACtC,QAAQ;;IAE9B;IACAsC,GAAG,CAACF,WAAW,KAAKE,GAAG,CAACe,YAAY;IACpCf,GAAG,CAACgB,MAAM,KAAKhB,GAAG,CAACiB,OAAO;;IAE1B;IACA,OAAOjB,GAAG,CAACc,SAAS;IACpB,OAAOd,GAAG,CAACe,YAAY;IACvB,OAAOf,GAAG,CAACiB,OAAO;EACpB;AACF","ignoreList":[]}

package/build/browser/object/convertWireToOsdkObjects.test.js

@@ -575,7 +575,13 @@ describe("convertWireToOsdkObjects", () => {
                       "Person",
                     ],
                     "implements": [],
-                    "links": {},
+                    "links": {
+                      "toBar": {
+                        "multiplicity": true,
+                        "targetType": "interface",
+                        "targetTypeApiName": "BarInterface",
+                      },
+                    },
                     "properties": {
                       "fooSpt": {
                         "description": "A foo",
@@ -625,29 +631,35 @@ describe("convertWireToOsdkObjects", () => {
         const objAsFoo = employee.$as(FooInterface);
         expect(objAsFoo.$__EXPERIMENTAL__NOT_SUPPORTED_YET__metadata).toBeDefined();
         expect(objAsFoo.$__EXPERIMENTAL__NOT_SUPPORTED_YET__metadata.InterfaceMetadata).toMatchInlineSnapshot(`
-          {
-            "apiName": "FooInterface",
-            "description": "Interface for Foo",
-            "displayName": "Foo Interface",
-            "implementedBy": [
-              "Employee",
-              "Person",
-            ],
-            "implements": [],
-            "links": {},
-            "properties": {
-              "fooSpt": {
-                "description": "A foo",
-                "displayName": "Foo",
-                "multiplicity": false,
-                "nullable": true,
-                "type": "string",
+            {
+              "apiName": "FooInterface",
+              "description": "Interface for Foo",
+              "displayName": "Foo Interface",
+              "implementedBy": [
+                "Employee",
+                "Person",
+              ],
+              "implements": [],
+              "links": {
+                "toBar": {
+                  "multiplicity": true,
+                  "targetType": "interface",
+                  "targetTypeApiName": "BarInterface",
+                },
               },
-            },
-            "rid": "ri.interface.main.interface.1",
-            "type": "interface",
-          }
-        `);
+              "properties": {
+                "fooSpt": {
+                  "description": "A foo",
+                  "displayName": "Foo",
+                  "multiplicity": false,
+                  "nullable": true,
+                  "type": "string",
+                },
+              },
+              "rid": "ri.interface.main.interface.1",
+              "type": "interface",
+            }
+          `);
       });
       it("$experimental_metadata is not enumerable", async () => {
         const {