@toa.io/extensions.storages 1.0.0-alpha.21 → 1.0.0-alpha.219

package/transpiled/providers/Cloudinary.d.ts

@@ -0,0 +1,51 @@
+/// <reference types="node" />
+import { Readable } from 'node:stream';
+import { Provider } from '../Provider';
+import type { Maybe } from '@toa.io/types';
+import type { Metadata, Stream } from '../Entry';
+import type { Secret, Secrets } from '../Secrets';
+import type { TransformationOptions } from 'cloudinary';
+export type CloudinarySecrets = Secrets<'API_KEY' | 'API_SECRET'>;
+export declare class Cloudinary extends Provider<CloudinaryOptions> {
+    static readonly SECRETS: readonly Secret[];
+    private readonly type;
+    private readonly eager;
+    private readonly transformations;
+    private readonly config;
+    private readonly prefix;
+    constructor(options: CloudinaryOptions, secrets?: CloudinarySecrets);
+    get(path: string, options?: GetOptions): Promise<Maybe<Stream>>;
+    head(path: string): Promise<Maybe<Metadata>>;
+    put(path: string, stream: Readable): Promise<void>;
+    commit(): Promise<void>;
+    delete(path: string): Promise<void>;
+    move(from: string, to: string): Promise<void | Error>;
+    private fetch;
+    private url;
+    private toTransformation;
+    private mapTransformation;
+    private metadata;
+    private cloudinary;
+}
+interface GetOptions {
+    agent?: string;
+    range?: string;
+}
+export interface CloudinaryOptions {
+    environment: string;
+    type: StorageType;
+    prefix?: string;
+    eager?: TransformationOptions[];
+    transformations?: TransformationDeclaration[];
+}
+type TransformationDeclaration = Omit<Transformation, 'extension'> & {
+    extension: string;
+};
+interface Transformation {
+    extension: RegExp;
+    condition?: string;
+    transformation: Record<string, unknown> | Array<Record<string, unknown>>;
+    optional?: boolean;
+}
+type StorageType = 'image' | 'video';
+export {};

package/transpiled/providers/Cloudinary.js

