@panneau/protocol 0.0.0-stage → 5.0.0-alpha.1

package/dist/schemas/resource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resource.js","names":[],"sources":["../../src/schemas/resource.ts"],"sourcesContent":["import { z } from 'zod';\n\nimport { Action } from './action';\nimport { Abilities } from './common';\nimport { BlockType, Field } from './field';\nimport { LayoutNode } from './layout';\nimport { ListDefinition } from './list';\n\nexport const ResourceFeatures = z.looseObject({\n    drafts: z.boolean().optional(),\n    revisions: z.boolean().optional(),\n    preview: z\n        .union([\n            z.null(),\n            z.looseObject({\n                mode: z.enum(['component', 'iframe']),\n                component: z\n                    .string()\n                    .optional()\n                    .meta({ description: '`component`: the plugin preview.' }),\n            }),\n        ])\n        .optional(),\n    search: z\n        .boolean()\n        .optional()\n        .meta({ description: 'Whether the resource is in the global search.' }),\n});\n\nexport const Resource = z\n    .looseObject({\n        id: z.string().min(1),\n        label: z.looseObject({ singular: z.string(), plural: z.string() }),\n        description: z.string().optional(),\n        icon: z.string().optional(),\n        itemTitle: z\n            .string()\n            .optional()\n            .meta({ description: 'The field used as the title of an item, in lists and pickers.' }),\n        fields: z.array(Field),\n        form: z.looseObject({ layout: z.array(LayoutNode).optional() }).optional(),\n        list: ListDefinition.optional(),\n        actions: z.array(Action).optional(),\n        abilities: Abilities.optional(),\n        features: ResourceFeatures.optional(),\n        types: z\n            .array(BlockType)\n            .optional()\n            .meta({ description: 'Variants of the resource, each with its own extra fields.' }),\n        settings: z.record(z.string(), z.unknown()).optional(),\n    })\n    .meta({ description: 'A set of items managed in the admin.' });\n\nexport type ResourceFeatures = z.infer<typeof ResourceFeatures>;\nexport type Resource = z.infer<typeof Resource>;\n/** A resource as a backend writes it, before defaults are applied. */\nexport type ResourceInput = z.input<typeof Resource>;\n"],"mappings":";;;;;;;AAQA,IAAa,mBAAmB,EAAE,YAAY;CAC1C,QAAQ,EAAE,QAAQ,CAAC,CAAC,SAAS;CAC7B,WAAW,EAAE,QAAQ,CAAC,CAAC,SAAS;CAChC,SAAS,EACJ,MAAM,CACH,EAAE,KAAK,GACP,EAAE,YAAY;EACV,MAAM,EAAE,KAAK,CAAC,aAAa,QAAQ,CAAC;EACpC,WAAW,EACN,OAAO,CAAC,CACR,SAAS,CAAC,CACV,KAAK,EAAE,aAAa,mCAAmC,CAAC;CACjE,CAAC,CACL,CAAC,CAAC,CACD,SAAS;CACd,QAAQ,EACH,QAAQ,CAAC,CACT,SAAS,CAAC,CACV,KAAK,EAAE,aAAa,gDAAgD,CAAC;AAC9E,CAAC;AAED,IAAa,WAAW,EACnB,YAAY;CACT,IAAI,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC;CACpB,OAAO,EAAE,YAAY;EAAE,UAAU,EAAE,OAAO;EAAG,QAAQ,EAAE,OAAO;CAAE,CAAC;CACjE,aAAa,EAAE,OAAO,CAAC,CAAC,SAAS;CACjC,MAAM,EAAE,OAAO,CAAC,CAAC,SAAS;CAC1B,WAAW,EACN,OAAO,CAAC,CACR,SAAS,CAAC,CACV,KAAK,EAAE,aAAa,gEAAgE,CAAC;CAC1F,QAAQ,EAAE,MAAM,KAAK;CACrB,MAAM,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,SAAS;CACzE,MAAM,eAAe,SAAS;CAC9B,SAAS,EAAE,MAAM,MAAM,CAAC,CAAC,SAAS;CAClC,WAAW,UAAU,SAAS;CAC9B,UAAU,iBAAiB,SAAS;CACpC,OAAO,EACF,MAAM,SAAS,CAAC,CAChB,SAAS,CAAC,CACV,KAAK,EAAE,aAAa,4DAA4D,CAAC;CACtF,UAAU,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC,SAAS;AACzD,CAAC,CAAC,CACD,KAAK,EAAE,aAAa,uCAAuC,CAAC"}

