@osdk/generator 2.0.0-beta.8 → 2.0.0

package/build/esm/util/test/compileThis.js

@@ -0,0 +1,41 @@
+/*
+ * Copyright 2023 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 * as ts from "typescript";
+export function compileThis(files, basePath) {
+  const compilerOptions = {
+    noEmit: true,
+    target: ts.ScriptTarget.ES2020
+  };
+  const host = ts.createCompilerHost(compilerOptions);
+  const originalReadFile = host.readFile;
+  host.readFile = filename => {
+    if (filename.startsWith(basePath)) {
+      return files[filename];
+    } else {
+      return originalReadFile(filename);
+    }
+  };
+  host.writeFile = () => {
+    throw new Error("File writes not allowed");
+  };
+  const program = ts.createProgram({
+    options: compilerOptions,
+    host,
+    rootNames: ["/foo/index.ts"]
+  });
+  return ts.getPreEmitDiagnostics(program);
+}
+//# sourceMappingURL=compileThis.js.map

package/build/esm/util/test/compileThis.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"compileThis.js","names":["ts","compileThis","files","basePath","compilerOptions","noEmit","target","ScriptTarget","ES2020","host","createCompilerHost","originalReadFile","readFile","filename","startsWith","writeFile","Error","program","createProgram","options","rootNames","getPreEmitDiagnostics"],"sources":["compileThis.js"],"sourcesContent":["/*\n * Copyright 2023 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 * as ts from \"typescript\";\nexport function compileThis(files, basePath) {\n    const compilerOptions = {\n        noEmit: true,\n        target: ts.ScriptTarget.ES2020,\n    };\n    const host = ts.createCompilerHost(compilerOptions);\n    const originalReadFile = host.readFile;\n    host.readFile = (filename) => {\n        if (filename.startsWith(basePath)) {\n            return files[filename];\n        }\n        else {\n            return originalReadFile(filename);\n        }\n    };\n    host.writeFile = () => {\n        throw new Error(\"File writes not allowed\");\n    };\n    const program = ts.createProgram({\n        options: compilerOptions,\n        host,\n        rootNames: [\"/foo/index.ts\"],\n    });\n    return ts.getPreEmitDiagnostics(program);\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,KAAKA,EAAE,MAAM,YAAY;AAChC,OAAO,SAASC,WAAWA,CAACC,KAAK,EAAEC,QAAQ,EAAE;EACzC,MAAMC,eAAe,GAAG;IACpBC,MAAM,EAAE,IAAI;IACZC,MAAM,EAAEN,EAAE,CAACO,YAAY,CAACC;EAC5B,CAAC;EACD,MAAMC,IAAI,GAAGT,EAAE,CAACU,kBAAkB,CAACN,eAAe,CAAC;EACnD,MAAMO,gBAAgB,GAAGF,IAAI,CAACG,QAAQ;EACtCH,IAAI,CAACG,QAAQ,GAAIC,QAAQ,IAAK;IAC1B,IAAIA,QAAQ,CAACC,UAAU,CAACX,QAAQ,CAAC,EAAE;MAC/B,OAAOD,KAAK,CAACW,QAAQ,CAAC;IAC1B,CAAC,MACI;MACD,OAAOF,gBAAgB,CAACE,QAAQ,CAAC;IACrC;EACJ,CAAC;EACDJ,IAAI,CAACM,SAAS,GAAG,MAAM;IACnB,MAAM,IAAIC,KAAK,CAAC,yBAAyB,CAAC;EAC9C,CAAC;EACD,MAAMC,OAAO,GAAGjB,EAAE,CAACkB,aAAa,CAAC;IAC7BC,OAAO,EAAEf,eAAe;IACxBK,IAAI;IACJW,SAAS,EAAE,CAAC,eAAe;EAC/B,CAAC,CAAC;EACF,OAAOpB,EAAE,CAACqB,qBAAqB,CAACJ,OAAO,CAAC;AAC5C","ignoreList":[]}

package/build/esm/util/test/createMockMinimalFiles.js

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2023 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 { vi } from "vitest";
+export function createMockMinimalFiles() {
+  const writeFile = vi.fn(() => Promise.resolve());
+  const getFiles = () => Object.fromEntries(writeFile.mock.calls);
+  const readdir = vi.fn(() => Promise.resolve([]));
+  return {
+    minimalFiles: {
+      writeFile: writeFile,
+      mkdir: () => Promise.resolve(),
+      readdir: readdir
+    },
+    getFiles,
+    dumpFilesToConsole: () => {
+      for (const [path, contents] of Object.entries(getFiles())) {
+        console.group(path);
+        console.log(contents);
+        console.groupEnd();
+      }
+    }
+  };
+}
+//# sourceMappingURL=createMockMinimalFiles.js.map

package/build/esm/util/test/createMockMinimalFiles.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createMockMinimalFiles.js","names":["vi","createMockMinimalFiles","writeFile","fn","Promise","resolve","getFiles","Object","fromEntries","mock","calls","readdir","minimalFiles","mkdir","dumpFilesToConsole","path","contents","entries","console","group","log","groupEnd"],"sources":["createMockMinimalFiles.js"],"sourcesContent":["/*\n * Copyright 2023 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 { vi } from \"vitest\";\nexport function createMockMinimalFiles() {\n    const writeFile = vi.fn(() => Promise.resolve());\n    const getFiles = () => Object.fromEntries(writeFile.mock.calls);\n    const readdir = vi.fn(() => Promise.resolve([]));\n    return {\n        minimalFiles: {\n            writeFile: writeFile,\n            mkdir: () => Promise.resolve(),\n            readdir: readdir,\n        },\n        getFiles,\n        dumpFilesToConsole: () => {\n            for (const [path, contents] of Object.entries(getFiles())) {\n                console.group(path);\n                console.log(contents);\n                console.groupEnd();\n            }\n        },\n    };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASA,EAAE,QAAQ,QAAQ;AAC3B,OAAO,SAASC,sBAAsBA,CAAA,EAAG;EACrC,MAAMC,SAAS,GAAGF,EAAE,CAACG,EAAE,CAAC,MAAMC,OAAO,CAACC,OAAO,CAAC,CAAC,CAAC;EAChD,MAAMC,QAAQ,GAAGA,CAAA,KAAMC,MAAM,CAACC,WAAW,CAACN,SAAS,CAACO,IAAI,CAACC,KAAK,CAAC;EAC/D,MAAMC,OAAO,GAAGX,EAAE,CAACG,EAAE,CAAC,MAAMC,OAAO,CAACC,OAAO,CAAC,EAAE,CAAC,CAAC;EAChD,OAAO;IACHO,YAAY,EAAE;MACVV,SAAS,EAAEA,SAAS;MACpBW,KAAK,EAAEA,CAAA,KAAMT,OAAO,CAACC,OAAO,CAAC,CAAC;MAC9BM,OAAO,EAAEA;IACb,CAAC;IACDL,QAAQ;IACRQ,kBAAkB,EAAEA,CAAA,KAAM;MACtB,KAAK,MAAM,CAACC,IAAI,EAAEC,QAAQ,CAAC,IAAIT,MAAM,CAACU,OAAO,CAACX,QAAQ,CAAC,CAAC,CAAC,EAAE;QACvDY,OAAO,CAACC,KAAK,CAACJ,IAAI,CAAC;QACnBG,OAAO,CAACE,GAAG,CAACJ,QAAQ,CAAC;QACrBE,OAAO,CAACG,QAAQ,CAAC,CAAC;MACtB;IACJ;EACJ,CAAC;AACL","ignoreList":[]}

package/build/esm/util/test/formatTs.js

@@ -0,0 +1,32 @@
+/*
+ * Copyright 2023 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 { format } from "prettier";
+export function formatTs(contents) {
+  try {
+    return format(contents, {
+      parser: "typescript",
+      singleQuote: true,
+      trailingComma: "all",
+      tabWidth: 2,
+      printWidth: 120
+    });
+  } catch (e) {
+    console.error("Failed to format file", e);
+    console.log(contents);
+    return contents;
+  }
+}
+//# sourceMappingURL=formatTs.js.map

package/build/esm/util/test/formatTs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"formatTs.js","names":["format","formatTs","contents","parser","singleQuote","trailingComma","tabWidth","printWidth","e","console","error","log"],"sources":["formatTs.js"],"sourcesContent":["/*\n * Copyright 2023 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 { format } from \"prettier\";\nexport function formatTs(contents) {\n    try {\n        return format(contents, {\n            parser: \"typescript\",\n            singleQuote: true,\n            trailingComma: \"all\",\n            tabWidth: 2,\n            printWidth: 120,\n        });\n    }\n    catch (e) {\n        console.error(\"Failed to format file\", e);\n        console.log(contents);\n        return contents;\n    }\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASA,MAAM,QAAQ,UAAU;AACjC,OAAO,SAASC,QAAQA,CAACC,QAAQ,EAAE;EAC/B,IAAI;IACA,OAAOF,MAAM,CAACE,QAAQ,EAAE;MACpBC,MAAM,EAAE,YAAY;MACpBC,WAAW,EAAE,IAAI;MACjBC,aAAa,EAAE,KAAK;MACpBC,QAAQ,EAAE,CAAC;MACXC,UAAU,EAAE;IAChB,CAAC,CAAC;EACN,CAAC,CACD,OAAOC,CAAC,EAAE;IACNC,OAAO,CAACC,KAAK,CAAC,uBAAuB,EAAEF,CAAC,CAAC;IACzCC,OAAO,CAACE,GAAG,CAACT,QAAQ,CAAC;IACrB,OAAOA,QAAQ;EACnB;AACJ","ignoreList":[]}

package/build/esm/util/verifyOutDir.js

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2023 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.
+ */
+/**
+ * Verify that the target outDir does not yet exist OR is empty.
+ *
+ * Re-generating an ontology on top of itself is not supported and may leave old
+ * files around or refuse to update files with new contents in some cases.
+ */
+export async function verifyOutDir(outDir, fs) {
+  // if outDir exists and is not empty, we cannot proceed with the generation
+  try {
+    const contents = await fs.readdir(outDir);
+    if (contents.length !== 0) {
+      throw new Error(`outDir ${outDir} is not empty, please delete its contents and try again`);
+    }
+  } catch (e) {
+    if (!(e.code === "ENOENT")) {
+      throw e;
+    } // acceptable, we'll create the directory ourselves
+  }
+}
+//# sourceMappingURL=verifyOutDir.js.map

