mftsccs-node 0.2.15 → 0.2.17

package/dist/types/DataStructures/AccessControl/AccessControlModels.d.ts

@@ -0,0 +1,144 @@
+/**
+ * Data models for V1 Access Control Service
+ * These models mirror the C# FreeSchema.Models.AccessControl types
+ */
+/**
+ * Permission set enum (bitwise flags)
+ * Mirrors C# PermissionSet enum
+ */
+export declare enum PermissionSet {
+    None = 0,
+    Read = 1,// 1
+    Write = 2,// 2
+    Execute = 4,// 4
+    Delete = 8
+}
+/**
+ * Request model for single access operations (check, assign, revoke)
+ */
+export interface AccessRequest {
+    accessId?: number | null;
+    permission: string;
+    entityId?: number | null;
+}
+/**
+ * Result model for access operations
+ */
+export interface AccessResult {
+    accessId: number;
+    permission: string;
+    entityId?: number | null;
+    hasAccess: boolean;
+}
+/**
+ * Target for bulk access operations
+ */
+export interface BulkAccessTarget {
+    entityId?: number | null;
+    permissions: string[];
+}
+/**
+ * Request model for bulk access operations
+ */
+export interface BulkAccessRequest {
+    accessId?: number | null;
+    targets: BulkAccessTarget[];
+}
+/**
+ * Request model for bulk check access operations
+ */
+export interface BulkCheckAccessRequest {
+    accessId: number;
+    targets: BulkAccessTarget[];
+}
+/**
+ * Request model for access inheritance operations
+ */
+export interface AccessInheritanceRequest {
+    accessId?: number | null;
+    connectionTypeId?: number;
+    enable?: boolean;
+}
+/**
+ * Request model for super admin operations
+ */
+export interface SuperAdminRequest {
+    accessId?: number | null;
+}
+/**
+ * Standard API response wrapper for access control endpoints
+ */
+export interface AccessControlAPIResponse<T = unknown> {
+    status: boolean;
+    message?: string;
+    data?: T;
+}
+/**
+ * Valid permissions for validation
+ */
+export declare const VALID_PERMISSIONS: Set<string>;
+/**
+ * Check if a permission string is valid
+ */
+export declare function isValidPermission(permission: string): boolean;
+/**
+ * Request model for adding access by entity
+ * Mirrors C# AddAccessByEntityRequest
+ */
+export interface AddAccessByEntityRequest {
+    conceptId: number;
+    access: string;
+    entityId: number;
+    makePublic: boolean;
+    nestedAccessLevel: number;
+}
+/**
+ * Request model for adding public access to concept
+ * Mirrors C# AddPublicAccessToConcept
+ */
+export interface AddPublicAccessToConcept {
+    conceptId: number;
+    conceptIdList: number[];
+    accessList: string[];
+    nestedAccessLevel: number;
+}
+/**
+ * Request model for bulk adding access by entity
+ * Mirrors C# AddAccessByEntityBulkRequest
+ */
+export interface AddAccessByEntityBulkRequest {
+    conceptId: number;
+    conceptIdList: number[];
+    entityIdList: number[];
+    accessList: string[];
+    nestedAccessLevel: number;
+}
+/**
+ * Request model for adding access by user
+ * Mirrors C# AddAccessByUserRequest
+ */
+export interface AddAccessByUserRequest {
+    conceptId: number;
+    access: string;
+    userId: number;
+    makePublic: boolean;
+}
+/**
+ * Request model for checking bulk access
+ * Mirrors C# CheckAccessBulk
+ */
+export interface CheckAccessBulk {
+    userId: number;
+    access: string;
+    conceptIdList: number[];
+    connectionIdList: number[];
+}
+/**
+ * Alternative API response format
+ * Mirrors C# AccessControlApiResponse
+ */
+export interface AccessControlApiResponse {
+    success?: boolean | null;
+    data?: unknown;
+    message?: string | null;
+}

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

