@illuminateeducation/dna-atd-frontend 1.0.1 → 1.0.2-DNAATD-3045-v3-POC.0

package/dist/src/features/reports/codeBasedJasper/components/ReportFilters.vue.d.ts

@@ -0,0 +1,18 @@
+import { ReportData } from '../services/codeBasedJasperApi';
+type __VLS_Props = {
+    formData?: ReportData;
+    extraHtml?: string;
+};
+declare function getFormData(): Record<string, unknown>;
+declare function submitForm(): void;
+declare const _default: import('vue').DefineComponent<__VLS_Props, {
+    getFormData: typeof getFormData;
+    submitForm: typeof submitForm;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    "form-submitted": (data: Record<string, unknown>) => any;
+    "field-changed": (fieldName: string, value: unknown) => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
+    "onForm-submitted"?: ((data: Record<string, unknown>) => any) | undefined;
+    "onField-changed"?: ((fieldName: string, value: unknown) => any) | undefined;
+}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/src/features/reports/codeBasedJasper/components/ReportPagination.vue.d.ts

@@ -0,0 +1,11 @@
+import { PaginationData } from '../services/codeBasedJasperApi';
+type __VLS_Props = {
+    pagination: PaginationData;
+    loading?: boolean;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    "page-changed": (page: number) => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
+    "onPage-changed"?: ((page: number) => any) | undefined;
+}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/dist/src/features/reports/codeBasedJasper/components/ReportViewer.vue.d.ts

@@ -0,0 +1,16 @@
+import { PaginationData } from '../services/codeBasedJasperApi';
+type __VLS_Props = {
+    html: string;
+    iframeSrc?: string | null;
+    usesVisualizeJs?: boolean;
+    usesItemPreviewJs?: boolean;
+    pagination?: PaginationData;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    "page-changed": (page: number) => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
+    "onPage-changed"?: ((page: number) => any) | undefined;
+}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
+    iframeRef: HTMLIFrameElement;
+}, HTMLDivElement>;
+export default _default;

package/dist/src/features/reports/codeBasedJasper/composables/useCodeBasedJasper.d.ts

