@itwin/access-control-client 0.1.0

package/lib/cjs/subClients/RolesClient.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RolesClient = void 0;
+const BaseClient_1 = require("./BaseClient");
+class RolesClient extends BaseClient_1.BaseClient {
+    /** Retrieves a list of available user roles that are defined for a specified iTwin
+      * @param accessToken The client access token string
+      * @param iTwinId The id of the iTwin
+      * @returns Roles
+      */
+    async getITwinRolesAsync(accessToken, iTwinId) {
+        const url = `${this._baseUrl}/${iTwinId}/roles`;
+        return this.sendGenericAPIRequest(accessToken, "GET", url, undefined, "roles");
+    }
+    /** Retrieves the specified role for the specified iTwin
+      * @param accessToken The client access token string
+      * @param iTwinId The id of the iTwin
+      * @returns Role
+      */
+    async getITwinRoleAsync(accessToken, iTwinId, roleId) {
+        const url = `${this._baseUrl}/${iTwinId}/roles/${roleId}`;
+        return this.sendGenericAPIRequest(accessToken, "GET", url);
+    }
+    /** Creates a new iTwin Role
+      * @param accessToken The client access token string
+      * @param iTwinId The id of the iTwin
+      * @param role The role to be created
+      * @returns Role
+      */
+    async createITwinRoleAsync(accessToken, iTwinId, role) {
+        const url = `${this._baseUrl}/${iTwinId}/roles`;
+        return this.sendGenericAPIRequest(accessToken, "POST", url, role, "role");
+    }
+    /** Delete the specified iTwin role
+      * @param accessToken The client access token string
+      * @param iTwinId The id of the iTwin
+      * @param roleId The id of the role to remove
+      * @returns No Content
+      */
+    async deleteITwinRoleAsync(accessToken, iTwinId, roleId) {
+        const url = `${this._baseUrl}/${iTwinId}/roles/${roleId}`;
+        return this.sendGenericAPIRequest(accessToken, "DELETE", url);
+    }
+    /** Update the specified iTwin role
+      * @param accessToken The client access token string
+      * @param iTwinId The id of the iTwin
+      * @param roleId The id of the role to update
+      * @param role The updated role
+      * @returns Role
+      */
+    async updateITwinRoleAsync(accessToken, iTwinId, roleId, role) {
+        const url = `${this._baseUrl}/${iTwinId}/roles/${roleId}`;
+        return this.sendGenericAPIRequest(accessToken, "PATCH", url, role, "role");
+    }
+}
+exports.RolesClient = RolesClient;
+//# sourceMappingURL=RolesClient.js.map

package/lib/cjs/subClients/RolesClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RolesClient.js","sourceRoot":"","sources":["../../../src/subClients/RolesClient.ts"],"names":[],"mappings":";;;AASA,6CAA0C;AAE1C,MAAa,WAAY,SAAQ,uBAAU;IACzC;;;;QAII;IACG,KAAK,CAAC,kBAAkB,CAC7B,WAAwB,EACxB,OAAe;QAEf,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,QAAQ,CAAC;QAChD,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;QAII;IACG,KAAK,CAAC,iBAAiB,CAC5B,WAAwB,EACxB,OAAe,EACf,MAAc;QAEd,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,UAAU,MAAM,EAAE,CAAC;QAC1D,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;QAKI;IACG,KAAK,CAAC,oBAAoB,CAC/B,WAAwB,EACxB,OAAe,EACf,IAAa;QAEb,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,QAAQ,CAAC;QAChD,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;QAKI;IACG,KAAK,CAAC,oBAAoB,CAC/B,WAAwB,EACxB,OAAe,EACf,MAAc;QAEd,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,UAAU,MAAM,EAAE,CAAC;QAC1D,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;QAMI;IACG,KAAK,CAAC,oBAAoB,CAC/B,WAAwB,EACxB,OAAe,EACf,MAAc,EACd,IAAa;QAEb,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,UAAU,MAAM,EAAE,CAAC;QAC1D,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IAC7E,CAAC;CACF;AA1ED,kCA0EC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module AccessControlClient\r\n */\r\nimport type { AccessToken } from \"@itwin/core-bentley\";\r\nimport type { AccessControlAPIResponse, IRolesClient, NewRole, Role } from \"../accessControlTypes\";\r\nimport { BaseClient } from \"./BaseClient\";\r\n\r\nexport class RolesClient extends BaseClient implements IRolesClient{\r\n  /** Retrieves a list of available user roles that are defined for a specified iTwin\r\n    * @param accessToken The client access token string\r\n    * @param iTwinId The id of the iTwin\r\n    * @returns Roles\r\n    */\r\n  public async getITwinRolesAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n  ): Promise<AccessControlAPIResponse<Role[]>>{\r\n    const url = `${this._baseUrl}/${iTwinId}/roles`;\r\n    return this.sendGenericAPIRequest(accessToken, \"GET\", url, undefined, \"roles\");\r\n  }\r\n\r\n  /** Retrieves the specified role for the specified iTwin\r\n    * @param accessToken The client access token string\r\n    * @param iTwinId The id of the iTwin\r\n    * @returns Role\r\n    */\r\n  public async getITwinRoleAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    roleId: string,\r\n  ): Promise<AccessControlAPIResponse<Role>>{\r\n    const url = `${this._baseUrl}/${iTwinId}/roles/${roleId}`;\r\n    return this.sendGenericAPIRequest(accessToken, \"GET\", url);\r\n  }\r\n\r\n  /** Creates a new iTwin Role\r\n    * @param accessToken The client access token string\r\n    * @param iTwinId The id of the iTwin\r\n    * @param role The role to be created\r\n    * @returns Role\r\n    */\r\n  public async createITwinRoleAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    role: NewRole\r\n  ): Promise<AccessControlAPIResponse<Role>>{\r\n    const url = `${this._baseUrl}/${iTwinId}/roles`;\r\n    return this.sendGenericAPIRequest(accessToken, \"POST\", url, role, \"role\");\r\n  }\r\n\r\n  /** Delete the specified iTwin role\r\n    * @param accessToken The client access token string\r\n    * @param iTwinId The id of the iTwin\r\n    * @param roleId The id of the role to remove\r\n    * @returns No Content\r\n    */\r\n  public async deleteITwinRoleAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    roleId: string,\r\n  ): Promise<AccessControlAPIResponse<undefined>>{\r\n    const url = `${this._baseUrl}/${iTwinId}/roles/${roleId}`;\r\n    return this.sendGenericAPIRequest(accessToken, \"DELETE\", url);\r\n  }\r\n\r\n  /** Update the specified iTwin role\r\n    * @param accessToken The client access token string\r\n    * @param iTwinId The id of the iTwin\r\n    * @param roleId The id of the role to update\r\n    * @param role The updated role\r\n    * @returns Role\r\n    */\r\n  public async updateITwinRoleAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    roleId: string,\r\n    role: NewRole\r\n  ): Promise<AccessControlAPIResponse<Role>>{\r\n    const url = `${this._baseUrl}/${iTwinId}/roles/${roleId}`;\r\n    return this.sendGenericAPIRequest(accessToken, \"PATCH\", url, role, \"role\");\r\n  }\r\n}\r\n"]}