package/dist/validate.d.ts

@@ -0,0 +1,28 @@
+import type { z } from 'zod';
+import { BootConfig } from './schemas/boot';
+import { Definition } from './schemas/definition';
+export interface ValidationIssue {
+    /** Dot path of the invalid value (`resources.0.fields.2.type`), empty for the root. */
+    path: string;
+    message: string;
+}
+export type ValidationResult<T> = {
+    success: true;
+    data: T;
+} | {
+    success: false;
+    issues: ValidationIssue[];
+};
+/** Validates a value against one of the protocol's schemas. */
+export declare function validate<T extends z.ZodType>(schema: T, input: unknown): ValidationResult<z.infer<T>>;
+/**
+ * Validates a definition, as returned by `GET /definition`: against the schema, then the
+ * references between its parts (see `lintDefinition()`).
+ */
+export declare function validateDefinition(input: unknown): ValidationResult<Definition>;
+/**
+ * Validates a boot config, as a server writes it in the page: against the schema, then the
+ * references between the parts of its inlined definition, if any.
+ */
+export declare function validateBootConfig(input: unknown): ValidationResult<BootConfig>;
+//# sourceMappingURL=validate.d.ts.map

package/dist/validate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../src/validate.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAG7B,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAElD,MAAM,WAAW,eAAe;IAC5B,uFAAuF;IACvF,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAC1B;IAAE,OAAO,EAAE,IAAI,CAAC;IAAC,IAAI,EAAE,CAAC,CAAA;CAAE,GAAG;IAAE,OAAO,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,eAAe,EAAE,CAAA;CAAE,CAAC;AAE/E,+DAA+D;AAC/D,wBAAgB,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EACxC,MAAM,EAAE,CAAC,EACT,KAAK,EAAE,OAAO,GACf,gBAAgB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAY9B;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAO/E;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAU/E"}

package/dist/validate.js

@@ -0,0 +1,52 @@
+import { lintDefinition } from "./lint.js";
+import { Definition } from "./schemas/definition.js";
+import { BootConfig } from "./schemas/boot.js";
+//#region src/validate.ts
+/** Validates a value against one of the protocol's schemas. */
+function validate(schema, input) {
+	const result = schema.safeParse(input);
+	if (result.success) return {
+		success: true,
+		data: result.data
+	};
+	return {
+		success: false,
+		issues: result.error.issues.map((issue) => ({
+			path: issue.path.map(String).join("."),
+			message: issue.message
+		}))
+	};
+}
+/**
+* Validates a definition, as returned by `GET /definition`: against the schema, then the
+* references between its parts (see `lintDefinition()`).
+*/
+function validateDefinition(input) {
+	const result = validate(Definition, input);
+	if (!result.success) return result;
+	const issues = lintDefinition(result.data);
+	return issues.length > 0 ? {
+		success: false,
+		issues
+	} : result;
+}
+/**
+* Validates a boot config, as a server writes it in the page: against the schema, then the
+* references between the parts of its inlined definition, if any.
+*/
+function validateBootConfig(input) {
+	const result = validate(BootConfig, input);
+	if (!result.success || result.data.definition === void 0) return result;
+	const issues = lintDefinition(result.data.definition).map((issue) => ({
+		...issue,
+		path: issue.path === "" ? "definition" : `definition.${issue.path}`
+	}));
+	return issues.length > 0 ? {
+		success: false,
+		issues
+	} : result;
+}
+//#endregion
+export { validate, validateBootConfig, validateDefinition };
+
+//# sourceMappingURL=validate.js.map

package/dist/validate.js.map

