@xnestjs/storage 1.12.2 → 1.13.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xnestjs/storage",
-  "version": "1.12.2",
+  "version": "1.13.0",
   "description": "NestJS extension library for Storage solutions (S3,GS)",
   "author": "Panates",
   "license": "MIT",
@@ -17,41 +17,28 @@
     "minio": "^8.0.6"
   },
   "type": "module",
+  "module": "./index.js",
+  "types": "./index.d.ts",
   "exports": {
     ".": {
-      "import": {
-        "types": "./types/index.d.ts",
-        "default": "./esm/index.js"
-      },
-      "require": {
-        "types": "./types/index.d.cts",
-        "default": "./cjs/index.js"
-      },
-      "default": "./esm/index.js"
+      "types": "./index.d.ts",
+      "default": "./index.js"
     },
     "./package.json": "./package.json"
   },
-  "main": "./cjs/index.js",
-  "module": "./esm/index.js",
-  "types": "./types/index.d.ts",
+  "engines": {
+    "node": ">=20.0"
+  },
   "repository": {
     "registry": "https://github.com/panates/xnestjs.git",
     "directory": "packages/storage"
   },
-  "engines": {
-    "node": ">=16.0",
-    "npm": ">=7.0.0"
-  },
-  "files": [
-    "cjs/",
-    "esm/",
-    "types/",
-    "LICENSE",
-    "README.md"
-  ],
   "keywords": [
     "nestjs",
     "storage",
     "s3"
-  ]
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
 }

package/{esm/providers → providers}/s3-storage-connection.js

