dragdropdo-sdk 1.0.0

package/dist/src/index.js

@@ -0,0 +1,29 @@
+"use strict";
+/**
+ * DragDropDo SDK - Node.js Client Library
+ *
+ * Official Node.js client for the dragdropdo.com Business API
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = exports.Dragdropdo = void 0;
+var client_1 = require("./client");
+Object.defineProperty(exports, "Dragdropdo", { enumerable: true, get: function () { return client_1.Dragdropdo; } });
+__exportStar(require("./types"), exports);
+__exportStar(require("./errors"), exports);
+// Default export
+var client_2 = require("./client");
+Object.defineProperty(exports, "default", { enumerable: true, get: function () { return client_2.Dragdropdo; } });

package/dist/src/types.d.ts

@@ -0,0 +1,143 @@
+/**
+ * Type definitions for dragdropdo.com Business API Client
+ */
+export interface DragdropdoConfig {
+    /** API key for authentication */
+    apiKey: string;
+    /** Base URL of the D3 API (e.g., 'https://api-dev.dragdropdo.com') */
+    baseURL?: string;
+    /** Request timeout in milliseconds (default: 30000) */
+    timeout?: number;
+    /** Custom headers to include in all requests */
+    headers?: Record<string, string>;
+}
+export interface UploadFileOptions {
+    /** File path (absolute or relative) */
+    file: string;
+    /** Original file name */
+    fileName: string;
+    /** MIME type of the file */
+    mimeType?: string;
+    /** Number of parts for multipart upload (default: calculated automatically) */
+    parts?: number;
+    /** Optional progress callback */
+    onProgress?: (progress: UploadProgress) => void;
+}
+export interface UploadProgress {
+    /** Current part being uploaded (1-indexed) */
+    currentPart: number;
+    /** Total number of parts */
+    totalParts: number;
+    /** Bytes uploaded so far */
+    bytesUploaded: number;
+    /** Total file size in bytes */
+    totalBytes: number;
+    /** Upload percentage (0-100) */
+    percentage: number;
+}
+export interface UploadResponse {
+    /** File key for use in operations (snake_case from API) */
+    file_key: string;
+    /** Upload ID for completing the upload (snake_case from API) */
+    upload_id: string;
+    /** Presigned URLs for multipart upload (snake_case from API) */
+    presigned_urls: string[];
+    /** Object name returned by the API (snake_case from API) */
+    object_name?: string;
+    /** File key for use in operations (camelCase alias) */
+    fileKey: string;
+    /** Upload ID for completing the upload (camelCase alias) */
+    uploadId: string;
+    /** Presigned URLs for multipart upload (camelCase alias) */
+    presignedUrls: string[];
+    /** Object name returned by the API (camelCase alias) */
+    objectName?: string;
+}
+export interface SupportedOperationOptions {
+    /** File extension (e.g., 'pdf', 'jpg') */
+    ext: string;
+    /** Optional action to check (e.g., 'convert', 'compress') */
+    action?: string;
+    /** Optional parameters for validation (e.g., { convert_to: 'png' }) */
+    parameters?: Record<string, any>;
+}
+export interface SupportedOperationResponse {
+    /** Whether the operation is supported */
+    supported: boolean;
+    /** Normalized extension */
+    ext: string;
+    /** Action name (if provided) */
+    action?: string;
+    /** Available actions for this extension */
+    availableActions?: string[];
+    /** Action-specific parameters (e.g., available convert_to targets) */
+    parameters?: Record<string, any>;
+}
+export interface OperationOptions {
+    /** Action to perform: 'convert', 'compress', 'merge', 'zip', 'share', 'lock', 'unlock', 'reset_password' */
+    action: "convert" | "compress" | "merge" | "zip" | "create_zip" | "share" | "lock" | "unlock" | "reset_password";
+    /** Array of file keys from upload */
+    fileKeys: string[];
+    /** Action-specific parameters */
+    parameters?: OperationParameters;
+    /** Optional user metadata */
+    notes?: Record<string, string>;
+}
+export interface OperationParameters {
+    /** For convert: target format (e.g., 'pdf', 'png') */
+    convert_to?: string;
+    /** For compress: compression level (e.g., 'recommended', 'high', 'low') */
+    compression_value?: string;
+    /** For lock/unlock/reset_password: password */
+    password?: string;
+    /** For reset_password: old password */
+    old_password?: string;
+    /** For reset_password: new password */
+    new_password?: string;
+}
+export interface OperationResponse {
+    /** Main task ID for tracking the operation */
+    mainTaskId: string;
+}
+export interface StatusOptions {
+    /** Main task ID */
+    mainTaskId: string;
+    /** Optional file task ID for specific file status */
+    fileTaskId?: string;
+}
+export interface FileTaskStatus {
+    /** File key */
+    fileKey: string;
+    /** Status: 'queued' | 'running' | 'completed' | 'failed' */
+    status: "queued" | "running" | "completed" | "failed";
+    /** Download link (when completed) */
+    downloadLink?: string;
+    /** Error code (when failed) */
+    errorCode?: string;
+    /** Error message (when failed) */
+    errorMessage?: string;
+}
+export interface StatusResponse {
+    /** Overall operation status */
+    operationStatus: "queued" | "running" | "completed" | "failed";
+    /** Array of file task statuses */
+    filesData: FileTaskStatus[];
+}
+export interface PollStatusOptions extends StatusOptions {
+    /** Polling interval in milliseconds (default: 2000) */
+    interval?: number;
+    /** Maximum polling duration in milliseconds (default: 300000 = 5 minutes) */
+    timeout?: number;
+    /** Callback for each status update */
+    onUpdate?: (status: StatusResponse) => void;
+}
+export interface D3Error extends Error {
+    /** HTTP status code */
+    statusCode?: number;
+    /** Error code from API */
+    code?: number;
+    /** Error message */
+    message: string;
+    /** Additional error details */
+    details?: any;
+}