@@ -0,0 +1 @@
+{"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/dist/values.d.ts

@@ -0,0 +1,7 @@
+/** Reads a value at a dot path (`blocks.2.title.fr`). */
+export declare function getValue(values: unknown, path: string): unknown;
+/** Whether a value counts as filled: not null, not an empty or blank string, not an empty array or object. */
+export declare function isFilled(value: unknown): boolean;
+export declare function isRecord(value: unknown): value is Record<string, unknown>;
+export declare function isEqual(a: unknown, b: unknown): boolean;
+//# sourceMappingURL=values.d.ts.map

package/dist/values.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"values.d.ts","sourceRoot":"","sources":["../src/values.ts"],"names":[],"mappings":"AAAA,yDAAyD;AACzD,wBAAgB,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAU/D;AAED,8GAA8G;AAC9G,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAchD;AAED,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAEzE;AAED,wBAAgB,OAAO,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,GAAG,OAAO,CAQvD"}

package/dist/values.js

@@ -0,0 +1,29 @@
+//#region src/values.ts
+/** Reads a value at a dot path (`blocks.2.title.fr`). */
+function getValue(values, path) {
+	if (path === "") return values;
+	return path.split(".").reduce((current, key) => {
+		if (current === null || typeof current !== "object") return;
+		return current[key];
+	}, values);
+}
+/** Whether a value counts as filled: not null, not an empty or blank string, not an empty array or object. */
+function isFilled(value) {
+	if (value === null || value === void 0) return false;
+	if (typeof value === "string") return value.trim() !== "";
+	if (Array.isArray(value)) return value.length > 0;
+	if (typeof value === "object") return Object.keys(value).length > 0;
+	return true;
+}
+function isRecord(value) {
+	return value !== null && typeof value === "object" && !Array.isArray(value);
+}
+function isEqual(a, b) {
+	if (a === b) return true;
+	if (typeof a !== "object" || typeof b !== "object" || a === null || b === null) return false;
+	return JSON.stringify(a) === JSON.stringify(b);
+}
+//#endregion
+export { getValue, isEqual, isFilled, isRecord };
+
+//# sourceMappingURL=values.js.map

package/dist/values.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"values.js","names":[],"sources":["../src/values.ts"],"sourcesContent":["/** Reads a value at a dot path (`blocks.2.title.fr`). */\nexport function getValue(values: unknown, path: string): unknown {\n    if (path === '') {\n        return values;\n    }\n    return path.split('.').reduce<unknown>((current, key) => {\n        if (current === null || typeof current !== 'object') {\n            return undefined;\n        }\n        return (current as Record<string, unknown>)[key];\n    }, values);\n}\n\n/** Whether a value counts as filled: not null, not an empty or blank string, not an empty array or object. */\nexport function isFilled(value: unknown): boolean {\n    if (value === null || value === undefined) {\n        return false;\n    }\n    if (typeof value === 'string') {\n        return value.trim() !== '';\n    }\n    if (Array.isArray(value)) {\n        return value.length > 0;\n    }\n    if (typeof value === 'object') {\n        return Object.keys(value).length > 0;\n    }\n    return true;\n}\n\nexport function isRecord(value: unknown): value is Record<string, unknown> {\n    return value !== null && typeof value === 'object' && !Array.isArray(value);\n}\n\nexport function isEqual(a: unknown, b: unknown): boolean {\n    if (a === b) {\n        return true;\n    }\n    if (typeof a !== 'object' || typeof b !== 'object' || a === null || b === null) {\n        return false;\n    }\n    return JSON.stringify(a) === JSON.stringify(b);\n}\n"],"mappings":";;AACA,SAAgB,SAAS,QAAiB,MAAuB;CAC7D,IAAI,SAAS,IACT,OAAO;CAEX,OAAO,KAAK,MAAM,GAAG,CAAC,CAAC,QAAiB,SAAS,QAAQ;EACrD,IAAI,YAAY,QAAQ,OAAO,YAAY,UACvC;EAEJ,OAAQ,QAAoC;CAChD,GAAG,MAAM;AACb;;AAGA,SAAgB,SAAS,OAAyB;CAC9C,IAAI,UAAU,QAAQ,UAAU,KAAA,GAC5B,OAAO;CAEX,IAAI,OAAO,UAAU,UACjB,OAAO,MAAM,KAAK,MAAM;CAE5B,IAAI,MAAM,QAAQ,KAAK,GACnB,OAAO,MAAM,SAAS;CAE1B,IAAI,OAAO,UAAU,UACjB,OAAO,OAAO,KAAK,KAAK,CAAC,CAAC,SAAS;CAEvC,OAAO;AACX;AAEA,SAAgB,SAAS,OAAkD;CACvE,OAAO,UAAU,QAAQ,OAAO,UAAU,YAAY,CAAC,MAAM,QAAQ,KAAK;AAC9E;AAEA,SAAgB,QAAQ,GAAY,GAAqB;CACrD,IAAI,MAAM,GACN,OAAO;CAEX,IAAI,OAAO,MAAM,YAAY,OAAO,MAAM,YAAY,MAAM,QAAQ,MAAM,MACtE,OAAO;CAEX,OAAO,KAAK,UAAU,CAAC,MAAM,KAAK,UAAU,CAAC;AACjD"}

