mftsccs-node 0.2.14 → 0.2.16

package/dist/types/Services/AccessControl/AccessControlService.d.ts

@@ -1,267 +1,139 @@
-import { PermissionSet } from "./PermissionSet";
+/**
+ * AccessControlService
+ *
+ * This service provides access control functionality including:
+ * - Check access for concepts with complex permission logic
+ * - Assign and revoke access permissions
+ * - Bulk operations for access management
+ * - Super admin checks with caching
+ * - Access inheritance management
+ *
+ * This is the TypeScript equivalent of the C# AccessControlService class.
+ * All methods are static and can be called directly on the class.
+ */
+import { AccessResult, BulkAccessRequest } from '../../DataStructures/AccessControl/AccessControlModels';
+import { PermissionSet } from './PermissionSet';
 export declare class AccessControlService {
-    private static accessCache;
-    private static baseUrl;
+    private static cacheService;
+    private static apiClient;
     private static initialize;
     /**
-     * Checks if a user or entity has the specified access for a single concept.
-     * @param userId - The user's ID.
-     * @param access - The required PermissionSet.
-     * @param conceptId - The concept ID to check.
-     * @param entityId - Optional entity ID (defaults to userId).
-     * @returns Promise<boolean> - True if access is granted, false otherwise.
+     * Check whether a user/entity has the specified permission.
+     * Returns true if allowed, false otherwise.
+     *
+     * @param conceptId - The ID of the concept to check access for
+     * @param permission - The permission to check (PermissionSet flags)
+     * @param entityId - Optional entity ID to check access for
+     * @returns Promise<boolean> - True if access is granted, false otherwise
      */
-    static checkAccessOfConcept(userId: number, access: PermissionSet, conceptId: number, entityId?: number): Promise<boolean>;
+    static checkAccess(conceptId: number, permission: PermissionSet, entityId?: number | null): Promise<boolean>;
     /**
-     * Checks if a user or entity has the specified access for all concepts in a list.
-     * @param userId - The user's ID.
-     * @param access - The required PermissionSet.
-     * @param conceptIdList - Array of concept IDs to check.
-     * @param entityId - Optional entity ID (defaults to userId).
-     * @returns Promise<boolean> - True if access is granted for all, false otherwise.
+     * Get all conceptIds which have a certain permission for an entity.
+     * Optional filter by a list of conceptIds.
+     *
+     * @param permission - The permission to check (PermissionSet flags)
+     * @param conceptIdsFilter - List of concept IDs to filter
+     * @param entityId - Optional entity ID
+     * @returns Promise<number[]> - Array of concept IDs that have the permission
      */
-    static checkAccessOfConceptList(userId: number, access: PermissionSet, conceptIdList: number[], entityId?: number): Promise<boolean>;
+    static getConceptIdsWithPermission(permission: PermissionSet, conceptIdsFilter: number[], entityId?: number | null): Promise<number[]>;
     /**
-     * Filters a list of concept IDs, returning only those for which the user or entity has the specified access.
-     * @param userId - The user's ID.
-     * @param access - The required PermissionSet.
-     * @param conceptIdList - Array of concept IDs to filter.
-     * @param entityId - Optional entity ID (defaults to userId).
-     * @returns Promise<number[]> - Array of concept IDs with access.
+     * Assign access permission to an entity
+     *
+     * @param conceptId - The concept ID to assign access for
+     * @param permission - The permission to assign (PermissionSet flags)
+     * @param entityId - Optional entity ID
+     * @returns Promise<boolean> - True if successful, false otherwise
      */
-    static filterConceptListByAccess(userId: number, access: PermissionSet, conceptIdList: number[], entityId?: number): Promise<number[]>;
+    static assignAccess(conceptId: number, permission: PermissionSet, entityId?: number | null): Promise<boolean>;
     /**
-     * Gets the entity ID for a given user ID.
-     * @param userId - The user's ID.
-     * @returns number - The entity ID (default: userId).
+     * Assign access permissions to multiple targets in bulk
+     *
+     * @param request - Bulk access request containing targets
+     * @returns Promise<AccessResult[]> - Array of access results
      */
-    private static getEntityIdConceptByUserId;
+    static assignAccessBulk(request: BulkAccessRequest): Promise<AccessResult[]>;
     /**
-     * Assigns access to a specific entity for a concept.
-     * @param request - Object containing conceptId, access, entityId, makePublic.
-     * @returns Promise<any> - API response.
+     * Revoke access permission from an entity
+     *
+     * @param conceptId - The concept ID to revoke access for
+     * @param permission - The permission to revoke (PermissionSet flags)
+     * @param entityId - Optional entity ID
+     * @returns Promise<boolean> - True if successfully revoked, false otherwise
      */
-    static assignAccessToEntity(request: {
-        conceptId: number;
-        access: string;
-        entityId: number;
-        makePublic: boolean;
-    }): Promise<any>;
+    static revokeAccess(conceptId: number, permission: PermissionSet, entityId?: number | null): Promise<boolean>;
     /**
-     * Assigns public access to a concept or list of concepts.
-     * @param request - Object containing conceptId, accessList, connectionTypeList, nestedAccessLevel, conceptIdList.
-     * @returns Promise<any> - API response.
+     * Revoke access permissions from multiple targets in bulk
+     *
+     * @param request - Bulk access request containing targets
+     * @returns Promise<AccessResult[]> - Array of access results
      */
-    static assignPublicAccess(request: {
-        conceptId: number;
-        accessList: string[];
-        connectionTypeList?: string[];
-        nestedAccessLevel?: number;
-        conceptIdList?: number[];
-    }): Promise<any>;
+    static revokeAccessBulk(request: BulkAccessRequest): Promise<AccessResult[]>;
     /**
-     * Assigns public access to multiple concepts in bulk.
-     * @param request - Object containing conceptIdList, accessList, connectionTypeList, nestedAccessLevel, conceptId.
-     * @returns Promise<any> - API response.
+     * Set access inheritance for a concept
+     *
+     * @param conceptId - The concept ID to set inheritance for
+     * @returns Promise<boolean> - True if successful, false otherwise
      */
-    static assignPublicAccessBlukConcept(request: {
-        conceptIdList: number[];
-        accessList: string[];
-        connectionTypeList?: string[];
-        nestedAccessLevel?: number;
-        conceptId?: number;
-    }): Promise<any>;
+    static setAccessInheritance(conceptId: number): Promise<boolean>;
     /**
-     * Assigns access to multiple entities and concepts in bulk.
-     * @param request - Object containing conceptId, conceptIdList, entityIdList, accessList, connectionTypeList, nestedAccessLevel.
-     * @returns Promise<any> - API response.
+     * Get access inheritance status for a concept
+     *
+     * @param conceptId - The concept ID to check
+     * @param connectionTypeId - The connection type ID (default: 999)
+     * @returns Promise<boolean> - True if inheritance is enabled, false otherwise
      */
-    static assignAccessToEntityBulk(request: {
-        conceptId: number;
-        conceptIdList?: number[];
-        entityIdList: number[];
-        accessList: string[];
-        connectionTypeList?: string[];
-        nestedAccessLevel?: number;
-    }): Promise<any>;
+    static getAccessInheritanceStatus(conceptId: number, connectionTypeId?: number): Promise<boolean>;
     /**
-     * Assigns access to a user for a concept.
-     * @param request - Object containing conceptId, access, userId, makePublic.
-     * @returns Promise<any> - API response.
+     * Set access inheritance status for a concept
+     *
+     * @param conceptId - The concept ID to set inheritance status for
+     * @param isEnabled - Whether to enable or disable inheritance
+     * @param connectionTypeId - The connection type ID (default: 999)
+     * @returns Promise<boolean> - True if successful, false otherwise
      */
-    static assignAccessByUser(request: {
-        conceptId: number;
-        access: string;
-        userId: number;
-        makePublic: boolean;
-    }): Promise<any>;
+    static setAccessInheritanceStatus(conceptId: number, isEnabled: boolean, connectionTypeId?: number): Promise<boolean>;
     /**
-     * Revokes access for an entity from a concept.
-     * @param params - Object containing conceptId, access, entityId.
-     * @returns Promise<any> - API response.
+     * Check if an entity is a super admin
+     * Uses caching for performance
+     *
+     * @param entityId - The entity ID to check
+     * @returns Promise<boolean> - True if super admin, false otherwise
      */
-    static revokeAccess(params: {
-        conceptId: number;
-        access: string;
-        entityId: number;
-    }): Promise<any>;
+    static isSuperAdmin(entityId: number): Promise<boolean>;
     /**
-     * Revokes access for multiple entities in bulk.
-     * @param request - Object containing conceptId, entityIdList, accessList.
-     * @returns Promise<any> - API response.
+     * Assign super admin access to an entity
+     *
+     * @param entityId - The entity ID to grant super admin access to
+     * @returns Promise<number> - The entity ID if successful, 0 otherwise
      */
-    static revokeAccessBulk(request: {
-        conceptId: number;
-        entityIdList: number[];
-        accessList: string[];
-    }): Promise<any>;
+    static assignSuperAdmin(entityId: number): Promise<number>;
     /**
-     * Gets the access list for a concept and user.
-     * @param conceptId - The concept ID.
-     * @param userId - The user ID.
-     * @returns Promise<any> - API response.
+     * Revoke super admin access from an entity
+     *
+     * @param entityId - The entity ID to revoke super admin access from
+     * @returns Promise<string> - Success message or error message
      */
-    static getAccessList(conceptId: number, userId: number): Promise<any>;
+    static revokeSuperAdmin(entityId: number): Promise<string>;
     /**
-     * Gets the public access list for a list of concept IDs.
-     * @param conceptIdList - Array of concept IDs.
-     * @returns Promise<any> - API response.
+     * Convert PermissionSet to string for API calls
      */
-    static getPublicAccessList(conceptIdList: number[]): Promise<any>;
+    private static permissionSetToString;
     /**
-     * Revokes public access for a concept.
-     * @param request - Object containing conceptId, accessList.
-     * @returns Promise<any> - API response.
+     * Internal method to check access via cache or API
+     *
+     * @param accessId - The access ID to check
+     * @param permission - The permission to check (string)
+     * @param entityId - Optional entity ID
+     * @returns Promise<boolean> - True if access is granted, false otherwise
      */
-    static revokePublicAccess(request: {
-        conceptId: number;
-        accessList: string[];
-    }): Promise<any>;
+    private static checkAccessInternal;
     /**
-     * Checks if an entity has a specific permission for a concept.
-     * @param params - Object containing conceptId, permission, entityId.
-     * @returns Promise<any> - API response.
+     * Clear all access cache entries
      */
-    static checkAccess(params: {
-        conceptId: number;
-        permission: string;
-        entityId: number;
-    }): Promise<any>;
+    static clearCache(): void;
     /**
-     * Checks if a user has a specific access for a concept.
-     * @param request - Object containing conceptId, access, userId.
-     * @returns Promise<any> - API response.
+     * Clear super admin cache
      */
-    static checkAccessByUser(request: {
-        conceptId: number;
-        access: string;
-        userId: number;
-    }): Promise<any>;
-    /**
-     * Filters concepts by access for a user.
-     * @param request - Object containing userId, access, conceptIdList, connectionIdList.
-     * @returns Promise<any> - API response.
-     */
-    static filterConceptsByAccess(request: {
-        userId: number;
-        access: string;
-        conceptIdList?: number[];
-        connectionIdList?: number[];
-    }): Promise<any>;
-    /**
-     * Checks access for a user on multiple concepts in bulk.
-     * @param request - Object containing userId, access, conceptIdList.
-     * @returns Promise<any> - API response.
-     */
-    static checkAccessOfConceptBulk(request: {
-        userId: number;
-        access: string;
-        conceptIdList: number[];
-    }): Promise<any>;
-    /**
-     * Gets entities with a specific access for a concept.
-     * @param conceptId - The concept ID.
-     * @param access - The access type.
-     * @returns Promise<any> - API response.
-     */
-    static getEntitiesByAccess(conceptId: number, access: string): Promise<any>;
-    /**
-     * Gets all entities with any access for a concept.
-     * @param conceptId - The concept ID.
-     * @returns Promise<any> - API response.
-     */
-    static getEntitiesWithAccess(conceptId: number): Promise<any>;
-    /**
-     * Gets access groups by entity.
-     * @param entityId - Optional entity ID.
-     * @returns Promise<any> - API response.
-     */
-    static getAccessGroupByEntity(entityId?: number): Promise<any>;
-    /**
-     * Gets access groups by user.
-     * @param userId - Optional user ID.
-     * @returns Promise<any> - API response.
-     */
-    static getAccessGroupByUser(userId?: number): Promise<any>;
-    /**
-     * Gets public access by access IDs.
-     * @param accessIdList - Array of access IDs.
-     * @returns Promise<any> - API response.
-     */
-    static getPublicAccessByAccessIds(accessIdList: number[]): Promise<any>;
-    /**
-     * Gets the full access mapping for public users.
-     * @returns Promise<any> - API response.
-     */
-    static getFullAccessMappingForPublic(): Promise<any>;
-    /**
-     * Assigns public access for all users.
-     * @returns Promise<any> - API response.
-     */
-    static assignPublicAccessForAllUser(): Promise<any>;
-    /**
-     * Assigns access by connection type for users.
-     * @returns Promise<any> - API response.
-     */
-    static assignAccessByConncetionTypeOfUser(): Promise<any>;
-    /**
-     * Sets access inheritance for a concept.
-     * @param request - Object containing mainConceptId, enable, connectionTypeId.
-     * @returns Promise<any> - API response.
-     */
-    static setAccessInheritance(request: {
-        mainConceptId: number;
-        enable: boolean;
-        connectionTypeId?: number;
-    }): Promise<any>;
-    /**
-     * Gets the status of access inheritance for a concept.
-     * @param mainConceptId - The main concept ID.
-     * @param connectionTypeId - The connection type ID (default: 999).
-     * @returns Promise<any> - API response.
-     */
-    static getAccessInheritanceStatus(mainConceptId: number, connectionTypeId?: number): Promise<any>;
-    /**
-     * Performs a GET request to the backend API.
-     * @param path - The API path.
-     * @param errorMsg - Error message to throw if request fails.
-     * @returns Promise<any> - API response.
-     */
-    private static _get;
-    /**
-     * Performs a POST request to the backend API.
-     * @param path - The API path.
-     * @param body - Request body.
-     * @param errorMsg - Error message to throw if request fails.
-     * @returns Promise<any> - API response.
-     */
-    private static _post;
-    /**
-     * Performs a DELETE request to the backend API.
-     * @param path - The API path.
-     * @param body - Optional request body.
-     * @param errorMsg - Error message to throw if request fails.
-     * @returns Promise<any> - API response.
-     */
-    private static _delete;
+    static clearSuperAdminCache(): void;
 }

