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

package/dist/validation.js

@@ -0,0 +1,217 @@
+/**
+ * Validation Utilities
+ *
+ * Schema validation utilities for custom blocks.
+ *
+ * @module @pwfabric/authoring/validation
+ */
+// ============================================================
+// PROPS VALIDATION
+// ============================================================
+/**
+ * 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 function validateProps(props, schema) {
+    const result = schema.safeParse(props);
+    if (result.success) {
+        return {
+            valid: true,
+            props: result.data,
+            errors: [],
+        };
+    }
+    const errors = result.error.errors.map((e) => ({
+        code: 'VALIDATION_ERROR',
+        message: e.message,
+        path: e.path.join('.'),
+    }));
+    return {
+        valid: false,
+        errors,
+    };
+}
+/**
+ * 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 function validatePropsWithDefaults(props, schema, defaultProps) {
+    const result = schema.safeParse(props);
+    return result.success ? result.data : defaultProps;
+}
+// ============================================================
+// BLOCK VALIDATION
+// ============================================================
+/**
+ * Validate a block against its definition
+ *
+ * @param block - The block to validate
+ * @param definition - The block definition
+ * @returns Validation result
+ */
+export function validateBlock(block, definition) {
+    const errors = [];
+    // Validate type matches
+    if (block.type !== definition.type) {
+        errors.push({
+            code: 'TYPE_MISMATCH',
+            message: `Expected block type "${definition.type}", got "${block.type}"`,
+        });
+        return { valid: false, errors };
+    }
+    // Validate props
+    const propsResult = validateProps(block.props, definition.schema);
+    if (!propsResult.valid) {
+        errors.push(...propsResult.errors);
+    }
+    // Validate children constraints
+    if (block.children && block.children.length > 0) {
+        if (!definition.canHaveChildren) {
+            errors.push({
+                code: 'CHILDREN_NOT_ALLOWED',
+                message: `Block type "${definition.type}" cannot have children`,
+            });
+        }
+        if (definition.allowedChildren && definition.allowedChildren.length > 0) {
+            for (const child of block.children) {
+                if (!definition.allowedChildren.includes(child.type)) {
+                    errors.push({
+                        code: 'INVALID_CHILD_TYPE',
+                        message: `Block type "${child.type}" is not allowed as a child of "${definition.type}"`,
+                        path: `children.${child.id}`,
+                    });
+                }
+            }
+        }
+    }
+    if (errors.length > 0) {
+        return { valid: false, errors };
+    }
+    return {
+        valid: true,
+        block: {
+            ...block,
+            props: propsResult.props ?? block.props,
+        },
+        errors: [],
+    };
+}
+/**
+ * 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 function validateBlockTree(blocks, registry) {
+    const errors = [];
+    function validateRecursive(block, path) {
+        const definition = registry.get(block.type);
+        if (!definition) {
+            // Not a custom block, skip validation
+            // (could be a built-in block type)
+            if (block.children) {
+                block.children.forEach((child, index) => {
+                    validateRecursive(child, `${path}.children[${index}]`);
+                });
+            }
+            return;
+        }
+        const result = validateBlock(block, definition);
+        if (!result.valid) {
+            errors.push(...result.errors.map((e) => ({
+                ...e,
+                path: e.path ? `${path}.${e.path}` : path,
+            })));
+        }
+        if (block.children) {
+            block.children.forEach((child, index) => {
+                validateRecursive(child, `${path}.children[${index}]`);
+            });
+        }
+    }
+    blocks.forEach((block, index) => {
+        validateRecursive(block, `blocks[${index}]`);
+    });
+    return errors;
+}
+// ============================================================
+// SCHEMA UTILITIES
+// ============================================================
+/**
+ * Create a validation function for a specific block type
+ *
+ * @param definition - The block definition
+ * @returns A validation function
+ */
+export function createBlockValidator(definition) {
+    return (block) => validateBlock(block, definition);
+}
+/**
+ * Create a props validation function for a specific schema
+ *
+ * @param schema - The Zod schema
+ * @returns A validation function
+ */
+export function createPropsValidator(schema) {
+    return (props) => validateProps(props, schema);
+}
+// ============================================================
+// ERROR FORMATTING
+// ============================================================
+/**
+ * Format validation errors as a human-readable string
+ *
+ * @param errors - The validation errors
+ * @returns Formatted error string
+ */
+export function formatValidationErrors(errors) {
+    if (errors.length === 0) {
+        return 'No errors';
+    }
+    return errors
+        .map((e) => {
+        const path = e.path ? ` at ${e.path}` : '';
+        return `[${e.code}]${path}: ${e.message}`;
+    })
+        .join('\n');
+}
+/**
+ * Check if a validation result has errors
+ */
+export function hasErrors(result) {
+    return !result.valid && result.errors.length > 0;
+}
+// ============================================================
+// TYPE GUARDS
+// ============================================================
+/**
+ * Check if a value is a valid Block
+ */
+export function isBlock(value) {
+    if (!value || typeof value !== 'object') {
+        return false;
+    }
+    const block = value;
+    return (typeof block.id === 'string' &&
+        typeof block.type === 'string' &&
+        typeof block.props === 'object');
+}
+/**
+ * Check if a value is a valid Block array
+ */
+export function isBlockArray(value) {
+    return Array.isArray(value) && value.every(isBlock);
+}
+//# sourceMappingURL=validation.js.map

