@storyshelf/storage-s3 0.1.0 → 0.1.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Siddhant Gupta
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.mts

@@ -16,6 +16,7 @@ interface S3StorageOptions {
   /** Pre-configured S3 client. Defaults to a client built from the other options. */
   client?: S3Client;
 }
+/** Join an optional key prefix with a storage path. */
 declare function s3Key(prefix: string, path: string): string;
 /**
  * Create an S3-compatible StorageAdapter (AWS S3, R2, MinIO, etc.).

package/dist/index.mjs

@@ -3,6 +3,7 @@ import "node:url";
 import.meta.url;
 import { DeleteObjectCommand, GetObjectCommand, HeadObjectCommand, ListObjectsV2Command, PutObjectCommand, S3Client, S3ServiceException } from "@aws-sdk/client-s3";
 //#region src/index.ts
+/** Join an optional key prefix with a storage path. */
 function s3Key(prefix, path) {
 	return prefix === "" ? path : `${prefix}/${path}`;
 }
@@ -12,6 +13,32 @@ function s3Rel(prefix, key) {
 function isNotFound(error) {
 	return error instanceof S3ServiceException && error.$metadata.httpStatusCode === 404;
 }
+async function s3Read(ctx, path) {
+	const body = (await ctx.client.send(new GetObjectCommand({
+		Bucket: ctx.bucket,
+		Key: s3Key(ctx.prefix, path)
+	}))).Body;
+	if (body === void 0) return Buffer.alloc(0);
+	return Buffer.from(await body.transformToByteArray());
+}
+async function s3Exists(ctx, path) {
+	try {
+		await ctx.client.send(new HeadObjectCommand({
+			Bucket: ctx.bucket,
+			Key: s3Key(ctx.prefix, path)
+		}));
+		return true;
+	} catch (error) {
+		if (isNotFound(error)) return false;
+		throw error;
+	}
+}
+async function s3List(ctx, listPrefix) {
+	return ((await ctx.client.send(new ListObjectsV2Command({
+		Bucket: ctx.bucket,
+		Prefix: s3Key(ctx.prefix, listPrefix)
+	}))).Contents ?? []).map((item) => item.Key).filter((key) => key !== void 0).map((key) => s3Rel(ctx.prefix, key));
+}
 /**
 * Create an S3-compatible StorageAdapter (AWS S3, R2, MinIO, etc.).
 *
@@ -25,20 +52,20 @@ function createS3Storage(options) {
 		region,
 		forcePathStyle: true
 	});
+	const ctx = {
+		client,
+		bucket,
+		prefix
+	};
 	return {
 		metadata: {
 			name: "S3 Storage",
-			version: "0.1.0",
+			version: globalThis.__PKG_VERSION__ ?? "0.0.0",
 			description: "S3-compatible storage adapter",
 			kind: "s3"
 		},
 		async read(path) {
-			const body = (await client.send(new GetObjectCommand({
-				Bucket: bucket,
-				Key: s3Key(prefix, path)
-			}))).Body;
-			if (body === void 0) return Buffer.alloc(0);
-			return Buffer.from(await body.transformToByteArray());
+			return await s3Read(ctx, path);
 		},
 		async write(path, data) {
 			await client.send(new PutObjectCommand({
@@ -54,22 +81,10 @@ function createS3Storage(options) {
 			}));
 		},
 		async exists(path) {
-			try {
-				await client.send(new HeadObjectCommand({
-					Bucket: bucket,
-					Key: s3Key(prefix, path)
-				}));
-				return true;
-			} catch (error) {
-				if (isNotFound(error)) return false;
-				throw error;
-			}
+			return await s3Exists(ctx, path);
 		},
 		async list(listPrefix) {
-			return ((await client.send(new ListObjectsV2Command({
-				Bucket: bucket,
-				Prefix: s3Key(prefix, listPrefix)
-			}))).Contents ?? []).map((item) => item.Key).filter((key) => key !== void 0).map((key) => s3Rel(prefix, key));
+			return await s3List(ctx, listPrefix);
 		}
 	};
 }

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["import {\n  DeleteObjectCommand,\n  GetObjectCommand,\n  HeadObjectCommand,\n  ListObjectsV2Command,\n  PutObjectCommand,\n  S3Client,\n  S3ServiceException,\n} from \"@aws-sdk/client-s3\";\n\nimport type { StorageAdapter } from \"@storyshelf/core/adapter/storage\";\n\ndeclare const __PKG_VERSION__: string;\n\n/** Options for configuring an S3-compatible storage adapter. */\nexport interface S3StorageOptions {\n  /** S3 bucket name. */\n  bucket: string;\n  /** Optional key prefix applied to all stored objects. */\n  prefix?: string;\n  /** Custom endpoint for S3-compatible services (e.g. MinIO, R2). */\n  endpoint?: string;\n  /** AWS region. Defaults to `us-east-1`. */\n  region?: string;\n  /** Pre-configured S3 client. Defaults to a client built from the other options. */\n  client?: S3Client;\n}\n\nexport function s3Key(prefix: string, path: string): string {\n  return prefix === \"\" ? path : `${prefix}/${path}`;\n}\n\nfunction s3Rel(prefix: string, key: string): string {\n  return prefix === \"\" ? key : key.slice(prefix.length + 1);\n}\n\nfunction isNotFound(error: unknown): boolean {\n  return error instanceof S3ServiceException && error.$metadata.httpStatusCode === 404;\n}\n\n/**\n * Create an S3-compatible StorageAdapter (AWS S3, R2, MinIO, etc.).\n *\n * @param options - S3 configuration options.\n * @returns A StorageAdapter backed by the configured S3 bucket.\n */\nexport function createS3Storage(options: S3StorageOptions): StorageAdapter {\n  const { bucket, prefix = \"\", endpoint, region = \"us-east-1\", client: injectedClient } = options;\n  const client = injectedClient ?? new S3Client({ endpoint, region, forcePathStyle: true });\n\n  return {\n    metadata: {\n      name: \"S3 Storage\",\n      version: typeof __PKG_VERSION__ === \"undefined\" ? \"0.0.0\" : __PKG_VERSION__, // oxlint-disable-line unicorn/no-typeof-undefined\n      description: \"S3-compatible storage adapter\",\n      kind: \"s3\",\n    },\n    async read(path) {\n      const response = await client.send(\n        new GetObjectCommand({ Bucket: bucket, Key: s3Key(prefix, path) }),\n      );\n      const body = response.Body;\n      if (body === undefined) {\n        return Buffer.alloc(0);\n      }\n      return Buffer.from(await body.transformToByteArray());\n    },\n    async write(path, data) {\n      await client.send(\n        new PutObjectCommand({ Bucket: bucket, Key: s3Key(prefix, path), Body: data }),\n      );\n    },\n    async delete(path) {\n      await client.send(\n        new DeleteObjectCommand({ Bucket: bucket, Key: s3Key(prefix, path) }),\n      );\n    },\n    async exists(path) {\n      try {\n        await client.send(new HeadObjectCommand({ Bucket: bucket, Key: s3Key(prefix, path) }));\n        return true;\n      } catch (error) {\n        if (isNotFound(error)) {\n          return false;\n        }\n        throw error;\n      }\n    },\n    async list(listPrefix) {\n      const response = await client.send(\n        new ListObjectsV2Command({ Bucket: bucket, Prefix: s3Key(prefix, listPrefix) }),\n      );\n      return (response.Contents ?? [])\n        .map((item) => item.Key)\n        .filter((key): key is string => key !== undefined)\n        .map((key) => s3Rel(prefix, key));\n    },\n  };\n}\n"],"mappings":";;;;;AA4BA,SAAgB,MAAM,QAAgB,MAAsB;CAC1D,OAAO,WAAW,KAAK,OAAO,GAAG,OAAO,GAAG;AAC7C;AAEA,SAAS,MAAM,QAAgB,KAAqB;CAClD,OAAO,WAAW,KAAK,MAAM,IAAI,MAAM,OAAO,SAAS,CAAC;AAC1D;AAEA,SAAS,WAAW,OAAyB;CAC3C,OAAO,iBAAiB,sBAAsB,MAAM,UAAU,mBAAmB;AACnF;;;;;;;AAQA,SAAgB,gBAAgB,SAA2C;CACzE,MAAM,EAAE,QAAQ,SAAS,IAAI,UAAU,SAAS,aAAa,QAAQ,mBAAmB;CACxF,MAAM,SAAS,kBAAkB,IAAI,SAAS;EAAE;EAAU;EAAQ,gBAAgB;CAAK,CAAC;CAExF,OAAO;EACL,UAAU;GACR,MAAM;GACN,SAAA;GACA,aAAa;GACb,MAAM;EACR;EACA,MAAM,KAAK,MAAM;GAIf,MAAM,QAAO,MAHU,OAAO,KAC5B,IAAI,iBAAiB;IAAE,QAAQ;IAAQ,KAAK,MAAM,QAAQ,IAAI;GAAE,CAAC,CACnE,EAAA,CACsB;GACtB,IAAI,SAAS,KAAA,GACX,OAAO,OAAO,MAAM,CAAC;GAEvB,OAAO,OAAO,KAAK,MAAM,KAAK,qBAAqB,CAAC;EACtD;EACA,MAAM,MAAM,MAAM,MAAM;GACtB,MAAM,OAAO,KACX,IAAI,iBAAiB;IAAE,QAAQ;IAAQ,KAAK,MAAM,QAAQ,IAAI;IAAG,MAAM;GAAK,CAAC,CAC/E;EACF;EACA,MAAM,OAAO,MAAM;GACjB,MAAM,OAAO,KACX,IAAI,oBAAoB;IAAE,QAAQ;IAAQ,KAAK,MAAM,QAAQ,IAAI;GAAE,CAAC,CACtE;EACF;EACA,MAAM,OAAO,MAAM;GACjB,IAAI;IACF,MAAM,OAAO,KAAK,IAAI,kBAAkB;KAAE,QAAQ;KAAQ,KAAK,MAAM,QAAQ,IAAI;IAAE,CAAC,CAAC;IACrF,OAAO;GACT,SAAS,OAAO;IACd,IAAI,WAAW,KAAK,GAClB,OAAO;IAET,MAAM;GACR;EACF;EACA,MAAM,KAAK,YAAY;GAIrB,SAAQ,MAHe,OAAO,KAC5B,IAAI,qBAAqB;IAAE,QAAQ;IAAQ,QAAQ,MAAM,QAAQ,UAAU;GAAE,CAAC,CAChF,EAAA,CACiB,YAAY,CAAC,EAAA,CAC3B,KAAK,SAAS,KAAK,GAAG,CAAC,CACvB,QAAQ,QAAuB,QAAQ,KAAA,CAAS,CAAC,CACjD,KAAK,QAAQ,MAAM,QAAQ,GAAG,CAAC;EACpC;CACF;AACF"}
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["import {\n  DeleteObjectCommand,\n  GetObjectCommand,\n  HeadObjectCommand,\n  ListObjectsV2Command,\n  PutObjectCommand,\n  S3Client,\n  S3ServiceException,\n} from \"@aws-sdk/client-s3\";\n\nimport type { StorageAdapter } from \"@storyshelf/core/adapter/storage\";\n\ndeclare const __PKG_VERSION__: string | undefined;\n\n/** Options for configuring an S3-compatible storage adapter. */\nexport interface S3StorageOptions {\n  /** S3 bucket name. */\n  bucket: string;\n  /** Optional key prefix applied to all stored objects. */\n  prefix?: string;\n  /** Custom endpoint for S3-compatible services (e.g. MinIO, R2). */\n  endpoint?: string;\n  /** AWS region. Defaults to `us-east-1`. */\n  region?: string;\n  /** Pre-configured S3 client. Defaults to a client built from the other options. */\n  client?: S3Client;\n}\n\n/** Join an optional key prefix with a storage path. */\nexport function s3Key(prefix: string, path: string): string {\n  return prefix === \"\" ? path : `${prefix}/${path}`;\n}\n\nfunction s3Rel(prefix: string, key: string): string {\n  return prefix === \"\" ? key : key.slice(prefix.length + 1);\n}\n\nfunction isNotFound(error: unknown): boolean {\n  return error instanceof S3ServiceException && error.$metadata.httpStatusCode === 404;\n}\n\ninterface S3Context {\n  client: S3Client;\n  bucket: string;\n  prefix: string;\n}\n\nasync function s3Read(ctx: S3Context, path: string): Promise<Buffer> {\n  const response = await ctx.client.send(\n    new GetObjectCommand({ Bucket: ctx.bucket, Key: s3Key(ctx.prefix, path) }),\n  );\n  const body = response.Body;\n  if (body === undefined) {\n    return Buffer.alloc(0);\n  }\n  return Buffer.from(await body.transformToByteArray());\n}\n\nasync function s3Exists(ctx: S3Context, path: string): Promise<boolean> {\n  try {\n    await ctx.client.send(new HeadObjectCommand({ Bucket: ctx.bucket, Key: s3Key(ctx.prefix, path) }));\n    return true;\n  } catch (error) {\n    if (isNotFound(error)) {\n      return false;\n    }\n    throw error;\n  }\n}\n\nasync function s3List(ctx: S3Context, listPrefix: string): Promise<string[]> {\n  const response = await ctx.client.send(\n    new ListObjectsV2Command({ Bucket: ctx.bucket, Prefix: s3Key(ctx.prefix, listPrefix) }),\n  );\n  return (response.Contents ?? [])\n    .map((item) => item.Key)\n    .filter((key): key is string => key !== undefined)\n    .map((key) => s3Rel(ctx.prefix, key));\n}\n\n/**\n * Create an S3-compatible StorageAdapter (AWS S3, R2, MinIO, etc.).\n *\n * @param options - S3 configuration options.\n * @returns A StorageAdapter backed by the configured S3 bucket.\n */\nexport function createS3Storage(options: S3StorageOptions): StorageAdapter {\n  const { bucket, prefix = \"\", endpoint, region = \"us-east-1\", client: injectedClient } = options;\n  const client = injectedClient ?? new S3Client({ endpoint, region, forcePathStyle: true });\n  const ctx: S3Context = { client, bucket, prefix };\n\n  return {\n    metadata: {\n      name: \"S3 Storage\",\n      version: (globalThis as unknown as { __PKG_VERSION__?: string }).__PKG_VERSION__ ?? \"0.0.0\",\n      description: \"S3-compatible storage adapter\",\n      kind: \"s3\",\n    },\n    async read(path) {\n      return await s3Read(ctx, path);\n    },\n    async write(path, data) {\n      await client.send(\n        new PutObjectCommand({ Bucket: bucket, Key: s3Key(prefix, path), Body: data }),\n      );\n    },\n    async delete(path) {\n      await client.send(\n        new DeleteObjectCommand({ Bucket: bucket, Key: s3Key(prefix, path) }),\n      );\n    },\n    async exists(path) {\n      return await s3Exists(ctx, path);\n    },\n    async list(listPrefix) {\n      return await s3List(ctx, listPrefix);\n    },\n  };\n}\n"],"mappings":";;;;;;AA6BA,SAAgB,MAAM,QAAgB,MAAsB;CAC1D,OAAO,WAAW,KAAK,OAAO,GAAG,OAAO,GAAG;AAC7C;AAEA,SAAS,MAAM,QAAgB,KAAqB;CAClD,OAAO,WAAW,KAAK,MAAM,IAAI,MAAM,OAAO,SAAS,CAAC;AAC1D;AAEA,SAAS,WAAW,OAAyB;CAC3C,OAAO,iBAAiB,sBAAsB,MAAM,UAAU,mBAAmB;AACnF;AAQA,eAAe,OAAO,KAAgB,MAA+B;CAInE,MAAM,QAAO,MAHU,IAAI,OAAO,KAChC,IAAI,iBAAiB;EAAE,QAAQ,IAAI;EAAQ,KAAK,MAAM,IAAI,QAAQ,IAAI;CAAE,CAAC,CAC3E,EAAA,CACsB;CACtB,IAAI,SAAS,KAAA,GACX,OAAO,OAAO,MAAM,CAAC;CAEvB,OAAO,OAAO,KAAK,MAAM,KAAK,qBAAqB,CAAC;AACtD;AAEA,eAAe,SAAS,KAAgB,MAAgC;CACtE,IAAI;EACF,MAAM,IAAI,OAAO,KAAK,IAAI,kBAAkB;GAAE,QAAQ,IAAI;GAAQ,KAAK,MAAM,IAAI,QAAQ,IAAI;EAAE,CAAC,CAAC;EACjG,OAAO;CACT,SAAS,OAAO;EACd,IAAI,WAAW,KAAK,GAClB,OAAO;EAET,MAAM;CACR;AACF;AAEA,eAAe,OAAO,KAAgB,YAAuC;CAI3E,SAAQ,MAHe,IAAI,OAAO,KAChC,IAAI,qBAAqB;EAAE,QAAQ,IAAI;EAAQ,QAAQ,MAAM,IAAI,QAAQ,UAAU;CAAE,CAAC,CACxF,EAAA,CACiB,YAAY,CAAC,EAAA,CAC3B,KAAK,SAAS,KAAK,GAAG,CAAC,CACvB,QAAQ,QAAuB,QAAQ,KAAA,CAAS,CAAC,CACjD,KAAK,QAAQ,MAAM,IAAI,QAAQ,GAAG,CAAC;AACxC;;;;;;;AAQA,SAAgB,gBAAgB,SAA2C;CACzE,MAAM,EAAE,QAAQ,SAAS,IAAI,UAAU,SAAS,aAAa,QAAQ,mBAAmB;CACxF,MAAM,SAAS,kBAAkB,IAAI,SAAS;EAAE;EAAU;EAAQ,gBAAgB;CAAK,CAAC;CACxF,MAAM,MAAiB;EAAE;EAAQ;EAAQ;CAAO;CAEhD,OAAO;EACL,UAAU;GACR,MAAM;GACN,SAAU,WAAuD,mBAAmB;GACpF,aAAa;GACb,MAAM;EACR;EACA,MAAM,KAAK,MAAM;GACf,OAAO,MAAM,OAAO,KAAK,IAAI;EAC/B;EACA,MAAM,MAAM,MAAM,MAAM;GACtB,MAAM,OAAO,KACX,IAAI,iBAAiB;IAAE,QAAQ;IAAQ,KAAK,MAAM,QAAQ,IAAI;IAAG,MAAM;GAAK,CAAC,CAC/E;EACF;EACA,MAAM,OAAO,MAAM;GACjB,MAAM,OAAO,KACX,IAAI,oBAAoB;IAAE,QAAQ;IAAQ,KAAK,MAAM,QAAQ,IAAI;GAAE,CAAC,CACtE;EACF;EACA,MAAM,OAAO,MAAM;GACjB,OAAO,MAAM,SAAS,KAAK,IAAI;EACjC;EACA,MAAM,KAAK,YAAY;GACrB,OAAO,MAAM,OAAO,KAAK,UAAU;EACrC;CACF;AACF"}

