@osdk/maker 0.11.0-beta.2 → 0.11.0-beta.3

package/build/cjs/index.d.cts

@@ -458,6 +458,7 @@ declare function importSharedPropertyType(opts: {
     apiName: string;
     packageName?: string;
     typeHint: PropertyTypeType;
+    array?: boolean;
 }): SharedPropertyType;
 
 type SimplifiedInterfaceTypeStatus = {

package/build/esm/api/defineImportSpt.js

@@ -25,7 +25,8 @@ export function importSharedPropertyType(opts) {
   const {
     apiName,
     packageName,
-    typeHint
+    typeHint,
+    array
   } = opts;
   const fullApiName = packageName === undefined ? apiName : `${packageName}.${apiName}`;
   if (packageName !== undefined) {
@@ -36,6 +37,7 @@ export function importSharedPropertyType(opts) {
     apiName: fullApiName,
     type: typeHint,
     nonNameSpacedApiName: apiName,
+    array: array ?? false,
     __type: OntologyEntityTypeEnum.SHARED_PROPERTY_TYPE
   };
   importOntologyEntity(spt);

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

@@ -1 +1 @@
-{"version":3,"file":"defineImportSpt.js","names":["invariant","importOntologyEntity","OntologyEntityTypeEnum","importSharedPropertyType","opts","apiName","packageName","typeHint","fullApiName","undefined","endsWith","process","env","NODE_ENV","match","spt","type","nonNameSpacedApiName","__type","SHARED_PROPERTY_TYPE"],"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 { importOntologyEntity } from \"./importOntologyEntity.js\";\nimport {\n  OntologyEntityTypeEnum,\n  type PropertyTypeType,\n  type SharedPropertyType,\n} 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  const fullApiName = packageName === undefined\n    ? apiName\n    : `${packageName}.${apiName}`;\n  if (packageName !== undefined) {\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  const spt: SharedPropertyType = {\n    apiName: fullApiName,\n    type: typeHint,\n    nonNameSpacedApiName: apiName,\n    __type: OntologyEntityTypeEnum.SHARED_PROPERTY_TYPE,\n  };\n  importOntologyEntity(spt);\n  return spt;\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,oBAAoB,QAAQ,2BAA2B;AAChE,SACEC,sBAAsB,QAGjB,YAAY;;AAEnB;AACA;AACA;AACA,OAAO,SAASC,wBAAwBA,CACtCC,IAIC,EACmB;EACpB,MAAM;IAAEC,OAAO;IAAEC,WAAW;IAAEC;EAAS,CAAC,GAAGH,IAAI;EAC/C,MAAMI,WAAW,GAAGF,WAAW,KAAKG,SAAS,GACzCJ,OAAO,GACP,GAAGC,WAAW,IAAID,OAAO,EAAE;EAC/B,IAAIC,WAAW,KAAKG,SAAS,EAAE;IAC7B,CACE,CAACH,WAAW,CAACI,QAAQ,CAAC,GAAG,CAAC,GAAAC,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAD5Bb,SAAS,QAEP,8CAA8C,IAFhDA,SAAS;IAKT,EACEM,WAAW,CAACQ,KAAK,CAAC,OAAO,CAAC,IAAI,IAAI,IAAAH,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBADpCb,SAAS,QAEP,6CAA6C,IAF/CA,SAAS;EAIX;EACA,MAAMe,GAAuB,GAAG;IAC9BV,OAAO,EAAEG,WAAW;IACpBQ,IAAI,EAAET,QAAQ;IACdU,oBAAoB,EAAEZ,OAAO;IAC7Ba,MAAM,EAAEhB,sBAAsB,CAACiB;EACjC,CAAC;EACDlB,oBAAoB,CAACc,GAAG,CAAC;EACzB,OAAOA,GAAG;AACZ","ignoreList":[]}
+{"version":3,"file":"defineImportSpt.js","names":["invariant","importOntologyEntity","OntologyEntityTypeEnum","importSharedPropertyType","opts","apiName","packageName","typeHint","array","fullApiName","undefined","endsWith","process","env","NODE_ENV","match","spt","type","nonNameSpacedApiName","__type","SHARED_PROPERTY_TYPE"],"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 { importOntologyEntity } from \"./importOntologyEntity.js\";\nimport {\n  OntologyEntityTypeEnum,\n  type PropertyTypeType,\n  type SharedPropertyType,\n} 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    array?: boolean;\n  },\n): SharedPropertyType {\n  const { apiName, packageName, typeHint, array } = opts;\n  const fullApiName = packageName === undefined\n    ? apiName\n    : `${packageName}.${apiName}`;\n  if (packageName !== undefined) {\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  const spt: SharedPropertyType = {\n    apiName: fullApiName,\n    type: typeHint,\n    nonNameSpacedApiName: apiName,\n    array: array ?? false,\n    __type: OntologyEntityTypeEnum.SHARED_PROPERTY_TYPE,\n  };\n  importOntologyEntity(spt);\n  return spt;\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,oBAAoB,QAAQ,2BAA2B;AAChE,SACEC,sBAAsB,QAGjB,YAAY;;AAEnB;AACA;AACA;AACA,OAAO,SAASC,wBAAwBA,CACtCC,IAKC,EACmB;EACpB,MAAM;IAAEC,OAAO;IAAEC,WAAW;IAAEC,QAAQ;IAAEC;EAAM,CAAC,GAAGJ,IAAI;EACtD,MAAMK,WAAW,GAAGH,WAAW,KAAKI,SAAS,GACzCL,OAAO,GACP,GAAGC,WAAW,IAAID,OAAO,EAAE;EAC/B,IAAIC,WAAW,KAAKI,SAAS,EAAE;IAC7B,CACE,CAACJ,WAAW,CAACK,QAAQ,CAAC,GAAG,CAAC,GAAAC,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAD5Bd,SAAS,QAEP,8CAA8C,IAFhDA,SAAS;IAKT,EACEM,WAAW,CAACS,KAAK,CAAC,OAAO,CAAC,IAAI,IAAI,IAAAH,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBADpCd,SAAS,QAEP,6CAA6C,IAF/CA,SAAS;EAIX;EACA,MAAMgB,GAAuB,GAAG;IAC9BX,OAAO,EAAEI,WAAW;IACpBQ,IAAI,EAAEV,QAAQ;IACdW,oBAAoB,EAAEb,OAAO;IAC7BG,KAAK,EAAEA,KAAK,IAAI,KAAK;IACrBW,MAAM,EAAEjB,sBAAsB,CAACkB;EACjC,CAAC;EACDnB,oBAAoB,CAACe,GAAG,CAAC;EACzB,OAAOA,GAAG;AACZ","ignoreList":[]}

package/build/esm/api/overall.test.js

@@ -18,6 +18,7 @@ import * as fs from "fs";
 import path from "path";
 import { beforeEach, describe, expect, it } from "vitest";
 import { defineAction, defineCreateInterfaceObjectAction, defineCreateObjectAction, defineDeleteObjectAction, defineModifyInterfaceObjectAction, defineModifyObjectAction } from "./defineAction.js";
+import { importSharedPropertyType } from "./defineImportSpt.js";
 import { defineInterface } from "./defineInterface.js";
 import { defineInterfaceLinkConstraint } from "./defineInterfaceLinkConstraint.js";
 import { defineLink } from "./defineLink.js";
@@ -5133,6 +5134,110 @@ describe("Ontology Defining", () => {
     });
   });
   describe("Imports", () => {
+    it("Legacy importing works", () => {
+      const id = importSharedPropertyType({
+        apiName: "id",
+        packageName: "com.palantir.core.ontology.types",
+        typeHint: "string"
+      });
+      defineInterface({
+        apiName: "myInterface",
+        properties: {
+          id
+        }
+      });
+      expect(dumpOntologyFullMetadata()).toMatchInlineSnapshot(`
+        {
+          "blockData": {
+            "actionTypes": {},
+            "blockPermissionInformation": {
+              "actionTypes": {},
+              "linkTypes": {},
+              "objectTypes": {},
+            },
+            "interfaceTypes": {
+              "com.palantir.myInterface": {
+                "interfaceType": {
+                  "allExtendsInterfaces": [],
+                  "allLinks": [],
+                  "allProperties": [],
+                  "allPropertiesV2": {},
+                  "apiName": "com.palantir.myInterface",
+                  "displayMetadata": {
+                    "description": "myInterface",
+                    "displayName": "myInterface",
+                    "icon": undefined,
+                  },
+                  "extendsInterfaces": [],
+                  "links": [],
+                  "properties": [],
+                  "propertiesV2": {
+                    "com.palantir.core.ontology.types.id": {
+                      "required": true,
+                      "sharedPropertyType": {
+                        "aliases": [],
+                        "apiName": "com.palantir.core.ontology.types.id",
+                        "baseFormatter": undefined,
+                        "dataConstraints": undefined,
+                        "displayMetadata": {
+                          "description": undefined,
+                          "displayName": "com.palantir.core.ontology.types.id",
+                          "visibility": "NORMAL",
+                        },
+                        "gothamMapping": undefined,
+                        "indexedForSearch": true,
+                        "type": {
+                          "string": {
+                            "analyzerOverride": undefined,
+                            "enableAsciiFolding": undefined,
+                            "isLongText": false,
+                            "supportsEfficientLeadingWildcard": false,
+                            "supportsExactMatching": true,
+                          },
+                          "type": "string",
+                        },
+                        "typeClasses": [],
+                        "valueType": undefined,
+                      },
+                    },
+                  },
+                  "status": {
+                    "active": {},
+                    "type": "active",
+                  },
+                },
+              },
+            },
+            "linkTypes": {},
+            "objectTypes": {},
+            "sharedPropertyTypes": {},
+          },
+          "importedTypes": {
+            "actionTypes": [],
+            "interfaceTypes": [],
+            "linkTypes": [],
+            "objectTypes": [],
+            "sharedPropertyTypes": [
+              {
+                "apiName": "com.palantir.core.ontology.types.id",
+                "description": undefined,
+                "displayName": "com.palantir.core.ontology.types.id",
+                "type": {
+                  "string": {
+                    "analyzerOverride": undefined,
+                    "enableAsciiFolding": undefined,
+                    "isLongText": false,
+                    "supportsEfficientLeadingWildcard": false,
+                    "supportsExactMatching": true,
+                  },
+                  "type": "string",
+                },
+              },
+            ],
+          },
+        }
+      `);
+    });
     it("Simple importing works", () => {
       // does the same as "import { spt } from '@other/package'"
       const spt = {