package/build/esm/util/verifyOutDir.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"verifyOutDir.js","names":["verifyOutDir","outDir","fs","contents","readdir","length","Error","e","code"],"sources":["verifyOutDir.js"],"sourcesContent":["/*\n * Copyright 2023 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n/**\n * Verify that the target outDir does not yet exist OR is empty.\n *\n * Re-generating an ontology on top of itself is not supported and may leave old\n * files around or refuse to update files with new contents in some cases.\n */\nexport async function verifyOutDir(outDir, fs) {\n    // if outDir exists and is not empty, we cannot proceed with the generation\n    try {\n        const contents = await fs.readdir(outDir);\n        if (contents.length !== 0) {\n            throw new Error(`outDir ${outDir} is not empty, please delete its contents and try again`);\n        }\n    }\n    catch (e) {\n        if (e.code === \"ENOENT\") {\n            // acceptable, we'll create the directory ourselves\n        }\n        else {\n            throw e;\n        }\n    }\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeA,YAAYA,CAACC,MAAM,EAAEC,EAAE,EAAE;EAC3C;EACA,IAAI;IACA,MAAMC,QAAQ,GAAG,MAAMD,EAAE,CAACE,OAAO,CAACH,MAAM,CAAC;IACzC,IAAIE,QAAQ,CAACE,MAAM,KAAK,CAAC,EAAE;MACvB,MAAM,IAAIC,KAAK,CAAC,UAAUL,MAAM,yDAAyD,CAAC;IAC9F;EACJ,CAAC,CACD,OAAOM,CAAC,EAAE;IACN,MAAIA,CAAC,CAACC,IAAI,KAAK,QAAQ,GAGlB;MACD,MAAMD,CAAC;IACX,CAAC,CAJG;EAKR;AACJ","ignoreList":[]}

package/build/esm/v2.0/UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst.js

