@ysk-kit/storage 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 YSK Limited
+
+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,33 @@
+export type PresignPutInput = {
+    key: string;
+    mime: string;
+    byteSize: number;
+};
+export type PresignResult = {
+    url: string;
+    headers: Record<string, string>;
+};
+export interface IStoragePort {
+    presignPut(input: PresignPutInput): Promise<PresignResult>;
+    presignGet(key: string): Promise<PresignResult>;
+    putLocal?(key: string, body: Buffer, mime: string): Promise<void>;
+    getLocal?(key: string): Promise<{
+        body: Buffer;
+        mime: string;
+    } | null>;
+}
+import { createS3Storage } from './s3';
+export { createS3Storage };
+export type StorageEnv = {
+    API_PUBLIC_URL: string;
+    S3_ENDPOINT?: string | undefined;
+    S3_BUCKET?: string | undefined;
+    S3_ACCESS_KEY?: string | undefined;
+    S3_SECRET_KEY?: string | undefined;
+    S3_REGION?: string | undefined;
+};
+export declare const createStorageFromEnv: (env: StorageEnv) => IStoragePort;
+export declare const createLocalStorage: (opts: {
+    publicBaseUrl: string;
+}) => IStoragePort;
+//# 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,MAAM,MAAM,eAAe,GAAG;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC;AAC9E,MAAM,MAAM,aAAa,GAAG;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAAE,CAAC;AAE7E,MAAM,WAAW,YAAY;IAC3B,UAAU,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAC3D,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAChD,QAAQ,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAClE,QAAQ,CAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC,CAAC;CACxE;AAED,OAAO,EAAE,eAAe,EAAE,MAAM,MAAM,CAAC;AAEvC,OAAO,EAAE,eAAe,EAAE,CAAC;AAE3B,MAAM,MAAM,UAAU,GAAG;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAChC,CAAC;AAEF,eAAO,MAAM,oBAAoB,GAAI,KAAK,UAAU,KAAG,YAWtD,CAAC;AAEF,eAAO,MAAM,kBAAkB,GAAI,MAAM;IAAE,aAAa,EAAE,MAAM,CAAA;CAAE,KAAG,YAsBpE,CAAC"}

package/dist/index.js

