@fibery/expression-utils 9.2.1 → 9.3.0

package/lib/contextVariables.js

@@ -4,6 +4,89 @@ function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'defau
 
 var ___default = /*#__PURE__*/_interopDefaultLegacy(_);
 
+const getAutomationButtonContextVariables = (typeId, typeName, fiberySchema) => {
+  if (!fiberySchema) {
+    return [];
+  }
+  const userTypeObject = fiberySchema.typeObjectsByName["fibery/user"];
+  const typeObject = fiberySchema.typeObjectsById[typeId];
+  return [{
+    id: "triggeredEntity",
+    title: `Step 1 ${typeName}`,
+    typeObject,
+    description: `The ${typeName} for which the Button was clicked`
+  }, {
+    id: "currentUser",
+    title: `User who clicked Button`,
+    typeObject: userTypeObject,
+    description: `The User who triggered this automation by clicking a Button.`
+  }];
+};
+const getTriggerCollectionFieldObject = (typeId, collectionFieldId, fiberySchema) => {
+  if (!fiberySchema) {
+    return undefined;
+  }
+  if (!Object.hasOwn(fiberySchema.typeObjectsById, typeId)) {
+    return undefined;
+  }
+  if (!Object.hasOwn(fiberySchema.typeObjectsById[typeId].fieldObjectsById, collectionFieldId)) {
+    return undefined;
+  }
+  return fiberySchema.typeObjectsById[typeId].fieldObjectsById[collectionFieldId];
+};
+const getTriggerContextVariables = (trigger, typeId, fiberySchema) => {
+  if (!fiberySchema) {
+    return [];
+  }
+  const typeObject = fiberySchema.typeObjectsById[typeId];
+  const userTypeObject = fiberySchema.typeObjectsByName["fibery/user"];
+  const triggeredEntityVar = {
+    id: "triggeredEntity",
+    title: `Step 1 ${typeObject.title}`,
+    typeObject,
+    description: `The ${typeObject.title} from step 1 of this Rule`
+  };
+  const currentUserVar = {
+    id: "currentUser",
+    title: `User who triggered Rule`,
+    typeObject: userTypeObject,
+    description: `The User who made the change which triggered this automation. Empty in case the change was made by a formula or an integration.`
+  };
+  if (trigger.trigger === "time-based") {
+    return [triggeredEntityVar];
+  } else if (trigger.trigger === "created") {
+    return typeObject.syncSource !== null ? [triggeredEntityVar] : [triggeredEntityVar, currentUserVar];
+  } else if (trigger.trigger === "updated") {
+    const disableCurrentUserVar = trigger.args.updatedField && ___default["default"].isArray(trigger.args.updatedField) && trigger.args.updatedField.some(fieldId => {
+      if (!Object.hasOwn(typeObject.fieldObjectsById, fieldId)) {
+        return false;
+      }
+      const fieldObject = typeObject.fieldObjectsById[fieldId];
+      return (fieldObject == null ? void 0 : fieldObject.isReadOnly) || (fieldObject == null ? void 0 : fieldObject.type) === "Collaboration~Documents/Document";
+    });
+    return disableCurrentUserVar ? [triggeredEntityVar] : [triggeredEntityVar, currentUserVar];
+  } else if (trigger.trigger === "collection-item-added" || trigger.trigger === "collection-item-removed") {
+    const collectionItemFieldObject = getTriggerCollectionFieldObject(typeId, trigger.args.changedCollectionField, fiberySchema);
+    const collectionItemTypeObject = collectionItemFieldObject == null ? void 0 : collectionItemFieldObject.typeObject;
+    const variables = [triggeredEntityVar];
+    collectionItemTypeObject && variables.push({
+      id: "triggered-collection-item",
+      title: `Step 1 ${trigger.trigger === "collection-item-added" ? "linked" : "unlinked"} ${collectionItemTypeObject.title}`,
+      typeObject: collectionItemTypeObject,
+      description: `The ${collectionItemTypeObject.title} from step 1 of this Rule`
+    });
+    const disableCurrentUserVar = collectionItemFieldObject == null ? void 0 : collectionItemFieldObject.isReadOnly;
+    !disableCurrentUserVar && variables.push(currentUserVar);
+    return variables;
+  } else {
+    return [];
+  }
+};
+const getAutomationTriggersContextVariables = (triggers, typeId, fiberySchema) => {
+  return ___default["default"].uniqBy(___default["default"].flatten(triggers.map(trigger => {
+    return getTriggerContextVariables(trigger, typeId, fiberySchema);
+  })), variable => `${variable.id}_${variable.typeObject.id}`);
+};
 const getEntityQueryVariables = schema => {
   const grouped = ___default["default"].groupBy(schema.typeObjects.filter(x => x.isDomain), typeObject => typeObject.pluralTitle);
   return ___default["default"].flatten(Object.values(grouped).map(group => {
@@ -17,4 +100,7 @@ const getEntityQueryVariables = schema => {
   }));
 };
 
+exports.getAutomationButtonContextVariables = getAutomationButtonContextVariables;
+exports.getAutomationTriggersContextVariables = getAutomationTriggersContextVariables;
 exports.getEntityQueryVariables = getEntityQueryVariables;
+exports.getTriggerCollectionFieldObject = getTriggerCollectionFieldObject;

package/lib/expression-utils.js

@@ -1011,6 +1011,89 @@ var visitors = {
   fieldAccessVisitorTypeAware: fieldAccessVisitorTypeAware
 };
 
+const getAutomationButtonContextVariables = (typeId, typeName, fiberySchema) => {
+  if (!fiberySchema) {
+    return [];
+  }
+  const userTypeObject = fiberySchema.typeObjectsByName["fibery/user"];
+  const typeObject = fiberySchema.typeObjectsById[typeId];
+  return [{
+    id: "triggeredEntity",
+    title: `Step 1 ${typeName}`,
+    typeObject,
+    description: `The ${typeName} for which the Button was clicked`
+  }, {
+    id: "currentUser",
+    title: `User who clicked Button`,
+    typeObject: userTypeObject,
+    description: `The User who triggered this automation by clicking a Button.`
+  }];
+};
+const getTriggerCollectionFieldObject = (typeId, collectionFieldId, fiberySchema) => {
+  if (!fiberySchema) {
+    return undefined;
+  }
+  if (!Object.hasOwn(fiberySchema.typeObjectsById, typeId)) {
+    return undefined;
+  }
+  if (!Object.hasOwn(fiberySchema.typeObjectsById[typeId].fieldObjectsById, collectionFieldId)) {
+    return undefined;
+  }
+  return fiberySchema.typeObjectsById[typeId].fieldObjectsById[collectionFieldId];
+};
+const getTriggerContextVariables = (trigger, typeId, fiberySchema) => {
+  if (!fiberySchema) {
+    return [];
+  }
+  const typeObject = fiberySchema.typeObjectsById[typeId];
+  const userTypeObject = fiberySchema.typeObjectsByName["fibery/user"];
+  const triggeredEntityVar = {
+    id: "triggeredEntity",
+    title: `Step 1 ${typeObject.title}`,
+    typeObject,
+    description: `The ${typeObject.title} from step 1 of this Rule`
+  };
+  const currentUserVar = {
+    id: "currentUser",
+    title: `User who triggered Rule`,
+    typeObject: userTypeObject,
+    description: `The User who made the change which triggered this automation. Empty in case the change was made by a formula or an integration.`
+  };
+  if (trigger.trigger === "time-based") {
+    return [triggeredEntityVar];
+  } else if (trigger.trigger === "created") {
+    return typeObject.syncSource !== null ? [triggeredEntityVar] : [triggeredEntityVar, currentUserVar];
+  } else if (trigger.trigger === "updated") {
+    const disableCurrentUserVar = trigger.args.updatedField && ___default["default"].isArray(trigger.args.updatedField) && trigger.args.updatedField.some(fieldId => {
+      if (!Object.hasOwn(typeObject.fieldObjectsById, fieldId)) {
+        return false;
+      }
+      const fieldObject = typeObject.fieldObjectsById[fieldId];
+      return (fieldObject == null ? void 0 : fieldObject.isReadOnly) || (fieldObject == null ? void 0 : fieldObject.type) === "Collaboration~Documents/Document";
+    });
+    return disableCurrentUserVar ? [triggeredEntityVar] : [triggeredEntityVar, currentUserVar];
+  } else if (trigger.trigger === "collection-item-added" || trigger.trigger === "collection-item-removed") {
+    const collectionItemFieldObject = getTriggerCollectionFieldObject(typeId, trigger.args.changedCollectionField, fiberySchema);
+    const collectionItemTypeObject = collectionItemFieldObject == null ? void 0 : collectionItemFieldObject.typeObject;
+    const variables = [triggeredEntityVar];
+    collectionItemTypeObject && variables.push({
+      id: "triggered-collection-item",
+      title: `Step 1 ${trigger.trigger === "collection-item-added" ? "linked" : "unlinked"} ${collectionItemTypeObject.title}`,
+      typeObject: collectionItemTypeObject,
+      description: `The ${collectionItemTypeObject.title} from step 1 of this Rule`
+    });
+    const disableCurrentUserVar = collectionItemFieldObject == null ? void 0 : collectionItemFieldObject.isReadOnly;
+    !disableCurrentUserVar && variables.push(currentUserVar);
+    return variables;
+  } else {
+    return [];
+  }
+};
+const getAutomationTriggersContextVariables = (triggers, typeId, fiberySchema) => {
+  return ___default["default"].uniqBy(___default["default"].flatten(triggers.map(trigger => {
+    return getTriggerContextVariables(trigger, typeId, fiberySchema);
+  })), variable => `${variable.id}_${variable.typeObject.id}`);
+};
 const getEntityQueryVariables = schema => {
   const grouped = ___default["default"].groupBy(schema.typeObjects.filter(x => x.isDomain), typeObject => typeObject.pluralTitle);
   return ___default["default"].flatten(Object.values(grouped).map(group => {
@@ -1026,6 +1109,9 @@ const getEntityQueryVariables = schema => {
 
 var contextVariables = {
   __proto__: null,
+  getAutomationButtonContextVariables: getAutomationButtonContextVariables,
+  getTriggerCollectionFieldObject: getTriggerCollectionFieldObject,
+  getAutomationTriggersContextVariables: getAutomationTriggersContextVariables,
   getEntityQueryVariables: getEntityQueryVariables
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fibery/expression-utils",
-  "version": "9.2.1",
+  "version": "9.3.0",
   "description": "utils for working with fibery api expressions",
   "exports": {
     ".": "./lib/expression-utils.js",

package/types.d.ts

@@ -70,10 +70,30 @@ declare module "@fibery/expression-utils" {
     relationalOperators: Set<string>;
     mathOperators: Set<string>;
   };
+  type TContextVariable = {
+    typeObject: TypeObject;
+    id: string;
+    title: string;
+    isCollection: boolean;
+    description: string;
+  };
   export const contextVariables: {
-    getEntityQueryVariables: (
-      schema: Schema
-    ) => Array<{typeObject: TypeObject; id: string; title: string; isCollection: boolean; description: string}>;
+    getEntityQueryVariables: (schema: Schema) => Array<TContextVariable>;
+    getAutomationButtonContextVariables: (
+      typeId: string,
+      typeName: string,
+      fiberySchema?: Schema
+    ) => Array<TContextVariable>;
+    getAutomationTriggersContextVariables: (
+      triggers: Array<{trigger: string; args: Record<string, unknown>}>,
+      typeId: string,
+      fiberySchema?: Schema
+    ) => Array<TContextVariable>;
+    getTriggerCollectionFieldObject: (
+      typeId: string,
+      collectionFieldId: string,
+      fiberySchema?: Schema
+    ) => FieldObject | undefined;
   };
   export const paramsPlaceholders: {
     formulaTodayDateParamPlaceholder: string;