package/dist/types/Services/AccessControl/PermissionSet.d.ts

@@ -1,8 +1,23 @@
+/**
+ * Permission set enum (bitwise flags)
+ * Mirrors C# PermissionSet enum
+ */
 export declare enum PermissionSet {
     None = 0,
-    Read = 1,
-    Write = 2,
-    Execute = 4,
+    Read = 1,// 1
+    Write = 2,// 2
+    Execute = 4,// 4
     Delete = 8
 }
+/**
+ * Convert an array of permission strings to a PermissionSet bitfield
+ */
 export declare function getPermissionSetFromStrings(permissions: string[]): PermissionSet;
+/**
+ * Convert a PermissionSet bitfield to an array of permission strings
+ */
+export declare function getStringsFromPermissionSet(permissions: PermissionSet): string[];
+/**
+ * Check if a permission string is valid
+ */
+export declare function isValidPermission(permission: string): boolean;

package/dist/types/Services/AccessControl/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Access Control Services
+ *
+ * This module exports all access control components:
+ * - AccessControlService: Main service for access control operations
+ * - CacheService: In-memory caching for access checks
+ * - APIClientService: HTTP client for access control API endpoints
+ * - PermissionSet: Permission flags and utilities
+ * - Models: Data types for access control operations
+ */
+export { AccessControlService } from './AccessControlService';
+export { CacheService, ICacheService } from './AccessControlCacheService';
+export { APIClientService, IAPIClientService } from './APIClientService';
+export { PermissionSet, getPermissionSetFromStrings, getStringsFromPermissionSet, isValidPermission } from './PermissionSet';
+export { PermissionSet as PermissionSetEnum, AccessRequest, AccessResult, BulkAccessRequest, BulkAccessTarget, BulkCheckAccessRequest, AccessInheritanceRequest, SuperAdminRequest, AccessControlAPIResponse, AccessControlApiResponse, AddAccessByEntityRequest, AddPublicAccessToConcept, AddAccessByEntityBulkRequest, AddAccessByUserRequest, CheckAccessBulk, VALID_PERMISSIONS, isValidPermission as isValidPermissionFromModels } from '../../DataStructures/AccessControl/AccessControlModels';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mftsccs-node",
-  "version": "0.2.14",
+  "version": "0.2.16",
   "environment": "production",
   "description": "Full Pack of concept and connection system",
   "main": "dist/bundle.js",

package/dist/bundle.js.LICENSE.txt

@@ -1 +0,0 @@
-/*! safe-buffer. MIT License. Feross Aboukhadijeh <https://feross.org/opensource> */