package/package.json

@@ -1,44 +1,52 @@
 {
   "name": "@storyshelf/storage-s3",
-  "version": "0.1.0",
-  "type": "module",
+  "version": "0.1.2",
   "description": "S3-compatible storage adapter for StoryShelf (AWS SDK v3).",
+  "homepage": "https://github.com/GuptaSiddhant/StoryShelf#readme",
+  "bugs": {
+    "url": "https://github.com/GuptaSiddhant/StoryShelf/issues"
+  },
+  "license": "MIT",
   "author": {
     "name": "Siddhant Gupta",
     "url": "https://guptasiddhant.com"
   },
-  "license": "MIT",
-  "sideEffects": false,
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/GuptaSiddhant/storyshelf.git",
+    "url": "git+https://github.com/GuptaSiddhant/StoryShelf.git",
     "directory": "packages/storage-s3"
   },
-  "homepage": "https://github.com/GuptaSiddhant/storyshelf#readme",
-  "bugs": {
-    "url": "https://github.com/GuptaSiddhant/storyshelf/issues"
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "types": "./dist/index.d.mts",
+  "exports": {
+    ".": {
+      "source": "./src/index.ts",
+      "default": "./dist/index.mjs"
+    },
+    "./package.json": "./package.json"
   },
   "publishConfig": {
-    "access": "public",
     "exports": {
       ".": "./dist/index.mjs",
       "./package.json": "./package.json"
-    }
+    },
+    "access": "public"
   },
-  "files": [
-    "dist"
-  ],
   "scripts": {
     "build": "tsdown",
     "dev": "tsdown -w",
-    "fmt": "oxfmt -c ../../.oxfmtrc.json ./src",
+    "fmt": "oxfmt ./src",
     "lint": "oxlint --type-aware --type-check ./src",
     "test": "vitest run",
     "prepublishOnly": "nub run build"
   },
   "dependencies": {
     "@aws-sdk/client-s3": "^3.700.0",
-    "@storyshelf/core": "workspace:*"
+    "@storyshelf/core": "^0.1.2"
   },
   "devDependencies": {
     "@types/node": "catalog:",
@@ -50,12 +58,13 @@
     "typescript": "catalog:",
     "vitest": "catalog:"
   },
-  "types": "./dist/index.d.mts",
-  "exports": {
-    ".": {
-      "source": "./src/index.ts",
-      "default": "./dist/index.mjs"
-    },
-    "./package.json": "./package.json"
+  "jsr": {
+    "runtimeCompat": {
+      "node": true,
+      "deno": true,
+      "browser": false,
+      "workerd": false,
+      "bun": true
+    }
   }
 }