@@ -0,0 +1,223 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Cloudinary = void 0;
+const node_path_1 = require("node:path");
+const node_stream_1 = require("node:stream");
+const cloudinary_1 = require("cloudinary");
+const openspan_1 = require("openspan");
+const Provider_1 = require("../Provider");
+const errors_1 = require("../errors");
+class Cloudinary extends Provider_1.Provider {
+    static SECRETS = [
+        { name: 'API_KEY' },
+        { name: 'API_SECRET' }
+    ];
+    type;
+    eager = [];
+    transformations = [];
+    config;
+    prefix;
+    constructor(options, secrets) {
+        super(options, secrets);
+        this.type = options.type;
+        if (options.eager !== undefined)
+            this.eager = options.eager;
+        if (options.transformations !== undefined)
+            this.transformations = options.transformations.map((transformation) => {
+                const { extension, ...rest } = transformation;
+                let expression = extension;
+                if (!extension.startsWith('^'))
+                    expression = '^' + extension;
+                if (!extension.endsWith('$'))
+                    expression = extension + '$';
+                return {
+                    extension: new RegExp(expression),
+                    ...rest
+                };
+            });
+        this.config = {
+            cloud_name: options.environment,
+            api_key: secrets.API_KEY,
+            api_secret: secrets.API_SECRET
+        };
+        this.prefix = options.prefix ?? '/';
+    }
+    async get(path, options) {
+        const headers = {};
+        if (options?.range !== undefined)
+            headers.range = options.range;
+        if (options?.agent !== undefined)
+            headers['user-agent'] = options.agent;
+        const response = await this.fetch(path, { method: 'GET', headers });
+        if (response instanceof Error)
+            return errors_1.ERR_NOT_FOUND;
+        const metadata = this.metadata(response);
+        return {
+            stream: node_stream_1.Readable.fromWeb(response.body),
+            ...metadata
+        };
+    }
+    async head(path) {
+        const response = await this.fetch(path, { method: 'HEAD' });
+        if (response instanceof Error)
+            return errors_1.ERR_NOT_FOUND;
+        return this.metadata(response);
+    }
+    async put(path, stream) {
+        const id = (0, node_path_1.basename)(path);
+        const folder = (0, node_path_1.join)(this.prefix, (0, node_path_1.dirname)(path));
+        await new Promise((resolve, reject) => {
+            const options = {
+                public_id: id,
+                folder,
+                eager: this.eager,
+                resource_type: this.type
+            };
+            openspan_1.console.debug('Uploading to Cloudinary', { path, options });
+            stream.pipe(this.cloudinary().uploader.upload_stream(options, (error, result) => {
+                if (error !== undefined)
+                    reject(error);
+                else
+                    resolve(result);
+            }));
+            stream.on('error', (e) => {
+                openspan_1.console.error('Cloudinary stream error', { path, error: e });
+                stream.destroy();
+                reject(e);
+            });
+        });
+    }
+    async commit() {
+        // metadata is read-only
+    }
+    async delete(path) {
+        const id = (0, node_path_1.join)(this.prefix, path);
+        openspan_1.console.debug('Deleting from Cloudinary', { path: id });
+        await this.cloudinary().uploader.destroy(id, { resource_type: this.type, invalidate: true });
+    }
+    async move(from, to) {
+        const source = (0, node_path_1.join)(this.prefix, from);
+        const target = (0, node_path_1.join)(this.prefix, to);
+        try {
+            await this.cloudinary().uploader.rename(source, target, { resource_type: this.type, overwrite: true });
+        }
+        catch (error) {
+            if (error.http_code === 404)
+                return errors_1.ERR_NOT_FOUND;
+            else
+                throw error;
+        }
+    }
+    async fetch(path, options = { method: 'GET' }) {
+        const url = this.url(path);
+        if (url === null)
+            return errors_1.ERR_NOT_FOUND;
+        openspan_1.console.debug('Fetching from Cloudinary', {
+            method: options.method,
+            path,
+            url
+        });
+        const response = await fetch(url, options).catch((e) => e);
+        if (response instanceof Error || response.ok === false) {
+            openspan_1.console.debug('Failed to fetch from Cloudinary', {
+                url,
+                status: response.status,
+                message: response.message
+            });
+            return errors_1.ERR_NOT_FOUND;
+        }
+        else
+            openspan_1.console.debug('Received response from Cloudinary', {
+                url,
+                status: response.status,
+                headers: response.headers
+            });
+        return response;
+    }
+    url(path) {
+        const [base, transformation] = this.toTransformation(path);
+        if (base === null)
+            return null;
+        const id = (0, node_path_1.join)(this.prefix, base);
+        return this.cloudinary().url(id, {
+            resource_type: this.type,
+            transformation,
+            version: 2
+        });
+    }
+    toTransformation(path) {
+        if (this.transformations.length === 0)
+            return [path, undefined];
+        const [base, ...extensions] = path.split('.');
+        const transformations = [];
+        let t = 0;
+        for (const extension of extensions) {
+            let found = false;
+            for (t; t < this.transformations.length && !found; t++) {
+                const { extension: regex, condition, transformation, optional } = this.transformations[t];
+                const match = regex.exec(extension);
+                // eslint-disable-next-line max-depth
+                if (match === null)
+                    if (optional === true)
+                        continue;
+                    else
+                        return [null, undefined];
+                const options = Array.isArray(transformation) ? transformation : [transformation];
+                const stages = options.map((stage) => this.mapTransformation(stage, match.groups));
+                found = true;
+                if (condition === undefined)
+                    transformations.push(...stages);
+                else {
+                    transformations.push({ if: condition });
+                    transformations.push(...stages);
+                    transformations.push({ if: 'end' });
+                }
+            }
+            if (!found)
+                return [null, undefined];
+        }
+        for (t; t < this.transformations.length; t++)
+            if (this.transformations[t].optional !== true)
+                return [null, undefined];
+        return [base, transformations];
+    }
+    mapTransformation(options, groups) {
+        return Object.fromEntries(Object.entries(options).map(([key, value]) => {
+            if (typeof value !== 'string')
+                return [key, value];
+            if (value.startsWith('<') && value.endsWith('>'))
+                value = groups[value.slice(1, -1)];
+            if (key === 'zoom' && value !== undefined)
+                value = Number.parseInt(value) / 100;
+            if (key === 'fetch_format' && value === 'jpeg')
+                value = 'jpg';
+            return [key, value];
+        }));
+    }
+    metadata(response) {
+        const size = response.headers.get('content-length') === null
+            ? null
+            : Number.parseInt(response.headers.get('content-length'));
+        const created = response.headers.get('date') ?? new Date().toISOString();
+        const etag = response.headers.get('etag');
+        const checksum = etag === null ? (0, node_path_1.basename)(response.url) : etag.slice(1, -1);
+        const range = response.headers.get('content-range');
+        return {
+            type: response.headers.get('content-type'),
+            size,
+            checksum,
+            created,
+            range: range ?? undefined,
+            partial: response.status === 206,
+            attributes: {
+                url: response.url
+            }
+        };
+    }
+    cloudinary() {
+        cloudinary_1.v2.config(this.config);
+        return cloudinary_1.v2;
+    }
+}
+exports.Cloudinary = Cloudinary;
+//# sourceMappingURL=Cloudinary.js.map

