@campxdev/pdfme 1.1.0 → 1.2.0

package/dist/types/_vendors/schemas/index.d.ts

@@ -0,0 +1,22 @@
+import multiVariableText from './multiVariableText/index.js';
+import text from './text/index.js';
+import image from './graphics/image.js';
+import svg from './graphics/svg.js';
+import { signature } from './graphics/signature.js';
+import barcodes from './barcodes/index.js';
+import line from './shapes/line.js';
+import table from './tables/index.js';
+import { rectangle, ellipse } from './shapes/rectAndEllipse.js';
+import dateTime from './date/dateTime.js';
+import date from './date/date.js';
+import time from './date/time.js';
+import select from './select/index.js';
+import radioGroup from './radioGroup/index.js';
+import checkbox from './checkbox/index.js';
+import dynamicTable from './dynamicTable/index.js';
+import variableBarcodes, { dynamicQrCode, dynamicBarcode } from './variableBarcode/index.js';
+declare const builtInPlugins: {
+    Text: import('../common/index.js').Plugin<import("./multiVariableText/types.js").MultiVariableTextSchema>;
+};
+export { builtInPlugins, text, multiVariableText, image, svg, signature, table, barcodes, line, rectangle, ellipse, dateTime, date, time, select, radioGroup, checkbox, dynamicTable, variableBarcodes, dynamicQrCode, dynamicBarcode, };
+export { getDynamicHeightsForTable } from './tables/dynamicTemplate.js';

package/dist/types/_vendors/schemas/insertVariableWidget.d.ts

@@ -0,0 +1,9 @@
+import type { PropPanelWidgetProps } from '../common/index.js';
+/**
+ * Factory function that creates an "Insert Variable" widget for a specific schema field.
+ * The widget renders a dropdown of available variables and appends {varName} to the field value.
+ *
+ * @param targetKey - The schema field key to insert variables into (e.g., 'text', 'content')
+ * @returns A PropPanelWidgetProps function that renders the variable picker
+ */
+export declare const createInsertVariableWidget: (targetKey: string) => (props: PropPanelWidgetProps) => void;

package/dist/types/_vendors/schemas/multiVariableText/helper.d.ts

@@ -0,0 +1,3 @@
+import { MultiVariableTextSchema } from './types.js';
+export declare const substituteVariables: (text: string, variablesIn: string | Record<string, string>, extraContext?: Record<string, unknown>) => string;
+export declare const validateVariables: (value: string, schema: MultiVariableTextSchema) => boolean;

package/dist/types/_vendors/schemas/multiVariableText/index.d.ts

@@ -0,0 +1,4 @@
+import type { Plugin } from '../../common/index.js';
+import type { MultiVariableTextSchema } from './types.js';
+declare const schema: Plugin<MultiVariableTextSchema>;
+export default schema;

package/dist/types/_vendors/schemas/multiVariableText/pdfRender.d.ts

@@ -0,0 +1,3 @@
+import { PDFRenderProps } from '../../common/index.js';
+import { MultiVariableTextSchema } from './types.js';
+export declare const pdfRender: (arg: PDFRenderProps<MultiVariableTextSchema>) => Promise<void>;

package/dist/types/_vendors/schemas/multiVariableText/propPanel.d.ts

@@ -0,0 +1,3 @@
+import { PropPanel } from '../../common/index.js';
+import { MultiVariableTextSchema } from './types.js';
+export declare const propPanel: PropPanel<MultiVariableTextSchema>;

package/dist/types/_vendors/schemas/multiVariableText/types.d.ts

@@ -0,0 +1,5 @@
+import type { TextSchema } from '../text/types.js';
+export interface MultiVariableTextSchema extends TextSchema {
+    text?: string;
+    variables?: string[];
+}

package/dist/types/_vendors/schemas/multiVariableText/uiRender.d.ts

@@ -0,0 +1,3 @@
+import { UIRenderProps } from '../../common/index.js';
+import { MultiVariableTextSchema } from './types.js';
+export declare const uiRender: (arg: UIRenderProps<MultiVariableTextSchema>) => Promise<void>;

