@aztec/stdlib 0.0.0-test.1 → 0.0.1-commit.023c3e5

package/dest/file-store/factory.d.ts

@@ -0,0 +1,7 @@
+import { type Logger } from '@aztec/foundation/log';
+import type { FileStore, ReadOnlyFileStore } from './interface.js';
+export declare function createFileStore(config: string, logger?: Logger): Promise<FileStore>;
+export declare function createFileStore(config: undefined, logger?: Logger): Promise<undefined>;
+export declare function createReadOnlyFileStore(config: string, logger?: Logger): Promise<ReadOnlyFileStore>;
+export declare function createReadOnlyFileStore(config: undefined, logger?: Logger): Promise<undefined>;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZmFjdG9yeS5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2ZpbGUtc3RvcmUvZmFjdG9yeS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsS0FBSyxNQUFNLEVBQWdCLE1BQU0sdUJBQXVCLENBQUM7QUFJbEUsT0FBTyxLQUFLLEVBQUUsU0FBUyxFQUFFLGlCQUFpQixFQUFFLE1BQU0sZ0JBQWdCLENBQUM7QUFXbkUsd0JBQXNCLGVBQWUsQ0FBQyxNQUFNLEVBQUUsTUFBTSxFQUFFLE1BQU0sQ0FBQyxFQUFFLE1BQU0sR0FBRyxPQUFPLENBQUMsU0FBUyxDQUFDLENBQUM7QUFDM0Ysd0JBQXNCLGVBQWUsQ0FBQyxNQUFNLEVBQUUsU0FBUyxFQUFFLE1BQU0sQ0FBQyxFQUFFLE1BQU0sR0FBRyxPQUFPLENBQUMsU0FBUyxDQUFDLENBQUM7QUE2QzlGLHdCQUFzQix1QkFBdUIsQ0FBQyxNQUFNLEVBQUUsTUFBTSxFQUFFLE1BQU0sQ0FBQyxFQUFFLE1BQU0sR0FBRyxPQUFPLENBQUMsaUJBQWlCLENBQUMsQ0FBQztBQUMzRyx3QkFBc0IsdUJBQXVCLENBQUMsTUFBTSxFQUFFLFNBQVMsRUFBRSxNQUFNLENBQUMsRUFBRSxNQUFNLEdBQUcsT0FBTyxDQUFDLFNBQVMsQ0FBQyxDQUFDIn0=

package/dest/file-store/factory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../../src/file-store/factory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAgB,MAAM,uBAAuB,CAAC;AAIlE,OAAO,KAAK,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAWnE,wBAAsB,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;AAC3F,wBAAsB,eAAe,CAAC,MAAM,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;AA6C9F,wBAAsB,uBAAuB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;AAC3G,wBAAsB,uBAAuB,CAAC,MAAM,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC"}

package/dest/file-store/factory.js

@@ -0,0 +1,64 @@
+import { createLogger } from '@aztec/foundation/log';
+import { GoogleCloudFileStore } from './gcs.js';
+import { HttpFileStore } from './http.js';
+import { LocalFileStore } from './local.js';
+import { S3FileStore } from './s3.js';
+const supportedExamples = [
+    `gs://bucket-name/path/to/store`,
+    `s3://bucket-name/path/to/store`,
+    `file:///absolute/local/path/to/store`,
+    `https://host/path`
+];
+export async function createFileStore(config, logger = createLogger('stdlib:file-store')) {
+    if (config === undefined) {
+        return undefined;
+    } else if (config.startsWith('file://')) {
+        const url = new URL(config);
+        if (url.host) {
+            throw new Error(`File store URL only supports local paths (got host ${url.host} from ${config})`);
+        }
+        const path = url.pathname;
+        logger.info(`Creating local file file store at ${path}`);
+        return new LocalFileStore(path);
+    } else if (config.startsWith('gs://')) {
+        try {
+            const url = new URL(config);
+            const bucket = url.host;
+            const path = url.pathname.replace(/^\/+/, '');
+            logger.info(`Creating google cloud file store at ${bucket} ${path}`);
+            const store = new GoogleCloudFileStore(bucket, path);
+            await store.checkCredentials();
+            return store;
+        } catch  {
+            throw new Error(`Invalid google cloud store definition: '${config}'.`);
+        }
+    } else if (config.startsWith('s3://')) {
+        try {
+            const url = new URL(config);
+            const bucket = url.host;
+            const path = url.pathname.replace(/^\/+/, '');
+            const endpoint = url.searchParams.get('endpoint');
+            const publicBaseUrl = url.searchParams.get('publicBaseUrl') ?? undefined;
+            logger.info(`Creating S3 file store at ${bucket} ${path}`);
+            const store = new S3FileStore(bucket, path, {
+                endpoint: endpoint ?? undefined,
+                publicBaseUrl
+            });
+            return store;
+        } catch  {
+            throw new Error(`Invalid S3 store definition: '${config}'.`);
+        }
+    } else {
+        throw new Error(`Unknown file store config: '${config}'. Supported values are ${supportedExamples.join(', ')}.`);
+    }
+}
+export async function createReadOnlyFileStore(config, logger = createLogger('stdlib:file-store')) {
+    if (config === undefined) {
+        return undefined;
+    } else if (config.startsWith('http://') || config.startsWith('https://')) {
+        logger.info(`Creating read-only HTTP file store at ${config}`);
+        return new HttpFileStore(config, logger);
+    } else {
+        return await createFileStore(config, logger);
+    }
+}

