@directus/storage-driver-supabase 3.0.7 → 3.0.9

package/dist/index.d.ts

@@ -1,46 +1,48 @@
-import { TusDriver, ReadOptions, ChunkedUploadContext } from '@directus/storage';
-import { Readable } from 'node:stream';
+import { Readable } from "node:stream";
+import { TusDriver } from "@directus/storage";
+import { ChunkedUploadContext, ReadOptions } from "@directus/types";
 
+//#region src/index.d.ts
 type DriverSupabaseConfig = {
-    bucket: string;
-    serviceRole: string;
-    projectId?: string;
-    /** Allows a custom Supabase endpoint for self-hosting */
-    endpoint?: string;
-    root?: string;
-    tus?: {
-        chunkSize?: number;
-    };
+  bucket: string;
+  serviceRole: string;
+  projectId?: string;
+  /** Allows a custom Supabase endpoint for self-hosting */
+  endpoint?: string;
+  root?: string;
+  tus?: {
+    chunkSize?: number;
+  };
 };
 declare class DriverSupabase implements TusDriver {
-    private config;
-    private client;
-    private bucket;
-    private readonly preferredChunkSize;
-    constructor(config: DriverSupabaseConfig);
-    private get endpoint();
-    private getClient;
-    private getBucket;
-    private fullPath;
-    private getAuthenticatedUrl;
-    private getResumableUrl;
-    read(filepath: string, options?: ReadOptions): Promise<Readable>;
-    stat(filepath: string): Promise<{
-        size: any;
-        modified: Date;
-    }>;
-    exists(filepath: string): Promise<boolean>;
-    move(src: string, dest: string): Promise<void>;
-    copy(src: string, dest: string): Promise<void>;
-    write(filepath: string, content: Readable, type?: string): Promise<void>;
-    delete(filepath: string): Promise<void>;
-    list(prefix?: string): AsyncIterable<string>;
-    listGenerator(prefix: string): AsyncIterable<string>;
-    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>;
+  private config;
+  private client;
+  private bucket;
+  private readonly preferredChunkSize;
+  constructor(config: DriverSupabaseConfig);
+  private get endpoint();
+  private getClient;
+  private getBucket;
+  private fullPath;
+  private getAuthenticatedUrl;
+  private getResumableUrl;
+  read(filepath: string, options?: ReadOptions): Promise<Readable>;
+  stat(filepath: string): Promise<{
+    size: any;
+    modified: Date;
+  }>;
+  exists(filepath: string): Promise<boolean>;
+  move(src: string, dest: string): Promise<void>;
+  copy(src: string, dest: string): Promise<void>;
+  write(filepath: string, content: Readable, type?: string): Promise<void>;
+  delete(filepath: string): Promise<void>;
+  list(prefix?: string): AsyncIterable<string>;
+  listGenerator(prefix: string): AsyncIterable<string>;
+  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 { DriverSupabase, type DriverSupabaseConfig, DriverSupabase as default };
+//#endregion
+export { DriverSupabase, DriverSupabase as default, DriverSupabaseConfig };

package/dist/index.js

@@ -1,223 +1,203 @@
-// src/index.ts
 import { DEFAULT_CHUNK_SIZE } from "@directus/constants";
 import { normalizePath } from "@directus/utils";
 import { StorageClient } from "@supabase/storage-js";
-import { join } from "path";
-import { Readable } from "stream";
+import { join } from "node:path";
+import { Readable } from "node:stream";
 import * as tus from "tus-js-client";
 import { fetch } from "undici";
+
+//#region src/index.ts
 var DriverSupabase = class {
-  config;
-  client;
-  bucket;
-  // TUS specific members
-  preferredChunkSize;
-  constructor(config) {
-    this.config = {
-      ...config,
-      root: normalizePath(config.root ?? "", { removeLeading: true })
-    };
-    this.preferredChunkSize = this.config.tus?.chunkSize ?? DEFAULT_CHUNK_SIZE;
-    this.client = this.getClient();
-    this.bucket = this.getBucket();
-  }
-  get endpoint() {
-    return this.config.endpoint ?? `https://${this.config.projectId}.supabase.co/storage/v1`;
-  }
-  getClient() {
-    if (!this.config.projectId && !this.config.endpoint) {
-      throw new Error("`project_id` or `endpoint` is required");
-    }
-    if (!this.config.serviceRole) {
-      throw new Error("`service_role` is required");
-    }
-    return new StorageClient(this.endpoint, {
-      apikey: this.config.serviceRole,
-      Authorization: `Bearer ${this.config.serviceRole}`
-    });
-  }
-  getBucket() {
-    if (!this.config.bucket) {
-      throw new Error("`bucket` is required");
-    }
-    return this.client.from(this.config.bucket);
-  }
-  fullPath(filepath) {
-    const path = join(this.config.root, filepath);
-    if (path === ".") return "";
-    return normalizePath(path);
-  }
-  getAuthenticatedUrl(filepath) {
-    return `${this.endpoint}/${join("object/authenticated", this.config.bucket, this.fullPath(filepath))}`;
-  }
-  getResumableUrl() {
-    return `${this.endpoint}/upload/resumable`;
-  }
-  async read(filepath, options) {
-    const { range } = options || {};
-    const requestInit = { method: "GET" };
-    requestInit.headers = {
-      Authorization: `Bearer ${this.config.serviceRole}`
-    };
-    if (range) {
-      requestInit.headers["Range"] = `bytes=${range.start ?? ""}-${range.end ?? ""}`;
-    }
-    const response = await fetch(this.getAuthenticatedUrl(filepath), requestInit);
-    if (response.status >= 400 || !response.body) {
-      throw new Error(`No stream returned for file "${filepath}"`);
-    }
-    return Readable.fromWeb(response.body);
-  }
-  async stat(filepath) {
-    const { data, error } = await this.bucket.list(this.config.root, {
-      search: filepath,
-      limit: 1
-    });
-    if (error || data.length === 0) {
-      throw new Error("File not found");
-    }
-    return {
-      size: data[0]?.metadata["contentLength"] ?? 0,
-      modified: new Date(data[0]?.metadata["lastModified"] || null)
-    };
-  }
-  async exists(filepath) {
-    try {
-      await this.stat(filepath);
-      return true;
-    } catch {
-      return false;
-    }
-  }
-  async move(src, dest) {
-    await this.bucket.move(this.fullPath(src), this.fullPath(dest));
-  }
-  async copy(src, dest) {
-    await this.bucket.copy(this.fullPath(src), this.fullPath(dest));
-  }
-  async write(filepath, content, type) {
-    await this.bucket.upload(this.fullPath(filepath), content, {
-      contentType: type ?? "",
-      cacheControl: "3600",
-      upsert: true,
-      duplex: "half"
-    });
-  }
-  async delete(filepath) {
-    await this.bucket.remove([this.fullPath(filepath)]);
-  }
-  list(prefix = "") {
-    const fullPrefix = this.fullPath(prefix);
-    return this.listGenerator(fullPrefix);
-  }
-  async *listGenerator(prefix) {
-    const limit = 1e3;
-    let offset = 0;
-    let itemCount = 0;
-    const isDirectory = prefix.endsWith("/");
-    const prefixDirectory = isDirectory ? prefix : dirname(prefix);
-    const search = isDirectory ? "" : prefix.split("/").pop() ?? "";
-    do {
-      const { data, error } = await this.bucket.list(prefixDirectory, {
-        limit,
-        offset,
-        search
-      });
-      if (!data || error) {
-        break;
-      }
-      itemCount = data.length;
-      offset += itemCount;
-      for (const item of data) {
-        const filePath = normalizePath(join(prefixDirectory, item.name));
-        if (item.id !== null) {
-          yield filePath.substring(this.config.root ? this.config.root.length + 1 : 0);
-        } else {
-          yield* this.listGenerator(`${filePath}/`);
-        }
-      }
-    } while (itemCount === limit);
-  }
-  get tusExtensions() {
-    return ["creation", "termination", "expiration"];
-  }
-  async createChunkedUpload(_filepath, context) {
-    return context;
-  }
-  async writeChunk(filepath, content, offset, context) {
-    let bytesUploaded = offset || 0;
-    const metadata = {
-      bucketName: this.config.bucket,
-      objectName: this.fullPath(filepath),
-      contentType: context.metadata["type"] ?? "image/png",
-      cacheControl: "3600"
-    };
-    await new Promise((resolve, reject) => {
-      const upload = new tus.Upload(content, {
-        endpoint: this.getResumableUrl(),
-        // @ts-expect-error
-        fileReader: new FileReader(),
-        headers: {
-          Authorization: `Bearer ${this.config.serviceRole}`,
-          "x-upsert": "true"
-        },
-        metadata,
-        chunkSize: this.preferredChunkSize,
-        uploadSize: context.size,
-        retryDelays: null,
-        onError(error) {
-          reject(error);
-        },
-        onChunkComplete: function(chunkSize) {
-          bytesUploaded += chunkSize;
-          resolve(null);
-        },
-        onSuccess() {
-          resolve(null);
-        },
-        onUploadUrlAvailable() {
-          if (!context.metadata["upload-url"]) {
-            context.metadata["upload-url"] = upload.url;
-          }
-        }
-      });
-      if (context.metadata["upload-url"]) {
-        upload.resumeFromPreviousUpload({
-          size: context.size,
-          creationTime: context.metadata["creation_date"],
-          metadata,
-          uploadUrl: context.metadata["upload-url"]
-        });
-      }
-      upload.start();
-    });
-    return bytesUploaded;
-  }
-  async finishChunkedUpload(_filepath, _context) {
-  }
-  async deleteChunkedUpload(filepath, _context) {
-    await this.delete(filepath);
-  }
+	config;
+	client;
+	bucket;
+	preferredChunkSize;
+	constructor(config) {
+		this.config = {
+			...config,
+			root: normalizePath(config.root ?? "", { removeLeading: true })
+		};
+		this.preferredChunkSize = this.config.tus?.chunkSize ?? DEFAULT_CHUNK_SIZE;
+		this.client = this.getClient();
+		this.bucket = this.getBucket();
+	}
+	get endpoint() {
+		return this.config.endpoint ?? `https://${this.config.projectId}.supabase.co/storage/v1`;
+	}
+	getClient() {
+		if (!this.config.projectId && !this.config.endpoint) throw new Error("`project_id` or `endpoint` is required");
+		if (!this.config.serviceRole) throw new Error("`service_role` is required");
+		return new StorageClient(this.endpoint, {
+			apikey: this.config.serviceRole,
+			Authorization: `Bearer ${this.config.serviceRole}`
+		});
+	}
+	getBucket() {
+		if (!this.config.bucket) throw new Error("`bucket` is required");
+		return this.client.from(this.config.bucket);
+	}
+	fullPath(filepath) {
+		const path = join(this.config.root, filepath);
+		if (path === ".") return "";
+		return normalizePath(path);
+	}
+	getAuthenticatedUrl(filepath) {
+		return `${this.endpoint}/${join("object/authenticated", this.config.bucket, this.fullPath(filepath))}`;
+	}
+	getResumableUrl() {
+		return `${this.endpoint}/upload/resumable`;
+	}
+	async read(filepath, options) {
+		const { range } = options || {};
+		const requestInit = { method: "GET" };
+		requestInit.headers = { Authorization: `Bearer ${this.config.serviceRole}` };
+		if (range) requestInit.headers["Range"] = `bytes=${range.start ?? ""}-${range.end ?? ""}`;
+		const response = await fetch(this.getAuthenticatedUrl(filepath), requestInit);
+		if (response.status >= 400 || !response.body) throw new Error(`No stream returned for file "${filepath}"`);
+		return Readable.fromWeb(response.body);
+	}
+	async stat(filepath) {
+		const { data, error } = await this.bucket.list(this.config.root, {
+			search: filepath,
+			limit: 1
+		});
+		if (error || data.length === 0) throw new Error("File not found");
+		return {
+			size: data[0]?.metadata["contentLength"] ?? 0,
+			modified: new Date(data[0]?.metadata["lastModified"] || null)
+		};
+	}
+	async exists(filepath) {
+		try {
+			await this.stat(filepath);
+			return true;
+		} catch {
+			return false;
+		}
+	}
+	async move(src, dest) {
+		await this.bucket.move(this.fullPath(src), this.fullPath(dest));
+	}
+	async copy(src, dest) {
+		await this.bucket.copy(this.fullPath(src), this.fullPath(dest));
+	}
+	async write(filepath, content, type) {
+		await this.bucket.upload(this.fullPath(filepath), content, {
+			contentType: type ?? "",
+			cacheControl: "3600",
+			upsert: true,
+			duplex: "half"
+		});
+	}
+	async delete(filepath) {
+		await this.bucket.remove([this.fullPath(filepath)]);
+	}
+	list(prefix = "") {
+		const fullPrefix = this.fullPath(prefix);
+		return this.listGenerator(fullPrefix);
+	}
+	async *listGenerator(prefix) {
+		const limit = 1e3;
+		let offset = 0;
+		let itemCount = 0;
+		const isDirectory = prefix.endsWith("/");
+		const prefixDirectory = isDirectory ? prefix : dirname(prefix);
+		const search = isDirectory ? "" : prefix.split("/").pop() ?? "";
+		do {
+			const { data, error } = await this.bucket.list(prefixDirectory, {
+				limit,
+				offset,
+				search
+			});
+			if (!data || error) break;
+			itemCount = data.length;
+			offset += itemCount;
+			for (const item of data) {
+				const filePath = normalizePath(join(prefixDirectory, item.name));
+				if (item.id !== null) yield filePath.substring(this.config.root ? this.config.root.length + 1 : 0);
+				else yield* this.listGenerator(`${filePath}/`);
+			}
+		} while (itemCount === limit);
+	}
+	get tusExtensions() {
+		return [
+			"creation",
+			"termination",
+			"expiration"
+		];
+	}
+	async createChunkedUpload(_filepath, context) {
+		return context;
+	}
+	async writeChunk(filepath, content, offset, context) {
+		let bytesUploaded = offset || 0;
+		const metadata = {
+			bucketName: this.config.bucket,
+			objectName: this.fullPath(filepath),
+			contentType: context.metadata["type"] ?? "image/png",
+			cacheControl: "3600"
+		};
+		await new Promise((resolve, reject) => {
+			const upload = new tus.Upload(content, {
+				endpoint: this.getResumableUrl(),
+				fileReader: new FileReader(),
+				headers: {
+					Authorization: `Bearer ${this.config.serviceRole}`,
+					"x-upsert": "true"
+				},
+				metadata,
+				chunkSize: this.preferredChunkSize,
+				uploadSize: context.size,
+				retryDelays: null,
+				onError(error) {
+					reject(error);
+				},
+				onChunkComplete: function(chunkSize) {
+					bytesUploaded += chunkSize;
+					resolve(null);
+				},
+				onSuccess() {
+					resolve(null);
+				},
+				onUploadUrlAvailable() {
+					if (!context.metadata["upload-url"]) context.metadata["upload-url"] = upload.url;
+				}
+			});
+			if (context.metadata["upload-url"]) upload.resumeFromPreviousUpload({
+				size: context.size,
+				creationTime: context.metadata["creation_date"],
+				metadata,
+				uploadUrl: context.metadata["upload-url"]
+			});
+			upload.start();
+		});
+		return bytesUploaded;
+	}
+	async finishChunkedUpload(_filepath, _context) {}
+	async deleteChunkedUpload(filepath, _context) {
+		await this.delete(filepath);
+	}
 };
-var index_default = DriverSupabase;
+var src_default = DriverSupabase;
+/**
+* dirname implementation that always uses '/' to split and returns '' in case of no separator present.
+*/
 function dirname(path) {
-  return path.split("/").slice(0, -1).join("/");
+	return path.split("/").slice(0, -1).join("/");
 }
-var StreamSource2 = class extends tus.StreamSource {
-  _streamEnded = false;
-  // @ts-expect-error
-  async slice(start, end) {
-    if (this._streamEnded) return null;
-    this._streamEnded = true;
-    return super.slice(0, end - start);
-  }
+var StreamSource = class extends tus.StreamSource {
+	_streamEnded = false;
+	async slice(start, end) {
+		if (this._streamEnded) return null;
+		this._streamEnded = true;
+		return super.slice(0, end - start);
+	}
 };
 var FileReader = class {
-  async openFile(input, _) {
-    return new StreamSource2(input);
-  }
-};
-export {
-  DriverSupabase,
-  index_default as default
+	async openFile(input, _) {
+		return new StreamSource(input);
+	}
 };
+
+//#endregion
+export { DriverSupabase, src_default as default };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@directus/storage-driver-supabase",
-  "version": "3.0.7",
+  "version": "3.0.9",
   "description": "Supabase file storage abstraction for `@directus/storage`",
   "homepage": "https://directus.io",
   "repository": {
@@ -21,24 +21,25 @@
     "dist"
   ],
   "dependencies": {
-    "@supabase/storage-js": "2.7.1",
+    "@supabase/storage-js": "2.10.4",
     "tus-js-client": "4.3.1",
-    "undici": "7.5.0",
-    "@directus/utils": "13.0.8",
-    "@directus/storage": "12.0.0",
-    "@directus/constants": "13.0.1"
+    "undici": "7.13.0",
+    "@directus/constants": "13.0.3",
+    "@directus/utils": "13.0.10",
+    "@directus/storage": "12.0.2"
   },
   "devDependencies": {
     "@directus/tsconfig": "3.0.0",
-    "@ngneat/falso": "7.3.0",
+    "@ngneat/falso": "8.0.2",
     "@vitest/coverage-v8": "3.2.4",
-    "tsup": "8.5.0",
+    "tsdown": "0.14.2",
     "typescript": "5.8.3",
-    "vitest": "3.2.4"
+    "vitest": "3.2.4",
+    "@directus/types": "13.2.3"
   },
   "scripts": {
-    "build": "tsup src/index.ts --format=esm --dts",
-    "dev": "tsup src/index.ts --format=esm --dts --watch",
+    "build": "tsdown src/index.ts --dts",
+    "dev": "tsdown src/index.ts --dts --watch",
     "test": "vitest run",
     "test:coverage": "vitest run --coverage"
   }