@or-sdk/settings 0.25.10-beta.4276.0 → 0.25.10-beta.4281.0
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.
- package/README.md +2 -46
- package/dist/types/Settings.d.ts +0 -110
- package/dist/types/Settings.d.ts.map +1 -1
- package/dist/types/types.d.ts +0 -9
- package/dist/types/types.d.ts.map +1 -1
- package/package.json +2 -9
- package/tsconfig.dev.json +8 -0
- package/tsconfig.esm.json +12 -0
- package/tsconfig.json +7 -0
- package/tsconfig.types.json +11 -0
package/README.md
CHANGED
|
@@ -1,23 +1,9 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
OneReach SDK client for Settings.
|
|
4
|
-
|
|
5
|
-
## When to use
|
|
6
|
-
|
|
7
|
-
- Use this package when integrating with the Settings capability on the OneReach platform.
|
|
8
|
-
- Use its typed client and exported models instead of hand-writing requests to that service.
|
|
9
|
-
|
|
10
|
-
## When not to use
|
|
11
|
-
|
|
12
|
-
- Do not use it for a different platform capability; choose the dedicated `@or-sdk/*` package instead.
|
|
13
|
-
- Do not use it for generic third-party HTTP calls.
|
|
14
|
-
|
|
15
|
-
## Installation
|
|
1
|
+
## Installation:
|
|
16
2
|
```
|
|
17
3
|
$ npm i @or-sdk/settings
|
|
18
4
|
```
|
|
19
5
|
|
|
20
|
-
## Usage
|
|
6
|
+
## Usage:
|
|
21
7
|
```typescript
|
|
22
8
|
import { Settings } from '@or-sdk/settings'
|
|
23
9
|
|
|
@@ -33,33 +19,3 @@ const settings = new Settings({
|
|
|
33
19
|
discoveryUrl: 'http://example.discovery/endpoint'
|
|
34
20
|
});
|
|
35
21
|
```
|
|
36
|
-
|
|
37
|
-
## Configuration
|
|
38
|
-
|
|
39
|
-
- Prefer `sdkUrl` when the service URL is known; it avoids a discovery request.
|
|
40
|
-
- Use `discoveryUrl` only when the service URL is not available.
|
|
41
|
-
- Provide `token` as a bearer-token string or getter where supported.
|
|
42
|
-
|
|
43
|
-
## Common pitfalls
|
|
44
|
-
|
|
45
|
-
- Keep the client token current when it can expire; a token getter is preferable where the constructor accepts one.
|
|
46
|
-
- Treat the generated TypeScript types as the authoritative contract for optional parameters and response shapes.
|
|
47
|
-
|
|
48
|
-
## Method map
|
|
49
|
-
|
|
50
|
-
| Method | Purpose |
|
|
51
|
-
|---|---|
|
|
52
|
-
| `init(...)` | See the exported TypeScript signature for parameters and result. |
|
|
53
|
-
| `getRoleSettings(...)` | See the exported TypeScript signature for parameters and result. |
|
|
54
|
-
| `setRoleSettings(...)` | See the exported TypeScript signature for parameters and result. |
|
|
55
|
-
| `getAccountSettings(...)` | See the exported TypeScript signature for parameters and result. |
|
|
56
|
-
| `getUserSettings(...)` | See the exported TypeScript signature for parameters and result. |
|
|
57
|
-
| `getMergedSettings(...)` | See the exported TypeScript signature for parameters and result. |
|
|
58
|
-
| `setAccountSettings(...)` | See the exported TypeScript signature for parameters and result. |
|
|
59
|
-
| `setUserSettings(...)` | See the exported TypeScript signature for parameters and result. |
|
|
60
|
-
| `deleteAccountSettings(...)` | See the exported TypeScript signature for parameters and result. |
|
|
61
|
-
| `deleteUserSettings(...)` | See the exported TypeScript signature for parameters and result. |
|
|
62
|
-
|
|
63
|
-
## More detail
|
|
64
|
-
|
|
65
|
-
Full signatures and exported types are available in `src/` and `dist/types/`.
|
package/dist/types/Settings.d.ts
CHANGED
|
@@ -6,124 +6,14 @@ export declare class Settings {
|
|
|
6
6
|
private accountSettingsRoute;
|
|
7
7
|
private userSettingsRoute;
|
|
8
8
|
private mergedSettingsRoute;
|
|
9
|
-
/**
|
|
10
|
-
* Get role settings
|
|
11
|
-
* ```typescript
|
|
12
|
-
* const result = await instance.getRoleSettings({
|
|
13
|
-
* role: 'ROLE',
|
|
14
|
-
* payload: {
|
|
15
|
-
* accountId: 'account-id',
|
|
16
|
-
* userId: 'user-id',
|
|
17
|
-
* key: 'key',
|
|
18
|
-
* }
|
|
19
|
-
* });
|
|
20
|
-
* ```
|
|
21
|
-
*/
|
|
22
9
|
getRoleSettings(role: string, payload: RoleRouteGetPayload, ...rest: unknown[]): Promise<any>;
|
|
23
|
-
/**
|
|
24
|
-
* Set role settings
|
|
25
|
-
* ```typescript
|
|
26
|
-
* const result = await instance.setRoleSettings({
|
|
27
|
-
* role: 'ROLE',
|
|
28
|
-
* payload: {
|
|
29
|
-
* accountId: 'account-id',
|
|
30
|
-
* userId: 'user-id',
|
|
31
|
-
* key: 'key',
|
|
32
|
-
* value: value
|
|
33
|
-
* }
|
|
34
|
-
* });
|
|
35
|
-
* ```
|
|
36
|
-
*/
|
|
37
10
|
setRoleSettings(role: string, payload: RoleRouteParamsSetPayload, ...rest: unknown[]): Promise<any>;
|
|
38
|
-
/**
|
|
39
|
-
* Get account settings
|
|
40
|
-
* ```typescript
|
|
41
|
-
* const result = await instance.getAccountSettings({
|
|
42
|
-
* payload: {
|
|
43
|
-
* accountId: 'account-id',
|
|
44
|
-
* key: 'key',
|
|
45
|
-
* }
|
|
46
|
-
* });
|
|
47
|
-
* ```
|
|
48
|
-
*/
|
|
49
11
|
getAccountSettings({ accountId, key }: AccountRouteGetPayload, ...rest: unknown[]): Promise<any>;
|
|
50
|
-
/**
|
|
51
|
-
* Get user settings
|
|
52
|
-
* ```typescript
|
|
53
|
-
* const result = await instance.getUserSettings({
|
|
54
|
-
* payload: {
|
|
55
|
-
* accountId: 'account-id',
|
|
56
|
-
* userId: 'user-id',
|
|
57
|
-
* key: 'key',
|
|
58
|
-
* }
|
|
59
|
-
* });
|
|
60
|
-
* ```
|
|
61
|
-
*/
|
|
62
12
|
getUserSettings({ accountId, userId, key }: UserRouteGetPayload, ...rest: unknown[]): Promise<any>;
|
|
63
|
-
/**
|
|
64
|
-
* Get merged settings
|
|
65
|
-
* ```typescript
|
|
66
|
-
* const result = await instance.getMergedSettings({
|
|
67
|
-
* payload: {
|
|
68
|
-
* accountId: 'account-id',
|
|
69
|
-
* userId: 'user-id',
|
|
70
|
-
* key: 'key',
|
|
71
|
-
* }
|
|
72
|
-
* });
|
|
73
|
-
* ```
|
|
74
|
-
*/
|
|
75
13
|
getMergedSettings({ accountId, userId, key }: MergedRouteGetPayload): Promise<any>;
|
|
76
|
-
/**
|
|
77
|
-
* Set account settings
|
|
78
|
-
* ```typescript
|
|
79
|
-
* const result = await instance.setAccountSettings({
|
|
80
|
-
* payload: {
|
|
81
|
-
* accountId: 'account-id',
|
|
82
|
-
* key: 'key',
|
|
83
|
-
* value: value
|
|
84
|
-
* }
|
|
85
|
-
* });
|
|
86
|
-
* ```
|
|
87
|
-
*/
|
|
88
14
|
setAccountSettings({ accountId, key, value }: AccountRouteSetPayload, ...rest: unknown[]): Promise<any>;
|
|
89
|
-
/**
|
|
90
|
-
* Set user settings
|
|
91
|
-
* ```typescript
|
|
92
|
-
* const result = await instance.setUserSettings({
|
|
93
|
-
* payload: {
|
|
94
|
-
* accountId: 'account-id',
|
|
95
|
-
* userId: 'user-id',
|
|
96
|
-
* key: 'key',
|
|
97
|
-
* value: value
|
|
98
|
-
* }
|
|
99
|
-
* });
|
|
100
|
-
* ```
|
|
101
|
-
*/
|
|
102
15
|
setUserSettings({ accountId, userId, key, value, }: UserRouteSetPayload, ...rest: unknown[]): Promise<any>;
|
|
103
|
-
/**
|
|
104
|
-
* Delete account settings
|
|
105
|
-
* ```typescript
|
|
106
|
-
* const result = await instance.deleteAccountSettings({
|
|
107
|
-
* payload: {
|
|
108
|
-
* accountId: 'account-id',
|
|
109
|
-
* key: 'key',
|
|
110
|
-
* }
|
|
111
|
-
* });
|
|
112
|
-
* ```
|
|
113
|
-
*/
|
|
114
16
|
deleteAccountSettings({ accountId, key }: AccountRouteDeletePayload): Promise<any>;
|
|
115
|
-
/**
|
|
116
|
-
* Delete user settings
|
|
117
|
-
* ```typescript
|
|
118
|
-
* const result = await instance.deleteUserSettings({
|
|
119
|
-
* payload: {
|
|
120
|
-
* accountId: 'account-id',
|
|
121
|
-
* userId: 'user-id',
|
|
122
|
-
* key: 'key',
|
|
123
|
-
* }
|
|
124
|
-
* });
|
|
125
|
-
* ```
|
|
126
|
-
*/
|
|
127
17
|
deleteUserSettings({ accountId, userId, key }: UserRouteDeletePayload): Promise<any>;
|
|
128
18
|
}
|
|
129
19
|
//# sourceMappingURL=Settings.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Settings.d.ts","sourceRoot":"","sources":["../../src/Settings.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,yBAAyB,EACzB,sBAAsB,EACtB,sBAAsB,EACtB,qBAAqB,EACrB,mBAAmB,EACnB,yBAAyB,EACzB,cAAc,EACd,sBAAsB,EACtB,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,SAAS,CAAC;AAEjB,qBAAa,QAAQ;IACnB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;gBAEpB,MAAM,EAAE,cAAc;IAU5B,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAG3B,OAAO,CAAC,oBAAoB;IAW5B,OAAO,CAAC,iBAAiB;IAezB,OAAO,CAAC,mBAAmB;
|
|
1
|
+
{"version":3,"file":"Settings.d.ts","sourceRoot":"","sources":["../../src/Settings.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,yBAAyB,EACzB,sBAAsB,EACtB,sBAAsB,EACtB,qBAAqB,EACrB,mBAAmB,EACnB,yBAAyB,EACzB,cAAc,EACd,sBAAsB,EACtB,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,SAAS,CAAC;AAEjB,qBAAa,QAAQ;IACnB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;gBAEpB,MAAM,EAAE,cAAc;IAU5B,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAG3B,OAAO,CAAC,oBAAoB;IAW5B,OAAO,CAAC,iBAAiB;IAezB,OAAO,CAAC,mBAAmB;IA4BpB,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,mBAAmB,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IA2B7F,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,yBAAyB,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAwB7F,kBAAkB,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,EAAE,sBAAsB,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAwBhG,eAAe,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,mBAAmB,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAyBlG,iBAAiB,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,qBAAqB,GAAG,OAAO,CAAC,GAAG,CAAC;IAyBlF,kBAAkB,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,sBAAsB,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IA0BvG,eAAe,CAC1B,EACE,SAAS,EACT,MAAM,EACN,GAAG,EACH,KAAK,GACN,EAAE,mBAAmB,EACtB,GAAG,IAAI,EAAE,OAAO,EAAE,GACjB,OAAO,CAAC,GAAG,CAAC;IAyBF,qBAAqB,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,EAAE,yBAAyB,GAAG,OAAO,CAAC,GAAG,CAAC;IAsBlF,kBAAkB,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,sBAAsB,GAAG,OAAO,CAAC,GAAG,CAAC;CAUlG"}
|
package/dist/types/types.d.ts
CHANGED
|
@@ -1,16 +1,7 @@
|
|
|
1
1
|
import { Token } from '@or-sdk/base';
|
|
2
2
|
export type SettingsConfig = {
|
|
3
|
-
/**
|
|
4
|
-
* token
|
|
5
|
-
*/
|
|
6
3
|
token: Token;
|
|
7
|
-
/**
|
|
8
|
-
* Url of OneReach service discovery api
|
|
9
|
-
*/
|
|
10
4
|
discoveryUrl?: string;
|
|
11
|
-
/**
|
|
12
|
-
* Url of OneReach SDK api
|
|
13
|
-
*/
|
|
14
5
|
sdkUrl?: string;
|
|
15
6
|
};
|
|
16
7
|
export type AccountRouteGetPayload = {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAErC,MAAM,MAAM,cAAc,GAAG;
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAErC,MAAM,MAAM,cAAc,GAAG;IAI3B,KAAK,EAAE,KAAK,CAAC;IAIb,YAAY,CAAC,EAAE,MAAM,CAAC;IAKtB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG,mBAAmB,CAAC;AAExD,MAAM,MAAM,mBAAmB,GAAG,mBAAmB,CAAC;AAEtD,MAAM,MAAM,yBAAyB,GAAG,mBAAmB,GAAG;IAC5D,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,OAAO,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG,sBAAsB,GAAG;IAC5D,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,OAAO,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,mBAAmB,GAAG;IACtD,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,OAAO,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;CACb,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,17 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@or-sdk/settings",
|
|
3
|
-
"version": "0.25.10-beta.
|
|
4
|
-
"description": "OneReach SDK client for Settings",
|
|
3
|
+
"version": "0.25.10-beta.4281.0",
|
|
5
4
|
"license": "Apache-2.0",
|
|
6
5
|
"main": "dist/cjs/index.js",
|
|
7
6
|
"module": "dist/esm/index.js",
|
|
8
7
|
"types": "dist/types/index.d.ts",
|
|
9
|
-
"files": [
|
|
10
|
-
"dist",
|
|
11
|
-
"src",
|
|
12
|
-
"README.md",
|
|
13
|
-
"CHANGELOG.md"
|
|
14
|
-
],
|
|
15
8
|
"scripts": {
|
|
16
9
|
"build": "pnpm clean && concurrently 'pnpm:build:*(!watch)'",
|
|
17
10
|
"build:cjs": "tsc --project tsconfig.json",
|
|
@@ -26,7 +19,7 @@
|
|
|
26
19
|
},
|
|
27
20
|
"dependencies": {
|
|
28
21
|
"@or-sdk/base": "^0.44.7",
|
|
29
|
-
"@or-sdk/sdk-api": "^0.29.6-beta.
|
|
22
|
+
"@or-sdk/sdk-api": "^0.29.6-beta.4281.0"
|
|
30
23
|
},
|
|
31
24
|
"devDependencies": {
|
|
32
25
|
"concurrently": "9.0.1",
|
package/tsconfig.json
ADDED