@or-sdk/permissions 2.3.2-beta.4019.0 → 2.3.2-beta.4045.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.
|
@@ -1,125 +1,21 @@
|
|
|
1
1
|
import { Base } from '@or-sdk/base';
|
|
2
2
|
import { ApiTokenPermissionsResponse, AvailablePermissionsResponse, BulkApiTokenPermissionsResponse, CurrentPermissionsResponse, Permission, PermissionsByServiceResponse, PermissionsConfig, RegisterServiceDto, UpdateApiTokenPermissionsDto, UpdateMultiUserBySinglePermissionsDto, UpdateMultiUserPermissionsDto, UpdateSingleUserPermissionsDto, UserPermissionsResponse } from './types';
|
|
3
|
-
/**
|
|
4
|
-
* OneReach Permissions service client
|
|
5
|
-
* ## Installation:
|
|
6
|
-
* ```
|
|
7
|
-
* $ npm i @or-sdk/permissions
|
|
8
|
-
* ```
|
|
9
|
-
*/
|
|
10
3
|
export declare class Permissions extends Base {
|
|
11
|
-
/**
|
|
12
|
-
* ```typescript
|
|
13
|
-
* import { Permissions } from '@or-sdk/permissions'
|
|
14
|
-
* const permissions = new Permissions({
|
|
15
|
-
* token: 'my-account-token-string',
|
|
16
|
-
* permissionsUrl: 'http://example.permissions/endpoint'
|
|
17
|
-
* });
|
|
18
|
-
* ```
|
|
19
|
-
*/
|
|
20
4
|
constructor(params: PermissionsConfig);
|
|
21
|
-
/**
|
|
22
|
-
* Registers a new service with its permissions
|
|
23
|
-
* @param {RegisterServiceParams} params - Service registration data
|
|
24
|
-
* @param {string} params.service - Service identifier
|
|
25
|
-
* @param {string} params.serviceLabel - Human-readable service name
|
|
26
|
-
* @param {Permission[]} params.permissions - List of permissions to register
|
|
27
|
-
* @returns {Promise<Permission[]>} Registered permissions
|
|
28
|
-
*/
|
|
29
5
|
registerService(params: RegisterServiceDto): Promise<Permission[]>;
|
|
30
|
-
/**
|
|
31
|
-
* Gets all available permissions across all services
|
|
32
|
-
* @returns {Promise<AvailablePermissionsResponse>} List of services with their available permissions
|
|
33
|
-
*/
|
|
34
6
|
getAllAvailablePermissions(): Promise<AvailablePermissionsResponse>;
|
|
35
|
-
/**
|
|
36
|
-
* Gets all permissions for current user across all services
|
|
37
|
-
* @returns {Promise<CurrentPermissionsResponse>} List of services with their permissions
|
|
38
|
-
*/
|
|
39
7
|
getCurrent(): Promise<CurrentPermissionsResponse>;
|
|
40
|
-
/**
|
|
41
|
-
* Gets current user permissions for a specific service
|
|
42
|
-
* @param {string} service - Service identifier
|
|
43
|
-
* @returns {Promise<PermissionsByServiceResponse>} Map of permission names to their effects
|
|
44
|
-
*/
|
|
45
8
|
getCurrentForService(service: string): Promise<PermissionsByServiceResponse>;
|
|
46
|
-
/**
|
|
47
|
-
* Updates permissions for a SingleUser
|
|
48
|
-
* @param {UpdateSingleUserPermissionsDto} data - Update parameters
|
|
49
|
-
* @param {string} data.userId - Single User Id
|
|
50
|
-
* @param {string} data.accountId - Account id of single user, cross-account only for SUPER ADMIN. Optional, would use current account if not present
|
|
51
|
-
* @param {Object} data.permissions - Map of service names to permission overrides
|
|
52
|
-
* @returns {Promise<UserPermissionsResponse>}
|
|
53
|
-
*/
|
|
54
9
|
updateSingleUser(params: UpdateSingleUserPermissionsDto): Promise<UserPermissionsResponse>;
|
|
55
|
-
/**
|
|
56
|
-
* Updates permissions for a MultiUser
|
|
57
|
-
* @param {UpdateMultiUserPermissionsDto} data - Update parameters
|
|
58
|
-
* @param {string} data.userId - Multi User Id
|
|
59
|
-
* @param {Object} data.permissions - Map of service names to permission overrides
|
|
60
|
-
* @returns {Promise<UserPermissionsResponse>}
|
|
61
|
-
*/
|
|
62
10
|
updateMultiUser(params: UpdateMultiUserPermissionsDto): Promise<UserPermissionsResponse>;
|
|
63
|
-
/**
|
|
64
|
-
* Updates permissions for a MultiUser using accountId and singleUserId
|
|
65
|
-
* @param {UpdateMultiUserBySinglePermissionsDto} data - Update parameters
|
|
66
|
-
* @param {string} data.userId - Single User Id
|
|
67
|
-
* @param {string} data.accountId - Account Id, only for cross-account usage.
|
|
68
|
-
* @param {Object} data.permissions - Map of service names to permission overrides
|
|
69
|
-
* @returns {Promise<UserPermissionsResponse>}
|
|
70
|
-
*/
|
|
71
11
|
updateMultiUserByAccIdAndSingleId(params: UpdateMultiUserBySinglePermissionsDto): Promise<UserPermissionsResponse>;
|
|
72
|
-
/**
|
|
73
|
-
* Gets all permissions for a MultiUser using accountId and singleUserId
|
|
74
|
-
* @param {string} data.userId - Single User Id
|
|
75
|
-
* @param {string} data.accountId - Account Id, only for cross-account usage.
|
|
76
|
-
* @returns {Promise<UserPermissionsResponse>}
|
|
77
|
-
*/
|
|
78
12
|
getMultiUserByAccIdAndSingleId(userId: string, accountId?: string): Promise<UserPermissionsResponse>;
|
|
79
|
-
/**
|
|
80
|
-
* Resets all single user permissions, so they will no longer override multiuser permissions.
|
|
81
|
-
* @param {string} data.userId - Single User Id
|
|
82
|
-
* @param {string} data.accountId - Account Id, only for cross-account usage.
|
|
83
|
-
* @returns {Promise<UserPermissionsResponse>}
|
|
84
|
-
*/
|
|
85
13
|
resetSingleUserPermissions(userId: string, accountId?: string): Promise<UserPermissionsResponse>;
|
|
86
|
-
/**
|
|
87
|
-
* Gets permissions for a specific user within an account
|
|
88
|
-
* @param {string} userId - User identifier
|
|
89
|
-
* @returns {Promise<UserPermissionsResponse>} List of services with detailed permissions
|
|
90
|
-
*/
|
|
91
14
|
getByUserIdInCurrentAccount(userId: string): Promise<UserPermissionsResponse>;
|
|
92
|
-
/**
|
|
93
|
-
* Checks if user has the specified permission scopes
|
|
94
|
-
* @param {string[]} scope - List of permission scopes to check
|
|
95
|
-
* @returns {Promise<boolean>} True if user has all specified scopes, false otherwise
|
|
96
|
-
*/
|
|
97
15
|
checkScope(scope: string[]): Promise<boolean>;
|
|
98
|
-
/**
|
|
99
|
-
* Gets all permissions for an API token
|
|
100
|
-
* @param {string} tokenId - API Token identifier
|
|
101
|
-
* @returns {Promise<ApiTokenPermissionsResponse>} List of services with their permissions
|
|
102
|
-
*/
|
|
103
16
|
getApiTokenPermissions(tokenId: string): Promise<ApiTokenPermissionsResponse>;
|
|
104
|
-
/**
|
|
105
|
-
* Gets permissions for multiple API tokens
|
|
106
|
-
* @param {string[]} tokenIds - List of API Token identifiers
|
|
107
|
-
* @returns {Promise<BulkApiTokenPermissionsResponse>} Map of token IDs to their permissions
|
|
108
|
-
*/
|
|
109
17
|
getBulkApiTokenPermissions(tokenIds: string[]): Promise<BulkApiTokenPermissionsResponse>;
|
|
110
|
-
/**
|
|
111
|
-
* Sets permissions for an API token
|
|
112
|
-
* @param {UpdateApiTokenPermissionsDto} params - Update parameters
|
|
113
|
-
* @param {string} params.tokenId - API Token identifier
|
|
114
|
-
* @param {Object} params.permissions - Map of service names to permission overrides
|
|
115
|
-
* @returns {Promise<ApiTokenPermissionsResponse>} Updated permissions
|
|
116
|
-
*/
|
|
117
18
|
setApiTokenPermissions(params: UpdateApiTokenPermissionsDto): Promise<ApiTokenPermissionsResponse>;
|
|
118
|
-
/**
|
|
119
|
-
* Deletes all permissions for an API token
|
|
120
|
-
* @param {string} tokenId - API Token identifier
|
|
121
|
-
* @returns {Promise<{ success: boolean }>}
|
|
122
|
-
*/
|
|
123
19
|
deleteApiTokenPermissions(tokenId: string): Promise<{
|
|
124
20
|
success: boolean;
|
|
125
21
|
}>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Permissions.d.ts","sourceRoot":"","sources":["../../src/Permissions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAGpC,OAAO,EACL,2BAA2B,EAC3B,4BAA4B,EAC5B,+BAA+B,EAC/B,0BAA0B,EAC1B,UAAU,EACV,4BAA4B,EAC5B,iBAAiB,EACjB,kBAAkB,EAClB,4BAA4B,EAC5B,qCAAqC,EACrC,6BAA6B,EAC7B,8BAA8B,EAC9B,uBAAuB,EACxB,MAAM,SAAS,CAAC;
|
|
1
|
+
{"version":3,"file":"Permissions.d.ts","sourceRoot":"","sources":["../../src/Permissions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAGpC,OAAO,EACL,2BAA2B,EAC3B,4BAA4B,EAC5B,+BAA+B,EAC/B,0BAA0B,EAC1B,UAAU,EACV,4BAA4B,EAC5B,iBAAiB,EACjB,kBAAkB,EAClB,4BAA4B,EAC5B,qCAAqC,EACrC,6BAA6B,EAC7B,8BAA8B,EAC9B,uBAAuB,EACxB,MAAM,SAAS,CAAC;AASjB,qBAAa,WAAY,SAAQ,IAAI;gBAUvB,MAAM,EAAE,iBAAiB;IAkB/B,eAAe,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAalE,0BAA0B,IAAI,OAAO,CAAC,4BAA4B,CAAC;IAanE,UAAU,IAAI,OAAO,CAAC,0BAA0B,CAAC;IAajD,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,4BAA4B,CAAC;IAgB5E,gBAAgB,CAAC,MAAM,EAAE,8BAA8B,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAmB1F,eAAe,CAAC,MAAM,EAAE,6BAA6B,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAoBxF,iCAAiC,CAAC,MAAM,EAAE,qCAAqC,GACrF,OAAO,CAAC,uBAAuB,CAAC;IAmB1B,8BAA8B,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GACvE,OAAO,CAAC,uBAAuB,CAAC;IAe1B,0BAA0B,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GACnE,OAAO,CAAC,uBAAuB,CAAC;IAc1B,2BAA2B,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAa7E,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAc7C,sBAAsB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,2BAA2B,CAAC;IAa7E,0BAA0B,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,+BAA+B,CAAC;IAgBxF,sBAAsB,CAAC,MAAM,EAAE,4BAA4B,GAAG,OAAO,CAAC,2BAA2B,CAAC;IAiBlG,yBAAyB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC;CAOhF"}
|
package/dist/types/types.d.ts
CHANGED
|
@@ -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,oBAAY,UAAU;IACpB,UAAU,eAAe;IACzB,SAAS,cAAc;IACvB,QAAQ,aAAa;CACtB;AAED,MAAM,MAAM,iBAAiB,GAAG;
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAErC,oBAAY,UAAU;IACpB,UAAU,eAAe;IACzB,SAAS,cAAc;IACvB,QAAQ,aAAa;CACtB;AAED,MAAM,MAAM,iBAAiB,GAAG;IAI9B,KAAK,EAAE,KAAK,CAAC;IAIb,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,eAAe,GAAG;IACjD,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE;QACT,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,eAAe,EAAE,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,kBAAkB,EAAE,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG,eAAe,EAAE,CAAC;AAC3D,MAAM,MAAM,uBAAuB,GAAG,uBAAuB,EAAE,CAAC;AAEhE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG;IAC3C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE;QACX,CAAC,WAAW,EAAE,MAAM,GAAG,kBAAkB,EAAE,CAAC;KAC7C,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG;IAC1C,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE;QACX,CAAC,WAAW,EAAE,MAAM,GAAG,kBAAkB,EAAE,CAAC;KAC7C,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,qCAAqC,GAAG;IAClD,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE;QACX,CAAC,WAAW,EAAE,MAAM,GAAG,kBAAkB,EAAE,CAAC;KAC7C,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,UAAU,EAAE,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE;QACX,CAAC,WAAW,EAAE,MAAM,GAAG,kBAAkB,EAAE,CAAC;KAC7C,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG,eAAe,EAAE,CAAC;AAE5D,MAAM,MAAM,+BAA+B,GAAG,MAAM,CAAC,MAAM,EAAE,eAAe,EAAE,CAAC,CAAC;AAEhF,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,EAAE;QACT,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,mBAAmB,EAAE,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG,wBAAwB,EAAE,CAAC"}
|