package/lib/esm/AccessControlClient.d.ts

@@ -0,0 +1,10 @@
+/** @packageDocumentation
+ * @module AccessControlClient
+ */
+import type { IAccessControlClient, IMembersClient, IPermissionsClient, IRolesClient } from "./accessControlTypes";
+export declare class AccessControlClient implements IAccessControlClient {
+    permissions: IPermissionsClient;
+    roles: IRolesClient;
+    members: IMembersClient;
+}
+//# sourceMappingURL=AccessControlClient.d.ts.map

package/lib/esm/AccessControlClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AccessControlClient.d.ts","sourceRoot":"","sources":["../../src/AccessControlClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,KAAK,EAAE,oBAAoB,EAAE,cAAc,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAKnH,qBAAa,mBAAoB,YAAW,oBAAoB;IACvD,WAAW,EAAE,kBAAkB,CAA2B;IAC1D,KAAK,EAAE,YAAY,CAAqB;IACxC,OAAO,EAAE,cAAc,CAAuB;CACtD"}

package/lib/esm/AccessControlClient.js

@@ -0,0 +1,11 @@
+import { MembersClient } from "./subClients/MembersClient";
+import { PermissionsClient } from "./subClients/PermissionsClient";
+import { RolesClient } from "./subClients/RolesClient";
+export class AccessControlClient {
+    constructor() {
+        this.permissions = new PermissionsClient();
+        this.roles = new RolesClient();
+        this.members = new MembersClient();
+    }
+}
+//# sourceMappingURL=AccessControlClient.js.map

package/lib/esm/AccessControlClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AccessControlClient.js","sourceRoot":"","sources":["../../src/AccessControlClient.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACnE,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD,MAAM,OAAO,mBAAmB;IAAhC;QACS,gBAAW,GAAuB,IAAI,iBAAiB,EAAE,CAAC;QAC1D,UAAK,GAAiB,IAAI,WAAW,EAAE,CAAC;QACxC,YAAO,GAAmB,IAAI,aAAa,EAAE,CAAC;IACvD,CAAC;CAAA","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module AccessControlClient\r\n */\r\nimport type { IAccessControlClient, IMembersClient, IPermissionsClient, IRolesClient } from \"./accessControlTypes\";\r\nimport { MembersClient } from \"./subClients/MembersClient\";\r\nimport { PermissionsClient } from \"./subClients/PermissionsClient\";\r\nimport { RolesClient } from \"./subClients/RolesClient\";\r\n\r\nexport class AccessControlClient implements IAccessControlClient {\r\n  public permissions: IPermissionsClient = new PermissionsClient();\r\n  public roles: IRolesClient = new RolesClient();\r\n  public members: IMembersClient = new MembersClient();\r\n}\r\n"]}

package/lib/esm/access-control-client.d.ts

@@ -0,0 +1,3 @@
+export * from "./AccessControlClient";
+export * from "./accessControlTypes";
+//# sourceMappingURL=access-control-client.d.ts.map

package/lib/esm/access-control-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"access-control-client.d.ts","sourceRoot":"","sources":["../../src/access-control-client.ts"],"names":[],"mappings":"AAIA,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC"}

package/lib/esm/access-control-client.js

@@ -0,0 +1,7 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+export * from "./AccessControlClient";
+export * from "./accessControlTypes";
+//# sourceMappingURL=access-control-client.js.map

package/lib/esm/access-control-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"access-control-client.js","sourceRoot":"","sources":["../../src/access-control-client.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\nexport * from \"./AccessControlClient\";\r\nexport * from \"./accessControlTypes\";\r\n"]}

package/lib/esm/accessControlTypes.d.ts

@@ -0,0 +1,80 @@
+/** @packageDocumentation
+ * @module AccessControlClient
+ */
+import type { AccessToken } from "@itwin/core-bentley";
+export interface IAccessControlClient {
+    permissions: IPermissionsClient;
+    roles: IRolesClient;
+    members: IMembersClient;
+}
+export interface IPermissionsClient {
+    /** Retrieves the list of all available permissions **/
+    getPermissionsAsync(accessToken: AccessToken): Promise<AccessControlAPIResponse<Permission[]>>;
+    /** Retrieves a list of permissions the identity has for a specified iTwin */
+    getITwinPermissionsAsync(accessToken: AccessToken, iTwinId: string): Promise<AccessControlAPIResponse<Permission[]>>;
+}
+export interface IMembersClient {
+    /** Retrieves a list of team members and their roles assigned to a specified iTwin. */
+    queryITwinMembersAsync(accessToken: AccessToken, iTwinId: string, arg?: AccessControlQueryArg): Promise<AccessControlAPIResponse<Member[]>>;
+    /** Retrieves a specific member for a specified iTwin. */
+    getITwinMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<AccessControlAPIResponse<Member>>;
+    /** Add new iTwin members */
+    addITwinMembersAsync(accessToken: AccessToken, iTwinId: string, newMembers: NewMember[]): Promise<AccessControlAPIResponse<undefined>>;
+    /**  Remove the specified iTwin member */
+    removeITwinMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<AccessControlAPIResponse<undefined>>;
+    /**  Update iTwin team member roles */
+    updateITwinMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string, roleIds: string[]): Promise<AccessControlAPIResponse<Member>>;
+}
+export interface IRolesClient {
+    /** Retrieves a list of roles the for a specified iTwin */
+    getITwinRolesAsync(accessToken: AccessToken, iTwinId: string): Promise<AccessControlAPIResponse<Role[]>>;
+    /** Retrieves a role for a specified iTwin */
+    getITwinRoleAsync(accessToken: AccessToken, iTwinId: string, roleId: string): Promise<AccessControlAPIResponse<Role>>;
+    /** Creates a new iTwin Role */
+    createITwinRoleAsync(accessToken: AccessToken, iTwinId: string, role: NewRole): Promise<AccessControlAPIResponse<Role>>;
+    /** Removes an existing iTwin Role */
+    deleteITwinRoleAsync(accessToken: AccessToken, iTwinId: string, roleId: string): Promise<AccessControlAPIResponse<undefined>>;
+    /** Updates an existing iTwin Role */
+    updateITwinRoleAsync(accessToken: AccessToken, iTwinId: string, roleId: string, role: NewRole): Promise<AccessControlAPIResponse<Role>>;
+}
+export interface AccessControlQueryArg {
+    top?: number;
+    skip?: number;
+}
+export interface AccessControlAPIResponse<T> {
+    data?: T;
+    status: number;
+    error?: Error;
+}
+export interface Error {
+    code: string;
+    message: string;
+    details?: ErrorDetail[];
+    target?: string;
+}
+export interface ErrorDetail {
+    code: string;
+    message: string;
+    target?: string;
+}
+export declare type Permission = string;
+export interface Member {
+    id: string;
+    email: string;
+    givenName: string;
+    surname: string;
+    organization: string;
+    roles: Omit<Role, "permissions">[];
+}
+export interface NewMember {
+    email: string;
+    roleId: string;
+}
+export interface Role {
+    id: string;
+    displayName: string;
+    description: string;
+    permissions: Permission[];
+}
+export declare type NewRole = Omit<Role, "id">;
+//# sourceMappingURL=accessControlTypes.d.ts.map

