@osdk/maker 0.13.0-beta.12 → 0.13.0-beta.14

package/build/cjs/index.d.cts

@@ -378,9 +378,15 @@ type ActionTypeUserDefinition = {
     submissionMetadata?: SubmissionMetadata;
     primaryKeyOption?: "autoGenerated" | "userInput";
 };
-declare function defineCreateInterfaceObjectAction(interfaceType: InterfaceType, objectType?: ObjectTypeDefinition, validation?: ActionLevelValidationDefinition): ActionType;
+type InterfaceActionTypeUserDefinition = {
+    interfaceType: InterfaceType;
+    objectType?: ObjectTypeDefinition;
+    validation?: ActionLevelValidationDefinition;
+    excludedProperties?: Array<string>;
+};
+declare function defineCreateInterfaceObjectAction(def: InterfaceActionTypeUserDefinition): ActionType;
 declare function defineCreateObjectAction(def: ActionTypeUserDefinition): ActionType;
-declare function defineModifyInterfaceObjectAction(interfaceType: InterfaceType, objectType?: ObjectTypeDefinition, validation?: ActionLevelValidationDefinition): ActionType;
+declare function defineModifyInterfaceObjectAction(def: InterfaceActionTypeUserDefinition): ActionType;
 declare function defineModifyObjectAction(def: ActionTypeUserDefinition): ActionType;
 declare function defineDeleteObjectAction(def: ActionTypeUserDefinition): ActionType;
 declare function defineCreateOrModifyObjectAction(def: ActionTypeUserDefinition): ActionType;
