@directus/storage-driver-supabase 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,34 @@
+/// <reference types="node" resolution-mode="require"/>
+import type { Driver, Range } from '@directus/storage';
+import { Readable } from 'node:stream';
+export type DriverSupabaseConfig = {
+    bucket: string;
+    serviceRole: string;
+    projectId?: string;
+    endpoint?: string;
+    root?: string;
+};
+export declare class DriverSupabase implements Driver {
+    private config;
+    private client;
+    private bucket;
+    constructor(config: DriverSupabaseConfig);
+    private get endpoint();
+    private getClient;
+    private getBucket;
+    private getFullPath;
+    private getAuthenticatedUrl;
+    read(filepath: string, range?: Range): Promise<Readable>;
+    head(filepath: string): Promise<import("undici").Headers>;
+    stat(filepath: string): Promise<{
+        size: number;
+        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): AsyncGenerator<string, void, unknown>;
+}
+export default DriverSupabase;

package/dist/index.js

@@ -0,0 +1,118 @@
+import { normalizePath } from '@directus/utils';
+import { StorageClient } from '@supabase/storage-js';
+import { join } from 'node:path';
+import { Readable } from 'node:stream';
+import { fetch } from 'undici';
+export class DriverSupabase {
+    config;
+    client;
+    bucket;
+    constructor(config) {
+        this.config = config;
+        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);
+    }
+    getFullPath(filepath) {
+        return this.config.root ? normalizePath(join(this.config.root, filepath)) : filepath;
+    }
+    getAuthenticatedUrl(filepath) {
+        return `${this.endpoint}/${join('object/authenticated', this.config.bucket, this.getFullPath(filepath))}`;
+    }
+    async read(filepath, range) {
+        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 head(filepath) {
+        const response = await fetch(this.getAuthenticatedUrl(filepath), {
+            method: 'HEAD',
+            headers: {
+                Authorization: `Bearer ${this.config.serviceRole}`,
+            },
+        });
+        if (response.status >= 400) {
+            throw new Error('File not found');
+        }
+        return response.headers;
+    }
+    async stat(filepath) {
+        const headers = await this.head(filepath);
+        return {
+            size: parseInt(headers.get('content-length') || ''),
+            modified: new Date(headers.get('last-modified') || ''),
+        };
+    }
+    async exists(filepath) {
+        try {
+            await this.stat(filepath);
+            return true;
+        }
+        catch {
+            return false;
+        }
+    }
+    async move(src, dest) {
+        await this.bucket.move(this.getFullPath(src), this.getFullPath(dest));
+    }
+    async copy(src, dest) {
+        await this.bucket.copy(this.getFullPath(src), this.getFullPath(dest));
+    }
+    async write(filepath, content, type) {
+        await this.bucket.upload(this.getFullPath(filepath), content, {
+            contentType: type ?? '',
+            cacheControl: '3600',
+            upsert: true,
+            duplex: 'half',
+        });
+    }
+    async delete(filepath) {
+        await this.bucket.remove([this.getFullPath(filepath)]);
+    }
+    async *list(prefix = '') {
+        const limit = 1000;
+        let offset = 0;
+        let itemCount = 0;
+        do {
+            const { data, error } = await this.bucket.list(this.config.root, { limit, offset, search: prefix });
+            if (!data || error) {
+                break;
+            }
+            itemCount = data.length;
+            offset += itemCount;
+            for (const item of data) {
+                yield item.name;
+            }
+        } while (itemCount === limit);
+    }
+}
+export default DriverSupabase;

package/license

