feat(index.rts): migrated

Author: Chau Tran

.travis.yml

@@ -0,0 +1,37 @@
+language: node_js
+cache:
+  directories:
+    - ~/.npm
+notifications:
+  email: false
+node_js:
+  - '10'
+  - '11'
+  - '12'
+script:
+  - npm run test
+
+jobs:
+  include:
+    - stage: Production
+      before_script:
+        - npm run build:docs
+      node_js:
+        - '12'
+      name: deploy_docs
+      script: if [ "$TRAVIS_BRANCH" = "master" -a "$TRAVIS_PULL_REQUEST" = "false" ]; then npm run deploy-docs; fi
+    - name: npm_release
+      node_js:
+        - '12'
+      before_script:
+        - npm run build
+      script: if [ "$TRAVIS_BRANCH" = "master" -a "$TRAVIS_PULL_REQUEST" = "false" ]; then npm run semantic-release; fi
+    - name: produce_coverage
+      node_js:
+        - '12'
+      before_script:
+        - npm run test:cov
+      script: if [ "$TRAVIS_BRANCH" = "master" -a "$TRAVIS_PULL_REQUEST" = "false" ]; then npm run report-coverage; fi
+branches:
+  except:
+    - /^v\d+\.\d+\.\d+$/

package.json

@@ -1,6 +1,6 @@
 {
-  "name": "nest-automapper",
-  "version": "0.1.0",
+  "name": "nestjsx-automapper",
+  "version": "0.0.0-development",
   "license": "MIT",
   "author": "Chau Tran",
   "main": "dist/index.js",
@@ -9,16 +9,33 @@
   "files": [
     "dist"
   ],
+  "keywords": [
+    "nestjs",
+    "automapper",
+    "typescript"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/nestjsx/automapper.git"
+  },
+  "engines": {
+    "node": ">=8.0.0"
+  },
   "scripts": {
     "start": "tsdx watch",
     "build": "tsdx build",
-    "test": "tsdx test",
-    "lint": "tsdx lint"
+    "build:docs": "typedoc --out docs --target es6 --theme minimal --mode file src",
+    "test": "tsdx test --no-cache",
+    "test:cov": "tsdx test --coverage",
+    "lint": "tsdx lint src && lint-staged",
+    "commit": "git-cz",
+    "semantic-release": "semantic-release",
+    "deploy-docs": "ts-node tools/gh-pages",
+    "report-coverage": "cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js && rm -rf ./coverage"
   },
-  "peerDependencies": {},
   "husky": {
     "hooks": {
-      "pre-commit": "tsdx lint"
+      "pre-commit": "npm run test && git add . && npm run lint"
     }
   },
   "prettier": {
@@ -27,11 +44,70 @@
     "singleQuote": true,
     "trailingComma": "es5"
   },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "config": {
+    "commitizen": {
+      "path": "node_modules/cz-conventional-changelog"
+    }
+  },
+  "lint-staged": {
+    "{src}/**/*.ts": [
+      "prettier --write",
+      "git add"
+    ]
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "jest": {
+    "transform": {
+      ".(ts|tsx)": "ts-jest"
+    },
+    "testEnvironment": "node",
+    "moduleFileExtensions": [
+      "ts",
+      "tsx",
+      "js"
+    ],
+    "coveragePathIgnorePatterns": [
+      "/node_modules/",
+      "/test/"
+    ],
+    "collectCoverageFrom": [
+      "src/automapper.{js,ts}"
+    ]
+  },
   "devDependencies": {
-    "@types/jest": "^24.0.21",
-    "husky": "^3.0.9",
-    "tsdx": "^0.11.0",
-    "tslib": "^1.10.0",
-    "typescript": "^3.6.4"
+    "@commitlint/cli": "8.2.0",
+    "@commitlint/config-conventional": "8.2.0",
+    "@nestjs/common": "6.8.5",
+    "@nestjs/core": "6.8.5",
+    "@nestjs/testing": "6.8.5",
+    "@types/jest": "24.0.21",
+    "commitizen": "4.0.3",
+    "coveralls": "3.0.7",
+    "cz-conventional-changelog": "3.0.2",
+    "husky": "3.0.9",
+    "lint-staged": "9.4.2",
+    "prettier": "1.18.2",
+    "reflect-metadata": "0.1.13",
+    "semantic-release": "^15.13.30",
+    "shelljs": "0.8.3",
+    "ts-node": "8.4.1",
+    "tsdx": "0.11.0",
+    "tslib": "1.10.0",
+    "typedoc": "0.15.0",
+    "typescript": "3.7.2"
+  },
+  "dependencies": {
+    "@nartc/automapper": "^1.1.8"
+  },
+  "peerDependencies": {
+    "@nestjs/common": "~6.8.5",
+    "reflect-metadata": "~0.1.13"
   }
 }

src/automapper.module.ts

@@ -0,0 +1,54 @@
+import { AutoMapper } from '@nartc/automapper';
+import { DynamicModule, Global, Logger, Module } from '@nestjs/common';
+import { forFeatureProviders, forRootProviders } from './automapper.provider';
+import {
+  AutomapperModuleFeatureOptions,
+  AutomapperModuleRootOptions,
+} from './interfaces';
+
+@Global()
+@Module({})
+export class AutomapperModule {
+  private static readonly logger: Logger = new Logger('AutomapperModule');
+
+  /**
+   * Initialize an AutoMapper instance with a name. Default to "default"
+   *
+   * Generally, `forRoot` only needs to be ran once to provide a singleton for the whole application
+   *
+   * @param {AutomapperModuleRootOptions} options
+   */
+  static forRoot(options?: AutomapperModuleRootOptions): DynamicModule {
+    const mapper = new AutoMapper();
+
+    options && options.config && mapper.initialize(options.config);
+    const providers = forRootProviders(options);
+
+    return {
+      module: AutomapperModule,
+      providers,
+      exports: providers,
+    };
+  }
+
+  /**
+   * Add to the AutoMapper instance a list of MappingProfiles. By default, the instance with name "default" will be
+   * used.
+   *
+   * @param {AutomapperModuleFeatureOptions} options
+   */
+  static forFeature(options: AutomapperModuleFeatureOptions): DynamicModule {
+    if (!options || (options && !options.profiles)) {
+      const message = 'AutomapperModuleFeatureOptions.profiles is empty';
+      this.logger.error(message);
+      throw new Error(message);
+    }
+    const providers = forFeatureProviders(options);
+    return {
+      module: AutomapperModule,
+      imports: [AutomapperModule],
+      providers,
+      exports: providers,
+    };
+  }
+}

src/automapper.provider.ts

@@ -0,0 +1,46 @@
+import { AutoMapper } from '@nartc/automapper';
+import { Provider } from '@nestjs/common';
+import {
+  AutomapperModuleFeatureOptions,
+  AutomapperModuleRootOptions,
+} from './interfaces';
+import { getMapperToken } from './utils/getMapperToken';
+import { MAPPER_MAP, MapperMap } from './utils/mapperMap';
+
+export const forRootProviders = (
+  options?: AutomapperModuleRootOptions
+): Provider[] => {
+  const mapper = new AutoMapper();
+  const token = getMapperToken(options ? options.name : '');
+  !MapperMap.has(token) && MapperMap.set(token, mapper);
+
+  return [
+    {
+      provide: token,
+      useValue: mapper,
+    },
+    {
+      provide: MAPPER_MAP,
+      useValue: MapperMap,
+    },
+  ];
+};
+
+export const forFeatureProviders = (
+  options: AutomapperModuleFeatureOptions
+): Provider[] => {
+  const token = getMapperToken(options ? options.name : '');
+  const mapper = MapperMap.has(token)
+    ? (MapperMap.get(token) as AutoMapper)
+    : new AutoMapper();
+
+  options.profiles.forEach(mapper.addProfile.bind(mapper));
+  !MapperMap.has(token) && MapperMap.set(token, mapper);
+
+  return [
+    {
+      provide: token,
+      useValue: mapper,
+    },
+  ];
+};

src/decorators/index.ts

@@ -0,0 +1 @@
+export * from './inject-mapper.decorator';

src/decorators/inject-mapper.decorator.ts

@@ -0,0 +1,10 @@
+import { Inject } from '@nestjs/common';
+import { getMapperToken } from '../utils/getMapperToken';
+
+/**
+ * Inject the AutoMapper intsance with name.
+ *
+ * @param {string} name - Name of the AutoMapper instance
+ * @default default
+ */
+export const InjectMapper = (name?: string) => Inject(getMapperToken(name));

src/index.ts

@@ -1,6 +1,3 @@
-export const sum = (a: number, b: number) => {
-  if ('development' === process.env.NODE_ENV) {
-    console.log('boop');
-  }
-  return a + b;
-};
+export * from './automapper.module';
+export * from './interfaces';
+export * from './decorators';

src/interfaces/automapper-configuration.interface.ts

@@ -0,0 +1,31 @@
+import { AutoMapperConfiguration, MappingProfile } from '@nartc/automapper';
+
+export interface AutomapperModuleRootOptions {
+  /**
+   * Configuration Function to be ran when initialize a new AutoMapper instance
+   *
+   * @param {AutoMapperConfiguration} cfg
+   */
+  config?: (cfg: AutoMapperConfiguration) => void;
+
+  /**
+   * Name of the AutoMapper instance
+   *
+   * @default default
+   */
+  name?: string;
+}
+
+export interface AutomapperModuleFeatureOptions {
+  /**
+   * An array of MappingProfile to be added to the AutoMapper instance
+   */
+  profiles: Array<MappingProfile>;
+
+  /**
+   * Name of the AutoMapper instance
+   *
+   * @default default
+   */
+  name?: string;
+}

src/interfaces/index.ts

@@ -0,0 +1 @@
+export * from './automapper-configuration.interface';

src/utils/getMapperToken.ts

@@ -0,0 +1,3 @@
+const AUTOMAPPER = 'nestjs__AUTO_MAPPER__';
+export const getMapperToken = (name?: string) =>
+  name ? AUTOMAPPER + name : AUTOMAPPER + 'default';