@octaviaflow/flow-rules 0.10.0 → 0.11.0

package/dist/catalog/storage/fileEditContract.d.ts

@@ -0,0 +1,127 @@
+/**
+ * What the file-format actions share.
+ *
+ * `csv_action`, `json_action`, `xml_action`, `excel_action` and `file_action`
+ * are one panel family (CsvConfigPanel + FileEditControls in the editor) and
+ * one executor family (`doEditFile` in the Engine). The keys they share when
+ * `operation` is `edit` live here once, so five contracts cannot drift from
+ * each other the way `index.ts` and `config.ts` once did.
+ *
+ * Shapes are what the editor WRITES and the Engine READS today — not what
+ * either could accept. `setFields` is edited as a list of pairs but stored as
+ * an object; `mergeUpdate` is true unless it is exactly `false`.
+ */
+export type FileFormatOperation = 'parse' | 'generate' | 'edit';
+export type FileEditOperation = 'append' | 'update' | 'upsert' | 'set_fields';
+export type FileEditMatchOp = '=' | '!=' | '>' | '<' | '>=' | '<=' | 'contains';
+export type FileEditDestination = 'new' | 'in_place';
+export type FileEditSource = 'inline' | 's3' | 'url';
+export declare const FILE_FORMAT_OPERATIONS: readonly FileFormatOperation[];
+export declare const FILE_EDIT_OPERATIONS: readonly FileEditOperation[];
+export declare const FILE_EDIT_MATCH_OPS: readonly FileEditMatchOp[];
+export declare const FILE_EDIT_DESTINATIONS: readonly FileEditDestination[];
+export declare const FILE_EDIT_SOURCES: readonly FileEditSource[];
+export interface FileEditConfigType {
+    /** `append` (default) | `update` | `upsert` | `set_fields`. */
+    editOperation?: FileEditOperation;
+    /** The column that identifies a row — required by `update` and `upsert`. */
+    keyField?: string;
+    /** `false` replaces the whole matched row; anything else merges into it. */
+    mergeUpdate?: boolean;
+    /** `set_fields`: the column the row filter reads. */
+    matchField?: string;
+    /** `set_fields`: how `matchField` is compared to `matchValue`; `=` by default. */
+    matchOp?: FileEditMatchOp;
+    /** `set_fields`: the value compared against. */
+    matchValue?: string;
+    /** `set_fields`: column → new value, applied to every matching row. */
+    setFields?: Record<string, string>;
+    /** `new` (default) writes an edited copy; `in_place` overwrites an S3 source. */
+    destination?: FileEditDestination;
+    /** Name of the edited copy when `destination` is `new`. */
+    outputFileName?: string;
+    /** Where the file to edit comes from; inferred from `content` when absent. */
+    source?: FileEditSource;
+    /** `source: 's3'` — the platform-bucket key of the file to edit. */
+    s3Key?: string;
+    /** `source: 'url'` — the file to edit is fetched from here. */
+    url?: string;
+}
+/** The shared schema entries, spread into each file-format contract. */
+export declare const FILE_EDIT_SCHEMA: {
+    readonly editOperation: {
+        readonly type: "select";
+        readonly required: false;
+        readonly options: readonly FileEditOperation[];
+        readonly description: "How the file is edited: append rows, update rows by key, upsert, or set fields on matching rows";
+    };
+    readonly keyField: {
+        readonly type: "string";
+        readonly required: false;
+        readonly description: "Match key column for update / upsert";
+    };
+    readonly mergeUpdate: {
+        readonly type: "boolean";
+        readonly required: false;
+        readonly description: "false replaces the whole matched row; default merges";
+    };
+    readonly matchField: {
+        readonly type: "string";
+        readonly required: false;
+        readonly description: "set_fields: column the row filter reads";
+    };
+    readonly matchOp: {
+        readonly type: "select";
+        readonly required: false;
+        readonly options: readonly FileEditMatchOp[];
+        readonly description: "set_fields: comparison; \"=\" by default";
+    };
+    readonly matchValue: {
+        readonly type: "string";
+        readonly required: false;
+        readonly description: "set_fields: value compared against";
+    };
+    readonly setFields: {
+        readonly type: "object";
+        readonly required: false;
+        readonly description: "set_fields: { column: newValue } applied to matching rows";
+    };
+    readonly destination: {
+        readonly type: "select";
+        readonly required: false;
+        readonly options: readonly FileEditDestination[];
+        readonly description: "\"new\" writes an edited copy (default); \"in_place\" overwrites an S3 source";
+    };
+    readonly outputFileName: {
+        readonly type: "string";
+        readonly required: false;
+        readonly description: "Name of the edited copy when destination is \"new\"";
+    };
+    readonly source: {
+        readonly type: "select";
+        readonly required: false;
+        readonly options: readonly FileEditSource[];
+        readonly description: "Where the file to edit comes from; inferred from content when absent";
+    };
+    readonly s3Key: {
+        readonly type: "string";
+        readonly required: false;
+        readonly description: "source \"s3\": platform-bucket key of the file to edit";
+    };
+    readonly url: {
+        readonly type: "url";
+        readonly required: false;
+        readonly description: "source \"url\": the file to edit is fetched from here";
+    };
+};
+/**
+ * The errors the Engine would raise for an edit, said before the run. Only
+ * what blocks execution — the panel enforces nothing else.
+ */
+export declare function fileEditErrors(config: Partial<FileEditConfigType> & {
+    operation?: string;
+}): string[];
+/** `operation` must be one of the three when it is set; absent means `parse`. */
+export declare function fileFormatErrors(config: {
+    operation?: string;
+} & Partial<FileEditConfigType>): string[];

