@edirect/dynamics 11.0.40 → 11.0.41

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.md +27 -9
  2. package/dist/README.md +27 -9
  3. package/dist/package.json +3 -3
  4. package/package.json +5 -5
package/README.md CHANGED
@@ -1,17 +1,24 @@
1
1
  # @edirect/dynamics
2
2
 
3
- The EDirectInsure Dynamics Module.
3
+ Dynamics integration module for Edirect applications. Provides services and utilities to interact with Microsoft Dynamics APIs, including authentication, data posting, and configuration.
4
+
5
+ ## Features
6
+
7
+ - Handles OAuth2 authentication with Dynamics
8
+ - Provides service for posting and retrieving data
9
+ - Integrates with NestJS and Edirect config modules
4
10
 
5
11
  ## Installation
6
12
 
7
- ```shell
8
- $ npm i --save @edirect/dynamics
13
+ ```bash
14
+ npm install @edirect/dynamics
9
15
  ```
10
16
 
11
17
  ## Usage
12
18
 
13
- ```yml
14
- # .YOUR_ENVIRONMENT.env
19
+ Add the following environment variables to your .env file:
20
+
21
+ ```env
15
22
  DYNAMICS_TOKEN_URL="https://login.windows.net/YOUR_TENANT/oauth2/token"
16
23
  DYNAMICS_CLIENT_ID="YOUR_CLIENT_ID"
17
24
  DYNAMICS_USER_NAME="YOUR_USER_NAME"
@@ -20,8 +27,9 @@ DYNAMICS_RESOURCE="YOUR_RESOURCE_URL"
20
27
  DYNAMICS_ENABLED="true/false"
21
28
  ```
22
29
 
23
- ```ts
24
- // app.module.ts
30
+ Import and register the module in your app:
31
+
32
+ ```typescript
25
33
  import { Module } from '@nestjs/common';
26
34
  import { DynamicsModule } from '@edirect/dynamics';
27
35
 
@@ -32,8 +40,9 @@ import { DynamicsModule } from '@edirect/dynamics';
32
40
  export class AppModule {}
33
41
  ```
34
42
 
35
- ```ts
36
- // cats.controller.ts
43
+ Use the service in your controllers:
44
+
45
+ ```typescript
37
46
  import { Controller } from '@nestjs/common';
38
47
  import { DynamicsService } from '@edirect/dynamics';
39
48
 
@@ -48,3 +57,12 @@ export class CatsController {
48
57
  }
49
58
  }
50
59
  ```
60
+
61
+ ## Environment Variables
62
+
63
+ - `DYNAMICS_TOKEN_URL`: OAuth2 token endpoint for Dynamics
64
+ - `DYNAMICS_CLIENT_ID`: Client ID for authentication
65
+ - `DYNAMICS_USER_NAME`: Username for Dynamics
66
+ - `DYNAMICS_PASSWORD`: Password for Dynamics
67
+ - `DYNAMICS_RESOURCE`: Resource URL for Dynamics API
68
+ - `DYNAMICS_ENABLED`: Enable/disable Dynamics integration
package/dist/README.md CHANGED
@@ -1,17 +1,24 @@
1
1
  # @edirect/dynamics
2
2
 
3
- The EDirectInsure Dynamics Module.
3
+ Dynamics integration module for Edirect applications. Provides services and utilities to interact with Microsoft Dynamics APIs, including authentication, data posting, and configuration.
4
+
5
+ ## Features
6
+
7
+ - Handles OAuth2 authentication with Dynamics
8
+ - Provides service for posting and retrieving data
9
+ - Integrates with NestJS and Edirect config modules
4
10
 
5
11
  ## Installation
6
12
 
