@acorex/connectivity 20.6.0-next.6 → 20.6.0-next.7

package/api/index.d.ts

@@ -9,6 +9,8 @@ import { AXPApplicationLoader, AXPApplication, AXPFeatureLoader, AXPFeature, AXP
 import * as i3 from '@acorex/connectivity/utils';
 import * as i1 from '@acorex/platform/runtime';
 import { Observable } from 'rxjs';
+import * as _acorex_modules_report_management from '@acorex/modules/report-management';
+import { AXPReportCategoryProvider, AXPReportCategory, AXPReportDefinitionProvider, AXPReportDefinition } from '@acorex/modules/report-management';
 
 declare class AXCApiEntityStorageService implements AXPEntityStorageService<string, any> {
     private http;
@@ -234,5 +236,192 @@ declare class APIGoogleStrategy extends AXPAuthStrategy {
     static ɵprov: i0.ɵɵInjectableDeclaration<APIGoogleStrategy>;
 }
 
-export { APIGoogleStrategy, AXCAPIOidcStrategy, AXCApiEntityStorageService, AXCApiModule, AXCReportManagementApiModule, AXMConfigurationService, AXMOidcApplicationLoader, AXMOidcFeatureLoader, AXMOidcPermissionLoader, AXMOidcTenantLoader };
-export type { AXPOAuthExternalCredentials, AXPUserPassCredentials, ApplicationConfiguration, Auth, Culture, IAuthenticationDataModel, Language, Localization, NameValue, Resource };
+/**
+ * Execute Report DTO - Response from report execution API
+ */
+interface AXPExecuteReportDto {
+    type: string;
+    items: Record<string, unknown>[];
+    totalCount: number;
+}
+/**
+ * API Response for Category endpoint
+ * Used by: GET /api/v1/global/report-management/category
+ *          GET /api/v1/global/report-management/category/{parentId}
+ */
+interface AXCReportCategoryApiResponse {
+    totalCount: number;
+    items: AXCReportCategoryApiItem[];
+}
+/**
+ * Category Item with recursive structure
+ * Each category can contain child categories (folderItems) and reports (reportDefinitionItems)
+ */
+interface AXCReportCategoryApiItem {
+    reportCategoryParentId: string | null;
+    name: string;
+    title: string;
+    description: string | null;
+    folderCount: number;
+    itemCount: number;
+    isArchived: boolean;
+    reportDefinitionItems: AXCReportDefinitionApiItem[];
+    folderItems: AXCReportCategoryApiItem[];
+    id: string;
+}
+/**
+ * Report Definition Item (in category list, without full layout)
+ */
+interface AXCReportDefinitionApiItem {
+    categoryIds: string[];
+    name: string;
+    title: string;
+    description: string | null;
+    isArchived: boolean;
+    id: string;
+}
+/**
+ * Full Report Definition with complete details including layouts
+ * Used by: GET /api/v1/global/report-management/report/{reportId}
+ */
+interface AXCReportDefinitionApiResponse {
+    id: string;
+    name: string;
+    title: string;
+    description: string | null;
+    categoryIds: string[];
+    parameterGroups: AXCReportParameterGroup[];
+    layouts: AXCReportLayoutDefinition[];
+    defaultLayoutId: string;
+}
+/**
+ * Parameter Group for report parameters
+ */
+interface AXCReportParameterGroup {
+    name: string;
+    title: string;
+    parameters: AXCReportParameter[];
+}
+/**
+ * Report Parameter definition
+ */
+interface AXCReportParameter {
+    path: string;
+    title: string;
+    description?: string;
+    widget: {
+        type: string;
+        path?: string | null;
+        options?: any;
+        valueTransforms?: any;
+    };
+}
+/**
+ * Layout Definition for report display
+ */
+interface AXCReportLayoutDefinition {
+    id: string;
+    title: string;
+    layout: any;
+    dataSource?: {
+        type: string;
+        name?: string;
+        provider?: string;
+    };
+    export?: {
+        fileNameTemplate: string;
+        pdf?: any;
+        excel?: any;
+        csv?: any;
+    };
+    isDefault?: boolean;
+}
+declare class AXCReportManagementDataService {
+    private readonly http;
+    private readonly configs;
+    private readonly baseUrl;
+    private categoryDataCache;
+    private rootCategoriesCache;
+    private pendingRequests;
+    private pendingRootCategoriesRequest;
+    /**
+     * Fetch root categories (no parent). Only root categories without reports and children.
+     * Uses cache and pending requests to avoid duplicate API calls.
+     */
+    getRootCategories(): Promise<AXCReportCategoryApiItem[]>;
+    /**
+     * Fetch category data for a given parentId.
+     * Returns the parent category with its FolderItems (children) and ReportDefinitionItems (reports).
+     * Uses cache to avoid duplicate API calls.
+     */
+    getCategoryData(parentId: string): Promise<AXCReportCategoryApiItem | undefined>;
+    /**
+     * Fetch both child categories and reports for a given parentId.
+     * This method ensures only one API call is made and both results are returned.
+     */
+    getCategoryChildrenAndReports(parentId: string): Promise<{
+        categories: AXCReportCategoryApiItem[];
+        reports: AXCReportDefinitionApiItem[];
+    }>;
+    /**
+     * Fetch child categories of a given parent.
+     * Uses getCategoryData to get FolderItems (children) from the parent category.
+     */
+    getChildCategories(parentId: string): Promise<AXCReportCategoryApiItem[]>;
+    /**
+     * Fetch report definitions that belong to a specific category.
+     * Uses getCategoryData to get ReportDefinitionItems (reports) from the category.
+     */
+    getCategoryReports(categoryId: string): Promise<AXCReportDefinitionApiItem[]>;
+    /**
+     * Fetch a single category by id.
+     * First checks cache, then uses getCategoryData if not found in cache.
+     */
+    getCategoryById(id: string): Promise<AXCReportCategoryApiItem | undefined>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AXCReportManagementDataService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AXCReportManagementDataService>;
+}
+/**
+ * Category provider that uses the shared data service.
+ * Both providers use the same dataService instance which ensures proper caching.
+ */
+declare class AXCReportCategoryApiProvider implements AXPReportCategoryProvider {
+    private readonly dataService;
+    getList(parentId?: string): Promise<AXPReportCategory[]>;
+    getById(id: string): Promise<AXPReportCategory | undefined>;
+    private mapApiCategoryToReportCategory;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AXCReportCategoryApiProvider, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AXCReportCategoryApiProvider>;
+}
+/**
+ * Definition provider that uses the shared data service.
+ * Both providers use the same dataService instance which ensures proper caching.
+ */
+declare class AXCReportDefinitionApiProvider implements AXPReportDefinitionProvider {
+    private readonly dataService;
+    private readonly http;
+    getList(categoryId: string): Promise<AXPReportDefinition[]>;
+    getById(id: string): Promise<AXPReportDefinition | undefined>;
+    private mapApiReportDefinitionItemToReportDefinition;
+    private mapApiReportDefinitionToReportDefinition;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AXCReportDefinitionApiProvider, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AXCReportDefinitionApiProvider>;
+}
+/**
+ * Both providers use the same dataService instance (which is a singleton),
+ * ensuring they share the same cache and only one API call is made when both
+ * getCategories and getReportsByCategoryId are called for the same categoryId.
+ */
+declare const AXC_REPORT_CATEGORY_API_PROVIDER: {
+    provide: i0.InjectionToken<_acorex_modules_report_management.AXPReportCategoryProviderToken[]>;
+    useClass: typeof AXCReportCategoryApiProvider;
+    multi: boolean;
+};
+declare const AXC_REPORT_DEFINITION_API_PROVIDER: {
+    provide: i0.InjectionToken<_acorex_modules_report_management.AXPReportDefinitionProviderToken[]>;
+    useClass: typeof AXCReportDefinitionApiProvider;
+    multi: boolean;
+};
+
+export { APIGoogleStrategy, AXCAPIOidcStrategy, AXCApiEntityStorageService, AXCApiModule, AXCReportCategoryApiProvider, AXCReportDefinitionApiProvider, AXCReportManagementApiModule, AXCReportManagementDataService, AXC_REPORT_CATEGORY_API_PROVIDER, AXC_REPORT_DEFINITION_API_PROVIDER, AXMConfigurationService, AXMOidcApplicationLoader, AXMOidcFeatureLoader, AXMOidcPermissionLoader, AXMOidcTenantLoader };
+export type { AXCReportCategoryApiItem, AXCReportCategoryApiResponse, AXCReportDefinitionApiItem, AXCReportDefinitionApiResponse, AXCReportLayoutDefinition, AXCReportParameter, AXCReportParameterGroup, AXPExecuteReportDto, AXPOAuthExternalCredentials, AXPUserPassCredentials, ApplicationConfiguration, Auth, Culture, IAuthenticationDataModel, Language, Localization, NameValue, Resource };

package/fesm2022/acorex-connectivity-api.mjs

@@ -839,26 +839,142 @@ class AXCReportManagementDataService {
         this.http = inject(HttpClient);
         this.configs = inject(AXP_ROOT_CONFIG_TOKEN);
         this.baseUrl = this.configs.baseUrl;
-        // Shared cache for all categories data
-        this.allCategoriesData = [];
-        this.dataLoaded = false;
-    }
-    async getAllCategoriesData() {
-        if (!this.dataLoaded) {
-            await this.loadAllCategories();
+        // Cache for category data to avoid duplicate API calls
+        this.categoryDataCache = new Map();
+        this.rootCategoriesCache = null;
+        this.pendingRequests = new Map();
+        this.pendingRootCategoriesRequest = null;
+    }
+    //#region ----   Lazy Category/Report Fetching   ----
+    /**
+     * Fetch root categories (no parent). Only root categories without reports and children.
+     * Uses cache and pending requests to avoid duplicate API calls.
+     */
+    async getRootCategories() {
+        // Check if already cached
+        if (this.rootCategoriesCache !== null) {
+            return this.rootCategoriesCache;
         }
-        return this.allCategoriesData;
-    }
-    async loadAllCategories() {
-        const url = `${this.baseUrl}/v1/global/report-management/category`;
-        const params = { Skip: 0, Take: 1000 };
-        const response = await firstValueFrom(this.http.get(url, { params }));
-        this.allCategoriesData = response.items;
-        this.dataLoaded = true;
+        // Check if there's already a pending request
+        if (this.pendingRootCategoriesRequest !== null) {
+            return this.pendingRootCategoriesRequest;
+        }
+        // Create the request and cache it
+        const requestPromise = (async () => {
+            try {
+                const url = `${this.baseUrl}/v1/global/report-management/category`;
+                const params = { Skip: 0, Take: 1000 };
+                const response = await firstValueFrom(this.http.get(url, { params }));
+                const all = response.items ?? [];
+                const rootCategories = all.filter((i) => !i.reportCategoryParentId);
+                // Cache the result
+                this.rootCategoriesCache = rootCategories;
+                return rootCategories;
+            }
+            finally {
+                // Remove from pending requests after completion
+                this.pendingRootCategoriesRequest = null;
+            }
+        })();
+        this.pendingRootCategoriesRequest = requestPromise;
+        return requestPromise;
+    }
+    /**
+     * Fetch category data for a given parentId.
+     * Returns the parent category with its FolderItems (children) and ReportDefinitionItems (reports).
+     * Uses cache to avoid duplicate API calls.
+     */
+    async getCategoryData(parentId) {
+        // Check if already cached
+        if (this.categoryDataCache.has(parentId)) {
+            return this.categoryDataCache.get(parentId);
+        }
+        // Check if there's already a pending request for this category
+        if (this.pendingRequests.has(parentId)) {
+            return this.pendingRequests.get(parentId);
+        }
+        // Create the request and cache it
+        const requestPromise = (async () => {
+            try {
+                const url = `${this.baseUrl}/v1/global/report-management/category/${parentId}`;
+                const response = await firstValueFrom(this.http.get(url));
+                const categoryData = response.items?.[0];
+                // Cache the result
+                this.categoryDataCache.set(parentId, categoryData);
+                return categoryData;
+            }
+            catch {
+                const undefinedResult = undefined;
+                this.categoryDataCache.set(parentId, undefinedResult);
+                return undefinedResult;
+            }
+            finally {
+                // Remove from pending requests after completion
+                this.pendingRequests.delete(parentId);
+            }
+        })();
+        this.pendingRequests.set(parentId, requestPromise);
+        return requestPromise;
+    }
+    /**
+     * Fetch both child categories and reports for a given parentId.
+     * This method ensures only one API call is made and both results are returned.
+     */
+    async getCategoryChildrenAndReports(parentId) {
+        const categoryData = await this.getCategoryData(parentId);
+        return {
+            categories: categoryData?.folderItems ?? [],
+            reports: categoryData?.reportDefinitionItems ?? [],
+        };
     }
-    clearCache() {
-        this.allCategoriesData = [];
-        this.dataLoaded = false;
+    /**
+     * Fetch child categories of a given parent.
+     * Uses getCategoryData to get FolderItems (children) from the parent category.
+     */
+    async getChildCategories(parentId) {
+        const categoryData = await this.getCategoryData(parentId);
+        return categoryData?.folderItems ?? [];
+    }
+    /**
+     * Fetch report definitions that belong to a specific category.
+     * Uses getCategoryData to get ReportDefinitionItems (reports) from the category.
+     */
+    async getCategoryReports(categoryId) {
+        const categoryData = await this.getCategoryData(categoryId);
+        return categoryData?.reportDefinitionItems ?? [];
+    }
+    /**
+     * Fetch a single category by id.
+     * First checks cache, then uses getCategoryData if not found in cache.
+     */
+    async getCategoryById(id) {
+        // First check if it's in cache (from previous getCategoryData calls)
+        if (this.categoryDataCache.has(id)) {
+            return this.categoryDataCache.get(id);
+        }
+        // Try to get from category data endpoint (which will cache it)
+        const categoryData = await this.getCategoryData(id);
+        if (categoryData) {
+            return categoryData;
+        }
+        // Fallback: search in root categories cache
+        if (this.rootCategoriesCache) {
+            const found = this.rootCategoriesCache.find((c) => c.id === id);
+            if (found) {
+                return found;
+            }
+        }
+        // Last resort: search in all categories (but this should rarely happen)
+        try {
+            const url = `${this.baseUrl}/v1/global/report-management/category`;
+            const params = { Skip: 0, Take: 1000 };
+            const response = await firstValueFrom(this.http.get(url, { params }));
+            const all = response.items ?? [];
+            return all.find((c) => c.id === id);
+        }
+        catch {
+            return undefined;
+        }
     }
     static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "20.3.12", ngImport: i0, type: AXCReportManagementDataService, deps: [], target: i0.ɵɵFactoryTarget.Injectable }); }
     static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "20.3.12", ngImport: i0, type: AXCReportManagementDataService }); }
