@cirrobio/sdk 0.2.3 → 0.2.5

package/dist/api/error-handler.d.ts

@@ -0,0 +1,8 @@
+import { Middleware, ResponseContext } from "@cirrobio/api-client";
+export declare class ApiError extends Error {
+    errors: string[];
+    constructor(message: string, errors: string[]);
+}
+export declare class PortalErrorHandler implements Middleware {
+    post(context: ResponseContext): Promise<Response | void>;
+}

package/dist/api/error-handler.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PortalErrorHandler = exports.ApiError = void 0;
+class ApiError extends Error {
+    constructor(message, errors) {
+        super(message);
+        this.errors = errors;
+    }
+}
+exports.ApiError = ApiError;
+class PortalErrorHandler {
+    async post(context) {
+        const { response } = context;
+        if (response && (response.status >= 200 && response.status < 300)) {
+            return response;
+        }
+        // Handle Error
+        let errorMessage;
+        const errors = [];
+        try {
+            const err = await response.json();
+            console.warn(err);
+            if ('errorDetail' in err) {
+                errorMessage = err.errorDetail;
+                errors.push(err.errors.map((e) => e.message));
+            }
+            else {
+                errorMessage = err.message;
+            }
+        }
+        catch (ignore) {
+            errorMessage = "Unknown Error";
+        }
+        throw new ApiError(errorMessage, errors);
+    }
+}
+exports.PortalErrorHandler = PortalErrorHandler;

package/dist/api.d.ts

@@ -1,8 +1 @@
-import { Middleware, ResponseContext } from "@cirrobio/api-client";
-export declare class ApiError extends Error {
-    errors: string[];
-    constructor(message: string, errors: string[]);
-}
-export declare class PortalErrorHandler implements Middleware {
-    post(context: ResponseContext): Promise<Response | void>;
-}
+export { PortalErrorHandler, ApiError } from './api/error-handler';

package/dist/api.js

@@ -1,105 +1,6 @@
 "use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PortalErrorHandler = exports.ApiError = void 0;
-var ApiError = /** @class */ (function (_super) {
-    __extends(ApiError, _super);
-    function ApiError(message, errors) {
-        var _this = _super.call(this, message) || this;
-        _this.errors = errors;
-        return _this;
-    }
-    return ApiError;
-}(Error));
-exports.ApiError = ApiError;
-var PortalErrorHandler = /** @class */ (function () {
-    function PortalErrorHandler() {
-    }
-    PortalErrorHandler.prototype.post = function (context) {
-        return __awaiter(this, void 0, void 0, function () {
-            var response, errorMessage, errors, err, ignore_1;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        response = context.response;
-                        if (response && (response.status >= 200 && response.status < 300)) {
-                            return [2 /*return*/, response];
-                        }
-                        errors = [];
-                        _a.label = 1;
-                    case 1:
-                        _a.trys.push([1, 3, , 4]);
-                        return [4 /*yield*/, response.json()];
-                    case 2:
-                        err = _a.sent();
-                        console.warn(err);
-                        if ('errorDetail' in err) {
-                            errorMessage = err.errorDetail;
-                            errors.push(err.errors.map(function (e) { return e.message; }));
-                        }
-                        else {
-                            errorMessage = err.message;
-                        }
-                        return [3 /*break*/, 4];
-                    case 3:
-                        ignore_1 = _a.sent();
-                        errorMessage = "Unknown Error";
-                        return [3 /*break*/, 4];
-                    case 4: throw new ApiError(errorMessage, errors);
-                }
-            });
-        });
-    };
-    return PortalErrorHandler;
-}());
-exports.PortalErrorHandler = PortalErrorHandler;
+exports.ApiError = exports.PortalErrorHandler = void 0;
+var error_handler_1 = require("./api/error-handler");
+Object.defineProperty(exports, "PortalErrorHandler", { enumerable: true, get: function () { return error_handler_1.PortalErrorHandler; } });
+Object.defineProperty(exports, "ApiError", { enumerable: true, get: function () { return error_handler_1.ApiError; } });

package/dist/file/__test__/s3-utils.test.d.ts

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

package/dist/file/__test__/s3-utils.test.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const file_1 = require("../../file");
+describe("s3-utils", () => {
+    describe("s3UriToParams", () => {
+        it("should parse a valid s3 URI", () => {
+            const uri = "s3://my-bucket/my-key/nested/folder";
+            const result = (0, file_1.s3UriToParams)(uri);
+            expect(result).toEqual({ Bucket: "my-bucket", Key: "my-key/nested/folder" });
+        });
+        it("should throw an error for an invalid URI", () => {
+            const uri = "invalid-uri";
+            expect(() => (0, file_1.s3UriToParams)(uri)).toThrowError(`Received invalid uri: '${uri}'`);
+        });
+    });
+});

