@directus/storage-driver-gcs 11.0.2 → 11.1.1

package/dist/index.d.ts

@@ -1,14 +1,19 @@
-import { Driver, ReadOptions } from '@directus/storage';
+import { TusDriver, ReadOptions, ChunkedUploadContext } from '@directus/storage';
 import { Readable } from 'node:stream';
 
 type DriverGCSConfig = {
     root?: string;
     bucket: string;
     apiEndpoint?: string;
+    tus?: {
+        enabled: boolean;
+        chunkSize?: number;
+    };
 };
-declare class DriverGCS implements Driver {
+declare class DriverGCS implements TusDriver {
     private root;
     private bucket;
+    private readonly preferredChunkSize;
     constructor(config: DriverGCSConfig);
     private fullPath;
     private file;
@@ -23,6 +28,11 @@ declare class DriverGCS implements Driver {
     move(src: string, dest: string): Promise<void>;
     copy(src: string, dest: string): Promise<void>;
     list(prefix?: string): AsyncGenerator<string, void, unknown>;
+    get tusExtensions(): string[];
+    createChunkedUpload(filepath: string, context: ChunkedUploadContext): Promise<ChunkedUploadContext>;
+    writeChunk(filepath: string, content: Readable, offset: number, context: ChunkedUploadContext): Promise<number>;
+    finishChunkedUpload(_filepath: string, _context: ChunkedUploadContext): Promise<void>;
+    deleteChunkedUpload(filepath: string, _context: ChunkedUploadContext): Promise<void>;
 }
 
 export { DriverGCS, type DriverGCSConfig, DriverGCS as default };

package/dist/index.js

@@ -1,16 +1,24 @@
 // src/index.ts
+import { DEFAULT_CHUNK_SIZE } from "@directus/constants";
 import { normalizePath } from "@directus/utils";
 import { Storage } from "@google-cloud/storage";
 import { join } from "node:path";
 import { pipeline } from "node:stream/promises";
+var MINIMUM_CHUNK_SIZE = 262144;
 var DriverGCS = class {
   root;
   bucket;
+  // TUS specific members
+  preferredChunkSize;
   constructor(config) {
-    const { bucket, root, ...storageOptions } = config;
+    const { bucket, root, tus, ...storageOptions } = config;
     this.root = root ? normalizePath(root, { removeLeading: true }) : "";
     const storage = new Storage(storageOptions);
     this.bucket = storage.bucket(bucket);
+    this.preferredChunkSize = tus?.chunkSize || DEFAULT_CHUNK_SIZE;
+    if (tus?.enabled && (this.preferredChunkSize < MINIMUM_CHUNK_SIZE || Math.log2(this.preferredChunkSize) % 1 !== 0)) {
+      throw new Error("Invalid chunkSize provided");
+    }
   }
   fullPath(filepath) {
     return normalizePath(join(this.root, filepath));
@@ -60,6 +68,42 @@ var DriverGCS = class {
       query = nextQuery;
     }
   }
+  get tusExtensions() {
+    return ["creation", "termination", "expiration"];
+  }
+  async createChunkedUpload(filepath, context) {
+    const file = this.file(this.fullPath(filepath));
+    const [uri] = await file.createResumableUpload();
+    context.metadata["uri"] = uri;
+    return context;
+  }
+  async writeChunk(filepath, content, offset, context) {
+    const file = this.file(this.fullPath(filepath));
+    const stream = file.createWriteStream({
+      chunkSize: this.preferredChunkSize,
+      uri: context.metadata["uri"],
+      offset,
+      isPartialUpload: true,
+      resumeCRC32C: context.metadata["hash"],
+      metadata: {
+        contentLength: context.size || 0
+      }
+    });
+    stream.on("crc32c", (hash) => {
+      context.metadata["hash"] = hash;
+    });
+    let bytesUploaded = offset || 0;
+    content.on("data", (chunk) => {
+      bytesUploaded += chunk.length;
+    });
+    await pipeline(content, stream);
+    return bytesUploaded;
+  }
+  async finishChunkedUpload(_filepath, _context) {
+  }
+  async deleteChunkedUpload(filepath, _context) {
+    await this.delete(filepath);
+  }
 };
 var src_default = DriverGCS;
 export {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@directus/storage-driver-gcs",
-  "version": "11.0.2",
+  "version": "11.1.1",
   "description": "GCS file storage abstraction for `@directus/storage`",
   "homepage": "https://directus.io",
   "repository": {
@@ -22,8 +22,9 @@
   ],
   "dependencies": {
     "@google-cloud/storage": "7.13.0",
-    "@directus/utils": "12.0.2",
-    "@directus/storage": "11.0.1"
+    "@directus/constants": "12.0.1",
+    "@directus/storage": "11.0.1",
+    "@directus/utils": "12.0.4"
   },
   "devDependencies": {
     "@ngneat/falso": "7.2.0",