@defra-fish/dynamics-lib 1.73.0-rc.0 → 1.73.0-rc.2

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 (2) hide show
  1. package/README.md +15 -15
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -5,21 +5,21 @@ shared by the different packages which comprise the Rod Licensing digital servic
5
5
 
6
6
  # Environment variables
7
7
 
8
- | name | description | required | default | valid | notes |
9
- | ------------------------ | ---------------------------------------------------------------- | :------: | -------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------- |
10
- | NODE_ENV | Node environment | no | | development, test, production | |
11
- | REDIS_HOST | Hostname of the redis instance used to cache reference data | no | | | If undefined, local memory will be used for caching |
12
- | REDIS_PORT | Port number of the redis instance used to cache reference data | no | 6379 | | |
13
- | REDIS_PASSWORD | Password used to authenticate with the configured redis instance | no | | | If undefined, authentication will not be attempted |
14
- | OAUTH_CLIENT_ID | OAuth 2.0 client ID for client credentials flow | yes | 4000 | | |
15
- | OAUTH_CLIENT_SECRET | OAuth 2.0 client secret for client credentials flow | yes | | | |
16
- | OAUTH_AUTHORITY_HOST_URL | OAuth 2.0 authority host | yes | | | |
17
- | OAUTH_TENANT | OAuth 2.0 tenant | yes | | | |
18
- | OAUTH_SCOPE | OAuth 2.0 scope to request (client credentials resource) | yes | | | |
19
- | DYNAMICS_API_PATH | Full URL to the dynamics API | yes | | | The full URL to the dynamics web api. e.g. https://dynamics-server/api/data/v9.1/ |
20
- | DYNAMICS_API_VERSION | The version of the Dynamics API | yes | | | The version of the dynamics web api. e.g. 9.1 |
21
- | DYNAMICS_API_TIMEOUT | The Dynamics API request timeout | no | 90000 | | The time in milliseconds after which requests will timeout if Dynamics does not return a response, e.g. 90000 |
22
- | DYNAMICS_CACHE_TTL | Default TTL for cached operations | no | 12 hours | | The default TTL for cached operations. Specified in seconds. |
8
+ | name | description | required | default | valid | notes |
9
+ | ------------------------ | ---------------------------------------------------------------- | :------: | -------- | ---------------------- | ------------------------------------------------------------------------------------------------------------- |
10
+ | NODE_ENV | Node environment | no | | development, fsh-{env} | |
11
+ | REDIS_HOST | Hostname of the redis instance used to cache reference data | no | | | If undefined, local memory will be used for caching |
12
+ | REDIS_PORT | Port number of the redis instance used to cache reference data | no | 6379 | | |
13
+ | REDIS_PASSWORD | Password used to authenticate with the configured redis instance | no | | | If undefined, authentication will not be attempted |
14
+ | OAUTH_CLIENT_ID | OAuth 2.0 client ID for client credentials flow | yes | 4000 | | |
15
+ | OAUTH_CLIENT_SECRET | OAuth 2.0 client secret for client credentials flow | yes | | | |
16
+ | OAUTH_AUTHORITY_HOST_URL | OAuth 2.0 authority host | yes | | | |
17
+ | OAUTH_TENANT | OAuth 2.0 tenant | yes | | | |
18
+ | OAUTH_SCOPE | OAuth 2.0 scope to request (client credentials resource) | yes | | | |
19
+ | DYNAMICS_API_PATH | Full URL to the dynamics API | yes | | | The full URL to the dynamics web api. e.g. https://dynamics-server/api/data/v9.1/ |
20
+ | DYNAMICS_API_VERSION | The version of the Dynamics API | yes | | | The version of the dynamics web api. e.g. 9.1 |
21
+ | DYNAMICS_API_TIMEOUT | The Dynamics API request timeout | no | 90000 | | The time in milliseconds after which requests will timeout if Dynamics does not return a response, e.g. 90000 |
22
+ | DYNAMICS_CACHE_TTL | Default TTL for cached operations | no | 12 hours | | The default TTL for cached operations. Specified in seconds. |
23
23
 
24
24
  # Prerequisites
25
25
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@defra-fish/dynamics-lib",
3
- "version": "1.73.0-rc.0",
3
+ "version": "1.73.0-rc.2",
4
4
  "description": "Framework to support integration with dynamics",
5
5
  "type": "module",
6
6
  "engines": {
@@ -43,5 +43,5 @@
43
43
  "simple-oauth2": "4.3.0",
44
44
  "uuid": "8.3.2"
45
45
  },
46
- "gitHead": "d3c761fbc6233011a3ef052ddd37283a57e3db9e"
46
+ "gitHead": "4af1022c2c39f20e07f6f26737d2cd01a038a76a"
47
47
  }