@storyshelf/storage-azure 0.6.2 → 0.8.0

package/README.md

@@ -75,6 +75,19 @@ interface AzureStorageOptions {
 }
 ```
 
+Options at a glance:
+
+| Option                       | Required | Notes                                                  |
+| ---------------------------- | -------- | ------------------------------------------------------ |
+| `container`                  | yes      | Blob container name                                    |
+| `prefix`                     | no       | Key prefix applied to every object                     |
+| `client`                     | no       | Pre-built `ContainerClient`; skips client construction |
+| `connectionString`           | no\*     | Storage connection string                              |
+| `accountName` / `accountKey` | no\*     | Explicit credentials pair                              |
+| `accountUrl` / `sasToken`    | no\*     | URL + SAS form (emulator, fine-grained SAS)            |
+
+`*` At least one auth form is needed unless `client` is supplied.
+
 ### `createAzureStorage(options: AzureStorageOptions): StorageAdapter`
 
 Creates a `StorageAdapter` backed by the configured Azure container. 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 { BlobServiceClient, StorageSharedKeyCredential } from "@azure/storage-blob";
-//#region src/client.ts
+// src/client.ts
 /** Resolve the container client for the configured credentials. */
 function resolveContainerClient(options, containerName) {
 	if (options.client) return options.client;
@@ -26,7 +26,6 @@ function buildAccountUrl(accountName) {
 	if (!accountName) return;
 	return `https://${accountName}.blob.core.windows.net`;
 }
-//#endregion
 export { resolveContainerClient };
 
 //# sourceMappingURL=client.mjs.map

package/dist/errors.mjs

@@ -2,7 +2,7 @@ import "node:path";
 import "node:url";
 import.meta.url;
 import "node:stream";
-//#region src/errors.ts
+// src/errors.ts
 /** Not-found guards and stream/collect helpers for Azure blob I/O. */
 /** True when an Azure SDK error means the blob (or container) is missing. */
 function isNotFound(error) {
@@ -35,7 +35,6 @@ async function deleteBlobQuiet(blob) {
 		await withDelete.delete?.();
 	} catch {}
 }
-//#endregion
 export { collectDownload, collectStream, deleteBlobQuiet, isNotFound };
 
 //# sourceMappingURL=errors.mjs.map

package/dist/index.d.mts

@@ -3,7 +3,6 @@ import __tsdown_shims_url from 'node:url';
 import { AzureStorageOptions } from "./types.mjs";
 import { azureKey } from "./keys.mjs";
 import { StorageAdapter } from "@storyshelf/core/adapter/storage";
-//#region src/index.d.ts
 /**
  * Create an Azure Blob Storage-backed StorageAdapter.
  *
@@ -11,6 +10,5 @@ import { StorageAdapter } from "@storyshelf/core/adapter/storage";
  * @returns A StorageAdapter backed by the configured Azure container.
  */
 declare function createAzureStorage(options: AzureStorageOptions): StorageAdapter;
-//#endregion
 export { type AzureStorageOptions, azureKey, createAzureStorage };
 //# sourceMappingURL=index.d.mts.map

package/dist/index.mjs

@@ -6,7 +6,7 @@ import { buildAzureLifecycle } from "./lifecycle.mjs";
 import { azureKey } from "./keys.mjs";
 import { azureDelete, azureExists, azureList, azureRead, azureWrite } from "./operations.mjs";
 import { azureReadStream, azureWriteStream } from "./streams.mjs";
