@panneau/protocol 5.0.0-alpha.0 → 5.0.0-alpha.2

package/dist/validate.js

@@ -1,7 +1,6 @@
+import { lintDefinition } from "./lint.js";
 import { Definition } from "./schemas/definition.js";
-import { Problem } from "./schemas/api.js";
 import { BootConfig } from "./schemas/boot.js";
-import { lintDefinition } from "./lint.js";
 //#region src/validate.ts
 /** Validates a value against one of the protocol's schemas. */
 function validate(schema, input) {
@@ -47,11 +46,7 @@ function validateBootConfig(input) {
 		issues
 	} : result;
 }
-/** Whether a value is a problem details object (an API error). */
-function isProblem(value) {
-	return Problem.safeParse(value).success;
-}
 //#endregion
-export { isProblem, validate, validateBootConfig, validateDefinition };
+export { validate, validateBootConfig, validateDefinition };
 
 //# sourceMappingURL=validate.js.map

package/dist/validate.js.map

@@ -1 +1 @@
-{"version":3,"file":"validate.js","names":[],"sources":["../src/validate.ts"],"sourcesContent":["import type { z } from 'zod';\n\nimport { lintDefinition } from './lint';\nimport { Problem } from './schemas/api';\nimport { BootConfig } from './schemas/boot';\nimport { Definition } from './schemas/definition';\n\nexport interface ValidationIssue {\n    /** Dot path of the invalid value (`resources.0.fields.2.type`), empty for the root. */\n    path: string;\n    message: string;\n}\n\nexport type ValidationResult<T> =\n    { success: true; data: T } | { success: false; issues: ValidationIssue[] };\n\n/** Validates a value against one of the protocol's schemas. */\nexport function validate<T extends z.ZodType>(\n    schema: T,\n    input: unknown,\n): ValidationResult<z.infer<T>> {\n    const result = schema.safeParse(input);\n    if (result.success) {\n        return { success: true, data: result.data };\n    }\n    return {\n        success: false,\n        issues: result.error.issues.map((issue) => ({\n            path: issue.path.map(String).join('.'),\n            message: issue.message,\n        })),\n    };\n}\n\n/**\n * Validates a definition, as returned by `GET /definition`: against the schema, then the\n * references between its parts (see `lintDefinition()`).\n */\nexport function validateDefinition(input: unknown): ValidationResult<Definition> {\n    const result = validate(Definition, input);\n    if (!result.success) {\n        return result;\n    }\n    const issues = lintDefinition(result.data);\n    return issues.length > 0 ? { success: false, issues } : result;\n}\n\n/**\n * Validates a boot config, as a server writes it in the page: against the schema, then the\n * references between the parts of its inlined definition, if any.\n */\nexport function validateBootConfig(input: unknown): ValidationResult<BootConfig> {\n    const result = validate(BootConfig, input);\n    if (!result.success || result.data.definition === undefined) {\n        return result;\n    }\n    const issues = lintDefinition(result.data.definition).map((issue) => ({\n        ...issue,\n        path: issue.path === '' ? 'definition' : `definition.${issue.path}`,\n    }));\n    return issues.length > 0 ? { success: false, issues } : result;\n}\n\n/** Whether a value is a problem details object (an API error). */\nexport function isProblem(value: unknown): value is Problem {\n    return Problem.safeParse(value).success;\n}\n"],"mappings":";;;;;;AAiBA,SAAgB,SACZ,QACA,OAC4B;CAC5B,MAAM,SAAS,OAAO,UAAU,KAAK;CACrC,IAAI,OAAO,SACP,OAAO;EAAE,SAAS;EAAM,MAAM,OAAO;CAAK;CAE9C,OAAO;EACH,SAAS;EACT,QAAQ,OAAO,MAAM,OAAO,KAAK,WAAW;GACxC,MAAM,MAAM,KAAK,IAAI,MAAM,CAAC,CAAC,KAAK,GAAG;GACrC,SAAS,MAAM;EACnB,EAAE;CACN;AACJ;;;;;AAMA,SAAgB,mBAAmB,OAA8C;CAC7E,MAAM,SAAS,SAAS,YAAY,KAAK;CACzC,IAAI,CAAC,OAAO,SACR,OAAO;CAEX,MAAM,SAAS,eAAe,OAAO,IAAI;CACzC,OAAO,OAAO,SAAS,IAAI;EAAE,SAAS;EAAO;CAAO,IAAI;AAC5D;;;;;AAMA,SAAgB,mBAAmB,OAA8C;CAC7E,MAAM,SAAS,SAAS,YAAY,KAAK;CACzC,IAAI,CAAC,OAAO,WAAW,OAAO,KAAK,eAAe,KAAA,GAC9C,OAAO;CAEX,MAAM,SAAS,eAAe,OAAO,KAAK,UAAU,CAAC,CAAC,KAAK,WAAW;EAClE,GAAG;EACH,MAAM,MAAM,SAAS,KAAK,eAAe,cAAc,MAAM;CACjE,EAAE;CACF,OAAO,OAAO,SAAS,IAAI;EAAE,SAAS;EAAO;CAAO,IAAI;AAC5D;;AAGA,SAAgB,UAAU,OAAkC;CACxD,OAAO,QAAQ,UAAU,KAAK,CAAC,CAAC;AACpC"}
+{"version":3,"file":"validate.js","names":[],"sources":["../src/validate.ts"],"sourcesContent":["import type { z } from 'zod';\n\nimport { lintDefinition } from './lint';\nimport { BootConfig } from './schemas/boot';\nimport { Definition } from './schemas/definition';\n\nexport interface ValidationIssue {\n    /** Dot path of the invalid value (`resources.0.fields.2.type`), empty for the root. */\n    path: string;\n    message: string;\n}\n\nexport type ValidationResult<T> =\n    { success: true; data: T } | { success: false; issues: ValidationIssue[] };\n\n/** Validates a value against one of the protocol's schemas. */\nexport function validate<T extends z.ZodType>(\n    schema: T,\n    input: unknown,\n): ValidationResult<z.infer<T>> {\n    const result = schema.safeParse(input);\n    if (result.success) {\n        return { success: true, data: result.data };\n    }\n    return {\n        success: false,\n        issues: result.error.issues.map((issue) => ({\n            path: issue.path.map(String).join('.'),\n            message: issue.message,\n        })),\n    };\n}\n\n/**\n * Validates a definition, as returned by `GET /definition`: against the schema, then the\n * references between its parts (see `lintDefinition()`).\n */\nexport function validateDefinition(input: unknown): ValidationResult<Definition> {\n    const result = validate(Definition, input);\n    if (!result.success) {\n        return result;\n    }\n    const issues = lintDefinition(result.data);\n    return issues.length > 0 ? { success: false, issues } : result;\n}\n\n/**\n * Validates a boot config, as a server writes it in the page: against the schema, then the\n * references between the parts of its inlined definition, if any.\n */\nexport function validateBootConfig(input: unknown): ValidationResult<BootConfig> {\n    const result = validate(BootConfig, input);\n    if (!result.success || result.data.definition === undefined) {\n        return result;\n    }\n    const issues = lintDefinition(result.data.definition).map((issue) => ({\n        ...issue,\n        path: issue.path === '' ? 'definition' : `definition.${issue.path}`,\n    }));\n    return issues.length > 0 ? { success: false, issues } : result;\n}\n"],"mappings":";;;;;AAgBA,SAAgB,SACZ,QACA,OAC4B;CAC5B,MAAM,SAAS,OAAO,UAAU,KAAK;CACrC,IAAI,OAAO,SACP,OAAO;EAAE,SAAS;EAAM,MAAM,OAAO;CAAK;CAE9C,OAAO;EACH,SAAS;EACT,QAAQ,OAAO,MAAM,OAAO,KAAK,WAAW;GACxC,MAAM,MAAM,KAAK,IAAI,MAAM,CAAC,CAAC,KAAK,GAAG;GACrC,SAAS,MAAM;EACnB,EAAE;CACN;AACJ;;;;;AAMA,SAAgB,mBAAmB,OAA8C;CAC7E,MAAM,SAAS,SAAS,YAAY,KAAK;CACzC,IAAI,CAAC,OAAO,SACR,OAAO;CAEX,MAAM,SAAS,eAAe,OAAO,IAAI;CACzC,OAAO,OAAO,SAAS,IAAI;EAAE,SAAS;EAAO;CAAO,IAAI;AAC5D;;;;;AAMA,SAAgB,mBAAmB,OAA8C;CAC7E,MAAM,SAAS,SAAS,YAAY,KAAK;CACzC,IAAI,CAAC,OAAO,WAAW,OAAO,KAAK,eAAe,KAAA,GAC9C,OAAO;CAEX,MAAM,SAAS,eAAe,OAAO,KAAK,UAAU,CAAC,CAAC,KAAK,WAAW;EAClE,GAAG;EACH,MAAM,MAAM,SAAS,KAAK,eAAe,cAAc,MAAM;CACjE,EAAE;CACF,OAAO,OAAO,SAAS,IAAI;EAAE,SAAS;EAAO;CAAO,IAAI;AAC5D"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@panneau/protocol",
-    "version": "5.0.0-alpha.0",
+    "version": "5.0.0-alpha.2",
     "description": "The Panneau protocol: definition schema, HTTP API spec and conformance kit",
     "type": "module",
     "license": "MIT",
@@ -16,6 +16,11 @@
             "types": "./dist/index.d.ts",
             "default": "./dist/index.js"
         },