@@ -0,0 +1,87 @@
+/**
+ * APIClientService
+ *
+ * API client service for Access Control endpoints.
+ * Provides typed HTTP methods for all access control API operations.
+ *
+ * This is the TypeScript equivalent of the C# APIClientService class.
+ */
+import { AccessRequest, AccessResult, AccessControlAPIResponse, BulkAccessRequest, BulkCheckAccessRequest, AccessInheritanceRequest, SuperAdminRequest } from '../../DataStructures/AccessControl/AccessControlModels';
+export interface IAPIClientService {
+    assignAccessAsync(request: AccessRequest): Promise<AccessControlAPIResponse<AccessResult>>;
+    checkAccessAsync(request: AccessRequest): Promise<AccessControlAPIResponse<AccessResult>>;
+    revokeAccessAsync(request: AccessRequest): Promise<AccessControlAPIResponse<AccessResult>>;
+    assignAccessBulkAsync(request: BulkAccessRequest): Promise<AccessControlAPIResponse<AccessResult[]>>;
+    revokeAccessBulkAsync(request: BulkAccessRequest): Promise<AccessControlAPIResponse<AccessResult[]>>;
+    checkAccessBulkAsync(request: BulkCheckAccessRequest): Promise<AccessControlAPIResponse<AccessResult[]>>;
+    getAccessByIdAsync(accessId: number): Promise<AccessControlAPIResponse<AccessResult[]>>;
+    setAccessInheritanceAsync(request: AccessInheritanceRequest): Promise<AccessControlAPIResponse>;
+    getAccessInheritanceStatusAsync(accessId: number, connectionTypeId?: number): Promise<AccessControlAPIResponse>;
+    assignSuperAdminAccessAsync(request: SuperAdminRequest): Promise<AccessControlAPIResponse>;
+    revokeSuperAdminAccessAsync(request: SuperAdminRequest): Promise<AccessControlAPIResponse>;
+    checkSuperAdminStatusAsync(accessId: number): Promise<AccessControlAPIResponse>;
+}
+export declare class APIClientService implements IAPIClientService {
+    private readonly baseUrl;
+    constructor(baseUrl?: string);
+    /**
+     * Perform a GET request and return typed response
+     */
+    private getAsync;
+    /**
+     * Perform a POST request with JSON body and return typed response
+     */
+    private postAsync;
+    /**
+     * Perform a DELETE request with optional JSON body and return typed response
+     */
+    private deleteAsync;
+    /**
+     * Assign access to an entity
+     */
+    assignAccessAsync(request: AccessRequest): Promise<AccessControlAPIResponse<AccessResult>>;
+    /**
+     * Check if an entity has access
+     */
+    checkAccessAsync(request: AccessRequest): Promise<AccessControlAPIResponse<AccessResult>>;
+    /**
+     * Revoke access from an entity
+     */
+    revokeAccessAsync(request: AccessRequest): Promise<AccessControlAPIResponse<AccessResult>>;
+    /**
+     * Assign access to multiple targets in bulk
+     */
+    assignAccessBulkAsync(request: BulkAccessRequest): Promise<AccessControlAPIResponse<AccessResult[]>>;
+    /**
+     * Revoke access from multiple targets in bulk
+     */
+    revokeAccessBulkAsync(request: BulkAccessRequest): Promise<AccessControlAPIResponse<AccessResult[]>>;
+    /**
+     * Check access for multiple targets in bulk
+     */
+    checkAccessBulkAsync(request: BulkCheckAccessRequest): Promise<AccessControlAPIResponse<AccessResult[]>>;
+    /**
+     * Get all access entries for a specific accessId
+     */
+    getAccessByIdAsync(accessId: number): Promise<AccessControlAPIResponse<AccessResult[]>>;
+    /**
+     * Set access inheritance for an access ID
+     */
+    setAccessInheritanceAsync(request: AccessInheritanceRequest): Promise<AccessControlAPIResponse>;
+    /**
+     * Get access inheritance status
+     */
+    getAccessInheritanceStatusAsync(accessId: number, connectionTypeId?: number): Promise<AccessControlAPIResponse>;
+    /**
+     * Assign super admin access
+     */
+    assignSuperAdminAccessAsync(request: SuperAdminRequest): Promise<AccessControlAPIResponse>;
+    /**
+     * Revoke super admin access
+     */
+    revokeSuperAdminAccessAsync(request: SuperAdminRequest): Promise<AccessControlAPIResponse>;
+    /**
+     * Check super admin status
+     */
+    checkSuperAdminStatusAsync(accessId: number): Promise<AccessControlAPIResponse>;
+}

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