package/dist/catalog/storage/ftp-action/config.d.ts

@@ -0,0 +1,85 @@
+/**
+ * FTP / SFTP Action Configuration (deprecated — `storage_action` replaces it)
+ *
+ * What FtpConfigPanel writes and the Engine's `runFtp` reads. The Backend adds
+ * `_resolvedFtpCredentials` from `connector` at dispatch.
+ */
+export type FtpOperation = 'download' | 'upload' | 'list' | 'delete' | 'move';
+export declare const FTP_OPERATIONS: readonly FtpOperation[];
+export interface FtpActionConfigType {
+    /** The FTP/SFTP connector instance (a connection id). */
+    connector: string;
+    /** `download` when absent. */
+    operation?: FtpOperation;
+    /** File or folder path on the server (`/` for list when absent). */
+    remotePath?: string;
+    /** `upload`: the body. */
+    content?: string;
+    /** `upload`: name when `remotePath` is a folder. */
+    fileName?: string;
+    /** `move`: the new path. */
+    destPath?: string;
+    /** `upload`: `overwrite` (default) or `skip` when the file exists. */
+    ifExists?: 'overwrite' | 'skip';
+    /** `list`: keep only these extensions. */
+    fileTypes?: string[];
+    /** `list`: keep only names matching this glob. */
+    filePattern?: string;
+}
+export declare const FtpActionConfig: {
+    defaults: FtpActionConfigType;
+    schema: {
+        connector: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+        operation: {
+            type: string;
+            required: boolean;
+            options: readonly FtpOperation[];
+        };
+        remotePath: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+        content: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+        fileName: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+        destPath: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+        ifExists: {
+            type: string;
+            required: boolean;
+            options: string[];
+            description: string;
+        };
+        fileTypes: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+        filePattern: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+    };
+    validate: (config: Partial<FtpActionConfigType>) => {
+        valid: boolean;
+        errors: string[];
+    };
+    merge: (userConfig: Partial<FtpActionConfigType>) => FtpActionConfigType;
+    getLabel: (config: FtpActionConfigType) => string;
+};

package/dist/catalog/storage/google-drive-action/config.d.ts

