@pdfme/common 6.0.3 → 6.0.5-dev.1

package/{src/types.ts → dist/types.d.ts}

@@ -1,45 +1,55 @@
 import { z } from 'zod';
 import type { PDFPage, PDFDocument } from '@pdfme/pdf-lib';
-import type { ThemeConfig } from 'antd';
-import type { WidgetProps as _PropPanelWidgetProps, Schema as _PropPanelSchema } from 'form-render';
-import {
-  Lang,
-  Dict,
-  Mode,
-  Size,
-  Schema,
-  Font,
-  SchemaForUI,
-  BasePdf,
-  BlankPdf,
-  CustomPdf,
-  CommonOptions,
-  Template,
-  GeneratorOptions,
-  GenerateProps,
-  UIOptions,
-  UIProps,
-  PreviewProps,
-  DesignerProps,
-  ColorType,
-  LegacySchemaPageArray,
-  SchemaPageArray,
-} from './schema.js';
-
-export type PropPanelSchema = _PropPanelSchema;
+import { Lang, Dict, Mode, Size, Schema, Font, SchemaForUI, BasePdf, BlankPdf, CustomPdf, CommonOptions, Template, GeneratorOptions, GenerateProps, UIOptions, UIProps, PreviewProps, DesignerProps, ColorType, LegacySchemaPageArray, SchemaPageArray } from './schema.js';
+export interface UIOptionsThemeToken {
+    colorPrimary?: string;
+    colorPrimaryBg?: string;
+    colorWhite?: string;
+    [key: string]: unknown;
+}
+export interface UIOptionsTheme {
+    token?: UIOptionsThemeToken;
+    components?: Record<string, Record<string, unknown>>;
+    [key: string]: unknown;
+}
+export interface PropPanelRule {
+    validator?: (...args: any[]) => unknown;
+    message?: string;
+    pattern?: RegExp | string;
+    [key: string]: unknown;
+}
+export interface PropPanelSchema {
+    title?: string;
+    type?: string;
+    widget?: string;
+    default?: unknown;
+    placeholder?: string;
+    format?: string;
+    required?: boolean;
+    hidden?: boolean | string;
+    disabled?: boolean;
+    bind?: string | false | string[];
+    span?: number;
+    column?: number;
+    min?: number;
+    max?: number;
+    props?: Record<string, unknown>;
+    rules?: PropPanelRule[];
+    properties?: Record<string, PropPanelSchema>;
+    items?: PropPanelSchema | PropPanelSchema[];
+    [key: string]: unknown;
+}
 export type ChangeSchemaItem = {
-  key: string;
-  value: unknown;
-  schemaId: string;
+    key: string;
+    value: unknown;
+    schemaId: string;
 };
 export type ChangeSchemas = (objs: ChangeSchemaItem[]) => void;
-
 export type UITheme = {
-  colorPrimary: string;
-  colorPrimaryBg: string;
-  colorWhite: string;
+    colorPrimary: string;
+    colorPrimaryBg: string;
+    colorWhite: string;
 };
-
 /**
  * Properties used for PDF rendering.
  * @template T Type of the extended Schema object.
@@ -53,17 +63,15 @@ export type UITheme = {
  * @property {Map<string | number, unknown>} _cache Cache shared only during the execution of the generate function (useful for caching images, etc. if needed).
  */
 export interface PDFRenderProps<T extends Schema> {
-  value: string;
-  schema: T;
-  basePdf: BasePdf;
-  pdfLib: typeof import('@pdfme/pdf-lib');
-  pdfDoc: PDFDocument;
-  page: PDFPage;
-  options: GeneratorOptions;
-
-  _cache: Map<string | number, unknown>;
+    value: string;
+    schema: T;
+    basePdf: BasePdf;
+    pdfLib: typeof import('@pdfme/pdf-lib');
+    pdfDoc: PDFDocument;
+    page: PDFPage;
+    options: GeneratorOptions;
+    _cache: Map<string | number, unknown>;
 }
