@osdk/maker 0.12.2 → 0.13.0-beta.10

package/build/cjs/index.cjs

@@ -40,7 +40,7 @@ var fs__namespace = /*#__PURE__*/_interopNamespace(fs);
 // src/cli/main.ts
 
 // src/api/types.ts
-var OntologyEntityTypeEnum = /* @__PURE__ */ function(OntologyEntityTypeEnum2) {
+var OntologyEntityTypeEnum = /* @__PURE__ */ (function(OntologyEntityTypeEnum2) {
   OntologyEntityTypeEnum2["OBJECT_TYPE"] = "OBJECT_TYPE";
   OntologyEntityTypeEnum2["LINK_TYPE"] = "LINK_TYPE";
   OntologyEntityTypeEnum2["INTERFACE_TYPE"] = "INTERFACE_TYPE";
@@ -48,19 +48,21 @@ var OntologyEntityTypeEnum = /* @__PURE__ */ function(OntologyEntityTypeEnum2) {
   OntologyEntityTypeEnum2["ACTION_TYPE"] = "ACTION_TYPE";
   OntologyEntityTypeEnum2["VALUE_TYPE"] = "VALUE_TYPE";
   return OntologyEntityTypeEnum2;
-}({});
+})({});
 var MODIFY_OBJECT_PARAMETER = "objectToModifyParameter";
 var CREATE_OR_MODIFY_OBJECT_PARAMETER = "objectToCreateOrModifyParameter";
 
 // src/api/defineObject.ts
 var ISO_8601_DURATION = /^P(?!$)(?:(?:((?:\d+Y)|(?:\d+(?:\.|,)\d+Y$))?((?:\d+M)|(?:\d+(?:\.|,)\d+M$))?((?:\d+D)|(?:\d+(?:\.|,)\d+D$))?(T((?:\d+H)|(?:\d+(?:\.|,)\d+H$))?((?:\d+M)|(?:\d+(?:\.|,)\d+M$))?((?:\d+S)|(?:\d+(?:\.|,)\d+S$))?)?)|(?:\d+(?:(?:\.|,)\d+)?W))$/;
 var ISO_8601_DATETIME = /^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:\d{2})?)?$/;
