flowflex 0.1.0

package/dist/types.d.ts

@@ -0,0 +1,66 @@
+/** Options accepted by the `FlowFlex` constructor. */
+export interface FlowFlexOptions {
+    /** Custom integration API key — starts with `cik_`. */
+    apiKey: string;
+    /** Custom integration API secret. */
+    apiSecret: string;
+    /**
+     * Integration code — the opaque public identifier in your event URL
+     * (`/v1/events/<code>`). Shown on the integration's detail page.
+     */
+    integrationCode: string;
+    /**
+     * FlowFlex host, e.g. `https://app.flowflex.com`. Do NOT include `/api`
+     * or `/v1` — the SDK appends the correct paths.
+     */
+    baseUrl: string;
+    /** Per-request timeout in milliseconds. Default: 30000. */
+    timeoutMs?: number;
+    /**
+     * Custom fetch implementation. Defaults to the global `fetch`
+     * (Node 18+ and all modern browsers). Provide one for older runtimes.
+     */
+    fetch?: typeof fetch;
+    /**
+     * Max attachment size in bytes the SDK will accept before uploading.
+     * Defaults to 25 MB (the backend's limit). Files larger than this fail fast
+     * client-side instead of after a full upload.
+     */
+    maxFileBytes?: number;
+}
+/** Response from the presigned upload-URL endpoint. */
+export interface UploadUrlResponse {
+    assetId: string;
+    uploadUrl: string;
+    token: string;
+}
+/** Options for a single file attachment. */
+export interface FileOptions {
+    /**
+     * Filename stored alongside the asset and used as the WhatsApp document
+     * filename. Required when the source is a Buffer/Blob with no inherent name.
+     */
+    filename?: string;
+    /**
+     * MIME type, e.g. `application/pdf`. Required when it cannot be inferred
+     * from the filename extension.
+     */
+    mime?: string;
+    /** Optional size in bytes — sent for server-side validation only. */
+    size?: number;
+}
+/** Options for `sendEvent`. */
+export interface SendEventOptions {
+    /**
+     * Idempotency key — dedupes retries on the backend. A random UUID is
+     * generated if omitted.
+     */
+    idempotencyKey?: string;
+}
+/** Result returned by `sendEvent`. */
+export interface SendEventResult {
+    /** Raw response body from the events endpoint. */
+    response: unknown;
+    /** Map of payload paths → assetId, for every file that was uploaded. */
+    uploadedAssets: Record<string, string>;
+}

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "flowflex",
+  "version": "0.1.0",
+  "description": "Official FlowFlex SDK — fire custom-integration events and attach private files without handling presigned URLs yourself.",
+  "license": "UNLICENSED",
+  "main": "./dist/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "browser": {
+        "import": "./dist/esm/browser.js",
+        "require": "./dist/browser.js"
+      },
+      "import": "./dist/esm/index.js",
+      "require": "./dist/index.js"
+    }
+  },
+  "browser": {
+    "./dist/index.js": "./dist/browser.js",
+    "./dist/esm/index.js": "./dist/esm/browser.js"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json && tsc -p tsconfig.esm.json && node -e \"require('fs').writeFileSync('dist/esm/package.json','{\\\"type\\\":\\\"module\\\"}')\"",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "npm run clean && npm run build"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "keywords": [
+    "flowflex",
+    "whatsapp",
+    "automation",
+    "flows",
+    "sdk"
+  ],
+  "devDependencies": {
+    "typescript": "^5.4.0",
+    "@types/node": "^20.0.0"
+  }
+}