@@ -0,0 +1,114 @@
+/*
+ * Copyright 2023 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 { __UNSTABLE_wireInterfaceTypeV2ToSdkObjectDefinition } from "@osdk/generator-converters";
+import fastDeepEqual from "fast-deep-equal";
+import invariant from "tiny-invariant";
+import { propertyJsdoc } from "../shared/propertyJsdoc.js";
+import { deleteUndefineds } from "../util/deleteUndefineds.js";
+import { stringify } from "../util/stringify.js";
+import { createDefinition, createObjectSet, createOsdkObject, createPropertyKeys, createProps } from "./wireObjectTypeV2ToSdkObjectConstV2.js";
+/** @internal */
+export function __UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst(interfaceDef, ontology, v2 = false) {
+  const definition = deleteUndefineds(__UNSTABLE_wireInterfaceTypeV2ToSdkObjectDefinition(interfaceDef.raw, v2));
+  const objectDefIdentifier = interfaceDef.getDefinitionIdentifier(v2);
+  const parents = definition.implements?.map(p => {
+    !(ontology.interfaceTypes[p] != null) ? invariant(false, `Expected to find a parent interface named ${p} in the ontology and did not.`) : void 0;
+    const it = deleteUndefineds(__UNSTABLE_wireInterfaceTypeV2ToSdkObjectDefinition(ontology.requireInterfaceType(p, true).raw, v2));
+    return it;
+  }) ?? [];
+  const mergedProperties = {
+    ...definition.properties
+  };
+  for (const parent of parents) {
+    for (const apiName of Object.keys(parent.properties)) {
+      if (definition.properties[apiName] != null) {
+        !fastDeepEqual(definition.properties[apiName], parent.properties[apiName]) ? invariant(false, `Interface ${definition.apiName} redefines property '${apiName}' from parent '${parent.apiName}' but the properties do not match`) : void 0;
+      } else if (mergedProperties[apiName] != null) {
+        !fastDeepEqual(mergedProperties[apiName], parent.properties[apiName]) ? invariant(false, `Some interface defines a conflicting property '${apiName}' that does not match property from parent '${parent.apiName}'`) : void 0;
+      }
+      mergedProperties[apiName] = parent.properties[apiName];
+    }
+  }
+  const ogProperties = definition.properties;
+  definition.properties = mergedProperties;
+  const objectSetIdentifier = `${interfaceDef.shortApiName}.ObjectSet`;
+  const propertyKeysIdentifier = `${interfaceDef.shortApiName}.PropertyKeys`;
+  // const osdkObjectPropsIdentifier = `OsdkObjectProps$${objectDefIdentifier}`;
+  const osdkObjectPropsIdentifier = `${interfaceDef.shortApiName}.Props`;
+  const osdkObjectStrictPropsIdentifier = `${interfaceDef.shortApiName}.StrictProps`;
+  const osdkObjectLinksIdentifier = `OsdkObjectLinks$${objectDefIdentifier}`;
+  const osdkObjectIdentifier = `${interfaceDef.shortApiName}.OsdkObject`;
+  const ids = {
+    objectDefIdentifier: interfaceDef.shortApiName,
+    osdkObjectLinksIdentifier,
+    osdkObjectPropsIdentifier,
+    osdkObjectStrictPropsIdentifier,
+    objectSetIdentifier,
+    osdkObjectIdentifier,
+    propertyKeysIdentifier
+  };
+
+  // FIXME: We need to fill in the imports
+  // if we want links to work
+
+  return `${[].join("\n")}
+    ${v2 ? function () {
+    return `import type {
+      InterfaceDefinition as $InterfaceDefinition,
+      ObjectSet as $ObjectSet, 
+      Osdk as $Osdk,
+      PropertyValueWireToClient as $PropType,
+    } from "@osdk/api";
+    
+        ${Object.keys(definition.links).length === 0 ? `export type ${osdkObjectLinksIdentifier} = {};` : `
+        export interface ${osdkObjectLinksIdentifier}  {
+${stringify(definition.links, {
+      "*": definition => {
+        const linkTarget = ontology.requireObjectType(definition.targetType).getImportedDefinitionIdentifier(v2);
+        return `${definition.multiplicity ? `${linkTarget}["objectSet"]` : `SingleLinkAccessor<${linkTarget}>`}
+          `;
+      }
+    })}
+    }
+    `}
+
+    export namespace ${interfaceDef.shortApiName} {
+
+      ${createPropertyKeys(interfaceDef)}
+
+
+      ${createProps(interfaceDef, "Props", false)}
+      ${createProps(interfaceDef, "StrictProps", true)}
+
+
+      ${createObjectSet(interfaceDef, ids)}
+
+      ${createOsdkObject(interfaceDef, "OsdkObject", ids)}
+      
+    }    
+
+    ${createDefinition(interfaceDef, ontology, interfaceDef.shortApiName, ids)}
+
+`;
+  }() : ""}
+
+    export const ${interfaceDef.shortApiName}: ${interfaceDef.shortApiName} = {
+      type: "interface",
+      apiName: "${interfaceDef.fullApiName}",
+      osdkMetadata: $osdkMetadata,
+       };`;
+}
+//# sourceMappingURL=UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst.js.map