-//#region src/index.ts
+// src/index.ts
 /**
 * Create an Azure Blob Storage-backed StorageAdapter.
 *
@@ -23,7 +23,7 @@ function createAzureStorage(options) {
 	return {
 		metadata: {
 			name: "Azure Blob Storage",
-			version: globalThis.__PKG_VERSION__ ?? "0.0.0",
+			version: "0.8.0",
 			description: "Azure Blob Storage adapter",
 			kind: "azure",
 			category: "storage"
@@ -52,7 +52,6 @@ function createAzureStorage(options) {
 		}
 	};
 }
-//#endregion
 export { azureKey, createAzureStorage };
 
 //# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["/**\n * Azure Blob Storage adapter for StoryShelf.\n *\n * Persists captured screenshots and diff overlays in an Azure Blob container.\n * The CLI uploads the built Storybook; the server renders stories with\n * Playwright and stores the resulting blobs here.\n */\nimport type { StorageAdapter } from \"@storyshelf/core/adapter/storage\";\nimport { resolveContainerClient, type AzureContext } from \"./client.ts\";\nimport { buildAzureLifecycle } from \"./lifecycle.ts\";\nimport { azureDelete, azureExists, azureList, azureRead, azureWrite } from \"./operations.ts\";\nimport { azureReadStream, azureWriteStream } from \"./streams.ts\";\nimport type { AzureStorageOptions } from \"./types.ts\";\n\ndeclare const __PKG_VERSION__: string | undefined;\n\n/**\n * Create an Azure Blob Storage-backed StorageAdapter.\n *\n * @param options - Azure configuration options.\n * @returns A StorageAdapter backed by the configured Azure container.\n */\nexport function createAzureStorage(options: AzureStorageOptions): StorageAdapter {\n  const { container: containerName, prefix = \"\" } = options;\n  const container = resolveContainerClient(options, containerName);\n  const ctx: AzureContext = { container, prefix };\n\n  return {\n    metadata: {\n      name: \"Azure Blob Storage\",\n      version: (globalThis as unknown as { __PKG_VERSION__?: string }).__PKG_VERSION__ ?? \"0.0.0\",\n      description: \"Azure Blob Storage adapter\",\n      kind: \"azure\",\n      category: \"storage\",\n    },\n    lifecycle: buildAzureLifecycle(container, containerName),\n    async read(path) {\n      return await azureRead(ctx, path);\n    },\n    async write(path, data) {\n      await azureWrite(ctx, path, data);\n    },\n    async delete(path) {\n      await azureDelete(ctx, path);\n    },\n    async exists(path) {\n      return await azureExists(ctx, path);\n    },\n    async list(listPrefix) {\n      return await azureList(ctx, listPrefix);\n    },\n    async writeStream(path, stream) {\n      await azureWriteStream(ctx, path, stream);\n    },\n    async readStream(path) {\n      return await azureReadStream(ctx, path);\n    },\n  };\n}\n\nexport type { AzureStorageOptions } from \"./types.ts\";\nexport { azureKey } from \"./keys.ts\";\n"],"mappings":";;;;;;;;;;;;;;;AAsBA,SAAgB,mBAAmB,SAA8C;CAC/E,MAAM,EAAE,WAAW,eAAe,SAAS,OAAO;CAClD,MAAM,YAAY,uBAAuB,SAAS,aAAa;CAC/D,MAAM,MAAoB;EAAE;EAAW;CAAO;CAE9C,OAAO;EACL,UAAU;GACR,MAAM;GACN,SAAU,WAAuD,mBAAmB;GACpF,aAAa;GACb,MAAM;GACN,UAAU;EACZ;EACA,WAAW,oBAAoB,WAAW,aAAa;EACvD,MAAM,KAAK,MAAM;GACf,OAAO,MAAM,UAAU,KAAK,IAAI;EAClC;EACA,MAAM,MAAM,MAAM,MAAM;GACtB,MAAM,WAAW,KAAK,MAAM,IAAI;EAClC;EACA,MAAM,OAAO,MAAM;GACjB,MAAM,YAAY,KAAK,IAAI;EAC7B;EACA,MAAM,OAAO,MAAM;GACjB,OAAO,MAAM,YAAY,KAAK,IAAI;EACpC;EACA,MAAM,KAAK,YAAY;GACrB,OAAO,MAAM,UAAU,KAAK,UAAU;EACxC;EACA,MAAM,YAAY,MAAM,QAAQ;GAC9B,MAAM,iBAAiB,KAAK,MAAM,MAAM;EAC1C;EACA,MAAM,WAAW,MAAM;GACrB,OAAO,MAAM,gBAAgB,KAAK,IAAI;EACxC;CACF;AACF"}
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["/**\n * Azure Blob Storage adapter for StoryShelf.\n *\n * Persists captured screenshots and diff overlays in an Azure Blob container.\n * The CLI uploads the built Storybook; the server renders stories with\n * Playwright and stores the resulting blobs here.\n */\nimport type { StorageAdapter } from \"@storyshelf/core/adapter/storage\";\nimport { resolveContainerClient, type AzureContext } from \"./client.ts\";\nimport { buildAzureLifecycle } from \"./lifecycle.ts\";\nimport { azureDelete, azureExists, azureList, azureRead, azureWrite } from \"./operations.ts\";\nimport { azureReadStream, azureWriteStream } from \"./streams.ts\";\nimport type { AzureStorageOptions } from \"./types.ts\";\n\ndeclare const __PKG_VERSION__: string | undefined;\n\n/**\n * Create an Azure Blob Storage-backed StorageAdapter.\n *\n * @param options - Azure configuration options.\n * @returns A StorageAdapter backed by the configured Azure container.\n */\nexport function createAzureStorage(options: AzureStorageOptions): StorageAdapter {\n  const { container: containerName, prefix = \"\" } = options;\n  const container = resolveContainerClient(options, containerName);\n  const ctx: AzureContext = { container, prefix };\n\n  return {\n    metadata: {\n      name: \"Azure Blob Storage\",\n      version: typeof __PKG_VERSION__ === \"string\" ? __PKG_VERSION__ : \"0.0.0\",\n      description: \"Azure Blob Storage adapter\",\n      kind: \"azure\",\n      category: \"storage\",\n    },\n    lifecycle: buildAzureLifecycle(container, containerName),\n    async read(path) {\n      return await azureRead(ctx, path);\n    },\n    async write(path, data) {\n      await azureWrite(ctx, path, data);\n    },\n    async delete(path) {\n      await azureDelete(ctx, path);\n    },\n    async exists(path) {\n      return await azureExists(ctx, path);\n    },\n    async list(listPrefix) {\n      return await azureList(ctx, listPrefix);\n    },\n    async writeStream(path, stream) {\n      await azureWriteStream(ctx, path, stream);\n    },\n    async readStream(path) {\n      return await azureReadStream(ctx, path);\n    },\n  };\n}\n\nexport type { AzureStorageOptions } from \"./types.ts\";\nexport { azureKey } from \"./keys.ts\";\n"],"mappings":";;;;;;;;;;;;;;;AAsBA,SAAgB,mBAAmB,SAA8C;CAC/E,MAAM,EAAE,WAAW,eAAe,SAAS,OAAO;CAClD,MAAM,YAAY,uBAAuB,SAAS,aAAa;CAC/D,MAAM,MAAoB;EAAE;EAAW;CAAO;CAE9C,OAAO;EACL,UAAU;GACR,MAAM;GACN,SAAA;GACA,aAAa;GACb,MAAM;GACN,UAAU;EACZ;EACA,WAAW,oBAAoB,WAAW,aAAa;EACvD,MAAM,KAAK,MAAM;GACf,OAAO,MAAM,UAAU,KAAK,IAAI;EAClC;EACA,MAAM,MAAM,MAAM,MAAM;GACtB,MAAM,WAAW,KAAK,MAAM,IAAI;EAClC;EACA,MAAM,OAAO,MAAM;GACjB,MAAM,YAAY,KAAK,IAAI;EAC7B;EACA,MAAM,OAAO,MAAM;GACjB,OAAO,MAAM,YAAY,KAAK,IAAI;EACpC;EACA,MAAM,KAAK,YAAY;GACrB,OAAO,MAAM,UAAU,KAAK,UAAU;EACxC;EACA,MAAM,YAAY,MAAM,QAAQ;GAC9B,MAAM,iBAAiB,KAAK,MAAM,MAAM;EAC1C;EACA,MAAM,WAAW,MAAM;GACrB,OAAO,MAAM,gBAAgB,KAAK,IAAI;EACxC;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 Azure blob names. */
 /** Join an optional prefix with a storage path. */
 declare function azureKey(prefix: string, path: string): string;
