@mondaydotcomorg/monday-authorization 3.1.0 → 3.1.1-feature-bashanye-fix-platform-url.d268e4c

package/README.md

@@ -222,3 +222,157 @@ Special notes for asynchronous operations:
 2. To update an existing key, just use upsert operation, it'll override previous value.
 3. Requests with a lot of operations might split to chunks that will be consumed either sequence or in parallel, so there might be a timeframe where some of the operations already applied and some not. Eventually all of them will be applied.
 4. If your MS depends on the access to the asynchronous operation, you can use a health check operation `asyncResourceAttributesHealthCheck` that will return false if it can't reach to SNS or can't find the required topic. Note it doesn't check write permissions so make sure your MS have permissions to write to the SNS topic.
+
+### Roles API
+
+The Roles API allows you to manage roles (both basic and custom) for accounts. Use `RolesService` to retrieve, create, update, and delete roles.
+
+#### Get Roles
+
+Use `RolesService.getRoles` to retrieve all roles for an account:
+
+```ts
+import { RolesService } from '@mondaydotcomorg/monday-authorization';
+
+const rolesService = new RolesService();
+const accountId = 739630;
+const resourceTypes = ['account', 'workspace'];
+const style = 'A'; // or 'B'
+
+const rolesResponse = await rolesService.getRoles(accountId, resourceTypes, style);
+// Returns: { customRoles: CustomRole[], basicRoles?: BasicRole[] }
+```
+
+**Parameters:**
+- `accountId` - The account ID
+- `resourceTypes` - Array of resource types to filter roles by (e.g., ['account', 'workspace'])
+- `style` - Deprecated, don't use it. the style of the roles to return, either 'A' or 'B' (default is 'A'). Note that basic role IDs are returned in A style and not B style.
+
+#### Create Custom Roles
+
+Use `RolesService.createCustomRole` to create custom roles for an account:
+
+```ts
+import { RolesService, RoleType } from '@mondaydotcomorg/monday-authorization';
+
+const rolesService = new RolesService();
+const accountId = 739630;
+const customRoles = [
+  {
+    name: 'Custom Admin Role',
+    resourceType: 'workspace',
+    resourceId: 123,
+    sourceRole: {
+      id: 5,
+      type: RoleType.BASIC,
+    },
+  },
+];
+
+const rolesResponse = await rolesService.createCustomRole(accountId, customRoles);
+```
+
+**Parameters:**
+- `accountId` - The account ID
+- `roles` - Array of `RoleCreateRequest` objects (cannot be empty)
+
+#### Update Custom Roles
+
+Use `RolesService.updateCustomRole` to update existing custom roles:
+
+```ts
+import { RolesService } from '@mondaydotcomorg/monday-authorization';
+
+const rolesService = new RolesService();
+const accountId = 739630;
+const updateRequests = [
+  {
+    id: 1000,
+    updateAttributes: {
+      name: 'Updated Custom Role Name',
+    },
+  },
+];
+
+const rolesResponse = await rolesService.updateCustomRole(accountId, updateRequests);
+```
+
+**Parameters:**
+- `accountId` - The account ID
+- `updateRequests` - Array of `RoleUpdateRequest` objects
+
+#### Delete Custom Roles
+
+Use `RolesService.deleteCustomRole` to delete custom roles:
+
+```ts
+import { RolesService } from '@mondaydotcomorg/monday-authorization';
+
+const rolesService = new RolesService();
+const accountId = 739630;
+const roleIds = [1000, 1001, 1002];
+
+const rolesResponse = await rolesService.deleteCustomRole(accountId, roleIds);
+```
+
+**Parameters:**
+- `accountId` - The account ID
+- `roleIds` - Array of custom role IDs to delete
+
+#### Types
+
+The following types are available for working with roles:
+
+```ts
+import {
+  CustomRole,
+  BasicRole,
+  RoleType,
+  RoleCreateRequest,
+  RoleUpdateRequest,
+  RolesResponse,
+} from '@mondaydotcomorg/monday-authorization';
+
+// CustomRole interface
+interface CustomRole {
+  id?: number;
+  name: string;
+  resourceType: string;
+  resourceId: number;
+  basicRoleId: number;
+  basicRoleType: RoleType;
+}
+
+// BasicRole interface
+interface BasicRole {
+  id: number;
+  resourceType: string;
+  roleType: string;
+  name: string;
+}
+
+// RoleCreateRequest interface
+interface RoleCreateRequest {
+  name: string;
+  resourceType: string;
+  resourceId: number;
+  sourceRole: {
+    id: number;
+    type: RoleType;
+  };
+}
+
+// RoleUpdateRequest interface
+interface RoleUpdateRequest {
+  id: number;
+  updateAttributes: {
+    name: string;
+  };
+}
+
+// RolesResponse interface
+interface RolesResponse {
+  customRoles: CustomRole[];
+  basicRoles?: BasicRole[];
+}
+```