package/dist/version.d.ts

@@ -0,0 +1,5 @@
+/** Version of the Panneau protocol described by this package. */
+export declare const PROTOCOL_VERSION = 1;
+/** Media type of error responses. */
+export declare const PROBLEM_CONTENT_TYPE = "application/problem+json";
+//# sourceMappingURL=version.d.ts.map

package/dist/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AAAA,iEAAiE;AACjE,eAAO,MAAM,gBAAgB,IAAI,CAAC;AAElC,qCAAqC;AACrC,eAAO,MAAM,oBAAoB,6BAA6B,CAAC"}

package/dist/version.js

@@ -0,0 +1,9 @@
+//#region src/version.ts
+/** Version of the Panneau protocol described by this package. */
+var PROTOCOL_VERSION = 1;
+/** Media type of error responses. */
+var PROBLEM_CONTENT_TYPE = "application/problem+json";
+//#endregion
+export { PROBLEM_CONTENT_TYPE, PROTOCOL_VERSION };
+
+//# sourceMappingURL=version.js.map

package/dist/version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.js","names":[],"sources":["../src/version.ts"],"sourcesContent":["/** Version of the Panneau protocol described by this package. */\nexport const PROTOCOL_VERSION = 1;\n\n/** Media type of error responses. */\nexport const PROBLEM_CONTENT_TYPE = 'application/problem+json';\n"],"mappings":";;AACA,IAAa,mBAAmB;;AAGhC,IAAa,uBAAuB"}

package/package.json

@@ -1,6 +1,54 @@
 {
-  "name": "@panneau/protocol",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+    "name": "@panneau/protocol",
+    "version": "5.0.0-alpha.1",
+    "description": "The Panneau protocol: definition schema, HTTP API spec and conformance kit",
+    "type": "module",
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/folkloreinc/panneau-js.git",
+        "directory": "packages/protocol"
+    },
+    "sideEffects": false,
+    "exports": {
+        ".": {
+            "@panneau/source": "./src/index.ts",
+            "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",
+            "default": "./dist/mock/index.js"
+        },
+        "./conformance": {
+            "@panneau/source": "./src/conformance/index.ts",
+            "types": "./dist/conformance/index.d.ts",
+            "default": "./dist/conformance/index.js"
+        },
+        "./definition.schema.json": "./schema/definition.schema.json",
+        "./openapi.json": "./schema/openapi.json",
+        "./boot.schema.json": "./schema/boot.schema.json",
+        "./package.json": "./package.json"
+    },
+    "files": [
+        "dist",
+        "schema"
+    ],
+    "scripts": {
+        "build": "vite build && tsc -p tsconfig.build.json && node scripts/generate-schemas.js",
+        "typecheck": "tsc --noEmit",
+        "api": "tsc -p tsconfig.build.json && node ../../scripts/api-report.js"
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "dependencies": {
+        "zod": "^4.6.7"
+    }
+}