@osdk/maker 0.13.0-beta.8 → 0.13.0

package/build/browser/api/defineAction.js

@@ -16,40 +16,46 @@
 
 import { consola } from "consola";
 import invariant from "tiny-invariant";
-import { convertToDisplayName, getAllInterfaceProperties } from "./defineObject.js";
-import { namespace, ontologyDefinition, updateOntology } from "./defineOntology.js";
-import { convertConditionDefinition, convertMappingValue } from "./ontologyUtils.js";
-import { CREATE_OR_MODIFY_OBJECT_PARAMETER, MODIFY_OBJECT_PARAMETER, OntologyEntityTypeEnum } from "./types.js";
-export function defineCreateInterfaceObjectAction(interfaceType, objectType, validation) {
-  const allProperties = Object.entries(getAllInterfaceProperties(interfaceType)).filter(([_, prop]) => !isStruct(prop.sharedPropertyType.type));
-  if (allProperties.length !== Object.entries(getAllInterfaceProperties(interfaceType)).length) {
-    consola.info(`Some properties on ${interfaceType.apiName} were skipped in the create action because they are structs`);
+import { convertConditionDefinition } from "../conversion/toMarketplace/convertConditionDefinition.js";
+import { convertMappingValue } from "../conversion/toMarketplace/convertMappingValue.js";
+import { isActionParameterTypePrimitive } from "./action/ActionParameterType.js";
+import { OntologyEntityTypeEnum } from "./common/OntologyEntityTypeEnum.js";
+import { uppercaseFirstLetter } from "./defineObject.js";
+import { importedTypes, namespace, ontologyDefinition, updateOntology } from "./defineOntology.js";
+import { getFlattenedInterfaceProperties } from "./interface/getFlattenedInterfaceProperties.js";
+import { isStruct } from "./properties/PropertyTypeType.js";
+export const MODIFY_OBJECT_PARAMETER = "objectToModifyParameter";
+export const CREATE_OR_MODIFY_OBJECT_PARAMETER = "objectToCreateOrModifyParameter";
+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
               }
             }
           }]
@@ -67,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: []
@@ -77,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",
@@ -85,8 +91,8 @@ export function defineCreateInterfaceObjectAction(interfaceType, objectType, val
         }]))
       }
     }],
-    ...(validation ? {
-      validation: convertValidationRule(validation)
+    ...(def.validation ? {
+      validation: convertValidationRule(def.validation)
     } : {})
   });
 }
@@ -147,35 +153,35 @@ export function defineCreateObjectAction(def) {
     })
   });
 }
-export function defineModifyInterfaceObjectAction(interfaceType, objectType, validation) {
-  const allProperties = Object.entries(getAllInterfaceProperties(interfaceType)).filter(([_, prop]) => !isStruct(prop.sharedPropertyType.type));
-  if (allProperties.length !== Object.entries(getAllInterfaceProperties(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
               }
             }
           }]
@@ -193,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: []
@@ -210,8 +216,8 @@ export function defineModifyInterfaceObjectAction(interfaceType, objectType, val
         }]))
       }
     }],
-    ...(validation ? {
-      validation: convertValidationRule(validation)
+    ...(def.validation ? {
+      validation: convertValidationRule(def.validation)
     } : {})
   });
 }
