Merge pull request #72 from permitio/maya/per-9025-add-all-tenants-ch…

…eck-for-node-blee Add all tenants check for Node
permitio · Feb 29, 2024 · c642bff · c642bff
2 parents 4c8b23d + 72bd81a
commit c642bff
Show file tree

Hide file tree

Showing 130 changed files with 24,204 additions and 22,889 deletions.
diff --git a/docs/assets/search.js b/docs/assets/search.js
diff --git a/docs/classes/ApiClient.html b/docs/classes/ApiClient.html
diff --git a/docs/classes/ApiContext.html b/docs/classes/ApiContext.html
diff --git a/docs/classes/ConditionSetRulesApi.html b/docs/classes/ConditionSetRulesApi.html
diff --git a/docs/classes/ConditionSetsApi.html b/docs/classes/ConditionSetsApi.html
diff --git a/docs/classes/DeprecatedApiClient.html b/docs/classes/DeprecatedApiClient.html
diff --git a/docs/classes/ElementsClient.html b/docs/classes/ElementsClient.html
diff --git a/docs/classes/EnvironmentsApi.html b/docs/classes/EnvironmentsApi.html
diff --git a/docs/classes/Permit.html b/docs/classes/Permit.html
diff --git a/docs/classes/PermitApiError.html b/docs/classes/PermitApiError.html
diff --git a/docs/classes/PermitConnectionError.html b/docs/classes/PermitConnectionError.html
diff --git a/docs/classes/PermitContextError.html b/docs/classes/PermitContextError.html
diff --git a/docs/classes/PermitError.html b/docs/classes/PermitError.html
diff --git a/docs/classes/PermitPDPStatusError.html b/docs/classes/PermitPDPStatusError.html
diff --git a/docs/classes/ProjectsApi.html b/docs/classes/ProjectsApi.html
diff --git a/docs/classes/ResourceActionGroupsApi.html b/docs/classes/ResourceActionGroupsApi.html
diff --git a/docs/classes/ResourceActionsApi.html b/docs/classes/ResourceActionsApi.html
diff --git a/docs/classes/ResourceAttributesApi.html b/docs/classes/ResourceAttributesApi.html
diff --git a/docs/classes/ResourcesApi.html b/docs/classes/ResourcesApi.html
diff --git a/docs/classes/RoleAssignmentsApi.html b/docs/classes/RoleAssignmentsApi.html
diff --git a/docs/classes/RolesApi.html b/docs/classes/RolesApi.html
diff --git a/docs/classes/TenantsApi.html b/docs/classes/TenantsApi.html
diff --git a/docs/classes/UsersApi.html b/docs/classes/UsersApi.html
diff --git a/docs/enums/APIKeyOwnerType.html b/docs/enums/APIKeyOwnerType.html
diff --git a/docs/enums/ApiKeyLevel.html b/docs/enums/ApiKeyLevel.html
diff --git a/docs/enums/AttributeType.html b/docs/enums/AttributeType.html
diff --git a/docs/enums/ConditionSetType.html b/docs/enums/ConditionSetType.html
diff --git a/docs/enums/ElementsApiErrors.html b/docs/enums/ElementsApiErrors.html
diff --git a/docs/enums/MemberAccessLevel.html b/docs/enums/MemberAccessLevel.html
diff --git a/docs/enums/MemberAccessObj.html b/docs/enums/MemberAccessObj.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/interfaces/APIKeyRead.html b/docs/interfaces/APIKeyRead.html
diff --git a/docs/interfaces/ActionBlockEditable.html b/docs/interfaces/ActionBlockEditable.html
diff --git a/docs/interfaces/ActionBlockRead.html b/docs/interfaces/ActionBlockRead.html
diff --git a/docs/interfaces/AttributeBlockEditable.html b/docs/interfaces/AttributeBlockEditable.html
diff --git a/docs/interfaces/AttributeBlockRead.html b/docs/interfaces/AttributeBlockRead.html
diff --git a/docs/interfaces/BulkRoleAssignmentReport.html b/docs/interfaces/BulkRoleAssignmentReport.html
diff --git a/docs/interfaces/BulkRoleUnAssignmentReport.html b/docs/interfaces/BulkRoleUnAssignmentReport.html
diff --git a/docs/interfaces/ConditionSetCreate.html b/docs/interfaces/ConditionSetCreate.html
diff --git a/docs/interfaces/ConditionSetRead.html b/docs/interfaces/ConditionSetRead.html
diff --git a/docs/interfaces/ConditionSetRuleCreate.html b/docs/interfaces/ConditionSetRuleCreate.html
diff --git a/docs/interfaces/ConditionSetRuleRead.html b/docs/interfaces/ConditionSetRuleRead.html
diff --git a/docs/interfaces/ConditionSetRuleRemove.html b/docs/interfaces/ConditionSetRuleRemove.html
diff --git a/docs/interfaces/ConditionSetUpdate.html b/docs/interfaces/ConditionSetUpdate.html
diff --git a/docs/interfaces/Context.html b/docs/interfaces/Context.html
diff --git a/docs/interfaces/ContextTransform.html b/docs/interfaces/ContextTransform.html
diff --git a/docs/interfaces/EmbeddedLoginRequestOutputWithContent.html b/docs/interfaces/EmbeddedLoginRequestOutputWithContent.html
diff --git a/docs/interfaces/EnvironmentCopy.html b/docs/interfaces/EnvironmentCopy.html
diff --git a/docs/interfaces/EnvironmentCopyScope.html b/docs/interfaces/EnvironmentCopyScope.html
diff --git a/docs/interfaces/EnvironmentCopyScopeFilters.html b/docs/interfaces/EnvironmentCopyScopeFilters.html
diff --git a/docs/interfaces/EnvironmentCopyTarget.html b/docs/interfaces/EnvironmentCopyTarget.html
diff --git a/docs/interfaces/EnvironmentCreate.html b/docs/interfaces/EnvironmentCreate.html
diff --git a/docs/interfaces/EnvironmentRead.html b/docs/interfaces/EnvironmentRead.html
diff --git a/docs/interfaces/EnvironmentStats.html b/docs/interfaces/EnvironmentStats.html
diff --git a/docs/interfaces/EnvironmentUpdate.html b/docs/interfaces/EnvironmentUpdate.html
diff --git a/docs/interfaces/IConditionSetRulesApi.html b/docs/interfaces/IConditionSetRulesApi.html
diff --git a/docs/interfaces/IConditionSetsApi.html b/docs/interfaces/IConditionSetsApi.html
diff --git a/docs/interfaces/ICreateOrUpdateUserResult.html b/docs/interfaces/ICreateOrUpdateUserResult.html
diff --git a/docs/interfaces/IDeprecatedPermitApi.html b/docs/interfaces/IDeprecatedPermitApi.html
diff --git a/docs/interfaces/IDeprecatedReadApis.html b/docs/interfaces/IDeprecatedReadApis.html
diff --git a/docs/interfaces/IDeprecatedWriteApis.html b/docs/interfaces/IDeprecatedWriteApis.html
diff --git a/docs/interfaces/IEnvironmentsApi.html b/docs/interfaces/IEnvironmentsApi.html
diff --git a/docs/interfaces/IGetUserRoles.html b/docs/interfaces/IGetUserRoles.html
diff --git a/docs/interfaces/IListActionGroups.html b/docs/interfaces/IListActionGroups.html
diff --git a/docs/interfaces/IListActions.html b/docs/interfaces/IListActions.html
diff --git a/docs/interfaces/IListAttributes.html b/docs/interfaces/IListAttributes.html
diff --git a/docs/interfaces/IListConditionSetRules.html b/docs/interfaces/IListConditionSetRules.html
diff --git a/docs/interfaces/IListEnvironments.html b/docs/interfaces/IListEnvironments.html
diff --git a/docs/interfaces/IListResourceUsers.html b/docs/interfaces/IListResourceUsers.html
diff --git a/docs/interfaces/IListRoleAssignments.html b/docs/interfaces/IListRoleAssignments.html
diff --git a/docs/interfaces/IListTenantUsers.html b/docs/interfaces/IListTenantUsers.html
diff --git a/docs/interfaces/IPagination.html b/docs/interfaces/IPagination.html
diff --git a/docs/interfaces/IPermitApi.html b/docs/interfaces/IPermitApi.html
diff --git a/docs/interfaces/IPermitClient.html b/docs/interfaces/IPermitClient.html
diff --git a/docs/interfaces/IPermitConfig.html b/docs/interfaces/IPermitConfig.html
diff --git a/docs/interfaces/IPermitElementsApi.html b/docs/interfaces/IPermitElementsApi.html
diff --git a/docs/interfaces/IProjectsApi.html b/docs/interfaces/IProjectsApi.html
diff --git a/docs/interfaces/IResource.html b/docs/interfaces/IResource.html
diff --git a/docs/interfaces/IResourceActionGroupsApi.html b/docs/interfaces/IResourceActionGroupsApi.html
diff --git a/docs/interfaces/IResourceActionsApi.html b/docs/interfaces/IResourceActionsApi.html
diff --git a/docs/interfaces/IResourceAttributesApi.html b/docs/interfaces/IResourceAttributesApi.html
diff --git a/docs/interfaces/IResourcesApi.html b/docs/interfaces/IResourcesApi.html
diff --git a/docs/interfaces/IRoleAssignmentsApi.html b/docs/interfaces/IRoleAssignmentsApi.html
diff --git a/docs/interfaces/IRolesApi.html b/docs/interfaces/IRolesApi.html
diff --git a/docs/interfaces/ITenantsApi.html b/docs/interfaces/ITenantsApi.html
diff --git a/docs/interfaces/IUser.html b/docs/interfaces/IUser.html
diff --git a/docs/interfaces/IUsersApi.html b/docs/interfaces/IUsersApi.html
diff --git a/docs/interfaces/OrgMemberRead.html b/docs/interfaces/OrgMemberRead.html
diff --git a/docs/interfaces/PaginatedResultUserRead.html b/docs/interfaces/PaginatedResultUserRead.html
diff --git a/docs/interfaces/ParentId.html b/docs/interfaces/ParentId.html
diff --git a/docs/interfaces/ProjectCreate.html b/docs/interfaces/ProjectCreate.html
diff --git a/docs/interfaces/ProjectRead.html b/docs/interfaces/ProjectRead.html
diff --git a/docs/interfaces/ProjectUpdate.html b/docs/interfaces/ProjectUpdate.html
diff --git a/docs/interfaces/ResourceActionCreate.html b/docs/interfaces/ResourceActionCreate.html
diff --git a/docs/interfaces/ResourceActionGroupCreate.html b/docs/interfaces/ResourceActionGroupCreate.html
diff --git a/docs/interfaces/ResourceActionGroupRead.html b/docs/interfaces/ResourceActionGroupRead.html
diff --git a/docs/interfaces/ResourceActionRead.html b/docs/interfaces/ResourceActionRead.html
diff --git a/docs/interfaces/ResourceActionUpdate.html b/docs/interfaces/ResourceActionUpdate.html
diff --git a/docs/interfaces/ResourceAttributeCreate.html b/docs/interfaces/ResourceAttributeCreate.html
diff --git a/docs/interfaces/ResourceAttributeRead.html b/docs/interfaces/ResourceAttributeRead.html
diff --git a/docs/interfaces/ResourceAttributeUpdate.html b/docs/interfaces/ResourceAttributeUpdate.html
diff --git a/docs/interfaces/ResourceCreate.html b/docs/interfaces/ResourceCreate.html
diff --git a/docs/interfaces/ResourceId.html b/docs/interfaces/ResourceId.html
diff --git a/docs/interfaces/ResourceRead.html b/docs/interfaces/ResourceRead.html
diff --git a/docs/interfaces/ResourceReplace.html b/docs/interfaces/ResourceReplace.html
diff --git a/docs/interfaces/ResourceUpdate.html b/docs/interfaces/ResourceUpdate.html
diff --git a/docs/interfaces/RoleAssignmentCreate.html b/docs/interfaces/RoleAssignmentCreate.html
diff --git a/docs/interfaces/RoleAssignmentRead.html b/docs/interfaces/RoleAssignmentRead.html
diff --git a/docs/interfaces/RoleAssignmentRemove.html b/docs/interfaces/RoleAssignmentRemove.html
diff --git a/docs/interfaces/RoleCreate.html b/docs/interfaces/RoleCreate.html
diff --git a/docs/interfaces/RoleRead.html b/docs/interfaces/RoleRead.html
diff --git a/docs/interfaces/RoleUpdate.html b/docs/interfaces/RoleUpdate.html
diff --git a/docs/interfaces/Statistics.html b/docs/interfaces/Statistics.html
diff --git a/docs/interfaces/TenantCreate.html b/docs/interfaces/TenantCreate.html
diff --git a/docs/interfaces/TenantRead.html b/docs/interfaces/TenantRead.html
diff --git a/docs/interfaces/TenantUpdate.html b/docs/interfaces/TenantUpdate.html
diff --git a/docs/interfaces/UserCreate.html b/docs/interfaces/UserCreate.html
diff --git a/docs/interfaces/UserInTenant.html b/docs/interfaces/UserInTenant.html
diff --git a/docs/interfaces/UserRead.html b/docs/interfaces/UserRead.html
diff --git a/docs/interfaces/UserRole.html b/docs/interfaces/UserRole.html
diff --git a/docs/interfaces/UserUpdate.html b/docs/interfaces/UserUpdate.html
diff --git a/docs/interfaces/loginAsSchema.html b/docs/interfaces/loginAsSchema.html
diff --git a/docs/modules.html b/docs/modules.html
diff --git a/docs/types/EnvironmentCopyConflictStrategyEnum.html b/docs/types/EnvironmentCopyConflictStrategyEnum.html
diff --git a/docs/types/IAction.html b/docs/types/IAction.html
diff --git a/docs/variables/EnvironmentCopyConflictStrategyEnum-1.html b/docs/variables/EnvironmentCopyConflictStrategyEnum-1.html
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "permitio",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "Node.js client library for the Permit.io full-stack permissions platform",
   "main": "build/main/index.js",
   "typings": "build/main/index.d.ts",

