@pdfme/ui 0.0.0

package/dist/types/__tests__/assets/helper.d.ts

@@ -0,0 +1,3 @@
+import { Template } from '@pdfme/common';
+export declare const setupUIMock: () => void;
+export declare const getSampleTemplate: () => Template;

package/dist/types/__tests__/components/Designer.test.d.ts

@@ -0,0 +1 @@
+import '@testing-library/jest-dom';

package/dist/types/__tests__/components/PluginIcon.test.d.ts

@@ -0,0 +1 @@
+import '@testing-library/jest-dom';

package/dist/types/__tests__/components/Preview.test.d.ts

@@ -0,0 +1 @@
+import '@testing-library/jest-dom';

package/dist/types/__tests__/helper.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/src/Designer.d.ts

@@ -0,0 +1,21 @@
+import { Template, DesignerProps } from '@pdfme/common';
+import { BaseUIClass } from './class.js';
+declare class Designer extends BaseUIClass {
+    private onSaveTemplateCallback?;
+    private onChangeTemplateCallback?;
+    private onPageChangeCallback?;
+    private pageCursor;
+    constructor(props: DesignerProps);
+    saveTemplate(): void;
+    updateTemplate(template: Template): void;
+    onSaveTemplate(cb: (template: Template) => void): void;
+    onChangeTemplate(cb: (template: Template) => void): void;
+    onPageChange(cb: (pageInfo: {
+        currentPage: number;
+        totalPages: number;
+    }) => void): void;
+    getPageCursor(): number;
+    getTotalPages(): number;
+    protected render(): void;
+}
+export default Designer;

package/dist/types/src/Form.d.ts

@@ -0,0 +1,24 @@
+import { PreviewProps } from '@pdfme/common';
+import { PreviewUI } from './class.js';
+declare class Form extends PreviewUI {
+    private onChangeInputCallback?;
+    private onPageChangeCallback?;
+    private pageCursor;
+    constructor(props: PreviewProps);
+    onChangeInput(cb: (arg: {
+        index: number;
+        value: string;
+        name: string;
+    }) => void): void;
+    onPageChange(cb: (pageInfo: {
+        currentPage: number;
+        totalPages: number;
+    }) => void): void;
+    getPageCursor(): number;
+    getTotalPages(): number;
+    setInputs(inputs: {
+        [key: string]: string;
+    }[]): void;
+    protected render(): void;
+}
+export default Form;

package/dist/types/src/Viewer.d.ts

@@ -0,0 +1,15 @@
+import { PreviewProps } from '@pdfme/common';
+import { PreviewUI } from './class.js';
+declare class Viewer extends PreviewUI {
+    private onPageChangeCallback?;
+    private pageCursor;
+    constructor(props: PreviewProps);
+    onPageChange(cb: (pageInfo: {
+        currentPage: number;
+        totalPages: number;
+    }) => void): void;
+    getPageCursor(): number;
+    getTotalPages(): number;
+    protected render(): void;
+}
+export default Viewer;

package/dist/types/src/class.d.ts