@@ -0,0 +1,184 @@
+/**
+ * @file useCodeBasedJasper.ts
+ * @description Vue composable for Code Based Jasper Report functionality
+ * @author Illuminate Education
+ * @lastUpdated 2025-01-03
+ *
+ * @responsibilities
+ * - Provides reactive access to Code Based Jasper store
+ * - Exposes report data and loading states
+ * - Wraps API calls with error handling
+ * - Simplifies component integration
+ */
+export declare function useCodeBasedJasper(): {
+    reportData: import('vue').Ref<{
+        form_html?: string | undefined;
+        form_fields?: Record<string, {
+            label?: string;
+            default?: unknown;
+            options?: Record<string, string>;
+            required?: boolean;
+            disabled?: boolean;
+        }> | undefined;
+        demographic_fields?: Record<string, {
+            label?: string;
+            default?: unknown;
+            options?: Record<string, string>;
+            required?: boolean;
+            disabled?: boolean;
+        }> | undefined;
+        form_action?: string | undefined;
+        form_method?: string | undefined;
+        hidden_fields?: Record<string, unknown> | undefined;
+        form_data?: Record<string, unknown> | undefined;
+        selected_filter_options?: Record<string, unknown> | undefined;
+        additional_field_names?: string[] | undefined;
+        additional_fields?: Record<string, {
+            label?: string;
+            default?: unknown;
+            options?: Record<string, string>;
+            required?: boolean;
+            disabled?: boolean;
+            control?: "select" | "checkbox" | "text";
+        }> | undefined;
+        additional_fields_html?: Record<string, string> | undefined;
+        extra_html?: string | undefined;
+        report_html?: string | undefined;
+        pagination?: {
+            currentPage: number;
+            totalPages: number;
+            hasNext: boolean;
+            hasPrev: boolean;
+        } | undefined;
+        has_assessment_finder?: boolean | undefined;
+        cascading_field_names?: string[] | undefined;
+        multiple_assessment_ids_data?: {
+            label?: string | undefined;
+            value?: string | undefined;
+            selected?: {
+                [x: string]: unknown;
+                type_id: number;
+                title: string;
+                date_administered?: string | undefined;
+                author?: string | undefined;
+            }[] | undefined;
+        } | undefined;
+        assessment_finder_form_html?: string | undefined;
+        assessment_finder_data?: {
+            filters: {
+                year: Record<string, string>;
+                grade: Record<string, string>;
+                subject: Record<string, string>;
+                sub_type: Record<string, string>;
+                type_id: Record<string, string>;
+                date_taken: Record<string, string>;
+            };
+            defaults: Record<string, unknown>;
+            placeholders: Record<string, string>;
+            selected_assessments?: unknown[] | undefined;
+        } | undefined;
+        assessment_finder_extra_html?: string | undefined;
+        favorites?: unknown;
+        drilldown_fields?: string[] | undefined;
+        debug_report?: string | undefined;
+    } | null, import('../services/codeBasedJasperApi').ReportData | {
+        form_html?: string | undefined;
+        form_fields?: Record<string, {
+            label?: string;
+            default?: unknown;
+            options?: Record<string, string>;
+            required?: boolean;
+            disabled?: boolean;
+        }> | undefined;
+        demographic_fields?: Record<string, {
+            label?: string;
+            default?: unknown;
+            options?: Record<string, string>;
+            required?: boolean;
+            disabled?: boolean;
+        }> | undefined;
+        form_action?: string | undefined;
+        form_method?: string | undefined;
+        hidden_fields?: Record<string, unknown> | undefined;
+        form_data?: Record<string, unknown> | undefined;
+        selected_filter_options?: Record<string, unknown> | undefined;
+        additional_field_names?: string[] | undefined;
+        additional_fields?: Record<string, {
+            label?: string;
+            default?: unknown;
+            options?: Record<string, string>;
+            required?: boolean;
+            disabled?: boolean;
+            control?: "select" | "checkbox" | "text";
+        }> | undefined;
+        additional_fields_html?: Record<string, string> | undefined;
+        extra_html?: string | undefined;
+        report_html?: string | undefined;
+        pagination?: {
+            currentPage: number;
+            totalPages: number;
+            hasNext: boolean;
+            hasPrev: boolean;
+        } | undefined;
+        has_assessment_finder?: boolean | undefined;
+        cascading_field_names?: string[] | undefined;
+        multiple_assessment_ids_data?: {
+            label?: string | undefined;
+            value?: string | undefined;
+            selected?: {
+                [x: string]: unknown;
+                type_id: number;
+                title: string;
+                date_administered?: string | undefined;
+                author?: string | undefined;
+            }[] | undefined;
+        } | undefined;
+        assessment_finder_form_html?: string | undefined;
+        assessment_finder_data?: {
+            filters: {
+                year: Record<string, string>;
+                grade: Record<string, string>;
+                subject: Record<string, string>;
+                sub_type: Record<string, string>;
+                type_id: Record<string, string>;
+                date_taken: Record<string, string>;
+            };
+            defaults: Record<string, unknown>;
+            placeholders: Record<string, string>;
+            selected_assessments?: unknown[] | undefined;
+        } | undefined;
+        assessment_finder_extra_html?: string | undefined;
+        favorites?: unknown;
+        drilldown_fields?: string[] | undefined;
+        debug_report?: string | undefined;
+    } | null>;
+    reportHtml: import('vue').Ref<string | null, string | null>;
+    pagination: import('vue').Ref<{
+        currentPage: number;
+        totalPages: number;
+        hasNext: boolean;
+        hasPrev: boolean;
+    }, import('../services/codeBasedJasperApi').PaginationData | {
+        currentPage: number;
+        totalPages: number;
+        hasNext: boolean;
+        hasPrev: boolean;
+    }>;
+    isLoading: import('vue').Ref<boolean, boolean>;
+    isGeneratingDownload: import('vue').Ref<boolean, boolean>;
+    isFavorite: import('vue').Ref<boolean, boolean>;
+    debugReport: import('vue').Ref<string | null, string | null>;
+    hasReport: import('vue').ComputedRef<boolean>;
+    canShowFavorites: import('vue').ComputedRef<boolean>;
+    loadReportData: (params?: Record<string, unknown>) => Promise<import('../services/codeBasedJasperApi').ReportData>;
+    changeScope: (params: Record<string, unknown>) => Promise<import('../services/codeBasedJasperApi').ScopeChangeResponse>;
+    generateReport: (data: Record<string, unknown>) => Promise<import('../services/codeBasedJasperApi').GenerateReportResponse>;
+    loadReportHtml: (params?: Record<string, unknown>) => Promise<{
+        report_html: string;
+        pagination?: import('../services/codeBasedJasperApi').PaginationData;
+    }>;
+    downloadReport: (data: Record<string, unknown>) => Promise<import('../services/codeBasedJasperApi').DownloadReportResponse>;
+    loadFavorites: (jasperPrebuiltId: number | string) => Promise<import('../services/codeBasedJasperApi').FavoritesResponse>;
+    toggleFavorite: (jasperPrebuiltId: number | string) => Promise<import('../services/codeBasedJasperApi').ToggleFavoriteResponse>;
+    reset: () => void;
+};