package/dest/file-store/gcs.d.ts

@@ -0,0 +1,20 @@
+import { type Logger } from '@aztec/foundation/log';
+import type { FileStore, FileStoreSaveOptions } from './interface.js';
+export declare class GoogleCloudFileStore implements FileStore {
+    private readonly bucketName;
+    private readonly basePath;
+    private readonly log;
+    private readonly storage;
+    constructor(bucketName: string, basePath: string, log?: Logger);
+    checkCredentials(): Promise<void>;
+    save(path: string, data: Buffer, opts?: FileStoreSaveOptions): Promise<string>;
+    upload(destPath: string, srcPath: string, opts?: FileStoreSaveOptions): Promise<string>;
+    private handleUploadedFile;
+    read(pathOrUrlStr: string): Promise<Buffer>;
+    download(pathOrUrlStr: string, destPath: string): Promise<void>;
+    exists(pathOrUrlStr: string): Promise<boolean>;
+    private getFileObject;
+    private getBucketAndFullPath;
+    private getFullPath;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZ2NzLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvZmlsZS1zdG9yZS9nY3MudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLEtBQUssTUFBTSxFQUFnQixNQUFNLHVCQUF1QixDQUFDO0FBS2xFLE9BQU8sS0FBSyxFQUFFLFNBQVMsRUFBRSxvQkFBb0IsRUFBRSxNQUFNLGdCQUFnQixDQUFDO0FBRXRFLHFCQUFhLG9CQUFxQixZQUFXLFNBQVM7SUFJbEQsT0FBTyxDQUFDLFFBQVEsQ0FBQyxVQUFVO0lBQzNCLE9BQU8sQ0FBQyxRQUFRLENBQUMsUUFBUTtJQUN6QixPQUFPLENBQUMsUUFBUSxDQUFDLEdBQUc7SUFMdEIsT0FBTyxDQUFDLFFBQVEsQ0FBQyxPQUFPLENBQVU7SUFFbEMsWUFDbUIsVUFBVSxFQUFFLE1BQU0sRUFDbEIsUUFBUSxFQUFFLE1BQU0sRUFDaEIsR0FBRyxHQUFFLE1BQThDLEVBR3JFO0lBRVksZ0JBQWdCLGtCQUU1QjtJQUVZLElBQUksQ0FDZixJQUFJLEVBQUUsTUFBTSxFQUNaLElBQUksRUFBRSxNQUFNLEVBQ1osSUFBSSxHQUFFLG9CQUF1RSxHQUM1RSxPQUFPLENBQUMsTUFBTSxDQUFDLENBVWpCO0lBRVksTUFBTSxDQUNqQixRQUFRLEVBQUUsTUFBTSxFQUNoQixPQUFPLEVBQUUsTUFBTSxFQUNmLElBQUksR0FBRSxvQkFBc0UsR0FDM0UsT0FBTyxDQUFDLE1BQU0sQ0FBQyxDQWVqQjtZQUVhLGtCQUFrQjtJQW1CbkIsSUFBSSxDQUFDLFlBQVksRUFBRSxNQUFNLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxDQUl2RDtJQUVZLFFBQVEsQ0FBQyxZQUFZLEVBQUUsTUFBTSxFQUFFLFFBQVEsRUFBRSxNQUFNLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUczRTtJQUVZLE1BQU0sQ0FBQyxZQUFZLEVBQUUsTUFBTSxHQUFHLE9BQU8sQ0FBQyxPQUFPLENBQUMsQ0FNMUQ7WUFFYSxhQUFhO0lBVTNCLE9BQU8sQ0FBQyxvQkFBb0I7SUFVNUIsT0FBTyxDQUFDLFdBQVc7Q0FHcEIifQ==

package/dest/file-store/gcs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"gcs.d.ts","sourceRoot":"","sources":["../../src/file-store/gcs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAgB,MAAM,uBAAuB,CAAC;AAKlE,OAAO,KAAK,EAAE,SAAS,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAEtE,qBAAa,oBAAqB,YAAW,SAAS;IAIlD,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,GAAG;IALtB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAU;IAElC,YACmB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,GAAG,GAAE,MAA8C,EAGrE;IAEY,gBAAgB,kBAE5B;IAEY,IAAI,CACf,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,IAAI,GAAE,oBAAuE,GAC5E,OAAO,CAAC,MAAM,CAAC,CAUjB;IAEY,MAAM,CACjB,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EACf,IAAI,GAAE,oBAAsE,GAC3E,OAAO,CAAC,MAAM,CAAC,CAejB;YAEa,kBAAkB;IAmBnB,IAAI,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAIvD;IAEY,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAG3E;IAEY,MAAM,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAM1D;YAEa,aAAa;IAU3B,OAAO,CAAC,oBAAoB;IAU5B,OAAO,CAAC,WAAW;CAGpB"}

package/dest/file-store/gcs.js

@@ -0,0 +1,115 @@
+import { createLogger } from '@aztec/foundation/log';
+import { Storage } from '@google-cloud/storage';
+import { join } from 'path';
+export class GoogleCloudFileStore {
+    bucketName;
+    basePath;
+    log;
+    storage;
+    constructor(bucketName, basePath, log = createLogger('stdlib:gcs-file-store')){
+        this.bucketName = bucketName;
+        this.basePath = basePath;
+        this.log = log;
+        this.storage = new Storage();
+    }
+    async checkCredentials() {
+        await this.storage.getServiceAccount();
+    }
+    async save(path, data, opts = {
+        public: false,
+        metadata: {},
+        compress: false
+    }) {
+        const fullPath = this.getFullPath(path);
+        try {
+            const bucket = this.storage.bucket(this.bucketName);
+            const file = bucket.file(fullPath);
+            await file.save(data, {
+                metadata: opts.metadata,
+                gzip: opts.compress
+            });
+            return this.handleUploadedFile(file, opts);
+        } catch (err) {
+            throw new Error(`Error saving file to google cloud storage at ${fullPath}: ${err.message ?? err}`);
+        }
+    }
+    async upload(destPath, srcPath, opts = {
+        compress: true,
+        public: false,
+        metadata: {}
+    }) {
+        const fullPath = this.getFullPath(destPath);
+        try {
+            const bucket = this.storage.bucket(this.bucketName);
+            const file = bucket.file(fullPath);
+            const uploadOpts = {
+                destination: file,
+                gzip: opts.compress,
+                metadata: opts.metadata
+            };
+            await bucket.upload(srcPath, uploadOpts);
+            return this.handleUploadedFile(file, opts);
+        } catch (err) {
+            throw new Error(`Error saving file to google cloud storage at ${fullPath}: ${err.message ?? err}`);
+        }
+    }
+    async handleUploadedFile(file, opts) {
+        if (opts.public) {
+            try {
+                if (!await file.isPublic()) {
+                    await file.makePublic();
+                }
+            } catch (err) {
+                this.log.warn(`Error making file ${file.name} public: ${err.message ?? err}. This is expected if we handle public access at the bucket level.`);
+            }
+            return file.publicUrl().replaceAll('%2F', '/');
+        } else {
+            return file.cloudStorageURI.toString();
+        }
+    }
+    async read(pathOrUrlStr) {
+        const file = await this.getFileObject(pathOrUrlStr);
+        const contents = await file.download();
+        return contents[0];
+    }
+    async download(pathOrUrlStr, destPath) {
+        const file = await this.getFileObject(pathOrUrlStr);
+        await file.download({
+            destination: destPath
+        });
+    }
+    async exists(pathOrUrlStr) {
+        const { bucketName, fullPath } = this.getBucketAndFullPath(pathOrUrlStr);
+        const bucket = this.storage.bucket(bucketName);
+        const file = bucket.file(fullPath);
+        const [exists] = await file.exists();
+        return exists;
+    }
+    async getFileObject(pathOrUrlStr) {
+        const { bucketName, fullPath } = this.getBucketAndFullPath(pathOrUrlStr);
+        const bucket = this.storage.bucket(bucketName);
+        const file = bucket.file(fullPath);
+        if (!await file.exists()) {
+            throw new Error(`File at ${fullPath} in gcs bucket ${bucketName} does not exist`);
+        }
+        return file;
+    }
+    getBucketAndFullPath(pathOrUrlStr) {
+        if (URL.canParse(pathOrUrlStr)) {
+            const url = new URL(pathOrUrlStr);
+            // Note that we accept reading from anywhere, not just our bucket
+            return {
+                fullPath: url.pathname.replace(/^\/+/, ''),
+                bucketName: url.host
+            };
+        } else {
+            return {
+                fullPath: this.getFullPath(pathOrUrlStr),
+                bucketName: this.bucketName
+            };
+        }
+    }
+    getFullPath(path) {
+        return this.basePath && this.basePath.length > 0 ? join(this.basePath, path) : path;
+    }
+}

package/dest/file-store/http.d.ts

@@ -0,0 +1,14 @@
+import { type Logger } from '@aztec/foundation/log';
+import type { ReadOnlyFileStore } from './interface.js';
+export declare class HttpFileStore implements ReadOnlyFileStore {
+    private readonly baseUrl;
+    private readonly log;
+    private readonly axiosInstance;
+    private readonly fetch;
+    constructor(baseUrl: string, log?: Logger);
+    read(pathOrUrl: string): Promise<Buffer>;
+    download(pathOrUrl: string, destPath: string): Promise<void>;
+    exists(pathOrUrl: string): Promise<boolean>;
+    private getUrl;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaHR0cC5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2ZpbGUtc3RvcmUvaHR0cC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsS0FBSyxNQUFNLEVBQWdCLE1BQU0sdUJBQXVCLENBQUM7QUFVbEUsT0FBTyxLQUFLLEVBQUUsaUJBQWlCLEVBQUUsTUFBTSxnQkFBZ0IsQ0FBQztBQUV4RCxxQkFBYSxhQUFjLFlBQVcsaUJBQWlCO0lBS25ELE9BQU8sQ0FBQyxRQUFRLENBQUMsT0FBTztJQUN4QixPQUFPLENBQUMsUUFBUSxDQUFDLEdBQUc7SUFMdEIsT0FBTyxDQUFDLFFBQVEsQ0FBQyxhQUFhLENBQWdCO0lBQzlDLE9BQU8sQ0FBQyxRQUFRLENBQUMsS0FBSyxDQUErRDtJQUVyRixZQUNtQixPQUFPLEVBQUUsTUFBTSxFQUNmLEdBQUcsR0FBRSxNQUErQyxFQVl0RTtJQUVZLElBQUksQ0FBQyxTQUFTLEVBQUUsTUFBTSxHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FRcEQ7SUFFWSxRQUFRLENBQUMsU0FBUyxFQUFFLE1BQU0sRUFBRSxRQUFRLEVBQUUsTUFBTSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FZeEU7SUFFWSxNQUFNLENBQUMsU0FBUyxFQUFFLE1BQU0sR0FBRyxPQUFPLENBQUMsT0FBTyxDQUFDLENBUXZEO0lBRUQsT0FBTyxDQUFDLE1BQU07Q0FHZiJ9

package/dest/file-store/http.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"http.d.ts","sourceRoot":"","sources":["../../src/file-store/http.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAgB,MAAM,uBAAuB,CAAC;AAUlE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAExD,qBAAa,aAAc,YAAW,iBAAiB;IAKnD,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,GAAG;IALtB,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAgB;IAC9C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAA+D;IAErF,YACmB,OAAO,EAAE,MAAM,EACf,GAAG,GAAE,MAA+C,EAYtE;IAEY,IAAI,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAQpD;IAEY,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAYxE;IAEY,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAQvD;IAED,OAAO,CAAC,MAAM;CAGf"}

package/dest/file-store/http.js

@@ -0,0 +1,74 @@
+import { createLogger } from '@aztec/foundation/log';
+import { makeBackoff, retry } from '@aztec/foundation/retry';
+import axios from 'axios';
+import { createWriteStream } from 'fs';
+import { mkdir } from 'fs/promises';
+import { dirname } from 'path';
+import { pipeline } from 'stream/promises';
+export class HttpFileStore {
+    baseUrl;
+    log;
+    axiosInstance;
+    fetch;
+    constructor(baseUrl, log = createLogger('stdlib:http-file-store')){
+        this.baseUrl = baseUrl;
+        this.log = log;
+        this.axiosInstance = axios.create();
+        this.fetch = async (config)=>{
+            return await retry(()=>this.axiosInstance.request(config), `Fetching ${config.url}`, makeBackoff([
+                1,
+                1,
+                3
+            ]), this.log, /*failSilently=*/ true);
+        };
+    }
+    async read(pathOrUrl) {
+        const url = this.getUrl(pathOrUrl);
+        try {
+            const response = await this.fetch({
+                url,
+                method: 'GET',
+                responseType: 'arraybuffer'
+            });
+            return Buffer.from(response.data);
+        } catch (error) {
+            throw new Error(`Error fetching file from ${url}: ${error instanceof Error ? error.message : String(error)}`);
+        }
+    }
+    async download(pathOrUrl, destPath) {
+        const url = this.getUrl(pathOrUrl);
+        try {
+            this.log.debug(`Downloading file from ${url} to ${destPath}`);
+            const response = await this.fetch({
+                url,
+                method: 'GET',
+                responseType: 'stream'
+            });
+            this.log.debug(`Response ${response.status} (${response.statusText}) from ${url}, writing to ${destPath}`);
+            await mkdir(dirname(destPath), {
+                recursive: true
+            });
+            await pipeline(response.data, createWriteStream(destPath));
+            this.log.debug(`Download of ${url} to ${destPath} complete`);
+        } catch (error) {
+            throw new Error(`Error fetching file from ${url}`, {
+                cause: error
+            });
+        }
+    }
+    async exists(pathOrUrl) {
+        const url = this.getUrl(pathOrUrl);
+        try {
+            await this.fetch({
+                url,
+                method: 'HEAD'
+            });
+            return true;
+        } catch  {
+            return false;
+        }
+    }
+    getUrl(path) {
+        return URL.canParse(path) ? path : `${this.baseUrl.replace(/\/$/, '')}/${path}`;
+    }
+}

package/dest/file-store/index.d.ts

@@ -0,0 +1,3 @@
+export * from './interface.js';
+export * from './factory.js';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9maWxlLXN0b3JlL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLGNBQWMsZ0JBQWdCLENBQUM7QUFDL0IsY0FBYyxjQUFjLENBQUMifQ==

package/dest/file-store/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/file-store/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC"}

package/dest/file-store/index.js

@@ -0,0 +1,2 @@
+export * from './interface.js';
+export * from './factory.js';

package/dest/file-store/interface.d.ts

@@ -0,0 +1,28 @@
+/** Simple read-only file store. */
+export interface ReadOnlyFileStore {
+    /** Reads a file given a path, or an URI as returned by calling `save`. Returns file contents. */
+    read(pathOrUrl: string): Promise<Buffer>;
+    /** Downloads a file given a path, or an URI as returned by calling `save`. Saves file to local path. */
+    download(pathOrUrlStr: string, destPath: string): Promise<void>;
+    /** Returns whether a file at the given path or URI exists. */
+    exists(pathOrUrl: string): Promise<boolean>;
+}
+export type FileStoreSaveOptions = {
+    public?: boolean;
+    metadata?: Record<string, string>;
+    compress?: boolean;
+};
+/** Simple file store. */
+export interface FileStore extends ReadOnlyFileStore {
+    /**
+     * Saves contents to the given path. Returns an URI that can be used later to `read` the file.
+     * Default: `compress` is false unless explicitly set.
+     */
+    save(path: string, data: Buffer, opts?: FileStoreSaveOptions): Promise<string>;
+    /**
+     * Uploads contents from a local file. Returns an URI that can be used later to `read` the file.
+     * Default: `compress` is true unless explicitly set to false.
+     */
+    upload(destPath: string, srcPath: string, opts?: FileStoreSaveOptions): Promise<string>;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW50ZXJmYWNlLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvZmlsZS1zdG9yZS9pbnRlcmZhY2UudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsbUNBQW1DO0FBQ25DLE1BQU0sV0FBVyxpQkFBaUI7SUFDaEMsaUdBQWlHO0lBQ2pHLElBQUksQ0FBQyxTQUFTLEVBQUUsTUFBTSxHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FBQztJQUN6Qyx3R0FBd0c7SUFDeEcsUUFBUSxDQUFDLFlBQVksRUFBRSxNQUFNLEVBQUUsUUFBUSxFQUFFLE1BQU0sR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUM7SUFDaEUsOERBQThEO0lBQzlELE1BQU0sQ0FBQyxTQUFTLEVBQUUsTUFBTSxHQUFHLE9BQU8sQ0FBQyxPQUFPLENBQUMsQ0FBQztDQUM3QztBQUVELE1BQU0sTUFBTSxvQkFBb0IsR0FBRztJQUFFLE1BQU0sQ0FBQyxFQUFFLE9BQU8sQ0FBQztJQUFDLFFBQVEsQ0FBQyxFQUFFLE1BQU0sQ0FBQyxNQUFNLEVBQUUsTUFBTSxDQUFDLENBQUM7SUFBQyxRQUFRLENBQUMsRUFBRSxPQUFPLENBQUE7Q0FBRSxDQUFDO0FBRS9HLHlCQUF5QjtBQUN6QixNQUFNLFdBQVcsU0FBVSxTQUFRLGlCQUFpQjtJQUNsRDs7O09BR0c7SUFDSCxJQUFJLENBQUMsSUFBSSxFQUFFLE1BQU0sRUFBRSxJQUFJLEVBQUUsTUFBTSxFQUFFLElBQUksQ0FBQyxFQUFFLG9CQUFvQixHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FBQztJQUMvRTs7O09BR0c7SUFDSCxNQUFNLENBQUMsUUFBUSxFQUFFLE1BQU0sRUFBRSxPQUFPLEVBQUUsTUFBTSxFQUFFLElBQUksQ0FBQyxFQUFFLG9CQUFvQixHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FBQztDQUN6RiJ9

package/dest/file-store/interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"interface.d.ts","sourceRoot":"","sources":["../../src/file-store/interface.ts"],"names":[],"mappings":"AAAA,mCAAmC;AACnC,MAAM,WAAW,iBAAiB;IAChC,iGAAiG;IACjG,IAAI,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACzC,wGAAwG;IACxG,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAChE,8DAA8D;IAC9D,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CAC7C;AAED,MAAM,MAAM,oBAAoB,GAAG;IAAE,MAAM,CAAC,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC;AAE/G,yBAAyB;AACzB,MAAM,WAAW,SAAU,SAAQ,iBAAiB;IAClD;;;OAGG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC/E;;;OAGG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CACzF"}

package/dest/file-store/interface.js

@@ -0,0 +1 @@
+/** Simple read-only file store. */ /** Simple file store. */ export { };

package/dest/file-store/local.d.ts

@@ -0,0 +1,14 @@
+import type { FileStore } from './interface.js';
+export declare class LocalFileStore implements FileStore {
+    private readonly basePath;
+    constructor(basePath: string);
+    save(path: string, data: Buffer): Promise<string>;
+    upload(destPath: string, srcPath: string, _opts: {
+        compress: boolean;
+    }): Promise<string>;
+    read(pathOrUrlStr: string): Promise<Buffer>;
+    download(pathOrUrlStr: string, destPath: string): Promise<void>;
+    exists(pathOrUrlStr: string): Promise<boolean>;
+    private getFullPath;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibG9jYWwuZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9maWxlLXN0b3JlL2xvY2FsLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUdBLE9BQU8sS0FBSyxFQUFFLFNBQVMsRUFBRSxNQUFNLGdCQUFnQixDQUFDO0FBRWhELHFCQUFhLGNBQWUsWUFBVyxTQUFTO0lBQ2xDLE9BQU8sQ0FBQyxRQUFRLENBQUMsUUFBUTtJQUFyQyxZQUE2QixRQUFRLEVBQUUsTUFBTSxFQUFJO0lBRXBDLElBQUksQ0FBQyxJQUFJLEVBQUUsTUFBTSxFQUFFLElBQUksRUFBRSxNQUFNLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxDQUs3RDtJQUVZLE1BQU0sQ0FBQyxRQUFRLEVBQUUsTUFBTSxFQUFFLE9BQU8sRUFBRSxNQUFNLEVBQUUsS0FBSyxFQUFFO1FBQUUsUUFBUSxFQUFFLE9BQU8sQ0FBQTtLQUFFLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxDQUdwRztJQUVNLElBQUksQ0FBQyxZQUFZLEVBQUUsTUFBTSxHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FHakQ7SUFFWSxRQUFRLENBQUMsWUFBWSxFQUFFLE1BQU0sRUFBRSxRQUFRLEVBQUUsTUFBTSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FJM0U7SUFFTSxNQUFNLENBQUMsWUFBWSxFQUFFLE1BQU0sR0FBRyxPQUFPLENBQUMsT0FBTyxDQUFDLENBS3BEO0lBRUQsT0FBTyxDQUFDLFdBQVc7Q0FPcEIifQ==

package/dest/file-store/local.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"local.d.ts","sourceRoot":"","sources":["../../src/file-store/local.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEhD,qBAAa,cAAe,YAAW,SAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAArC,YAA6B,QAAQ,EAAE,MAAM,EAAI;IAEpC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAK7D;IAEY,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE;QAAE,QAAQ,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAGpG;IAEM,IAAI,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAGjD;IAEY,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAI3E;IAEM,MAAM,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAKpD;IAED,OAAO,CAAC,WAAW;CAOpB"}

package/dest/file-store/local.js

@@ -0,0 +1,40 @@
+import { access, mkdir, readFile, writeFile } from 'fs/promises';
+import { dirname, resolve } from 'path';
+export class LocalFileStore {
+    basePath;
+    constructor(basePath){
+        this.basePath = basePath;
+    }
+    async save(path, data) {
+        const fullPath = this.getFullPath(path);
+        await mkdir(dirname(fullPath), {
+            recursive: true
+        });
+        await writeFile(fullPath, data);
+        return `file://${fullPath}`;
+    }
+    async upload(destPath, srcPath, _opts) {
+        const data = await readFile(srcPath);
+        return this.save(destPath, data);
+    }
+    read(pathOrUrlStr) {
+        const fullPath = this.getFullPath(pathOrUrlStr);
+        return readFile(fullPath);
+    }
+    async download(pathOrUrlStr, destPath) {
+        const data = await this.read(pathOrUrlStr);
+        const fullPath = this.getFullPath(destPath);
+        await writeFile(fullPath, data);
+    }
+    exists(pathOrUrlStr) {
+        const fullPath = this.getFullPath(pathOrUrlStr);
+        return access(fullPath).then(()=>true).catch(()=>false);
+    }
+    getFullPath(pathOrUrl) {
+        if (URL.canParse(pathOrUrl)) {
+            return new URL(pathOrUrl).pathname;
+        } else {
+            return resolve(this.basePath, pathOrUrl);
+        }
+    }
+}

package/dest/file-store/s3.d.ts

@@ -0,0 +1,26 @@
+import { type Logger } from '@aztec/foundation/log';
+import type { FileStore, FileStoreSaveOptions } from './interface.js';
+export declare class S3FileStore implements FileStore {
+    private readonly bucketName;
+    private readonly basePath;
+    private readonly log;
+    private readonly s3;
+    private readonly region;
+    private readonly endpoint?;
+    private readonly publicBaseUrl?;
+    constructor(bucketName: string, basePath: string, opts: {
+        endpoint?: string;
+        publicBaseUrl?: string;
+    }, log?: Logger);
+    save(path: string, data: Buffer, opts?: FileStoreSaveOptions): Promise<string>;
+    upload(destPath: string, srcPath: string, opts?: FileStoreSaveOptions): Promise<string>;
+    read(pathOrUrlStr: string): Promise<Buffer>;
+    download(pathOrUrlStr: string, destPath: string): Promise<void>;
+    exists(pathOrUrlStr: string): Promise<boolean>;
+    private extractUserMetadata;
+    private detectContentType;
+    private buildReturnedUrl;
+    private getBucketAndKey;
+    private getFullPath;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiczMuZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9maWxlLXN0b3JlL3MzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxLQUFLLE1BQU0sRUFBZ0IsTUFBTSx1QkFBdUIsQ0FBQztBQWlCbEUsT0FBTyxLQUFLLEVBQUUsU0FBUyxFQUFFLG9CQUFvQixFQUFFLE1BQU0sZ0JBQWdCLENBQUM7QUFNdEUscUJBQWEsV0FBWSxZQUFXLFNBQVM7SUFPekMsT0FBTyxDQUFDLFFBQVEsQ0FBQyxVQUFVO0lBQzNCLE9BQU8sQ0FBQyxRQUFRLENBQUMsUUFBUTtJQUV6QixPQUFPLENBQUMsUUFBUSxDQUFDLEdBQUc7SUFUdEIsT0FBTyxDQUFDLFFBQVEsQ0FBQyxFQUFFLENBQVc7SUFDOUIsT0FBTyxDQUFDLFFBQVEsQ0FBQyxNQUFNLENBQVM7SUFDaEMsT0FBTyxDQUFDLFFBQVEsQ0FBQyxRQUFRLENBQUMsQ0FBUztJQUNuQyxPQUFPLENBQUMsUUFBUSxDQUFDLGFBQWEsQ0FBQyxDQUFTO0lBRXhDLFlBQ21CLFVBQVUsRUFBRSxNQUFNLEVBQ2xCLFFBQVEsRUFBRSxNQUFNLEVBQ2pDLElBQUksRUFBRTtRQUFFLFFBQVEsQ0FBQyxFQUFFLE1BQU0sQ0FBQztRQUFDLGFBQWEsQ0FBQyxFQUFFLE1BQU0sQ0FBQTtLQUFFLEVBQ2xDLEdBQUcsR0FBRSxNQUE2QyxFQWVwRTtJQUVZLElBQUksQ0FBQyxJQUFJLEVBQUUsTUFBTSxFQUFFLElBQUksRUFBRSxNQUFNLEVBQUUsSUFBSSxHQUFFLG9CQUF5QixHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FrQjlGO0lBRVksTUFBTSxDQUFDLFFBQVEsRUFBRSxNQUFNLEVBQUUsT0FBTyxFQUFFLE1BQU0sRUFBRSxJQUFJLEdBQUUsb0JBQXlCLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxDQXdEdkc7SUFFWSxJQUFJLENBQUMsWUFBWSxFQUFFLE1BQU0sR0FBRyxPQUFPLENBQUMsTUFBTSxDQUFDLENBU3ZEO0lBRVksUUFBUSxDQUFDLFlBQVksRUFBRSxNQUFNLEVBQUUsUUFBUSxFQUFFLE1BQU0sR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLENBSzNFO0lBRVksTUFBTSxDQUFDLFlBQVksRUFBRSxNQUFNLEdBQUcsT0FBTyxDQUFDLE9BQU8sQ0FBQyxDQWExRDtJQUVELE9BQU8sQ0FBQyxtQkFBbUI7SUFRM0IsT0FBTyxDQUFDLGlCQUFpQjtJQXNCekIsT0FBTyxDQUFDLGdCQUFnQjtJQTBCeEIsT0FBTyxDQUFDLGVBQWU7SUEyQnZCLE9BQU8sQ0FBQyxXQUFXO0NBS3BCIn0=

package/dest/file-store/s3.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"s3.d.ts","sourceRoot":"","sources":["../../src/file-store/s3.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAgB,MAAM,uBAAuB,CAAC;AAiBlE,OAAO,KAAK,EAAE,SAAS,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAMtE,qBAAa,WAAY,YAAW,SAAS;IAOzC,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAEzB,OAAO,CAAC,QAAQ,CAAC,GAAG;IATtB,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAW;IAC9B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAS;IAExC,YACmB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EACjC,IAAI,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,aAAa,CAAC,EAAE,MAAM,CAAA;KAAE,EAClC,GAAG,GAAE,MAA6C,EAepE;IAEY,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,oBAAyB,GAAG,OAAO,CAAC,MAAM,CAAC,CAkB9F;IAEY,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,GAAE,oBAAyB,GAAG,OAAO,CAAC,MAAM,CAAC,CAwDvG;IAEY,IAAI,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CASvD;IAEY,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAK3E;IAEY,MAAM,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAa1D;IAED,OAAO,CAAC,mBAAmB;IAQ3B,OAAO,CAAC,iBAAiB;IAsBzB,OAAO,CAAC,gBAAgB;IA0BxB,OAAO,CAAC,eAAe;IA2BvB,OAAO,CAAC,WAAW;CAKpB"}