package/transpiled/providers/Cloudinary.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Cloudinary.js","sourceRoot":"","sources":["../../source/providers/Cloudinary.ts"],"names":[],"mappings":";;;AAAA,yCAAmD;AACnD,6CAAsC;AACtC,2CAA6C;AAC7C,uCAAkC;AAClC,0CAAsC;AACtC,sCAAyC;AAazC,MAAa,UAAW,SAAQ,mBAA2B;IAClD,MAAM,CAAmB,OAAO,GAAsB;QAC3D,EAAE,IAAI,EAAE,SAAS,EAAE;QACnB,EAAE,IAAI,EAAE,YAAY,EAAE;KACvB,CAAA;IAEgB,IAAI,CAAa;IACjB,KAAK,GAA4B,EAAE,CAAA;IACnC,eAAe,GAAqB,EAAE,CAAA;IACtC,MAAM,CAAe;IACrB,MAAM,CAAQ;IAE/B,YAAoB,OAA0B,EAAE,OAA2B;QACzE,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QAEvB,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAA;QAExB,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS;YAC7B,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAA;QAE5B,IAAI,OAAO,CAAC,eAAe,KAAK,SAAS;YACvC,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,cAAc,EAAE,EAAE;gBACpE,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,cAAc,CAAA;gBAE7C,IAAI,UAAU,GAAG,SAAS,CAAA;gBAE1B,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC;oBAC5B,UAAU,GAAG,GAAG,GAAG,SAAS,CAAA;gBAE9B,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC;oBAC1B,UAAU,GAAG,SAAS,GAAG,GAAG,CAAA;gBAE9B,OAAO;oBACL,SAAS,EAAE,IAAI,MAAM,CAAC,UAAU,CAAC;oBACjC,GAAG,IAAI;iBACR,CAAA;YACH,CAAC,CAAC,CAAA;QAEJ,IAAI,CAAC,MAAM,GAAG;YACZ,UAAU,EAAE,OAAO,CAAC,WAAW;YAC/B,OAAO,EAAE,OAAQ,CAAC,OAAO;YACzB,UAAU,EAAE,OAAQ,CAAC,UAAU;SAChC,CAAA;QAED,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,GAAG,CAAA;IACrC,CAAC;IAEM,KAAK,CAAC,GAAG,CAAE,IAAY,EAAE,OAAoB;QAClD,MAAM,OAAO,GAA2B,EAAE,CAAA;QAE1C,IAAI,OAAO,EAAE,KAAK,KAAK,SAAS;YAC9B,OAAO,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAA;QAE/B,IAAI,OAAO,EAAE,KAAK,KAAK,SAAS;YAC9B,OAAO,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC,KAAK,CAAA;QAEvC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAA;QAEnE,IAAI,QAAQ,YAAY,KAAK;YAC3B,OAAO,sBAAa,CAAA;QAEtB,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;QAExC,OAAO;YACL,MAAM,EAAE,sBAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAsB,CAAC;YACzD,GAAG,QAAQ;SACZ,CAAA;IACH,CAAC;IAEM,KAAK,CAAC,IAAI,CAAE,IAAY;QAC7B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;QAE3D,IAAI,QAAQ,YAAY,KAAK;YAC3B,OAAO,sBAAa,CAAA;QAEtB,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;IAChC,CAAC;IAEM,KAAK,CAAC,GAAG,CAAE,IAAY,EAAE,MAAgB;QAC9C,MAAM,EAAE,GAAG,IAAA,oBAAQ,EAAC,IAAI,CAAC,CAAA;QACzB,MAAM,MAAM,GAAG,IAAA,gBAAI,EAAC,IAAI,CAAC,MAAM,EAAE,IAAA,mBAAO,EAAC,IAAI,CAAC,CAAC,CAAA;QAE/C,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACpC,MAAM,OAAO,GAAqB;gBAChC,SAAS,EAAE,EAAE;gBACb,MAAM;gBACN,KAAK,EAAE,IAAI,CAAC,KAAK;gBACjB,aAAa,EAAE,IAAI,CAAC,IAAI;aACzB,CAAA;YAED,kBAAO,CAAC,KAAK,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAA;YAE3D,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC,OAAO,EAC1D,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;gBAChB,IAAI,KAAK,KAAK,SAAS;oBAAE,MAAM,CAAC,KAAK,CAAC,CAAA;;oBACjC,OAAO,CAAC,MAAM,CAAC,CAAA;YACtB,CAAC,CAAC,CAAC,CAAA;YAEL,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;gBACvB,kBAAO,CAAC,KAAK,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAA;gBAC5D,MAAM,CAAC,OAAO,EAAE,CAAA;gBAEhB,MAAM,CAAC,CAAC,CAAC,CAAA;YACX,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;IACJ,CAAC;IAEM,KAAK,CAAC,MAAM;QACjB,wBAAwB;IAC1B,CAAC;IAEM,KAAK,CAAC,MAAM,CAAE,IAAY;QAC/B,MAAM,EAAE,GAAG,IAAA,gBAAI,EAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;QAElC,kBAAO,CAAC,KAAK,CAAC,0BAA0B,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAA;QAEvD,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,EACzC,EAAE,aAAa,EAAE,IAAI,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAA;IACnD,CAAC;IAEM,KAAK,CAAC,IAAI,CAAE,IAAY,EAAE,EAAU;QACzC,MAAM,MAAM,GAAG,IAAA,gBAAI,EAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;QACtC,MAAM,MAAM,GAAG,IAAA,gBAAI,EAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,CAAA;QAEpC,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EACpD,EAAE,aAAa,EAAE,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;QAClD,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,IAAI,KAAK,CAAC,SAAS,KAAK,GAAG;gBACzB,OAAO,sBAAa,CAAA;;gBAEpB,MAAM,KAAK,CAAA;QACf,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,KAAK,CAAE,IAAY,EAAE,UAAuB,EAAE,MAAM,EAAE,KAAK,EAAE;QACzE,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QAE1B,IAAI,GAAG,KAAK,IAAI;YACd,OAAO,sBAAa,CAAA;QAEtB,kBAAO,CAAC,KAAK,CAAC,0BAA0B,EAAE;YACxC,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,IAAI;YACJ,GAAG;SACJ,CAAC,CAAA;QAEF,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAA;QAE1D,IAAI,QAAQ,YAAY,KAAK,IAAI,QAAQ,CAAC,EAAE,KAAK,KAAK,EAAE,CAAC;YACvD,kBAAO,CAAC,KAAK,CAAC,iCAAiC,EAAE;gBAC/C,GAAG;gBACH,MAAM,EAAE,QAAQ,CAAC,MAAM;gBACvB,OAAO,EAAE,QAAQ,CAAC,OAAO;aAC1B,CAAC,CAAA;YAEF,OAAO,sBAAa,CAAA;QACtB,CAAC;;YACC,kBAAO,CAAC,KAAK,CAAC,mCAAmC,EAAE;gBACjD,GAAG;gBACH,MAAM,EAAE,QAAQ,CAAC,MAAM;gBACvB,OAAO,EAAE,QAAQ,CAAC,OAAO;aAC1B,CAAC,CAAA;QAEJ,OAAO,QAAQ,CAAA;IACjB,CAAC;IAEO,GAAG,CAAE,IAAY;QACvB,MAAM,CAAC,IAAI,EAAE,cAAc,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAA;QAE1D,IAAI,IAAI,KAAK,IAAI;YACf,OAAO,IAAI,CAAA;QAEb,MAAM,EAAE,GAAG,IAAA,gBAAI,EAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;QAElC,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC,GAAG,CAAC,EAAE,EAAE;YAC/B,aAAa,EAAE,IAAI,CAAC,IAAI;YACxB,cAAc;YACd,OAAO,EAAE,CAAC;SACX,CAAC,CAAA;IACJ,CAAC;IAEO,gBAAgB,CAAE,IAAY;QACpC,IAAI,IAAI,CAAC,eAAe,CAAC,MAAM,KAAK,CAAC;YACnC,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC,CAAA;QAE1B,MAAM,CAAC,IAAI,EAAE,GAAG,UAAU,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAC7C,MAAM,eAAe,GAA4B,EAAE,CAAA;QAEnD,IAAI,CAAC,GAAG,CAAC,CAAA;QAET,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YACnC,IAAI,KAAK,GAAG,KAAK,CAAA;YAEjB,KAAK,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;gBACvD,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,cAAc,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAA;gBAEzF,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;gBAEnC,qCAAqC;gBACrC,IAAI,KAAK,KAAK,IAAI;oBAChB,IAAI,QAAQ,KAAK,IAAI;wBACnB,SAAQ;;wBAER,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC,CAAA;gBAE5B,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAA;gBACjF,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,KAAK,CAAC,MAAO,CAAC,CAAC,CAAA;gBAEnF,KAAK,GAAG,IAAI,CAAA;gBAEZ,IAAI,SAAS,KAAK,SAAS;oBACzB,eAAe,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAA;qBAC5B,CAAC;oBACJ,eAAe,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,CAAA;oBACvC,eAAe,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAA;oBAC/B,eAAe,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAA;gBACrC,CAAC;YACH,CAAC;YAED,IAAI,CAAC,KAAK;gBACR,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC,CAAA;QAC5B,CAAC;QAED,KAAK,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC,EAAE;YAC1C,IAAI,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,QAAQ,KAAK,IAAI;gBAC3C,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC,CAAA;QAE5B,OAAO,CAAC,IAAI,EAAE,eAAe,CAAC,CAAA;IAChC,CAAC;IAEO,iBAAiB,CAAE,OAAgC,EAAE,MAA8B;QACzF,OAAO,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YACrE,IAAI,OAAO,KAAK,KAAK,QAAQ;gBAC3B,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;YAErB,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC;gBAC9C,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;YAEpC,IAAI,GAAG,KAAK,MAAM,IAAI,KAAK,KAAK,SAAS;gBACvC,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAe,CAAC,GAAG,GAAG,CAAA;YAEhD,IAAI,GAAG,KAAK,cAAc,IAAI,KAAK,KAAK,MAAM;gBAC5C,KAAK,GAAG,KAAK,CAAA;YAEf,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;QACrB,CAAC,CAAC,CAAC,CAAA;IACL,CAAC;IAEO,QAAQ,CAAE,QAAkB;QAClC,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,KAAK,IAAI;YAC1D,CAAC,CAAC,IAAI;YACN,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAE,CAAC,CAAA;QAE5D,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAA;QACxE,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;QACzC,MAAM,QAAQ,GAAG,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,IAAA,oBAAQ,EAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;QAC3E,MAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAA;QAEnD,OAAO;YACL,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAE;YAC3C,IAAI;YACJ,QAAQ;YACR,OAAO;YACP,KAAK,EAAE,KAAK,IAAI,SAAS;YACzB,OAAO,EAAE,QAAQ,CAAC,MAAM,KAAK,GAAG;YAChC,UAAU,EAAE;gBACV,GAAG,EAAE,QAAQ,CAAC,GAAG;aAClB;SACF,CAAA;IACH,CAAC;IAEO,UAAU;QAChB,eAAU,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAE9B,OAAO,eAAU,CAAA;IACnB,CAAC;;AApRH,gCAqRC"}