+var API_NAME_PATTERN = /^([a-zA-Z][a-zA-Z0-9\\-]*)$/;
 function defineObject(objectDef) {
   const apiName = namespace + objectDef.apiName;
   const propertyApiNames = objectDef.properties ? Object.keys(objectDef.properties) : [];
   if (ontologyDefinition[OntologyEntityTypeEnum.OBJECT_TYPE][apiName] !== void 0) {
     throw new Error(`Object type with apiName ${objectDef.apiName} is already defined`);
   }
+  !API_NAME_PATTERN.test(objectDef.apiName) ? process.env.NODE_ENV !== "production" ? invariant5__default.default(false, `Invalid API name ${objectDef.apiName}. API names must match the regex ${API_NAME_PATTERN}.`) : invariant5__default.default(false) : void 0;
   !propertyApiNames.includes(objectDef.titlePropertyApiName) ? process.env.NODE_ENV !== "production" ? invariant5__default.default(false, `Title property ${objectDef.titlePropertyApiName} is not defined on object ${objectDef.apiName}`) : invariant5__default.default(false) : void 0;
   !propertyApiNames.includes(objectDef.primaryKeyPropertyApiName) ? process.env.NODE_ENV !== "production" ? invariant5__default.default(false, `Primary key property ${objectDef.primaryKeyPropertyApiName} does not exist on object ${objectDef.apiName}`) : invariant5__default.default(false) : void 0;
   !!objectDef.properties?.[objectDef.primaryKeyPropertyApiName]?.editOnly ? process.env.NODE_ENV !== "production" ? invariant5__default.default(false, `Primary key property ${objectDef.primaryKeyPropertyApiName} on object ${objectDef.apiName} cannot be edit-only`) : invariant5__default.default(false) : void 0;
@@ -414,7 +416,9 @@ function getPropertyTypeName(type) {
 function convertValueType(valueType) {
   return {
     apiName: valueType.apiName,
-    version: valueType.version
+    version: valueType.version,
+    packageNamespace: valueType.packageNamespace,
+    displayMetadata: valueType.displayMetadata
   };
 }
 function convertValueTypeDataConstraints(dataConstraints) {
@@ -684,10 +688,7 @@ async function defineOntology(ns, body, outputDir, dependencyFile) {
   if (dependencyFile) {
     writeDependencyFile(dependencyFile);
   }
-  return {
-    ontology: convertToWireOntologyIr(ontologyDefinition),
-    valueType: convertOntologyToValueTypeIr(ontologyDefinition)
-  };
+  return convertToWireOntologyIr(ontologyDefinition);
 }
 function writeStaticObjects(outputDir) {
   const codegenDir = path2__namespace.resolve(outputDir, "codegen");
@@ -753,111 +754,32 @@ export const ${entityFileNameBase}: ${entityTypeName} = wrapWithProxy(${entityFi
 }
 function convertOntologyToValueTypeIr(ontology) {
   return {
-    valueTypes: Object.values(ontology[OntologyEntityTypeEnum.VALUE_TYPE]).map((definitions) => ({
-      metadata: {
-        apiName: definitions[0].apiName,
-        displayMetadata: definitions[0].displayMetadata,
-        status: definitions[0].status
-      },
-      versions: definitions.map((definition) => ({
-        version: definition.version,
-        baseType: definition.baseType,
-        constraints: definition.constraints,
-        exampleValues: definition.exampleValues
-      }))
-    }))
+    valueTypes: convertValueTypesToIr(ontology[OntologyEntityTypeEnum.VALUE_TYPE])
   };
 }
-function convertToWireOntologyIr(ontology) {
-  return {
-    blockData: convertToWireBlockData(ontology),
-    importedTypes: convertToWireImportedTypes(importedTypes)
-  };
+function convertValueTypesToIr(valueTypes) {
+  return Object.values(valueTypes).map((definitions) => ({
+    metadata: {
+      apiName: definitions[0].apiName,
+      packageNamespace: definitions[0].packageNamespace,
+      displayMetadata: definitions[0].displayMetadata,
+      status: definitions[0].status
+    },
+    // TODO(dpaquin): instead of deduping here, we should refactor the value type types from arrays to maps
+    versions: Array.from(new Map(definitions.map((definition) => [definition.version, definition])).values()).map((definition) => ({
+      version: definition.version,
+      baseType: definition.baseType,
+      constraints: definition.constraints,
+      exampleValues: definition.exampleValues
+    }))
+  }));
 }
-function convertToWireImportedTypes(importedTypes2) {
-  const asBlockData = convertToWireBlockData(importedTypes2);
+function convertToWireOntologyIr(ontology) {
   return {
-    sharedPropertyTypes: Object.values(asBlockData.sharedPropertyTypes).map((spt) => ({
-      apiName: spt.sharedPropertyType.apiName,
-      displayName: spt.sharedPropertyType.displayMetadata.displayName,
-      description: spt.sharedPropertyType.displayMetadata.description,
-      type: spt.sharedPropertyType.type,
-      valueType: spt.sharedPropertyType.valueType === void 0 ? void 0 : {
-        apiName: spt.sharedPropertyType.valueType.apiName,
-        version: spt.sharedPropertyType.valueType.version
-      }
-    })),
-    objectTypes: Object.values(asBlockData.objectTypes).map((ot) => ({
-      apiName: ot.objectType.apiName,
-      displayName: ot.objectType.displayMetadata.displayName,
-      description: ot.objectType.displayMetadata.description,
-      propertyTypes: Object.values(ot.objectType.propertyTypes).map((p) => ({
-        apiName: p.apiName,
-        displayName: p.displayMetadata.displayName,
-        description: p.displayMetadata.description,
-        type: p.type,
-        sharedPropertyType: p.sharedPropertyTypeApiName
-      }))
-    })),
-    interfaceTypes: Object.values(asBlockData.interfaceTypes).map((i) => ({
-      apiName: i.interfaceType.apiName,
-      displayName: i.interfaceType.displayMetadata.displayName,
-      description: i.interfaceType.displayMetadata.description,
-      properties: Object.values(i.interfaceType.propertiesV2).map((p) => ({
-        apiName: p.sharedPropertyType.apiName,
-        displayName: p.sharedPropertyType.displayMetadata.displayName,
-        description: p.sharedPropertyType.displayMetadata.description,
-        type: p.sharedPropertyType.type
-      })),
-      links: i.interfaceType.links.map((l) => ({
-        apiName: l.metadata.apiName,
-        displayName: l.metadata.displayName,
-        description: l.metadata.description,
-        cardinality: l.cardinality,
-        required: l.required
-      }))
-    })),
-    actionTypes: Object.values(asBlockData.actionTypes).map((a) => ({
-      apiName: a.actionType.metadata.apiName,
-      displayName: a.actionType.metadata.displayMetadata.displayName,
-      description: a.actionType.metadata.displayMetadata.description,
-      parameters: Object.values(a.actionType.metadata.parameters).map((p) => ({
-        id: p.id,
-        displayName: p.displayMetadata.displayName,
-        description: p.displayMetadata.description,
-        type: p.type
-      }))
-    })),
-    linkTypes: Object.values(asBlockData.linkTypes).map((l) => {
-      if (l.linkType.definition.type === "oneToMany") {
-        return {
-          id: l.linkType.id,
-          definition: {
-            type: "oneToMany",
-            "oneToMany": {
-              objectTypeApiNameOneSide: l.linkType.definition.oneToMany.objectTypeRidOneSide,
-              objectTypeApiNameManySide: l.linkType.definition.oneToMany.objectTypeRidManySide,
-              manyToOneLinkDisplayName: l.linkType.definition.oneToMany.manyToOneLinkMetadata.displayMetadata.displayName,
-              oneToManyLinkDisplayName: l.linkType.definition.oneToMany.oneToManyLinkMetadata.displayMetadata.displayName,
-              cardinality: l.linkType.definition.oneToMany.cardinalityHint
-            }
-          }
-        };
-      } else {
-        return {
-          id: l.linkType.id,
-          definition: {
-            type: "manyToMany",
-            "manyToMany": {
-              objectTypeApiNameA: l.linkType.definition.manyToMany.objectTypeRidA,
-              objectTypeApiNameB: l.linkType.definition.manyToMany.objectTypeRidB,
-              objectTypeAToBLinkDisplayName: l.linkType.definition.manyToMany.objectTypeAToBLinkMetadata.displayMetadata.displayName,
-              objectTypeBToALinkDisplayName: l.linkType.definition.manyToMany.objectTypeBToALinkMetadata.displayMetadata.displayName
-            }
-          }
-        };
-      }
-    })
+    ontology: convertToWireBlockData(ontology),
+    importedOntology: convertToWireBlockData(importedTypes),
+    valueTypes: convertOntologyToValueTypeIr(ontology),
+    importedValueTypes: convertOntologyToValueTypeIr(importedTypes)
   };
 }
 function convertToWireBlockData(ontology) {
@@ -1217,11 +1139,15 @@ function convertInterface(interfaceType) {
       required: spt.required,
       sharedPropertyType: convertSpt(spt.sharedPropertyType)
     }])),
+    displayMetadata: {
+      displayName: interfaceType.displayMetadata.displayName,
+      description: interfaceType.displayMetadata.description
+    },
     extendsInterfaces: interfaceType.extendsInterfaces.map((i) => i.apiName),
     // these are omitted from our internal types but we need to re-add them for the final json
+    properties: [],
     // TODO(mwalther): Support propertiesV3
-    propertiesV3: {},
-    properties: []
+    propertiesV3: {}
   };
 }
 function dumpOntologyFullMetadata() {
@@ -1264,7 +1190,9 @@ function convertSpt({
     typeClasses: typeClasses ?? [],
     valueType: valueType === void 0 ? void 0 : {
       apiName: valueType.apiName,
-      version: valueType.version
+      version: valueType.version,
+      packageNamespace: valueType.packageNamespace,
+      displayMetadata: valueType.displayMetadata
     }
   };
 }
@@ -1704,7 +1632,7 @@ function writeDependencyFile(dependencyFile) {
 function dependencyInjectionString() {
   const namespaceNoDot = namespace.endsWith(".") ? namespace.slice(0, -1) : namespace;
   return `import { addDependency } from "@osdk/maker";
-
+// @ts-ignore
 addDependency("${namespaceNoDot}", new URL(import.meta.url).pathname);
 `;
 }
@@ -1721,7 +1649,7 @@ function convertCardinality(cardinality) {
 // src/cli/main.ts
 var apiNamespaceRegex = /^[a-z0-9-]+(\.[a-z0-9-]+)*\.$/;
 async function main(args = process.argv) {
-  const commandLineOpts = await yargs__default.default(helpers.hideBin(args)).version("0.12.2").wrap(Math.min(150, yargs__default.default().terminalWidth())).strict().help().options({
+  const commandLineOpts = await yargs__default.default(helpers.hideBin(args)).version("0.13.0-beta.10").wrap(Math.min(150, yargs__default.default().terminalWidth())).strict().help().options({
     input: {
       alias: "i",
       describe: "Input file",
@@ -1773,11 +1701,11 @@ async function main(args = process.argv) {
     !apiNamespaceRegex.test(apiNamespace) ? process.env.NODE_ENV !== "production" ? invariant5__default.default(false, "API namespace is invalid! It is expected to conform to ^[a-z0-9-]+(.[a-z0-9-]+)*.$") : invariant5__default.default(false) : void 0;
   }
   consola.consola.info(`Loading ontology from ${commandLineOpts.input}`);
-  const ontology = await loadOntology(commandLineOpts.input, apiNamespace, commandLineOpts.outputDir, commandLineOpts.dependencies);
+  const ontologyIr = await loadOntology(commandLineOpts.input, apiNamespace, commandLineOpts.outputDir, commandLineOpts.dependencies);
   consola.consola.info(`Saving ontology to ${commandLineOpts.output}`);
-  await fs2__namespace.writeFile(commandLineOpts.output, JSON.stringify(ontology.ontology, null, 2));
-  if (ontology.valueType.valueTypes.length > 0) {
-    await fs2__namespace.writeFile(commandLineOpts.valueTypesOutput, JSON.stringify(ontology.valueType, null, 2));
+  await fs2__namespace.writeFile(commandLineOpts.output, JSON.stringify(ontologyIr, null, 2));
+  if (ontologyIr.valueTypes.valueTypes.length > 0 || ontologyIr.importedValueTypes.valueTypes.length > 0) {
+    await fs2__namespace.writeFile(commandLineOpts.valueTypesOutput, JSON.stringify(ontologyIr.valueTypes, null, 2));
   }
 }
 async function loadOntology(input, apiNamespace, outputDir, dependencyFile) {
@@ -1870,7 +1798,7 @@ function defineCreateInterfaceObjectAction(interfaceType, objectType, validation
       }
     }],
     ...validation ? {
-      validation: [convertValidationRule(validation)]
+      validation: convertValidationRule(validation)
     } : {}
   });
 }
@@ -1883,7 +1811,7 @@ function defineCreateObjectAction(def) {
   if (def.parameterOrdering) {
     validateParameterOrdering(def.parameterOrdering, parameterNames, actionApiName);
   }
-  const parameters = createParameters(def, parameterNames, true);
+  const parameters = createParameters(def, parameterNames);
   const mappings = Object.fromEntries(Object.entries(def.nonParameterMappings ?? {}).map(([id, value]) => [id, convertMappingValue(value)]));
   return defineAction({
     apiName: actionApiName,
@@ -1912,7 +1840,7 @@ function defineCreateObjectAction(def) {
     }],
     parameterOrdering: def.parameterOrdering ?? createDefaultParameterOrdering(def, parameters),
     ...def.actionLevelValidation ? {
-      validation: [convertValidationRule(def.actionLevelValidation)]
+      validation: convertValidationRule(def.actionLevelValidation)
     } : {},
     ...def.defaultFormat && {
       defaultFormat: def.defaultFormat
@@ -1995,7 +1923,7 @@ function defineModifyInterfaceObjectAction(interfaceType, objectType, validation
       }
     }],
     ...validation ? {
-      validation: [convertValidationRule(validation)]
+      validation: convertValidationRule(validation)
     } : {}
   });
 }
@@ -2012,7 +1940,7 @@ function defineModifyObjectAction(def) {
     }
     validateParameterOrdering(def.parameterOrdering, parameterNames, actionApiName);
   }
-  const parameters = createParameters(def, parameterNames, false);
+  const parameters = createParameters(def, parameterNames);
   parameters.forEach((p) => {
     if (p.id !== MODIFY_OBJECT_PARAMETER && p.defaultValue === void 0) {
       p.defaultValue = {
@@ -2052,7 +1980,7 @@ function defineModifyObjectAction(def) {
     },
     parameterOrdering: def.parameterOrdering ?? createDefaultParameterOrdering(def, parameters, MODIFY_OBJECT_PARAMETER),
     ...def.actionLevelValidation ? {
-      validation: [convertValidationRule(def.actionLevelValidation)]
+      validation: convertValidationRule(def.actionLevelValidation)
     } : {},
     ...def.defaultFormat && {
       defaultFormat: def.defaultFormat
@@ -2105,7 +2033,7 @@ function defineDeleteObjectAction(def) {
       typeGroups: []
     },
     ...def.actionLevelValidation ? {
-      validation: [convertValidationRule(def.actionLevelValidation)]
+      validation: convertValidationRule(def.actionLevelValidation)
     } : {}
   });
 }
@@ -2122,7 +2050,7 @@ function defineCreateOrModifyObjectAction(def) {
     }
     validateParameterOrdering(def.parameterOrdering, parameterNames, actionApiName);
   }
-  const parameters = createParameters(def, parameterNames, false);
+  const parameters = createParameters(def, parameterNames);
   parameters.forEach((p) => {
     if (p.id !== CREATE_OR_MODIFY_OBJECT_PARAMETER && p.defaultValue === void 0) {
       p.defaultValue = {
@@ -2162,7 +2090,7 @@ function defineCreateOrModifyObjectAction(def) {
     },
     parameterOrdering: def.parameterOrdering ?? createDefaultParameterOrdering(def, parameters, CREATE_OR_MODIFY_OBJECT_PARAMETER),
     ...def.actionLevelValidation ? {
-      validation: [convertValidationRule(def.actionLevelValidation)]
+      validation: convertValidationRule(def.actionLevelValidation)
     } : {},
     ...def.defaultFormat && {
       defaultFormat: def.defaultFormat
@@ -2219,7 +2147,7 @@ function defineAction(actionDef) {
   updateOntology(fullAction);
   return fullAction;
 }
-function createParameters(def, parameterSet, defaultRequired) {
+function createParameters(def, parameterSet) {
   const targetParam = [];
   parameterSet.forEach((name) => {
     if (name === MODIFY_OBJECT_PARAMETER) {
@@ -2281,13 +2209,13 @@ function createParameters(def, parameterSet, defaultRequired) {
     validation: def.parameterConfiguration?.[id] !== void 0 ? {
       ...def.parameterConfiguration?.[id],
       allowedValues: def.parameterConfiguration?.[id].allowedValues ?? (def.parameterConfiguration?.[id].customParameterType ? extractAllowedValuesFromActionParameterType(def.parameterConfiguration?.[id].customParameterType) : extractAllowedValuesFromPropertyType(def.objectType.properties?.[id].type)),
-      required: def.parameterConfiguration?.[id].required ?? defaultRequired
+      required: def.parameterConfiguration?.[id].required ?? def.objectType.properties?.[id]?.nullability?.noNulls ?? false
     } : {
       required: def.objectType.properties?.[id].array ?? false ? {
         listLength: def.objectType.properties?.[id].nullability?.noEmptyCollections ? {
           min: 1
         } : {}
-      } : def.objectType.properties?.[id].nullability?.noNulls ?? defaultRequired,
+      } : def.objectType.properties?.[id].nullability?.noNulls ?? false,
       allowedValues: extractAllowedValuesFromPropertyType(def.objectType.properties?.[id].type)
     },
     defaultValue: def.parameterConfiguration?.[id]?.defaultValue,
@@ -2564,13 +2492,15 @@ function sanitize2(s) {
   return s.includes(".") ? s : namespace + s;
 }
 function convertValidationRule(actionValidation) {
-  return {
-    condition: convertConditionDefinition(actionValidation.condition),
-    displayMetadata: actionValidation.displayMetadata ?? {
-      failureMessage: "Did not satisfy validation",
-      typeClasses: []
-    }
-  };
+  return actionValidation.map((rule) => {
+    return {
+      condition: convertConditionDefinition(rule.condition),
+      displayMetadata: rule.displayMetadata ?? {
+        failureMessage: "Did not satisfy validation",
+        typeClasses: []
+      }
+    };
+  });
 }
 function validateActionConfiguration(action) {
   const seenParameterIds = /* @__PURE__ */ new Set();
@@ -2948,6 +2878,7 @@ function defineValueType(valueTypeDef) {
   const baseType = convertValueTypeTypeToBaseType(type.type);
   const vt = {
     apiName,
+    packageNamespace: namespace.substring(0, namespace.length - 1),
     displayMetadata: {
       displayName,
       description: description ?? ""