@osdk/maker 0.12.0-beta.2 → 0.12.0-beta.20

package/CHANGELOG.md

@@ -1,5 +1,166 @@
 # @osdk/maker
 
+## 0.12.0-beta.20
+
+### Minor Changes
+
+- 45ed433: Target objects are configurable and default parameter ordering is better in OAC actions
+
+## 0.12.0-beta.19
+
+### Patch Changes
+
+- @osdk/api@2.4.0-beta.16
+
+## 0.12.0-beta.18
+
+### Patch Changes
+
+- @osdk/api@2.4.0-beta.15
+
+## 0.12.0-beta.17
+
+### Minor Changes
+
+- f1f587b: Support custom parameters in OAC actions
+- 641bc0c: Fix create-or-modify non parameter mapped property bug
+- 25bae67: OAC modify object actions set parameter defaults to match the selected object
+- 5c76e33: Trim value type before putting it in SPT IR
+
+### Patch Changes
+
+- @osdk/api@2.4.0-beta.14
+
+## 0.12.0-beta.16
+
+### Patch Changes
+
+- Updated dependencies [4bc848b]
+  - @osdk/api@2.4.0-beta.13
+
+## 0.12.0-beta.15
+
+### Minor Changes
+
+- a1736f3: Actions can have properties that are not mapped to parameters
+- c621638: Create or Modify actions in OAC
+
+### Patch Changes
+
+- @osdk/api@2.4.0-beta.12
+
+## 0.12.0-beta.14
+
+### Minor Changes
+
+- d384b4c: Add custom display names and descriptions for action parameters in OAC
+- 02be685: Remove jiti
+
+### Patch Changes
+
+- @osdk/api@2.4.0-beta.11
+
+## 0.12.0-beta.13
+
+### Minor Changes
+
+- ed41359: Action sections in OAC
+
+## 0.12.0-beta.12
+
+### Minor Changes
+
+- 666787f: fix text allowed values name
+
+### Patch Changes
+
+- @osdk/api@2.4.0-beta.10
+
+## 0.12.0-beta.11
+
+### Minor Changes
+
+- b0955ef: Action parameter defaults and table forms
+- defc2cf: change parameterLevelValidations to parameterConfiguration
+
+### Patch Changes
+
+- Updated dependencies [9101bad]
+  - @osdk/api@2.4.0-beta.9
+
+## 0.12.0-beta.10
+
+### Minor Changes
+
+- 4dffba1: Support extended string params in actions
+
+### Patch Changes
+
+- Updated dependencies [9f4fe9e]
+  - @osdk/api@2.4.0-beta.8
+
+## 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
+
+- 764e5f1: Add marking constraints
+
+### Patch Changes
+
+- @osdk/api@2.4.0-beta.6
+
+## 0.12.0-beta.7
+
+### Minor Changes
+
+- 75fbd09: Type classes and list validation for object actions
+
+### Patch Changes
+
+- @osdk/api@2.4.0-beta.5
+
+## 0.12.0-beta.6
+
+### Minor Changes
+
+- 3dcd9b1: Modify object actions cannot modify pk
+
+## 0.12.0-beta.5
+
+### Minor Changes
+
+- a01b8d4: Revert import block data changes
+
+### Patch Changes
+
+- @osdk/api@2.4.0-beta.4
+
+## 0.12.0-beta.4
+
+### Minor Changes
+
+- e647175: Skip struct props for object create + modify actions
+
+## 0.12.0-beta.3
+
+### Minor Changes
+
+- 988bf66: Use block data type for imports
+
+### Patch Changes
+
+- @osdk/api@2.4.0-beta.3
+
 ## 0.12.0-beta.2
 
 ### 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,
+    },
+    parameterConfiguration: {
+      "numDeals": {
+        defaultVisibility: "hidden",
+        conditionalOverrides: [
+          makeDealsVisible,
+        ],
+      },
+    },
+    excludedProperties: ["experience"],
+  },
+);
+```