package/transpiled/providers/Declaration.d.ts

@@ -1,14 +1,15 @@
 import type { S3Options } from './S3';
+import type { CloudinaryOptions } from './Cloudinary';
 import type { FileSystemOptions } from './FileSystem';
 import type { TemporaryOptions } from './Temporary';
 export type Declaration = ({
     provider: 's3';
 } & S3Options) | ({
+    provider: 'cloudinary';
+} & CloudinaryOptions) | ({
     provider: 'fs';
 } & FileSystemOptions) | ({
     provider: 'tmp';
 } & TemporaryOptions) | ({
-    provider: 'mem';
-}) | ({
     provider: 'test';
 } & TemporaryOptions);

package/transpiled/providers/FileSystem.d.ts

@@ -1,15 +1,23 @@
 /// <reference types="node" />
-import { type Readable } from 'node:stream';
 import { Provider } from '../Provider';
-import type { ProviderSecrets } from '../Provider';
+import type { Readable } from 'node:stream';
+import type { Maybe } from '@toa.io/types';
+import type { Metadata, Stream } from '../Entry';
 export interface FileSystemOptions {
     path: string;
+    claim?: string;
 }
 export declare class FileSystem extends Provider<FileSystemOptions> {
-    protected readonly path: string;
-    constructor(options: FileSystemOptions, secrets?: ProviderSecrets);
-    get(path: string): Promise<Readable | null>;
-    put(rel: string, filename: string, stream: Readable): Promise<void>;
+    readonly root: string;
+    constructor(options: FileSystemOptions);
+    get(rel: string): Promise<Maybe<Stream>>;
+    head(rel: string): Promise<Maybe<Metadata>>;
+    put(rel: string, stream: Readable): Promise<void>;
+    commit(rel: string, metadata: Metadata): Promise<void>;
     delete(path: string): Promise<void>;
-    move(from: string, to: string): Promise<void>;
+    move(from: string, to: string): Promise<Maybe<void>>;
+    private blob;
+    private meta;
+    private join;
+    private try;
 }

