@cloudpdf/sdk 0.0.0 → 3.0.0-next.10

package/dist/esm/uploads/Uploads.mjs

@@ -0,0 +1,74 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { prepareUploadSource } from "./source.mjs";
+/** High-level, integrity-pinned `init -> transfer -> commit` workflow. */
+export class Uploads {
+    constructor(protocol) {
+        this.protocol = protocol;
+    }
+    create(input) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
+            const source = yield prepareUploadSource(input.source);
+            const requestOptions = { abortSignal: input.signal };
+            const init = (yield this.protocol.init({
+                tenantId: input.tenantId,
+                contentLength: source.size,
+                contentSha256: source.sha256,
+                metadata: input.metadata,
+                idempotencyKey: input.idempotencyKey,
+                dedupMode: input.dedupMode,
+                docId: input.docId,
+                uploadTtlSec: input.uploadTtlSec,
+                uploadPreference: input.uploadPreference,
+            }, requestOptions));
+            if (init.tag === "deduped") {
+                (_a = input.onProgress) === null || _a === void 0 ? void 0 : _a.call(input, source.size, source.size);
+                return { tag: init.tag, document: init.document };
+            }
+            if (!init.upload)
+                throw new Error("CloudPDF init response omitted upload access");
+            (_b = input.onProgress) === null || _b === void 0 ? void 0 : _b.call(input, 0, source.size);
+            if (init.upload.kind === "presigned") {
+                const body = yield source.open();
+                const response = yield this.protocol.presigned(init.upload.presigned.url, Object.assign({ method: init.upload.presigned.method, 
+                    // These are the exact signed headers. In particular, no SDK
+                    // Authorization header is added to an object-store request.
+                    headers: init.upload.presigned.headers, body, signal: input.signal }, (isStreamBody(body) ? { duplex: "half" } : {})));
+                if (!response.ok) {
+                    const detail = yield response.text().catch(() => "");
+                    throw new Error(`presigned upload failed: ${response.status} ${response.statusText} ${detail}`.trim());
+                }
+            }
+            else {
+                const form = new FormData();
+                form.append("file", yield source.openProxyBlob(), source.filename);
+                const response = yield this.protocol.proxy(init.upload.url, form, {
+                    abortSignal: input.signal,
+                    maxRetries: 0,
+                });
+                if (!response.ok) {
+                    const detail = yield response.text().catch(() => "");
+                    throw new Error(`proxy upload failed: ${response.status} ${response.statusText} ${detail}`.trim());
+                }
+            }
+            (_c = input.onProgress) === null || _c === void 0 ? void 0 : _c.call(input, source.size, source.size);
+            const committed = (yield this.protocol.commit({
+                tenantId: input.tenantId,
+                id: init.document.id,
+                sha256: source.sha256,
+            }, requestOptions));
+            return { tag: init.tag, document: committed.document };
+        });
+    }
+}
+function isStreamBody(body) {
+    return typeof body === "object" && body !== null && ("pipe" in body || "getReader" in body);
+}

package/dist/esm/uploads/index.d.mts

@@ -0,0 +1,2 @@
+export { Uploads } from "./Uploads.mjs";
+export type { DedupMode, ReopenableUploadSource, UploadCreateInput, UploadCreateResult, UploadPreference, UploadProtocol, UploadSource, } from "./types.mjs";

package/dist/esm/uploads/index.mjs

@@ -0,0 +1 @@
+export { Uploads } from "./Uploads.mjs";

package/dist/esm/uploads/source.d.mts

@@ -0,0 +1,10 @@
+import type { UploadSource } from "./types.mjs";
+export interface PreparedUploadSource {
+    size: number;
+    sha256: string;
+    filename: string;
+    contentType: string;
+    open(): Promise<BodyInit>;
+    openProxyBlob(): Promise<Blob>;
+}
+export declare function prepareUploadSource(source: UploadSource): Promise<PreparedUploadSource>;

package/dist/esm/uploads/source.mjs