@@ -419,6 +425,29 @@ export function defineAction(actionDef) {
     if (rule.type === "deleteObjectRule") {
       !parameterIds.some(id => id === rule.deleteObjectRule.objectToDelete) ? process.env.NODE_ENV !== "production" ? invariant(false, `Object to delete parameter must be defined in parameters`) : invariant(false) : void 0;
     }
+    if (rule.type === "modifyInterfaceRule") {
+      // The there must be a parameter for the interface, and the interface there must exist
+      const interfaceParam = actionDef.parameters.find(p => p.id === rule.modifyInterfaceRule.interfaceObjectToModifyParameter);
+      !(interfaceParam !== undefined && typeof interfaceParam.type === "object" && (interfaceParam.type.type === "interfaceReference" || interfaceParam.type.type === "interfaceReferenceList")) ? process.env.NODE_ENV !== "production" ? invariant(false, `Interface object to modify parameter must be an interface reference`) : invariant(false) : void 0;
+      const interfaceReference = interfaceParam.type.type === "interfaceReference" ? interfaceParam.type.interfaceReference.interfaceTypeRid : interfaceParam.type.interfaceReferenceList.interfaceTypeRid;
+      !(ontologyDefinition.INTERFACE_TYPE[interfaceReference] !== undefined || importedTypes.INTERFACE_TYPE[interfaceReference] !== undefined) ? process.env.NODE_ENV !== "production" ? invariant(false, `Interface type ${interfaceReference} does not exist`) : invariant(false) : void 0;
+
+      // All referenced SPTs must exist on the interface
+      const interfaceType = ontologyDefinition.INTERFACE_TYPE[interfaceReference];
+      Object.keys(rule.modifyInterfaceRule.sharedPropertyValues).forEach(spt => {
+        !Object.keys(getFlattenedInterfaceProperties(interfaceType)).includes(spt) ? process.env.NODE_ENV !== "production" ? invariant(false, `Shared property type ${spt} does not exist in interface type ${interfaceReference}`) : invariant(false) : void 0;
+      });
+    }
+    if (rule.type === "addInterfaceRule") {
+      // The referenced interface must exist globally
+      const interfaceType = ontologyDefinition.INTERFACE_TYPE[rule.addInterfaceRule.interfaceApiName] ?? importedTypes.INTERFACE_TYPE[rule.addInterfaceRule.interfaceApiName];
+      !(interfaceType !== undefined) ? process.env.NODE_ENV !== "production" ? invariant(false, `Interface type ${rule.addInterfaceRule.interfaceApiName} does not exist`) : invariant(false) : void 0;
+
+      // All referenced SPTs must exist on the interface
+      Object.keys(rule.addInterfaceRule.sharedPropertyValues).forEach(spt => {
+        !Object.keys(getFlattenedInterfaceProperties(interfaceType)).includes(spt) ? process.env.NODE_ENV !== "production" ? invariant(false, `Shared property type ${spt} does not exist in interface type ${interfaceType.apiName}`) : invariant(false) : void 0;
+      });
+    }
   });
   const fullAction = {
     ...actionDef,
@@ -492,7 +521,7 @@ function createParameters(def, parameterSet) {
   });
   return [...targetParam, ...Array.from(parameterSet).map(id => ({
     id,
-    displayName: def.parameterConfiguration?.[id]?.displayName ?? def.objectType.properties?.[id]?.displayName ?? convertToDisplayName(id),
+    displayName: def.parameterConfiguration?.[id]?.displayName ?? def.objectType.properties?.[id]?.displayName ?? uppercaseFirstLetter(id),
     type: def.parameterConfiguration?.[id]?.customParameterType ?? extractActionParameterType(def.objectType.properties?.[id]),
     validation: def.parameterConfiguration?.[id] !== undefined ? {
       ...def.parameterConfiguration?.[id],
@@ -775,12 +804,6 @@ function extractActionParameterType(pt) {
 function maybeAddList(type, pt) {
   return pt.array ?? false ? type + "List" : type;
 }
-function isActionParameterTypePrimitive(type) {
-  return ["boolean", "booleanList", "integer", "integerList", "long", "longList", "double", "doubleList", "string", "stringList", "decimal", "decimalList", "timestamp", "timestampList", "geohash", "geohashList", "geoshape", "geoshapeList", "timeSeriesReference", "date", "dateList", "objectTypeReference", "objectReference", "attachment", "attachmentList", "marking", "markingList", "mediaReference", "mediaReferenceList", "geotimeSeriesReference", "geotimeSeriesReferenceList"].includes(type);
-}
-function isStruct(type) {
-  return typeof type === "object" && type.type === "struct";
-}
 function kebab(s) {
   return s.replace(/([a-z])([A-Z])/g, "$1-$2").replace(/([A-Z])([A-Z][a-z])/g, "$1-$2").replace(/\./g, "-").toLowerCase();
 }