package/dist/file/actions/delete.fn.d.ts

@@ -0,0 +1,9 @@
+import { AWSCredentials } from "@cirrobio/api-client";
+export interface DeleteFileParams {
+    url: string;
+    credentials: AWSCredentials;
+}
+/**
+ * Delete a file from S3 given its URL and credentials.
+ */
+export declare function deleteFile({ url, credentials }: DeleteFileParams): Promise<void>;

package/dist/file/actions/delete.fn.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deleteFile = void 0;
+const client_s3_1 = require("@aws-sdk/client-s3");
+const s3_utils_1 = require("../util/s3-utils");
+const s3_client_1 = require("../util/s3-client");
+/**
+ * Delete a file from S3 given its URL and credentials.
+ */
+async function deleteFile({ url, credentials }) {
+    const { Bucket, Key } = (0, s3_utils_1.s3UriToParams)(url);
+    const cmd = new client_s3_1.DeleteObjectCommand({ Bucket, Key });
+    await (0, s3_client_1.createS3Client)(credentials).send(cmd);
+}
+exports.deleteFile = deleteFile;

package/dist/file/actions/sign-url.fn.d.ts

@@ -0,0 +1,15 @@
+import { AWSCredentials } from "@cirrobio/api-client";
+export interface GetFileUrlParams extends GetSignedUrlOptions {
+    url: string;
+    credentials?: AWSCredentials;
+}
+export interface GetSignedUrlOptions {
+    download?: boolean;
+    gzip?: boolean;
+    timeout?: number;
+    filename?: string;
+}
+/**
+ * Get a signed URL for a file in S3 given its S3 URI.
+ */
+export declare function getSignedUrl({ url, credentials, ...params }: GetFileUrlParams): Promise<string>;

package/dist/file/actions/sign-url.fn.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSignedUrl = void 0;
+const client_s3_1 = require("@aws-sdk/client-s3");
+const s3_request_presigner_1 = require("@aws-sdk/s3-request-presigner");
+const s3_client_1 = require("../util/s3-client");
+const s3_utils_1 = require("../util/s3-utils");
+/**
+ * Get a signed URL for a file in S3 given its S3 URI.
+ */
+function getSignedUrl({ url, credentials, ...params }) {
+    var _a, _b;
+    const client = (0, s3_client_1.createS3Client)(credentials);
+    const { Bucket, Key } = (0, s3_utils_1.s3UriToParams)(url);
+    const fileName = (_a = params.filename) !== null && _a !== void 0 ? _a : Key.split('/').pop();
+    const args = { Bucket, Key };
+    if (params === null || params === void 0 ? void 0 : params.download) {
+        args.ResponseContentDisposition = `attachment; filename="${fileName}"`;
+    }
+    if (params === null || params === void 0 ? void 0 : params.gzip) {
+        args.ResponseContentEncoding = 'gzip';
+    }
+    const command = new client_s3_1.GetObjectCommand(args);
+    return (0, s3_request_presigner_1.getSignedUrl)(client, command, { expiresIn: 60 * ((_b = params === null || params === void 0 ? void 0 : params.timeout) !== null && _b !== void 0 ? _b : 5) });
+}
+exports.getSignedUrl = getSignedUrl;

package/dist/file/actions/upload.fn.d.ts

@@ -0,0 +1,13 @@
+import { Upload } from "@aws-sdk/lib-storage";
+import { AWSCredentials } from '@cirrobio/api-client';
+export interface UploadFileParams {
+    bucket: string;
+    path: string;
+    file: File;
+    credentials: AWSCredentials;
+    metadata?: Record<string, string>;
+}
+/**
+ * Upload a file to S3
+ */
+export declare function uploadFile({ bucket, path, file, credentials, metadata }: UploadFileParams): Upload;

package/dist/file/actions/upload.fn.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.uploadFile = void 0;
+const lib_storage_1 = require("@aws-sdk/lib-storage");
+const s3_client_1 = require("../util/s3-client");
+/**
+ * Upload a file to S3
+ */
+function uploadFile({ bucket, path, file, credentials, metadata }) {
+    const params = {
+        Bucket: bucket,
+        Key: path,
+        Body: file,
+        ContentType: file.type,
+        Metadata: metadata,
+    };
+    return new lib_storage_1.Upload({
+        client: (0, s3_client_1.createS3Client)(credentials),
+        queueSize: 4,
+        params,
+    });
+}
+exports.uploadFile = uploadFile;