@@ -1,9 +1,11 @@
 import * as Minio from 'minio';
 import { StorageConnection } from '../services/storage-connection.js';
 export class S3StorageConnection extends StorageConnection {
+    provider = 's3';
+    config;
+    _client;
     constructor(config) {
         super();
-        this.provider = 's3';
         this.config = config;
         this._client = new Minio.Client(config);
         this._client.setRequestOptions({

package/{esm/services → services}/storage-bucket.js

@@ -1,4 +1,6 @@
 export class StorageBucket {
+    _connection;
+    _bucketName;
     constructor(_connection, _bucketName) {
         this._connection = _connection;
         this._bucketName = _bucketName;

package/{esm/storage-core.module.js → storage-core.module.js}

@@ -44,6 +44,7 @@ export class StorageCoreModule {
     static _createDynamicModule(opts, metadata) {
         const token = opts.token ?? StorageConnection;
         const providers = [
+            ...(metadata.providers ?? []),
             {
                 provide: token,
                 inject: [STORAGE_OPTIONS],
@@ -65,18 +66,17 @@ export class StorageCoreModule {
                     ? new Logger(opts.logger)
                     : opts.logger,
             },
+            {
+                provide: STORAGE_MODULE_ID,
+                useValue: crypto.randomUUID(),
+            },
         ];
         return {
+            global: opts.global,
             module: StorageCoreModule,
+            imports: opts.imports,
             ...metadata,
-            providers: [
-                ...(metadata.providers ?? []),
-                ...providers,
-                {
-                    provide: STORAGE_MODULE_ID,
-                    useValue: crypto.randomUUID(),
-                },
-            ],
+            providers,
             exports: [STORAGE_OPTIONS, token, ...(metadata.exports ?? [])],
         };
     }

package/cjs/constants.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.STORAGE_MODULE_ID = exports.STORAGE_OPTIONS = void 0;
-exports.STORAGE_OPTIONS = Symbol('STORAGE_OPTIONS');
-exports.STORAGE_MODULE_ID = Symbol('STORAGE_MODULE_ID');

package/cjs/get-storage-config.js

@@ -1,35 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getStorageConfig = getStorageConfig;
-const tslib_1 = require("tslib");
-const node_process_1 = tslib_1.__importDefault(require("node:process"));
-const objects_1 = require("@jsopen/objects");
-const putil_varhelpers_1 = require("putil-varhelpers");
-function getStorageConfig(moduleOptions, prefix = 'STORAGE_') {
-    const options = (0, objects_1.clone)(moduleOptions);
-    const env = node_process_1.default.env;
-    options.provider = options.provider || env[prefix + 'PROVIDER'];
-    if (!options.provider)
-        throw new Error(`You must provide a Storage provider or "${prefix + 'PROVIDER'}" env variable`);
-    if (options.provider === 's3') {
-        options.s3 = options.s3 || {};
-        options.s3.endPoint = options.s3.endPoint ?? env[prefix + 'S3_ENDPOINT'];
-        options.s3.accessKey =
-            options.s3.accessKey ?? env[prefix + 'S3_ACCESS_KEY'];
-        options.s3.secretKey =
-            options.s3.secretKey ?? env[prefix + 'S3_SECRET_KEY'];
-        options.s3.useSSL = options.s3.useSSL ?? (0, putil_varhelpers_1.toBoolean)(env[prefix + 'S3_SSL']);
-        options.s3.port = options.s3.port ?? (0, putil_varhelpers_1.toInt)(env[prefix + 'S3_PORT']);
-        options.s3.sessionToken =
-            options.s3.sessionToken ?? env[prefix + 'S3_SESSION_TOKEN'];
-        options.s3.partSize =
-            options.s3.partSize ?? (0, putil_varhelpers_1.toInt)(env[prefix + 'S3_PART_SIZE']);
-        options.s3.pathStyle =
-            options.s3.pathStyle ?? (0, putil_varhelpers_1.toBoolean)(env[prefix + 'S3_PATH_STYLE']);
-        options.s3.s3AccelerateEndpoint =
-            options.s3.s3AccelerateEndpoint ?? env[prefix + 'S3_ACC_ENDPOINT'];
-    }
-    else
-        throw new Error(`Unknown Storage provider (${options.provider})`);
-    return options;
-}

package/cjs/index.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./constants.js"), exports);
-tslib_1.__exportStar(require("./get-storage-config.js"), exports);
-tslib_1.__exportStar(require("./services/storage-bucket.js"), exports);
-tslib_1.__exportStar(require("./services/storage-connection.js"), exports);
-tslib_1.__exportStar(require("./storage.module.js"), exports);
-tslib_1.__exportStar(require("./types.js"), exports);

package/cjs/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "commonjs"
-}

package/cjs/providers/s3-storage-connection.js

@@ -1,97 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.S3StorageConnection = void 0;
-const tslib_1 = require("tslib");
-const Minio = tslib_1.__importStar(require("minio"));
-const storage_connection_js_1 = require("../services/storage-connection.js");
-class S3StorageConnection extends storage_connection_js_1.StorageConnection {
-    constructor(config) {
-        super();
-        this.provider = 's3';
-        this.config = config;
-        this._client = new Minio.Client(config);
-        this._client.setRequestOptions({
-            rejectUnauthorized: config.rejectUnauthorized,
-        });
-    }
-    async putObject(bucketName, objectName, source, options) {
-        const meta = options ? updateMetadata(options?.metadata, options) : {};
-        if (typeof source === 'string')
-            await this._client.fPutObject(bucketName, objectName, source, meta);
-        else
-            await this._client.putObject(bucketName, objectName, source, undefined, meta);
-    }
-    async getObjectInfo(bucketName, objectName) {
-        const o = await this._client.statObject(bucketName, objectName);
-        const inf = {
-            size: o.size,
-            etag: o.etag,
-            lastModified: o.lastModified,
-            metadata: o.metaData,
-        };
-        if (inf.metadata) {
-            const meta = inf.metadata;
-            removeKey(meta, 'content-length');
-            removeKey(meta, 'last-modified');
-            if (meta['Content-Type']) {
-                inf.contentLanguage = meta['Content-Type'];
-                removeKey(meta, 'content-type');
-            }
-            if (meta['Content-Language']) {
-                inf.contentLanguage = meta['Content-Language'];
-                removeKey(meta, 'content-language');
-            }
-            if (meta['Content-Encoding']) {
-                inf.contentEncoding = meta['Content-Encoding'];
-                removeKey(meta, 'content-encoding');
-            }
-            if (meta['Content-Name']) {
-                inf.originalName = meta['Content-Name'];
-                removeKey(meta, 'content-name');
-            }
-        }
-        return inf;
-    }
-    async removeObject(bucketName, objectName) {
-        await this._client.removeObject(bucketName, objectName);
-    }
-    async getFile(bucketName, objectName, filePath) {
-        await this._client.fGetObject(bucketName, objectName, filePath);
-    }
-    getObject(bucketName, objectName) {
-        return this._client.getObject(bucketName, objectName);
-    }
-    presignedGetObject(bucketName, objectName, options) {
-        const expires = options?.expires || 5 * 60 * 60; // 5 minutes
-        return this._client.presignedGetObject(bucketName, objectName, expires);
-    }
-}
-exports.S3StorageConnection = S3StorageConnection;
-function updateMetadata(meta, options) {
-    if (!options)
-        return meta;
-    const newMeta = { ...meta };
-    if (options.contentType) {
-        removeKey(newMeta, 'content-type');
-        newMeta['Content-Type'] = options.contentType;
-    }
-    if (options.contentLanguage) {
-        removeKey(newMeta, 'content-language');
-        newMeta['Content-Language'] = options.contentLanguage;
-    }
-    if (options.contentEncoding) {
-        removeKey(newMeta, 'content-encoding');
-        newMeta['Content-Encoding'] = options.contentLanguage;
-    }
-    if (options.originalName) {
-        removeKey(newMeta, 'content-name');
-        newMeta['Content-Name'] = options.originalName;
-    }
-    return newMeta;
-}
-function removeKey(obj, key) {
-    key = key.toLowerCase();
-    const k = Object.keys(obj).find(x => x.toLowerCase() === key);
-    if (k)
-        delete obj[k];
-}

package/cjs/services/storage-bucket.js

@@ -1,28 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StorageBucket = void 0;
-class StorageBucket {
-    constructor(_connection, _bucketName) {
-        this._connection = _connection;
-        this._bucketName = _bucketName;
-    }
-    putObject(objectName, buffer, options) {
-        return this._connection.putObject(this._bucketName, objectName, buffer, options);
-    }
-    getObjectInfo(objectName) {
-        return this._connection.getObjectInfo(this._bucketName, objectName);
-    }
-    removeObject(objectName) {
-        return this._connection.removeObject(this._bucketName, objectName);
-    }
-    getFile(objectName, filePath) {
-        return this._connection.getFile(this._bucketName, objectName, filePath);
-    }
-    getObject(objectName) {
-        return this._connection.getObject(this._bucketName, objectName);
-    }
-    presignedGetObject(objectName, options) {
-        return this._connection.presignedGetObject(this._bucketName, objectName, options);
-    }
-}
-exports.StorageBucket = StorageBucket;

package/cjs/services/storage-connection.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StorageConnection = void 0;
-const storage_bucket_js_1 = require("./storage-bucket.js");
-class StorageConnection {
-    getBucket(bucketName) {
-        return new storage_bucket_js_1.StorageBucket(this, bucketName);
-    }
-}
-exports.StorageConnection = StorageConnection;

package/cjs/storage-core.module.js

@@ -1,88 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StorageCoreModule = void 0;
-const tslib_1 = require("tslib");
-const node_assert_1 = tslib_1.__importDefault(require("node:assert"));
-const common_1 = require("@nestjs/common");
-const crypto_1 = tslib_1.__importDefault(require("crypto"));
-const constants_js_1 = require("./constants.js");
-const get_storage_config_js_1 = require("./get-storage-config.js");
-const s3_storage_connection_js_1 = require("./providers/s3-storage-connection.js");
-const storage_connection_js_1 = require("./services/storage-connection.js");
-const CLIENT_TOKEN = Symbol('CLIENT_TOKEN');
-class StorageCoreModule {
-    /**
-     * Configures and returns a dynamic module
-     */
-    static forRoot(moduleOptions) {
-        const connectionOptions = (0, get_storage_config_js_1.getStorageConfig)(moduleOptions.useValue || {}, moduleOptions.envPrefix);
-        return this._createDynamicModule(moduleOptions, {
-            global: moduleOptions.global,
-            providers: [
-                {
-                    provide: constants_js_1.STORAGE_OPTIONS,
-                    useValue: connectionOptions,
-                },
-            ],
-        });
-    }
-    /**
-     * Configures and returns an async dynamic module
-     */
-    static forRootAsync(asyncOptions) {
-        node_assert_1.default.ok(asyncOptions.useFactory, 'useFactory is required');
-        return this._createDynamicModule(asyncOptions, {
-            global: asyncOptions.global,
-            providers: [
-                {
-                    provide: constants_js_1.STORAGE_OPTIONS,
-                    inject: asyncOptions.inject,
-                    useFactory: async (...args) => {
-                        const opts = await asyncOptions.useFactory(...args);
-                        return (0, get_storage_config_js_1.getStorageConfig)(opts, asyncOptions.envPrefix);
-                    },
-                },
-            ],
-        });
-    }
-    static _createDynamicModule(opts, metadata) {
-        const token = opts.token ?? storage_connection_js_1.StorageConnection;
-        const providers = [
-            {
-                provide: token,
-                inject: [constants_js_1.STORAGE_OPTIONS],
-                useFactory: async (storageOptions) => {
-                    if (storageOptions.provider === 's3') {
-                        return new s3_storage_connection_js_1.S3StorageConnection(storageOptions.s3);
-                    }
-                    /** istanbul ignore next */
-                    throw new Error(`Unknown Storage provider (${storageOptions.provider})`);
-                },
-            },
-            {
-                provide: CLIENT_TOKEN,
-                useExisting: token,
-            },
-            {
-                provide: common_1.Logger,
-                useValue: typeof opts.logger === 'string'
-                    ? new common_1.Logger(opts.logger)
-                    : opts.logger,
-            },
-        ];
-        return {
-            module: StorageCoreModule,
-            ...metadata,
-            providers: [
-                ...(metadata.providers ?? []),
-                ...providers,
-                {
-                    provide: constants_js_1.STORAGE_MODULE_ID,
-                    useValue: crypto_1.default.randomUUID(),
-                },
-            ],
-            exports: [constants_js_1.STORAGE_OPTIONS, token, ...(metadata.exports ?? [])],
-        };
-    }
-}
-exports.StorageCoreModule = StorageCoreModule;

package/cjs/storage.module.js

@@ -1,25 +0,0 @@
-"use strict";
-var StorageModule_1;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StorageModule = void 0;
-const tslib_1 = require("tslib");
-const common_1 = require("@nestjs/common");
-const storage_core_module_js_1 = require("./storage-core.module.js");
-let StorageModule = StorageModule_1 = class StorageModule {
-    static forRoot(options) {
-        return {
-            module: StorageModule_1,
-            imports: [storage_core_module_js_1.StorageCoreModule.forRoot(options || {})],
-        };
-    }
-    static forRootAsync(options) {
-        return {
-            module: StorageModule_1,
-            imports: [storage_core_module_js_1.StorageCoreModule.forRootAsync(options)],
-        };
-    }
-};
-exports.StorageModule = StorageModule;
-exports.StorageModule = StorageModule = StorageModule_1 = tslib_1.__decorate([
-    (0, common_1.Module)({})
-], StorageModule);

package/cjs/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/esm/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "module"
-}

package/types/index.d.cts

@@ -1,6 +0,0 @@
-export * from './constants.js';
-export * from './get-storage-config.js';
-export * from './services/storage-bucket.js';
-export * from './services/storage-connection.js';
-export * from './storage.module.js';
-export * from './types.js';