@@ -1,19 +1,74 @@
-import { PermissionSet } from './PermissionSet';
-export declare class AccessControlCacheService {
-    private readonly userAccessCache;
-    private readonly publicAccessCache;
-    private readonly baseUrl;
-    constructor();
-    loadCacheFromApi(entityId?: number): Promise<void>;
-    loadCacheFromJson(jsonData: any): void;
-    hasAccess(entityId: number, conceptId: number, required: PermissionSet): Promise<boolean>;
-    getAccessibleConcepts(entityId: number, conceptIds: number[], required: PermissionSet): Promise<number[]>;
-    getAccessByUser(entityId: number): Promise<Map<number, PermissionSet>>;
-    getAccessByConcept(conceptId: number): Promise<Map<number, PermissionSet>>;
-    deleteRecordByUserId(entityId: number): void;
-    deletePublicAccessRecordById(conceptId: number): void;
-    clearCache(): void;
-    getConceptsByPublicAccess(): Promise<Record<number, string[]>>;
-    hasPublicAccess(conceptId: number, required: PermissionSet): Promise<boolean>;
-    getConceptsWithPublicAccess(conceptIds: number[], required: PermissionSet): Promise<number[]>;
+/**
+ * CacheService
+ *
+ * Thread-safe in-memory cache for access checks.
+ * Supports single and bulk queries with secondary indexes.
+ * Key format: "{accessId}:{permission}:{entityId}"
+ * Value: boolean (HasAccess)
+ *
+ * This is the TypeScript equivalent of the C# CacheService class.
+ */
+export interface ICacheService {
+    get(accessId: number, permission: string, entityId?: number | null): boolean | null;
+    set(accessId: number, permission: string, entityId: number | null | undefined, hasAccess: boolean): void;
+    remove(accessId: number, permission: string, entityId?: number | null): void;
+    clear(): void;
+    getPermissionsByAccessAndEntity(accessId: number, entityId?: number | null): Map<string, boolean>;
+    getPermissionsByAccess(accessId: number): Map<string, boolean>;
+    getPermissionsByEntity(entityId: number): Map<string, boolean>;
+    getSuperAdmin(entityId: number): boolean | null;
+    setSuperAdmin(entityId: number, isSuperAdmin: boolean): void;
+    clearSuperAdminCache(): void;
+}
+export declare class CacheService implements ICacheService {
+    private readonly accessCache;
+    private readonly accessIndex;
+    private readonly entityIndex;
+    private static readonly superAdminCache;
+    /**
+     * Generate a cache key from accessId, permission, and entityId
+     */
+    private generateKey;
+    /**
+     * Get cached access. Returns true/false if present, null if not cached.
+     */
+    get(accessId: number, permission: string, entityId?: number | null): boolean | null;
+    /**
+     * Set or update cached access
+     */
+    set(accessId: number, permission: string, entityId: number | null | undefined, hasAccess: boolean): void;
+    /**
+     * Remove a cached entry (e.g., after revoke)
+     */
+    remove(accessId: number, permission: string, entityId?: number | null): void;
+    /**
+     * Clear all cached access entries
+     */
+    clear(): void;
+    /**
+     * Get all permissions for a specific accessId + entityId
+     */
+    getPermissionsByAccessAndEntity(accessId: number, entityId?: number | null): Map<string, boolean>;
+    /**
+     * Get all permissions for a specific accessId across all entities
+     * Returns a Map with key tuple (entityId, permission) and value hasAccess
+     */
+    getPermissionsByAccess(accessId: number): Map<string, boolean>;
+    /**
+     * Get all permissions for a specific entity across all accessIds
+     * Returns a Map with key tuple (accessId, permission) and value hasAccess
+     */
+    getPermissionsByEntity(entityId: number): Map<string, boolean>;
+    /**
+     * Get cached super admin status for an entity
+     */
+    getSuperAdmin(entityId: number): boolean | null;
+    /**
+     * Set super admin status for an entity
+     */
+    setSuperAdmin(entityId: number, isSuperAdmin: boolean): void;
+    /**
+     * Clear the super admin cache
+     */
+    clearSuperAdminCache(): void;
 }