Initial commit

.eslintrc.js

@@ -0,0 +1,25 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: 'tsconfig.json',
+    tsconfigRootDir : __dirname, 
+    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/workflows/npm-publish.yml

@@ -0,0 +1,34 @@
+name: Node.js Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  publish-gpr:
+    runs-on: ubuntu-latest
+    permissions:
+      actions: write
+      contents: write
+      deployments: write
+      packages: write
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          registry-url: https://npm.pkg.github.com/
+          scope: '@goapptiv'
+      - name: Log in to registry
+        run: echo "//npm.pkg.github.com/:_authToken=${{ secrets.GITHUB_TOKEN }}" >> .npmrc
+      - name: Install Packages
+        run: npm install
+      - name: Install Packages
+        run: npm install
+      - name: Build Package
+        run: npm run build
+      - name: Publish Library
+        run: npm publish
+
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -0,0 +1,38 @@
+# compiled output
+/dist
+/node_modules
+
+# Logs
+logs
+*.log
+npm-debug.log*
+pnpm-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
+
+# environment
+.env

.prettierrc

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

README.md

@@ -0,0 +1,46 @@
+# GoApptiv Slack Helper NestJS
+
+This package provides additional utility functions for Slack like automatically sending exception message to slack on exception and many more features to come
+
+## Installation
+
+1. Create a `.npmrc` in the root folder and add the following lines.
+
+```bash
+//npm.pkg.github.com/:_authToken=TOKEN
+@goapptiv:registry=https://npm.pkg.github.com/
+```
+
+2. Create a personal token with **read:packages** permission and replace the `TOKEN` with your personal token in the above mentioned file.
+
+3. Install the package using the following command
+
+```bash
+npm install @goapptiv/slack-helper-nestjs
+```
+
+4. Register the SlackHelperModule in your root module
+
+```ts
+SlackHelperModule.registerAsync({
+  imports: [AppConfigModule],
+  useFactory: (appConfigService: AppConfigService) => ({
+    logger: new Logger(SlackHelperModule.name), // <--- This field is optional, if not provided it will take the Logger from nestjs/common
+    appEnv: appConfigService.appEnvironment,
+    channels: {
+      default: 'general',
+      general: 'general',
+      exceptions: 'exception',
+    },
+  }),
+  inject: [AppConfigService],
+});
+```
+
+5. Pass eventEmitter
+
+This package internally uses @goapptiv/exception-handler, so make sure to pass the eventEmitter to exception-handler filters.
+
+## Usage
+
+It does everything automatically!

nest-cli.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://json.schemastore.org/nest-cli",
+  "collection": "@nestjs/schematics",
+  "sourceRoot": "src"
+}