@@ -0,0 +1,119 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
+};
+export function prepareUploadSource(source) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a, _b;
+        if (isReopenable(source)) {
+            return {
+                size: source.size,
+                sha256: normalizeSha(source.sha256),
+                filename: (_a = source.filename) !== null && _a !== void 0 ? _a : "document.pdf",
+                contentType: (_b = source.contentType) !== null && _b !== void 0 ? _b : "application/pdf",
+                open: () => __awaiter(this, void 0, void 0, function* () { return source.open(); }),
+                openProxyBlob: () => __awaiter(this, void 0, void 0, function* () {
+                    if (!source.openProxyBlob) {
+                        throw new Error("the server selected proxy upload, but this reopenable source does not provide openProxyBlob()");
+                    }
+                    return source.openProxyBlob();
+                }),
+            };
+        }
+        if (isPathSource(source))
+            return preparePath(source.path);
+        const blob = toBlob(source);
+        return {
+            size: blob.size,
+            sha256: yield sha256Bytes(new Uint8Array(yield blob.arrayBuffer())),
+            filename: "document.pdf",
+            contentType: blob.type || "application/pdf",
+            open: () => __awaiter(this, void 0, void 0, function* () { return blob; }),
+            openProxyBlob: () => __awaiter(this, void 0, void 0, function* () { return blob; }),
+        };
+    });
+}
+function preparePath(path) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a, e_1, _b, _c;
+        const [{ createReadStream }, { readFile, stat }, { createHash }] = yield Promise.all([
+            import("node:fs"),
+            import("node:fs/promises"),
+            import("node:crypto"),
+        ]);
+        const info = yield stat(path);
+        if (!info.isFile())
+            throw new Error(`upload source is not a file: ${path}`);
+        const hash = createHash("sha256");
+        try {
+            for (var _d = true, _e = __asyncValues(createReadStream(path)), _f; _f = yield _e.next(), _a = _f.done, !_a; _d = true) {
+                _c = _f.value;
+                _d = false;
+                const chunk = _c;
+                hash.update(chunk);
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (!_d && !_a && (_b = _e.return)) yield _b.call(_e);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+        return {
+            size: info.size,
+            sha256: hash.digest("hex"),
+            filename: path.split(/[\\/]/).pop() || "document.pdf",
+            contentType: "application/pdf",
+            open: () => __awaiter(this, void 0, void 0, function* () { return createReadStream(path); }),
+            // The proxy route is deliberately bounded. Presigned mode remains
+            // streaming; the uncommon filesystem fallback materializes one Blob.
+            openProxyBlob: () => __awaiter(this, void 0, void 0, function* () { return new Blob([new Uint8Array(yield readFile(path))], { type: "application/pdf" }); }),
+        };
+    });
+}
+function sha256Bytes(bytes) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a;
+        if ((_a = globalThis.crypto) === null || _a === void 0 ? void 0 : _a.subtle) {
+            const digest = yield globalThis.crypto.subtle.digest("SHA-256", new Uint8Array(bytes));
+            return hex(new Uint8Array(digest));
+        }
+        const { createHash } = yield import("node:crypto");
+        return createHash("sha256").update(bytes).digest("hex");
+    });
+}
+function toBlob(source) {
+    if (source instanceof Blob)
+        return source;
+    const bytes = source instanceof Uint8Array ? new Uint8Array(source) : new Uint8Array(source.slice(0));
+    return new Blob([bytes], { type: "application/pdf" });
+}
+function isPathSource(source) {
+    return typeof source === "object" && source !== null && "path" in source;
+}
+function isReopenable(source) {
+    return typeof source === "object" && source !== null && "open" in source && "size" in source && "sha256" in source;
+}
+function normalizeSha(value) {
+    const normalized = value.toLowerCase();
+    if (!/^[a-f0-9]{64}$/.test(normalized)) {
+        throw new Error("reopenable upload source sha256 must be 64 lowercase or uppercase hex characters");
+    }
+    return normalized;
+}
+function hex(bytes) {
+    return Array.from(bytes, (byte) => byte.toString(16).padStart(2, "0")).join("");
+}

package/dist/esm/uploads/types.d.mts

@@ -0,0 +1,46 @@
+export type UploadPreference = "auto" | "presigned" | "proxy";
+export type DedupMode = "always-create" | "reuse-existing";
+/**
+ * A source that can be opened again after its hash is known. This is the
+ * escape hatch for streams: init needs the final SHA before transfer starts,
+ * so a one-shot unknown stream cannot implement the protocol safely.
+ */
+export interface ReopenableUploadSource {
+    size: number;
+    sha256: string;
+    filename?: string;
+    contentType?: string;
+    open(): BodyInit | Promise<BodyInit>;
+    /** Required only if the server selects the multipart proxy fallback. */
+    openProxyBlob?(): Blob | Promise<Blob>;
+}
+export type UploadSource = Uint8Array | ArrayBuffer | Blob | {
+    path: string;
+} | ReopenableUploadSource;
+export interface UploadCreateInput {
+    tenantId: string;
+    source: UploadSource;
+    metadata?: Record<string, unknown>;
+    idempotencyKey?: string;
+    dedupMode?: DedupMode;
+    docId?: string;
+    uploadTtlSec?: number;
+    /** `auto` prefers a presigned object-store PUT and is recommended. */
+    uploadPreference?: UploadPreference;
+    signal?: AbortSignal;
+    onProgress?: (loaded: number, total: number) => void;
+}
+export interface UploadCreateResult<Document = unknown> {
+    tag: "created" | "resumed" | "deduped";
+    document: Document;
+}
+export interface UploadRequestOptions {
+    abortSignal?: AbortSignal;
+    maxRetries?: number;
+}
+export interface UploadProtocol {
+    init(request: Record<string, unknown>, options: UploadRequestOptions): Promise<unknown>;
+    commit(request: Record<string, unknown>, options: UploadRequestOptions): Promise<unknown>;
+    proxy(url: string, form: FormData, options: UploadRequestOptions): Promise<Response>;
+    presigned(url: string, init: RequestInit): Promise<Response>;
+}