package/build/esm/v2.0/UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst.js","names":["__UNSTABLE_wireInterfaceTypeV2ToSdkObjectDefinition","fastDeepEqual","invariant","propertyJsdoc","deleteUndefineds","stringify","createDefinition","createObjectSet","createOsdkObject","createPropertyKeys","createProps","__UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst","interfaceDef","ontology","v2","definition","raw","objectDefIdentifier","getDefinitionIdentifier","parents","implements","map","p","interfaceTypes","it","requireInterfaceType","mergedProperties","properties","parent","apiName","Object","keys","ogProperties","objectSetIdentifier","shortApiName","propertyKeysIdentifier","osdkObjectPropsIdentifier","osdkObjectStrictPropsIdentifier","osdkObjectLinksIdentifier","osdkObjectIdentifier","ids","join","links","length","linkTarget","requireObjectType","targetType","getImportedDefinitionIdentifier","multiplicity","fullApiName"],"sources":["UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst.js"],"sourcesContent":["/*\n * Copyright 2023 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 { __UNSTABLE_wireInterfaceTypeV2ToSdkObjectDefinition } from \"@osdk/generator-converters\";\nimport fastDeepEqual from \"fast-deep-equal\";\nimport invariant from \"tiny-invariant\";\nimport { propertyJsdoc } from \"../shared/propertyJsdoc.js\";\nimport { deleteUndefineds } from \"../util/deleteUndefineds.js\";\nimport { stringify } from \"../util/stringify.js\";\nimport { createDefinition, createObjectSet, createOsdkObject, createPropertyKeys, createProps, } from \"./wireObjectTypeV2ToSdkObjectConstV2.js\";\n/** @internal */\nexport function __UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst(interfaceDef, ontology, v2 = false) {\n    const definition = deleteUndefineds(__UNSTABLE_wireInterfaceTypeV2ToSdkObjectDefinition(interfaceDef.raw, v2));\n    const objectDefIdentifier = interfaceDef.getDefinitionIdentifier(v2);\n    const parents = definition.implements?.map(p => {\n        invariant(ontology.interfaceTypes[p] != null, `Expected to find a parent interface named ${p} in the ontology and did not.`);\n        const it = deleteUndefineds(__UNSTABLE_wireInterfaceTypeV2ToSdkObjectDefinition(ontology.requireInterfaceType(p, true).raw, v2));\n        return it;\n    }) ?? [];\n    const mergedProperties = { ...definition.properties };\n    for (const parent of parents) {\n        for (const apiName of Object.keys(parent.properties)) {\n            if (definition.properties[apiName] != null) {\n                invariant(fastDeepEqual(definition.properties[apiName], parent.properties[apiName]), `Interface ${definition.apiName} redefines property '${apiName}' from parent '${parent.apiName}' but the properties do not match`);\n            }\n            else if (mergedProperties[apiName] != null) {\n                invariant(fastDeepEqual(mergedProperties[apiName], parent.properties[apiName]), `Some interface defines a conflicting property '${apiName}' that does not match property from parent '${parent.apiName}'`);\n            }\n            mergedProperties[apiName] = parent.properties[apiName];\n        }\n    }\n    const ogProperties = definition.properties;\n    definition.properties = mergedProperties;\n    function localPropertyJsdoc(apiName) {\n        const property = definition.properties[apiName];\n        const isInherited = ogProperties[apiName] == null;\n        return propertyJsdoc(property, { isInherited, apiName });\n    }\n    function maybeStripNamespace(q) {\n        if (interfaceDef.apiNamespace && q.startsWith(`${interfaceDef.apiNamespace}.`)) {\n            return q.slice(interfaceDef.apiNamespace.length + 1);\n        }\n        else {\n            return q;\n        }\n    }\n    const objectSetIdentifier = `${interfaceDef.shortApiName}.ObjectSet`;\n    const propertyKeysIdentifier = `${interfaceDef.shortApiName}.PropertyKeys`;\n    // const osdkObjectPropsIdentifier = `OsdkObjectProps$${objectDefIdentifier}`;\n    const osdkObjectPropsIdentifier = `${interfaceDef.shortApiName}.Props`;\n    const osdkObjectStrictPropsIdentifier = `${interfaceDef.shortApiName}.StrictProps`;\n    const osdkObjectLinksIdentifier = `OsdkObjectLinks$${objectDefIdentifier}`;\n    const osdkObjectIdentifier = `${interfaceDef.shortApiName}.OsdkObject`;\n    const ids = {\n        objectDefIdentifier: interfaceDef.shortApiName,\n        osdkObjectLinksIdentifier,\n        osdkObjectPropsIdentifier,\n        osdkObjectStrictPropsIdentifier,\n        objectSetIdentifier,\n        osdkObjectIdentifier,\n        propertyKeysIdentifier,\n    };\n    function getV2Types() {\n        return `import type {\n      InterfaceDefinition as $InterfaceDefinition,\n      ObjectSet as $ObjectSet, \n      Osdk as $Osdk,\n      PropertyValueWireToClient as $PropType,\n    } from \"@osdk/api\";\n    \n        ${Object.keys(definition.links).length === 0\n            ? `export type ${osdkObjectLinksIdentifier} = {};`\n            : `\n        export interface ${osdkObjectLinksIdentifier}  {\n${stringify(definition.links, {\n                \"*\": (definition) => {\n                    const linkTarget = ontology.requireObjectType(definition.targetType)\n                        .getImportedDefinitionIdentifier(v2);\n                    return `${definition.multiplicity\n                        ? `${linkTarget}[\"objectSet\"]`\n                        : `SingleLinkAccessor<${linkTarget}>`}\n          `;\n                },\n            })}\n    }\n    `}\n\n    export namespace ${interfaceDef.shortApiName} {\n\n      ${createPropertyKeys(interfaceDef)}\n\n\n      ${createProps(interfaceDef, \"Props\", false)}\n      ${createProps(interfaceDef, \"StrictProps\", true)}\n\n\n      ${createObjectSet(interfaceDef, ids)}\n\n      ${createOsdkObject(interfaceDef, \"OsdkObject\", ids)}\n      \n    }    \n\n    ${createDefinition(interfaceDef, ontology, interfaceDef.shortApiName, ids)}\n\n`;\n    }\n    // FIXME: We need to fill in the imports\n    // if we want links to work\n    const imports = [];\n    definition;\n    return `${imports.join(\"\\n\")}\n    ${v2 ? getV2Types() : \"\"}\n\n    export const ${interfaceDef.shortApiName}: ${interfaceDef.shortApiName} = {\n      type: \"interface\",\n      apiName: \"${interfaceDef.fullApiName}\",\n      osdkMetadata: $osdkMetadata,\n       };`;\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASA,mDAAmD,QAAQ,4BAA4B;AAChG,OAAOC,aAAa,MAAM,iBAAiB;AAC3C,OAAOC,SAAS,MAAM,gBAAgB;AACtC,SAASC,aAAa,QAAQ,4BAA4B;AAC1D,SAASC,gBAAgB,QAAQ,6BAA6B;AAC9D,SAASC,SAAS,QAAQ,sBAAsB;AAChD,SAASC,gBAAgB,EAAEC,eAAe,EAAEC,gBAAgB,EAAEC,kBAAkB,EAAEC,WAAW,QAAS,yCAAyC;AAC/I;AACA,OAAO,SAASC,8CAA8CA,CAACC,YAAY,EAAEC,QAAQ,EAAEC,EAAE,GAAG,KAAK,EAAE;EAC/F,MAAMC,UAAU,GAAGX,gBAAgB,CAACJ,mDAAmD,CAACY,YAAY,CAACI,GAAG,EAAEF,EAAE,CAAC,CAAC;EAC9G,MAAMG,mBAAmB,GAAGL,YAAY,CAACM,uBAAuB,CAACJ,EAAE,CAAC;EACpE,MAAMK,OAAO,GAAGJ,UAAU,CAACK,UAAU,EAAEC,GAAG,CAACC,CAAC,IAAI;IAC5C,EAAUT,QAAQ,CAACU,cAAc,CAACD,CAAC,CAAC,IAAI,IAAI,IAA5CpB,SAAS,QAAqC,6CAA6CoB,CAAC,+BAA+B;IAC3H,MAAME,EAAE,GAAGpB,gBAAgB,CAACJ,mDAAmD,CAACa,QAAQ,CAACY,oBAAoB,CAACH,CAAC,EAAE,IAAI,CAAC,CAACN,GAAG,EAAEF,EAAE,CAAC,CAAC;IAChI,OAAOU,EAAE;EACb,CAAC,CAAC,IAAI,EAAE;EACR,MAAME,gBAAgB,GAAG;IAAE,GAAGX,UAAU,CAACY;EAAW,CAAC;EACrD,KAAK,MAAMC,MAAM,IAAIT,OAAO,EAAE;IAC1B,KAAK,MAAMU,OAAO,IAAIC,MAAM,CAACC,IAAI,CAACH,MAAM,CAACD,UAAU,CAAC,EAAE;MAClD,IAAIZ,UAAU,CAACY,UAAU,CAACE,OAAO,CAAC,IAAI,IAAI,EAAE;QACxC,CAAU5B,aAAa,CAACc,UAAU,CAACY,UAAU,CAACE,OAAO,CAAC,EAAED,MAAM,CAACD,UAAU,CAACE,OAAO,CAAC,CAAC,GAAnF3B,SAAS,QAA4E,aAAaa,UAAU,CAACc,OAAO,wBAAwBA,OAAO,kBAAkBD,MAAM,CAACC,OAAO,mCAAmC;MAC1N,CAAC,MACI,IAAIH,gBAAgB,CAACG,OAAO,CAAC,IAAI,IAAI,EAAE;QACxC,CAAU5B,aAAa,CAACyB,gBAAgB,CAACG,OAAO,CAAC,EAAED,MAAM,CAACD,UAAU,CAACE,OAAO,CAAC,CAAC,GAA9E3B,SAAS,QAAuE,kDAAkD2B,OAAO,+CAA+CD,MAAM,CAACC,OAAO,GAAG;MAC7M;MACAH,gBAAgB,CAACG,OAAO,CAAC,GAAGD,MAAM,CAACD,UAAU,CAACE,OAAO,CAAC;IAC1D;EACJ;EACA,MAAMG,YAAY,GAAGjB,UAAU,CAACY,UAAU;EAC1CZ,UAAU,CAACY,UAAU,GAAGD,gBAAgB;EAcxC,MAAMO,mBAAmB,GAAG,GAAGrB,YAAY,CAACsB,YAAY,YAAY;EACpE,MAAMC,sBAAsB,GAAG,GAAGvB,YAAY,CAACsB,YAAY,eAAe;EAC1E;EACA,MAAME,yBAAyB,GAAG,GAAGxB,YAAY,CAACsB,YAAY,QAAQ;EACtE,MAAMG,+BAA+B,GAAG,GAAGzB,YAAY,CAACsB,YAAY,cAAc;EAClF,MAAMI,yBAAyB,GAAG,mBAAmBrB,mBAAmB,EAAE;EAC1E,MAAMsB,oBAAoB,GAAG,GAAG3B,YAAY,CAACsB,YAAY,aAAa;EACtE,MAAMM,GAAG,GAAG;IACRvB,mBAAmB,EAAEL,YAAY,CAACsB,YAAY;IAC9CI,yBAAyB;IACzBF,yBAAyB;IACzBC,+BAA+B;IAC/BJ,mBAAmB;IACnBM,oBAAoB;IACpBJ;EACJ,CAAC;;EA6CD;EACA;;EAGA,OAAO,GAFS,EAAE,CAEAM,IAAI,CAAC,IAAI,CAAC;AAChC,MAAM3B,EAAE,GAjDJ,YAAsB;IAClB,OAAO;AACf;AACA;AACA;AACA;AACA;AACA;AACA,UAAUgB,MAAM,CAACC,IAAI,CAAChB,UAAU,CAAC2B,KAAK,CAAC,CAACC,MAAM,KAAK,CAAC,GACtC,eAAeL,yBAAyB,QAAQ,GAChD;AACd,2BAA2BA,yBAAyB;AACpD,EAAEjC,SAAS,CAACU,UAAU,CAAC2B,KAAK,EAAE;MACd,GAAG,EAAG3B,UAAU,IAAK;QACjB,MAAM6B,UAAU,GAAG/B,QAAQ,CAACgC,iBAAiB,CAAC9B,UAAU,CAAC+B,UAAU,CAAC,CAC/DC,+BAA+B,CAACjC,EAAE,CAAC;QACxC,OAAO,GAAGC,UAAU,CAACiC,YAAY,GAC3B,GAAGJ,UAAU,eAAe,GAC5B,sBAAsBA,UAAU,GAAG;AAC7D,WAAW;MACK;IACJ,CAAC,CAAC;AACd;AACA,KAAK;AACL;AACA,uBAAuBhC,YAAY,CAACsB,YAAY;AAChD;AACA,QAAQzB,kBAAkB,CAACG,YAAY,CAAC;AACxC;AACA;AACA,QAAQF,WAAW,CAACE,YAAY,EAAE,OAAO,EAAE,KAAK,CAAC;AACjD,QAAQF,WAAW,CAACE,YAAY,EAAE,aAAa,EAAE,IAAI,CAAC;AACtD;AACA;AACA,QAAQL,eAAe,CAACK,YAAY,EAAE4B,GAAG,CAAC;AAC1C;AACA,QAAQhC,gBAAgB,CAACI,YAAY,EAAE,YAAY,EAAE4B,GAAG,CAAC;AACzD;AACA;AACA;AACA,MAAMlC,gBAAgB,CAACM,YAAY,EAAEC,QAAQ,EAAED,YAAY,CAACsB,YAAY,EAAEM,GAAG,CAAC;AAC9E;AACA,CAAC;EACG,CAAC,CAMiB,CAAC,GAAG,EAAE;AAC5B;AACA,mBAAmB5B,YAAY,CAACsB,YAAY,KAAKtB,YAAY,CAACsB,YAAY;AAC1E;AACA,kBAAkBtB,YAAY,CAACqC,WAAW;AAC1C;AACA,UAAU;AACV","ignoreList":[]}

package/build/esm/v2.0/UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst.test.js

@@ -0,0 +1,273 @@
+/*
+ * Copyright 2024 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 { format } from "prettier";
+import { describe, expect, it } from "vitest";
+import { enhanceOntology } from "../GenerateContext/enhanceOntology.js";
+import { __UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst } from "./UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst.js";
+function simpleSpt(apiName, metadataLevel = 2) {
+  return {
+    apiName,
+    dataType: {
+      type: "integer"
+    },
+    rid: `${apiName}Rid`,
+    displayName: metadataLevel >= 1 ? `${apiName} property dn` : apiName,
+    description: metadataLevel >= 2 ? `${apiName} property desc` : undefined
+  };
+}
+function simpleInterface(apiName, spts, parents, metadataLevel = 2) {
+  const properties = Object.fromEntries(spts.map(spt => [spt.apiName, spt]));
+  return {
+    apiName,
+    rid: `${apiName}Rid`,
+    displayName: metadataLevel >= 1 ? `${apiName} interface dn` : apiName,
+    description: metadataLevel >= 2 ? `${apiName} interface desc` : undefined,
+    extendsInterfaces: parents,
+    links: {},
+    properties
+  };
+}
+function simpleOntology(apiName, interfaces) {
+  const interfaceTypes = Object.fromEntries(interfaces.map(i => [i.apiName, i]));
+  const sharedPropertyTypes = Object.fromEntries(interfaces.flatMap(i => Object.entries(i.properties)));
+  return {
+    actionTypes: {},
+    interfaceTypes,
+    objectTypes: {},
+    ontology: {
+      apiName,
+      description: `${apiName} ontology desc`,
+      displayName: `${apiName} ontology dn`,
+      rid: `${apiName} ontology rid`
+    },
+    queryTypes: {},
+    sharedPropertyTypes
+  };
+}
+describe(__UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst, () => {
+  it("Does not say (inherited) on properties locally defined", async () => {
+    const ontology = enhanceOntology(simpleOntology("ontology", [simpleInterface("Bar", [simpleSpt("bar", 0)], [], 0)]), undefined, new Map(), "");
+    const formattedCode = await format(__UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst(ontology.interfaceTypes.Bar, ontology, true), {
+      parser: "typescript",
+      printWidth: 100
+    });
+    expect(formattedCode).toMatchInlineSnapshot(`
+      "import type {
+        InterfaceDefinition as $InterfaceDefinition,
+        ObjectSet as $ObjectSet,
+        Osdk as $Osdk,
+        PropertyValueWireToClient as $PropType,
+      } from "@osdk/api";
+
+      export type OsdkObjectLinks$Bar = {};
+
+      export namespace Bar {
+        export type PropertyKeys = "bar";
+
+        export interface Props {
+          readonly bar: $PropType["integer"] | undefined;
+        }
+        export interface StrictProps {
+          readonly bar: $PropType["integer"] | undefined;
+        }
+
+        export interface ObjectSet extends $ObjectSet<Bar, Bar.ObjectSet> {}
+
+        export type OsdkObject<
+          OPTIONS extends never | "$notStrict" | "$rid" = never,
+          K extends keyof Bar.Props = keyof Bar.Props,
+        > = $Osdk<Bar, K | OPTIONS>;
+      }
+
+      export interface Bar extends $InterfaceDefinition {
+        osdkMetadata: typeof $osdkMetadata;
+        type: "interface";
+        apiName: "Bar";
+        __DefinitionMetadata?: {
+          objectSet: Bar.ObjectSet;
+          props: Bar.Props;
+          linksType: OsdkObjectLinks$Bar;
+          strictProps: Bar.StrictProps;
+          apiName: "Bar";
+          displayName: "Bar";
+          implements: [];
+          links: {};
+          properties: {
+            /**
+             * (no ontology metadata)
+             */
+            bar: $PropertyDef<"integer", "nullable", "single">;
+          };
+          rid: "BarRid";
+          type: "interface";
+        };
+      }
+
+      export const Bar: Bar = {
+        type: "interface",
+        apiName: "Bar",
+        osdkMetadata: $osdkMetadata,
+      };
+      "
+    `);
+  });
+  it("Generates properties for inherited SPTs", async () => {
+    const fooSpt = simpleSpt("foo");
+    const barSpt = simpleSpt("bar");
+    const ontology = enhanceOntology(simpleOntology("ontology", [simpleInterface("Foo", [fooSpt], ["Parent"]), simpleInterface("Parent", [barSpt], [])]), undefined, new Map(), "");
+    const formattedCode = await format(__UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst(ontology.interfaceTypes.Foo, ontology, true), {
+      parser: "typescript"
+    });
+    expect(formattedCode).toMatchInlineSnapshot(`
+      "import type {
+        InterfaceDefinition as $InterfaceDefinition,
+        ObjectSet as $ObjectSet,
+        Osdk as $Osdk,
+        PropertyValueWireToClient as $PropType,
+      } from "@osdk/api";
+
+      export type OsdkObjectLinks$Foo = {};
+
+      export namespace Foo {
+        export type PropertyKeys = "foo";
+
+        export interface Props {
+          readonly foo: $PropType["integer"] | undefined;
+        }
+        export interface StrictProps {
+          readonly foo: $PropType["integer"] | undefined;
+        }
+
+        export interface ObjectSet extends $ObjectSet<Foo, Foo.ObjectSet> {}
+
+        export type OsdkObject<
+          OPTIONS extends never | "$notStrict" | "$rid" = never,
+          K extends keyof Foo.Props = keyof Foo.Props,
+        > = $Osdk<Foo, K | OPTIONS>;
+      }
+
+      export interface Foo extends $InterfaceDefinition {
+        osdkMetadata: typeof $osdkMetadata;
+        type: "interface";
+        apiName: "Foo";
+        __DefinitionMetadata?: {
+          objectSet: Foo.ObjectSet;
+          props: Foo.Props;
+          linksType: OsdkObjectLinks$Foo;
+          strictProps: Foo.StrictProps;
+          apiName: "Foo";
+          description: "Foo interface desc";
+          displayName: "Foo interface dn";
+          implements: ["Parent"];
+          links: {};
+          properties: {
+            /**
+             *   display name: 'foo property dn',
+             *   description: foo property desc
+             */
+            foo: $PropertyDef<"integer", "nullable", "single">;
+          };
+          rid: "FooRid";
+          type: "interface";
+        };
+      }
+
+      export const Foo: Foo = {
+        type: "interface",
+        apiName: "Foo",
+        osdkMetadata: $osdkMetadata,
+      };
+      "
+    `);
+  });
+  it("allows for SPT reuse if the same", async () => {
+    const fooSpt = simpleSpt("foo");
+    const barSpt = simpleSpt("bar");
+    const ontology = enhanceOntology(simpleOntology("ontology", [simpleInterface("Foo", [fooSpt, barSpt], ["Parent"]), simpleInterface("Parent", [barSpt], [])]), undefined, new Map(), "");
+    const formattedCode = await format(__UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst(ontology.interfaceTypes.Foo, ontology, true), {
+      parser: "typescript"
+    });
+    expect(formattedCode).toMatchInlineSnapshot(`
+      "import type {
+        InterfaceDefinition as $InterfaceDefinition,
+        ObjectSet as $ObjectSet,
+        Osdk as $Osdk,
+        PropertyValueWireToClient as $PropType,
+      } from "@osdk/api";
+
+      export type OsdkObjectLinks$Foo = {};
+
+      export namespace Foo {
+        export type PropertyKeys = "foo" | "bar";
+
+        export interface Props {
+          readonly bar: $PropType["integer"] | undefined;
+          readonly foo: $PropType["integer"] | undefined;
+        }
+        export interface StrictProps {
+          readonly bar: $PropType["integer"] | undefined;
+          readonly foo: $PropType["integer"] | undefined;
+        }
+
+        export interface ObjectSet extends $ObjectSet<Foo, Foo.ObjectSet> {}
+
+        export type OsdkObject<
+          OPTIONS extends never | "$notStrict" | "$rid" = never,
+          K extends keyof Foo.Props = keyof Foo.Props,
+        > = $Osdk<Foo, K | OPTIONS>;
+      }
+
+      export interface Foo extends $InterfaceDefinition {
+        osdkMetadata: typeof $osdkMetadata;
+        type: "interface";
+        apiName: "Foo";
+        __DefinitionMetadata?: {
+          objectSet: Foo.ObjectSet;
+          props: Foo.Props;
+          linksType: OsdkObjectLinks$Foo;
+          strictProps: Foo.StrictProps;
+          apiName: "Foo";
+          description: "Foo interface desc";
+          displayName: "Foo interface dn";
+          implements: ["Parent"];
+          links: {};
+          properties: {
+            /**
+             *   display name: 'bar property dn',
+             *   description: bar property desc
+             */
+            bar: $PropertyDef<"integer", "nullable", "single">;
+            /**
+             *   display name: 'foo property dn',
+             *   description: foo property desc
+             */
+            foo: $PropertyDef<"integer", "nullable", "single">;
+          };
+          rid: "FooRid";
+          type: "interface";
+        };
+      }
+
+      export const Foo: Foo = {
+        type: "interface",
+        apiName: "Foo",
+        osdkMetadata: $osdkMetadata,
+      };
+      "
+    `);
+  });
+});
+//# sourceMappingURL=UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst.test.js.map

package/build/esm/v2.0/UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst.test.js","names":["format","describe","expect","it","enhanceOntology","__UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst","simpleSpt","apiName","metadataLevel","dataType","type","rid","displayName","description","undefined","simpleInterface","spts","parents","properties","Object","fromEntries","map","spt","extendsInterfaces","links","simpleOntology","interfaces","interfaceTypes","i","sharedPropertyTypes","flatMap","entries","actionTypes","objectTypes","ontology","queryTypes","Map","formattedCode","Bar","parser","printWidth","toMatchInlineSnapshot","fooSpt","barSpt","Foo"],"sources":["UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst.test.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 { format } from \"prettier\";\nimport { describe, expect, it } from \"vitest\";\nimport { enhanceOntology } from \"../GenerateContext/enhanceOntology.js\";\nimport { __UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst } from \"./UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst.js\";\nfunction simpleSpt(apiName, metadataLevel = 2) {\n    return {\n        apiName,\n        dataType: {\n            type: \"integer\",\n        },\n        rid: `${apiName}Rid`,\n        displayName: metadataLevel >= 1 ? `${apiName} property dn` : apiName,\n        description: metadataLevel >= 2 ? `${apiName} property desc` : undefined,\n    };\n}\nfunction simpleInterface(apiName, spts, parents, metadataLevel = 2) {\n    const properties = Object.fromEntries(spts.map(spt => [spt.apiName, spt]));\n    return {\n        apiName,\n        rid: `${apiName}Rid`,\n        displayName: metadataLevel >= 1 ? `${apiName} interface dn` : apiName,\n        description: metadataLevel >= 2 ? `${apiName} interface desc` : undefined,\n        extendsInterfaces: parents,\n        links: {},\n        properties,\n    };\n}\nfunction simpleOntology(apiName, interfaces) {\n    const interfaceTypes = Object\n        .fromEntries(interfaces.map(i => [i.apiName, i]));\n    const sharedPropertyTypes = Object\n        .fromEntries(interfaces.flatMap(i => Object.entries(i.properties)));\n    return {\n        actionTypes: {},\n        interfaceTypes,\n        objectTypes: {},\n        ontology: {\n            apiName,\n            description: `${apiName} ontology desc`,\n            displayName: `${apiName} ontology dn`,\n            rid: `${apiName} ontology rid`,\n        },\n        queryTypes: {},\n        sharedPropertyTypes,\n    };\n}\ndescribe(__UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst, () => {\n    it(\"Does not say (inherited) on properties locally defined\", async () => {\n        const ontology = enhanceOntology(simpleOntology(\"ontology\", [\n            simpleInterface(\"Bar\", [simpleSpt(\"bar\", 0)], [], 0),\n        ]), undefined, new Map(), \"\");\n        const formattedCode = await format(__UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst(ontology.interfaceTypes.Bar, ontology, true), {\n            parser: \"typescript\",\n            printWidth: 100,\n        });\n        expect(formattedCode).toMatchInlineSnapshot(`\n      \"import type {\n        InterfaceDefinition as $InterfaceDefinition,\n        ObjectSet as $ObjectSet,\n        Osdk as $Osdk,\n        PropertyValueWireToClient as $PropType,\n      } from \"@osdk/api\";\n\n      export type OsdkObjectLinks$Bar = {};\n\n      export namespace Bar {\n        export type PropertyKeys = \"bar\";\n\n        export interface Props {\n          readonly bar: $PropType[\"integer\"] | undefined;\n        }\n        export interface StrictProps {\n          readonly bar: $PropType[\"integer\"] | undefined;\n        }\n\n        export interface ObjectSet extends $ObjectSet<Bar, Bar.ObjectSet> {}\n\n        export type OsdkObject<\n          OPTIONS extends never | \"$notStrict\" | \"$rid\" = never,\n          K extends keyof Bar.Props = keyof Bar.Props,\n        > = $Osdk<Bar, K | OPTIONS>;\n      }\n\n      export interface Bar extends $InterfaceDefinition {\n        osdkMetadata: typeof $osdkMetadata;\n        type: \"interface\";\n        apiName: \"Bar\";\n        __DefinitionMetadata?: {\n          objectSet: Bar.ObjectSet;\n          props: Bar.Props;\n          linksType: OsdkObjectLinks$Bar;\n          strictProps: Bar.StrictProps;\n          apiName: \"Bar\";\n          displayName: \"Bar\";\n          implements: [];\n          links: {};\n          properties: {\n            /**\n             * (no ontology metadata)\n             */\n            bar: $PropertyDef<\"integer\", \"nullable\", \"single\">;\n          };\n          rid: \"BarRid\";\n          type: \"interface\";\n        };\n      }\n\n      export const Bar: Bar = {\n        type: \"interface\",\n        apiName: \"Bar\",\n        osdkMetadata: $osdkMetadata,\n      };\n      \"\n    `);\n    });\n    it(\"Generates properties for inherited SPTs\", async () => {\n        const fooSpt = simpleSpt(\"foo\");\n        const barSpt = simpleSpt(\"bar\");\n        const ontology = enhanceOntology(simpleOntology(\"ontology\", [\n            simpleInterface(\"Foo\", [fooSpt], [\"Parent\"]),\n            simpleInterface(\"Parent\", [barSpt], []),\n        ]), undefined, new Map(), \"\");\n        const formattedCode = await format(__UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst(ontology.interfaceTypes.Foo, ontology, true), {\n            parser: \"typescript\",\n        });\n        expect(formattedCode).toMatchInlineSnapshot(`\n      \"import type {\n        InterfaceDefinition as $InterfaceDefinition,\n        ObjectSet as $ObjectSet,\n        Osdk as $Osdk,\n        PropertyValueWireToClient as $PropType,\n      } from \"@osdk/api\";\n\n      export type OsdkObjectLinks$Foo = {};\n\n      export namespace Foo {\n        export type PropertyKeys = \"foo\";\n\n        export interface Props {\n          readonly foo: $PropType[\"integer\"] | undefined;\n        }\n        export interface StrictProps {\n          readonly foo: $PropType[\"integer\"] | undefined;\n        }\n\n        export interface ObjectSet extends $ObjectSet<Foo, Foo.ObjectSet> {}\n\n        export type OsdkObject<\n          OPTIONS extends never | \"$notStrict\" | \"$rid\" = never,\n          K extends keyof Foo.Props = keyof Foo.Props,\n        > = $Osdk<Foo, K | OPTIONS>;\n      }\n\n      export interface Foo extends $InterfaceDefinition {\n        osdkMetadata: typeof $osdkMetadata;\n        type: \"interface\";\n        apiName: \"Foo\";\n        __DefinitionMetadata?: {\n          objectSet: Foo.ObjectSet;\n          props: Foo.Props;\n          linksType: OsdkObjectLinks$Foo;\n          strictProps: Foo.StrictProps;\n          apiName: \"Foo\";\n          description: \"Foo interface desc\";\n          displayName: \"Foo interface dn\";\n          implements: [\"Parent\"];\n          links: {};\n          properties: {\n            /**\n             *   display name: 'foo property dn',\n             *   description: foo property desc\n             */\n            foo: $PropertyDef<\"integer\", \"nullable\", \"single\">;\n          };\n          rid: \"FooRid\";\n          type: \"interface\";\n        };\n      }\n\n      export const Foo: Foo = {\n        type: \"interface\",\n        apiName: \"Foo\",\n        osdkMetadata: $osdkMetadata,\n      };\n      \"\n    `);\n    });\n    it(\"allows for SPT reuse if the same\", async () => {\n        const fooSpt = simpleSpt(\"foo\");\n        const barSpt = simpleSpt(\"bar\");\n        const ontology = enhanceOntology(simpleOntology(\"ontology\", [\n            simpleInterface(\"Foo\", [fooSpt, barSpt], [\"Parent\"]),\n            simpleInterface(\"Parent\", [barSpt], []),\n        ]), undefined, new Map(), \"\");\n        const formattedCode = await format(__UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst(ontology.interfaceTypes.Foo, ontology, true), {\n            parser: \"typescript\",\n        });\n        expect(formattedCode).toMatchInlineSnapshot(`\n      \"import type {\n        InterfaceDefinition as $InterfaceDefinition,\n        ObjectSet as $ObjectSet,\n        Osdk as $Osdk,\n        PropertyValueWireToClient as $PropType,\n      } from \"@osdk/api\";\n\n      export type OsdkObjectLinks$Foo = {};\n\n      export namespace Foo {\n        export type PropertyKeys = \"foo\" | \"bar\";\n\n        export interface Props {\n          readonly bar: $PropType[\"integer\"] | undefined;\n          readonly foo: $PropType[\"integer\"] | undefined;\n        }\n        export interface StrictProps {\n          readonly bar: $PropType[\"integer\"] | undefined;\n          readonly foo: $PropType[\"integer\"] | undefined;\n        }\n\n        export interface ObjectSet extends $ObjectSet<Foo, Foo.ObjectSet> {}\n\n        export type OsdkObject<\n          OPTIONS extends never | \"$notStrict\" | \"$rid\" = never,\n          K extends keyof Foo.Props = keyof Foo.Props,\n        > = $Osdk<Foo, K | OPTIONS>;\n      }\n\n      export interface Foo extends $InterfaceDefinition {\n        osdkMetadata: typeof $osdkMetadata;\n        type: \"interface\";\n        apiName: \"Foo\";\n        __DefinitionMetadata?: {\n          objectSet: Foo.ObjectSet;\n          props: Foo.Props;\n          linksType: OsdkObjectLinks$Foo;\n          strictProps: Foo.StrictProps;\n          apiName: \"Foo\";\n          description: \"Foo interface desc\";\n          displayName: \"Foo interface dn\";\n          implements: [\"Parent\"];\n          links: {};\n          properties: {\n            /**\n             *   display name: 'bar property dn',\n             *   description: bar property desc\n             */\n            bar: $PropertyDef<\"integer\", \"nullable\", \"single\">;\n            /**\n             *   display name: 'foo property dn',\n             *   description: foo property desc\n             */\n            foo: $PropertyDef<\"integer\", \"nullable\", \"single\">;\n          };\n          rid: \"FooRid\";\n          type: \"interface\";\n        };\n      }\n\n      export const Foo: Foo = {\n        type: \"interface\",\n        apiName: \"Foo\",\n        osdkMetadata: $osdkMetadata,\n      };\n      \"\n    `);\n    });\n});\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASA,MAAM,QAAQ,UAAU;AACjC,SAASC,QAAQ,EAAEC,MAAM,EAAEC,EAAE,QAAQ,QAAQ;AAC7C,SAASC,eAAe,QAAQ,uCAAuC;AACvE,SAASC,8CAA8C,QAAQ,mDAAmD;AAClH,SAASC,SAASA,CAACC,OAAO,EAAEC,aAAa,GAAG,CAAC,EAAE;EAC3C,OAAO;IACHD,OAAO;IACPE,QAAQ,EAAE;MACNC,IAAI,EAAE;IACV,CAAC;IACDC,GAAG,EAAE,GAAGJ,OAAO,KAAK;IACpBK,WAAW,EAAEJ,aAAa,IAAI,CAAC,GAAG,GAAGD,OAAO,cAAc,GAAGA,OAAO;IACpEM,WAAW,EAAEL,aAAa,IAAI,CAAC,GAAG,GAAGD,OAAO,gBAAgB,GAAGO;EACnE,CAAC;AACL;AACA,SAASC,eAAeA,CAACR,OAAO,EAAES,IAAI,EAAEC,OAAO,EAAET,aAAa,GAAG,CAAC,EAAE;EAChE,MAAMU,UAAU,GAAGC,MAAM,CAACC,WAAW,CAACJ,IAAI,CAACK,GAAG,CAACC,GAAG,IAAI,CAACA,GAAG,CAACf,OAAO,EAAEe,GAAG,CAAC,CAAC,CAAC;EAC1E,OAAO;IACHf,OAAO;IACPI,GAAG,EAAE,GAAGJ,OAAO,KAAK;IACpBK,WAAW,EAAEJ,aAAa,IAAI,CAAC,GAAG,GAAGD,OAAO,eAAe,GAAGA,OAAO;IACrEM,WAAW,EAAEL,aAAa,IAAI,CAAC,GAAG,GAAGD,OAAO,iBAAiB,GAAGO,SAAS;IACzES,iBAAiB,EAAEN,OAAO;IAC1BO,KAAK,EAAE,CAAC,CAAC;IACTN;EACJ,CAAC;AACL;AACA,SAASO,cAAcA,CAAClB,OAAO,EAAEmB,UAAU,EAAE;EACzC,MAAMC,cAAc,GAAGR,MAAM,CACxBC,WAAW,CAACM,UAAU,CAACL,GAAG,CAACO,CAAC,IAAI,CAACA,CAAC,CAACrB,OAAO,EAAEqB,CAAC,CAAC,CAAC,CAAC;EACrD,MAAMC,mBAAmB,GAAGV,MAAM,CAC7BC,WAAW,CAACM,UAAU,CAACI,OAAO,CAACF,CAAC,IAAIT,MAAM,CAACY,OAAO,CAACH,CAAC,CAACV,UAAU,CAAC,CAAC,CAAC;EACvE,OAAO;IACHc,WAAW,EAAE,CAAC,CAAC;IACfL,cAAc;IACdM,WAAW,EAAE,CAAC,CAAC;IACfC,QAAQ,EAAE;MACN3B,OAAO;MACPM,WAAW,EAAE,GAAGN,OAAO,gBAAgB;MACvCK,WAAW,EAAE,GAAGL,OAAO,cAAc;MACrCI,GAAG,EAAE,GAAGJ,OAAO;IACnB,CAAC;IACD4B,UAAU,EAAE,CAAC,CAAC;IACdN;EACJ,CAAC;AACL;AACA5B,QAAQ,CAACI,8CAA8C,EAAE,MAAM;EAC3DF,EAAE,CAAC,wDAAwD,EAAE,YAAY;IACrE,MAAM+B,QAAQ,GAAG9B,eAAe,CAACqB,cAAc,CAAC,UAAU,EAAE,CACxDV,eAAe,CAAC,KAAK,EAAE,CAACT,SAAS,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CACvD,CAAC,EAAEQ,SAAS,EAAE,IAAIsB,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC;IAC7B,MAAMC,aAAa,GAAG,MAAMrC,MAAM,CAACK,8CAA8C,CAAC6B,QAAQ,CAACP,cAAc,CAACW,GAAG,EAAEJ,QAAQ,EAAE,IAAI,CAAC,EAAE;MAC5HK,MAAM,EAAE,YAAY;MACpBC,UAAU,EAAE;IAChB,CAAC,CAAC;IACFtC,MAAM,CAACmC,aAAa,CAAC,CAACI,qBAAqB,CAAC;AACpD;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,KAAK,CAAC;EACF,CAAC,CAAC;EACFtC,EAAE,CAAC,yCAAyC,EAAE,YAAY;IACtD,MAAMuC,MAAM,GAAGpC,SAAS,CAAC,KAAK,CAAC;IAC/B,MAAMqC,MAAM,GAAGrC,SAAS,CAAC,KAAK,CAAC;IAC/B,MAAM4B,QAAQ,GAAG9B,eAAe,CAACqB,cAAc,CAAC,UAAU,EAAE,CACxDV,eAAe,CAAC,KAAK,EAAE,CAAC2B,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,EAC5C3B,eAAe,CAAC,QAAQ,EAAE,CAAC4B,MAAM,CAAC,EAAE,EAAE,CAAC,CAC1C,CAAC,EAAE7B,SAAS,EAAE,IAAIsB,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC;IAC7B,MAAMC,aAAa,GAAG,MAAMrC,MAAM,CAACK,8CAA8C,CAAC6B,QAAQ,CAACP,cAAc,CAACiB,GAAG,EAAEV,QAAQ,EAAE,IAAI,CAAC,EAAE;MAC5HK,MAAM,EAAE;IACZ,CAAC,CAAC;IACFrC,MAAM,CAACmC,aAAa,CAAC,CAACI,qBAAqB,CAAC;AACpD;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,KAAK,CAAC;EACF,CAAC,CAAC;EACFtC,EAAE,CAAC,kCAAkC,EAAE,YAAY;IAC/C,MAAMuC,MAAM,GAAGpC,SAAS,CAAC,KAAK,CAAC;IAC/B,MAAMqC,MAAM,GAAGrC,SAAS,CAAC,KAAK,CAAC;IAC/B,MAAM4B,QAAQ,GAAG9B,eAAe,CAACqB,cAAc,CAAC,UAAU,EAAE,CACxDV,eAAe,CAAC,KAAK,EAAE,CAAC2B,MAAM,EAAEC,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,EACpD5B,eAAe,CAAC,QAAQ,EAAE,CAAC4B,MAAM,CAAC,EAAE,EAAE,CAAC,CAC1C,CAAC,EAAE7B,SAAS,EAAE,IAAIsB,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC;IAC7B,MAAMC,aAAa,GAAG,MAAMrC,MAAM,CAACK,8CAA8C,CAAC6B,QAAQ,CAACP,cAAc,CAACiB,GAAG,EAAEV,QAAQ,EAAE,IAAI,CAAC,EAAE;MAC5HK,MAAM,EAAE;IACZ,CAAC,CAAC;IACFrC,MAAM,CAACmC,aAAa,CAAC,CAACI,qBAAqB,CAAC;AACpD;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,KAAK,CAAC;EACF,CAAC,CAAC;AACN,CAAC,CAAC","ignoreList":[]}