@basaltkit/storage-gcs 1.0.0 → 1.1.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2026 Machize Contributors
+Copyright (c) 2026 Basalt Contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,3 +1,9 @@
+<p align="center">
+  <a href="https://basaltkit-docs.pages.dev">
+    <img src="https://basaltkit-docs.pages.dev/social-card.png" alt="Basalt" width="440">
+  </a>
+</p>
+
 # @basaltkit/storage-gcs
 
 **Google Cloud Storage** driver for [`@basaltkit/storage`](https://www.npmjs.com/package/@basaltkit/storage): stores files on GCS without changing your app's code. You need this module when you run on Google Cloud and want GCS instead of S3 or local disk.

package/dist/index.d.ts

@@ -1,7 +1,6 @@
-import { StorageDriver, PutOptions } from '@basaltkit/storage';
-
+import { type TemporaryUrlOptions, type PutOptions, type StorageDriver } from '@basaltkit/storage';
 /** The subset of a `@google-cloud/storage` File this driver uses. */
-interface GcsFileLike {
+export interface GcsFileLike {
     save(data: Buffer, options?: {
         contentType?: string;
     }): Promise<unknown>;
@@ -11,10 +10,11 @@ interface GcsFileLike {
     getSignedUrl(config: {
         action: 'read';
         expires: number;
+        responseDisposition?: string;
     }): Promise<[string]>;
 }
 /** The subset of a `@google-cloud/storage` Bucket this driver uses. */
-interface GcsBucketLike {
+export interface GcsBucketLike {
     file(path: string): GcsFileLike;
     getFiles(options?: {
         prefix?: string;
@@ -22,7 +22,7 @@ interface GcsBucketLike {
         name: string;
     }[]]>;
 }
-interface GcsDriverOptions {
+export interface GcsDriverOptions {
     bucket: string;
     projectId?: string;
     keyFilename?: string;
@@ -34,7 +34,7 @@ interface GcsDriverOptions {
  * `@google-cloud/storage` (an optional peer dependency) via an injectable
  * bucket, so its logic is unit-tested without touching GCS.
  */
-declare class GcsStorageDriver implements StorageDriver {
+export declare class GcsStorageDriver implements StorageDriver {
     private readonly options;
     readonly name = "gcs";
     private bucketPromise;
@@ -44,9 +44,7 @@ declare class GcsStorageDriver implements StorageDriver {
     exists(path: string): Promise<boolean>;
     delete(path: string): Promise<boolean>;
     list(prefix: string): Promise<string[]>;
-    temporaryUrl(path: string, expiresInMs: number): Promise<string>;
+    temporaryUrl(path: string, expiresInMs: number, options?: TemporaryUrlOptions): Promise<string>;
     disconnect(): Promise<void>;
     private bucket;
 }
-
-export { type GcsBucketLike, type GcsDriverOptions, type GcsFileLike, GcsStorageDriver };

package/dist/index.js

@@ -1,60 +1,73 @@
-// src/index.ts
-import { StorageFileNotFoundError } from "@basaltkit/storage";
-var isNotFound = (error) => error?.code === 404;
-var GcsStorageDriver = class {
-  constructor(options) {
-    this.options = options;
-  }
-  options;
-  name = "gcs";
-  bucketPromise;
-  async put(path, content, options) {
-    const data = Buffer.isBuffer(content) ? content : Buffer.from(content);
-    await (await this.bucket()).file(path).save(data, options?.contentType !== void 0 ? { contentType: options.contentType } : {});
-  }
-  async get(path) {
-    try {
-      const [buffer] = await (await this.bucket()).file(path).download();
-      return buffer;
-    } catch (error) {
-      if (isNotFound(error)) throw new StorageFileNotFoundError(path);
-      throw error;
-    }
-  }
-  async exists(path) {
-    const [exists] = await (await this.bucket()).file(path).exists();
-    return exists;
-  }
-  async delete(path) {
-    if (!await this.exists(path)) return false;
-    await (await this.bucket()).file(path).delete();
-    return true;
-  }
-  async list(prefix) {
-    const [files] = await (await this.bucket()).getFiles({ prefix });
-    return files.map((file) => file.name);
-  }
-  async temporaryUrl(path, expiresInMs) {
-    const [url] = await (await this.bucket()).file(path).getSignedUrl({ action: "read", expires: Date.now() + expiresInMs });
-    return url;
-  }
-  async disconnect() {
-  }
-  bucket() {
-    if (!this.bucketPromise) {
-      this.bucketPromise = this.options.client ? Promise.resolve(this.options.client) : (async () => {
-        const specifier = "@google-cloud/storage";
-        const mod = await import(specifier);
-        const storage = new mod.Storage({
-          ...this.options.projectId ? { projectId: this.options.projectId } : {},
-          ...this.options.keyFilename ? { keyFilename: this.options.keyFilename } : {}
+import { StorageFileNotFoundError } from '@basaltkit/storage';
+const isNotFound = (error) => error?.code === 404;
+/**
+ * Google Cloud Storage driver for `@basaltkit/storage`. Uses
+ * `@google-cloud/storage` (an optional peer dependency) via an injectable
+ * bucket, so its logic is unit-tested without touching GCS.
+ */
+export class GcsStorageDriver {
+    options;
+    name = 'gcs';
+    bucketPromise;
+    constructor(options) {
+        this.options = options;
+    }
+    async put(path, content, options) {
+        const data = Buffer.isBuffer(content) ? content : Buffer.from(content);
+        await (await this.bucket())
+            .file(path)
+            .save(data, options?.contentType !== undefined ? { contentType: options.contentType } : {});
+    }
+    async get(path) {
+        try {
+            const [buffer] = await (await this.bucket()).file(path).download();
+            return buffer;
+        }
+        catch (error) {
+            if (isNotFound(error))
+                throw new StorageFileNotFoundError(path);
+            throw error;
+        }
+    }
+    async exists(path) {
+        const [exists] = await (await this.bucket()).file(path).exists();
+        return exists;
+    }
+    async delete(path) {
+        if (!(await this.exists(path)))
+            return false;
+        await (await this.bucket()).file(path).delete();
+        return true;
+    }
+    async list(prefix) {
+        const [files] = await (await this.bucket()).getFiles({ prefix });
+        return files.map((file) => file.name);
+    }
+    async temporaryUrl(path, expiresInMs, options) {
+        const [url] = await (await this.bucket()).file(path).getSignedUrl({
+            action: 'read',
+            expires: Date.now() + expiresInMs,
+            // Signed response header: uploaded HTML/SVG downloads instead of
+            // rendering on the storage origin ('attachment' is the Disk default).
+            responseDisposition: options?.disposition ?? 'attachment',
         });
-        return storage.bucket(this.options.bucket);
-      })();
-    }
-    return this.bucketPromise;
-  }
-};
-export {
-  GcsStorageDriver
-};
+        return url;
+    }
+    async disconnect() { }
+    bucket() {
+        if (!this.bucketPromise) {
+            this.bucketPromise = this.options.client
+                ? Promise.resolve(this.options.client)
+                : (async () => {
+                    const specifier = '@google-cloud/storage';
+                    const mod = (await import(specifier));
+                    const storage = new mod.Storage({
+                        ...(this.options.projectId ? { projectId: this.options.projectId } : {}),
+                        ...(this.options.keyFilename ? { keyFilename: this.options.keyFilename } : {}),
+                    });
+                    return storage.bucket(this.options.bucket);
+                })();
+        }
+        return this.bucketPromise;
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@basaltkit/storage-gcs",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Google Cloud Storage driver for @basaltkit/storage — put/get/list/delete/signed URLs over @google-cloud/storage, with an injectable client for testing.",
   "license": "MIT",
   "type": "module",
@@ -14,16 +14,15 @@
     "dist"
   ],
   "dependencies": {
-    "@basaltkit/storage": "^1.0.0"
+    "@basaltkit/storage": "^1.3.0"
   },
   "peerDependencies": {
     "@google-cloud/storage": "^7.0.0"
   },
   "devDependencies": {
-    "@types/node": "^22.15.0",
-    "tsup": "^8.4.0",
-    "typescript": "^5.8.0",
-    "vitest": "^3.1.0",
+    "@types/node": "^26.3.0",
+    "typescript": "^7.0.2",
+    "vitest": "^4.1.11",
     "@basaltkit/tsconfig": "^0.24.0"
   },
   "publishConfig": {
@@ -31,11 +30,11 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/Zebedeu/basalt.git",
+    "url": "git+https://github.com/basaltkit/basalt.git",
     "directory": "packages/storage-gcs"
   },
-  "homepage": "https://github.com/Zebedeu/basalt/tree/main/packages/storage-gcs#readme",
-  "bugs": "https://github.com/Zebedeu/basalt/issues",
+  "homepage": "https://github.com/basaltkit/basalt/tree/main/packages/storage-gcs#readme",
+  "bugs": "https://github.com/basaltkit/basalt/issues",
   "keywords": [
     "basalt",
     "typescript",
@@ -44,7 +43,7 @@
     "google-cloud"
   ],
   "scripts": {
-    "build": "tsup src/index.ts --format esm --dts --clean",
+    "build": "tsc -p tsconfig.build.json",
     "test": "vitest run",
     "typecheck": "tsc --noEmit"
   }