@pdfme/common 5.3.17 → 5.3.18-dev.1

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

@@ -126,8 +126,18 @@ export type Plugin<T = Schema> = {
     uninterruptedEditMode?: boolean;
 };
 export type Plugins = {
-    [key: string]: Plugin<any> | undefined;
+    [key: string]: Plugin<any>;
 };
+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];
+}
 export type Lang = z.infer<typeof Lang>;
 export type Dict = z.infer<typeof Dict>;
 export type Mode = z.infer<typeof Mode>;

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

@@ -1 +1 @@
-export declare const PDFME_VERSION = "5.3.17";
+export declare const PDFME_VERSION = "5.3.18";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pdfme/common",
-  "version": "5.3.17",
+  "version": "5.3.18-dev.1",
   "sideEffects": false,
   "author": "hand-dot",
   "license": "MIT",

package/src/helper.ts

@@ -235,15 +235,15 @@ const checkProps = <T>(data: unknown, zodSchema: z.ZodType<T>) => {
 ERROR MESSAGE: ${issue.message}
 --------------------------`,
       );
-
-      const message = messages.join('\n');
       throw Error(`[@pdfme/common] Invalid argument:
 --------------------------
-${message}`);
+${messages.join('\n')}`);
+    } else {
+      throw Error(`[@pdfme/common] Unexpected parsing error: ${e instanceof Error ? e.message : String(e)}`);
     }
   }
 
-  // Check fon if template and options exist
+  // Check fonts if template and options exist
   if (data && typeof data === 'object' && 'template' in data && 'options' in data) {
     const { template, options } = data as { template: Template; options: { font?: Font } };
     if (options && options.font) {

package/src/index.ts

@@ -34,6 +34,7 @@ import type {
   CommonOptions,
   GeneratorOptions,
   Plugins,
+  PluginRegistry,
   GenerateProps,
   UIOptions,
   UIProps,
@@ -64,6 +65,7 @@ import {
 } from './helper.js';
 import { getDynamicTemplate } from './dynamicTemplate.js';
 import { replacePlaceholders } from './expression.js';
+import { pluginRegistry } from './pluginRegistry.js';
 
 export {
   PDFME_VERSION,
@@ -97,6 +99,7 @@ export {
   checkPreviewProps,
   checkDesignerProps,
   checkGenerateProps,
+  pluginRegistry,
 };
 
 export type {
@@ -113,7 +116,9 @@ export type {
   Template,
   CommonOptions,
   GeneratorOptions,
+  Plugin,
   Plugins,
+  PluginRegistry,
   GenerateProps,
   UIOptions,
   UIProps,
@@ -128,5 +133,4 @@ export type {
   PDFRenderProps,
   UIRenderProps,
   Mode,
-  Plugin,
 };

package/src/pluginRegistry.ts

@@ -0,0 +1,32 @@
+import { Plugins, Plugin, PluginRegistry } from './types.js';
+
+/**
+ * Wraps plugins collection with utility methods
+ */
+export const pluginRegistry = (plugins: Plugins): PluginRegistry => {
+  return {
+    plugins: plugins,
+    entries: (): [string, Plugin][] => Object.entries(plugins),
+    values: (): Plugin[] => Object.values(plugins),
+    exists: (): boolean => Object.values(plugins).length > 0,
+    findWithLabelByType(type: string): [string, Plugin | undefined] {
+      for (const [label, plugin] of Object.entries(this.plugins) as [string, Plugin][]) {
+        if (!plugin || typeof plugin !== 'object') continue;
+        if (!plugin.propPanel || typeof plugin.propPanel !== 'object') continue;
+
+        const defaultSchema = plugin.propPanel.defaultSchema as Record<string, unknown>;
+
+        if (defaultSchema && 'type' in defaultSchema && defaultSchema.type === type) {
+          return [label, plugin];
+        }
+      }
+      return ['', undefined];
+    },
+    findByType(type: string): Plugin | undefined {
+      const [, plugin] = this.findWithLabelByType(type)
+      return plugin;
+    }
+  }
+};
+
+

package/src/schema.ts

@@ -152,12 +152,25 @@ export const Font = z.record(
   }),
 );
 
+export const Plugin = z
+  .object({
+    ui: z.function().args(z.any()).returns(z.any()),
+    pdf: z.function().args(z.any()).returns(z.any()),
+    propPanel: z.object({
+      schema: z.unknown(),
+      widgets: z.record(z.any()).optional(),
+      defaultSchema: Schema,
+    }),
+    icon: z.string().optional(),
+  })
+  .passthrough();
+
 export const CommonOptions = z.object({ font: Font.optional() }).passthrough();
 
 const CommonProps = z.object({
   template: Template,
   options: CommonOptions.optional(),
-  plugins: z.record(z.object({ ui: z.any(), pdf: z.any(), propPanel: z.any() })).optional(),
+  plugins: z.record(Plugin).optional(),
 });
 
 // -------------------generate-------------------

package/src/types.ts

@@ -154,7 +154,16 @@ export type Plugin<T = Schema> = {
 };
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-export type Plugins = { [key: string]: Plugin<any> | undefined };
+export type Plugins = { [key: string]: Plugin<any> };
+
+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];
+}
 
 export type Lang = z.infer<typeof Lang>;
 export type Dict = z.infer<typeof Dict>;

package/src/version.ts

@@ -1 +1 @@
-export const PDFME_VERSION = '5.3.17';
+export const PDFME_VERSION = '5.3.18';