@osdk/maker 0.13.0 → 0.14.0-beta.10

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

@@ -0,0 +1,387 @@
+/*
+ * Copyright 2025 Palantir Technologies, Inc. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { beforeEach, describe, expect, it } from "vitest";
+import { defineInterface } from "../defineInterface.js";
+import { defineOntology, dumpOntologyFullMetadata } from "../defineOntology.js";
+import { defineSharedPropertyType } from "../defineSpt.js";
+describe("SPTs", () => {
+  beforeEach(async () => {
+    await defineOntology("com.palantir.", () => {}, "/tmp/");
+  });
+  it("doesn't let you create the same spt twice", () => {
+    defineSharedPropertyType({
+      apiName: "foo",
+      type: "string"
+    });
+    expect(() => {
+      defineSharedPropertyType({
+        apiName: "foo",
+        type: "string"
+      });
+    }).toThrowErrorMatchingInlineSnapshot(`[Error: Invariant failed: Shared property type com.palantir.foo already exists]`);
+  });
+  it("uses a predefined spt", () => {
+    const fooSpt = defineSharedPropertyType({
+      apiName: "fooSpt",
+      type: "string"
+    });
+    defineInterface({
+      apiName: "FooInterface",
+      displayName: "Foo Interface",
+      properties: {
+        fooSpt
+      },
+      icon: {
+        color: "#00000",
+        locator: "airplane"
+      }
+    });
+    expect(dumpOntologyFullMetadata().ontology).toMatchInlineSnapshot(`
+          {
+            "actionTypes": {},
+            "blockPermissionInformation": {
+              "actionTypes": {},
+              "linkTypes": {},
+              "objectTypes": {},
+            },
+            "interfaceTypes": {
+              "com.palantir.FooInterface": {
+                "interfaceType": {
+                  "apiName": "com.palantir.FooInterface",
+                  "displayMetadata": {
+                    "description": "Foo Interface",
+                    "displayName": "Foo Interface",
+                    "icon": {
+                      "blueprint": {
+                        "color": "#00000",
+                        "locator": "airplane",
+                      },
+                      "type": "blueprint",
+                    },
+                  },
+                  "extendsInterfaces": [],
+                  "links": [],
+                  "properties": [],
+                  "propertiesV2": {
+                    "com.palantir.fooSpt": {
+                      "required": true,
+                      "sharedPropertyType": {
+                        "aliases": [],
+                        "apiName": "com.palantir.fooSpt",
+                        "baseFormatter": undefined,
+                        "dataConstraints": undefined,
+                        "displayMetadata": {
+                          "description": undefined,
+                          "displayName": "fooSpt",
+                          "visibility": "NORMAL",
+                        },
+                        "gothamMapping": undefined,
+                        "indexedForSearch": true,
+                        "type": {
+                          "string": {
+                            "analyzerOverride": undefined,
+                            "enableAsciiFolding": undefined,
+                            "isLongText": false,
+                            "supportsEfficientLeadingWildcard": false,
+                            "supportsExactMatching": true,
+                          },
+                          "type": "string",
+                        },
+                        "typeClasses": [
+                          {
+                            "kind": "render_hint",
+                            "name": "SELECTABLE",
+                          },
+                          {
+                            "kind": "render_hint",
+                            "name": "SORTABLE",
+                          },
+                        ],
+                        "valueType": undefined,
+                      },
+                    },
+                  },
+                  "propertiesV3": {},
+                  "searchable": true,
+                  "status": {
+                    "active": {},
+                    "type": "active",
+                  },
+                },
+              },
+            },
+            "linkTypes": {},
+            "objectTypes": {},
+            "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,
+                  "type": {
+                    "string": {
+                      "analyzerOverride": undefined,
+                      "enableAsciiFolding": undefined,
+                      "isLongText": false,
+                      "supportsEfficientLeadingWildcard": false,
+                      "supportsExactMatching": true,
+                    },
+                    "type": "string",
+                  },
+                  "typeClasses": [
+                    {
+                      "kind": "render_hint",
+                      "name": "SELECTABLE",
+                    },
+                    {
+                      "kind": "render_hint",
+                      "name": "SORTABLE",
+                    },
+                  ],
+                  "valueType": undefined,
+                },
+              },
+            },
+          }
+        `);
+  });
+  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().ontology).toMatchInlineSnapshot(`
+                  {
+                    "actionTypes": {},
+                    "blockPermissionInformation": {
+                      "actionTypes": {},
+                      "linkTypes": {},
+                      "objectTypes": {},
+                    },
+                    "interfaceTypes": {},
+                    "linkTypes": {},
+                    "objectTypes": {},
+                    "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,
+                          "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": [],
+                          "valueType": undefined,
+                        },
+                      },
+                    },
+                  }
+          `);
+  });
+  it("Custom string fields properly set", () => {
+    const spt = defineSharedPropertyType({
+      apiName: "foo",
+      type: {
+        type: "string",
+        isLongText: true,
+        supportsEfficientLeadingWildcard: true,
+        supportsExactMatching: false
+      }
+    });
+    defineInterface({
+      apiName: "interface",
+      properties: {
+        foo: spt
+      }
+    });
+    expect(dumpOntologyFullMetadata().ontology).toMatchInlineSnapshot(`
+          {
+            "actionTypes": {},
+            "blockPermissionInformation": {
+              "actionTypes": {},
+              "linkTypes": {},
+              "objectTypes": {},
+            },
+            "interfaceTypes": {
+              "com.palantir.interface": {
+                "interfaceType": {
+                  "apiName": "com.palantir.interface",
+                  "displayMetadata": {
+                    "description": "interface",
+                    "displayName": "interface",
+                    "icon": {
+                      "blueprint": {
+                        "color": "#4C90F0",
+                        "locator": "layout-hierarchy",
+                      },
+                      "type": "blueprint",
+                    },
+                  },
+                  "extendsInterfaces": [],
+                  "links": [],
+                  "properties": [],
+                  "propertiesV2": {
+                    "com.palantir.foo": {
+                      "required": true,
+                      "sharedPropertyType": {
+                        "aliases": [],
+                        "apiName": "com.palantir.foo",
+                        "baseFormatter": undefined,
+                        "dataConstraints": undefined,
+                        "displayMetadata": {
+                          "description": undefined,
+                          "displayName": "foo",
+                          "visibility": "NORMAL",
+                        },
+                        "gothamMapping": undefined,
+                        "indexedForSearch": true,
+                        "type": {
+                          "string": {
+                            "analyzerOverride": undefined,
+                            "enableAsciiFolding": undefined,
+                            "isLongText": true,
+                            "supportsEfficientLeadingWildcard": true,
+                            "supportsExactMatching": false,
+                          },
+                          "type": "string",
+                        },
+                        "typeClasses": [
+                          {
+                            "kind": "render_hint",
+                            "name": "SELECTABLE",
+                          },
+                          {
+                            "kind": "render_hint",
+                            "name": "SORTABLE",
+                          },
+                        ],
+                        "valueType": undefined,
+                      },
+                    },
+                  },
+                  "propertiesV3": {},
+                  "searchable": true,
+                  "status": {
+                    "active": {},
+                    "type": "active",
+                  },
+                },
+              },
+            },
+            "linkTypes": {},
+            "objectTypes": {},
+            "sharedPropertyTypes": {
+              "com.palantir.foo": {
+                "sharedPropertyType": {
+                  "aliases": [],
+                  "apiName": "com.palantir.foo",
+                  "baseFormatter": undefined,
+                  "dataConstraints": undefined,
+                  "displayMetadata": {
+                    "description": undefined,
+                    "displayName": "foo",
+                    "visibility": "NORMAL",
+                  },
+                  "gothamMapping": undefined,
+                  "indexedForSearch": true,
+                  "type": {
+                    "string": {
+                      "analyzerOverride": undefined,
+                      "enableAsciiFolding": undefined,
+                      "isLongText": true,
+                      "supportsEfficientLeadingWildcard": true,
+                      "supportsExactMatching": false,
+                    },
+                    "type": "string",
+                  },
+                  "typeClasses": [
+                    {
+                      "kind": "render_hint",
+                      "name": "SELECTABLE",
+                    },
+                    {
+                      "kind": "render_hint",
+                      "name": "SORTABLE",
+                    },
+                  ],
+                  "valueType": undefined,
+                },
+              },
+            },
+          }
+        `);
+  });
+});
+//# sourceMappingURL=spt.test.js.map

package/build/esm/api/test/spt.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"spt.test.js","names":["beforeEach","describe","expect","it","defineInterface","defineOntology","dumpOntologyFullMetadata","defineSharedPropertyType","apiName","type","toThrowErrorMatchingInlineSnapshot","fooSpt","displayName","properties","icon","color","locator","ontology","toMatchInlineSnapshot","structDefinition","fieldType","displayMetadata","description","undefined","spt","isLongText","supportsEfficientLeadingWildcard","supportsExactMatching","foo"],"sources":["spt.test.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { beforeEach, describe, expect, it } from \"vitest\";\nimport { defineInterface } from \"../defineInterface.js\";\nimport { defineOntology, dumpOntologyFullMetadata } from \"../defineOntology.js\";\nimport { defineSharedPropertyType } from \"../defineSpt.js\";\ndescribe(\"SPTs\", () => {\n  beforeEach(async () => {\n    await defineOntology(\"com.palantir.\", () => {}, \"/tmp/\");\n  });\n\n  it(\"doesn't let you create the same spt twice\", () => {\n    defineSharedPropertyType({\n      apiName: \"foo\",\n      type: \"string\",\n    });\n\n    expect(() => {\n      defineSharedPropertyType({\n        apiName: \"foo\",\n        type: \"string\",\n      });\n    }).toThrowErrorMatchingInlineSnapshot(\n      `[Error: Invariant failed: Shared property type com.palantir.foo already exists]`,\n    );\n  });\n\n  it(\"uses a predefined spt\", () => {\n    const fooSpt = defineSharedPropertyType({\n      apiName: \"fooSpt\",\n      type: \"string\",\n    });\n\n    const FooInterface = defineInterface({\n      apiName: \"FooInterface\",\n      displayName: \"Foo Interface\",\n      properties: {\n        fooSpt,\n      },\n      icon: { color: \"#00000\", locator: \"airplane\" },\n    });\n\n    expect(dumpOntologyFullMetadata().ontology).toMatchInlineSnapshot(`\n          {\n            \"actionTypes\": {},\n            \"blockPermissionInformation\": {\n              \"actionTypes\": {},\n              \"linkTypes\": {},\n              \"objectTypes\": {},\n            },\n            \"interfaceTypes\": {\n              \"com.palantir.FooInterface\": {\n                \"interfaceType\": {\n                  \"apiName\": \"com.palantir.FooInterface\",\n                  \"displayMetadata\": {\n                    \"description\": \"Foo Interface\",\n                    \"displayName\": \"Foo Interface\",\n                    \"icon\": {\n                      \"blueprint\": {\n                        \"color\": \"#00000\",\n                        \"locator\": \"airplane\",\n                      },\n                      \"type\": \"blueprint\",\n                    },\n                  },\n                  \"extendsInterfaces\": [],\n                  \"links\": [],\n                  \"properties\": [],\n                  \"propertiesV2\": {\n                    \"com.palantir.fooSpt\": {\n                      \"required\": true,\n                      \"sharedPropertyType\": {\n                        \"aliases\": [],\n                        \"apiName\": \"com.palantir.fooSpt\",\n                        \"baseFormatter\": undefined,\n                        \"dataConstraints\": undefined,\n                        \"displayMetadata\": {\n                          \"description\": undefined,\n                          \"displayName\": \"fooSpt\",\n                          \"visibility\": \"NORMAL\",\n                        },\n                        \"gothamMapping\": undefined,\n                        \"indexedForSearch\": true,\n                        \"type\": {\n                          \"string\": {\n                            \"analyzerOverride\": undefined,\n                            \"enableAsciiFolding\": undefined,\n                            \"isLongText\": false,\n                            \"supportsEfficientLeadingWildcard\": false,\n                            \"supportsExactMatching\": true,\n                          },\n                          \"type\": \"string\",\n                        },\n                        \"typeClasses\": [\n                          {\n                            \"kind\": \"render_hint\",\n                            \"name\": \"SELECTABLE\",\n                          },\n                          {\n                            \"kind\": \"render_hint\",\n                            \"name\": \"SORTABLE\",\n                          },\n                        ],\n                        \"valueType\": undefined,\n                      },\n                    },\n                  },\n                  \"propertiesV3\": {},\n                  \"searchable\": true,\n                  \"status\": {\n                    \"active\": {},\n                    \"type\": \"active\",\n                  },\n                },\n              },\n            },\n            \"linkTypes\": {},\n            \"objectTypes\": {},\n            \"sharedPropertyTypes\": {\n              \"com.palantir.fooSpt\": {\n                \"sharedPropertyType\": {\n                  \"aliases\": [],\n                  \"apiName\": \"com.palantir.fooSpt\",\n                  \"baseFormatter\": undefined,\n                  \"dataConstraints\": undefined,\n                  \"displayMetadata\": {\n                    \"description\": undefined,\n                    \"displayName\": \"fooSpt\",\n                    \"visibility\": \"NORMAL\",\n                  },\n                  \"gothamMapping\": undefined,\n                  \"indexedForSearch\": true,\n                  \"type\": {\n                    \"string\": {\n                      \"analyzerOverride\": undefined,\n                      \"enableAsciiFolding\": undefined,\n                      \"isLongText\": false,\n                      \"supportsEfficientLeadingWildcard\": false,\n                      \"supportsExactMatching\": true,\n                    },\n                    \"type\": \"string\",\n                  },\n                  \"typeClasses\": [\n                    {\n                      \"kind\": \"render_hint\",\n                      \"name\": \"SELECTABLE\",\n                    },\n                    {\n                      \"kind\": \"render_hint\",\n                      \"name\": \"SORTABLE\",\n                    },\n                  ],\n                  \"valueType\": undefined,\n                },\n              },\n            },\n          }\n        `);\n  });\n\n  it(\"properly serializes both types of struct SPTs\", () => {\n    const fooSpt = defineSharedPropertyType({\n      apiName: \"fooSpt\",\n      type: {\n        type: \"struct\",\n        structDefinition: {\n          \"simpleProperty\": \"boolean\",\n          \"complexProperty\": {\n            fieldType: \"date\",\n            displayMetadata: {\n              displayName: \"complex property\",\n              description: undefined,\n            },\n          },\n        },\n      },\n    });\n\n    expect(dumpOntologyFullMetadata().ontology).toMatchInlineSnapshot(`\n                  {\n                    \"actionTypes\": {},\n                    \"blockPermissionInformation\": {\n                      \"actionTypes\": {},\n                      \"linkTypes\": {},\n                      \"objectTypes\": {},\n                    },\n                    \"interfaceTypes\": {},\n                    \"linkTypes\": {},\n                    \"objectTypes\": {},\n                    \"sharedPropertyTypes\": {\n                      \"com.palantir.fooSpt\": {\n                        \"sharedPropertyType\": {\n                          \"aliases\": [],\n                          \"apiName\": \"com.palantir.fooSpt\",\n                          \"baseFormatter\": undefined,\n                          \"dataConstraints\": undefined,\n                          \"displayMetadata\": {\n                            \"description\": undefined,\n                            \"displayName\": \"fooSpt\",\n                            \"visibility\": \"NORMAL\",\n                          },\n                          \"gothamMapping\": undefined,\n                          \"indexedForSearch\": true,\n                          \"type\": {\n                            \"struct\": {\n                              \"structFields\": [\n                                {\n                                  \"aliases\": [],\n                                  \"apiName\": \"simpleProperty\",\n                                  \"displayMetadata\": {\n                                    \"description\": undefined,\n                                    \"displayName\": \"simpleProperty\",\n                                  },\n                                  \"fieldType\": {\n                                    \"boolean\": {},\n                                    \"type\": \"boolean\",\n                                  },\n                                  \"typeClasses\": [],\n                                },\n                                {\n                                  \"aliases\": [],\n                                  \"apiName\": \"complexProperty\",\n                                  \"displayMetadata\": {\n                                    \"description\": undefined,\n                                    \"displayName\": \"complex property\",\n                                  },\n                                  \"fieldType\": {\n                                    \"date\": {},\n                                    \"type\": \"date\",\n                                  },\n                                  \"typeClasses\": [],\n                                },\n                              ],\n                            },\n                            \"type\": \"struct\",\n                          },\n                          \"typeClasses\": [],\n                          \"valueType\": undefined,\n                        },\n                      },\n                    },\n                  }\n          `);\n  });\n\n  it(\"Custom string fields properly set\", () => {\n    const spt = defineSharedPropertyType({\n      apiName: \"foo\",\n      type: {\n        type: \"string\",\n        isLongText: true,\n        supportsEfficientLeadingWildcard: true,\n        supportsExactMatching: false,\n      },\n    });\n\n    defineInterface({\n      apiName: \"interface\",\n      properties: { foo: spt },\n    });\n\n    expect(dumpOntologyFullMetadata().ontology).toMatchInlineSnapshot(`\n          {\n            \"actionTypes\": {},\n            \"blockPermissionInformation\": {\n              \"actionTypes\": {},\n              \"linkTypes\": {},\n              \"objectTypes\": {},\n            },\n            \"interfaceTypes\": {\n              \"com.palantir.interface\": {\n                \"interfaceType\": {\n                  \"apiName\": \"com.palantir.interface\",\n                  \"displayMetadata\": {\n                    \"description\": \"interface\",\n                    \"displayName\": \"interface\",\n                    \"icon\": {\n                      \"blueprint\": {\n                        \"color\": \"#4C90F0\",\n                        \"locator\": \"layout-hierarchy\",\n                      },\n                      \"type\": \"blueprint\",\n                    },\n                  },\n                  \"extendsInterfaces\": [],\n                  \"links\": [],\n                  \"properties\": [],\n                  \"propertiesV2\": {\n                    \"com.palantir.foo\": {\n                      \"required\": true,\n                      \"sharedPropertyType\": {\n                        \"aliases\": [],\n                        \"apiName\": \"com.palantir.foo\",\n                        \"baseFormatter\": undefined,\n                        \"dataConstraints\": undefined,\n                        \"displayMetadata\": {\n                          \"description\": undefined,\n                          \"displayName\": \"foo\",\n                          \"visibility\": \"NORMAL\",\n                        },\n                        \"gothamMapping\": undefined,\n                        \"indexedForSearch\": true,\n                        \"type\": {\n                          \"string\": {\n                            \"analyzerOverride\": undefined,\n                            \"enableAsciiFolding\": undefined,\n                            \"isLongText\": true,\n                            \"supportsEfficientLeadingWildcard\": true,\n                            \"supportsExactMatching\": false,\n                          },\n                          \"type\": \"string\",\n                        },\n                        \"typeClasses\": [\n                          {\n                            \"kind\": \"render_hint\",\n                            \"name\": \"SELECTABLE\",\n                          },\n                          {\n                            \"kind\": \"render_hint\",\n                            \"name\": \"SORTABLE\",\n                          },\n                        ],\n                        \"valueType\": undefined,\n                      },\n                    },\n                  },\n                  \"propertiesV3\": {},\n                  \"searchable\": true,\n                  \"status\": {\n                    \"active\": {},\n                    \"type\": \"active\",\n                  },\n                },\n              },\n            },\n            \"linkTypes\": {},\n            \"objectTypes\": {},\n            \"sharedPropertyTypes\": {\n              \"com.palantir.foo\": {\n                \"sharedPropertyType\": {\n                  \"aliases\": [],\n                  \"apiName\": \"com.palantir.foo\",\n                  \"baseFormatter\": undefined,\n                  \"dataConstraints\": undefined,\n                  \"displayMetadata\": {\n                    \"description\": undefined,\n                    \"displayName\": \"foo\",\n                    \"visibility\": \"NORMAL\",\n                  },\n                  \"gothamMapping\": undefined,\n                  \"indexedForSearch\": true,\n                  \"type\": {\n                    \"string\": {\n                      \"analyzerOverride\": undefined,\n                      \"enableAsciiFolding\": undefined,\n                      \"isLongText\": true,\n                      \"supportsEfficientLeadingWildcard\": true,\n                      \"supportsExactMatching\": false,\n                    },\n                    \"type\": \"string\",\n                  },\n                  \"typeClasses\": [\n                    {\n                      \"kind\": \"render_hint\",\n                      \"name\": \"SELECTABLE\",\n                    },\n                    {\n                      \"kind\": \"render_hint\",\n                      \"name\": \"SORTABLE\",\n                    },\n                  ],\n                  \"valueType\": undefined,\n                },\n              },\n            },\n          }\n        `);\n  });\n});\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAASA,UAAU,EAAEC,QAAQ,EAAEC,MAAM,EAAEC,EAAE,QAAQ,QAAQ;AACzD,SAASC,eAAe,QAAQ,uBAAuB;AACvD,SAASC,cAAc,EAAEC,wBAAwB,QAAQ,sBAAsB;AAC/E,SAASC,wBAAwB,QAAQ,iBAAiB;AAC1DN,QAAQ,CAAC,MAAM,EAAE,MAAM;EACrBD,UAAU,CAAC,YAAY;IACrB,MAAMK,cAAc,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC;EAC1D,CAAC,CAAC;EAEFF,EAAE,CAAC,2CAA2C,EAAE,MAAM;IACpDI,wBAAwB,CAAC;MACvBC,OAAO,EAAE,KAAK;MACdC,IAAI,EAAE;IACR,CAAC,CAAC;IAEFP,MAAM,CAAC,MAAM;MACXK,wBAAwB,CAAC;QACvBC,OAAO,EAAE,KAAK;QACdC,IAAI,EAAE;MACR,CAAC,CAAC;IACJ,CAAC,CAAC,CAACC,kCAAkC,CACnC,iFACF,CAAC;EACH,CAAC,CAAC;EAEFP,EAAE,CAAC,uBAAuB,EAAE,MAAM;IAChC,MAAMQ,MAAM,GAAGJ,wBAAwB,CAAC;MACtCC,OAAO,EAAE,QAAQ;MACjBC,IAAI,EAAE;IACR,CAAC,CAAC;IAEmBL,eAAe,CAAC;MACnCI,OAAO,EAAE,cAAc;MACvBI,WAAW,EAAE,eAAe;MAC5BC,UAAU,EAAE;QACVF;MACF,CAAC;MACDG,IAAI,EAAE;QAAEC,KAAK,EAAE,QAAQ;QAAEC,OAAO,EAAE;MAAW;IAC/C,CAAC,CAAC;IAEFd,MAAM,CAACI,wBAAwB,CAAC,CAAC,CAACW,QAAQ,CAAC,CAACC,qBAAqB,CAAC;AACtE;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,SAAS,CAAC;EACR,CAAC,CAAC;EAEFf,EAAE,CAAC,+CAA+C,EAAE,MAAM;IACzCI,wBAAwB,CAAC;MACtCC,OAAO,EAAE,QAAQ;MACjBC,IAAI,EAAE;QACJA,IAAI,EAAE,QAAQ;QACdU,gBAAgB,EAAE;UAChB,gBAAgB,EAAE,SAAS;UAC3B,iBAAiB,EAAE;YACjBC,SAAS,EAAE,MAAM;YACjBC,eAAe,EAAE;cACfT,WAAW,EAAE,kBAAkB;cAC/BU,WAAW,EAAEC;YACf;UACF;QACF;MACF;IACF,CAAC,CAAC;IAEFrB,MAAM,CAACI,wBAAwB,CAAC,CAAC,CAACW,QAAQ,CAAC,CAACC,qBAAqB,CAAC;AACtE;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,WAAW,CAAC;EACV,CAAC,CAAC;EAEFf,EAAE,CAAC,mCAAmC,EAAE,MAAM;IAC5C,MAAMqB,GAAG,GAAGjB,wBAAwB,CAAC;MACnCC,OAAO,EAAE,KAAK;MACdC,IAAI,EAAE;QACJA,IAAI,EAAE,QAAQ;QACdgB,UAAU,EAAE,IAAI;QAChBC,gCAAgC,EAAE,IAAI;QACtCC,qBAAqB,EAAE;MACzB;IACF,CAAC,CAAC;IAEFvB,eAAe,CAAC;MACdI,OAAO,EAAE,WAAW;MACpBK,UAAU,EAAE;QAAEe,GAAG,EAAEJ;MAAI;IACzB,CAAC,CAAC;IAEFtB,MAAM,CAACI,wBAAwB,CAAC,CAAC,CAACW,QAAQ,CAAC,CAACC,qBAAqB,CAAC;AACtE;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,SAAS,CAAC;EACR,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}

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

@@ -0,0 +1,156 @@
+/*
+ * Copyright 2025 Palantir Technologies, Inc. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { beforeEach, describe, expect, it } from "vitest";
+import { defineObject } from "../defineObject.js";
+import { defineOntology, dumpOntologyFullMetadata, dumpValueTypeWireType } from "../defineOntology.js";
+import { defineValueType } from "../defineValueType.js";
+describe("Value Types", () => {
+  beforeEach(async () => {
+    await defineOntology("com.palantir.", () => {}, "/tmp/");
+  });
+  it("Fails to define value type with incorrect semver", () => {
+    expect(() => defineValueType({
+      apiName: "apiName",
+      displayName: "displayName",
+      type: {
+        "type": "boolean",
+        constraints: [{
+          constraint: {
+            "allowedValues": ["TRUE_VALUE"]
+          }
+        }]
+      },
+      version: "not a version"
+    })).toThrowErrorMatchingInlineSnapshot("[Error: Invariant failed: Version is not a valid semver]");
+  });
+  it("Tests convertProperty function with valueType constraints for string", () => {
+    const testStringValueType = defineValueType({
+      apiName: "stringWithConstraints",
+      displayName: "String With Constraints",
+      description: "A string type with additional constraints",
+      type: {
+        "type": "string",
+        constraints: [{
+          constraint: {
+            type: "length",
+            length: {
+              minSize: 5,
+              maxSize: 20
+            }
+          },
+          failureMessage: {
+            message: "String must be between 5 and 20 characters"
+          }
+        }]
+      },
+      version: "1.0.0"
+    });
+    defineObject({
+      titlePropertyApiName: "constrainedString",
+      displayName: "Test Object",
+      pluralDisplayName: "Test Objects",
+      apiName: "testObject",
+      primaryKeyPropertyApiName: "constrainedString",
+      properties: {
+        "constrainedString": {
+          type: "string",
+          displayName: "Constrained String",
+          valueType: testStringValueType
+        }
+      }
+    });
+    const ontology = dumpOntologyFullMetadata();
+    const objectPropertyType = ontology.ontology.objectTypes["com.palantir.testObject"].objectType.propertyTypes["constrainedString"];
+    expect(objectPropertyType.valueType).toEqual({
+      apiName: "stringWithConstraints",
+      version: "1.0.0",
+      packageNamespace: "com.palantir",
+      displayMetadata: {
+        displayName: "String With Constraints",
+        description: "A string type with additional constraints"
+      }
+    });
+    expect(objectPropertyType.dataConstraints).toBeDefined();
+    expect(objectPropertyType.dataConstraints?.propertyTypeConstraints).toHaveLength(1);
+    const constraintWrapper = objectPropertyType.dataConstraints?.propertyTypeConstraints[0];
+    expect(constraintWrapper?.constraints?.type).toBe("string");
+    expect((constraintWrapper?.constraints).string.length.minSize).toBe(5);
+    expect((constraintWrapper?.constraints).string.length.maxSize).toBe(20);
+    expect(constraintWrapper?.failureMessage?.message).toBe("String must be between 5 and 20 characters");
+  });
+  it("Correctly serializes a value type", () => {
+    defineValueType({
+      apiName: "apiName",
+      displayName: "displayName",
+      type: {
+        "type": "boolean",
+        constraints: [{
+          constraint: {
+            "allowedValues": ["TRUE_VALUE"]
+          }
+        }]
+      },
+      version: "0.1.0"
+    });
+    expect(dumpValueTypeWireType()).toMatchInlineSnapshot(`
+        {
+          "valueTypes": [
+            {
+              "metadata": {
+                "apiName": "apiName",
+                "displayMetadata": {
+                  "description": "",
+                  "displayName": "displayName",
+                },
+                "packageNamespace": "com.palantir",
+                "status": {
+                  "active": {},
+                  "type": "active",
+                },
+              },
+              "versions": [
+                {
+                  "baseType": {
+                    "boolean": {},
+                    "type": "boolean",
+                  },
+                  "constraints": [
+                    {
+                      "constraint": {
+                        "constraint": {
+                          "boolean": {
+                            "allowedValues": [
+                              "TRUE_VALUE",
+                            ],
+                          },
+                          "type": "boolean",
+                        },
+                        "failureMessage": undefined,
+                      },
+                    },
+                  ],
+                  "exampleValues": [],
+                  "version": "0.1.0",
+                },
+              ],
+            },
+          ],
+        }
+      `);
+  });
+});
+//# sourceMappingURL=valueTypes.test.js.map

package/build/esm/api/test/valueTypes.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"valueTypes.test.js","names":["beforeEach","describe","expect","it","defineObject","defineOntology","dumpOntologyFullMetadata","dumpValueTypeWireType","defineValueType","apiName","displayName","type","constraints","constraint","version","toThrowErrorMatchingInlineSnapshot","testStringValueType","description","length","minSize","maxSize","failureMessage","message","titlePropertyApiName","pluralDisplayName","primaryKeyPropertyApiName","properties","valueType","ontology","objectPropertyType","objectTypes","objectType","propertyTypes","toEqual","packageNamespace","displayMetadata","dataConstraints","toBeDefined","propertyTypeConstraints","toHaveLength","constraintWrapper","toBe","string","toMatchInlineSnapshot"],"sources":["valueTypes.test.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { beforeEach, describe, expect, it } from \"vitest\";\nimport { defineObject } from \"../defineObject.js\";\nimport {\n  defineOntology,\n  dumpOntologyFullMetadata,\n  dumpValueTypeWireType,\n} from \"../defineOntology.js\";\nimport { defineValueType } from \"../defineValueType.js\";\n\ndescribe(\"Value Types\", () => {\n  beforeEach(async () => {\n    await defineOntology(\"com.palantir.\", () => {}, \"/tmp/\");\n  });\n\n  it(\"Fails to define value type with incorrect semver\", () => {\n    expect(() =>\n      defineValueType({\n        apiName: \"apiName\",\n        displayName: \"displayName\",\n        type: {\n          \"type\": \"boolean\",\n          constraints: [{ constraint: { \"allowedValues\": [\"TRUE_VALUE\"] } }],\n        },\n        version: \"not a version\",\n      })\n    ).toThrowErrorMatchingInlineSnapshot(\n      \"[Error: Invariant failed: Version is not a valid semver]\",\n    );\n  });\n\n  it(\"Tests convertProperty function with valueType constraints for string\", () => {\n    const testStringValueType = defineValueType({\n      apiName: \"stringWithConstraints\",\n      displayName: \"String With Constraints\",\n      description: \"A string type with additional constraints\",\n      type: {\n        \"type\": \"string\",\n        constraints: [\n          {\n            constraint: {\n              type: \"length\",\n              length: {\n                minSize: 5,\n                maxSize: 20,\n              },\n            },\n            failureMessage: {\n              message: \"String must be between 5 and 20 characters\",\n            },\n          },\n        ],\n      },\n      version: \"1.0.0\",\n    });\n\n    const object = defineObject({\n      titlePropertyApiName: \"constrainedString\",\n      displayName: \"Test Object\",\n      pluralDisplayName: \"Test Objects\",\n      apiName: \"testObject\",\n      primaryKeyPropertyApiName: \"constrainedString\",\n      properties: {\n        \"constrainedString\": {\n          type: \"string\",\n          displayName: \"Constrained String\",\n          valueType: testStringValueType,\n        },\n      },\n    });\n\n    const ontology = dumpOntologyFullMetadata();\n    const objectPropertyType =\n      ontology.ontology.objectTypes[\"com.palantir.testObject\"]\n        .objectType.propertyTypes[\"constrainedString\"];\n\n    expect(objectPropertyType.valueType).toEqual({\n      apiName: \"stringWithConstraints\",\n      version: \"1.0.0\",\n      packageNamespace: \"com.palantir\",\n      displayMetadata: {\n        displayName: \"String With Constraints\",\n        description: \"A string type with additional constraints\",\n      },\n    });\n\n    expect(objectPropertyType.dataConstraints).toBeDefined();\n    expect(objectPropertyType.dataConstraints?.propertyTypeConstraints)\n      .toHaveLength(1);\n\n    const constraintWrapper = objectPropertyType.dataConstraints\n      ?.propertyTypeConstraints[0];\n    expect(constraintWrapper?.constraints?.type).toBe(\"string\");\n    expect(\n      (constraintWrapper?.constraints as {\n        type: \"string\";\n        string: { length: { minSize: number; maxSize: number } };\n      }).string.length.minSize,\n    ).toBe(5);\n    expect(\n      (constraintWrapper?.constraints as {\n        type: \"string\";\n        string: { length: { minSize: number; maxSize: number } };\n      }).string.length.maxSize,\n    ).toBe(20);\n    expect(constraintWrapper?.failureMessage?.message).toBe(\n      \"String must be between 5 and 20 characters\",\n    );\n  });\n\n  it(\"Correctly serializes a value type\", () => {\n    defineValueType({\n      apiName: \"apiName\",\n      displayName: \"displayName\",\n      type: {\n        \"type\": \"boolean\",\n        constraints: [{ constraint: { \"allowedValues\": [\"TRUE_VALUE\"] } }],\n      },\n      version: \"0.1.0\",\n    });\n    expect(dumpValueTypeWireType()).toMatchInlineSnapshot(`\n        {\n          \"valueTypes\": [\n            {\n              \"metadata\": {\n                \"apiName\": \"apiName\",\n                \"displayMetadata\": {\n                  \"description\": \"\",\n                  \"displayName\": \"displayName\",\n                },\n                \"packageNamespace\": \"com.palantir\",\n                \"status\": {\n                  \"active\": {},\n                  \"type\": \"active\",\n                },\n              },\n              \"versions\": [\n                {\n                  \"baseType\": {\n                    \"boolean\": {},\n                    \"type\": \"boolean\",\n                  },\n                  \"constraints\": [\n                    {\n                      \"constraint\": {\n                        \"constraint\": {\n                          \"boolean\": {\n                            \"allowedValues\": [\n                              \"TRUE_VALUE\",\n                            ],\n                          },\n                          \"type\": \"boolean\",\n                        },\n                        \"failureMessage\": undefined,\n                      },\n                    },\n                  ],\n                  \"exampleValues\": [],\n                  \"version\": \"0.1.0\",\n                },\n              ],\n            },\n          ],\n        }\n      `);\n  });\n});\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAASA,UAAU,EAAEC,QAAQ,EAAEC,MAAM,EAAEC,EAAE,QAAQ,QAAQ;AACzD,SAASC,YAAY,QAAQ,oBAAoB;AACjD,SACEC,cAAc,EACdC,wBAAwB,EACxBC,qBAAqB,QAChB,sBAAsB;AAC7B,SAASC,eAAe,QAAQ,uBAAuB;AAEvDP,QAAQ,CAAC,aAAa,EAAE,MAAM;EAC5BD,UAAU,CAAC,YAAY;IACrB,MAAMK,cAAc,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC;EAC1D,CAAC,CAAC;EAEFF,EAAE,CAAC,kDAAkD,EAAE,MAAM;IAC3DD,MAAM,CAAC,MACLM,eAAe,CAAC;MACdC,OAAO,EAAE,SAAS;MAClBC,WAAW,EAAE,aAAa;MAC1BC,IAAI,EAAE;QACJ,MAAM,EAAE,SAAS;QACjBC,WAAW,EAAE,CAAC;UAAEC,UAAU,EAAE;YAAE,eAAe,EAAE,CAAC,YAAY;UAAE;QAAE,CAAC;MACnE,CAAC;MACDC,OAAO,EAAE;IACX,CAAC,CACH,CAAC,CAACC,kCAAkC,CAClC,0DACF,CAAC;EACH,CAAC,CAAC;EAEFZ,EAAE,CAAC,sEAAsE,EAAE,MAAM;IAC/E,MAAMa,mBAAmB,GAAGR,eAAe,CAAC;MAC1CC,OAAO,EAAE,uBAAuB;MAChCC,WAAW,EAAE,yBAAyB;MACtCO,WAAW,EAAE,2CAA2C;MACxDN,IAAI,EAAE;QACJ,MAAM,EAAE,QAAQ;QAChBC,WAAW,EAAE,CACX;UACEC,UAAU,EAAE;YACVF,IAAI,EAAE,QAAQ;YACdO,MAAM,EAAE;cACNC,OAAO,EAAE,CAAC;cACVC,OAAO,EAAE;YACX;UACF,CAAC;UACDC,cAAc,EAAE;YACdC,OAAO,EAAE;UACX;QACF,CAAC;MAEL,CAAC;MACDR,OAAO,EAAE;IACX,CAAC,CAAC;IAEaV,YAAY,CAAC;MAC1BmB,oBAAoB,EAAE,mBAAmB;MACzCb,WAAW,EAAE,aAAa;MAC1Bc,iBAAiB,EAAE,cAAc;MACjCf,OAAO,EAAE,YAAY;MACrBgB,yBAAyB,EAAE,mBAAmB;MAC9CC,UAAU,EAAE;QACV,mBAAmB,EAAE;UACnBf,IAAI,EAAE,QAAQ;UACdD,WAAW,EAAE,oBAAoB;UACjCiB,SAAS,EAAEX;QACb;MACF;IACF,CAAC,CAAC;IAEF,MAAMY,QAAQ,GAAGtB,wBAAwB,CAAC,CAAC;IAC3C,MAAMuB,kBAAkB,GACtBD,QAAQ,CAACA,QAAQ,CAACE,WAAW,CAAC,yBAAyB,CAAC,CACrDC,UAAU,CAACC,aAAa,CAAC,mBAAmB,CAAC;IAElD9B,MAAM,CAAC2B,kBAAkB,CAACF,SAAS,CAAC,CAACM,OAAO,CAAC;MAC3CxB,OAAO,EAAE,uBAAuB;MAChCK,OAAO,EAAE,OAAO;MAChBoB,gBAAgB,EAAE,cAAc;MAChCC,eAAe,EAAE;QACfzB,WAAW,EAAE,yBAAyB;QACtCO,WAAW,EAAE;MACf;IACF,CAAC,CAAC;IAEFf,MAAM,CAAC2B,kBAAkB,CAACO,eAAe,CAAC,CAACC,WAAW,CAAC,CAAC;IACxDnC,MAAM,CAAC2B,kBAAkB,CAACO,eAAe,EAAEE,uBAAuB,CAAC,CAChEC,YAAY,CAAC,CAAC,CAAC;IAElB,MAAMC,iBAAiB,GAAGX,kBAAkB,CAACO,eAAe,EACxDE,uBAAuB,CAAC,CAAC,CAAC;IAC9BpC,MAAM,CAACsC,iBAAiB,EAAE5B,WAAW,EAAED,IAAI,CAAC,CAAC8B,IAAI,CAAC,QAAQ,CAAC;IAC3DvC,MAAM,CACJ,CAACsC,iBAAiB,EAAE5B,WAAW,EAG5B8B,MAAM,CAACxB,MAAM,CAACC,OACnB,CAAC,CAACsB,IAAI,CAAC,CAAC,CAAC;IACTvC,MAAM,CACJ,CAACsC,iBAAiB,EAAE5B,WAAW,EAG5B8B,MAAM,CAACxB,MAAM,CAACE,OACnB,CAAC,CAACqB,IAAI,CAAC,EAAE,CAAC;IACVvC,MAAM,CAACsC,iBAAiB,EAAEnB,cAAc,EAAEC,OAAO,CAAC,CAACmB,IAAI,CACrD,4CACF,CAAC;EACH,CAAC,CAAC;EAEFtC,EAAE,CAAC,mCAAmC,EAAE,MAAM;IAC5CK,eAAe,CAAC;MACdC,OAAO,EAAE,SAAS;MAClBC,WAAW,EAAE,aAAa;MAC1BC,IAAI,EAAE;QACJ,MAAM,EAAE,SAAS;QACjBC,WAAW,EAAE,CAAC;UAAEC,UAAU,EAAE;YAAE,eAAe,EAAE,CAAC,YAAY;UAAE;QAAE,CAAC;MACnE,CAAC;MACDC,OAAO,EAAE;IACX,CAAC,CAAC;IACFZ,MAAM,CAACK,qBAAqB,CAAC,CAAC,CAAC,CAACoC,qBAAqB,CAAC;AAC1D;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,OAAO,CAAC;EACN,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}