@@ -868,34 +984,29 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.3.12", ngImpo
         }] });
 //#endregion
 //#region ----   API Providers   ----
+/**
+ * Category provider that uses the shared data service.
+ * Both providers use the same dataService instance which ensures proper caching.
+ */
 class AXCReportCategoryApiProvider {
     constructor() {
         this.dataService = inject(AXCReportManagementDataService);
-        // Cache to store processed categories
-        this.categoriesCache = new Map();
     }
     async getList(parentId) {
-        // Check cache first
-        if (this.categoriesCache.has(parentId)) {
-            return this.categoriesCache.get(parentId);
-        }
         try {
-            // Get data from shared service
-            const allCategoriesData = await this.dataService.getAllCategoriesData();
-            // Filter categories based on parentId
-            let filteredItems;
+            // For root level, get root categories (each category includes folderItems in API response)
             if (!parentId) {
-                // Root categories (no parent)
-                filteredItems = allCategoriesData.filter((item) => !item.reportCategoryParentId);
-            }
-            else {
-                // Child categories
-                filteredItems = allCategoriesData.filter((item) => item.reportCategoryParentId === parentId);
+                const filteredItems = await this.dataService.getRootCategories();
+                // Each root category has folderItems in the API response, but we only return the root categories themselves
+                // The folderItems are preserved in the API response structure, similar to child state
+                return filteredItems.map((item) => this.mapApiCategoryToReportCategory(item));
             }
-            const categories = filteredItems.map((item) => this.mapApiCategoryToReportCategory(item));
-            // Cache the result
-            this.categoriesCache.set(parentId, categories);
-            return categories;
+            // For child level, get categories from category data (which includes folderItems)
+            // This ensures we use the same API response that getList for definitions will use
+            // The folderItems structure is preserved, similar to root state
+            const categoryData = await this.dataService.getCategoryData(parentId);
+            const filteredItems = categoryData?.folderItems ?? [];
+            return filteredItems.map((item) => this.mapApiCategoryToReportCategory(item));
         }
         catch (error) {
             console.error('Error fetching report categories:', error);
@@ -904,9 +1015,7 @@ class AXCReportCategoryApiProvider {
     }
     async getById(id) {
         try {
-            // Get data from shared service
-            const allCategoriesData = await this.dataService.getAllCategoriesData();
-            const apiItem = allCategoriesData.find((item) => item.id === id);
+            const apiItem = await this.dataService.getCategoryById(id);
             if (!apiItem) {
                 return undefined;
             }
@@ -927,48 +1036,32 @@ class AXCReportCategoryApiProvider {
             hasReport: apiItem.itemCount > 0, // reportDefinitionItems = files
         };
     }
-    // Method to clear cache when needed
-    clearCache() {
-        this.categoriesCache.clear();
-        this.dataService.clearCache();
-    }
     static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "20.3.12", ngImport: i0, type: AXCReportCategoryApiProvider, deps: [], target: i0.ɵɵFactoryTarget.Injectable }); }
     static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "20.3.12", ngImport: i0, type: AXCReportCategoryApiProvider }); }
 }
 i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.3.12", ngImport: i0, type: AXCReportCategoryApiProvider, decorators: [{
             type: Injectable
         }] });
