@aztec/stdlib 0.0.0-test.1 → 0.0.1-commit.017a351

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,21 @@
+import { type Logger } from '@aztec/foundation/log';
+import type { ReadOnlyFileStore } from './interface.js';
+/** Options for configuring HttpFileStore behavior. */
+export interface HttpFileStoreOptions {
+    /** Retry backoff intervals in seconds. Empty array disables retries. Default: [1, 1, 3]. */
+    retryBackoff?: number[];
+    /** Request timeout in milliseconds. Default: no timeout (axios default). */
+    timeoutMs?: number;
+}
+export declare class HttpFileStore implements ReadOnlyFileStore {
+    private readonly baseUrl;
+    private readonly log;
+    private readonly axiosInstance;
+    private readonly fetch;
+    constructor(baseUrl: string, log?: Logger, options?: HttpFileStoreOptions);
+    read(pathOrUrl: string): Promise<Buffer>;
+    download(pathOrUrl: string, destPath: string): Promise<void>;
+    exists(pathOrUrl: string): Promise<boolean>;
+    private getUrl;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaHR0cC5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2ZpbGUtc3RvcmUvaHR0cC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsS0FBSyxNQUFNLEVBQWdCLE1BQU0sdUJBQXVCLENBQUM7QUFVbEUsT0FBTyxLQUFLLEVBQUUsaUJBQWlCLEVBQUUsTUFBTSxnQkFBZ0IsQ0FBQztBQUV4RCxzREFBc0Q7QUFDdEQsTUFBTSxXQUFXLG9CQUFvQjtJQUNuQyw0RkFBNEY7SUFDNUYsWUFBWSxDQUFDLEVBQUUsTUFBTSxFQUFFLENBQUM7SUFDeEIsNEVBQTRFO0lBQzVFLFNBQVMsQ0FBQyxFQUFFLE1BQU0sQ0FBQztDQUNwQjtBQUVELHFCQUFhLGFBQWMsWUFBVyxpQkFBaUI7SUFLbkQsT0FBTyxDQUFDLFFBQVEsQ0FBQyxPQUFPO0lBQ3hCLE9BQU8sQ0FBQyxRQUFRLENBQUMsR0FBRztJQUx0QixPQUFPLENBQUMsUUFBUSxDQUFDLGFBQWEsQ0FBZ0I7SUFDOUMsT0FBTyxDQUFDLFFBQVEsQ0FBQyxLQUFLLENBQStEO0lBRXJGLFlBQ21CLE9BQU8sRUFBRSxNQUFNLEVBQ2YsR0FBRyxHQUFFLE1BQStDLEVBQ3JFLE9BQU8sQ0FBQyxFQUFFLG9CQUFvQixFQXNCL0I7SUFFWSxJQUFJLENBQUMsU0FBUyxFQUFFLE1BQU0sR0FBRyxPQUFPLENBQUMsTUFBTSxDQUFDLENBUXBEO0lBRVksUUFBUSxDQUFDLFNBQVMsRUFBRSxNQUFNLEVBQUUsUUFBUSxFQUFFLE1BQU0sR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLENBWXhFO0lBRVksTUFBTSxDQUFDLFNBQVMsRUFBRSxNQUFNLEdBQUcsT0FBTyxDQUFDLE9BQU8sQ0FBQyxDQVF2RDtJQUVELE9BQU8sQ0FBQyxNQUFNO0NBR2YifQ==

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,sDAAsD;AACtD,MAAM,WAAW,oBAAoB;IACnC,4FAA4F;IAC5F,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,4EAA4E;IAC5E,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,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,EACrE,OAAO,CAAC,EAAE,oBAAoB,EAsB/B;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,85 @@
+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'), options){
+        this.baseUrl = baseUrl;
+        this.log = log;
+        this.axiosInstance = axios.create({
+            ...options?.timeoutMs !== undefined && {
+                timeout: options.timeoutMs
+            }
+        });
+        const retryBackoff = options?.retryBackoff ?? [
+            1,
+            1,
+            3
+        ];
+        if (retryBackoff.length > 0) {
+            this.fetch = async (config)=>{
+                return await retry(()=>this.axiosInstance.request(config), `Fetching ${config.url}`, makeBackoff(retryBackoff), this.log, /*failSilently=*/ true);
+            };
+        } else {
+            this.fetch = async (config)=>{
+                return await this.axiosInstance.request(config);
+            };
+        }
+    }
+    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,4 @@
+export * from './interface.js';
+export * from './factory.js';
+export { type HttpFileStoreOptions } from './http.js';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9maWxlLXN0b3JlL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLGNBQWMsZ0JBQWdCLENBQUM7QUFDL0IsY0FBYyxjQUFjLENBQUM7QUFDN0IsT0FBTyxFQUFFLEtBQUssb0JBQW9CLEVBQUUsTUFBTSxXQUFXLENBQUMifQ==

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;AAC7B,OAAO,EAAE,KAAK,oBAAoB,EAAE,MAAM,WAAW,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, FileStoreSaveOptions } from './interface.js';
+export declare class LocalFileStore implements FileStore {
+    private readonly basePath;
+    constructor(basePath: string);
+    save(path: string, data: Buffer, opts?: FileStoreSaveOptions): 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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibG9jYWwuZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9maWxlLXN0b3JlL2xvY2FsLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUtBLE9BQU8sS0FBSyxFQUFFLFNBQVMsRUFBRSxvQkFBb0IsRUFBRSxNQUFNLGdCQUFnQixDQUFDO0FBS3RFLHFCQUFhLGNBQWUsWUFBVyxTQUFTO0lBQ2xDLE9BQU8sQ0FBQyxRQUFRLENBQUMsUUFBUTtJQUFyQyxZQUE2QixRQUFRLEVBQUUsTUFBTSxFQUFJO0lBRXBDLElBQUksQ0FBQyxJQUFJLEVBQUUsTUFBTSxFQUFFLElBQUksRUFBRSxNQUFNLEVBQUUsSUFBSSxDQUFDLEVBQUUsb0JBQW9CLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxDQU0xRjtJQUVZLE1BQU0sQ0FBQyxRQUFRLEVBQUUsTUFBTSxFQUFFLE9BQU8sRUFBRSxNQUFNLEVBQUUsS0FBSyxFQUFFO1FBQUUsUUFBUSxFQUFFLE9BQU8sQ0FBQTtLQUFFLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxDQUdwRztJQUVZLElBQUksQ0FBQyxZQUFZLEVBQUUsTUFBTSxHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FPdkQ7SUFFWSxRQUFRLENBQUMsWUFBWSxFQUFFLE1BQU0sRUFBRSxRQUFRLEVBQUUsTUFBTSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FJM0U7SUFFTSxNQUFNLENBQUMsWUFBWSxFQUFFLE1BQU0sR0FBRyxPQUFPLENBQUMsT0FBTyxDQUFDLENBS3BEO0lBRUQsT0FBTyxDQUFDLFdBQVc7Q0FPcEIifQ==

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":"AAKA,OAAO,KAAK,EAAE,SAAS,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAKtE,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,EAAE,IAAI,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,MAAM,CAAC,CAM1F;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;IAEY,IAAI,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAOvD;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,49 @@
+import { access, mkdir, readFile, writeFile } from 'fs/promises';
+import { dirname, resolve } from 'path';
+import { promisify } from 'util';
+import { gunzip as gunzipCb, gzip as gzipCb } from 'zlib';
+const gzip = promisify(gzipCb);
+const gunzip = promisify(gunzipCb);
+export class LocalFileStore {
+    basePath;
+    constructor(basePath){
+        this.basePath = basePath;
+    }
+    async save(path, data, opts) {
+        const fullPath = this.getFullPath(path);
+        await mkdir(dirname(fullPath), {
+            recursive: true
+        });
+        const toWrite = opts?.compress ? await gzip(data) : data;
+        await writeFile(fullPath, toWrite);
+        return `file://${fullPath}`;
+    }
+    async upload(destPath, srcPath, _opts) {
+        const data = await readFile(srcPath);
+        return this.save(destPath, data);
+    }
+    async read(pathOrUrlStr) {
+        const fullPath = this.getFullPath(pathOrUrlStr);
+        const data = await readFile(fullPath);
+        if (data.length >= 2 && data[0] === 0x1f && data[1] === 0x8b) {
+            return await gunzip(data);
+        }
+        return data;
+    }
+    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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiczMuZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9maWxlLXN0b3JlL3MzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxLQUFLLE1BQU0sRUFBZ0IsTUFBTSx1QkFBdUIsQ0FBQztBQWtCbEUsT0FBTyxLQUFLLEVBQUUsU0FBUyxFQUFFLG9CQUFvQixFQUFFLE1BQU0sZ0JBQWdCLENBQUM7QUFTdEUscUJBQWEsV0FBWSxZQUFXLFNBQVM7SUFPekMsT0FBTyxDQUFDLFFBQVEsQ0FBQyxVQUFVO0lBQzNCLE9BQU8sQ0FBQyxRQUFRLENBQUMsUUFBUTtJQUV6QixPQUFPLENBQUMsUUFBUSxDQUFDLEdBQUc7SUFUdEIsT0FBTyxDQUFDLFFBQVEsQ0FBQyxFQUFFLENBQVc7SUFDOUIsT0FBTyxDQUFDLFFBQVEsQ0FBQyxNQUFNLENBQVM7SUFDaEMsT0FBTyxDQUFDLFFBQVEsQ0FBQyxRQUFRLENBQUMsQ0FBUztJQUNuQyxPQUFPLENBQUMsUUFBUSxDQUFDLGFBQWEsQ0FBQyxDQUFTO0lBRXhDLFlBQ21CLFVBQVUsRUFBRSxNQUFNLEVBQ2xCLFFBQVEsRUFBRSxNQUFNLEVBQ2pDLElBQUksRUFBRTtRQUFFLFFBQVEsQ0FBQyxFQUFFLE1BQU0sQ0FBQztRQUFDLGFBQWEsQ0FBQyxFQUFFLE1BQU0sQ0FBQTtLQUFFLEVBQ2xDLEdBQUcsR0FBRSxNQUE2QyxFQWVwRTtJQUVZLElBQUksQ0FBQyxJQUFJLEVBQUUsTUFBTSxFQUFFLElBQUksRUFBRSxNQUFNLEVBQUUsSUFBSSxHQUFFLG9CQUF5QixHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FtQjlGO0lBRVksTUFBTSxDQUFDLFFBQVEsRUFBRSxNQUFNLEVBQUUsT0FBTyxFQUFFLE1BQU0sRUFBRSxJQUFJLEdBQUUsb0JBQXlCLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxDQXdEdkc7SUFFWSxJQUFJLENBQUMsWUFBWSxFQUFFLE1BQU0sR0FBRyxPQUFPLENBQUMsTUFBTSxDQUFDLENBYXZEO0lBRVksUUFBUSxDQUFDLFlBQVksRUFBRSxNQUFNLEVBQUUsUUFBUSxFQUFFLE1BQU0sR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLENBSzNFO0lBRVksTUFBTSxDQUFDLFlBQVksRUFBRSxNQUFNLEdBQUcsT0FBTyxDQUFDLE9BQU8sQ0FBQyxDQWExRDtJQUVELE9BQU8sQ0FBQyxtQkFBbUI7SUFRM0IsT0FBTyxDQUFDLGlCQUFpQjtJQXNCekIsT0FBTyxDQUFDLGdCQUFnQjtJQTBCeEIsT0FBTyxDQUFDLGVBQWU7SUEyQnZCLE9BQU8sQ0FBQyxXQUFXO0NBS3BCIn0=

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;AAkBlE,OAAO,KAAK,EAAE,SAAS,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAStE,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,CAmB9F;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,CAavD;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"}

package/dest/file-store/s3.js

@@ -0,0 +1,256 @@
+import { createLogger } from '@aztec/foundation/log';
+import { GetObjectCommand, HeadObjectCommand, PutObjectCommand, S3Client } from '@aws-sdk/client-s3';
+import { createReadStream, createWriteStream } from 'fs';
+import { mkdir, mkdtemp, stat, unlink } from 'fs/promises';
+import { tmpdir } from 'os';
+import { basename, dirname, join } from 'path';
+import { pipeline } from 'stream/promises';
+import { promisify } from 'util';
+import { createGzip, gunzip as gunzipCb, gzip as gzipCb } from 'zlib';
+const gzip = promisify(gzipCb);
+const gunzip = promisify(gunzipCb);
+function normalizeBasePath(path) {
+    return path?.replace(/^\/+|\/+$/g, '') ?? '';
+}
+export class S3FileStore {
+    bucketName;
+    basePath;
+    log;
+    s3;
+    region;
+    endpoint;
+    publicBaseUrl;
+    constructor(bucketName, basePath, opts, log = createLogger('stdlib:s3-file-store')){
+        this.bucketName = bucketName;
+        this.basePath = basePath;
+        this.log = log;
+        this.endpoint = opts.endpoint;
+        this.region = this.endpoint ? 'auto' : process.env.AWS_REGION ?? process.env.AWS_DEFAULT_REGION ?? 'us-east-1';
+        this.publicBaseUrl = opts.publicBaseUrl;
+        const clientOptions = {};
+        if (this.endpoint) {
+            clientOptions.region = 'auto';
+            clientOptions.endpoint = this.endpoint;
+            clientOptions.forcePathStyle = true;
+        } else {
+            clientOptions.region = this.region;
+        }
+        this.s3 = new S3Client(clientOptions);
+    }
+    async save(path, data, opts = {}) {
+        const key = this.getFullPath(path);
+        const shouldCompress = !!opts.compress;
+        const body = shouldCompress ? await gzip(data) : data;
+        const contentLength = body.length;
+        const contentType = this.detectContentType(key, shouldCompress);
+        const put = new PutObjectCommand({
+            Bucket: this.bucketName,
+            Key: key,
+            Body: body,
+            ContentType: contentType,
+            ContentEncoding: shouldCompress ? 'gzip' : undefined,
+            CacheControl: opts.metadata?.['Cache-control'],
+            Metadata: this.extractUserMetadata(opts.metadata),
+            ContentLength: contentLength
+        });
+        await this.s3.send(put);
+        return this.buildReturnedUrl(key, !!opts.public);
+    }
+    async upload(destPath, srcPath, opts = {}) {
+        const key = this.getFullPath(destPath);
+        const shouldCompress = opts.compress !== false; // default true like GCS impl
+        await mkdir(dirname(srcPath), {
+            recursive: true
+        }).catch(()=>undefined);
+        let contentLength;
+        let bodyPath = srcPath;
+        // We don't set Content-Encoding and we avoid SigV4 streaming (aws-chunked).
+        // With AWS SigV4 streaming uploads (Content-Encoding: aws-chunked[,gzip]), servers require
+        // x-amz-decoded-content-length (the size of the decoded payload) and an exact Content-Length
+        // that includes chunk metadata. For on-the-fly compression, providing
+        // those values without buffering or a pre-pass is impractical. Instead, we pre-gzip to a temp file
+        // to know ContentLength up-front and upload the gzipped bytes as-is, omitting Content-Encoding.
+        // Reference: AWS SigV4 streaming (chunked upload) requirements —
+        // https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-streaming.html
+        if (shouldCompress) {
+            // Pre-gzip to a temp file so we know the exact length for R2/S3 headers
+            const tmpDir = await mkdtemp(join(tmpdir(), 's3-upload-'));
+            const gzPath = join(tmpDir, `${basename(srcPath)}.gz`);
+            try {
+                await pipeline(createReadStream(srcPath), createGzip(), createWriteStream(gzPath));
+                const st = await stat(gzPath);
+                contentLength = st.size;
+                bodyPath = gzPath;
+            } catch (err) {
+                // Ensure temp file is removed on failure
+                await unlink(gzPath).catch(()=>undefined);
+                throw err;
+            }
+        } else {
+            const st = await stat(srcPath);
+            contentLength = st.size;
+            bodyPath = srcPath;
+        }
+        const bodyStream = createReadStream(bodyPath);
+        const contentType = this.detectContentType(key, shouldCompress);
+        try {
+            const put = new PutObjectCommand({
+                Bucket: this.bucketName,
+                Key: key,
+                Body: bodyStream,
+                ContentType: contentType,
+                CacheControl: opts.metadata?.['Cache-control'],
+                Metadata: this.extractUserMetadata(opts.metadata),
+                // Explicitly set ContentLength so R2 can compute x-amz-decoded-content-length correctly
+                ContentLength: contentLength
+            });
+            await this.s3.send(put);
+        } finally{
+            if (shouldCompress && bodyPath !== srcPath) {
+                await unlink(bodyPath).catch(()=>undefined);
+            }
+        }
+        return this.buildReturnedUrl(key, !!opts.public);
+    }
+    async read(pathOrUrlStr) {
+        const { bucket, key } = this.getBucketAndKey(pathOrUrlStr);
+        const out = await this.s3.send(new GetObjectCommand({
+            Bucket: bucket,
+            Key: key
+        }));
+        const stream = out.Body;
+        const chunks = [];
+        for await (const chunk of stream){
+            chunks.push(Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk));
+        }
+        const buffer = Buffer.concat(chunks);
+        if (out.ContentEncoding === 'gzip') {
+            return await gunzip(buffer);
+        }
+        return buffer;
+    }
+    async download(pathOrUrlStr, destPath) {
+        const { bucket, key } = this.getBucketAndKey(pathOrUrlStr);
+        const out = await this.s3.send(new GetObjectCommand({
+            Bucket: bucket,
+            Key: key
+        }));
+        await mkdir(dirname(destPath), {
+            recursive: true
+        });
+        await pipeline(out.Body, createWriteStream(destPath));
+    }
+    async exists(pathOrUrlStr) {
+        try {
+            const { bucket, key } = this.getBucketAndKey(pathOrUrlStr);
+            await this.s3.send(new HeadObjectCommand({
+                Bucket: bucket,
+                Key: key
+            }));
+            return true;
+        } catch (err) {
+            const code = err?.$metadata?.httpStatusCode ?? err?.name ?? err?.Code;
+            if (code === 404 || code === 'NotFound' || code === 'NoSuchKey') {
+                return false;
+            }
+            this.log.warn(`Error checking existence for ${pathOrUrlStr}: ${err?.message ?? String(err)}`);
+            return false;
+        }
+    }
+    extractUserMetadata(meta) {
+        if (!meta) {
+            return undefined;
+        }
+        const { ['Cache-control']: _ignored, ...rest } = meta;
+        return Object.keys(rest).length ? rest : undefined;
+    }
+    detectContentType(key, isCompressed) {
+        // Basic content type inference
+        const lower = key.toLowerCase();
+        if (lower.endsWith('.json') || lower.endsWith('.json.gz')) {
+            return 'application/json';
+        }
+        if (lower.endsWith('.txt') || lower.endsWith('.log') || lower.endsWith('.csv') || lower.endsWith('.md')) {
+            return 'text/plain; charset=utf-8';
+        }
+        if (lower.endsWith('.db') || lower.endsWith('.sqlite') || lower.endsWith('.bin')) {
+            return 'application/octet-stream';
+        }
+        if (lower.endsWith('.wasm') || lower.endsWith('.wasm.gz')) {
+            return 'application/wasm';
+        }
+        // If compressed, prefer octet-stream unless known
+        if (isCompressed) {
+            return 'application/octet-stream';
+        }
+        return undefined;
+    }
+    buildReturnedUrl(key, makePublic) {
+        if (!makePublic) {
+            return `s3://${this.bucketName}/${key}`;
+        }
+        if (this.publicBaseUrl) {
+            const base = this.publicBaseUrl.replace(/\/$/, '');
+            // key already includes basePath via getFullPath, so do not prefix basePath again
+            const full = key.replace(/^\/+/, '');
+            return `${base}/${full}`;
+        }
+        // Try to synthesize a URL from endpoint if available (works for public R2 buckets)
+        if (this.endpoint) {
+            try {
+                const url = new URL(this.endpoint);
+                return `https://${this.bucketName}.${url.host}/${key}`;
+            } catch  {
+            // fallthrough
+            }
+        }
+        // Fallback to AWS style URL if region looks valid
+        return `https://${this.bucketName}.s3.${this.region}.amazonaws.com/${key}`;
+    }
+    getBucketAndKey(pathOrUrlStr) {
+        if (URL.canParse(pathOrUrlStr)) {
+            const url = new URL(pathOrUrlStr);
+            if (url.protocol === 's3:') {
+                return {
+                    bucket: url.host,
+                    key: url.pathname.replace(/^\/+/, '')
+                };
+            }
+            // For https URLs, try to infer virtual-hosted or path-style
+            if (url.protocol === 'https:' || url.protocol === 'http:') {
+                // If the URL matches the configured publicBaseUrl host, map back to our bucket and key
+                if (this.publicBaseUrl && url.host === new URL(this.publicBaseUrl).host) {
+                    return {
+                        bucket: this.bucketName,
+                        key: url.pathname.replace(/^\/+/, '')
+                    };
+                }
+                const hostParts = url.host.split('.');
+                if (hostParts.length > 3 && (hostParts[1] === 's3' || hostParts[hostParts.length - 2] === 'r2')) {
+                    // virtual hosted
+                    return {
+                        bucket: hostParts[0],
+                        key: url.pathname.replace(/^\/+/, '')
+                    };
+                } else if (this.endpoint && url.host === new URL(this.endpoint).host) {
+                    // path-style at custom endpoint
+                    const [bucket, ...rest] = url.pathname.replace(/^\/+/, '').split('/');
+                    return {
+                        bucket,
+                        key: rest.join('/')
+                    };
+                }
+            }
+        }
+        // Treat as path
+        return {
+            bucket: this.bucketName,
+            key: this.getFullPath(pathOrUrlStr)
+        };
+    }
+    getFullPath(path) {
+        const base = normalizeBasePath(this.basePath);
+        const rel = path.replace(/^\/+/, '');
+        return base ? join(base, rel) : rel;
+    }
+}