-//#endregion
 export { azureKey };
 //# 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 Azure blob names. */
 /** Join an optional prefix with a storage path. */
 function azureKey(prefix, path) {
@@ -11,7 +11,6 @@ function azureKey(prefix, path) {
 function azureRel(prefix, key) {
 	return prefix === "" ? key : key.slice(prefix.length + 1);
 }
-//#endregion
 export { azureKey, azureRel };
 
 //# 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 lifecycle for an Azure container. */
 function buildAzureLifecycle(container, containerName) {
 	return {
@@ -30,7 +30,6 @@ async function containerExists(container, containerName) {
 		await iterator.return?.();
 	}
 }
-//#endregion
 export { buildAzureLifecycle };
 
 //# sourceMappingURL=lifecycle.mjs.map

package/dist/operations.mjs

@@ -3,7 +3,7 @@ import "node:url";
 import.meta.url;
 import { collectDownload, isNotFound } from "./errors.mjs";
 import { azureKey, azureRel } from "./keys.mjs";
-//#region src/operations.ts
+// src/operations.ts
 /** Buffered Azure blob CRUD with SDK-version duck-typing and async-iterator list. */
 /** Download a blob, preferring `downloadToBuffer` when the SDK offers it. */
 async function azureRead(ctx, path) {
@@ -48,7 +48,6 @@ async function azureList(ctx, listPrefix) {
 	for await (const item of ctx.container.listBlobsFlat(prefix === "" ? void 0 : { prefix })) blobs.push(azureRel(ctx.prefix, item.name));
 	return blobs;
 }
-//#endregion
 export { azureDelete, azureExists, azureList, azureRead, azureWrite };
 
 //# sourceMappingURL=operations.mjs.map

package/dist/streams.mjs

@@ -5,7 +5,7 @@ import { collectStream, deleteBlobQuiet } from "./errors.mjs";
 import { azureKey } from "./keys.mjs";
 import { azureExists, azureWrite } from "./operations.mjs";
 import { Readable } from "node:stream";
-//#region src/streams.ts
+// src/streams.ts
 /** Streamed Azure blob reads and writes, with failure cleanup. */
 /** Upload a readable, streaming when the SDK supports it and buffering otherwise. */
 async function azureWriteStream(ctx, path, stream) {
@@ -40,7 +40,6 @@ async function writeStreamBuffered(ctx, path, stream, blob) {
 		throw error;
 	}
 }
-//#endregion
 export { azureReadStream, azureWriteStream };
 
 //# 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 { ContainerClient } from "@azure/storage-blob";
-//#region src/types.d.ts
 /** Options for configuring an Azure Blob Storage adapter. */
 interface AzureStorageOptions {
   /** Azure container name. */
@@ -21,6 +20,5 @@ interface AzureStorageOptions {
   /** SAS token (with or without leading `?`). */
   sasToken?: string;
 }
-//#endregion
 export { AzureStorageOptions };
 //# sourceMappingURL=types.d.mts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storyshelf/storage-azure",
-  "version": "0.6.2",
+  "version": "0.8.0",
   "description": "Azure Blob Storage adapter for StoryShelf.",
   "keywords": [
     "azure",
@@ -27,9 +27,6 @@
     "dist"
   ],
   "type": "module",
-  "engines": {
-    "node": ">=24"
-  },
   "sideEffects": false,
   "types": "./dist/index.d.mts",
   "exports": {
@@ -56,7 +53,7 @@
   },
   "dependencies": {
     "@azure/storage-blob": "^12.26.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": {