@pwfabric/authoring 0.0.0-stage → 1.0.0-rc.0

package/dist/registry.js

@@ -0,0 +1,277 @@
+/**
+ * CustomBlockRegistry
+ *
+ * Registry for managing custom block definitions.
+ *
+ * @module @pwfabric/authoring/registry
+ *
+ * @example
+ * ```typescript
+ * import { createCustomBlockRegistry, defineBlock } from '@pwfabric/authoring'
+ * import { z } from 'zod'
+ *
+ * const registry = createCustomBlockRegistry()
+ *
+ * const MyBlock = defineBlock({
+ *   type: 'my-block',
+ *   name: 'My Block',
+ *   schema: z.object({ title: z.string() }),
+ *   defaultProps: { title: 'Default' },
+ *   component: ({ props }) => <div>{props.title}</div>
+ * })
+ *
+ * registry.register(MyBlock)
+ *
+ * // Use with SurfaceRenderer
+ * <SurfaceRenderer components={registry.getComponents()} />
+ * ```
+ */
+import { createElement } from 'react';
+// ============================================================
+// CUSTOM BLOCK REGISTRY
+// ============================================================
+/**
+ * CustomBlockRegistry
+ *
+ * Manages registration and retrieval of custom block definitions.
+ * Provides a bridge between custom block definitions and the
+ * SurfaceRenderer component registry.
+ */
+export class CustomBlockRegistry {
+    definitions = new Map();
+    /**
+     * Register a custom block definition
+     *
+     * @param definition - The custom block definition to register
+     * @throws Error if block type already registered
+     */
+    register(definition) {
+        if (this.definitions.has(definition.type)) {
+            throw new Error(`Block type "${definition.type}" is already registered`);
+        }
+        this.definitions.set(definition.type, definition);
+    }
+    /**
+     * Register multiple custom block definitions
+     *
+     * @param definitions - Array of custom block definitions
+     */
+    registerMany(definitions) {
+        for (const definition of definitions) {
+            this.register(definition);
+        }
+    }
+    /**
+     * Get a custom block definition by type
+     *
+     * @param type - Block type identifier
+     * @returns The block definition or undefined
+     */
+    get(type) {
+        return this.definitions.get(type);
+    }
+    /**
+     * Check if a block type is registered
+     *
+     * @param type - Block type identifier
+     * @returns True if registered
+     */
+    has(type) {
+        return this.definitions.has(type);
+    }
+    /**
+     * Get all registered custom block definitions
+     *
+     * @returns Array of all block definitions
+     */
+    list() {
+        return Array.from(this.definitions.values());
+    }
+    /**
+     * Get block definitions by category
+     *
+     * @param category - Block category
+     * @returns Array of block definitions in category
+     */
+    getByCategory(category) {
+        return this.list().filter((def) => def.category === category);
+    }
+    /**
+     * Get all registered block types
+     *
+     * @returns Array of block type identifiers
+     */
+    types() {
+        return Array.from(this.definitions.keys());
+    }
+    /**
+     * Unregister a custom block
+     *
+     * @param type - Block type identifier
+     * @returns True if block was unregistered
+     */
+    unregister(type) {
+        return this.definitions.delete(type);
+    }
+    /**
+     * Clear all registrations
+     */
+    clear() {
+        this.definitions.clear();
+    }
+    /**
+     * Get number of registered blocks
+     */
+    get size() {
+        return this.definitions.size;
+    }
+    /**
+     * Get a component registry for use with SurfaceRenderer
+     *
+     * This method creates a BlockComponentRegistry that can be passed
+     * to the SurfaceRenderer's `components` prop to enable rendering
+     * of custom blocks.
+     *
+     * @returns BlockComponentRegistry with all registered custom blocks
+     *
+     * @example
+     * ```typescript
+     * import { SurfaceRenderer } from '@pwfabric/runtime'
+     *
+     * const registry = createCustomBlockRegistry()
+     * registry.register(MyCustomBlock)
+     *
+     * // Pass to SurfaceRenderer
+     * <SurfaceRenderer
+     *   surface={mySurface}
+     *   components={registry.getComponents()}
+     * />
+     * ```
+     */
+    getComponents() {
+        const components = {};
+        for (const definition of this.definitions.values()) {
+            components[definition.type] = createBlockComponentWrapper(definition);
+        }
+        return components;
+    }
+}
+/**
+ * Create a wrapper component that adapts CustomBlockComponent to BlockComponent
+ *
+ * This bridges the gap between the SDK's CustomBlockComponent interface
+ * and the runtime's BlockComponent interface.
+ */
+/**
+ * Map runtime BlockContext to SDK CustomBlockContext
+ *
+ * Narrows the full runtime context to only what custom block authors need.
+ * Excludes: capabilities, imageAdapter, basePath (platform internals).
+ */
+function mapToCustomBlockContext(runtimeContext) {
+    if (!runtimeContext || typeof runtimeContext !== 'object')
+        return undefined;
+    const ctx = runtimeContext;
+    return {
+        theme: ctx.theme ?? 'light',
+        viewport: ctx.viewport ?? 'lg',
+        onEvent: typeof ctx.onEvent === 'function'
+            ? (event) => {
+                ;
+                ctx.onEvent(event);
+            }
+            : undefined,
+    };
+}
+function createBlockComponentWrapper(definition) {
+    return function WrappedComponent({ block, props: rawProps, children, context, }) {
+        // Validate and apply defaults using the schema
+        const result = definition.schema.safeParse(rawProps);
+        const validatedProps = result.success ? result.data : definition.defaultProps;
+        // Map runtime context to custom block context
+        const customContext = mapToCustomBlockContext(context);
+        // Create the custom block component props
+        const customProps = {
+            props: validatedProps,
+            blockId: block.id,
+            children,
+            context: customContext,
+        };
+        // Render using the custom component
+        return createElement(definition.component, customProps);
+    };
+}
+// ============================================================
+// FACTORY FUNCTIONS
+// ============================================================
+/**
+ * Create a new CustomBlockRegistry
+ *
+ * @returns A new CustomBlockRegistry instance
+ *
+ * @example
+ * ```typescript
+ * const registry = createCustomBlockRegistry()
+ * registry.register(MyBlock)
+ * ```
+ */
+export function createCustomBlockRegistry() {
+    return new CustomBlockRegistry();
+}
+/**
+ * Get a singleton instance of CustomBlockRegistry
+ *
+ * Use this when you want a shared registry across your application.
+ * For isolated registries (e.g., in tests), use `createCustomBlockRegistry()`.
+ */
+let globalRegistry = null;
+export function getCustomBlockRegistry() {
+    if (!globalRegistry) {
+        globalRegistry = new CustomBlockRegistry();
+    }
+    return globalRegistry;
+}
+/**
+ * Reset the global registry
+ *
+ * Useful for testing or when you need to clear all registrations.
+ */
+export function resetGlobalRegistry() {
+    globalRegistry = null;
+}
+// ============================================================
+// MERGE UTILITIES
+// ============================================================
+/**
+ * Merge multiple custom block registries into one
+ *
+ * @param registries - Registries to merge
+ * @returns A new registry containing all blocks from input registries
+ * @throws Error if there are duplicate block types
+ */
+export function mergeRegistries(...registries) {
+    const merged = new CustomBlockRegistry();
+    for (const registry of registries) {
+        for (const definition of registry.list()) {
+            merged.register(definition);
+        }
+    }
+    return merged;
+}
+/**
+ * Merge a custom block registry with a base BlockComponentRegistry
+ *
+ * This is useful when you want to extend the default block components
+ * with custom blocks.
+ *
+ * @param baseComponents - The base component registry (e.g., defaultBlockComponents)
+ * @param customRegistry - The custom block registry
+ * @returns A merged BlockComponentRegistry
+ */
+export function mergeWithBaseComponents(baseComponents, customRegistry) {
+    return {
+        ...baseComponents,
+        ...customRegistry.getComponents(),
+    };
+}
+//# sourceMappingURL=registry.js.map

