@osdk/maker 0.9.0-beta.3 → 0.9.0-beta.30

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

@@ -1 +1 @@
-{"version":3,"file":"defineInterface.js","names":["invariant","namespace","ontologyDefinition","defineSharedPropertyType","defineInterface","opts","apiName","interfaceTypes","undefined","properties","Object","fromEntries","entries","map","type","isSimpleType","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            invariant(isSimpleType(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, `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 isSimpleType(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\" || v === \"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,IAAlER,SAAS,QAA2D,aAAaM,OAAO,iBAAiB;EACzG,MAAMG,UAAU,GAAGC,MAAM,CAACC,WAAW,CAACD,MAAM,CAACE,OAAO,CAACP,IAAI,CAACI,UAAU,IAAI,CAAC,CAAC,CAAC,CAACI,GAAG,CAAC,CAAC,CAACP,OAAO,EAAEQ,IAAI,CAAC,KAAK;IACjG,IAAI,OAAOA,IAAI,KAAK,QAAQ,EAAE;MAC1B,CAAUC,YAAY,CAACD,IAAI,CAAC,GAA5Bd,SAAS,QAAqB,qBAAqBc,IAAI,iBAAiBR,OAAO,qBAAqBA,OAAO,EAAE;MAC7G,MAAMU,GAAG,GAAGb,wBAAwB,CAAC;QACjCG,OAAO;QACPW,WAAW,EAAEX,OAAO;QACpBQ,IAAI;QACJI,KAAK,EAAE;MACX,CAAC,CAAC;MACF,OAAO,CAACZ,OAAO,EAAEU,GAAG,CAAC;IACzB,CAAC,MACI;MACD,EAAUf,SAAS,GAAGK,OAAO,KAAKQ,IAAI,CAACR,OAAO,IAA9CN,SAAS,QAAuC,oDAAoDmB,IAAI,CAACC,SAAS,CAAC;QAAEC,GAAG,EAAEf,OAAO;QAAEA,OAAO,EAAEQ,IAAI,CAACR;MAAQ,CAAC,CAAC,EAAE;MAC7J,OAAO,CAACA,OAAO,EAAEQ,IAAI,CAAC;IAC1B;EACJ,CAAC,CAAC,CAAC;EACH,IAAIQ,iBAAiB,GAAG,EAAE;EAC1B,IAAIjB,IAAI,CAACkB,OAAO,EAAE;IACd,IAAI,OAAOlB,IAAI,CAACkB,OAAO,KAAK,QAAQ,EAAE;MAClCD,iBAAiB,GAAG,CAACjB,IAAI,CAACkB,OAAO,CAAC;IACtC,CAAC,MACI,IAAIC,KAAK,CAACC,OAAO,CAACpB,IAAI,CAACkB,OAAO,CAAC,IAC7BlB,IAAI,CAACkB,OAAO,CAACG,KAAK,CAACC,IAAI,IAAI,OAAOA,IAAI,KAAK,QAAQ,CAAC,EAAE;MACzDL,iBAAiB,GAAGjB,IAAI,CAACkB,OAAO;IACpC,CAAC,MACI,IAAIlB,IAAI,CAACkB,OAAO,CAACjB,OAAO,KAAKE,SAAS,EAAE;MACzCc,iBAAiB,GAAG,CAACjB,IAAI,CAACkB,OAAO,CAACjB,OAAO,CAAC;IAC9C,CAAC,MACI;MACDgB,iBAAiB,GAAGjB,IAAI,CAACkB,OAAO,CAACV,GAAG,CAACc,IAAI,IAAIA,IAAI,CAACrB,OAAO,CAAC;IAC9D;EACJ;EACA,MAAMsB,CAAC,GAAG;IACNtB,OAAO;IACPuB,eAAe,EAAE;MACbZ,WAAW,EAAEZ,IAAI,CAACY,WAAW,IAAIZ,IAAI,CAACC,OAAO;MAC7CwB,WAAW,EAAEzB,IAAI,CAACyB,WAAW,IAAIzB,IAAI,CAACY,WAAW,IAAIZ,IAAI,CAACC,OAAO;MACjEyB,IAAI,EAAE1B,IAAI,CAAC0B,IAAI,KAAKvB,SAAS,GACvB;QACEM,IAAI,EAAE,WAAW;QACjBkB,SAAS,EAAE;UAAEC,KAAK,EAAE5B,IAAI,CAAC0B,IAAI,CAACE,KAAK;UAAEC,OAAO,EAAE7B,IAAI,CAAC0B,IAAI,CAACG;QAAQ;MACpE,CAAC,GACC1B;IACV,CAAC;IACDc,iBAAiB,EAAEA,iBAAiB;IACpCa,KAAK,EAAE,EAAE;IACT1B,UAAU;IACV2B,MAAM,EAAE;MAAEtB,IAAI,EAAE,QAAQ;MAAEuB,MAAM,EAAE,CAAC;IAAE;EACzC,CAAC;EACD,OAAOnC,kBAAkB,CAACK,cAAc,CAACD,OAAO,CAAC,GAAGsB,CAAC;AACzD;AACA,SAASb,YAAYA,CAACuB,CAAC,EAAE;EACrB,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,IAAIA,CAAC,KAAK,SAAS,IAClDA,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/esm/api/defineInterfaceLinkConstraint.js

@@ -13,16 +13,17 @@
  * 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) {
   const fromLinkMeta = getLinkMeta(linkDef);
-  !(linkDef.from.links.find(a => a.metadata.apiName === fromLinkMeta.apiName) == null) ? invariant(false, `Link with apiName ${fromLinkMeta.apiName} already exists on ${linkDef.apiName}`) : void 0;
+  !(linkDef.from.links.find(a => a.metadata.apiName === fromLinkMeta.apiName) == null) ? process.env.NODE_ENV !== "production" ? invariant(false, `Link with apiName ${fromLinkMeta.apiName} already exists on ${linkDef.apiName}`) : invariant(false) : void 0;
   linkDef.from.links.push({
     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/esm/api/defineInterfaceLinkConstraint.js.map

@@ -1 +1 @@
-{"version":3,"file":"defineInterfaceLinkConstraint.js","names":["invariant","namespace","defineInterfaceLinkConstraint","linkDef","fromLinkMeta","getLinkMeta","from","links","find","a","metadata","apiName","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,IADXX,SAAS,QACI,qBAAqBI,YAAY,CAACO,OAAO,sBAAsBR,OAAO,CAACQ,OAAO,EAAE;EAC7FR,OAAO,CAACG,IAAI,CAACC,KAAK,CAACK,IAAI,CAAC;IACpBC,WAAW,EAAEV,OAAO,CAACW,MAAM,GAAG,MAAM,GAAG,QAAQ;IAC/CC,kBAAkB,EAAEC,aAAa,CAACb,OAAO,CAACW,MAAM,IAAIX,OAAO,CAACc,KAAK,CAAC;IAClEP,QAAQ,EAAEN,YAAY;IACtBc,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,CAACR;EACjD,CAAC;AACL;AACA,SAASN,WAAWA,CAACiB,IAAI,EAAE;EACvB,OAAO,OAAOA,IAAI,KAAK,QAAQ,GACzBC,YAAY,CAAC;IAAEZ,OAAO,EAAEV,SAAS,GAAGqB;EAAK,CAAC,CAAC,GAC3CC,YAAY,CAACD,IAAI,CAAC;AAC5B;AACA,SAASC,YAAYA,CAAC;EAAEZ,OAAO;EAAEa,WAAW;EAAEC;AAAY,CAAC,EAAE;EACzD,OAAO;IACHd,OAAO,EAAEV,SAAS,GAAGU,OAAO;IAC5Bc,WAAW,EAAEA,WAAW,IAAId,OAAO;IACnCa,WAAW,EAAEA,WAAW,IAAIC,WAAW,IAAId;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/esm/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}`
+    };
   }
-  invariant(false);
+  return {
+    type: "valid"
+  };
 }
 //# sourceMappingURL=defineObject.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"defineObject.js","names":["invariant","ontologyDefinition","defineObject","apiName","opts","objectTypes","implementsInterfaces","implementsInterfaces2","linkTypes","objectType","primaryKey","displayName","pluralDisplayName","icon","color","name","type","properties","dataType","convertType","rid","status","titleProperty","sharedPropertyTypeMapping","data","t","multiplicity","subType","itemType"],"sources":["defineObject.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 { ontologyDefinition } from \"./defineOntology.js\";\nexport function defineObject(apiName, opts) {\n    ontologyDefinition.objectTypes[apiName] = {\n        implementsInterfaces: [],\n        implementsInterfaces2: {},\n        linkTypes: [],\n        objectType: {\n            apiName,\n            primaryKey: opts.primaryKey.apiName,\n            displayName: opts.displayName ?? apiName,\n            pluralDisplayName: opts.pluralDisplayName ?? apiName,\n            icon: {\n                color: \"blue\",\n                name: \"cube\",\n                type: \"blueprint\",\n            },\n            properties: {\n                [opts.primaryKey.apiName]: {\n                    dataType: convertType(opts.primaryKey),\n                },\n            },\n            rid: \"PLACEHOLDER\",\n            status: \"ACTIVE\",\n            titleProperty: opts.primaryKey.apiName,\n        },\n        sharedPropertyTypeMapping: {},\n    };\n    // FIXME: don't return the raw value\n    return {\n        data: ontologyDefinition.objectTypes[apiName],\n        linkTypes: {},\n    };\n}\nfunction convertType(t) {\n    switch (true) {\n        case t.multiplicity === true:\n            return {\n                type: \"array\",\n                subType: convertType({ ...t, multiplicity: false }),\n            };\n        case t.type === \"stringTimeseries\":\n            return {\n                itemType: {\n                    type: \"string\",\n                },\n                type: \"timeseries\",\n            };\n            break;\n        case t.type === \"numericTimeseries\":\n            return {\n                itemType: {\n                    type: \"double\",\n                },\n                type: \"timeseries\",\n            };\n        case t.type === \"datetime\":\n            return {\n                type: \"timestamp\",\n            };\n        default:\n            return {\n                type: t.type,\n            };\n    }\n    invariant(false);\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,kBAAkB,QAAQ,qBAAqB;AACxD,OAAO,SAASC,YAAYA,CAACC,OAAO,EAAEC,IAAI,EAAE;EACxCH,kBAAkB,CAACI,WAAW,CAACF,OAAO,CAAC,GAAG;IACtCG,oBAAoB,EAAE,EAAE;IACxBC,qBAAqB,EAAE,CAAC,CAAC;IACzBC,SAAS,EAAE,EAAE;IACbC,UAAU,EAAE;MACRN,OAAO;MACPO,UAAU,EAAEN,IAAI,CAACM,UAAU,CAACP,OAAO;MACnCQ,WAAW,EAAEP,IAAI,CAACO,WAAW,IAAIR,OAAO;MACxCS,iBAAiB,EAAER,IAAI,CAACQ,iBAAiB,IAAIT,OAAO;MACpDU,IAAI,EAAE;QACFC,KAAK,EAAE,MAAM;QACbC,IAAI,EAAE,MAAM;QACZC,IAAI,EAAE;MACV,CAAC;MACDC,UAAU,EAAE;QACR,CAACb,IAAI,CAACM,UAAU,CAACP,OAAO,GAAG;UACvBe,QAAQ,EAAEC,WAAW,CAACf,IAAI,CAACM,UAAU;QACzC;MACJ,CAAC;MACDU,GAAG,EAAE,aAAa;MAClBC,MAAM,EAAE,QAAQ;MAChBC,aAAa,EAAElB,IAAI,CAACM,UAAU,CAACP;IACnC,CAAC;IACDoB,yBAAyB,EAAE,CAAC;EAChC,CAAC;EACD;EACA,OAAO;IACHC,IAAI,EAAEvB,kBAAkB,CAACI,WAAW,CAACF,OAAO,CAAC;IAC7CK,SAAS,EAAE,CAAC;EAChB,CAAC;AACL;AACA,SAASW,WAAWA,CAACM,CAAC,EAAE;EACpB,QAAQ,IAAI;IACR,KAAKA,CAAC,CAACC,YAAY,KAAK,IAAI;MACxB,OAAO;QACHV,IAAI,EAAE,OAAO;QACbW,OAAO,EAAER,WAAW,CAAC;UAAE,GAAGM,CAAC;UAAEC,YAAY,EAAE;QAAM,CAAC;MACtD,CAAC;IACL,KAAKD,CAAC,CAACT,IAAI,KAAK,kBAAkB;MAC9B,OAAO;QACHY,QAAQ,EAAE;UACNZ,IAAI,EAAE;QACV,CAAC;QACDA,IAAI,EAAE;MACV,CAAC;MACD;IACJ,KAAKS,CAAC,CAACT,IAAI,KAAK,mBAAmB;MAC/B,OAAO;QACHY,QAAQ,EAAE;UACNZ,IAAI,EAAE;QACV,CAAC;QACDA,IAAI,EAAE;MACV,CAAC;IACL,KAAKS,CAAC,CAACT,IAAI,KAAK,UAAU;MACtB,OAAO;QACHA,IAAI,EAAE;MACV,CAAC;IACL;MACI,OAAO;QACHA,IAAI,EAAES,CAAC,CAACT;MACZ,CAAC;EACT;EACAhB,SAAS;AACb","ignoreList":[]}
+{"version":3,"file":"defineObject.js","names":["invariant","namespace","ontologyDefinition","defineObject","objectDef","apiName","propertyApiNames","properties","map","val","objectTypes","undefined","Error","includes","titlePropertyApiName","process","env","NODE_ENV","primaryKeys","length","nonExistentPrimaryKeys","filter","primaryKey","implementsInterfaces","forEach","interfaceImpl","nonExistentInterfaceProperties","propertyMapping","interfaceProperty","implements","interfaceProp","type","reason","interfaceToObjectProperties","Object","fromEntries","mapping","mapsTo","validateProperty","nonNameSpacedApiName","validateInterfaceImplProperty","baseValidations","entries","extendsValidations","extendsInterfaces","flatMap","interfaceApiName","interfaceTypes","allFailedValidations","concat","formatValidationErrors","join","error","spt","mappedObjectProp","object","objProp","find","prop"],"sources":["defineObject.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 type { ObjectType, SharedPropertyType } from \"./types.js\";\n\nexport function defineObject(objectDef: ObjectType): ObjectType {\n  const apiName = namespace + objectDef.apiName;\n  const propertyApiNames = (objectDef.properties ?? []).map(val => val.apiName);\n  if (ontologyDefinition.objectTypes[apiName] !== undefined) {\n    throw new Error(\n      `Object type with apiName ${objectDef.apiName} is already defined`,\n    );\n  }\n  invariant(\n    propertyApiNames.includes(objectDef.titlePropertyApiName),\n    `Title property ${objectDef.titlePropertyApiName} is not defined on object ${objectDef.apiName}`,\n  );\n  invariant(\n    objectDef.primaryKeys.length !== 0,\n    `${objectDef.apiName} does not have any primary keys, objects must have at least one primary key`,\n  );\n  const nonExistentPrimaryKeys = objectDef.primaryKeys.filter(primaryKey =>\n    !objectDef.properties?.map(val => val.apiName).includes(primaryKey)\n  );\n  invariant(\n    nonExistentPrimaryKeys.length === 0,\n    `Primary key properties ${nonExistentPrimaryKeys} do not exist on object ${objectDef.apiName}`,\n  );\n\n  objectDef.implementsInterfaces?.forEach(interfaceImpl => {\n    const nonExistentInterfaceProperties: ValidationResult[] = interfaceImpl\n      .propertyMapping.map(val => val.interfaceProperty).filter(\n        interfaceProperty =>\n          interfaceImpl.implements.properties[interfaceProperty] === undefined,\n      ).map(interfaceProp => ({\n        type: \"invalid\",\n        reason:\n          `Interface property ${interfaceImpl.implements.apiName}.${interfaceProp} referenced in ${objectDef.apiName} object does not exist`,\n      }));\n\n    const interfaceToObjectProperties = Object.fromEntries(\n      interfaceImpl.propertyMapping.map(\n        mapping => [mapping.interfaceProperty, mapping.mapsTo],\n      ),\n    );\n    const validateProperty = (\n      interfaceProp: [string, SharedPropertyType],\n    ): ValidationResult => {\n      if (\n        interfaceProp[1].nonNameSpacedApiName in interfaceToObjectProperties\n      ) {\n        return validateInterfaceImplProperty(\n          interfaceProp[1],\n          interfaceToObjectProperties[interfaceProp[0]],\n          objectDef,\n        );\n      }\n      return {\n        type: \"invalid\",\n        reason: `Interface property ${interfaceImpl.implements.apiName}.${\n          interfaceProp[1].nonNameSpacedApiName\n        } not implemented by ${objectDef.apiName} object definition`,\n      };\n    };\n    const baseValidations = Object.entries(interfaceImpl.implements.properties)\n      .map<ValidationResult>(validateProperty);\n    const extendsValidations = interfaceImpl.implements.extendsInterfaces\n      .flatMap(interfaceApiName =>\n        Object.entries(\n          ontologyDefinition.interfaceTypes[interfaceApiName].properties,\n        ).map(validateProperty)\n      );\n\n    const allFailedValidations = baseValidations.concat(\n      extendsValidations,\n      nonExistentInterfaceProperties,\n    ).filter(val => val.type === \"invalid\");\n    invariant(\n      allFailedValidations.length === 0,\n      \"\\n\" + allFailedValidations.map(formatValidationErrors).join(\"\\n\"),\n    );\n  });\n\n  ontologyDefinition.objectTypes[apiName] = { ...objectDef, apiName: apiName };\n  return { ...objectDef, apiName: apiName };\n}\n\ntype ValidationResult = { type: \"valid\" } | { type: \"invalid\"; reason: string };\n\nfunction formatValidationErrors(\n  error: { type: \"invalid\"; reason: string },\n): string {\n  return `Ontology Definition Error: ${error.reason}\\n`;\n}\n\n// Validate that the object and the interface property match up\nfunction validateInterfaceImplProperty(\n  spt: SharedPropertyType,\n  mappedObjectProp: string,\n  object: ObjectType,\n): ValidationResult {\n  const objProp = object.properties?.find(prop =>\n    prop.apiName === mappedObjectProp\n  );\n  if (objProp === undefined) {\n    return {\n      type: \"invalid\",\n      reason:\n        `Object property mapped to interface does not exist. Object Property Mapped: ${mappedObjectProp}`,\n    };\n  }\n  if (spt.type !== objProp?.type) {\n    return {\n      type: \"invalid\",\n      reason:\n        `Object property type does not match the interface property it is mapped to. Interface Property: ${spt.apiName}, objectProperty: ${mappedObjectProp}`,\n    };\n  }\n\n  return { type: \"valid\" };\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;AAGnE,OAAO,SAASC,YAAYA,CAACC,SAAqB,EAAc;EAC9D,MAAMC,OAAO,GAAGJ,SAAS,GAAGG,SAAS,CAACC,OAAO;EAC7C,MAAMC,gBAAgB,GAAG,CAACF,SAAS,CAACG,UAAU,IAAI,EAAE,EAAEC,GAAG,CAACC,GAAG,IAAIA,GAAG,CAACJ,OAAO,CAAC;EAC7E,IAAIH,kBAAkB,CAACQ,WAAW,CAACL,OAAO,CAAC,KAAKM,SAAS,EAAE;IACzD,MAAM,IAAIC,KAAK,CACb,4BAA4BR,SAAS,CAACC,OAAO,qBAC/C,CAAC;EACH;EACA,CACEC,gBAAgB,CAACO,QAAQ,CAACT,SAAS,CAACU,oBAAoB,CAAC,GAAAC,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAD3DjB,SAAS,QAEP,kBAAkBI,SAAS,CAACU,oBAAoB,6BAA6BV,SAAS,CAACC,OAAO,EAAE,IAFlGL,SAAS;EAIT,EACEI,SAAS,CAACc,WAAW,CAACC,MAAM,KAAK,CAAC,IAAAJ,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBADpCjB,SAAS,QAEP,GAAGI,SAAS,CAACC,OAAO,6EAA6E,IAFnGL,SAAS;EAIT,MAAMoB,sBAAsB,GAAGhB,SAAS,CAACc,WAAW,CAACG,MAAM,CAACC,UAAU,IACpE,CAAClB,SAAS,CAACG,UAAU,EAAEC,GAAG,CAACC,GAAG,IAAIA,GAAG,CAACJ,OAAO,CAAC,CAACQ,QAAQ,CAACS,UAAU,CACpE,CAAC;EACD,EACEF,sBAAsB,CAACD,MAAM,KAAK,CAAC,IAAAJ,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBADrCjB,SAAS,QAEP,0BAA0BoB,sBAAsB,2BAA2BhB,SAAS,CAACC,OAAO,EAAE,IAFhGL,SAAS;EAKTI,SAAS,CAACmB,oBAAoB,EAAEC,OAAO,CAACC,aAAa,IAAI;IACvD,MAAMC,8BAAkD,GAAGD,aAAa,CACrEE,eAAe,CAACnB,GAAG,CAACC,GAAG,IAAIA,GAAG,CAACmB,iBAAiB,CAAC,CAACP,MAAM,CACvDO,iBAAiB,IACfH,aAAa,CAACI,UAAU,CAACtB,UAAU,CAACqB,iBAAiB,CAAC,KAAKjB,SAC/D,CAAC,CAACH,GAAG,CAACsB,aAAa,KAAK;MACtBC,IAAI,EAAE,SAAS;MACfC,MAAM,EACJ,sBAAsBP,aAAa,CAACI,UAAU,CAACxB,OAAO,IAAIyB,aAAa,kBAAkB1B,SAAS,CAACC,OAAO;IAC9G,CAAC,CAAC,CAAC;IAEL,MAAM4B,2BAA2B,GAAGC,MAAM,CAACC,WAAW,CACpDV,aAAa,CAACE,eAAe,CAACnB,GAAG,CAC/B4B,OAAO,IAAI,CAACA,OAAO,CAACR,iBAAiB,EAAEQ,OAAO,CAACC,MAAM,CACvD,CACF,CAAC;IACD,MAAMC,gBAAgB,GACpBR,aAA2C,IACtB;MACrB,IACEA,aAAa,CAAC,CAAC,CAAC,CAACS,oBAAoB,IAAIN,2BAA2B,EACpE;QACA,OAAOO,6BAA6B,CAClCV,aAAa,CAAC,CAAC,CAAC,EAChBG,2BAA2B,CAACH,aAAa,CAAC,CAAC,CAAC,CAAC,EAC7C1B,SACF,CAAC;MACH;MACA,OAAO;QACL2B,IAAI,EAAE,SAAS;QACfC,MAAM,EAAE,sBAAsBP,aAAa,CAACI,UAAU,CAACxB,OAAO,IAC5DyB,aAAa,CAAC,CAAC,CAAC,CAACS,oBAAoB,uBAChBnC,SAAS,CAACC,OAAO;MAC1C,CAAC;IACH,CAAC;IACD,MAAMoC,eAAe,GAAGP,MAAM,CAACQ,OAAO,CAACjB,aAAa,CAACI,UAAU,CAACtB,UAAU,CAAC,CACxEC,GAAG,CAAmB8B,gBAAgB,CAAC;IAC1C,MAAMK,kBAAkB,GAAGlB,aAAa,CAACI,UAAU,CAACe,iBAAiB,CAClEC,OAAO,CAACC,gBAAgB,IACvBZ,MAAM,CAACQ,OAAO,CACZxC,kBAAkB,CAAC6C,cAAc,CAACD,gBAAgB,CAAC,CAACvC,UACtD,CAAC,CAACC,GAAG,CAAC8B,gBAAgB,CACxB,CAAC;IAEH,MAAMU,oBAAoB,GAAGP,eAAe,CAACQ,MAAM,CACjDN,kBAAkB,EAClBjB,8BACF,CAAC,CAACL,MAAM,CAACZ,GAAG,IAAIA,GAAG,CAACsB,IAAI,KAAK,SAAS,CAAC;IACvC,EACEiB,oBAAoB,CAAC7B,MAAM,KAAK,CAAC,IAAAJ,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBADnCjB,SAAS,QAEP,IAAI,GAAGgD,oBAAoB,CAACxC,GAAG,CAAC0C,sBAAsB,CAAC,CAACC,IAAI,CAAC,IAAI,CAAC,IAFpEnD,SAAS;EAIX,CAAC,CAAC;EAEFE,kBAAkB,CAACQ,WAAW,CAACL,OAAO,CAAC,GAAG;IAAE,GAAGD,SAAS;IAAEC,OAAO,EAAEA;EAAQ,CAAC;EAC5E,OAAO;IAAE,GAAGD,SAAS;IAAEC,OAAO,EAAEA;EAAQ,CAAC;AAC3C;AAIA,SAAS6C,sBAAsBA,CAC7BE,KAA0C,EAClC;EACR,OAAO,8BAA8BA,KAAK,CAACpB,MAAM,IAAI;AACvD;;AAEA;AACA,SAASQ,6BAA6BA,CACpCa,GAAuB,EACvBC,gBAAwB,EACxBC,MAAkB,EACA;EAClB,MAAMC,OAAO,GAAGD,MAAM,CAAChD,UAAU,EAAEkD,IAAI,CAACC,IAAI,IAC1CA,IAAI,CAACrD,OAAO,KAAKiD,gBACnB,CAAC;EACD,IAAIE,OAAO,KAAK7C,SAAS,EAAE;IACzB,OAAO;MACLoB,IAAI,EAAE,SAAS;MACfC,MAAM,EACJ,+EAA+EsB,gBAAgB;IACnG,CAAC;EACH;EACA,IAAID,GAAG,CAACtB,IAAI,KAAKyB,OAAO,EAAEzB,IAAI,EAAE;IAC9B,OAAO;MACLA,IAAI,EAAE,SAAS;MACfC,MAAM,EACJ,mGAAmGqB,GAAG,CAAChD,OAAO,qBAAqBiD,gBAAgB;IACvJ,CAAC;EACH;EAEA,OAAO;IAAEvB,IAAI,EAAE;EAAQ,CAAC;AAC1B","ignoreList":[]}

package/build/esm/api/defineOntology.js

@@ -1,3 +1,19 @@
+/*
+ * 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.
+ */
+
 /*
  * Copyright 2024 Palantir Technologies, Inc. All rights reserved.
  *
@@ -13,8 +29,10 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 /** @internal */
 export let ontologyDefinition;
+
 /** @internal */
 export let namespace;
 export async function defineOntology(ns, body) {
@@ -25,7 +43,10 @@ export async function defineOntology(ns, body) {
     queryTypes: {},
     interfaceTypes: {},
     sharedPropertyTypes: {},
-    valueTypes: {}
+    valueTypes: {},
+    importedTypes: {
+      sharedPropertyTypes: []
+    }
   };
   try {
     await body();
@@ -58,21 +79,114 @@ function convertOntologyToValueTypeIr(ontology) {
 }
 function convertToWireOntologyIr(ontology) {
   return {
-    sharedPropertyTypes: Object.fromEntries(Object.entries(ontology.sharedPropertyTypes).map(([apiName, spt]) => [apiName, {
-      sharedPropertyType: convertSpt(spt)
-    }])),
-    interfaceTypes: Object.fromEntries(Object.entries(ontology.interfaceTypes).map(([apiName, interfaceType]) => {
-      return [apiName, {
-        interfaceType: convertInterface(interfaceType)
-      }];
-    })),
-    blockPermissionInformation: {
-      actionTypes: {},
-      linkTypes: {},
-      objectTypes: {}
+    blockData: {
+      objectTypes: Object.fromEntries(Object.entries(ontology.objectTypes).map(([apiName, objectType]) => {
+        return [apiName, convertObject(objectType)];
+      })),
+      sharedPropertyTypes: Object.fromEntries(Object.entries(ontology.sharedPropertyTypes).map(([apiName, spt]) => [apiName, {
+        sharedPropertyType: convertSpt(spt)
+      }])),
+      interfaceTypes: Object.fromEntries(Object.entries(ontology.interfaceTypes).map(([apiName, interfaceType]) => {
+        return [apiName, {
+          interfaceType: convertInterface(interfaceType)
+        }];
+      })),
+      blockPermissionInformation: {
+        actionTypes: {},
+        linkTypes: {},
+        objectTypes: {}
+      }
+    },
+    importedTypes: ontology.importedTypes
+  };
+}
+function convertObject(objectType) {
+  const propertyDatasource = {};
+  (objectType.properties ?? []).forEach(property => {
+    propertyDatasource[property.apiName] = {
+      type: "column",
+      column: property.apiName
+    };
+  });
+  const datasource = {
+    rid: "ri.ontology.main.datasource.".concat(objectType.apiName),
+    datasource: {
+      type: "datasetV2",
+      datasetV2: {
+        datasetRid: objectType.apiName,
+        propertyMapping: propertyDatasource
+      }
+    },
+    editsConfiguration: {
+      onlyAllowPrivilegedEdits: false
+    },
+    redacted: false
+  };
+  const implementations = objectType.implementsInterfaces ?? [];
+  return {
+    objectType: {
+      displayMetadata: {
+        description: objectType.description,
+        displayName: objectType.displayName,
+        groupDisplayName: undefined,
+        icon: {
+          type: "blueprint",
+          blueprint: objectType.icon ?? {
+            locator: "cube",
+            color: "#2D72D2"
+          }
+        },
+        pluralDisplayName: objectType.pluralDisplayName,
+        visibility: objectType.visibility ?? "NORMAL"
+      },
+      primaryKeys: objectType.primaryKeys,
+      propertyTypes: Object.fromEntries(objectType.properties?.map(val => [val.apiName, convertProperty(val)]) ?? []),
+      titlePropertyTypeRid: objectType.titlePropertyApiName,
+      apiName: objectType.apiName,
+      status: objectType.status ?? {
+        type: "active",
+        active: {}
+      },
+      redacted: false,
+      implementsInterfaces2: implementations.map(impl => ({
+        interfaceTypeApiName: impl.implements.apiName,
+        properties: Object.fromEntries(impl.propertyMapping.map(mapping => [namespace + mapping.interfaceProperty, {
+          propertyTypeRid: mapping.mapsTo
+        }]))
+      })),
+      allImplementsInterfaces: {}
+    },
+    datasources: [datasource],
+    entityMetadata: {
+      arePatchesEnabled: objectType.editsEnabled ?? false
     }
   };
 }
+function convertProperty(property) {
+  const output = {
+    apiName: property.apiName,
+    sharedPropertyTypeApiName: property.sharedPropertyType?.apiName,
+    displayMetadata: {
+      displayName: property.displayName,
+      description: property.description,
+      visibility: property.visibility ?? "NORMAL"
+    },
+    indexedForSearch: property.indexedForSearch ?? true,
+    ruleSetBinding: undefined,
+    baseFormatter: property.baseFormatter,
+    type: convertType(property.type),
+    typeClasses: property.typeClasses ?? [],
+    status: property.status ?? {
+      type: "active",
+      active: {}
+    },
+    inlineAction: undefined,
+    dataConstraints: property.dataConstraints,
+    sharedPropertyTypeRid: property.sharedPropertyType?.apiName,
+    valueType: undefined
+  };
+  return output;
+}
 function convertInterface(interfaceType) {
   return {
     ...interfaceType,
@@ -99,6 +213,14 @@ function convertSpt({
   typeClasses,
   valueType
 }) {
+  const dataConstraint = typeof type === "object" && type.type === "marking" ? {
+    propertyTypeConstraints: [],
+    nullability: undefined,
+    nullabilityV2: {
+      noEmptyCollections: true,
+      noNulls: true
+    }
+  } : undefined;
   return {
     apiName,
     displayMetadata: {
@@ -114,7 +236,7 @@ function convertSpt({
     } : convertType(type),
     aliases: [],
     baseFormatter: undefined,
-    dataConstraints: undefined,
+    dataConstraints: dataConstraint,
     gothamMapping: gothamMapping,
     indexedForSearch: true,
     provenance: undefined,
@@ -123,20 +245,67 @@ function convertSpt({
   };
 }
 function convertType(type) {
-  switch (type) {
-    case "marking":
+  switch (true) {
+    case typeof type === "object" && "markingType" in type:
       return {
-        type,
-        [type]: {
-          markingType: "MANDATORY"
+        "type": "marking",
+        marking: {
+          markingType: type.markingType
+        }
+      };
+    case typeof type === "object" && "structDefinition" in type:
+      const structFields = new Array();
+      for (const key in type.structDefinition) {
+        const fieldTypeDefinition = type.structDefinition[key];
+        let field;
+        if (typeof fieldTypeDefinition === "string") {
+          field = {
+            apiName: key,
+            displayMetadata: {
+              displayName: key,
+              description: undefined
+            },
+            typeClasses: [],
+            aliases: [],
+            fieldType: convertType(fieldTypeDefinition)
+          };
+        } else {
+          // If it is a full form type definition then process it as such
+          if ("fieldType" in fieldTypeDefinition) {
+            field = {
+              ...fieldTypeDefinition,
+              apiName: key,
+              fieldType: convertType(fieldTypeDefinition.fieldType),
+              typeClasses: fieldTypeDefinition.typeClasses ?? [],
+              aliases: fieldTypeDefinition.aliases ?? []
+            };
+          } else {
+            field = {
+              apiName: key,
+              displayMetadata: {
+                displayName: key,
+                description: undefined
+              },
+              typeClasses: [],
+              aliases: [],
+              fieldType: convertType(fieldTypeDefinition)
+            };
+          }
+        }
+        structFields.push(field);
+      }
+      return {
+        type: "struct",
+        struct: {
+          structFields
         }
       };
-    case "geopoint":
+    case type === "geopoint":
       return {
         type: "geohash",
         geohash: {}
       };
-    case "decimal":
+    case type === "decimal":
       return {
         type,
         [type]: {
@@ -144,17 +313,18 @@ function convertType(type) {
           scale: undefined
         }
       };
-    case "string":
+    case type === "string":
       return {
         type,
         [type]: {
           analyzerOverride: undefined,
           enableAsciiFolding: undefined,
           isLongText: false,
+          supportsEfficientLeadingWildcard: false,
           supportsExactMatching: true
         }
       };
-    case "mediaReference":
+    case type === "mediaReference":
       return {
         type: type,
         mediaReference: {}
@@ -164,6 +334,7 @@ function convertType(type) {
       return distributeTypeHelper(type);
   }
 }
+
 /**
  * Helper function to avoid duplication. Makes the types match properly with the correct
  * behavior without needing to switch on type.