@krantho/media-s3 0.0.0-stage → 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Descoped
+
+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.ts

@@ -0,0 +1,2 @@
+export { createS3FileStore } from './s3-file-store.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA"}

package/dist/index.js

@@ -0,0 +1,2 @@
+export { createS3FileStore } from './s3-file-store.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA"}

package/dist/s3-file-store.d.ts

@@ -0,0 +1,4 @@
+import type { S3MediaSection } from '@krantho/config';
+import type { IFileStore } from '@krantho/persistence';
+export declare function createS3FileStore(section: S3MediaSection): IFileStore;
+//# sourceMappingURL=s3-file-store.d.ts.map

package/dist/s3-file-store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"s3-file-store.d.ts","sourceRoot":"","sources":["../src/s3-file-store.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AACrD,OAAO,KAAK,EAAE,UAAU,EAAc,MAAM,sBAAsB,CAAA;AA2FlE,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,cAAc,GAAG,UAAU,CAMrE"}

package/dist/s3-file-store.js

@@ -0,0 +1,81 @@
+import { CopyObjectCommand, DeleteObjectCommand, GetObjectCommand, NoSuchKey, PutObjectCommand, S3Client, } from '@aws-sdk/client-s3';
+/** Keys never change content, so objects are cached for a year */
+const CACHE_CONTROL = 'public, max-age=31536000, immutable';
+/** File store on an S3-compatible bucket whose objects are public at `publicUrl` */
+class S3FileStore {
+    client;
+    label = 'S3';
+    location;
+    publicUrl;
+    constructor(client, target) {
+        this.client = client;
+        this.location = target.bucket;
+        this.publicUrl = target.publicUrl.replace(/\/+$/, '');
+    }
+    async put(key, bytes, contentType) {
+        await this.client.send(new PutObjectCommand({
+            Bucket: this.location,
+            Key: key,
+            Body: bytes,
+            ContentType: contentType,
+            CacheControl: CACHE_CONTROL,
+        }));
+        return this.stored(key);
+    }
+    async get(key) {
+        try {
+            const result = await this.client.send(new GetObjectCommand({ Bucket: this.location, Key: key }));
+            if (result.Body === undefined)
+                return null;
+            return await result.Body.transformToByteArray();
+        }
+        catch (error) {
+            if (error instanceof NoSuchKey)
+                return null;
+            throw error;
+        }
+    }
+    async copy(fromKey, toKey, contentType) {
+        await this.client.send(new CopyObjectCommand({
+            Bucket: this.location,
+            Key: toKey,
+            CopySource: `${this.location}/${encodeURIComponent(fromKey)}`,
+            MetadataDirective: 'REPLACE',
+            ContentType: contentType,
+            CacheControl: CACHE_CONTROL,
+        }));
+        return this.stored(toKey);
+    }
+    async delete(key) {
+        await this.client.send(new DeleteObjectCommand({ Bucket: this.location, Key: key }));
+    }
+    stored(key) {
+        return { key, url: `${this.publicUrl}/${key}` };
+    }
+}
+function required(value, path) {
+    if (value === undefined)
+        throw new Error(`${path}: required when media.provider is "s3"`);
+    return value;
+}
+/** Client options from config; without a key pair the SDK uses its default credential chain */
+function clientConfig(section, region) {
+    const config = { region, forcePathStyle: section.forcePathStyle };
+    if (section.endpoint !== undefined)
+        config.endpoint = section.endpoint;
+    if (section.accessKeyId !== undefined && section.secretAccessKey !== undefined) {
+        config.credentials = {
+            accessKeyId: section.accessKeyId,
+            secretAccessKey: section.secretAccessKey,
+        };
+    }
+    return config;
+}
+export function createS3FileStore(section) {
+    const bucket = required(section.bucket, 'media.s3.bucket');
+    const region = required(section.region, 'media.s3.region');
+    const publicUrl = required(section.publicUrl, 'media.s3.publicUrl');
+    const client = new S3Client(clientConfig(section, region));
+    return new S3FileStore(client, { bucket, publicUrl });
+}
+//# sourceMappingURL=s3-file-store.js.map