package/dist/{extensions.fn.js → file/extensions.fn.js}

@@ -1,18 +1,9 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.matchesExtension = exports.FILE_EXTENSIONS_TO_OPEN = exports.FILE_OME_EXTENSIONS = exports.FILE_IMAGE_EXTENSIONS = exports.FILE_TXT_EXTENSIONS = exports.FILE_TXT_GENOMICS_EXTENSIONS = exports.FILE_DSV_EXTENSIONS = exports.FILE_PROTEIN_STRUCTURE_EXTENSIONS = exports.FILE_BROWSER_EXTENSIONS = exports.FILE_TRACK_EXTENSIONS = exports.FILE_TRACK_EXTENSIONS_NO_INDEX = exports.FILE_VITESSCE_EXTENSIONS = exports.FILE_TRACK_INDEX_EXTENSIONS = exports.FILE_TRACK_SEG = exports.FILE_TRACK_WIG = exports.FILE_TRACK_VARIANT = exports.FILE_TRACK_ALIGNMENTS = exports.FILE_TRACK_ANNOTATION = void 0;
 /**
  * An array of file extensions that can be rendered in a genome viewer
  */
-var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
-    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
-        if (ar || !(i in from)) {
-            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
-            ar[i] = from[i];
-        }
-    }
-    return to.concat(ar || Array.prototype.slice.call(from));
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.matchesExtension = exports.FILE_EXTENSIONS_TO_OPEN = exports.FILE_OME_EXTENSIONS = exports.FILE_IMAGE_EXTENSIONS = exports.FILE_TXT_EXTENSIONS = exports.FILE_TXT_GENOMICS_EXTENSIONS = exports.FILE_DSV_EXTENSIONS = exports.FILE_PROTEIN_STRUCTURE_EXTENSIONS = exports.FILE_BROWSER_EXTENSIONS = exports.FILE_TRACK_EXTENSIONS = exports.FILE_TRACK_EXTENSIONS_NO_INDEX = exports.FILE_VITESSCE_EXTENSIONS = exports.FILE_TRACK_INDEX_EXTENSIONS = exports.FILE_TRACK_SEG = exports.FILE_TRACK_WIG = exports.FILE_TRACK_VARIANT = exports.FILE_TRACK_ALIGNMENTS = exports.FILE_TRACK_ANNOTATION = void 0;
 exports.FILE_TRACK_ANNOTATION = ['bed', 'bed.gz', 'gtf', 'gtf.gz'];
 exports.FILE_TRACK_ALIGNMENTS = ['cram', 'cram.gz']; // TODO: put back bam
 exports.FILE_TRACK_VARIANT = ['vcf', 'vcf.gz'];
@@ -20,8 +11,17 @@ exports.FILE_TRACK_WIG = ['wig', 'wig.gz', 'bw', 'bw.gz', 'bigwig', 'bigwig.gz']
 exports.FILE_TRACK_SEG = ['seg', 'seg.gz'];
 exports.FILE_TRACK_INDEX_EXTENSIONS = ['tbi', 'bai', 'crai', 'csi'];
 exports.FILE_VITESSCE_EXTENSIONS = ['hdf5', 'h5ad', 'loom'];
-exports.FILE_TRACK_EXTENSIONS_NO_INDEX = __spreadArray(__spreadArray(__spreadArray(__spreadArray(__spreadArray([], exports.FILE_TRACK_ANNOTATION, true), exports.FILE_TRACK_ALIGNMENTS, true), exports.FILE_TRACK_VARIANT, true), exports.FILE_TRACK_WIG, true), exports.FILE_TRACK_SEG, true);
-exports.FILE_TRACK_EXTENSIONS = __spreadArray(__spreadArray([], exports.FILE_TRACK_EXTENSIONS_NO_INDEX, true), exports.FILE_TRACK_INDEX_EXTENSIONS, true);
+exports.FILE_TRACK_EXTENSIONS_NO_INDEX = [
+    ...exports.FILE_TRACK_ANNOTATION,
+    ...exports.FILE_TRACK_ALIGNMENTS,
+    ...exports.FILE_TRACK_VARIANT,
+    ...exports.FILE_TRACK_WIG,
+    ...exports.FILE_TRACK_SEG
+];
+exports.FILE_TRACK_EXTENSIONS = [
+    ...exports.FILE_TRACK_EXTENSIONS_NO_INDEX,
+    ...exports.FILE_TRACK_INDEX_EXTENSIONS
+];
 exports.FILE_BROWSER_EXTENSIONS = ['html', 'pdf'];
 /**
  * An array of file extensions that are protein structure files.
@@ -38,7 +38,7 @@ exports.FILE_TXT_GENOMICS_EXTENSIONS = ['fasta', 'fna', 'fsa', 'fa', 'fastp', 'f
 /**
  * An array of file extensions that are considered TXT files.
  */
