@osdk/maker 0.9.0-beta.9 → 0.9.0

package/CHANGELOG.md

@@ -1,5 +1,309 @@
 # @osdk/maker
 
+## 0.9.0
+
+### Minor Changes
+
+- 25fd9f0: Updating package.json to have better entry points to support react native bundlers.
+- f0b519d: Upgrade to vitest 3 and vite 6
+- 1812118: Add geotime support for OSDK.
+- bc1761c: Update platform API dependencies.
+- bb8b219: Use new external packages instead of the internal ones.
+- 44e62f6: Updating fetch for auth and other packages.
+- 91cfa3a: Fixing url parsing for client.
+- c9e855d: Allowing interfaces to extend other interfaces for ontology as code.
+- 94463b6: Support objects as code
+- 9d35a1f: Remove unused imports
+- 8d8bebb: Fix nullability
+- 7a95618: Generate new OMS APIs
+- c9da74c: Improves code quality by fixing linting errors
+- abfe4b3: Add support for reading struct properties.
+- caf1abc: Support generating linked products for marketplace
+- cd8d657: Support importing foreign SPTs
+- b8a1a58: Add nullability to markings because of course they need to be nullable. This sucks in the data model, I should talk to the ontology team about this.
+- b0544d4: Add additional marking configuration
+- 9018dc2: Updating platform api dependencies.
+- f569124: Add media reference to maker
+- 0a4f131: Fix value types so they actually serialize correctly.
+- 8e5e49a: Add optional link constraints
+- 6b6c8a1: Updates gateway endpoints and changes fetchContents for attachments to return a response
+- 2b35ed4: Structs in maker package
+- 09eaf24: Update to latest platform sdks
+- 06e66dc: Making interface type status configurable
+- d665147: Update platform sdk deps
+
+### Patch Changes
+
+- Updated dependencies [966d408]
+- Updated dependencies [cddc196]
+- Updated dependencies [d794c19]
+- Updated dependencies [05febf4]
+- Updated dependencies [55c05f2]
+- Updated dependencies [0dc40b0]
+- Updated dependencies [25fd9f0]
+- Updated dependencies [11a05cc]
+- Updated dependencies [7865cb6]
+- Updated dependencies [9c4efe6]
+- Updated dependencies [3ea2e79]
+- Updated dependencies [1812118]
+- Updated dependencies [bc1761c]
+- Updated dependencies [656f975]
+- Updated dependencies [f1145ff]
+- Updated dependencies [f446d0c]
+- Updated dependencies [c80ca45]
+- Updated dependencies [bb8b219]
+- Updated dependencies [03f95eb]
+- Updated dependencies [1a89f23]
+- Updated dependencies [9d35a1f]
+- Updated dependencies [c691c8b]
+- Updated dependencies [749cf69]
+- Updated dependencies [f03e39f]
+- Updated dependencies [11088aa]
+- Updated dependencies [72c1905]
+- Updated dependencies [9298f75]
+- Updated dependencies [f34b3d4]
+- Updated dependencies [acbfab9]
+- Updated dependencies [62c1d63]
+- Updated dependencies [3c9ac22]
+- Updated dependencies [1591f04]
+- Updated dependencies [03e1941]
+- Updated dependencies [abfe4b3]
+- Updated dependencies [b79becf]
+- Updated dependencies [27866a8]
+- Updated dependencies [e5fe7c0]
+- Updated dependencies [1b2e8c9]
+- Updated dependencies [9f3807c]
+- Updated dependencies [0c56d21]
+- Updated dependencies [e548b9b]
+- Updated dependencies [ee6224b]
+- Updated dependencies [1dc0228]
+- Updated dependencies [6c60414]
+- Updated dependencies [5fe2c8d]
+- Updated dependencies [d3b3f35]
+- Updated dependencies [785f663]
+- Updated dependencies [6b6c8a1]
+- Updated dependencies [c537e2d]
+- Updated dependencies [73fa373]
+- Updated dependencies [8e6a5f4]
+- Updated dependencies [2d5e648]
+- Updated dependencies [31e7d70]
+- Updated dependencies [f19da8e]
+  - @osdk/api@2.1.0
+
+## 0.9.0-rc.32
+
+### Patch Changes
+
+- Updated dependencies [55c05f2]
+  - @osdk/api@2.1.0-rc.32
+
+## 0.9.0-beta.31
+
+### Minor Changes
+
+- bb8b219: Use new external packages instead of the internal ones.
+
+### Patch Changes
+
+- Updated dependencies [bb8b219]
+- Updated dependencies [ee6224b]
+- Updated dependencies [5fe2c8d]
+  - @osdk/api@2.1.0-beta.31
+
+## 0.9.0-beta.30
+
+### Patch Changes
+
+- Updated dependencies [966d408]
+- Updated dependencies [f03e39f]
+- Updated dependencies [1591f04]
+- Updated dependencies [785f663]
+- Updated dependencies [2d5e648]
+  - @osdk/api@2.1.0-beta.30
+
+## 0.9.0-beta.29
+
+### Patch Changes
+
+- Updated dependencies [f1145ff]
+  - @osdk/api@2.1.0-beta.29
+
+## 0.9.0-beta.28
+
+### Patch Changes
+
+- Updated dependencies [f446d0c]
+  - @osdk/api@2.1.0-beta.28
+
+## 0.9.0-beta.27
+
+### Patch Changes
+
+- @osdk/api@2.1.0-beta.27
+
+## 0.9.0-beta.26
+
+### Minor Changes
+
+- 44e62f6: Updating fetch for auth and other packages.
+- 94463b6: Support objects as code
+
+### Patch Changes
+
+- Updated dependencies [7865cb6]
+- Updated dependencies [9c4efe6]
+- Updated dependencies [f19da8e]
+  - @osdk/api@2.1.0-beta.26
+
+## 0.9.0-beta.25
+
+### Patch Changes
+
+- Updated dependencies [c80ca45]
+  - @osdk/api@2.1.0-beta.25
+
+## 0.9.0-beta.24
+
+### Patch Changes
+
+- Updated dependencies [03f95eb]
+- Updated dependencies [c691c8b]
+- Updated dependencies [3c9ac22]
+  - @osdk/api@2.1.0-beta.24
+
+## 0.9.0-beta.23
+
+### Minor Changes
+
+- f0b519d: Upgrade to vitest 3 and vite 6
+- 7a95618: Generate new OMS APIs
+- d665147: Update platform sdk deps
+
+### Patch Changes
+
+- Updated dependencies [d794c19]
+- Updated dependencies [62c1d63]
+  - @osdk/api@2.1.0-beta.23
+
+## 0.9.0-beta.22
+
+### Minor Changes
+
+- 8d8bebb: Fix nullability
+- c9da74c: Improves code quality by fixing linting errors
+
+### Patch Changes
+
+- Updated dependencies [73fa373]
+  - @osdk/api@2.1.0-beta.22
+
+## 0.9.0-beta.21
+
+### Patch Changes
+
+- Updated dependencies [3ea2e79]
+- Updated dependencies [656f975]
+- Updated dependencies [f34b3d4]
+  - @osdk/api@2.1.0-beta.21
+
+## 0.9.0-beta.20
+
+### Minor Changes
+
+- 9d35a1f: Remove unused imports
+- abfe4b3: Add support for reading struct properties.
+- 06e66dc: Making interface type status configurable
+
+### Patch Changes
+
+- Updated dependencies [9d35a1f]
+- Updated dependencies [abfe4b3]
+- Updated dependencies [c537e2d]
+  - @osdk/api@2.1.0-beta.20
+
+## 0.9.0-beta.19
+
+### Patch Changes
+
+- Updated dependencies [cddc196]
+  - @osdk/api@2.1.0-beta.19
+
+## 0.9.0-beta.18
+
+### Patch Changes
+
+- @osdk/api@2.1.0-beta.18
+
+## 0.9.0-beta.17
+
+### Patch Changes
+
+- @osdk/api@2.1.0-beta.17
+
+## 0.9.0-beta.16
+
+### Minor Changes
+
+- 0a4f131: Fix value types so they actually serialize correctly.
+- 8e5e49a: Add optional link constraints
+
+### Patch Changes
+
+- Updated dependencies [e5fe7c0]
+  - @osdk/api@2.1.0-beta.16
+
+## 0.9.0-beta.15
+
+### Patch Changes
+
+- @osdk/api@2.1.0-beta.15
+
+## 0.9.0-beta.14
+
+### Minor Changes
+
+- 91cfa3a: Fixing url parsing for client.
+- 6b6c8a1: Updates gateway endpoints and changes fetchContents for attachments to return a response
+
+### Patch Changes
+
+- Updated dependencies [0c56d21]
+- Updated dependencies [6b6c8a1]
+  - @osdk/api@2.1.0-beta.14
+
+## 0.9.0-beta.13
+
+### Patch Changes
+
+- @osdk/api@2.1.0-beta.13
+
+## 0.9.0-beta.12
+
+### Patch Changes
+
+- @osdk/api@2.1.0-beta.12
+
+## 0.9.0-beta.11
+
+### Minor Changes
+
+- bc1761c: Update platform API dependencies.
+- caf1abc: Support generating linked products for marketplace
+
+### Patch Changes
+
+- Updated dependencies [bc1761c]
+- Updated dependencies [9298f75]
+  - @osdk/api@2.1.0-beta.11
+
+## 0.9.0-beta.10
+
+### Patch Changes
+
+- Updated dependencies [11a05cc]
+- Updated dependencies [11088aa]
+  - @osdk/api@2.1.0-beta.10
+
 ## 0.9.0-beta.9
 
 ### Patch Changes

