@storyshelf/storage-gcs 0.6.2 → 0.8.0

package/README.md

@@ -64,6 +64,20 @@ interface GcsStorageOptions {
 }
 ```
 
+Options at a glance:
+
+| Option        | Required | Notes                                                    |
+| ------------- | -------- | -------------------------------------------------------- |
+| `bucket`      | yes      | GCS bucket name                                          |
+| `prefix`      | no       | Key prefix for every object                              |
+| `client`      | no       | Pre-built `Storage` client (tests, custom endpoint)      |
+| `projectId`   | no       | GCP project ID (defaults to ADC)                         |
+| `keyFilename` | no       | Path to service-account JSON                             |
+| `credentials` | no       | Inline service-account object                            |
+| `apiEndpoint` | no       | Custom endpoint (emulator, e.g. `http://localhost:9090`) |
+
+Auth otherwise uses Application Default Credentials.
+
 ### `createGcsStorage(options: GcsStorageOptions): StorageAdapter`
 
 Creates a `StorageAdapter` backed by the configured GCS bucket. The returned adapter implements every method of the `StorageAdapter` interface (`read`, `write`, `delete`, `exists`, `list(prefix)`, `readStream`, `writeStream`).

package/dist/client.mjs

@@ -2,7 +2,7 @@ import "node:path";
 import "node:url";
 import.meta.url;
 import { Storage } from "@google-cloud/storage";
