#3 - Create publish workflow

.github/workflows/publish.yml

@@ -0,0 +1,26 @@
+name: "Publish package"
+
+on:
+  release:
+    types:
+      - "published"
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: "Checkout"
+        uses: actions/checkout@v3
+      - name: "Use Node.js"
+        uses: actions/setup-node@v3
+        with:
+          node-version: 14
+          cache: "npm"
+      - name: "Install packages"
+        run: npm install
+      - name: "Build package"
+        run: npm run build
+      - name: "Publish package"
+        run: npm publish
+        with:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/tests.yml

@@ -2,7 +2,11 @@ name: "Test package"
 
 on:
   pull_request:
-    branches: [master]
+    branches:
+      - "master"
+    types:
+      - "opened"
+      - "synchronize"
 
 jobs:
   test:

README.md

@@ -6,21 +6,20 @@ NodeJS Auth0 wrapper for Nestjs
 
 ## Install
 ```bash
-npm install @twirelab/nestjs-auth0
+npm i @twirelab/nestjs-auth0 auth0
+npm i -D @types/auth0
 ```
 
 or
 
 ```bash
-yarn install @twirelab/nestjs-auth0
+yarn add @twirelab/nestjs-auth0 auth0
+yarn add -D @types/auth0
 ```
 
-## Usage
-
-### Authentication Client
+## Authentication Client
 
 Add below code into app.module.js file.
-
 ```typescript
 import { AuthenticationModule } from "@twirelab/nestjs-auth0";
 
@@ -36,10 +35,25 @@ import { AuthenticationModule } from "@twirelab/nestjs-auth0";
 export class AppModule {}
 ```
 
-### Management Client
+Now you can inject authentication client into your services, for example:
+```typescript
+import { Injectable } from '@nestjs/common';
+import { InjectAuthentication } from "@twirelab/nestjs-auth0";
+import { AuthenticationClient, TokenResponse } from "auth0";
+
+@Injectable()
+export class AppService {
+  constructor(@InjectAuthentication() private readonly authentication: AuthenticationClient) { }
+
+  async getCredentialsGrant(): Promise<TokenResponse> {
+    return await this.authentication.clientCredentialsGrant({ audience: "..." });
+  }
+}
+```
 
-Add below code into app.module.js file.
+## Management Client
 
+Add below code into app.module.js file.
 ```typescript
 import { ManagementModule } from "@twirelab/nestjs-auth0";
 
@@ -54,6 +68,22 @@ import { ManagementModule } from "@twirelab/nestjs-auth0";
 export class AppModule {}
 ```
 
+Now you can inject management client into your services, for example:
+```typescript
+import { Injectable } from "@nestjs/common";
+import { InjectManagement } from "@twirelab/nestjs-auth0";
+import { ManagementClient, User } from "auth0";
+
+@Injectable()
+export class AppService {
+  constructor(@InjectManagement() private readonly management: ManagementClient) { }
+
+  async getUsers(): Promise<User[]> {
+    return await this.management.getUsers();
+  }
+}
+```
+
 To obtain **automatically** a Management API token via the ManagementClient, you can specify the parameters `clientId`, `clientSecret` (use a Non Interactive Client) and optionally `scope`. Behind the scenes the Client Credentials Grant is used to obtain the `access_token` and is by default cached for the duration of the returned `expires_in` value.
 
 ```typescript

package.json

@@ -1,11 +1,14 @@
 {
   "name": "@twirelab/nestjs-auth0",
-  "version": "0.1.4",
+  "version": "0.2.0",
   "description": "",
   "main": "lib/index.js",
   "private": false,
   "types": "lib/index.d.ts",
-  "author": "Twirelab",
+  "author": {
+    "name": "Twirelab",
+    "email": "contact@twirelab.com"
+  },
   "license": "MIT",
   "scripts": {
     "clean": "rimraf lib",
@@ -28,6 +31,8 @@
     "auth0",
     "authentication",
     "management",
+    "nodejs",
+    "express",
     "app",
     "wrapper",
     "client"
@@ -55,4 +60,4 @@
     "@nestjs/common": "^8.0.0",
     "@nestjs/core": "^8.0.0"
   }
-}
+}