package/dist/types/_vendors/schemas/radioGroup/index.d.ts

@@ -0,0 +1,7 @@
+import { Plugin, Schema } from '../../common/index.js';
+interface RadioGroup extends Schema {
+    group: string;
+    color: string;
+}
+declare const schema: Plugin<RadioGroup>;
+export default schema;

package/dist/types/_vendors/schemas/select/index.d.ts

@@ -0,0 +1,7 @@
+import { Plugin } from '../../common/index.js';
+import { TextSchema } from '../text/types.js';
+interface Select extends TextSchema {
+    options: string[];
+}
+declare const schema: Plugin<Select>;
+export default schema;

package/dist/types/_vendors/schemas/shapes/line.d.ts

@@ -0,0 +1,6 @@
+import type { Schema, Plugin } from '../../common/index.js';
+interface LineSchema extends Schema {
+    color: string;
+}
+declare const lineSchema: Plugin<LineSchema>;
+export default lineSchema;

package/dist/types/_vendors/schemas/shapes/rectAndEllipse.d.ts

@@ -0,0 +1,175 @@
+import { Schema } from '../../common/index.js';
+interface ShapeSchema extends Schema {
+    type: 'ellipse' | 'rectangle';
+    borderWidth: number;
+    borderColor: string;
+    color: string;
+    radius?: number;
+}
+export declare const rectangle: {
+    propPanel: {
+        defaultSchema: {
+            type: "ellipse" | "rectangle";
+            borderWidth: number;
+            borderColor: string;
+            color: string;
+            radius?: number;
+            name: string;
+            position: {
+                x: number;
+                y: number;
+            };
+            width: number;
+            height: number;
+            content?: string | undefined;
+            rotate?: number | undefined;
+            opacity?: number | undefined;
+            readOnly?: boolean | undefined;
+            required?: boolean | undefined;
+            __bodyRange?: {
+                start: number;
+                end?: number | undefined;
+            } | undefined;
+            __isSplit?: boolean | undefined;
+        };
+        schema: ((propPanelProps: Omit<{
+            rootElement: HTMLDivElement;
+            activeSchema: import('../../common/index.js').SchemaForUI;
+            activeElements: HTMLElement[];
+            changeSchemas: import('../../common/index.js').ChangeSchemas;
+            schemas: import('../../common/index.js').SchemaForUI[];
+            options: import('../../common/index.js').UIOptions;
+            theme: import("antd").GlobalToken;
+            i18n: (key: string) => string;
+        }, "rootElement">) => Record<string, import('../../common/index.js').PropPanelSchema>) | Record<string, import('../../common/index.js').PropPanelSchema>;
+        widgets?: Record<string, (props: import('../../common/index.js').PropPanelWidgetProps) => void>;
+    };
+    icon: string;
+    pdf: (arg: import('../../common/index.js').PDFRenderProps<ShapeSchema & {
+        [x: string]: unknown;
+        name: string;
+        type: string;
+        position: {
+            x: number;
+            y: number;
+        };
+        width: number;
+        height: number;
+        content?: string | undefined;
+        rotate?: number | undefined;
+        opacity?: number | undefined;
+        readOnly?: boolean | undefined;
+        required?: boolean | undefined;
+        __bodyRange?: {
+            start: number;
+            end?: number | undefined;
+        } | undefined;
+        __isSplit?: boolean | undefined;
+    }>) => Promise<void> | void;
+    ui: (arg: import('../../common/index.js').UIRenderProps<ShapeSchema & {
+        [x: string]: unknown;
+        name: string;
+        type: string;
+        position: {
+            x: number;
+            y: number;
+        };
+        width: number;
+        height: number;
+        content?: string | undefined;
+        rotate?: number | undefined;
+        opacity?: number | undefined;
+        readOnly?: boolean | undefined;
+        required?: boolean | undefined;
+        __bodyRange?: {
+            start: number;
+            end?: number | undefined;
+        } | undefined;
+        __isSplit?: boolean | undefined;
+    }>) => Promise<void> | void;
+    uninterruptedEditMode?: boolean;
+};
+export declare const ellipse: {
+    propPanel: {
+        defaultSchema: {
+            type: "ellipse" | "rectangle";
+            borderWidth: number;
+            borderColor: string;
+            color: string;
+            radius?: number;
+            name: string;
+            position: {
+                x: number;
+                y: number;
+            };
+            width: number;
+            height: number;
+            content?: string | undefined;
+            rotate?: number | undefined;
+            opacity?: number | undefined;
+            readOnly?: boolean | undefined;
+            required?: boolean | undefined;
+            __bodyRange?: {
+                start: number;
+                end?: number | undefined;
+            } | undefined;
+            __isSplit?: boolean | undefined;
+        };
+        schema: ((propPanelProps: Omit<{
+            rootElement: HTMLDivElement;
+            activeSchema: import('../../common/index.js').SchemaForUI;
+            activeElements: HTMLElement[];
+            changeSchemas: import('../../common/index.js').ChangeSchemas;
+            schemas: import('../../common/index.js').SchemaForUI[];
+            options: import('../../common/index.js').UIOptions;
+            theme: import("antd").GlobalToken;
+            i18n: (key: string) => string;
+        }, "rootElement">) => Record<string, import('../../common/index.js').PropPanelSchema>) | Record<string, import('../../common/index.js').PropPanelSchema>;
+        widgets?: Record<string, (props: import('../../common/index.js').PropPanelWidgetProps) => void>;
+    };
+    icon: string;
+    pdf: (arg: import('../../common/index.js').PDFRenderProps<ShapeSchema & {
+        [x: string]: unknown;
+        name: string;
+        type: string;
+        position: {
+            x: number;
+            y: number;
+        };
+        width: number;
+        height: number;
+        content?: string | undefined;
+        rotate?: number | undefined;
+        opacity?: number | undefined;
+        readOnly?: boolean | undefined;
+        required?: boolean | undefined;
+        __bodyRange?: {
+            start: number;
+            end?: number | undefined;
+        } | undefined;
+        __isSplit?: boolean | undefined;
+    }>) => Promise<void> | void;
+    ui: (arg: import('../../common/index.js').UIRenderProps<ShapeSchema & {
+        [x: string]: unknown;
+        name: string;
+        type: string;
+        position: {
+            x: number;
+            y: number;
+        };
+        width: number;
+        height: number;
+        content?: string | undefined;
+        rotate?: number | undefined;
+        opacity?: number | undefined;
+        readOnly?: boolean | undefined;
+        required?: boolean | undefined;
+        __bodyRange?: {
+            start: number;
+            end?: number | undefined;
+        } | undefined;
+        __isSplit?: boolean | undefined;
+    }>) => Promise<void> | void;
+    uninterruptedEditMode?: boolean;
+};
+export {};

