@zola_do/minio 0.2.17 → 0.2.18

package/README.md

@@ -429,3 +429,16 @@ ISC
 - [Contributing](../../CONTRIBUTING.md)
 - [Code of Conduct](../../CODE_OF_CONDUCT.md)
 - [Security Policy](../../SECURITY.md)
+
+
+## Configuration Validation
+
+Validate MinIO settings before bootstrap when object storage is required:
+
+```typescript
+import { validateMinioEnv } from '@zola_do/minio';
+
+validateMinioEnv();
+```
+
+Required variables: `MINIO_ENDPOINT`, `MINIO_ACCESSKEY`, `MINIO_SECRETKEY`. `MINIO_PORT` is validated when provided.

package/dist/index.d.ts

@@ -4,3 +4,5 @@ export * from './bucket-name.enum';
 export * from './min-io.module';
 export * from './min-io.service';
 export * from './min-io.zola-object-storage';
+export * from './validate-minio-env.helper';
+export * from './minio-error-response.type';

package/dist/index.js

@@ -20,4 +20,6 @@ __exportStar(require("./bucket-name.enum"), exports);
 __exportStar(require("./min-io.module"), exports);
 __exportStar(require("./min-io.service"), exports);
 __exportStar(require("./min-io.zola-object-storage"), exports);
