@dcd-sdk/storage-client 1.0.0 → 1.0.1

package/dist/client.js

@@ -1,178 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createMediaClient = exports.MediaClient = exports.createBucketClient = exports.BucketClient = exports.StorageClient = void 0;
-exports.createStorageClient = createStorageClient;
-const builder_js_1 = require("./builder.js");
-class StorageClient {
-    constructor(config) {
-        if (!config.endpoint) {
-            throw new Error('StorageClient: endpoint is required');
-        }
-        this.endpoint = config.endpoint.replace(/\/+$/, '');
-        this.apiKey = (config.apiKey || '').trim();
-    }
-    /**
-     * Initializes a fluent URL builder for the specified asset public ID
-     */
-    url(publicId) {
-        return new builder_js_1.TransformationBuilder(this.endpoint, publicId);
-    }
-    /**
-     * Generates a short-lived cryptographically signed upload token for safe client-side browser/mobile uploads.
-     * Keeps master API keys strictly on backend servers.
-     */
-    async createSignedUploadToken(options = {}) {
-        if (!this.apiKey) {
-            throw new Error('StorageClient: API key is required on backend to generate signed upload tokens.');
-        }
-        const signUrl = `${this.endpoint}/v1/upload/sign`;
-        const response = await fetch(signUrl, {
-            method: 'POST',
-            headers: {
-                'Content-Type': 'application/json',
-                Authorization: `Bearer ${this.apiKey}`,
-            },
-            body: JSON.stringify(options),
-        });
-        const data = await response.json();
-        if (!response.ok) {
-            throw new Error(data.error?.message || `Failed to generate signed upload token with status ${response.status}`);
-        }
-        return data;
-    }
-    /**
-     * Directly uploads a file to the storage server.
-     * Supports File/Blob in browser environments and Buffer/ReadStream in Node.js environments.
-     * Supports both Master API Key and Client Signed Upload Tokens (dcd_sig_...).
-     */
-    async upload(file, options = {}) {
-        const uploadUrl = `${this.endpoint}/v1/upload`;
-        const formData = new FormData();
-        let fileToAppend = file;
-        let filename = options.filename;
-        if (typeof file === 'string') {
-            if (typeof process !== 'undefined' && process.versions?.node) {
-                try {
-                    const fs = await import('node:fs');
-                    const path = await import('node:path');
-                    if (fs.existsSync(file)) {
-                        const buf = fs.readFileSync(file);
-                        filename = filename || path.basename(file);
-                        fileToAppend = new Blob([new Uint8Array(buf)]);
-                    }
-                }
-                catch {
-                    // ignore
-                }
-            }
-        }
-        else if (typeof Buffer !== 'undefined' && Buffer.isBuffer(file)) {
-            fileToAppend = new Blob([new Uint8Array(file)]);
-            filename = filename || 'upload.bin';
-        }
-        if (filename) {
-            formData.append('file', fileToAppend, filename);
-        }
-        else {
-            formData.append('file', fileToAppend);
-        }
-        if (options.folder)
-            formData.append('folder', options.folder);
-        if (options.publicId)
-            formData.append('public_id', options.publicId);
-        if (options.overwrite !== undefined)
-            formData.append('overwrite', String(options.overwrite));
-        if (options.uniqueFilename !== undefined)
-            formData.append('unique_filename', String(options.uniqueFilename));
-        // Determine auth header: Use options.token if provided, otherwise this.apiKey
-        const headers = {};
-        if (options.token) {
-            headers['X-Upload-Token'] = options.token;
-        }
-        else if (this.apiKey) {
-            headers['Authorization'] = `Bearer ${this.apiKey}`;
-        }
-        else {
-            throw new Error('StorageClient: Either apiKey or a signed upload token must be provided to upload.');
-        }
-        // Browser upload with progress tracking via XMLHttpRequest
-        if (typeof XMLHttpRequest !== 'undefined' && options.onProgress) {
-            return new Promise((resolve, reject) => {
-                const xhr = new XMLHttpRequest();
-                xhr.open('POST', uploadUrl, true);
-                for (const [k, v] of Object.entries(headers)) {
-                    xhr.setRequestHeader(k, v);
-                }
-                xhr.upload.onprogress = (e) => {
-                    if (e.lengthComputable && options.onProgress) {
-                        const percent = Math.round((e.loaded / e.total) * 100);
-                        options.onProgress(percent);
-                    }
-                };
-                xhr.onload = () => {
-                    if (xhr.status >= 200 && xhr.status < 300) {
-                        try {
-                            const res = JSON.parse(xhr.responseText);
-                            resolve(res.asset);
-                        }
-                        catch {
-                            reject(new Error('Invalid response from storage server'));
-                        }
-                    }
-                    else {
-                        try {
-                            const errData = JSON.parse(xhr.responseText);
-                            reject(new Error(errData.error?.message || `Upload failed with status ${xhr.status}`));
-                        }
-                        catch {
-                            reject(new Error(`Upload failed with status ${xhr.status}`));
-                        }
-                    }
-                };
-                xhr.onerror = () => reject(new Error('Network error during file upload'));
-                xhr.send(formData);
-            });
-        }
-        // Standard fetch upload (Browser or Node.js)
-        const response = await fetch(uploadUrl, {
-            method: 'POST',
-            headers,
-            body: formData,
-        });
-        const data = await response.json();
-        if (!response.ok) {
-            throw new Error(data.error?.message || `Upload failed with status ${response.status}`);
-        }
-        return data.asset;
-    }
-    /**
-     * Helper method for frontend clients to upload using only a signed upload token (zero API key)
-     */
-    async uploadWithToken(file, token, options = {}) {
-        return this.upload(file, { ...options, token });
-    }
-    /**
-     * Permanently deletes a storage asset (requires API key with delete role)
-     */
-    async delete(publicId) {
-        const cleanPublicId = publicId.replace(/^\/+/, '');
-        const deleteUrl = `${this.endpoint}/v1/admin/files/${cleanPublicId}`;
-        const response = await fetch(deleteUrl, {
-            method: 'DELETE',
-            headers: {
-                Authorization: `Bearer ${this.apiKey}`,
-            },
-        });
-        return response.ok;
-    }
-}
-exports.StorageClient = StorageClient;
-function createStorageClient(config) {
-    return new StorageClient(config);
-}
-// Bucket modern API aliases
-exports.BucketClient = StorageClient;
-exports.createBucketClient = createStorageClient;
-// Backward compatibility aliases
-exports.MediaClient = StorageClient;
-exports.createMediaClient = createStorageClient;

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AACrD,OAAO,EACL,aAAa,EACb,mBAAmB,EACnB,YAAY,EACZ,kBAAkB,EAClB,WAAW,EACX,iBAAiB,GAClB,MAAM,aAAa,CAAC;AACrB,YAAY,EACV,WAAW,EACX,kBAAkB,EAClB,iBAAiB,EACjB,QAAQ,EACR,YAAY,EACZ,mBAAmB,EACnB,kBAAkB,EAClB,iBAAiB,EACjB,qBAAqB,EACrB,aAAa,GACd,MAAM,YAAY,CAAC"}

