@osdk/maker 0.13.0-beta.4 → 0.13.0-beta.5

package/build/cjs/index.d.cts

@@ -1,4 +1,4 @@
-import { ActionTypeApiName, ParameterId, OntologyIrBaseParameterType_decimal, OntologyIrBaseParameterType_decimalList, OntologyIrBaseParameterType_timestamp, OntologyIrBaseParameterType_timestampList, OntologyIrBaseParameterType_objectReference, OntologyIrBaseParameterType_objectReferenceList, OntologyIrBaseParameterType_objectSetRid, OntologyIrBaseParameterType_objectTypeReference, OntologyIrBaseParameterType_interfaceReference, OntologyIrBaseParameterType_interfaceReferenceList, OntologyIrBaseParameterType_struct, OntologyIrBaseParameterType_structList, OntologyIrLabelledValue, OntologyIrConditionValue, OntologyIrParameterDateRangeValue, InterfaceTypeApiName, OntologyIrCondition, OntologyIrParameterPrefill, OntologyIrLogicRule, SectionId, ActionTypeStatus_deprecated, OntologyIrActionTypeEntities, OntologyIrFormContent, OntologyIrValidationRule, DisplayMetadataConfigurationDefaultLayout, DisplayMetadataConfigurationDisplayAndFormat, ButtonDisplayMetadata, OntologyIrMarketplaceInterfaceType, StructFieldType, ValueTypeApiNameReference, Visibility, SharedPropertyTypeGothamMapping, InterfaceTypeStatus, OntologyIrPropertyType, ValueTypeApiName, ValueTypeDisplayMetadata, ValueTypeStatus, ValueTypeVersion, BaseType, ValueTypeDataConstraint, ExampleValue, ValidationRuleDisplayMetadata, OntologyIrLogicRuleValue_parameterId, OntologyIrLogicRuleValue_staticValue, OntologyIrLogicRuleValue_objectParameterPropertyValue, OntologyIrLogicRuleValue_interfaceParameterPropertyValue, OntologyIrLogicRuleValue_synchronousWebhookOutput, LinkTypeMetadata, OntologyIrLinkTypeStatus, DataConstraint, FailureMessage, OntologyIrObjectType, OntologyIr, OntologyIrValueTypeBlockData, OntologyIrType } from '@osdk/client.unstable';
+import { ActionTypeApiName, ParameterId, OntologyIrBaseParameterType_decimal, OntologyIrBaseParameterType_decimalList, OntologyIrBaseParameterType_timestamp, OntologyIrBaseParameterType_timestampList, OntologyIrBaseParameterType_objectReference, OntologyIrBaseParameterType_objectReferenceList, OntologyIrBaseParameterType_objectSetRid, OntologyIrBaseParameterType_objectTypeReference, OntologyIrBaseParameterType_interfaceReference, OntologyIrBaseParameterType_interfaceReferenceList, OntologyIrBaseParameterType_struct, OntologyIrBaseParameterType_structList, OntologyIrLabelledValue, OntologyIrConditionValue, OntologyIrParameterDateRangeValue, InterfaceTypeApiName, OntologyIrCondition, OntologyIrParameterPrefill, OntologyIrLogicRule, SectionId, ActionTypeStatus_deprecated, OntologyIrActionTypeEntities, OntologyIrFormContent, OntologyIrValidationRule, DisplayMetadataConfigurationDefaultLayout, DisplayMetadataConfigurationDisplayAndFormat, ButtonDisplayMetadata, OntologyIrMarketplaceInterfaceType, StructFieldType, OntologyIrValueTypeReferenceWithMetadata, Visibility, SharedPropertyTypeGothamMapping, InterfaceTypeStatus, OntologyIrPropertyType, ValueTypeApiName, ValueTypeDisplayMetadata, ValueTypeStatus, ValueTypeVersion, BaseType, ValueTypeDataConstraint, ExampleValue, ValidationRuleDisplayMetadata, OntologyIrLogicRuleValue_parameterId, OntologyIrLogicRuleValue_staticValue, OntologyIrLogicRuleValue_objectParameterPropertyValue, OntologyIrLogicRuleValue_interfaceParameterPropertyValue, OntologyIrLogicRuleValue_synchronousWebhookOutput, LinkTypeMetadata, OntologyIrLinkTypeStatus, DataConstraint, FailureMessage, OntologyIrObjectType, OntologyIr, OntologyIrType } from '@osdk/client.unstable';
 
 declare function main(args?: string[]): Promise<void>;
 
