@xnestjs/storage 1.5.3 → 1.6.0

package/README.md

@@ -72,6 +72,8 @@ export class MyModule {
 The library supports configuration through environment variables. Environment variables below is accepted.
 All environment variables starts with prefix (STORAGE_). This can be configured while registering the module.
 
+<--- BEGIN env --->
+
 | Environment Variable | Type | Default | Description                         |
 |----------------------|------|---------|-------------------------------------|
 | STORAGE_PROVIDER     | Enum |         | Storage Provider `s3` for Amazon S3 |
@@ -89,3 +91,5 @@ All environment variables starts with prefix (STORAGE_). This can be configured
 | STORAGE_S3_PATH_STYLE    | Boolean |         |                 |
 | STORAGE_S3_SECRET_KEY    | String  |         |                 |
 | STORAGE_S3_ACC_ENDPOINT  | String  |         |                 |
+
+<--- END env --->

package/cjs/{get-connection-options.js → get-storage-config.js}

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getConnectionOptions = getConnectionOptions;
+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 getConnectionOptions(moduleOptions, prefix = 'STORAGE_') {
+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'];

package/cjs/index.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./constants.js"), exports);
-tslib_1.__exportStar(require("./get-connection-options.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);

package/cjs/storage-core.module.js

@@ -6,7 +6,7 @@ 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_connection_options_js_1 = require("./get-connection-options.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');
@@ -15,7 +15,7 @@ class StorageCoreModule {
      * Configures and returns a dynamic module
      */
     static forRoot(moduleOptions) {
-        const connectionOptions = (0, get_connection_options_js_1.getConnectionOptions)(moduleOptions.useValue || {}, moduleOptions.envPrefix);
+        const connectionOptions = (0, get_storage_config_js_1.getStorageConfig)(moduleOptions.useValue || {}, moduleOptions.envPrefix);
         return this._createDynamicModule(moduleOptions, {
             global: moduleOptions.global,
             providers: [
@@ -39,7 +39,7 @@ class StorageCoreModule {
                     inject: asyncOptions.inject,
                     useFactory: async (...args) => {
                         const opts = await asyncOptions.useFactory(...args);
-                        return (0, get_connection_options_js_1.getConnectionOptions)(opts, asyncOptions.envPrefix);
+                        return (0, get_storage_config_js_1.getStorageConfig)(opts, asyncOptions.envPrefix);
                     },
                 },
             ],

package/esm/{get-connection-options.js → get-storage-config.js}

@@ -1,7 +1,7 @@
 import process from 'node:process';
 import { clone } from '@jsopen/objects';
 import { toBoolean, toInt } from 'putil-varhelpers';
-export function getConnectionOptions(moduleOptions, prefix = 'STORAGE_') {
+export function getStorageConfig(moduleOptions, prefix = 'STORAGE_') {
     const options = clone(moduleOptions);
     const env = process.env;
     options.provider = options.provider || env[prefix + 'PROVIDER'];

package/esm/index.js

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

package/esm/storage-core.module.js

@@ -2,7 +2,7 @@ import assert from 'node:assert';
 import { Logger } from '@nestjs/common';
 import crypto from 'crypto';
 import { STORAGE_MODULE_ID, STORAGE_OPTIONS } from './constants.js';
-import { getConnectionOptions } from './get-connection-options.js';
+import { getStorageConfig } from './get-storage-config.js';
 import { S3StorageConnection } from './providers/s3-storage-connection.js';
 import { StorageConnection } from './services/storage-connection.js';
 const CLIENT_TOKEN = Symbol('CLIENT_TOKEN');
@@ -11,7 +11,7 @@ export class StorageCoreModule {
      * Configures and returns a dynamic module
      */
     static forRoot(moduleOptions) {
-        const connectionOptions = getConnectionOptions(moduleOptions.useValue || {}, moduleOptions.envPrefix);
+        const connectionOptions = getStorageConfig(moduleOptions.useValue || {}, moduleOptions.envPrefix);
         return this._createDynamicModule(moduleOptions, {
             global: moduleOptions.global,
             providers: [
@@ -35,7 +35,7 @@ export class StorageCoreModule {
                     inject: asyncOptions.inject,
                     useFactory: async (...args) => {
                         const opts = await asyncOptions.useFactory(...args);
-                        return getConnectionOptions(opts, asyncOptions.envPrefix);
+                        return getStorageConfig(opts, asyncOptions.envPrefix);
                     },
                 },
             ],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xnestjs/storage",
-  "version": "1.5.3",
+  "version": "1.6.0",
   "description": "NestJS extension library for Storage solutions (S3,GS)",
   "author": "Panates",
   "license": "MIT",

package/types/get-storage-config.d.ts

@@ -0,0 +1,2 @@
+import type { StorageOptions } from './types.js';
+export declare function getStorageConfig(moduleOptions: Partial<StorageOptions>, prefix?: string): StorageOptions;

package/types/index.d.cts

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

package/types/index.d.ts

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

package/types/get-connection-options.d.ts

@@ -1,2 +0,0 @@
-import type { StorageOptions } from './types.js';
-export declare function getConnectionOptions(moduleOptions: Partial<StorageOptions>, prefix?: string): StorageOptions;