+/**
+ * Definition provider that uses the shared data service.
+ * Both providers use the same dataService instance which ensures proper caching.
+ */
 class AXCReportDefinitionApiProvider {
     constructor() {
         this.dataService = inject(AXCReportManagementDataService);
         this.http = inject(HttpClient);
-        // Cache to store report definitions by category to avoid unnecessary API calls
-        this.reportDefinitionsCache = new Map();
     }
     async getList(categoryId) {
-        // Check cache first
-        if (this.reportDefinitionsCache.has(categoryId)) {
-            return this.reportDefinitionsCache.get(categoryId);
-        }
         try {
-            // Get data from shared service
-            const allCategoriesData = await this.dataService.getAllCategoriesData();
-            // Find the specific category and extract its report definitions
-            const categoryItem = allCategoriesData.find((item) => item.id === categoryId);
-            if (!categoryItem) {
-                // Cache empty result to avoid repeated API calls
-                this.reportDefinitionsCache.set(categoryId, []);
-                return [];
-            }
-            const reportDefinitions = categoryItem.reportDefinitionItems.map((item) => this.mapApiReportDefinitionItemToReportDefinition(item));
-            // Cache the result
-            this.reportDefinitionsCache.set(categoryId, reportDefinitions);
+            // Use getCategoryData which is cached and shared with getCategories
+            // This ensures only one API call is made when both getCategories and getReportsByCategoryId are called
+            const categoryData = await this.dataService.getCategoryData(categoryId);
+            const defs = categoryData?.reportDefinitionItems ?? [];
+            const reportDefinitions = defs.map((item) => this.mapApiReportDefinitionItemToReportDefinition(item));
             return reportDefinitions;
         }
         catch (error) {
             console.error('Error fetching report definitions:', error);
-            // Cache empty result to avoid repeated failed API calls
-            this.reportDefinitionsCache.set(categoryId, []);
             return [];
         }
     }
@@ -1027,11 +1120,6 @@ class AXCReportDefinitionApiProvider {
         };
         return res;
     }
