@osdk/maker 0.11.0-rc.15 → 0.12.0-beta.10

package/CHANGELOG.md

@@ -1,11 +1,91 @@
 # @osdk/maker
 
-## 0.11.0-rc.15
+## 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
+
+- 8bb08eb: Turn on module cache
+- 5994895: Interface struct properties are skipped in crud actions
 
 ### Patch Changes
 
-- Updated dependencies [f82cff2]
-  - @osdk/api@2.3.0-rc.11
+- Updated dependencies [29d2ada]
+- Updated dependencies [8c95154]
+- Updated dependencies [c32dcf2]
+  - @osdk/api@2.4.0-beta.2
 
 ## 0.11.0-beta.14
 
@@ -138,6 +218,81 @@
 
 - @osdk/api@2.3.0-beta.2
 
+## 0.10.0
+
+### Patch Changes
+
+- 322c5bc: Simulated release
+- 6eeb423: Simple create and modify actions for interfaces
+- 4a02a1f: Make string more configurable
+- 38ad25b: Make properties nullable
+- 489ea17: Wire through nullability to SPT
+- 1a09a8e: Enforce that struct, mediaReference, and GTSR type SPTs cannot have render hints
+- 12843cb: Add ability to load all underlying properties of an interface.
+- a08bdfb: Support stream datasources in OAC
+- 0a41cec: Support optional interface properties
+- 18ba34f: Adds the ability to generate and execute functions at pinned versions
+- 21e33a5: Upgrade consola to 3.4.0
+- 63b2e63: Update Platform SDK Dependencies
+- 75f6b51: Propagate required/optional fields from interfaces to actions
+- 7416ce4: Update Platform SDK Dependencies
+- 10da391: Links as Code
+- c0aa106: Add visibility field to shared property type in maker
+- 7bb2971: OAC support for actions on objects
+- f1b1188: OAC Imports v0
+- cff551a: Update OAC codegen
+- 5745d3e: Make Object PKs singular
+- ca5d920: Fix marking/list validation
+- e287c5b: Support marking types in SPTs in Interfaces in Actions
+- 5e8e839: Bump OMS API to include links in ontology IR
+- 24c4b12: Add geotime and mediaset datasources to OAC
+- 889e84b: Release
+- 395ae07: Actions as code
+- 94663ab: Change the status definitions for objects and add validation for timestamps.
+- 791e655: Add support for geoshape and geohash action parameters.
+- f12caa4: Fix marking list for modify action
+- 317b555: Release
+- c7f7a99: Export defineOntology method
+- 8f67e1e: OAC Struct Property Field Mapping Support
+- cc380b5: Use the latest Platform APIs
+- 340ba44: Fix test
+- Updated dependencies [322c5bc]
+- Updated dependencies [c6bee50]
+- Updated dependencies [7416ce4]
+- Updated dependencies [7170fd1]
+- Updated dependencies [12843cb]
+- Updated dependencies [18ba34f]
+- Updated dependencies [6abf078]
+- Updated dependencies [f82767c]
+- Updated dependencies [56aa502]
+- Updated dependencies [0e874b1]
+- Updated dependencies [abe4897]
+- Updated dependencies [63b2e63]
+- Updated dependencies [cddfbf9]
+- Updated dependencies [7416ce4]
+- Updated dependencies [23ea0e4]
+- Updated dependencies [26c2d95]
+- Updated dependencies [488b51c]
+- Updated dependencies [71462e9]
+- Updated dependencies [fccd9ac]
+- Updated dependencies [5665b18]
+- Updated dependencies [46cede4]
+- Updated dependencies [761e69d]
+- Updated dependencies [889e84b]
+- Updated dependencies [a6e5f89]
+- Updated dependencies [ed69666]
+- Updated dependencies [4183a55]
+- Updated dependencies [70b4464]
+- Updated dependencies [791e655]
+- Updated dependencies [317b555]
+- Updated dependencies [63b2e63]
+- Updated dependencies [a146ce4]
+- Updated dependencies [3d0ab11]
+- Updated dependencies [805df40]
+- Updated dependencies [5467a0f]
+- Updated dependencies [63b2e63]
+  - @osdk/api@2.2.0
+
 ## 0.10.0-beta.25
 
 ### Minor Changes

package/README.md