diff --git a/src/enforcement/enforcer.ts b/src/enforcement/enforcer.ts
@@ -6,6 +6,7 @@ import { CheckConfig, Context, ContextStore } from '../utils/context';
 import { AxiosLoggingInterceptor } from '../utils/http-logger';
 
 import {
+  AllTenantsResponse,
   BulkOpaDecisionResult,
   BulkPolicyDecision,
   IAction,
@@ -18,6 +19,7 @@ import {
   OpaDecisionResult,
   OpaGetUserPermissionsResult,
   PolicyDecision,
+  TenantDetails,
 } from './interfaces';
 
 const RESOURCE_DELIMITER = ':';
@@ -100,6 +102,18 @@ export interface IEnforcer {
     resource_types?: string[],
     config?: CheckConfig,
   ): Promise<IUserPermissions>;
+
+  /**
+   * Get all tenants available in the system.
+   * @returns An array of TenantDetails representing all tenants.
+   */
+  checkAllTenants(
+    user: IUser | string,
+    action: string,
+    resource: IResource | string,
+    context: Context | undefined,
+    sdk: string | undefined,
+  ): Promise<TenantDetails[]>;
 }
 
 /**
@@ -311,6 +325,33 @@ export class Enforcer implements IEnforcer {
       });
   }
 
+  public async checkAllTenants(
+    user: IUser | string,
+    action: string,
+    resource: IResource | string,
+    context: Context = {}, // default to empty context if not provided
+    sdk = 'node', // default to "node" if not provided
+  ): Promise<TenantDetails[]> {
+    try {
+      const response = await this.client.post<AllTenantsResponse>('/allowed/all-tenants', {
+        headers: {
+          Authorization: `Bearer ${this.config.token}`,
+          'X-Permit-Sdk-Language': sdk,
+        },
+        params: {
+          user,
+          action,
+          resource,
+          context,
+        },
+      });
+      return response.data.allowedTenants.map((item) => item.tenant);
+    } catch (error) {
+      this.logger.error('Error fetching all tenants:', error);
+      throw error;
+    }
+  }
+
   public async check(
     user: IUser | string,
     action: IAction,
@@ -423,6 +464,7 @@ export class Enforcer implements IEnforcer {
       check: this.check.bind(this),
       bulkCheck: this.bulkCheck.bind(this),
       getUserPermissions: this.getUserPermissions.bind(this),
+      checkAllTenants: this.checkAllTenants.bind(this),
     };
   }
 }
diff --git a/src/enforcement/interfaces.ts b/src/enforcement/interfaces.ts
@@ -126,6 +126,21 @@ export interface OpaDecisionResult {
   result: PolicyDecision;
 }
 
+export interface TenantDetails {
+  key: string;
+  attributes: {
+    [id: string]: any;
+  };
+}
+
+export interface AllTenantsCheckResponse {
+  tenant: TenantDetails;
+}
+
+export interface AllTenantsResponse {
+  allowedTenants: AllTenantsCheckResponse[];
+}
+
 interface TenantPermissions {
   permissions: string[];
   tenant?: {
@@ -161,3 +176,4 @@ export interface OpaGetUserPermissionsResult {
 export function isOpaGetUserPermissionsResult(obj: any): obj is OpaGetUserPermissionsResult {
   return 'result' in obj;
 }
+
diff --git a/src/index.ts b/src/index.ts
@@ -5,7 +5,13 @@ import { ApiClient, IPermitApi } from './api/api-client';
 import { ElementsClient, IPermitElementsApi } from './api/elements';
 import { ConfigFactory, IPermitConfig } from './config';
 import { Enforcer, IEnforcer } from './enforcement/enforcer';
-import { ICheckQuery, IResource, IUser, IUserPermissions } from './enforcement/interfaces';
+import {
+  ICheckQuery,
+  IResource,
+  IUser,
+  IUserPermissions,
+  TenantDetails,
+} from './enforcement/interfaces';
 import { LoggerFactory } from './logger';
 import { CheckConfig, Context } from './utils/context';
 import { AxiosLoggingInterceptor } from './utils/http-logger';
@@ -182,6 +188,29 @@ export class Permit implements IPermitClient {
     return await this.enforcer.bulkCheck(checks, context, config);
   }
 
+  /**
+   * Get all tenants available in the system.
+   * @returns An array of TenantDetails representing all tenants.
+   */
+  /**
+   * Get all tenants available in the system.
+   * @returns An array of TenantDetails representing all tenants.
+   */
+  public async checkAllTenants(
+    user: IUser | string,
+    action: string,
+    resource: IResource | string,
+    context?: Context | undefined,
+    sdk?: string | undefined,
+  ): Promise<TenantDetails[]> {
+    try {
+      return await this.enforcer.checkAllTenants(user, action, resource, context, sdk);
+    } catch (error) {
+      this.logger.error('Error fetching all tenants:', error);
+      throw error;
+    }
+  }
+
   /**
    * Get all permissions for the specified user.
    *