feat(): nestjs hasher

.commitlintrc.json

@@ -0,0 +1,28 @@
+{
+  "extends": ["@commitlint/config-angular"],
+  "rules": {
+    "subject-case": [
+      2,
+      "always",
+      ["sentence-case", "start-case", "pascal-case", "upper-case", "lower-case"]
+    ],
+    "type-enum": [
+      2,
+      "always",
+      [
+        "build",
+        "chore",
+        "ci",
+        "docs",
+        "feat",
+        "fix",
+        "perf",
+        "refactor",
+        "revert",
+        "style",
+        "test",
+        "sample"
+      ]
+    ]
+  }
+}

.eslintignore

@@ -0,0 +1,4 @@
+src/**/*.test.ts
+src/**/files/**
+test/**
+*.spec.ts

.eslintrc.js

@@ -0,0 +1,24 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: 'tsconfig.json',
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint/eslint-plugin'],
+  extends: [
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+  ],
+  root: true,
+  env: {
+    node: true,
+    jest: true,
+  },
+  ignorePatterns: ['.eslintrc.js'],
+  rules: {
+    '@typescript-eslint/interface-name-prefix': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+  },
+};

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,42 @@
+## PR Checklist
+
+Please check if your PR fulfills the following requirements:
+
+- [ ] The commit message follows our guidelines: https://github.com/themartiangeeks/nest-hasher/blob/main/CONTRIBUTING.md
+- [ ] Tests for the changes have been added (for bug fixes / features)
+- [ ] Docs have been added / updated (for bug fixes / features)
+
+## PR Type
+
+What kind of change does this PR introduce?
+
+<!-- Please check the one that applies to this PR using "x". -->
+
+```
+[ ] Bugfix
+[ ] Feature
+[ ] Code style update (formatting, local variables)
+[ ] Refactoring (no functional changes, no api changes)
+[ ] Build related changes
+[ ] CI related changes
+[ ] Other... Please describe:
+```
+
+## What is the current behavior?
+
+<!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->
+
+Issue Number: N/A
+
+## What is the new behavior?
+
+## Does this PR introduce a breaking change?
+
+```
+[ ] Yes
+[ ] No
+```
+
+<!-- If this PR contains a breaking change, please describe the impact and migration path for existing applications below. -->
+
+## Other information

.github/workflows/publisher.yml

@@ -0,0 +1,35 @@
+name: PUBLISH PACKAGE
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - name: Checkout source code
+        uses: actions/checkout@v2
+
+      - name: Use NodeJS v12
+        uses: actions/setup-node@v2
+        with:
+          node-version: '12.x'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Build project
+        run: npm run build
+
+      - name: Build index.ts file
+        run: tsc index.ts -d
+
+      - name: Publish package
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GH_TOKEN }}

.github/workflows/release.yml

@@ -0,0 +1,25 @@
+name: RELEASER
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  Realeaser:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout source code
+        uses: actions/checkout@v2
+
+      - name: Use NodeJS v16
+        uses: actions/setup-node@v1
+        with:
+          node-version: 16
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Create new release
+        env:
+          GH_TOKEN: ${{secrets.GH_TOKEN}}
+        run: npx semantic-release

.gitignore

@@ -0,0 +1,34 @@
+# compiled output
+/dist
+/node_modules
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# OS
+.DS_Store
+
+# Tests
+/coverage
+/.nyc_output
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx --no-install commitlint --edit ""

.husky/pre-commit

@@ -0,0 +1,5 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged
+npm run lint

.prettierrc

@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all"
+}

.releaserc.js

@@ -0,0 +1,22 @@
+module.exports = {
+  plugins: [
+    '@semantic-release/commit-analyzer',
+    '@semantic-release/github',
+    [
+      '@semantic-release/npm',
+      {
+        npmPublish: false,
+      },
+    ],
+    ['@semantic-release/release-notes-generator'],
+    [
+      '@semantic-release/git',
+      {
+        assets: ['package.json'],
+        message: 'chore(release): release ${nextRelease.version}',
+      },
+    ],
+  ],
+  branches: ['main'],
+  preset: 'angular',
+};

CONTRIBUTING.md

@@ -0,0 +1,12 @@
+# Contributing to NestJS Hasher
+
+We would love for you to contribute to NestJS Hasher and help make it even better than it is
+today! As a contributor, here are the guidelines we would like you to follow:
+
+- [Code of Conduct](#coc)
+- [Question or Problem?](#question)
+- [Issues and Bugs](#issue)
+- [Feature Requests](#feature)
+- [Submission Guidelines](#submit)
+- [Coding Rules](#rules)
+- [Commit Message Guidelines](#commit)

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 The Martian Geeks
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,49 @@
+# Nestjs Hasher
+
+NestJS Hasher, is a module that combines several hash libraries into one such as _bcrypt_ and _argon_.
+You can use them separately, without affecting anything. This library works only with the [NestJS](https://nestjs.com/) framework.
+
+## Installation
+
+To use the library you must execute the command below in your project.
+
+```bash
+$ npm install @sinuos/nestjs-hasher
+```
+
+## Usage
+
+To use this library, you must declare the module in `AppModule`
+
+### Bcrypt
+
+```typescript
+import { Module } from '@nestjs/common';
+import { NestjsHasherModule } from 'nestjs-hasher';
+
+@Module({
+  imports: [
+    NestjsHasherModule.register({
+      provider: 'bcrypt',
+      round: 10,
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+### Argon
+
+```typescript
+import { Module } from '@nestjs/common';
+import { NestjsHasherModule } from 'nestjs-hasher';
+
+@Module({
+  imports: [
+    NestjsHasherModule.register({
+      provider: 'argon',
+    }),
+  ],
+})
+export class AppModule {}
+```

index.d.ts

@@ -0,0 +1 @@
+export * from './dist';

index.js

@@ -0,0 +1,26 @@
+'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];
+          },
+        });
+      }
+    : function (o, m, k, k2) {
+        if (k2 === undefined) k2 = k;
+        o[k2] = m[k];
+      });
+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);
+  };
+exports.__esModule = true;
+__exportStar(require('./dist'), exports);

index.ts

@@ -0,0 +1 @@
+export * from './dist';

lib/constants/index.ts

@@ -0,0 +1 @@
+export * from './provider.constant';

lib/constants/provider.constant.ts

@@ -0,0 +1,2 @@
+/** @const HASHER_CONFIG */
+export const HASHER_CONFIG = 'HASHER_CONFIG';

lib/exceptions/index.ts

@@ -0,0 +1 @@
+export * from './nestjs-hasher.exception';

lib/exceptions/nestjs-hasher.exception.ts

@@ -0,0 +1,13 @@
+/**
+ * @class NestjsHasherException
+ * @extends Error
+ */
+export class NestjsHasherException extends Error {
+  /**
+   * @constructor
+   * @param message
+   */
+  constructor(message: string) {
+    super(message);
+  }
+}

lib/index.ts

@@ -0,0 +1,2 @@
+export * from './nestjs-hasher.module';
+export * from './nestjs-hasher.service';