package/dist/src/types.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * Type definitions for dragdropdo.com Business API Client
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/tests/client.e2e.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/client.e2e.test.js

@@ -0,0 +1,167 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const nock_1 = __importDefault(require("nock"));
+const src_1 = require("../src");
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const os = __importStar(require("os"));
+const API_BASE = "https://api-dev.dragdropdo.com";
+describe("Dragdropdo end-to-end (mocked HTTP)", () => {
+    beforeAll(() => {
+        nock_1.default.disableNetConnect();
+    });
+    afterAll(() => {
+        nock_1.default.enableNetConnect();
+    });
+    afterEach(() => {
+        if (!nock_1.default.isDone()) {
+            const pending = nock_1.default.pendingMocks();
+            nock_1.default.cleanAll();
+            throw new Error(`Not all HTTP mocks were satisfied: ${pending.join(", ")}`);
+        }
+        nock_1.default.cleanAll();
+    });
+    test("uploads a file (path) with multipart flow", async () => {
+        const client = new src_1.Dragdropdo({ apiKey: "test-key", baseURL: API_BASE });
+        const tmpFile = path.join(os.tmpdir(), `d3-test-${Date.now()}.pdf`);
+        const sixMbContent = "a".repeat(6 * 1024 * 1024);
+        fs.writeFileSync(tmpFile, sixMbContent);
+        const cleanup = () => {
+            if (fs.existsSync(tmpFile)) {
+                fs.unlinkSync(tmpFile);
+            }
+        };
+        (0, nock_1.default)(API_BASE)
+            .post("/v1/external/upload", (body) => {
+            return (body.file_name === "test.pdf" &&
+                body.size === 6 * 1024 * 1024 &&
+                body.mime_type === "application/pdf" &&
+                body.parts === 2);
+        })
+            .reply(200, {
+            data: {
+                file_key: "file-key-123",
+                upload_id: "upload-id-456",
+                presigned_urls: [
+                    "https://upload.d3.com/part1",
+                    "https://upload.d3.com/part2",
+                ],
+            },
+        });
+        (0, nock_1.default)("https://upload.d3.com")
+            .put("/part1")
+            .reply(200, {}, { ETag: '"etag-part-1"' });
+        (0, nock_1.default)("https://upload.d3.com")
+            .put("/part2")
+            .reply(200, {}, { ETag: '"etag-part-2"' });
+        (0, nock_1.default)(API_BASE)
+            .post("/v1/external/complete-upload", (body) => {
+            return (body.file_key === "file-key-123" &&
+                body.upload_id === "upload-id-456" &&
+                Array.isArray(body.parts) &&
+                body.parts.length === 2 &&
+                body.parts[0].etag === "etag-part-1" &&
+                body.parts[0].part_number === 1 &&
+                body.parts[1].etag === "etag-part-2" &&
+                body.parts[1].part_number === 2);
+        })
+            .reply(200, {
+            data: {
+                message: "Upload completed successfully",
+                file_key: "file-key-123",
+            },
+        });
+        let result;
+        try {
+            result = await client.uploadFile({
+                file: tmpFile,
+                fileName: "test.pdf",
+                mimeType: "application/pdf",
+                parts: 2,
+            });
+        }
+        finally {
+            cleanup();
+        }
+        expect(result.fileKey).toBe("file-key-123");
+        expect(result.uploadId).toBe("upload-id-456");
+        expect(result.presignedUrls).toHaveLength(2);
+    });
+    test("creates an operation and polls status to completion", async () => {
+        const client = new src_1.Dragdropdo({ apiKey: "test-key", baseURL: API_BASE });
+        (0, nock_1.default)(API_BASE)
+            .post("/v1/external/do", {
+            action: "convert",
+            file_keys: ["file-key-123"],
+            parameters: { convert_to: "png" },
+            notes: undefined,
+        })
+            .reply(200, { data: { mainTaskId: "task-123" } });
+        (0, nock_1.default)(API_BASE)
+            .get("/v1/external/status/task-123")
+            .reply(200, {
+            data: {
+                operationStatus: "queued",
+                filesData: [{ fileKey: "file-key-123", status: "queued" }],
+            },
+        })
+            .get("/v1/external/status/task-123")
+            .reply(200, {
+            data: {
+                operationStatus: "completed",
+                filesData: [
+                    {
+                        fileKey: "file-key-123",
+                        status: "completed",
+                        downloadLink: "https://files.d3.com/output.png",
+                    },
+                ],
+            },
+        });
+        const operation = await client.convert(["file-key-123"], "png");
+        expect(operation.mainTaskId).toBe("task-123");
+        const status = await client.pollStatus({
+            mainTaskId: operation.mainTaskId,
+            interval: 5,
+            timeout: 1000,
+        });
+        expect(status.operationStatus).toBe("completed");
+        expect(status.filesData[0].downloadLink).toContain("files.d3.com");
+    });
+});

