@osdk/maker 0.12.0-beta.8 → 0.12.0-rc.23

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, OntologyIrLogicRule, SectionId, ActionTypeStatus_deprecated, OntologyIrActionTypeEntities, OntologyIrFormContent, OntologyIrValidationRule, OntologyIrMarketplaceInterfaceType, StructFieldType, ApiNameValueTypeReference, Visibility, SharedPropertyTypeGothamMapping, InterfaceTypeStatus, OntologyIrObjectType, OntologyIrPropertyType, ValueTypeApiName, ValueTypeDisplayMetadata, ValueTypeStatus, ValueTypeVersion, BaseType, ValueTypeDataConstraint, ExampleValue, ValidationRuleDisplayMetadata, LinkTypeMetadata, OntologyIrLinkTypeStatus, DataConstraint, FailureMessage, OntologyIr, OntologyIrValueTypeBlockData } 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, 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';
 
 declare function main(args?: string[]): Promise<void>;
 
@@ -22,6 +22,25 @@ type ActionType = OntologyEntityBase & RequiredFields<Partial<ActionTypeInner>,
     __type: OntologyEntityTypeEnum.ACTION_TYPE;
 };
 type ActionTypeDefinition = Omit<ActionType, "__type">;
+type ActionTypeUserDefinition = {
+    objectType: ObjectTypeDefinition;
+    apiName?: string;
+    displayName?: string;
+    status?: ActionStatus;
+    parameterConfiguration?: Record<string, ActionParameterConfiguration>;
+    nonParameterMappings?: Record<string, MappingValue>;
+    actionLevelValidation?: ActionLevelValidationDefinition;
+    excludedProperties?: Array<ParameterId>;
+    sections?: Array<ActionSection>;
+    defaultFormat?: DisplayMetadataConfigurationDefaultLayout;
+    enableLayoutSwitch?: boolean;
+    displayAndFormat?: DisplayMetadataConfigurationDisplayAndFormat;
+    parameterOrdering?: Array<string>;
+    submissionMetadata?: SubmissionMetadata;
+    primaryKeyOption?: "autoGenerated" | "userInput";
+};
+declare const MODIFY_OBJECT_PARAMETER: string;
+declare const CREATE_OR_MODIFY_OBJECT_PARAMETER: string;
 interface ActionParameter {
     id: ParameterId;
     displayName: string;
@@ -29,19 +48,55 @@ interface ActionParameter {
     validation: ActionParameterValidation;
     description?: string;
     typeClasses?: Array<TypeClass>;
+    defaultValue?: OntologyIrParameterPrefill;
 }
-interface ActionParameterValidation {
-    allowedValues: ActionParameterAllowedValues;
-    required: ActionParameterRequirementConstraint;
+type ActionParameterValidation = Omit<ActionParameterConfiguration, "displayName" | "defaultValue">;
+interface ActionParameterConfiguration {
+    allowedValues?: ActionParameterAllowedValues;
+    required?: ActionParameterRequirementConstraint;
     defaultVisibility?: "editable" | "disabled" | "hidden";
     conditionalOverrides?: Array<ActionParameterConditionalOverride>;
+    defaultValue?: OntologyIrParameterPrefill;
+    displayName?: string;
+    description?: string;
+    customParameterType?: ActionParameterType;
 }
+type ActionSection = {
+    id: string;
+    displayName: string;
+    parameters: Array<string>;
+    defaultVisibility?: "visible" | "hidden";
+    description?: string;
+    columnCount?: 1 | 2;
+    showTitleBar?: boolean;
+    collapsedByDefault?: boolean;
+    style?: "box" | "minimal";
+    conditionalOverrides?: Array<SectionConditionalOverride>;
+};
+type SubmissionMetadata = {
+    submitButtonDisplayMetadata?: ButtonDisplayMetadata;
+    successMessage: string;
+    undoButtonConfiguration?: boolean;
+};
+type MappingValue = CustomMapping | UuidMappingValue | CurrentTimeMappingValue | CurrentUserMappingValue;
+type UuidMappingValue = {
+    type: "uuid";
+    linkId?: string;
+};
+type CurrentTimeMappingValue = {
+    type: "currentTime";
+};
+type CurrentUserMappingValue = {
+    type: "currentUser";
+};
+type CustomMapping = OntologyIrLogicRuleValue_parameterId | OntologyIrLogicRuleValue_staticValue | OntologyIrLogicRuleValue_objectParameterPropertyValue | OntologyIrLogicRuleValue_interfaceParameterPropertyValue | OntologyIrLogicRuleValue_synchronousWebhookOutput;
 type ConditionDefinition = UnionCondition | OntologyIrCondition | GroupValidationRule | ParameterValidationRule;
 type UnionCondition = {
     type: "and" | "or";
     conditions: Array<ConditionDefinition>;
 };
-type ActionParameterConditionalOverride = VisibilityOverride | DisabledOverride | RequiredOverride;
+type ActionParameterConditionalOverride = VisibilityOverride | DisabledOverride | RequiredOverride | DefaultValueOverride | ConstraintOverride;
+type SectionConditionalOverride = VisibilityOverride;
 type VisibilityOverride = {
     type: "visibility";
     condition: ConditionDefinition;
@@ -54,6 +109,16 @@ type RequiredOverride = {
     type: "required";
     condition: ConditionDefinition;
 };
+type DefaultValueOverride = {
+    type: "defaultValue";
+    condition: ConditionDefinition;
+    defaultValue: OntologyIrParameterPrefill;
+};
+type ConstraintOverride = {
+    type: "constraint";
+    condition: ConditionDefinition;
+    constraint: ActionParameterAllowedValues;
+};
 type ActionParameterRequirementConstraint = boolean | {
     listLength: {
         min?: number;
@@ -63,6 +128,7 @@ type ActionParameterRequirementConstraint = boolean | {
 type ActionParameterAllowedValues = {
     type: "oneOf";
     oneOf: Array<OntologyIrLabelledValue>;
+    otherValueAllowed?: boolean;
 } | {
     type: "range";
     min?: OntologyIrConditionValue;
@@ -118,12 +184,17 @@ interface ActionTypeInner {
     };
     parameters: Array<ActionParameter>;
     rules: Array<OntologyIrLogicRule>;
-    sections: Record<SectionId, Array<ParameterId>>;
+    sections: Record<SectionId, ActionSection>;
     status: ActionStatus;
     entities: OntologyIrActionTypeEntities;
+    parameterOrdering: Array<string>;
     formContentOrdering: Array<OntologyIrFormContent>;
     validation: Array<OntologyIrValidationRule>;
     typeClasses: Array<TypeClass>;
+    defaultFormat: DisplayMetadataConfigurationDefaultLayout;
+    enableLayoutSwitch: boolean;
+    displayAndFormat: DisplayMetadataConfigurationDisplayAndFormat;
+    submissionMetadata: SubmissionMetadata;
 }
 type ActionLevelValidationDefinition = {
     condition: ConditionDefinition;
@@ -222,7 +293,7 @@ interface PropertyType {
     array?: boolean;
     description?: string;
     displayName?: string;
-    valueType?: ApiNameValueTypeReference;
+    valueType?: ValueTypeApiNameReference;
     visibility?: Visibility;
     typeClasses?: TypeClass[];
     nullability?: Nullability;
@@ -289,7 +360,7 @@ interface OneToManyLinkTypeDefinition {
     redacted?: boolean;
 }
 interface OneToManyObjectLinkReference {
-    object: ObjectType;
+    object: ObjectTypeDefinition;
     metadata: LinkTypeMetadata;
 }
 interface OneToManyLinkTypeUserDefinition {
@@ -300,7 +371,7 @@ interface OneToManyLinkTypeUserDefinition {
     cardinality?: "OneToMany" | "OneToOne" | undefined;
 }
 interface OneToManyObjectLinkReferenceUserDefinition {
-    object: ObjectType;
+    object: ObjectTypeDefinition;
     metadata: LinkTypeMetadataUserDefinition;
 }
 interface ManyToManyLinkTypeDefinition {
@@ -312,7 +383,7 @@ interface ManyToManyLinkTypeDefinition {
     redacted?: boolean;
 }
 interface ManyToManyObjectLinkReference {
-    object: ObjectType;
+    object: ObjectTypeDefinition;
     metadata: LinkTypeMetadata;
 }
 interface ManyToManyLinkTypeUserDefinition {
@@ -321,7 +392,7 @@ interface ManyToManyLinkTypeUserDefinition {
     toMany: ManyToManyObjectLinkReferenceUserDefinition;
 }
 interface ManyToManyObjectLinkReferenceUserDefinition {
-    object: ObjectType;
+    object: ObjectTypeDefinition;
     metadata: LinkTypeMetadataUserDefinition;
 }
 interface LinkTypeMetadataUserDefinition {
@@ -529,15 +600,16 @@ interface ObjectTypeDatasourceDefinition_restrictedView {
     type: "restrictedView";
 }
 type ObjectTypeDatasourceDefinition = ObjectTypeDatasourceDefinition_stream | ObjectTypeDatasourceDefinition_dataset | ObjectTypeDatasourceDefinition_restrictedView;
-type ActionParameterTypePrimitive = "boolean" | "booleanList" | "integer" | "integerList" | "long" | "longList" | "double" | "doubleList" | "string" | "stringList" | "decimal" | "decimalList" | "timestamp" | "timestampList" | "geohash" | "geohashList" | "geoshape" | "geoshapeList" | "timeSeriesReference" | "date" | "dateList" | "objectTypeReference" | "objectReference" | "attachment" | "attachmentList" | "marking" | "markingList" | "mediaReference" | "mediaReferenceList" | "geotimeSeriesReference" | "geotimeSeriesReferenceList";
+type ActionParameterTypePrimitive = "boolean" | "booleanList" | "integer" | "integerList" | "long" | "longList" | "double" | "doubleList" | "string" | "stringList" | "decimal" | "decimalList" | "timestamp" | "timestampList" | "geohash" | "geohashList" | "geoshape" | "geoshapeList" | "timeSeriesReference" | "date" | "dateList" | "objectTypeReference" | "attachment" | "attachmentList" | "marking" | "markingList" | "mediaReference" | "mediaReferenceList" | "geotimeSeriesReference" | "geotimeSeriesReferenceList";
 type ActionParameterTypeComplex = OntologyIrBaseParameterType_decimal | OntologyIrBaseParameterType_decimalList | OntologyIrBaseParameterType_timestamp | OntologyIrBaseParameterType_timestampList | OntologyIrBaseParameterType_objectReference | OntologyIrBaseParameterType_objectReferenceList | OntologyIrBaseParameterType_objectSetRid | OntologyIrBaseParameterType_objectTypeReference | OntologyIrBaseParameterType_objectReference | OntologyIrBaseParameterType_interfaceReference | OntologyIrBaseParameterType_interfaceReferenceList | OntologyIrBaseParameterType_struct | OntologyIrBaseParameterType_structList;
 type ActionParameterType = ActionParameterTypePrimitive | ActionParameterTypeComplex;
 
-declare function defineCreateInterfaceObjectAction(interfaceType: InterfaceType, objectType?: ObjectType, validation?: ActionLevelValidationDefinition): ActionType;
-declare function defineCreateObjectAction(objectType: ObjectType, validation?: ActionLevelValidationDefinition): ActionType;
-declare function defineModifyInterfaceObjectAction(interfaceType: InterfaceType, objectType?: ObjectType, validation?: ActionLevelValidationDefinition): ActionType;
-declare function defineModifyObjectAction(objectType: ObjectType, validation?: ActionLevelValidationDefinition): ActionType;
-declare function defineDeleteObjectAction(objectType: ObjectType, validation?: ActionLevelValidationDefinition): ActionType;
+declare function defineCreateInterfaceObjectAction(interfaceType: InterfaceType, objectType?: ObjectTypeDefinition, validation?: ActionLevelValidationDefinition): ActionType;
+declare function defineCreateObjectAction(def: ActionTypeUserDefinition): ActionType;
+declare function defineModifyInterfaceObjectAction(interfaceType: InterfaceType, objectType?: ObjectTypeDefinition, validation?: ActionLevelValidationDefinition): ActionType;
+declare function defineModifyObjectAction(def: ActionTypeUserDefinition): ActionType;
+declare function defineDeleteObjectAction(def: ActionTypeUserDefinition): ActionType;
+declare function defineCreateOrModifyObjectAction(def: ActionTypeUserDefinition): ActionType;
 declare function defineAction(actionDef: ActionTypeDefinition): ActionType;
 
 /**
@@ -602,13 +674,17 @@ declare function defineInterfaceLinkConstraint(linkDef: One | Many): void;
 
 declare function defineLink(linkDefinition: LinkTypeDefinition): LinkType;
 
-declare function defineObject(objectDef: ObjectTypeDefinition): ObjectType;
+declare function defineObject(objectDef: ObjectTypeDefinition): ObjectTypeDefinition;
+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 dumpOntologyFullMetadata(): OntologyIr;
+declare function addNamespaceIfNone(apiName: string): string;
 
 interface SharedPropertyTypeDefinition {
     apiName: string;
@@ -616,7 +692,7 @@ interface SharedPropertyTypeDefinition {
     array?: boolean;
     description?: string;
     displayName?: string;
-    valueType?: ApiNameValueTypeReference;
+    valueType?: ValueTypeApiNameReference;
     visibility?: Visibility;
     typeClasses?: SharedPropertyType["typeClasses"];
     gothamMapping?: SharedPropertyTypeGothamMapping;
@@ -641,6 +717,8 @@ declare function defineValueType(valueTypeDef: ValueTypeDefinition): ValueTypeDe
 
 declare function importOntologyEntity<T extends OntologyEntityBase>(e: T): void;
 
+declare function convertType(type: PropertyTypeType): OntologyIrType;
+
 /**
  * Wraps an OntologyEntityType with a Proxy that calls importOntologyEntity when properties are accessed.
  *
@@ -649,4 +727,4 @@ declare function importOntologyEntity<T extends OntologyEntityBase>(e: T): void;
  */
 declare function wrapWithProxy<T extends OntologyEntityBase>(entity: T): T;
 
-export { type ActionType, type ConditionDefinition, type InterfaceType, type LinkType, type ObjectType, OntologyEntityTypeEnum, type SharedPropertyType, type ValueTypeDefinitionVersion, addDependency, main as default, defineAction, defineCreateInterfaceObjectAction, defineCreateObjectAction, defineDeleteObjectAction, defineInterface, defineInterfaceLinkConstraint, defineLink, defineModifyInterfaceObjectAction, defineModifyObjectAction, defineObject, defineOntology, defineSharedPropertyType, defineValueType, importOntologyEntity, importSharedPropertyType, wrapWithProxy };
+export { type ActionParameterAllowedValues, type ActionParameterConditionalOverride, type ActionParameterConfiguration, type ActionParameterValidation, type ActionSection, type ActionType, CREATE_OR_MODIFY_OBJECT_PARAMETER, type ConditionDefinition, type CurrentTimeMappingValue, type CurrentUserMappingValue, type CustomMapping, type InterfaceType, type LinkType, MODIFY_OBJECT_PARAMETER, type MappingValue, type ObjectPropertyType, type ObjectType, OntologyEntityTypeEnum, type PropertyTypeType, type SectionConditionalOverride, type SharedPropertyType, type SubmissionMetadata, type UuidMappingValue, type ValueTypeDefinitionVersion, addDependency, addNamespaceIfNone, convertToDisplayName, convertToPluralDisplayName, convertType, main as default, defineAction, defineCreateInterfaceObjectAction, defineCreateObjectAction, defineCreateOrModifyObjectAction, defineDeleteObjectAction, defineInterface, defineInterfaceLinkConstraint, defineLink, defineModifyInterfaceObjectAction, defineModifyObjectAction, defineObject, defineOntology, defineSharedPropertyType, defineValueType, dumpOntologyFullMetadata, importOntologyEntity, importSharedPropertyType, wrapWithProxy };