package/transpiled/providers/FileSystem.js

@@ -4,40 +4,80 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FileSystem = void 0;
-const node_path_1 = require("node:path");
 const promises_1 = __importDefault(require("node:fs/promises"));
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
 const Provider_1 = require("../Provider");
+const errors_1 = require("../errors");
 class FileSystem extends Provider_1.Provider {
-    path;
-    constructor(options, secrets) {
-        super(options, secrets);
-        this.path = options.path;
+    root;
+    constructor(options) {
+        super(options);
+        this.root = options.path;
     }
-    async get(path) {
-        try {
-            const fd = await promises_1.default.open((0, node_path_1.join)(this.path, path));
-            return fd.createReadStream();
-        }
-        catch (err) {
-            if (err?.code === 'ENOENT')
-                return null;
-            throw err;
-        }
+    async get(rel) {
+        const path = this.blob(rel);
+        const metadata = await this.head(rel);
+        if (metadata instanceof Error)
+            return metadata;
+        const stream = (0, node_fs_1.createReadStream)(path);
+        return { stream, ...metadata };
     }
-    async put(rel, filename, stream) {
-        const dir = (0, node_path_1.join)(this.path, rel);
-        const path = (0, node_path_1.join)(dir, filename);
-        await promises_1.default.mkdir((0, node_path_1.dirname)(path), { recursive: true });
+    async head(rel) {
+        const path = this.meta(rel);
+        return this.try(async () => {
+            const contents = await promises_1.default.readFile(path, 'utf8');
+            return JSON.parse(contents);
+        });
+    }
+    async put(rel, stream) {
+        const path = this.blob(rel);
+        const dir = (0, node_path_1.dirname)(path);
+        await promises_1.default.mkdir(dir, { recursive: true });
         await promises_1.default.writeFile(path, stream);
     }
+    async commit(rel, metadata) {
+        const path = this.meta(rel);
+        await promises_1.default.writeFile(path, JSON.stringify(metadata), 'utf8');
+    }
     async delete(path) {
-        await promises_1.default.rm((0, node_path_1.join)(this.path, path), { recursive: true, force: true });
+        await Promise.all([
+            promises_1.default.rm(this.blob(path), { force: true }),
+            promises_1.default.rm(this.meta(path), { force: true })
+        ]);
     }
     async move(from, to) {
-        from = (0, node_path_1.join)(this.path, from);
-        to = (0, node_path_1.join)(this.path, to);
-        await promises_1.default.mkdir((0, node_path_1.dirname)(to), { recursive: true });
-        await promises_1.default.rename(from, to);
+        const bf = this.blob(from);
+        const bt = this.blob(to);
+        const mf = this.meta(from);
+        const mt = this.meta(to);
+        await promises_1.default.mkdir((0, node_path_1.dirname)(bt), { recursive: true });
+        return await this.try(async () => {
+            await Promise.all([
+                promises_1.default.rename(bf, bt),
+                promises_1.default.rename(mf, mt)
+            ]);
+        });
+    }
+    blob(rel) {
+        return this.join(rel, '.blob');
+    }
+    meta(rel) {
+        return this.join(rel, '.meta');
+    }
+    join(rel, ext) {
+        return (0, node_path_1.join)(this.root, rel) + ext;
+    }
+    async try(action) {
+        try {
+            return await action();
+        }
+        catch (err) {
+            if (err?.code === 'ENOENT')
+                return errors_1.ERR_NOT_FOUND;
+            else
+                throw err;
+        }
     }
 }
 exports.FileSystem = FileSystem;

package/transpiled/providers/FileSystem.js.map

@@ -1 +1 @@
-{"version":3,"file":"FileSystem.js","sourceRoot":"","sources":["../../source/providers/FileSystem.ts"],"names":[],"mappings":";;;;;;AACA,yCAAyC;AACzC,gEAAiC;AACjC,0CAAsC;AAOtC,MAAa,UAAW,SAAQ,mBAA2B;IACtC,IAAI,CAAQ;IAE/B,YAAoB,OAA0B,EAAE,OAAyB;QACvE,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QAEvB,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAA;IAC1B,CAAC;IAEM,KAAK,CAAC,GAAG,CAAE,IAAY;QAC5B,IAAI,CAAC;YACH,MAAM,EAAE,GAAG,MAAM,kBAAE,CAAC,IAAI,CAAC,IAAA,gBAAI,EAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAA;YAE/C,OAAO,EAAE,CAAC,gBAAgB,EAAE,CAAA;QAC9B,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAK,GAA6B,EAAE,IAAI,KAAK,QAAQ;gBAAE,OAAO,IAAI,CAAA;YAElE,MAAM,GAAG,CAAA;QACX,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,GAAG,CAAE,GAAW,EAAE,QAAgB,EAAE,MAAgB;QAC/D,MAAM,GAAG,GAAG,IAAA,gBAAI,EAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;QAChC,MAAM,IAAI,GAAG,IAAA,gBAAI,EAAC,GAAG,EAAE,QAAQ,CAAC,CAAA;QAEhC,MAAM,kBAAE,CAAC,KAAK,CAAC,IAAA,mBAAO,EAAC,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;QAClD,MAAM,kBAAE,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IAClC,CAAC;IAEM,KAAK,CAAC,MAAM,CAAE,IAAY;QAC/B,MAAM,kBAAE,CAAC,EAAE,CAAC,IAAA,gBAAI,EAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;IACtE,CAAC;IAEM,KAAK,CAAC,IAAI,CAAE,IAAY,EAAE,EAAU;QACzC,IAAI,GAAG,IAAA,gBAAI,EAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;QAC5B,EAAE,GAAG,IAAA,gBAAI,EAAC,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA;QAExB,MAAM,kBAAE,CAAC,KAAK,CAAC,IAAA,mBAAO,EAAC,EAAE,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;QAChD,MAAM,kBAAE,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA;IAC3B,CAAC;CACF;AAxCD,gCAwCC"}
+{"version":3,"file":"FileSystem.js","sourceRoot":"","sources":["../../source/providers/FileSystem.ts"],"names":[],"mappings":";;;;;;AAAA,gEAAiC;AACjC,qCAA0C;AAC1C,yCAAyC;AACzC,0CAAsC;AACtC,sCAAyC;AAUzC,MAAa,UAAW,SAAQ,mBAA2B;IAChC,IAAI,CAAQ;IAErC,YAAoB,OAA0B;QAC5C,KAAK,CAAC,OAAO,CAAC,CAAA;QAEd,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAA;IAC1B,CAAC;IAEM,KAAK,CAAC,GAAG,CAAE,GAAW;QAC3B,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QAC3B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QAErC,IAAI,QAAQ,YAAY,KAAK;YAC3B,OAAO,QAAQ,CAAA;QAEjB,MAAM,MAAM,GAAG,IAAA,0BAAgB,EAAC,IAAI,CAAC,CAAA;QAErC,OAAO,EAAE,MAAM,EAAE,GAAG,QAAQ,EAAE,CAAA;IAChC,CAAC;IAEM,KAAK,CAAC,IAAI,CAAE,GAAW;QAC5B,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QAE3B,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE;YACzB,MAAM,QAAQ,GAAG,MAAM,kBAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;YAEhD,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAA;QAC7B,CAAC,CAAC,CAAA;IACJ,CAAC;IAEM,KAAK,CAAC,GAAG,CAAE,GAAW,EAAE,MAAgB;QAC7C,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QAC3B,MAAM,GAAG,GAAG,IAAA,mBAAO,EAAC,IAAI,CAAC,CAAA;QAEzB,MAAM,kBAAE,CAAC,KAAK,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;QACxC,MAAM,kBAAE,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IAClC,CAAC;IAEM,KAAK,CAAC,MAAM,CAAE,GAAW,EAAE,QAAkB;QAClD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QAE3B,MAAM,kBAAE,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAA;IAC5D,CAAC;IAEM,KAAK,CAAC,MAAM,CAAE,IAAY;QAC/B,MAAM,OAAO,CAAC,GAAG,CAAC;YAChB,kBAAE,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;YACvC,kBAAE,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;SACxC,CAAC,CAAA;IACJ,CAAC;IAEM,KAAK,CAAC,IAAI,CAAE,IAAY,EAAE,EAAU;QACzC,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAC1B,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACxB,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAC1B,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QAExB,MAAM,kBAAE,CAAC,KAAK,CAAC,IAAA,mBAAO,EAAC,EAAE,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;QAEhD,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE;YAC/B,MAAM,OAAO,CAAC,GAAG,CAAC;gBAChB,kBAAE,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC;gBACjB,kBAAE,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC;aAClB,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;IACJ,CAAC;IAEO,IAAI,CAAE,GAAW;QACvB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;IAChC,CAAC;IAEO,IAAI,CAAE,GAAW;QACvB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;IAChC,CAAC;IAEO,IAAI,CAAE,GAAW,EAAE,GAAW;QACpC,OAAO,IAAA,gBAAI,EAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,GAAG,GAAG,CAAA;IACnC,CAAC;IAEO,KAAK,CAAC,GAAG,CAAW,MAAwB;QAClD,IAAI,CAAC;YACH,OAAO,MAAM,MAAM,EAAE,CAAA;QACvB,CAAC;QAAC,OAAO,GAAgC,EAAE,CAAC;YAC1C,IAAI,GAAG,EAAE,IAAI,KAAK,QAAQ;gBACxB,OAAO,sBAAa,CAAA;;gBAEpB,MAAM,GAAG,CAAA;QACb,CAAC;IACH,CAAC;CACF;AA1FD,gCA0FC"}

package/transpiled/providers/S3.d.ts

@@ -1,27 +1,27 @@
 /// <reference types="node" />
 import { Readable } from 'node:stream';
-import { S3Client } from '@aws-sdk/client-s3';
-import { Provider, type ProviderSecret, type ProviderSecrets } from '../Provider';
+import { Provider } from '../Provider';
+import type { Maybe } from '@toa.io/types';
+import type { Metadata, Stream } from '../Entry';
+import type { Secret, Secrets } from '../Secrets';
 export interface S3Options {
     bucket: string;
     region?: string;
     prefix?: string;
     endpoint?: string;
 }
-type S3Secrets = ProviderSecrets<'ACCESS_KEY_ID' | 'SECRET_ACCESS_KEY'>;
+type S3Secrets = Secrets<'ACCESS_KEY_ID' | 'SECRET_ACCESS_KEY'>;
 export declare class S3 extends Provider<S3Options> {
-    static readonly SECRETS: readonly ProviderSecret[];
-    protected readonly bucket: string;
-    protected readonly client: S3Client;
+    static readonly SECRETS: readonly Secret[];
+    private readonly bucket;
+    private readonly client;
     constructor(options: S3Options, secrets?: S3Secrets);
-    get(Key: string): Promise<Readable | null>;
-    put(path: string, filename: string, stream: Readable): Promise<void>;
-    /**
-     * Deletes either a single object or "directory" - all objects
-     * with given prefix (prefix will be enforced to finish with `/`)
-     * @param Key - key name or path prefix
-     */
+    get(Key: string): Promise<Maybe<Stream>>;
+    head(Key: string): Promise<Maybe<Metadata>>;
+    put(Key: string, stream: Readable): Promise<void>;
+    commit(Key: string, metadata: object): Promise<void>;
     delete(Key: string): Promise<void>;
-    move(from: string, keyTo: string): Promise<void>;
+    move(from: string, keyTo: string): Promise<Maybe<void>>;
+    private try;
 }
 export {};