package/build/browser/api/defineImportSpt.js

@@ -13,13 +13,35 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
+import invariant from "tiny-invariant";
+import { ontologyDefinition } from "./defineOntology.js";
 /**
  * Defines a foreign shared property type you want to take as an input to your product. The typeHint field is used for OSDK generation
  */
 export function importSharedPropertyType(opts) {
+  const {
+    apiName,
+    packageName,
+    typeHint
+  } = opts;
+  if (packageName !== undefined) {
+    ontologyDefinition.importedTypes.sharedPropertyTypes.push({
+      apiName,
+      packageName
+    });
+    !!packageName.endsWith(".") ? process.env.NODE_ENV !== "production" ? invariant(false, "Package name format invalid ends with period") : invariant(false) : void 0;
+    !(packageName.match("[A-Z]") == null) ? process.env.NODE_ENV !== "production" ? invariant(false, "Package name includes upper case characters") : invariant(false) : void 0;
+    return {
+      apiName: packageName + "." + apiName,
+      type: typeHint,
+      nonNameSpacedApiName: apiName
+    };
+  }
   return {
-    apiName: opts.apiName,
-    type: opts.typeHint
+    apiName: apiName,
+    type: typeHint,
+    nonNameSpacedApiName: apiName
   };
 }
 //# sourceMappingURL=defineImportSpt.js.map

package/build/browser/api/defineImportSpt.js.map

