@or-sdk/permissions 1.1.0 → 1.1.1-beta.3267.0

package/README.md

@@ -1 +1,15 @@
 ## Installation:
+```
+$ npm i @or-sdk/permissions
+```
+
+
+## Usage:
+```typescript
+import { Permissions } from '@or-sdk/permissions'
+
+const permissions = new Permissions({
+ token: 'my-account-token-string',
+ permissionsUrl: 'http://example.permissions/endpoint'
+});
+```

package/dist/cjs/Permissions.js

@@ -65,15 +65,31 @@ var Permissions = (function (_super) {
             serviceKey: constants_1.SERVICE_KEY,
         }) || this;
     }
-    Permissions.prototype.getCurrentUserPermissionsByService = function (service) {
+    Permissions.prototype.registerService = function (params) {
+        return __awaiter(this, void 0, void 0, function () {
+            var data;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4, this.callApiV2({
+                            method: 'POST',
+                            route: '/v1/permissions/services',
+                            data: params,
+                        })];
+                    case 1:
+                        data = _a.sent();
+                        return [2, data];
+                }
+            });
+        });
+    };
+    Permissions.prototype.getCurrent = function () {
         return __awaiter(this, void 0, void 0, function () {
             var data;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0: return [4, this.callApiV2({
                             method: 'GET',
-                            route: '/v1/permissions',
-                            params: { service: service },
+                            route: '/v1/permissions/self',
                         })];
                     case 1:
                         data = _a.sent();
@@ -82,14 +98,14 @@ var Permissions = (function (_super) {
             });
         });
     };