package/lib/esm/accessControlTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"accessControlTypes.d.ts","sourceRoot":"","sources":["../../src/accessControlTypes.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAEvD,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,kBAAkB,CAAC;IAChC,KAAK,EAAE,YAAY,CAAC;IACpB,OAAO,EAAE,cAAc,CAAC;CACzB;AAED,MAAM,WAAW,kBAAkB;IACjC,uDAAuD;IACvD,mBAAmB,CACjB,WAAW,EAAE,WAAW,GACvB,OAAO,CAAC,wBAAwB,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;IAEnD,6EAA6E;IAC7E,wBAAwB,CACtB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,wBAAwB,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;CACpD;AAED,MAAM,WAAW,cAAc;IAC7B,sFAAsF;IACtF,sBAAsB,CACpB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,GAAG,CAAC,EAAE,qBAAqB,GAC1B,OAAO,CAAC,wBAAwB,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAE/C,yDAAyD;IACzD,mBAAmB,CACjB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC,CAAC;IAE7C,4BAA4B;IAC5B,oBAAoB,CAClB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,SAAS,EAAE,GACtB,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhD,yCAAyC;IACzC,sBAAsB,CACpB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhD,sCAAsC;IACtC,sBAAsB,CACpB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EAAE,GAChB,OAAO,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC,CAAC;CAC9C;AAED,MAAM,WAAW,YAAY;IAC3B,0DAA0D;IAC1D,kBAAkB,CAChB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,wBAAwB,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAE7C,6CAA6C;IAC7C,iBAAiB,CACf,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC,CAAC;IAE3C,+BAA+B;IAC/B,oBAAoB,CAClB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,OAAO,GACZ,OAAO,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC,CAAC;IAE3C,qCAAqC;IACrC,oBAAoB,CAClB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhD,qCAAqC;IACrC,oBAAoB,CAClB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,OAAO,GACZ,OAAO,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC,CAAC;CAC5C;AAED,MAAM,WAAW,qBAAqB;IACpC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,wBAAwB,CAAC,CAAC;IACzC,IAAI,CAAC,EAAE,CAAC,CAAC;IACT,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,KAAK,CAAC;CACf;AAED,MAAM,WAAW,KAAK;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,WAAW,EAAE,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,oBAAY,UAAU,GAAG,MAAM,CAAC;AAEhC,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,aAAa,CAAC,EAAE,CAAC;CACpC;AAED,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,IAAI;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,UAAU,EAAE,CAAC;CAC3B;AAED,oBAAY,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC"}

package/lib/esm/accessControlTypes.js

@@ -0,0 +1,9 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module AccessControlClient
+ */
+export {};
+//# sourceMappingURL=accessControlTypes.js.map

package/lib/esm/accessControlTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"accessControlTypes.js","sourceRoot":"","sources":["../../src/accessControlTypes.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module AccessControlClient\r\n */\r\n\r\nimport type { AccessToken } from \"@itwin/core-bentley\";\r\n\r\nexport interface IAccessControlClient {\r\n  permissions: IPermissionsClient;\r\n  roles: IRolesClient;\r\n  members: IMembersClient;\r\n}\r\n\r\nexport interface IPermissionsClient {\r\n  /** Retrieves the list of all available permissions **/\r\n  getPermissionsAsync(\r\n    accessToken: AccessToken,\r\n  ): Promise<AccessControlAPIResponse<Permission[]>>;\r\n\r\n  /** Retrieves a list of permissions the identity has for a specified iTwin */\r\n  getITwinPermissionsAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string\r\n  ): Promise<AccessControlAPIResponse<Permission[]>>;\r\n}\r\n\r\nexport interface IMembersClient{\r\n  /** Retrieves a list of team members and their roles assigned to a specified iTwin. */\r\n  queryITwinMembersAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    arg?: AccessControlQueryArg\r\n  ): Promise<AccessControlAPIResponse<Member[]>>;\r\n\r\n  /** Retrieves a specific member for a specified iTwin. */\r\n  getITwinMemberAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    memberId: string\r\n  ): Promise<AccessControlAPIResponse<Member>>;\r\n\r\n  /** Add new iTwin members */\r\n  addITwinMembersAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    newMembers: NewMember[]\r\n  ): Promise<AccessControlAPIResponse<undefined>>;\r\n\r\n  /**  Remove the specified iTwin member */\r\n  removeITwinMemberAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    memberId: string\r\n  ): Promise<AccessControlAPIResponse<undefined>>;\r\n\r\n  /**  Update iTwin team member roles */\r\n  updateITwinMemberAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    memberId: string,\r\n    roleIds: string[]\r\n  ): Promise<AccessControlAPIResponse<Member>>;\r\n}\r\n\r\nexport interface IRolesClient {\r\n  /** Retrieves a list of roles the for a specified iTwin */\r\n  getITwinRolesAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n  ): Promise<AccessControlAPIResponse<Role[]>>;\r\n\r\n  /** Retrieves a role for a specified iTwin */\r\n  getITwinRoleAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    roleId: string,\r\n  ): Promise<AccessControlAPIResponse<Role>>;\r\n\r\n  /** Creates a new iTwin Role */\r\n  createITwinRoleAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    role: NewRole\r\n  ): Promise<AccessControlAPIResponse<Role>>;\r\n\r\n  /** Removes an existing iTwin Role */\r\n  deleteITwinRoleAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    roleId: string,\r\n  ): Promise<AccessControlAPIResponse<undefined>>;\r\n\r\n  /** Updates an existing iTwin Role */\r\n  updateITwinRoleAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    roleId: string,\r\n    role: NewRole\r\n  ): Promise<AccessControlAPIResponse<Role>>;\r\n}\r\n\r\nexport interface AccessControlQueryArg {\r\n  top?: number;\r\n  skip?: number;\r\n}\r\n\r\nexport interface AccessControlAPIResponse<T> {\r\n  data?: T;\r\n  status: number;\r\n  error?: Error;\r\n}\r\n\r\nexport interface Error {\r\n  code: string;\r\n  message: string;\r\n  details?: ErrorDetail[];\r\n  target?: string;\r\n}\r\n\r\nexport interface ErrorDetail {\r\n  code: string;\r\n  message: string;\r\n  target?: string;\r\n}\r\n\r\nexport type Permission = string;\r\n\r\nexport interface Member {\r\n  id: string;\r\n  email: string;\r\n  givenName: string;\r\n  surname: string;\r\n  organization: string;\r\n  roles: Omit<Role, \"permissions\">[];\r\n}\r\n\r\nexport interface NewMember {\r\n  email: string;\r\n  roleId: string;\r\n}\r\n\r\nexport interface Role {\r\n  id: string;\r\n  displayName: string;\r\n  description: string;\r\n  permissions: Permission[];\r\n}\r\n\r\nexport type NewRole = Omit<Role, \"id\">;\r\n"]}

