nestjs-ip-filter 0.1.3 → 0.2.0

package/lib/ipfilter.module.ts

@@ -1,23 +1,22 @@
 import { DynamicModule, Module } from '@nestjs/common';
-import { IpFilterCoreModule } from './ipfilter-core.module';
-import {
-  IpFilterModuleAsyncOptions,
-  IpFilterModuleOptions,
-} from './ipfilter.interface';
+import { APP_GUARD } from '@nestjs/core';
+import { IPFILTER_TOKEN } from './ipfilter.constants';
+import { IpFilterGuard } from './ipfilter.guard';
+import { ConfigurableModuleClass } from './ipfilter.module-definition';
+import { IpFilterService } from './ipfilter.service';
 
-Module({});
-export class IpFilter {
-  static forRoot(options: IpFilterModuleOptions): DynamicModule {
-    return {
-      module: IpFilter,
-      imports: [IpFilterCoreModule.forRoot(options)],
-    };
-  }
+const ipFilterServiceProvider = {
+  provide: IPFILTER_TOKEN,
+  useClass: IpFilterService,
+};
 
-  static forRootAsync(options: IpFilterModuleAsyncOptions): DynamicModule {
-    return {
-      module: IpFilter,
-      imports: [IpFilterCoreModule.forRootAsync(options)],
-    };
-  }
-}
+const ipFilterGuardProvider = {
+  provide: APP_GUARD,
+  useClass: IpFilterGuard,
+};
+
+@Module({
+  providers: [ipFilterServiceProvider, ipFilterGuardProvider],
+  exports: [ipFilterServiceProvider],
+})
+export class IpFilter extends ConfigurableModuleClass {}

package/lib/ipfilter.service.ts

@@ -1,6 +1,6 @@
 import { Inject, Injectable } from '@nestjs/common';
 import { IpFilterModuleOptions } from './ipfilter.interface';