package/dist/validation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.js","sourceRoot":"","sources":["../src/validation.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAYH,+DAA+D;AAC/D,mBAAmB;AACnB,+DAA+D;AAE/D;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAC3B,KAAc,EACd,MAAyB;IAEzB,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;IAEtC,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,OAAO;YACL,KAAK,EAAE,IAAI;YACX,KAAK,EAAE,MAAM,CAAC,IAAI;YAClB,MAAM,EAAE,EAAE;SACX,CAAA;IACH,CAAC;IAED,MAAM,MAAM,GAA2B,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACrE,IAAI,EAAE,kBAAkB;QACxB,OAAO,EAAE,CAAC,CAAC,OAAO;QAClB,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;KACvB,CAAC,CAAC,CAAA;IAEH,OAAO;QACL,KAAK,EAAE,KAAK;QACZ,MAAM;KACP,CAAA;AACH,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,yBAAyB,CACvC,KAAc,EACd,MAAyB,EACzB,YAAoB;IAEpB,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;IACtC,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAA;AACpD,CAAC;AAED,+DAA+D;AAC/D,mBAAmB;AACnB,+DAA+D;AAE/D;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAC3B,KAAY,EACZ,UAAyC;IAEzC,MAAM,MAAM,GAA2B,EAAE,CAAA;IAEzC,wBAAwB;IACxB,IAAI,KAAK,CAAC,IAAI,KAAK,UAAU,CAAC,IAAI,EAAE,CAAC;QACnC,MAAM,CAAC,IAAI,CAAC;YACV,IAAI,EAAE,eAAe;YACrB,OAAO,EAAE,wBAAwB,UAAU,CAAC,IAAI,WAAW,KAAK,CAAC,IAAI,GAAG;SACzE,CAAC,CAAA;QACF,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,CAAA;IACjC,CAAC;IAED,iBAAiB;IACjB,MAAM,WAAW,GAAG,aAAa,CAAC,KAAK,CAAC,KAAK,EAAE,UAAU,CAAC,MAAM,CAAC,CAAA;IACjE,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC;QACvB,MAAM,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IACpC,CAAC;IAED,gCAAgC;IAChC,IAAI,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAChD,IAAI,CAAC,UAAU,CAAC,eAAe,EAAE,CAAC;YAChC,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,sBAAsB;gBAC5B,OAAO,EAAE,eAAe,UAAU,CAAC,IAAI,wBAAwB;aAChE,CAAC,CAAA;QACJ,CAAC;QAED,IAAI,UAAU,CAAC,eAAe,IAAI,UAAU,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxE,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;gBACnC,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;oBACrD,MAAM,CAAC,IAAI,CAAC;wBACV,IAAI,EAAE,oBAAoB;wBAC1B,OAAO,EAAE,eAAe,KAAK,CAAC,IAAI,mCAAmC,UAAU,CAAC,IAAI,GAAG;wBACvF,IAAI,EAAE,YAAY,KAAK,CAAC,EAAE,EAAE;qBAC7B,CAAC,CAAA;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,CAAA;IACjC,CAAC;IAED,OAAO;QACL,KAAK,EAAE,IAAI;QACX,KAAK,EAAE;YACL,GAAG,KAAK;YACR,KAAK,EAAE,WAAW,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK;SACxC;QACD,MAAM,EAAE,EAAE;KACX,CAAA;AACH,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,iBAAiB,CAC/B,MAAwB,EACxB,QAA8B;IAE9B,MAAM,MAAM,GAA2B,EAAE,CAAA;IAEzC,SAAS,iBAAiB,CAAC,KAAY,EAAE,IAAY;QACnD,MAAM,UAAU,GAAG,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QAE3C,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,sCAAsC;YACtC,mCAAmC;YACnC,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;gBACnB,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAY,EAAE,KAAa,EAAE,EAAE;oBACrD,iBAAiB,CAAC,KAAK,EAAE,GAAG,IAAI,aAAa,KAAK,GAAG,CAAC,CAAA;gBACxD,CAAC,CAAC,CAAA;YACJ,CAAC;YACD,OAAM;QACR,CAAC;QAED,MAAM,MAAM,GAAG,aAAa,CAAC,KAAK,EAAE,UAAU,CAAC,CAAA;QAC/C,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;YAClB,MAAM,CAAC,IAAI,CACT,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;gBAC3B,GAAG,CAAC;gBACJ,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI;aAC1C,CAAC,CAAC,CACJ,CAAA;QACH,CAAC;QAED,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;YACnB,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAY,EAAE,KAAa,EAAE,EAAE;gBACrD,iBAAiB,CAAC,KAAK,EAAE,GAAG,IAAI,aAAa,KAAK,GAAG,CAAC,CAAA;YACxD,CAAC,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;IAED,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QAC9B,iBAAiB,CAAC,KAAK,EAAE,UAAU,KAAK,GAAG,CAAC,CAAA;IAC9C,CAAC,CAAC,CAAA;IAEF,OAAO,MAAM,CAAA;AACf,CAAC;AAED,+DAA+D;AAC/D,mBAAmB;AACnB,+DAA+D;AAE/D;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAClC,UAAyC;IAEzC,OAAO,CAAC,KAAY,EAAE,EAAE,CAAC,aAAa,CAAC,KAAK,EAAE,UAAU,CAAC,CAAA;AAC3D,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAClC,MAAyB;IAEzB,OAAO,CAAC,KAAc,EAAE,EAAE,CAAC,aAAa,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;AACzD,CAAC;AAED,+DAA+D;AAC/D,mBAAmB;AACnB,+DAA+D;AAE/D;;;;;GAKG;AACH,MAAM,UAAU,sBAAsB,CAAC,MAAuC;IAC5E,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,WAAW,CAAA;IACpB,CAAC;IAED,OAAO,MAAM;SACV,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QACT,MAAM,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAA;QAC1C,OAAO,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,KAAK,CAAC,CAAC,OAAO,EAAE,CAAA;IAC3C,CAAC,CAAC;SACD,IAAI,CAAC,IAAI,CAAC,CAAA;AACf,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,SAAS,CAAC,MAAqD;IAC7E,OAAO,CAAC,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAA;AAClD,CAAC;AAED,+DAA+D;AAC/D,cAAc;AACd,+DAA+D;AAE/D;;GAEG;AACH,MAAM,UAAU,OAAO,CAAC,KAAc;IACpC,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACxC,OAAO,KAAK,CAAA;IACd,CAAC;IAED,MAAM,KAAK,GAAG,KAAuB,CAAA;IACrC,OAAO,CACL,OAAO,KAAK,CAAC,EAAE,KAAK,QAAQ;QAC5B,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ;QAC9B,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,CAChC,CAAA;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,YAAY,CAAC,KAAc;IACzC,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;AACrD,CAAC"}

