@osdk/maker 0.9.0-beta.2 → 0.9.0-beta.21

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

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 import { beforeEach, describe, expect, it } from "vitest";
+import { importSharedPropertyType } from "./defineImportSpt.js";
 import { defineInterface } from "./defineInterface.js";
 import { defineInterfaceLinkConstraint } from "./defineInterfaceLinkConstraint.js";
 import { defineOntology, dumpOntologyFullMetadata, dumpValueTypeWireType } from "./defineOntology.js";
@@ -28,15 +29,11 @@ describe("Ontology Defining", () => {
       expect(() => defineValueType({
         apiName: "apiName",
         displayName: "displayName",
-        typeAndConstraints: {
-          baseType: {
-            boolean: {}
-          },
+        type: {
+          "type": "boolean",
           constraints: [{
             constraint: {
-              boolean: {
-                allowedValues: ["TRUE_VALUE"]
-              }
+              "allowedValues": ["TRUE_VALUE"]
             }
           }]
         },
@@ -47,61 +44,59 @@ describe("Ontology Defining", () => {
       defineValueType({
         apiName: "apiName",
         displayName: "displayName",
-        typeAndConstraints: {
-          baseType: {
-            boolean: {}
-          },
+        type: {
+          "type": "boolean",
           constraints: [{
             constraint: {
-              boolean: {
-                allowedValues: ["TRUE_VALUE"]
-              }
+              "allowedValues": ["TRUE_VALUE"]
             }
           }]
         },
         version: "0.1.0"
       });
       expect(dumpValueTypeWireType()).toMatchInlineSnapshot(`
+ {
+   "valueTypes": [
+     {
+       "metadata": {
+         "apiName": "apiName",
+         "displayMetadata": {
+           "description": "",
+           "displayName": "displayName",
+         },
+         "status": {
+           "active": {},
+           "type": "active",
+         },
+       },
+       "versions": [
          {
-            "valueTypes": [
-              {
-                "metadata": {
-                  "apiName": "apiName",
-                  "displayMetadata": {
-                    "description": "",
-                    "displayName": "displayName",
-                  },
-                  "status": {
-                    "active": {},
-                    "type": "active",
-                  },
-                },
-                "versions": [
-                  {
-                    "baseType": {
-                      "boolean": {},
-                    },
-                    "constraints": [
-                      {
-                        "constraint": {
-                          "boolean": "boolean",
-                          "constraint": {
-                            "boolean": {
-                              "allowedValues": [
-                                "TRUE_VALUE",
-                              ],
-                            },
-                          },
-                        },
-                      },
-                    ],
-                    "exampleValues": [],
-                    "version": "0.1.0",
-                  },
-                ],
-              },
-            ],
-          }
+           "baseType": {
+             "boolean": {},
+             "type": "boolean",
+           },
+           "constraints": [
+             {
+               "constraint": {
+                 "constraint": {
+                   "boolean": {
+                     "allowedValues": [
+                       "TRUE_VALUE",
+                     ],
+                   },
+                   "type": "boolean",
+                 },
+                 "failureMessage": undefined,
+               },
+             },
+           ],
+           "exampleValues": [],
+           "version": "0.1.0",
+         },
+       ],
+     },
+   ],
+ }
         `);
     });
     defineOntology("com.palantir.", () => {});
@@ -144,7 +139,7 @@ describe("Ontology Defining", () => {
             foo: "string"
           }
         });
-        expect(dumpOntologyFullMetadata()).toMatchInlineSnapshot(`
+        expect(dumpOntologyFullMetadata().blockData).toMatchInlineSnapshot(`
           {
             "blockPermissionInformation": {
               "actionTypes": {},
@@ -254,7 +249,7 @@ describe("Ontology Defining", () => {
           apiName: "foo",
           type: "string"
         });
-        expect(dumpOntologyFullMetadata()).toMatchInlineSnapshot(`
+        expect(dumpOntologyFullMetadata().blockData).toMatchInlineSnapshot(`
           {
             "blockPermissionInformation": {
               "actionTypes": {},
@@ -326,7 +321,7 @@ describe("Ontology Defining", () => {
         },
         extends: [parentInterface]
       });
-      expect(dumpOntologyFullMetadata()).toMatchInlineSnapshot(`
+      expect(dumpOntologyFullMetadata().blockData).toMatchInlineSnapshot(`
         {
           "blockPermissionInformation": {
             "actionTypes": {},
@@ -538,7 +533,7 @@ describe("Ontology Defining", () => {
         },
         extends: ["parentInterface"]
       });
-      expect(dumpOntologyFullMetadata()).toMatchInlineSnapshot(`
+      expect(dumpOntologyFullMetadata().blockData).toMatchInlineSnapshot(`
         {
           "blockPermissionInformation": {
             "actionTypes": {},
@@ -755,7 +750,7 @@ describe("Ontology Defining", () => {
         toOne: b,
         apiName: "singleLink"
       });
-      expect(dumpOntologyFullMetadata()).toMatchInlineSnapshot(`
+      expect(dumpOntologyFullMetadata().blockData).toMatchInlineSnapshot(`
         {
           "blockPermissionInformation": {
             "actionTypes": {},
@@ -828,7 +823,7 @@ describe("Ontology Defining", () => {
         toMany: b,
         apiName: "manyLink"
       });
-      expect(dumpOntologyFullMetadata()).toMatchInlineSnapshot(`
+      expect(dumpOntologyFullMetadata().blockData).toMatchInlineSnapshot(`
         {
           "blockPermissionInformation": {
             "actionTypes": {},
@@ -926,7 +921,7 @@ describe("Ontology Defining", () => {
         locator: "airplane"
       }
     });
-    expect(dumpOntologyFullMetadata()).toMatchInlineSnapshot(`
+    expect(dumpOntologyFullMetadata().blockData).toMatchInlineSnapshot(`
       {
         "blockPermissionInformation": {
           "actionTypes": {},
@@ -1037,5 +1032,301 @@ describe("Ontology Defining", () => {
       }
     `);
   });
+  it("properly serializes both types of struct SPTs", () => {
+    defineSharedPropertyType({
+      apiName: "fooSpt",
+      type: {
+        type: "struct",
+        structDefinition: {
+          "simpleProperty": "boolean",
+          "complexProperty": {
+            fieldType: "date",
+            displayMetadata: {
+              displayName: "complex property",
+              description: undefined
+            }
+          }
+        }
+      }
+    });
+    expect(dumpOntologyFullMetadata().blockData).toMatchInlineSnapshot(`
+              {
+                "blockPermissionInformation": {
+                  "actionTypes": {},
+                  "linkTypes": {},
+                  "objectTypes": {},
+                },
+                "interfaceTypes": {},
+                "sharedPropertyTypes": {
+                  "com.palantir.fooSpt": {
+                    "sharedPropertyType": {
+                      "aliases": [],
+                      "apiName": "com.palantir.fooSpt",
+                      "baseFormatter": undefined,
+                      "dataConstraints": undefined,
+                      "displayMetadata": {
+                        "description": undefined,
+                        "displayName": "fooSpt",
+                        "visibility": "NORMAL",
+                      },
+                      "gothamMapping": undefined,
+                      "indexedForSearch": true,
+                      "provenance": undefined,
+                      "type": {
+                        "struct": {
+                          "structFields": [
+                            {
+                              "aliases": [],
+                              "apiName": "simpleProperty",
+                              "displayMetadata": {
+                                "description": undefined,
+                                "displayName": "simpleProperty",
+                              },
+                              "fieldType": {
+                                "boolean": {},
+                                "type": "boolean",
+                              },
+                              "typeClasses": [],
+                            },
+                            {
+                              "aliases": [],
+                              "apiName": "complexProperty",
+                              "displayMetadata": {
+                                "description": undefined,
+                                "displayName": "complex property",
+                              },
+                              "fieldType": {
+                                "date": {},
+                                "type": "date",
+                              },
+                              "typeClasses": [],
+                            },
+                          ],
+                        },
+                        "type": "struct",
+                      },
+                      "typeClasses": [
+                        {
+                          "kind": "render_hint",
+                          "name": "SELECTABLE",
+                        },
+                        {
+                          "kind": "render_hint",
+                          "name": "SORTABLE",
+                        },
+                      ],
+                      "valueType": undefined,
+                    },
+                  },
+                },
+              }
+      `);
+  });
+  it("Adds imported SPTs only to the interface definition", () => {
+    const regularSpt = defineSharedPropertyType({
+      apiName: "foo",
+      type: {
+        type: "marking",
+        markingType: "CBAC"
+      }
+    });
+    const importedSpt = importSharedPropertyType({
+      apiName: "bar",
+      typeHint: "string",
+      packageName: "com.palantir.bar"
+    });
+    defineInterface({
+      apiName: "interface",
+      properties: {
+        foo: regularSpt,
+        bar: importedSpt
+      }
+    });
+    expect(dumpOntologyFullMetadata().blockData).toMatchInlineSnapshot(`
+      {
+        "blockPermissionInformation": {
+          "actionTypes": {},
+          "linkTypes": {},
+          "objectTypes": {},
+        },
+        "interfaceTypes": {
+          "com.palantir.interface": {
+            "interfaceType": {
+              "allExtendsInterfaces": [],
+              "allLinks": [],
+              "allProperties": [],
+              "apiName": "com.palantir.interface",
+              "displayMetadata": {
+                "description": "interface",
+                "displayName": "interface",
+                "icon": undefined,
+              },
+              "extendsInterfaces": [],
+              "links": [],
+              "properties": [
+                {
+                  "aliases": [],
+                  "apiName": "com.palantir.foo",
+                  "baseFormatter": undefined,
+                  "dataConstraints": {
+                    "nullability": "NO_EXPLICIT_NULLS",
+                    "nullabilityV2": {
+                      "noEmptyCollections": true,
+                      "noNulls": true,
+                    },
+                    "propertyTypeConstraints": [],
+                  },
+                  "displayMetadata": {
+                    "description": undefined,
+                    "displayName": "foo",
+                    "visibility": "NORMAL",
+                  },
+                  "gothamMapping": undefined,
+                  "indexedForSearch": true,
+                  "provenance": undefined,
+                  "type": {
+                    "marking": {
+                      "markingType": "CBAC",
+                    },
+                    "type": "marking",
+                  },
+                  "typeClasses": [
+                    {
+                      "kind": "render_hint",
+                      "name": "SELECTABLE",
+                    },
+                    {
+                      "kind": "render_hint",
+                      "name": "SORTABLE",
+                    },
+                  ],
+                  "valueType": undefined,
+                },
+                {
+                  "aliases": [],
+                  "apiName": "com.palantir.bar.bar",
+                  "baseFormatter": undefined,
+                  "dataConstraints": undefined,
+                  "displayMetadata": {
+                    "description": undefined,
+                    "displayName": "com.palantir.bar.bar",
+                    "visibility": "NORMAL",
+                  },
+                  "gothamMapping": undefined,
+                  "indexedForSearch": true,
+                  "provenance": undefined,
+                  "type": {
+                    "string": {
+                      "analyzerOverride": undefined,
+                      "enableAsciiFolding": undefined,
+                      "isLongText": false,
+                      "supportsExactMatching": true,
+                    },
+                    "type": "string",
+                  },
+                  "typeClasses": [],
+                  "valueType": undefined,
+                },
+              ],
+              "status": {
+                "active": {},
+                "type": "active",
+              },
+            },
+          },
+        },
+        "sharedPropertyTypes": {
+          "com.palantir.foo": {
+            "sharedPropertyType": {
+              "aliases": [],
+              "apiName": "com.palantir.foo",
+              "baseFormatter": undefined,
+              "dataConstraints": {
+                "nullability": "NO_EXPLICIT_NULLS",
+                "nullabilityV2": {
+                  "noEmptyCollections": true,
+                  "noNulls": true,
+                },
+                "propertyTypeConstraints": [],
+              },
+              "displayMetadata": {
+                "description": undefined,
+                "displayName": "foo",
+                "visibility": "NORMAL",
+              },
+              "gothamMapping": undefined,
+              "indexedForSearch": true,
+              "provenance": undefined,
+              "type": {
+                "marking": {
+                  "markingType": "CBAC",
+                },
+                "type": "marking",
+              },
+              "typeClasses": [
+                {
+                  "kind": "render_hint",
+                  "name": "SELECTABLE",
+                },
+                {
+                  "kind": "render_hint",
+                  "name": "SORTABLE",
+                },
+              ],
+              "valueType": undefined,
+            },
+          },
+        },
+      }
+      `);
+    expect(dumpOntologyFullMetadata().importedTypes).toMatchInlineSnapshot(`
+       {
+         "sharedPropertyTypes": [
+           {
+             "apiName": "bar",
+             "packageName": "com.palantir.bar",
+           },
+         ],
+       }
+    `);
+  });
+  it("defaults interface status to active", () => {
+    const result = defineInterface({
+      apiName: "Foo"
+    });
+    expect(result.status).toEqual({
+      type: "active",
+      active: {}
+    });
+  });
+  it("sets interface status as experimental from opts as typed", () => {
+    const result = defineInterface({
+      apiName: "Foo",
+      status: {
+        type: "experimental"
+      }
+    });
+    expect(result.status).toEqual({
+      type: "experimental",
+      experimental: {}
+    });
+  });
+  it("sets interface status as deprecated from opts as typed", () => {
+    const result = defineInterface({
+      apiName: "Foo",
+      status: {
+        type: "deprecated",
+        message: "foo",
+        deadline: "foo"
+      }
+    });
+    expect(result.status).toEqual({
+      type: "deprecated",
+      deprecated: {
+        message: "foo",
+        deadline: "foo"
+      }
+    });
+  });
 });
 //# sourceMappingURL=overall.test.js.map