@edirect/dynamics 11.0.48 → 11.0.50

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 +17 -17
  2. package/dist/README.md +32 -101
  3. package/dist/package.json +6 -6
  4. package/package.json +4 -4
package/README.md CHANGED
@@ -58,7 +58,7 @@ export class PolicySyncService {
58
58
  async createContact(data: object): Promise<object | null> {
59
59
  return this.dynamics.post(
60
60
  'https://yourorg.crm.dynamics.com/api/data/v9.2/contacts',
61
- data
61
+ data,
62
62
  );
63
63
  }
64
64
 
@@ -66,7 +66,7 @@ export class PolicySyncService {
66
66
  async updateContact(id: string, data: object): Promise<object | null> {
67
67
  return this.dynamics.patch(
68
68
  `https://yourorg.crm.dynamics.com/api/data/v9.2/contacts(${id})`,
69
- data
69
+ data,
70
70
  );
71
71
  }
72
72
 
@@ -75,7 +75,7 @@ export class PolicySyncService {
75
75
  return this.dynamics.get(
76
76
  'https://yourorg.crm.dynamics.com/api/data/v9.2/accounts',
77
77
  {},
78
- 'client_credentials'
78
+ 'client_credentials',
79
79
  );
80
80
  }
81
81
  }
@@ -89,11 +89,11 @@ export class PolicySyncService {
89
89
 
90
90
  Performs a GET request to the Dynamics API. Returns `null` if `DYNAMICS_ENABLED` is `false`.
91
91
 
92
- | Parameter | Type | Default | Description |
93
- |-----------|------|---------|-------------|
94
- | `url` | `string` | — | Full Dynamics API endpoint URL |
95
- | `options` | `AxiosRequestConfig` | — | Additional Axios request options |
96
- | `grantType` | `'password' \| 'client_credentials'` | `'password'` | OAuth2 grant type to use |
92
+ | Parameter | Type | Default | Description |
93
+ | ----------- | ------------------------------------ | ------------ | -------------------------------- |
94
+ | `url` | `string` | — | Full Dynamics API endpoint URL |
95
+ | `options` | `AxiosRequestConfig` | — | Additional Axios request options |
96
+ | `grantType` | `'password' \| 'client_credentials'` | `'password'` | OAuth2 grant type to use |
97
97
 
98
98
  #### `post(url, data, options?, grantType?): Promise<object | null>`
99
99
 
@@ -117,15 +117,15 @@ Refreshes the current token. Falls back to `getAccessToken()` on failure.
117
117
 
118
118
  ## Environment Variables
119
119
 
120
- | Variable | Description | Required For |
121
- |----------|-------------|-------------|
122
- | `DYNAMICS_TOKEN_URL` | Azure AD OAuth2 token endpoint | All grant types |
123
- | `DYNAMICS_CLIENT_ID` | Application client ID | All grant types |
124
- | `DYNAMICS_CLIENT_SECRET` | Client secret | `client_credentials` |
125
- | `DYNAMICS_USER_NAME` | Service account username | `password` |
126
- | `DYNAMICS_PASSWORD` | Service account password | `password` |
127
- | `DYNAMICS_RESOURCE` | Dynamics CRM resource URL | All grant types |
128
- | `DYNAMICS_ENABLED` | Set to `'true'` to enable; any other value disables all API calls | All |
120
+ | Variable | Description | Required For |
121
+ | ------------------------ | ----------------------------------------------------------------- | -------------------- |
122
+ | `DYNAMICS_TOKEN_URL` | Azure AD OAuth2 token endpoint | All grant types |
123
+ | `DYNAMICS_CLIENT_ID` | Application client ID | All grant types |
124
+ | `DYNAMICS_CLIENT_SECRET` | Client secret | `client_credentials` |
125
+ | `DYNAMICS_USER_NAME` | Service account username | `password` |
126
+ | `DYNAMICS_PASSWORD` | Service account password | `password` |
127
+ | `DYNAMICS_RESOURCE` | Dynamics CRM resource URL | All grant types |
128
+ | `DYNAMICS_ENABLED` | Set to `'true'` to enable; any other value disables all API calls | All |
129
129
 
130
130
  ## Token Flow
131
131
 
package/dist/README.md CHANGED
@@ -1,137 +1,68 @@
1
1
  # @edirect/dynamics
2
2
 
3
- Microsoft Dynamics 365 integration module for eDirect NestJS applications. Handles OAuth2 token acquisition (password grant and client credentials), automatic token refresh, and provides `get`, `post`, and `patch` methods for Dynamics API calls.
3
+ Dynamics integration module for Edirect applications. Provides services and utilities to interact with Microsoft Dynamics APIs, including authentication, data posting, and configuration.
4
4
 
5
5
  ## Features
6
6
 
7
- - OAuth2 `password` grant and `client_credentials` grant support
8
- - Automatic token caching and refresh (falls back to full re-auth on refresh failure)
9
- - `get`, `post`, `patch` HTTP methods with automatic Bearer token injection
10
- - `DYNAMICS_ENABLED` flag to safely disable all Dynamics calls without removing code
11
- - NestJS module — integrates with `@edirect/config`
7
+ - Handles OAuth2 authentication with Dynamics
8
+ - Provides service for posting and retrieving data
9
+ - Integrates with NestJS and Edirect config modules
12
10
 
13
11
  ## Installation
14
12
 
15
- ```sh
16
- pnpm add @edirect/dynamics
17
- # or
13
+ ```bash
18
14
  npm install @edirect/dynamics
19
15
  ```
20
16
 
21
- ## Setup
17
+ ## Usage
22
18
 
23
- ### 1. Set environment variables
19
+ Add the following environment variables to your .env file:
24
20
 
25
21
  ```env
26
- DYNAMICS_TOKEN_URL=https://login.windows.net/YOUR_TENANT_ID/oauth2/token
27
- DYNAMICS_CLIENT_ID=your-client-id
28
- DYNAMICS_CLIENT_SECRET=your-client-secret # required for client_credentials grant
29
- DYNAMICS_USER_NAME=service@yourorg.onmicrosoft.com # required for password grant
30
- DYNAMICS_PASSWORD=your-dynamics-password # required for password grant
31
- DYNAMICS_RESOURCE=https://yourorg.crm.dynamics.com
32
- DYNAMICS_ENABLED=true
22
+ DYNAMICS_TOKEN_URL="https://login.windows.net/YOUR_TENANT/oauth2/token"
23
+ DYNAMICS_CLIENT_ID="YOUR_CLIENT_ID"
24
+ DYNAMICS_USER_NAME="YOUR_USER_NAME"
25
+ DYNAMICS_PASSWORD="YOUR_DYNAMICS_PASSWORD"
26
+ DYNAMICS_RESOURCE="YOUR_RESOURCE_URL"
27
+ DYNAMICS_ENABLED="true/false"
33
28
  ```
34
29
 
35
- ### 2. Register `DynamicsModule` in your AppModule
30
+ Import and register the module in your app:
36
31
 
37
- ```ts
32
+ ```typescript
38
33
  import { Module } from '@nestjs/common';
39
34
  import { DynamicsModule } from '@edirect/dynamics';
40
35
 
41
36
  @Module({
42
37
  imports: [DynamicsModule],
38
+ ...
43
39
  })
44
40
  export class AppModule {}
45
41
  ```
46
42
 
47
- ### 3. Inject and use `DynamicsService`
43
+ Use the service in your controllers:
48
44
 
49
- ```ts
50
- import { Injectable } from '@nestjs/common';
45
+ ```typescript
46
+ import { Controller } from '@nestjs/common';
51
47
  import { DynamicsService } from '@edirect/dynamics';
52
48
 
53
- @Injectable()
54
- export class PolicySyncService {
55
- constructor(private readonly dynamics: DynamicsService) {}
49
+ @Controller('cats')
50
+ export class CatsController {
51
+ constructor(private readonly dynamicsService: DynamicsService) {}
56
52
 
57
- // POST using password grant (default)
58
- async createContact(data: object): Promise<object | null> {
59
- return this.dynamics.post(
60
- 'https://yourorg.crm.dynamics.com/api/data/v9.2/contacts',
61
- data
62
- );
63
- }
64
-
65
- // PATCH using password grant
66
- async updateContact(id: string, data: object): Promise<object | null> {
67
- return this.dynamics.patch(
68
- `https://yourorg.crm.dynamics.com/api/data/v9.2/contacts(${id})`,
69
- data
70
- );
71
- }
72
-
73
- // GET using client_credentials grant
74
- async getAccounts(): Promise<object | null> {
75
- return this.dynamics.get(
76
- 'https://yourorg.crm.dynamics.com/api/data/v9.2/accounts',
77
- {},
78
- 'client_credentials'
79
- );
53
+ postSomethingToDynamics(): Promise<any> {
54
+ return this.dynamicsService.post('YOUR_URL', {
55
+ YOUR_ATTRIBUTE: 'YOUR_VALUE',
56
+ });
80
57
  }
81
58
  }
82
59
  ```
83
60
 
84
- ## API
85
-
86
- ### `DynamicsService`
87
-
88
- #### `get(url, options?, grantType?): Promise<object | null>`
89
-
90
- Performs a GET request to the Dynamics API. Returns `null` if `DYNAMICS_ENABLED` is `false`.
91
-
92
- | Parameter | Type | Default | Description |
93
- |-----------|------|---------|-------------|
94
- | `url` | `string` | — | Full Dynamics API endpoint URL |
95
- | `options` | `AxiosRequestConfig` | — | Additional Axios request options |
96
- | `grantType` | `'password' \| 'client_credentials'` | `'password'` | OAuth2 grant type to use |
97
-
98
- #### `post(url, data, options?, grantType?): Promise<object | null>`
99
-
100
- Performs a POST request. Returns `null` if `DYNAMICS_ENABLED` is `false`.
101
-
102
- #### `patch(url, data, options?, grantType?): Promise<object | null>`
103
-
104
- Performs a PATCH request. Returns `null` if `DYNAMICS_ENABLED` is `false`.
105
-
106
- #### `getAccessToken(): Promise<ITokenSet>`
107
-
108
- Acquires a token using the `password` grant. Automatically refreshes if expired.
109
-
110
- #### `getAccessTokenByClientCredentials(): Promise<ITokenSet>`
111
-
112
- Acquires a token using `client_credentials` grant.
113
-
114
- #### `getRefreshToken(): Promise<ITokenSet>`
115
-
116
- Refreshes the current token. Falls back to `getAccessToken()` on failure.
117
-
118
61
  ## Environment Variables
119
62
 
120
- | Variable | Description | Required For |
121
- |----------|-------------|-------------|
122
- | `DYNAMICS_TOKEN_URL` | Azure AD OAuth2 token endpoint | All grant types |
123
- | `DYNAMICS_CLIENT_ID` | Application client ID | All grant types |
124
- | `DYNAMICS_CLIENT_SECRET` | Client secret | `client_credentials` |
125
- | `DYNAMICS_USER_NAME` | Service account username | `password` |
126
- | `DYNAMICS_PASSWORD` | Service account password | `password` |
127
- | `DYNAMICS_RESOURCE` | Dynamics CRM resource URL | All grant types |
128
- | `DYNAMICS_ENABLED` | Set to `'true'` to enable; any other value disables all API calls | All |
129
-
130
- ## Token Flow
131
-
132
- ```
133
- 1. First call → acquire token (password or client_credentials)
134
- 2. Subsequent calls → if token not expired, use refresh_token grant
135
- 3. If refresh fails → fall back to full re-authentication
136
- 4. Token is cached in memory (service singleton)
137
- ```
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
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@edirect/dynamics",
3
- "version": "11.0.48",
3
+ "version": "11.0.46",
4
4
  "main": "./dist/src/index.js",
5
5
  "types": "./dist/src/index.d.ts",
6
6
  "exports": {
@@ -16,18 +16,18 @@
16
16
  "dist"
17
17
  ],
18
18
  "dependencies": {
19
- "@edirect/config": "^11.0.48",
19
+ "@edirect/config": "^11.0.46",
20
20
  "@nestjs/axios": "^4.0.1",
21
- "@nestjs/common": "^11.1.15",
22
- "axios": "^1.13.6",
21
+ "@nestjs/common": "^11.1.12",
22
+ "axios": "^1.13.3",
23
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
- "@types/lodash": "4.17.24",
30
- "@types/node": "^25.3.3"
29
+ "@types/lodash": "4.17.23",
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.48",
3
+ "version": "11.0.50",
4
4
  "packageScope": "@edirect",
5
5
  "main": "./dist/src/index.js",
6
6
  "types": "./dist/src/index.d.ts",
@@ -18,17 +18,17 @@
18
18
  ],
19
19
  "dependencies": {
20
20
  "@nestjs/axios": "^4.0.1",
21
- "@nestjs/common": "^11.1.15",
21
+ "@nestjs/common": "^11.1.16",
22
22
  "axios": "^1.13.6",
23
23
  "lodash": "^4.17.23",
24
24
  "tslib": "^2.8.1",
25
- "@edirect/config": "11.0.48"
25
+ "@edirect/config": "11.0.50"
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.24",
31
- "@types/node": "^25.3.3"
31
+ "@types/node": "^25.4.0"
32
32
  },
33
33
  "nx": {
34
34
  "name": "@edirect/dynamics",