package/dist/types/_vendors/schemas/tables/cell.d.ts

@@ -0,0 +1,4 @@
+import { Plugin } from '../../common/index.js';
+import type { CellSchema } from './types.js';
+declare const cellSchema: Plugin<CellSchema>;
+export default cellSchema;

package/dist/types/_vendors/schemas/tables/classes.d.ts

@@ -0,0 +1,69 @@
+import { Font } from '../../common/index.js';
+import type { Font as FontKitFont } from 'fontkit';
+import type { Styles, TableInput, Settings, Section, StylesProps } from './types.js';
+type ContentSettings = {
+    body: Row[];
+    head: Row[];
+    columns: Column[];
+};
+export declare class Cell {
+    raw: string;
+    text: string[];
+    styles: Styles;
+    section: Section;
+    contentHeight: number;
+    contentWidth: number;
+    wrappedWidth: number;
+    minReadableWidth: number;
+    minWidth: number;
+    width: number;
+    height: number;
+    x: number;
+    y: number;
+    constructor(raw: string, styles: Styles, section: Section);
+    getContentHeight(): number;
+    padding(name: 'top' | 'bottom' | 'left' | 'right'): number;
+}
+export declare class Column {
+    index: number;
+    wrappedWidth: number;
+    minReadableWidth: number;
+    minWidth: number;
+    width: number;
+    constructor(index: number);
+    getMaxCustomCellWidth(table: Table): number;
+}
+export declare class Row {
+    readonly raw: string[];
+    readonly index: number;
+    readonly section: Section;
+    readonly cells: {
+        [key: string]: Cell;
+    };
+    height: number;
+    constructor(raw: string[], index: number, section: Section, cells: {
+        [key: string]: Cell;
+    });
+    getMaxCellHeight(columns: Column[]): number;
+    getMinimumRowHeight(columns: Column[]): number;
+}
+export declare class Table {
+    readonly settings: Settings;
+    readonly styles: StylesProps;
+    readonly columns: Column[];
+    readonly head: Row[];
+    readonly body: Row[];
+    constructor(input: TableInput, content: ContentSettings);
+    static create(arg: {
+        input: TableInput;
+        content: ContentSettings;
+        font: Font;
+        _cache: Map<string | number, FontKitFont>;
+    }): Promise<Table>;
+    getHeadHeight(): number;
+    getBodyHeight(): number;
+    allRows(): Row[];
+    getWidth(): number;
+    getHeight(): number;
+}
+export {};

