@osdk/maker 0.13.0-beta.1 → 0.13.0-beta.11

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>;
 
@@ -196,7 +196,8 @@ interface ActionTypeInner {
     displayAndFormat: DisplayMetadataConfigurationDisplayAndFormat;
     submissionMetadata: SubmissionMetadata;
 }
-type ActionLevelValidationDefinition = {
+type ActionLevelValidationDefinition = Array<ActionLevelValidationRule>;
+type ActionLevelValidationRule = {
     condition: ConditionDefinition;
     displayMetadata?: ValidationRuleDisplayMetadata;
 };
@@ -282,7 +283,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 +294,7 @@ interface PropertyType {
     array?: boolean;
     description?: string;
     displayName?: string;
-    valueType?: ValueTypeApiNameReference;
+    valueType?: OntologyIrValueTypeReferenceWithMetadata;
     visibility?: Visibility;
     typeClasses?: TypeClass[];
     nullability?: Nullability;
@@ -581,6 +582,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 +680,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 +690,7 @@ interface SharedPropertyTypeDefinition {
     array?: boolean;
     description?: string;
     displayName?: string;
-    valueType?: ValueTypeApiNameReference;
+    valueType?: OntologyIrValueTypeReferenceWithMetadata;
     visibility?: Visibility;
     typeClasses?: SharedPropertyType["typeClasses"];
     gothamMapping?: SharedPropertyTypeGothamMapping;

package/build/esm/api/defineAction.js

@@ -17,7 +17,7 @@
 import { consola } from "consola";
 import invariant from "tiny-invariant";
 import { convertToDisplayName, getAllInterfaceProperties } from "./defineObject.js";
-import { namespace, ontologyDefinition, updateOntology } from "./defineOntology.js";
+import { importedTypes, namespace, ontologyDefinition, updateOntology } from "./defineOntology.js";
 import { convertConditionDefinition, convertMappingValue } from "./ontologyUtils.js";
 import { CREATE_OR_MODIFY_OBJECT_PARAMETER, MODIFY_OBJECT_PARAMETER, OntologyEntityTypeEnum } from "./types.js";
 export function defineCreateInterfaceObjectAction(interfaceType, objectType, validation) {
@@ -86,7 +86,7 @@ export function defineCreateInterfaceObjectAction(interfaceType, objectType, val
       }
     }],
     ...(validation ? {
-      validation: [convertValidationRule(validation)]
+      validation: convertValidationRule(validation)
     } : {})
   });
 }
@@ -99,7 +99,7 @@ export 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,
@@ -128,7 +128,7 @@ export function defineCreateObjectAction(def) {
     }],
     parameterOrdering: def.parameterOrdering ?? createDefaultParameterOrdering(def, parameters),
     ...(def.actionLevelValidation ? {
-      validation: [convertValidationRule(def.actionLevelValidation)]
+      validation: convertValidationRule(def.actionLevelValidation)
     } : {}),
     ...(def.defaultFormat && {
       defaultFormat: def.defaultFormat
@@ -211,7 +211,7 @@ export function defineModifyInterfaceObjectAction(interfaceType, objectType, val
       }
     }],
     ...(validation ? {
-      validation: [convertValidationRule(validation)]
+      validation: convertValidationRule(validation)
     } : {})
   });
 }
@@ -228,7 +228,7 @@ export 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 === undefined) {
       p.defaultValue = {
@@ -268,7 +268,7 @@ export 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
@@ -321,7 +321,7 @@ export function defineDeleteObjectAction(def) {
       typeGroups: []
     },
     ...(def.actionLevelValidation ? {
-      validation: [convertValidationRule(def.actionLevelValidation)]
+      validation: convertValidationRule(def.actionLevelValidation)
     } : {})
   });
 }
