@prismatic-io/components-imap 0.0.0-stage → 0.0.1

package/npm-dist/index.d.cts

@@ -0,0 +1,632 @@
+//#region npm-dist/.entry.d.ts
+declare const _default: import("@prismatic-io/spectral").CallableComponent<{
+  key: "imap";
+  public: true;
+  documentationUrl: "https://prismatic.io/docs/components/imap/";
+  display: {
+    category: "Application Connectors";
+    label: string;
+    description: string;
+    iconPath: string;
+  };
+  hooks: {
+    error: (error: unknown) => unknown;
+  };
+  actions: {
+    listMailboxes: import("@prismatic-io/spectral").ActionDefinition<{
+      connection: {
+        label: string;
+        type: "connection";
+        required: true;
+        comments: string;
+      };
+    }, import("@prismatic-io/spectral").ConfigVarResultCollection, boolean, {
+      data: ({
+        path: string;
+        flags: Set<string>;
+        delimiter: string;
+        listed: boolean;
+        name: string;
+        subscribed: boolean;
+        specialUse?: undefined;
+      } | {
+        path: string;
+        flags: Set<string>;
+        delimiter: string;
+        listed: boolean;
+        specialUse: string;
+        name: string;
+        subscribed: boolean;
+      })[];
+    }>;
+    getStatus: import("@prismatic-io/spectral").ActionDefinition<{
+      connection: {
+        label: string;
+        type: "connection";
+        required: true;
+        comments: string;
+      };
+      mailbox: {
+        label: string;
+        type: "string";
+        required: true;
+        comments: string;
+        example: string;
+        placeholder: string;
+        clean: (value: unknown, defaultValue?: string) => string;
+      };
+    }, import("@prismatic-io/spectral").ConfigVarResultCollection, boolean, {
+      data: any;
+    }>;
+    addFlags: import("@prismatic-io/spectral").ActionDefinition<{
+      connection: {
+        label: string;
+        type: "connection";
+        required: true;
+        comments: string;
+      };
+      mailbox: {
+        label: string;
+        type: "string";
+        required: true;
+        comments: string;
+        example: string;
+        placeholder: string;
+        clean: (value: unknown, defaultValue?: string) => string;
+      };
+      range: {
+        label: string;
+        type: "string";
+        required: true;
+        comments: string;
+        example: string;
+        placeholder: string;
+        clean: (value: unknown, defaultValue?: string) => string;
+      };
+      flags: {
+        label: string;
+        type: "string";
+        required: true;
+        collection: "valuelist";
+        comments: string;
+        example: string;
+        placeholder: string;
+        clean: (value: unknown) => string[];
+      };
+    }, import("@prismatic-io/spectral").ConfigVarResultCollection, boolean, {
+      data: boolean;
+    }>;
+    appendMessage: import("@prismatic-io/spectral").ActionDefinition<{
+      connection: {
+        label: string;
+        type: "connection";
+        required: true;
+        comments: string;
+      };
+      mailbox: {
+        label: string;
+        type: "string";
+        required: true;
+        comments: string;
+        example: string;
+        placeholder: string;
+        clean: (value: unknown, defaultValue?: string) => string;
+      };
+      path: {
+        label: string;
+        type: "string";
+        required: true;
+        comments: string;
+        example: string;
+        placeholder: string;
+        clean: (value: unknown, defaultValue?: string) => string;
+      };
+      content: {
+        label: string;
+        type: "string";
+        required: true;
+        comments: string;
+        example: string;
+        placeholder: string;
+        clean: (value: unknown, defaultValue?: string) => string;
+      };
+    }, import("@prismatic-io/spectral").ConfigVarResultCollection, boolean, {
+      data: any;
+    }>;
+    copyMessage: import("@prismatic-io/spectral").ActionDefinition<{
+      connection: {
+        label: string;
+        type: "connection";
+        required: true;
+        comments: string;
+      };
+      mailbox: {
+        label: string;
+        type: "string";
+        required: true;
+        comments: string;
+        example: string;
+        placeholder: string;
+        clean: (value: unknown, defaultValue?: string) => string;
+      };
+      range: {
+        label: string;
+        type: "string";
+        required: true;
+        comments: string;
+        example: string;
+        placeholder: string;
+        clean: (value: unknown, defaultValue?: string) => string;
+      };
+      path: {
+        label: string;
+        type: "string";
+        required: true;
+        comments: string;
+        example: string;
+        placeholder: string;
+        clean: (value: unknown, defaultValue?: string) => string;
+      };
+    }, import("@prismatic-io/spectral").ConfigVarResultCollection, boolean, {
+      data: {
+        uidValidity: string | undefined;
+        path: string;
+        destination: string;
+        uidMap?: Map<number, number>;
+      };
+    }>;
+    createMailbox: import("@prismatic-io/spectral").ActionDefinition<{
+      connection: {
+        label: string;
+        type: "connection";
+        required: true;
+        comments: string;
+      };
+      path: {
+        label: string;
+        type: "string";
+        required: true;
+        comments: string;
+        example: string;
+        placeholder: string;
+        clean: (value: unknown, defaultValue?: string) => string;
+      };
+    }, import("@prismatic-io/spectral").ConfigVarResultCollection, boolean, {
+      data: {
+        path: string;
+        created: boolean;
+      };
+    }>;
+    deleteMessage: import("@prismatic-io/spectral").ActionDefinition<{
+      connection: {
+        label: string;
+        type: "connection";
+        required: true;
+        comments: string;
+      };
+      mailbox: {
+        label: string;
+        type: "string";
+        required: true;
+        comments: string;
+        example: string;
+        placeholder: string;
+        clean: (value: unknown, defaultValue?: string) => string;
+      };
+      messageIndex: {
+        label: string;
+        type: "string";
+        required: true;
+        example: string;
+        comments: string;
+        placeholder: string;
+        clean: (value: unknown, defaultValue?: string) => string;
+      };
+    }, import("@prismatic-io/spectral").ConfigVarResultCollection, boolean, {
+      data: boolean;
+    }>;
+    downloadMessage: import("@prismatic-io/spectral").ActionDefinition<{
+      connection: {
+        label: string;
+        type: "connection";
+        required: true;
+        comments: string;
+      };
+      mailbox: {
+        label: string;
+        type: "string";
+        required: true;
+        comments: string;
+        example: string;
+        placeholder: string;
+        clean: (value: unknown, defaultValue?: string) => string;
+      };
+      messageIndex: {
+        label: string;
+        comments: string;
+        type: "string";
+        required: true;
+        example: string;
+        placeholder: string;
+        clean: (value: unknown, defaultValue?: string) => string;
+      };
+    }, import("@prismatic-io/spectral").ConfigVarResultCollection, boolean, {
+      data: {
+        meta: {
+          expectedSize: number;
+          contentType: string;
+        };
+        message: {
+          headers: Record<string, unknown>;
+          attachments: {
+            file: {
+              contentType: string;
+              data: Buffer;
+            };
+          }[];
+          attachmentsMetadata: {
+            filename: string | undefined;
+            size: number;
+            checksum: string;
+            headers: unknown;
+            related: boolean;
+          }[];
+          text: string | undefined;
+          html: string | false;
+        };
+      };
+    }>;
+    removeFlags: import("@prismatic-io/spectral").ActionDefinition<{
+      connection: {
+        label: string;
+        type: "connection";
+        required: true;
+        comments: string;
+      };
+      mailbox: {
+        label: string;
+        type: "string";
+        required: true;
+        comments: string;
+        example: string;
+        placeholder: string;
+        clean: (value: unknown, defaultValue?: string) => string;
+      };
+      range: {
+        label: string;
+        type: "string";
+        required: true;
+        comments: string;
+        example: string;
+        placeholder: string;
+        clean: (value: unknown, defaultValue?: string) => string;
+      };
+      flags: {
+        label: string;
+        type: "string";
+        required: true;
+        collection: "valuelist";
+        comments: string;
+        example: string;
+        placeholder: string;
+        clean: (value: unknown) => string[];
+      };
+    }, import("@prismatic-io/spectral").ConfigVarResultCollection, boolean, {
+      data: boolean;
+    }>;
+    renameMailbox: import("@prismatic-io/spectral").ActionDefinition<{
+      connection: {
+        label: string;
+        type: "connection";
+        required: true;
+        comments: string;
+      };
+      path: {
+        label: string;
+        type: "string";
+        required: true;
+        comments: string;
+        example: string;
+        placeholder: string;
+        clean: (value: unknown, defaultValue?: string) => string;
+      };
+      newPath: {
+        label: string;
+        type: "string";
+        required: true;
+        comments: string;
+        example: string;
+        placeholder: string;
+        clean: (value: unknown, defaultValue?: string) => string;
+      };
+    }, import("@prismatic-io/spectral").ConfigVarResultCollection, boolean, {
+      data: import("imapflow").MailboxRenameResponse;
+    }>;
+    searchMailbox: import("@prismatic-io/spectral").ActionDefinition<{
+      connection: {
+        label: string;
+        type: "connection";
+        required: true;
+        comments: string;
+      };
+      mailbox: {
+        label: string;
+        type: "string";
+        required: true;
+        comments: string;
+        example: string;
+        placeholder: string;
+        clean: (value: unknown, defaultValue?: string) => string;
+      };
+      from: {
+        label: string;
+        type: "string";
+        required: false;
+        comments: string;
+        example: string;
+        placeholder: string;
+        clean: (value: unknown, defaultValue?: string) => string;
+      };
+      to: {
+        label: string;
+        type: "string";
+        required: false;
+        comments: string;
+        example: string;
+        placeholder: string;
+        clean: (value: unknown, defaultValue?: string) => string;
+      };
+      readUnread: {
+        label: string;
+        type: "string";
+        required: true;
+        default: string;
+        comments: string;
+        model: {
+          label: string;
+          value: string;
+        }[];
+        clean: (value: unknown, defaultValue?: string) => string;
+      };
+      filterOptions: {
+        label: string;
+        type: "code";
+        language: "json";
+        required: false;
+        comments: string;
+        placeholder: string;
+        example: string;
+        clean: (value: unknown) => object;
+      };
+    }, import("@prismatic-io/spectral").ConfigVarResultCollection, boolean, {
+      data: number[];
+    }>;
+    setFlags: import("@prismatic-io/spectral").ActionDefinition<{
+      connection: {
+        label: string;
+        type: "connection";
+        required: true;
+        comments: string;
+      };
+      mailbox: {
+        label: string;
+        type: "string";
+        required: true;
+        comments: string;
+        example: string;
+        placeholder: string;
+        clean: (value: unknown, defaultValue?: string) => string;
+      };
+      range: {
+        label: string;
+        type: "string";
+        required: true;
+        comments: string;
+        example: string;
+        placeholder: string;
+        clean: (value: unknown, defaultValue?: string) => string;
+      };
+      flags: {
+        label: string;
+        type: "string";
+        required: true;
+        collection: "valuelist";
+        comments: string;
+        example: string;
+        placeholder: string;
+        clean: (value: unknown) => string[];
+      };
+    }, import("@prismatic-io/spectral").ConfigVarResultCollection, boolean, {
+      data: boolean;
+    }>;
+  };
+  triggers: {
+    newEmailsPollingTrigger: import("@prismatic-io/spectral").PollingTriggerDefinition<{
+      connection: {
+        label: string;
+        type: "connection";
+        required: true;
+        comments: string;
+      };
+      mailbox: {
+        label: string;
+        type: "string";
+        required: true;
+        comments: string;
+        example: string;
+        placeholder: string;
+        clean: (value: unknown, defaultValue?: string) => string;
+      };
+      lookBackDate: {
+        label: string;
+        placeholder: string;
+        type: "string";
+        required: false;
+        comments: string;
+        example: string;
+        clean: (value: unknown) => string;
+      };
+      fetchContent: {
+        label: string;
+        type: "boolean";
+        required: false;
+        default: string;
+        comments: string;
+        clean: (value: unknown, defaultValue?: boolean) => boolean;
+      };
+      markAsRead: {
+        label: string;
+        type: "boolean";
+        required: false;
+        default: string;
+        comments: string;
+        clean: (value: unknown, defaultValue?: boolean) => boolean;
+      };
+    }, import("@prismatic-io/spectral").ConfigVarResultCollection, import("@prismatic-io/spectral").TriggerPayload<Record<string, unknown>>, boolean, {
+      payload: {
+        body: {
+          data: Record<string, unknown>[];
+        };
+        headers: {
+          [key: string]: string;
+        };
+        queryParameters: {
+          [key: string]: string;
+        };
+        rawBody: {
+          data: unknown;
+          contentType?: string;
+        };
+        pathFragment: string;
+        webhookUrls: {
+          [key: string]: string;
+        };
+        webhookApiKeys: {
+          [key: string]: string[];
+        };
+        invokeUrl: string;
+        executionId: string;
+        customer: import("@prismatic-io/spectral").CustomerAttributes;
+        instance: import("@prismatic-io/spectral").InstanceAttributes;
+        user: import("@prismatic-io/spectral").UserAttributes;
+        integration: import("@prismatic-io/spectral").IntegrationAttributes;
+        flow: import("@prismatic-io/spectral").FlowAttributes;
+        startedAt: string;
+        globalDebug: boolean;
+        paginationState?: Record<string, unknown> | undefined;
+      };
+      polledNoChanges: boolean;
+    }, import("@prismatic-io/spectral").Inputs>;
+  };
+  dataSources: {
+    listMailboxes: import("@prismatic-io/spectral").DataSourceDefinition<{
+      connection: {
+        label: string;
+        type: "connection";
+        required: true;
+        comments: string;
+      };
+    }, import("@prismatic-io/spectral").ConfigVarResultCollection, "picklist">;
+  };
+  connections: import("@prismatic-io/spectral").KeyedConnection<{
+    key: "imap";
+    display: {
+      label: string;
+      description: string;
+    };
+    inputs: {
+      host: {
+        label: string;
+        placeholder: string;
+        type: "string";
+        required: true;
+        clean: (param: unknown) => string | undefined;
+        shown: true;
+        comments: string;
+        example: string;
+        onPremControlled: true;
+      };
+      port: {
+        label: string;
+        placeholder: string;
+        type: "string";
+        required: true;
+        clean: (param: unknown) => number | undefined;
+        shown: true;
+        comments: string;
+        example: string;
+        default: string;
+        onPremControlled: true;
+      };
+      secure: {
+        label: string;
+        placeholder: string;
+        type: "boolean";
+        clean: (param: unknown) => true | undefined;
+        required: true;
+        shown: true;
+        default: string;
+        comments: string;
+      };
+      user: {
+        label: string;
+        placeholder: string;
+        type: "string";
+        clean: (param: unknown) => string | undefined;
+        required: true;
+        shown: true;
+        comments: string;
+        example: string;
+      };
+      pass: {
+        label: string;
+        placeholder: string;
+        type: "password";
+        required: false;
+        shown: true;
+        clean: (param: unknown) => string | undefined;
+        comments: string;
+        example: string;
+      };
+      minVersion: {
+        label: string;
+        type: "string";
+        required: true;
+        shown: true;
+        clean: (param: unknown) => string | undefined;
+        comments: string;
+        example: string;
+        default: string;
+        model: {
+          label: string;
+          value: string;
+        }[];
+      };
+      maxVersion: {
+        label: string;
+        type: "string";
+        required: true;
+        shown: true;
+        clean: (param: unknown) => string | undefined;
+        comments: string;
+        example: string;
+        default: string;
+        model: {
+          label: string;
+          value: string;
+        }[];
+      };
+      minDHSize: {
+        label: string;
+        type: "string";
+        required: true;
+        shown: true;
+        clean: (param: unknown) => number | undefined;
+        comments: string;
+        example: string;
+        default: string;
+      };
+    };
+  }, "imap">[];
+}>;
+export = _default;