package/lib/esm/subClients/BaseClient.d.ts

@@ -0,0 +1,30 @@
+/** @packageDocumentation
+ * @module AccessControlClient
+ */
+import type { AccessToken } from "@itwin/core-bentley";
+import type { Method } from "axios";
+import type { AxiosRequestConfig } from "axios";
+import type { AccessControlAPIResponse, AccessControlQueryArg } from "../accessControlTypes";
+export declare class BaseClient {
+    protected _baseUrl: string;
+    constructor();
+    /**
+      * Sends a basic API request
+      * @param accessTokenString The client access token string
+      * @param method The method type of the request (ex. GET, POST, DELETE, etc)
+      * @param url The url of the request
+      */
+    protected sendGenericAPIRequest(accessToken: AccessToken, method: Method, url: string, data?: any, property?: string): Promise<AccessControlAPIResponse<any>>;
+    /**
+      * Build the request methods, headers, and other options
+      * @param accessTokenString The client access token string
+      */
+    protected getRequestOptions(accessTokenString: string, method: Method, url: string, data?: any): AxiosRequestConfig;
+    /**
+      * Build a query to be appended to a URL
+      * @param queryArg Object container queryable properties
+      * @returns query string with AccessControlQueryArg applied, which should be appended to a url
+      */
+    protected getQueryString(queryArg: AccessControlQueryArg): string;
+}
+//# sourceMappingURL=BaseClient.d.ts.map

package/lib/esm/subClients/BaseClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseClient.d.ts","sourceRoot":"","sources":["../../../src/subClients/BaseClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AACpC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAEhD,OAAO,KAAK,EAAE,wBAAwB,EAAE,qBAAqB,EAAC,MAAM,uBAAuB,CAAC;AAE5F,qBAAa,UAAU;IACrB,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAkD;;IAW5E;;;;;QAKI;cACY,qBAAqB,CACnC,WAAW,EAAE,WAAW,EACxB,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,GAAG,EACV,QAAQ,CAAC,EAAE,MAAM,GAChB,OAAO,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC;IAuBzC;;;QAGI;IACJ,SAAS,CAAC,iBAAiB,CAAC,iBAAiB,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,kBAAkB;IAenH;;;;QAII;IACJ,SAAS,CAAC,cAAc,CAAC,QAAQ,EAAE,qBAAqB,GAAG,MAAM;CAgBlE"}

package/lib/esm/subClients/BaseClient.js

@@ -0,0 +1,74 @@
+import axios from "axios";
+export class BaseClient {
+    constructor() {
+        this._baseUrl = "https://api.bentley.com/accesscontrol/itwins";
+        const urlPrefix = process.env.IMJS_URL_PREFIX;
+        if (urlPrefix) {
+            const baseUrl = new URL(this._baseUrl);
+            baseUrl.hostname = urlPrefix + baseUrl.hostname;
+            this._baseUrl = baseUrl.href;
+        }
+    }
+    /**
+      * Sends a basic API request
+      * @param accessTokenString The client access token string
+      * @param method The method type of the request (ex. GET, POST, DELETE, etc)
+      * @param url The url of the request
+      */
+    async sendGenericAPIRequest(accessToken, method, url, data, property) {
+        const requestOptions = this.getRequestOptions(accessToken, method, url, data);
+        try {
+            const response = await axios(requestOptions);
+            return {
+                status: response.status,
+                data: response.data.error || response.data === "" ? undefined : property ? response.data[property] : response.data,
+                error: response.data.error,
+            };
+        }
+        catch (err) {
+            return {
+                status: 500,
+                error: {
+                    code: "InternalServerError",
+                    message: "An internal exception happened while calling iTwins Service",
+                },
+            };
+        }
+    }
+    /**
+      * Build the request methods, headers, and other options
+      * @param accessTokenString The client access token string
+      */
+    getRequestOptions(accessTokenString, method, url, data) {
+        return {
+            method,
+            url,
+            data,
+            headers: {
+                "authorization": accessTokenString,
+                "content-type": "application/json",
+            },
+            validateStatus(status) {
+                return status < 500; // Resolve only if the status code is less than 500
+            },
+        };
+    }
+    /**
+      * Build a query to be appended to a URL
+      * @param queryArg Object container queryable properties
+      * @returns query string with AccessControlQueryArg applied, which should be appended to a url
+      */
+    getQueryString(queryArg) {
+        let queryString = "";
+        if (queryArg.top) {
+            queryString += `&$top=${queryArg.top}`;
+        }
+        if (queryArg.skip) {
+            queryString += `&$skip=${queryArg.skip}`;
+        }
+        // trim & from start of string
+        queryString.replace(/^&+/, "");
+        return queryString;
+    }
+}
+//# sourceMappingURL=BaseClient.js.map

