@esvndev/es-print-template 0.0.1

package/dist/index.d.ts

@@ -0,0 +1,445 @@
+import { Layout } from 'react-grid-layout';
+import * as react from 'react';
+import { IFColumnSelectTable } from 'react-table-edit';
+
+type ITextAlign = 'center' | 'left' | 'right' | 'initial' | 'start' | 'unset' | 'inherit';
+type IBorder = 'top' | 'left' | 'right' | 'bottom' | 'none' | 'inside' | 'outside' | 'full' | 'vertical' | 'horizontal';
+type DataRecord = Record<string, unknown>;
+type TemplateApiResponse<T = unknown> = Promise<T>;
+type UploadFileApi<T = unknown> = (params: FormData) => TemplateApiResponse<T>;
+type PageSizeKey = 'A4' | 'A4R' | 'A3' | 'A3R' | 'A5' | 'A5R';
+type PageSize = {
+    width: number;
+    height: number;
+};
+type TemplateBreakpoint = 'lg' | 'md' | 'sm' | 'xs' | 'xxs';
+type TemplateGridLayouts = Record<TemplateBreakpoint, Layout[]>;
+type IFNumberFormat = {
+    dateFormat?: string;
+    decimalSeparator?: string;
+    thousandSeparator?: string;
+    colorNegative?: string;
+    prefixNegative?: string;
+    suffixNegative?: string;
+};
+type IColumnType = "number" | "time" | "date" | "week" | "month" | "file" | "quarter" | "year" | "datetime" | "string" | "boolean" | "checkbox" | "color" | null | undefined;
+interface IFDataGeneralSetting {
+    id?: string;
+    organizationId: string;
+    type: 'PrintDocument' | 'ColumnsTable';
+    name: string;
+    category: string;
+    resourceCode: string;
+    value: string;
+    more?: string;
+}
+
+type ITypeEdit = "layout" | "section";
+interface IFPrintDocumentLayoutDisplay {
+    i: string;
+    x: number;
+    y: number;
+    h: number;
+    w: number;
+    max?: number;
+    minW?: number;
+    minH?: number;
+    maxW?: number;
+    static?: boolean;
+}
+interface IFOrganization {
+    id: string;
+    name: string;
+    address: string;
+}
+interface IFPrintDocFile {
+    name: string;
+    path: string;
+    size: number;
+    title: string;
+    type: string;
+    tableFields: string[];
+    virtualPath: string;
+}
+/**
+ * Đại diện cho một tài liệu in
+ */
+interface IFPrintDocument {
+    /** ID tài liệu (tùy chọn) */
+    id?: string;
+    /** Tên tài liệu */
+    name: string;
+    /** Loại tài liệu */
+    type: string;
+    /** Mã chức năng tài liệu */
+    resourceCode: string;
+    /** Có phải tài liệu mặc định không (tùy chọn) */
+    isDefault?: boolean;
+    /** Cấu hình tài liệu in bằng file*/
+    file?: IFPrintDocFile;
+    /** Cấu hình tài liệu in */
+    setting?: IFPrintDocumentSetting;
+    /** Danh sách trường dữ liệu (tùy chọn) */
+    dataFields?: IFPrintDocumentSetupColumn[];
+    /** Danh sách bảng dữ liệu (tùy chọn) */
+    tableFields?: IFPrintDocumentTableField[];
+    more?: string;
+}
+interface IFOptionTypePrint {
+    value: string;
+    label: string;
+    resourceCode: string;
+    /** Danh sách trường dữ liệu (tùy chọn) */
+    dataFields?: IFPrintDocumentSetupColumn[];
+    /** Danh sách bảng dữ liệu (tùy chọn) */
+    tableFields?: IFPrintDocumentTableField[];
+}
+/**
+ * Đại diện một bảng trong tài liệu in
+ */
+interface IFPrintDocumentTableField {
+    /** Tên trường dữ liệu */
+    field: string;
+    /** Danh sách cột của bảng */
+    columns: IFPrintDocumentSetupColumn[];
+    /** Tiêu đề hiển thị của bảng */
+    headerText: string;
+}
+/**
+ * Cấu hình kiểu dữ liệu cho nội dung
+ */
+interface IFDataStyleSetting {
+    /** Màu chữ */
+    color?: string;
+    /** Màu nền */
+    backgroundColor?: string;
+    /** Font chữ */
+    fontFamily?: string;
+    /** Kích thước chữ */
+    fontSize?: number;
+    /** In đậm hay không */
+    bold?: boolean;
+    /** In nghiêng hay không */
+    italic?: boolean;
+    /** Gạch chân hay không */
+    underline?: boolean;
+}
+/**
+ * Cấu hình của tài liệu in
+ */
+interface IFPrintDocumentSetting {
+    /** Cấu hình trang in */
+    pageSetting: PageSetting;
+    /** Kiểu dáng chung */
+    style: IFDataStyleSetting;
+    /** Bố cục của tài liệu (mảng 2 chiều) */
+    layout: IFPrintDocumentLayout[][];
+}
+/**
+ * Định nghĩa bố cục của tài liệu in
+ */
+interface IFPrintDocumentLayout {
+    /** ID của bố cục (tùy chọn) */
+    id?: string;
+    /** Số hàng trong bố cục */
+    rows?: number;
+    /** Độ rộng phần tử trong bố cục */
+    width: number;
+    /** Loại nội dung (bảng, chữ ký, nội dung) */
+    type?: "table" | "signature" | "content";
+    /** Căn chỉnh vị trí */
+    align?: ITextAlign;
+    /** Đường viền */
+    border?: IBorder;
+    /** Các cột con (nếu có) */
+    children?: IFPrintDocumentSetupColumn[][];
+    /** Định nghĩa bảng (nếu type là 'table') */
+    table?: IFPrintDocumentSetupTable;
+    /** Định nghĩa chữ ký (nếu type là 'signature') */
+    signature?: IFPrintDocumentSetupSignature;
+}
+/**
+ * Cấu hình bảng trong tài liệu in
+ */
+interface IFPrintDocumentSetupTable {
+    /** Danh sách cột trong bảng */
+    columns: IFPrintDocumentSetupColumn[];
+    /** Cấu hình kiểu dữ liệu cho header */
+    header: IFDataStyleSetting;
+    /** Cấu hình kiểu dữ liệu cho nội dung */
+    content: IFDataStyleSetting;
+    /** Cấu hình kiểu dữ liệu cho tổng kết */
+    summary: IFDataStyleSetting;
+    /** Text hàng tổng */
+    headerSum?: string;
+    /** Tên trường dữ liệu chính */
+    field: string;
+    /** Danh sách trường cần tính tổng */
+    fieldSums: string[];
+    /** Có phải bảng tổng không */
+    isTotalTable: boolean;
+    /** Có hàng mẫu hay không*/
+    haveSampleRow?: boolean;
+    /** Các trường dùng để tính tổng bảng */
+    fieldTotalTable: string[];
+}
+/**
+ * Cấu hình hình ảnh trong tài liệu in
+ */
+interface IFPrintDocumentSetupImage {
+    /** Chiều cao ảnh */
+    height: number;
+    /** Chiều rộng ảnh */
+    width: number;
+    /** Khoảng cách từ lề trái (tùy chọn) */
+    left?: number;
+    /** Khoảng cách từ lề trên (tùy chọn) */
+    top?: number;
+    /** Ảnh nằm dưới chữ hay không */
+    behindText?: boolean;
+    /** Đường dẫn ảnh */
+    url: string;
+}
+/**
+ * Cấu hình một cột trong bảng hoặc nội dung tài liệu in
+ */
+interface IFPrintDocumentSetupColumn {
+    /** ID của cột (tùy chọn) */
+    id?: string;
+    /** Tiêu đề hiển thị của cột */
+    headerText: string;
+    /** Nội dung hiển thị ở header */
+    headerDisplay?: string;
+    /** Tên trường dữ liệu tương ứng */
+    field?: string;
+    /** Loại dữ liệu của cột */
+    type?: "text" | "template" | "image" | "data" | "blank";
+    /** Kiểu dữ liệu (số, ngày, chuỗi) */
+    dataType?: "number" | "date" | "string" | "QrCode" | "BarCode";
+    /** Định dạng hiển thị dữ liệu */
+    format?: string;
+    /** Độ rộng của cột */
+    width?: number;
+    /** Chiều cao của cột (tính theo hàng) */
+    rows?: number;
+    /** Số phần thập phân (nếu là số) */
+    fraction?: number;
+    /** Cấu hình kiểu dáng của cột */
+    style?: IFDataStyleSetting;
+    /** Cấu hình ảnh (nếu type là 'image') */
+    imageSetting?: IFPrintDocumentSetupImage;
+    /** Căn chỉnh tiêu đề */
+    headerAlign?: "left" | "right" | "center";
+    /** Các cột con (chỉ dùng cho bảng và dữ liệu text có chứa dữ liệu nhiều trường) */
+    children?: IFPrintDocumentSetupColumn[];
+    /** Gộp cột (chỉ dùng cho bảng) */
+    colspan?: number;
+    /** Gộp hàng (chỉ dùng cho bảng) */
+    rowspan?: number;
+}
+/**
+ * Cấu hình trang in
+ */
+interface PageSetting {
+    /** Lề trên */
+    marginTop: number;
+    /** Lề dưới */
+    marginBottom: number;
+    /** Lề trái */
+    marginLeft: number;
+    /** Lề phải */
+    marginRight: number;
+    /** Màu nền trang */
+    background?: string;
+    /** Kích thước trang */
+    pageSize?: "A4" | "A4R" | "A3" | "A3R" | "A5" | "A5R";
+    /** Độ trong suốt của trang */
+    opacity?: number;
+    /** Khoảng cách giữa các phần trong trang */
+    spaceLayout?: number;
+    /** Danh sách hình ảnh trong trang */
+    images?: IFPrintDocumentSetupImage[];
+}
+/**
+ * Cấu hình chữ ký trong tài liệu in
+ */
+interface IFPrintDocumentSetupSignature {
+    /** Cấu hình chữ ký */
+    setting: IFDataSetupSignature;
+    /** Kiểu dáng chữ ký */
+    style?: IFDataStyleSetting;
+}
+interface IFPrintDocOrganizationApi {
+    id: string;
+    organization: string;
+    setting?: IFPrintDocumentSetting;
+    file?: IFPrintDocFile;
+    data: DataRecord[];
+    typePage: string;
+}
+/**
+ * API tài liệu in
+ */
+interface IFPrintDocumentApi {
+    /** Tổ chức sử dụng tài liệu này */
+    organization: IFOrganization;
+    /** Cấu hình tài liệu */
+    setting?: IFPrintDocumentSetting;
+    /** Cấu hình tài liệu in bằng file*/
+    file?: IFPrintDocFile;
+    /** Loại trang */
+    typePage?: string;
+    /** dữ liệu in */
+    data: DataRecord[];
+    /** Danh sách trường dữ liệu (tùy chọn) */
+    dataFields?: IFPrintDocumentSetupColumn[];
+    /** Danh sách bảng dữ liệu (tùy chọn) */
+    tableFields?: IFPrintDocumentTableField[];
+}
+/**
+ * Cấu hình chữ ký trong tài liệu in
+ */
+interface IFDataSetupSignature {
+    /** Tiêu đề chữ ký */
+    title: string;
+    /** Danh sách chữ ký chi tiết */
+    detail: IFDataSetupSignatureDetail[];
+    /** In tên người ký lên chứng từ, báo cáo */
+    reportSigning?: number;
+    /** Lấy tên người lập biểu theo tài khoản đăng nhập */
+    loginSigning?: number;
+}
+/**
+ * Chi tiết của một chữ ký
+ */
+interface IFDataSetupSignatureDetail {
+    /** ID chữ ký (tùy chọn) */
+    id?: string;
+    /** Vị trí chữ ký */
+    position: string;
+    /** Tiêu đề chữ ký */
+    title?: string;
+    /** Tên người ký */
+    name?: string;
+    /** Mã chữ ký / trường dữ liệu*/
+    code: string;
+    /** Là chữ ký từ dữ liệu phiếu */
+    isSignForm?: boolean;
+}
+
+type IFieldConfig = {
+    name: any;
+    label: any;
+    type: 'select';
+    options: any[];
+} | {
+    name: any;
+    label: any;
+    type?: 'string' | undefined;
+    options?: never;
+};
+
+type IFActionPrint = {
+    /** Điều kiện hiển thị*/
+    condition?: {
+        /** Dư liệu dòng*/
+        rowData: any;
+        /** Danh sách điều kiện hiển thị*/
+        listCondition: IFieldConfig[];
+    };
+    /** Kích thước của cửa sổ (window size), có thể dùng để xác định layout in */
+    windowSize: any;
+    /** Tên mẫu in mặc định */
+    defaultNameTemplate: string;
+    /** Thuộc tính có lấy dữ liệu ban đầu khi khỏi tạo không?*/
+    isLoadOnInit?: boolean;
+    /** Thuộc tính diable in*/
+    isDisabled?: boolean;
+    /** Có hiện tên hay không */
+    showTitle?: boolean;
+    /** Tổ chức, dùng để xác định dữ liệu liên quan khi in */
+    organization: IFOrganization;
+    /** Cấu hình chữ ký trong tài liệu in */
+    signatures?: IFDataSetupSignature;
+    /** Cấu hình format số trong tài liệu in */
+    formatNumber: IFNumberFormat;
+    /** Danh sách tùy chọn kiểu in mặc định */
+    defaultOptionTypePrint: IFPrintDocument[];
+    /** Url xem PDF */
+    DOCUMENT_URL_VIEW: string;
+    /** Url cnd*/
+    CDN_URL_VIEW: string;
+    containerDropDown?: string | HTMLElement | React.RefObject<HTMLElement> | undefined;
+    /**
+     * API lấy danh sách cấu hình hộp cài đặt chung
+     * @param params - Tham số truyền lên API
+     */
+    getListBoxGeneralSettingApi: (params: any) => Promise<any>;
+    /**
+     * API cập nhật cấu hình chung
+     * @param params - Tham số cập nhật
+     */
+    updateGeneralSettingApi: (params: any) => Promise<any>;
+    /**
+   * Hàm lấy thông tin lọc in hàng loạt
+   * @param params - Tham số lọc, phân trang
+   * @returns Promise trả về dữ liệu
+   */
+    handleFilterPrint?: (data: any) => string;
+    /**
+     * API lấy dữ liệu phân trang
+     * @param params - Tham số lọc, phân trang
+     * @returns Promise trả về dữ liệu
+     */
+    getPagingDataApi?: (params: any) => Promise<any>;
+    /**
+     * API upload file
+     * @param params - Dữ liệu file cần upload
+     * @returns Promise trả về kết quả upload
+     */
+    uploadFileApi: (params: any) => Promise<any>;
+    /**
+     * API thực hiện in
+     * @param params - Tham số cấu hình in
+     * @returns Promise trả về kết quả in
+     */
+    exportApi: (params: IFPrintDocumentApi) => Promise<any>;
+    /**
+     * API xuất file sau khi merge dữ liệu
+     * @param params - Tham số cấu hình merge
+     * @returns Promise trả về kết quả file
+     */
+    printApi: (params: IFPrintDocumentApi) => Promise<any>;
+    /**
+     * Thực hiện lấy dữ liệu cần in
+     * @param type - Loại mẫu in
+     * @returns Promise trả về dữ liệu cần in
+     */
+    handlGetDataPrint: (type: string, name: string) => Promise<any>;
+    /**
+     * API Xóa cấu hình in
+     * @param params - id cấu hình in
+     * @returns Promise trả về kết quả in
+     */
+    deleteGeneralSettingApi: (params: string) => Promise<any>;
+    /**
+     * Tùy chọn thay thế
+     */
+    optionalFields?: {
+        field: string;
+        label: string;
+        isClearable?: boolean;
+        loadOptions?: any;
+        columns?: IFColumnSelectTable[];
+        fieldLabel?: string;
+        fieldValue?: string;
+        options: any[];
+        callback: (val: any, item: any) => void;
+    }[];
+};
+type IFPrintComponentRef = {
+    getListTemplate: any;
+};
+declare const PrintComponent: react.ForwardRefExoticComponent<IFActionPrint & react.RefAttributes<IFPrintComponentRef>>;
+
+export { DataRecord, IBorder, IColumnType, IFActionPrint, IFDataGeneralSetting, IFDataSetupSignature, IFDataSetupSignatureDetail, IFDataStyleSetting, IFNumberFormat, IFOptionTypePrint, IFOrganization, IFPrintComponentRef, IFPrintDocFile, IFPrintDocOrganizationApi, IFPrintDocument, IFPrintDocumentApi, IFPrintDocumentLayout, IFPrintDocumentLayoutDisplay, IFPrintDocumentSetting, IFPrintDocumentSetupColumn, IFPrintDocumentSetupImage, IFPrintDocumentSetupSignature, IFPrintDocumentSetupTable, IFPrintDocumentTableField, ITextAlign, ITypeEdit, PageSetting, PageSize, PageSizeKey, TemplateApiResponse, TemplateBreakpoint, TemplateGridLayouts, UploadFileApi, PrintComponent as default };