package/package.json

@@ -1,6 +1,60 @@
 {
   "name": "@pwfabric/authoring",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "1.0.0-rc.0",
+  "description": "Authoring surface for PWFabric — define blocks, factories and capabilities",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md"
+  ],
+  "dependencies": {
+    "zod": "^3.25.76",
+    "@pwfabric/contracts": "1.0.0-rc.0",
+    "@pwfabric/runtime": "1.0.0-rc.0",
+    "@pwfabric/core": "1.0.0-rc.0"
+  },
+  "peerDependencies": {
+    "react": "^19.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "@types/react": "^19.0.0",
+    "@vitest/coverage-v8": "^2.1.9",
+    "typescript": "^5.4.0",
+    "vitest": "^2.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pwfabric/pwfabric",
+    "directory": "packages/authoring"
+  },
+  "homepage": "https://github.com/pwfabric/pwfabric#readme",
+  "bugs": {
+    "url": "https://github.com/pwfabric/pwfabric/issues"
+  },
+  "license": "Apache-2.0",
+  "author": "PhiMajor Solutions",
+  "scripts": {
+    "build": "rm -rf dist tsconfig.tsbuildinfo && tsc",
+    "dev": "tsc --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "lint": "eslint src",
+    "lint:fix": "eslint src --fix",
+    "typecheck": "tsc --noEmit",
+    "clean": "rm -rf dist"
+  }
 }