+__exportStar(require("./validate-minio-env.helper"), exports);
+__exportStar(require("./minio-error-response.type"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wDAAsC;AACtC,8DAA4C;AAC5C,qDAAmC;AACnC,kDAAgC;AAChC,mDAAiC;AACjC,+DAA6C"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wDAAsC;AACtC,8DAA4C;AAC5C,qDAAmC;AACnC,kDAAgC;AAChC,mDAAiC;AACjC,+DAA6C;AAC7C,8DAA4C;AAC5C,8DAA4C"}

package/dist/min-io.module.d.ts

@@ -1,2 +1,16 @@
+import { DynamicModule, ModuleMetadata } from '@nestjs/common';
+export interface MinIOModuleOptions {
+    endPoint?: string;
+    port?: number;
+    useSSL?: boolean;
+    accessKey?: string;
+    secretKey?: string;
+}
+export interface MinIOModuleAsyncOptions extends Pick<ModuleMetadata, 'imports'> {
+    inject?: any[];
+    useFactory: (...args: any[]) => MinIOModuleOptions | Promise<MinIOModuleOptions>;
+}
 export declare class MinIOModule {
+    static forRoot(options?: MinIOModuleOptions): DynamicModule;
+    static forRootAsync(options: MinIOModuleAsyncOptions): DynamicModule;
 }

package/dist/min-io.module.js

@@ -5,6 +5,7 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
+var MinIOModule_1;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MinIOModule = void 0;
 const common_1 = require("@nestjs/common");
@@ -12,28 +13,66 @@ const Minio = require("minio");
 const min_io_service_1 = require("./min-io.service");
 const min_io_zola_object_storage_1 = require("./min-io.zola-object-storage");
 const min_io_tokens_1 = require("./min-io.tokens");
-let MinIOModule = class MinIOModule {
+function parseBoolean(value, defaultValue) {
+    if (value === undefined || value === '') {
+        return defaultValue;
+    }
+    return ['true', '1', 'yes', 'on'].includes(value.toLowerCase());
+}
+function createClientOptions(options = {}) {
+    var _a, _b, _c, _d, _e, _f;
+    return {
+        endPoint: (_a = options.endPoint) !== null && _a !== void 0 ? _a : process.env.MINIO_ENDPOINT,
+        port: (_b = options.port) !== null && _b !== void 0 ? _b : Number((_c = process.env.MINIO_PORT) !== null && _c !== void 0 ? _c : 443),
+        useSSL: (_d = options.useSSL) !== null && _d !== void 0 ? _d : parseBoolean(process.env.MINIO_USESSL, true),
+        accessKey: (_e = options.accessKey) !== null && _e !== void 0 ? _e : process.env.MINIO_ACCESSKEY,
+        secretKey: (_f = options.secretKey) !== null && _f !== void 0 ? _f : process.env.MINIO_SECRETKEY,
+    };
+}
+function createClientProvider(options = {}) {
+    return {
+        provide: min_io_tokens_1.MINIO_CLIENT,
+        useFactory: () => new Minio.Client(createClientOptions(options)),
+    };
+}
+function createAsyncClientProvider(options) {
+    var _a;
+    return {
+        provide: min_io_tokens_1.MINIO_CLIENT,
+        useFactory: async (...args) => new Minio.Client(createClientOptions(await options.useFactory(...args))),
+        inject: (_a = options.inject) !== null && _a !== void 0 ? _a : [],
+    };
+}
+let MinIOModule = MinIOModule_1 = class MinIOModule {
+    static forRoot(options = {}) {
+        return {
+            module: MinIOModule_1,
+            providers: [
+                createClientProvider(options),
+                min_io_service_1.MinIOService,
+                min_io_zola_object_storage_1.MinioZolaObjectStorage,
+            ],
+            exports: [min_io_service_1.MinIOService, min_io_zola_object_storage_1.MinioZolaObjectStorage],
+        };
+    }
+    static forRootAsync(options) {
+        var _a;
+        return {
+            module: MinIOModule_1,
+            imports: (_a = options.imports) !== null && _a !== void 0 ? _a : [],
+            providers: [
+                createAsyncClientProvider(options),
+                min_io_service_1.MinIOService,
+                min_io_zola_object_storage_1.MinioZolaObjectStorage,
+            ],
+            exports: [min_io_service_1.MinIOService, min_io_zola_object_storage_1.MinioZolaObjectStorage],
+        };
+    }
 };
 exports.MinIOModule = MinIOModule;
-exports.MinIOModule = MinIOModule = __decorate([
+exports.MinIOModule = MinIOModule = MinIOModule_1 = __decorate([
     (0, common_1.Module)({
-        providers: [
-            {
-                provide: min_io_tokens_1.MINIO_CLIENT,
-                useFactory: () => {
-                    var _a, _b;
-                    return new Minio.Client({
-                        endPoint: process.env.MINIO_ENDPOINT,
-                        port: Number((_a = process.env.MINIO_PORT) !== null && _a !== void 0 ? _a : 443),
-                        useSSL: Boolean((_b = process.env.MINIO_USESSL) !== null && _b !== void 0 ? _b : true),
-                        accessKey: process.env.MINIO_ACCESSKEY,
-                        secretKey: process.env.MINIO_SECRETKEY,
-                    });
-                },
-            },
-            min_io_service_1.MinIOService,
-            min_io_zola_object_storage_1.MinioZolaObjectStorage,
-        ],
+        providers: [createClientProvider(), min_io_service_1.MinIOService, min_io_zola_object_storage_1.MinioZolaObjectStorage],
         controllers: [],
         exports: [min_io_service_1.MinIOService, min_io_zola_object_storage_1.MinioZolaObjectStorage],
     })

package/dist/min-io.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"min-io.module.js","sourceRoot":"","sources":["../src/min-io.module.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2CAAwC;AACxC,+BAA+B;AAC/B,qDAAgD;AAChD,6EAAsE;AACtE,mDAA+C;AAqBxC,IAAM,WAAW,GAAjB,MAAM,WAAW;CAAG,CAAA;AAAd,kCAAW;sBAAX,WAAW;IAnBvB,IAAA,eAAM,EAAC;QACN,SAAS,EAAE;YACT;gBACE,OAAO,EAAE,4BAAY;gBACrB,UAAU,EAAE,GAAG,EAAE;;oBACf,OAAA,IAAI,KAAK,CAAC,MAAM,CAAC;wBACf,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,cAAc;wBACpC,IAAI,EAAE,MAAM,CAAC,MAAA,OAAO,CAAC,GAAG,CAAC,UAAU,mCAAI,GAAG,CAAC;wBAC3C,MAAM,EAAE,OAAO,CAAC,MAAA,OAAO,CAAC,GAAG,CAAC,YAAY,mCAAI,IAAI,CAAC;wBACjD,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,eAAe;wBACtC,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,eAAe;qBACvC,CAAC,CAAA;iBAAA;aACL;YACD,6BAAY;YACZ,mDAAsB;SACvB;QACD,WAAW,EAAE,EAAE;QACf,OAAO,EAAE,CAAC,6BAAY,EAAE,mDAAsB,CAAC;KAChD,CAAC;GACW,WAAW,CAAG"}
+{"version":3,"file":"min-io.module.js","sourceRoot":"","sources":["../src/min-io.module.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,2CAKwB;AACxB,+BAA+B;AAC/B,qDAAgD;AAChD,6EAAsE;AACtE,mDAA+C;AAoB/C,SAAS,YAAY,CACnB,KAAyB,EACzB,YAAqB;IAErB,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;QACxC,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,OAAO,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;AAClE,CAAC;AAED,SAAS,mBAAmB,CAC1B,UAA8B,EAAE;;IAEhC,OAAO;QACL,QAAQ,EAAE,MAAA,OAAO,CAAC,QAAQ,mCAAI,OAAO,CAAC,GAAG,CAAC,cAAc;QACxD,IAAI,EAAE,MAAA,OAAO,CAAC,IAAI,mCAAI,MAAM,CAAC,MAAA,OAAO,CAAC,GAAG,CAAC,UAAU,mCAAI,GAAG,CAAC;QAC3D,MAAM,EAAE,MAAA,OAAO,CAAC,MAAM,mCAAI,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,IAAI,CAAC;QACtE,SAAS,EAAE,MAAA,OAAO,CAAC,SAAS,mCAAI,OAAO,CAAC,GAAG,CAAC,eAAe;QAC3D,SAAS,EAAE,MAAA,OAAO,CAAC,SAAS,mCAAI,OAAO,CAAC,GAAG,CAAC,eAAe;KAC5D,CAAC;AACJ,CAAC;AAED,SAAS,oBAAoB,CAAC,UAA8B,EAAE;IAC5D,OAAO;QACL,OAAO,EAAE,4BAAY;QACrB,UAAU,EAAE,GAAG,EAAE,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;KACjE,CAAC;AACJ,CAAC;AAED,SAAS,yBAAyB,CAAC,OAAgC;;IACjE,OAAO;QACL,OAAO,EAAE,4BAAY;QACrB,UAAU,EAAE,KAAK,EAAE,GAAG,IAAW,EAAE,EAAE,CACnC,IAAI,KAAK,CAAC,MAAM,CAAC,mBAAmB,CAAC,MAAM,OAAO,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;QAC1E,MAAM,EAAE,MAAA,OAAO,CAAC,MAAM,mCAAI,EAAE;KAC7B,CAAC;AACJ,CAAC;AAOM,IAAM,WAAW,mBAAjB,MAAM,WAAW;IACtB,MAAM,CAAC,OAAO,CAAC,UAA8B,EAAE;QAC7C,OAAO;YACL,MAAM,EAAE,aAAW;YACnB,SAAS,EAAE;gBACT,oBAAoB,CAAC,OAAO,CAAC;gBAC7B,6BAAY;gBACZ,mDAAsB;aACvB;YACD,OAAO,EAAE,CAAC,6BAAY,EAAE,mDAAsB,CAAC;SAChD,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,YAAY,CAAC,OAAgC;;QAClD,OAAO;YACL,MAAM,EAAE,aAAW;YACnB,OAAO,EAAE,MAAA,OAAO,CAAC,OAAO,mCAAI,EAAE;YAC9B,SAAS,EAAE;gBACT,yBAAyB,CAAC,OAAO,CAAC;gBAClC,6BAAY;gBACZ,mDAAsB;aACvB;YACD,OAAO,EAAE,CAAC,6BAAY,EAAE,mDAAsB,CAAC;SAChD,CAAC;IACJ,CAAC;CACF,CAAA;AAzBY,kCAAW;sBAAX,WAAW;IALvB,IAAA,eAAM,EAAC;QACN,SAAS,EAAE,CAAC,oBAAoB,EAAE,EAAE,6BAAY,EAAE,mDAAsB,CAAC;QACzE,WAAW,EAAE,EAAE;QACf,OAAO,EAAE,CAAC,6BAAY,EAAE,mDAAsB,CAAC;KAChD,CAAC;GACW,WAAW,CAyBvB"}

package/dist/minio-error-response.type.d.ts

@@ -0,0 +1,9 @@
+export type MinioErrorResponse = {
+    statusCode: number;
+    message: string | string[];
+    timestamp?: string;
+    path?: string;
+    error?: string;
+    bucketName?: string;
+    filepath?: string;
+};

package/dist/minio-error-response.type.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=minio-error-response.type.js.map

package/dist/minio-error-response.type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"minio-error-response.type.js","sourceRoot":"","sources":["../src/minio-error-response.type.ts"],"names":[],"mappings":""}

package/dist/validate-minio-env.helper.d.ts

@@ -0,0 +1,4 @@
+export type ValidateMinioEnvOptions = {
+    required?: boolean;
+};
+export declare function validateMinioEnv(options?: ValidateMinioEnvOptions): void;

package/dist/validate-minio-env.helper.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateMinioEnv = validateMinioEnv;
+function validateMinioEnv(options = {}) {
+    const { required = true } = options;
+    if (!required) {
+        return;
+    }
+    for (const key of ['MINIO_ENDPOINT', 'MINIO_ACCESSKEY', 'MINIO_SECRETKEY']) {
+        if (!process.env[key]) {
+            throw new Error(`${key} is required`);
+        }
+    }
+    if (process.env.MINIO_PORT) {
+        const port = Number(process.env.MINIO_PORT);
+        if (!Number.isInteger(port) || port <= 0) {
+            throw new Error('MINIO_PORT must be a positive integer');
+        }
+    }
+}
+//# sourceMappingURL=validate-minio-env.helper.js.map

package/dist/validate-minio-env.helper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-minio-env.helper.js","sourceRoot":"","sources":["../src/validate-minio-env.helper.ts"],"names":[],"mappings":";;AAIA,4CAkBC;AAlBD,SAAgB,gBAAgB,CAAC,UAAmC,EAAE;IACpE,MAAM,EAAE,QAAQ,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC;IACpC,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO;IACT,CAAC;IAED,KAAK,MAAM,GAAG,IAAI,CAAC,gBAAgB,EAAE,iBAAiB,EAAE,iBAAiB,CAAC,EAAE,CAAC;QAC3E,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,cAAc,CAAC,CAAC;QACxC,CAAC;IACH,CAAC;IAED,IAAI,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC;QAC3B,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE,CAAC;YACzC,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;QAC3D,CAAC;IACH,CAAC;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zola_do/minio",
-  "version": "0.2.17",
+  "version": "0.2.18",
   "description": "MinIO object storage for NestJS",
   "author": "zolaDO",
   "license": "ISC",