-    Permissions.prototype.getAllCurrentUserPermissions = function () {
+    Permissions.prototype.getCurrentForService = function (service) {
         return __awaiter(this, void 0, void 0, function () {
             var data;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0: return [4, this.callApiV2({
                             method: 'GET',
-                            route: '/v1/permissions/all',
+                            route: "/v1/permissions/self/".concat(service),
                         })];
                     case 1:
                         data = _a.sent();
@@ -98,14 +114,14 @@ var Permissions = (function (_super) {
             });
         });
     };
-    Permissions.prototype.updateEntityPermissions = function (data) {
+    Permissions.prototype.updateEntity = function (data) {
         return __awaiter(this, void 0, void 0, function () {
             var response;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0: return [4, this.callApiV2({
                             method: 'PUT',
-                            route: '/v1/permissions',
+                            route: '/v1/permissions/entities',
                             data: data,
                         })];
                     case 1:
@@ -115,14 +131,31 @@ var Permissions = (function (_super) {
             });
         });
     };
-    Permissions.prototype.getAllUserPermissions = function (userid) {
+    Permissions.prototype.getByUserIdInCurrentAccount = function (userId) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4, this.callApiV2({
+                            method: 'GET',
+                            route: "/v1/permissions/all/".concat(userId),
+                        })];
+                    case 1:
+                        response = _a.sent();
+                        return [2, response];
+                }
+            });
+        });
+    };
+    Permissions.prototype.checkScope = function (scope) {
         return __awaiter(this, void 0, void 0, function () {
             var response;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0: return [4, this.callApiV2({
                             method: 'GET',
-                            route: "/v1/permissions/all/".concat(userid),
+                            route: '/v1/permissions/scope',
+                            params: { scope: scope.join(',') },
                         })];
                     case 1:
                         response = _a.sent();

package/dist/cjs/Permissions.js.map

@@ -1 +1 @@
-{"version":3,"file":"Permissions.js","sourceRoot":"","sources":["../../src/Permissions.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qCAAoC;AAEpC,yCAA0C;AAU1C;IAAiC,+BAAI;IAUnC,qBAAY,MAAyB;QAC3B,IAAA,KAAK,GAAmC,MAAM,MAAzC,EAAE,YAAY,GAAqB,MAAM,aAA3B,EAAE,cAAc,GAAK,MAAM,eAAX,CAAY;QAEvD,OAAA,MAAK,YAAC;YACJ,KAAK,OAAA;YACL,YAAY,cAAA;YACZ,UAAU,EAAE,cAAc;YAC1B,UAAU,EAAE,uBAAW;SACxB,CAAC,SAAC;IACL,CAAC;IAEK,wDAAkC,GAAxC,UAAyC,OAAe;;;;;4BACzC,WAAM,IAAI,CAAC,SAAS,CAA+B;4BAC9D,MAAM,EAAE,KAAK;4BACb,KAAK,EAAE,iBAAiB;4BACxB,MAAM,EAAE,EAAE,OAAO,SAAA,EAAE;yBACpB,CAAC,EAAA;;wBAJI,IAAI,GAAG,SAIX;wBACF,WAAO,IAAI,EAAC;;;;KACb;IAEK,kDAA4B,GAAlC;;;;;4BACe,WAAM,IAAI,CAAC,SAAS,CAA4B;4BAC3D,MAAM,EAAE,KAAK;4BACb,KAAK,EAAE,qBAAqB;yBAC7B,CAAC,EAAA;;wBAHI,IAAI,GAAG,SAGX;wBACF,WAAO,IAAI,EAAC;;;;KACb;IAEK,6CAAuB,GAA7B,UAA8B,IAA6B;;;;;4BACxC,WAAM,IAAI,CAAC,SAAS,CAA4B;4BAC/D,MAAM,EAAE,KAAK;4BACb,KAAK,EAAE,iBAAiB;4BACxB,IAAI,MAAA;yBACL,CAAC,EAAA;;wBAJI,QAAQ,GAAG,SAIf;wBACF,WAAO,QAAQ,EAAC;;;;KACjB;IAEK,2CAAqB,GAA3B,UAA4B,MAAc;;;;;4BACvB,WAAM,IAAI,CAAC,SAAS,CAAoC;4BACvE,MAAM,EAAE,KAAK;4BACb,KAAK,EAAE,8BAAuB,MAAM,CAAE;yBACvC,CAAC,EAAA;;wBAHI,QAAQ,GAAG,SAGf;wBACF,WAAO,QAAQ,EAAC;;;;KACjB;IACH,kBAAC;AAAD,CAAC,AAtDD,CAAiC,WAAI,GAsDpC;AAtDY,kCAAW"}
+{"version":3,"file":"Permissions.js","sourceRoot":"","sources":["../../src/Permissions.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qCAAoC;AAEpC,yCAA0C;AAkB1C;IAAiC,+BAAI;IAUnC,qBAAY,MAAyB;QAC3B,IAAA,KAAK,GAAmC,MAAM,MAAzC,EAAE,YAAY,GAAqB,MAAM,aAA3B,EAAE,cAAc,GAAK,MAAM,eAAX,CAAY;QACvD,OAAA,MAAK,YAAC;YACJ,KAAK,OAAA;YACL,YAAY,cAAA;YACZ,UAAU,EAAE,cAAc;YAC1B,UAAU,EAAE,uBAAW;SACxB,CAAC,SAAC;IACL,CAAC;IAUK,qCAAe,GAArB,UAAsB,MAA0B;;;;;4BACjC,WAAM,IAAI,CAAC,SAAS,CAAe;4BAC9C,MAAM,EAAE,MAAM;4BACd,KAAK,EAAE,0BAA0B;4BACjC,IAAI,EAAE,MAAM;yBACb,CAAC,EAAA;;wBAJI,IAAI,GAAG,SAIX;wBACF,WAAO,IAAI,EAAC;;;;KACb;IAOK,gCAAU,GAAhB;;;;;4BACe,WAAM,IAAI,CAAC,SAAS,CAA6B;4BAC5D,MAAM,EAAE,KAAK;4BACb,KAAK,EAAE,sBAAsB;yBAC9B,CAAC,EAAA;;wBAHI,IAAI,GAAG,SAGX;wBACF,WAAO,IAAI,EAAC;;;;KACb;IAOK,0CAAoB,GAA1B,UAA2B,OAAe;;;;;4BAC3B,WAAM,IAAI,CAAC,SAAS,CAA+B;4BAC9D,MAAM,EAAE,KAAK;4BACb,KAAK,EAAE,+BAAwB,OAAO,CAAE;yBACzC,CAAC,EAAA;;wBAHI,IAAI,GAAG,SAGX;wBACF,WAAO,IAAI,EAAC;;;;KACb;IAUK,kCAAY,GAAlB,UAAmB,IAAgC;;;;;4BAChC,WAAM,IAAI,CAAC,SAAS,CAA6B;4BAChE,MAAM,EAAE,KAAK;4BACb,KAAK,EAAE,0BAA0B;4BACjC,IAAI,MAAA;yBACL,CAAC,EAAA;;wBAJI,QAAQ,GAAG,SAIf;wBACF,WAAO,QAAQ,EAAC;;;;KACjB;IAOK,iDAA2B,GAAjC,UAAkC,MAAc;;;;;4BAC7B,WAAM,IAAI,CAAC,SAAS,CAA0B;4BAC7D,MAAM,EAAE,KAAK;4BACb,KAAK,EAAE,8BAAuB,MAAM,CAAE;yBACvC,CAAC,EAAA;;wBAHI,QAAQ,GAAG,SAGf;wBACF,WAAO,QAAQ,EAAC;;;;KACjB;IAOK,gCAAU,GAAhB,UAAiB,KAAe;;;;;4BACb,WAAM,IAAI,CAAC,SAAS,CAAU;4BAC7C,MAAM,EAAE,KAAK;4BACb,KAAK,EAAE,uBAAuB;4BAC9B,MAAM,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;yBACnC,CAAC,EAAA;;wBAJI,QAAQ,GAAG,SAIf;wBACF,WAAO,QAAQ,EAAC;;;;KACjB;IACH,kBAAC;AAAD,CAAC,AA1GD,CAAiC,WAAI,GA0GpC;AA1GY,kCAAW"}

package/dist/esm/Permissions.js

@@ -19,40 +19,59 @@ export class Permissions extends Base {
             serviceKey: SERVICE_KEY,
         });
     }
-    getCurrentUserPermissionsByService(service) {
+    registerService(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const data = yield this.callApiV2({
+                method: 'POST',
+                route: '/v1/permissions/services',
+                data: params,
+            });
+            return data;
+        });
+    }
+    getCurrent() {
         return __awaiter(this, void 0, void 0, function* () {
             const data = yield this.callApiV2({
                 method: 'GET',
-                route: '/v1/permissions',
-                params: { service },
+                route: '/v1/permissions/self',
             });
             return data;
         });
     }
-    getAllCurrentUserPermissions() {
+    getCurrentForService(service) {
         return __awaiter(this, void 0, void 0, function* () {
             const data = yield this.callApiV2({
                 method: 'GET',
-                route: '/v1/permissions/all',
+                route: `/v1/permissions/self/${service}`,
             });
             return data;
         });
     }
-    updateEntityPermissions(data) {
+    updateEntity(data) {
         return __awaiter(this, void 0, void 0, function* () {
             const response = yield this.callApiV2({
                 method: 'PUT',
-                route: '/v1/permissions',
+                route: '/v1/permissions/entities',
                 data,
             });
             return response;
         });
     }
-    getAllUserPermissions(userid) {
+    getByUserIdInCurrentAccount(userId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.callApiV2({
+                method: 'GET',
+                route: `/v1/permissions/all/${userId}`,
+            });
+            return response;
+        });
+    }
+    checkScope(scope) {
         return __awaiter(this, void 0, void 0, function* () {
             const response = yield this.callApiV2({
                 method: 'GET',
-                route: `/v1/permissions/all/${userid}`,
+                route: '/v1/permissions/scope',
+                params: { scope: scope.join(',') },
             });
             return response;
         });

package/dist/esm/Permissions.js.map

@@ -1 +1 @@
-{"version":3,"file":"Permissions.js","sourceRoot":"","sources":["../../src/Permissions.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAEpC,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAU1C,MAAM,OAAO,WAAY,SAAQ,IAAI;IAUnC,YAAY,MAAyB;QACnC,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,cAAc,EAAE,GAAG,MAAM,CAAC;QAEvD,KAAK,CAAC;YACJ,KAAK;YACL,YAAY;YACZ,UAAU,EAAE,cAAc;YAC1B,UAAU,EAAE,WAAW;SACxB,CAAC,CAAC;IACL,CAAC;IAEK,kCAAkC,CAAC,OAAe;;YACtD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,CAA+B;gBAC9D,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,iBAAiB;gBACxB,MAAM,EAAE,EAAE,OAAO,EAAE;aACpB,CAAC,CAAC;YACH,OAAO,IAAI,CAAC;QACd,CAAC;KAAA;IAEK,4BAA4B;;YAChC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,CAA4B;gBAC3D,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,qBAAqB;aAC7B,CAAC,CAAC;YACH,OAAO,IAAI,CAAC;QACd,CAAC;KAAA;IAEK,uBAAuB,CAAC,IAA6B;;YACzD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAA4B;gBAC/D,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,iBAAiB;gBACxB,IAAI;aACL,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC;QAClB,CAAC;KAAA;IAEK,qBAAqB,CAAC,MAAc;;YACxC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAoC;gBACvE,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,uBAAuB,MAAM,EAAE;aACvC,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC;QAClB,CAAC;KAAA;CACF"}
+{"version":3,"file":"Permissions.js","sourceRoot":"","sources":["../../src/Permissions.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAEpC,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAkB1C,MAAM,OAAO,WAAY,SAAQ,IAAI;IAUnC,YAAY,MAAyB;QACnC,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,cAAc,EAAE,GAAG,MAAM,CAAC;QACvD,KAAK,CAAC;YACJ,KAAK;YACL,YAAY;YACZ,UAAU,EAAE,cAAc;YAC1B,UAAU,EAAE,WAAW;SACxB,CAAC,CAAC;IACL,CAAC;IAUK,eAAe,CAAC,MAA0B;;YAC9C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,CAAe;gBAC9C,MAAM,EAAE,MAAM;gBACd,KAAK,EAAE,0BAA0B;gBACjC,IAAI,EAAE,MAAM;aACb,CAAC,CAAC;YACH,OAAO,IAAI,CAAC;QACd,CAAC;KAAA;IAOK,UAAU;;YACd,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,CAA6B;gBAC5D,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,sBAAsB;aAC9B,CAAC,CAAC;YACH,OAAO,IAAI,CAAC;QACd,CAAC;KAAA;IAOK,oBAAoB,CAAC,OAAe;;YACxC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,CAA+B;gBAC9D,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,wBAAwB,OAAO,EAAE;aACzC,CAAC,CAAC;YACH,OAAO,IAAI,CAAC;QACd,CAAC;KAAA;IAUK,YAAY,CAAC,IAAgC;;YACjD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAA6B;gBAChE,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,0BAA0B;gBACjC,IAAI;aACL,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC;QAClB,CAAC;KAAA;IAOK,2BAA2B,CAAC,MAAc;;YAC9C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAA0B;gBAC7D,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,uBAAuB,MAAM,EAAE;aACvC,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC;QAClB,CAAC;KAAA;IAOK,UAAU,CAAC,KAAe;;YAC9B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAU;gBAC7C,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,uBAAuB;gBAC9B,MAAM,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;aACnC,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC;QAClB,CAAC;KAAA;CACF"}

package/dist/types/Permissions.d.ts

@@ -1,10 +1,12 @@
 import { Base } from '@or-sdk/base';
-import { GetAllPermissionsByUserIdResponse, GetAllPermissionsResponse, GetPermissionByServiceResult, PermissionsConfig, UpdateEntityPermissions } from './types';
+import { CurrentPermissionsResponse, Permission, PermissionsByServiceResponse, PermissionsConfig, RegisterServiceDto, UpdateEntityPermissionsDto, UserPermissionsResponse } from './types';
 export declare class Permissions extends Base {
     constructor(params: PermissionsConfig);
-    getCurrentUserPermissionsByService(service: string): Promise<GetPermissionByServiceResult>;
-    getAllCurrentUserPermissions(): Promise<GetAllPermissionsResponse>;
-    updateEntityPermissions(data: UpdateEntityPermissions): Promise<GetAllPermissionsResponse>;
-    getAllUserPermissions(userid: string): Promise<GetAllPermissionsByUserIdResponse>;
+    registerService(params: RegisterServiceDto): Promise<Permission[]>;
+    getCurrent(): Promise<CurrentPermissionsResponse>;
+    getCurrentForService(service: string): Promise<PermissionsByServiceResponse>;
+    updateEntity(data: UpdateEntityPermissionsDto): Promise<CurrentPermissionsResponse>;
+    getByUserIdInCurrentAccount(userId: string): Promise<UserPermissionsResponse>;
+    checkScope(scope: string[]): Promise<boolean>;
 }
 //# sourceMappingURL=Permissions.d.ts.map

package/dist/types/Permissions.d.ts.map

@@ -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,EAAE,iCAAiC,EAAE,yBAAyB,EAAE,4BAA4B,EAAE,iBAAiB,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAC;AASjK,qBAAa,WAAY,SAAQ,IAAI;gBAUvB,MAAM,EAAE,iBAAiB;IAW/B,kCAAkC,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,4BAA4B,CAAC;IAS1F,4BAA4B,IAAI,OAAO,CAAC,yBAAyB,CAAC;IAQlE,uBAAuB,CAAC,IAAI,EAAE,uBAAuB,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAS1F,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,iCAAiC,CAAC;CAOxF"}
+{"version":3,"file":"Permissions.d.ts","sourceRoot":"","sources":["../../src/Permissions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAGpC,OAAO,EACL,0BAA0B,EAC1B,UAAU,EACV,4BAA4B,EAC5B,iBAAiB,EACjB,kBAAkB,EAClB,0BAA0B,EAC1B,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;IAclE,UAAU,IAAI,OAAO,CAAC,0BAA0B,CAAC;IAajD,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,4BAA4B,CAAC;IAgB5E,YAAY,CAAC,IAAI,EAAE,0BAA0B,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAcnF,2BAA2B,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAa7E,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAQpD"}

package/dist/types/types.d.ts

@@ -8,36 +8,47 @@ export type PermissionsConfig = {
     permissionsUrl: string;
     discoveryUrl?: string;
 };
-export type GetPermissionByServiceResult = {
+export type PermissionsByServiceResponse = {
     [key: string]: boolean;
 };
-export type ServicePermission = {
+export type BasicPermission = {
     name: string;
     effect: boolean;
 };
-export type ExtendedServicePermission = ServicePermission & {
+export type DetailedPermission = BasicPermission & {
     description: string;
 };
-export type ServiceWithPermissions = {
+export type PermissionGroup = {
     serviceName: string;
-    permissions: ServicePermission[];
+    permissions: BasicPermission[];
 };
-export type ExtendedServiceWithPermissions = {
+export type DetailedPermissionGroup = {
     serviceName: string;
     serviceLabel: string;
-    permissions: ExtendedServicePermission[];
+    permissions: DetailedPermission[];
 };
-export type GetAllPermissionsResponse = ServiceWithPermissions[];
-export type GetAllPermissionsByUserIdResponse = ExtendedServiceWithPermissions[];
+export type CurrentPermissionsResponse = PermissionGroup[];
+export type UserPermissionsResponse = DetailedPermissionGroup[];
 export type PermissionOverride = {
     permissionName: string;
     effect: boolean;
 };
-export type UpdateEntityPermissions = {
+export type UpdateEntityPermissionsDto = {
     entityType: EntityType;
     entityId: string;
     permissions: {
         [serviceName: string]: PermissionOverride[];
     };
 };
+export type Permission = {
+    name: string;
+    description: string;
+    defaultEffect: boolean;
+    metadata?: unknown;
+};
+export type RegisterServiceDto = {
+    service: string;
+    serviceLabel: string;
+    permissions: Permission[];
+};
 //# sourceMappingURL=types.d.ts.map

package/dist/types/types.d.ts.map

@@ -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;CACxB;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,iBAAiB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG,iBAAiB,GAAG;IAC1D,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,iBAAiB,EAAE,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG;IAC3C,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,yBAAyB,EAAE,CAAC;CAC1C,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG,sBAAsB,EAAE,CAAC;AACjE,MAAM,MAAM,iCAAiC,GAAG,8BAA8B,EAAE,CAAC;AAEjF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,UAAU,EAAE,UAAU,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE;QACX,CAAC,WAAW,EAAE,MAAM,GAAG,kBAAkB,EAAE,CAAC;KAC7C,CAAC;CACH,CAAC"}
+{"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;CACxB;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;CACrB,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,0BAA0B,GAAG;IACvC,UAAU,EAAE,UAAU,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,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"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@or-sdk/permissions",
-  "version": "1.1.0",
+  "version": "1.1.1-beta.3267.0",
   "license": "Apache-2.0",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -26,6 +26,5 @@
   },
   "publishConfig": {
     "access": "public"
-  },
-  "gitHead": "468edb5e9810689f4e523fc0df043ed1f9cadef9"
+  }
 }

package/src/Permissions.ts

@@ -1,7 +1,15 @@
 import { Base } from '@or-sdk/base';
 
 import { SERVICE_KEY } from './constants';
-import { GetAllPermissionsByUserIdResponse, GetAllPermissionsResponse, GetPermissionByServiceResult, PermissionsConfig, UpdateEntityPermissions } from './types';
+import {
+  CurrentPermissionsResponse,
+  Permission,
+  PermissionsByServiceResponse,
+  PermissionsConfig,
+  RegisterServiceDto,
+  UpdateEntityPermissionsDto,
+  UserPermissionsResponse,
+} from './types';
 
 /**
  * OneReach Permissions service client
@@ -22,7 +30,6 @@ export class Permissions extends Base {
    */
   constructor(params: PermissionsConfig) {
     const { token, discoveryUrl, permissionsUrl } = params;
-
     super({
       token,
       discoveryUrl,
@@ -31,36 +38,89 @@ export class Permissions extends Base {
     });
   }
 
-  async getCurrentUserPermissionsByService(service: string): Promise<GetPermissionByServiceResult> {
-    const data = await this.callApiV2<GetPermissionByServiceResult>({
+  /**
+  * Registers a new service with its permissions
+  * @param {RegisterServiceParams} params - Service registration data
+  * @param {string} params.service - Service identifier
+  * @param {string} params.serviceLabel - Human-readable service name
+  * @param {Permission[]} params.permissions - List of permissions to register
+  * @returns {Promise<Permission[]>} Registered permissions
+  */
+  async registerService(params: RegisterServiceDto): Promise<Permission[]> {
+    const data = await this.callApiV2<Permission[]>({
+      method: 'POST',
+      route: '/v1/permissions/services',
+      data: params,
+    });
+    return data;
+  }
+
+  /**
+  * Gets all permissions for current user across all services
+  * @returns {Promise<CurrentPermissionsResponse>} List of services with their permissions
+  */
+
+  async getCurrent(): Promise<CurrentPermissionsResponse> {
+    const data = await this.callApiV2<CurrentPermissionsResponse>({
       method: 'GET',
-      route: '/v1/permissions',
-      params: { service },
+      route: '/v1/permissions/self',
     });
     return data;
   }
 
-  async getAllCurrentUserPermissions(): Promise<GetAllPermissionsResponse> {
-    const data = await this.callApiV2<GetAllPermissionsResponse>({
+  /**
+  * Gets current user permissions for a specific service
+  * @param {string} service - Service identifier
+  * @returns {Promise<PermissionsByServiceResponse>} Map of permission names to their effects
+  */
+  async getCurrentForService(service: string): Promise<PermissionsByServiceResponse> {
+    const data = await this.callApiV2<PermissionsByServiceResponse>({
       method: 'GET',
-      route: '/v1/permissions/all',
+      route: `/v1/permissions/self/${service}`,
     });
     return data;
   }
 
-  async updateEntityPermissions(data: UpdateEntityPermissions): Promise<GetAllPermissionsResponse> {
-    const response = await this.callApiV2<GetAllPermissionsResponse>({
+  /**
+  * Updates permissions for a specific entity (SingleUser or MultiUser)
+  * @param {UpdateEntityPermissionsDto} data - Update parameters
+  * @param {EntityType} data.entityType - Type of entity (SingleUser/MultiUser)
+  * @param {string} data.entityId - Entity identifier
+  * @param {Object} data.permissions - Map of service names to permission overrides
+  * @returns {Promise<CurrentPermissionsResponse>}
+  */
+  async updateEntity(data: UpdateEntityPermissionsDto): Promise<CurrentPermissionsResponse> {
+    const response = await this.callApiV2<CurrentPermissionsResponse>({
       method: 'PUT',
-      route: '/v1/permissions',
+      route: '/v1/permissions/entities',
       data,
     });
     return response;
   }
 
-  async getAllUserPermissions(userid: string): Promise<GetAllPermissionsByUserIdResponse> {
-    const response = await this.callApiV2<GetAllPermissionsByUserIdResponse>({
+  /**
+  * Gets permissions for a specific user within an account
+  * @param {string} userId - User identifier
+  * @returns {Promise<UserPermissionsResponse>} List of services with detailed permissions
+  */
+  async getByUserIdInCurrentAccount(userId: string): Promise<UserPermissionsResponse> {
+    const response = await this.callApiV2<UserPermissionsResponse>({
+      method: 'GET',
+      route: `/v1/permissions/all/${userId}`,
+    });
+    return response;
+  }
+
+  /**
+  * Checks if user has the specified permission scopes
+  * @param {string[]} scope - List of permission scopes to check
+  * @returns {Promise<boolean>} True if user has all specified scopes, false otherwise
+  */
+  async checkScope(scope: string[]): Promise<boolean> {
+    const response = await this.callApiV2<boolean>({
       method: 'GET',
-      route: `/v1/permissions/all/${userid}`,
+      route: '/v1/permissions/scope',
+      params: { scope: scope.join(',') },
     });
     return response;
   }

package/src/types.ts

@@ -11,48 +11,61 @@ export type PermissionsConfig = {
    */
   token: Token;
   /**
-   * function which return token
-   */
+     * function which return token
+     */
   permissionsUrl: string;
   discoveryUrl?: string;
 };
 
-export type GetPermissionByServiceResult = {
+export type PermissionsByServiceResponse = {
   [key: string]: boolean;
 };
 
-export type ServicePermission = {
+export type BasicPermission = {
   name: string;
   effect: boolean;
 };
 
-export type ExtendedServicePermission = ServicePermission & {
+export type DetailedPermission = BasicPermission & {
   description: string;
 };
 
-export type ServiceWithPermissions = {
+export type PermissionGroup = {
   serviceName: string;
-  permissions: ServicePermission[];
+  permissions: BasicPermission[];
 };
 
-export type ExtendedServiceWithPermissions = {
+export type DetailedPermissionGroup = {
   serviceName: string;
   serviceLabel: string;
-  permissions: ExtendedServicePermission[];
+  permissions: DetailedPermission[];
 };
 
-export type GetAllPermissionsResponse = ServiceWithPermissions[];
-export type GetAllPermissionsByUserIdResponse = ExtendedServiceWithPermissions[];
+export type CurrentPermissionsResponse = PermissionGroup[];
+export type UserPermissionsResponse = DetailedPermissionGroup[];
 
 export type PermissionOverride = {
   permissionName: string;
   effect: boolean;
 };
 
-export type UpdateEntityPermissions = {
+export type UpdateEntityPermissionsDto = {
   entityType: EntityType;
   entityId: string;
   permissions: {
     [serviceName: string]: PermissionOverride[];
   };
 };
+
+export type Permission = {
+  name: string;
+  description: string;
+  defaultEffect: boolean;
+  metadata?: unknown;
+};
+
+export type RegisterServiceDto = {
+  service: string;
+  serviceLabel: string;
+  permissions: Permission[];
+};