@panneau/protocol 5.0.0-alpha.11 → 5.0.0-alpha.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/conformance/index.d.ts +6 -0
- package/dist/conformance/index.d.ts.map +1 -1
- package/dist/conformance/index.js +185 -2
- package/dist/conformance/index.js.map +1 -1
- package/dist/constants.d.ts +12 -2
- package/dist/constants.d.ts.map +1 -1
- package/dist/constants.js +22 -2
- package/dist/constants.js.map +1 -1
- package/dist/context.d.ts +15 -0
- package/dist/context.d.ts.map +1 -0
- package/dist/context.js +34 -0
- package/dist/context.js.map +1 -0
- package/dist/index.js +6 -5
- package/dist/lint.d.ts.map +1 -1
- package/dist/lint.js +17 -0
- package/dist/lint.js.map +1 -1
- package/dist/mock/index.d.ts +25 -4
- package/dist/mock/index.d.ts.map +1 -1
- package/dist/mock/index.js +129 -29
- package/dist/mock/index.js.map +1 -1
- package/dist/openapi.d.ts.map +1 -1
- package/dist/openapi.js +57 -5
- package/dist/openapi.js.map +1 -1
- package/dist/rules.d.ts +6 -0
- package/dist/rules.d.ts.map +1 -1
- package/dist/rules.js +20 -5
- package/dist/rules.js.map +1 -1
- package/dist/runtime/index.d.ts +1 -0
- package/dist/runtime/index.d.ts.map +1 -1
- package/dist/runtime/index.js +3 -2
- package/dist/schemas/action.d.ts +2 -0
- package/dist/schemas/action.d.ts.map +1 -1
- package/dist/schemas/api.d.ts +9 -0
- package/dist/schemas/api.d.ts.map +1 -1
- package/dist/schemas/api.js +5 -3
- package/dist/schemas/api.js.map +1 -1
- package/dist/schemas/definition.d.ts +67 -0
- package/dist/schemas/definition.d.ts.map +1 -1
- package/dist/schemas/definition.js +45 -2
- package/dist/schemas/definition.js.map +1 -1
- package/dist/schemas/field.d.ts +3 -0
- package/dist/schemas/field.d.ts.map +1 -1
- package/dist/schemas/field.js +6 -4
- package/dist/schemas/field.js.map +1 -1
- package/dist/schemas/index.d.ts +102 -0
- package/dist/schemas/index.d.ts.map +1 -1
- package/dist/schemas/index.js +9 -4
- package/dist/schemas/index.js.map +1 -1
- package/dist/schemas/list.d.ts +15 -0
- package/dist/schemas/list.d.ts.map +1 -1
- package/dist/schemas/list.js +13 -5
- package/dist/schemas/list.js.map +1 -1
- package/dist/schemas/resource.d.ts +11 -0
- package/dist/schemas/resource.d.ts.map +1 -1
- package/package.json +1 -1
- package/schema/boot.schema.json +136 -10
- package/schema/definition.schema.json +136 -10
- package/schema/openapi.json +523 -32
package/dist/openapi.js
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { PROBLEM_CONTENT_TYPE } from "./version.js";
|
|
2
|
+
import { CONTEXT_HEADER, CONTEXT_PROBLEM_TYPE } from "./constants.js";
|
|
2
3
|
import "./search.js";
|
|
3
4
|
import { Theme } from "./schemas/theme.js";
|
|
4
5
|
import { Definition } from "./schemas/definition.js";
|
|
@@ -16,7 +17,7 @@ var ok = (description, schema, headers) => ({
|
|
|
16
17
|
var PROBLEMS = {
|
|
17
18
|
400: "Bad request, such as a dry run of an action that does not declare `dryRun`.",
|
|
18
19
|
401: "Not authenticated.",
|
|
19
|
-
403:
|
|
20
|
+
403: `Not allowed. A value of \`${CONTEXT_HEADER}\` that the user can't use is a problem of type \`${CONTEXT_PROBLEM_TYPE}\`, with its \`param\`.`,
|
|
20
21
|
404: "Not found.",
|
|
21
22
|
409: "Conflict with a business rule.",
|
|
22
23
|
412: "Version conflict: `If-Match` does not match the current version, which is in `current`.",
|
|
@@ -120,6 +121,42 @@ function createBootConfigJsonSchema() {
|
|
|
120
121
|
})
|
|
121
122
|
};
|
|
122
123
|
}
|
|
124
|
+
/** The `Panneau-Context` header, which every operation takes (decision 0045). */
|
|
125
|
+
var contextHeader = {
|
|
126
|
+
name: CONTEXT_HEADER,
|
|
127
|
+
in: "header",
|
|
128
|
+
required: false,
|
|
129
|
+
description: "The values of the current context, when the definition has `context`: the format of a query string, in the order of its params (`client=4&contest=12`). Responses vary with it.",
|
|
130
|
+
schema: { type: "string" }
|
|
131
|
+
};
|
|
132
|
+
var METHODS = [
|
|
133
|
+
"get",
|
|
134
|
+
"post",
|
|
135
|
+
"put",
|
|
136
|
+
"patch",
|
|
137
|
+
"delete"
|
|
138
|
+
];
|
|
139
|
+
/**
|
|
140
|
+
* Adds the `Panneau-Context` header to the parameters of every path, and its `403` problem to
|
|
141
|
+
* every operation that doesn't have one: a value the user can't use is refused everywhere.
|
|
142
|
+
*/
|
|
143
|
+
function withContextHeader(paths) {
|
|
144
|
+
const parameter = { $ref: "#/components/parameters/Context" };
|
|
145
|
+
return Object.fromEntries(Object.entries(paths).map(([path, item]) => [path, {
|
|
146
|
+
...Object.fromEntries(Object.entries(item).map(([key, operation]) => {
|
|
147
|
+
if (!METHODS.includes(key)) return [key, operation];
|
|
148
|
+
const { responses = {}, ...rest } = operation;
|
|
149
|
+
return [key, {
|
|
150
|
+
...rest,
|
|
151
|
+
responses: {
|
|
152
|
+
...problems(403),
|
|
153
|
+
...responses
|
|
154
|
+
}
|
|
155
|
+
}];
|
|
156
|
+
})),
|
|
157
|
+
parameters: [...item.parameters ?? [], parameter]
|
|
158
|
+
}]));
|
|
159
|
+
}
|
|
123
160
|
/** The OpenAPI 3.1 document of the Panneau HTTP API. */
|
|
124
161
|
function createOpenApiDocument() {
|
|
125
162
|
return {
|
|
@@ -129,15 +166,27 @@ function createOpenApiDocument() {
|
|
|
129
166
|
version: String(1),
|
|
130
167
|
description: "The HTTP API between a Panneau frontend and its backend. Paths are relative to `api.baseUrl` of the definition. Authentication is up to the backend (session cookie or bearer token). Errors use `application/problem+json`."
|
|
131
168
|
},
|
|
132
|
-
paths: {
|
|
169
|
+
paths: withContextHeader({
|
|
133
170
|
"/definition": { get: {
|
|
134
171
|
operationId: "getDefinition",
|
|
135
|
-
summary: "The definition for the current user, in the current locale
|
|
172
|
+
summary: "The definition for the current user, in the current locale, and for the values of `Panneau-Context`.",
|
|
136
173
|
responses: {
|
|
137
174
|
200: ok("The definition.", ref("Definition")),
|
|
138
175
|
...problems(401, 403)
|
|
139
176
|
}
|
|
140
177
|
} },
|
|
178
|
+
"/context/{param}/options": {
|
|
179
|
+
parameters: [pathParameter("param", "The name of a param of the context.")],
|
|
180
|
+
get: {
|
|
181
|
+
operationId: "getContextOptions",
|
|
182
|
+
summary: "The choices of a param of the context without inline `options`, for the values of the params before it in `Panneau-Context`.",
|
|
183
|
+
parameters: [queryParameter("q", "Search terms.", { type: "string" })],
|
|
184
|
+
responses: {
|
|
185
|
+
200: ok("The first choices that match `q`, in the order to show them.", ref("ContextOptionsResponse")),
|
|
186
|
+
...problems(401, 403, 404)
|
|
187
|
+
}
|
|
188
|
+
}
|
|
189
|
+
},
|
|
141
190
|
"/resources/{resource}": {
|
|
142
191
|
parameters: [resource],
|
|
143
192
|
get: {
|
|
@@ -534,8 +583,11 @@ function createOpenApiDocument() {
|
|
|
534
583
|
}
|
|
535
584
|
}
|
|
536
585
|
}
|
|
537
|
-
},
|
|
538
|
-
components: {
|
|
586
|
+
}),
|
|
587
|
+
components: {
|
|
588
|
+
schemas: createComponentSchemas(),
|
|
589
|
+
parameters: { Context: contextHeader }
|
|
590
|
+
}
|
|
539
591
|
};
|
|
540
592
|
}
|
|
541
593
|
//#endregion
|
package/dist/openapi.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"openapi.js","names":[],"sources":["../src/openapi.ts"],"sourcesContent":["import { z } from 'zod';\n\nimport { createSchemaRegistry } from './schemas';\nimport { BootConfig } from './schemas/boot';\nimport { Definition } from './schemas/definition';\nimport { Theme } from './schemas/theme';\nimport {\n SEARCH_DEFAULT_LIMIT,\n SEARCH_MAX_LENGTH,\n SEARCH_MAX_LIMIT,\n SEARCH_MIN_LENGTH,\n} from './search';\nimport { PROBLEM_CONTENT_TYPE, PROTOCOL_VERSION } from './version';\n\ntype JsonObject = Record<string, unknown>;\n\nconst ref = (id: string): JsonObject => ({ $ref: `#/components/schemas/${id}` });\n\nconst json = (schema: JsonObject): JsonObject => ({ 'application/json': { schema } });\n\nconst ok = (description: string, schema?: JsonObject, headers?: JsonObject): JsonObject => ({\n description,\n ...(schema !== undefined ? { content: json(schema) } : {}),\n ...(headers !== undefined ? { headers } : {}),\n});\n\nconst PROBLEMS: Record<number, string> = {\n 400: 'Bad request, such as a dry run of an action that does not declare `dryRun`.',\n 401: 'Not authenticated.',\n 403: 'Not allowed.',\n 404: 'Not found.',\n 409: 'Conflict with a business rule.',\n 412: 'Version conflict: `If-Match` does not match the current version, which is in `current`.',\n 422: 'Invalid values: messages are in `errors`, keyed by dot path.',\n 429: 'Too many requests: `Retry-After` gives the seconds to wait.',\n};\n\nfunction problems(...statuses: number[]): JsonObject {\n return Object.fromEntries(\n statuses.map((status) => [\n String(status),\n {\n description: PROBLEMS[status],\n content: { [PROBLEM_CONTENT_TYPE]: { schema: ref('Problem') } },\n },\n ]),\n );\n}\n\nconst etag = { ETag: { description: 'The version of the item.', schema: { type: 'string' } } };\n\nconst pathParameter = (name: string, description: string): JsonObject => ({\n name,\n in: 'path',\n required: true,\n description,\n schema: { type: 'string' },\n});\n\nconst queryParameter = (name: string, description: string, schema: JsonObject): JsonObject => ({\n name,\n in: 'query',\n required: false,\n description,\n schema,\n});\n\nconst listParameters = [\n queryParameter('page', 'Page number, from 1.', { type: 'integer', minimum: 1 }),\n queryParameter('perPage', 'Items per page.', { type: 'integer', minimum: 1 }),\n queryParameter(\n 'cursor',\n 'Lists whose `pagination` is `cursor`: the `nextCursor` (or `previousCursor`) of a page, instead of `page`.',\n { type: 'string' },\n ),\n queryParameter('sort', 'Comma-separated fields; a `-` prefix sorts descending.', {\n type: 'string',\n }),\n {\n name: 'filter',\n in: 'query',\n required: false,\n style: 'deepObject',\n explode: true,\n description:\n '`filter[status]=published`; `filter[tags][]=a&filter[tags][]=b` for any of several values; `filter[published_at][from]=2026-01-01&filter[published_at][to]=2026-01-31` for the inclusive bounds of a range filter (`date-range`), without the open end.',\n schema: { type: 'object', additionalProperties: true },\n },\n queryParameter('q', 'Search.', { type: 'string' }),\n queryParameter('fields', 'Comma-separated fields to include in each item.', { type: 'string' }),\n];\n\nconst resource = pathParameter('resource', 'Resource id.');\nconst id = pathParameter('id', 'Item id.');\nconst values = { type: 'object', additionalProperties: true };\n\n/** Component schemas, generated from the protocol's Zod schemas. */\nexport function createComponentSchemas(): Record<string, JsonObject> {\n const { schemas } = z.toJSONSchema(createSchemaRegistry(), {\n io: 'input',\n uri: (schemaId) => `#/components/schemas/${schemaId}`,\n });\n return Object.fromEntries(\n Object.entries(schemas).map(([schemaId, schema]) => {\n const { $schema: _schema, $id: _id, ...rest } = schema as JsonObject;\n return [schemaId, rest];\n }),\n );\n}\n\n/** The JSON Schema of the definition (`GET /definition`). */\nexport function createDefinitionJsonSchema(): JsonObject {\n return {\n $id: 'https://github.com/folkloreinc/panneau-js/blob/v5.x/packages/protocol/schema/definition.schema.json',\n ...(z.toJSONSchema(Definition, {\n io: 'input',\n metadata: createSchemaRegistry(),\n }) as JsonObject),\n };\n}\n\n/** The JSON Schema of a theme, for themes written as JSON files. */\nexport function createThemeJsonSchema(): JsonObject {\n return {\n $id: 'https://github.com/folkloreinc/panneau-js/blob/v5.x/packages/protocol/schema/theme.schema.json',\n ...(z.toJSONSchema(Theme, {\n io: 'input',\n metadata: createSchemaRegistry(),\n }) as JsonObject),\n };\n}\n\n/** The JSON Schema of the boot config, which a server writes in the page of the app. */\nexport function createBootConfigJsonSchema(): JsonObject {\n return {\n $id: 'https://github.com/folkloreinc/panneau-js/blob/v5.x/packages/protocol/schema/boot.schema.json',\n ...(z.toJSONSchema(BootConfig, {\n io: 'input',\n metadata: createSchemaRegistry(),\n }) as JsonObject),\n };\n}\n\n/** The OpenAPI 3.1 document of the Panneau HTTP API. */\nexport function createOpenApiDocument(): JsonObject {\n return {\n openapi: '3.1.0',\n info: {\n title: 'Panneau protocol',\n version: String(PROTOCOL_VERSION),\n description:\n 'The HTTP API between a Panneau frontend and its backend. Paths are relative to `api.baseUrl` of the definition. Authentication is up to the backend (session cookie or bearer token). Errors use `application/problem+json`.',\n },\n paths: {\n '/definition': {\n get: {\n operationId: 'getDefinition',\n summary: 'The definition for the current user, in the current locale.',\n responses: {\n 200: ok('The definition.', ref('Definition')),\n ...problems(401, 403),\n },\n },\n },\n '/resources/{resource}': {\n parameters: [resource],\n get: {\n operationId: 'listItems',\n parameters: listParameters,\n responses: {\n 200: ok('A page of items.', ref('ListResponse')),\n // A `cursor` the backend can't read (decision 0039)\n ...problems(401, 403, 404, 422),\n },\n },\n post: {\n operationId: 'createItem',\n requestBody: { required: true, content: json(values) },\n responses: {\n 201: ok('The created item.', ref('ItemResponse'), etag),\n ...problems(401, 403, 404, 409, 422),\n },\n },\n },\n '/resources/{resource}/{id}': {\n parameters: [resource, id],\n get: {\n operationId: 'getItem',\n responses: {\n 200: ok('The item.', ref('ItemResponse'), etag),\n ...problems(401, 403, 404),\n },\n },\n patch: {\n operationId: 'updateItem',\n description: 'Partial update: only the values sent are changed.',\n parameters: [\n {\n name: 'If-Match',\n in: 'header',\n required: false,\n description: 'The version the client edited.',\n schema: { type: 'string' },\n },\n ],\n requestBody: { required: true, content: json(values) },\n responses: {\n 200: ok('The updated item.', ref('ItemResponse'), etag),\n ...problems(401, 403, 404, 409, 412, 422),\n },\n },\n delete: {\n operationId: 'deleteItem',\n responses: { 204: ok('Deleted.'), ...problems(401, 403, 404, 409) },\n },\n },\n '/resources/{resource}/{id}/duplicate': {\n parameters: [resource, id],\n post: {\n operationId: 'duplicateItem',\n description:\n 'Copies an item, for the built-in `duplicate` (decision 0040). Allowed on the items whose `abilities.duplicate` is `true`.',\n responses: {\n 201: ok('The copy, a new item.', ref('ItemResponse'), etag),\n ...problems(401, 403, 404),\n 409: {\n description:\n 'The copy conflicts with another item, such as a unique value.',\n content: { [PROBLEM_CONTENT_TYPE]: { schema: ref('Problem') } },\n },\n },\n },\n },\n '/resources/{resource}/{id}/preview': {\n parameters: [resource, id],\n post: {\n operationId: 'previewItem',\n requestBody: { required: true, content: json(values) },\n responses: {\n 200: ok('A short-lived preview URL.', ref('PreviewResponse')),\n ...problems(401, 403, 404, 422),\n },\n },\n },\n '/resources/{resource}/actions/{action}': {\n parameters: [resource, pathParameter('action', 'Action id.')],\n post: {\n operationId: 'runAction',\n requestBody: {\n required: true,\n content: {\n ...json(ref('ActionRequest')),\n 'multipart/form-data': { schema: ref('ActionRequest') },\n },\n },\n responses: {\n 200: ok('The result.', ref('ActionResult')),\n 202: ok('The action runs in the background.', ref('ActionRunResponse')),\n ...problems(400, 401, 403, 404, 409, 422),\n },\n },\n },\n '/resources/{resource}/fields/{field}/check': {\n parameters: [resource, pathParameter('field', 'Name of a field with `check`.')],\n post: {\n operationId: 'checkField',\n summary:\n 'Checks a value as it is typed: whether a slug is available, and its URL. With the permission to create, or to update the item `id`.',\n requestBody: { required: true, content: json(ref('FieldCheckRequest')) },\n responses: {\n 200: ok(\n 'What the backend says about the value.',\n ref('FieldCheckResponse'),\n ),\n ...problems(401, 403, 404, 422),\n },\n },\n },\n '/actions/runs': {\n get: {\n operationId: 'listActionRuns',\n summary: \"The current user's recent runs.\",\n responses: {\n 200: ok('Runs, newest first.', {\n type: 'object',\n required: ['data'],\n properties: { data: { type: 'array', items: ref('ActionRun') } },\n }),\n ...problems(401),\n },\n },\n },\n '/actions/runs/{run}': {\n parameters: [pathParameter('run', 'Run id.')],\n get: {\n operationId: 'getActionRun',\n responses: {\n 200: ok('The run.', ref('ActionRunResponse')),\n ...problems(401, 403, 404),\n },\n },\n delete: {\n operationId: 'cancelActionRun',\n responses: { 204: ok('Cancelled.'), ...problems(401, 403, 404, 409) },\n },\n },\n '/uploads/sign': {\n post: {\n operationId: 'signUpload',\n summary:\n \"Signs a request of the browser's S3 client. The first request of a file creates its upload.\",\n requestBody: { required: true, content: json(ref('UploadSignRequest')) },\n responses: {\n 200: ok('The presigned request.', ref('UploadSignResponse')),\n ...problems(401, 403, 404, 422),\n },\n },\n },\n '/uploads/{upload}/complete': {\n parameters: [pathParameter('upload', 'Upload id: `upl_…`.')],\n post: {\n operationId: 'completeUpload',\n summary:\n 'Once the browser completed the upload in storage, checks the object and gives the upload, which values reference.',\n requestBody: {\n required: false,\n content: json({\n type: 'object',\n properties: {\n name: {\n type: 'string',\n description:\n \"The file's name, which the key doesn't keep, since the backend chose it.\",\n },\n },\n }),\n },\n responses: {\n 200: ok('The upload.', ref('UploadResponse')),\n ...problems(401, 403, 404, 422),\n },\n },\n },\n '/auth/session': {\n get: {\n operationId: 'getSession',\n responses: { 200: ok('The current user.', ref('Session')), ...problems(401) },\n },\n },\n '/auth/login': {\n post: {\n operationId: 'login',\n requestBody: {\n required: true,\n content: json({\n description:\n 'An email and a password, or the single secret of `auth.token`.',\n oneOf: [\n {\n type: 'object',\n required: ['email', 'password'],\n properties: {\n email: { type: 'string' },\n password: { type: 'string' },\n remember: { type: 'boolean' },\n },\n },\n {\n type: 'object',\n required: ['token'],\n properties: {\n token: { type: 'string' },\n remember: { type: 'boolean' },\n },\n },\n ],\n }),\n },\n responses: {\n 200: ok('Logged in.', ref('Session')),\n 202: ok(\n 'A second factor is required: answer `/auth/two-factor/challenge`.',\n {\n type: 'object',\n properties: { twoFactor: { type: 'boolean', const: true } },\n },\n ),\n ...problems(422),\n },\n },\n },\n '/auth/logout': {\n post: {\n operationId: 'logout',\n description:\n '`panneau` auth mode. In `external` mode, the browser goes to `auth.logoutUrl` instead.',\n responses: { 204: ok('Logged out.') },\n },\n },\n '/auth/providers/{provider}/redirect': {\n parameters: [pathParameter('provider', 'Provider id.')],\n get: {\n operationId: 'redirectToProvider',\n parameters: [\n queryParameter('next', 'Local path to go to after login.', {\n type: 'string',\n }),\n ],\n responses: {\n 302: { description: 'Redirect to the provider.' },\n ...problems(404),\n },\n },\n },\n '/auth/password/forgot': {\n post: {\n operationId: 'forgotPassword',\n requestBody: {\n required: true,\n content: json({\n type: 'object',\n required: ['email'],\n properties: { email: { type: 'string' } },\n }),\n },\n responses: {\n 204: ok('A reset link was sent, if the account exists.'),\n ...problems(422),\n },\n },\n },\n '/auth/password/reset': {\n post: {\n operationId: 'resetPassword',\n requestBody: {\n required: true,\n content: json({\n type: 'object',\n required: ['token', 'email', 'password'],\n properties: {\n token: { type: 'string' },\n email: { type: 'string' },\n password: { type: 'string' },\n },\n }),\n },\n responses: { 204: ok('The password was reset.'), ...problems(422) },\n },\n },\n '/auth/two-factor/challenge': {\n post: {\n operationId: 'twoFactorChallenge',\n requestBody: {\n required: true,\n content: json({\n type: 'object',\n properties: {\n code: { type: 'string' },\n recoveryCode: { type: 'string' },\n },\n }),\n },\n responses: { 200: ok('Logged in.', ref('Session')), ...problems(422) },\n },\n },\n '/auth/passkeys/options': {\n post: {\n operationId: 'passkeyOptions',\n responses: {\n 200: ok('WebAuthn request options.', {\n type: 'object',\n additionalProperties: true,\n }),\n },\n },\n },\n '/auth/passkeys/login': {\n post: {\n operationId: 'passkeyLogin',\n requestBody: {\n required: true,\n content: json({ type: 'object', additionalProperties: true }),\n },\n responses: { 200: ok('Logged in.', ref('Session')), ...problems(422) },\n },\n },\n '/account': {\n get: {\n operationId: 'getAccount',\n responses: {\n 200: ok('The current user.', {\n type: 'object',\n required: ['data'],\n properties: { data: ref('User') },\n }),\n ...problems(401),\n },\n },\n patch: {\n operationId: 'updateAccount',\n requestBody: { required: true, content: json(values) },\n responses: {\n 200: ok('The updated user.', {\n type: 'object',\n required: ['data'],\n properties: { data: ref('User') },\n }),\n ...problems(401, 422),\n },\n },\n },\n '/search': {\n get: {\n operationId: 'search',\n parameters: [\n {\n ...queryParameter('q', 'Search terms, trimmed.', {\n type: 'string',\n minLength: SEARCH_MIN_LENGTH,\n maxLength: SEARCH_MAX_LENGTH,\n }),\n required: true,\n },\n queryParameter('limit', 'Items per resource.', {\n type: 'integer',\n minimum: 1,\n maximum: SEARCH_MAX_LIMIT,\n default: SEARCH_DEFAULT_LIMIT,\n }),\n queryParameter(\n 'resources',\n 'Comma-separated ids of the searchable resources to search. Defaults to every one.',\n { type: 'string' },\n ),\n ],\n responses: {\n 200: ok(\n `Results grouped by resource, in the order of the definition: at most \\`limit\\` items per resource, and ${SEARCH_MAX_LIMIT} in all.`,\n ref('SearchResponse'),\n ),\n ...problems(401, 422, 429),\n },\n },\n },\n '/embeds': {\n get: {\n operationId: 'resolveEmbed',\n parameters: [\n {\n ...queryParameter('url', 'The URL to embed.', { type: 'string' }),\n required: true,\n },\n ],\n responses: {\n 200: ok(\n \"The value of an `embed` field for the URL, from its provider's oEmbed.\",\n ref('EmbedResponse'),\n ),\n ...problems(401, 422, 429),\n },\n },\n },\n '/dashboard/widgets/{widget}': {\n parameters: [pathParameter('widget', 'Widget id.')],\n get: {\n operationId: 'getWidgetData',\n responses: {\n 200: ok(\"The widget's data. Its shape depends on the widget type.\", {\n type: 'object',\n additionalProperties: true,\n }),\n ...problems(401, 403, 404),\n },\n },\n },\n },\n components: { schemas: createComponentSchemas() },\n };\n}\n"],"mappings":";;;;;;;;AAgBA,IAAM,OAAO,QAA4B,EAAE,MAAM,wBAAwB,KAAK;AAE9E,IAAM,QAAQ,YAAoC,EAAE,oBAAoB,EAAE,OAAO,EAAE;AAEnF,IAAM,MAAM,aAAqB,QAAqB,aAAsC;CACxF;CACA,GAAI,WAAW,KAAA,IAAY,EAAE,SAAS,KAAK,MAAM,EAAE,IAAI,CAAC;CACxD,GAAI,YAAY,KAAA,IAAY,EAAE,QAAQ,IAAI,CAAC;AAC/C;AAEA,IAAM,WAAmC;CACrC,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;AACT;AAEA,SAAS,SAAS,GAAG,UAAgC;CACjD,OAAO,OAAO,YACV,SAAS,KAAK,WAAW,CACrB,OAAO,MAAM,GACb;EACI,aAAa,SAAS;EACtB,SAAS,GAAG,uBAAuB,EAAE,QAAQ,IAAI,SAAS,EAAE,EAAE;CAClE,CACJ,CAAC,CACL;AACJ;AAEA,IAAM,OAAO,EAAE,MAAM;CAAE,aAAa;CAA4B,QAAQ,EAAE,MAAM,SAAS;AAAE,EAAE;AAE7F,IAAM,iBAAiB,MAAc,iBAAqC;CACtE;CACA,IAAI;CACJ,UAAU;CACV;CACA,QAAQ,EAAE,MAAM,SAAS;AAC7B;AAEA,IAAM,kBAAkB,MAAc,aAAqB,YAAoC;CAC3F;CACA,IAAI;CACJ,UAAU;CACV;CACA;AACJ;AAEA,IAAM,iBAAiB;CACnB,eAAe,QAAQ,wBAAwB;EAAE,MAAM;EAAW,SAAS;CAAE,CAAC;CAC9E,eAAe,WAAW,mBAAmB;EAAE,MAAM;EAAW,SAAS;CAAE,CAAC;CAC5E,eACI,UACA,8GACA,EAAE,MAAM,SAAS,CACrB;CACA,eAAe,QAAQ,0DAA0D,EAC7E,MAAM,SACV,CAAC;CACD;EACI,MAAM;EACN,IAAI;EACJ,UAAU;EACV,OAAO;EACP,SAAS;EACT,aACI;EACJ,QAAQ;GAAE,MAAM;GAAU,sBAAsB;EAAK;CACzD;CACA,eAAe,KAAK,WAAW,EAAE,MAAM,SAAS,CAAC;CACjD,eAAe,UAAU,mDAAmD,EAAE,MAAM,SAAS,CAAC;AAClG;AAEA,IAAM,WAAW,cAAc,YAAY,cAAc;AACzD,IAAM,KAAK,cAAc,MAAM,UAAU;AACzC,IAAM,SAAS;CAAE,MAAM;CAAU,sBAAsB;AAAK;;AAG5D,SAAgB,yBAAqD;CACjE,MAAM,EAAE,YAAY,EAAE,aAAa,qBAAqB,GAAG;EACvD,IAAI;EACJ,MAAM,aAAa,wBAAwB;CAC/C,CAAC;CACD,OAAO,OAAO,YACV,OAAO,QAAQ,OAAO,CAAC,CAAC,KAAK,CAAC,UAAU,YAAY;EAChD,MAAM,EAAE,SAAS,SAAS,KAAK,KAAK,GAAG,SAAS;EAChD,OAAO,CAAC,UAAU,IAAI;CAC1B,CAAC,CACL;AACJ;;AAGA,SAAgB,6BAAyC;CACrD,OAAO;EACH,KAAK;EACL,GAAI,EAAE,aAAa,YAAY;GAC3B,IAAI;GACJ,UAAU,qBAAqB;EACnC,CAAC;CACL;AACJ;;AAGA,SAAgB,wBAAoC;CAChD,OAAO;EACH,KAAK;EACL,GAAI,EAAE,aAAa,OAAO;GACtB,IAAI;GACJ,UAAU,qBAAqB;EACnC,CAAC;CACL;AACJ;;AAGA,SAAgB,6BAAyC;CACrD,OAAO;EACH,KAAK;EACL,GAAI,EAAE,aAAa,YAAY;GAC3B,IAAI;GACJ,UAAU,qBAAqB;EACnC,CAAC;CACL;AACJ;;AAGA,SAAgB,wBAAoC;CAChD,OAAO;EACH,SAAS;EACT,MAAM;GACF,OAAO;GACP,SAAS,OAAA,CAAuB;GAChC,aACI;EACR;EACA,OAAO;GACH,eAAe,EACX,KAAK;IACD,aAAa;IACb,SAAS;IACT,WAAW;KACP,KAAK,GAAG,mBAAmB,IAAI,YAAY,CAAC;KAC5C,GAAG,SAAS,KAAK,GAAG;IACxB;GACJ,EACJ;GACA,yBAAyB;IACrB,YAAY,CAAC,QAAQ;IACrB,KAAK;KACD,aAAa;KACb,YAAY;KACZ,WAAW;MACP,KAAK,GAAG,oBAAoB,IAAI,cAAc,CAAC;MAE/C,GAAG,SAAS,KAAK,KAAK,KAAK,GAAG;KAClC;IACJ;IACA,MAAM;KACF,aAAa;KACb,aAAa;MAAE,UAAU;MAAM,SAAS,KAAK,MAAM;KAAE;KACrD,WAAW;MACP,KAAK,GAAG,qBAAqB,IAAI,cAAc,GAAG,IAAI;MACtD,GAAG,SAAS,KAAK,KAAK,KAAK,KAAK,GAAG;KACvC;IACJ;GACJ;GACA,8BAA8B;IAC1B,YAAY,CAAC,UAAU,EAAE;IACzB,KAAK;KACD,aAAa;KACb,WAAW;MACP,KAAK,GAAG,aAAa,IAAI,cAAc,GAAG,IAAI;MAC9C,GAAG,SAAS,KAAK,KAAK,GAAG;KAC7B;IACJ;IACA,OAAO;KACH,aAAa;KACb,aAAa;KACb,YAAY,CACR;MACI,MAAM;MACN,IAAI;MACJ,UAAU;MACV,aAAa;MACb,QAAQ,EAAE,MAAM,SAAS;KAC7B,CACJ;KACA,aAAa;MAAE,UAAU;MAAM,SAAS,KAAK,MAAM;KAAE;KACrD,WAAW;MACP,KAAK,GAAG,qBAAqB,IAAI,cAAc,GAAG,IAAI;MACtD,GAAG,SAAS,KAAK,KAAK,KAAK,KAAK,KAAK,GAAG;KAC5C;IACJ;IACA,QAAQ;KACJ,aAAa;KACb,WAAW;MAAE,KAAK,GAAG,UAAU;MAAG,GAAG,SAAS,KAAK,KAAK,KAAK,GAAG;KAAE;IACtE;GACJ;GACA,wCAAwC;IACpC,YAAY,CAAC,UAAU,EAAE;IACzB,MAAM;KACF,aAAa;KACb,aACI;KACJ,WAAW;MACP,KAAK,GAAG,yBAAyB,IAAI,cAAc,GAAG,IAAI;MAC1D,GAAG,SAAS,KAAK,KAAK,GAAG;MACzB,KAAK;OACD,aACI;OACJ,SAAS,GAAG,uBAAuB,EAAE,QAAQ,IAAI,SAAS,EAAE,EAAE;MAClE;KACJ;IACJ;GACJ;GACA,sCAAsC;IAClC,YAAY,CAAC,UAAU,EAAE;IACzB,MAAM;KACF,aAAa;KACb,aAAa;MAAE,UAAU;MAAM,SAAS,KAAK,MAAM;KAAE;KACrD,WAAW;MACP,KAAK,GAAG,8BAA8B,IAAI,iBAAiB,CAAC;MAC5D,GAAG,SAAS,KAAK,KAAK,KAAK,GAAG;KAClC;IACJ;GACJ;GACA,0CAA0C;IACtC,YAAY,CAAC,UAAU,cAAc,UAAU,YAAY,CAAC;IAC5D,MAAM;KACF,aAAa;KACb,aAAa;MACT,UAAU;MACV,SAAS;OACL,GAAG,KAAK,IAAI,eAAe,CAAC;OAC5B,uBAAuB,EAAE,QAAQ,IAAI,eAAe,EAAE;MAC1D;KACJ;KACA,WAAW;MACP,KAAK,GAAG,eAAe,IAAI,cAAc,CAAC;MAC1C,KAAK,GAAG,sCAAsC,IAAI,mBAAmB,CAAC;MACtE,GAAG,SAAS,KAAK,KAAK,KAAK,KAAK,KAAK,GAAG;KAC5C;IACJ;GACJ;GACA,8CAA8C;IAC1C,YAAY,CAAC,UAAU,cAAc,SAAS,+BAA+B,CAAC;IAC9E,MAAM;KACF,aAAa;KACb,SACI;KACJ,aAAa;MAAE,UAAU;MAAM,SAAS,KAAK,IAAI,mBAAmB,CAAC;KAAE;KACvE,WAAW;MACP,KAAK,GACD,0CACA,IAAI,oBAAoB,CAC5B;MACA,GAAG,SAAS,KAAK,KAAK,KAAK,GAAG;KAClC;IACJ;GACJ;GACA,iBAAiB,EACb,KAAK;IACD,aAAa;IACb,SAAS;IACT,WAAW;KACP,KAAK,GAAG,uBAAuB;MAC3B,MAAM;MACN,UAAU,CAAC,MAAM;MACjB,YAAY,EAAE,MAAM;OAAE,MAAM;OAAS,OAAO,IAAI,WAAW;MAAE,EAAE;KACnE,CAAC;KACD,GAAG,SAAS,GAAG;IACnB;GACJ,EACJ;GACA,uBAAuB;IACnB,YAAY,CAAC,cAAc,OAAO,SAAS,CAAC;IAC5C,KAAK;KACD,aAAa;KACb,WAAW;MACP,KAAK,GAAG,YAAY,IAAI,mBAAmB,CAAC;MAC5C,GAAG,SAAS,KAAK,KAAK,GAAG;KAC7B;IACJ;IACA,QAAQ;KACJ,aAAa;KACb,WAAW;MAAE,KAAK,GAAG,YAAY;MAAG,GAAG,SAAS,KAAK,KAAK,KAAK,GAAG;KAAE;IACxE;GACJ;GACA,iBAAiB,EACb,MAAM;IACF,aAAa;IACb,SACI;IACJ,aAAa;KAAE,UAAU;KAAM,SAAS,KAAK,IAAI,mBAAmB,CAAC;IAAE;IACvE,WAAW;KACP,KAAK,GAAG,0BAA0B,IAAI,oBAAoB,CAAC;KAC3D,GAAG,SAAS,KAAK,KAAK,KAAK,GAAG;IAClC;GACJ,EACJ;GACA,8BAA8B;IAC1B,YAAY,CAAC,cAAc,UAAU,qBAAqB,CAAC;IAC3D,MAAM;KACF,aAAa;KACb,SACI;KACJ,aAAa;MACT,UAAU;MACV,SAAS,KAAK;OACV,MAAM;OACN,YAAY,EACR,MAAM;QACF,MAAM;QACN,aACI;OACR,EACJ;MACJ,CAAC;KACL;KACA,WAAW;MACP,KAAK,GAAG,eAAe,IAAI,gBAAgB,CAAC;MAC5C,GAAG,SAAS,KAAK,KAAK,KAAK,GAAG;KAClC;IACJ;GACJ;GACA,iBAAiB,EACb,KAAK;IACD,aAAa;IACb,WAAW;KAAE,KAAK,GAAG,qBAAqB,IAAI,SAAS,CAAC;KAAG,GAAG,SAAS,GAAG;IAAE;GAChF,EACJ;GACA,eAAe,EACX,MAAM;IACF,aAAa;IACb,aAAa;KACT,UAAU;KACV,SAAS,KAAK;MACV,aACI;MACJ,OAAO,CACH;OACI,MAAM;OACN,UAAU,CAAC,SAAS,UAAU;OAC9B,YAAY;QACR,OAAO,EAAE,MAAM,SAAS;QACxB,UAAU,EAAE,MAAM,SAAS;QAC3B,UAAU,EAAE,MAAM,UAAU;OAChC;MACJ,GACA;OACI,MAAM;OACN,UAAU,CAAC,OAAO;OAClB,YAAY;QACR,OAAO,EAAE,MAAM,SAAS;QACxB,UAAU,EAAE,MAAM,UAAU;OAChC;MACJ,CACJ;KACJ,CAAC;IACL;IACA,WAAW;KACP,KAAK,GAAG,cAAc,IAAI,SAAS,CAAC;KACpC,KAAK,GACD,qEACA;MACI,MAAM;MACN,YAAY,EAAE,WAAW;OAAE,MAAM;OAAW,OAAO;MAAK,EAAE;KAC9D,CACJ;KACA,GAAG,SAAS,GAAG;IACnB;GACJ,EACJ;GACA,gBAAgB,EACZ,MAAM;IACF,aAAa;IACb,aACI;IACJ,WAAW,EAAE,KAAK,GAAG,aAAa,EAAE;GACxC,EACJ;GACA,uCAAuC;IACnC,YAAY,CAAC,cAAc,YAAY,cAAc,CAAC;IACtD,KAAK;KACD,aAAa;KACb,YAAY,CACR,eAAe,QAAQ,oCAAoC,EACvD,MAAM,SACV,CAAC,CACL;KACA,WAAW;MACP,KAAK,EAAE,aAAa,4BAA4B;MAChD,GAAG,SAAS,GAAG;KACnB;IACJ;GACJ;GACA,yBAAyB,EACrB,MAAM;IACF,aAAa;IACb,aAAa;KACT,UAAU;KACV,SAAS,KAAK;MACV,MAAM;MACN,UAAU,CAAC,OAAO;MAClB,YAAY,EAAE,OAAO,EAAE,MAAM,SAAS,EAAE;KAC5C,CAAC;IACL;IACA,WAAW;KACP,KAAK,GAAG,+CAA+C;KACvD,GAAG,SAAS,GAAG;IACnB;GACJ,EACJ;GACA,wBAAwB,EACpB,MAAM;IACF,aAAa;IACb,aAAa;KACT,UAAU;KACV,SAAS,KAAK;MACV,MAAM;MACN,UAAU;OAAC;OAAS;OAAS;MAAU;MACvC,YAAY;OACR,OAAO,EAAE,MAAM,SAAS;OACxB,OAAO,EAAE,MAAM,SAAS;OACxB,UAAU,EAAE,MAAM,SAAS;MAC/B;KACJ,CAAC;IACL;IACA,WAAW;KAAE,KAAK,GAAG,yBAAyB;KAAG,GAAG,SAAS,GAAG;IAAE;GACtE,EACJ;GACA,8BAA8B,EAC1B,MAAM;IACF,aAAa;IACb,aAAa;KACT,UAAU;KACV,SAAS,KAAK;MACV,MAAM;MACN,YAAY;OACR,MAAM,EAAE,MAAM,SAAS;OACvB,cAAc,EAAE,MAAM,SAAS;MACnC;KACJ,CAAC;IACL;IACA,WAAW;KAAE,KAAK,GAAG,cAAc,IAAI,SAAS,CAAC;KAAG,GAAG,SAAS,GAAG;IAAE;GACzE,EACJ;GACA,0BAA0B,EACtB,MAAM;IACF,aAAa;IACb,WAAW,EACP,KAAK,GAAG,6BAA6B;KACjC,MAAM;KACN,sBAAsB;IAC1B,CAAC,EACL;GACJ,EACJ;GACA,wBAAwB,EACpB,MAAM;IACF,aAAa;IACb,aAAa;KACT,UAAU;KACV,SAAS,KAAK;MAAE,MAAM;MAAU,sBAAsB;KAAK,CAAC;IAChE;IACA,WAAW;KAAE,KAAK,GAAG,cAAc,IAAI,SAAS,CAAC;KAAG,GAAG,SAAS,GAAG;IAAE;GACzE,EACJ;GACA,YAAY;IACR,KAAK;KACD,aAAa;KACb,WAAW;MACP,KAAK,GAAG,qBAAqB;OACzB,MAAM;OACN,UAAU,CAAC,MAAM;OACjB,YAAY,EAAE,MAAM,IAAI,MAAM,EAAE;MACpC,CAAC;MACD,GAAG,SAAS,GAAG;KACnB;IACJ;IACA,OAAO;KACH,aAAa;KACb,aAAa;MAAE,UAAU;MAAM,SAAS,KAAK,MAAM;KAAE;KACrD,WAAW;MACP,KAAK,GAAG,qBAAqB;OACzB,MAAM;OACN,UAAU,CAAC,MAAM;OACjB,YAAY,EAAE,MAAM,IAAI,MAAM,EAAE;MACpC,CAAC;MACD,GAAG,SAAS,KAAK,GAAG;KACxB;IACJ;GACJ;GACA,WAAW,EACP,KAAK;IACD,aAAa;IACb,YAAY;KACR;MACI,GAAG,eAAe,KAAK,0BAA0B;OAC7C,MAAM;OACN,WAAA;OACA,WAAA;MACJ,CAAC;MACD,UAAU;KACd;KACA,eAAe,SAAS,uBAAuB;MAC3C,MAAM;MACN,SAAS;MACT,SAAA;MACA,SAAA;KACJ,CAAC;KACD,eACI,aACA,qFACA,EAAE,MAAM,SAAS,CACrB;IACJ;IACA,WAAW;KACP,KAAK,GACD,qHACA,IAAI,gBAAgB,CACxB;KACA,GAAG,SAAS,KAAK,KAAK,GAAG;IAC7B;GACJ,EACJ;GACA,WAAW,EACP,KAAK;IACD,aAAa;IACb,YAAY,CACR;KACI,GAAG,eAAe,OAAO,qBAAqB,EAAE,MAAM,SAAS,CAAC;KAChE,UAAU;IACd,CACJ;IACA,WAAW;KACP,KAAK,GACD,0EACA,IAAI,eAAe,CACvB;KACA,GAAG,SAAS,KAAK,KAAK,GAAG;IAC7B;GACJ,EACJ;GACA,+BAA+B;IAC3B,YAAY,CAAC,cAAc,UAAU,YAAY,CAAC;IAClD,KAAK;KACD,aAAa;KACb,WAAW;MACP,KAAK,GAAG,4DAA4D;OAChE,MAAM;OACN,sBAAsB;MAC1B,CAAC;MACD,GAAG,SAAS,KAAK,KAAK,GAAG;KAC7B;IACJ;GACJ;EACJ;EACA,YAAY,EAAE,SAAS,uBAAuB,EAAE;CACpD;AACJ"}
|
|
1
|
+
{"version":3,"file":"openapi.js","names":[],"sources":["../src/openapi.ts"],"sourcesContent":["import { z } from 'zod';\n\nimport { CONTEXT_HEADER, CONTEXT_PROBLEM_TYPE } from './constants';\nimport { createSchemaRegistry } from './schemas';\nimport { BootConfig } from './schemas/boot';\nimport { Definition } from './schemas/definition';\nimport { Theme } from './schemas/theme';\nimport {\n SEARCH_DEFAULT_LIMIT,\n SEARCH_MAX_LENGTH,\n SEARCH_MAX_LIMIT,\n SEARCH_MIN_LENGTH,\n} from './search';\nimport { PROBLEM_CONTENT_TYPE, PROTOCOL_VERSION } from './version';\n\ntype JsonObject = Record<string, unknown>;\n\nconst ref = (id: string): JsonObject => ({ $ref: `#/components/schemas/${id}` });\n\nconst json = (schema: JsonObject): JsonObject => ({ 'application/json': { schema } });\n\nconst ok = (description: string, schema?: JsonObject, headers?: JsonObject): JsonObject => ({\n description,\n ...(schema !== undefined ? { content: json(schema) } : {}),\n ...(headers !== undefined ? { headers } : {}),\n});\n\nconst PROBLEMS: Record<number, string> = {\n 400: 'Bad request, such as a dry run of an action that does not declare `dryRun`.',\n 401: 'Not authenticated.',\n 403: `Not allowed. A value of \\`${CONTEXT_HEADER}\\` that the user can't use is a problem of type \\`${CONTEXT_PROBLEM_TYPE}\\`, with its \\`param\\`.`,\n 404: 'Not found.',\n 409: 'Conflict with a business rule.',\n 412: 'Version conflict: `If-Match` does not match the current version, which is in `current`.',\n 422: 'Invalid values: messages are in `errors`, keyed by dot path.',\n 429: 'Too many requests: `Retry-After` gives the seconds to wait.',\n};\n\nfunction problems(...statuses: number[]): JsonObject {\n return Object.fromEntries(\n statuses.map((status) => [\n String(status),\n {\n description: PROBLEMS[status],\n content: { [PROBLEM_CONTENT_TYPE]: { schema: ref('Problem') } },\n },\n ]),\n );\n}\n\nconst etag = { ETag: { description: 'The version of the item.', schema: { type: 'string' } } };\n\nconst pathParameter = (name: string, description: string): JsonObject => ({\n name,\n in: 'path',\n required: true,\n description,\n schema: { type: 'string' },\n});\n\nconst queryParameter = (name: string, description: string, schema: JsonObject): JsonObject => ({\n name,\n in: 'query',\n required: false,\n description,\n schema,\n});\n\nconst listParameters = [\n queryParameter('page', 'Page number, from 1.', { type: 'integer', minimum: 1 }),\n queryParameter('perPage', 'Items per page.', { type: 'integer', minimum: 1 }),\n queryParameter(\n 'cursor',\n 'Lists whose `pagination` is `cursor`: the `nextCursor` (or `previousCursor`) of a page, instead of `page`.',\n { type: 'string' },\n ),\n queryParameter('sort', 'Comma-separated fields; a `-` prefix sorts descending.', {\n type: 'string',\n }),\n {\n name: 'filter',\n in: 'query',\n required: false,\n style: 'deepObject',\n explode: true,\n description:\n '`filter[status]=published`; `filter[tags][]=a&filter[tags][]=b` for any of several values; `filter[published_at][from]=2026-01-01&filter[published_at][to]=2026-01-31` for the inclusive bounds of a range filter (`date-range`), without the open end.',\n schema: { type: 'object', additionalProperties: true },\n },\n queryParameter('q', 'Search.', { type: 'string' }),\n queryParameter('fields', 'Comma-separated fields to include in each item.', { type: 'string' }),\n];\n\nconst resource = pathParameter('resource', 'Resource id.');\nconst id = pathParameter('id', 'Item id.');\nconst values = { type: 'object', additionalProperties: true };\n\n/** Component schemas, generated from the protocol's Zod schemas. */\nexport function createComponentSchemas(): Record<string, JsonObject> {\n const { schemas } = z.toJSONSchema(createSchemaRegistry(), {\n io: 'input',\n uri: (schemaId) => `#/components/schemas/${schemaId}`,\n });\n return Object.fromEntries(\n Object.entries(schemas).map(([schemaId, schema]) => {\n const { $schema: _schema, $id: _id, ...rest } = schema as JsonObject;\n return [schemaId, rest];\n }),\n );\n}\n\n/** The JSON Schema of the definition (`GET /definition`). */\nexport function createDefinitionJsonSchema(): JsonObject {\n return {\n $id: 'https://github.com/folkloreinc/panneau-js/blob/v5.x/packages/protocol/schema/definition.schema.json',\n ...(z.toJSONSchema(Definition, {\n io: 'input',\n metadata: createSchemaRegistry(),\n }) as JsonObject),\n };\n}\n\n/** The JSON Schema of a theme, for themes written as JSON files. */\nexport function createThemeJsonSchema(): JsonObject {\n return {\n $id: 'https://github.com/folkloreinc/panneau-js/blob/v5.x/packages/protocol/schema/theme.schema.json',\n ...(z.toJSONSchema(Theme, {\n io: 'input',\n metadata: createSchemaRegistry(),\n }) as JsonObject),\n };\n}\n\n/** The JSON Schema of the boot config, which a server writes in the page of the app. */\nexport function createBootConfigJsonSchema(): JsonObject {\n return {\n $id: 'https://github.com/folkloreinc/panneau-js/blob/v5.x/packages/protocol/schema/boot.schema.json',\n ...(z.toJSONSchema(BootConfig, {\n io: 'input',\n metadata: createSchemaRegistry(),\n }) as JsonObject),\n };\n}\n\n/** The `Panneau-Context` header, which every operation takes (decision 0045). */\nconst contextHeader: JsonObject = {\n name: CONTEXT_HEADER,\n in: 'header',\n required: false,\n description:\n 'The values of the current context, when the definition has `context`: the format of a query string, in the order of its params (`client=4&contest=12`). Responses vary with it.',\n schema: { type: 'string' },\n};\n\nconst METHODS = ['get', 'post', 'put', 'patch', 'delete'];\n\n/**\n * Adds the `Panneau-Context` header to the parameters of every path, and its `403` problem to\n * every operation that doesn't have one: a value the user can't use is refused everywhere.\n */\nfunction withContextHeader(paths: Record<string, JsonObject>): Record<string, JsonObject> {\n const parameter = { $ref: '#/components/parameters/Context' };\n return Object.fromEntries(\n Object.entries(paths).map(([path, item]) => [\n path,\n {\n ...Object.fromEntries(\n Object.entries(item).map(([key, operation]) => {\n if (!METHODS.includes(key)) {\n return [key, operation];\n }\n const { responses = {}, ...rest } = operation as JsonObject;\n return [\n key,\n {\n ...rest,\n responses: { ...problems(403), ...(responses as JsonObject) },\n },\n ];\n }),\n ),\n parameters: [...((item.parameters as JsonObject[] | undefined) ?? []), parameter],\n },\n ]),\n );\n}\n\n/** The OpenAPI 3.1 document of the Panneau HTTP API. */\nexport function createOpenApiDocument(): JsonObject {\n return {\n openapi: '3.1.0',\n info: {\n title: 'Panneau protocol',\n version: String(PROTOCOL_VERSION),\n description:\n 'The HTTP API between a Panneau frontend and its backend. Paths are relative to `api.baseUrl` of the definition. Authentication is up to the backend (session cookie or bearer token). Errors use `application/problem+json`.',\n },\n paths: withContextHeader({\n '/definition': {\n get: {\n operationId: 'getDefinition',\n summary:\n 'The definition for the current user, in the current locale, and for the values of `Panneau-Context`.',\n responses: {\n 200: ok('The definition.', ref('Definition')),\n ...problems(401, 403),\n },\n },\n },\n '/context/{param}/options': {\n parameters: [pathParameter('param', 'The name of a param of the context.')],\n get: {\n operationId: 'getContextOptions',\n summary:\n 'The choices of a param of the context without inline `options`, for the values of the params before it in `Panneau-Context`.',\n parameters: [queryParameter('q', 'Search terms.', { type: 'string' })],\n responses: {\n 200: ok(\n 'The first choices that match `q`, in the order to show them.',\n ref('ContextOptionsResponse'),\n ),\n ...problems(401, 403, 404),\n },\n },\n },\n '/resources/{resource}': {\n parameters: [resource],\n get: {\n operationId: 'listItems',\n parameters: listParameters,\n responses: {\n 200: ok('A page of items.', ref('ListResponse')),\n // A `cursor` the backend can't read (decision 0039)\n ...problems(401, 403, 404, 422),\n },\n },\n post: {\n operationId: 'createItem',\n requestBody: { required: true, content: json(values) },\n responses: {\n 201: ok('The created item.', ref('ItemResponse'), etag),\n ...problems(401, 403, 404, 409, 422),\n },\n },\n },\n '/resources/{resource}/{id}': {\n parameters: [resource, id],\n get: {\n operationId: 'getItem',\n responses: {\n 200: ok('The item.', ref('ItemResponse'), etag),\n ...problems(401, 403, 404),\n },\n },\n patch: {\n operationId: 'updateItem',\n description: 'Partial update: only the values sent are changed.',\n parameters: [\n {\n name: 'If-Match',\n in: 'header',\n required: false,\n description: 'The version the client edited.',\n schema: { type: 'string' },\n },\n ],\n requestBody: { required: true, content: json(values) },\n responses: {\n 200: ok('The updated item.', ref('ItemResponse'), etag),\n ...problems(401, 403, 404, 409, 412, 422),\n },\n },\n delete: {\n operationId: 'deleteItem',\n responses: { 204: ok('Deleted.'), ...problems(401, 403, 404, 409) },\n },\n },\n '/resources/{resource}/{id}/duplicate': {\n parameters: [resource, id],\n post: {\n operationId: 'duplicateItem',\n description:\n 'Copies an item, for the built-in `duplicate` (decision 0040). Allowed on the items whose `abilities.duplicate` is `true`.',\n responses: {\n 201: ok('The copy, a new item.', ref('ItemResponse'), etag),\n ...problems(401, 403, 404),\n 409: {\n description:\n 'The copy conflicts with another item, such as a unique value.',\n content: { [PROBLEM_CONTENT_TYPE]: { schema: ref('Problem') } },\n },\n },\n },\n },\n '/resources/{resource}/{id}/preview': {\n parameters: [resource, id],\n post: {\n operationId: 'previewItem',\n requestBody: { required: true, content: json(values) },\n responses: {\n 200: ok('A short-lived preview URL.', ref('PreviewResponse')),\n ...problems(401, 403, 404, 422),\n },\n },\n },\n '/resources/{resource}/actions/{action}': {\n parameters: [resource, pathParameter('action', 'Action id.')],\n post: {\n operationId: 'runAction',\n requestBody: {\n required: true,\n content: {\n ...json(ref('ActionRequest')),\n 'multipart/form-data': { schema: ref('ActionRequest') },\n },\n },\n responses: {\n 200: ok('The result.', ref('ActionResult')),\n 202: ok('The action runs in the background.', ref('ActionRunResponse')),\n ...problems(400, 401, 403, 404, 409, 422),\n },\n },\n },\n '/resources/{resource}/fields/{field}/check': {\n parameters: [resource, pathParameter('field', 'Name of a field with `check`.')],\n post: {\n operationId: 'checkField',\n summary:\n 'Checks a value as it is typed: whether a slug is available, and its URL. With the permission to create, or to update the item `id`.',\n requestBody: { required: true, content: json(ref('FieldCheckRequest')) },\n responses: {\n 200: ok(\n 'What the backend says about the value.',\n ref('FieldCheckResponse'),\n ),\n ...problems(401, 403, 404, 422),\n },\n },\n },\n '/actions/runs': {\n get: {\n operationId: 'listActionRuns',\n summary: \"The current user's recent runs.\",\n responses: {\n 200: ok('Runs, newest first.', {\n type: 'object',\n required: ['data'],\n properties: { data: { type: 'array', items: ref('ActionRun') } },\n }),\n ...problems(401),\n },\n },\n },\n '/actions/runs/{run}': {\n parameters: [pathParameter('run', 'Run id.')],\n get: {\n operationId: 'getActionRun',\n responses: {\n 200: ok('The run.', ref('ActionRunResponse')),\n ...problems(401, 403, 404),\n },\n },\n delete: {\n operationId: 'cancelActionRun',\n responses: { 204: ok('Cancelled.'), ...problems(401, 403, 404, 409) },\n },\n },\n '/uploads/sign': {\n post: {\n operationId: 'signUpload',\n summary:\n \"Signs a request of the browser's S3 client. The first request of a file creates its upload.\",\n requestBody: { required: true, content: json(ref('UploadSignRequest')) },\n responses: {\n 200: ok('The presigned request.', ref('UploadSignResponse')),\n ...problems(401, 403, 404, 422),\n },\n },\n },\n '/uploads/{upload}/complete': {\n parameters: [pathParameter('upload', 'Upload id: `upl_…`.')],\n post: {\n operationId: 'completeUpload',\n summary:\n 'Once the browser completed the upload in storage, checks the object and gives the upload, which values reference.',\n requestBody: {\n required: false,\n content: json({\n type: 'object',\n properties: {\n name: {\n type: 'string',\n description:\n \"The file's name, which the key doesn't keep, since the backend chose it.\",\n },\n },\n }),\n },\n responses: {\n 200: ok('The upload.', ref('UploadResponse')),\n ...problems(401, 403, 404, 422),\n },\n },\n },\n '/auth/session': {\n get: {\n operationId: 'getSession',\n responses: { 200: ok('The current user.', ref('Session')), ...problems(401) },\n },\n },\n '/auth/login': {\n post: {\n operationId: 'login',\n requestBody: {\n required: true,\n content: json({\n description:\n 'An email and a password, or the single secret of `auth.token`.',\n oneOf: [\n {\n type: 'object',\n required: ['email', 'password'],\n properties: {\n email: { type: 'string' },\n password: { type: 'string' },\n remember: { type: 'boolean' },\n },\n },\n {\n type: 'object',\n required: ['token'],\n properties: {\n token: { type: 'string' },\n remember: { type: 'boolean' },\n },\n },\n ],\n }),\n },\n responses: {\n 200: ok('Logged in.', ref('Session')),\n 202: ok(\n 'A second factor is required: answer `/auth/two-factor/challenge`.',\n {\n type: 'object',\n properties: { twoFactor: { type: 'boolean', const: true } },\n },\n ),\n ...problems(422),\n },\n },\n },\n '/auth/logout': {\n post: {\n operationId: 'logout',\n description:\n '`panneau` auth mode. In `external` mode, the browser goes to `auth.logoutUrl` instead.',\n responses: { 204: ok('Logged out.') },\n },\n },\n '/auth/providers/{provider}/redirect': {\n parameters: [pathParameter('provider', 'Provider id.')],\n get: {\n operationId: 'redirectToProvider',\n parameters: [\n queryParameter('next', 'Local path to go to after login.', {\n type: 'string',\n }),\n ],\n responses: {\n 302: { description: 'Redirect to the provider.' },\n ...problems(404),\n },\n },\n },\n '/auth/password/forgot': {\n post: {\n operationId: 'forgotPassword',\n requestBody: {\n required: true,\n content: json({\n type: 'object',\n required: ['email'],\n properties: { email: { type: 'string' } },\n }),\n },\n responses: {\n 204: ok('A reset link was sent, if the account exists.'),\n ...problems(422),\n },\n },\n },\n '/auth/password/reset': {\n post: {\n operationId: 'resetPassword',\n requestBody: {\n required: true,\n content: json({\n type: 'object',\n required: ['token', 'email', 'password'],\n properties: {\n token: { type: 'string' },\n email: { type: 'string' },\n password: { type: 'string' },\n },\n }),\n },\n responses: { 204: ok('The password was reset.'), ...problems(422) },\n },\n },\n '/auth/two-factor/challenge': {\n post: {\n operationId: 'twoFactorChallenge',\n requestBody: {\n required: true,\n content: json({\n type: 'object',\n properties: {\n code: { type: 'string' },\n recoveryCode: { type: 'string' },\n },\n }),\n },\n responses: { 200: ok('Logged in.', ref('Session')), ...problems(422) },\n },\n },\n '/auth/passkeys/options': {\n post: {\n operationId: 'passkeyOptions',\n responses: {\n 200: ok('WebAuthn request options.', {\n type: 'object',\n additionalProperties: true,\n }),\n },\n },\n },\n '/auth/passkeys/login': {\n post: {\n operationId: 'passkeyLogin',\n requestBody: {\n required: true,\n content: json({ type: 'object', additionalProperties: true }),\n },\n responses: { 200: ok('Logged in.', ref('Session')), ...problems(422) },\n },\n },\n '/account': {\n get: {\n operationId: 'getAccount',\n responses: {\n 200: ok('The current user.', {\n type: 'object',\n required: ['data'],\n properties: { data: ref('User') },\n }),\n ...problems(401),\n },\n },\n patch: {\n operationId: 'updateAccount',\n requestBody: { required: true, content: json(values) },\n responses: {\n 200: ok('The updated user.', {\n type: 'object',\n required: ['data'],\n properties: { data: ref('User') },\n }),\n ...problems(401, 422),\n },\n },\n },\n '/search': {\n get: {\n operationId: 'search',\n parameters: [\n {\n ...queryParameter('q', 'Search terms, trimmed.', {\n type: 'string',\n minLength: SEARCH_MIN_LENGTH,\n maxLength: SEARCH_MAX_LENGTH,\n }),\n required: true,\n },\n queryParameter('limit', 'Items per resource.', {\n type: 'integer',\n minimum: 1,\n maximum: SEARCH_MAX_LIMIT,\n default: SEARCH_DEFAULT_LIMIT,\n }),\n queryParameter(\n 'resources',\n 'Comma-separated ids of the searchable resources to search. Defaults to every one.',\n { type: 'string' },\n ),\n ],\n responses: {\n 200: ok(\n `Results grouped by resource, in the order of the definition: at most \\`limit\\` items per resource, and ${SEARCH_MAX_LIMIT} in all.`,\n ref('SearchResponse'),\n ),\n ...problems(401, 422, 429),\n },\n },\n },\n '/embeds': {\n get: {\n operationId: 'resolveEmbed',\n parameters: [\n {\n ...queryParameter('url', 'The URL to embed.', { type: 'string' }),\n required: true,\n },\n ],\n responses: {\n 200: ok(\n \"The value of an `embed` field for the URL, from its provider's oEmbed.\",\n ref('EmbedResponse'),\n ),\n ...problems(401, 422, 429),\n },\n },\n },\n '/dashboard/widgets/{widget}': {\n parameters: [pathParameter('widget', 'Widget id.')],\n get: {\n operationId: 'getWidgetData',\n responses: {\n 200: ok(\"The widget's data. Its shape depends on the widget type.\", {\n type: 'object',\n additionalProperties: true,\n }),\n ...problems(401, 403, 404),\n },\n },\n },\n }),\n components: {\n schemas: createComponentSchemas(),\n parameters: { Context: contextHeader },\n },\n };\n}\n"],"mappings":";;;;;;;;;AAiBA,IAAM,OAAO,QAA4B,EAAE,MAAM,wBAAwB,KAAK;AAE9E,IAAM,QAAQ,YAAoC,EAAE,oBAAoB,EAAE,OAAO,EAAE;AAEnF,IAAM,MAAM,aAAqB,QAAqB,aAAsC;CACxF;CACA,GAAI,WAAW,KAAA,IAAY,EAAE,SAAS,KAAK,MAAM,EAAE,IAAI,CAAC;CACxD,GAAI,YAAY,KAAA,IAAY,EAAE,QAAQ,IAAI,CAAC;AAC/C;AAEA,IAAM,WAAmC;CACrC,KAAK;CACL,KAAK;CACL,KAAK,6BAA6B,eAAe,oDAAoD,qBAAqB;CAC1H,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;AACT;AAEA,SAAS,SAAS,GAAG,UAAgC;CACjD,OAAO,OAAO,YACV,SAAS,KAAK,WAAW,CACrB,OAAO,MAAM,GACb;EACI,aAAa,SAAS;EACtB,SAAS,GAAG,uBAAuB,EAAE,QAAQ,IAAI,SAAS,EAAE,EAAE;CAClE,CACJ,CAAC,CACL;AACJ;AAEA,IAAM,OAAO,EAAE,MAAM;CAAE,aAAa;CAA4B,QAAQ,EAAE,MAAM,SAAS;AAAE,EAAE;AAE7F,IAAM,iBAAiB,MAAc,iBAAqC;CACtE;CACA,IAAI;CACJ,UAAU;CACV;CACA,QAAQ,EAAE,MAAM,SAAS;AAC7B;AAEA,IAAM,kBAAkB,MAAc,aAAqB,YAAoC;CAC3F;CACA,IAAI;CACJ,UAAU;CACV;CACA;AACJ;AAEA,IAAM,iBAAiB;CACnB,eAAe,QAAQ,wBAAwB;EAAE,MAAM;EAAW,SAAS;CAAE,CAAC;CAC9E,eAAe,WAAW,mBAAmB;EAAE,MAAM;EAAW,SAAS;CAAE,CAAC;CAC5E,eACI,UACA,8GACA,EAAE,MAAM,SAAS,CACrB;CACA,eAAe,QAAQ,0DAA0D,EAC7E,MAAM,SACV,CAAC;CACD;EACI,MAAM;EACN,IAAI;EACJ,UAAU;EACV,OAAO;EACP,SAAS;EACT,aACI;EACJ,QAAQ;GAAE,MAAM;GAAU,sBAAsB;EAAK;CACzD;CACA,eAAe,KAAK,WAAW,EAAE,MAAM,SAAS,CAAC;CACjD,eAAe,UAAU,mDAAmD,EAAE,MAAM,SAAS,CAAC;AAClG;AAEA,IAAM,WAAW,cAAc,YAAY,cAAc;AACzD,IAAM,KAAK,cAAc,MAAM,UAAU;AACzC,IAAM,SAAS;CAAE,MAAM;CAAU,sBAAsB;AAAK;;AAG5D,SAAgB,yBAAqD;CACjE,MAAM,EAAE,YAAY,EAAE,aAAa,qBAAqB,GAAG;EACvD,IAAI;EACJ,MAAM,aAAa,wBAAwB;CAC/C,CAAC;CACD,OAAO,OAAO,YACV,OAAO,QAAQ,OAAO,CAAC,CAAC,KAAK,CAAC,UAAU,YAAY;EAChD,MAAM,EAAE,SAAS,SAAS,KAAK,KAAK,GAAG,SAAS;EAChD,OAAO,CAAC,UAAU,IAAI;CAC1B,CAAC,CACL;AACJ;;AAGA,SAAgB,6BAAyC;CACrD,OAAO;EACH,KAAK;EACL,GAAI,EAAE,aAAa,YAAY;GAC3B,IAAI;GACJ,UAAU,qBAAqB;EACnC,CAAC;CACL;AACJ;;AAGA,SAAgB,wBAAoC;CAChD,OAAO;EACH,KAAK;EACL,GAAI,EAAE,aAAa,OAAO;GACtB,IAAI;GACJ,UAAU,qBAAqB;EACnC,CAAC;CACL;AACJ;;AAGA,SAAgB,6BAAyC;CACrD,OAAO;EACH,KAAK;EACL,GAAI,EAAE,aAAa,YAAY;GAC3B,IAAI;GACJ,UAAU,qBAAqB;EACnC,CAAC;CACL;AACJ;;AAGA,IAAM,gBAA4B;CAC9B,MAAM;CACN,IAAI;CACJ,UAAU;CACV,aACI;CACJ,QAAQ,EAAE,MAAM,SAAS;AAC7B;AAEA,IAAM,UAAU;CAAC;CAAO;CAAQ;CAAO;CAAS;AAAQ;;;;;AAMxD,SAAS,kBAAkB,OAA+D;CACtF,MAAM,YAAY,EAAE,MAAM,kCAAkC;CAC5D,OAAO,OAAO,YACV,OAAO,QAAQ,KAAK,CAAC,CAAC,KAAK,CAAC,MAAM,UAAU,CACxC,MACA;EACI,GAAG,OAAO,YACN,OAAO,QAAQ,IAAI,CAAC,CAAC,KAAK,CAAC,KAAK,eAAe;GAC3C,IAAI,CAAC,QAAQ,SAAS,GAAG,GACrB,OAAO,CAAC,KAAK,SAAS;GAE1B,MAAM,EAAE,YAAY,CAAC,GAAG,GAAG,SAAS;GACpC,OAAO,CACH,KACA;IACI,GAAG;IACH,WAAW;KAAE,GAAG,SAAS,GAAG;KAAG,GAAI;IAAyB;GAChE,CACJ;EACJ,CAAC,CACL;EACA,YAAY,CAAC,GAAK,KAAK,cAA2C,CAAC,GAAI,SAAS;CACpF,CACJ,CAAC,CACL;AACJ;;AAGA,SAAgB,wBAAoC;CAChD,OAAO;EACH,SAAS;EACT,MAAM;GACF,OAAO;GACP,SAAS,OAAA,CAAuB;GAChC,aACI;EACR;EACA,OAAO,kBAAkB;GACrB,eAAe,EACX,KAAK;IACD,aAAa;IACb,SACI;IACJ,WAAW;KACP,KAAK,GAAG,mBAAmB,IAAI,YAAY,CAAC;KAC5C,GAAG,SAAS,KAAK,GAAG;IACxB;GACJ,EACJ;GACA,4BAA4B;IACxB,YAAY,CAAC,cAAc,SAAS,qCAAqC,CAAC;IAC1E,KAAK;KACD,aAAa;KACb,SACI;KACJ,YAAY,CAAC,eAAe,KAAK,iBAAiB,EAAE,MAAM,SAAS,CAAC,CAAC;KACrE,WAAW;MACP,KAAK,GACD,gEACA,IAAI,wBAAwB,CAChC;MACA,GAAG,SAAS,KAAK,KAAK,GAAG;KAC7B;IACJ;GACJ;GACA,yBAAyB;IACrB,YAAY,CAAC,QAAQ;IACrB,KAAK;KACD,aAAa;KACb,YAAY;KACZ,WAAW;MACP,KAAK,GAAG,oBAAoB,IAAI,cAAc,CAAC;MAE/C,GAAG,SAAS,KAAK,KAAK,KAAK,GAAG;KAClC;IACJ;IACA,MAAM;KACF,aAAa;KACb,aAAa;MAAE,UAAU;MAAM,SAAS,KAAK,MAAM;KAAE;KACrD,WAAW;MACP,KAAK,GAAG,qBAAqB,IAAI,cAAc,GAAG,IAAI;MACtD,GAAG,SAAS,KAAK,KAAK,KAAK,KAAK,GAAG;KACvC;IACJ;GACJ;GACA,8BAA8B;IAC1B,YAAY,CAAC,UAAU,EAAE;IACzB,KAAK;KACD,aAAa;KACb,WAAW;MACP,KAAK,GAAG,aAAa,IAAI,cAAc,GAAG,IAAI;MAC9C,GAAG,SAAS,KAAK,KAAK,GAAG;KAC7B;IACJ;IACA,OAAO;KACH,aAAa;KACb,aAAa;KACb,YAAY,CACR;MACI,MAAM;MACN,IAAI;MACJ,UAAU;MACV,aAAa;MACb,QAAQ,EAAE,MAAM,SAAS;KAC7B,CACJ;KACA,aAAa;MAAE,UAAU;MAAM,SAAS,KAAK,MAAM;KAAE;KACrD,WAAW;MACP,KAAK,GAAG,qBAAqB,IAAI,cAAc,GAAG,IAAI;MACtD,GAAG,SAAS,KAAK,KAAK,KAAK,KAAK,KAAK,GAAG;KAC5C;IACJ;IACA,QAAQ;KACJ,aAAa;KACb,WAAW;MAAE,KAAK,GAAG,UAAU;MAAG,GAAG,SAAS,KAAK,KAAK,KAAK,GAAG;KAAE;IACtE;GACJ;GACA,wCAAwC;IACpC,YAAY,CAAC,UAAU,EAAE;IACzB,MAAM;KACF,aAAa;KACb,aACI;KACJ,WAAW;MACP,KAAK,GAAG,yBAAyB,IAAI,cAAc,GAAG,IAAI;MAC1D,GAAG,SAAS,KAAK,KAAK,GAAG;MACzB,KAAK;OACD,aACI;OACJ,SAAS,GAAG,uBAAuB,EAAE,QAAQ,IAAI,SAAS,EAAE,EAAE;MAClE;KACJ;IACJ;GACJ;GACA,sCAAsC;IAClC,YAAY,CAAC,UAAU,EAAE;IACzB,MAAM;KACF,aAAa;KACb,aAAa;MAAE,UAAU;MAAM,SAAS,KAAK,MAAM;KAAE;KACrD,WAAW;MACP,KAAK,GAAG,8BAA8B,IAAI,iBAAiB,CAAC;MAC5D,GAAG,SAAS,KAAK,KAAK,KAAK,GAAG;KAClC;IACJ;GACJ;GACA,0CAA0C;IACtC,YAAY,CAAC,UAAU,cAAc,UAAU,YAAY,CAAC;IAC5D,MAAM;KACF,aAAa;KACb,aAAa;MACT,UAAU;MACV,SAAS;OACL,GAAG,KAAK,IAAI,eAAe,CAAC;OAC5B,uBAAuB,EAAE,QAAQ,IAAI,eAAe,EAAE;MAC1D;KACJ;KACA,WAAW;MACP,KAAK,GAAG,eAAe,IAAI,cAAc,CAAC;MAC1C,KAAK,GAAG,sCAAsC,IAAI,mBAAmB,CAAC;MACtE,GAAG,SAAS,KAAK,KAAK,KAAK,KAAK,KAAK,GAAG;KAC5C;IACJ;GACJ;GACA,8CAA8C;IAC1C,YAAY,CAAC,UAAU,cAAc,SAAS,+BAA+B,CAAC;IAC9E,MAAM;KACF,aAAa;KACb,SACI;KACJ,aAAa;MAAE,UAAU;MAAM,SAAS,KAAK,IAAI,mBAAmB,CAAC;KAAE;KACvE,WAAW;MACP,KAAK,GACD,0CACA,IAAI,oBAAoB,CAC5B;MACA,GAAG,SAAS,KAAK,KAAK,KAAK,GAAG;KAClC;IACJ;GACJ;GACA,iBAAiB,EACb,KAAK;IACD,aAAa;IACb,SAAS;IACT,WAAW;KACP,KAAK,GAAG,uBAAuB;MAC3B,MAAM;MACN,UAAU,CAAC,MAAM;MACjB,YAAY,EAAE,MAAM;OAAE,MAAM;OAAS,OAAO,IAAI,WAAW;MAAE,EAAE;KACnE,CAAC;KACD,GAAG,SAAS,GAAG;IACnB;GACJ,EACJ;GACA,uBAAuB;IACnB,YAAY,CAAC,cAAc,OAAO,SAAS,CAAC;IAC5C,KAAK;KACD,aAAa;KACb,WAAW;MACP,KAAK,GAAG,YAAY,IAAI,mBAAmB,CAAC;MAC5C,GAAG,SAAS,KAAK,KAAK,GAAG;KAC7B;IACJ;IACA,QAAQ;KACJ,aAAa;KACb,WAAW;MAAE,KAAK,GAAG,YAAY;MAAG,GAAG,SAAS,KAAK,KAAK,KAAK,GAAG;KAAE;IACxE;GACJ;GACA,iBAAiB,EACb,MAAM;IACF,aAAa;IACb,SACI;IACJ,aAAa;KAAE,UAAU;KAAM,SAAS,KAAK,IAAI,mBAAmB,CAAC;IAAE;IACvE,WAAW;KACP,KAAK,GAAG,0BAA0B,IAAI,oBAAoB,CAAC;KAC3D,GAAG,SAAS,KAAK,KAAK,KAAK,GAAG;IAClC;GACJ,EACJ;GACA,8BAA8B;IAC1B,YAAY,CAAC,cAAc,UAAU,qBAAqB,CAAC;IAC3D,MAAM;KACF,aAAa;KACb,SACI;KACJ,aAAa;MACT,UAAU;MACV,SAAS,KAAK;OACV,MAAM;OACN,YAAY,EACR,MAAM;QACF,MAAM;QACN,aACI;OACR,EACJ;MACJ,CAAC;KACL;KACA,WAAW;MACP,KAAK,GAAG,eAAe,IAAI,gBAAgB,CAAC;MAC5C,GAAG,SAAS,KAAK,KAAK,KAAK,GAAG;KAClC;IACJ;GACJ;GACA,iBAAiB,EACb,KAAK;IACD,aAAa;IACb,WAAW;KAAE,KAAK,GAAG,qBAAqB,IAAI,SAAS,CAAC;KAAG,GAAG,SAAS,GAAG;IAAE;GAChF,EACJ;GACA,eAAe,EACX,MAAM;IACF,aAAa;IACb,aAAa;KACT,UAAU;KACV,SAAS,KAAK;MACV,aACI;MACJ,OAAO,CACH;OACI,MAAM;OACN,UAAU,CAAC,SAAS,UAAU;OAC9B,YAAY;QACR,OAAO,EAAE,MAAM,SAAS;QACxB,UAAU,EAAE,MAAM,SAAS;QAC3B,UAAU,EAAE,MAAM,UAAU;OAChC;MACJ,GACA;OACI,MAAM;OACN,UAAU,CAAC,OAAO;OAClB,YAAY;QACR,OAAO,EAAE,MAAM,SAAS;QACxB,UAAU,EAAE,MAAM,UAAU;OAChC;MACJ,CACJ;KACJ,CAAC;IACL;IACA,WAAW;KACP,KAAK,GAAG,cAAc,IAAI,SAAS,CAAC;KACpC,KAAK,GACD,qEACA;MACI,MAAM;MACN,YAAY,EAAE,WAAW;OAAE,MAAM;OAAW,OAAO;MAAK,EAAE;KAC9D,CACJ;KACA,GAAG,SAAS,GAAG;IACnB;GACJ,EACJ;GACA,gBAAgB,EACZ,MAAM;IACF,aAAa;IACb,aACI;IACJ,WAAW,EAAE,KAAK,GAAG,aAAa,EAAE;GACxC,EACJ;GACA,uCAAuC;IACnC,YAAY,CAAC,cAAc,YAAY,cAAc,CAAC;IACtD,KAAK;KACD,aAAa;KACb,YAAY,CACR,eAAe,QAAQ,oCAAoC,EACvD,MAAM,SACV,CAAC,CACL;KACA,WAAW;MACP,KAAK,EAAE,aAAa,4BAA4B;MAChD,GAAG,SAAS,GAAG;KACnB;IACJ;GACJ;GACA,yBAAyB,EACrB,MAAM;IACF,aAAa;IACb,aAAa;KACT,UAAU;KACV,SAAS,KAAK;MACV,MAAM;MACN,UAAU,CAAC,OAAO;MAClB,YAAY,EAAE,OAAO,EAAE,MAAM,SAAS,EAAE;KAC5C,CAAC;IACL;IACA,WAAW;KACP,KAAK,GAAG,+CAA+C;KACvD,GAAG,SAAS,GAAG;IACnB;GACJ,EACJ;GACA,wBAAwB,EACpB,MAAM;IACF,aAAa;IACb,aAAa;KACT,UAAU;KACV,SAAS,KAAK;MACV,MAAM;MACN,UAAU;OAAC;OAAS;OAAS;MAAU;MACvC,YAAY;OACR,OAAO,EAAE,MAAM,SAAS;OACxB,OAAO,EAAE,MAAM,SAAS;OACxB,UAAU,EAAE,MAAM,SAAS;MAC/B;KACJ,CAAC;IACL;IACA,WAAW;KAAE,KAAK,GAAG,yBAAyB;KAAG,GAAG,SAAS,GAAG;IAAE;GACtE,EACJ;GACA,8BAA8B,EAC1B,MAAM;IACF,aAAa;IACb,aAAa;KACT,UAAU;KACV,SAAS,KAAK;MACV,MAAM;MACN,YAAY;OACR,MAAM,EAAE,MAAM,SAAS;OACvB,cAAc,EAAE,MAAM,SAAS;MACnC;KACJ,CAAC;IACL;IACA,WAAW;KAAE,KAAK,GAAG,cAAc,IAAI,SAAS,CAAC;KAAG,GAAG,SAAS,GAAG;IAAE;GACzE,EACJ;GACA,0BAA0B,EACtB,MAAM;IACF,aAAa;IACb,WAAW,EACP,KAAK,GAAG,6BAA6B;KACjC,MAAM;KACN,sBAAsB;IAC1B,CAAC,EACL;GACJ,EACJ;GACA,wBAAwB,EACpB,MAAM;IACF,aAAa;IACb,aAAa;KACT,UAAU;KACV,SAAS,KAAK;MAAE,MAAM;MAAU,sBAAsB;KAAK,CAAC;IAChE;IACA,WAAW;KAAE,KAAK,GAAG,cAAc,IAAI,SAAS,CAAC;KAAG,GAAG,SAAS,GAAG;IAAE;GACzE,EACJ;GACA,YAAY;IACR,KAAK;KACD,aAAa;KACb,WAAW;MACP,KAAK,GAAG,qBAAqB;OACzB,MAAM;OACN,UAAU,CAAC,MAAM;OACjB,YAAY,EAAE,MAAM,IAAI,MAAM,EAAE;MACpC,CAAC;MACD,GAAG,SAAS,GAAG;KACnB;IACJ;IACA,OAAO;KACH,aAAa;KACb,aAAa;MAAE,UAAU;MAAM,SAAS,KAAK,MAAM;KAAE;KACrD,WAAW;MACP,KAAK,GAAG,qBAAqB;OACzB,MAAM;OACN,UAAU,CAAC,MAAM;OACjB,YAAY,EAAE,MAAM,IAAI,MAAM,EAAE;MACpC,CAAC;MACD,GAAG,SAAS,KAAK,GAAG;KACxB;IACJ;GACJ;GACA,WAAW,EACP,KAAK;IACD,aAAa;IACb,YAAY;KACR;MACI,GAAG,eAAe,KAAK,0BAA0B;OAC7C,MAAM;OACN,WAAA;OACA,WAAA;MACJ,CAAC;MACD,UAAU;KACd;KACA,eAAe,SAAS,uBAAuB;MAC3C,MAAM;MACN,SAAS;MACT,SAAA;MACA,SAAA;KACJ,CAAC;KACD,eACI,aACA,qFACA,EAAE,MAAM,SAAS,CACrB;IACJ;IACA,WAAW;KACP,KAAK,GACD,qHACA,IAAI,gBAAgB,CACxB;KACA,GAAG,SAAS,KAAK,KAAK,GAAG;IAC7B;GACJ,EACJ;GACA,WAAW,EACP,KAAK;IACD,aAAa;IACb,YAAY,CACR;KACI,GAAG,eAAe,OAAO,qBAAqB,EAAE,MAAM,SAAS,CAAC;KAChE,UAAU;IACd,CACJ;IACA,WAAW;KACP,KAAK,GACD,0EACA,IAAI,eAAe,CACvB;KACA,GAAG,SAAS,KAAK,KAAK,GAAG;IAC7B;GACJ,EACJ;GACA,+BAA+B;IAC3B,YAAY,CAAC,cAAc,UAAU,YAAY,CAAC;IAClD,KAAK;KACD,aAAa;KACb,WAAW;MACP,KAAK,GAAG,4DAA4D;OAChE,MAAM;OACN,sBAAsB;MAC1B,CAAC;MACD,GAAG,SAAS,KAAK,KAAK,GAAG;KAC7B;IACJ;GACJ;EACJ,CAAC;EACD,YAAY;GACR,SAAS,uBAAuB;GAChC,YAAY,EAAE,SAAS,cAAc;EACzC;CACJ;AACJ"}
|
package/dist/rules.d.ts
CHANGED
|
@@ -17,6 +17,12 @@ export interface CheckOptions {
|
|
|
17
17
|
mode?: 'create' | 'update';
|
|
18
18
|
/** Only check the fields present in the values (partial updates). */
|
|
19
19
|
partial?: boolean;
|
|
20
|
+
/**
|
|
21
|
+
* The values of the item being updated. With `partial`, conditions (`visibleWhen`) and rules
|
|
22
|
+
* that read other fields read them for the fields that aren't in the values: a field shown
|
|
23
|
+
* when `status` is `published`, sent alone, is checked on a published item (decision 0043).
|
|
24
|
+
*/
|
|
25
|
+
item?: Record<string, unknown>;
|
|
20
26
|
}
|
|
21
27
|
/**
|
|
22
28
|
* Checks one value against a field's rules. Returns the rules that fail. Rules limited to a `mode`
|
package/dist/rules.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"rules.d.ts","sourceRoot":"","sources":["../src/rules.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAInD,2CAA2C;AAC3C,MAAM,WAAW,WAAW;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,qDAAqD;IACrD,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,2CAA2C;IAC3C,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,YAAY;IACzB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,8EAA8E;IAC9E,IAAI,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAC3B,qEAAqE;IACrE,OAAO,CAAC,EAAE,OAAO,CAAC;
|
|
1
|
+
{"version":3,"file":"rules.d.ts","sourceRoot":"","sources":["../src/rules.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAInD,2CAA2C;AAC3C,MAAM,WAAW,WAAW;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,qDAAqD;IACrD,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,2CAA2C;IAC3C,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,YAAY;IACzB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,8EAA8E;IAC9E,IAAI,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAC3B,qEAAqE;IACrE,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC;AA8FD;;;GAGG;AACH,wBAAgB,UAAU,CACtB,KAAK,EAAE,IAAI,EAAE,EACb,KAAK,EAAE,OAAO,EACd,IAAI,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,EAClC,IAAI,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC,GAC5B,WAAW,EAAE,CAmFf;AA4GD;;;;GAIG;AACH,wBAAgB,WAAW,CACvB,MAAM,EAAE,KAAK,EAAE,EACf,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,OAAO,GAAE,YAAiB,GAC3B,MAAM,CAAC,MAAM,EAAE,WAAW,EAAE,CAAC,CAQ/B"}
|
package/dist/rules.js
CHANGED
|
@@ -4,6 +4,8 @@ import { evaluateCondition } from "./conditions.js";
|
|
|
4
4
|
import { matchesRatio, renderedCropSize } from "./transforms.js";
|
|
5
5
|
//#region src/rules.ts
|
|
6
6
|
var EMAIL = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
|
|
7
|
+
/** An international phone number in E.164: `+`, then 7 to 15 digits, without a leading zero. */
|
|
8
|
+
var TEL = /^\+[1-9]\d{6,14}$/;
|
|
7
9
|
function isKnownRule(rule) {
|
|
8
10
|
return PORTABLE_RULES.includes(rule.rule);
|
|
9
11
|
}
|
|
@@ -90,6 +92,9 @@ function checkRules(rules, value, root = {}, mode) {
|
|
|
90
92
|
case "json":
|
|
91
93
|
valid = isRecord(value) || Array.isArray(value);
|
|
92
94
|
break;
|
|
95
|
+
case "tel":
|
|
96
|
+
valid = typeof value !== "string" || TEL.test(value);
|
|
97
|
+
break;
|
|
93
98
|
case "in": {
|
|
94
99
|
const allowed = rule.value;
|
|
95
100
|
valid = (Array.isArray(value) ? value : [value]).every((item) => allowed.includes(item));
|
|
@@ -120,13 +125,19 @@ function checkRules(rules, value, root = {}, mode) {
|
|
|
120
125
|
function addFailures(context, path, failures) {
|
|
121
126
|
if (failures.length > 0) context.failures[path] = [...context.failures[path] ?? [], ...failures];
|
|
122
127
|
}
|
|
128
|
+
/** The rule each type implies: its values are checked whatever rules the field lists. */
|
|
129
|
+
var IMPLIED_RULES = {
|
|
130
|
+
json: { rule: "json" },
|
|
131
|
+
tel: { rule: "tel" }
|
|
132
|
+
};
|
|
123
133
|
/**
|
|
124
|
-
* The rules of a field that apply in the mode, with
|
|
125
|
-
* type.
|
|
134
|
+
* The rules of a field that apply in the mode, with the one its type implies: `json` for the
|
|
135
|
+
* `json` type, `tel` for the `tel` type.
|
|
126
136
|
*/
|
|
127
137
|
function rulesOf(field, mode) {
|
|
128
138
|
const rules = (field.rules ?? []).filter((rule) => appliesIn(rule, mode));
|
|
129
|
-
|
|
139
|
+
const implied = IMPLIED_RULES[field.type];
|
|
140
|
+
return implied !== void 0 && !rules.some((rule) => rule.rule === implied.rule) ? [...rules, implied] : rules;
|
|
130
141
|
}
|
|
131
142
|
function checkFieldValue(field, value, path, context) {
|
|
132
143
|
const rules = rulesOf(field, context.mode);
|
|
@@ -160,7 +171,7 @@ function checkFields(fields, values, prefix, context) {
|
|
|
160
171
|
if (field.readOnly === true) return;
|
|
161
172
|
if (context.mode === "create" && field.updateOnly === true) return;
|
|
162
173
|
if (context.mode === "update" && field.createOnly === true) return;
|
|
163
|
-
if (field.visibleWhen !== void 0 && !evaluateCondition(field.visibleWhen, values)) return;
|
|
174
|
+
if (field.visibleWhen !== void 0 && !evaluateCondition(field.visibleWhen, prefix === "" ? context.root : values)) return;
|
|
164
175
|
if (context.partial === true && prefix === "" && !(field.name in values)) return;
|
|
165
176
|
checkFieldValue(field, values[field.name], `${prefix}${field.name}`, context);
|
|
166
177
|
});
|
|
@@ -171,9 +182,13 @@ function checkFields(fields, values, prefix, context) {
|
|
|
171
182
|
* Hidden and read-only fields are skipped. Rules this version doesn't know are ignored.
|
|
172
183
|
*/
|
|
173
184
|
function checkValues(fields, values, options = {}) {
|
|
185
|
+
const root = options.partial === true && options.item !== void 0 ? {
|
|
186
|
+
...options.item,
|
|
187
|
+
...values
|
|
188
|
+
} : values;
|
|
174
189
|
const context = {
|
|
175
190
|
...options,
|
|
176
|
-
root
|
|
191
|
+
root,
|
|
177
192
|
failures: {}
|
|
178
193
|
};
|
|
179
194
|
checkFields(fields, values, "", context);
|
package/dist/rules.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"rules.js","names":[],"sources":["../src/rules.ts"],"sourcesContent":["import { evaluateCondition } from './conditions';\nimport { PORTABLE_RULES } from './constants';\nimport type { Field, Rule } from './schemas/field';\nimport { matchesRatio, renderedCropSize } from './transforms';\nimport { getValue, isFilled, isRecord } from './values';\n\n/** A rule that a value doesn't satisfy. */\nexport interface RuleFailure {\n rule: string;\n /** The rule's parameter (`max: 120` gives `120`). */\n value?: unknown;\n /** The message set on the rule, if any. */\n message?: string;\n}\n\nexport interface CheckOptions {\n /**\n * Locales a `required` localized field must be filled in. Without it, one filled locale is\n * enough.\n */\n locales?: string[];\n /** `create` skips `updateOnly` fields; `update` skips `createOnly` fields. */\n mode?: 'create' | 'update';\n /** Only check the fields present in the values (partial updates). */\n partial?: boolean;\n}\n\ninterface Context extends CheckOptions {\n /** The whole form, for `visibleWhen` and date rules that reference other fields. */\n root: Record<string, unknown>;\n failures: Record<string, RuleFailure[]>;\n}\n\nconst EMAIL = /^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$/;\n\nfunction isKnownRule(rule: Rule): boolean {\n return (PORTABLE_RULES as readonly string[]).includes(rule.rule);\n}\n\n/**\n * Whether a rule applies in a mode: a rule with a `mode` applies only in that mode, and not when the\n * mode isn't known.\n */\nfunction appliesIn(rule: Rule, mode: CheckOptions['mode']): boolean {\n return rule.mode === undefined || rule.mode === mode;\n}\n\nfunction failure(rule: Rule): RuleFailure {\n const result: RuleFailure = { rule: rule.rule };\n if ('value' in rule && rule.value !== undefined) {\n result.value = rule.value;\n }\n if (rule.message !== undefined) {\n result.message = rule.message;\n }\n return result;\n}\n\nfunction sizeOf(value: unknown): number | null {\n if (typeof value === 'number') {\n return value;\n }\n if (typeof value === 'string' || Array.isArray(value)) {\n return value.length;\n }\n return null;\n}\n\nfunction matchesMime(mime: string, patterns: string[]): boolean {\n return patterns.some((pattern) => {\n if (pattern.endsWith('/*')) {\n return mime.startsWith(pattern.slice(0, -1));\n }\n return mime === pattern;\n });\n}\n\n/** The files of a value, with their MIME type and size: stored files, or chosen ones (`File`). */\nfunction mediaList(value: unknown): Record<string, unknown>[] {\n const list = Array.isArray(value) ? value : [value];\n return list\n .filter(isRecord)\n .map((media) =>\n typeof Blob !== 'undefined' && media instanceof Blob\n ? { mime: media.type === '' ? undefined : media.type, size: media.size }\n : media,\n );\n}\n\n/**\n * Whether each image of a value has the crop the `crop` rule asks for (decision 0031): a crop when\n * it is required, and one of the ratios once rendered. An id alone has no crop.\n */\nfunction hasCrop(value: unknown, rule: { ratios?: string[]; required?: boolean }): boolean {\n const entries = Array.isArray(value) ? value : [value];\n return entries.every((entry) => {\n const transform = isRecord(entry) && isRecord(entry.transform) ? entry.transform : {};\n const size = renderedCropSize(transform);\n if (size === null) {\n return rule.required !== true;\n }\n const ratios = rule.ratios ?? [];\n return (\n ratios.length === 0 ||\n ratios.some((ratio) => matchesRatio(size.width, size.height, ratio))\n );\n });\n}\n\nfunction toTime(value: unknown): number | null {\n if (typeof value !== 'string' && typeof value !== 'number') {\n return null;\n }\n const time = new Date(value).getTime();\n return Number.isNaN(time) ? null : time;\n}\n\n/**\n * Checks one value against a field's rules. Returns the rules that fail. Rules limited to a `mode`\n * only apply when it is given.\n */\nexport function checkRules(\n rules: Rule[],\n value: unknown,\n root: Record<string, unknown> = {},\n mode?: CheckOptions['mode'],\n): RuleFailure[] {\n const failures: RuleFailure[] = [];\n const filled = isFilled(value);\n const applying = rules.filter((rule) => isKnownRule(rule) && appliesIn(rule, mode));\n applying.forEach((rule) => {\n if (rule.rule === 'required') {\n if (!filled) {\n failures.push(failure(rule));\n }\n return;\n }\n if (!filled) {\n return;\n }\n let valid = true;\n switch (rule.rule) {\n case 'min':\n case 'max': {\n const size = sizeOf(value);\n const limit = rule.value as number;\n valid = size === null || (rule.rule === 'min' ? size >= limit : size <= limit);\n break;\n }\n case 'pattern':\n valid =\n typeof value !== 'string' ||\n new RegExp(rule.value as string, (rule as { flags?: string }).flags).test(\n value,\n );\n break;\n case 'email':\n valid = typeof value !== 'string' || EMAIL.test(value);\n break;\n case 'url':\n valid = typeof value !== 'string' || URL.canParse(value);\n break;\n case 'json':\n // Text that doesn't parse stays a string in the form: only objects and arrays pass\n valid = isRecord(value) || Array.isArray(value);\n break;\n case 'in': {\n const allowed = rule.value as unknown[];\n const values = Array.isArray(value) ? value : [value];\n valid = values.every((item) => allowed.includes(item));\n break;\n }\n case 'accept':\n valid = mediaList(value).every(\n (media) =>\n typeof media.mime !== 'string' ||\n matchesMime(media.mime, rule.value as string[]),\n );\n break;\n case 'maxSize':\n valid = mediaList(value).every(\n (media) =>\n typeof media.size !== 'number' || media.size <= (rule.value as number),\n );\n break;\n case 'crop':\n valid = !isRecord(rule.value) || hasCrop(value, rule.value);\n break;\n case 'before':\n case 'after': {\n const bound = rule.value as string | { field: string };\n const boundTime = toTime(\n typeof bound === 'string' ? bound : getValue(root, bound.field),\n );\n const time = toTime(value);\n if (boundTime !== null && time !== null) {\n valid = rule.rule === 'before' ? time < boundTime : time > boundTime;\n }\n break;\n }\n }\n if (!valid) {\n failures.push(failure(rule));\n }\n });\n return failures;\n}\n\nfunction addFailures(context: Context, path: string, failures: RuleFailure[]) {\n if (failures.length > 0) {\n context.failures[path] = [...(context.failures[path] ?? []), ...failures];\n }\n}\n\n/**\n * The rules of a field that apply in the mode, with those its type implies: `json` for the `json`\n * type.\n */\nfunction rulesOf(field: Field, mode: CheckOptions['mode']): Rule[] {\n const rules = (field.rules ?? []).filter((rule) => appliesIn(rule, mode));\n return field.type === 'json' && !rules.some((rule) => rule.rule === 'json')\n ? [...rules, { rule: 'json' }]\n : rules;\n}\n\nfunction checkFieldValue(field: Field, value: unknown, path: string, context: Context) {\n const rules = rulesOf(field, context.mode);\n if (field.localized === true) {\n const localized = isRecord(value) ? value : {};\n const required = rules.filter((rule) => rule.rule === 'required');\n const others = rules.filter((rule) => rule.rule !== 'required');\n if (required.length > 0) {\n const locales = context.locales;\n if (locales === undefined || locales.length === 0) {\n if (!Object.values(localized).some(isFilled)) {\n addFailures(context, path, required.map(failure));\n }\n } else {\n locales.forEach((locale) => {\n addFailures(\n context,\n `${path}.${locale}`,\n checkRules(required, localized[locale], context.root, context.mode),\n );\n });\n }\n }\n Object.entries(localized).forEach(([locale, localeValue]) => {\n addFailures(\n context,\n `${path}.${locale}`,\n checkRules(others, localeValue, context.root, context.mode),\n );\n });\n return;\n }\n\n addFailures(context, path, checkRules(rules, value, context.root, context.mode));\n\n if (field.type === 'group' && field.fields !== undefined && isRecord(value)) {\n checkFields(field.fields, value, `${path}.`, context);\n }\n if (field.type === 'repeater' && Array.isArray(value)) {\n value.forEach((item, index) => {\n if (!isRecord(item)) {\n return;\n }\n const blockFields =\n field.types !== undefined\n ? field.types.find((type) => type.id === item.type)?.fields\n : field.fields;\n if (blockFields !== undefined) {\n checkFields(blockFields, item, `${path}.${index}.`, context);\n }\n });\n }\n}\n\nfunction checkFields(\n fields: Field[],\n values: Record<string, unknown>,\n prefix: string,\n context: Context,\n) {\n fields.forEach((field) => {\n if (field.readOnly === true) {\n return;\n }\n if (context.mode === 'create' && field.updateOnly === true) {\n return;\n }\n if (context.mode === 'update' && field.createOnly === true) {\n return;\n }\n if (field.visibleWhen !== undefined && !evaluateCondition(field.visibleWhen, values)) {\n return;\n }\n if (context.partial === true && prefix === '' && !(field.name in values)) {\n return;\n }\n checkFieldValue(field, values[field.name], `${prefix}${field.name}`, context);\n });\n}\n\n/**\n * Checks form values against the portable rules of their fields. Returns the failures keyed by\n * the dot path of the value (`title.fr`, `blocks.2.image`), the same keys as validation errors.\n * Hidden and read-only fields are skipped. Rules this version doesn't know are ignored.\n */\nexport function checkValues(\n fields: Field[],\n values: Record<string, unknown>,\n options: CheckOptions = {},\n): Record<string, RuleFailure[]> {\n const context: Context = { ...options, root: values, failures: {} };\n checkFields(fields, values, '', context);\n return context.failures;\n}\n"],"mappings":";;;;;AAiCA,IAAM,QAAQ;AAEd,SAAS,YAAY,MAAqB;CACtC,OAAQ,eAAqC,SAAS,KAAK,IAAI;AACnE;;;;;AAMA,SAAS,UAAU,MAAY,MAAqC;CAChE,OAAO,KAAK,SAAS,KAAA,KAAa,KAAK,SAAS;AACpD;AAEA,SAAS,QAAQ,MAAyB;CACtC,MAAM,SAAsB,EAAE,MAAM,KAAK,KAAK;CAC9C,IAAI,WAAW,QAAQ,KAAK,UAAU,KAAA,GAClC,OAAO,QAAQ,KAAK;CAExB,IAAI,KAAK,YAAY,KAAA,GACjB,OAAO,UAAU,KAAK;CAE1B,OAAO;AACX;AAEA,SAAS,OAAO,OAA+B;CAC3C,IAAI,OAAO,UAAU,UACjB,OAAO;CAEX,IAAI,OAAO,UAAU,YAAY,MAAM,QAAQ,KAAK,GAChD,OAAO,MAAM;CAEjB,OAAO;AACX;AAEA,SAAS,YAAY,MAAc,UAA6B;CAC5D,OAAO,SAAS,MAAM,YAAY;EAC9B,IAAI,QAAQ,SAAS,IAAI,GACrB,OAAO,KAAK,WAAW,QAAQ,MAAM,GAAG,EAAE,CAAC;EAE/C,OAAO,SAAS;CACpB,CAAC;AACL;;AAGA,SAAS,UAAU,OAA2C;CAE1D,QADa,MAAM,QAAQ,KAAK,IAAI,QAAQ,CAAC,KAAK,EAAA,CAE7C,OAAO,QAAQ,CAAC,CAChB,KAAK,UACF,OAAO,SAAS,eAAe,iBAAiB,OAC1C;EAAE,MAAM,MAAM,SAAS,KAAK,KAAA,IAAY,MAAM;EAAM,MAAM,MAAM;CAAK,IACrE,KACV;AACR;;;;;AAMA,SAAS,QAAQ,OAAgB,MAA0D;CAEvF,QADgB,MAAM,QAAQ,KAAK,IAAI,QAAQ,CAAC,KAAK,EAAA,CACtC,OAAO,UAAU;EAC5B,MAAM,YAAY,SAAS,KAAK,KAAK,SAAS,MAAM,SAAS,IAAI,MAAM,YAAY,CAAC;EACpF,MAAM,OAAO,iBAAiB,SAAS;EACvC,IAAI,SAAS,MACT,OAAO,KAAK,aAAa;EAE7B,MAAM,SAAS,KAAK,UAAU,CAAC;EAC/B,OACI,OAAO,WAAW,KAClB,OAAO,MAAM,UAAU,aAAa,KAAK,OAAO,KAAK,QAAQ,KAAK,CAAC;CAE3E,CAAC;AACL;AAEA,SAAS,OAAO,OAA+B;CAC3C,IAAI,OAAO,UAAU,YAAY,OAAO,UAAU,UAC9C,OAAO;CAEX,MAAM,OAAO,IAAI,KAAK,KAAK,CAAC,CAAC,QAAQ;CACrC,OAAO,OAAO,MAAM,IAAI,IAAI,OAAO;AACvC;;;;;AAMA,SAAgB,WACZ,OACA,OACA,OAAgC,CAAC,GACjC,MACa;CACb,MAAM,WAA0B,CAAC;CACjC,MAAM,SAAS,SAAS,KAAK;CAE7B,MADuB,QAAQ,SAAS,YAAY,IAAI,KAAK,UAAU,MAAM,IAAI,CACjF,CAAA,CAAS,SAAS,SAAS;EACvB,IAAI,KAAK,SAAS,YAAY;GAC1B,IAAI,CAAC,QACD,SAAS,KAAK,QAAQ,IAAI,CAAC;GAE/B;EACJ;EACA,IAAI,CAAC,QACD;EAEJ,IAAI,QAAQ;EACZ,QAAQ,KAAK,MAAb;GACI,KAAK;GACL,KAAK,OAAO;IACR,MAAM,OAAO,OAAO,KAAK;IACzB,MAAM,QAAQ,KAAK;IACnB,QAAQ,SAAS,SAAS,KAAK,SAAS,QAAQ,QAAQ,QAAQ,QAAQ;IACxE;GACJ;GACA,KAAK;IACD,QACI,OAAO,UAAU,YACjB,IAAI,OAAO,KAAK,OAAkB,KAA4B,KAAK,CAAC,CAAC,KACjE,KACJ;IACJ;GACJ,KAAK;IACD,QAAQ,OAAO,UAAU,YAAY,MAAM,KAAK,KAAK;IACrD;GACJ,KAAK;IACD,QAAQ,OAAO,UAAU,YAAY,IAAI,SAAS,KAAK;IACvD;GACJ,KAAK;IAED,QAAQ,SAAS,KAAK,KAAK,MAAM,QAAQ,KAAK;IAC9C;GACJ,KAAK,MAAM;IACP,MAAM,UAAU,KAAK;IAErB,SADe,MAAM,QAAQ,KAAK,IAAI,QAAQ,CAAC,KAAK,EAAA,CACrC,OAAO,SAAS,QAAQ,SAAS,IAAI,CAAC;IACrD;GACJ;GACA,KAAK;IACD,QAAQ,UAAU,KAAK,CAAC,CAAC,OACpB,UACG,OAAO,MAAM,SAAS,YACtB,YAAY,MAAM,MAAM,KAAK,KAAiB,CACtD;IACA;GACJ,KAAK;IACD,QAAQ,UAAU,KAAK,CAAC,CAAC,OACpB,UACG,OAAO,MAAM,SAAS,YAAY,MAAM,QAAS,KAAK,KAC9D;IACA;GACJ,KAAK;IACD,QAAQ,CAAC,SAAS,KAAK,KAAK,KAAK,QAAQ,OAAO,KAAK,KAAK;IAC1D;GACJ,KAAK;GACL,KAAK,SAAS;IACV,MAAM,QAAQ,KAAK;IACnB,MAAM,YAAY,OACd,OAAO,UAAU,WAAW,QAAQ,SAAS,MAAM,MAAM,KAAK,CAClE;IACA,MAAM,OAAO,OAAO,KAAK;IACzB,IAAI,cAAc,QAAQ,SAAS,MAC/B,QAAQ,KAAK,SAAS,WAAW,OAAO,YAAY,OAAO;IAE/D;GACJ;EACJ;EACA,IAAI,CAAC,OACD,SAAS,KAAK,QAAQ,IAAI,CAAC;CAEnC,CAAC;CACD,OAAO;AACX;AAEA,SAAS,YAAY,SAAkB,MAAc,UAAyB;CAC1E,IAAI,SAAS,SAAS,GAClB,QAAQ,SAAS,QAAQ,CAAC,GAAI,QAAQ,SAAS,SAAS,CAAC,GAAI,GAAG,QAAQ;AAEhF;;;;;AAMA,SAAS,QAAQ,OAAc,MAAoC;CAC/D,MAAM,SAAS,MAAM,SAAS,CAAC,EAAA,CAAG,QAAQ,SAAS,UAAU,MAAM,IAAI,CAAC;CACxE,OAAO,MAAM,SAAS,UAAU,CAAC,MAAM,MAAM,SAAS,KAAK,SAAS,MAAM,IACpE,CAAC,GAAG,OAAO,EAAE,MAAM,OAAO,CAAC,IAC3B;AACV;AAEA,SAAS,gBAAgB,OAAc,OAAgB,MAAc,SAAkB;CACnF,MAAM,QAAQ,QAAQ,OAAO,QAAQ,IAAI;CACzC,IAAI,MAAM,cAAc,MAAM;EAC1B,MAAM,YAAY,SAAS,KAAK,IAAI,QAAQ,CAAC;EAC7C,MAAM,WAAW,MAAM,QAAQ,SAAS,KAAK,SAAS,UAAU;EAChE,MAAM,SAAS,MAAM,QAAQ,SAAS,KAAK,SAAS,UAAU;EAC9D,IAAI,SAAS,SAAS,GAAG;GACrB,MAAM,UAAU,QAAQ;GACxB,IAAI,YAAY,KAAA,KAAa,QAAQ,WAAW,GACxC;QAAA,CAAC,OAAO,OAAO,SAAS,CAAC,CAAC,KAAK,QAAQ,GACvC,YAAY,SAAS,MAAM,SAAS,IAAI,OAAO,CAAC;GAAA,OAGpD,QAAQ,SAAS,WAAW;IACxB,YACI,SACA,GAAG,KAAK,GAAG,UACX,WAAW,UAAU,UAAU,SAAS,QAAQ,MAAM,QAAQ,IAAI,CACtE;GACJ,CAAC;EAET;EACA,OAAO,QAAQ,SAAS,CAAC,CAAC,SAAS,CAAC,QAAQ,iBAAiB;GACzD,YACI,SACA,GAAG,KAAK,GAAG,UACX,WAAW,QAAQ,aAAa,QAAQ,MAAM,QAAQ,IAAI,CAC9D;EACJ,CAAC;EACD;CACJ;CAEA,YAAY,SAAS,MAAM,WAAW,OAAO,OAAO,QAAQ,MAAM,QAAQ,IAAI,CAAC;CAE/E,IAAI,MAAM,SAAS,WAAW,MAAM,WAAW,KAAA,KAAa,SAAS,KAAK,GACtE,YAAY,MAAM,QAAQ,OAAO,GAAG,KAAK,IAAI,OAAO;CAExD,IAAI,MAAM,SAAS,cAAc,MAAM,QAAQ,KAAK,GAChD,MAAM,SAAS,MAAM,UAAU;EAC3B,IAAI,CAAC,SAAS,IAAI,GACd;EAEJ,MAAM,cACF,MAAM,UAAU,KAAA,IACV,MAAM,MAAM,MAAM,SAAS,KAAK,OAAO,KAAK,IAAI,CAAC,EAAE,SACnD,MAAM;EAChB,IAAI,gBAAgB,KAAA,GAChB,YAAY,aAAa,MAAM,GAAG,KAAK,GAAG,MAAM,IAAI,OAAO;CAEnE,CAAC;AAET;AAEA,SAAS,YACL,QACA,QACA,QACA,SACF;CACE,OAAO,SAAS,UAAU;EACtB,IAAI,MAAM,aAAa,MACnB;EAEJ,IAAI,QAAQ,SAAS,YAAY,MAAM,eAAe,MAClD;EAEJ,IAAI,QAAQ,SAAS,YAAY,MAAM,eAAe,MAClD;EAEJ,IAAI,MAAM,gBAAgB,KAAA,KAAa,CAAC,kBAAkB,MAAM,aAAa,MAAM,GAC/E;EAEJ,IAAI,QAAQ,YAAY,QAAQ,WAAW,MAAM,EAAE,MAAM,QAAQ,SAC7D;EAEJ,gBAAgB,OAAO,OAAO,MAAM,OAAO,GAAG,SAAS,MAAM,QAAQ,OAAO;CAChF,CAAC;AACL;;;;;;AAOA,SAAgB,YACZ,QACA,QACA,UAAwB,CAAC,GACI;CAC7B,MAAM,UAAmB;EAAE,GAAG;EAAS,MAAM;EAAQ,UAAU,CAAC;CAAE;CAClE,YAAY,QAAQ,QAAQ,IAAI,OAAO;CACvC,OAAO,QAAQ;AACnB"}
|
|
1
|
+
{"version":3,"file":"rules.js","names":[],"sources":["../src/rules.ts"],"sourcesContent":["import { evaluateCondition } from './conditions';\nimport { PORTABLE_RULES } from './constants';\nimport type { Field, Rule } from './schemas/field';\nimport { matchesRatio, renderedCropSize } from './transforms';\nimport { getValue, isFilled, isRecord } from './values';\n\n/** A rule that a value doesn't satisfy. */\nexport interface RuleFailure {\n rule: string;\n /** The rule's parameter (`max: 120` gives `120`). */\n value?: unknown;\n /** The message set on the rule, if any. */\n message?: string;\n}\n\nexport interface CheckOptions {\n /**\n * Locales a `required` localized field must be filled in. Without it, one filled locale is\n * enough.\n */\n locales?: string[];\n /** `create` skips `updateOnly` fields; `update` skips `createOnly` fields. */\n mode?: 'create' | 'update';\n /** Only check the fields present in the values (partial updates). */\n partial?: boolean;\n /**\n * The values of the item being updated. With `partial`, conditions (`visibleWhen`) and rules\n * that read other fields read them for the fields that aren't in the values: a field shown\n * when `status` is `published`, sent alone, is checked on a published item (decision 0043).\n */\n item?: Record<string, unknown>;\n}\n\ninterface Context extends CheckOptions {\n /** The whole form, for `visibleWhen` and date rules that reference other fields. */\n root: Record<string, unknown>;\n failures: Record<string, RuleFailure[]>;\n}\n\nconst EMAIL = /^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$/;\n/** An international phone number in E.164: `+`, then 7 to 15 digits, without a leading zero. */\nconst TEL = /^\\+[1-9]\\d{6,14}$/;\n\nfunction isKnownRule(rule: Rule): boolean {\n return (PORTABLE_RULES as readonly string[]).includes(rule.rule);\n}\n\n/**\n * Whether a rule applies in a mode: a rule with a `mode` applies only in that mode, and not when the\n * mode isn't known.\n */\nfunction appliesIn(rule: Rule, mode: CheckOptions['mode']): boolean {\n return rule.mode === undefined || rule.mode === mode;\n}\n\nfunction failure(rule: Rule): RuleFailure {\n const result: RuleFailure = { rule: rule.rule };\n if ('value' in rule && rule.value !== undefined) {\n result.value = rule.value;\n }\n if (rule.message !== undefined) {\n result.message = rule.message;\n }\n return result;\n}\n\nfunction sizeOf(value: unknown): number | null {\n if (typeof value === 'number') {\n return value;\n }\n if (typeof value === 'string' || Array.isArray(value)) {\n return value.length;\n }\n return null;\n}\n\nfunction matchesMime(mime: string, patterns: string[]): boolean {\n return patterns.some((pattern) => {\n if (pattern.endsWith('/*')) {\n return mime.startsWith(pattern.slice(0, -1));\n }\n return mime === pattern;\n });\n}\n\n/** The files of a value, with their MIME type and size: stored files, or chosen ones (`File`). */\nfunction mediaList(value: unknown): Record<string, unknown>[] {\n const list = Array.isArray(value) ? value : [value];\n return list\n .filter(isRecord)\n .map((media) =>\n typeof Blob !== 'undefined' && media instanceof Blob\n ? { mime: media.type === '' ? undefined : media.type, size: media.size }\n : media,\n );\n}\n\n/**\n * Whether each image of a value has the crop the `crop` rule asks for (decision 0031): a crop when\n * it is required, and one of the ratios once rendered. An id alone has no crop.\n */\nfunction hasCrop(value: unknown, rule: { ratios?: string[]; required?: boolean }): boolean {\n const entries = Array.isArray(value) ? value : [value];\n return entries.every((entry) => {\n const transform = isRecord(entry) && isRecord(entry.transform) ? entry.transform : {};\n const size = renderedCropSize(transform);\n if (size === null) {\n return rule.required !== true;\n }\n const ratios = rule.ratios ?? [];\n return (\n ratios.length === 0 ||\n ratios.some((ratio) => matchesRatio(size.width, size.height, ratio))\n );\n });\n}\n\nfunction toTime(value: unknown): number | null {\n if (typeof value !== 'string' && typeof value !== 'number') {\n return null;\n }\n const time = new Date(value).getTime();\n return Number.isNaN(time) ? null : time;\n}\n\n/**\n * Checks one value against a field's rules. Returns the rules that fail. Rules limited to a `mode`\n * only apply when it is given.\n */\nexport function checkRules(\n rules: Rule[],\n value: unknown,\n root: Record<string, unknown> = {},\n mode?: CheckOptions['mode'],\n): RuleFailure[] {\n const failures: RuleFailure[] = [];\n const filled = isFilled(value);\n const applying = rules.filter((rule) => isKnownRule(rule) && appliesIn(rule, mode));\n applying.forEach((rule) => {\n if (rule.rule === 'required') {\n if (!filled) {\n failures.push(failure(rule));\n }\n return;\n }\n if (!filled) {\n return;\n }\n let valid = true;\n switch (rule.rule) {\n case 'min':\n case 'max': {\n const size = sizeOf(value);\n const limit = rule.value as number;\n valid = size === null || (rule.rule === 'min' ? size >= limit : size <= limit);\n break;\n }\n case 'pattern':\n valid =\n typeof value !== 'string' ||\n new RegExp(rule.value as string, (rule as { flags?: string }).flags).test(\n value,\n );\n break;\n case 'email':\n valid = typeof value !== 'string' || EMAIL.test(value);\n break;\n case 'url':\n valid = typeof value !== 'string' || URL.canParse(value);\n break;\n case 'json':\n // Text that doesn't parse stays a string in the form: only objects and arrays pass\n valid = isRecord(value) || Array.isArray(value);\n break;\n case 'tel':\n valid = typeof value !== 'string' || TEL.test(value);\n break;\n case 'in': {\n const allowed = rule.value as unknown[];\n const values = Array.isArray(value) ? value : [value];\n valid = values.every((item) => allowed.includes(item));\n break;\n }\n case 'accept':\n valid = mediaList(value).every(\n (media) =>\n typeof media.mime !== 'string' ||\n matchesMime(media.mime, rule.value as string[]),\n );\n break;\n case 'maxSize':\n valid = mediaList(value).every(\n (media) =>\n typeof media.size !== 'number' || media.size <= (rule.value as number),\n );\n break;\n case 'crop':\n valid = !isRecord(rule.value) || hasCrop(value, rule.value);\n break;\n case 'before':\n case 'after': {\n const bound = rule.value as string | { field: string };\n const boundTime = toTime(\n typeof bound === 'string' ? bound : getValue(root, bound.field),\n );\n const time = toTime(value);\n if (boundTime !== null && time !== null) {\n valid = rule.rule === 'before' ? time < boundTime : time > boundTime;\n }\n break;\n }\n }\n if (!valid) {\n failures.push(failure(rule));\n }\n });\n return failures;\n}\n\nfunction addFailures(context: Context, path: string, failures: RuleFailure[]) {\n if (failures.length > 0) {\n context.failures[path] = [...(context.failures[path] ?? []), ...failures];\n }\n}\n\n/** The rule each type implies: its values are checked whatever rules the field lists. */\nconst IMPLIED_RULES: Readonly<Record<string, Rule>> = {\n json: { rule: 'json' },\n tel: { rule: 'tel' },\n};\n\n/**\n * The rules of a field that apply in the mode, with the one its type implies: `json` for the\n * `json` type, `tel` for the `tel` type.\n */\nfunction rulesOf(field: Field, mode: CheckOptions['mode']): Rule[] {\n const rules = (field.rules ?? []).filter((rule) => appliesIn(rule, mode));\n const implied = IMPLIED_RULES[field.type];\n return implied !== undefined && !rules.some((rule) => rule.rule === implied.rule)\n ? [...rules, implied]\n : rules;\n}\n\nfunction checkFieldValue(field: Field, value: unknown, path: string, context: Context) {\n const rules = rulesOf(field, context.mode);\n if (field.localized === true) {\n const localized = isRecord(value) ? value : {};\n const required = rules.filter((rule) => rule.rule === 'required');\n const others = rules.filter((rule) => rule.rule !== 'required');\n if (required.length > 0) {\n const locales = context.locales;\n if (locales === undefined || locales.length === 0) {\n if (!Object.values(localized).some(isFilled)) {\n addFailures(context, path, required.map(failure));\n }\n } else {\n locales.forEach((locale) => {\n addFailures(\n context,\n `${path}.${locale}`,\n checkRules(required, localized[locale], context.root, context.mode),\n );\n });\n }\n }\n Object.entries(localized).forEach(([locale, localeValue]) => {\n addFailures(\n context,\n `${path}.${locale}`,\n checkRules(others, localeValue, context.root, context.mode),\n );\n });\n return;\n }\n\n addFailures(context, path, checkRules(rules, value, context.root, context.mode));\n\n if (field.type === 'group' && field.fields !== undefined && isRecord(value)) {\n checkFields(field.fields, value, `${path}.`, context);\n }\n if (field.type === 'repeater' && Array.isArray(value)) {\n value.forEach((item, index) => {\n if (!isRecord(item)) {\n return;\n }\n const blockFields =\n field.types !== undefined\n ? field.types.find((type) => type.id === item.type)?.fields\n : field.fields;\n if (blockFields !== undefined) {\n checkFields(blockFields, item, `${path}.${index}.`, context);\n }\n });\n }\n}\n\nfunction checkFields(\n fields: Field[],\n values: Record<string, unknown>,\n prefix: string,\n context: Context,\n) {\n fields.forEach((field) => {\n if (field.readOnly === true) {\n return;\n }\n if (context.mode === 'create' && field.updateOnly === true) {\n return;\n }\n if (context.mode === 'update' && field.createOnly === true) {\n return;\n }\n if (\n field.visibleWhen !== undefined &&\n !evaluateCondition(field.visibleWhen, prefix === '' ? context.root : values)\n ) {\n return;\n }\n if (context.partial === true && prefix === '' && !(field.name in values)) {\n return;\n }\n checkFieldValue(field, values[field.name], `${prefix}${field.name}`, context);\n });\n}\n\n/**\n * Checks form values against the portable rules of their fields. Returns the failures keyed by\n * the dot path of the value (`title.fr`, `blocks.2.image`), the same keys as validation errors.\n * Hidden and read-only fields are skipped. Rules this version doesn't know are ignored.\n */\nexport function checkValues(\n fields: Field[],\n values: Record<string, unknown>,\n options: CheckOptions = {},\n): Record<string, RuleFailure[]> {\n const root =\n options.partial === true && options.item !== undefined\n ? { ...options.item, ...values }\n : values;\n const context: Context = { ...options, root, failures: {} };\n checkFields(fields, values, '', context);\n return context.failures;\n}\n"],"mappings":";;;;;AAuCA,IAAM,QAAQ;;AAEd,IAAM,MAAM;AAEZ,SAAS,YAAY,MAAqB;CACtC,OAAQ,eAAqC,SAAS,KAAK,IAAI;AACnE;;;;;AAMA,SAAS,UAAU,MAAY,MAAqC;CAChE,OAAO,KAAK,SAAS,KAAA,KAAa,KAAK,SAAS;AACpD;AAEA,SAAS,QAAQ,MAAyB;CACtC,MAAM,SAAsB,EAAE,MAAM,KAAK,KAAK;CAC9C,IAAI,WAAW,QAAQ,KAAK,UAAU,KAAA,GAClC,OAAO,QAAQ,KAAK;CAExB,IAAI,KAAK,YAAY,KAAA,GACjB,OAAO,UAAU,KAAK;CAE1B,OAAO;AACX;AAEA,SAAS,OAAO,OAA+B;CAC3C,IAAI,OAAO,UAAU,UACjB,OAAO;CAEX,IAAI,OAAO,UAAU,YAAY,MAAM,QAAQ,KAAK,GAChD,OAAO,MAAM;CAEjB,OAAO;AACX;AAEA,SAAS,YAAY,MAAc,UAA6B;CAC5D,OAAO,SAAS,MAAM,YAAY;EAC9B,IAAI,QAAQ,SAAS,IAAI,GACrB,OAAO,KAAK,WAAW,QAAQ,MAAM,GAAG,EAAE,CAAC;EAE/C,OAAO,SAAS;CACpB,CAAC;AACL;;AAGA,SAAS,UAAU,OAA2C;CAE1D,QADa,MAAM,QAAQ,KAAK,IAAI,QAAQ,CAAC,KAAK,EAAA,CAE7C,OAAO,QAAQ,CAAC,CAChB,KAAK,UACF,OAAO,SAAS,eAAe,iBAAiB,OAC1C;EAAE,MAAM,MAAM,SAAS,KAAK,KAAA,IAAY,MAAM;EAAM,MAAM,MAAM;CAAK,IACrE,KACV;AACR;;;;;AAMA,SAAS,QAAQ,OAAgB,MAA0D;CAEvF,QADgB,MAAM,QAAQ,KAAK,IAAI,QAAQ,CAAC,KAAK,EAAA,CACtC,OAAO,UAAU;EAC5B,MAAM,YAAY,SAAS,KAAK,KAAK,SAAS,MAAM,SAAS,IAAI,MAAM,YAAY,CAAC;EACpF,MAAM,OAAO,iBAAiB,SAAS;EACvC,IAAI,SAAS,MACT,OAAO,KAAK,aAAa;EAE7B,MAAM,SAAS,KAAK,UAAU,CAAC;EAC/B,OACI,OAAO,WAAW,KAClB,OAAO,MAAM,UAAU,aAAa,KAAK,OAAO,KAAK,QAAQ,KAAK,CAAC;CAE3E,CAAC;AACL;AAEA,SAAS,OAAO,OAA+B;CAC3C,IAAI,OAAO,UAAU,YAAY,OAAO,UAAU,UAC9C,OAAO;CAEX,MAAM,OAAO,IAAI,KAAK,KAAK,CAAC,CAAC,QAAQ;CACrC,OAAO,OAAO,MAAM,IAAI,IAAI,OAAO;AACvC;;;;;AAMA,SAAgB,WACZ,OACA,OACA,OAAgC,CAAC,GACjC,MACa;CACb,MAAM,WAA0B,CAAC;CACjC,MAAM,SAAS,SAAS,KAAK;CAE7B,MADuB,QAAQ,SAAS,YAAY,IAAI,KAAK,UAAU,MAAM,IAAI,CACjF,CAAA,CAAS,SAAS,SAAS;EACvB,IAAI,KAAK,SAAS,YAAY;GAC1B,IAAI,CAAC,QACD,SAAS,KAAK,QAAQ,IAAI,CAAC;GAE/B;EACJ;EACA,IAAI,CAAC,QACD;EAEJ,IAAI,QAAQ;EACZ,QAAQ,KAAK,MAAb;GACI,KAAK;GACL,KAAK,OAAO;IACR,MAAM,OAAO,OAAO,KAAK;IACzB,MAAM,QAAQ,KAAK;IACnB,QAAQ,SAAS,SAAS,KAAK,SAAS,QAAQ,QAAQ,QAAQ,QAAQ;IACxE;GACJ;GACA,KAAK;IACD,QACI,OAAO,UAAU,YACjB,IAAI,OAAO,KAAK,OAAkB,KAA4B,KAAK,CAAC,CAAC,KACjE,KACJ;IACJ;GACJ,KAAK;IACD,QAAQ,OAAO,UAAU,YAAY,MAAM,KAAK,KAAK;IACrD;GACJ,KAAK;IACD,QAAQ,OAAO,UAAU,YAAY,IAAI,SAAS,KAAK;IACvD;GACJ,KAAK;IAED,QAAQ,SAAS,KAAK,KAAK,MAAM,QAAQ,KAAK;IAC9C;GACJ,KAAK;IACD,QAAQ,OAAO,UAAU,YAAY,IAAI,KAAK,KAAK;IACnD;GACJ,KAAK,MAAM;IACP,MAAM,UAAU,KAAK;IAErB,SADe,MAAM,QAAQ,KAAK,IAAI,QAAQ,CAAC,KAAK,EAAA,CACrC,OAAO,SAAS,QAAQ,SAAS,IAAI,CAAC;IACrD;GACJ;GACA,KAAK;IACD,QAAQ,UAAU,KAAK,CAAC,CAAC,OACpB,UACG,OAAO,MAAM,SAAS,YACtB,YAAY,MAAM,MAAM,KAAK,KAAiB,CACtD;IACA;GACJ,KAAK;IACD,QAAQ,UAAU,KAAK,CAAC,CAAC,OACpB,UACG,OAAO,MAAM,SAAS,YAAY,MAAM,QAAS,KAAK,KAC9D;IACA;GACJ,KAAK;IACD,QAAQ,CAAC,SAAS,KAAK,KAAK,KAAK,QAAQ,OAAO,KAAK,KAAK;IAC1D;GACJ,KAAK;GACL,KAAK,SAAS;IACV,MAAM,QAAQ,KAAK;IACnB,MAAM,YAAY,OACd,OAAO,UAAU,WAAW,QAAQ,SAAS,MAAM,MAAM,KAAK,CAClE;IACA,MAAM,OAAO,OAAO,KAAK;IACzB,IAAI,cAAc,QAAQ,SAAS,MAC/B,QAAQ,KAAK,SAAS,WAAW,OAAO,YAAY,OAAO;IAE/D;GACJ;EACJ;EACA,IAAI,CAAC,OACD,SAAS,KAAK,QAAQ,IAAI,CAAC;CAEnC,CAAC;CACD,OAAO;AACX;AAEA,SAAS,YAAY,SAAkB,MAAc,UAAyB;CAC1E,IAAI,SAAS,SAAS,GAClB,QAAQ,SAAS,QAAQ,CAAC,GAAI,QAAQ,SAAS,SAAS,CAAC,GAAI,GAAG,QAAQ;AAEhF;;AAGA,IAAM,gBAAgD;CAClD,MAAM,EAAE,MAAM,OAAO;CACrB,KAAK,EAAE,MAAM,MAAM;AACvB;;;;;AAMA,SAAS,QAAQ,OAAc,MAAoC;CAC/D,MAAM,SAAS,MAAM,SAAS,CAAC,EAAA,CAAG,QAAQ,SAAS,UAAU,MAAM,IAAI,CAAC;CACxE,MAAM,UAAU,cAAc,MAAM;CACpC,OAAO,YAAY,KAAA,KAAa,CAAC,MAAM,MAAM,SAAS,KAAK,SAAS,QAAQ,IAAI,IAC1E,CAAC,GAAG,OAAO,OAAO,IAClB;AACV;AAEA,SAAS,gBAAgB,OAAc,OAAgB,MAAc,SAAkB;CACnF,MAAM,QAAQ,QAAQ,OAAO,QAAQ,IAAI;CACzC,IAAI,MAAM,cAAc,MAAM;EAC1B,MAAM,YAAY,SAAS,KAAK,IAAI,QAAQ,CAAC;EAC7C,MAAM,WAAW,MAAM,QAAQ,SAAS,KAAK,SAAS,UAAU;EAChE,MAAM,SAAS,MAAM,QAAQ,SAAS,KAAK,SAAS,UAAU;EAC9D,IAAI,SAAS,SAAS,GAAG;GACrB,MAAM,UAAU,QAAQ;GACxB,IAAI,YAAY,KAAA,KAAa,QAAQ,WAAW,GACxC;QAAA,CAAC,OAAO,OAAO,SAAS,CAAC,CAAC,KAAK,QAAQ,GACvC,YAAY,SAAS,MAAM,SAAS,IAAI,OAAO,CAAC;GAAA,OAGpD,QAAQ,SAAS,WAAW;IACxB,YACI,SACA,GAAG,KAAK,GAAG,UACX,WAAW,UAAU,UAAU,SAAS,QAAQ,MAAM,QAAQ,IAAI,CACtE;GACJ,CAAC;EAET;EACA,OAAO,QAAQ,SAAS,CAAC,CAAC,SAAS,CAAC,QAAQ,iBAAiB;GACzD,YACI,SACA,GAAG,KAAK,GAAG,UACX,WAAW,QAAQ,aAAa,QAAQ,MAAM,QAAQ,IAAI,CAC9D;EACJ,CAAC;EACD;CACJ;CAEA,YAAY,SAAS,MAAM,WAAW,OAAO,OAAO,QAAQ,MAAM,QAAQ,IAAI,CAAC;CAE/E,IAAI,MAAM,SAAS,WAAW,MAAM,WAAW,KAAA,KAAa,SAAS,KAAK,GACtE,YAAY,MAAM,QAAQ,OAAO,GAAG,KAAK,IAAI,OAAO;CAExD,IAAI,MAAM,SAAS,cAAc,MAAM,QAAQ,KAAK,GAChD,MAAM,SAAS,MAAM,UAAU;EAC3B,IAAI,CAAC,SAAS,IAAI,GACd;EAEJ,MAAM,cACF,MAAM,UAAU,KAAA,IACV,MAAM,MAAM,MAAM,SAAS,KAAK,OAAO,KAAK,IAAI,CAAC,EAAE,SACnD,MAAM;EAChB,IAAI,gBAAgB,KAAA,GAChB,YAAY,aAAa,MAAM,GAAG,KAAK,GAAG,MAAM,IAAI,OAAO;CAEnE,CAAC;AAET;AAEA,SAAS,YACL,QACA,QACA,QACA,SACF;CACE,OAAO,SAAS,UAAU;EACtB,IAAI,MAAM,aAAa,MACnB;EAEJ,IAAI,QAAQ,SAAS,YAAY,MAAM,eAAe,MAClD;EAEJ,IAAI,QAAQ,SAAS,YAAY,MAAM,eAAe,MAClD;EAEJ,IACI,MAAM,gBAAgB,KAAA,KACtB,CAAC,kBAAkB,MAAM,aAAa,WAAW,KAAK,QAAQ,OAAO,MAAM,GAE3E;EAEJ,IAAI,QAAQ,YAAY,QAAQ,WAAW,MAAM,EAAE,MAAM,QAAQ,SAC7D;EAEJ,gBAAgB,OAAO,OAAO,MAAM,OAAO,GAAG,SAAS,MAAM,QAAQ,OAAO;CAChF,CAAC;AACL;;;;;;AAOA,SAAgB,YACZ,QACA,QACA,UAAwB,CAAC,GACI;CAC7B,MAAM,OACF,QAAQ,YAAY,QAAQ,QAAQ,SAAS,KAAA,IACvC;EAAE,GAAG,QAAQ;EAAM,GAAG;CAAO,IAC7B;CACV,MAAM,UAAmB;EAAE,GAAG;EAAS;EAAM,UAAU,CAAC;CAAE;CAC1D,YAAY,QAAQ,QAAQ,IAAI,OAAO;CACvC,OAAO,QAAQ;AACnB"}
|
package/dist/runtime/index.d.ts
CHANGED
|
@@ -9,6 +9,7 @@ export type { ValidationIssue } from '../validate.js';
|
|
|
9
9
|
export { type FilterRange, type FilterValue, type CursorPageMeta, type ListQuery, isCursorPage, fromSearchParams, isFilterRange, matchesFilterRange, toSearchParams, } from '../query.js';
|
|
10
10
|
export { type ReadSearchQueryResult, type SearchQuery, type SearchableResource, SEARCH_DEFAULT_LIMIT, SEARCH_MAX_LENGTH, SEARCH_MAX_LIMIT, SEARCH_MIN_LENGTH, isSearchableResource, readSearchQuery, toSearchQueryParams, } from '../search.js';
|
|
11
11
|
export { getValue, isFilled } from '../values.js';
|
|
12
|
+
export { type ContextValues, contextBefore, formatContextHeader, parseContextHeader, } from '../context.js';
|
|
12
13
|
export { isProblem } from '../problem.js';
|
|
13
14
|
export { type PartialTheme, mergeThemes } from '../themes.js';
|
|
14
15
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/runtime/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AACpE,cAAc,cAAc,CAAC;AAC7B,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,WAAW,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACxF,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,EAAE,iBAAiB,EAAE,KAAK,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAChF,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAC3E,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AACzC,YAAY,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EACH,KAAK,WAAW,EAChB,KAAK,WAAW,EAChB,KAAK,cAAc,EACnB,KAAK,SAAS,EACd,YAAY,EACZ,gBAAgB,EAChB,aAAa,EACb,kBAAkB,EAClB,cAAc,GACjB,MAAM,UAAU,CAAC;AAClB,OAAO,EACH,KAAK,qBAAqB,EAC1B,KAAK,WAAW,EAChB,KAAK,kBAAkB,EACvB,oBAAoB,EACpB,iBAAiB,EACjB,gBAAgB,EAChB,iBAAiB,EACjB,oBAAoB,EACpB,eAAe,EACf,mBAAmB,GACtB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,KAAK,YAAY,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/runtime/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AACpE,cAAc,cAAc,CAAC;AAC7B,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,WAAW,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACxF,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,EAAE,iBAAiB,EAAE,KAAK,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAChF,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAC3E,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AACzC,YAAY,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EACH,KAAK,WAAW,EAChB,KAAK,WAAW,EAChB,KAAK,cAAc,EACnB,KAAK,SAAS,EACd,YAAY,EACZ,gBAAgB,EAChB,aAAa,EACb,kBAAkB,EAClB,cAAc,GACjB,MAAM,UAAU,CAAC;AAClB,OAAO,EACH,KAAK,qBAAqB,EAC1B,KAAK,WAAW,EAChB,KAAK,kBAAkB,EACvB,oBAAoB,EACpB,iBAAiB,EACjB,gBAAgB,EAChB,iBAAiB,EACjB,oBAAoB,EACpB,eAAe,EACf,mBAAmB,GACtB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,EACH,KAAK,aAAa,EAClB,aAAa,EACb,mBAAmB,EACnB,kBAAkB,GACrB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,KAAK,YAAY,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC"}
|
package/dist/runtime/index.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { PROBLEM_CONTENT_TYPE, PROTOCOL_VERSION } from "../version.js";
|
|
2
|
-
import { BOOT_CONFIG_ELEMENT_ID, BUILT_IN_ACTIONS, BUILT_IN_FIELD_TYPES, BUILT_IN_ITEM_ACTIONS, BUILT_IN_LAYOUT_NODE_TYPES, BUILT_IN_LINK_ACTIONS, BUILT_IN_LIST_LAYOUTS, ITEM_ACTION_ABILITIES, PORTABLE_RULES, RICH_TEXT_STYLE_ELEMENTS, isBuiltInItemAction, isBuiltInLink } from "../constants.js";
|
|
2
|
+
import { BOOT_CONFIG_ELEMENT_ID, BUILT_IN_ACTIONS, BUILT_IN_FIELD_TYPES, BUILT_IN_ITEM_ACTIONS, BUILT_IN_LAYOUT_NODE_TYPES, BUILT_IN_LINK_ACTIONS, BUILT_IN_LIST_LAYOUTS, CONTEXT_HEADER, CONTEXT_PROBLEM_TYPE, ITEM_ACTION_ABILITIES, PORTABLE_RULES, RESERVED_ROUTE_SEGMENTS, RICH_TEXT_STYLE_ELEMENTS, isBuiltInItemAction, isBuiltInLink } from "../constants.js";
|
|
3
3
|
import { getValue, isFilled } from "../values.js";
|
|
4
4
|
import { evaluateCondition } from "../conditions.js";
|
|
5
5
|
import { matchesRatio, parseRatio, renderedCropSize } from "../transforms.js";
|
|
@@ -8,6 +8,7 @@ import { getMediaLibraries } from "../libraries.js";
|
|
|
8
8
|
import { lintDefinition } from "../lint.js";
|
|
9
9
|
import { fromSearchParams, isCursorPage, isFilterRange, matchesFilterRange, toSearchParams } from "../query.js";
|
|
10
10
|
import { SEARCH_DEFAULT_LIMIT, SEARCH_MAX_LENGTH, SEARCH_MAX_LIMIT, SEARCH_MIN_LENGTH, isSearchableResource, readSearchQuery, toSearchQueryParams } from "../search.js";
|
|
11
|
+
import { contextBefore, formatContextHeader, parseContextHeader } from "../context.js";
|
|
11
12
|
import { isProblem } from "../problem.js";
|
|
12
13
|
import { mergeThemes } from "../themes.js";
|
|
13
|
-
export { BOOT_CONFIG_ELEMENT_ID, BUILT_IN_ACTIONS, BUILT_IN_FIELD_TYPES, BUILT_IN_ITEM_ACTIONS, BUILT_IN_LAYOUT_NODE_TYPES, BUILT_IN_LINK_ACTIONS, BUILT_IN_LIST_LAYOUTS, ITEM_ACTION_ABILITIES, PORTABLE_RULES, PROBLEM_CONTENT_TYPE, PROTOCOL_VERSION, RICH_TEXT_STYLE_ELEMENTS, SEARCH_DEFAULT_LIMIT, SEARCH_MAX_LENGTH, SEARCH_MAX_LIMIT, SEARCH_MIN_LENGTH, checkRules, checkValues, evaluateCondition, fromSearchParams, getMediaLibraries, getValue, isBuiltInItemAction, isBuiltInLink, isCursorPage, isFilled, isFilterRange, isProblem, isSearchableResource, lintDefinition, matchesFilterRange, matchesRatio, mergeThemes, parseRatio, readSearchQuery, renderedCropSize, toSearchParams, toSearchQueryParams };
|
|
14
|
+
export { BOOT_CONFIG_ELEMENT_ID, BUILT_IN_ACTIONS, BUILT_IN_FIELD_TYPES, BUILT_IN_ITEM_ACTIONS, BUILT_IN_LAYOUT_NODE_TYPES, BUILT_IN_LINK_ACTIONS, BUILT_IN_LIST_LAYOUTS, CONTEXT_HEADER, CONTEXT_PROBLEM_TYPE, ITEM_ACTION_ABILITIES, PORTABLE_RULES, PROBLEM_CONTENT_TYPE, PROTOCOL_VERSION, RESERVED_ROUTE_SEGMENTS, RICH_TEXT_STYLE_ELEMENTS, SEARCH_DEFAULT_LIMIT, SEARCH_MAX_LENGTH, SEARCH_MAX_LIMIT, SEARCH_MIN_LENGTH, checkRules, checkValues, contextBefore, evaluateCondition, formatContextHeader, fromSearchParams, getMediaLibraries, getValue, isBuiltInItemAction, isBuiltInLink, isCursorPage, isFilled, isFilterRange, isProblem, isSearchableResource, lintDefinition, matchesFilterRange, matchesRatio, mergeThemes, parseContextHeader, parseRatio, readSearchQuery, renderedCropSize, toSearchParams, toSearchQueryParams };
|
package/dist/schemas/action.d.ts
CHANGED
|
@@ -54,6 +54,7 @@ export declare const Action: z.ZodObject<{
|
|
|
54
54
|
default: z.ZodOptional<z.ZodUnknown>;
|
|
55
55
|
localized: z.ZodOptional<z.ZodBoolean>;
|
|
56
56
|
readOnly: z.ZodOptional<z.ZodBoolean>;
|
|
57
|
+
abilities: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodBoolean>>;
|
|
57
58
|
createOnly: z.ZodOptional<z.ZodBoolean>;
|
|
58
59
|
updateOnly: z.ZodOptional<z.ZodBoolean>;
|
|
59
60
|
rules: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
|
|
@@ -87,6 +88,7 @@ export declare const Action: z.ZodObject<{
|
|
|
87
88
|
rule: z.ZodEnum<{
|
|
88
89
|
email: "email";
|
|
89
90
|
url: "url";
|
|
91
|
+
tel: "tel";
|
|
90
92
|
json: "json";
|
|
91
93
|
}>;
|
|
92
94
|
message: z.ZodOptional<z.ZodString>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"action.d.ts","sourceRoot":"","sources":["../../src/schemas/action.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtC,eAAO,MAAM,WAAW;;;;EAA4C,CAAC;AAErE,eAAO,MAAM,eAAe;;;;;EAA6C,CAAC;AAE1E,eAAO,MAAM,aAAa;;;;;mBAWxB,CAAC;AAEH,eAAO,MAAM,MAAM
|
|
1
|
+
{"version":3,"file":"action.d.ts","sourceRoot":"","sources":["../../src/schemas/action.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtC,eAAO,MAAM,WAAW;;;;EAA4C,CAAC;AAErE,eAAO,MAAM,eAAe;;;;;EAA6C,CAAC;AAE1E,eAAO,MAAM,aAAa;;;;;mBAWxB,CAAC;AAEH,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAyEb,CAAC;AAEP,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,CAAC;AACtD,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AAC9D,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AAC1D,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,MAAM,CAAC,CAAC;AAC5C,qEAAqE;AACrE,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,MAAM,CAAC,CAAC"}
|
package/dist/schemas/api.d.ts
CHANGED
|
@@ -53,6 +53,7 @@ export declare const Problem: z.ZodObject<{
|
|
|
53
53
|
version: z.ZodNullable<z.ZodString>;
|
|
54
54
|
abilities: z.ZodRecord<z.ZodString, z.ZodBoolean>;
|
|
55
55
|
}, z.core.$loose>>;
|
|
56
|
+
param: z.ZodOptional<z.ZodString>;
|
|
56
57
|
}, z.core.$loose>;
|
|
57
58
|
export declare const Selection: z.ZodUnion<readonly [z.ZodObject<{
|
|
58
59
|
ids: z.ZodArray<z.ZodString>;
|
|
@@ -469,6 +470,13 @@ export declare const Session: z.ZodObject<{
|
|
|
469
470
|
resource: z.ZodOptional<z.ZodString>;
|
|
470
471
|
}, z.core.$loose>;
|
|
471
472
|
}, z.core.$loose>;
|
|
473
|
+
export declare const ContextOptionsResponse: z.ZodObject<{
|
|
474
|
+
data: z.ZodArray<z.ZodObject<{
|
|
475
|
+
value: z.ZodString;
|
|
476
|
+
label: z.ZodString;
|
|
477
|
+
description: z.ZodOptional<z.ZodString>;
|
|
478
|
+
}, z.core.$loose>>;
|
|
479
|
+
}, z.core.$loose>;
|
|
472
480
|
export declare const SearchResponse: z.ZodObject<{
|
|
473
481
|
data: z.ZodArray<z.ZodObject<{
|
|
474
482
|
resource: z.ZodString;
|
|
@@ -528,6 +536,7 @@ export type Pagination = z.infer<typeof Pagination>;
|
|
|
528
536
|
export type ItemResponse = z.infer<typeof ItemResponse>;
|
|
529
537
|
export type CursorPagination = z.infer<typeof CursorPagination>;
|
|
530
538
|
export type ListResponse = z.infer<typeof ListResponse>;
|
|
539
|
+
export type ContextOptionsResponse = z.infer<typeof ContextOptionsResponse>;
|
|
531
540
|
export type Problem = z.infer<typeof Problem>;
|
|
532
541
|
export type Selection = z.infer<typeof Selection>;
|
|
533
542
|
export type ActionRequest = z.infer<typeof ActionRequest>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../src/schemas/api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAKxB,eAAO,MAAM,IAAI;;;;iBAUX,CAAC;AAEP,eAAO,MAAM,UAAU;;;;;iBAKrB,CAAC;AAEH,eAAO,MAAM,gBAAgB;;;;;iBAiBvB,CAAC;AAEP,eAAO,MAAM,YAAY;;;;;;iBAAgC,CAAC;AAE1D,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;iBAGvB,CAAC;AAEH,eAAO,MAAM,OAAO
|
|
1
|
+
{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../src/schemas/api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAKxB,eAAO,MAAM,IAAI;;;;iBAUX,CAAC;AAEP,eAAO,MAAM,UAAU;;;;;iBAKrB,CAAC;AAEH,eAAO,MAAM,gBAAgB;;;;;iBAiBvB,CAAC;AAEP,eAAO,MAAM,YAAY;;;;;;iBAAgC,CAAC;AAE1D,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;iBAGvB,CAAC;AAEH,eAAO,MAAM,OAAO;;;;;;;;;;;;;iBAiB6E,CAAC;AAElG,eAAO,MAAM,SAAS;;;;;;;;mBAYpB,CAAC;AAEH,eAAO,MAAM,aAAa;;;;;;;;;;;;iBASxB,CAAC;AAEH,eAAO,MAAM,gBAAgB;;;;;;;;iBAQ3B,CAAC;AAEH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAuBvB,CAAC;AAEH,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAUpB,CAAC;AAEH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAAoC,CAAC;AAEnE,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;mBAgCE,CAAC,CAAC,WAAW,CAAC,OAAO,cAAc,CAAC;iBAU3D,CAAC;AAEP,eAAO,MAAM,eAAe;;iBAG1B,CAAC;AAEH,eAAO,MAAM,UAAU;;;;;iBAYjB,CAAC;AAEP,eAAO,MAAM,MAAM;;;;;;iBAWb,CAAC;AAEP,eAAO,MAAM,cAAc;;;;;;;;iBAAkC,CAAC;AAE9D,eAAO,MAAM,iBAAiB;;;;;;;;;;;;iBAWxB,CAAC;AAEP,eAAO,MAAM,kBAAkB;;;;;iBAemB,CAAC;AAEnD,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uBA5EO,CAAC,CAAC,WAAW,CAAC,OAAO,cAAc,CAAC;;iBAkI3D,CAAC;AAEP,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2BApIO,CAAC,CAAC,WAAW,CAAC,OAAO,cAAc,CAAC;;;iBAyI/D,CAAC;AAEH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2BA3IE,CAAC,CAAC,WAAW,CAAC,OAAO,cAAc,CAAC;;;;;;;;;;;;;;;;;;;;;uBAApC,CAAC,CAAC,WAAW,CAAC,OAAO,cAAc,CAAC;;iBA4J3D,CAAC;AAEP,eAAO,MAAM,iBAAiB;;;;;iBAe2D,CAAC;AAE1F,eAAO,MAAM,kBAAkB;;;;;;iBAyBzB,CAAC;AAEP,eAAO,MAAM,OAAO;;;;;;;;;iBAAgC,CAAC;AAErD,eAAO,MAAM,sBAAsB;;;;;;iBAEsD,CAAC;AAE1F,eAAO,MAAM,cAAc;;;;;;;;;;iBAgBrB,CAAC;AAEP,eAAO,MAAM,eAAe;;;iBAAuE,CAAC;AAEpG,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;iBAiBjB,CAAC;AAEP,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;iBAAsC,CAAC;AAEjE,eAAO,MAAM,aAAa;;;;iBAM8D,CAAC;AAEzF,MAAM,MAAM,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,CAAC;AACxC,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAC;AACpD,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;AACxD,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAChE,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;AACxD,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAC5E,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,CAAC;AAC9C,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,SAAS,CAAC,CAAC;AAClD,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AAC1D,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAChE,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;AACxD,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,SAAS,CAAC,CAAC;AAClD,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAClE,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAC5D,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AAC9D,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAC;AACpD,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,MAAM,CAAC,CAAC;AAC5C,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAC5D,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAClE,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AACpE,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAClE,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AACpE,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,SAAS,CAAC,CAAC;AAClD,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,SAAS,CAAC,CAAC;AAClD,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAC5D,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,CAAC;AAC9C,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAC5D,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AAC9D,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAC;AACpD,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AAC1D,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC"}
|
package/dist/schemas/api.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { Abilities, Id, RouteReference } from "./common.js";
|
|
2
|
-
import { User } from "./definition.js";
|
|
2
|
+
import { ContextOption, User } from "./definition.js";
|
|
3
3
|
import { z } from "zod";
|
|
4
4
|
//#region src/schemas/api.ts
|
|
5
5
|
var Item = z.looseObject({
|
|
@@ -31,7 +31,8 @@ var Problem = z.looseObject({
|
|
|
31
31
|
detail: z.string().optional(),
|
|
32
32
|
instance: z.string().optional(),
|
|
33
33
|
errors: z.record(z.string(), z.array(z.string())).optional().meta({ description: "`422`: messages keyed by the dot path of the invalid value." }),
|
|
34
|
-
current: Item.optional().meta({ description: "`412`: the current version of the item." })
|
|
34
|
+
current: Item.optional().meta({ description: "`412`: the current version of the item." }),
|
|
35
|
+
param: z.string().optional().meta({ description: "`403` of type `urn:panneau:problem:context`: the param of the context whose value the user can't use." })
|
|
35
36
|
}).meta({ description: "An error, as RFC 9457 problem details (`application/problem+json`)." });
|
|
36
37
|
var Selection = z.union([z.looseObject({ ids: z.array(Id).min(1) }), z.looseObject({
|
|
37
38
|
query: z.looseObject({
|
|
@@ -197,6 +198,7 @@ var FieldCheckResponse = z.looseObject({
|
|
|
197
198
|
disabled: z.boolean().optional().meta({ description: "The field doesn't apply to this item (the home page has no slug): the field is read-only." })
|
|
198
199
|
}).meta({ description: "What the backend says about a value: not authoritative, since saving still validates it." });
|
|
199
200
|
var Session = z.looseObject({ user: User });
|
|
201
|
+
var ContextOptionsResponse = z.looseObject({ data: z.array(ContextOption) }).meta({ description: "The first choices of a param of the context that match `q`." });
|
|
200
202
|
var SearchResponse = z.looseObject({ data: z.array(z.looseObject({
|
|
201
203
|
resource: z.string().meta({ description: "The id of the resource." }),
|
|
202
204
|
items: z.array(Item),
|
|
@@ -229,6 +231,6 @@ var LocationValue = z.looseObject({
|
|
|
229
231
|
address: z.string().optional()
|
|
230
232
|
}).meta({ description: "The value of a `location` field: a point, and its address." });
|
|
231
233
|
//#endregion
|
|
232
|
-
export { ActionItemResult, ActionRequest, ActionResult, ActionRun, ActionRunResponse, CursorPagination, EmbedResponse, EmbedValue, FieldCheckRequest, FieldCheckResponse, Item, ItemResponse, ListResponse, LocationValue, MediaInfo, MediaItem, MediaReference, MediaTransform, Pagination, PreviewResponse, Problem, SearchResponse, Selection, Session, StoredFile, Upload, UploadReference, UploadResponse, UploadSignRequest, UploadSignResponse };
|
|
234
|
+
export { ActionItemResult, ActionRequest, ActionResult, ActionRun, ActionRunResponse, ContextOptionsResponse, CursorPagination, EmbedResponse, EmbedValue, FieldCheckRequest, FieldCheckResponse, Item, ItemResponse, ListResponse, LocationValue, MediaInfo, MediaItem, MediaReference, MediaTransform, Pagination, PreviewResponse, Problem, SearchResponse, Selection, Session, StoredFile, Upload, UploadReference, UploadResponse, UploadSignRequest, UploadSignResponse };
|
|
233
235
|
|
|
234
236
|
//# sourceMappingURL=api.js.map
|