-//#region src/client.ts
+// src/client.ts
 /** GCS Storage client construction and shared operation context. */
 /** Build the bucket handle plus key prefix every GCS operation threads through. */
 function createGcsContext(options) {
@@ -21,7 +21,6 @@ function resolveClientOptions(options) {
 	if (options.apiEndpoint !== void 0) config.apiEndpoint = options.apiEndpoint;
 	return config;
 }
-//#endregion
 export { createGcsContext, resolveClientOptions };
 
 //# sourceMappingURL=client.mjs.map

package/dist/errors.mjs

@@ -1,7 +1,7 @@
 import "node:path";
 import "node:url";
 import.meta.url;
-//#region src/errors.ts
+// src/errors.ts
 /** Not-found guard for GCS API errors. */
 /** Return whether a GCS error signals a missing object. */
 function isNotFound(error) {
@@ -10,7 +10,6 @@ function isNotFound(error) {
 	if (err.statusCode === 404) return true;
 	return err.errors?.[0]?.reason === "notFound";
 }
-//#endregion
 export { isNotFound };
 
 //# sourceMappingURL=errors.mjs.map

package/dist/index.d.mts

@@ -3,7 +3,6 @@ import __tsdown_shims_url from 'node:url';
 import { GcsStorageOptions } from "./types.mjs";
 import { gcsKey } from "./keys.mjs";
 import { StorageAdapter } from "@storyshelf/core/adapter/storage";
-//#region src/index.d.ts
 /**
  * Create a Google Cloud Storage (GCS) StorageAdapter.
  *
@@ -11,6 +10,5 @@ import { StorageAdapter } from "@storyshelf/core/adapter/storage";
  * @returns A StorageAdapter backed by the configured GCS bucket.
  */
 declare function createGcsStorage(options: GcsStorageOptions): StorageAdapter;
-//#endregion
 export { type GcsStorageOptions, createGcsStorage, gcsKey };
 //# sourceMappingURL=index.d.mts.map

package/dist/index.mjs

@@ -6,7 +6,7 @@ import { createGcsLifecycle } from "./lifecycle.mjs";
 import { gcsKey } from "./keys.mjs";
 import { gcsDelete, gcsExists, gcsList, gcsRead, gcsWrite } from "./operations.mjs";
 import { gcsReadStream, gcsWriteStream } from "./streams.mjs";
-//#region src/index.ts
+// src/index.ts
 /**
 * Create a Google Cloud Storage (GCS) StorageAdapter.
 *
@@ -18,7 +18,7 @@ function createGcsStorage(options) {
 	return {
 		metadata: {
 			name: "GCS Storage",
-			version: globalThis.__PKG_VERSION__ ?? "0.0.0",
+			version: "0.8.0",
 			description: "Google Cloud Storage adapter",
 			kind: "gcs",
 			category: "storage"
@@ -47,7 +47,6 @@ function createGcsStorage(options) {
 		}
 	};
 }
-//#endregion
 export { createGcsStorage, gcsKey };
 
 //# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["/**\n * Google Cloud Storage adapter for StoryShelf.\n *\n * Server-side blob storage for screenshots, diffs, and Storybook archives.\n * The factory wires per-concern modules (client, lifecycle, operations,\n * streams); key and option helpers are re-exported below.\n */\nimport type { StorageAdapter } from \"@storyshelf/core/adapter/storage\";\nimport { createGcsContext } from \"./client.ts\";\nimport { createGcsLifecycle } from \"./lifecycle.ts\";\nimport { gcsDelete, gcsExists, gcsList, gcsRead, gcsWrite } from \"./operations.ts\";\nimport { gcsReadStream, gcsWriteStream } from \"./streams.ts\";\nimport type { GcsStorageOptions } from \"./types.ts\";\n\ndeclare const __PKG_VERSION__: string | undefined;\n\n/**\n * Create a Google Cloud Storage (GCS) StorageAdapter.\n *\n * @param options - GCS configuration options.\n * @returns A StorageAdapter backed by the configured GCS bucket.\n */\nexport function createGcsStorage(options: GcsStorageOptions): StorageAdapter {\n  const ctx = createGcsContext(options);\n\n  return {\n    metadata: {\n      name: \"GCS Storage\",\n      version: (globalThis as unknown as { __PKG_VERSION__?: string }).__PKG_VERSION__ ?? \"0.0.0\",\n      description: \"Google Cloud Storage adapter\",\n      kind: \"gcs\",\n      category: \"storage\",\n    },\n    lifecycle: createGcsLifecycle(ctx),\n    async read(path) {\n      return await gcsRead(ctx, path);\n    },\n    async write(path, data) {\n      await gcsWrite(ctx, path, data);\n    },\n    async delete(path) {\n      await gcsDelete(ctx, path);\n    },\n    async exists(path) {\n      return await gcsExists(ctx, path);\n    },\n    async list(listPrefix) {\n      return await gcsList(ctx, listPrefix);\n    },\n    async writeStream(path, stream) {\n      await gcsWriteStream(ctx, path, stream);\n    },\n    async readStream(path) {\n      return await gcsReadStream(ctx, path);\n    },\n  };\n}\n\nexport type { GcsStorageOptions } from \"./types.ts\";\nexport { gcsKey } from \"./keys.ts\";\n"],"mappings":";;;;;;;;;;;;;;;AAsBA,SAAgB,iBAAiB,SAA4C;CAC3E,MAAM,MAAM,iBAAiB,OAAO;CAEpC,OAAO;EACL,UAAU;GACR,MAAM;GACN,SAAU,WAAuD,mBAAmB;GACpF,aAAa;GACb,MAAM;GACN,UAAU;EACZ;EACA,WAAW,mBAAmB,GAAG;EACjC,MAAM,KAAK,MAAM;GACf,OAAO,MAAM,QAAQ,KAAK,IAAI;EAChC;EACA,MAAM,MAAM,MAAM,MAAM;GACtB,MAAM,SAAS,KAAK,MAAM,IAAI;EAChC;EACA,MAAM,OAAO,MAAM;GACjB,MAAM,UAAU,KAAK,IAAI;EAC3B;EACA,MAAM,OAAO,MAAM;GACjB,OAAO,MAAM,UAAU,KAAK,IAAI;EAClC;EACA,MAAM,KAAK,YAAY;GACrB,OAAO,MAAM,QAAQ,KAAK,UAAU;EACtC;EACA,MAAM,YAAY,MAAM,QAAQ;GAC9B,MAAM,eAAe,KAAK,MAAM,MAAM;EACxC;EACA,MAAM,WAAW,MAAM;GACrB,OAAO,MAAM,cAAc,KAAK,IAAI;EACtC;CACF;AACF"}
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["/**\n * Google Cloud Storage adapter for StoryShelf.\n *\n * Server-side blob storage for screenshots, diffs, and Storybook archives.\n * The factory wires per-concern modules (client, lifecycle, operations,\n * streams); key and option helpers are re-exported below.\n */\nimport type { StorageAdapter } from \"@storyshelf/core/adapter/storage\";\nimport { createGcsContext } from \"./client.ts\";\nimport { createGcsLifecycle } from \"./lifecycle.ts\";\nimport { gcsDelete, gcsExists, gcsList, gcsRead, gcsWrite } from \"./operations.ts\";\nimport { gcsReadStream, gcsWriteStream } from \"./streams.ts\";\nimport type { GcsStorageOptions } from \"./types.ts\";\n\ndeclare const __PKG_VERSION__: string | undefined;\n\n/**\n * Create a Google Cloud Storage (GCS) StorageAdapter.\n *\n * @param options - GCS configuration options.\n * @returns A StorageAdapter backed by the configured GCS bucket.\n */\nexport function createGcsStorage(options: GcsStorageOptions): StorageAdapter {\n  const ctx = createGcsContext(options);\n\n  return {\n    metadata: {\n      name: \"GCS Storage\",\n      version: typeof __PKG_VERSION__ === \"string\" ? __PKG_VERSION__ : \"0.0.0\",\n      description: \"Google Cloud Storage adapter\",\n      kind: \"gcs\",\n      category: \"storage\",\n    },\n    lifecycle: createGcsLifecycle(ctx),\n    async read(path) {\n      return await gcsRead(ctx, path);\n    },\n    async write(path, data) {\n      await gcsWrite(ctx, path, data);\n    },\n    async delete(path) {\n      await gcsDelete(ctx, path);\n    },\n    async exists(path) {\n      return await gcsExists(ctx, path);\n    },\n    async list(listPrefix) {\n      return await gcsList(ctx, listPrefix);\n    },\n    async writeStream(path, stream) {\n      await gcsWriteStream(ctx, path, stream);\n    },\n    async readStream(path) {\n      return await gcsReadStream(ctx, path);\n    },\n  };\n}\n\nexport type { GcsStorageOptions } from \"./types.ts\";\nexport { gcsKey } from \"./keys.ts\";\n"],"mappings":";;;;;;;;;;;;;;;AAsBA,SAAgB,iBAAiB,SAA4C;CAC3E,MAAM,MAAM,iBAAiB,OAAO;CAEpC,OAAO;EACL,UAAU;GACR,MAAM;GACN,SAAA;GACA,aAAa;GACb,MAAM;GACN,UAAU;EACZ;EACA,WAAW,mBAAmB,GAAG;EACjC,MAAM,KAAK,MAAM;GACf,OAAO,MAAM,QAAQ,KAAK,IAAI;EAChC;EACA,MAAM,MAAM,MAAM,MAAM;GACtB,MAAM,SAAS,KAAK,MAAM,IAAI;EAChC;EACA,MAAM,OAAO,MAAM;GACjB,MAAM,UAAU,KAAK,IAAI;EAC3B;EACA,MAAM,OAAO,MAAM;GACjB,OAAO,MAAM,UAAU,KAAK,IAAI;EAClC;EACA,MAAM,KAAK,YAAY;GACrB,OAAO,MAAM,QAAQ,KAAK,UAAU;EACtC;EACA,MAAM,YAAY,MAAM,QAAQ;GAC9B,MAAM,eAAe,KAAK,MAAM,MAAM;EACxC;EACA,MAAM,WAAW,MAAM;GACrB,OAAO,MAAM,cAAc,KAAK,IAAI;EACtC;CACF;AACF"}