@@ -440,11 +446,15 @@ type LinkType = (OntologyEntityBase & OneToManyLinkTypeDefinition & {
     __type: OntologyEntityTypeEnum.LINK_TYPE;
 }) | (OntologyEntityBase & ManyToManyLinkTypeDefinition & {
     __type: OntologyEntityTypeEnum.LINK_TYPE;
+}) | (OntologyEntityBase & IntermediaryLinkTypeDefinition & {
+    __type: OntologyEntityTypeEnum.LINK_TYPE;
 });
 type LinkTypeDefinition = Omit<OntologyEntityBase & OneToManyLinkTypeUserDefinition & {
     __type: OntologyEntityTypeEnum.LINK_TYPE;
 }, "__type"> | Omit<OntologyEntityBase & ManyToManyLinkTypeUserDefinition & {
     __type: OntologyEntityTypeEnum.LINK_TYPE;
+}, "__type"> | Omit<OntologyEntityBase & IntermediaryLinkTypeUserDefinition & {
+    __type: OntologyEntityTypeEnum.LINK_TYPE;
 }, "__type">;
 type ObjectTypePropertyApiName = string;
 interface OneToManyLinkTypeDefinition {
@@ -493,6 +503,31 @@ interface ManyToManyObjectLinkReferenceUserDefinition {
     object: ObjectTypeDefinition;
     metadata: LinkTypeMetadataUserDefinition;
 }
+interface IntermediaryLinkTypeDefinition {
+    apiName: string;
+    many: IntermediaryObjectLinkReference;
+    toMany: IntermediaryObjectLinkReference;
+    intermediaryObjectType: ObjectTypeDefinition;
+    editsEnabled?: boolean;
+    status?: OntologyIrLinkTypeStatus;
+    redacted?: boolean;
+}
+interface IntermediaryObjectLinkReference {
+    object: ObjectTypeDefinition;
+    metadata: LinkTypeMetadata;
+    linkToIntermediary: LinkType;
+}
+interface IntermediaryLinkTypeUserDefinition {
+    apiName: string;
+    many: IntermediaryObjectLinkReferenceUserDefinition;
+    toMany: IntermediaryObjectLinkReferenceUserDefinition;
+    intermediaryObjectType: ObjectTypeDefinition;
+}
+interface IntermediaryObjectLinkReferenceUserDefinition {
+    object: ObjectTypeDefinition;
+    metadata: LinkTypeMetadataUserDefinition;
+    linkToIntermediary: LinkType;
+}
 interface LinkTypeMetadataUserDefinition {
     apiName: string;
     displayName?: string;
@@ -528,7 +563,7 @@ interface ObjectTypeInner extends Omit<OntologyIrObjectType, "titlePropertyTypeR
     status?: ObjectTypeStatus;
 }
 
-declare function defineOntology(ns: string, body: () => void | Promise<void>, outputDir: string | undefined, dependencyFile?: string): Promise<OntologyIr>;
+declare function defineOntology(ns: string, body: () => void | Promise<void>, outputDir: string | undefined, dependencyFile?: string, uniquenessKey?: string): Promise<OntologyIr>;
 declare function dumpOntologyFullMetadata(): OntologyIr;
 declare function addNamespaceIfNone(apiName: string): string;
 

package/build/esm/api/defineAction.js

@@ -26,36 +26,36 @@ import { getFlattenedInterfaceProperties } from "./interface/getFlattenedInterfa
 import { isStruct } from "./properties/PropertyTypeType.js";
 export const MODIFY_OBJECT_PARAMETER = "objectToModifyParameter";
 export const CREATE_OR_MODIFY_OBJECT_PARAMETER = "objectToCreateOrModifyParameter";
-export function defineCreateInterfaceObjectAction(interfaceType, objectType, validation) {
-  const allProperties = Object.entries(getFlattenedInterfaceProperties(interfaceType)).filter(([_, prop]) => !isStruct(prop.sharedPropertyType.type));
-  if (allProperties.length !== Object.entries(getFlattenedInterfaceProperties(interfaceType)).length) {
-    consola.info(`Some properties on ${interfaceType.apiName} were skipped in the create action because they are structs`);
+export function defineCreateInterfaceObjectAction(def) {
+  const allProperties = Object.entries(getFlattenedInterfaceProperties(def.interfaceType)).filter(([_, prop]) => !isStruct(prop.sharedPropertyType.type) && !(def.excludedProperties ?? []).includes(prop.sharedPropertyType.nonNameSpacedApiName));
+  if (allProperties.length !== Object.entries(getFlattenedInterfaceProperties(def.interfaceType)).length) {
+    consola.info(`Some properties on ${def.interfaceType.apiName} were skipped in the create action because they are structs`);
   }
   return defineAction({
-    apiName: `create-${kebab(interfaceType.apiName.split(".").pop() ?? interfaceType.apiName)}${objectType === undefined ? "" : `-${kebab(objectType.apiName.split(".").pop() ?? objectType.apiName)}`}`,
-    displayName: `Create ${interfaceType.displayMetadata.displayName}`,
+    apiName: `create-${kebab(def.interfaceType.apiName.split(".").pop() ?? def.interfaceType.apiName)}${def.objectType === undefined ? "" : `-${kebab(def.objectType.apiName.split(".").pop() ?? def.objectType.apiName)}`}`,
+    displayName: `Create ${def.interfaceType.displayMetadata.displayName}`,
     parameters: [{
       id: "objectTypeParameter",
       displayName: "Object type to create",
       type: {
         type: "objectTypeReference",
         objectTypeReference: {
-          interfaceTypeRids: [interfaceType.apiName]
+          interfaceTypeRids: [def.interfaceType.apiName]
         }
       },
       validation: {
         required: true,
-        allowedValues: objectType === undefined ? {
+        allowedValues: def.objectType === undefined ? {
           type: "objectTypeReference",
-          interfaceTypes: [interfaceType.apiName]
+          interfaceTypes: [def.interfaceType.apiName]
         } : {
           type: "oneOf",
           oneOf: [{
-            label: objectType.displayName,
+            label: def.objectType.displayName,
             value: {
               type: "objectType",
               objectType: {
-                objectTypeId: objectType.apiName
+                objectTypeId: def.objectType.apiName
               }
             }
           }]
@@ -73,9 +73,9 @@ export function defineCreateInterfaceObjectAction(interfaceType, objectType, val
         allowedValues: extractAllowedValuesFromPropertyType(prop.sharedPropertyType.type)
       }
     }))],
-    status: interfaceType.status.type !== "deprecated" ? interfaceType.status.type : interfaceType.status,
+    status: def.interfaceType.status.type !== "deprecated" ? def.interfaceType.status.type : def.interfaceType.status,
     entities: {
-      affectedInterfaceTypes: [interfaceType.apiName],
+      affectedInterfaceTypes: [def.interfaceType.apiName],
       affectedObjectTypes: [],
       affectedLinkTypes: [],
       typeGroups: []
@@ -83,7 +83,7 @@ export function defineCreateInterfaceObjectAction(interfaceType, objectType, val
     rules: [{
       type: "addInterfaceRule",
       addInterfaceRule: {
-        interfaceApiName: interfaceType.apiName,
+        interfaceApiName: def.interfaceType.apiName,
         objectTypeParameter: "objectTypeParameter",
         sharedPropertyValues: Object.fromEntries(allProperties.map(([id, _prop]) => [id, {
           type: "parameterId",
@@ -91,8 +91,8 @@ export function defineCreateInterfaceObjectAction(interfaceType, objectType, val
         }]))
       }
     }],
-    ...(validation ? {
-      validation: convertValidationRule(validation)
+    ...(def.validation ? {
+      validation: convertValidationRule(def.validation)
     } : {})
   });
 }
@@ -153,35 +153,35 @@ export function defineCreateObjectAction(def) {
     })
   });
 }
-export function defineModifyInterfaceObjectAction(interfaceType, objectType, validation) {
-  const allProperties = Object.entries(getFlattenedInterfaceProperties(interfaceType)).filter(([_, prop]) => !isStruct(prop.sharedPropertyType.type));
-  if (allProperties.length !== Object.entries(getFlattenedInterfaceProperties(interfaceType)).length) {
-    consola.info(`Some properties on ${interfaceType.apiName} were skipped in the modify action because they are structs`);
+export function defineModifyInterfaceObjectAction(def) {
+  const allProperties = Object.entries(getFlattenedInterfaceProperties(def.interfaceType)).filter(([_, prop]) => !isStruct(prop.sharedPropertyType.type) && !(def.excludedProperties ?? []).includes(prop.sharedPropertyType.nonNameSpacedApiName));
+  if (allProperties.length !== Object.entries(getFlattenedInterfaceProperties(def.interfaceType)).length) {
+    consola.info(`Some properties on ${def.interfaceType.apiName} were skipped in the modify action because they are structs`);
   }
   return defineAction({
-    apiName: `modify-${kebab(interfaceType.apiName.split(".").pop() ?? interfaceType.apiName)}${objectType === undefined ? "" : `-${kebab(objectType.apiName.split(".").pop() ?? objectType.apiName)}`}`,
-    displayName: `Modify ${interfaceType.displayMetadata.displayName}`,
+    apiName: `modify-${kebab(def.interfaceType.apiName.split(".").pop() ?? def.interfaceType.apiName)}${def.objectType === undefined ? "" : `-${kebab(def.objectType.apiName.split(".").pop() ?? def.objectType.apiName)}`}`,
+    displayName: `Modify ${def.interfaceType.displayMetadata.displayName}`,
     parameters: [{
       id: "interfaceObjectToModifyParameter",
       displayName: "Object type to modify",
       type: {
         type: "interfaceReference",
         interfaceReference: {
-          interfaceTypeRid: interfaceType.apiName
+          interfaceTypeRid: def.interfaceType.apiName
         }
       },
       validation: {
         required: true,
-        allowedValues: objectType === undefined ? {
+        allowedValues: def.objectType === undefined ? {
           type: "interfaceObjectQuery"
         } : {
           type: "oneOf",
           oneOf: [{
-            label: objectType.displayName,
+            label: def.objectType.displayName,
             value: {
               type: "objectType",
               objectType: {
-                objectTypeId: objectType.apiName
+                objectTypeId: def.objectType.apiName
               }
             }
           }]
@@ -199,9 +199,9 @@ export function defineModifyInterfaceObjectAction(interfaceType, objectType, val
         allowedValues: extractAllowedValuesFromPropertyType(prop.sharedPropertyType.type)
       }
     }))],
-    status: interfaceType.status.type !== "deprecated" ? interfaceType.status.type : interfaceType.status,
+    status: def.interfaceType.status.type !== "deprecated" ? def.interfaceType.status.type : def.interfaceType.status,
     entities: {
-      affectedInterfaceTypes: [interfaceType.apiName],
+      affectedInterfaceTypes: [def.interfaceType.apiName],
       affectedObjectTypes: [],
       affectedLinkTypes: [],
       typeGroups: []
@@ -216,8 +216,8 @@ export function defineModifyInterfaceObjectAction(interfaceType, objectType, val
         }]))
       }
     }],
-    ...(validation ? {
-      validation: convertValidationRule(validation)
+    ...(def.validation ? {
+      validation: convertValidationRule(def.validation)
     } : {})
   });
 }