-exports.FILE_TXT_EXTENSIONS = __spreadArray(__spreadArray(['txt', 'log', 'yml', 'cfg', 'xml', 'yaml'], exports.FILE_DSV_EXTENSIONS, true), exports.FILE_TXT_GENOMICS_EXTENSIONS, true);
+exports.FILE_TXT_EXTENSIONS = ['txt', 'log', 'yml', 'cfg', 'xml', 'yaml', ...exports.FILE_DSV_EXTENSIONS, ...exports.FILE_TXT_GENOMICS_EXTENSIONS];
 /**
  * An array of file extensions that are considered image files.
  */
@@ -51,7 +51,12 @@ exports.FILE_OME_EXTENSIONS = ['tif', 'ome.tif', 'ome.tiff', 'ome.tif.gz', 'ome.
  * An array of file extensions that can be opened in the browser.
  * Includes common document formats such as HTML, PDF, and JSON, as well as image, DSV, TXT, and OME file formats.
  */
-exports.FILE_EXTENSIONS_TO_OPEN = __spreadArray(__spreadArray(__spreadArray(__spreadArray(['html', 'pdf', 'json', 'fcs'], exports.FILE_IMAGE_EXTENSIONS, true), exports.FILE_TXT_EXTENSIONS, true), exports.FILE_TRACK_EXTENSIONS, true), exports.FILE_PROTEIN_STRUCTURE_EXTENSIONS, true);
+exports.FILE_EXTENSIONS_TO_OPEN = ['html', 'pdf', 'json', 'fcs',
+    ...exports.FILE_IMAGE_EXTENSIONS,
+    ...exports.FILE_TXT_EXTENSIONS,
+    ...exports.FILE_TRACK_EXTENSIONS,
+    ...exports.FILE_PROTEIN_STRUCTURE_EXTENSIONS
+];
 /**
  * Checks if a file has an extension that matches one in the provided list.
  * @param filePath The file to check the extension of.
@@ -65,7 +70,7 @@ function matchesExtension(filePath, extensions) {
         filePath = filePath.slice(0, -3); // remove the .gz extension
     }
     // Now, get the extension of the file
-    var fileExtension = filePath.slice(filePath.lastIndexOf('.') + 1);
+    const fileExtension = filePath.slice(filePath.lastIndexOf('.') + 1);
     // Check if the fileExtension is in the list of extensions
     return extensions.includes(fileExtension);
 }

package/dist/file/file-object.model.d.ts

@@ -0,0 +1,54 @@
+import { ProjectFileAccessContext } from "./project-access-context";
+export declare enum FileSystemObjectType {
+    FILE = "file",
+    FOLDER = "folder"
+}
+/**
+ * Represents a file that can be downloaded
+ */
+export interface DownloadableFile {
+    url: string;
+    name?: string;
+    fileAccessContext: ProjectFileAccessContext;
+}
+/**
+ * Represents a file in Cirro
+ */
+export interface FileSystemObject extends DownloadableFile {
+    /**
+     * Unique Id For Object
+     */
+    id: string;
+    /**
+     * Object S3 Url
+     */
+    url: string;
+    /**
+     * Object Path
+     */
+    path: string;
+    /**
+     * Object Name
+     */
+    name: string;
+    /**
+     * Object Size
+     */
+    size: number;
+    /**
+     * Object Kind (PNG, TXT)
+     */
+    kind: string;
+    /**
+     * Object Type (File or Folder)
+     */
+    type: FileSystemObjectType;
+    /**
+     * Metadata
+     */
+    metadata?: Record<string, any>;
+    /**
+     * Access context
+     */
+    fileAccessContext: ProjectFileAccessContext;
+}

package/dist/file/file-object.model.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileSystemObjectType = void 0;
+var FileSystemObjectType;
+(function (FileSystemObjectType) {
+    FileSystemObjectType["FILE"] = "file";
+    FileSystemObjectType["FOLDER"] = "folder";
+})(FileSystemObjectType = exports.FileSystemObjectType || (exports.FileSystemObjectType = {}));

package/dist/file/file.service.d.ts

@@ -0,0 +1,29 @@
+import { AWSCredentials, FileApi } from "@cirrobio/api-client";
+import { ProjectFileAccessContext } from "./project-access-context";
+import { DownloadableFile } from "./file-object.model";
+import { GetSignedUrlOptions, GetFileUrlParams } from "./actions/sign-url.fn";
+/**
+ * Service for viewing files in Cirro
+ *  currently this only operates on files within a project
+ */
+export declare class FileService {
+    private readonly fileApi;
+    constructor(fileApi: FileApi);
+    /**
+     * Get contents of a file
+     */
+    getProjectFile(file: DownloadableFile): Promise<Response>;
+    /**
+     * Get a signed URL for a file
+     */
+    getSignedUrlFromProjectFile(file: DownloadableFile, params?: GetSignedUrlOptions): Promise<string>;
+    /**
+     * Get a signed URL for a file given a path
+     */
+    getSignedUrlFromProjectPath(fileAccessContext: ProjectFileAccessContext, path: string, params?: GetFileUrlParams): Promise<string>;
+    /**
+     * Get credentials for accessing a project file
+     */
+    getProjectAccessCredentials(fileAccessContext: ProjectFileAccessContext): Promise<AWSCredentials>;
+    private getProjectReadCredentials;
+}

package/dist/file/file.service.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileService = void 0;
+const api_client_1 = require("@cirrobio/api-client");
+const credentials_mutex_so_1 = require("./util/credentials-mutex.so");
+const sign_url_fn_1 = require("./actions/sign-url.fn");
+const shared_1 = require("./shared");
+/**
+ * Service for viewing files in Cirro
+ *  currently this only operates on files within a project
+ */
+class FileService {
+    constructor(fileApi) {
+        this.fileApi = fileApi;
+    }
+    /**
+     * Get contents of a file
+     */
+    async getProjectFile(file) {
+        const url = await this.getSignedUrlFromProjectFile(file);
+        return fetch(url);
+    }
+    /**
+     * Get a signed URL for a file
+     */
+    async getSignedUrlFromProjectFile(file, params) {
+        const credentials = await this.getProjectAccessCredentials(file.fileAccessContext);
+        const _params = {
+            ...params,
+            filename: file.name,
+            url: file.url,
+            credentials,
+        };
+        return (0, sign_url_fn_1.getSignedUrl)(_params);
+    }
+    /**
+     * Get a signed URL for a file given a path
+     */
+    async getSignedUrlFromProjectPath(fileAccessContext, path, params) {
+        const credentials = await this.getProjectAccessCredentials(fileAccessContext);
+        const _params = {
+            ...params,
+            filename: path.split('/').pop(),
+            url: `s3://${(0, shared_1.getProjectS3Bucket)(fileAccessContext.project.id)}/${path}`,
+            credentials,
+        };
+        return (0, sign_url_fn_1.getSignedUrl)(_params);
+    }
+    /**
+     * Get credentials for accessing a project file
+     */
+    async getProjectAccessCredentials(fileAccessContext) {
+        // Special case for project download, since we can cache the credentials
+        if (fileAccessContext.fileAccessRequest.accessType === api_client_1.AccessType.ProjectDownload) {
+            return this.getProjectReadCredentials(fileAccessContext);
+        }
+        return this.fileApi.generateProjectFileAccessToken({ projectId: fileAccessContext.project.id, fileAccessRequest: fileAccessContext.fileAccessRequest });
+    }
+    async getProjectReadCredentials(fileAccessContext) {
+        const projectId = fileAccessContext.project.id;
+        return credentials_mutex_so_1.credentialsMutex.dispatch(async () => {
+            const cachedCredentials = credentials_mutex_so_1.credentialsCache.get(projectId);
+            const expirationTime = cachedCredentials ? cachedCredentials === null || cachedCredentials === void 0 ? void 0 : cachedCredentials.expiration : null;
+            const fetchNewCredentials = !expirationTime || expirationTime < new Date();
+            if (fetchNewCredentials) {
+                const fileAccessRequest = fileAccessContext.fileAccessRequest;
+                const credentials = await this.fileApi.generateProjectFileAccessToken({ projectId, fileAccessRequest });
+                credentials_mutex_so_1.credentialsCache.set(projectId, credentials);
+                return credentials;
+            }
+            return cachedCredentials;
+        });
+    }
+}
+exports.FileService = FileService;

package/dist/file/project-access-context.d.ts

@@ -0,0 +1,14 @@
+import { DatasetDetail, FileAccessRequest, Project } from "@cirrobio/api-client";
+type ProjectIdentifiable = Pick<Project, 'id'>;
+/**
+ * Helper class to encapsulate the file access for a project.
+ */
+export declare class ProjectFileAccessContext {
+    readonly project: ProjectIdentifiable;
+    readonly dataset: DatasetDetail;
+    readonly fileAccessRequest: FileAccessRequest;
+    constructor(project: ProjectIdentifiable, dataset: DatasetDetail, fileAccessRequest: FileAccessRequest);
+    static projectDownload(project: ProjectIdentifiable): ProjectFileAccessContext;
+    static datasetDownload(project: ProjectIdentifiable, dataset: DatasetDetail): ProjectFileAccessContext;
+}
+export {};

package/dist/file/project-access-context.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProjectFileAccessContext = void 0;
+const api_client_1 = require("@cirrobio/api-client");
+/**
+ * Helper class to encapsulate the file access for a project.
+ */
+class ProjectFileAccessContext {
+    constructor(project, dataset, fileAccessRequest) {
+        this.project = project;
+        this.dataset = dataset;
+        this.fileAccessRequest = fileAccessRequest;
+    }
+    static projectDownload(project) {
+        const request = { accessType: api_client_1.AccessType.ProjectDownload };
+        return new ProjectFileAccessContext(project, null, request);
+    }
+    static datasetDownload(project, dataset) {
+        const accessType = dataset.share ? api_client_1.AccessType.SharedDatasetDownload : api_client_1.AccessType.ProjectDownload;
+        const request = { accessType, datasetId: dataset.id };
+        return new ProjectFileAccessContext(project, dataset, request);
+    }
+}
+exports.ProjectFileAccessContext = ProjectFileAccessContext;

package/dist/file/shared.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Get the S3 bucket name for a project.
+ * Will be deprecated in the future.
+ */
+export declare function getProjectS3Bucket(projectId: string): string;

package/dist/file/shared.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getProjectS3Bucket = void 0;
+/**
+ * Get the S3 bucket name for a project.
+ * Will be deprecated in the future.
+ */
+function getProjectS3Bucket(projectId) {
+    return `project-${projectId}`;
+}
+exports.getProjectS3Bucket = getProjectS3Bucket;

package/dist/file/util/credentials-mutex.so.d.ts

@@ -0,0 +1,15 @@
+import { AWSCredentials } from '@cirrobio/api-client';
+declare class Mutex<T> {
+    private mutex;
+    lock(): PromiseLike<() => void>;
+    dispatch(fn: (() => T) | (() => PromiseLike<T>)): Promise<T>;
+}
+/**
+ * A mutex to ensure that only one request for credentials is made at a time.
+ */
+export declare const credentialsMutex: Mutex<AWSCredentials>;
+/**
+ * A cache of credentials to avoid making multiple requests for the same credentials.
+ */
+export declare const credentialsCache: Map<string, AWSCredentials>;
+export {};

package/dist/file/util/credentials-mutex.so.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.credentialsCache = exports.credentialsMutex = void 0;
+class Mutex {
+    constructor() {
+        this.mutex = Promise.resolve();
+    }
+    lock() {
+        let begin = () => { };
+        this.mutex = this.mutex.then(() => new Promise(begin));
+        return new Promise((res) => {
+            begin = res;
+        });
+    }
+    async dispatch(fn) {
+        const unlock = await this.lock();
+        try {
+            return await Promise.resolve(fn());
+        }
+        finally {
+            unlock();
+        }
+    }
+}
+/**
+ * A mutex to ensure that only one request for credentials is made at a time.
+ */
+exports.credentialsMutex = new Mutex();
+/**
+ * A cache of credentials to avoid making multiple requests for the same credentials.
+ */
+exports.credentialsCache = new Map();

package/dist/file/util/s3-client.d.ts

@@ -0,0 +1,6 @@
+import { S3Client } from "@aws-sdk/client-s3";
+import { AWSCredentials } from "@cirrobio/api-client";
+/**
+ * Creates an S3 client using the provided credentials.
+ */
+export declare function createS3Client(credentials: AWSCredentials): S3Client;