package/dist/s3-file-store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"s3-file-store.js","sourceRoot":"","sources":["../src/s3-file-store.ts"],"names":[],"mappings":"AACA,OAAO,EACL,iBAAiB,EACjB,mBAAmB,EACnB,gBAAgB,EAChB,SAAS,EACT,gBAAgB,EAChB,QAAQ,GACT,MAAM,oBAAoB,CAAA;AAI3B,kEAAkE;AAClE,MAAM,aAAa,GAAG,qCAAqC,CAAA;AAO3D,oFAAoF;AACpF,MAAM,WAAW;IAMI;IALV,KAAK,GAAG,IAAI,CAAA;IACZ,QAAQ,CAAQ;IACR,SAAS,CAAQ;IAElC,YACmB,MAAgB,EACjC,MAAgB;QADC,WAAM,GAAN,MAAM,CAAU;QAGjC,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAA;QAC7B,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAA;IACvD,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAW,EAAE,KAAiB,EAAE,WAAmB;QAC3D,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACpB,IAAI,gBAAgB,CAAC;YACnB,MAAM,EAAE,IAAI,CAAC,QAAQ;YACrB,GAAG,EAAE,GAAG;YACR,IAAI,EAAE,KAAK;YACX,WAAW,EAAE,WAAW;YACxB,YAAY,EAAE,aAAa;SAC5B,CAAC,CACH,CAAA;QACD,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;IACzB,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAW;QACnB,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACnC,IAAI,gBAAgB,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,QAAQ,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAC1D,CAAA;YACD,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS;gBAAE,OAAO,IAAI,CAAA;YAC1C,OAAO,MAAM,MAAM,CAAC,IAAI,CAAC,oBAAoB,EAAE,CAAA;QACjD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,SAAS;gBAAE,OAAO,IAAI,CAAA;YAC3C,MAAM,KAAK,CAAA;QACb,CAAC;IACH,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,OAAe,EAAE,KAAa,EAAE,WAAmB;QAC5D,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACpB,IAAI,iBAAiB,CAAC;YACpB,MAAM,EAAE,IAAI,CAAC,QAAQ;YACrB,GAAG,EAAE,KAAK;YACV,UAAU,EAAE,GAAG,IAAI,CAAC,QAAQ,IAAI,kBAAkB,CAAC,OAAO,CAAC,EAAE;YAC7D,iBAAiB,EAAE,SAAS;YAC5B,WAAW,EAAE,WAAW;YACxB,YAAY,EAAE,aAAa;SAC5B,CAAC,CACH,CAAA;QACD,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IAC3B,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,GAAW;QACtB,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,mBAAmB,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,QAAQ,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;IACtF,CAAC;IAEO,MAAM,CAAC,GAAW;QACxB,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,SAAS,IAAI,GAAG,EAAE,EAAE,CAAA;IACjD,CAAC;CACF;AAED,SAAS,QAAQ,CAAC,KAAyB,EAAE,IAAY;IACvD,IAAI,KAAK,KAAK,SAAS;QAAE,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,wCAAwC,CAAC,CAAA;IACzF,OAAO,KAAK,CAAA;AACd,CAAC;AAED,+FAA+F;AAC/F,SAAS,YAAY,CAAC,OAAuB,EAAE,MAAc;IAC3D,MAAM,MAAM,GAAmB,EAAE,MAAM,EAAE,cAAc,EAAE,OAAO,CAAC,cAAc,EAAE,CAAA;IACjF,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS;QAAE,MAAM,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAA;IACtE,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS,IAAI,OAAO,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;QAC/E,MAAM,CAAC,WAAW,GAAG;YACnB,WAAW,EAAE,OAAO,CAAC,WAAW;YAChC,eAAe,EAAE,OAAO,CAAC,eAAe;SACzC,CAAA;IACH,CAAC;IACD,OAAO,MAAM,CAAA;AACf,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,OAAuB;IACvD,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAA;IAC1D,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAA;IAC1D,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,CAAC,SAAS,EAAE,oBAAoB,CAAC,CAAA;IACnE,MAAM,MAAM,GAAG,IAAI,QAAQ,CAAC,YAAY,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAA;IAC1D,OAAO,IAAI,WAAW,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAA;AACvD,CAAC"}

package/package.json

@@ -1,6 +1,39 @@
 {
   "name": "@krantho/media-s3",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "1.0.1",
+  "description": "The krantho media file store on S3-compatible object storage, such as AWS S3, Cloudflare R2 and MinIO.",
+  "license": "MIT",
+  "homepage": "https://krantho.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/descoped/krantho.git",
+    "directory": "packages/media-s3"
+  },
+  "bugs": {
+    "url": "https://github.com/descoped/krantho/issues"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@aws-sdk/client-s3": "^3.1168.0",
+    "@krantho/config": "1.0.1",
+    "@krantho/persistence": "1.0.1"
+  },
+  "devDependencies": {
+    "@types/node": "^25.9.9",
+    "typescript": "^6.0.3"
+  },
+  "scripts": {
+    "build": "tsc",
+    "typecheck": "tsc --noEmit",
+    "clean": "rm -rf dist"
+  }
 }

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.