+        "./runtime": {
+            "@panneau/source": "./src/runtime/index.ts",
+            "types": "./dist/runtime/index.d.ts",
+            "default": "./dist/runtime/index.js"
+        },
         "./mock": {
             "@panneau/source": "./src/mock/index.ts",
             "types": "./dist/mock/index.d.ts",
@@ -29,6 +34,7 @@
         "./definition.schema.json": "./schema/definition.schema.json",
         "./openapi.json": "./schema/openapi.json",
         "./boot.schema.json": "./schema/boot.schema.json",
+        "./theme.schema.json": "./schema/theme.schema.json",
         "./package.json": "./package.json"
     },
     "files": [

package/schema/boot.schema.json

@@ -141,18 +141,7 @@
                     "$ref": "#/$defs/Uploads"
                 },
                 "theme": {
-                    "type": "object",
-                    "properties": {
-                        "colorScheme": {
-                            "type": "string",
-                            "enum": [
-                                "light",
-                                "dark",
-                                "auto"
-                            ]
-                        }
-                    },
-                    "additionalProperties": {}
+                    "$ref": "#/$defs/DefinitionTheme"
                 },
                 "user": {
                     "anyOf": [
@@ -1196,6 +1185,260 @@
             ],
             "additionalProperties": {}
         },