package/dist/esm/uploads/types.mjs

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

package/dist/esm/version.d.mts

@@ -0,0 +1 @@
+export declare const SDK_VERSION = "3.0.0-next.10";

package/dist/esm/version.mjs

@@ -0,0 +1 @@
+export const SDK_VERSION = "3.0.0-next.10";

package/package.json

@@ -1,29 +1,195 @@
 {
   "name": "@cloudpdf/sdk",
-  "version": "0.0.0",
-  "description": "Bootstrap package for the official CloudPDF TypeScript SDK.",
+  "version": "3.0.0-next.10",
+  "private": false,
   "license": "Apache-2.0",
-  "author": "CloudPDF <hello@cloudpdf.com>",
-  "homepage": "https://www.cloudpdf.com",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/embedpdf/cloudpdf-sdk-typescript.git"
-  },
-  "type": "module",
-  "main": "./index.js",
-  "types": "./index.d.ts",
+  "type": "commonjs",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.mjs",
+  "types": "./dist/cjs/index.d.ts",
   "exports": {
     ".": {
-      "types": "./index.d.ts",
-      "import": "./index.js",
-      "default": "./index.js"
-    }
+      "import": {
+        "types": "./dist/esm/index.d.mts",
+        "default": "./dist/esm/index.mjs"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      },
+      "default": "./dist/cjs/index.js"
+    },
+    "./deployment": {
+      "import": {
+        "types": "./dist/esm/api/resources/deployment/exports.d.mts",
+        "default": "./dist/esm/api/resources/deployment/exports.mjs"
+      },
+      "require": {
+        "types": "./dist/cjs/api/resources/deployment/exports.d.ts",
+        "default": "./dist/cjs/api/resources/deployment/exports.js"
+      },
+      "default": "./dist/cjs/api/resources/deployment/exports.js"
+    },
+    "./doc": {
+      "import": {
+        "types": "./dist/esm/api/resources/doc/exports.d.mts",
+        "default": "./dist/esm/api/resources/doc/exports.mjs"
+      },
+      "require": {
+        "types": "./dist/cjs/api/resources/doc/exports.d.ts",
+        "default": "./dist/cjs/api/resources/doc/exports.js"
+      },
+      "default": "./dist/cjs/api/resources/doc/exports.js"
+    },
+    "./shares": {
+      "import": {
+        "types": "./dist/esm/api/resources/shares/exports.d.mts",
+        "default": "./dist/esm/api/resources/shares/exports.mjs"
+      },
+      "require": {
+        "types": "./dist/cjs/api/resources/shares/exports.d.ts",
+        "default": "./dist/cjs/api/resources/shares/exports.js"
+      },
+      "default": "./dist/cjs/api/resources/shares/exports.js"
+    },
+    "./tenants": {
+      "import": {
+        "types": "./dist/esm/api/resources/tenants/exports.d.mts",
+        "default": "./dist/esm/api/resources/tenants/exports.mjs"
+      },
+      "require": {
+        "types": "./dist/cjs/api/resources/tenants/exports.d.ts",
+        "default": "./dist/cjs/api/resources/tenants/exports.js"
+      },
+      "default": "./dist/cjs/api/resources/tenants/exports.js"
+    },
+    "./documents": {
+      "import": {
+        "types": "./dist/esm/api/resources/documents/exports.d.mts",
+        "default": "./dist/esm/api/resources/documents/exports.mjs"
+      },
+      "require": {
+        "types": "./dist/cjs/api/resources/documents/exports.d.ts",
+        "default": "./dist/cjs/api/resources/documents/exports.js"
+      },
+      "default": "./dist/cjs/api/resources/documents/exports.js"
+    },
+    "./tokens": {
+      "import": {
+        "types": "./dist/esm/api/resources/tokens/exports.d.mts",
+        "default": "./dist/esm/api/resources/tokens/exports.mjs"
+      },
+      "require": {
+        "types": "./dist/cjs/api/resources/tokens/exports.d.ts",
+        "default": "./dist/cjs/api/resources/tokens/exports.js"
+      },
+      "default": "./dist/cjs/api/resources/tokens/exports.js"
+    },
+    "./doc/annotations": {
+      "import": {
+        "types": "./dist/esm/api/resources/doc/resources/annotations/exports.d.mts",
+        "default": "./dist/esm/api/resources/doc/resources/annotations/exports.mjs"
+      },
+      "require": {
+        "types": "./dist/cjs/api/resources/doc/resources/annotations/exports.d.ts",
+        "default": "./dist/cjs/api/resources/doc/resources/annotations/exports.js"
+      },
+      "default": "./dist/cjs/api/resources/doc/resources/annotations/exports.js"
+    },
+    "./doc/forms": {
+      "import": {
+        "types": "./dist/esm/api/resources/doc/resources/forms/exports.d.mts",
+        "default": "./dist/esm/api/resources/doc/resources/forms/exports.mjs"
+      },
+      "require": {
+        "types": "./dist/cjs/api/resources/doc/resources/forms/exports.d.ts",
+        "default": "./dist/cjs/api/resources/doc/resources/forms/exports.js"
+      },
+      "default": "./dist/cjs/api/resources/doc/resources/forms/exports.js"
+    },
+    "./doc/metadata": {
+      "import": {
+        "types": "./dist/esm/api/resources/doc/resources/metadata/exports.d.mts",
+        "default": "./dist/esm/api/resources/doc/resources/metadata/exports.mjs"
+      },
+      "require": {
+        "types": "./dist/cjs/api/resources/doc/resources/metadata/exports.d.ts",
+        "default": "./dist/cjs/api/resources/doc/resources/metadata/exports.js"
+      },
+      "default": "./dist/cjs/api/resources/doc/resources/metadata/exports.js"
+    },
+    "./doc/pages": {
+      "import": {
+        "types": "./dist/esm/api/resources/doc/resources/pages/exports.d.mts",
+        "default": "./dist/esm/api/resources/doc/resources/pages/exports.mjs"
+      },
+      "require": {
+        "types": "./dist/cjs/api/resources/doc/resources/pages/exports.d.ts",
+        "default": "./dist/cjs/api/resources/doc/resources/pages/exports.js"
+      },
+      "default": "./dist/cjs/api/resources/doc/resources/pages/exports.js"
+    },
+    "./doc/redactions": {
+      "import": {
+        "types": "./dist/esm/api/resources/doc/resources/redactions/exports.d.mts",
+        "default": "./dist/esm/api/resources/doc/resources/redactions/exports.mjs"
+      },
+      "require": {
+        "types": "./dist/cjs/api/resources/doc/resources/redactions/exports.d.ts",
+        "default": "./dist/cjs/api/resources/doc/resources/redactions/exports.js"
+      },
+      "default": "./dist/cjs/api/resources/doc/resources/redactions/exports.js"
+    },
+    "./package.json": "./package.json"
   },
   "files": [
-    "index.js",
-    "index.d.ts"
+    "dist",
+    "reference.md",
+    "README.md",
+    "LICENSE"
   ],