@@ -0,0 +1,135 @@
+/**
+ * Google Drive Action Configuration (deprecated — `storage_action` replaces it)
+ *
+ * What GoogleDriveConfigPanel writes and the Engine's `runGoogleDrive` reads.
+ * The Backend adds `_resolvedStorageCredentials` from `connector` at dispatch.
+ */
+export type GoogleDriveOperation = 'upload' | 'download' | 'list' | 'delete' | 'move' | 'copy' | 'share' | 'create_folder';
+export declare const GOOGLE_DRIVE_OPERATIONS: readonly GoogleDriveOperation[];
+export interface GoogleDriveActionConfigType {
+    /** The Google Drive connector instance (a connection id). */
+    connector: string;
+    /** `upload` when absent. */
+    operation?: GoogleDriveOperation;
+    /** download / delete / move / copy / share: the file. */
+    fileId?: string;
+    /** upload / list / create_folder: the folder (root when empty). */
+    folderId?: string;
+    /** upload: folder path (`a/b/c`) resolved — or created — when `folderId` is empty. */
+    folderName?: string;
+    /** upload: name; copy: the copy's name; create_folder: the folder's name. */
+    fileName?: string;
+    /** upload: the body; pulled from the upstream step when empty. */
+    content?: string;
+    /** upload: MIME type (`application/octet-stream` by default). */
+    mimeType?: string;
+    /** upload: create `folderName` when it does not exist (true unless exactly false). */
+    createFolderIfNotExists?: boolean;
+    /** move / copy: destination folder. */
+    destFolderId?: string;
+    /** share: who. */
+    shareEmail?: string;
+    /** share: `reader` (default) or `writer`. */
+    shareRole?: 'reader' | 'writer';
+    /** list: Drive search query. */
+    query?: string;
+    /** list: page size (50 by default). */
+    pageSize?: number;
+    /** list: keep only these extensions. */
+    fileTypes?: string[];
+    /** list: keep only names matching this glob. */
+    filePattern?: string;
+}
+export declare const GoogleDriveActionConfig: {
+    defaults: GoogleDriveActionConfigType;
+    schema: {
+        connector: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+        operation: {
+            type: string;
+            required: boolean;
+            options: readonly GoogleDriveOperation[];
+        };
+        fileId: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+        folderId: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+        folderName: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+        fileName: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+        content: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+        mimeType: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+        createFolderIfNotExists: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+        destFolderId: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+        shareEmail: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+        shareRole: {
+            type: string;
+            required: boolean;
+            options: string[];
+            description: string;
+        };
+        query: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+        pageSize: {
+            type: string;
+            required: boolean;
+            min: number;
+            description: string;
+        };
+        fileTypes: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+        filePattern: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+    };
+    validate: (config: Partial<GoogleDriveActionConfigType>) => {
+        valid: boolean;
+        errors: string[];
+    };
+    merge: (userConfig: Partial<GoogleDriveActionConfigType>) => GoogleDriveActionConfigType;
+    getLabel: (config: GoogleDriveActionConfigType) => string;
+};

package/dist/catalog/storage/json-action/config.d.ts