+        "DefinitionTheme": {
+            "type": "object",
+            "properties": {
+                "label": {
+                    "type": "string"
+                },
+                "tokens": {
+                    "$ref": "#/$defs/ThemeTokens"
+                },
+                "dark": {
+                    "$ref": "#/$defs/ThemeTokens"
+                },
+                "palette": {
+                    "type": "object",
+                    "propertyNames": {
+                        "type": "string",
+                        "pattern": "^[a-z0-9-]+$"
+                    },
+                    "additionalProperties": {
+                        "type": "string",
+                        "pattern": "^[^{};<]*$"
+                    }
+                },
+                "tones": {
+                    "type": "object",
+                    "propertyNames": {
+                        "type": "string",
+                        "pattern": "^[a-z0-9-]+$"
+                    },
+                    "additionalProperties": {
+                        "$ref": "#/$defs/ToneInput"
+                    }
+                },
+                "components": {
+                    "type": "object",
+                    "propertyNames": {
+                        "type": "string",
+                        "pattern": "^[a-z0-9-]+$"
+                    },
+                    "additionalProperties": {
+                        "type": "object",
+                        "properties": {
+                            "variants": {
+                                "type": "object",
+                                "propertyNames": {
+                                    "type": "string",
+                                    "pattern": "^[a-z0-9-]+$"
+                                },
+                                "additionalProperties": {
+                                    "$ref": "#/$defs/ThemeTokens"
+                                }
+                            }
+                        },
+                        "additionalProperties": {}
+                    }
+                },
+                "densities": {
+                    "type": "object",
+                    "properties": {
+                        "compact": {
+                            "$ref": "#/$defs/ThemeTokens"
+                        },
+                        "comfortable": {
+                            "$ref": "#/$defs/ThemeTokens"
+                        },
+                        "touch": {
+                            "$ref": "#/$defs/ThemeTokens"
+                        }
+                    },
+                    "additionalProperties": {}
+                },
+                "fonts": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/ThemeFont"
+                    }
+                },
+                "colorScheme": {
+                    "type": "string",
+                    "enum": [
+                        "light",
+                        "dark",
+                        "auto"
+                    ]
+                },
+                "density": {
+                    "type": "string",
+                    "enum": [
+                        "compact",
+                        "comfortable",
+                        "touch",
+                        "auto"
+                    ]
+                },
+                "extends": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        }
+                    ]
+                }
+            },
+            "additionalProperties": {}
+        },
+        "ThemeTokens": {
+            "type": "object",
+            "propertyNames": {
+                "type": "string",
+                "pattern": "^[a-zA-Z0-9_-]+$"
+            },
+            "additionalProperties": {
+                "type": "string",
+                "pattern": "^[^{};<]*$"
+            }
+        },
+        "ToneInput": {
+            "anyOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "type": "object",
+                    "properties": {
+                        "text": {
+                            "type": "string"
+                        },
+                        "subtle": {
+                            "type": "string"
+                        },
+                        "border": {
+                            "type": "string"
+                        },
+                        "outline": {
+                            "type": "string"
+                        },
+                        "solid": {
+                            "type": "string"
+                        },
+                        "solidHover": {
+                            "type": "string"
+                        },
+                        "solidText": {
+                            "type": "string"
+                        },
+                        "dark": {
+                            "type": "object",
+                            "properties": {
+                                "text": {
+                                    "type": "string"
+                                },
+                                "subtle": {
+                                    "type": "string"
+                                },
+                                "border": {
+                                    "type": "string"
+                                },
+                                "outline": {
+                                    "type": "string"
+                                },
+                                "solid": {
+                                    "type": "string"
+                                },
+                                "solidHover": {
+                                    "type": "string"
+                                },
+                                "solidText": {
+                                    "type": "string"
+                                }
+                            },
+                            "additionalProperties": {}
+                        }
+                    },
+                    "required": [
+                        "text",
+                        "subtle",
+                        "border",
+                        "outline",
+                        "solid",
+                        "solidHover",
+                        "solidText"
+                    ],
+                    "additionalProperties": {}
+                }
+            ]
+        },
+        "ThemeFont": {
+            "anyOf": [
+                {
+                    "$ref": "#/$defs/ThemeFontFace"
+                },
+                {
+                    "$ref": "#/$defs/ThemeFontStylesheet"
+                }
+            ]
+        },
+        "ThemeFontFace": {
+            "type": "object",
+            "properties": {
+                "family": {
+                    "type": "string",
+                    "pattern": "^[^{}<;\"\\\\]+$"
+                },
+                "src": {
+                    "type": "string",
+                    "pattern": "^[^{}<]+$"
+                },
+                "weight": {
+                    "type": "string",
+                    "pattern": "^[^{}<;]*$"
+                },
+                "style": {
+                    "type": "string",
+                    "pattern": "^[^{}<;]*$"
+                },
+                "display": {
+                    "type": "string",
+                    "enum": [
+                        "auto",
+                        "block",
+                        "swap",
+                        "fallback",
+                        "optional"
+                    ]
+                },
+                "unicodeRange": {
+                    "type": "string",
+                    "pattern": "^[^{}<;]*$"
+                }
+            },
+            "required": [
+                "family",
+                "src"
+            ],
+            "additionalProperties": {}
+        },
+        "ThemeFontStylesheet": {
+            "type": "object",
+            "properties": {
+                "stylesheet": {
+                    "type": "string",
+                    "minLength": 1
+                }
+            },
+            "required": [
+                "stylesheet"
+            ],
+            "additionalProperties": {}
+        },
         "User": {
             "type": "object",
             "properties": {

package/schema/definition.schema.json

@@ -107,18 +107,7 @@
                     "$ref": "#/$defs/Uploads"
                 },
                 "theme": {
-                    "type": "object",
-                    "properties": {
-                        "colorScheme": {
-                            "type": "string",
-                            "enum": [
-                                "light",
-                                "dark",
-                                "auto"
-                            ]
-                        }
-                    },
-                    "additionalProperties": {}
+                    "$ref": "#/$defs/DefinitionTheme"
                 },
                 "user": {
                     "anyOf": [
@@ -1162,6 +1151,260 @@
             ],
             "additionalProperties": {}
         },
+        "DefinitionTheme": {
+            "type": "object",
+            "properties": {
+                "label": {
+                    "type": "string"
+                },
+                "tokens": {
+                    "$ref": "#/$defs/ThemeTokens"
+                },
+                "dark": {
+                    "$ref": "#/$defs/ThemeTokens"
+                },
+                "palette": {
+                    "type": "object",
+                    "propertyNames": {
+                        "type": "string",
+                        "pattern": "^[a-z0-9-]+$"
+                    },
+                    "additionalProperties": {
+                        "type": "string",
+                        "pattern": "^[^{};<]*$"
+                    }
+                },
+                "tones": {
+                    "type": "object",
+                    "propertyNames": {
+                        "type": "string",
+                        "pattern": "^[a-z0-9-]+$"
+                    },
+                    "additionalProperties": {
+                        "$ref": "#/$defs/ToneInput"
+                    }
+                },
+                "components": {
+                    "type": "object",
+                    "propertyNames": {
+                        "type": "string",
+                        "pattern": "^[a-z0-9-]+$"
+                    },
+                    "additionalProperties": {
+                        "type": "object",
+                        "properties": {
+                            "variants": {
+                                "type": "object",
+                                "propertyNames": {
+                                    "type": "string",
+                                    "pattern": "^[a-z0-9-]+$"
+                                },
+                                "additionalProperties": {
+                                    "$ref": "#/$defs/ThemeTokens"
+                                }
+                            }
+                        },
+                        "additionalProperties": {}
+                    }
+                },
+                "densities": {
+                    "type": "object",
+                    "properties": {
+                        "compact": {
+                            "$ref": "#/$defs/ThemeTokens"
+                        },
+                        "comfortable": {
+                            "$ref": "#/$defs/ThemeTokens"
+                        },
+                        "touch": {
+                            "$ref": "#/$defs/ThemeTokens"
+                        }
+                    },
+                    "additionalProperties": {}
+                },
+                "fonts": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/ThemeFont"
+                    }
+                },
+                "colorScheme": {
+                    "type": "string",
+                    "enum": [
+                        "light",
+                        "dark",
+                        "auto"
+                    ]
+                },
+                "density": {
+                    "type": "string",
+                    "enum": [
+                        "compact",
+                        "comfortable",
+                        "touch",
+                        "auto"
+                    ]
+                },
+                "extends": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        }
+                    ]
+                }
+            },
+            "additionalProperties": {}
+        },
+        "ThemeTokens": {
+            "type": "object",
+            "propertyNames": {
+                "type": "string",
+                "pattern": "^[a-zA-Z0-9_-]+$"
+            },
+            "additionalProperties": {
+                "type": "string",
+                "pattern": "^[^{};<]*$"
+            }
+        },
+        "ToneInput": {
+            "anyOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "type": "object",
+                    "properties": {
+                        "text": {
+                            "type": "string"
+                        },
+                        "subtle": {
+                            "type": "string"
+                        },
+                        "border": {
+                            "type": "string"
+                        },
+                        "outline": {
+                            "type": "string"
+                        },
+                        "solid": {
+                            "type": "string"
+                        },
+                        "solidHover": {
+                            "type": "string"
+                        },
+                        "solidText": {
+                            "type": "string"
+                        },
+                        "dark": {
+                            "type": "object",
+                            "properties": {
+                                "text": {
+                                    "type": "string"
+                                },
+                                "subtle": {
+                                    "type": "string"
+                                },
+                                "border": {
+                                    "type": "string"
+                                },
+                                "outline": {
+                                    "type": "string"
+                                },
+                                "solid": {
+                                    "type": "string"
+                                },
+                                "solidHover": {
+                                    "type": "string"
+                                },
+                                "solidText": {
+                                    "type": "string"
+                                }
+                            },
+                            "additionalProperties": {}
+                        }
+                    },
+                    "required": [
+                        "text",
+                        "subtle",
+                        "border",
+                        "outline",
+                        "solid",
+                        "solidHover",
+                        "solidText"
+                    ],
+                    "additionalProperties": {}
+                }
+            ]
+        },
+        "ThemeFont": {
+            "anyOf": [
+                {
+                    "$ref": "#/$defs/ThemeFontFace"
+                },
+                {
+                    "$ref": "#/$defs/ThemeFontStylesheet"
+                }
+            ]
+        },
+        "ThemeFontFace": {
+            "type": "object",
+            "properties": {
+                "family": {
+                    "type": "string",
+                    "pattern": "^[^{}<;\"\\\\]+$"
+                },
+                "src": {
+                    "type": "string",
+                    "pattern": "^[^{}<]+$"
+                },
+                "weight": {
+                    "type": "string",
+                    "pattern": "^[^{}<;]*$"
+                },
+                "style": {
+                    "type": "string",
+                    "pattern": "^[^{}<;]*$"
+                },
+                "display": {
+                    "type": "string",
+                    "enum": [
+                        "auto",
+                        "block",
+                        "swap",
+                        "fallback",
+                        "optional"
+                    ]
+                },
+                "unicodeRange": {
+                    "type": "string",
+                    "pattern": "^[^{}<;]*$"
+                }
+            },
+            "required": [
+                "family",
+                "src"
+            ],
+            "additionalProperties": {}
+        },
+        "ThemeFontStylesheet": {
+            "type": "object",
+            "properties": {
+                "stylesheet": {
+                    "type": "string",
+                    "minLength": 1
+                }
+            },
+            "required": [
+                "stylesheet"
+            ],
+            "additionalProperties": {}
+        },
         "User": {
             "type": "object",
             "properties": {