+  "dependencies": {},
+  "devDependencies": {
+    "webpack": "^5.105.4",
+    "ts-loader": "^9.5.4",
+    "vitest": "^4.1.1",
+    "msw": "2.11.2",
+    "@types/node": "^20.0.0",
+    "typescript": "~5.9.3",
+    "@biomejs/biome": "2.4.10"
+  },
+  "browser": {
+    "fs": false,
+    "os": false,
+    "path": false,
+    "stream": false,
+    "crypto": false
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "sideEffects": false,
+  "description": "The official TypeScript SDK for the CloudPDF API.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/embedpdf/embed-pdf-viewer.git",
+    "directory": "cloudpdf/sdk"
+  },
   "publishConfig": {
     "access": "public"
+  },
+  "scripts": {
+    "format": "biome format --write --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
+    "format:check": "biome format --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
+    "lint": "biome lint --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
+    "lint:fix": "biome lint --fix --unsafe --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
+    "check": "biome check --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
+    "check:fix": "biome check --fix --unsafe --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
+    "build": "pnpm build:cjs && pnpm build:esm",
+    "build:cjs": "tsc --project ./tsconfig.cjs.json",
+    "build:esm": "tsc --project ./tsconfig.esm.json && node scripts/rename-to-esm-files.js dist/esm",
+    "test": "vitest run",
+    "test:unit": "vitest run --project unit",
+    "test:wire": "vitest run --project wire"
   }
-}
+}