package/dist/types/_vendors/schemas/tables/dynamicTemplate.d.ts

@@ -0,0 +1,7 @@
+import { Schema, BasePdf, CommonOptions } from '../../common/index.js';
+export declare const getDynamicHeightsForTable: (value: string, args: {
+    schema: Schema;
+    basePdf: BasePdf;
+    options: CommonOptions;
+    _cache: Map<string | number, unknown>;
+}) => Promise<number[]>;

package/dist/types/_vendors/schemas/tables/helper.d.ts

@@ -0,0 +1,265 @@
+export declare const getDefaultCellStyles: () => {
+    fontName: undefined;
+    alignment: import("../text/types.js").ALIGNMENT;
+    verticalAlignment: import("../text/types.js").VERTICAL_ALIGNMENT;
+    fontSize: number;
+    lineHeight: number;
+    characterSpacing: number;
+    fontColor: string;
+    backgroundColor: string;
+    borderColor: string;
+    borderWidth: {
+        top: number;
+        bottom: number;
+        left: number;
+        right: number;
+    };
+    padding: {
+        top: number;
+        bottom: number;
+        left: number;
+        right: number;
+    };
+};
+export declare const getCellPropPanelSchema: (arg: {
+    i18n: (key: string) => string;
+    fallbackFontName: string;
+    fontNames: string[];
+    isBody?: boolean;
+}) => {
+    '-': {
+        type: string;
+        widget: string;
+    };
+    borderWidth: {
+        title: string;
+        type: string;
+        widget: string;
+        span: number;
+        properties: {
+            top: {
+                type: string;
+                widget: string;
+                props: {
+                    min: number;
+                    step: number;
+                };
+                span: number;
+                title: string;
+            };
+            right: {
+                type: string;
+                widget: string;
+                props: {
+                    min: number;
+                    step: number;
+                };
+                span: number;
+                title: string;
+            };
+            bottom: {
+                type: string;
+                widget: string;
+                props: {
+                    min: number;
+                    step: number;
+                };
+                span: number;
+                title: string;
+            };
+            left: {
+                type: string;
+                widget: string;
+                props: {
+                    min: number;
+                    step: number;
+                };
+                span: number;
+                title: string;
+            };
+        };
+    };
+    '--': {
+        type: string;
+        widget: string;
+    };
+    padding: {
+        title: string;
+        type: string;
+        widget: string;
+        span: number;
+        properties: {
+            top: {
+                type: string;
+                widget: string;
+                props: {
+                    min: number;
+                    step: number;
+                };
+                span: number;
+                title: string;
+            };
+            right: {
+                type: string;
+                widget: string;
+                props: {
+                    min: number;
+                    step: number;
+                };
+                span: number;
+                title: string;
+            };
+            bottom: {
+                type: string;
+                widget: string;
+                props: {
+                    min: number;
+                    step: number;
+                };
+                span: number;
+                title: string;
+            };
+            left: {
+                type: string;
+                widget: string;
+                props: {
+                    min: number;
+                    step: number;
+                };
+                span: number;
+                title: string;
+            };
+        };
+    };
+    alternateBackgroundColor?: {
+        title: string;
+        type: string;
+        widget: string;
+        props: {
+            disabledAlpha: boolean;
+        };
+        rules: {
+            pattern: string;
+            message: string;
+        }[];
+    } | undefined;
+    fontName: {
+        title: string;
+        type: string;
+        widget: string;
+        default: string;
+        placeholder: string;
+        props: {
+            options: {
+                label: string;
+                value: string;
+            }[];
+        };
+        span: number;
+    };
+    fontSize: {
+        title: string;
+        type: string;
+        widget: string;
+        props: {
+            min: number;
+        };
+        span: number;
+    };
+    characterSpacing: {
+        title: string;
+        type: string;
+        widget: string;
+        props: {
+            min: number;
+        };
+        span: number;
+    };
+    alignment: {
+        title: string;
+        type: string;
+        widget: string;
+        props: {
+            options: {
+                label: string;
+                value: import("../text/types.js").ALIGNMENT;
+            }[];
+        };
+        span: number;
+    };
+    verticalAlignment: {
+        title: string;
+        type: string;
+        widget: string;
+        props: {
+            options: {
+                label: string;
+                value: import("../text/types.js").VERTICAL_ALIGNMENT;
+            }[];
+        };
+        span: number;
+    };
+    lineHeight: {
+        title: string;
+        type: string;
+        widget: string;
+        props: {
+            step: number;
+            min: number;
+        };
+        span: number;
+    };
+    fontColor: {
+        title: string;
+        type: string;
+        widget: string;
+        props: {
+            disabledAlpha: boolean;
+        };
+        rules: {
+            pattern: string;
+            message: string;
+        }[];
+    };
+    borderColor: {
+        title: string;
+        type: string;
+        widget: string;
+        props: {
+            disabledAlpha: boolean;
+        };
+        rules: {
+            pattern: string;
+            message: string;
+        }[];
+    };
+    backgroundColor: {
+        title: string;
+        type: string;
+        widget: string;
+        props: {
+            disabledAlpha: boolean;
+        };
+        rules: {
+            pattern: string;
+            message: string;
+        }[];
+    };
+};
+export declare const getColumnStylesPropPanelSchema: ({ head, i18n, }: {
+    head: string[];
+    i18n: (key: string) => string;
+}) => {
+    alignment: {
+        type: string;
+        widget: string;
+        title: string;
+        column: number;
+        properties: {};
+    };
+};
+export declare const getBody: (value: string | string[][]) => string[][];
+export declare const getBodyWithRange: (value: string | string[][], range?: {
+    start: number;
+    end?: number | undefined;
+}) => string[][];