package/lib/esm/subClients/BaseClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseClient.js","sourceRoot":"","sources":["../../../src/subClients/BaseClient.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,MAAM,OAAO,CAAC;AAG1B,MAAM,OAAO,UAAU;IAGrB;QAFU,aAAQ,GAAW,8CAA8C,CAAC;QAG1E,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC;QAC9C,IAAI,SAAS,EAAE;YACb,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACvC,OAAO,CAAC,QAAQ,GAAG,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC;YAChD,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;SAC9B;IACH,CAAC;IAED;;;;;QAKI;IACM,KAAK,CAAC,qBAAqB,CACnC,WAAwB,EACxB,MAAc,EACd,GAAW,EACX,IAAU,EACV,QAAiB;QAEjB,MAAM,cAAc,GAAG,IAAI,CAAC,iBAAiB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;QAE9E,IAAI;YACF,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,cAAc,CAAC,CAAC;YAE7C,OAAO;gBACL,MAAM,EAAE,QAAQ,CAAC,MAAM;gBACvB,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,KAAK,IAAI,QAAQ,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI;gBAClH,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,KAAK;aAC3B,CAAC;SACH;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO;gBACL,MAAM,EAAE,GAAG;gBACX,KAAK,EAAE;oBACL,IAAI,EAAE,qBAAqB;oBAC3B,OAAO,EACJ,6DAA6D;iBACjE;aACF,CAAC;SACH;IACH,CAAC;IAED;;;QAGI;IACM,iBAAiB,CAAC,iBAAyB,EAAE,MAAc,EAAE,GAAW,EAAE,IAAU;QAC5F,OAAO;YACL,MAAM;YACN,GAAG;YACH,IAAI;YACJ,OAAO,EAAE;gBACP,eAAe,EAAE,iBAAiB;gBAClC,cAAc,EAAE,kBAAkB;aACnC;YACD,cAAc,CAAC,MAAM;gBACnB,OAAO,MAAM,GAAG,GAAG,CAAC,CAAC,mDAAmD;YAC1E,CAAC;SACF,CAAC;IACJ,CAAC;IAED;;;;QAII;IACM,cAAc,CAAC,QAA+B;QACtD,IAAI,WAAW,GAAG,EAAE,CAAC;QAErB,IAAI,QAAQ,CAAC,GAAG,EAAE;YAChB,WAAW,IAAI,SAAS,QAAQ,CAAC,GAAG,EAAE,CAAC;SACxC;QAED,IAAI,QAAQ,CAAC,IAAI,EAAE;YACjB,WAAW,IAAI,UAAU,QAAQ,CAAC,IAAI,EAAE,CAAC;SAC1C;QAED,8BAA8B;QAC9B,WAAW,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAE/B,OAAO,WAAW,CAAC;IACrB,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module AccessControlClient\r\n */\r\nimport type { AccessToken } from \"@itwin/core-bentley\";\r\nimport type { Method } from \"axios\";\r\nimport type { AxiosRequestConfig } from \"axios\";\r\nimport axios from \"axios\";\r\nimport type { AccessControlAPIResponse, AccessControlQueryArg} from \"../accessControlTypes\";\r\n\r\nexport class BaseClient {\r\n  protected _baseUrl: string = \"https://api.bentley.com/accesscontrol/itwins\";\r\n\r\n  public constructor() {\r\n    const urlPrefix = process.env.IMJS_URL_PREFIX;\r\n    if (urlPrefix) {\r\n      const baseUrl = new URL(this._baseUrl);\r\n      baseUrl.hostname = urlPrefix + baseUrl.hostname;\r\n      this._baseUrl = baseUrl.href;\r\n    }\r\n  }\r\n\r\n  /**\r\n    * Sends a basic API request\r\n    * @param accessTokenString The client access token string\r\n    * @param method The method type of the request (ex. GET, POST, DELETE, etc)\r\n    * @param url The url of the request\r\n    */\r\n  protected async sendGenericAPIRequest(\r\n    accessToken: AccessToken,\r\n    method: Method,\r\n    url: string,\r\n    data?: any,\r\n    property?: string\r\n  ): Promise<AccessControlAPIResponse<any>> { // TODO: Change any response\r\n    const requestOptions = this.getRequestOptions(accessToken, method, url, data);\r\n\r\n    try {\r\n      const response = await axios(requestOptions);\r\n\r\n      return {\r\n        status: response.status,\r\n        data: response.data.error || response.data === \"\" ? undefined : property ? response.data[property] : response.data,\r\n        error: response.data.error,\r\n      };\r\n    } catch (err) {\r\n      return {\r\n        status: 500,\r\n        error: {\r\n          code: \"InternalServerError\",\r\n          message:\r\n             \"An internal exception happened while calling iTwins Service\",\r\n        },\r\n      };\r\n    }\r\n  }\r\n\r\n  /**\r\n    * Build the request methods, headers, and other options\r\n    * @param accessTokenString The client access token string\r\n    */\r\n  protected getRequestOptions(accessTokenString: string, method: Method, url: string, data?: any): AxiosRequestConfig {\r\n    return {\r\n      method,\r\n      url,\r\n      data,\r\n      headers: {\r\n        \"authorization\": accessTokenString,\r\n        \"content-type\": \"application/json\",\r\n      },\r\n      validateStatus(status) {\r\n        return status < 500; // Resolve only if the status code is less than 500\r\n      },\r\n    };\r\n  }\r\n\r\n  /**\r\n    * Build a query to be appended to a URL\r\n    * @param queryArg Object container queryable properties\r\n    * @returns query string with AccessControlQueryArg applied, which should be appended to a url\r\n    */\r\n  protected getQueryString(queryArg: AccessControlQueryArg): string {\r\n    let queryString = \"\";\r\n\r\n    if (queryArg.top) {\r\n      queryString += `&$top=${queryArg.top}`;\r\n    }\r\n\r\n    if (queryArg.skip) {\r\n      queryString += `&$skip=${queryArg.skip}`;\r\n    }\r\n\r\n    // trim & from start of string\r\n    queryString.replace(/^&+/, \"\");\r\n\r\n    return queryString;\r\n  }\r\n}\r\n"]}

package/lib/esm/subClients/MembersClient.d.ts

