nestjs-ip-filter 0.1.1 → 0.2.0

package/README.md

@@ -18,6 +18,9 @@ npm install nestjs-ip-filter
 
 ### Use Regex for the IP list
 
+> In Express-based framework, the incoming IP address will have prefix `::ffff:` characters. So if you have put `(^192.168.)` into the whitelist, it won't work because that regex describes it must have number `1` as a first character.
+> So for now, you should put that prefix for your regex string like `(^::ffff:192.168.)`. Will patch the source codes in the near future.
+
 You can use the Regex format string for the IP ranges.
 
 For a simple example, if you want to allow the private network hosts in `192.168.0.1/16`, you can write the Regex string like the below.
@@ -48,10 +51,10 @@ But be aware of that you should write the Regex string very carefully to avoid a
 
 You can initialize the dedicated Guard using non-async or async mode, as the other NestJS packages support.
 
-Use `forRoot` for the static IP address list.
+Use `register` for the static IP address list.
 
 ```typescript
-IpFilter.forRoot({
+IpFilter.register({
   whitelist: [
     '(^::1)',
     '(^192.168.)',
@@ -60,13 +63,13 @@ IpFilter.forRoot({
 }),
 ```
 
-Or, use `forRootAsync` for the provided IP addresses from the other Provider, such as ConfigModule or RepositoryModule for your database.
+Or, use `registerAsync` for the provided IP addresses from the other Provider, such as ConfigModule or RepositoryModule for your database.
 
 ```typescript
 // If it would like to get the whitelist IPs from a config file,
 // and if MyConfigModule provides that
 
-IpFilter.forRootAsync({
+IpFilter.registerAsync({
   imports: [ MyConfigModule ],
   inject: [ MyConfigService ],
   useFactory: async (myConfigService: MyConfigService) => ({
@@ -77,7 +80,7 @@ IpFilter.forRootAsync({
 
 Yeah, you can use your method to provide some async data.
 
-After setting up the `IpFilter` module with the `forRoot*` method, this will accept only the incoming requests for the given whitelist IP addresses.
+After setting up the `IpFilter` module with the `register*` method, this will accept only the incoming requests for the given whitelist IP addresses.
 
 ### Blacklist
 
@@ -89,7 +92,7 @@ Use `blacklist` option to let the Guard know the list.
 // If it would like to get the whitelist IPs from a config file,
 // and if MyConfigModule provides that
 
-IpFilter.forRootAsync({
+IpFilter.registerAsync({
   imports: [ MyConfigModule ],
   inject: [ MyConfigService ],
   useFactory: async (myConfigService: MyConfigService) => ({
@@ -111,7 +114,7 @@ If you want to throw that `IpFilterDenyException` when denial, set the option `u
 // If it would like to get the whitelist IPs from a config file,
 // and if MyConfigModule provides that
 
