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

package/dist/schemas/field.d.ts

@@ -0,0 +1,139 @@
+import { z } from 'zod';
+import { Condition } from './common';
+export declare const Rule: z.ZodUnion<readonly [z.ZodObject<{
+    rule: z.ZodLiteral<"required">;
+    message: z.ZodOptional<z.ZodString>;
+}, z.core.$loose>, z.ZodObject<{
+    rule: z.ZodEnum<{
+        min: "min";
+        max: "max";
+    }>;
+    value: z.ZodNumber;
+    message: z.ZodOptional<z.ZodString>;
+}, z.core.$loose>, z.ZodObject<{
+    rule: z.ZodLiteral<"pattern">;
+    value: z.ZodString;
+    flags: z.ZodOptional<z.ZodString>;
+    message: z.ZodOptional<z.ZodString>;
+}, z.core.$loose>, z.ZodObject<{
+    rule: z.ZodEnum<{
+        email: "email";
+        url: "url";
+    }>;
+    message: z.ZodOptional<z.ZodString>;
+}, z.core.$loose>, z.ZodObject<{
+    rule: z.ZodLiteral<"in">;
+    value: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
+    message: z.ZodOptional<z.ZodString>;
+}, z.core.$loose>, z.ZodObject<{
+    rule: z.ZodLiteral<"accept">;
+    value: z.ZodArray<z.ZodString>;
+    message: z.ZodOptional<z.ZodString>;
+}, z.core.$loose>, z.ZodObject<{
+    rule: z.ZodLiteral<"maxSize">;
+    value: z.ZodNumber;
+    message: z.ZodOptional<z.ZodString>;
+}, z.core.$loose>, z.ZodObject<{
+    rule: z.ZodEnum<{
+        before: "before";
+        after: "after";
+    }>;
+    value: z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+        field: z.ZodString;
+    }, z.core.$loose>]>;
+    message: z.ZodOptional<z.ZodString>;
+}, z.core.$loose>, z.ZodObject<{
+    rule: z.ZodString;
+    message: z.ZodOptional<z.ZodString>;
+}, z.core.$loose>]>;
+export declare const BlockType: z.ZodObject<{
+    id: z.ZodString;
+    label: z.ZodString;
+    icon: z.ZodOptional<z.ZodString>;
+    fields: z.ZodArray<typeof Field>;
+}, z.core.$loose>;
+export declare const Field: z.ZodObject<{
+    name: z.ZodString;
+    type: z.ZodString;
+    label: z.ZodOptional<z.ZodString>;
+    help: z.ZodOptional<z.ZodString>;
+    placeholder: z.ZodOptional<z.ZodString>;
+    default: z.ZodOptional<z.ZodUnknown>;
+    localized: z.ZodOptional<z.ZodBoolean>;
+    readOnly: z.ZodOptional<z.ZodBoolean>;
+    createOnly: z.ZodOptional<z.ZodBoolean>;
+    updateOnly: z.ZodOptional<z.ZodBoolean>;
+    rules: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
+        rule: z.ZodLiteral<"required">;
+        message: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>, z.ZodObject<{
+        rule: z.ZodEnum<{
+            min: "min";
+            max: "max";
+        }>;
+        value: z.ZodNumber;
+        message: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>, z.ZodObject<{
+        rule: z.ZodLiteral<"pattern">;
+        value: z.ZodString;
+        flags: z.ZodOptional<z.ZodString>;
+        message: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>, z.ZodObject<{
+        rule: z.ZodEnum<{
+            email: "email";
+            url: "url";
+        }>;
+        message: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>, z.ZodObject<{
+        rule: z.ZodLiteral<"in">;
+        value: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
+        message: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>, z.ZodObject<{
+        rule: z.ZodLiteral<"accept">;
+        value: z.ZodArray<z.ZodString>;
+        message: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>, z.ZodObject<{
+        rule: z.ZodLiteral<"maxSize">;
+        value: z.ZodNumber;
+        message: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>, z.ZodObject<{
+        rule: z.ZodEnum<{
+            before: "before";
+            after: "after";
+        }>;
+        value: z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+            field: z.ZodString;
+        }, z.core.$loose>]>;
+        message: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>, z.ZodObject<{
+        rule: z.ZodString;
+        message: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>]>>>;
+    visibleWhen: z.ZodOptional<z.ZodObject<{
+        field: z.ZodOptional<z.ZodString>;
+        equals: z.ZodOptional<z.ZodUnknown>;
+        in: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
+        notIn: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
+        filled: z.ZodOptional<z.ZodBoolean>;
+        all: z.ZodOptional<z.ZodArray<typeof Condition>>;
+        any: z.ZodOptional<z.ZodArray<typeof Condition>>;
+    }, z.core.$loose>>;
+    options: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        value: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>;
+        label: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        disabled: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$loose>>>;
+    multiple: z.ZodOptional<z.ZodBoolean>;
+    resource: z.ZodOptional<z.ZodString>;
+    accept: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    from: z.ZodOptional<z.ZodString>;
+    display: z.ZodOptional<z.ZodString>;
+    fields: z.ZodOptional<z.ZodArray<typeof Field>>;
+    types: z.ZodOptional<z.ZodArray<typeof BlockType>>;
+    settings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$loose>;
+export type Rule = z.infer<typeof Rule>;
+export type BlockType = z.infer<typeof BlockType>;
+export type Field = z.infer<typeof Field>;
+//# sourceMappingURL=field.d.ts.map

package/dist/schemas/field.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"field.d.ts","sourceRoot":"","sources":["../../src/schemas/field.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,EAAE,SAAS,EAAU,MAAM,UAAU,CAAC;AAY7C,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAkCX,CAAC;AAEP,eAAO,MAAM,SAAS;;;;YAKJ,CAAC,CAAC,QAAQ,CAAC,OAAO,KAAK,CAAC;iBAGxC,CAAC;AAEH,eAAO,MAAM,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAwCI,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,KAAK,CAAC,CAAC;WAMxC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,SAAS,CAAC,CAAC;;iBAQhB,CAAC;AAEjD,MAAM,MAAM,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,CAAC;AACxC,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,SAAS,CAAC,CAAC;AAClD,MAAM,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,KAAK,CAAC,CAAC"}

package/dist/schemas/field.js

@@ -0,0 +1,94 @@
+import { PORTABLE_RULES } from "../constants.js";
+import { Condition, Option } from "./common.js";
+import { z } from "zod";
+//#region src/schemas/field.ts
+var message = z.string().optional().meta({ description: "Message shown when the rule fails, instead of the default one." });
+var DateBound = z.union([z.string().meta({ description: "An ISO 8601 date or date-time." }), z.looseObject({ field: z.string().min(1) }).meta({ description: "Another field of the form." })]);
+var Rule = z.union([
+	z.looseObject({
+		rule: z.literal("required"),
+		message
+	}),
+	z.looseObject({
+		rule: z.enum(["min", "max"]),
+		value: z.number(),
+		message
+	}),
+	z.looseObject({
+		rule: z.literal("pattern"),
+		value: z.string(),
+		flags: z.string().optional(),
+		message
+	}),
+	z.looseObject({
+		rule: z.enum(["email", "url"]),
+		message
+	}),
+	z.looseObject({
+		rule: z.literal("in"),
+		value: z.array(z.union([
+			z.string(),
+			z.number(),
+			z.boolean()
+		])),
+		message
+	}),
+	z.looseObject({
+		rule: z.literal("accept"),
+		value: z.array(z.string().min(1)),
+		message
+	}),
+	z.looseObject({
+		rule: z.literal("maxSize"),
+		value: z.number().int().positive(),
+		message
+	}),
+	z.looseObject({
+		rule: z.enum(["before", "after"]),
+		value: DateBound,
+		message
+	}),
+	z.looseObject({
+		rule: z.string().refine((rule) => !PORTABLE_RULES.includes(rule)),
+		message
+	}).meta({ description: "A rule added in a later version of the protocol. Clients that don't know it ignore it; the server still enforces it." })
+]).meta({ description: "A portable validation rule. `min` and `max` apply to numbers, and to the length of text and arrays. `accept` lists MIME types (`image/*`). `maxSize` is in bytes." });
+var BlockType = z.looseObject({
+	id: z.string().min(1),
+	label: z.string(),
+	icon: z.string().optional(),
+	get fields() {
+		return z.array(Field);
+	}
+});
+var Field = z.looseObject({
+	name: z.string().min(1),
+	type: z.string().min(1).meta({ description: "A built-in field type, or a type provided by a plugin." }),
+	label: z.string().optional(),
+	help: z.string().optional(),
+	placeholder: z.string().optional(),
+	default: z.unknown().optional(),
+	localized: z.boolean().optional().meta({ description: "The value is an object keyed by locale." }),
+	readOnly: z.boolean().optional(),
+	createOnly: z.boolean().optional(),
+	updateOnly: z.boolean().optional(),
+	rules: z.array(Rule).optional(),
+	visibleWhen: Condition.optional(),
+	options: z.array(Option).optional().meta({ description: "`select`: the choices." }),
+	multiple: z.boolean().optional().meta({ description: "`select`, `relation`, `media`: the value is an array." }),
+	resource: z.string().optional().meta({ description: "`relation`: id of the related resource." }),
+	accept: z.array(z.string()).optional().meta({ description: "`media`: accepted MIME types." }),
+	from: z.string().optional().meta({ description: "`slug`: the field the slug is generated from." }),
+	display: z.string().optional().meta({ description: "Display used in lists, when it differs from the default one of the type." }),
+	get fields() {
+		return z.array(Field).optional().meta({ description: "`group` and `repeater`: the nested fields." });
+	},
+	get types() {
+		return z.array(BlockType).optional().meta({ description: "`repeater`: typed blocks, each with its own fields." });
+	},
+	settings: z.record(z.string(), z.unknown()).optional()
+}).meta({ description: "A field of a form." });
+//#endregion
+export { BlockType, Field, Rule };
+
+//# sourceMappingURL=field.js.map

package/dist/schemas/field.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"field.js","names":[],"sources":["../../src/schemas/field.ts"],"sourcesContent":["import { z } from 'zod';\n\nimport { PORTABLE_RULES } from '../constants';\nimport { Condition, Option } from './common';\n\nconst message = z\n    .string()\n    .optional()\n    .meta({ description: 'Message shown when the rule fails, instead of the default one.' });\n\nconst DateBound = z.union([\n    z.string().meta({ description: 'An ISO 8601 date or date-time.' }),\n    z.looseObject({ field: z.string().min(1) }).meta({ description: 'Another field of the form.' }),\n]);\n\nexport const Rule = z\n    .union([\n        z.looseObject({ rule: z.literal('required'), message }),\n        z.looseObject({ rule: z.enum(['min', 'max']), value: z.number(), message }),\n        z.looseObject({\n            rule: z.literal('pattern'),\n            value: z.string(),\n            flags: z.string().optional(),\n            message,\n        }),\n        z.looseObject({ rule: z.enum(['email', 'url']), message }),\n        z.looseObject({\n            rule: z.literal('in'),\n            value: z.array(z.union([z.string(), z.number(), z.boolean()])),\n            message,\n        }),\n        z.looseObject({ rule: z.literal('accept'), value: z.array(z.string().min(1)), message }),\n        z.looseObject({ rule: z.literal('maxSize'), value: z.number().int().positive(), message }),\n        z.looseObject({ rule: z.enum(['before', 'after']), value: DateBound, message }),\n        z\n            .looseObject({\n                rule: z\n                    .string()\n                    .refine((rule) => !(PORTABLE_RULES as readonly string[]).includes(rule)),\n                message,\n            })\n            .meta({\n                description:\n                    \"A rule added in a later version of the protocol. Clients that don't know it ignore it; the server still enforces it.\",\n            }),\n    ])\n    .meta({\n        description:\n            'A portable validation rule. `min` and `max` apply to numbers, and to the length of text and arrays. `accept` lists MIME types (`image/*`). `maxSize` is in bytes.',\n    });\n\nexport const BlockType = z.looseObject({\n    id: z.string().min(1),\n    label: z.string(),\n    icon: z.string().optional(),\n    // Return types are written out so that declaration files keep the recursion.\n    get fields(): z.ZodArray<typeof Field> {\n        return z.array(Field);\n    },\n});\n\nexport const Field = z\n    .looseObject({\n        name: z.string().min(1),\n        type: z\n            .string()\n            .min(1)\n            .meta({ description: 'A built-in field type, or a type provided by a plugin.' }),\n        label: z.string().optional(),\n        help: z.string().optional(),\n        placeholder: z.string().optional(),\n        default: z.unknown().optional(),\n        localized: z\n            .boolean()\n            .optional()\n            .meta({ description: 'The value is an object keyed by locale.' }),\n        readOnly: z.boolean().optional(),\n        createOnly: z.boolean().optional(),\n        updateOnly: z.boolean().optional(),\n        rules: z.array(Rule).optional(),\n        visibleWhen: Condition.optional(),\n        options: z.array(Option).optional().meta({ description: '`select`: the choices.' }),\n        multiple: z\n            .boolean()\n            .optional()\n            .meta({ description: '`select`, `relation`, `media`: the value is an array.' }),\n        resource: z\n            .string()\n            .optional()\n            .meta({ description: '`relation`: id of the related resource.' }),\n        accept: z\n            .array(z.string())\n            .optional()\n            .meta({ description: '`media`: accepted MIME types.' }),\n        from: z\n            .string()\n            .optional()\n            .meta({ description: '`slug`: the field the slug is generated from.' }),\n        display: z.string().optional().meta({\n            description: 'Display used in lists, when it differs from the default one of the type.',\n        }),\n        get fields(): z.ZodOptional<z.ZodArray<typeof Field>> {\n            return z\n                .array(Field)\n                .optional()\n                .meta({ description: '`group` and `repeater`: the nested fields.' });\n        },\n        get types(): z.ZodOptional<z.ZodArray<typeof BlockType>> {\n            return z\n                .array(BlockType)\n                .optional()\n                .meta({ description: '`repeater`: typed blocks, each with its own fields.' });\n        },\n        settings: z.record(z.string(), z.unknown()).optional(),\n    })\n    .meta({ description: 'A field of a form.' });\n\nexport type Rule = z.infer<typeof Rule>;\nexport type BlockType = z.infer<typeof BlockType>;\nexport type Field = z.infer<typeof Field>;\n"],"mappings":";;;;AAKA,IAAM,UAAU,EACX,OAAO,CAAC,CACR,SAAS,CAAC,CACV,KAAK,EAAE,aAAa,iEAAiE,CAAC;AAE3F,IAAM,YAAY,EAAE,MAAM,CACtB,EAAE,OAAO,CAAC,CAAC,KAAK,EAAE,aAAa,iCAAiC,CAAC,GACjE,EAAE,YAAY,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,EAAE,aAAa,6BAA6B,CAAC,CAClG,CAAC;AAED,IAAa,OAAO,EACf,MAAM;CACH,EAAE,YAAY;EAAE,MAAM,EAAE,QAAQ,UAAU;EAAG;CAAQ,CAAC;CACtD,EAAE,YAAY;EAAE,MAAM,EAAE,KAAK,CAAC,OAAO,KAAK,CAAC;EAAG,OAAO,EAAE,OAAO;EAAG;CAAQ,CAAC;CAC1E,EAAE,YAAY;EACV,MAAM,EAAE,QAAQ,SAAS;EACzB,OAAO,EAAE,OAAO;EAChB,OAAO,EAAE,OAAO,CAAC,CAAC,SAAS;EAC3B;CACJ,CAAC;CACD,EAAE,YAAY;EAAE,MAAM,EAAE,KAAK,CAAC,SAAS,KAAK,CAAC;EAAG;CAAQ,CAAC;CACzD,EAAE,YAAY;EACV,MAAM,EAAE,QAAQ,IAAI;EACpB,OAAO,EAAE,MAAM,EAAE,MAAM;GAAC,EAAE,OAAO;GAAG,EAAE,OAAO;GAAG,EAAE,QAAQ;EAAC,CAAC,CAAC;EAC7D;CACJ,CAAC;CACD,EAAE,YAAY;EAAE,MAAM,EAAE,QAAQ,QAAQ;EAAG,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC;EAAG;CAAQ,CAAC;CACvF,EAAE,YAAY;EAAE,MAAM,EAAE,QAAQ,SAAS;EAAG,OAAO,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS;EAAG;CAAQ,CAAC;CACzF,EAAE,YAAY;EAAE,MAAM,EAAE,KAAK,CAAC,UAAU,OAAO,CAAC;EAAG,OAAO;EAAW;CAAQ,CAAC;CAC9E,EACK,YAAY;EACT,MAAM,EACD,OAAO,CAAC,CACR,QAAQ,SAAS,CAAE,eAAqC,SAAS,IAAI,CAAC;EAC3E;CACJ,CAAC,CAAC,CACD,KAAK,EACF,aACI,uHACR,CAAC;AACT,CAAC,CAAC,CACD,KAAK,EACF,aACI,oKACR,CAAC;AAEL,IAAa,YAAY,EAAE,YAAY;CACnC,IAAI,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC;CACpB,OAAO,EAAE,OAAO;CAChB,MAAM,EAAE,OAAO,CAAC,CAAC,SAAS;CAE1B,IAAI,SAAmC;EACnC,OAAO,EAAE,MAAM,KAAK;CACxB;AACJ,CAAC;AAED,IAAa,QAAQ,EAChB,YAAY;CACT,MAAM,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC;CACtB,MAAM,EACD,OAAO,CAAC,CACR,IAAI,CAAC,CAAC,CACN,KAAK,EAAE,aAAa,yDAAyD,CAAC;CACnF,OAAO,EAAE,OAAO,CAAC,CAAC,SAAS;CAC3B,MAAM,EAAE,OAAO,CAAC,CAAC,SAAS;CAC1B,aAAa,EAAE,OAAO,CAAC,CAAC,SAAS;CACjC,SAAS,EAAE,QAAQ,CAAC,CAAC,SAAS;CAC9B,WAAW,EACN,QAAQ,CAAC,CACT,SAAS,CAAC,CACV,KAAK,EAAE,aAAa,0CAA0C,CAAC;CACpE,UAAU,EAAE,QAAQ,CAAC,CAAC,SAAS;CAC/B,YAAY,EAAE,QAAQ,CAAC,CAAC,SAAS;CACjC,YAAY,EAAE,QAAQ,CAAC,CAAC,SAAS;CACjC,OAAO,EAAE,MAAM,IAAI,CAAC,CAAC,SAAS;CAC9B,aAAa,UAAU,SAAS;CAChC,SAAS,EAAE,MAAM,MAAM,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,aAAa,yBAAyB,CAAC;CAClF,UAAU,EACL,QAAQ,CAAC,CACT,SAAS,CAAC,CACV,KAAK,EAAE,aAAa,wDAAwD,CAAC;CAClF,UAAU,EACL,OAAO,CAAC,CACR,SAAS,CAAC,CACV,KAAK,EAAE,aAAa,0CAA0C,CAAC;CACpE,QAAQ,EACH,MAAM,EAAE,OAAO,CAAC,CAAC,CACjB,SAAS,CAAC,CACV,KAAK,EAAE,aAAa,gCAAgC,CAAC;CAC1D,MAAM,EACD,OAAO,CAAC,CACR,SAAS,CAAC,CACV,KAAK,EAAE,aAAa,gDAAgD,CAAC;CAC1E,SAAS,EAAE,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAChC,aAAa,2EACjB,CAAC;CACD,IAAI,SAAkD;EAClD,OAAO,EACF,MAAM,KAAK,CAAC,CACZ,SAAS,CAAC,CACV,KAAK,EAAE,aAAa,6CAA6C,CAAC;CAC3E;CACA,IAAI,QAAqD;EACrD,OAAO,EACF,MAAM,SAAS,CAAC,CAChB,SAAS,CAAC,CACV,KAAK,EAAE,aAAa,sDAAsD,CAAC;CACpF;CACA,UAAU,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC,SAAS;AACzD,CAAC,CAAC,CACD,KAAK,EAAE,aAAa,qBAAqB,CAAC"}