-import { IPFILTER_MODULE_OPTIONS } from './ipfilter.constants';
+import { MODULE_OPTIONS_TOKEN } from './ipfilter.module-definition';
 
 @Injectable()
 export class IpFilterService {
@@ -10,7 +10,7 @@ export class IpFilterService {
   private _blacklist: string[];
 
   constructor(
-    @Inject(IPFILTER_MODULE_OPTIONS)
+    @Inject(MODULE_OPTIONS_TOKEN)
     readonly options: IpFilterModuleOptions,
   ) {
     this.useDenyException = options.useDenyException ?? false;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nestjs-ip-filter",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "description": "A NestJS Guard for filtering IP addresses",
   "author": "Deokgyu Yang <secugyu@gmail.com>",
   "keywords": [
@@ -34,35 +34,35 @@
     "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand"
   },
   "dependencies": {
-    "@nestjs/common": "8.4.7",
-    "@nestjs/core": "8.4.7",
-    "@nestjs/platform-express": "8.4.7",
+    "@nestjs/common": "9.0.0",
+    "@nestjs/core": "9.0.0",
+    "@nestjs/platform-express": "9.0.0",
     "@supercharge/request-ip": "1.2.0",
     "reflect-metadata": "0.1.13",
     "rimraf": "3.0.2",
-    "rxjs": "7.5.5"
+    "rxjs": "7.5.6"
   },
   "devDependencies": {
-    "@nestjs/cli": "8.2.6",
-    "@nestjs/schematics": "8.0.11",
-    "@nestjs/testing": "8.4.7",
+    "@nestjs/cli": "9.0.0",
+    "@nestjs/schematics": "9.0.0",
+    "@nestjs/testing": "9.0.0",
     "@types/express": "4.17.13",
-    "@types/jest": "28.1.3",
-    "@types/node": "16.11.41",
+    "@types/jest": "28.1.5",
+    "@types/node": "18.0.4",
     "@types/supertest": "2.0.12",
-    "@typescript-eslint/eslint-plugin": "5.29.0",
-    "@typescript-eslint/parser": "5.29.0",
-    "eslint": "8.18.0",
+    "@typescript-eslint/eslint-plugin": "5.30.6",
+    "@typescript-eslint/parser": "5.30.6",
+    "eslint": "8.19.0",
     "eslint-config-google": "0.14.0",
     "eslint-config-prettier": "8.5.0",
-    "eslint-plugin-prettier": "4.0.0",
-    "jest": "28.1.1",
+    "eslint-plugin-prettier": "4.2.1",
+    "jest": "28.1.3",
     "prettier": "2.7.1",
     "source-map-support": "0.5.21",
-    "supertest": "6.2.3",
-    "ts-jest": "28.0.5",
+    "supertest": "6.2.4",
+    "ts-jest": "28.0.6",
     "ts-loader": "9.3.1",
-    "ts-node": "10.8.1",
+    "ts-node": "10.9.1",
     "tsconfig-paths": "4.0.0",
     "typescript": "4.7.4"
   },

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

@@ -1,24 +0,0 @@
-import { Provider, Type } from '@nestjs/common';
-import { IpFilterModuleAsyncOptions, IpFilterModuleOptions } from './ipfilter.interface';
-import { IpFilterGuard } from './ipfilter.guard';
-export declare class IpFilterCoreModule {
-    static forRoot(options: IpFilterModuleOptions): {
-        module: typeof IpFilterCoreModule;
-        providers: (Provider<any> | {
-            provide: string;
-            useClass: typeof IpFilterGuard;
-        })[];
-        exports: Provider<any>[];
-    };
-    static forRootAsync(options: IpFilterModuleAsyncOptions): {
-        module: typeof IpFilterCoreModule;
-        imports: (Type<any> | import("@nestjs/common").DynamicModule | Promise<import("@nestjs/common").DynamicModule> | import("@nestjs/common").ForwardReference<any>)[];
-        providers: (Provider<any> | {
-            provide: string;
-            useClass: typeof IpFilterGuard;
-        })[];
-        exports: import("@nestjs/common").FactoryProvider<any>[];
-    };
-    private static createAsyncProviders;
-    private static createAsyncOptionsProvider;
-}

package/dist/ipfilter-core.module.js

@@ -1,87 +0,0 @@
-"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;
-};
-var IpFilterCoreModule_1;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.IpFilterCoreModule = void 0;
-const common_1 = require("@nestjs/common");
-const ipfilter_constants_1 = require("./ipfilter.constants");
-const ipfilter_providers_1 = require("./ipfilter.providers");
-const ipfilter_service_1 = require("./ipfilter.service");
-const core_1 = require("@nestjs/core");
-const ipfilter_guard_1 = require("./ipfilter.guard");
-let IpFilterCoreModule = IpFilterCoreModule_1 = class IpFilterCoreModule {
-    static forRoot(options) {
-        const ipFilterServiceProvider = (0, ipfilter_providers_1.createIpFilterProviders)(options);
-        const ipFilterGuardProvider = {
-            provide: core_1.APP_GUARD,
-            useClass: ipfilter_guard_1.IpFilterGuard,
-        };
-        return {
-            module: IpFilterCoreModule_1,
-            providers: [ipFilterGuardProvider, ipFilterServiceProvider],
-            exports: [ipFilterServiceProvider],
-        };
-    }
-    static forRootAsync(options) {
-        const provider = {
-            inject: [ipfilter_constants_1.IPFILTER_MODULE_OPTIONS],
-            provide: ipfilter_constants_1.IPFILTER_TOKEN,
-            useFactory: (options) => new ipfilter_service_1.IpFilterService(options),
-        };
-        const ipFilterGuardProvider = {
-            provide: core_1.APP_GUARD,
-            useClass: ipfilter_guard_1.IpFilterGuard,
-        };
-        return {
-            module: IpFilterCoreModule_1,
-            imports: options.imports,
-            providers: [
-                ...this.createAsyncProviders(options),
-                ipFilterGuardProvider,
-                provider,
-            ],
-            exports: [provider],
-        };
-    }
-    static createAsyncProviders(options) {
-        if (options.useExisting || options.useFactory) {
-            return [this.createAsyncOptionsProvider(options)];
-        }
-        const useClass = options.useClass;
-        return [
-            this.createAsyncOptionsProvider(options),
-            {
-                provide: useClass,
-                useClass,
-            },
-        ];
-    }
-    static createAsyncOptionsProvider(options) {
-        if (options.useFactory) {
-            return {
-                inject: options.inject || [],
-                provide: ipfilter_constants_1.IPFILTER_MODULE_OPTIONS,
-                useFactory: options.useFactory,
-            };
-        }
-        const inject = [
-            (options.useClass || options.useExisting),
-        ];
-        return {
-            provide: ipfilter_constants_1.IPFILTER_MODULE_OPTIONS,
-            useFactory: async (optionsFactory) => await optionsFactory.createIpFilterModuleOptions(),
-            inject,
-        };
-    }
-};
-IpFilterCoreModule = IpFilterCoreModule_1 = __decorate([
-    (0, common_1.Global)(),
-    (0, common_1.Module)({})
-], IpFilterCoreModule);
-exports.IpFilterCoreModule = IpFilterCoreModule;
-//# sourceMappingURL=ipfilter-core.module.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"ipfilter-core.module.js","sourceRoot":"","sources":["../lib/ipfilter-core.module.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,2CAAgE;AAMhE,6DAA+E;AAC/E,6DAA+D;AAC/D,yDAAqD;AACrD,uCAAyC;AACzC,qDAAiD;AAIjD,IAAa,kBAAkB,0BAA/B,MAAa,kBAAkB;IAC7B,MAAM,CAAC,OAAO,CAAC,OAA8B;QAC3C,MAAM,uBAAuB,GAAG,IAAA,4CAAuB,EAAC,OAAO,CAAC,CAAC;QACjE,MAAM,qBAAqB,GAAG;YAC5B,OAAO,EAAE,gBAAS;YAClB,QAAQ,EAAE,8BAAa;SACxB,CAAC;QAEF,OAAO;YACL,MAAM,EAAE,oBAAkB;YAC1B,SAAS,EAAE,CAAC,qBAAqB,EAAE,uBAAuB,CAAC;YAC3D,OAAO,EAAE,CAAC,uBAAuB,CAAC;SACnC,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,YAAY,CAAC,OAAmC;QACrD,MAAM,QAAQ,GAAa;YACzB,MAAM,EAAE,CAAC,4CAAuB,CAAC;YACjC,OAAO,EAAE,mCAAc;YACvB,UAAU,EAAE,CAAC,OAA8B,EAAE,EAAE,CAC7C,IAAI,kCAAe,CAAC,OAAO,CAAC;SAC/B,CAAC;QACF,MAAM,qBAAqB,GAAG;YAC5B,OAAO,EAAE,gBAAS;YAClB,QAAQ,EAAE,8BAAa;SACxB,CAAC;QAEF,OAAO;YACL,MAAM,EAAE,oBAAkB;YAC1B,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,SAAS,EAAE;gBACT,GAAG,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC;gBACrC,qBAAqB;gBACrB,QAAQ;aACT;YACD,OAAO,EAAE,CAAC,QAAQ,CAAC;SACpB,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,oBAAoB,CACjC,OAAmC;QAEnC,IAAI,OAAO,CAAC,WAAW,IAAI,OAAO,CAAC,UAAU,EAAE;YAC7C,OAAO,CAAC,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,CAAC,CAAC;SACnD;QAED,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAwC,CAAC;QAElE,OAAO;YACL,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC;YACxC;gBACE,OAAO,EAAE,QAAQ;gBACjB,QAAQ;aACT;SACF,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,0BAA0B,CACvC,OAAmC;QAEnC,IAAI,OAAO,CAAC,UAAU,EAAE;YACtB,OAAO;gBACL,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,EAAE;gBAC5B,OAAO,EAAE,4CAAuB;gBAChC,UAAU,EAAE,OAAO,CAAC,UAAU;aAC/B,CAAC;SACH;QAED,MAAM,MAAM,GAAG;YACb,CAAC,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,WAAW,CAAiC;SAC1E,CAAC;QAEF,OAAO;YACL,OAAO,EAAE,4CAAuB;YAChC,UAAU,EAAE,KAAK,EAAE,cAAsC,EAAE,EAAE,CAC3D,MAAM,cAAc,CAAC,2BAA2B,EAAE;YACpD,MAAM;SACP,CAAC;IACJ,CAAC;CACF,CAAA;AA/EY,kBAAkB;IAF9B,IAAA,eAAM,GAAE;IACR,IAAA,eAAM,EAAC,EAAE,CAAC;GACE,kBAAkB,CA+E9B;AA/EY,gDAAkB"}

package/dist/ipfilter.providers.d.ts

@@ -1,3 +0,0 @@
-import { Provider } from '@nestjs/common';
-import { IpFilterModuleOptions } from './ipfilter.interface';
-export declare function createIpFilterProviders(options: IpFilterModuleOptions): Provider;

package/dist/ipfilter.providers.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createIpFilterProviders = void 0;
-const ipfilter_constants_1 = require("./ipfilter.constants");
-const ipfilter_service_1 = require("./ipfilter.service");
-function createIpFilterProviders(options) {
-    return {
-        provide: ipfilter_constants_1.IPFILTER_TOKEN,
-        useValue: new ipfilter_service_1.IpFilterService(options),
-    };
-}
-exports.createIpFilterProviders = createIpFilterProviders;
-//# sourceMappingURL=ipfilter.providers.js.map

package/dist/ipfilter.providers.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ipfilter.providers.js","sourceRoot":"","sources":["../lib/ipfilter.providers.ts"],"names":[],"mappings":";;;AAEA,6DAAsD;AACtD,yDAAqD;AAErD,SAAgB,uBAAuB,CACrC,OAA8B;IAE9B,OAAO;QACL,OAAO,EAAE,mCAAc;QACvB,QAAQ,EAAE,IAAI,kCAAe,CAAC,OAAO,CAAC;KACvC,CAAC;AACJ,CAAC;AAPD,0DAOC"}

package/lib/ipfilter-core.module.ts

@@ -1,94 +0,0 @@
-import { Global, Module, Provider, Type } from '@nestjs/common';
-import {
-  IpFilterModuleAsyncOptions,
-  IpFilterModuleOptions,
-  IpFilterOptionsFactory,
-} from './ipfilter.interface';
-import { IPFILTER_MODULE_OPTIONS, IPFILTER_TOKEN } from './ipfilter.constants';
-import { createIpFilterProviders } from './ipfilter.providers';
-import { IpFilterService } from './ipfilter.service';
-import { APP_GUARD } from '@nestjs/core';
-import { IpFilterGuard } from './ipfilter.guard';
-
-@Global()
-@Module({})
-export class IpFilterCoreModule {
-  static forRoot(options: IpFilterModuleOptions) {
-    const ipFilterServiceProvider = createIpFilterProviders(options);
-    const ipFilterGuardProvider = {
-      provide: APP_GUARD,
-      useClass: IpFilterGuard,
-    };
-
-    return {
-      module: IpFilterCoreModule,
-      providers: [ipFilterGuardProvider, ipFilterServiceProvider],
-      exports: [ipFilterServiceProvider],
-    };
-  }
-
-  static forRootAsync(options: IpFilterModuleAsyncOptions) {
-    const provider: Provider = {
-      inject: [IPFILTER_MODULE_OPTIONS],
-      provide: IPFILTER_TOKEN,
-      useFactory: (options: IpFilterModuleOptions) =>
-        new IpFilterService(options),
-    };
-    const ipFilterGuardProvider = {
-      provide: APP_GUARD,
-      useClass: IpFilterGuard,
-    };
-
-    return {
-      module: IpFilterCoreModule,
-      imports: options.imports,
-      providers: [
-        ...this.createAsyncProviders(options),
-        ipFilterGuardProvider,
-        provider,
-      ],
-      exports: [provider],
-    };
-  }
-
-  private static createAsyncProviders(
-    options: IpFilterModuleAsyncOptions,
-  ): Provider[] {
-    if (options.useExisting || options.useFactory) {
-      return [this.createAsyncOptionsProvider(options)];
-    }
-
-    const useClass = options.useClass as Type<IpFilterOptionsFactory>;
-
-    return [
-      this.createAsyncOptionsProvider(options),
-      {
-        provide: useClass,
-        useClass,
-      },
-    ];
-  }
-
-  private static createAsyncOptionsProvider(
-    options: IpFilterModuleAsyncOptions,
-  ): Provider {
-    if (options.useFactory) {
-      return {
-        inject: options.inject || [],
-        provide: IPFILTER_MODULE_OPTIONS,
-        useFactory: options.useFactory,
-      };
-    }
-
-    const inject = [
-      (options.useClass || options.useExisting) as Type<IpFilterOptionsFactory>,
-    ];
-
-    return {
-      provide: IPFILTER_MODULE_OPTIONS,
-      useFactory: async (optionsFactory: IpFilterOptionsFactory) =>
-        await optionsFactory.createIpFilterModuleOptions(),
-      inject,
-    };
-  }
-}

package/lib/ipfilter.providers.ts

@@ -1,13 +0,0 @@
-import { Provider } from '@nestjs/common';
-import { IpFilterModuleOptions } from './ipfilter.interface';
-import { IPFILTER_TOKEN } from './ipfilter.constants';
-import { IpFilterService } from './ipfilter.service';
-
-export function createIpFilterProviders(
-  options: IpFilterModuleOptions,
-): Provider {
-  return {
-    provide: IPFILTER_TOKEN,
-    useValue: new IpFilterService(options),
-  };
-}