package/dist/authorization-service.js

@@ -333,10 +333,10 @@ function createAuthorizationParams(resources, action) {
     return params;
 }
 function getAuthorizeUrl() {
-    return '/internal_ms/authorization/authorize';
+    return `${process.env.MONDAY_INTERNAL_URL}/internal_ms/authorization/authorize`;
 }
 function getCanActionsInScopesUrl() {
-    return '/internal_ms/authorization/can_actions_in_scopes';
+    return `${process.env.MONDAY_INTERNAL_URL}/internal_ms/authorization/can_actions_in_scopes`;
 }
 
 exports.AuthorizationService = AuthorizationService;

package/dist/esm/authorization-service.mjs

@@ -325,10 +325,10 @@ function createAuthorizationParams(resources, action) {
     return params;
 }
 function getAuthorizeUrl() {
-    return '/internal_ms/authorization/authorize';
+    return `${process.env.MONDAY_INTERNAL_URL}/internal_ms/authorization/authorize`;
 }
 function getCanActionsInScopesUrl() {
-    return '/internal_ms/authorization/can_actions_in_scopes';
+    return `${process.env.MONDAY_INTERNAL_URL}/internal_ms/authorization/can_actions_in_scopes`;
 }
 
 export { AuthorizationService, createAuthorizationParams, setIgniteClient, setRedisClient, setRequestFetchOptions };

package/dist/esm/roles-service.d.ts

@@ -14,11 +14,31 @@ export declare class RolesService {
     /**
      * Get all roles for an account
      * @param accountId - The account ID
+     * @param style - The style of the roles to return, either 'A' or 'B', default is 'A'. 'B' is not deprecated and only available for backward compatibility.
      * @returns - The roles for the account, both basic and custom roles. Note that basic role ids are returned in A style and not B style.
      */
-    getRoles(accountId: number, resourceTypes: string[]): Promise<RolesResponse>;
+    getRoles(accountId: number, resourceTypes: string[], style?: 'A' | 'B'): Promise<RolesResponse>;
+    /**
+     * Create a custom role for an account
+     * @param accountId - The account ID
+     * @param roles - The roles to create
+     * @returns - The created roles
+     * Note that basic role ids should be provided in A style and not in B style.
+     */
     createCustomRole(accountId: number, roles: RoleCreateRequest[]): Promise<RolesResponse>;
+    /**
+     * Delete a custom role for an account
+     * @param accountId - The account ID
+     * @param roleIds - The ids of the roles to delete
+     * @returns - The deleted roles. Note that basic role ids should be provided in A style and not in B style.
+     */
     deleteCustomRole(accountId: number, roleIds: number[]): Promise<RolesResponse>;
+    /**
+     * Update a custom role for an account
+     * @param accountId - The account ID
+     * @param updateRequests - The requests to update the roles
+     * @returns - The updated roles. Note that basic role ids should be provided in A style and not in B style.
+     */
     updateCustomRole(accountId: number, updateRequests: RoleUpdateRequest[]): Promise<RolesResponse>;
     private sendRoleRequest;
 }

