@octaviaflow/flow-rules 0.2.0 → 0.3.0

package/dist/index.d.ts

@@ -29,3 +29,13 @@ export { buildPathOptions, collectArrayPaths, collectArrayPathsFromSample, infer
 export { type QueryMode, type QueryType } from "./catalog/general/query/types";
 export { type VariableField, type VariableSource, type VariableSourceKind, type VariableType, type VariablesConfig, } from "./catalog/utility/variables/config";
 export { type DebugConfig, type DebugConfigType, type DebugMode, type DebugSamplingStrategy, type WatchExpression, } from "./catalog/utility/debug/config";
+export { migrateDelayConfig, } from "./catalog/actions/delay/migrate";
+export { type DelayConfig, } from "./catalog/actions/delay/types";
+export { emailDefinition, } from "./catalog/communication/email-send/index";
+export { EmailConfig, } from "./catalog/communication/email-send/config";
+export { queryDefinition, } from "./catalog/general/query/index";
+export { isQueryableConnector, } from "./catalog/general/query/config";
+export { AggregateFunction, type BuildQueryConfig, type ColumnSchema, type ConnectorSchema, JoinType, LogicalOperator, type QueryExecutionResult, type QueryField, type QueryFilter, type QueryFilterGroup, type QueryJoin, type QuerySort, SortDirection, type VisualQueryConfig, } from "./catalog/general/query/types";
+export { DATABASE_CONNECTOR_IDS, type FieldMapping, TRANSFORM_OPERATIONS, TransformConfig, type TransformConfigType, type TransformOperation, } from "./catalog/general/transform/config";
+export { STORAGE_CONNECTOR_IDS, type StorageExtraField, type StoragePathField, getStorageProvider, storageConfigKeys, } from "./catalog/storage/storageCapabilities";
+export { ManualTriggerConfig, } from "./catalog/triggers/manual-trigger/index";

package/dist/index.js

@@ -133,6 +133,48 @@ function generateEdgeId(sourceId, targetId) {
   return `edge_${sourceId}_${targetId}_${Date.now()}_${randomSuffix(7)}`;
 }
 
+// src/catalog/triggers/manual-trigger/config.ts
+var ManualTriggerConfig = {
+  defaults: {
+    description: ""
+  },
+  schema: {
+    description: {
+      type: "string",
+      maxLength: 500,
+      required: false,
+      description: "Optional description for this trigger (shown on node)"
+    }
+  },
+  validate: (config) => {
+    const errors = [];
+    if (config.description !== undefined) {
+      if (typeof config.description !== "string") {
+        errors.push("Description must be a string");
+      }
+      if (config.description.length > 500) {
+        errors.push("Description must not exceed 500 characters");
+      }
+    }
+    return {
+      valid: errors.length === 0,
+      errors
+    };
+  },
+  merge: (userConfig) => {
+    return {
+      ...ManualTriggerConfig.defaults,
+      ...userConfig
+    };
+  },
+  getLabel: (config) => {
+    if (config.description) {
+      return `Manual Trigger: ${config.description}`;
+    }
+    return "Manual Trigger";
+  }
+};
+
 // src/catalog/triggers/manual-trigger/index.ts
 var manualTriggerDefinition = {
   id: "manual_trigger",
@@ -982,6 +1024,34 @@ var groupDefinition = {
   isOfficial: true,
   testable: false
 };
+
+// src/catalog/general/query/types.ts
+var LogicalOperator;
+((LogicalOperator) => {
+  LogicalOperator["And"] = "and";
+  LogicalOperator["Or"] = "or";
+})(LogicalOperator ||= {});
+var SortDirection;
+((SortDirection) => {
+  SortDirection["Ascending"] = "asc";
+  SortDirection["Descending"] = "desc";
+})(SortDirection ||= {});
+var JoinType;
+((JoinType) => {
+  JoinType["Inner"] = "inner";
+  JoinType["Left"] = "left";
+  JoinType["Right"] = "right";
+  JoinType["Full"] = "full";
+})(JoinType ||= {});
+var AggregateFunction;
+((AggregateFunction) => {
+  AggregateFunction["Count"] = "count";
+  AggregateFunction["Sum"] = "sum";
+  AggregateFunction["Average"] = "avg";
+  AggregateFunction["Min"] = "min";
+  AggregateFunction["Max"] = "max";
+  AggregateFunction["CountDistinct"] = "count_distinct";
+})(AggregateFunction ||= {});
 // src/catalog/general/query/config.ts
 var BuildQueryConfigDefaults = {
   mode: "visual" /* Visual */,
@@ -1003,6 +1073,31 @@ var BuildQueryConfigDefaults = {
     parameters: {}
   }
 };
+function isQueryableConnector(connector) {
+  if (connector.isQueryable !== undefined) {
+    return connector.isQueryable;
+  }
+  if (connector.category === "storage") {
+    return false;
+  }
+  if (!connector.type) {
+    return false;
+  }
+  const storageTypes = [
+    "dropbox",
+    "google_drive",
+    "google-drive",
+    "onedrive",
+    "box",
+    "ftp",
+    "sftp",
+    "s3",
+    "azure_blob",
+    "azure-blob",
+    "storage"
+  ];
+  return !storageTypes.includes(connector.type.toLowerCase());
+}
 
 // src/catalog/general/query/index.ts
 var queryDefinition = {
@@ -2983,16 +3078,378 @@ function buildPathOptions(upstreamNodes) {
   }
   return paths;
 }
+// src/catalog/actions/delay/migrate.ts
+var LEGACY_UNITS = new Set([
+  "milliseconds",
+  "seconds",
+  "minutes",
+  "hours"
+]);
+function migrateDelayConfig(raw) {
+  if (raw && typeof raw === "object" && "mode" in raw) {
+    return raw;
+  }
+  const legacy = raw ?? {};
+  const duration = typeof legacy.duration === "number" && Number.isFinite(legacy.duration) ? legacy.duration : 1;
+  const unit = typeof legacy.unit === "string" && LEGACY_UNITS.has(legacy.unit) ? legacy.unit : "milliseconds";
+  return {
+    mode: "fixed",
+    fixed: { duration, unit }
+  };
+}
+// src/catalog/communication/email-send/config.ts
+var EmailConfig = {
+  defaults: {
+    connection: "",
+    operation: "send",
+    to: "",
+    cc: "",
+    bcc: "",
+    subject: "",
+    body: "",
+    isHtml: false,
+    attachments: [],
+    folder: "Inbox",
+    query: "",
+    limit: 10
+  },
+  schema: {
+    connection: { type: "connection", required: true },
+    operation: { type: "select", required: true },
+    to: { type: "string", required: false },
+    cc: { type: "string", required: false },
+    bcc: { type: "string", required: false },
+    subject: { type: "string", required: false },
+    body: { type: "string", required: false },
+    isHtml: { type: "boolean", required: false },
+    attachments: { type: "array", required: false },
+    folder: { type: "string", required: false },
+    query: { type: "string", required: false },
+    limit: { type: "number", required: false }
+  },
+  validate: (config) => {
+    const errors = [];
+    if (!config.connection)
+      errors.push("Email service connection is required");
+    if (!config.operation)
+      errors.push("Operation is required");
+    if (config.operation === "send") {
+      if (!config.to)
+        errors.push("Recipient email is required for send operation");
+      if (!config.subject)
+        errors.push("Subject is required for send operation");
+      if (!config.body)
+        errors.push("Body is required for send operation");
+    } else if (config.operation) {
+      errors.push("Only Send is available for the Email action right now");
+    }
+    return { valid: errors.length === 0, errors };
+  },
+  merge: (userConfig) => {
+    return { ...EmailConfig.defaults, ...userConfig };
+  },
+  getLabel: (config) => {
+    switch (config.operation) {
+      case "send":
+        return `Email: Send to ${config.to}`;
+      case "read":
+        return `Email: Read from ${config.folder}`;
+      case "search":
+        return `Email: Search "${config.query}"`;
+      case "delete":
+        return `Email: Delete from ${config.folder}`;
+      case "move":
+        return `Email: Move to ${config.folder}`;
+      case "mark_read":
+        return `Email: Mark as read`;
+      default:
+        return `Email: ${config.operation}`;
+    }
+  }
+};
+// src/catalog/general/transform/config.ts
+var TRANSFORM_OPERATIONS = [
+  { id: "upsert", label: "Upsert" },
+  { id: "insert", label: "Insert" },
+  { id: "update", label: "Update" },
+  { id: "delete", label: "Delete" }
+];
+var DATABASE_CONNECTOR_IDS = new Set(["mongodb", "postgresql", "mysql", "sqlite", "google_sheets"]);
+var TransformConfig = {
+  defaults: {
+    name: "Transform",
+    operation: "upsert",
+    connectorId: "",
+    database: "",
+    objectName: "",
+    mode: "visual",
+    mappings: [],
+    expression: "",
+    fieldDefaults: {},
+    upsertMatchKey: "",
+    sheetHeaders: [],
+    createTabIfMissing: true,
+    writeHeaderRow: true,
+    clearBeforeWrite: false,
+    sheetCustomLayout: false,
+    sheetHeaderRow: 1,
+    sheetColumns: ""
+  },
+  schema: {
+    operation: { type: "select", required: true },
+    connectorId: { type: "connection", required: true },
+    database: { type: "text", required: false },
+    objectName: { type: "select", required: true },
+    mode: { type: "select", required: true },
+    mappings: { type: "array", required: false },
+    expression: { type: "code", required: false }
+  },
+  generateName: (operation, connectorLabel, objectName) => {
+    const opLabel = TRANSFORM_OPERATIONS.find((o) => o.id === operation)?.label || "Transform";
+    const target = connectorLabel || "Target";
+    const obj = objectName || "Object";
+    return `${opLabel} → ${target} · ${obj}`;
+  },
+  validate: (config) => {
+    const errors = [];
+    if (!config.operation) {
+      errors.push("Operation is required");
+    }
+    if (!config.connectorId) {
+      errors.push("Target connector is required");
+    }
+    if (!config.objectName) {
+      errors.push("Object (table) is required");
+    }
+    const isLegacyExpression = config.mode === "expression" && !!config.expression?.trim();
+    if (!isLegacyExpression) {
+      if (!config.mappings || config.mappings.length === 0) {
+        errors.push("At least one field mapping is required");
+      } else {
+        config.mappings.forEach((mapping, index) => {
+          if (!mapping.sourceField) {
+            errors.push(`Mapping ${index + 1}: Source field is required`);
+          }
+          if (!mapping.targetField) {
+            errors.push(`Mapping ${index + 1}: Target field is required`);
+          }
+        });
+      }
+    }
+    return { valid: errors.length === 0, errors };
+  },
+  merge: (userConfig) => {
+    return { ...TransformConfig.defaults, ...userConfig };
+  },
+  getLabel: (config) => {
+    const count = config.mappings?.length ?? 0;
+    return `${config.name || "Transform"} (${count} field${count !== 1 ? "s" : ""})`;
+  },
+  createMappingId: () => {
+    return `map_${Date.now()}_${randomSuffix(5)}`;
+  }
+};
+// src/catalog/storage/storageCapabilities.ts
+var contentTypeField = {
+  key: "contentType",
+  label: "Content type",
+  type: "string",
+  placeholder: "application/octet-stream",
+  advanced: true,
+  hint: "MIME type for the uploaded file."
+};
+var STORAGE_PROVIDERS = {
+  aws_s3: {
+    connectorId: "aws_s3",
+    label: "Amazon S3",
+    browse: true,
+    operations: [
+      { value: "list", label: "List files", path: { key: "prefix", label: "Folder", selectMode: "folder" }, fields: [{ key: "maxKeys", label: "Max results", type: "number", defaultValue: 100, advanced: true }] },
+      { value: "download", label: "Download file", path: { key: "key", label: "File", selectMode: "both", required: true } },
+      { value: "upload", label: "Upload file", path: { key: "key", label: "Destination key", selectMode: "both", required: true }, content: true, fields: [contentTypeField] },
+      { value: "delete", label: "Delete file", path: { key: "key", label: "File", selectMode: "both", required: true } },
+      { value: "copy", label: "Copy file", path: { key: "key", label: "Source file", selectMode: "both", required: true }, dest: { key: "destKey", label: "Destination key", selectMode: "both", required: true } },
+      { value: "move", label: "Move / rename", path: { key: "key", label: "Source file", selectMode: "both", required: true }, dest: { key: "destKey", label: "Destination key", selectMode: "both", required: true } },
+      { value: "presign", label: "Get signed URL", path: { key: "key", label: "File", selectMode: "both", required: true }, fields: [{ key: "expiresIn", label: "Expiry (seconds)", type: "number", defaultValue: 3600, advanced: true }] }
+    ]
+  },
+  ftp_sftp: {
+    connectorId: "ftp_sftp",
+    label: "FTP / SFTP",
+    browse: true,
+    operations: [
+      { value: "list", label: "List files", path: { key: "remotePath", label: "Folder", selectMode: "folder" } },
+      { value: "download", label: "Download file", path: { key: "remotePath", label: "File", selectMode: "both", required: true } },
+      { value: "upload", label: "Upload file", path: { key: "remotePath", label: "Destination path", selectMode: "both", required: true }, content: true },
+      { value: "delete", label: "Delete file", path: { key: "remotePath", label: "File", selectMode: "both", required: true } },
+      { value: "move", label: "Move / rename", path: { key: "remotePath", label: "Source file", selectMode: "both", required: true }, dest: { key: "destPath", label: "Destination path", selectMode: "both", required: true } }
+    ]
+  },
+  dropbox: {
+    connectorId: "dropbox",
+    label: "Dropbox",
+    browse: true,
+    operations: [
+      { value: "list", label: "List files", path: { key: "path", label: "Folder", selectMode: "folder" } },
+      { value: "download", label: "Download file", path: { key: "path", label: "File", selectMode: "both", required: true } },
+      { value: "upload", label: "Upload file", path: { key: "path", label: "Destination path", selectMode: "both", required: true }, content: true, fields: [{ key: "mode", label: "Write mode", type: "select", options: [{ label: "Overwrite", value: "overwrite" }, { label: "Add (keep both)", value: "add" }], defaultValue: "overwrite", advanced: true }] },
+      { value: "delete", label: "Delete file", path: { key: "path", label: "File", selectMode: "both", required: true } },
+      { value: "copy", label: "Copy file", path: { key: "path", label: "Source file", selectMode: "both", required: true }, dest: { key: "destPath", label: "Destination path", selectMode: "both", required: true } },
+      { value: "move", label: "Move / rename", path: { key: "path", label: "Source file", selectMode: "both", required: true }, dest: { key: "destPath", label: "Destination path", selectMode: "both", required: true } }
+    ]
+  },
+  onedrive: {
+    connectorId: "onedrive",
+    label: "OneDrive",
+    browse: true,
+    operations: [
+      { value: "list", label: "List files", path: { key: "path", label: "Folder", selectMode: "folder" } },
+      { value: "download", label: "Download file", path: { key: "path", label: "File", selectMode: "both", required: true } },
+      { value: "upload", label: "Upload file", path: { key: "path", label: "Destination path", selectMode: "both", required: true }, content: true, fields: [contentTypeField] },
+      { value: "delete", label: "Delete file", path: { key: "path", label: "File", selectMode: "both", required: true } },
+      { value: "copy", label: "Copy file", path: { key: "path", label: "Source file", selectMode: "both", required: true }, dest: { key: "destPath", label: "Destination path", selectMode: "both", required: true } },
+      { value: "move", label: "Move / rename", path: { key: "path", label: "Source file", selectMode: "both", required: true }, dest: { key: "destPath", label: "Destination path", selectMode: "both", required: true } }
+    ]
+  },
+  google_drive: {
+    connectorId: "google_drive",
+    label: "Google Drive",
+    browse: true,
+    operations: [
+      { value: "list", label: "List files", path: { key: "folderId", label: "Folder", selectMode: "folder" }, fields: [{ key: "query", label: "Search query", type: "string", advanced: true }, { key: "pageSize", label: "Max results", type: "number", defaultValue: 50, advanced: true }] },
+      { value: "download", label: "Download file", path: { key: "fileId", label: "File", selectMode: "both", required: true } },
+      { value: "upload", label: "Upload file", path: { key: "folderId", label: "Destination folder", selectMode: "both" }, content: true, fields: [{ key: "fileName", label: "File name", type: "string", required: true }, { key: "mimeType", label: "Content type", type: "string", advanced: true }] },
+      { value: "delete", label: "Delete file", path: { key: "fileId", label: "File", selectMode: "both", required: true } },
+      { value: "move", label: "Move", path: { key: "fileId", label: "File", selectMode: "both", required: true }, dest: { key: "destFolderId", label: "Destination folder", selectMode: "both", required: true } },
+      { value: "copy", label: "Copy", path: { key: "fileId", label: "File", selectMode: "both", required: true }, dest: { key: "destFolderId", label: "Destination folder", selectMode: "both" }, fields: [{ key: "fileName", label: "New name", type: "string" }] },
+      { value: "share", label: "Share", path: { key: "fileId", label: "File", selectMode: "both", required: true }, fields: [{ key: "shareEmail", label: "Share with (email)", type: "string", required: true }, { key: "shareRole", label: "Role", type: "select", options: [{ label: "Viewer", value: "reader" }, { label: "Editor", value: "writer" }], defaultValue: "reader" }] },
+      { value: "create_folder", label: "Create folder", path: { key: "folderId", label: "Parent folder", selectMode: "both" }, fields: [{ key: "fileName", label: "Folder name", type: "string", required: true }] }
+    ]
+  },
+  gcs: {
+    connectorId: "gcs",
+    label: "Google Cloud Storage",
+    browse: true,
+    operations: [
+      { value: "list", label: "List files", path: { key: "prefix", label: "Folder", selectMode: "folder" }, fields: [{ key: "maxKeys", label: "Max results", type: "number", defaultValue: 100, advanced: true }] },
+      { value: "download", label: "Download file", path: { key: "key", label: "File", selectMode: "both", required: true } },
+      { value: "upload", label: "Upload file", path: { key: "key", label: "Destination key", selectMode: "both", required: true }, content: true, fields: [contentTypeField] },
+      { value: "delete", label: "Delete file", path: { key: "key", label: "File", selectMode: "both", required: true } },
+      { value: "copy", label: "Copy file", path: { key: "key", label: "Source file", selectMode: "both", required: true }, dest: { key: "destKey", label: "Destination key", selectMode: "both", required: true } },
+      { value: "move", label: "Move / rename", path: { key: "key", label: "Source file", selectMode: "both", required: true }, dest: { key: "destKey", label: "Destination key", selectMode: "both", required: true } },
+      { value: "presign", label: "Get signed URL", path: { key: "key", label: "File", selectMode: "both", required: true }, fields: [{ key: "expiresIn", label: "Expiry (seconds)", type: "number", defaultValue: 3600, advanced: true }] }
+    ]
+  },
+  azure_blob: {
+    connectorId: "azure_blob",
+    label: "Azure Blob Storage",
+    browse: true,
+    operations: [
+      { value: "list", label: "List files", path: { key: "prefix", label: "Folder", selectMode: "folder" }, fields: [{ key: "maxKeys", label: "Max results", type: "number", defaultValue: 100, advanced: true }] },
+      { value: "download", label: "Download file", path: { key: "blob", label: "File", selectMode: "both", required: true } },
+      { value: "upload", label: "Upload file", path: { key: "blob", label: "Destination blob", selectMode: "both", required: true }, content: true, fields: [contentTypeField] },
+      { value: "delete", label: "Delete file", path: { key: "blob", label: "File", selectMode: "both", required: true } },
+      { value: "copy", label: "Copy file", path: { key: "blob", label: "Source blob", selectMode: "both", required: true }, dest: { key: "destBlob", label: "Destination blob", selectMode: "both", required: true } },
+      { value: "move", label: "Move / rename", path: { key: "blob", label: "Source blob", selectMode: "both", required: true }, dest: { key: "destBlob", label: "Destination blob", selectMode: "both", required: true } },
+      { value: "presign", label: "Get signed URL", path: { key: "blob", label: "File", selectMode: "both", required: true }, fields: [{ key: "expiresIn", label: "Expiry (seconds)", type: "number", defaultValue: 3600, advanced: true }] }
+    ]
+  }
+};
+STORAGE_PROVIDERS.google_sheets = { ...STORAGE_PROVIDERS.google_drive, connectorId: "google_sheets" };
+var transferOp = {
+  value: "transfer",
+  label: "Transfer to another connector",
+  path: { key: "path", label: "Source file or folder", selectMode: "both", required: true }
+};
+for (const id of ["aws_s3", "ftp_sftp", "dropbox", "onedrive", "google_drive", "gcs", "azure_blob"]) {
+  STORAGE_PROVIDERS[id].operations.push(transferOp);
+}
+var syncOp = {
+  value: "sync",
+  label: "Sync folder to another connector",
+  path: { key: "path", label: "Source folder", selectMode: "both", required: true },
+  fields: [
+    {
+      key: "ifExists",
+      label: "If a file already exists",
+      type: "select",
+      options: [
+        { label: "Overwrite", value: "overwrite" },
+        { label: "Skip it", value: "skip" },
+        { label: "Keep both (rename)", value: "rename" }
+      ],
+      defaultValue: "overwrite",
+      hint: "What to do when the destination already has the file."
+    },
+    {
+      key: "onError",
+      label: "On file error",
+      type: "select",
+      options: [
+        { label: "Stop the sync", value: "abort" },
+        { label: "Skip the file & continue", value: "skip" }
+      ],
+      defaultValue: "abort",
+      hint: "A bad file (timeout, lock, permission) stops the whole sync, or is skipped."
+    }
+  ]
+};
+for (const id of ["aws_s3", "ftp_sftp", "dropbox", "onedrive", "google_drive", "gcs", "azure_blob"]) {
+  STORAGE_PROVIDERS[id].operations.push(syncOp);
+}
+var STORAGE_CONNECTOR_IDS = Object.keys(STORAGE_PROVIDERS).filter((id) => id !== "google_sheets");
+function getStorageProvider(connectorId) {
+  if (!connectorId)
+    return;
+  return STORAGE_PROVIDERS[connectorId] ?? STORAGE_PROVIDERS[connectorId.replace(/-/g, "_")];
+}
+function storageConfigKeys() {
+  const keys = new Set([
+    "operation",
+    "connector",
+    "content",
+    "outputAs",
+    "path",
+    "destPath",
+    "destConnector",
+    "sourceIsDirectory",
+    "cursor",
+    "fileBudget",
+    "timeBudgetMs"
+  ]);
+  for (const provider of Object.values(STORAGE_PROVIDERS)) {
+    for (const op of provider.operations) {
+      if (op.path)
+        keys.add(op.path.key);
+      if (op.dest)
+        keys.add(op.dest.key);
+      for (const f of op.fields ?? [])
+        keys.add(f.key);
+    }
+  }
+  return [...keys];
+}
 export {
   ActionCategory,
   ActionStatus,
   ActionType,
+  AggregateFunction,
   CONDITION_OPERATORS,
+  DATABASE_CONNECTOR_IDS,
+  EmailConfig,
   FieldType,
+  JoinType,
+  LogicalOperator,
+  ManualTriggerConfig,
+  STORAGE_CONNECTOR_IDS,
+  SortDirection,
+  TRANSFORM_OPERATIONS,
+  TransformConfig,
   actionsRegistry,
   buildPathOptions,
   collectArrayPaths,
   collectArrayPathsFromSample,
+  emailDefinition,
   generateEdgeId,
   generateStepId,
   generateUUIDv4,
@@ -3003,7 +3460,12 @@ export {
   getEdgeValidationStatus,
   getNodeConfigStatus,
   getNodeValidationStatus,
+  getStorageProvider,
   inferSchemaFromSample,
+  isQueryableConnector,
+  migrateDelayConfig,
+  queryDefinition,
+  storageConfigKeys,
   validateEdge,
   validateNode,
   validateWorkflow

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@octaviaflow/flow-rules",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "The flow action catalog and the rules engine behind Flow Doctor — one definition of what a step accepts and what makes a flow valid, shared by the editor and the server",
   "type": "module",
   "main": "./dist/index.js",