package/dist/keys.d.mts

@@ -1,9 +1,7 @@
 import __tsdown_shims_path from 'node:path';
 import __tsdown_shims_url from 'node:url';
-//#region src/keys.d.ts
 /** Key join/split for GCS object keys. */
 /** Join an optional key prefix with a storage path. */
 declare function gcsKey(prefix: string, path: string): string;
-//#endregion
 export { gcsKey };
 //# sourceMappingURL=keys.d.mts.map

package/dist/keys.mjs

@@ -1,7 +1,7 @@
 import "node:path";
 import "node:url";
 import.meta.url;
-//#region src/keys.ts
+// src/keys.ts
 /** Key join/split for GCS object keys. */
 /** Join an optional key prefix with a storage path. */
 function gcsKey(prefix, path) {
@@ -11,7 +11,6 @@ function gcsKey(prefix, path) {
 function gcsRel(prefix, key) {
 	return prefix === "" ? key : key.slice(prefix.length + 1);
 }
-//#endregion
 export { gcsKey, gcsRel };
 
 //# sourceMappingURL=keys.mjs.map

package/dist/lifecycle.mjs

@@ -1,7 +1,7 @@
 import "node:path";
 import "node:url";
 import.meta.url;
-//#region src/lifecycle.ts
+// src/lifecycle.ts
 /** Build the setup/health/teardown hooks probing a GCS bucket. */
 function createGcsLifecycle(ctx) {
 	return {
@@ -24,7 +24,6 @@ function gcsHealthQuery(prefix) {
 		maxResults: 1
 	};
 }
-//#endregion
 export { createGcsLifecycle, gcsHealthQuery };
 
 //# sourceMappingURL=lifecycle.mjs.map

package/dist/operations.mjs

@@ -3,7 +3,7 @@ import "node:url";
 import.meta.url;
 import { isNotFound } from "./errors.mjs";
 import { gcsKey, gcsRel } from "./keys.mjs";
-//#region src/operations.ts
+// src/operations.ts
 /** Download the full bytes stored at `path`. */
 async function gcsRead(ctx, path) {
 	const [data] = await ctx.bucket.file(gcsKey(ctx.prefix, path)).download();
@@ -45,7 +45,6 @@ function nextQueryQuery(nextQuery) {
 	if (!nextQuery || typeof nextQuery !== "object") return;
 	return nextQuery.pageToken ? nextQuery : void 0;
 }
-//#endregion
 export { gcsDelete, gcsExists, gcsList, gcsRead, gcsWrite };
 
 //# sourceMappingURL=operations.mjs.map

package/dist/streams.mjs

@@ -3,7 +3,7 @@ import "node:url";
 import.meta.url;
 import { gcsKey } from "./keys.mjs";
 import { pipeline } from "node:stream/promises";
-//#region src/streams.ts
+// src/streams.ts
 /** Stream `stream` to `path`, deleting the partial object when the pipeline fails. */
 async function gcsWriteStream(ctx, path, stream) {
 	const file = ctx.bucket.file(gcsKey(ctx.prefix, path));
@@ -24,7 +24,6 @@ async function gcsReadStream(ctx, path) {
 	if (!exists) throw new Error(`No object at "${path}"`);
 	return file.createReadStream();
 }
-//#endregion
 export { gcsReadStream, gcsWriteStream };
 
 //# sourceMappingURL=streams.mjs.map

package/dist/types.d.mts

@@ -1,7 +1,6 @@
 import __tsdown_shims_path from 'node:path';
 import __tsdown_shims_url from 'node:url';
 import { Storage } from "@google-cloud/storage";
-//#region src/types.d.ts
 /** Options for configuring a GCS storage adapter. */
 interface GcsStorageOptions {
   /** GCS bucket name. */
@@ -19,6 +18,5 @@ interface GcsStorageOptions {
   /** Custom API endpoint (e.g. emulator: http://localhost:9090). */
   apiEndpoint?: string;
 }
-//#endregion
 export { GcsStorageOptions };
 //# sourceMappingURL=types.d.mts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storyshelf/storage-gcs",
-  "version": "0.6.2",
+  "version": "0.8.0",
   "description": "Google Cloud Storage adapter for StoryShelf.",
   "keywords": [
     "gcs",
@@ -27,9 +27,6 @@
     "dist"
   ],
   "type": "module",
-  "engines": {
-    "node": ">=24"
-  },
   "sideEffects": false,
   "types": "./dist/index.d.mts",
   "exports": {
@@ -56,7 +53,7 @@
   },
   "dependencies": {
     "@google-cloud/storage": "^7.13.0",
-    "@storyshelf/core": "0.6.2"
+    "@storyshelf/core": "0.8.0"
   },
   "devDependencies": {
     "@types/node": "^26.0.0",
@@ -66,7 +63,10 @@
     "oxlint-tsgolint": "^7.0.2001",
     "tsdown": "^0.22.14",
     "typescript": "^7.0.2",
-    "vitest": "^5.0.0"
+    "vitest": "^5.0.5"
+  },
+  "engines": {
+    "node": ">=24"
   },
   "jsr": {
     "runtimeCompat": {