package/dist/esm/roles-service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"roles-service.d.ts","sourceRoot":"","sources":["../../src/roles-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAO,aAAa,EAAE,UAAU,EAAE,MAAM,sCAAsC,CAAC;AACtF,OAAO,EAAoB,gBAAgB,EAAE,MAAM,mCAAmC,CAAC;AACvF,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAOlF,qBAAa,YAAY;IACvB,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,YAAY,CAAkC;IACtD,OAAO,CAAC,kBAAkB,CAA4B;IAEtD;;;;OAIG;gBACS,UAAU,CAAC,EAAE,UAAU,EAAE,YAAY,CAAC,EAAE,gBAAgB,CAAC,aAAa,CAAC;IAqBnF;;;;OAIG;IACG,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,aAAa,CAAC;IAI5E,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,iBAAiB,EAAE,GAAG,OAAO,CAAC,aAAa,CAAC;IAUvF,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,aAAa,CAAC;IAM9E,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,iBAAiB,EAAE,GAAG,OAAO,CAAC,aAAa,CAAC;YAMxF,eAAe;CAiC9B"}
+{"version":3,"file":"roles-service.d.ts","sourceRoot":"","sources":["../../src/roles-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAO,aAAa,EAAE,UAAU,EAAE,MAAM,sCAAsC,CAAC;AACtF,OAAO,EAAoB,gBAAgB,EAAE,MAAM,mCAAmC,CAAC;AACvF,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAMlF,qBAAa,YAAY;IACvB,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,YAAY,CAAkC;IACtD,OAAO,CAAC,kBAAkB,CAA4B;IAEtD;;;;OAIG;gBACS,UAAU,CAAC,EAAE,UAAU,EAAE,YAAY,CAAC,EAAE,gBAAgB,CAAC,aAAa,CAAC;IAqBnF;;;;;OAKG;IACG,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,EAAE,KAAK,GAAE,GAAG,GAAG,GAAS,GAAG,OAAO,CAAC,aAAa,CAAC;IAI1G;;;;;;OAMG;IACG,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,iBAAiB,EAAE,GAAG,OAAO,CAAC,aAAa,CAAC;IAU7F;;;;;OAKG;IACG,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,aAAa,CAAC;IAMpF;;;;;OAKG;IACG,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,iBAAiB,EAAE,GAAG,OAAO,CAAC,aAAa,CAAC;YAMxF,eAAe;CAkC9B"}

package/dist/esm/roles-service.mjs

@@ -4,7 +4,6 @@ import { getAttributionsFromApi } from './attributions-service.mjs';
 import { ERROR_MESSAGES, DEFAULT_FETCH_OPTIONS, APP_NAME } from './constants.mjs';
 
 const API_PATH = '/roles/account/{accountId}';
-const A_STYLE_NAME = 'A';
 class RolesService {
     httpClient;
     fetchOptions;
@@ -37,11 +36,19 @@ class RolesService {
     /**
      * Get all roles for an account
      * @param accountId - The account ID
+     * @param style - The style of the roles to return, either 'A' or 'B', default is 'A'. 'B' is not deprecated and only available for backward compatibility.
      * @returns - The roles for the account, both basic and custom roles. Note that basic role ids are returned in A style and not B style.
      */
-    async getRoles(accountId, resourceTypes) {
-        return await this.sendRoleRequest('GET', accountId, {}, { resourceTypes });
+    async getRoles(accountId, resourceTypes, style = 'A') {
+        return await this.sendRoleRequest('GET', accountId, {}, { resourceTypes, style });
     }
+    /**
+     * Create a custom role for an account
+     * @param accountId - The account ID
+     * @param roles - The roles to create
+     * @returns - The created roles
+     * Note that basic role ids should be provided in A style and not in B style.
+     */
     async createCustomRole(accountId, roles) {
         if (roles.length === 0) {
             throw new Error('Roles array cannot be empty');
@@ -50,17 +57,29 @@ class RolesService {
             customRoles: roles,
         });
     }
+    /**
+     * Delete a custom role for an account
+     * @param accountId - The account ID
+     * @param roleIds - The ids of the roles to delete
+     * @returns - The deleted roles. Note that basic role ids should be provided in A style and not in B style.
+     */
     async deleteCustomRole(accountId, roleIds) {
         return await this.sendRoleRequest('DELETE', accountId, {
             ids: roleIds,
         });
     }
+    /**
+     * Update a custom role for an account
+     * @param accountId - The account ID
+     * @param updateRequests - The requests to update the roles
+     * @returns - The updated roles. Note that basic role ids should be provided in A style and not in B style.
+     */
     async updateCustomRole(accountId, updateRequests) {
         return await this.sendRoleRequest('PATCH', accountId, {
             customRoles: updateRequests,
         });
     }
-    async sendRoleRequest(method, accountId, body, additionalQueryParams = {}) {
+    async sendRoleRequest(method, accountId, body, additionalQueryParams = {}, style = 'A') {
         try {
             return await this.httpClient.fetch({
                 url: {
@@ -68,7 +87,7 @@ class RolesService {
                     path: API_PATH.replace('{accountId}', accountId.toString()),
                 },
                 query: {
-                    style: A_STYLE_NAME,
+                    style: style,
                     ...additionalQueryParams,
                 },
                 method,

package/dist/roles-service.d.ts

@@ -14,11 +14,31 @@ export declare class RolesService {
     /**
      * Get all roles for an account
      * @param accountId - The account ID
+     * @param style - The style of the roles to return, either 'A' or 'B', default is 'A'. 'B' is not deprecated and only available for backward compatibility.
      * @returns - The roles for the account, both basic and custom roles. Note that basic role ids are returned in A style and not B style.
      */
-    getRoles(accountId: number, resourceTypes: string[]): Promise<RolesResponse>;
+    getRoles(accountId: number, resourceTypes: string[], style?: 'A' | 'B'): Promise<RolesResponse>;
+    /**
+     * Create a custom role for an account
+     * @param accountId - The account ID
+     * @param roles - The roles to create
+     * @returns - The created roles
+     * Note that basic role ids should be provided in A style and not in B style.
+     */
     createCustomRole(accountId: number, roles: RoleCreateRequest[]): Promise<RolesResponse>;
+    /**
+     * Delete a custom role for an account
+     * @param accountId - The account ID
+     * @param roleIds - The ids of the roles to delete
+     * @returns - The deleted roles. Note that basic role ids should be provided in A style and not in B style.
+     */
     deleteCustomRole(accountId: number, roleIds: number[]): Promise<RolesResponse>;
+    /**
+     * Update a custom role for an account
+     * @param accountId - The account ID
+     * @param updateRequests - The requests to update the roles
+     * @returns - The updated roles. Note that basic role ids should be provided in A style and not in B style.
+     */
     updateCustomRole(accountId: number, updateRequests: RoleUpdateRequest[]): Promise<RolesResponse>;
     private sendRoleRequest;
 }

package/dist/roles-service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"roles-service.d.ts","sourceRoot":"","sources":["../src/roles-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAO,aAAa,EAAE,UAAU,EAAE,MAAM,sCAAsC,CAAC;AACtF,OAAO,EAAoB,gBAAgB,EAAE,MAAM,mCAAmC,CAAC;AACvF,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAOlF,qBAAa,YAAY;IACvB,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,YAAY,CAAkC;IACtD,OAAO,CAAC,kBAAkB,CAA4B;IAEtD;;;;OAIG;gBACS,UAAU,CAAC,EAAE,UAAU,EAAE,YAAY,CAAC,EAAE,gBAAgB,CAAC,aAAa,CAAC;IAqBnF;;;;OAIG;IACG,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,aAAa,CAAC;IAI5E,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,iBAAiB,EAAE,GAAG,OAAO,CAAC,aAAa,CAAC;IAUvF,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,aAAa,CAAC;IAM9E,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,iBAAiB,EAAE,GAAG,OAAO,CAAC,aAAa,CAAC;YAMxF,eAAe;CAiC9B"}
+{"version":3,"file":"roles-service.d.ts","sourceRoot":"","sources":["../src/roles-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAO,aAAa,EAAE,UAAU,EAAE,MAAM,sCAAsC,CAAC;AACtF,OAAO,EAAoB,gBAAgB,EAAE,MAAM,mCAAmC,CAAC;AACvF,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAMlF,qBAAa,YAAY;IACvB,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,YAAY,CAAkC;IACtD,OAAO,CAAC,kBAAkB,CAA4B;IAEtD;;;;OAIG;gBACS,UAAU,CAAC,EAAE,UAAU,EAAE,YAAY,CAAC,EAAE,gBAAgB,CAAC,aAAa,CAAC;IAqBnF;;;;;OAKG;IACG,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,EAAE,KAAK,GAAE,GAAG,GAAG,GAAS,GAAG,OAAO,CAAC,aAAa,CAAC;IAI1G;;;;;;OAMG;IACG,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,iBAAiB,EAAE,GAAG,OAAO,CAAC,aAAa,CAAC;IAU7F;;;;;OAKG;IACG,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,aAAa,CAAC;IAMpF;;;;;OAKG;IACG,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,iBAAiB,EAAE,GAAG,OAAO,CAAC,aAAa,CAAC;YAMxF,eAAe;CAkC9B"}

package/dist/roles-service.js

@@ -6,7 +6,6 @@ const attributionsService = require('./attributions-service.js');
 const constants = require('./constants.js');
 
 const API_PATH = '/roles/account/{accountId}';
-const A_STYLE_NAME = 'A';
 class RolesService {
     httpClient;
     fetchOptions;
@@ -39,11 +38,19 @@ class RolesService {
     /**
      * Get all roles for an account
      * @param accountId - The account ID
+     * @param style - The style of the roles to return, either 'A' or 'B', default is 'A'. 'B' is not deprecated and only available for backward compatibility.
      * @returns - The roles for the account, both basic and custom roles. Note that basic role ids are returned in A style and not B style.
      */
-    async getRoles(accountId, resourceTypes) {
-        return await this.sendRoleRequest('GET', accountId, {}, { resourceTypes });
+    async getRoles(accountId, resourceTypes, style = 'A') {
+        return await this.sendRoleRequest('GET', accountId, {}, { resourceTypes, style });
     }
+    /**
+     * Create a custom role for an account
+     * @param accountId - The account ID
+     * @param roles - The roles to create
+     * @returns - The created roles
+     * Note that basic role ids should be provided in A style and not in B style.
+     */
     async createCustomRole(accountId, roles) {
         if (roles.length === 0) {
             throw new Error('Roles array cannot be empty');
@@ -52,17 +59,29 @@ class RolesService {
             customRoles: roles,
         });
     }
+    /**
+     * Delete a custom role for an account
+     * @param accountId - The account ID
+     * @param roleIds - The ids of the roles to delete
+     * @returns - The deleted roles. Note that basic role ids should be provided in A style and not in B style.
+     */
     async deleteCustomRole(accountId, roleIds) {
         return await this.sendRoleRequest('DELETE', accountId, {
             ids: roleIds,
         });
     }
+    /**
+     * Update a custom role for an account
+     * @param accountId - The account ID
+     * @param updateRequests - The requests to update the roles
+     * @returns - The updated roles. Note that basic role ids should be provided in A style and not in B style.
+     */
     async updateCustomRole(accountId, updateRequests) {
         return await this.sendRoleRequest('PATCH', accountId, {
             customRoles: updateRequests,
         });
     }
-    async sendRoleRequest(method, accountId, body, additionalQueryParams = {}) {
+    async sendRoleRequest(method, accountId, body, additionalQueryParams = {}, style = 'A') {
         try {
             return await this.httpClient.fetch({
                 url: {
@@ -70,7 +89,7 @@ class RolesService {
                     path: API_PATH.replace('{accountId}', accountId.toString()),
                 },
                 query: {
-                    style: A_STYLE_NAME,
+                    style: style,
                     ...additionalQueryParams,
                 },
                 method,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mondaydotcomorg/monday-authorization",
-  "version": "3.1.0",
+  "version": "3.1.1-feature-bashanye-fix-platform-url.d268e4c",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "license": "BSD-3-Clause",