-
 /**
  * Type for properties used in UI rendering.
  *
@@ -84,22 +92,27 @@ export interface PDFRenderProps<T extends Schema> {
  * @property {Map<string | number, unknown>} _cache - Cache shared only during the execution of the render function (useful for caching images, etc. if needed).
  */
 export type UIRenderProps<T extends Schema> = {
-  schema: T;
-  basePdf: BasePdf;
-  mode: Mode;
-  tabIndex?: number;
-  placeholder?: string;
-  stopEditing?: () => void;
-  value: string;
-  onChange?: (arg: { key: string; value: unknown } | { key: string; value: unknown }[]) => void;
-  rootElement: HTMLDivElement;
-  options: UIOptions;
-  theme: UITheme;
-  i18n: (key: string) => string;
-  scale: number;
-  _cache: Map<string | number, unknown>;
+    schema: T;
+    basePdf: BasePdf;
+    mode: Mode;
+    tabIndex?: number;
+    placeholder?: string;
+    stopEditing?: () => void;
+    value: string;
+    onChange?: (arg: {
+        key: string;
+        value: unknown;
+    } | {
+        key: string;
+        value: unknown;
+    }[]) => void;
+    rootElement: HTMLDivElement;
+    options: UIOptions;
+    theme: UITheme;
+    i18n: (key: string) => string;
+    scale: number;
+    _cache: Map<string | number, unknown>;
 };
-
 /**
  * Type for properties used in configuring the property panel.
  *
@@ -114,18 +127,23 @@ export type UIRenderProps<T extends Schema> = {
  * @property {(key: keyof Dict | string) => string} i18n - Internationalization dictionary for UI labels and texts.
  */
 type PropPanelProps = {
-  rootElement: HTMLDivElement;
-  activeSchema: SchemaForUI;
-  activeElements: HTMLElement[];
-  changeSchemas: ChangeSchemas;
-  schemas: SchemaForUI[];
-  options: UIOptions;
-  theme: UITheme;
-  i18n: (key: string) => string;
+    rootElement: HTMLDivElement;
+    activeSchema: SchemaForUI;
+    activeElements: HTMLElement[];
+    changeSchemas: ChangeSchemas;
+    schemas: SchemaForUI[];
+    options: UIOptions;
+    theme: UITheme;
+    i18n: (key: string) => string;
+};
+type PropPanelWidgetRuntimeProps = {
+    schema?: PropPanelSchema;
+    value?: unknown;
+    onChange?: (...args: any[]) => unknown;
+    error?: unknown;
+    [key: string]: unknown;
 };
-
-export type PropPanelWidgetProps = _PropPanelWidgetProps & PropPanelProps;
-
+export type PropPanelWidgetProps = PropPanelWidgetRuntimeProps & PropPanelProps;
 /**
  * Used for customizing the property panel.
  * @template T - Type of the extended Schema object.
@@ -134,14 +152,10 @@ export type PropPanelWidgetProps = _PropPanelWidgetProps & PropPanelProps;
  * @property {T} defaultSchema - The default schema set when adding the schema.
  */
 export interface PropPanel<T extends Schema> {
-  schema:
-    | ((propPanelProps: Omit<PropPanelProps, 'rootElement'>) => Record<string, PropPanelSchema>)
-    | Record<string, PropPanelSchema>;
-
-  widgets?: Record<string, (props: PropPanelWidgetProps) => void>;
-  defaultSchema: T;
+    schema: ((propPanelProps: Omit<PropPanelProps, 'rootElement'>) => Record<string, PropPanelSchema>) | Record<string, PropPanelSchema>;
+    widgets?: Record<string, (props: PropPanelWidgetProps) => void>;
+    defaultSchema: T;
 }
-
 /**
  * The Plugin interface is used for PDF and UI rendering, as well as defining the property panel.
  * The 'pdf' is used in the generator package, 'ui' is used in the viewer, form, and designer packages, and 'propPanel' is used in the designer package.
@@ -154,31 +168,31 @@ export interface PropPanel<T extends Schema> {
  * @property {boolean} [uninterruptedEditMode] When editing in the UI, should the field avoid re-rendering while in edit mode?
  */
 export interface Plugin<T extends Schema = Schema> {
-  pdf(arg: PDFRenderProps<T & Schema>): Promise<void> | void;
-  ui(arg: UIRenderProps<T & Schema>): Promise<void> | void;
-  propPanel: PropPanel<T & Schema>;
-  icon?: string;
-  uninterruptedEditMode?: boolean;
+    pdf(arg: PDFRenderProps<T & Schema>): Promise<void> | void;
+    ui(arg: UIRenderProps<T & Schema>): Promise<void> | void;
+    propPanel: PropPanel<T & Schema>;
+    icon?: string;
+    uninterruptedEditMode?: boolean;
 }
-
-export type Plugins = { [key: string]: Plugin };
-
+export type Plugins = {
+    [key: string]: Plugin;
+};
 export interface PluginRegistry {
-  plugins: { [key: string]: Plugin };
-  exists(): boolean;
-  values(): Plugin[];
-  entries(): [string, Plugin][];
-  findByType(type: string): Plugin | undefined;
-  findWithLabelByType(type: string): [string, Plugin | undefined];
+    plugins: {
+        [key: string]: Plugin;
+    };
+    exists(): boolean;
+    values(): Plugin[];
+    entries(): [string, Plugin][];
+    findByType(type: string): Plugin | undefined;
+    findWithLabelByType(type: string): [string, Plugin | undefined];
 }