package/dist/registry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"registry.js","sourceRoot":"","sources":["../src/registry.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AAUH,OAAO,EAAE,aAAa,EAAkB,MAAM,OAAO,CAAA;AAErD,+DAA+D;AAC/D,wBAAwB;AACxB,+DAA+D;AAE/D;;;;;;GAMG;AACH,MAAM,OAAO,mBAAmB;IACb,WAAW,GAAG,IAAI,GAAG,EAAiC,CAAA;IAEvE;;;;;OAKG;IACH,QAAQ,CACN,UAAyC;QAEzC,IAAI,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YAC1C,MAAM,IAAI,KAAK,CAAC,eAAe,UAAU,CAAC,IAAI,yBAAyB,CAAC,CAAA;QAC1E,CAAC;QACD,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,UAAmC,CAAC,CAAA;IAC5E,CAAC;IAED;;;;OAIG;IACH,YAAY,CAAC,WAA6C;QACxD,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;YACrC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;QAC3B,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,IAAY;QACd,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IACnC,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,IAAY;QACd,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IACnC,CAAC;IAED;;;;OAIG;IACH,IAAI;QACF,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,CAAA;IAC9C,CAAC;IAED;;;;;OAKG;IACH,aAAa,CAAC,QAAuB;QACnC,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAA;IAC/D,CAAC;IAED;;;;OAIG;IACH,KAAK;QACH,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAA;IAC5C,CAAC;IAED;;;;;OAKG;IACH,UAAU,CAAC,IAAY;QACrB,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IACtC,CAAC;IAED;;OAEG;IACH,KAAK;QACH,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,CAAA;IAC1B,CAAC;IAED;;OAEG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAA;IAC9B,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,aAAa;QACX,MAAM,UAAU,GAA2B,EAAE,CAAA;QAE7C,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,EAAE,CAAC;YACnD,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,2BAA2B,CAAC,UAAU,CAAC,CAAA;QACvE,CAAC;QAED,OAAO,UAAU,CAAA;IACnB,CAAC;CACF;AAED;;;;;GAKG;AACH;;;;;GAKG;AACH,SAAS,uBAAuB,CAAC,cAAuB;IACtD,IAAI,CAAC,cAAc,IAAI,OAAO,cAAc,KAAK,QAAQ;QAAE,OAAO,SAAS,CAAA;IAE3E,MAAM,GAAG,GAAG,cAAyC,CAAA;IACrD,OAAO;QACL,KAAK,EAAG,GAAG,CAAC,KAA0B,IAAI,OAAO;QACjD,QAAQ,EAAG,GAAG,CAAC,QAAmB,IAAI,IAAI;QAC1C,OAAO,EACL,OAAO,GAAG,CAAC,OAAO,KAAK,UAAU;YAC/B,CAAC,CAAC,CAAC,KAA4D,EAAE,EAAE;gBAC/D,CAAC;gBAAC,GAAG,CAAC,OAAgC,CAAC,KAAK,CAAC,CAAA;YAC/C,CAAC;YACH,CAAC,CAAC,SAAS;KAChB,CAAA;AACH,CAAC;AAED,SAAS,2BAA2B,CAClC,UAAiC;IAOjC,OAAO,SAAS,gBAAgB,CAAC,EAC/B,KAAK,EACL,KAAK,EAAE,QAAQ,EACf,QAAQ,EACR,OAAO,GAMR;QACC,+CAA+C;QAC/C,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAA;QACpD,MAAM,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,YAAY,CAAA;QAE7E,8CAA8C;QAC9C,MAAM,aAAa,GAAG,uBAAuB,CAAC,OAAO,CAAC,CAAA;QAEtD,0CAA0C;QAC1C,MAAM,WAAW,GAA8B;YAC7C,KAAK,EAAE,cAAc;YACrB,OAAO,EAAE,KAAK,CAAC,EAAE;YACjB,QAAQ;YACR,OAAO,EAAE,aAAa;SACvB,CAAA;QAED,oCAAoC;QACpC,OAAO,aAAa,CAClB,UAAU,CAAC,SAA2D,EACtE,WAAW,CACZ,CAAA;IACH,CAAC,CAAA;AACH,CAAC;AAED,+DAA+D;AAC/D,oBAAoB;AACpB,+DAA+D;AAE/D;;;;;;;;;;GAUG;AACH,MAAM,UAAU,yBAAyB;IACvC,OAAO,IAAI,mBAAmB,EAAE,CAAA;AAClC,CAAC;AAED;;;;;GAKG;AACH,IAAI,cAAc,GAA+B,IAAI,CAAA;AAErD,MAAM,UAAU,sBAAsB;IACpC,IAAI,CAAC,cAAc,EAAE,CAAC;QACpB,cAAc,GAAG,IAAI,mBAAmB,EAAE,CAAA;IAC5C,CAAC;IACD,OAAO,cAAc,CAAA;AACvB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,mBAAmB;IACjC,cAAc,GAAG,IAAI,CAAA;AACvB,CAAC;AAED,+DAA+D;AAC/D,kBAAkB;AAClB,+DAA+D;AAE/D;;;;;;GAMG;AACH,MAAM,UAAU,eAAe,CAC7B,GAAG,UAA0C;IAE7C,MAAM,MAAM,GAAG,IAAI,mBAAmB,EAAE,CAAA;IAExC,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE,CAAC;QAClC,KAAK,MAAM,UAAU,IAAI,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC;YACzC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;QAC7B,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,uBAAuB,CACrC,cAAsC,EACtC,cAAmC;IAEnC,OAAO;QACL,GAAG,cAAc;QACjB,GAAG,cAAc,CAAC,aAAa,EAAE;KAClC,CAAA;AACH,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,272 @@
+/**
+ * @pwfabric/authoring Type Definitions
+ *
+ * Core type definitions for the Custom Block SDK.
+ *
+ * @module @pwfabric/authoring/types
+ */
+import type { ZodSchema, ZodTypeDef } from 'zod';
+import type { Block, BlockCategory } from '@pwfabric/core';
+import type { BlockComponentRegistry } from '@pwfabric/runtime';
+import type { ReactNode } from 'react';
+/**
+ * Custom block definition options
+ *
+ * Used with `defineBlock()` to create a type-safe custom block.
+ */
+export interface CustomBlockOptions<TProps extends Record<string, unknown> = Record<string, unknown>, TSchema extends ZodSchema<TProps, ZodTypeDef, unknown> = ZodSchema<TProps>> {
+    /** Unique block type identifier (kebab-case) */
+    readonly type: string;
+    /** Human-readable display name */
+    readonly name: string;
+    /** Block category for grouping */
+    readonly category?: BlockCategory;
+    /** Icon character or identifier */
+    readonly icon?: string;
+    /** Zod schema for props validation */
+    readonly schema: TSchema;
+    /** Default props for new instances */
+    readonly defaultProps: TProps;
+    /** Whether this block can contain children */
+    readonly canHaveChildren?: boolean;
+    /** Restrict which block types can be children */
+    readonly allowedChildren?: readonly string[];
+    /** Restrict which block types can be parents */
+    readonly allowedParents?: readonly string[];
+    /** open trait vocabulary this block carries (kebab-case). */
+    readonly traits?: readonly string[];
+    /** children must carry ANY of these traits (containers only). */
+    readonly allowedChildTraits?: readonly string[];
+    /** Maximum instances allowed in a surface */
+    readonly maxInstances?: number;
+    /** React component to render this block */
+    readonly component: CustomBlockComponent<TProps>;
+}
+/**
+ * Custom block context
+ *
+ * Narrowed view of the runtime BlockContext for custom block authors.
+ * Excludes platform internals (capabilities, imageAdapter, basePath).
+ */
+export interface CustomBlockContext {
+    /** Current theme */
+    readonly theme: 'light' | 'dark';
+    /** Current viewport breakpoint */
+    readonly viewport: string;
+    /** Event handler for block-level events */
+    readonly onEvent?: ((event: {
+        type: string;
+        blockId?: string;
+        payload?: unknown;
+    }) => void) | undefined;
+}
+/**
+ * Custom block component props
+ */
+export interface CustomBlockComponentProps<TProps = Record<string, unknown>> {
+    /** The resolved, type-safe props */
+    readonly props: TProps;
+    /** Block ID */
+    readonly blockId: string;
+    /** Rendered children (for container blocks) */
+    readonly children?: ReactNode;
+    /** Runtime context (theme, viewport, events) */
+    readonly context?: CustomBlockContext | undefined;
+}
+/**
+ * Custom block component type
+ */
+export type CustomBlockComponent<TProps = Record<string, unknown>> = (props: CustomBlockComponentProps<TProps>) => ReactNode;
+/**
+ * Custom block definition (result of defineBlock)
+ *
+ * Contains both the block metadata and the component for rendering.
+ */
+export interface CustomBlockDefinition<TProps extends Record<string, unknown> = Record<string, unknown>> {
+    /** Unique block type identifier */
+    readonly type: string;
+    /** Human-readable display name */
+    readonly name: string;
+    /** Block category */
+    readonly category: BlockCategory;
+    /** Icon character or identifier */
+    readonly icon: string;
+    /** Zod schema for validation */
+    readonly schema: ZodSchema<TProps>;
+    /** Default props */
+    readonly defaultProps: TProps;
+    /** Whether this block can contain children */
+    readonly canHaveChildren: boolean;
+    /** Allowed child block types */
+    readonly allowedChildren?: readonly string[];
+    /** Allowed parent block types */
+    readonly allowedParents?: readonly string[];
+    /** open trait vocabulary this block carries (kebab-case). */
+    readonly traits?: readonly string[];
+    /** children must carry ANY of these traits (containers only). */
+    readonly allowedChildTraits?: readonly string[];
+    /** Maximum instances */
+    readonly maxInstances?: number;
+    /** React component */
+    readonly component: CustomBlockComponent<TProps>;
+}
+/**
+ * Factory configuration input
+ *
+ * Passed to the build function to customize the generated blocks.
+ */
+export type FactoryConfig = Record<string, unknown>;
+/**
+ * Block specification for factory output
+ *
+ * Simplified block definition without requiring an id (auto-generated).
+ */
+export interface BlockSpec {
+    /** Block type */
+    readonly type: string;
+    /** Block props */
+    readonly props: Record<string, unknown>;
+    /** Nested children */
+    readonly children?: readonly BlockSpec[];
+}
+/**
+ * Factory definition options
+ *
+ * Used with `defineFactory()` to create a factory function.
+ */
+export interface FactoryOptions<TConfig extends FactoryConfig = FactoryConfig> {
+    /** Unique factory identifier (kebab-case) */
+    readonly id: string;
+    /** Human-readable factory name */
+    readonly name?: string;
+    /** Factory description */
+    readonly description?: string;
+    /** Optional Zod schema for config validation */
+    readonly configSchema?: ZodSchema<TConfig>;
+    /** Build function that returns block specifications */
+    readonly build: (config: TConfig) => readonly BlockSpec[];
+}
+/**
+ * Factory definition (result of defineFactory)
+ */
+export interface FactoryDefinition<TConfig extends FactoryConfig = FactoryConfig> {
+    /** Factory identifier */
+    readonly id: string;
+    /** Factory name */
+    readonly name: string;
+    /** Factory description */
+    readonly description: string;
+    /** Config schema (if provided) */
+    readonly configSchema?: ZodSchema<TConfig>;
+    /** Build function */
+    readonly build: (config: TConfig) => readonly Block[];
+    /** Validate config against schema (if provided) */
+    readonly validateConfig: (config: unknown) => FactoryValidationResult<TConfig>;
+}
+/**
+ * Factory validation result
+ */
+export interface FactoryValidationResult<TConfig = FactoryConfig> {
+    /** Whether validation passed */
+    readonly valid: boolean;
+    /** Validated config (if valid) */
+    readonly config?: TConfig;
+    /** Validation errors (if invalid) */
+    readonly errors?: readonly FactoryValidationError[];
+}
+/**
+ * Factory validation error
+ */
+export interface FactoryValidationError {
+    /** Error path in the config */
+    readonly path: string;
+    /** Error message */
+    readonly message: string;
+}
+/**
+ * Custom block registry interface
+ */
+export interface ICustomBlockRegistry {
+    /**
+     * Register a custom block definition
+     */
+    register<TProps extends Record<string, unknown>>(definition: CustomBlockDefinition<TProps>): void;
+    /**
+     * Get a custom block definition by type
+     */
+    get(type: string): CustomBlockDefinition | undefined;
+    /**
+     * Check if a block type is registered
+     */
+    has(type: string): boolean;
+    /**
+     * Get all registered custom block definitions
+     */
+    list(): readonly CustomBlockDefinition[];
+    /**
+     * Get block definitions by category
+     */
+    getByCategory(category: BlockCategory): readonly CustomBlockDefinition[];
+    /**
+     * Get all registered block types
+     */
+    types(): readonly string[];
+    /**
+     * Unregister a custom block
+     */
+    unregister(type: string): boolean;
+    /**
+     * Clear all registrations
+     */
+    clear(): void;
+    /**
+     * Get a component registry for use with SurfaceRenderer
+     */
+    getComponents(): BlockComponentRegistry;
+}
+/**
+ * Block validation result
+ */
+export interface BlockValidationResult {
+    /** Whether the block is valid */
+    readonly valid: boolean;
+    /** The validated block (with defaults applied) */
+    readonly block?: Block;
+    /** Validation errors */
+    readonly errors: readonly BlockValidationError[];
+}
+/**
+ * Block validation error
+ */
+export interface BlockValidationError {
+    /** Error code */
+    readonly code: string;
+    /** Error message */
+    readonly message: string;
+    /** Path to the invalid property */
+    readonly path?: string;
+}
+/**
+ * Props validation result
+ */
+export interface PropsValidationResult<TProps = Record<string, unknown>> {
+    /** Whether the props are valid */
+    readonly valid: boolean;
+    /** The validated props (with defaults applied) */
+    readonly props?: TProps;
+    /** Validation errors */
+    readonly errors: readonly BlockValidationError[];
+}
+/**
+ * Infer props type from a custom block definition
+ */
+export type InferBlockProps<T> = T extends CustomBlockDefinition<infer TProps> ? TProps : never;
+/**
+ * Infer config type from a factory definition
+ */
+export type InferFactoryConfig<T> = T extends FactoryDefinition<infer TConfig> ? TConfig : never;
+/**
+ * Infer props type from a Zod schema
+ */
+export type InferSchemaProps<T> = T extends ZodSchema<infer TOutput> ? TOutput : never;
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,KAAK,CAAA;AAChD,OAAO,KAAK,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AAC1D,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAA;AAC/D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAMtC;;;;GAIG;AACH,MAAM,WAAW,kBAAkB,CACjC,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAChE,OAAO,SAAS,SAAS,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC,MAAM,CAAC;IAE1E,gDAAgD;IAChD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IAErB,kCAAkC;IAClC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IAErB,kCAAkC;IAClC,QAAQ,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAA;IAEjC,mCAAmC;IACnC,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAA;IAEtB,sCAAsC;IACtC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAA;IAExB,sCAAsC;IACtC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAE7B,8CAA8C;IAC9C,QAAQ,CAAC,eAAe,CAAC,EAAE,OAAO,CAAA;IAElC,iDAAiD;IACjD,QAAQ,CAAC,eAAe,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;IAE5C,gDAAgD;IAChD,QAAQ,CAAC,cAAc,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;IAE3C,6DAA6D;IAC7D,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;IAEnC,iEAAiE;IACjE,QAAQ,CAAC,kBAAkB,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;IAE/C,6CAA6C;IAC7C,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAA;IAE9B,2CAA2C;IAC3C,QAAQ,CAAC,SAAS,EAAE,oBAAoB,CAAC,MAAM,CAAC,CAAA;CACjD;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC,oBAAoB;IACpB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAAA;IAChC,kCAAkC;IAClC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,2CAA2C;IAC3C,QAAQ,CAAC,OAAO,CAAC,EACb,CAAC,CAAC,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE,KAAK,IAAI,CAAC,GACxE,SAAS,CAAA;CACd;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACzE,oCAAoC;IACpC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,eAAe;IACf,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,+CAA+C;IAC/C,QAAQ,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAA;IAC7B,gDAAgD;IAChD,QAAQ,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,SAAS,CAAA;CAClD;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CACnE,KAAK,EAAE,yBAAyB,CAAC,MAAM,CAAC,KACrC,SAAS,CAAA;AAEd;;;;GAIG;AACH,MAAM,WAAW,qBAAqB,CACpC,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAEhE,mCAAmC;IACnC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IAErB,kCAAkC;IAClC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IAErB,qBAAqB;IACrB,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAA;IAEhC,mCAAmC;IACnC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IAErB,gCAAgC;IAChC,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,CAAA;IAElC,oBAAoB;IACpB,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAE7B,8CAA8C;IAC9C,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAA;IAEjC,gCAAgC;IAChC,QAAQ,CAAC,eAAe,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;IAE5C,iCAAiC;IACjC,QAAQ,CAAC,cAAc,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;IAE3C,6DAA6D;IAC7D,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;IAEnC,iEAAiE;IACjE,QAAQ,CAAC,kBAAkB,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;IAE/C,wBAAwB;IACxB,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAA;IAE9B,sBAAsB;IACtB,QAAQ,CAAC,SAAS,EAAE,oBAAoB,CAAC,MAAM,CAAC,CAAA;CACjD;AAMD;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAEnD;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,iBAAiB;IACjB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,kBAAkB;IAClB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACvC,sBAAsB;IACtB,QAAQ,CAAC,QAAQ,CAAC,EAAE,SAAS,SAAS,EAAE,CAAA;CACzC;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc,CAAC,OAAO,SAAS,aAAa,GAAG,aAAa;IAC3E,6CAA6C;IAC7C,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IAEnB,kCAAkC;IAClC,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAA;IAEtB,0BAA0B;IAC1B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;IAE7B,gDAAgD;IAChD,QAAQ,CAAC,YAAY,CAAC,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;IAE1C,uDAAuD;IACvD,QAAQ,CAAC,KAAK,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,SAAS,SAAS,EAAE,CAAA;CAC1D;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB,CAAC,OAAO,SAAS,aAAa,GAAG,aAAa;IAC9E,yBAAyB;IACzB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IAEnB,mBAAmB;IACnB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IAErB,0BAA0B;IAC1B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAE5B,kCAAkC;IAClC,QAAQ,CAAC,YAAY,CAAC,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;IAE1C,qBAAqB;IACrB,QAAQ,CAAC,KAAK,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,SAAS,KAAK,EAAE,CAAA;IAErD,mDAAmD;IACnD,QAAQ,CAAC,cAAc,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,uBAAuB,CAAC,OAAO,CAAC,CAAA;CAC/E;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB,CAAC,OAAO,GAAG,aAAa;IAC9D,gCAAgC;IAChC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAA;IACvB,kCAAkC;IAClC,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAA;IACzB,qCAAqC;IACrC,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,sBAAsB,EAAE,CAAA;CACpD;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,+BAA+B;IAC/B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,oBAAoB;IACpB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;CACzB;AAMD;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,QAAQ,CAAC,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,EAAE,qBAAqB,CAAC,MAAM,CAAC,GAAG,IAAI,CAAA;IAEjG;;OAEG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS,CAAA;IAEpD;;OAEG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAA;IAE1B;;OAEG;IACH,IAAI,IAAI,SAAS,qBAAqB,EAAE,CAAA;IAExC;;OAEG;IACH,aAAa,CAAC,QAAQ,EAAE,aAAa,GAAG,SAAS,qBAAqB,EAAE,CAAA;IAExE;;OAEG;IACH,KAAK,IAAI,SAAS,MAAM,EAAE,CAAA;IAE1B;;OAEG;IACH,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAA;IAEjC;;OAEG;IACH,KAAK,IAAI,IAAI,CAAA;IAEb;;OAEG;IACH,aAAa,IAAI,sBAAsB,CAAA;CACxC;AAMD;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,iCAAiC;IACjC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAA;IACvB,kDAAkD;IAClD,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAA;IACtB,wBAAwB;IACxB,QAAQ,CAAC,MAAM,EAAE,SAAS,oBAAoB,EAAE,CAAA;CACjD;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,iBAAiB;IACjB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,oBAAoB;IACpB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,mCAAmC;IACnC,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACrE,kCAAkC;IAClC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAA;IACvB,kDAAkD;IAClD,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB,wBAAwB;IACxB,QAAQ,CAAC,MAAM,EAAE,SAAS,oBAAoB,EAAE,CAAA;CACjD;AAMD;;GAEG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI,CAAC,SAAS,qBAAqB,CAAC,MAAM,MAAM,CAAC,GAAG,MAAM,GAAG,KAAK,CAAA;AAE/F;;GAEG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,IAAI,CAAC,SAAS,iBAAiB,CAAC,MAAM,OAAO,CAAC,GAAG,OAAO,GAAG,KAAK,CAAA;AAEhG;;GAEG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI,CAAC,SAAS,SAAS,CAAC,MAAM,OAAO,CAAC,GAAG,OAAO,GAAG,KAAK,CAAA"}

package/dist/types.js

@@ -0,0 +1,9 @@
+/**
+ * @pwfabric/authoring Type Definitions
+ *
+ * Core type definitions for the Custom Block SDK.
+ *
+ * @module @pwfabric/authoring/types
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG"}

package/dist/validation.d.ts

@@ -0,0 +1,81 @@
+/**
+ * Validation Utilities
+ *
+ * Schema validation utilities for custom blocks.
+ *
+ * @module @pwfabric/authoring/validation
+ */
+import type { ZodSchema } from 'zod';
+import type { Block } from '@pwfabric/core';
+import type { CustomBlockDefinition, BlockValidationResult, BlockValidationError, PropsValidationResult, ICustomBlockRegistry } from './types.js';
+/**
+ * Validate props against a Zod schema
+ *
+ * @param props - The props to validate
+ * @param schema - The Zod schema to validate against
+ * @returns Validation result with validated props or errors
+ */
+export declare function validateProps<TProps extends Record<string, unknown>>(props: unknown, schema: ZodSchema<TProps>): PropsValidationResult<TProps>;
+/**
+ * Validate props with defaults applied
+ *
+ * If validation fails, returns the default props.
+ *
+ * @param props - The props to validate
+ * @param schema - The Zod schema
+ * @param defaultProps - Default props to use if validation fails
+ * @returns Validated props or defaults
+ */
+export declare function validatePropsWithDefaults<TProps extends Record<string, unknown>>(props: unknown, schema: ZodSchema<TProps>, defaultProps: TProps): TProps;
+/**
+ * Validate a block against its definition
+ *
+ * @param block - The block to validate
+ * @param definition - The block definition
+ * @returns Validation result
+ */
+export declare function validateBlock<TProps extends Record<string, unknown>>(block: Block, definition: CustomBlockDefinition<TProps>): BlockValidationResult;
+/**
+ * Validate a block tree against a registry of definitions
+ *
+ * Recursively validates all blocks in the tree.
+ *
+ * @param blocks - The blocks to validate
+ * @param registry - The block registry
+ * @returns Array of validation errors (empty if all valid)
+ */
+export declare function validateBlockTree(blocks: readonly Block[], registry: ICustomBlockRegistry): readonly BlockValidationError[];
+/**
+ * Create a validation function for a specific block type
+ *
+ * @param definition - The block definition
+ * @returns A validation function
+ */
+export declare function createBlockValidator<TProps extends Record<string, unknown>>(definition: CustomBlockDefinition<TProps>): (block: Block) => BlockValidationResult;
+/**
+ * Create a props validation function for a specific schema
+ *
+ * @param schema - The Zod schema
+ * @returns A validation function
+ */
+export declare function createPropsValidator<TProps extends Record<string, unknown>>(schema: ZodSchema<TProps>): (props: unknown) => PropsValidationResult<TProps>;
+/**
+ * Format validation errors as a human-readable string
+ *
+ * @param errors - The validation errors
+ * @returns Formatted error string
+ */
+export declare function formatValidationErrors(errors: readonly BlockValidationError[]): string;
+/**
+ * Check if a validation result has errors
+ */
+export declare function hasErrors(result: BlockValidationResult | PropsValidationResult): boolean;
+/**
+ * Check if a value is a valid Block
+ */
+export declare function isBlock(value: unknown): value is Block;
+/**
+ * Check if a value is a valid Block array
+ */
+export declare function isBlockArray(value: unknown): value is Block[];
+//# sourceMappingURL=validation.d.ts.map

package/dist/validation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../src/validation.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,KAAK,CAAA;AACpC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAA;AAC3C,OAAO,KAAK,EACV,qBAAqB,EACrB,qBAAqB,EACrB,oBAAoB,EACpB,qBAAqB,EACrB,oBAAoB,EACrB,MAAM,YAAY,CAAA;AAMnB;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAClE,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,GACxB,qBAAqB,CAAC,MAAM,CAAC,CAqB/B;AAED;;;;;;;;;GASG;AACH,wBAAgB,yBAAyB,CAAC,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC9E,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,EACzB,YAAY,EAAE,MAAM,GACnB,MAAM,CAGR;AAMD;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAClE,KAAK,EAAE,KAAK,EACZ,UAAU,EAAE,qBAAqB,CAAC,MAAM,CAAC,GACxC,qBAAqB,CAoDvB;AAED;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,SAAS,KAAK,EAAE,EACxB,QAAQ,EAAE,oBAAoB,GAC7B,SAAS,oBAAoB,EAAE,CAuCjC;AAMD;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACzE,UAAU,EAAE,qBAAqB,CAAC,MAAM,CAAC,GACxC,CAAC,KAAK,EAAE,KAAK,KAAK,qBAAqB,CAEzC;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACzE,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,GACxB,CAAC,KAAK,EAAE,OAAO,KAAK,qBAAqB,CAAC,MAAM,CAAC,CAEnD;AAMD;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,SAAS,oBAAoB,EAAE,GAAG,MAAM,CAWtF;AAED;;GAEG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,qBAAqB,GAAG,qBAAqB,GAAG,OAAO,CAExF;AAMD;;GAEG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,KAAK,CAWtD;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,KAAK,EAAE,CAE7D"}