@osdk/generator 1.6.0 → 1.8.0

package/build/js/index.mjs

@@ -2,7 +2,7 @@ import * as path15 from 'path';
 import path15__default, { join } from 'path';
 import { format } from 'prettier';
 import organizeImports from 'prettier-plugin-organize-imports';
-import { wireObjectTypeFullMetadataToSdkObjectTypeDefinition, wirePropertyV2ToSdkPropertyDefinition } from '@osdk/generator-converters';
+import { wireObjectTypeFullMetadataToSdkObjectTypeDefinition, __UNSTABLE_wireInterfaceTypeV2ToSdkObjectDefinition } from '@osdk/generator-converters';
 
 // src/v1.1/generateClientSdkVersionOneDotOne.ts
 
@@ -848,7 +848,9 @@ var defaultCustomizer = (value, defaultValueFormatter, key, defaultKeyFormatter)
 function stringify(obj, customizer = {}, separator = ",\n") {
   const defaultKeyFormatter = (key) => `${JSON.stringify(key)}`;
   const entries = [];
-  for (const [key, value] of Object.entries(obj)) {
+  const sortedKeys = Object.keys(obj).sort((a, b) => a.localeCompare(b));
+  for (const key of sortedKeys) {
+    const value = obj[key];
     const res = (customizer[key] ?? customizer["*"] ?? defaultCustomizer)(value, (value2) => JSON.stringify(value2, null, 2), key, defaultKeyFormatter);
     if (res) {
       if (typeof res === "string") {
@@ -927,8 +929,12 @@ ${Array.from(uniqueLinkTargets).map((linkTarget) => `import type { ${linkTarget}
 
   ${getDescriptionIfPresent(objectTypeWithLinks.objectType.description)}
   export interface ${objectTypeWithLinks.objectType.apiName} extends OntologyObject {
+  /** @deprecated please migrate to $apiName instead */
   readonly __apiName: "${objectTypeWithLinks.objectType.apiName}";
+  /** @deprecated please migrate to $primaryKey instead */
   readonly __primaryKey: ${wirePropertyTypeV2ToTypeScriptType(objectTypeWithLinks.objectType.properties[objectTypeWithLinks.objectType.primaryKey].dataType)};
+  readonly $apiName: "${objectTypeWithLinks.objectType.apiName}";
+  readonly $primaryKey: ${wirePropertyTypeV2ToTypeScriptType(objectTypeWithLinks.objectType.properties[objectTypeWithLinks.objectType.primaryKey].dataType)};
 ${Object.entries(objectTypeWithLinks.objectType.properties).sort((a, b) => a[0].localeCompare(b[0])).flatMap(([propertyName, propertyDefinition]) => {
     const propertyType = wirePropertyTypeV2ToTypeScriptType(propertyDefinition.dataType);
     const entries = [`${getDescriptionIfPresent(propertyDefinition.description, true)}readonly ${propertyName}: ${propertyType} | undefined`];
@@ -962,7 +968,7 @@ function wirePropertyTypeV2ToTypeScriptType(property) {
     case "date":
       return "LocalDate";
     case "decimal":
-      return "number";
+      return "string";
     case "double":
       return "number";
     case "float":
@@ -972,7 +978,7 @@ function wirePropertyTypeV2ToTypeScriptType(property) {
     case "geoshape":
       return "GeoShape";
     case "long":
-      return "number";
+      return "string";
     case "short":
       return "number";
     case "timestamp":
@@ -1012,13 +1018,14 @@ async function generatePerActionDataFiles(ontology, fs, outDir, importExt, v2) {
     const paramsIdentifier = `${action.apiName}$Params`;
     function createParamsDef() {
       const entries = Object.entries(parameters);
+      entries.sort((a, b) => a[0].localeCompare(b[0]));
       if (entries.length === 0) {
         return `// Represents the definition of the parameters for the action
           export type ${paramsDefIdentifier} = Record<string, never>;`;
       }
       return `// Represents the definition of the parameters for the action
         export type ${paramsDefIdentifier} = {
-          ${Object.entries(parameters).map(([key, value]) => {
+          ${entries.map(([key, value]) => {
         return `"${key}": {
                 ${stringify(value, {
           description: (value2, d) => value2 ? d(value2) : void 0,
@@ -1057,7 +1064,7 @@ async function generatePerActionDataFiles(ontology, fs, outDir, importExt, v2) {
           
           // Represents the definition of the action
           export interface ${actionDefIdentifier} extends ActionDefinition<"${action.apiName}", ${uniqueApiNamesString}, ${action.apiName}>{
-          ${Object.entries(actionDefSansParameters).map(([key, value]) => {
+          ${Object.entries(actionDefSansParameters).sort((a, b) => a[0].localeCompare(b[0])).map(([key, value]) => {
         return `${key}: ${JSON.stringify(value)};`;
       }).join("\n")}
           parameters: ${paramsDefIdentifier}
@@ -1075,6 +1082,10 @@ async function generatePerActionDataFiles(ontology, fs, outDir, importExt, v2) {
         referencedObjectDefs.add(getObjectDefIdentifier(p.dataType.objectApiName, v2));
         referencedObjectDefs.add(getObjectDefIdentifier(p.dataType.objectTypeApiName, v2));
       }
+      if (p.dataType.type === "array" && (p.dataType.subType.type === "object" || p.dataType.subType.type === "objectSet")) {
+        referencedObjectDefs.add(getObjectDefIdentifier(p.dataType.subType.objectApiName, v2));
+        referencedObjectDefs.add(getObjectDefIdentifier(p.dataType.subType.objectTypeApiName, v2));
+      }
     }
     const importObjects = referencedObjectDefs.size > 0 ? `import type {${[...referencedObjectDefs].join(",")}} from "../objects${importExt}";` : "";
     await fs.writeFile(path15__default.join(outDir, `${action.apiName}.ts`), await formatTs(`
@@ -1090,6 +1101,7 @@ async function generatePerActionDataFiles(ontology, fs, outDir, importExt, v2) {
   }));
   await fs.writeFile(path15__default.join(outDir, `index.ts`), await formatTs(`
       ${Object.values(ontology.actionTypes).map((action) => `export {${action.apiName}} from "./${action.apiName}${importExt}";`).join("\n")}
+    ${Object.keys(ontology.actionTypes).length === 0 ? "export {};" : ""}
       `));
 }
 function extractReferencedObjectsFromAction(actionType) {
@@ -1413,8 +1425,9 @@ function handleQueryDataType(dataType, importedObjects, isReturnValue) {
     case "double":
     case "float":
     case "integer":
-    case "long":
       return "number";
+    case "long":
+      return isReturnValue ? "string" : "string | number";
     case "date":
       return "LocalDate";
     case "timestamp":
@@ -1536,20 +1549,38 @@ async function generateClientSdkVersionOneDotOne(ontology, userAgent, fs, outDir
   await generateIndexFile(fs, outDir, importExt);
   await generateBackCompatDeprecatedExports(fs, outDir, importExt);
 }
-function __UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst(interfaceType, v2 = false) {
-  return `
-    export const ${interfaceType.apiName} = ${JSON.stringify(wireInterfaceTypeV2ToSdkObjectDefinition(interfaceType), null, 2)} satisfies InterfaceDefinition<"${interfaceType.apiName}", "">;`;
-}
-function wireInterfaceTypeV2ToSdkObjectDefinition(interfaceType, v2) {
-  return {
-    type: "interface",
-    apiName: interfaceType.apiName,
-    description: interfaceType.description,
-    properties: Object.fromEntries(Object.entries(interfaceType.properties).map(([key, value]) => {
-      return [key, wirePropertyV2ToSdkPropertyDefinition(value, true)];
-    })),
-    links: {}
-  };
+function __UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst(interfaceDef, v2 = false) {
+  const definition = deleteUndefineds(__UNSTABLE_wireInterfaceTypeV2ToSdkObjectDefinition(interfaceDef, v2));
+  const objectDefIdentifier = getObjectDefIdentifier(interfaceDef.apiName, v2);
+  function getV2Types() {
+    return `
+  export interface ${objectDefIdentifier} extends InterfaceDefinition<"${interfaceDef.apiName}", ${interfaceDef.apiName}> {
+    ${stringify(definition, {
+      type: () => void 0,
+      apiName: () => void 0,
+      links: (_value) => `{
+      ${stringify(definition.links, {
+        "*": (definition2) => `ObjectTypeLinkDefinition<${getObjectDefIdentifier(definition2.targetType, v2)}, ${definition2.multiplicity}>`
+      })}
+    }`,
+      properties: (_value) => `{
+      ${stringify(definition.properties, {
+        "*": (propertyDefinition) => `PropertyDef<"${propertyDefinition.type}", "${propertyDefinition.nullable ? "nullable" : "non-nullable"}", "${propertyDefinition.multiplicity ? "array" : "single"}">`
+      })}
+    }`
+    })}
+  }
+
+`;
+  }
+  const imports = [];
+  return `${imports.join("\n")}
+
+    ${v2 ? getV2Types() : ""}
+
+    export const ${definition.apiName}: ${objectDefIdentifier} = {
+      ${stringify(definition)}
+    };`;
 }
 async function generateOntologyMetadataFile(ontology, userAgent, fs, outDir) {
   fs.writeFile(path15__default.join(outDir, "OntologyMetadata.ts"), await formatTs(`
@@ -1565,9 +1596,10 @@ async function generateOntologyMetadataFile(ontology, userAgent, fs, outDir) {
 async function generateClientSdkVersionTwoPointZero(ontology, userAgent, fs, outDir, packageType = "commonjs") {
   await verifyOutdir(outDir, fs);
   const sanitizedOntology = sanitizeMetadata(ontology);
-  const objectNames = Object.keys(sanitizedOntology.objectTypes);
-  const actionNames = Object.keys(sanitizedOntology.actionTypes);
-  const interfaceNames = Object.keys(sanitizedOntology.interfaceTypes ?? {});
+  const objectNames = Object.keys(sanitizedOntology.objectTypes).sort((a, b) => a.localeCompare(b));
+  const actionNames = Object.keys(sanitizedOntology.actionTypes).sort((a, b) => a.localeCompare(b));
+  Object.keys(sanitizedOntology.queryTypes).sort((a, b) => a.localeCompare(b));
+  const interfaceNames = Object.keys(sanitizedOntology.interfaceTypes ?? {}).sort((a, b) => a.localeCompare(b));
   const importExt = packageType === "module" ? ".js" : "";
   await fs.mkdir(outDir, {
     recursive: true
@@ -1633,7 +1665,8 @@ async function generateClientSdkVersionTwoPointZero(ontology, userAgent, fs, out
   });
   await generatePerActionDataFiles(sanitizedOntology, fs, actionsDir, importExt, true);
   await fs.writeFile(path15__default.join(outDir, "ontology", "objects.ts"), await formatTs(`
-    ${Object.keys(ontology.objectTypes).map((apiName) => `export * from "./objects/${apiName}${importExt}";`).join("\n")}
+    ${Object.keys(ontology.objectTypes).sort((a, b) => a.localeCompare(b)).map((apiName) => `export * from "./objects/${apiName}${importExt}";`).join("\n")}
+    ${Object.keys(ontology.objectTypes).length === 0 ? "export {};" : ""}
     `));
 }
 function stringUnionFrom2(values) {
@@ -1652,7 +1685,7 @@ async function generateOntologyInterfaces(fs, outDir, interfaceNames, ontology,
     const obj = ontology.interfaceTypes[name];
     await fs.writeFile(path15__default.join(interfacesDir, `${name}.ts`), await formatTs(`
     
-      import type { InterfaceDefinition } from "@osdk/api";
+      import type { InterfaceDefinition, PropertyDef } from "@osdk/api";
 
       ${__UNSTABLE_wireInterfaceTypeV2ToSdkObjectConst(obj, true)}
     `));