@@ -0,0 +1,131 @@
+/**
+ * JSON Action Configuration
+ *
+ * What JsonConfigPanel writes and the Engine's json_action case reads.
+ */
+import { type FileEditConfigType, type FileFormatOperation } from '../fileEditContract';
+export interface JsonActionConfigType extends FileEditConfigType {
+    /** `parse` (default when absent) | `generate` | `edit`. */
+    operation: FileFormatOperation;
+    /** Legacy alias for `operation`. */
+    mode?: string;
+    /** `json` (an array, default) or `jsonl` (one object per line). */
+    format?: 'json' | 'jsonl';
+    /** JSON text, or an FX token from an upstream step. */
+    content?: string;
+    /** Legacy alias for `content`. */
+    inlineContent?: string;
+    /** `generate`: indent the output (true unless exactly false). */
+    prettyPrint?: boolean;
+    /** `generate`: name of the produced file. */
+    fileName?: string;
+    /** `edit`: the Engine's edit path reads this flag, not `format`, to pick JSONL. */
+    jsonl?: boolean;
+}
+export declare const JsonActionConfig: {
+    defaults: JsonActionConfigType;
+    schema: {
+        editOperation: {
+            readonly type: "select";
+            readonly required: false;
+            readonly options: readonly import("../fileEditContract").FileEditOperation[];
+            readonly description: "How the file is edited: append rows, update rows by key, upsert, or set fields on matching rows";
+        };
+        keyField: {
+            readonly type: "string";
+            readonly required: false;
+            readonly description: "Match key column for update / upsert";
+        };
+        mergeUpdate: {
+            readonly type: "boolean";
+            readonly required: false;
+            readonly description: "false replaces the whole matched row; default merges";
+        };
+        matchField: {
+            readonly type: "string";
+            readonly required: false;
+            readonly description: "set_fields: column the row filter reads";
+        };
+        matchOp: {
+            readonly type: "select";
+            readonly required: false;
+            readonly options: readonly import("../fileEditContract").FileEditMatchOp[];
+            readonly description: "set_fields: comparison; \"=\" by default";
+        };
+        matchValue: {
+            readonly type: "string";
+            readonly required: false;
+            readonly description: "set_fields: value compared against";
+        };
+        setFields: {
+            readonly type: "object";
+            readonly required: false;
+            readonly description: "set_fields: { column: newValue } applied to matching rows";
+        };
+        destination: {
+            readonly type: "select";
+            readonly required: false;
+            readonly options: readonly import("../fileEditContract").FileEditDestination[];
+            readonly description: "\"new\" writes an edited copy (default); \"in_place\" overwrites an S3 source";
+        };
+        outputFileName: {
+            readonly type: "string";
+            readonly required: false;
+            readonly description: "Name of the edited copy when destination is \"new\"";
+        };
+        source: {
+            readonly type: "select";
+            readonly required: false;
+            readonly options: readonly import("../fileEditContract").FileEditSource[];
+            readonly description: "Where the file to edit comes from; inferred from content when absent";
+        };
+        s3Key: {
+            readonly type: "string";
+            readonly required: false;
+            readonly description: "source \"s3\": platform-bucket key of the file to edit";
+        };
+        url: {
+            readonly type: "url";
+            readonly required: false;
+            readonly description: "source \"url\": the file to edit is fetched from here";
+        };
+        operation: {
+            type: string;
+            required: boolean;
+            options: readonly FileFormatOperation[];
+            description: string;
+        };
+        format: {
+            type: string;
+            required: boolean;
+            options: string[];
+            description: string;
+        };
+        content: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+        prettyPrint: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+        fileName: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+        jsonl: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+    };
+    validate: (config: Partial<JsonActionConfigType>) => {
+        valid: boolean;
+        errors: string[];
+    };
+    merge: (userConfig: Partial<JsonActionConfigType>) => JsonActionConfigType;
+    getLabel: (config: JsonActionConfigType) => string;
+};

package/dist/catalog/storage/onedrive-action/config.d.ts