package/dist/types.d.ts

@@ -1,67 +0,0 @@
-export type CropMode = 'fill' | 'fit' | 'crop' | 'scale';
-export type OutputFormat = 'auto' | 'webp' | 'avif' | 'jpeg' | 'png';
-export interface StorageClientConfig {
-    /** The base URL of the storage engine cluster (e.g. 'https://storage.mycoolapp.com' or 'http://192.168.1.50:7100') */
-    endpoint: string;
-    /** Public API key (dcd_pk_...), Secret key (dcd_sk_...), or Live key */
-    apiKey?: string;
-}
-export type MediaClientConfig = StorageClientConfig;
-export type BucketClientConfig = StorageClientConfig;
-export interface TransformationOptions {
-    width?: number;
-    height?: number;
-    crop?: CropMode;
-    format?: OutputFormat;
-    quality?: number | 'auto';
-    blur?: number;
-    grayscale?: boolean;
-    sharpen?: boolean;
-    rotation?: number | 'auto';
-}
-export interface UploadOptions {
-    folder?: string;
-    publicId?: string;
-    filename?: string;
-    overwrite?: boolean;
-    uniqueFilename?: boolean;
-    /** Optional client signed upload token (dcd_sig_...) to upload without API key */
-    token?: string;
-    tags?: string[];
-    onProgress?: (percent: number) => void;
-}
-export interface SignUploadOptions {
-    folder?: string;
-    maxBytes?: number;
-    expiresInSeconds?: number;
-}
-export interface SignedUploadResult {
-    success: boolean;
-    token: string;
-    uploadUrl: string;
-    expiresInSeconds: number;
-    folder?: string | null;
-    maxBytes?: number | null;
-}
-export interface AssetResult {
-    public_id: string;
-    publicId: string;
-    filename: string;
-    format: string;
-    resource_type?: string;
-    resourceType?: string;
-    width?: number;
-    height?: number;
-    bytes: number;
-    storageDriver: string;
-    etag: string;
-    url: string;
-    secure_url: string;
-    secureUrl: string;
-    rawUrl?: string;
-    created_at: number;
-    createdAt: number;
-}
-export type StorageAssetResult = AssetResult;
-export type BucketAssetResult = AssetResult;
-//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,CAAC;AACzD,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC;AAErE,MAAM,WAAW,mBAAmB;IAClC,sHAAsH;IACtH,QAAQ,EAAE,MAAM,CAAC;IACjB,wEAAwE;IACxE,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAGD,MAAM,MAAM,iBAAiB,GAAG,mBAAmB,CAAC;AACpD,MAAM,MAAM,kBAAkB,GAAG,mBAAmB,CAAC;AAErD,MAAM,WAAW,qBAAqB;IACpC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,kFAAkF;IAClF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;CACxC;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB,EAAE,MAAM,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,WAAW;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,MAAM,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;CACnB;AAGD,MAAM,MAAM,kBAAkB,GAAG,WAAW,CAAC;AAC7C,MAAM,MAAM,iBAAiB,GAAG,WAAW,CAAC"}

package/dist/types.js

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