@@ -1 +1 @@
-{"version":3,"file":"defineImportSpt.js","names":["importSharedPropertyType","opts","apiName","type","typeHint"],"sources":["defineImportSpt.js"],"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/**\n * Defines a foreign shared property type you want to take as an input to your product. The typeHint field is used for OSDK generation\n */\nexport function importSharedPropertyType(opts) {\n    return { apiName: opts.apiName, type: opts.typeHint };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASA,wBAAwBA,CAACC,IAAI,EAAE;EAC3C,OAAO;IAAEC,OAAO,EAAED,IAAI,CAACC,OAAO;IAAEC,IAAI,EAAEF,IAAI,CAACG;EAAS,CAAC;AACzD","ignoreList":[]}
+{"version":3,"file":"defineImportSpt.js","names":["invariant","ontologyDefinition","importSharedPropertyType","opts","apiName","packageName","typeHint","undefined","importedTypes","sharedPropertyTypes","push","endsWith","process","env","NODE_ENV","match","type","nonNameSpacedApiName"],"sources":["defineImportSpt.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 invariant from \"tiny-invariant\";\nimport { ontologyDefinition } from \"./defineOntology.js\";\nimport type { PropertyTypeType, SharedPropertyType } from \"./types.js\";\n\n/**\n * Defines a foreign shared property type you want to take as an input to your product. The typeHint field is used for OSDK generation\n */\nexport function importSharedPropertyType(\n  opts: {\n    apiName: string;\n    packageName?: string;\n    typeHint: PropertyTypeType;\n  },\n): SharedPropertyType {\n  const { apiName, packageName, typeHint } = opts;\n  if (packageName !== undefined) {\n    ontologyDefinition.importedTypes.sharedPropertyTypes.push({\n      apiName,\n      packageName,\n    });\n    invariant(\n      !packageName.endsWith(\".\"),\n      \"Package name format invalid ends with period\",\n    );\n\n    invariant(\n      packageName.match(\"[A-Z]\") == null,\n      \"Package name includes upper case characters\",\n    );\n\n    return {\n      apiName: packageName + \".\" + apiName,\n      type: typeHint,\n      nonNameSpacedApiName: apiName,\n    };\n  }\n  return { apiName: apiName, type: typeHint, nonNameSpacedApiName: apiName };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,OAAOA,SAAS,MAAM,gBAAgB;AACtC,SAASC,kBAAkB,QAAQ,qBAAqB;AAGxD;AACA;AACA;AACA,OAAO,SAASC,wBAAwBA,CACtCC,IAIC,EACmB;EACpB,MAAM;IAAEC,OAAO;IAAEC,WAAW;IAAEC;EAAS,CAAC,GAAGH,IAAI;EAC/C,IAAIE,WAAW,KAAKE,SAAS,EAAE;IAC7BN,kBAAkB,CAACO,aAAa,CAACC,mBAAmB,CAACC,IAAI,CAAC;MACxDN,OAAO;MACPC;IACF,CAAC,CAAC;IACF,CACE,CAACA,WAAW,CAACM,QAAQ,CAAC,GAAG,CAAC,GAAAC,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAD5Bd,SAAS,QAEP,8CAA8C,IAFhDA,SAAS;IAKT,EACEK,WAAW,CAACU,KAAK,CAAC,OAAO,CAAC,IAAI,IAAI,IAAAH,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBADpCd,SAAS,QAEP,6CAA6C,IAF/CA,SAAS;IAKT,OAAO;MACLI,OAAO,EAAEC,WAAW,GAAG,GAAG,GAAGD,OAAO;MACpCY,IAAI,EAAEV,QAAQ;MACdW,oBAAoB,EAAEb;IACxB,CAAC;EACH;EACA,OAAO;IAAEA,OAAO,EAAEA,OAAO;IAAEY,IAAI,EAAEV,QAAQ;IAAEW,oBAAoB,EAAEb;EAAQ,CAAC;AAC5E","ignoreList":[]}

package/build/browser/api/defineInterface.js

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 import invariant from "tiny-invariant";
 import { namespace, ontologyDefinition } from "./defineOntology.js";
 import { defineSharedPropertyType } from "./defineSpt.js";
@@ -21,7 +22,7 @@ export function defineInterface(opts) {
   !(ontologyDefinition.interfaceTypes[apiName] === undefined) ? process.env.NODE_ENV !== "production" ? invariant(false, `Interface ${apiName} already exists`) : invariant(false) : void 0;
   const properties = Object.fromEntries(Object.entries(opts.properties ?? {}).map(([apiName, type]) => {
     if (typeof type === "string" || typeof type === "object" && !("apiName" in type)) {
-      !isPropertyTypeType(type) ? process.env.NODE_ENV !== "production" ? invariant(false, `Invalid data type ${type} for property ${apiName} on InterfaceType ${apiName}`) : invariant(false) : void 0;
+      !isPropertyTypeType(type) ? process.env.NODE_ENV !== "production" ? invariant(false, `Invalid data type ${JSON.stringify(type)} for property ${apiName} on InterfaceType ${apiName}`) : invariant(false) : void 0;
       const spt = defineSharedPropertyType({
         apiName,
         displayName: apiName,
@@ -30,7 +31,8 @@ export function defineInterface(opts) {
       });
       return [apiName, spt];
     } else {
-      !(namespace + apiName === type.apiName || apiName === type.apiName) ? process.env.NODE_ENV !== "production" ? invariant(false, `property key and it's apiName must be identical. ${JSON.stringify({
+      const unNamespacedTypeApiName = type.apiName.slice(type.apiName.lastIndexOf(".") + 1);
+      !(namespace + apiName === type.apiName || apiName === unNamespacedTypeApiName) ? process.env.NODE_ENV !== "production" ? invariant(false, `property key and it's apiName must be identical. ${JSON.stringify({
         key: apiName,
         apiName: type.apiName
       })}`) : invariant(false) : void 0;
@@ -49,6 +51,10 @@ export function defineInterface(opts) {
       extendsInterfaces = opts.extends.map(item => item.apiName);
     }
   }
+  const status = mapSimplifiedStatusToInterfaceTypeStatus(opts.status ?? {
+    type: "active"
+  });
+  !(status.type !== "deprecated" || status.deprecated.message && status.deprecated.deadline) ? process.env.NODE_ENV !== "production" ? invariant(false, `Deprecated status must include message and deadline properties.`) : invariant(false) : void 0;
   const a = {
     apiName,
     displayMetadata: {
@@ -65,14 +71,36 @@ export function defineInterface(opts) {
     extendsInterfaces: extendsInterfaces,
     links: [],
     properties,
-    status: {
-      type: "active",
-      active: {}
-    }
+    status
   };
   return ontologyDefinition.interfaceTypes[apiName] = a;
 }
 function isPropertyTypeType(v) {
   return v === "boolean" || v === "byte" || v === "date" || v === "decimal" || v === "double" || v === "float" || v === "geopoint" || v === "geoshape" || v === "integer" || v === "long" || typeof v === "object" && v.type === "marking" || v === "short" || v === "string" || v === "timestamp";
 }
+function mapSimplifiedStatusToInterfaceTypeStatus(status) {
+  switch (status.type) {
+    case "deprecated":
+      return {
+        type: "deprecated",
+        deprecated: {
+          message: status.message,
+          deadline: status.deadline,
+          replacedBy: undefined
+        }
+      };
+    case "active":
+      return {
+        type: "active",
+        active: {}
+      };
+    case "experimental":
+      return {
+        type: "experimental",
+        experimental: {}
+      };
+    default:
+      throw new Error(`Invalid status type: ${status.type}`);
+  }
+}
 //# sourceMappingURL=defineInterface.js.map

package/build/browser/api/defineInterface.js.map

@@ -1 +1 @@
-{"version":3,"file":"defineInterface.js","names":["invariant","namespace","ontologyDefinition","defineSharedPropertyType","defineInterface","opts","apiName","interfaceTypes","undefined","process","env","NODE_ENV","properties","Object","fromEntries","entries","map","type","isPropertyTypeType","spt","displayName","array","JSON","stringify","key","extendsInterfaces","extends","Array","isArray","every","item","a","displayMetadata","description","icon","blueprint","color","locator","links","status","active","v"],"sources":["defineInterface.js"],"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 */\nimport invariant from \"tiny-invariant\";\nimport { namespace, ontologyDefinition } from \"./defineOntology.js\";\nimport { defineSharedPropertyType } from \"./defineSpt.js\";\nexport function defineInterface(opts) {\n    const apiName = namespace + opts.apiName;\n    invariant(ontologyDefinition.interfaceTypes[apiName] === undefined, `Interface ${apiName} already exists`);\n    const properties = Object.fromEntries(Object.entries(opts.properties ?? {}).map(([apiName, type]) => {\n        if (typeof type === \"string\"\n            || (typeof type === \"object\" && !(\"apiName\" in type))) {\n            invariant(isPropertyTypeType(type), `Invalid data type ${type} for property ${apiName} on InterfaceType ${apiName}`);\n            const spt = defineSharedPropertyType({\n                apiName,\n                displayName: apiName,\n                type,\n                array: false,\n            });\n            return [apiName, spt];\n        }\n        else {\n            invariant(namespace + apiName === type.apiName || apiName === type.apiName, `property key and it's apiName must be identical. ${JSON.stringify({ key: apiName, apiName: type.apiName })}`);\n            return [apiName, type];\n        }\n    }));\n    let extendsInterfaces = [];\n    if (opts.extends) {\n        if (typeof opts.extends === \"string\") {\n            extendsInterfaces = [opts.extends];\n        }\n        else if (Array.isArray(opts.extends)\n            && opts.extends.every(item => typeof item === \"string\")) {\n            extendsInterfaces = opts.extends;\n        }\n        else if (opts.extends.apiName !== undefined) {\n            extendsInterfaces = [opts.extends.apiName];\n        }\n        else {\n            extendsInterfaces = opts.extends.map(item => item.apiName);\n        }\n    }\n    const a = {\n        apiName,\n        displayMetadata: {\n            displayName: opts.displayName ?? opts.apiName,\n            description: opts.description ?? opts.displayName ?? opts.apiName,\n            icon: opts.icon !== undefined\n                ? {\n                    type: \"blueprint\",\n                    blueprint: { color: opts.icon.color, locator: opts.icon.locator },\n                }\n                : undefined,\n        },\n        extendsInterfaces: extendsInterfaces,\n        links: [],\n        properties,\n        status: { type: \"active\", active: {} },\n    };\n    return ontologyDefinition.interfaceTypes[apiName] = a;\n}\nfunction isPropertyTypeType(v) {\n    return v === \"boolean\" || v === \"byte\"\n        || v === \"date\" || v === \"decimal\" || v === \"double\"\n        || v === \"float\" || v === \"geopoint\" || v === \"geoshape\"\n        || v === \"integer\" || v === \"long\"\n        || (typeof v === \"object\" && v.type === \"marking\")\n        || v === \"short\" || v === \"string\"\n        || v === \"timestamp\";\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAOA,SAAS,MAAM,gBAAgB;AACtC,SAASC,SAAS,EAAEC,kBAAkB,QAAQ,qBAAqB;AACnE,SAASC,wBAAwB,QAAQ,gBAAgB;AACzD,OAAO,SAASC,eAAeA,CAACC,IAAI,EAAE;EAClC,MAAMC,OAAO,GAAGL,SAAS,GAAGI,IAAI,CAACC,OAAO;EACxC,EAAUJ,kBAAkB,CAACK,cAAc,CAACD,OAAO,CAAC,KAAKE,SAAS,IAAAC,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAAlEX,SAAS,QAA2D,aAAaM,OAAO,iBAAiB,IAAzGN,SAAS;EACT,MAAMY,UAAU,GAAGC,MAAM,CAACC,WAAW,CAACD,MAAM,CAACE,OAAO,CAACV,IAAI,CAACO,UAAU,IAAI,CAAC,CAAC,CAAC,CAACI,GAAG,CAAC,CAAC,CAACV,OAAO,EAAEW,IAAI,CAAC,KAAK;IACjG,IAAI,OAAOA,IAAI,KAAK,QAAQ,IACpB,OAAOA,IAAI,KAAK,QAAQ,IAAI,EAAE,SAAS,IAAIA,IAAI,CAAE,EAAE;MACvD,CAAUC,kBAAkB,CAACD,IAAI,CAAC,GAAAR,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAAlCX,SAAS,QAA2B,qBAAqBiB,IAAI,iBAAiBX,OAAO,qBAAqBA,OAAO,EAAE,IAAnHN,SAAS;MACT,MAAMmB,GAAG,GAAGhB,wBAAwB,CAAC;QACjCG,OAAO;QACPc,WAAW,EAAEd,OAAO;QACpBW,IAAI;QACJI,KAAK,EAAE;MACX,CAAC,CAAC;MACF,OAAO,CAACf,OAAO,EAAEa,GAAG,CAAC;IACzB,CAAC,MACI;MACD,EAAUlB,SAAS,GAAGK,OAAO,KAAKW,IAAI,CAACX,OAAO,IAAIA,OAAO,KAAKW,IAAI,CAACX,OAAO,IAAAG,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAA1EX,SAAS,QAAmE,oDAAoDsB,IAAI,CAACC,SAAS,CAAC;QAAEC,GAAG,EAAElB,OAAO;QAAEA,OAAO,EAAEW,IAAI,CAACX;MAAQ,CAAC,CAAC,EAAE,IAAzLN,SAAS;MACT,OAAO,CAACM,OAAO,EAAEW,IAAI,CAAC;IAC1B;EACJ,CAAC,CAAC,CAAC;EACH,IAAIQ,iBAAiB,GAAG,EAAE;EAC1B,IAAIpB,IAAI,CAACqB,OAAO,EAAE;IACd,IAAI,OAAOrB,IAAI,CAACqB,OAAO,KAAK,QAAQ,EAAE;MAClCD,iBAAiB,GAAG,CAACpB,IAAI,CAACqB,OAAO,CAAC;IACtC,CAAC,MACI,IAAIC,KAAK,CAACC,OAAO,CAACvB,IAAI,CAACqB,OAAO,CAAC,IAC7BrB,IAAI,CAACqB,OAAO,CAACG,KAAK,CAACC,IAAI,IAAI,OAAOA,IAAI,KAAK,QAAQ,CAAC,EAAE;MACzDL,iBAAiB,GAAGpB,IAAI,CAACqB,OAAO;IACpC,CAAC,MACI,IAAIrB,IAAI,CAACqB,OAAO,CAACpB,OAAO,KAAKE,SAAS,EAAE;MACzCiB,iBAAiB,GAAG,CAACpB,IAAI,CAACqB,OAAO,CAACpB,OAAO,CAAC;IAC9C,CAAC,MACI;MACDmB,iBAAiB,GAAGpB,IAAI,CAACqB,OAAO,CAACV,GAAG,CAACc,IAAI,IAAIA,IAAI,CAACxB,OAAO,CAAC;IAC9D;EACJ;EACA,MAAMyB,CAAC,GAAG;IACNzB,OAAO;IACP0B,eAAe,EAAE;MACbZ,WAAW,EAAEf,IAAI,CAACe,WAAW,IAAIf,IAAI,CAACC,OAAO;MAC7C2B,WAAW,EAAE5B,IAAI,CAAC4B,WAAW,IAAI5B,IAAI,CAACe,WAAW,IAAIf,IAAI,CAACC,OAAO;MACjE4B,IAAI,EAAE7B,IAAI,CAAC6B,IAAI,KAAK1B,SAAS,GACvB;QACES,IAAI,EAAE,WAAW;QACjBkB,SAAS,EAAE;UAAEC,KAAK,EAAE/B,IAAI,CAAC6B,IAAI,CAACE,KAAK;UAAEC,OAAO,EAAEhC,IAAI,CAAC6B,IAAI,CAACG;QAAQ;MACpE,CAAC,GACC7B;IACV,CAAC;IACDiB,iBAAiB,EAAEA,iBAAiB;IACpCa,KAAK,EAAE,EAAE;IACT1B,UAAU;IACV2B,MAAM,EAAE;MAAEtB,IAAI,EAAE,QAAQ;MAAEuB,MAAM,EAAE,CAAC;IAAE;EACzC,CAAC;EACD,OAAOtC,kBAAkB,CAACK,cAAc,CAACD,OAAO,CAAC,GAAGyB,CAAC;AACzD;AACA,SAASb,kBAAkBA,CAACuB,CAAC,EAAE;EAC3B,OAAOA,CAAC,KAAK,SAAS,IAAIA,CAAC,KAAK,MAAM,IAC/BA,CAAC,KAAK,MAAM,IAAIA,CAAC,KAAK,SAAS,IAAIA,CAAC,KAAK,QAAQ,IACjDA,CAAC,KAAK,OAAO,IAAIA,CAAC,KAAK,UAAU,IAAIA,CAAC,KAAK,UAAU,IACrDA,CAAC,KAAK,SAAS,IAAIA,CAAC,KAAK,MAAM,IAC9B,OAAOA,CAAC,KAAK,QAAQ,IAAIA,CAAC,CAACxB,IAAI,KAAK,SAAU,IAC/CwB,CAAC,KAAK,OAAO,IAAIA,CAAC,KAAK,QAAQ,IAC/BA,CAAC,KAAK,WAAW;AAC5B","ignoreList":[]}
+{"version":3,"file":"defineInterface.js","names":["invariant","namespace","ontologyDefinition","defineSharedPropertyType","defineInterface","opts","apiName","interfaceTypes","undefined","process","env","NODE_ENV","properties","Object","fromEntries","entries","map","type","isPropertyTypeType","JSON","stringify","spt","displayName","array","unNamespacedTypeApiName","slice","lastIndexOf","key","extendsInterfaces","extends","Array","isArray","every","item","status","mapSimplifiedStatusToInterfaceTypeStatus","deprecated","message","deadline","a","displayMetadata","description","icon","blueprint","color","locator","links","v","replacedBy","active","experimental","Error"],"sources":["defineInterface.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 invariant from \"tiny-invariant\";\nimport { namespace, ontologyDefinition } from \"./defineOntology.js\";\nimport { defineSharedPropertyType } from \"./defineSpt.js\";\nimport type { BlueprintIcon } from \"./iconNames.js\";\nimport type {\n  InterfaceType,\n  InterfaceTypeStatus,\n  PropertyTypeType,\n  SharedPropertyType,\n} from \"./types.js\";\n\ntype SimplifiedInterfaceTypeStatus =\n  | { type: \"deprecated\"; message: string; deadline: string }\n  | { type: \"active\" }\n  | { type: \"experimental\" };\n\nexport function defineInterface(\n  opts: {\n    apiName: string;\n    displayName?: string;\n    description?: string;\n    icon?: { locator: BlueprintIcon; color: string };\n    status?: SimplifiedInterfaceTypeStatus;\n    properties?: Record<\n      string,\n      SharedPropertyType | PropertyTypeType\n    >;\n\n    extends?: InterfaceType | InterfaceType[] | string | string[];\n  },\n): InterfaceType {\n  const apiName = namespace + opts.apiName;\n  invariant(\n    ontologyDefinition.interfaceTypes[apiName] === undefined,\n    `Interface ${apiName} already exists`,\n  );\n\n  const properties = Object.fromEntries(\n    Object.entries(opts.properties ?? {}).map<\n      [string, SharedPropertyType]\n    >(\n      ([apiName, type]) => {\n        if (\n          typeof type === \"string\"\n          || (typeof type === \"object\" && !(\"apiName\" in type))\n        ) {\n          invariant(\n            isPropertyTypeType(type),\n            `Invalid data type ${\n              JSON.stringify(type)\n            } for property ${apiName} on InterfaceType ${apiName}`,\n          );\n\n          const spt = defineSharedPropertyType({\n            apiName,\n            displayName: apiName,\n            type,\n            array: false,\n          });\n          return [apiName, spt];\n        } else {\n          const unNamespacedTypeApiName = type.apiName.slice(\n            type.apiName.lastIndexOf(\".\") + 1,\n          );\n          invariant(\n            namespace + apiName === type.apiName\n              || apiName === unNamespacedTypeApiName,\n            `property key and it's apiName must be identical. ${\n              JSON.stringify({ key: apiName, apiName: type.apiName })\n            }`,\n          );\n          return [apiName, type];\n        }\n      },\n    ),\n  );\n\n  let extendsInterfaces: string[] = [];\n  if (opts.extends) {\n    if (typeof opts.extends === \"string\") {\n      extendsInterfaces = [opts.extends];\n    } else if (\n      Array.isArray(opts.extends)\n      && opts.extends.every(item => typeof item === \"string\")\n    ) {\n      extendsInterfaces = opts.extends;\n    } else if ((opts.extends as InterfaceType).apiName !== undefined) {\n      extendsInterfaces = [(opts.extends as InterfaceType).apiName];\n    } else {\n      extendsInterfaces = (opts.extends as InterfaceType[]).map(item =>\n        item.apiName\n      );\n    }\n  }\n\n  const status: InterfaceTypeStatus = mapSimplifiedStatusToInterfaceTypeStatus(\n    opts.status ?? { type: \"active\" },\n  );\n\n  invariant(\n    status.type !== \"deprecated\"\n      || (status.deprecated.message && status.deprecated.deadline),\n    `Deprecated status must include message and deadline properties.`,\n  );\n\n  const a: InterfaceType = {\n    apiName,\n    displayMetadata: {\n      displayName: opts.displayName ?? opts.apiName,\n      description: opts.description ?? opts.displayName ?? opts.apiName,\n      icon: opts.icon !== undefined\n        ? {\n          type: \"blueprint\",\n          blueprint: { color: opts.icon.color, locator: opts.icon.locator },\n        }\n        : undefined,\n    },\n    extendsInterfaces: extendsInterfaces,\n    links: [],\n    properties,\n    status,\n  };\n\n  return ontologyDefinition.interfaceTypes[apiName] = a;\n}\n\nfunction isPropertyTypeType(\n  v: PropertyTypeType,\n): v is PropertyTypeType {\n  return v === \"boolean\" || v === \"byte\"\n    || v === \"date\" || v === \"decimal\" || v === \"double\"\n    || v === \"float\" || v === \"geopoint\" || v === \"geoshape\"\n    || v === \"integer\" || v === \"long\"\n    || (typeof v === \"object\" && v.type === \"marking\")\n    || v === \"short\" || v === \"string\"\n    || v === \"timestamp\";\n}\n\nfunction mapSimplifiedStatusToInterfaceTypeStatus(\n  status: SimplifiedInterfaceTypeStatus,\n): InterfaceTypeStatus {\n  switch (status.type) {\n    case \"deprecated\":\n      return {\n        type: \"deprecated\",\n        deprecated: {\n          message: status.message,\n          deadline: status.deadline,\n          replacedBy: undefined,\n        },\n      };\n    case \"active\":\n      return {\n        type: \"active\",\n        active: {},\n      };\n    case \"experimental\":\n      return {\n        type: \"experimental\",\n        experimental: {},\n      };\n    default:\n      throw new Error(`Invalid status type: ${(status as any).type}`);\n  }\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,OAAOA,SAAS,MAAM,gBAAgB;AACtC,SAASC,SAAS,EAAEC,kBAAkB,QAAQ,qBAAqB;AACnE,SAASC,wBAAwB,QAAQ,gBAAgB;AAczD,OAAO,SAASC,eAAeA,CAC7BC,IAYC,EACc;EACf,MAAMC,OAAO,GAAGL,SAAS,GAAGI,IAAI,CAACC,OAAO;EACxC,EACEJ,kBAAkB,CAACK,cAAc,CAACD,OAAO,CAAC,KAAKE,SAAS,IAAAC,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAD1DX,SAAS,QAEP,aAAaM,OAAO,iBAAiB,IAFvCN,SAAS;EAKT,MAAMY,UAAU,GAAGC,MAAM,CAACC,WAAW,CACnCD,MAAM,CAACE,OAAO,CAACV,IAAI,CAACO,UAAU,IAAI,CAAC,CAAC,CAAC,CAACI,GAAG,CAGvC,CAAC,CAACV,OAAO,EAAEW,IAAI,CAAC,KAAK;IACnB,IACE,OAAOA,IAAI,KAAK,QAAQ,IACpB,OAAOA,IAAI,KAAK,QAAQ,IAAI,EAAE,SAAS,IAAIA,IAAI,CAAE,EACrD;MACA,CACEC,kBAAkB,CAACD,IAAI,CAAC,GAAAR,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAD1BX,SAAS,QAEP,qBACEmB,IAAI,CAACC,SAAS,CAACH,IAAI,CAAC,iBACLX,OAAO,qBAAqBA,OAAO,EAAE,IAJxDN,SAAS;MAOT,MAAMqB,GAAG,GAAGlB,wBAAwB,CAAC;QACnCG,OAAO;QACPgB,WAAW,EAAEhB,OAAO;QACpBW,IAAI;QACJM,KAAK,EAAE;MACT,CAAC,CAAC;MACF,OAAO,CAACjB,OAAO,EAAEe,GAAG,CAAC;IACvB,CAAC,MAAM;MACL,MAAMG,uBAAuB,GAAGP,IAAI,CAACX,OAAO,CAACmB,KAAK,CAChDR,IAAI,CAACX,OAAO,CAACoB,WAAW,CAAC,GAAG,CAAC,GAAG,CAClC,CAAC;MACD,EACEzB,SAAS,GAAGK,OAAO,KAAKW,IAAI,CAACX,OAAO,IAC/BA,OAAO,KAAKkB,uBAAuB,IAAAf,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAF1CX,SAAS,QAGP,oDACEmB,IAAI,CAACC,SAAS,CAAC;QAAEO,GAAG,EAAErB,OAAO;QAAEA,OAAO,EAAEW,IAAI,CAACX;MAAQ,CAAC,CAAC,EACvD,IALJN,SAAS;MAOT,OAAO,CAACM,OAAO,EAAEW,IAAI,CAAC;IACxB;EACF,CACF,CACF,CAAC;EAED,IAAIW,iBAA2B,GAAG,EAAE;EACpC,IAAIvB,IAAI,CAACwB,OAAO,EAAE;IAChB,IAAI,OAAOxB,IAAI,CAACwB,OAAO,KAAK,QAAQ,EAAE;MACpCD,iBAAiB,GAAG,CAACvB,IAAI,CAACwB,OAAO,CAAC;IACpC,CAAC,MAAM,IACLC,KAAK,CAACC,OAAO,CAAC1B,IAAI,CAACwB,OAAO,CAAC,IACxBxB,IAAI,CAACwB,OAAO,CAACG,KAAK,CAACC,IAAI,IAAI,OAAOA,IAAI,KAAK,QAAQ,CAAC,EACvD;MACAL,iBAAiB,GAAGvB,IAAI,CAACwB,OAAO;IAClC,CAAC,MAAM,IAAKxB,IAAI,CAACwB,OAAO,CAAmBvB,OAAO,KAAKE,SAAS,EAAE;MAChEoB,iBAAiB,GAAG,CAAEvB,IAAI,CAACwB,OAAO,CAAmBvB,OAAO,CAAC;IAC/D,CAAC,MAAM;MACLsB,iBAAiB,GAAIvB,IAAI,CAACwB,OAAO,CAAqBb,GAAG,CAACiB,IAAI,IAC5DA,IAAI,CAAC3B,OACP,CAAC;IACH;EACF;EAEA,MAAM4B,MAA2B,GAAGC,wCAAwC,CAC1E9B,IAAI,CAAC6B,MAAM,IAAI;IAAEjB,IAAI,EAAE;EAAS,CAClC,CAAC;EAED,EACEiB,MAAM,CAACjB,IAAI,KAAK,YAAY,IACtBiB,MAAM,CAACE,UAAU,CAACC,OAAO,IAAIH,MAAM,CAACE,UAAU,CAACE,QAAS,IAAA7B,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAFhEX,SAAS,QAGP,iEAAiE,IAHnEA,SAAS;EAMT,MAAMuC,CAAgB,GAAG;IACvBjC,OAAO;IACPkC,eAAe,EAAE;MACflB,WAAW,EAAEjB,IAAI,CAACiB,WAAW,IAAIjB,IAAI,CAACC,OAAO;MAC7CmC,WAAW,EAAEpC,IAAI,CAACoC,WAAW,IAAIpC,IAAI,CAACiB,WAAW,IAAIjB,IAAI,CAACC,OAAO;MACjEoC,IAAI,EAAErC,IAAI,CAACqC,IAAI,KAAKlC,SAAS,GACzB;QACAS,IAAI,EAAE,WAAW;QACjB0B,SAAS,EAAE;UAAEC,KAAK,EAAEvC,IAAI,CAACqC,IAAI,CAACE,KAAK;UAAEC,OAAO,EAAExC,IAAI,CAACqC,IAAI,CAACG;QAAQ;MAClE,CAAC,GACCrC;IACN,CAAC;IACDoB,iBAAiB,EAAEA,iBAAiB;IACpCkB,KAAK,EAAE,EAAE;IACTlC,UAAU;IACVsB;EACF,CAAC;EAED,OAAOhC,kBAAkB,CAACK,cAAc,CAACD,OAAO,CAAC,GAAGiC,CAAC;AACvD;AAEA,SAASrB,kBAAkBA,CACzB6B,CAAmB,EACI;EACvB,OAAOA,CAAC,KAAK,SAAS,IAAIA,CAAC,KAAK,MAAM,IACjCA,CAAC,KAAK,MAAM,IAAIA,CAAC,KAAK,SAAS,IAAIA,CAAC,KAAK,QAAQ,IACjDA,CAAC,KAAK,OAAO,IAAIA,CAAC,KAAK,UAAU,IAAIA,CAAC,KAAK,UAAU,IACrDA,CAAC,KAAK,SAAS,IAAIA,CAAC,KAAK,MAAM,IAC9B,OAAOA,CAAC,KAAK,QAAQ,IAAIA,CAAC,CAAC9B,IAAI,KAAK,SAAU,IAC/C8B,CAAC,KAAK,OAAO,IAAIA,CAAC,KAAK,QAAQ,IAC/BA,CAAC,KAAK,WAAW;AACxB;AAEA,SAASZ,wCAAwCA,CAC/CD,MAAqC,EAChB;EACrB,QAAQA,MAAM,CAACjB,IAAI;IACjB,KAAK,YAAY;MACf,OAAO;QACLA,IAAI,EAAE,YAAY;QAClBmB,UAAU,EAAE;UACVC,OAAO,EAAEH,MAAM,CAACG,OAAO;UACvBC,QAAQ,EAAEJ,MAAM,CAACI,QAAQ;UACzBU,UAAU,EAAExC;QACd;MACF,CAAC;IACH,KAAK,QAAQ;MACX,OAAO;QACLS,IAAI,EAAE,QAAQ;QACdgC,MAAM,EAAE,CAAC;MACX,CAAC;IACH,KAAK,cAAc;MACjB,OAAO;QACLhC,IAAI,EAAE,cAAc;QACpBiC,YAAY,EAAE,CAAC;MACjB,CAAC;IACH;MACE,MAAM,IAAIC,KAAK,CAAC,wBAAyBjB,MAAM,CAASjB,IAAI,EAAE,CAAC;EACnE;AACF","ignoreList":[]}

package/build/browser/api/defineInterfaceLinkConstraint.js

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 import invariant from "tiny-invariant";
 import { namespace } from "./defineOntology.js";
 export function defineInterfaceLinkConstraint(linkDef) {
@@ -22,7 +23,7 @@ export function defineInterfaceLinkConstraint(linkDef) {
     cardinality: linkDef.toMany ? "MANY" : "SINGLE",
     linkedEntityTypeId: getLinkedType(linkDef.toMany ?? linkDef.toOne),
     metadata: fromLinkMeta,
-    required: true // TODO: expose this?
+    required: linkDef.required ?? true
   });
 }
 function getLinkedType(t) {

package/build/browser/api/defineInterfaceLinkConstraint.js.map

@@ -1 +1 @@
-{"version":3,"file":"defineInterfaceLinkConstraint.js","names":["invariant","namespace","defineInterfaceLinkConstraint","linkDef","fromLinkMeta","getLinkMeta","from","links","find","a","metadata","apiName","process","env","NODE_ENV","push","cardinality","toMany","linkedEntityTypeId","getLinkedType","toOne","required","t","type","interfaceType","meta","withDefaults","description","displayName"],"sources":["defineInterfaceLinkConstraint.js"],"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 */\nimport invariant from \"tiny-invariant\";\nimport { namespace } from \"./defineOntology.js\";\nexport function defineInterfaceLinkConstraint(linkDef) {\n    const fromLinkMeta = getLinkMeta(linkDef);\n    invariant(linkDef.from.links.find(a => a.metadata.apiName === fromLinkMeta.apiName)\n        == null, `Link with apiName ${fromLinkMeta.apiName} already exists on ${linkDef.apiName}`);\n    linkDef.from.links.push({\n        cardinality: linkDef.toMany ? \"MANY\" : \"SINGLE\",\n        linkedEntityTypeId: getLinkedType(linkDef.toMany ?? linkDef.toOne),\n        metadata: fromLinkMeta,\n        required: true, // TODO: expose this?\n    });\n}\nfunction getLinkedType(t) {\n    return {\n        type: \"interfaceType\",\n        interfaceType: typeof t === \"string\" ? t : t.apiName,\n    };\n}\nfunction getLinkMeta(meta) {\n    return typeof meta === \"string\"\n        ? withDefaults({ apiName: namespace + meta })\n        : withDefaults(meta);\n}\nfunction withDefaults({ apiName, description, displayName }) {\n    return {\n        apiName: namespace + apiName,\n        displayName: displayName ?? apiName,\n        description: description ?? displayName ?? apiName,\n    };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAOA,SAAS,MAAM,gBAAgB;AACtC,SAASC,SAAS,QAAQ,qBAAqB;AAC/C,OAAO,SAASC,6BAA6BA,CAACC,OAAO,EAAE;EACnD,MAAMC,YAAY,GAAGC,WAAW,CAACF,OAAO,CAAC;EACzC,EAAUA,OAAO,CAACG,IAAI,CAACC,KAAK,CAACC,IAAI,CAACC,CAAC,IAAIA,CAAC,CAACC,QAAQ,CAACC,OAAO,KAAKP,YAAY,CAACO,OAAO,CAAC,IAC5E,IAAI,IAAAC,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBADXd,SAAS,QACI,qBAAqBI,YAAY,CAACO,OAAO,sBAAsBR,OAAO,CAACQ,OAAO,EAAE,IAD7FX,SAAS;EAETG,OAAO,CAACG,IAAI,CAACC,KAAK,CAACQ,IAAI,CAAC;IACpBC,WAAW,EAAEb,OAAO,CAACc,MAAM,GAAG,MAAM,GAAG,QAAQ;IAC/CC,kBAAkB,EAAEC,aAAa,CAAChB,OAAO,CAACc,MAAM,IAAId,OAAO,CAACiB,KAAK,CAAC;IAClEV,QAAQ,EAAEN,YAAY;IACtBiB,QAAQ,EAAE,IAAI,CAAE;EACpB,CAAC,CAAC;AACN;AACA,SAASF,aAAaA,CAACG,CAAC,EAAE;EACtB,OAAO;IACHC,IAAI,EAAE,eAAe;IACrBC,aAAa,EAAE,OAAOF,CAAC,KAAK,QAAQ,GAAGA,CAAC,GAAGA,CAAC,CAACX;EACjD,CAAC;AACL;AACA,SAASN,WAAWA,CAACoB,IAAI,EAAE;EACvB,OAAO,OAAOA,IAAI,KAAK,QAAQ,GACzBC,YAAY,CAAC;IAAEf,OAAO,EAAEV,SAAS,GAAGwB;EAAK,CAAC,CAAC,GAC3CC,YAAY,CAACD,IAAI,CAAC;AAC5B;AACA,SAASC,YAAYA,CAAC;EAAEf,OAAO;EAAEgB,WAAW;EAAEC;AAAY,CAAC,EAAE;EACzD,OAAO;IACHjB,OAAO,EAAEV,SAAS,GAAGU,OAAO;IAC5BiB,WAAW,EAAEA,WAAW,IAAIjB,OAAO;IACnCgB,WAAW,EAAEA,WAAW,IAAIC,WAAW,IAAIjB;EAC/C,CAAC;AACL","ignoreList":[]}
+{"version":3,"file":"defineInterfaceLinkConstraint.js","names":["invariant","namespace","defineInterfaceLinkConstraint","linkDef","fromLinkMeta","getLinkMeta","from","links","find","a","metadata","apiName","process","env","NODE_ENV","push","cardinality","toMany","linkedEntityTypeId","getLinkedType","toOne","required","t","type","interfaceType","meta","withDefaults","description","displayName"],"sources":["defineInterfaceLinkConstraint.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 invariant from \"tiny-invariant\";\nimport { namespace } from \"./defineOntology.js\";\nimport type { InterfaceType } from \"./types.js\";\n\ntype Meta = { apiName: string; displayName?: string; description?: string };\ntype ApiNameOrInterfaceType = string | InterfaceType;\n\ntype Many = {\n  apiName: string;\n  from: InterfaceType;\n  toMany: ApiNameOrInterfaceType;\n  toOne?: never;\n  displayName?: string;\n  description?: string;\n  required?: boolean;\n};\ntype One = {\n  apiName: string;\n  from: InterfaceType;\n  toOne: ApiNameOrInterfaceType;\n  toMany?: never;\n  displayName?: string;\n  description?: string;\n  required?: boolean;\n};\n\nexport function defineInterfaceLinkConstraint(\n  linkDef: One | Many,\n): void {\n  const fromLinkMeta = getLinkMeta(linkDef);\n\n  invariant(\n    linkDef.from.links.find(a => a.metadata.apiName === fromLinkMeta.apiName)\n      == null,\n    `Link with apiName ${fromLinkMeta.apiName} already exists on ${linkDef.apiName}`,\n  );\n\n  linkDef.from.links.push({\n    cardinality: linkDef.toMany ? \"MANY\" : \"SINGLE\",\n    linkedEntityTypeId: getLinkedType(linkDef.toMany ?? linkDef.toOne),\n    metadata: fromLinkMeta,\n    required: linkDef.required ?? true,\n  });\n}\n\nfunction getLinkedType(t: string | InterfaceType) {\n  return {\n    type: \"interfaceType\" as const,\n    interfaceType: typeof t === \"string\" ? t : t.apiName,\n  };\n}\n\nfunction getLinkMeta(meta: One | Many) {\n  return typeof meta === \"string\"\n    ? withDefaults({ apiName: namespace + meta })\n    : withDefaults(meta);\n}\n\nfunction withDefaults(\n  { apiName, description, displayName }: Meta,\n): Required<Meta> {\n  return {\n    apiName: namespace + apiName,\n    displayName: displayName ?? apiName,\n    description: description ?? displayName ?? apiName,\n  };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,OAAOA,SAAS,MAAM,gBAAgB;AACtC,SAASC,SAAS,QAAQ,qBAAqB;AAyB/C,OAAO,SAASC,6BAA6BA,CAC3CC,OAAmB,EACb;EACN,MAAMC,YAAY,GAAGC,WAAW,CAACF,OAAO,CAAC;EAEzC,EACEA,OAAO,CAACG,IAAI,CAACC,KAAK,CAACC,IAAI,CAACC,CAAC,IAAIA,CAAC,CAACC,QAAQ,CAACC,OAAO,KAAKP,YAAY,CAACO,OAAO,CAAC,IACpE,IAAI,IAAAC,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAFXd,SAAS,QAGP,qBAAqBI,YAAY,CAACO,OAAO,sBAAsBR,OAAO,CAACQ,OAAO,EAAE,IAHlFX,SAAS;EAMTG,OAAO,CAACG,IAAI,CAACC,KAAK,CAACQ,IAAI,CAAC;IACtBC,WAAW,EAAEb,OAAO,CAACc,MAAM,GAAG,MAAM,GAAG,QAAQ;IAC/CC,kBAAkB,EAAEC,aAAa,CAAChB,OAAO,CAACc,MAAM,IAAId,OAAO,CAACiB,KAAK,CAAC;IAClEV,QAAQ,EAAEN,YAAY;IACtBiB,QAAQ,EAAElB,OAAO,CAACkB,QAAQ,IAAI;EAChC,CAAC,CAAC;AACJ;AAEA,SAASF,aAAaA,CAACG,CAAyB,EAAE;EAChD,OAAO;IACLC,IAAI,EAAE,eAAwB;IAC9BC,aAAa,EAAE,OAAOF,CAAC,KAAK,QAAQ,GAAGA,CAAC,GAAGA,CAAC,CAACX;EAC/C,CAAC;AACH;AAEA,SAASN,WAAWA,CAACoB,IAAgB,EAAE;EACrC,OAAO,OAAOA,IAAI,KAAK,QAAQ,GAC3BC,YAAY,CAAC;IAAEf,OAAO,EAAEV,SAAS,GAAGwB;EAAK,CAAC,CAAC,GAC3CC,YAAY,CAACD,IAAI,CAAC;AACxB;AAEA,SAASC,YAAYA,CACnB;EAAEf,OAAO;EAAEgB,WAAW;EAAEC;AAAkB,CAAC,EAC3B;EAChB,OAAO;IACLjB,OAAO,EAAEV,SAAS,GAAGU,OAAO;IAC5BiB,WAAW,EAAEA,WAAW,IAAIjB,OAAO;IACnCgB,WAAW,EAAEA,WAAW,IAAIC,WAAW,IAAIjB;EAC7C,CAAC;AACH","ignoreList":[]}

package/build/browser/api/defineObject.js

@@ -13,74 +13,69 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 import invariant from "tiny-invariant";
-import { ontologyDefinition } from "./defineOntology.js";
-export function defineObject(apiName, opts) {
+import { namespace, ontologyDefinition } from "./defineOntology.js";
+export function defineObject(objectDef) {
+  const apiName = namespace + objectDef.apiName;
+  const propertyApiNames = (objectDef.properties ?? []).map(val => val.apiName);
+  if (ontologyDefinition.objectTypes[apiName] !== undefined) {
+    throw new Error(`Object type with apiName ${objectDef.apiName} is already defined`);
+  }
+  !propertyApiNames.includes(objectDef.titlePropertyApiName) ? process.env.NODE_ENV !== "production" ? invariant(false, `Title property ${objectDef.titlePropertyApiName} is not defined on object ${objectDef.apiName}`) : invariant(false) : void 0;
+  !(objectDef.primaryKeys.length !== 0) ? process.env.NODE_ENV !== "production" ? invariant(false, `${objectDef.apiName} does not have any primary keys, objects must have at least one primary key`) : invariant(false) : void 0;
+  const nonExistentPrimaryKeys = objectDef.primaryKeys.filter(primaryKey => !objectDef.properties?.map(val => val.apiName).includes(primaryKey));
+  !(nonExistentPrimaryKeys.length === 0) ? process.env.NODE_ENV !== "production" ? invariant(false, `Primary key properties ${nonExistentPrimaryKeys} do not exist on object ${objectDef.apiName}`) : invariant(false) : void 0;
+  objectDef.implementsInterfaces?.forEach(interfaceImpl => {
+    const nonExistentInterfaceProperties = interfaceImpl.propertyMapping.map(val => val.interfaceProperty).filter(interfaceProperty => interfaceImpl.implements.properties[interfaceProperty] === undefined).map(interfaceProp => ({
+      type: "invalid",
+      reason: `Interface property ${interfaceImpl.implements.apiName}.${interfaceProp} referenced in ${objectDef.apiName} object does not exist`
+    }));
+    const interfaceToObjectProperties = Object.fromEntries(interfaceImpl.propertyMapping.map(mapping => [mapping.interfaceProperty, mapping.mapsTo]));
+    const validateProperty = interfaceProp => {
+      if (interfaceProp[1].nonNameSpacedApiName in interfaceToObjectProperties) {
+        return validateInterfaceImplProperty(interfaceProp[1], interfaceToObjectProperties[interfaceProp[0]], objectDef);
+      }
+      return {
+        type: "invalid",
+        reason: `Interface property ${interfaceImpl.implements.apiName}.${interfaceProp[1].nonNameSpacedApiName} not implemented by ${objectDef.apiName} object definition`
+      };
+    };
+    const baseValidations = Object.entries(interfaceImpl.implements.properties).map(validateProperty);
+    const extendsValidations = interfaceImpl.implements.extendsInterfaces.flatMap(interfaceApiName => Object.entries(ontologyDefinition.interfaceTypes[interfaceApiName].properties).map(validateProperty));
+    const allFailedValidations = baseValidations.concat(extendsValidations, nonExistentInterfaceProperties).filter(val => val.type === "invalid");
+    !(allFailedValidations.length === 0) ? process.env.NODE_ENV !== "production" ? invariant(false, "\n" + allFailedValidations.map(formatValidationErrors).join("\n")) : invariant(false) : void 0;
+  });
   ontologyDefinition.objectTypes[apiName] = {
-    implementsInterfaces: [],
-    implementsInterfaces2: {},
-    linkTypes: [],
-    objectType: {
-      apiName,
-      primaryKey: opts.primaryKey.apiName,
-      displayName: opts.displayName ?? apiName,
-      pluralDisplayName: opts.pluralDisplayName ?? apiName,
-      icon: {
-        color: "blue",
-        name: "cube",
-        type: "blueprint"
-      },
-      properties: {
-        [opts.primaryKey.apiName]: {
-          dataType: convertType(opts.primaryKey)
-        }
-      },
-      rid: "PLACEHOLDER",
-      status: "ACTIVE",
-      titleProperty: opts.primaryKey.apiName
-    },
-    sharedPropertyTypeMapping: {}
+    ...objectDef,
+    apiName: apiName
   };
-  // FIXME: don't return the raw value
   return {
-    data: ontologyDefinition.objectTypes[apiName],
-    linkTypes: {}
+    ...objectDef,
+    apiName: apiName
   };
 }
-function convertType(t) {
-  switch (true) {
-    case t.multiplicity === true:
-      return {
-        type: "array",
-        subType: convertType({
-          ...t,
-          multiplicity: false
-        })
-      };
-    case t.type === "stringTimeseries":
-      return {
-        itemType: {
-          type: "string"
-        },
-        type: "timeseries"
-      };
-      break;
-    case t.type === "numericTimeseries":
-      return {
-        itemType: {
-          type: "double"
-        },
-        type: "timeseries"
-      };
-    case t.type === "datetime":
-      return {
-        type: "timestamp"
-      };
-    default:
-      return {
-        type: t.type
-      };
+function formatValidationErrors(error) {
+  return `Ontology Definition Error: ${error.reason}\n`;
+}
+
+// Validate that the object and the interface property match up
+function validateInterfaceImplProperty(spt, mappedObjectProp, object) {
+  const objProp = object.properties?.find(prop => prop.apiName === mappedObjectProp);
+  if (objProp === undefined) {
+    return {
+      type: "invalid",
+      reason: `Object property mapped to interface does not exist. Object Property Mapped: ${mappedObjectProp}`
+    };
+  }
+  if (spt.type !== objProp?.type) {
+    return {
+      type: "invalid",
+      reason: `Object property type does not match the interface property it is mapped to. Interface Property: ${spt.apiName}, objectProperty: ${mappedObjectProp}`
+    };
   }
-  process.env.NODE_ENV !== "production" ? invariant(false) : invariant(false);
+  return {
+    type: "valid"
+  };
 }
 //# sourceMappingURL=defineObject.js.map