package/dist/src/features/reports/codeBasedJasper/mount.d.ts

@@ -0,0 +1 @@
+export declare function mountCodeBasedJasperReport(elementId?: string): import('vue').App<Element> | null;

package/dist/src/features/reports/codeBasedJasper/services/codeBasedJasperApi.d.ts

@@ -0,0 +1,190 @@
+/**
+ * @file codeBasedJasperApi.ts
+ * @description API service for Code Based Jasper Report endpoints
+ * @author Illuminate Education
+ * @lastUpdated 2025-01-03
+ *
+ * @responsibilities
+ * - Provides typed API methods for Code Based Jasper Report operations
+ * - Handles request/response formatting following bulk assessment pattern
+ * - Response format: { payload: {...}, status: 'OK' | 'Bad Request', error: '...' }
+ */
+export type { FormFieldData, FormDataWithFields, InitialData } from '../types';
+export type CodeBasedJasperResponse<T = unknown> = {
+    payload: T;
+    status: 'OK' | 'Bad Request';
+    error?: string;
+    debug_message?: string;
+    debug_data?: unknown;
+};
+export type ReportData = {
+    form_html?: string;
+    form_fields?: Record<string, {
+        label?: string;
+        default?: unknown;
+        options?: Record<string, string>;
+        required?: boolean;
+        disabled?: boolean;
+    }>;
+    demographic_fields?: ReportData['form_fields'];
+    form_action?: string;
+    form_method?: string;
+    hidden_fields?: Record<string, unknown>;
+    form_data?: Record<string, unknown>;
+    selected_filter_options?: Record<string, unknown>;
+    additional_field_names?: string[];
+    additional_fields?: Record<string, {
+        label?: string;
+        default?: unknown;
+        options?: Record<string, string>;
+        required?: boolean;
+        disabled?: boolean;
+        control?: 'select' | 'checkbox' | 'text';
+    }>;
+    additional_fields_html?: Record<string, string>;
+    extra_html?: string;
+    report_html?: string;
+    pagination?: PaginationData;
+    has_assessment_finder?: boolean;
+    cascading_field_names?: string[];
+    multiple_assessment_ids_data?: {
+        label?: string;
+        value?: string;
+        selected?: Array<{
+            type_id: number;
+            title: string;
+            date_administered?: string;
+            author?: string;
+            [key: string]: unknown;
+        }>;
+    };
+    assessment_finder_form_html?: string;
+    assessment_finder_data?: {
+        filters: {
+            year: Record<string, string>;
+            grade: Record<string, string>;
+            subject: Record<string, string>;
+            sub_type: Record<string, string>;
+            type_id: Record<string, string>;
+            date_taken: Record<string, string>;
+        };
+        defaults: Record<string, unknown>;
+        placeholders: Record<string, string>;
+        selected_assessments?: unknown[];
+    };
+    assessment_finder_extra_html?: string;
+    favorites?: unknown;
+    drilldown_fields?: string[];
+    debug_report?: string;
+};
+export type PaginationData = {
+    currentPage: number;
+    totalPages: number;
+    hasNext: boolean;
+    hasPrev: boolean;
+};
+export type ScopeChangeResponse = {
+    form_fields?: ReportData['form_fields'];
+    demographic_fields?: ReportData['demographic_fields'];
+};
+export type GenerateReportResponse = {
+    uses_visualize_js?: boolean;
+    visualize_js_url?: string;
+    background_process_id?: string;
+};
+export type DownloadReportResponse = {
+    download_url?: string;
+    blob?: Blob;
+    content_type?: string;
+    filename?: string;
+};
+export type BackgroundJobStatus = {
+    status: string;
+    background_process?: {
+        id: number | string;
+        status: string;
+        name?: string;
+        start_time?: string;
+        end_time?: string;
+        user_notice?: string;
+    };
+};
+export type FavoritesResponse = {
+    favorites: Array<{
+        jasper_prebuilt_id: number | string;
+    }>;
+};
+export type ToggleFavoriteResponse = {
+    is_favorite: boolean;
+};
+declare class CodeBasedJasperApiService {
+    private getBaseRequestParams;
+    private request;
+    /**
+     * List courses for the Courses autocomplete (remote search)
+     */
+    listCourses(params: Record<string, unknown>): Promise<{
+        courses: Array<{
+            value: string;
+            title: string;
+        }>;
+        count: number;
+    }>;
+    /**
+     * Get initial report data including form fields and current filters
+     */
+    getReportData(params?: Record<string, unknown>): Promise<ReportData>;
+    /**
+     * Handle scope changes (AJAX)
+     */
+    changeScope(params: Record<string, unknown>): Promise<ScopeChangeResponse>;
+    /**
+     * List assessments based on search criteria
+     */
+    listAssessments(searchParams: Record<string, unknown>): Promise<{
+        assessments: Array<{
+            type_id: number;
+            title: string;
+            date_administered: string;
+            author?: string;
+            [key: string]: unknown;
+        }>;
+        headers?: Record<string, string>;
+        count?: number;
+        error_message?: string;
+    }>;
+    /**
+     * Generate report with parameters
+     */
+    generateReport(data: Record<string, unknown>): Promise<GenerateReportResponse>;
+    /**
+     * Get report HTML
+     */
+    getReportHtml(params?: Record<string, unknown>): Promise<{
+        report_html: string;
+        pagination?: PaginationData;
+    }>;
+    /**
+     * Download report (PDF, Excel, Word)
+     */
+    downloadReport(data: Record<string, unknown>): Promise<DownloadReportResponse>;
+    /**
+     * Poll background job status (legacy endpoint used by BackgroundProcessStatusChecker)
+     */
+    getBackgroundJobStatus(background_process_id: number | string): Promise<BackgroundJobStatus>;
+    /**
+     * Generate drilldown report
+     */
+    drilldown(data: Record<string, unknown>): Promise<unknown>;
+    /**
+     * Get favorites data
+     */
+    getFavorites(): Promise<FavoritesResponse>;
+    /**
+     * Toggle favorite (add/remove)
+     */
+    toggleFavorite(data: {
+        jasper_prebuilt_id: number | string;
+    }): Promise<ToggleFavoriteResponse>;
+}
+export declare const codeBasedJasperApi: CodeBasedJasperApiService;