@@ -0,0 +1,38 @@
+import { createS3Storage } from './s3';
+export { createS3Storage };
+export const createStorageFromEnv = (env) => {
+    if (env.S3_ENDPOINT && env.S3_BUCKET && env.S3_ACCESS_KEY && env.S3_SECRET_KEY) {
+        return createS3Storage({
+            endpoint: env.S3_ENDPOINT,
+            bucket: env.S3_BUCKET,
+            accessKey: env.S3_ACCESS_KEY,
+            secretKey: env.S3_SECRET_KEY,
+            region: env.S3_REGION && env.S3_REGION.length > 0 ? env.S3_REGION : 'auto',
+        });
+    }
+    return createLocalStorage({ publicBaseUrl: env.API_PUBLIC_URL });
+};
+export const createLocalStorage = (opts) => {
+    const blobs = new Map();
+    return {
+        async presignPut(input) {
+            return {
+                url: `${opts.publicBaseUrl}/v1/files/local/${encodeURIComponent(input.key)}`,
+                headers: { 'content-type': input.mime },
+            };
+        },
+        async presignGet(key) {
+            return {
+                url: `${opts.publicBaseUrl}/v1/files/local/${encodeURIComponent(key)}`,
+                headers: {},
+            };
+        },
+        async putLocal(key, body, mime) {
+            blobs.set(key, { body, mime });
+        },
+        async getLocal(key) {
+            return blobs.get(key) ?? null;
+        },
+    };
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,eAAe,EAAE,MAAM,MAAM,CAAC;AAEvC,OAAO,EAAE,eAAe,EAAE,CAAC;AAW3B,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,GAAe,EAAgB,EAAE;IACpE,IAAI,GAAG,CAAC,WAAW,IAAI,GAAG,CAAC,SAAS,IAAI,GAAG,CAAC,aAAa,IAAI,GAAG,CAAC,aAAa,EAAE,CAAC;QAC/E,OAAO,eAAe,CAAC;YACrB,QAAQ,EAAE,GAAG,CAAC,WAAW;YACzB,MAAM,EAAE,GAAG,CAAC,SAAS;YACrB,SAAS,EAAE,GAAG,CAAC,aAAa;YAC5B,SAAS,EAAE,GAAG,CAAC,aAAa;YAC5B,MAAM,EAAE,GAAG,CAAC,SAAS,IAAI,GAAG,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM;SAC3E,CAAC,CAAC;IACL,CAAC;IACD,OAAO,kBAAkB,CAAC,EAAE,aAAa,EAAE,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC;AACnE,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,IAA+B,EAAgB,EAAE;IAClF,MAAM,KAAK,GAAG,IAAI,GAAG,EAA0C,CAAC;IAChE,OAAO;QACL,KAAK,CAAC,UAAU,CAAC,KAAK;YACpB,OAAO;gBACL,GAAG,EAAE,GAAG,IAAI,CAAC,aAAa,mBAAmB,kBAAkB,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;gBAC5E,OAAO,EAAE,EAAE,cAAc,EAAE,KAAK,CAAC,IAAI,EAAE;aACxC,CAAC;QACJ,CAAC;QACD,KAAK,CAAC,UAAU,CAAC,GAAG;YAClB,OAAO;gBACL,GAAG,EAAE,GAAG,IAAI,CAAC,aAAa,mBAAmB,kBAAkB,CAAC,GAAG,CAAC,EAAE;gBACtE,OAAO,EAAE,EAAE;aACZ,CAAC;QACJ,CAAC;QACD,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI;YAC5B,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QACjC,CAAC;QACD,KAAK,CAAC,QAAQ,CAAC,GAAG;YAChB,OAAO,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC;QAChC,CAAC;KACF,CAAC;AACJ,CAAC,CAAC"}

package/dist/s3.d.ts

@@ -0,0 +1,9 @@
+import type { IStoragePort } from './index';
+export declare const createS3Storage: (opts: {
+    endpoint: string;
+    bucket: string;
+    accessKey: string;
+    secretKey: string;
+    region: string;
+}) => IStoragePort;
+//# sourceMappingURL=s3.d.ts.map

package/dist/s3.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"s3.d.ts","sourceRoot":"","sources":["../src/s3.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAE5C,eAAO,MAAM,eAAe,GAAI,MAAM;IACpC,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;CAChB,KAAG,YA8BH,CAAC"}

package/dist/s3.js

@@ -0,0 +1,26 @@
+import { GetObjectCommand, PutObjectCommand, S3Client } from '@aws-sdk/client-s3';
+import { getSignedUrl } from '@aws-sdk/s3-request-presigner';
+export const createS3Storage = (opts) => {
+    const client = new S3Client({
+        endpoint: opts.endpoint,
+        region: opts.region,
+        credentials: { accessKeyId: opts.accessKey, secretAccessKey: opts.secretKey },
+        forcePathStyle: true,
+    });
+    return {
+        async presignPut(input) {
+            const url = await getSignedUrl(client, new PutObjectCommand({
+                Bucket: opts.bucket,
+                Key: input.key,
+                ContentType: input.mime,
+                ContentLength: input.byteSize,
+            }), { expiresIn: 600 });
+            return { url, headers: { 'content-type': input.mime } };
+        },
+        async presignGet(key) {
+            const url = await getSignedUrl(client, new GetObjectCommand({ Bucket: opts.bucket, Key: key }), { expiresIn: 600 });
+            return { url, headers: {} };
+        },
+    };
+};
+//# sourceMappingURL=s3.js.map

package/dist/s3.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"s3.js","sourceRoot":"","sources":["../src/s3.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAClF,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAG7D,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,IAM/B,EAAgB,EAAE;IACjB,MAAM,MAAM,GAAG,IAAI,QAAQ,CAAC;QAC1B,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,MAAM,EAAE,IAAI,CAAC,MAAM;QACnB,WAAW,EAAE,EAAE,WAAW,EAAE,IAAI,CAAC,SAAS,EAAE,eAAe,EAAE,IAAI,CAAC,SAAS,EAAE;QAC7E,cAAc,EAAE,IAAI;KACrB,CAAC,CAAC;IACH,OAAO;QACL,KAAK,CAAC,UAAU,CAAC,KAAK;YACpB,MAAM,GAAG,GAAG,MAAM,YAAY,CAC5B,MAAM,EACN,IAAI,gBAAgB,CAAC;gBACnB,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,GAAG,EAAE,KAAK,CAAC,GAAG;gBACd,WAAW,EAAE,KAAK,CAAC,IAAI;gBACvB,aAAa,EAAE,KAAK,CAAC,QAAQ;aAC9B,CAAC,EACF,EAAE,SAAS,EAAE,GAAG,EAAE,CACnB,CAAC;YACF,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,cAAc,EAAE,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC;QAC1D,CAAC;QACD,KAAK,CAAC,UAAU,CAAC,GAAG;YAClB,MAAM,GAAG,GAAG,MAAM,YAAY,CAC5B,MAAM,EACN,IAAI,gBAAgB,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EACvD,EAAE,SAAS,EAAE,GAAG,EAAE,CACnB,CAAC;YACF,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;QAC9B,CAAC;KACF,CAAC;AACJ,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@ysk-kit/storage",
+  "version": "1.0.0",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "dependencies": {
+    "@aws-sdk/client-s3": "^3.1142.0",
+    "@aws-sdk/s3-request-presigner": "^3.1142.0"
+  },
+  "devDependencies": {
+    "@types/node": "^24.5.2",
+    "typescript": "^6.0.3",
+    "vitest": "^5.0.2"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org",
+    "access": "public"
+  },
+  "scripts": {
+    "typecheck": "tsc --noEmit -p tsconfig.json",
+    "test": "vitest run --passWithNoTests",
+    "build": "tsc -p tsconfig.build.json"
+  }
+}