@@ -0,0 +1,107 @@
+Licensor:             Monospace, Inc.
+
+Licensed Work:        Directus
+                      The Licensed Work is Copyright © 2023 Monospace, Inc.
+
+Additional Use Grant: You may use the Licensed Work in production as long as
+                      your Total Finances do not exceed US $5,000,000 for the
+                      most recent 12-month period, provided that Monospace, Inc.
+                      will not be liable to you in any way, including for any
+                      damages, including general, special, incidental or
+                      consequential damages, arising out of such use.
+
+                      References to: “Total Finances” mean the largest of your
+                      aggregate gross revenues, entire budget, and/or funding
+                      (no matter the source); “you” and “your” include (without
+                      limitation) any individual or entity agreeing to these
+                      terms and any affiliates of such individual or entity; and
+                      “production” mean any use other than (i) development of
+                      (including evaluation of the Licensed Work), debugging, or
+                      testing your offerings, or (ii) making the Licensed Work
+                      available standalone in unmodified object code form.
+
+Change Date:          Three years from release date
+
+Change License:       GNU General Public License (GPL) v3
+
+For information about alternative licensing arrangements, please visit
+https://directus.io/pricing.
+
+--------------------------------------------------------------------------------
+
+Business Source License 1.1
+
+Terms
+
+The Licensor hereby grants you the right to copy, modify, create derivative
+works, redistribute, and make non-production use of the Licensed Work. The
+Licensor may make an Additional Use Grant, above, permitting limited production
+use.
+
+Effective on the Change Date, or the fourth anniversary of the first publicly
+available distribution of a specific version of the Licensed Work under this
+License, whichever comes first, the Licensor hereby grants you rights under the
+terms of the Change License, and the rights granted in the paragraph above
+terminate.
+
+If your use of the Licensed Work does not comply with the requirements currently
+in effect as described in this License, you must purchase a commercial license
+from the Licensor, its affiliated entities, or authorized resellers, or you must
+refrain from using the Licensed Work.
+
+All copies of the original and modified Licensed Work, and derivative works of
+the Licensed Work, are subject to this License. This License applies separately
+for each version of the Licensed Work and the Change Date may vary for each
+version of the Licensed Work released by Licensor.
+
+You must conspicuously display this License on each original or modified copy of
+the Licensed Work. If you receive the Licensed Work in original or modified form
+from a third party, the terms and conditions set forth in this License apply to
+your use of that work.
+
+Any use of the Licensed Work in violation of this License will automatically
+terminate your rights under this License for the current and all other versions
+of the Licensed Work.
+
+This License does not grant you any right in any trademark or logo of Licensor
+or its affiliates (provided that you may use a trademark or logo of Licensor as
+expressly required by this License).
+
+TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON AN
+“AS IS” BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS, EXPRESS
+OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND TITLE.
+
+MariaDB hereby grants you permission to use this License’s text to license your
+works, and to refer to it using the trademark “Business Source License”, as long
+as you comply with the Covenants of Licensor below.
+
+Covenants of Licensor
+
+In consideration of the right to use this License’s text and the “Business
+Source License” name and trademark, Licensor covenants to MariaDB, and to all
+other recipients of the licensed work to be provided by Licensor:
+
+1. To specify as the Change License the GPL Version 2.0 or any later version,
+   or a license that is compatible with GPL Version 2.0 or a later version,
+   where “compatible” means that software provided under the Change License can
+   be included in a program with software provided under GPL Version 2.0 or a
+   later version. Licensor may specify additional Change Licenses without
+   limitation.
+
+2. To either: (a) specify an additional grant of rights to use that does not
+   impose any additional restriction on the right granted in this License, as
+   the Additional Use Grant; or (b) insert the text “None”.
+
+3. To specify a Change Date.
+
+4. Not to modify this License in any other way.
+
+Notice
+
+The Business Source License (this document, or the "License") is not an Open
+Source license. However, the Licensed Work will eventually be made available
+under an Open Source License, as stated in this License.
+
+License text copyright © 2023 MariaDB plc, All Rights Reserved.
+“Business Source License” is a trademark of MariaDB plc.

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@directus/storage-driver-supabase",
+  "version": "1.0.0",
+  "description": "Supabase file storage abstraction for `@directus/storage`",
+  "homepage": "https://directus.io",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/directus/directus.git",
+    "directory": "packages/storage-driver-supabase"
+  },
+  "funding": "https://github.com/directus/directus?sponsor=1",
+  "license": "BUSL-1.1",
+  "author": "Matthew Rollinson <matt@rolley.io>",
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.js",
+    "./package.json": "./package.json"
+  },
+  "main": "dist/index.js",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@supabase/storage-js": "2.5.1",
+    "undici": "5.22.1",
+    "@directus/storage": "10.0.5",
+    "@directus/utils": "10.0.8"
+  },
+  "devDependencies": {
+    "@ngneat/falso": "6.4.0",
+    "@vitest/coverage-c8": "0.31.1",
+    "typescript": "5.0.4",
+    "vitest": "0.31.1",
+    "@directus/tsconfig": "1.0.0"
+  },
+  "scripts": {
+    "build": "tsc --project tsconfig.prod.json",
+    "dev": "tsc --watch",
+    "test": "vitest --watch=false"
+  }
+}

package/readme.md

@@ -0,0 +1,3 @@
+# `@directus/storage-driver-supabase`
+
+Supabase file storage driver for `@directus/storage`