@@ -338,7 +338,7 @@ export 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 === undefined) {
       p.defaultValue = {
@@ -378,7 +378,7 @@ export 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
@@ -419,6 +419,41 @@ export function defineAction(actionDef) {
     if (rule.type === "deleteObjectRule") {
       !parameterIds.some(id => id === rule.deleteObjectRule.objectToDelete) ? process.env.NODE_ENV !== "production" ? invariant(false, `Object to delete parameter must be defined in parameters`) : invariant(false) : void 0;
     }
+    if (rule.type === "modifyInterfaceRule") {
+      // all referenced SPTs exist globally
+      Object.keys(rule.modifyInterfaceRule.sharedPropertyValues).forEach(spt => {
+        !(ontologyDefinition.SHARED_PROPERTY_TYPE[spt] !== undefined || importedTypes.SHARED_PROPERTY_TYPE[spt] !== undefined) ? process.env.NODE_ENV !== "production" ? invariant(false, `Shared property type ${spt} does not exist.
+            If this SPT was imported, you may need to use [spt.apiName] as the key so that it is qualified with the right namespace`) : invariant(false) : void 0;
+      });
+
+      // The there must be a parameter for the interface, and the interface there must exist
+      const interfaceParam = actionDef.parameters.find(p => p.id === rule.modifyInterfaceRule.interfaceObjectToModifyParameter);
+      !(interfaceParam !== undefined && typeof interfaceParam.type === "object" && (interfaceParam.type.type === "interfaceReference" || interfaceParam.type.type === "interfaceReferenceList")) ? process.env.NODE_ENV !== "production" ? invariant(false, `Interface object to modify parameter must be an interface reference`) : invariant(false) : void 0;
+      const interfaceReference = interfaceParam.type.type === "interfaceReference" ? interfaceParam.type.interfaceReference.interfaceTypeRid : interfaceParam.type.interfaceReferenceList.interfaceTypeRid;
+      !(ontologyDefinition.INTERFACE_TYPE[interfaceReference] !== undefined || importedTypes.INTERFACE_TYPE[interfaceReference] !== undefined) ? process.env.NODE_ENV !== "production" ? invariant(false, `Interface type ${interfaceReference} does not exist`) : invariant(false) : void 0;
+
+      // All referenced SPTs must exist on the interface
+      const interfaceType = ontologyDefinition.INTERFACE_TYPE[interfaceReference];
+      Object.keys(rule.modifyInterfaceRule.sharedPropertyValues).forEach(spt => {
+        !(interfaceType.propertiesV2[spt] !== undefined) ? process.env.NODE_ENV !== "production" ? invariant(false, `Shared property type ${spt} does not exist in interface type ${interfaceReference}`) : invariant(false) : void 0;
+      });
+    }
+    if (rule.type === "addInterfaceRule") {
+      // All referenced SPTs must exist globally
+      Object.keys(rule.addInterfaceRule.sharedPropertyValues).forEach(spt => {
+        !(ontologyDefinition.SHARED_PROPERTY_TYPE[spt] !== undefined || importedTypes.SHARED_PROPERTY_TYPE[spt] !== undefined) ? process.env.NODE_ENV !== "production" ? invariant(false, `Shared property type ${spt} does not exist. 
+          If this SPT was imported, you may need to use [spt.apiName] as the key so that it is qualified with the right namespace`) : invariant(false) : void 0;
+      });
+
+      // The referenced interface must exist globally
+      const interfaceType = ontologyDefinition.INTERFACE_TYPE[rule.addInterfaceRule.interfaceApiName] ?? importedTypes.INTERFACE_TYPE[rule.addInterfaceRule.interfaceApiName];
+      !(interfaceType !== undefined) ? process.env.NODE_ENV !== "production" ? invariant(false, `Interface type ${rule.addInterfaceRule.interfaceApiName} does not exist`) : invariant(false) : void 0;
+
+      // All referenced SPTs must exist on the interface
+      Object.keys(rule.addInterfaceRule.sharedPropertyValues).forEach(spt => {
+        !(interfaceType.propertiesV2[spt] !== undefined) ? process.env.NODE_ENV !== "production" ? invariant(false, `Shared property type ${spt} does not exist in interface type ${interfaceType.apiName}`) : invariant(false) : void 0;
+      });
+    }
   });
   const fullAction = {
     ...actionDef,
@@ -435,7 +470,7 @@ export 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) {
@@ -497,13 +532,13 @@ function createParameters(def, parameterSet, defaultRequired) {
     validation: def.parameterConfiguration?.[id] !== undefined ? {
       ...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,
@@ -788,13 +823,15 @@ function sanitize(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 = new Set();