@@ -0,0 +1,44 @@
+/** @packageDocumentation
+ * @module AccessControlClient
+ */
+import type { AccessToken } from "@itwin/core-bentley";
+import type { AccessControlAPIResponse, AccessControlQueryArg, IMembersClient, Member, NewMember } from "../accessControlTypes";
+import { BaseClient } from "./BaseClient";
+export declare class MembersClient extends BaseClient implements IMembersClient {
+    /** Retrieves a list of iTwin members and their roles assignments.
+      * @param accessToken The client access token string
+      * @param iTwinId The id of the iTwin
+      * @returns Array of members
+      */
+    queryITwinMembersAsync(accessToken: AccessToken, iTwinId: string, arg?: AccessControlQueryArg): Promise<AccessControlAPIResponse<Member[]>>;
+    /** Retrieves a specific member for a specified iTwin.
+      * @param accessToken The client access token string
+      * @param iTwinId The id of the iTwin
+      * @param memberId The id of the member
+      * @returns Member
+      */
+    getITwinMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<AccessControlAPIResponse<Member>>;
+    /** Add new iTwin members
+      * @param accessToken The client access token string
+      * @param iTwinId The id of the iTwin
+      * @param newMembers The list of new members to be added along with their role
+      * @returns No Content
+      */
+    addITwinMembersAsync(accessToken: AccessToken, iTwinId: string, newMembers: NewMember[]): Promise<AccessControlAPIResponse<undefined>>;
+    /** Remove the specified member from the iTwin
+      * @param accessToken The client access token string
+      * @param iTwinId The id of the iTwin
+      * @param memberId The id of the member
+      * @returns No Content
+      */
+    removeITwinMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string): Promise<AccessControlAPIResponse<undefined>>;
+    /** Update iTwin team member roles
+      * @param accessToken The client access token string
+      * @param iTwinId The id of the iTwin
+      * @param memberId The id of the member
+      * @param roleIds The ids of the roles to be assigned
+      * @returns Member
+      */
+    updateITwinMemberAsync(accessToken: AccessToken, iTwinId: string, memberId: string, roleIds: string[]): Promise<AccessControlAPIResponse<Member>>;
+}
+//# sourceMappingURL=MembersClient.d.ts.map

package/lib/esm/subClients/MembersClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MembersClient.d.ts","sourceRoot":"","sources":["../../../src/subClients/MembersClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,wBAAwB,EAAE,qBAAqB,EAAE,cAAc,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAChI,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,qBAAa,aAAc,SAAQ,UAAW,YAAW,cAAc;IACrE;;;;QAII;IACS,sBAAsB,CACjC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,GAAG,CAAC,EAAE,qBAAqB,GAC1B,OAAO,CAAC,wBAAwB,CAAC,MAAM,EAAE,CAAC,CAAC;IAM9C;;;;;QAKI;IACS,mBAAmB,CAC9B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;IAK5C;;;;;QAKI;IACS,oBAAoB,CAC/B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,SAAS,EAAE,GACtB,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC;IAQ/C;;;;;QAKI;IACS,sBAAsB,CACjC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC;IAK/C;;;;;;QAMI;IACS,sBAAsB,CACjC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EAAE,GAChB,OAAO,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;CAO7C"}

package/lib/esm/subClients/MembersClient.js

@@ -0,0 +1,62 @@
+import { BaseClient } from "./BaseClient";
+export class MembersClient extends BaseClient {
+    /** Retrieves a list of iTwin members and their roles assignments.
+      * @param accessToken The client access token string
+      * @param iTwinId The id of the iTwin
+      * @returns Array of members
+      */
+    async queryITwinMembersAsync(accessToken, iTwinId, arg) {
+        let url = `${this._baseUrl}/${iTwinId}/members`;
+        if (arg)
+            url += `?${this.getQueryString(arg)}`;
+        return this.sendGenericAPIRequest(accessToken, "GET", url, undefined, "members"); // TODO: Consider how to handle paging
+    }
+    /** Retrieves a specific member for a specified iTwin.
+      * @param accessToken The client access token string
+      * @param iTwinId The id of the iTwin
+      * @param memberId The id of the member
+      * @returns Member
+      */
+    async getITwinMemberAsync(accessToken, iTwinId, memberId) {
+        const url = `${this._baseUrl}/${iTwinId}/members/${memberId}`;
+        return this.sendGenericAPIRequest(accessToken, "GET", url, undefined, "member");
+    }
+    /** Add new iTwin members
+      * @param accessToken The client access token string
+      * @param iTwinId The id of the iTwin
+      * @param newMembers The list of new members to be added along with their role
+      * @returns No Content
+      */
+    async addITwinMembersAsync(accessToken, iTwinId, newMembers) {
+        const url = `${this._baseUrl}/${iTwinId}/members`;
+        const body = {
+            members: newMembers,
+        };
+        return this.sendGenericAPIRequest(accessToken, "POST", url, body);
+    }
+    /** Remove the specified member from the iTwin
+      * @param accessToken The client access token string
+      * @param iTwinId The id of the iTwin
+      * @param memberId The id of the member
+      * @returns No Content
+      */
+    async removeITwinMemberAsync(accessToken, iTwinId, memberId) {
+        const url = `${this._baseUrl}/${iTwinId}/members/${memberId}`;
+        return this.sendGenericAPIRequest(accessToken, "DELETE", url);
+    }
+    /** Update iTwin team member roles
+      * @param accessToken The client access token string
+      * @param iTwinId The id of the iTwin
+      * @param memberId The id of the member
+      * @param roleIds The ids of the roles to be assigned
+      * @returns Member
+      */
+    async updateITwinMemberAsync(accessToken, iTwinId, memberId, roleIds) {
+        const url = `${this._baseUrl}/${iTwinId}/members/${memberId}`;
+        const body = {
+            roleIds,
+        };
+        return this.sendGenericAPIRequest(accessToken, "PATCH", url, body, "member");
+    }
+}
+//# sourceMappingURL=MembersClient.js.map