@@ -0,0 +1,89 @@
+import { Template, Size, UIProps, UIOptions, PluginRegistry, PreviewProps } from '@pdfme/common';
+export declare abstract class BaseUIClass {
+    protected domContainer: HTMLElement | null;
+    protected template: Template;
+    protected size: Size;
+    private lang;
+    private font;
+    private pluginsRegistry;
+    private options;
+    private readonly setSize;
+    resizeObserver: ResizeObserver;
+    constructor(props: UIProps);
+    protected getLang(): "en" | "zh" | "ja" | "ko" | "ar" | "th" | "pl" | "it" | "de" | "es" | "fr";
+    protected getFont(): Record<string, {
+        data: string | ArrayBuffer | Uint8Array<ArrayBuffer>;
+        fallback?: boolean | undefined;
+        subset?: boolean | undefined;
+    }>;
+    protected getPluginsRegistry(): PluginRegistry;
+    getOptions(): UIOptions;
+    getTemplate(): {
+        [x: string]: unknown;
+        schemas: {
+            [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;
+        }[][];
+        basePdf: string | ArrayBuffer | Uint8Array<ArrayBuffer> | {
+            width: number;
+            height: number;
+            padding: [number, number, number, number];
+            staticSchema?: {
+                [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;
+            }[] | undefined;
+        };
+        pdfmeVersion?: string | undefined;
+    };
+    updateTemplate(template: Template): void;
+    updateOptions(options: UIOptions): void;
+    destroy(): void;
+    protected abstract render(): void;
+}
+export declare abstract class PreviewUI extends BaseUIClass {
+    protected inputs: {
+        [key: string]: string;
+    }[];
+    constructor(props: PreviewProps);
+    getInputs(): {
+        [key: string]: string;
+    }[];
+    setInputs(inputs: {
+        [key: string]: string;
+    }[]): void;
+    protected abstract render(): void;
+}

package/dist/types/src/components/AppContextProvider.d.ts

@@ -0,0 +1,11 @@
+import React from 'react';
+import type { Font, Lang, UIOptions, PluginRegistry } from '@pdfme/common';
+type Props = {
+    children: React.ReactNode;
+    lang: Lang;
+    font: Font;
+    plugins: PluginRegistry;
+    options: UIOptions;
+};
+declare const AppContextProvider: ({ children, lang, font, plugins, options }: Props) => React.JSX.Element;
+export default AppContextProvider;

package/dist/types/src/components/CtlBar.d.ts

@@ -0,0 +1,14 @@
+import React from 'react';
+import { Size } from '@pdfme/common';
+type CtlBarProps = {
+    size: Size;
+    pageCursor: number;
+    pageNum: number;
+    setPageCursor: (page: number) => void;
+    zoomLevel: number;
+    setZoomLevel: (zoom: number) => void;
+    addPageAfter?: () => void;
+    removePage?: () => void;
+};
+declare const CtlBar: (props: CtlBarProps) => React.JSX.Element;
+export default CtlBar;

package/dist/types/src/components/Designer/Canvas/Guides.d.ts

@@ -0,0 +1,9 @@
+import React, { Ref } from 'react';
+import GuidesComponent from '@scena/react-guides';
+import { Size } from '@pdfme/common';
+declare const _Guides: ({ paperSize, horizontalRef, verticalRef, }: {
+    paperSize: Size;
+    horizontalRef: Ref<GuidesComponent> | undefined;
+    verticalRef: Ref<GuidesComponent> | undefined;
+}) => React.JSX.Element;
+export default _Guides;

package/dist/types/src/components/Designer/Canvas/Mask.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+import { Size } from '@pdfme/common';
+declare const Mask: ({ width, height }: Size) => React.JSX.Element;
+export default Mask;

package/dist/types/src/components/Designer/Canvas/Moveable.d.ts

@@ -0,0 +1,37 @@
+import React from 'react';
+import MoveableComponent, { OnDrag, OnRotate, OnRotateEnd, OnClick, OnResize } from 'react-moveable';
+type Props = {
+    target: HTMLElement[];
+    bounds: {
+        left: number;
+        top: number;
+        bottom: number;
+        right: number;
+    };
+    horizontalGuidelines: number[];
+    verticalGuidelines: number[];
+    keepRatio: boolean;
+    rotatable: boolean;
+    onDrag: ({ target, left, top }: OnDrag) => void;
+    onDragEnd: ({ target }: {
+        target: HTMLElement | SVGElement;
+    }) => void;
+    onDragGroupEnd: ({ targets }: {
+        targets: (HTMLElement | SVGElement)[];
+    }) => void;
+    onRotate: ({ target, rotate }: OnRotate) => void;
+    onRotateEnd: ({ target }: OnRotateEnd) => void;
+    onRotateGroupEnd: ({ targets }: {
+        targets: (HTMLElement | SVGElement)[];
+    }) => void;
+    onResize: ({ target, width, height, direction }: OnResize) => void;
+    onResizeEnd: ({ target }: {
+        target: HTMLElement | SVGElement;
+    }) => void;
+    onResizeGroupEnd: ({ targets }: {
+        targets: (HTMLElement | SVGElement)[];
+    }) => void;
+    onClick: (e: OnClick) => void;
+};
+declare const _default: React.ForwardRefExoticComponent<Props & React.RefAttributes<MoveableComponent<{}>>>;
+export default _default;

package/dist/types/src/components/Designer/Canvas/Padding.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+import { BasePdf } from '@pdfme/common';
+declare const Padding: ({ basePdf }: {
+    basePdf: BasePdf;
+}) => React.JSX.Element;
+export default Padding;

package/dist/types/src/components/Designer/Canvas/Selecto.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+import { OnSelect as SelectoOnSelect, OnDragStart as SelectoOnDragStart } from 'react-selecto';
+type Props = {
+    container: HTMLElement | null;
+    continueSelect: boolean;
+    onDragStart: (e: SelectoOnDragStart) => void;
+    onSelect: (e: SelectoOnSelect) => void;
+};
+declare const Selecto: (props: Props) => React.JSX.Element;
+export default Selecto;

package/dist/types/src/components/Designer/Canvas/index.d.ts

@@ -0,0 +1,22 @@
+import React, { MutableRefObject } from 'react';
+import { SchemaForUI, Size, ChangeSchemas, BasePdf } from '@pdfme/common';
+interface Props {
+    basePdf: BasePdf;
+    height: number;
+    hoveringSchemaId: string | null;
+    onChangeHoveringSchemaId: (id: string | null) => void;
+    pageCursor: number;
+    schemasList: SchemaForUI[][];
+    scale: number;
+    backgrounds: string[];
+    pageSizes: Size[];
+    size: Size;
+    activeElements: HTMLElement[];
+    onEdit: (targets: HTMLElement[]) => void;
+    changeSchemas: ChangeSchemas;
+    removeSchemas: (ids: string[]) => void;
+    paperRefs: MutableRefObject<HTMLDivElement[]>;
+    sidebarOpen: boolean;
+}
+declare const _default: React.ForwardRefExoticComponent<Props & React.RefAttributes<HTMLDivElement>>;
+export default _default;

package/dist/types/src/components/Designer/LeftSidebar.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import { BasePdf } from '@pdfme/common';
+declare const LeftSidebar: ({ height, scale, basePdf, }: {
+    height: number;
+    scale: number;
+    basePdf: BasePdf;
+}) => React.JSX.Element;
+export default LeftSidebar;

package/dist/types/src/components/Designer/PluginIcon.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+import { Plugin, Schema } from '@pdfme/common';
+interface PluginIconProps {
+    plugin: Plugin<Schema>;
+    label: string;
+    size?: number;
+    styles?: React.CSSProperties;
+}
+declare const PluginIcon: (props: PluginIconProps) => React.JSX.Element;
+export default PluginIcon;

package/dist/types/src/components/Designer/RightSidebar/DetailView/AlignWidget.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+import type { PropPanelWidgetProps } from '@pdfme/common';
+declare const AlignWidget: (props: PropPanelWidgetProps) => React.JSX.Element;
+export default AlignWidget;

package/dist/types/src/components/Designer/RightSidebar/DetailView/ButtonGroupWidget.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+import type { PropPanelWidgetProps } from '@pdfme/common';
+declare const ButtonGroupWidget: (props: PropPanelWidgetProps) => React.JSX.Element;
+export default ButtonGroupWidget;

package/dist/types/src/components/Designer/RightSidebar/DetailView/WidgetRenderer.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import type { PropPanelWidgetProps } from '@pdfme/common';
+type Props = PropPanelWidgetProps & {
+    widget: (props: PropPanelWidgetProps) => void;
+};
+declare const WidgetRenderer: (props: Props) => React.JSX.Element;
+export default WidgetRenderer;

package/dist/types/src/components/Designer/RightSidebar/DetailView/index.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import type { SchemaForUI } from '@pdfme/common';
+import type { SidebarProps } from '../../../../types.js';
+type DetailViewProps = Pick<SidebarProps, 'size' | 'schemas' | 'schemasList' | 'pageSize' | 'basePdf' | 'changeSchemas' | 'activeElements' | 'deselectSchema'> & {
+    activeSchema: SchemaForUI;
+};
+declare const _default: React.MemoExoticComponent<(props: DetailViewProps) => React.JSX.Element>;
+export default _default;

package/dist/types/src/components/Designer/RightSidebar/ListView/Item.d.ts

@@ -0,0 +1,45 @@
+import React from 'react';
+import { DraggableSyntheticListeners } from '@dnd-kit/core';
+interface Props {
+    /** Content to display in the item */
+    value: React.ReactNode;
+    /** Optional icon to display */
+    icon?: React.ReactNode;
+    /** Custom styles for the item */
+    style?: React.CSSProperties;
+    /** Status indicator for the item */
+    status?: 'is-warning' | 'is-danger';
+    /** Title attribute for the item */
+    title?: string;
+    /** Whether the item is required */
+    required?: boolean;
+    /** Whether the item is read-only */
+    readOnly?: boolean;
+    /** Whether the item is being dragged as an overlay */
+    dragOverlay?: boolean;
+    /** Click handler for the item */
+    onClick?: () => void;
+    /** Mouse enter handler */
+    onMouseEnter?: () => void;
+    /** Mouse leave handler */
+    onMouseLeave?: () => void;
+    /** Whether the item is currently being dragged */
+    dragging?: boolean;
+    /** Whether items are being sorted */
+    sorting?: boolean;
+    /** CSS transition value */
+    transition?: string;
+    /** Transform data for the item */
+    transform?: {
+        x: number;
+        y: number;
+        scaleX: number;
+        scaleY: number;
+    } | null;
+    /** Whether to fade the item in */
+    fadeIn?: boolean;
+    /** Drag listeners from dnd-kit */
+    listeners?: DraggableSyntheticListeners;
+}
+declare const Item: React.MemoExoticComponent<React.ForwardRefExoticComponent<Props & React.RefAttributes<HTMLLIElement>>>;
+export default Item;

package/dist/types/src/components/Designer/RightSidebar/ListView/SelectableSortableContainer.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+import type { SidebarProps } from '../../../../types.js';
+declare const SelectableSortableContainer: (props: Pick<SidebarProps, "schemas" | "onEdit" | "onSortEnd" | "hoveringSchemaId" | "onChangeHoveringSchemaId">) => React.JSX.Element;
+export default SelectableSortableContainer;

package/dist/types/src/components/Designer/RightSidebar/ListView/SelectableSortableItem.d.ts

@@ -0,0 +1,14 @@
+import React from 'react';
+import { SchemaForUI } from '@pdfme/common';
+interface Props {
+    isSelected: boolean;
+    style?: React.CSSProperties;
+    onSelect: (id: string, isShiftSelect: boolean) => void;
+    onEdit: (id: string) => void;
+    schema: SchemaForUI;
+    schemas: SchemaForUI[];
+    onMouseEnter: () => void;
+    onMouseLeave: () => void;
+}
+declare const SelectableSortableItem: ({ isSelected, style, onSelect, onEdit, schema, schemas, onMouseEnter, onMouseLeave, }: Props) => React.JSX.Element;
+export default SelectableSortableItem;

package/dist/types/src/components/Designer/RightSidebar/ListView/index.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+import type { SidebarProps } from '../../../../types.js';
+declare const ListView: (props: Pick<SidebarProps, "schemas" | "onSortEnd" | "onEdit" | "hoveringSchemaId" | "onChangeHoveringSchemaId" | "changeSchemas">) => React.JSX.Element;
+export default ListView;

package/dist/types/src/components/Designer/RightSidebar/index.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+import type { SidebarProps } from '../../../types.js';
+declare const Sidebar: (props: SidebarProps) => React.JSX.Element;
+export default Sidebar;

package/dist/types/src/components/Designer/RightSidebar/layout.d.ts

@@ -0,0 +1,15 @@
+import React from 'react';
+export declare const SIDEBAR_H_PADDING_PX = 16;
+export declare const SIDEBAR_V_PADDING_PX = 8;
+export declare const SIDEBAR_HEADER_HEIGHT = 60;
+type SectionProps = {
+    children: React.ReactNode;
+};
+type SidebarFrameProps = SectionProps & {
+    className?: string;
+};
+export declare const SidebarFrame: ({ children, className }: SidebarFrameProps) => React.JSX.Element;
+export declare const SidebarHeader: ({ children }: SectionProps) => React.JSX.Element;
+export declare const SidebarBody: ({ children }: SectionProps) => React.JSX.Element;
+export declare const SidebarFooter: ({ children }: SectionProps) => React.JSX.Element;
+export {};

package/dist/types/src/components/Designer/index.d.ts

@@ -0,0 +1,11 @@
+import React from 'react';
+import { Template, DesignerProps, Size } from '@pdfme/common';
+declare const TemplateEditor: ({ template, size, onSaveTemplate, onChangeTemplate, onPageCursorChange, }: Omit<DesignerProps, "domContainer"> & {
+    size: Size;
+    onSaveTemplate: (t: Template) => void;
+    onChangeTemplate: (t: Template) => void;
+} & {
+    onChangeTemplate: (t: Template) => void;
+    onPageCursorChange: (newPageCursor: number, totalPages: number) => void;
+}) => React.JSX.Element;
+export default TemplateEditor;

package/dist/types/src/components/ErrorScreen.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { Size } from '@pdfme/common';
+declare const ErrorScreen: ({ size, error }: {
+    size: Size;
+    error: Error;
+}) => React.JSX.Element;
+export default ErrorScreen;

package/dist/types/src/components/Paper.d.ts

@@ -0,0 +1,20 @@
+import React, { MutableRefObject, ReactNode } from 'react';
+import { SchemaForUI, Size } from '@pdfme/common';
+declare const Paper: (props: {
+    paperRefs: MutableRefObject<HTMLDivElement[]>;
+    scale: number;
+    size: Size;
+    schemasList: SchemaForUI[][];
+    pageSizes: Size[];
+    backgrounds: string[];
+    renderPaper: (arg: {
+        index: number;
+        paperSize: Size;
+    }) => ReactNode;
+    renderSchema: (arg: {
+        index: number;
+        schema: SchemaForUI;
+    }) => ReactNode;
+    hasRulers?: boolean;
+}) => React.JSX.Element | null;
+export default Paper;

package/dist/types/src/components/Preview.d.ts

@@ -0,0 +1,15 @@
+import React from 'react';
+import { PreviewProps, Size } from '@pdfme/common';
+declare const Preview: ({ template, inputs, size, onChangeInput, onPageChange, }: Omit<PreviewProps, "domContainer"> & {
+    onChangeInput?: (args: {
+        index: number;
+        value: string;
+        name: string;
+    }) => void;
+    onPageChange?: (pageInfo: {
+        currentPage: number;
+        totalPages: number;
+    }) => void;
+    size: Size;
+}) => React.JSX.Element;
+export default Preview;

package/dist/types/src/components/Renderer.d.ts

@@ -0,0 +1,13 @@
+import React from 'react';
+import { UIRenderProps, SchemaForUI, BasePdf, Schema } from '@pdfme/common';
+type RendererProps = Omit<UIRenderProps<Schema>, 'schema' | 'rootElement' | 'options' | 'theme' | 'i18n' | '_cache'> & {
+    basePdf: BasePdf;
+    schema: SchemaForUI;
+    value: string;
+    outline: string;
+    onChangeHoveringSchemaId?: (id: string | null) => void;
+    scale: number;
+    selectable?: boolean;
+};
+declare const Renderer: (props: RendererProps) => React.JSX.Element;
+export default Renderer;

package/dist/types/src/components/Root.d.ts

@@ -0,0 +1,9 @@
+import React, { ReactNode } from 'react';
+import { Size } from '@pdfme/common';
+type Props = {
+    size: Size;
+    scale: number;
+    children: ReactNode;
+};
+declare const _default: React.ForwardRefExoticComponent<Props & React.RefAttributes<HTMLDivElement>>;
+export default _default;

package/dist/types/src/components/Spinner.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+declare const Spinner: React.FC;
+export default Spinner;

package/dist/types/src/components/StaticSchema.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+import { Template } from '@pdfme/common';
+declare const StaticSchema: (props: {
+    template: Template;
+    input: Record<string, string>;
+    scale: number;
+    totalPages: number;
+    currentPage: number;
+}) => React.JSX.Element | null;
+export default StaticSchema;

package/dist/types/src/components/UnitPager.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+import { Size } from '@pdfme/common';
+type Props = {
+    size: Size;
+    unitCursor: number;
+    unitNum: number;
+    setUnitCursor: (page: number) => void;
+};
+declare const UnitPager: ({ size, unitCursor, unitNum, setUnitCursor }: Props) => React.JSX.Element | null;
+export default UnitPager;

package/dist/types/src/constants.d.ts

@@ -0,0 +1,11 @@
+export declare const DEFAULT_LANG = "en";
+export declare const DESTROYED_ERR_MSG = "[@pdfme/ui] this instance is already destroyed";
+export declare const SELECTABLE_CLASSNAME = "selectable";
+export declare const RULER_HEIGHT = 30;
+export declare const PAGE_GAP = 10;
+export declare const LEFT_SIDEBAR_WIDTH = 45;
+export declare const RIGHT_SIDEBAR_WIDTH = 400;
+export declare const BACKGROUND_COLOR = "rgb(74, 74, 74)";
+export declare const DEFAULT_MAX_ZOOM = 2;
+export declare const DESIGNER_CLASSNAME = "pdfme-designer-";
+export declare const UI_CLASSNAME = "pdfme-ui-";

package/dist/types/src/contexts.d.ts

@@ -0,0 +1,10 @@
+import { PluginRegistry, UIOptions } from '@pdfme/common';
+export declare const I18nContext: import("react").Context<(key: keyof import("@pdfme/common").Dict, dict?: import("@pdfme/common").Dict) => string>;
+export declare const FontContext: import("react").Context<Record<string, {
+    data: string | ArrayBuffer | Uint8Array<ArrayBuffer>;
+    fallback?: boolean | undefined;
+    subset?: boolean | undefined;
+}>>;
+export declare const PluginsRegistry: import("react").Context<PluginRegistry>;
+export declare const OptionsContext: import("react").Context<UIOptions>;
+export declare const CacheContext: import("react").Context<Map<string | number, unknown>>;