-
 export type Lang = z.infer<typeof Lang>;
 export type Dict = z.infer<typeof Dict>;
 export type Mode = z.infer<typeof Mode>;
 export type Size = z.infer<typeof Size>;
 export type Schema = z.infer<typeof Schema>;
 export type SchemaForUI = z.infer<typeof SchemaForUI>;
-
 /**
  * Represents the Font type definition.
  * @property {Object} [x: string] - Object key is the font name.
@@ -194,10 +208,21 @@ export type CustomPdf = z.infer<typeof CustomPdf>;
 export type Template = z.infer<typeof Template>;
 export type CommonOptions = z.infer<typeof CommonOptions>;
 export type GeneratorOptions = z.infer<typeof GeneratorOptions>;
-export type GenerateProps = Omit<z.infer<typeof GenerateProps>, 'plugins'> & { plugins?: Plugins };
-export type UIOptions = z.infer<typeof UIOptions> & { theme?: ThemeConfig };
-export type UIProps = Omit<z.infer<typeof UIProps>, 'plugins'> & { plugins?: Plugins };
-export type PreviewProps = Omit<z.infer<typeof PreviewProps>, 'plugins'> & { plugins?: Plugins };
-export type DesignerProps = Omit<z.infer<typeof DesignerProps>, 'plugins'> & { plugins?: Plugins };
+export type GenerateProps = Omit<z.infer<typeof GenerateProps>, 'plugins'> & {
+    plugins?: Plugins;
+};
+export type UIOptions = z.infer<typeof UIOptions> & {
+    theme?: UIOptionsTheme;
+};
+export type UIProps = Omit<z.infer<typeof UIProps>, 'plugins'> & {
+    plugins?: Plugins;
+};
+export type PreviewProps = Omit<z.infer<typeof PreviewProps>, 'plugins'> & {
+    plugins?: Plugins;
+};
+export type DesignerProps = Omit<z.infer<typeof DesignerProps>, 'plugins'> & {
+    plugins?: Plugins;
+};
 export type SchemaPageArray = z.infer<typeof SchemaPageArray>;
 export type LegacySchemaPageArray = z.infer<typeof LegacySchemaPageArray>;
+export {};

package/dist/version.d.ts

@@ -0,0 +1 @@
+export declare const PDFME_VERSION = "6.0.5";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pdfme/common",
-  "version": "6.0.3",
+  "version": "6.0.5-dev.1",
   "description": "TypeScript base PDF generator and React base UI. Open source, developed by the community, and completely free to use under the MIT license!",
   "keywords": [
     "pdf",
@@ -22,6 +22,10 @@
   },
   "type": "module",
   "sideEffects": false,
+  "files": [
+    "dist",
+    "README.md"
+  ],
   "main": "./dist/index.js",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -51,9 +55,5 @@
   },
   "devDependencies": {
     "@types/estree": "^1.0.6"
-  },
-  "peerDependencies": {
-    "antd": "^5.11.2 || ^6.0.0",
-    "form-render": "^2.2.20"
   }
 }

package/set-version.js

@@ -1,36 +0,0 @@
-import fs from 'node:fs';
-import path from 'node:path';
-import { execSync } from 'node:child_process';
-import { fileURLToPath } from 'node:url';
-
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
-
-const updateVersion = (version) => {
-  const filePath = path.join(__dirname, 'src/version.ts');
-  let content = '';
-
-  if (!fs.existsSync(filePath)) {
-    content = `export const PDFME_VERSION = '${version}';\n`;
-  } else {
-    content = fs.readFileSync(filePath, 'utf8');
-    const versionRegex = /export const PDFME_VERSION = '.*';/;
-    if (versionRegex.test(content)) {
-      content = content.replace(versionRegex, `export const PDFME_VERSION = '${version}';`);
-    } else {
-      content += `\nexport const PDFME_VERSION = '${version}';\n`;
-    }
-  }
-
-  fs.writeFileSync(filePath, content, 'utf8');
-  console.log(`Replaced PDFME_VERSION with '${version}' in ${filePath}`);
-};
-
-try {
-  const gitTag = execSync('git describe --tags $(git rev-list --tags --max-count=1)', {
-    encoding: 'utf8',
-  }).trim();
-  updateVersion(gitTag);
-} catch (error) {
-  console.error('Error replacing PDFME_VERSION:', error);
-  updateVersion('x.x.x');
-}