package/lib/esm/subClients/MembersClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MembersClient.js","sourceRoot":"","sources":["../../../src/subClients/MembersClient.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,MAAM,OAAO,aAAc,SAAQ,UAAU;IAC3C;;;;QAII;IACG,KAAK,CAAC,sBAAsB,CACjC,WAAwB,EACxB,OAAe,EACf,GAA2B;QAE3B,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,UAAU,CAAC;QAChD,IAAI,GAAG;YAAE,GAAG,IAAI,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC;QAC/C,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,sCAAsC;IAC1H,CAAC;IAED;;;;;QAKI;IACG,KAAK,CAAC,mBAAmB,CAC9B,WAAwB,EACxB,OAAe,EACf,QAAgB;QAEhB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,YAAY,QAAQ,EAAE,CAAC;QAC9D,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;IAClF,CAAC;IAED;;;;;QAKI;IACG,KAAK,CAAC,oBAAoB,CAC/B,WAAwB,EACxB,OAAe,EACf,UAAuB;QAEvB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,UAAU,CAAC;QAClD,MAAM,IAAI,GAAG;YACX,OAAO,EAAE,UAAU;SACpB,CAAC;QACF,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;IACpE,CAAC;IAED;;;;;QAKI;IACG,KAAK,CAAC,sBAAsB,CACjC,WAAwB,EACxB,OAAe,EACf,QAAgB;QAEhB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,YAAY,QAAQ,EAAE,CAAC;QAC9D,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;QAMI;IACG,KAAK,CAAC,sBAAsB,CACjC,WAAwB,EACxB,OAAe,EACf,QAAgB,EAChB,OAAiB;QAEjB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,YAAY,QAAQ,EAAE,CAAC;QAC9D,MAAM,IAAI,GAAG;YACX,OAAO;SACR,CAAC;QACF,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC/E,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module AccessControlClient\r\n */\r\nimport type { AccessToken } from \"@itwin/core-bentley\";\r\nimport type { AccessControlAPIResponse, AccessControlQueryArg, IMembersClient, Member, NewMember } from \"../accessControlTypes\";\r\nimport { BaseClient } from \"./BaseClient\";\r\n\r\nexport class MembersClient extends BaseClient implements IMembersClient{\r\n  /** Retrieves a list of iTwin members and their roles assignments.\r\n    * @param accessToken The client access token string\r\n    * @param iTwinId The id of the iTwin\r\n    * @returns Array of members\r\n    */\r\n  public async queryITwinMembersAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    arg?: AccessControlQueryArg\r\n  ): Promise<AccessControlAPIResponse<Member[]>>{\r\n    let url = `${this._baseUrl}/${iTwinId}/members`;\r\n    if (arg) url += `?${this.getQueryString(arg)}`;\r\n    return this.sendGenericAPIRequest(accessToken, \"GET\", url, undefined, \"members\"); // TODO: Consider how to handle paging\r\n  }\r\n\r\n  /** Retrieves a specific member for a specified iTwin.\r\n    * @param accessToken The client access token string\r\n    * @param iTwinId The id of the iTwin\r\n    * @param memberId The id of the member\r\n    * @returns Member\r\n    */\r\n  public async getITwinMemberAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    memberId: string\r\n  ): Promise<AccessControlAPIResponse<Member>>{\r\n    const url = `${this._baseUrl}/${iTwinId}/members/${memberId}`;\r\n    return this.sendGenericAPIRequest(accessToken, \"GET\", url, undefined, \"member\");\r\n  }\r\n\r\n  /** Add new iTwin members\r\n    * @param accessToken The client access token string\r\n    * @param iTwinId The id of the iTwin\r\n    * @param newMembers The list of new members to be added along with their role\r\n    * @returns No Content\r\n    */\r\n  public async addITwinMembersAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    newMembers: NewMember[]\r\n  ): Promise<AccessControlAPIResponse<undefined>>{\r\n    const url = `${this._baseUrl}/${iTwinId}/members`;\r\n    const body = {\r\n      members: newMembers,\r\n    };\r\n    return this.sendGenericAPIRequest(accessToken, \"POST\", url, body);\r\n  }\r\n\r\n  /** Remove the specified member from the iTwin\r\n    * @param accessToken The client access token string\r\n    * @param iTwinId The id of the iTwin\r\n    * @param memberId The id of the member\r\n    * @returns No Content\r\n    */\r\n  public async removeITwinMemberAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    memberId: string\r\n  ): Promise<AccessControlAPIResponse<undefined>> {\r\n    const url = `${this._baseUrl}/${iTwinId}/members/${memberId}`;\r\n    return this.sendGenericAPIRequest(accessToken, \"DELETE\", url);\r\n  }\r\n\r\n  /** Update iTwin team member roles\r\n    * @param accessToken The client access token string\r\n    * @param iTwinId The id of the iTwin\r\n    * @param memberId The id of the member\r\n    * @param roleIds The ids of the roles to be assigned\r\n    * @returns Member\r\n    */\r\n  public async updateITwinMemberAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n    memberId: string,\r\n    roleIds: string[]\r\n  ): Promise<AccessControlAPIResponse<Member>> {\r\n    const url = `${this._baseUrl}/${iTwinId}/members/${memberId}`;\r\n    const body = {\r\n      roleIds,\r\n    };\r\n    return this.sendGenericAPIRequest(accessToken, \"PATCH\", url, body, \"member\");\r\n  }\r\n}\r\n"]}

package/lib/esm/subClients/PermissionsClient.d.ts

@@ -0,0 +1,20 @@
+/** @packageDocumentation
+ * @module AccessControlClient
+ */
+import type { AccessToken } from "@itwin/core-bentley";
+import type { AccessControlAPIResponse, IPermissionsClient, Permission } from "../accessControlTypes";
+import { BaseClient } from "./BaseClient";
+export declare class PermissionsClient extends BaseClient implements IPermissionsClient {
+    /** Retrieves the list of all available permissions
+      * @param accessToken The client access token string
+      * @returns Array of permissions
+      */
+    getPermissionsAsync(accessToken: AccessToken): Promise<AccessControlAPIResponse<Permission[]>>;
+    /** Retrieves a list of permissions the identity has for a specified iTwin
+      * @param accessToken The client access token string
+      * @param iTwinId The id of the iTwin
+      * @returns Array of permissions
+      */
+    getITwinPermissionsAsync(accessToken: AccessToken, iTwinId: string): Promise<AccessControlAPIResponse<Permission[]>>;
+}
+//# sourceMappingURL=PermissionsClient.d.ts.map

package/lib/esm/subClients/PermissionsClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PermissionsClient.d.ts","sourceRoot":"","sources":["../../../src/subClients/PermissionsClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,wBAAwB,EAAE,kBAAkB,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACtG,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,qBAAa,iBAAkB,SAAQ,UAAW,YAAW,kBAAkB;IAC7E;;;QAGI;IACS,mBAAmB,CAC9B,WAAW,EAAE,WAAW,GACvB,OAAO,CAAC,wBAAwB,CAAC,UAAU,EAAE,CAAC,CAAC;IAKlD;;;;QAII;IACS,wBAAwB,CACnC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,wBAAwB,CAAC,UAAU,EAAE,CAAC,CAAC;CAInD"}

