@osdk/maker 0.12.0-beta.16 → 0.12.0-beta.18

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @osdk/maker
 
+## 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

package/build/browser/api/defineAction.js

@@ -64,7 +64,7 @@ export function defineCreateInterfaceObjectAction(interfaceType, objectType, val
         required: prop.sharedPropertyType.array ?? false ? {
           listLength: {}
         } : prop.required,
-        allowedValues: extractAllowedValuesFromType(prop.sharedPropertyType.type)
+        allowedValues: extractAllowedValuesFromPropertyType(prop.sharedPropertyType.type)
       }
     }))],
     status: interfaceType.status.type !== "deprecated" ? interfaceType.status.type : interfaceType.status,
@@ -91,10 +91,10 @@ export function defineCreateInterfaceObjectAction(interfaceType, objectType, val
   });
 }
 export function defineCreateObjectAction(def) {
-  [...Object.keys(def.parameterConfiguration ?? {}), ...Object.keys(def.nonParameterMappings ?? {}), ...(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 => !Object.keys(def.nonParameterMappings ?? {}).includes(id) && !def.excludedProperties?.includes(id) && !isStruct(def.objectType.properties?.[id].type));
+  validateActionParameters(def);
+  const propertyParameters = Object.keys(def.objectType.properties ?? {}).filter(id => !Object.keys(def.nonParameterMappings ?? {}).includes(id) && !def.excludedProperties?.includes(id) && !isStruct(def.objectType.properties?.[id].type));
+  const parameterNames = new Set(propertyParameters);
+  Object.keys(def.parameterConfiguration ?? {}).forEach(param => parameterNames.add(param));
   if (def.parameterOrdering) {
     const sortedOrdering = [...def.parameterOrdering].sort();
     const sortedParameterNames = [...parameterNames].sort();
@@ -118,9 +118,9 @@ export function defineCreateObjectAction(def) {
       addObjectRule: {
         objectTypeId: def.objectType.apiName,
         propertyValues: {
-          ...Object.fromEntries(parameters.map(p => [p.id, {
+          ...Object.fromEntries(propertyParameters.map(p => [p, {
             type: "parameterId",
-            parameterId: p.id
+            parameterId: p
           }])),
           ...mappings
         },
@@ -190,7 +190,7 @@ export function defineModifyInterfaceObjectAction(interfaceType, objectType, val
         required: prop.sharedPropertyType.array ?? false ? {
           listLength: {}
         } : prop.required,
-        allowedValues: extractAllowedValuesFromType(prop.sharedPropertyType.type)
+        allowedValues: extractAllowedValuesFromPropertyType(prop.sharedPropertyType.type)
       }
     }))],
     status: interfaceType.status.type !== "deprecated" ? interfaceType.status.type : interfaceType.status,
@@ -216,16 +216,27 @@ export function defineModifyInterfaceObjectAction(interfaceType, objectType, val
   });
 }
 export function defineModifyObjectAction(def) {
-  [...Object.keys(def.parameterConfiguration ?? {}), ...Object.keys(def.nonParameterMappings ?? {}), ...(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 => !Object.keys(def.nonParameterMappings ?? {}).includes(id) && !def.excludedProperties?.includes(id) && !isStruct(def.objectType.properties?.[id].type) && id !== def.objectType.primaryKeyPropertyApiName);
+  validateActionParameters(def);
+  const propertyParameters = Object.keys(def.objectType.properties ?? {}).filter(id => !Object.keys(def.nonParameterMappings ?? {}).includes(id) && !def.excludedProperties?.includes(id) && !isStruct(def.objectType.properties?.[id].type) && id !== def.objectType.primaryKeyPropertyApiName);
+  const parameterNames = new Set(propertyParameters);
+  Object.keys(def.parameterConfiguration ?? {}).forEach(param => parameterNames.add(param));
   if (def.parameterOrdering) {
     const sortedOrdering = [...def.parameterOrdering].sort();
     const sortedParameterNames = [...parameterNames].sort();
     !(sortedOrdering.length === sortedParameterNames.length && sortedOrdering.every((name, index) => name === sortedParameterNames[index])) ? process.env.NODE_ENV !== "production" ? invariant(false, `Action parameter ordering for ${def.objectType.apiName} does not match non-excluded properties`) : invariant(false) : void 0;
   }
   const parameters = createParameters(def, parameterNames, false);
+  parameters.forEach(p => {
+    if (p.defaultValue === undefined) {
+      p.defaultValue = {
+        type: "objectParameterPropertyValue",
+        objectParameterPropertyValue: {
+          parameterId: "objectToModifyParameter",
+          propertyTypeId: p.id
+        }
+      };
+    }
+  });
   const mappings = Object.fromEntries(Object.entries(def.nonParameterMappings ?? {}).map(([id, value]) => [id, convertMappingValue(value)]));
   return defineAction({
     apiName: def.apiName ?? `modify-object-${kebab(def.objectType.apiName.split(".").pop() ?? def.objectType.apiName)}`,
@@ -252,9 +263,9 @@ export function defineModifyObjectAction(def) {
       modifyObjectRule: {
         objectToModify: "objectToModifyParameter",
         propertyValues: {
-          ...Object.fromEntries(parameters.map(p => [p.id, {
+          ...Object.fromEntries(propertyParameters.map(p => [p, {
             type: "parameterId",
-            parameterId: p.id
+            parameterId: p
           }])),
           ...mappings
         },
@@ -326,13 +337,10 @@ export function defineDeleteObjectAction(def) {
   });
 }
 export function defineCreateOrModifyObjectAction(def) {
-  Object.keys(def.parameterConfiguration ?? {}).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);
+  validateActionParameters(def);
+  const propertyParameters = Object.keys(def.objectType.properties ?? {}).filter(id => !def.excludedProperties?.includes(id) && !isStruct(def.objectType.properties?.[id].type) && id !== def.objectType.primaryKeyPropertyApiName);
+  const parameterNames = new Set(propertyParameters);
+  Object.keys(def.parameterConfiguration ?? {}).forEach(param => parameterNames.add(param));
   if (def.parameterOrdering) {
     const sortedOrdering = [...def.parameterOrdering].sort();
     const sortedParameterNames = [...parameterNames].sort();
@@ -350,7 +358,7 @@ export function defineCreateOrModifyObjectAction(def) {
       };
     }
   });
-  Object.fromEntries(Object.entries(def.nonParameterMappings ?? {}).map(([id, value]) => [id, convertMappingValue(value)]));
+  const mappings = Object.fromEntries(Object.entries(def.nonParameterMappings ?? {}).map(([id, value]) => [id, convertMappingValue(value)]));
   return defineAction({
     apiName: def.apiName ?? `create-or-modify-${kebab(def.objectType.apiName.split(".").pop() ?? def.objectType.apiName)}`,
     displayName: def.displayName ?? `Create or Modify ${def.objectType.displayName}`,
@@ -382,10 +390,13 @@ export function defineCreateOrModifyObjectAction(def) {
       type: "addOrModifyObjectRuleV2",
       addOrModifyObjectRuleV2: {
         objectToModify: "objectToCreateOrModifyParameter",
-        propertyValues: Object.fromEntries(parameters.map(p => [p.id, {
-          type: "parameterId",
-          parameterId: p.id
-        }])),
+        propertyValues: {
+          ...Object.fromEntries(propertyParameters.map(p => [p, {
+            type: "parameterId",
+            parameterId: p
+          }])),
+          ...mappings
+        },
         structFieldValues: {}
       }
     }],
@@ -453,14 +464,21 @@ export function defineAction(actionDef) {
   updateOntology(fullAction);
   return fullAction;
 }
-function createParameters(def, parameterNames, defaultRequired) {
+function createParameters(def, parameterSet, defaultRequired) {
+  const parameterNames = Array.from(parameterSet);
+  // prefix objectReference parameters with the namespace
+  parameterNames.forEach(name => {
+    if (typeof def.parameterConfiguration?.[name]?.customParameterType === "object" && def.parameterConfiguration?.[name]?.customParameterType.type === "objectReference") {
+      def.parameterConfiguration[name].customParameterType.objectReference.objectTypeId = sanitize(def.parameterConfiguration[name].customParameterType.objectReference.objectTypeId);
+    }
+  });
   return Array.from(parameterNames).map(id => ({
     id,
-    displayName: def.parameterConfiguration?.[id]?.displayName ?? def.objectType.properties?.[id].displayName ?? convertToDisplayName(id),
-    type: extractActionParameterType(def.objectType.properties?.[id]),
+    displayName: def.parameterConfiguration?.[id]?.displayName ?? def.objectType.properties?.[id]?.displayName ?? convertToDisplayName(id),
+    type: def.parameterConfiguration?.[id]?.customParameterType ?? extractActionParameterType(def.objectType.properties?.[id]),
     validation: def.parameterConfiguration?.[id] !== undefined ? {
       ...def.parameterConfiguration?.[id],
-      allowedValues: def.parameterConfiguration?.[id].allowedValues ?? extractAllowedValuesFromType(def.objectType.properties?.[id].type),
+      allowedValues: def.parameterConfiguration?.[id].allowedValues ?? (def.parameterConfiguration?.[id].customParameterType ? extractAllowedValuesFromActionParameterType(def.parameterConfiguration?.[id].customParameterType) : extractAllowedValuesFromPropertyType(def.objectType.properties?.[id].type)),
       required: def.parameterConfiguration?.[id].required ?? defaultRequired
     } : {
       required: def.objectType.properties?.[id].array ?? false ? {
@@ -468,7 +486,7 @@ function createParameters(def, parameterNames, defaultRequired) {
           min: 1
         } : {}
       } : def.objectType.properties?.[id].nullability?.noNulls ?? defaultRequired,
-      allowedValues: extractAllowedValuesFromType(def.objectType.properties?.[id].type)
+      allowedValues: extractAllowedValuesFromPropertyType(def.objectType.properties?.[id].type)
     },
     defaultValue: def.parameterConfiguration?.[id]?.defaultValue,
     description: def.parameterConfiguration?.[id]?.description
@@ -537,7 +555,80 @@ function referencedParameterIds(actionDef) {
   });
   return parameterIds;
 }
-function extractAllowedValuesFromType(type) {
+function extractAllowedValuesFromActionParameterType(type) {
+  if (typeof type === "object") {
+    switch (type.type) {
+      case "objectReference":
+      case "objectReferenceList":
+        return {
+          type: "objectQuery"
+        };
+      case "struct":
+      case "structList":
+        throw new Error("Structs are not supported yet");
+      default:
+        throw new Error(`Inferred allowed values for ${type.type} not yet supported. Please explicitly provide allowed values.`);
+    }
+  }
+  switch (type) {
+    case "boolean":
+    case "booleanList":
+      return {
+        type: "boolean"
+      };
+    case "integer":
+    case "integerList":
+    case "decimal":
+    case "decimalList":
+    case "double":
+    case "doubleList":
+    case "long":
+    case "longList":
+      return {
+        type: "range"
+      };
+    case "timestamp":
+    case "timestampList":
+    case "date":
+    case "dateList":
+      return {
+        type: "datetime"
+      };
+    case "string":
+    case "stringList":
+      return {
+        type: "text"
+      };
+    case "geohash":
+    case "geohashList":
+      return {
+        type: "geohash"
+      };
+    case "geoshape":
+    case "geoshapeList":
+      return {
+        type: "geoshape"
+      };
+    case "mediaReference":
+    case "mediaReferenceList":
+      return {
+        type: "mediaReference"
+      };
+    case "geotimeSeriesReference":
+    case "geotimeSeriesReferenceList":
+      return {
+        type: "geotimeSeriesReference"
+      };
+    case "attachment":
+    case "attachmentList":
+      return {
+        type: "attachment"
+      };
+    default:
+      throw new Error(`Inferred allowed values for ${type} not yet supported. Please explicitly provide allowed values.`);
+  }
+}
+function extractAllowedValuesFromPropertyType(type) {
   switch (type) {
     case "boolean":
       return {
@@ -735,4 +826,13 @@ function validateActionCondition(condition, currentParameterId, seenParameterIds
       throw new Error(`Unknown condition type on parameter ${currentParameterId}`);
   }
 }
+function validateActionParameters(def) {
+  // validates that parameters either exist as object properties or have a type defined
+  [...Object.keys(def.parameterConfiguration ?? {})].forEach(id => {
+    !(def.objectType.properties?.[id] !== undefined || def.parameterConfiguration?.[id].customParameterType !== undefined) ? process.env.NODE_ENV !== "production" ? invariant(false, `Parameter ${id} does not exist as a property on ${def.objectType.apiName} and its type is not explicitly defined`) : invariant(false) : void 0;
+  });
+  [...Object.keys(def.nonParameterMappings ?? {}), ...(def.excludedProperties ?? [])].forEach(id => {
+    !(def.objectType.properties?.[id] !== undefined) ? process.env.NODE_ENV !== "production" ? invariant(false, `Property ${id} does not exist as a property on ${def.objectType.apiName}`) : invariant(false) : void 0;
+  });
+}
 //# sourceMappingURL=defineAction.js.map