@itwin/access-control-client 0.1.0

package/lib/esm/subClients/RolesClient.js

@@ -0,0 +1,53 @@
+import { BaseClient } from "./BaseClient";
+export class RolesClient extends 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");
+    }
+}
+//# sourceMappingURL=RolesClient.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"RolesClient.js","sourceRoot":"","sources":["../../../src/subClients/RolesClient.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,MAAM,OAAO,WAAY,SAAQ,UAAU;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","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/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@itwin/access-control-client",
+  "version": "0.1.0",
+  "description": "Access control client for the iTwin platform",
+  "main": "lib/cjs/access-control-client.js",
+  "module": "lib/esm/access-control-client.js",
+  "typings": "lib/cjs/access-control-client",
+  "scripts": {
+    "build": "npm run -s build:cjs && npm run -s build:esm",
+    "build:cjs": "tsc 1>&2 --outDir lib/cjs",
+    "build:esm": "tsc 1>&2 --module ES2020 --outDir lib/esm",
+    "clean": "rimraf lib",
+    "lint": "eslint -f visualstudio \"./src/**/*.ts\" 1>&2",
+    "lint:fix": "npm run lint -- --fix",
+    "webpackTests": "webpack --config ./src/test/utils/webpack.config.js 1>&2",
+    "test": "npm run -s webpackTests && npm run -s test:chrome",
+    "test:chrome": "certa -r chrome",
+    "test:electron": "certa -r electron",
+    "pack": "npm pack"
+  },
+  "dependencies": {
+    "axios": "^0.27.2"
+  },
+  "devDependencies": {
+    "@itwin/build-tools": "^3.0.0",
+    "@itwin/certa": "^3.0.0",
+    "@itwin/core-bentley": "^3.0.0",
+    "@itwin/eslint-plugin": "^3.0.0",
+    "@itwin/oidc-signin-tool": "^3.2.0",
+    "@types/chai": "^4.1.4",
+    "@types/jest": "^28.1.6",
+    "@types/mocha": "^8.2.2",
+    "@types/node": "14.14.31",
+    "chai": "^4.1.2",
+    "dotenv": "^10.0.0",
+    "dotenv-expand": "^5.1.0",
+    "eslint": "^7.11.0",
+    "mocha": "^8.3.2",
+    "rimraf": "^3.0.2",
+    "source-map-loader": "^1.0.0",
+    "typescript": "~4.4.0",
+    "webpack": "4.42.0",
+    "webpack-cli": "^4.9.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/iTwin/access-control-client"
+  },
+  "author": {
+    "name": "Bentley Systems, Inc",
+    "url": "http://www.bentley.com"
+  },
+  "license": "MIT",
+  "keywords": [
+    "Bentley",
+    "iTwin",
+    "access-control"
+  ],
+  "eslintConfig": {
+    "plugins": [
+      "@itwin"
+    ],
+    "extends": "plugin:@itwin/itwinjs-recommended",
+    "rules": {
+      "no-duplicate-imports": "off",
+      "@typescript-eslint/consistent-type-imports": "error"
+    }
+  }
+}