@@ -369,28 +369,12 @@ const personObject = defineObject({
   pluralDisplayName: "People",
   titlePropertyApiName: "name", // Property to use as the title
   primaryKeyPropertyApiName: "id", // Property to use as the primary key
-  properties: [
-    {
-      apiName: "id",
-      type: "string",
-      displayName: "ID",
-    },
-    {
-      apiName: "name",
-      type: "string",
-      displayName: "Name",
-    },
-    {
-      apiName: "email",
-      type: "string",
-      displayName: "Email",
-    },
-    {
-      apiName: "age",
-      type: "integer",
-      displayName: "Age",
-    },
-  ],
+  properties: {
+    "id": { type: "string", displayName: "ID" },
+    "name": { type: "string" },
+    "email": { type: "string" },
+    "age": { type: "integer" },
+  },
 });
 ```
 
@@ -404,38 +388,14 @@ const employeeObject = defineObject({
   pluralDisplayName: "Employees",
   titlePropertyApiName: "name",
   primaryKeyPropertyApiName: "id",
-  properties: [
-    {
-      apiName: "id",
-      type: "string",
-      displayName: "ID",
-    },
-    {
-      apiName: "name",
-      type: "string",
-      displayName: "Name",
-    },
-    {
-      apiName: "email",
-      type: "string",
-      displayName: "Email",
-    },
-    {
-      apiName: "department",
-      type: "string",
-      displayName: "Department",
-    },
-    {
-      apiName: "hireDate",
-      type: "date",
-      displayName: "Hire Date",
-    },
-    {
-      apiName: "isActive",
-      type: "boolean",
-      displayName: "Active",
-    },
-  ],
+  properties: {
+    "id": { type: "string", displayName: "ID" },
+    "name": { type: "string" },
+    "email": { type: "string" },
+    "department": { type: "string" },
+    "hireDate": { type: "date", displayName: "Hire Date" },
+    "isActive": { type: "boolean" },
+  },
   implementsInterfaces: [
     {
       implements: employeeInterface,
@@ -461,19 +421,10 @@ const customerObject = defineObject({
   pluralDisplayName: "Customers",
   titlePropertyApiName: "name",
   primaryKeyPropertyApiName: "id",
-  properties: [
-    {
-      apiName: "id",
-      type: "string",
-      displayName: "ID",
-    },
-    {
-      apiName: "name",
-      type: "string",
-      displayName: "Name",
-    },
-    {
-      apiName: "address",
+  properties: {
+    "id": { type: "string", displayName: "ID" },
+    "name": { type: "string" },
+    "address": {
       type: {
         type: "struct",
         structDefinition: {
@@ -486,7 +437,7 @@ const customerObject = defineObject({
       },
       displayName: "Address",
     },
-  ],
+  },
 });
 ```
 
@@ -500,23 +451,11 @@ const eventObject = defineObject({
   pluralDisplayName: "Events",
   titlePropertyApiName: "eventName",
   primaryKeyPropertyApiName: "eventId",
-  properties: [
-    {
-      apiName: "eventId",
-      type: "string",
-      displayName: "Event ID",
-    },
-    {
-      apiName: "eventName",
-      type: "string",
-      displayName: "Event Name",
-    },
-    {
-      apiName: "timestamp",
-      type: "timestamp",
-      displayName: "Timestamp",
-    },
-  ],
+  properties: {
+    "eventId": { type: "string", displayName: "Event ID" },
+    "eventName": { type: "string", displayName: "Event Name" },
+    "timestamp": { type: "timestamp" },
+  },
   datasource: {
     type: "stream",
     retentionPeriod: "P90D", // 90 days retention (ISO 8601 duration format)
@@ -530,23 +469,11 @@ const productObject = defineObject({
   pluralDisplayName: "Products",
   titlePropertyApiName: "name",
   primaryKeyPropertyApiName: "id",
-  properties: [
-    {
-      apiName: "id",
-      type: "string",
-      displayName: "ID",
-    },
-    {
-      apiName: "name",
-      type: "string",
-      displayName: "Name",
-    },
-    {
-      apiName: "price",
-      type: "decimal",
-      displayName: "Price",
-    },
-  ],
+  properties: {
+    "id": { type: "string", displayName: "ID" },
+    "name": { type: "string" },
+    "price": { type: "decimal" },
+  },
   datasource: {
     type: "dataset",
   },
@@ -640,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
@@ -714,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
@@ -723,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
@@ -746,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"],
+  },
+);
+```