package/lib/esm/subClients/PermissionsClient.js

@@ -0,0 +1,21 @@
+import { BaseClient } from "./BaseClient";
+export class PermissionsClient extends BaseClient {
+    /** Retrieves the list of all available permissions
+      * @param accessToken The client access token string
+      * @returns Array of permissions
+      */
+    async getPermissionsAsync(accessToken) {
+        const url = `${this._baseUrl}/permissions`;
+        return this.sendGenericAPIRequest(accessToken, "GET", url, undefined, "permissions");
+    }
+    /** Retrieves a list of permissions the identity has for a specified iTwin
+      * @param accessToken The client access token string
+      * @param iTwinId The id of the iTwin
+      * @returns Array of permissions
+      */
+    async getITwinPermissionsAsync(accessToken, iTwinId) {
+        const url = `${this._baseUrl}/${iTwinId}/permissions`;
+        return this.sendGenericAPIRequest(accessToken, "GET", url, undefined, "permissions");
+    }
+}
+//# sourceMappingURL=PermissionsClient.js.map

package/lib/esm/subClients/PermissionsClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PermissionsClient.js","sourceRoot":"","sources":["../../../src/subClients/PermissionsClient.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,MAAM,OAAO,iBAAkB,SAAQ,UAAU;IAC/C;;;QAGI;IACG,KAAK,CAAC,mBAAmB,CAC9B,WAAwB;QAExB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,cAAc,CAAC;QAC3C,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;IACvF,CAAC;IAED;;;;QAII;IACG,KAAK,CAAC,wBAAwB,CACnC,WAAwB,EACxB,OAAe;QAEf,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,cAAc,CAAC;QACtD,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;IACvF,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module AccessControlClient\r\n */\r\nimport type { AccessToken } from \"@itwin/core-bentley\";\r\nimport type { AccessControlAPIResponse, IPermissionsClient, Permission } from \"../accessControlTypes\";\r\nimport { BaseClient } from \"./BaseClient\";\r\n\r\nexport class PermissionsClient extends BaseClient implements IPermissionsClient{\r\n  /** Retrieves the list of all available permissions\r\n    * @param accessToken The client access token string\r\n    * @returns Array of permissions\r\n    */\r\n  public async getPermissionsAsync(\r\n    accessToken: AccessToken,\r\n  ): Promise<AccessControlAPIResponse<Permission[]>>{\r\n    const url = `${this._baseUrl}/permissions`;\r\n    return this.sendGenericAPIRequest(accessToken, \"GET\", url, undefined, \"permissions\");\r\n  }\r\n\r\n  /** Retrieves a list of permissions the identity has for a specified iTwin\r\n    * @param accessToken The client access token string\r\n    * @param iTwinId The id of the iTwin\r\n    * @returns Array of permissions\r\n    */\r\n  public async getITwinPermissionsAsync(\r\n    accessToken: AccessToken,\r\n    iTwinId: string,\r\n  ): Promise<AccessControlAPIResponse<Permission[]>>{\r\n    const url = `${this._baseUrl}/${iTwinId}/permissions`;\r\n    return this.sendGenericAPIRequest(accessToken, \"GET\", url, undefined, \"permissions\");\r\n  }\r\n}\r\n"]}

package/lib/esm/subClients/RolesClient.d.ts

@@ -0,0 +1,43 @@
+/** @packageDocumentation
+ * @module AccessControlClient
+ */
+import type { AccessToken } from "@itwin/core-bentley";
+import type { AccessControlAPIResponse, IRolesClient, NewRole, Role } from "../accessControlTypes";
+import { BaseClient } from "./BaseClient";
+export declare class RolesClient extends BaseClient implements IRolesClient {
+    /** Retrieves a list of available user roles that are defined for a specified iTwin
+      * @param accessToken The client access token string
+      * @param iTwinId The id of the iTwin
+      * @returns Roles
+      */
+    getITwinRolesAsync(accessToken: AccessToken, iTwinId: string): Promise<AccessControlAPIResponse<Role[]>>;
+    /** Retrieves the specified role for the specified iTwin
+      * @param accessToken The client access token string
+      * @param iTwinId The id of the iTwin
+      * @returns Role
+      */
+    getITwinRoleAsync(accessToken: AccessToken, iTwinId: string, roleId: string): Promise<AccessControlAPIResponse<Role>>;
+    /** Creates a new iTwin Role
+      * @param accessToken The client access token string
+      * @param iTwinId The id of the iTwin
+      * @param role The role to be created
+      * @returns Role
+      */
+    createITwinRoleAsync(accessToken: AccessToken, iTwinId: string, role: NewRole): Promise<AccessControlAPIResponse<Role>>;
+    /** Delete the specified iTwin role
+      * @param accessToken The client access token string
+      * @param iTwinId The id of the iTwin
+      * @param roleId The id of the role to remove
+      * @returns No Content
+      */
+    deleteITwinRoleAsync(accessToken: AccessToken, iTwinId: string, roleId: string): Promise<AccessControlAPIResponse<undefined>>;
+    /** Update the specified iTwin role
+      * @param accessToken The client access token string
+      * @param iTwinId The id of the iTwin
+      * @param roleId The id of the role to update
+      * @param role The updated role
+      * @returns Role
+      */
+    updateITwinRoleAsync(accessToken: AccessToken, iTwinId: string, roleId: string, role: NewRole): Promise<AccessControlAPIResponse<Role>>;
+}
+//# sourceMappingURL=RolesClient.d.ts.map

package/lib/esm/subClients/RolesClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RolesClient.d.ts","sourceRoot":"","sources":["../../../src/subClients/RolesClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,wBAAwB,EAAE,YAAY,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AACnG,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,qBAAa,WAAY,SAAQ,UAAW,YAAW,YAAY;IACjE;;;;QAII;IACS,kBAAkB,CAC7B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,wBAAwB,CAAC,IAAI,EAAE,CAAC,CAAC;IAK5C;;;;QAII;IACS,iBAAiB,CAC5B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;IAK1C;;;;;QAKI;IACS,oBAAoB,CAC/B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,OAAO,GACZ,OAAO,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;IAK1C;;;;;QAKI;IACS,oBAAoB,CAC/B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC;IAK/C;;;;;;QAMI;IACS,oBAAoB,CAC/B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,OAAO,GACZ,OAAO,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;CAI3C"}