package/dist/tests/client.live.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/client.live.test.js

@@ -0,0 +1,104 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const axios_1 = __importDefault(require("axios"));
+const src_1 = require("../src");
+const fs = __importStar(require("fs"));
+const os = __importStar(require("os"));
+const path = __importStar(require("path"));
+const API_BASE = process.env.D3_BASE_URL ?? "https://api-dev.dragdropdo.com";
+const API_KEY = process.env.D3_API_KEY ?? "";
+const RUN_LIVE = process.env.RUN_LIVE_TESTS === "1";
+// Skip unless explicitly enabled with RUN_LIVE_TESTS=1 and a real API key.
+const maybeDescribe = RUN_LIVE && API_KEY ? describe : describe.skip;
+if (!RUN_LIVE || !API_KEY) {
+    // Provide a hint when the suite is skipped.
+    // eslint-disable-next-line no-console
+    console.warn("Skipping live API tests. Set RUN_LIVE_TESTS=1 and D3_API_KEY to run.");
+}
+maybeDescribe("Dragdropdo live API", () => {
+    const log = (...args) => console.log("[live-test]", ...args);
+    test("upload, convert, poll, download", async () => {
+        if (!API_KEY) {
+            throw new Error("API_KEY is required for live tests");
+        }
+        const client = new src_1.Dragdropdo({ apiKey: API_KEY, baseURL: API_BASE });
+        const tmpFile = path.join(os.tmpdir(), `d3-live-${Date.now()}.txt`);
+        fs.writeFileSync(tmpFile, "hello world");
+        log("Uploading file...");
+        const upload = await client.uploadFile({
+            file: tmpFile,
+            fileName: "hello.txt",
+            mimeType: "text/plain",
+            parts: 1,
+        });
+        log("Upload result:", upload);
+        log("Starting convert...");
+        const operation = await client.convert([upload.fileKey || upload.file_key], "png");
+        log("Operation:", operation);
+        log("Polling status...");
+        const mainTaskId = operation.mainTaskId || operation.main_task_id;
+        if (!mainTaskId) {
+            throw new Error("mainTaskId not found in operation response");
+        }
+        const status = await client.pollStatus({
+            mainTaskId: mainTaskId,
+            interval: 3000,
+            timeout: 60000,
+        });
+        log("Final status:", status);
+        const opStatus = status.operationStatus || status.operation_status;
+        expect(opStatus).toBe("completed");
+        const filesData = status.filesData || status.files_data || [];
+        const link = filesData[0]?.downloadLink || filesData[0]?.download_link;
+        expect(link).toBeTruthy();
+        if (link) {
+            log("Downloading output...");
+            const res = await axios_1.default.get(link, {
+                responseType: "arraybuffer",
+            });
+            const buf = Buffer.from(res.data);
+            log("Downloaded bytes:", buf.length);
+            expect(res.status).toBe(200);
+            expect(buf.length).toBeGreaterThan(0);
+        }
+        if (fs.existsSync(tmpFile)) {
+            fs.unlinkSync(tmpFile);
+        }
+    }, 120000);
+});

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "dragdropdo-sdk",
+  "version": "1.0.0",
+  "description": "Official Node.js client library for the dragdropdo.com Business API",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build",
+    "test": "jest"
+  },
+  "keywords": [
+    "dragdropdo-sdk",
+    "dragdropdo-node-client",
+    "file-conversion",
+    "api-client",
+    "file-processing",
+    "pdf",
+    "convert",
+    "compress"
+  ],
+  "author": "TrippyTech Labs LLP",
+  "license": "ISC",
+  "dependencies": {
+    "axios": "^1.6.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "@types/jest": "^29.5.0",
+    "jest": "^29.0.0",
+    "nock": "^13.5.0",
+    "ts-jest": "^29.0.0",
+    "typescript": "^5.0.0"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=14.0.0"
+  }
+}