-    // Method to clear cache when needed
-    clearCache() {
-        this.reportDefinitionsCache.clear();
-        this.dataService.clearCache();
-    }
     static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "20.3.12", ngImport: i0, type: AXCReportDefinitionApiProvider, deps: [], target: i0.ɵɵFactoryTarget.Injectable }); }
     static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "20.3.12", ngImport: i0, type: AXCReportDefinitionApiProvider }); }
 }
@@ -1039,7 +1127,13 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.3.12", ngImpo
             type: Injectable
         }] });
 //#endregion
+//#endregion
 //#region ----   Provider Exports   ----
+/**
+ * Both providers use the same dataService instance (which is a singleton),
+ * ensuring they share the same cache and only one API call is made when both
+ * getCategories and getReportsByCategoryId are called for the same categoryId.
+ */
 const AXC_REPORT_CATEGORY_API_PROVIDER = {
     provide: AXP_REPORT_CATEGORY_PROVIDER,
     useClass: AXCReportCategoryApiProvider,
@@ -1451,5 +1545,5 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.3.12", ngImpo
  * Generated bundle index. Do not edit.
  */
 
-export { APIGoogleStrategy, AXCAPIOidcStrategy, AXCApiEntityStorageService, AXCApiModule, AXCReportManagementApiModule, AXMConfigurationService, AXMOidcApplicationLoader, AXMOidcFeatureLoader, AXMOidcPermissionLoader, AXMOidcTenantLoader };
+export { APIGoogleStrategy, AXCAPIOidcStrategy, AXCApiEntityStorageService, AXCApiModule, AXCReportCategoryApiProvider, AXCReportDefinitionApiProvider, AXCReportManagementApiModule, AXCReportManagementDataService, AXC_REPORT_CATEGORY_API_PROVIDER, AXC_REPORT_DEFINITION_API_PROVIDER, AXMConfigurationService, AXMOidcApplicationLoader, AXMOidcFeatureLoader, AXMOidcPermissionLoader, AXMOidcTenantLoader };
 //# sourceMappingURL=acorex-connectivity-api.mjs.map