@@ -282,7 +282,7 @@ interface InterfacePropertyType {
     sharedPropertyType: SharedPropertyType;
     required: boolean;
 }
-interface InterfaceType extends OntologyEntityBase, Omit<OntologyIrMarketplaceInterfaceType, "properties" | "allProperties" | "allLinks" | "extendsInterfaces" | "allExtendsInterfaces" | "propertiesV2" | "allPropertiesV2" | "propertiesV3" | "allPropertiesV3"> {
+interface InterfaceType extends OntologyEntityBase, Omit<OntologyIrMarketplaceInterfaceType, "properties" | "propertiesV2" | "propertiesV3" | "extendsInterfaces"> {
     propertiesV2: Record<string, InterfacePropertyType>;
     extendsInterfaces: Array<InterfaceType>;
     status: InterfaceTypeStatus;
@@ -293,7 +293,7 @@ interface PropertyType {
     array?: boolean;
     description?: string;
     displayName?: string;
-    valueType?: ValueTypeApiNameReference;
+    valueType?: OntologyIrValueTypeReferenceWithMetadata;
     visibility?: Visibility;
     typeClasses?: TypeClass[];
     nullability?: Nullability;
@@ -581,6 +581,7 @@ interface ValueTypeType_timestamp {
 type ValueTypeType = ValueTypeType_array | ValueTypeType_boolean | ValueTypeType_binary | ValueTypeType_byte | ValueTypeType_date | ValueTypeType_decimal | ValueTypeType_double | ValueTypeType_float | ValueTypeType_integer | ValueTypeType_long | ValueTypeType_map | ValueTypeType_optional | ValueTypeType_short | ValueTypeType_string | ValueTypeType_structV2 | ValueTypeType_timestamp;
 type ValueTypeDefinitionVersion = OntologyEntityBase & {
     apiName: ValueTypeApiName;
+    packageNamespace: string;
     displayMetadata: ValueTypeDisplayMetadata;
     status: ValueTypeStatus;
     version: ValueTypeVersion;
@@ -678,11 +679,7 @@ declare function defineObject(objectDef: ObjectTypeDefinition): ObjectTypeDefini
 declare function convertToDisplayName(s: string | undefined | null): string;
 declare function convertToPluralDisplayName(s: string | undefined | null): string;
 
-type OntologyAndValueTypeIrs = {
-    ontology: OntologyIr;
-    valueType: OntologyIrValueTypeBlockData;
-};
-declare function defineOntology(ns: string, body: () => void | Promise<void>, outputDir: string | undefined, dependencyFile?: string): Promise<OntologyAndValueTypeIrs>;
+declare function defineOntology(ns: string, body: () => void | Promise<void>, outputDir: string | undefined, dependencyFile?: string): Promise<OntologyIr>;
 declare function dumpOntologyFullMetadata(): OntologyIr;
 declare function addNamespaceIfNone(apiName: string): string;
 
@@ -692,7 +689,7 @@ interface SharedPropertyTypeDefinition {
     array?: boolean;
     description?: string;
     displayName?: string;
-    valueType?: ValueTypeApiNameReference;
+    valueType?: OntologyIrValueTypeReferenceWithMetadata;
     visibility?: Visibility;
     typeClasses?: SharedPropertyType["typeClasses"];
     gothamMapping?: SharedPropertyTypeGothamMapping;

package/build/esm/api/defineOntology.js

@@ -79,10 +79,7 @@ export async function defineOntology(ns, body, outputDir, dependencyFile) {
   if (dependencyFile) {
     writeDependencyFile(dependencyFile);
   }
-  return {
-    ontology: convertToWireOntologyIr(ontologyDefinition),
-    valueType: convertOntologyToValueTypeIr(ontologyDefinition)
-  };
+  return convertToWireOntologyIr(ontologyDefinition);
 }
 export function writeStaticObjects(outputDir) {
   const codegenDir = path.resolve(outputDir, "codegen");
@@ -148,111 +145,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(importedTypes) {
-  const asBlockData = convertToWireBlockData(importedTypes); // this just makes things easier to work with
+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 === undefined ? undefined : {
-        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) {
@@ -622,11 +540,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: {}
   };
 }
 export function dumpOntologyFullMetadata() {
@@ -672,7 +594,9 @@ function convertSpt({
     typeClasses: typeClasses ?? [],
     valueType: valueType === undefined ? undefined : {
       apiName: valueType.apiName,
-      version: valueType.version
+      version: valueType.version,
+      packageNamespace: valueType.packageNamespace,
+      displayMetadata: valueType.displayMetadata
     }
   };
 }