package/package.json

@@ -1,6 +1,56 @@
 {
   "name": "@prismatic-io/components-imap",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.0.1",
+  "main": "./npm-dist/index.cjs",
+  "types": "./npm-dist/index.d.cts",
+  "exports": {
+    ".": {
+      "types": "./npm-dist/index.d.cts",
+      "default": "./npm-dist/index.cjs"
+    }
+  },
+  "description": "Interact with your IMAP email account",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/prismatic-io/components.git",
+    "directory": "components/imap"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "npm-dist",
+    "dist"
+  ],
+  "prismatic": {
+    "component": "./dist/index.js"
+  },
+  "scripts": {
+    "build": "npm run format && npm run lint && tsdown",
+    "typecheck": "tsc --noEmit",
+    "lint": "biome lint --write .",
+    "format": "biome format --write .",
+    "test": "vitest run",
+    "generate:manifest": "npm run build && npx @prismatic-io/spectral component-manifest",
+    "generate:manifest:dev": "npm run build && npx @prismatic-io/spectral component-manifest --skip-signature-verify",
+    "prepare": "npm run build",
+    "publish:platform": "npm run build && prism components:publish"
+  },
+  "peerDependencies": {
+    "@prismatic-io/spectral": "^10.38.5"
+  },
+  "dependencies": {
+    "imapflow": "1.0.120",
+    "mailparser": "3.6.3"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "2.5.1",
+    "@types/imapflow": "^1.0.23",
+    "@types/node": "^26.6.4",
+    "tsdown": "0.22.3",
+    "typescript": "6.0.3",
+    "vitest": "4.1.9",
+    "@prismatic-io/spectral": "^10.38.5"
+  }
+}