7
- ```shell
8
- $ npm i --save @edirect/dynamics
13
+ ```bash
14
+ npm install @edirect/dynamics
9
15
  ```
10
16
 
11
17
  ## Usage
12
18
 
13
- ```yml
14
- # .YOUR_ENVIRONMENT.env
19
+ Add the following environment variables to your .env file:
20
+
21
+ ```env
15
22
  DYNAMICS_TOKEN_URL="https://login.windows.net/YOUR_TENANT/oauth2/token"
16
23
  DYNAMICS_CLIENT_ID="YOUR_CLIENT_ID"
17
24
  DYNAMICS_USER_NAME="YOUR_USER_NAME"
@@ -20,8 +27,9 @@ DYNAMICS_RESOURCE="YOUR_RESOURCE_URL"
20
27
  DYNAMICS_ENABLED="true/false"
21
28
  ```
22
29
 
23
- ```ts
24
- // app.module.ts
30
+ Import and register the module in your app:
31
+
32
+ ```typescript
25
33
  import { Module } from '@nestjs/common';
26
34
  import { DynamicsModule } from '@edirect/dynamics';
27
35
 
@@ -32,8 +40,9 @@ import { DynamicsModule } from '@edirect/dynamics';
32
40
  export class AppModule {}
33
41
  ```
34
42
 
35
- ```ts
36
- // cats.controller.ts
43
+ Use the service in your controllers:
44
+
45
+ ```typescript
37
46
  import { Controller } from '@nestjs/common';
38
47
  import { DynamicsService } from '@edirect/dynamics';
39
48
 
@@ -48,3 +57,12 @@ export class CatsController {
48
57
  }
49
58
  }
50
59
  ```
60
+
61
+ ## Environment Variables
62
+
63
+ - `DYNAMICS_TOKEN_URL`: OAuth2 token endpoint for Dynamics
64
+ - `DYNAMICS_CLIENT_ID`: Client ID for authentication
65
+ - `DYNAMICS_USER_NAME`: Username for Dynamics
66
+ - `DYNAMICS_PASSWORD`: Password for Dynamics
67
+ - `DYNAMICS_RESOURCE`: Resource URL for Dynamics API
68
+ - `DYNAMICS_ENABLED`: Enable/disable Dynamics integration
package/dist/package.json CHANGED
@@ -19,15 +19,15 @@
19
19
  "@edirect/config": "^11.0.40",
20
20
  "@nestjs/axios": "^4.0.1",
21
21
  "@nestjs/common": "^11.1.12",
22
- "axios": "^1.13.2",
23
- "lodash": "^4.17.21",
22
+ "axios": "^1.13.3",
23
+ "lodash": "^4.17.23",
24
24
  "tslib": "^2.8.1"
25
25
  },
26
26
  "devDependencies": {
27
27
  "@types/express": "^5.0.6",
28
28
  "@types/jest": "30.0.0",
29
29
  "@types/lodash": "4.17.23",
30
- "@types/node": "^25.0.9"
30
+ "@types/node": "^25.0.10"
31
31
  },
32
32
  "type": "commonjs"
33
33
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@edirect/dynamics",
3
- "version": "11.0.40",
3
+ "version": "11.0.41",
4
4
  "packageScope": "@edirect",
5
5
  "main": "./dist/src/index.js",
6
6
  "types": "./dist/src/index.d.ts",
@@ -19,16 +19,16 @@
19
19
  "dependencies": {
20
20
  "@nestjs/axios": "^4.0.1",
21
21
  "@nestjs/common": "^11.1.12",
22
- "axios": "^1.13.2",
23
- "lodash": "^4.17.21",
22
+ "axios": "^1.13.3",
23
+ "lodash": "^4.17.23",
24
24
  "tslib": "^2.8.1",
25
- "@edirect/config": "11.0.40"
25
+ "@edirect/config": "11.0.41"
26
26
  },
27
27
  "devDependencies": {
28
28
  "@types/express": "^5.0.6",
29
29
  "@types/jest": "30.0.0",
30
30
  "@types/lodash": "4.17.23",
31
- "@types/node": "^25.0.9"
31
+ "@types/node": "^25.0.10"
32
32
  },
33
33
  "nx": {
34
34
  "name": "@edirect/dynamics",