package/dist/types/_vendors/schemas/tables/index.d.ts

@@ -0,0 +1,4 @@
+import type { Plugin } from '../../common/index.js';
+import type { TableSchema } from './types.js';
+declare const tableSchema: Plugin<TableSchema>;
+export default tableSchema;

package/dist/types/_vendors/schemas/tables/pdfRender.d.ts

@@ -0,0 +1,3 @@
+import type { TableSchema } from './types.js';
+import type { PDFRenderProps } from '../../common/index.js';
+export declare const pdfRender: (arg: PDFRenderProps<TableSchema>) => Promise<void>;

package/dist/types/_vendors/schemas/tables/propPanel.d.ts

@@ -0,0 +1,3 @@
+import type { PropPanel } from '../../common/index.js';
+import type { TableSchema } from './types.js';
+export declare const propPanel: PropPanel<TableSchema>;

package/dist/types/_vendors/schemas/tables/tableHelper.d.ts

@@ -0,0 +1,10 @@
+import { Schema, BasePdf, CommonOptions } from '../../common/index.js';
+import { Table } from './classes.js';
+interface CreateTableArgs {
+    schema: Schema;
+    basePdf: BasePdf;
+    options: CommonOptions;
+    _cache: Map<string | number, unknown>;
+}
+export declare function createSingleTable(body: string[][], args: CreateTableArgs): Promise<Table>;
+export {};