-IpFilter.forRootAsync({
+IpFilter.registerAsync({
   imports: [ MyConfigModule ],
   inject: [ MyConfigService ],
   useFactory: async (myConfigService: MyConfigService) => ({

package/dist/index.d.ts

@@ -1,8 +1,7 @@
-export * from './ipfilter-core.module';
 export * from './ipfilter-deny.exception';
 export * from './ipfilter.constants';
 export * from './ipfilter.guard';
 export * from './ipfilter.interface';
 export * from './ipfilter.module';
-export * from './ipfilter.providers';
+export * from './ipfilter.module-definition';
 export * from './ipfilter.service';

package/dist/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -10,12 +14,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./ipfilter-core.module"), exports);
 __exportStar(require("./ipfilter-deny.exception"), exports);
 __exportStar(require("./ipfilter.constants"), exports);
 __exportStar(require("./ipfilter.guard"), exports);
 __exportStar(require("./ipfilter.interface"), exports);
 __exportStar(require("./ipfilter.module"), exports);
-__exportStar(require("./ipfilter.providers"), exports);
+__exportStar(require("./ipfilter.module-definition"), exports);
 __exportStar(require("./ipfilter.service"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yDAAuC;AACvC,4DAA0C;AAC1C,uDAAqC;AACrC,mDAAiC;AACjC,uDAAqC;AACrC,oDAAkC;AAClC,uDAAqC;AACrC,qDAAmC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4DAA0C;AAC1C,uDAAqC;AACrC,mDAAiC;AACjC,uDAAqC;AACrC,oDAAkC;AAClC,+DAA6C;AAC7C,qDAAmC"}

package/dist/ipfilter.constants.d.ts

@@ -1,2 +1 @@
-export declare const IPFILTER_MODULE_OPTIONS: unique symbol;
 export declare const IPFILTER_TOKEN: unique symbol;

package/dist/ipfilter.constants.js

@@ -1,6 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IPFILTER_TOKEN = exports.IPFILTER_MODULE_OPTIONS = void 0;
-exports.IPFILTER_MODULE_OPTIONS = Symbol('IpFilterModuleOptions');
+exports.IPFILTER_TOKEN = void 0;
 exports.IPFILTER_TOKEN = Symbol('IpFilterToken');
 //# sourceMappingURL=ipfilter.constants.js.map

package/dist/ipfilter.constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"ipfilter.constants.js","sourceRoot":"","sources":["../lib/ipfilter.constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,uBAAuB,GAAG,MAAM,CAAC,uBAAuB,CAAC,CAAC;AAC1D,QAAA,cAAc,GAAG,MAAM,CAAC,eAAe,CAAC,CAAC"}
+{"version":3,"file":"ipfilter.constants.js","sourceRoot":"","sources":["../lib/ipfilter.constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,cAAc,GAAG,MAAM,CAAC,eAAe,CAAC,CAAC"}

package/dist/ipfilter.interface.d.ts

@@ -1,4 +1,3 @@
-import { ModuleMetadata, Type } from '@nestjs/common';
 export declare type IpFilterModuleOptions = {
     whitelist?: string[];
     blacklist?: string[];
@@ -7,12 +6,3 @@ export declare type IpFilterModuleOptions = {
 export interface IpFilterDenyHandler {
     handle(): boolean;
 }
-export interface IpFilterOptionsFactory {
-    createIpFilterModuleOptions(): Promise<IpFilterModuleOptions> | IpFilterModuleOptions;
-}
-export interface IpFilterModuleAsyncOptions extends Pick<ModuleMetadata, 'imports'> {
-    inject?: any[];
-    useClass?: Type<IpFilterOptionsFactory>;
-    useExisting?: Type<IpFilterOptionsFactory>;
-    useFactory?: (...args: any[]) => Promise<IpFilterModuleOptions> | IpFilterModuleOptions;
-}

package/dist/ipfilter.module-definition.d.ts

@@ -0,0 +1,2 @@
+import { IpFilterModuleOptions } from './ipfilter.interface';
+export declare const ConfigurableModuleClass: import("@nestjs/common").ConfigurableModuleCls<IpFilterModuleOptions, "register", "create", {}>, MODULE_OPTIONS_TOKEN: string | symbol;

package/dist/ipfilter.module-definition.js

@@ -0,0 +1,7 @@
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MODULE_OPTIONS_TOKEN = exports.ConfigurableModuleClass = void 0;
+const common_1 = require("@nestjs/common");
+_a = new common_1.ConfigurableModuleBuilder().build(), exports.ConfigurableModuleClass = _a.ConfigurableModuleClass, exports.MODULE_OPTIONS_TOKEN = _a.MODULE_OPTIONS_TOKEN;
+//# sourceMappingURL=ipfilter.module-definition.js.map

package/dist/ipfilter.module-definition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ipfilter.module-definition.js","sourceRoot":"","sources":["../lib/ipfilter.module-definition.ts"],"names":[],"mappings":";;;;AAAA,2CAA2D;AAG9C,KACX,IAAI,kCAAyB,EAAyB,CAAC,KAAK,EAAE,EADjD,+BAAuB,+BAAE,4BAAoB,2BACK"}

package/dist/ipfilter.module.d.ts

@@ -1,6 +1,3 @@
-import { DynamicModule } from '@nestjs/common';
-import { IpFilterModuleAsyncOptions, IpFilterModuleOptions } from './ipfilter.interface';
-export declare class IpFilter {
-    static forRoot(options: IpFilterModuleOptions): DynamicModule;
-    static forRootAsync(options: IpFilterModuleAsyncOptions): DynamicModule;
+import { ConfigurableModuleClass } from './ipfilter.module-definition';
+export declare class IpFilter extends ConfigurableModuleClass {
 }

package/dist/ipfilter.module.js

@@ -1,22 +1,33 @@
 "use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    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;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IpFilter = void 0;
 const common_1 = require("@nestjs/common");
-const ipfilter_core_module_1 = require("./ipfilter-core.module");
-(0, common_1.Module)({});
-class IpFilter {
-    static forRoot(options) {
-        return {
-            module: IpFilter,
-            imports: [ipfilter_core_module_1.IpFilterCoreModule.forRoot(options)],
-        };
-    }
-    static forRootAsync(options) {
-        return {
-            module: IpFilter,
-            imports: [ipfilter_core_module_1.IpFilterCoreModule.forRootAsync(options)],
-        };
-    }
-}
+const core_1 = require("@nestjs/core");
+const ipfilter_constants_1 = require("./ipfilter.constants");
+const ipfilter_guard_1 = require("./ipfilter.guard");
+const ipfilter_module_definition_1 = require("./ipfilter.module-definition");
+const ipfilter_service_1 = require("./ipfilter.service");
+const ipFilterServiceProvider = {
+    provide: ipfilter_constants_1.IPFILTER_TOKEN,
+    useClass: ipfilter_service_1.IpFilterService,
+};
+const ipFilterGuardProvider = {
+    provide: core_1.APP_GUARD,
+    useClass: ipfilter_guard_1.IpFilterGuard,
+};
+let IpFilter = class IpFilter extends ipfilter_module_definition_1.ConfigurableModuleClass {
+};
+IpFilter = __decorate([
+    (0, common_1.Module)({
+        providers: [ipFilterServiceProvider, ipFilterGuardProvider],
+        exports: [ipFilterServiceProvider],
+    })
+], IpFilter);
 exports.IpFilter = IpFilter;
 //# sourceMappingURL=ipfilter.module.js.map

package/dist/ipfilter.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"ipfilter.module.js","sourceRoot":"","sources":["../lib/ipfilter.module.ts"],"names":[],"mappings":";;;AAAA,2CAAuD;AACvD,iEAA4D;AAM5D,IAAA,eAAM,EAAC,EAAE,CAAC,CAAC;AACX,MAAa,QAAQ;IACnB,MAAM,CAAC,OAAO,CAAC,OAA8B;QAC3C,OAAO;YACL,MAAM,EAAE,QAAQ;YAChB,OAAO,EAAE,CAAC,yCAAkB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;SAC/C,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,YAAY,CAAC,OAAmC;QACrD,OAAO;YACL,MAAM,EAAE,QAAQ;YAChB,OAAO,EAAE,CAAC,yCAAkB,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;SACpD,CAAC;IACJ,CAAC;CACF;AAdD,4BAcC"}
+{"version":3,"file":"ipfilter.module.js","sourceRoot":"","sources":["../lib/ipfilter.module.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2CAAuD;AACvD,uCAAyC;AACzC,6DAAsD;AACtD,qDAAiD;AACjD,6EAAuE;AACvE,yDAAqD;AAErD,MAAM,uBAAuB,GAAG;IAC9B,OAAO,EAAE,mCAAc;IACvB,QAAQ,EAAE,kCAAe;CAC1B,CAAC;AAEF,MAAM,qBAAqB,GAAG;IAC5B,OAAO,EAAE,gBAAS;IAClB,QAAQ,EAAE,8BAAa;CACxB,CAAC;AAMF,IAAa,QAAQ,GAArB,MAAa,QAAS,SAAQ,oDAAuB;CAAG,CAAA;AAA3C,QAAQ;IAJpB,IAAA,eAAM,EAAC;QACN,SAAS,EAAE,CAAC,uBAAuB,EAAE,qBAAqB,CAAC;QAC3D,OAAO,EAAE,CAAC,uBAAuB,CAAC;KACnC,CAAC;GACW,QAAQ,CAAmC;AAA3C,4BAAQ"}

package/dist/ipfilter.service.js

@@ -14,7 +14,7 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IpFilterService = void 0;
 const common_1 = require("@nestjs/common");
-const ipfilter_constants_1 = require("./ipfilter.constants");
+const ipfilter_module_definition_1 = require("./ipfilter.module-definition");
 let IpFilterService = class IpFilterService {
     constructor(options) {
         var _a, _b, _c;
@@ -38,7 +38,7 @@ let IpFilterService = class IpFilterService {
 };
 IpFilterService = __decorate([
     (0, common_1.Injectable)(),
-    __param(0, (0, common_1.Inject)(ipfilter_constants_1.IPFILTER_MODULE_OPTIONS)),
+    __param(0, (0, common_1.Inject)(ipfilter_module_definition_1.MODULE_OPTIONS_TOKEN)),
     __metadata("design:paramtypes", [Object])
 ], IpFilterService);
 exports.IpFilterService = IpFilterService;

package/dist/ipfilter.service.js.map

@@ -1 +1 @@
-{"version":3,"file":"ipfilter.service.js","sourceRoot":"","sources":["../lib/ipfilter.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAAoD;AAEpD,6DAA+D;AAG/D,IAAa,eAAe,GAA5B,MAAa,eAAe;IAM1B,YAEW,OAA8B;;QAA9B,YAAO,GAAP,OAAO,CAAuB;QAEvC,IAAI,CAAC,gBAAgB,GAAG,MAAA,OAAO,CAAC,gBAAgB,mCAAI,KAAK,CAAC;QAE1D,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,MAAA,OAAO,CAAC,SAAS,mCAAI,EAAE,CAAC,CAAC;QAC7D,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,MAAA,OAAO,CAAC,SAAS,mCAAI,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,IAAI,SAAS,CAAC,SAAmB;QAC/B,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAC9B,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,IAAI,SAAS,CAAC,SAAmB;QAC/B,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAC9B,CAAC;CACF,CAAA;AA/BY,eAAe;IAD3B,IAAA,mBAAU,GAAE;IAQR,WAAA,IAAA,eAAM,EAAC,4CAAuB,CAAC,CAAA;;GAPvB,eAAe,CA+B3B;AA/BY,0CAAe"}
+{"version":3,"file":"ipfilter.service.js","sourceRoot":"","sources":["../lib/ipfilter.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAAoD;AAEpD,6EAAoE;AAGpE,IAAa,eAAe,GAA5B,MAAa,eAAe;IAM1B,YAEW,OAA8B;;QAA9B,YAAO,GAAP,OAAO,CAAuB;QAEvC,IAAI,CAAC,gBAAgB,GAAG,MAAA,OAAO,CAAC,gBAAgB,mCAAI,KAAK,CAAC;QAE1D,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,MAAA,OAAO,CAAC,SAAS,mCAAI,EAAE,CAAC,CAAC;QAC7D,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,MAAA,OAAO,CAAC,SAAS,mCAAI,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,IAAI,SAAS,CAAC,SAAmB;QAC/B,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAC9B,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,IAAI,SAAS,CAAC,SAAmB;QAC/B,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAC9B,CAAC;CACF,CAAA;AA/BY,eAAe;IAD3B,IAAA,mBAAU,GAAE;IAQR,WAAA,IAAA,eAAM,EAAC,iDAAoB,CAAC,CAAA;;GAPpB,eAAe,CA+B3B;AA/BY,0CAAe"}