@osdk/maker 0.12.0-beta.8 → 0.12.0-beta.9

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @osdk/maker
 
+## 0.12.0-beta.9
+
+### Minor Changes
+
+- ac0029e: Improve CRUD actions customization
+
+### Patch Changes
+
+- @osdk/api@2.4.0-beta.7
+
 ## 0.12.0-beta.8
 
 ### Minor Changes

package/README.md

@@ -567,72 +567,15 @@ const personToAddressLink = defineInterfaceLinkConstraint({
 
 Actions define operations that can be performed on objects and interfaces.
 
-### Custom Action
-
-```typescript
-import { defineAction } from "@osdk/maker";
-
-// Define a custom action
-const markAsInactiveAction = defineAction({
-  apiName: "mark-as-inactive",
-  displayName: "Mark as Inactive",
-  parameters: [
-    {
-      id: "reason",
-      displayName: "Reason",
-      type: "string",
-      validation: {
-        required: true,
-        allowedValues: { type: "text" },
-      },
-    },
-    {
-      id: "effectiveDate",
-      displayName: "Effective Date",
-      type: "date",
-      validation: {
-        required: true,
-        allowedValues: { type: "datetime" },
-      },
-    },
-  ],
-  status: "active",
-  rules: [
-    {
-      type: "addOrModifyObjectRuleV2",
-      addOrModifyObjectRuleV2: {
-        objectToModify: "objectToModifyParameter",
-        propertyValues: {
-          "isActive": {
-            type: "staticValue",
-            staticValue: {
-              type: "boolean",
-              boolean: false,
-            },
-          },
-          "inactiveReason": {
-            type: "parameterId",
-            parameterId: "reason",
-          },
-          "inactiveDate": {
-            type: "parameterId",
-            parameterId: "effectiveDate",
-          },
-        },
-        structFieldValues: {},
-      },
-    },
-  ],
-});
-```
-
 ### Create Object Action
 
 ```typescript
 import { defineCreateObjectAction } from "@osdk/maker";
 
 // Define an action to create an employee
-const createEmployeeAction = defineCreateObjectAction(employeeObject);
+const createEmployeeAction = defineCreateObjectAction({
+  objectType: employeeObject,
+});
 ```
 
 ### Modify Object Action
@@ -641,7 +584,9 @@ const createEmployeeAction = defineCreateObjectAction(employeeObject);
 import { defineModifyObjectAction } from "@osdk/maker";
 
 // Define an action to modify an employee
-const modifyEmployeeAction = defineModifyObjectAction(employeeObject);
+const modifyEmployeeAction = defineModifyObjectAction({
+  objectType: employeeObject,
+});
 ```
 
 ### Delete Object Action
@@ -650,7 +595,9 @@ const modifyEmployeeAction = defineModifyObjectAction(employeeObject);
 import { defineDeleteObjectAction } from "@osdk/maker";
 
 // Define an action to delete an employee
-const deleteEmployeeAction = defineDeleteObjectAction(employeeObject);
+const deleteEmployeeAction = defineDeleteObjectAction({
+  objectType: employeeObject,
+});
 ```
 
 ### Interface Actions
@@ -673,3 +620,82 @@ const createEmployeePersonAction = defineCreateInterfaceObjectAction(
 // Define an action to modify objects implementing an interface
 const modifyPersonAction = defineModifyInterfaceObjectAction(personInterface);
 ```
+
+### Custom Action
+
+More customization such as security/submission criteria, constraints on parameter values, parameter overrides, etc.
+can also be added.
+
+```typescript
+import {
+  ActionParameterConditionalOverride,
+  ConditionDefinition,
+  defineModifyObjectAction,
+  defineObject,
+} from "@osdk/maker";
+
+const employeeObject = defineObject({
+  apiName: "employee",
+  displayName: "Employee",
+  pluralDisplayName: "Employees",
+  titlePropertyApiName: "id",
+  primaryKeyPropertyApiName: "id",
+  properties: {
+    "id": { type: "string", displayName: "ID" },
+    "team": { type: "string" },
+    "numDeals": { type: "integer" },
+    "experience": { type: "integer" },
+  },
+});
+
+const mustBeManagerCondition: ConditionDefinition = {
+  type: "group",
+  name: "managerGroup", // Actual group assigned during installation
+};
+
+const mustBeInTeamCondition: ConditionDefinition = {
+  type: "group",
+  name: "teamGroup",
+};
+
+const teamEqualsSalesParameterCondition: ConditionDefinition = {
+  type: "parameter",
+  parameterId: "team",
+  matches: {
+    type: "staticValue",
+    staticValue: {
+      type: "string",
+      string: "sales",
+    },
+  },
+};
+
+const makeDealsVisible: ActionParameterConditionalOverride = {
+  type: "visibility",
+  condition: {
+    type: "and",
+    conditions: [
+      mustBeInTeamCondition,
+      teamEqualsSalesParameterCondition,
+    ],
+  },
+};
+
+const modifyObjectActionType = defineModifyObjectAction(
+  {
+    objectType: employeeObject,
+    actionLevelValidation: {
+      condition: mustBeManagerCondition,
+    },
+    parameterLevelValidations: {
+      "numDeals": {
+        defaultVisibility: "hidden",
+        conditionalOverrides: [
+          makeDealsVisible,
+        ],
+      },
+    },
+    excludedProperties: ["experience"],
+  },
+);
+```

package/build/browser/api/defineAction.js

@@ -16,7 +16,7 @@
 
 import { consola } from "consola";
 import invariant from "tiny-invariant";
-import { getAllInterfaceProperties } from "./defineObject.js";
+import { convertToDisplayName, getAllInterfaceProperties } from "./defineObject.js";
 import { namespace, ontologyDefinition, updateOntology } from "./defineOntology.js";
 import { convertConditionDefinition } from "./ontologyUtils.js";
 import { OntologyEntityTypeEnum } from "./types.js";
@@ -90,48 +90,55 @@ export function defineCreateInterfaceObjectAction(interfaceType, objectType, val
     } : {})
   });
 }
-export function defineCreateObjectAction(objectType, validation) {
-  const filteredProperties = objectType.properties?.filter(prop => !isStruct(prop.type)) ?? [];
-  if (filteredProperties.length !== (objectType.properties?.length ?? 0)) {
-    consola.info(`Some properties on ${objectType.apiName} were skipped in the create action because they are structs`);
-  }
+export function defineCreateObjectAction(def) {
+  Object.keys(def.parameterLevelValidations ?? {}).forEach(id => {
+    !(def.objectType.properties?.[id] !== undefined) ? process.env.NODE_ENV !== "production" ? invariant(false, `Property ${id} does not exist on ${def.objectType.apiName}`) : invariant(false) : void 0;
+  });
+  (def.excludedProperties ?? []).forEach(id => {
+    !(def.objectType.properties?.[id] !== undefined) ? process.env.NODE_ENV !== "production" ? invariant(false, `Property ${id} does not exist on ${def.objectType.apiName}`) : invariant(false) : void 0;
+  });
+  const parameterNames = Object.keys(def.objectType.properties ?? {}).filter(id => !def.excludedProperties?.includes(id) && !isStruct(def.objectType.properties?.[id].type));
+  const parameters = Array.from(parameterNames).map(id => ({
+    id,
+    displayName: def.objectType.properties?.[id].displayName ?? convertToDisplayName(id),
+    type: extractActionParameterType(def.objectType.properties?.[id]),
+    validation: def.parameterLevelValidations?.[id] !== undefined ? {
+      ...def.parameterLevelValidations?.[id],
+      allowedValues: def.parameterLevelValidations?.[id].allowedValues ?? extractAllowedValuesFromType(def.objectType.properties?.[id].type),
+      required: def.parameterLevelValidations?.[id].required ?? true
+    } : {
+      required: def.objectType.properties?.[id].array ?? false ? {
+        listLength: def.objectType.properties?.[id].nullability?.noEmptyCollections ? {
+          min: 1
+        } : {}
+      } : def.objectType.properties?.[id].nullability?.noNulls ?? true,
+      allowedValues: extractAllowedValuesFromType(def.objectType.properties?.[id].type)
+    }
+  }));
   return defineAction({
-    apiName: `create-object-${kebab(objectType.apiName.split(".").pop() ?? objectType.apiName)}`,
-    displayName: `Create ${objectType.displayName}`,
-    parameters: [...filteredProperties.map(prop => ({
-      id: prop.apiName,
-      displayName: prop.displayName,
-      type: extractActionParameterType(prop),
-      typeClasses: prop.typeClasses ?? [],
-      validation: {
-        required: prop.array ?? false ? {
-          listLength: prop.nullability?.noEmptyCollections ? {
-            min: 1
-          } : {}
-        } : prop.nullability?.noNulls ?? true,
-        allowedValues: extractAllowedValuesFromType(prop.type)
-      }
-    }))],
-    status: "active",
+    apiName: def.apiName ?? `create-object-${kebab(def.objectType.apiName.split(".").pop() ?? def.objectType.apiName)}`,
+    displayName: def.displayName ?? `Create ${def.objectType.displayName}`,
+    parameters: parameters,
+    status: def.status ?? "active",
     entities: {
       affectedInterfaceTypes: [],
-      affectedObjectTypes: [objectType.apiName],
+      affectedObjectTypes: [def.objectType.apiName],
       affectedLinkTypes: [],
       typeGroups: []
     },
     rules: [{
       type: "addObjectRule",
       addObjectRule: {
-        objectTypeId: objectType.apiName,
-        propertyValues: filteredProperties.length > 0 ? Object.fromEntries(filteredProperties.map(p => [p.apiName, {
+        objectTypeId: def.objectType.apiName,
+        propertyValues: Object.fromEntries(parameters.map(p => [p.id, {
           type: "parameterId",
-          parameterId: p.apiName
-        }])) : {},
+          parameterId: p.id
+        }])),
         structFieldValues: {}
       }
     }],
-    ...(validation ? {
-      validation: [convertValidationRule(validation)]
+    ...(def.actionLevelValidation ? {
+      validation: [convertValidationRule(def.actionLevelValidation)]
     } : {})
   });
 }
@@ -203,22 +210,41 @@ export function defineModifyInterfaceObjectAction(interfaceType, objectType, val
     } : {})
   });
 }
-export function defineModifyObjectAction(objectType, validation) {
-  const properties = objectType.properties ?? [];
-  const filteredProperties = properties.filter(prop => !isStruct(prop.type) && prop.apiName !== objectType.primaryKeyPropertyApiName);
-  if (filteredProperties.length < properties.length) {
-    consola.warn(`Some properties on ${objectType.apiName} were skipped in the modify action because they were structs, or were the object's primary key which cannot be edited.`);
-  }
+export function defineModifyObjectAction(def) {
+  Object.keys(def.parameterLevelValidations ?? {}).forEach(id => {
+    !(def.objectType.properties?.[id] !== undefined) ? process.env.NODE_ENV !== "production" ? invariant(false, `Property ${id} does not exist on ${def.objectType.apiName}`) : invariant(false) : void 0;
+  });
+  (def.excludedProperties ?? []).forEach(id => {
+    !(def.objectType.properties?.[id] !== undefined) ? process.env.NODE_ENV !== "production" ? invariant(false, `Property ${id} does not exist on ${def.objectType.apiName}`) : invariant(false) : void 0;
+  });
+  const parameterNames = Object.keys(def.objectType.properties ?? {}).filter(id => !def.excludedProperties?.includes(id) && !isStruct(def.objectType.properties?.[id].type) && id !== def.objectType.primaryKeyPropertyApiName);
+  const parameters = Array.from(parameterNames).map(id => ({
+    id,
+    displayName: def.objectType.properties?.[id].displayName ?? convertToDisplayName(id),
+    type: extractActionParameterType(def.objectType.properties?.[id]),
+    validation: def.parameterLevelValidations?.[id] !== undefined ? {
+      ...def.parameterLevelValidations?.[id],
+      allowedValues: def.parameterLevelValidations?.[id].allowedValues ?? extractAllowedValuesFromType(def.objectType.properties?.[id].type),
+      required: def.parameterLevelValidations?.[id].required ?? false
+    } : {
+      required: def.objectType.properties?.[id].array ?? false ? {
+        listLength: def.objectType.properties?.[id].nullability?.noEmptyCollections ? {
+          min: 1
+        } : {}
+      } : def.objectType.properties?.[id].nullability?.noNulls ?? false,
+      allowedValues: extractAllowedValuesFromType(def.objectType.properties?.[id].type)
+    }
+  }));
   return defineAction({
-    apiName: `modify-object-${kebab(objectType.apiName.split(".").pop() ?? objectType.apiName)}`,
-    displayName: `Modify ${objectType.displayName}`,
+    apiName: def.apiName ?? `modify-object-${kebab(def.objectType.apiName.split(".").pop() ?? def.objectType.apiName)}`,
+    displayName: def.displayName ?? `Modify ${def.objectType.displayName}`,
     parameters: [{
       id: "objectToModifyParameter",
       displayName: "Modify object",
       type: {
         type: "objectReference",
         objectReference: {
-          objectTypeId: objectType.apiName
+          objectTypeId: def.objectType.apiName
         }
       },
       validation: {
@@ -227,54 +253,41 @@ export function defineModifyObjectAction(objectType, validation) {
         },
         required: true
       }
-    }, ...filteredProperties.map(prop => ({
-      id: prop.apiName,
-      displayName: prop.displayName,
-      type: extractActionParameterType(prop),
-      typeClasses: prop.typeClasses ?? [],
-      validation: {
-        required: prop.array ?? false ? {
-          listLength: prop.nullability?.noEmptyCollections ? {
-            min: 1
-          } : {}
-        } : prop.nullability?.noNulls ?? false,
-        allowedValues: extractAllowedValuesFromType(prop.type)
-      }
-    }))],
-    status: "active",
-    entities: {
-      affectedInterfaceTypes: [],
-      affectedObjectTypes: [objectType.apiName],
-      affectedLinkTypes: [],
-      typeGroups: []
-    },
+    }, ...parameters],
+    status: def.status ?? "active",
     rules: [{
       type: "modifyObjectRule",
       modifyObjectRule: {
         objectToModify: "objectToModifyParameter",
-        propertyValues: filteredProperties.length > 0 ? Object.fromEntries(filteredProperties.map(p => [p.apiName, {
+        propertyValues: Object.fromEntries(parameters.map(p => [p.id, {
           type: "parameterId",
-          parameterId: p.apiName
-        }])) : {},
+          parameterId: p.id
+        }])),
         structFieldValues: {}
       }
     }],
-    ...(validation ? {
-      validation: [convertValidationRule(validation)]
+    entities: {
+      affectedInterfaceTypes: [],
+      affectedObjectTypes: [def.objectType.apiName],
+      affectedLinkTypes: [],
+      typeGroups: []
+    },
+    ...(def.actionLevelValidation ? {
+      validation: [convertValidationRule(def.actionLevelValidation)]
     } : {})
   });
 }
-export function defineDeleteObjectAction(objectType, validation) {
+export function defineDeleteObjectAction(def) {
   return defineAction({
-    apiName: `delete-object-${kebab(objectType.apiName.split(".").pop() ?? objectType.apiName)}`,
-    displayName: `Delete ${objectType.displayName}`,
+    apiName: def.apiName ?? `delete-object-${kebab(def.objectType.apiName.split(".").pop() ?? def.objectType.apiName)}`,
+    displayName: def.displayName ?? `Delete ${def.objectType.displayName}`,
     parameters: [{
       id: "objectToDeleteParameter",
       displayName: "Delete object",
       type: {
         type: "objectReference",
         objectReference: {
-          objectTypeId: objectType.apiName
+          objectTypeId: def.objectType.apiName
         }
       },
       validation: {
@@ -284,21 +297,21 @@ export function defineDeleteObjectAction(objectType, validation) {
         }
       }
     }],
-    status: "active",
-    entities: {
-      affectedInterfaceTypes: [],
-      affectedObjectTypes: [objectType.apiName],
-      affectedLinkTypes: [],
-      typeGroups: []
-    },
+    status: def.status ?? "active",
     rules: [{
       type: "deleteObjectRule",
       deleteObjectRule: {
         objectToDelete: "objectToDeleteParameter"
       }
     }],
-    ...(validation ? {
-      validation: [convertValidationRule(validation)]
+    entities: {
+      affectedInterfaceTypes: [],
+      affectedObjectTypes: [def.objectType.apiName],
+      affectedLinkTypes: [],
+      typeGroups: []
+    },
+    ...(def.actionLevelValidation ? {
+      validation: [convertValidationRule(def.actionLevelValidation)]
     } : {})
   });
 }