@panneau/protocol 5.0.0-alpha.3 → 5.0.0-alpha.5

package/dist/schemas/resource.d.ts

@@ -15,6 +15,7 @@ export declare const ResourceFeatures: z.ZodObject<{
 }, z.core.$loose>;
 export declare const Resource: z.ZodObject<{
     id: z.ZodString;
+    kind: z.ZodOptional<z.ZodString>;
     label: z.ZodObject<{
         singular: z.ZodString;
         plural: z.ZodString;
@@ -22,6 +23,8 @@ export declare const Resource: z.ZodObject<{
     description: z.ZodOptional<z.ZodString>;
     icon: z.ZodOptional<z.ZodString>;
     itemTitle: z.ZodOptional<z.ZodString>;
+    itemSubtitle: z.ZodOptional<z.ZodString>;
+    itemImage: z.ZodOptional<z.ZodString>;
     fields: z.ZodArray<z.ZodObject<{
         name: z.ZodString;
         type: z.ZodString;
@@ -75,6 +78,13 @@ export declare const Resource: z.ZodObject<{
                 field: z.ZodString;
             }, z.core.$loose>]>;
             message: z.ZodOptional<z.ZodString>;
+        }, z.core.$loose>, z.ZodObject<{
+            rule: z.ZodLiteral<"crop">;
+            value: z.ZodObject<{
+                ratios: z.ZodOptional<z.ZodArray<z.ZodString>>;
+                required: z.ZodOptional<z.ZodBoolean>;
+            }, z.core.$loose>;
+            message: z.ZodOptional<z.ZodString>;
         }, z.core.$loose>, z.ZodObject<{
             rule: z.ZodString;
             message: z.ZodOptional<z.ZodString>;
@@ -95,9 +105,18 @@ export declare const Resource: z.ZodObject<{
             disabled: z.ZodOptional<z.ZodBoolean>;
         }, z.core.$loose>>>;
         multiple: z.ZodOptional<z.ZodBoolean>;
-        resource: z.ZodOptional<z.ZodString>;
+        resource: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
         accept: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        ratios: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        rotate: z.ZodOptional<z.ZodBoolean>;
+        focalPoint: z.ZodOptional<z.ZodBoolean>;
+        transformBase: z.ZodOptional<z.ZodEnum<{
+            media: "media";
+            original: "original";
+            choose: "choose";
+        }>>;
         from: z.ZodOptional<z.ZodString>;
+        check: z.ZodOptional<z.ZodBoolean>;
         display: z.ZodOptional<z.ZodString>;
         fields: z.ZodOptional<z.ZodArray<typeof Field>>;
         types: z.ZodOptional<z.ZodArray<typeof BlockType>>;
@@ -244,6 +263,13 @@ export declare const Resource: z.ZodObject<{
                     field: z.ZodString;
                 }, z.core.$loose>]>;
                 message: z.ZodOptional<z.ZodString>;
+            }, z.core.$loose>, z.ZodObject<{
+                rule: z.ZodLiteral<"crop">;
+                value: z.ZodObject<{
+                    ratios: z.ZodOptional<z.ZodArray<z.ZodString>>;
+                    required: z.ZodOptional<z.ZodBoolean>;
+                }, z.core.$loose>;
+                message: z.ZodOptional<z.ZodString>;
             }, z.core.$loose>, z.ZodObject<{
                 rule: z.ZodString;
                 message: z.ZodOptional<z.ZodString>;
@@ -264,9 +290,18 @@ export declare const Resource: z.ZodObject<{
                 disabled: z.ZodOptional<z.ZodBoolean>;
             }, z.core.$loose>>>;
             multiple: z.ZodOptional<z.ZodBoolean>;
-            resource: z.ZodOptional<z.ZodString>;
+            resource: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
             accept: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            ratios: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            rotate: z.ZodOptional<z.ZodBoolean>;
+            focalPoint: z.ZodOptional<z.ZodBoolean>;
+            transformBase: z.ZodOptional<z.ZodEnum<{
+                media: "media";
+                original: "original";
+                choose: "choose";
+            }>>;
             from: z.ZodOptional<z.ZodString>;
+            check: z.ZodOptional<z.ZodBoolean>;
             display: z.ZodOptional<z.ZodString>;
             fields: z.ZodOptional<z.ZodArray<typeof Field>>;
             types: z.ZodOptional<z.ZodArray<typeof BlockType>>;

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

@@ -1 +1 @@
-{"version":3,"file":"resource.d.ts","sourceRoot":"","sources":["../../src/schemas/resource.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAGtC,eAAO,MAAM,gBAAgB;;;;;;;;;;;iBAmB3B,CAAC;AAEH,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAsB6C,CAAC;AAEnE,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAChE,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,QAAQ,CAAC,CAAC;AAChD,sEAAsE;AACtE,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,QAAQ,CAAC,CAAC"}
+{"version":3,"file":"resource.d.ts","sourceRoot":"","sources":["../../src/schemas/resource.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAGtC,eAAO,MAAM,gBAAgB;;;;;;;;;;;iBAmB3B,CAAC;AAEH,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAkC6C,CAAC;AAEnE,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAChE,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,QAAQ,CAAC,CAAC;AAChD,sEAAsE;AACtE,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,QAAQ,CAAC,CAAC"}

package/dist/schemas/resource.js

@@ -12,10 +12,11 @@ var ResourceFeatures = z.looseObject({
 		mode: z.enum(["component", "iframe"]),
 		component: z.string().optional().meta({ description: "`component`: the plugin preview." })
 	})]).optional(),
-	search: z.boolean().optional().meta({ description: "Whether the resource is in the global search." })
+	search: z.boolean().optional().meta({ description: "Whether the resource is in the global search. Defaults to whether its list has a search (`list.search`)." })
 });
 var Resource = z.looseObject({
 	id: z.string().min(1),
+	kind: z.string().min(1).optional().meta({ description: "What the resource is. `media`: a library of media (decision 0026), with a `file` field and a `media` on each item. Without it, an ordinary resource. Clients treat a kind they don't know as an ordinary resource." }),
 	label: z.looseObject({
 		singular: z.string(),
 		plural: z.string()
@@ -23,6 +24,8 @@ var Resource = z.looseObject({
 	description: z.string().optional(),
 	icon: z.string().optional(),
 	itemTitle: z.string().optional().meta({ description: "The field used as the title of an item, in lists and pickers." }),
+	itemSubtitle: z.string().optional().meta({ description: "The field shown under the title of an item, in search results, cards and pickers." }),
+	itemImage: z.string().optional().meta({ description: "The field that holds the image of an item (a media or a URL), in search results, cards and pickers." }),
 	fields: z.array(Field),
 	form: z.looseObject({ layout: z.array(LayoutNode).optional() }).optional(),
 	list: ListDefinition.optional(),

package/dist/schemas/resource.js.map

@@ -1 +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"}
+{"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.boolean().optional().meta({\n        description:\n            'Whether the resource is in the global search. Defaults to whether its list has a search (`list.search`).',\n    }),\n});\n\nexport const Resource = z\n    .looseObject({\n        id: z.string().min(1),\n        kind: z.string().min(1).optional().meta({\n            description:\n                \"What the resource is. `media`: a library of media (decision 0026), with a `file` field and a `media` on each item. Without it, an ordinary resource. Clients treat a kind they don't know as an ordinary resource.\",\n        }),\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        itemSubtitle: z.string().optional().meta({\n            description:\n                'The field shown under the title of an item, in search results, cards and pickers.',\n        }),\n        itemImage: z.string().optional().meta({\n            description:\n                'The field that holds the image of an item (a media or a URL), in search results, cards and pickers.',\n        }),\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,EAAE,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAChC,aACI,2GACR,CAAC;AACL,CAAC;AAED,IAAa,WAAW,EACnB,YAAY;CACT,IAAI,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC;CACpB,MAAM,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EACpC,aACI,qNACR,CAAC;CACD,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,cAAc,EAAE,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EACrC,aACI,oFACR,CAAC;CACD,WAAW,EAAE,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAClC,aACI,sGACR,CAAC;CACD,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/search.d.ts

@@ -0,0 +1,51 @@
+/** Shortest search, in characters once trimmed: shorter is a `422`. */
+export declare const SEARCH_MIN_LENGTH = 2;
+/** Longest search, in characters. */
+export declare const SEARCH_MAX_LENGTH = 255;
+/** Items per resource without a `limit`. */
+export declare const SEARCH_DEFAULT_LIMIT = 5;
+/** Highest `limit`, and most items of a response, every resource together. */
+export declare const SEARCH_MAX_LIMIT = 20;
+/** What the global search reads of a resource. */
+export interface SearchableResource {
+    id: string;
+    features?: {
+        search?: boolean | undefined;
+    } | undefined;
+    list?: {
+        search?: boolean | undefined;
+    } | undefined;
+}
+/** Query of the global search (`GET /search`). */
+export interface SearchQuery {
+    q: string;
+    /** Items per resource, from 1 to 20. Defaults to 5. */
+    limit?: number;
+    /** Ids of the searchable resources to search. Defaults to every one. */
+    resources?: readonly string[];
+}
+/**
+ * Whether a resource is in the global search: its `features.search`, or, without it, whether its
+ * list has a search (`list.search`), so one setting serves both (decision 0029).
+ */
+export declare function isSearchableResource(resource: Omit<SearchableResource, 'id'>): boolean;
+/** Serializes a search query: `q=été&limit=20&resources=pages,articles`. */
+export declare function toSearchQueryParams(query: SearchQuery): URLSearchParams;
+/** A search query as a backend reads it: valid, or the messages of its invalid parameters. */
+export type ReadSearchQueryResult = {
+    query: Required<SearchQuery>;
+    errors?: undefined;
+} | {
+    query?: undefined;
+    errors: Record<string, string[]>;
+};
+/**
+ * Reads the query string of `GET /search`: the reference of how a backend validates it. `q` is
+ * trimmed and needs 2 characters; `limit` is an integer from 1 to 20; `resources` lists searchable
+ * resources of the definition. Invalid parameters are a `422`, with `errors` keyed by parameter.
+ * Without `resources`, every searchable resource is searched, in the order of the definition.
+ */
+export declare function readSearchQuery(params: URLSearchParams, definition: {
+    resources: readonly SearchableResource[];
+}): ReadSearchQueryResult;
+//# sourceMappingURL=search.d.ts.map

package/dist/search.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../src/search.ts"],"names":[],"mappings":"AAAA,uEAAuE;AACvE,eAAO,MAAM,iBAAiB,IAAI,CAAC;AACnC,qCAAqC;AACrC,eAAO,MAAM,iBAAiB,MAAM,CAAC;AACrC,4CAA4C;AAC5C,eAAO,MAAM,oBAAoB,IAAI,CAAC;AACtC,8EAA8E;AAC9E,eAAO,MAAM,gBAAgB,KAAK,CAAC;AAEnC,kDAAkD;AAClD,MAAM,WAAW,kBAAkB;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;KAAE,GAAG,SAAS,CAAC;IACxD,IAAI,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;KAAE,GAAG,SAAS,CAAC;CACvD;AAED,kDAAkD;AAClD,MAAM,WAAW,WAAW;IACxB,CAAC,EAAE,MAAM,CAAC;IACV,uDAAuD;IACvD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,wEAAwE;IACxE,SAAS,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CACjC;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,GAAG,OAAO,CAEtF;AAED,4EAA4E;AAC5E,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,WAAW,GAAG,eAAe,CASvE;AAED,8FAA8F;AAC9F,MAAM,MAAM,qBAAqB,GAC3B;IAAE,KAAK,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC;IAAC,MAAM,CAAC,EAAE,SAAS,CAAA;CAAE,GACpD;IAAE,KAAK,CAAC,EAAE,SAAS,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;CAAE,CAAC;AAE9D;;;;;GAKG;AACH,wBAAgB,eAAe,CAC3B,MAAM,EAAE,eAAe,EACvB,UAAU,EAAE;IAAE,SAAS,EAAE,SAAS,kBAAkB,EAAE,CAAA;CAAE,GACzD,qBAAqB,CAyCvB"}

package/dist/search.js

@@ -0,0 +1,53 @@
+//#region src/search.ts
+/** Shortest search, in characters once trimmed: shorter is a `422`. */
+var SEARCH_MIN_LENGTH = 2;
+/** Longest search, in characters. */
+var SEARCH_MAX_LENGTH = 255;
+/** Items per resource without a `limit`. */
+var SEARCH_DEFAULT_LIMIT = 5;
+/** Highest `limit`, and most items of a response, every resource together. */
+var SEARCH_MAX_LIMIT = 20;
+/**
+* Whether a resource is in the global search: its `features.search`, or, without it, whether its
+* list has a search (`list.search`), so one setting serves both (decision 0029).
+*/
+function isSearchableResource(resource) {
+	return resource.features?.search ?? resource.list?.search ?? false;
+}
+/** Serializes a search query: `q=été&limit=20&resources=pages,articles`. */
+function toSearchQueryParams(query) {
+	const params = new URLSearchParams({ q: query.q });
+	if (query.limit !== void 0) params.set("limit", String(query.limit));
+	if (query.resources !== void 0 && query.resources.length > 0) params.set("resources", query.resources.join(","));
+	return params;
+}
+/**
+* Reads the query string of `GET /search`: the reference of how a backend validates it. `q` is
+* trimmed and needs 2 characters; `limit` is an integer from 1 to 20; `resources` lists searchable
+* resources of the definition. Invalid parameters are a `422`, with `errors` keyed by parameter.
+* Without `resources`, every searchable resource is searched, in the order of the definition.
+*/
+function readSearchQuery(params, definition) {
+	const errors = {};
+	const q = (params.get("q") ?? "").trim();
+	if (q.length < 2) errors.q = [`The search must have at least 2 characters.`];
+	else if (q.length > 255) errors.q = [`The search must have at most 255 characters.`];
+	const rawLimit = params.get("limit");
+	const limit = rawLimit === null ? 5 : Number(rawLimit);
+	if (rawLimit !== null && (!/^\d+$/.test(rawLimit) || limit < 1 || limit > 20)) errors.limit = [`The limit must be an integer from 1 to 20.`];
+	const searchable = definition.resources.filter(isSearchableResource).map((resource) => resource.id);
+	const rawResources = params.get("resources");
+	const asked = rawResources === null ? searchable : rawResources.split(",").map((id) => id.trim()).filter((id) => id !== "");
+	const unknown = asked.filter((id) => !searchable.includes(id));
+	if (rawResources !== null && (asked.length === 0 || unknown.length > 0)) errors.resources = [unknown.length > 0 ? `These resources are not searchable: ${unknown.join(", ")}.` : "List at least one resource."];
+	if (Object.keys(errors).length > 0) return { errors };
+	return { query: {
+		q,
+		limit,
+		resources: searchable.filter((id) => asked.includes(id))
+	} };
+}
+//#endregion
+export { SEARCH_DEFAULT_LIMIT, SEARCH_MAX_LENGTH, SEARCH_MAX_LIMIT, SEARCH_MIN_LENGTH, isSearchableResource, readSearchQuery, toSearchQueryParams };
+
+//# sourceMappingURL=search.js.map

package/dist/search.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"search.js","names":[],"sources":["../src/search.ts"],"sourcesContent":["/** Shortest search, in characters once trimmed: shorter is a `422`. */\nexport const SEARCH_MIN_LENGTH = 2;\n/** Longest search, in characters. */\nexport const SEARCH_MAX_LENGTH = 255;\n/** Items per resource without a `limit`. */\nexport const SEARCH_DEFAULT_LIMIT = 5;\n/** Highest `limit`, and most items of a response, every resource together. */\nexport const SEARCH_MAX_LIMIT = 20;\n\n/** What the global search reads of a resource. */\nexport interface SearchableResource {\n    id: string;\n    features?: { search?: boolean | undefined } | undefined;\n    list?: { search?: boolean | undefined } | undefined;\n}\n\n/** Query of the global search (`GET /search`). */\nexport interface SearchQuery {\n    q: string;\n    /** Items per resource, from 1 to 20. Defaults to 5. */\n    limit?: number;\n    /** Ids of the searchable resources to search. Defaults to every one. */\n    resources?: readonly string[];\n}\n\n/**\n * Whether a resource is in the global search: its `features.search`, or, without it, whether its\n * list has a search (`list.search`), so one setting serves both (decision 0029).\n */\nexport function isSearchableResource(resource: Omit<SearchableResource, 'id'>): boolean {\n    return resource.features?.search ?? resource.list?.search ?? false;\n}\n\n/** Serializes a search query: `q=été&limit=20&resources=pages,articles`. */\nexport function toSearchQueryParams(query: SearchQuery): URLSearchParams {\n    const params = new URLSearchParams({ q: query.q });\n    if (query.limit !== undefined) {\n        params.set('limit', String(query.limit));\n    }\n    if (query.resources !== undefined && query.resources.length > 0) {\n        params.set('resources', query.resources.join(','));\n    }\n    return params;\n}\n\n/** A search query as a backend reads it: valid, or the messages of its invalid parameters. */\nexport type ReadSearchQueryResult =\n    | { query: Required<SearchQuery>; errors?: undefined }\n    | { query?: undefined; errors: Record<string, string[]> };\n\n/**\n * Reads the query string of `GET /search`: the reference of how a backend validates it. `q` is\n * trimmed and needs 2 characters; `limit` is an integer from 1 to 20; `resources` lists searchable\n * resources of the definition. Invalid parameters are a `422`, with `errors` keyed by parameter.\n * Without `resources`, every searchable resource is searched, in the order of the definition.\n */\nexport function readSearchQuery(\n    params: URLSearchParams,\n    definition: { resources: readonly SearchableResource[] },\n): ReadSearchQueryResult {\n    const errors: Record<string, string[]> = {};\n    const q = (params.get('q') ?? '').trim();\n    if (q.length < SEARCH_MIN_LENGTH) {\n        errors.q = [`The search must have at least ${SEARCH_MIN_LENGTH} characters.`];\n    } else if (q.length > SEARCH_MAX_LENGTH) {\n        errors.q = [`The search must have at most ${SEARCH_MAX_LENGTH} characters.`];\n    }\n\n    const rawLimit = params.get('limit');\n    const limit = rawLimit === null ? SEARCH_DEFAULT_LIMIT : Number(rawLimit);\n    if (rawLimit !== null && (!/^\\d+$/.test(rawLimit) || limit < 1 || limit > SEARCH_MAX_LIMIT)) {\n        errors.limit = [`The limit must be an integer from 1 to ${SEARCH_MAX_LIMIT}.`];\n    }\n\n    const searchable = definition.resources\n        .filter(isSearchableResource)\n        .map((resource) => resource.id);\n    const rawResources = params.get('resources');\n    const asked =\n        rawResources === null\n            ? searchable\n            : rawResources\n                  .split(',')\n                  .map((id) => id.trim())\n                  .filter((id) => id !== '');\n    const unknown = asked.filter((id) => !searchable.includes(id));\n    if (rawResources !== null && (asked.length === 0 || unknown.length > 0)) {\n        errors.resources = [\n            unknown.length > 0\n                ? `These resources are not searchable: ${unknown.join(', ')}.`\n                : 'List at least one resource.',\n        ];\n    }\n\n    if (Object.keys(errors).length > 0) {\n        return { errors };\n    }\n    // The order of the definition, without duplicates\n    const resources = searchable.filter((id) => asked.includes(id));\n    return { query: { q, limit, resources } };\n}\n"],"mappings":";;AACA,IAAa,oBAAoB;;AAEjC,IAAa,oBAAoB;;AAEjC,IAAa,uBAAuB;;AAEpC,IAAa,mBAAmB;;;;;AAsBhC,SAAgB,qBAAqB,UAAmD;CACpF,OAAO,SAAS,UAAU,UAAU,SAAS,MAAM,UAAU;AACjE;;AAGA,SAAgB,oBAAoB,OAAqC;CACrE,MAAM,SAAS,IAAI,gBAAgB,EAAE,GAAG,MAAM,EAAE,CAAC;CACjD,IAAI,MAAM,UAAU,KAAA,GAChB,OAAO,IAAI,SAAS,OAAO,MAAM,KAAK,CAAC;CAE3C,IAAI,MAAM,cAAc,KAAA,KAAa,MAAM,UAAU,SAAS,GAC1D,OAAO,IAAI,aAAa,MAAM,UAAU,KAAK,GAAG,CAAC;CAErD,OAAO;AACX;;;;;;;AAaA,SAAgB,gBACZ,QACA,YACqB;CACrB,MAAM,SAAmC,CAAC;CAC1C,MAAM,KAAK,OAAO,IAAI,GAAG,KAAK,GAAA,CAAI,KAAK;CACvC,IAAI,EAAE,SAAA,GACF,OAAO,IAAI,CAAC,6CAAgE;MACzE,IAAI,EAAE,SAAA,KACT,OAAO,IAAI,CAAC,8CAA+D;CAG/E,MAAM,WAAW,OAAO,IAAI,OAAO;CACnC,MAAM,QAAQ,aAAa,OAAA,IAA8B,OAAO,QAAQ;CACxE,IAAI,aAAa,SAAS,CAAC,QAAQ,KAAK,QAAQ,KAAK,QAAQ,KAAK,QAAA,KAC9D,OAAO,QAAQ,CAAC,4CAA6D;CAGjF,MAAM,aAAa,WAAW,UACzB,OAAO,oBAAoB,CAAC,CAC5B,KAAK,aAAa,SAAS,EAAE;CAClC,MAAM,eAAe,OAAO,IAAI,WAAW;CAC3C,MAAM,QACF,iBAAiB,OACX,aACA,aACK,MAAM,GAAG,CAAC,CACV,KAAK,OAAO,GAAG,KAAK,CAAC,CAAC,CACtB,QAAQ,OAAO,OAAO,EAAE;CACvC,MAAM,UAAU,MAAM,QAAQ,OAAO,CAAC,WAAW,SAAS,EAAE,CAAC;CAC7D,IAAI,iBAAiB,SAAS,MAAM,WAAW,KAAK,QAAQ,SAAS,IACjE,OAAO,YAAY,CACf,QAAQ,SAAS,IACX,uCAAuC,QAAQ,KAAK,IAAI,EAAE,KAC1D,6BACV;CAGJ,IAAI,OAAO,KAAK,MAAM,CAAC,CAAC,SAAS,GAC7B,OAAO,EAAE,OAAO;CAIpB,OAAO,EAAE,OAAO;EAAE;EAAG;EAAO,WADV,WAAW,QAAQ,OAAO,MAAM,SAAS,EAAE,CACjC;CAAU,EAAE;AAC5C"}

package/dist/transforms.d.ts

@@ -0,0 +1,17 @@
+import type { MediaTransform } from './schemas/api';
+/** The ratio of `width:height` (`16:9` gives 1.777…), or null when it isn't one. */
+export declare function parseRatio(ratio: string): number | null;
+/**
+ * Whether a size has a ratio (decision 0031): its height is within one pixel of its width divided
+ * by the ratio, since crops are in whole pixels.
+ */
+export declare function matchesRatio(width: number, height: number, ratio: number | string): boolean;
+/**
+ * The size of the crop of a transform as it is rendered: a quarter turn swaps its width and its
+ * height. Null without a crop.
+ */
+export declare function renderedCropSize(transform: Pick<MediaTransform, 'crop' | 'rotate'>): {
+    width: number;
+    height: number;
+} | null;
+//# sourceMappingURL=transforms.d.ts.map

package/dist/transforms.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transforms.d.ts","sourceRoot":"","sources":["../src/transforms.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAGpD,oFAAoF;AACpF,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAGvD;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAG3F;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAC5B,SAAS,EAAE,IAAI,CAAC,cAAc,EAAE,MAAM,GAAG,QAAQ,CAAC,GACnD;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAQ1C"}

package/dist/transforms.js

@@ -0,0 +1,34 @@
+import { isRecord } from "./values.js";
+//#region src/transforms.ts
+/** The ratio of `width:height` (`16:9` gives 1.777…), or null when it isn't one. */
+function parseRatio(ratio) {
+	const match = /^([1-9][0-9]*):([1-9][0-9]*)$/.exec(ratio);
+	return match === null ? null : Number(match[1]) / Number(match[2]);
+}
+/**
+* Whether a size has a ratio (decision 0031): its height is within one pixel of its width divided
+* by the ratio, since crops are in whole pixels.
+*/
+function matchesRatio(width, height, ratio) {
+	const value = typeof ratio === "number" ? ratio : parseRatio(ratio);
+	return value !== null && value > 0 && Math.abs(width / value - height) <= 1;
+}
+/**
+* The size of the crop of a transform as it is rendered: a quarter turn swaps its width and its
+* height. Null without a crop.
+*/
+function renderedCropSize(transform) {
+	const crop = transform.crop;
+	if (!isRecord(crop) || typeof crop.width !== "number" || typeof crop.height !== "number") return null;
+	return transform.rotate === 90 || transform.rotate === 270 ? {
+		width: crop.height,
+		height: crop.width
+	} : {
+		width: crop.width,
+		height: crop.height
+	};
+}
+//#endregion
+export { matchesRatio, parseRatio, renderedCropSize };
+
+//# sourceMappingURL=transforms.js.map

package/dist/transforms.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transforms.js","names":[],"sources":["../src/transforms.ts"],"sourcesContent":["import type { MediaTransform } from './schemas/api';\nimport { isRecord } from './values';\n\n/** The ratio of `width:height` (`16:9` gives 1.777…), or null when it isn't one. */\nexport function parseRatio(ratio: string): number | null {\n    const match = /^([1-9][0-9]*):([1-9][0-9]*)$/.exec(ratio);\n    return match === null ? null : Number(match[1]) / Number(match[2]);\n}\n\n/**\n * Whether a size has a ratio (decision 0031): its height is within one pixel of its width divided\n * by the ratio, since crops are in whole pixels.\n */\nexport function matchesRatio(width: number, height: number, ratio: number | string): boolean {\n    const value = typeof ratio === 'number' ? ratio : parseRatio(ratio);\n    return value !== null && value > 0 && Math.abs(width / value - height) <= 1;\n}\n\n/**\n * The size of the crop of a transform as it is rendered: a quarter turn swaps its width and its\n * height. Null without a crop.\n */\nexport function renderedCropSize(\n    transform: Pick<MediaTransform, 'crop' | 'rotate'>,\n): { width: number; height: number } | null {\n    const crop = transform.crop;\n    if (!isRecord(crop) || typeof crop.width !== 'number' || typeof crop.height !== 'number') {\n        return null;\n    }\n    return transform.rotate === 90 || transform.rotate === 270\n        ? { width: crop.height, height: crop.width }\n        : { width: crop.width, height: crop.height };\n}\n"],"mappings":";;;AAIA,SAAgB,WAAW,OAA8B;CACrD,MAAM,QAAQ,gCAAgC,KAAK,KAAK;CACxD,OAAO,UAAU,OAAO,OAAO,OAAO,MAAM,EAAE,IAAI,OAAO,MAAM,EAAE;AACrE;;;;;AAMA,SAAgB,aAAa,OAAe,QAAgB,OAAiC;CACzF,MAAM,QAAQ,OAAO,UAAU,WAAW,QAAQ,WAAW,KAAK;CAClE,OAAO,UAAU,QAAQ,QAAQ,KAAK,KAAK,IAAI,QAAQ,QAAQ,MAAM,KAAK;AAC9E;;;;;AAMA,SAAgB,iBACZ,WACwC;CACxC,MAAM,OAAO,UAAU;CACvB,IAAI,CAAC,SAAS,IAAI,KAAK,OAAO,KAAK,UAAU,YAAY,OAAO,KAAK,WAAW,UAC5E,OAAO;CAEX,OAAO,UAAU,WAAW,MAAM,UAAU,WAAW,MACjD;EAAE,OAAO,KAAK;EAAQ,QAAQ,KAAK;CAAM,IACzC;EAAE,OAAO,KAAK;EAAO,QAAQ,KAAK;CAAO;AACnD"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@panneau/protocol",
-    "version": "5.0.0-alpha.3",
+    "version": "5.0.0-alpha.5",
     "description": "The Panneau protocol: definition schema, HTTP API spec and conformance kit",
     "type": "module",
     "license": "MIT",

package/schema/boot.schema.json

@@ -171,6 +171,10 @@
                     "type": "string",
                     "minLength": 1
                 },
+                "kind": {
+                    "type": "string",
+                    "minLength": 1
+                },
                 "label": {
                     "type": "object",
                     "properties": {
@@ -196,6 +200,12 @@
                 "itemTitle": {
                     "type": "string"
                 },
+                "itemSubtitle": {
+                    "type": "string"
+                },
+                "itemImage": {
+                    "type": "string"
+                },
                 "fields": {
                     "type": "array",
                     "items": {
@@ -302,7 +312,20 @@
                     "type": "boolean"
                 },
                 "resource": {
-                    "type": "string"
+                    "anyOf": [
+                        {
+                            "type": "string",
+                            "minLength": 1
+                        },
+                        {
+                            "minItems": 1,
+                            "type": "array",
+                            "items": {
+                                "type": "string",
+                                "minLength": 1
+                            }
+                        }
+                    ]
                 },
                 "accept": {
                     "type": "array",
@@ -310,9 +333,33 @@
                         "type": "string"
                     }
                 },
+                "ratios": {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "pattern": "^[1-9][0-9]*:[1-9][0-9]*$"
+                    }
+                },
+                "rotate": {
+                    "type": "boolean"
+                },
+                "focalPoint": {
+                    "type": "boolean"
+                },
+                "transformBase": {
+                    "type": "string",
+                    "enum": [
+                        "media",
+                        "original",
+                        "choose"
+                    ]
+                },
                 "from": {
                     "type": "string"
                 },
+                "check": {
+                    "type": "boolean"
+                },
                 "display": {
                     "type": "string"
                 },
@@ -538,6 +585,39 @@
                     ],
                     "additionalProperties": {}
                 },
+                {
+                    "type": "object",
+                    "properties": {
+                        "rule": {
+                            "type": "string",
+                            "const": "crop"
+                        },
+                        "value": {
+                            "type": "object",
+                            "properties": {
+                                "ratios": {
+                                    "type": "array",
+                                    "items": {
+                                        "type": "string",
+                                        "pattern": "^[1-9][0-9]*:[1-9][0-9]*$"
+                                    }
+                                },
+                                "required": {
+                                    "type": "boolean"
+                                }
+                            },
+                            "additionalProperties": {}
+                        },
+                        "message": {
+                            "type": "string"
+                        }
+                    },
+                    "required": [
+                        "rule",
+                        "value"
+                    ],
+                    "additionalProperties": {}
+                },
                 {
                     "type": "object",
                     "properties": {
@@ -1459,6 +1539,9 @@
                 },
                 "abilities": {
                     "$ref": "#/$defs/Abilities"
+                },
+                "resource": {
+                    "type": "string"
                 }
             },
             "required": [

package/schema/definition.schema.json

@@ -137,6 +137,10 @@
                     "type": "string",
                     "minLength": 1
                 },
+                "kind": {
+                    "type": "string",
+                    "minLength": 1
+                },
                 "label": {
                     "type": "object",
                     "properties": {
@@ -162,6 +166,12 @@
                 "itemTitle": {
                     "type": "string"
                 },
+                "itemSubtitle": {
+                    "type": "string"
+                },
+                "itemImage": {
+                    "type": "string"
+                },
                 "fields": {
                     "type": "array",
                     "items": {
@@ -268,7 +278,20 @@
                     "type": "boolean"
                 },
                 "resource": {
-                    "type": "string"
+                    "anyOf": [
+                        {
+                            "type": "string",
+                            "minLength": 1
+                        },
+                        {
+                            "minItems": 1,
+                            "type": "array",
+                            "items": {
+                                "type": "string",
+                                "minLength": 1
+                            }
+                        }
+                    ]
                 },
                 "accept": {
                     "type": "array",
@@ -276,9 +299,33 @@
                         "type": "string"
                     }
                 },
+                "ratios": {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "pattern": "^[1-9][0-9]*:[1-9][0-9]*$"
+                    }
+                },
+                "rotate": {
+                    "type": "boolean"
+                },
+                "focalPoint": {
+                    "type": "boolean"
+                },
+                "transformBase": {
+                    "type": "string",
+                    "enum": [
+                        "media",
+                        "original",
+                        "choose"
+                    ]
+                },
                 "from": {
                     "type": "string"
                 },
+                "check": {
+                    "type": "boolean"
+                },
                 "display": {
                     "type": "string"
                 },
@@ -504,6 +551,39 @@
                     ],
                     "additionalProperties": {}
                 },
+                {
+                    "type": "object",
+                    "properties": {
+                        "rule": {
+                            "type": "string",
+                            "const": "crop"
+                        },
+                        "value": {
+                            "type": "object",
+                            "properties": {
+                                "ratios": {
+                                    "type": "array",
+                                    "items": {
+                                        "type": "string",
+                                        "pattern": "^[1-9][0-9]*:[1-9][0-9]*$"
+                                    }
+                                },
+                                "required": {
+                                    "type": "boolean"
+                                }
+                            },
+                            "additionalProperties": {}
+                        },
+                        "message": {
+                            "type": "string"
+                        }
+                    },
+                    "required": [
+                        "rule",
+                        "value"
+                    ],
+                    "additionalProperties": {}
+                },
                 {
                     "type": "object",
                     "properties": {
@@ -1425,6 +1505,9 @@
                 },
                 "abilities": {
                     "$ref": "#/$defs/Abilities"
+                },
+                "resource": {
+                    "type": "string"
                 }
             },
             "required": [