@@ -0,0 +1,94 @@
+/**
+ * OneDrive Action Configuration (deprecated — `storage_action` replaces it)
+ *
+ * The editor renders this one from the generic schema form (no custom panel):
+ * a save writes exactly `connector`, `operation`, `path`, `content`,
+ * `fileName`, `destPath` and nothing else. The Engine's `runOneDrive` reads
+ * these plus `contentType`, `fileTypes` and `filePattern`. The Backend adds
+ * `_resolvedStorageCredentials` from `connector` at dispatch.
+ */
+export type OneDriveOperation = 'download' | 'upload' | 'list' | 'delete' | 'move' | 'copy';
+export declare const ONEDRIVE_OPERATIONS: readonly OneDriveOperation[];
+export interface OneDriveActionConfigType {
+    /** The Microsoft / OneDrive connector instance (a connection id). */
+    connector: string;
+    /** `download` when absent. */
+    operation?: OneDriveOperation;
+    /** Path from the drive root (`''` or `/` is the root). */
+    path?: string;
+    /** Item id, as an alternative to `path`. */
+    itemId?: string;
+    /** upload: the body (simple PUT, under 4 MB). */
+    content?: string;
+    /** upload: name when `path` is a folder. */
+    fileName?: string;
+    /** move / copy: full destination path; its last segment is the new name. */
+    destPath?: string;
+    /** upload: MIME type (`application/octet-stream` by default). */
+    contentType?: string;
+    /** list: keep only these extensions. */
+    fileTypes?: string[];
+    /** list: keep only names matching this glob. */
+    filePattern?: string;
+}
+export declare const OneDriveActionConfig: {
+    defaults: OneDriveActionConfigType;
+    schema: {
+        connector: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+        operation: {
+            type: string;
+            required: boolean;
+            options: readonly OneDriveOperation[];
+        };
+        path: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+        itemId: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+        content: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+        fileName: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+        destPath: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+        contentType: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+        fileTypes: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+        filePattern: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+    };
+    validate: (config: Partial<OneDriveActionConfigType>) => {
+        valid: boolean;
+        errors: string[];
+    };
+    merge: (userConfig: Partial<OneDriveActionConfigType>) => OneDriveActionConfigType;
+    getLabel: (config: OneDriveActionConfigType) => string;
+};

package/dist/catalog/storage/s3-action/config.d.ts

@@ -0,0 +1,122 @@
+/**
+ * AWS S3 Action Configuration (deprecated — `storage_action` replaces it)
+ *
+ * Kept so existing steps resolve, edit and validate. What S3ConfigPanel
+ * writes and the Engine's `runS3` reads. The Backend adds
+ * `_resolvedStorageCredentials` from `connector` at dispatch.
+ */
+export type S3Operation = 'list' | 'download' | 'upload' | 'delete' | 'copy' | 'move' | 'presign';
+export declare const S3_OPERATIONS: readonly S3Operation[];
+export interface S3ActionConfigType {
+    /** The S3 connector instance (a connection id). */
+    connector: string;
+    /** `download` when absent. */
+    operation?: S3Operation;
+    /** Overrides the connector's bucket. */
+    bucket?: string;
+    /** Overrides the connector's region. */
+    region?: string;
+    /** Object key (download, upload, delete, copy, move, presign). */
+    key?: string;
+    /** `list`: key prefix. */
+    prefix?: string;
+    /** `upload`: the body. */
+    content?: string;
+    /** `upload`: MIME type (`application/octet-stream` by default). */
+    contentType?: string;
+    /** `copy` / `move`: destination bucket (source bucket by default). */
+    destBucket?: string;
+    /** `copy` / `move`: destination key. */
+    destKey?: string;
+    /** `presign`: URL lifetime in seconds (3600 by default). */
+    expiresIn?: number;
+    /** `list`: page size (100 by default). */
+    maxKeys?: number;
+    /** `list`: keep only these extensions. */
+    fileTypes?: string[];
+    /** `list`: keep only names matching this glob. */
+    filePattern?: string;
+}
+export declare const S3ActionConfig: {
+    defaults: S3ActionConfigType;
+    schema: {
+        connector: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+        operation: {
+            type: string;
+            required: boolean;
+            options: readonly S3Operation[];
+        };
+        bucket: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+        region: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+        key: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+        prefix: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+        content: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+        contentType: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+        destBucket: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+        destKey: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+        expiresIn: {
+            type: string;
+            required: boolean;
+            min: number;
+            description: string;
+        };
+        maxKeys: {
+            type: string;
+            required: boolean;
+            min: number;
+            description: string;
+        };
+        fileTypes: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+        filePattern: {
+            type: string;
+            required: boolean;
+            description: string;
+        };
+    };
+    validate: (config: Partial<S3ActionConfigType>) => {
+        valid: boolean;
+        errors: string[];
+    };
+    merge: (userConfig: Partial<S3ActionConfigType>) => S3ActionConfigType;
+    getLabel: (config: S3ActionConfigType) => string;
+};