@panneau/protocol 5.0.0-alpha.4 → 5.0.0-alpha.41
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/addresses.d.ts +23 -0
- package/dist/addresses.d.ts.map +1 -0
- package/dist/addresses.js +52 -0
- package/dist/addresses.js.map +1 -0
- package/dist/aggregates.d.ts +135 -0
- package/dist/aggregates.d.ts.map +1 -0
- package/dist/aggregates.js +236 -0
- package/dist/aggregates.js.map +1 -0
- package/dist/compound.d.ts +20 -0
- package/dist/compound.d.ts.map +1 -0
- package/dist/compound.js +27 -0
- package/dist/compound.js.map +1 -0
- package/dist/conditions.d.ts +1 -1
- package/dist/conformance/index.d.ts +6 -0
- package/dist/conformance/index.d.ts.map +1 -1
- package/dist/conformance/index.js +970 -11
- package/dist/conformance/index.js.map +1 -1
- package/dist/constants.d.ts +108 -2
- package/dist/constants.d.ts.map +1 -1
- package/dist/constants.js +181 -3
- 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/currencies.d.ts +22 -0
- package/dist/currencies.d.ts.map +1 -0
- package/dist/currencies.js +231 -0
- package/dist/currencies.js.map +1 -0
- package/dist/dashboards.d.ts +95 -0
- package/dist/dashboards.d.ts.map +1 -0
- package/dist/dashboards.js +140 -0
- package/dist/dashboards.js.map +1 -0
- package/dist/index.d.ts +4 -4
- package/dist/index.js +22 -8
- package/dist/libraries.d.ts +33 -0
- package/dist/libraries.d.ts.map +1 -0
- package/dist/libraries.js +59 -0
- package/dist/libraries.js.map +1 -0
- package/dist/links.d.ts +38 -0
- package/dist/links.d.ts.map +1 -0
- package/dist/links.js +65 -0
- package/dist/links.js.map +1 -0
- package/dist/lint.d.ts +4 -4
- package/dist/lint.d.ts.map +1 -1
- package/dist/lint.js +540 -15
- package/dist/lint.js.map +1 -1
- package/dist/mock/auth.d.ts +71 -0
- package/dist/mock/auth.d.ts.map +1 -0
- package/dist/mock/auth.js +346 -0
- package/dist/mock/auth.js.map +1 -0
- package/dist/mock/example.d.ts +1 -1
- package/dist/mock/example.d.ts.map +1 -1
- package/dist/mock/example.js +49 -28
- package/dist/mock/example.js.map +1 -1
- package/dist/mock/index.d.ts +96 -5
- package/dist/mock/index.d.ts.map +1 -1
- package/dist/mock/index.js +505 -44
- package/dist/mock/index.js.map +1 -1
- package/dist/openapi.d.ts.map +1 -1
- package/dist/openapi.js +462 -50
- package/dist/openapi.js.map +1 -1
- package/dist/periods.d.ts +61 -0
- package/dist/periods.d.ts.map +1 -0
- package/dist/periods.js +130 -0
- package/dist/periods.js.map +1 -0
- package/dist/problem.d.ts +1 -1
- package/dist/query.d.ts +18 -0
- package/dist/query.d.ts.map +1 -1
- package/dist/query.js +34 -8
- package/dist/query.js.map +1 -1
- package/dist/resourceTypes.d.ts +39 -0
- package/dist/resourceTypes.d.ts.map +1 -0
- package/dist/resourceTypes.js +34 -0
- package/dist/resourceTypes.js.map +1 -0
- package/dist/rules.d.ts +18 -5
- package/dist/rules.d.ts.map +1 -1
- package/dist/rules.js +233 -15
- package/dist/rules.js.map +1 -1
- package/dist/runtime/index.d.ts +23 -10
- package/dist/runtime/index.d.ts.map +1 -1
- package/dist/runtime/index.js +16 -3
- package/dist/schemas/action.d.ts +119 -10
- package/dist/schemas/action.d.ts.map +1 -1
- package/dist/schemas/action.js +20 -3
- package/dist/schemas/action.js.map +1 -1
- package/dist/schemas/api.d.ts +266 -5
- package/dist/schemas/api.d.ts.map +1 -1
- package/dist/schemas/api.js +134 -16
- package/dist/schemas/api.js.map +1 -1
- package/dist/schemas/boot.d.ts +25 -1
- package/dist/schemas/boot.d.ts.map +1 -1
- package/dist/schemas/boot.js +2 -1
- package/dist/schemas/boot.js.map +1 -1
- package/dist/schemas/common.d.ts +1 -0
- package/dist/schemas/common.d.ts.map +1 -1
- package/dist/schemas/common.js +2 -1
- package/dist/schemas/common.js.map +1 -1
- package/dist/schemas/definition.d.ts +1414 -30
- package/dist/schemas/definition.d.ts.map +1 -1
- package/dist/schemas/definition.js +77 -17
- package/dist/schemas/definition.js.map +1 -1
- package/dist/schemas/field.d.ts +358 -2
- package/dist/schemas/field.d.ts.map +1 -1
- package/dist/schemas/field.js +161 -20
- package/dist/schemas/field.js.map +1 -1
- package/dist/schemas/index.d.ts +5820 -46
- package/dist/schemas/index.d.ts.map +1 -1
- package/dist/schemas/index.js +69 -7
- package/dist/schemas/index.js.map +1 -1
- package/dist/schemas/jsonRules.d.ts +83 -0
- package/dist/schemas/jsonRules.d.ts.map +1 -0
- package/dist/schemas/jsonRules.js +46 -0
- package/dist/schemas/jsonRules.js.map +1 -0
- package/dist/schemas/layout.d.ts +2 -1
- package/dist/schemas/layout.d.ts.map +1 -1
- package/dist/schemas/layout.js +2 -1
- package/dist/schemas/layout.js.map +1 -1
- package/dist/schemas/list.d.ts +34 -2
- package/dist/schemas/list.d.ts.map +1 -1
- package/dist/schemas/list.js +21 -6
- package/dist/schemas/list.js.map +1 -1
- package/dist/schemas/resource.d.ts +826 -17
- package/dist/schemas/resource.d.ts.map +1 -1
- package/dist/schemas/resource.js +26 -4
- package/dist/schemas/resource.js.map +1 -1
- package/dist/schemas/theme.d.ts +6 -2
- package/dist/schemas/theme.d.ts.map +1 -1
- package/dist/schemas/theme.js +1 -0
- package/dist/schemas/theme.js.map +1 -1
- package/dist/schemas/widget.d.ts +4379 -0
- package/dist/schemas/widget.d.ts.map +1 -0
- package/dist/schemas/widget.js +269 -0
- package/dist/schemas/widget.js.map +1 -0
- package/dist/search.d.ts +51 -0
- package/dist/search.d.ts.map +1 -0
- package/dist/search.js +53 -0
- package/dist/search.js.map +1 -0
- package/dist/themes.d.ts +1 -1
- package/dist/transforms.d.ts +17 -0
- package/dist/transforms.d.ts.map +1 -0
- package/dist/transforms.js +34 -0
- package/dist/transforms.js.map +1 -0
- package/dist/validate.d.ts +5 -3
- package/dist/validate.d.ts.map +1 -1
- package/dist/validate.js +36 -2
- package/dist/validate.js.map +1 -1
- package/dist/values.d.ts +5 -1
- package/dist/values.d.ts.map +1 -1
- package/dist/values.js +16 -2
- package/dist/values.js.map +1 -1
- package/dist/widgets.d.ts +232 -0
- package/dist/widgets.d.ts.map +1 -0
- package/dist/widgets.js +630 -0
- package/dist/widgets.js.map +1 -0
- package/package.json +6 -3
- package/schema/boot.schema.json +1461 -104
- package/schema/definition.schema.json +1459 -105
- package/schema/openapi.json +7176 -2000
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 { 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};\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('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 ...problems(401, 403, 404),\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}/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 '/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 type: 'object',\n required: ['email', 'password'],\n properties: {\n email: { type: 'string' },\n password: { type: 'string' },\n remember: { type: 'boolean' },\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: { operationId: 'logout', responses: { 204: ok('Logged out.') } },\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.', { type: 'string' }),\n required: true,\n },\n ],\n responses: {\n 200: ok('Results grouped by resource.', ref('SearchResponse')),\n ...problems(401),\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":";;;;;;;AAUA,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;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,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;MAC/C,GAAG,SAAS,KAAK,KAAK,GAAG;KAC7B;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,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,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,MAAM;MACN,UAAU,CAAC,SAAS,UAAU;MAC9B,YAAY;OACR,OAAO,EAAE,MAAM,SAAS;OACxB,UAAU,EAAE,MAAM,SAAS;OAC3B,UAAU,EAAE,MAAM,UAAU;MAChC;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;IAAE,aAAa;IAAU,WAAW,EAAE,KAAK,GAAG,aAAa,EAAE;GAAE,EACzE;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,CACR;KACI,GAAG,eAAe,KAAK,iBAAiB,EAAE,MAAM,SAAS,CAAC;KAC1D,UAAU;IACd,CACJ;IACA,WAAW;KACP,KAAK,GAAG,gCAAgC,IAAI,gBAAgB,CAAC;KAC7D,GAAG,SAAS,GAAG;IACnB;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 { AGGREGATE_MAX_POINTS } from './aggregates';\nimport {\n AUTH_PAGE_PATHS,\n CONTEXT_HEADER,\n CONTEXT_PROBLEM_TYPE,\n EMAIL_UNVERIFIED_PROBLEM_TYPE,\n PASSWORD_CONFIRMATION_PROBLEM_TYPE,\n TWO_FACTOR_REQUIRED_PROBLEM_TYPE,\n} from './constants';\nimport { OVERVIEW_PERIODS } from './periods';\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';\nimport { WIDGET_BREAKDOWN_MAX_ITEMS } from './widgets';\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\\`. With \\`auth.emailVerification\\`, a user whose email address isn't verified gets a problem of type \\`${EMAIL_UNVERIFIED_PROBLEM_TYPE}\\` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type \\`${TWO_FACTOR_REQUIRED_PROBLEM_TYPE}\\` on every operation but those of the auth and of \\`/account/two-factor\\`.`,\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 423: `The password must be confirmed first (\\`POST /auth/password/confirm\\`): a problem of type \\`${PASSWORD_CONFIRMATION_PROBLEM_TYPE}\\`.`,\n 429: 'Too many requests: `Retry-After` gives the seconds to wait.',\n 500: 'Server error, such as a widget whose data does not have the shape of its type.',\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\n/** The parameters of `GET /resources/{resource}/aggregate`: the filters and search of the list. */\nconst aggregateParameters = [\n ...listParameters.filter((parameter) => ['filter', 'q'].includes(String(parameter.name))),\n queryParameter(\n 'measure',\n 'What is measured of the items: `count` (the default), or `sum:{field}` of a field of the `sum` of the aggregates of the list. A sum of `money` adds the amounts, in minor units.',\n { type: 'string', pattern: '^(count|sum:.+)$', default: 'count' },\n ),\n queryParameter(\n 'group',\n 'How the items are grouped: `{period}:{date field}`, where the period is `day`, `week` (from Monday) or `month` and the field is in the `dates` of the aggregates, or a field of their `groupBy`. Without it, the answer is a stat.',\n { type: 'string', pattern: '^((day|week|month):.+|[^:]+)$' },\n ),\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 '/locale/{locale}': {\n parameters: [pathParameter('locale', 'A `locale` of `interfaceLocales`.')],\n get: {\n operationId: 'switchLocale',\n summary:\n 'Optional: switches the interface to a locale of `interfaceLocales`, when their `url` is here (decision 0083). The app comes with a full navigation, and the next page load gets the definition in that locale.',\n parameters: [\n queryParameter(\n 'next',\n 'Where to go next: a local path under the base path of the app. Another one is ignored.',\n { type: 'string' },\n ),\n ],\n responses: {\n 302: { description: 'To `next`, or to the base path of the app.' },\n ...problems(401, 404),\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}/aggregate': {\n parameters: [resource],\n get: {\n operationId: 'getResourceAggregate',\n description: `The count or the sum of the items of the list that the user can list, with the filters and the search of the list, in the shape of a widget (decision 0084). Only what \\`list.aggregates\\` declares is aggregated: a resource without it is a \\`404\\`, and an undeclared field, or a measure or a group in the wrong format, a \\`422\\` with \\`errors\\` keyed by \\`measure\\` or \\`group\\`. Without a group, a \\`StatWidgetData\\`. By a period, a \\`SeriesWidgetData\\`: a point per period, at 0 without items, from the period of the \\`from\\` bound of the \\`date-range\\` filter whose id is the date field to the period of its \\`to\\` bound, or without a bound, of the first or the last item; at most ${AGGREGATE_MAX_POINTS} points, the latest, and their sum in \\`total\\`. By a field, a \\`BreakdownWidgetData\\`: a part per value, the largest first, at most ${WIDGET_BREAKDOWN_MAX_ITEMS}, the rest in \\`other\\`, each with its \\`key\\` (\\`null\\` for the items without a value), the label and the tone of its option for a \\`select\\`, and the measure of every item in \\`total\\`.`,\n parameters: aggregateParameters,\n responses: {\n 200: ok('The aggregate, in the shape of a widget.', {\n anyOf: [\n ref('StatWidgetData'),\n ref('SeriesWidgetData'),\n ref('BreakdownWidgetData'),\n ],\n }),\n ...problems(401, 403, 404, 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 ref('TwoFactorChallenge'),\n ),\n ...problems(422, 429),\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 summary:\n \"Starts the login with an OAuth provider of `auth.providers`. The callback is the backend's: it goes to `next`, or to the base path of the app with `authError` when it fails.\",\n parameters: [\n queryParameter(\n 'next',\n 'Where to go after the login: a local path under the base path of the app. Another one is ignored.',\n {\n type: 'string',\n },\n ),\n ],\n responses: {\n 302: { description: 'Redirect to the provider.' },\n ...problems(404),\n },\n },\n },\n '/auth/providers/{provider}/callback': {\n parameters: [pathParameter('provider', 'Provider id.')],\n get: {\n operationId: 'providerCallback',\n summary:\n \"Optional: the callback of the provider, when the backend has it here. Its URL is the backend's, registered with the provider; the app never calls it.\",\n responses: {\n 302: {\n description:\n 'To `next`, or to the base path of the app with `authError` when the login failed.',\n },\n ...problems(404),\n },\n },\n },\n '/auth/password/forgot': {\n post: {\n operationId: 'forgotPassword',\n summary: `With \\`auth.passwordReset\\`: emails a link to the page of the app at \\`{basePath}/${AUTH_PAGE_PATHS.resetPassword}?token=…&email=…\\`.`,\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(\n \"A reset link was sent, if the address has an account. The answer is the same when it hasn't, or when a link was sent recently.\",\n ),\n ...problems(422, 429),\n },\n },\n },\n '/auth/password/reset': {\n post: {\n operationId: 'resetPassword',\n summary:\n 'With `auth.passwordReset`: sets a new password, with the token and the email of the link. It does not log in.',\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: {\n 204: ok('The password was reset.'),\n ...problems(422, 429),\n },\n },\n },\n '/auth/email/verification': {\n post: {\n operationId: 'sendEmailVerification',\n summary: `With \\`auth.emailVerification\\`: emails the current user a link to the page of the app at \\`{basePath}/${AUTH_PAGE_PATHS.verifyEmail}?token=…\\`.`,\n responses: {\n 204: ok('A link was sent, or the address is already verified.'),\n ...problems(401, 429),\n },\n },\n },\n '/auth/email/verify': {\n post: {\n operationId: 'verifyEmail',\n summary:\n 'With `auth.emailVerification`: verifies the address of the token of a link. The user does not need to be logged in.',\n requestBody: {\n required: true,\n content: json({\n type: 'object',\n required: ['token'],\n properties: { token: { type: 'string' } },\n }),\n },\n responses: {\n 204: ok('The address is verified.'),\n ...problems(422, 429),\n },\n },\n },\n '/auth/two-factor/challenge': {\n post: {\n operationId: 'twoFactorChallenge',\n summary:\n 'Ends a login that answered `202`, with a code of the authenticator app or a recovery code. A login that is no longer pending is a `422`.',\n requestBody: {\n required: true,\n content: json({\n oneOf: [\n {\n type: 'object',\n required: ['code'],\n properties: { code: { type: 'string' } },\n },\n {\n type: 'object',\n required: ['recoveryCode'],\n properties: { recoveryCode: { type: 'string' } },\n },\n ],\n }),\n },\n responses: {\n 200: ok('Logged in.', ref('Session')),\n ...problems(422, 429),\n },\n },\n },\n '/auth/password/confirm': {\n post: {\n operationId: 'confirmPassword',\n summary:\n 'Confirms the password of the current user, for the operations that answer `423`.',\n requestBody: {\n required: true,\n content: json({\n type: 'object',\n required: ['password'],\n properties: { password: { type: 'string' } },\n }),\n },\n responses: {\n 204: ok('The password is confirmed.'),\n ...problems(401, 422, 429),\n },\n },\n },\n '/account/two-factor': {\n get: {\n operationId: 'getTwoFactor',\n summary: 'With `auth.twoFactor`: the two-factor authentication of the user.',\n responses: {\n 200: ok('Its status.', ref('TwoFactorStatus')),\n ...problems(401, 403),\n },\n },\n post: {\n operationId: 'enableTwoFactor',\n summary:\n 'Starts setting it up: a new secret, `pending` until `POST /account/two-factor/confirm`.',\n responses: {\n 200: ok(\n 'The secret to add to an authenticator app.',\n ref('TwoFactorSetup'),\n ),\n ...problems(401, 403, 409, 423),\n },\n },\n delete: {\n operationId: 'disableTwoFactor',\n summary: 'Turns it off. A `409` when the backend requires it for the user.',\n responses: {\n 204: ok('Turned off.'),\n ...problems(401, 403, 409, 423),\n },\n },\n },\n '/account/two-factor/confirm': {\n post: {\n operationId: 'confirmTwoFactor',\n requestBody: {\n required: true,\n content: json({\n type: 'object',\n required: ['code'],\n properties: { code: { type: 'string' } },\n }),\n },\n responses: {\n 200: ok('Turned on, with its recovery codes.', ref('RecoveryCodes')),\n ...problems(401, 403, 409, 422, 423),\n },\n },\n },\n '/account/two-factor/recovery-codes': {\n post: {\n operationId: 'regenerateRecoveryCodes',\n summary: 'New recovery codes, in place of the old ones.',\n responses: {\n 200: ok('The new codes.', ref('RecoveryCodes')),\n ...problems(401, 403, 409, 423),\n },\n },\n },\n '/auth/passkeys/options': {\n post: {\n operationId: 'passkeyLoginOptions',\n summary:\n 'With `auth.passkeys`: the options of `navigator.credentials.get()`, for any passkey of the site.',\n responses: {\n 200: ok('The options.', ref('WebAuthnOptions')),\n ...problems(429),\n },\n },\n },\n '/auth/passkeys/login': {\n post: {\n operationId: 'passkeyLogin',\n summary:\n 'Logs in with the credential of a passkey, in the JSON form of the WebAuthn spec. It does not ask for a second factor.',\n requestBody: {\n required: true,\n content: json({\n type: 'object',\n required: ['credential'],\n properties: {\n credential: { type: 'object', additionalProperties: true },\n remember: { type: 'boolean' },\n },\n }),\n },\n responses: {\n 200: ok('Logged in.', ref('Session')),\n ...problems(422, 429),\n },\n },\n },\n '/account/passkeys': {\n get: {\n operationId: 'listPasskeys',\n responses: {\n 200: ok('The passkeys of the current user.', {\n type: 'object',\n required: ['data'],\n properties: { data: { type: 'array', items: ref('Passkey') } },\n }),\n ...problems(401, 403),\n },\n },\n post: {\n operationId: 'addPasskey',\n summary:\n 'Adds a passkey, with the credential of `navigator.credentials.create()` for the options of `POST /account/passkeys/options`.',\n requestBody: {\n required: true,\n content: json({\n type: 'object',\n required: ['name', 'credential'],\n properties: {\n name: { type: 'string' },\n credential: { type: 'object', additionalProperties: true },\n },\n }),\n },\n responses: {\n 201: ok('The passkey.', {\n type: 'object',\n required: ['data'],\n properties: { data: ref('Passkey') },\n }),\n ...problems(401, 403, 409, 422, 423),\n },\n },\n },\n '/account/passkeys/options': {\n post: {\n operationId: 'passkeyRegistrationOptions',\n summary:\n \"The options of `navigator.credentials.create()`, for the current user. A `409` for a user who can't have passkeys.\",\n responses: {\n 200: ok('The options.', ref('WebAuthnOptions')),\n ...problems(401, 403, 409, 423),\n },\n },\n },\n '/account/passkeys/{passkey}': {\n parameters: [pathParameter('passkey', 'The id of the passkey.')],\n delete: {\n operationId: 'deletePasskey',\n responses: {\n 204: ok('Removed.'),\n ...problems(401, 403, 404, 423),\n },\n },\n },\n '/account': {\n get: {\n operationId: 'getAccount',\n summary: 'With `auth.account`: the current user.',\n responses: {\n 200: ok('The current user.', {\n type: 'object',\n required: ['data'],\n properties: { data: ref('User') },\n }),\n ...problems(401, 403),\n },\n },\n patch: {\n operationId: 'updateAccount',\n summary:\n 'Saves the name and the email of the current user. With `auth.emailVerification`, a new email is unverified, and gets a link.',\n requestBody: {\n required: true,\n content: json({\n type: 'object',\n properties: { name: { type: 'string' }, email: { type: 'string' } },\n }),\n },\n responses: {\n 200: ok('The updated user.', {\n type: 'object',\n required: ['data'],\n properties: { data: ref('User') },\n }),\n ...problems(401, 403, 422),\n },\n },\n },\n '/account/password': {\n put: {\n operationId: 'updatePassword',\n summary: 'Changes the password of the current user, with the current one.',\n requestBody: {\n required: true,\n content: json({\n type: 'object',\n required: ['currentPassword', 'password'],\n properties: {\n currentPassword: { type: 'string' },\n password: { type: 'string' },\n },\n }),\n },\n responses: {\n 204: ok('The password was changed.'),\n ...problems(401, 403, 422, 429),\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 description:\n 'The data of a widget of a dashboard of the user, read as the user (decision 0064): the home page, the dashboard page of `page`, or the summary above the list of `resource`, with the filters and the search of the list (decision 0084). The built-in widgets on a resource (`settings.resource`) have none: clients read the list or the aggregates of the resource. A widget that is not on that page or in that summary of the user is a `404`; a `403` hides the widget. `page` and `resource` together are a `422`.',\n parameters: [\n queryParameter(\n 'page',\n 'The id of the dashboard page of the widget, in `pages`. Defaults to `home`, the home page, whose widgets are `pages.home.widgets` or `dashboard.widgets`. Not with `resource`.',\n { type: 'string', minLength: 1 },\n ),\n queryParameter(\n 'resource',\n \"The id of the resource whose summary (`summary.widgets`) holds the widget, instead of a page. The request then has the list's current filters and search (`filter`, `q`), unless the widget has `settings.followsList: false`; never its sort or paging.\",\n { type: 'string', minLength: 1 },\n ),\n ...listParameters.filter((parameter) =>\n ['filter', 'q'].includes(String(parameter.name)),\n ),\n {\n name: 'period',\n in: 'query',\n required: false,\n style: 'deepObject',\n explode: true,\n description:\n 'The period chosen in the overview of the widget (decision 0084), unless the widget has `settings.period: false`: `period[option]=30d&period[from]=2026-10-19&period[to]=2026-11-17`. `from` and `to` are its first and last days, both inclusive, in the time zone of the browser. A wrong period is a `422` keyed by `period`.',\n schema: {\n type: 'object',\n properties: {\n option: { type: 'string', enum: [...OVERVIEW_PERIODS] },\n from: { type: 'string', format: 'date' },\n to: { type: 'string', format: 'date' },\n },\n required: ['option', 'from', 'to'],\n },\n },\n ],\n responses: {\n 200: ok(\n \"The widget's data, in the shape of its type: `StatWidgetData`, `SeriesWidgetData`, `ListWidgetData`, `BreakdownWidgetData`, `MetricWidgetData` and `TableWidgetData` for the built-in types, the plugin's own object for others. A `metric` that follows the period has `previous`, its value over the days of `getPreviousRange()`: the same number of days just before (`7d`, `30d`, `90d`), the same days of the month before (`month`), or of the year before (`year`).\",\n {\n anyOf: [\n ref('StatWidgetData'),\n ref('SeriesWidgetData'),\n ref('ListWidgetData'),\n ref('BreakdownWidgetData'),\n ref('MetricWidgetData'),\n ref('TableWidgetData'),\n { type: 'object', additionalProperties: true },\n ],\n },\n ),\n ...problems(401, 403, 404, 422, 500),\n },\n },\n },\n }),\n components: {\n schemas: createComponentSchemas(),\n parameters: { Context: contextHeader },\n },\n };\n}\n"],"mappings":";;;;;;;;;;;;AA2BA,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,8HAA8H,8BAA8B,4IAA4I,iCAAiC;CACnc,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK,+FAA+F,mCAAmC;CACvI,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;;AAGA,IAAM,sBAAsB;CACxB,GAAG,eAAe,QAAQ,cAAc,CAAC,UAAU,GAAG,CAAC,CAAC,SAAS,OAAO,UAAU,IAAI,CAAC,CAAC;CACxF,eACI,WACA,oLACA;EAAE,MAAM;EAAU,SAAS;EAAoB,SAAS;CAAQ,CACpE;CACA,eACI,SACA,sOACA;EAAE,MAAM;EAAU,SAAS;CAAgC,CAC/D;AACJ;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,oBAAoB;IAChB,YAAY,CAAC,cAAc,UAAU,mCAAmC,CAAC;IACzE,KAAK;KACD,aAAa;KACb,SACI;KACJ,YAAY,CACR,eACI,QACA,0FACA,EAAE,MAAM,SAAS,CACrB,CACJ;KACA,WAAW;MACP,KAAK,EAAE,aAAa,6CAA6C;MACjE,GAAG,SAAS,KAAK,GAAG;KACxB;IACJ;GACJ;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,mCAAmC;IAC/B,YAAY,CAAC,QAAQ;IACrB,KAAK;KACD,aAAa;KACb,aAAa;KACb,YAAY;KACZ,WAAW;MACP,KAAK,GAAG,4CAA4C,EAChD,OAAO;OACH,IAAI,gBAAgB;OACpB,IAAI,kBAAkB;OACtB,IAAI,qBAAqB;MAC7B,EACJ,CAAC;MACD,GAAG,SAAS,KAAK,KAAK,KAAK,GAAG;KAClC;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,IAAI,oBAAoB,CAC5B;KACA,GAAG,SAAS,KAAK,GAAG;IACxB;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,SACI;KACJ,YAAY,CACR,eACI,QACA,qGACA,EACI,MAAM,SACV,CACJ,CACJ;KACA,WAAW;MACP,KAAK,EAAE,aAAa,4BAA4B;MAChD,GAAG,SAAS,GAAG;KACnB;IACJ;GACJ;GACA,uCAAuC;IACnC,YAAY,CAAC,cAAc,YAAY,cAAc,CAAC;IACtD,KAAK;KACD,aAAa;KACb,SACI;KACJ,WAAW;MACP,KAAK,EACD,aACI,oFACR;MACA,GAAG,SAAS,GAAG;KACnB;IACJ;GACJ;GACA,yBAAyB,EACrB,MAAM;IACF,aAAa;IACb,SAAS,qFAAqF,gBAAgB,cAAc;IAC5H,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,GACD,gIACJ;KACA,GAAG,SAAS,KAAK,GAAG;IACxB;GACJ,EACJ;GACA,wBAAwB,EACpB,MAAM;IACF,aAAa;IACb,SACI;IACJ,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;KACP,KAAK,GAAG,yBAAyB;KACjC,GAAG,SAAS,KAAK,GAAG;IACxB;GACJ,EACJ;GACA,4BAA4B,EACxB,MAAM;IACF,aAAa;IACb,SAAS,0GAA0G,gBAAgB,YAAY;IAC/I,WAAW;KACP,KAAK,GAAG,sDAAsD;KAC9D,GAAG,SAAS,KAAK,GAAG;IACxB;GACJ,EACJ;GACA,sBAAsB,EAClB,MAAM;IACF,aAAa;IACb,SACI;IACJ,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,0BAA0B;KAClC,GAAG,SAAS,KAAK,GAAG;IACxB;GACJ,EACJ;GACA,8BAA8B,EAC1B,MAAM;IACF,aAAa;IACb,SACI;IACJ,aAAa;KACT,UAAU;KACV,SAAS,KAAK,EACV,OAAO,CACH;MACI,MAAM;MACN,UAAU,CAAC,MAAM;MACjB,YAAY,EAAE,MAAM,EAAE,MAAM,SAAS,EAAE;KAC3C,GACA;MACI,MAAM;MACN,UAAU,CAAC,cAAc;MACzB,YAAY,EAAE,cAAc,EAAE,MAAM,SAAS,EAAE;KACnD,CACJ,EACJ,CAAC;IACL;IACA,WAAW;KACP,KAAK,GAAG,cAAc,IAAI,SAAS,CAAC;KACpC,GAAG,SAAS,KAAK,GAAG;IACxB;GACJ,EACJ;GACA,0BAA0B,EACtB,MAAM;IACF,aAAa;IACb,SACI;IACJ,aAAa;KACT,UAAU;KACV,SAAS,KAAK;MACV,MAAM;MACN,UAAU,CAAC,UAAU;MACrB,YAAY,EAAE,UAAU,EAAE,MAAM,SAAS,EAAE;KAC/C,CAAC;IACL;IACA,WAAW;KACP,KAAK,GAAG,4BAA4B;KACpC,GAAG,SAAS,KAAK,KAAK,GAAG;IAC7B;GACJ,EACJ;GACA,uBAAuB;IACnB,KAAK;KACD,aAAa;KACb,SAAS;KACT,WAAW;MACP,KAAK,GAAG,eAAe,IAAI,iBAAiB,CAAC;MAC7C,GAAG,SAAS,KAAK,GAAG;KACxB;IACJ;IACA,MAAM;KACF,aAAa;KACb,SACI;KACJ,WAAW;MACP,KAAK,GACD,8CACA,IAAI,gBAAgB,CACxB;MACA,GAAG,SAAS,KAAK,KAAK,KAAK,GAAG;KAClC;IACJ;IACA,QAAQ;KACJ,aAAa;KACb,SAAS;KACT,WAAW;MACP,KAAK,GAAG,aAAa;MACrB,GAAG,SAAS,KAAK,KAAK,KAAK,GAAG;KAClC;IACJ;GACJ;GACA,+BAA+B,EAC3B,MAAM;IACF,aAAa;IACb,aAAa;KACT,UAAU;KACV,SAAS,KAAK;MACV,MAAM;MACN,UAAU,CAAC,MAAM;MACjB,YAAY,EAAE,MAAM,EAAE,MAAM,SAAS,EAAE;KAC3C,CAAC;IACL;IACA,WAAW;KACP,KAAK,GAAG,uCAAuC,IAAI,eAAe,CAAC;KACnE,GAAG,SAAS,KAAK,KAAK,KAAK,KAAK,GAAG;IACvC;GACJ,EACJ;GACA,sCAAsC,EAClC,MAAM;IACF,aAAa;IACb,SAAS;IACT,WAAW;KACP,KAAK,GAAG,kBAAkB,IAAI,eAAe,CAAC;KAC9C,GAAG,SAAS,KAAK,KAAK,KAAK,GAAG;IAClC;GACJ,EACJ;GACA,0BAA0B,EACtB,MAAM;IACF,aAAa;IACb,SACI;IACJ,WAAW;KACP,KAAK,GAAG,gBAAgB,IAAI,iBAAiB,CAAC;KAC9C,GAAG,SAAS,GAAG;IACnB;GACJ,EACJ;GACA,wBAAwB,EACpB,MAAM;IACF,aAAa;IACb,SACI;IACJ,aAAa;KACT,UAAU;KACV,SAAS,KAAK;MACV,MAAM;MACN,UAAU,CAAC,YAAY;MACvB,YAAY;OACR,YAAY;QAAE,MAAM;QAAU,sBAAsB;OAAK;OACzD,UAAU,EAAE,MAAM,UAAU;MAChC;KACJ,CAAC;IACL;IACA,WAAW;KACP,KAAK,GAAG,cAAc,IAAI,SAAS,CAAC;KACpC,GAAG,SAAS,KAAK,GAAG;IACxB;GACJ,EACJ;GACA,qBAAqB;IACjB,KAAK;KACD,aAAa;KACb,WAAW;MACP,KAAK,GAAG,qCAAqC;OACzC,MAAM;OACN,UAAU,CAAC,MAAM;OACjB,YAAY,EAAE,MAAM;QAAE,MAAM;QAAS,OAAO,IAAI,SAAS;OAAE,EAAE;MACjE,CAAC;MACD,GAAG,SAAS,KAAK,GAAG;KACxB;IACJ;IACA,MAAM;KACF,aAAa;KACb,SACI;KACJ,aAAa;MACT,UAAU;MACV,SAAS,KAAK;OACV,MAAM;OACN,UAAU,CAAC,QAAQ,YAAY;OAC/B,YAAY;QACR,MAAM,EAAE,MAAM,SAAS;QACvB,YAAY;SAAE,MAAM;SAAU,sBAAsB;QAAK;OAC7D;MACJ,CAAC;KACL;KACA,WAAW;MACP,KAAK,GAAG,gBAAgB;OACpB,MAAM;OACN,UAAU,CAAC,MAAM;OACjB,YAAY,EAAE,MAAM,IAAI,SAAS,EAAE;MACvC,CAAC;MACD,GAAG,SAAS,KAAK,KAAK,KAAK,KAAK,GAAG;KACvC;IACJ;GACJ;GACA,6BAA6B,EACzB,MAAM;IACF,aAAa;IACb,SACI;IACJ,WAAW;KACP,KAAK,GAAG,gBAAgB,IAAI,iBAAiB,CAAC;KAC9C,GAAG,SAAS,KAAK,KAAK,KAAK,GAAG;IAClC;GACJ,EACJ;GACA,+BAA+B;IAC3B,YAAY,CAAC,cAAc,WAAW,wBAAwB,CAAC;IAC/D,QAAQ;KACJ,aAAa;KACb,WAAW;MACP,KAAK,GAAG,UAAU;MAClB,GAAG,SAAS,KAAK,KAAK,KAAK,GAAG;KAClC;IACJ;GACJ;GACA,YAAY;IACR,KAAK;KACD,aAAa;KACb,SAAS;KACT,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;IACA,OAAO;KACH,aAAa;KACb,SACI;KACJ,aAAa;MACT,UAAU;MACV,SAAS,KAAK;OACV,MAAM;OACN,YAAY;QAAE,MAAM,EAAE,MAAM,SAAS;QAAG,OAAO,EAAE,MAAM,SAAS;OAAE;MACtE,CAAC;KACL;KACA,WAAW;MACP,KAAK,GAAG,qBAAqB;OACzB,MAAM;OACN,UAAU,CAAC,MAAM;OACjB,YAAY,EAAE,MAAM,IAAI,MAAM,EAAE;MACpC,CAAC;MACD,GAAG,SAAS,KAAK,KAAK,GAAG;KAC7B;IACJ;GACJ;GACA,qBAAqB,EACjB,KAAK;IACD,aAAa;IACb,SAAS;IACT,aAAa;KACT,UAAU;KACV,SAAS,KAAK;MACV,MAAM;MACN,UAAU,CAAC,mBAAmB,UAAU;MACxC,YAAY;OACR,iBAAiB,EAAE,MAAM,SAAS;OAClC,UAAU,EAAE,MAAM,SAAS;MAC/B;KACJ,CAAC;IACL;IACA,WAAW;KACP,KAAK,GAAG,2BAA2B;KACnC,GAAG,SAAS,KAAK,KAAK,KAAK,GAAG;IAClC;GACJ,EACJ;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,aACI;KACJ,YAAY;MACR,eACI,QACA,kLACA;OAAE,MAAM;OAAU,WAAW;MAAE,CACnC;MACA,eACI,YACA,4PACA;OAAE,MAAM;OAAU,WAAW;MAAE,CACnC;MACA,GAAG,eAAe,QAAQ,cACtB,CAAC,UAAU,GAAG,CAAC,CAAC,SAAS,OAAO,UAAU,IAAI,CAAC,CACnD;MACA;OACI,MAAM;OACN,IAAI;OACJ,UAAU;OACV,OAAO;OACP,SAAS;OACT,aACI;OACJ,QAAQ;QACJ,MAAM;QACN,YAAY;SACR,QAAQ;UAAE,MAAM;UAAU,MAAM,CAAC,GAAG,gBAAgB;SAAE;SACtD,MAAM;UAAE,MAAM;UAAU,QAAQ;SAAO;SACvC,IAAI;UAAE,MAAM;UAAU,QAAQ;SAAO;QACzC;QACA,UAAU;SAAC;SAAU;SAAQ;QAAI;OACrC;MACJ;KACJ;KACA,WAAW;MACP,KAAK,GACD,+cACA,EACI,OAAO;OACH,IAAI,gBAAgB;OACpB,IAAI,kBAAkB;OACtB,IAAI,gBAAgB;OACpB,IAAI,qBAAqB;OACzB,IAAI,kBAAkB;OACtB,IAAI,iBAAiB;OACrB;QAAE,MAAM;QAAU,sBAAsB;OAAK;MACjD,EACJ,CACJ;MACA,GAAG,SAAS,KAAK,KAAK,KAAK,KAAK,GAAG;KACvC;IACJ;GACJ;EACJ,CAAC;EACD,YAAY;GACR,SAAS,uBAAuB;GAChC,YAAY,EAAE,SAAS,cAAc;EACzC;CACJ;AACJ"}
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The periods an overview can offer (decision 0084): the 7, 30 or 90 days ending today, the current
|
|
3
|
+
* calendar month, and the last 12 months.
|
|
4
|
+
*/
|
|
5
|
+
export declare const OVERVIEW_PERIODS: readonly ["7d", "30d", "90d", "month", "year"];
|
|
6
|
+
export type OverviewPeriodOption = (typeof OVERVIEW_PERIODS)[number];
|
|
7
|
+
/** The query parameter of the chosen period, in the URL of a dashboard page or a list. */
|
|
8
|
+
export declare const PERIOD_PARAM = "period";
|
|
9
|
+
/** A period as the helpers read it: the `period` of a dashboard page or of a summary. */
|
|
10
|
+
export interface PeriodLike {
|
|
11
|
+
options: readonly string[];
|
|
12
|
+
default?: string | undefined;
|
|
13
|
+
}
|
|
14
|
+
/** The days of a period, both inclusive: `2026-10-19` to `2026-11-17`. */
|
|
15
|
+
export interface PeriodRange {
|
|
16
|
+
from: string;
|
|
17
|
+
to: string;
|
|
18
|
+
}
|
|
19
|
+
/** The chosen period of an overview, with its days, as widgets with an endpoint get it. */
|
|
20
|
+
export interface WidgetPeriod extends PeriodRange {
|
|
21
|
+
option: OverviewPeriodOption;
|
|
22
|
+
}
|
|
23
|
+
export declare function isOverviewPeriod(value: unknown): value is OverviewPeriodOption;
|
|
24
|
+
/** Whether a string is a day, `2026-11-17`, that exists. */
|
|
25
|
+
export declare function isDay(value: unknown): value is string;
|
|
26
|
+
/** The day of a date in the time zone of the browser (or of the runtime): `2026-11-17`. */
|
|
27
|
+
export declare function localDay(date?: Date): string;
|
|
28
|
+
/**
|
|
29
|
+
* The days of a period, both inclusive, ending `today` (decision 0084):
|
|
30
|
+
*
|
|
31
|
+
* - `7d`, `30d`, `90d`: the 7, 30 or 90 days ending today, today included;
|
|
32
|
+
* - `month`: the current calendar month, from its first day to today;
|
|
33
|
+
* - `year`: the last 12 months, the current month and the 11 before it, from the first day of the
|
|
34
|
+
* month 11 months ago to today.
|
|
35
|
+
*
|
|
36
|
+
* `today` is a day (`2026-11-17`), or a date read in the local time zone: the browser's, for the
|
|
37
|
+
* user.
|
|
38
|
+
*/
|
|
39
|
+
export declare function getPeriodRange(option: OverviewPeriodOption, today?: string | Date): PeriodRange;
|
|
40
|
+
/**
|
|
41
|
+
* The days a period is compared with, both inclusive (decision 0089): the change of a `metric` or a
|
|
42
|
+
* `table` is from them.
|
|
43
|
+
*
|
|
44
|
+
* - `7d`, `30d`, `90d`, and a range without an option: the same number of days, just before it;
|
|
45
|
+
* - `month`: the same days of the month before, to its last day when it is shorter (March 1 to 31
|
|
46
|
+
* after February 1 to 28);
|
|
47
|
+
* - `year`: the same days a year before.
|
|
48
|
+
*
|
|
49
|
+
* A backend computes `previous` of the data of a `metric` over these days.
|
|
50
|
+
*/
|
|
51
|
+
export declare function getPreviousRange(range: PeriodRange, option?: OverviewPeriodOption | null): PeriodRange;
|
|
52
|
+
/** The period an overview starts on: its `default`, or its first option. */
|
|
53
|
+
export declare function getDefaultPeriod(period: PeriodLike): OverviewPeriodOption | null;
|
|
54
|
+
/**
|
|
55
|
+
* The period chosen in a URL (`?period=90d`), when it is an option of the overview: else its
|
|
56
|
+
* default.
|
|
57
|
+
*/
|
|
58
|
+
export declare function readPeriodOption(value: string | null | undefined, period: PeriodLike): OverviewPeriodOption | null;
|
|
59
|
+
/** The option of an overview whose days are those of a range, if one is: else `null`. */
|
|
60
|
+
export declare function findPeriodOption(range: unknown, period: PeriodLike, today?: string | Date): OverviewPeriodOption | null;
|
|
61
|
+
//# sourceMappingURL=periods.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"periods.d.ts","sourceRoot":"","sources":["../src/periods.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,eAAO,MAAM,gBAAgB,gDAAiD,CAAC;AAE/E,MAAM,MAAM,oBAAoB,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC;AAErE,0FAA0F;AAC1F,eAAO,MAAM,YAAY,WAAW,CAAC;AAErC,yFAAyF;AACzF,MAAM,WAAW,UAAU;IACvB,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;IAC3B,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAChC;AAED,0EAA0E;AAC1E,MAAM,WAAW,WAAW;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;CACd;AAED,2FAA2F;AAC3F,MAAM,WAAW,YAAa,SAAQ,WAAW;IAC7C,MAAM,EAAE,oBAAoB,CAAC;CAChC;AAKD,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,oBAAoB,CAE9E;AAED,4DAA4D;AAC5D,wBAAgB,KAAK,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAUrD;AAED,2FAA2F;AAC3F,wBAAgB,QAAQ,CAAC,IAAI,GAAE,IAAiB,GAAG,MAAM,CAGxD;AAaD;;;;;;;;;;GAUG;AACH,wBAAgB,cAAc,CAC1B,MAAM,EAAE,oBAAoB,EAC5B,KAAK,GAAE,MAAM,GAAG,IAAiB,GAClC,WAAW,CAYb;AAQD;;;;;;;;;;GAUG;AACH,wBAAgB,gBAAgB,CAC5B,KAAK,EAAE,WAAW,EAClB,MAAM,CAAC,EAAE,oBAAoB,GAAG,IAAI,GACrC,WAAW,CA2Bb;AAED,4EAA4E;AAC5E,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,UAAU,GAAG,oBAAoB,GAAG,IAAI,CAGhF;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAC5B,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAChC,MAAM,EAAE,UAAU,GACnB,oBAAoB,GAAG,IAAI,CAI7B;AAED,yFAAyF;AACzF,wBAAgB,gBAAgB,CAC5B,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,UAAU,EAClB,KAAK,GAAE,MAAM,GAAG,IAAiB,GAClC,oBAAoB,GAAG,IAAI,CAW7B"}
|
package/dist/periods.js
ADDED
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
import { isFilterRange } from "./query.js";
|
|
2
|
+
//#region src/periods.ts
|
|
3
|
+
/**
|
|
4
|
+
* The periods an overview can offer (decision 0084): the 7, 30 or 90 days ending today, the current
|
|
5
|
+
* calendar month, and the last 12 months.
|
|
6
|
+
*/
|
|
7
|
+
var OVERVIEW_PERIODS = [
|
|
8
|
+
"7d",
|
|
9
|
+
"30d",
|
|
10
|
+
"90d",
|
|
11
|
+
"month",
|
|
12
|
+
"year"
|
|
13
|
+
];
|
|
14
|
+
/** The query parameter of the chosen period, in the URL of a dashboard page or a list. */
|
|
15
|
+
var PERIOD_PARAM = "period";
|
|
16
|
+
var DAY = /^(\d{4})-(\d{2})-(\d{2})$/;
|
|
17
|
+
var DAYS = {
|
|
18
|
+
"7d": 7,
|
|
19
|
+
"30d": 30,
|
|
20
|
+
"90d": 90
|
|
21
|
+
};
|
|
22
|
+
function isOverviewPeriod(value) {
|
|
23
|
+
return OVERVIEW_PERIODS.includes(value);
|
|
24
|
+
}
|
|
25
|
+
/** Whether a string is a day, `2026-11-17`, that exists. */
|
|
26
|
+
function isDay(value) {
|
|
27
|
+
if (typeof value !== "string") return false;
|
|
28
|
+
const match = DAY.exec(value);
|
|
29
|
+
if (match === null) return false;
|
|
30
|
+
return new Date(Date.UTC(Number(match[1]), Number(match[2]) - 1, Number(match[3]))).toISOString().slice(0, 10) === value;
|
|
31
|
+
}
|
|
32
|
+
/** The day of a date in the time zone of the browser (or of the runtime): `2026-11-17`. */
|
|
33
|
+
function localDay(date = /* @__PURE__ */ new Date()) {
|
|
34
|
+
const pad = (value) => String(value).padStart(2, "0");
|
|
35
|
+
return `${String(date.getFullYear())}-${pad(date.getMonth() + 1)}-${pad(date.getDate())}`;
|
|
36
|
+
}
|
|
37
|
+
/** A day as a date at midnight UTC, for the arithmetic of days. */
|
|
38
|
+
function utcDay(day) {
|
|
39
|
+
const match = DAY.exec(day);
|
|
40
|
+
if (match === null) throw new Error(`Not a day: ${day}.`);
|
|
41
|
+
return new Date(Date.UTC(Number(match[1]), Number(match[2]) - 1, Number(match[3])));
|
|
42
|
+
}
|
|
43
|
+
var toDay = (date) => date.toISOString().slice(0, 10);
|
|
44
|
+
/**
|
|
45
|
+
* The days of a period, both inclusive, ending `today` (decision 0084):
|
|
46
|
+
*
|
|
47
|
+
* - `7d`, `30d`, `90d`: the 7, 30 or 90 days ending today, today included;
|
|
48
|
+
* - `month`: the current calendar month, from its first day to today;
|
|
49
|
+
* - `year`: the last 12 months, the current month and the 11 before it, from the first day of the
|
|
50
|
+
* month 11 months ago to today.
|
|
51
|
+
*
|
|
52
|
+
* `today` is a day (`2026-11-17`), or a date read in the local time zone: the browser's, for the
|
|
53
|
+
* user.
|
|
54
|
+
*/
|
|
55
|
+
function getPeriodRange(option, today = /* @__PURE__ */ new Date()) {
|
|
56
|
+
const to = typeof today === "string" ? today : localDay(today);
|
|
57
|
+
const end = utcDay(to);
|
|
58
|
+
const days = DAYS[option];
|
|
59
|
+
if (days !== void 0) return {
|
|
60
|
+
from: toDay(/* @__PURE__ */ new Date(end.getTime() - (days - 1) * 864e5)),
|
|
61
|
+
to
|
|
62
|
+
};
|
|
63
|
+
const back = option === "year" ? 11 : 0;
|
|
64
|
+
return {
|
|
65
|
+
from: toDay(new Date(Date.UTC(end.getUTCFullYear(), end.getUTCMonth() - back, 1))),
|
|
66
|
+
to
|
|
67
|
+
};
|
|
68
|
+
}
|
|
69
|
+
var DAY_MS = 864e5;
|
|
70
|
+
/** The number of days of a month, of a year and a month from 0. */
|
|
71
|
+
var daysInMonth = (year, month) => new Date(Date.UTC(year, month + 1, 0)).getUTCDate();
|
|
72
|
+
/**
|
|
73
|
+
* The days a period is compared with, both inclusive (decision 0089): the change of a `metric` or a
|
|
74
|
+
* `table` is from them.
|
|
75
|
+
*
|
|
76
|
+
* - `7d`, `30d`, `90d`, and a range without an option: the same number of days, just before it;
|
|
77
|
+
* - `month`: the same days of the month before, to its last day when it is shorter (March 1 to 31
|
|
78
|
+
* after February 1 to 28);
|
|
79
|
+
* - `year`: the same days a year before.
|
|
80
|
+
*
|
|
81
|
+
* A backend computes `previous` of the data of a `metric` over these days.
|
|
82
|
+
*/
|
|
83
|
+
function getPreviousRange(range, option) {
|
|
84
|
+
const from = utcDay(range.from);
|
|
85
|
+
const to = utcDay(range.to);
|
|
86
|
+
if (option === "month" || option === "year") {
|
|
87
|
+
const back = option === "month" ? 1 : 12;
|
|
88
|
+
const shift = (date) => {
|
|
89
|
+
const year = date.getUTCFullYear();
|
|
90
|
+
const month = date.getUTCMonth() - back;
|
|
91
|
+
const target = new Date(Date.UTC(year, month, 1));
|
|
92
|
+
const last = daysInMonth(target.getUTCFullYear(), target.getUTCMonth());
|
|
93
|
+
return toDay(new Date(Date.UTC(target.getUTCFullYear(), target.getUTCMonth(), Math.min(date.getUTCDate(), last))));
|
|
94
|
+
};
|
|
95
|
+
return {
|
|
96
|
+
from: shift(from),
|
|
97
|
+
to: shift(to)
|
|
98
|
+
};
|
|
99
|
+
}
|
|
100
|
+
const days = Math.round((to.getTime() - from.getTime()) / DAY_MS) + 1;
|
|
101
|
+
return {
|
|
102
|
+
from: toDay(/* @__PURE__ */ new Date(from.getTime() - days * DAY_MS)),
|
|
103
|
+
to: toDay(/* @__PURE__ */ new Date(from.getTime() - DAY_MS))
|
|
104
|
+
};
|
|
105
|
+
}
|
|
106
|
+
/** The period an overview starts on: its `default`, or its first option. */
|
|
107
|
+
function getDefaultPeriod(period) {
|
|
108
|
+
const candidate = period.default ?? period.options[0];
|
|
109
|
+
return isOverviewPeriod(candidate) ? candidate : null;
|
|
110
|
+
}
|
|
111
|
+
/**
|
|
112
|
+
* The period chosen in a URL (`?period=90d`), when it is an option of the overview: else its
|
|
113
|
+
* default.
|
|
114
|
+
*/
|
|
115
|
+
function readPeriodOption(value, period) {
|
|
116
|
+
return isOverviewPeriod(value) && period.options.includes(value) ? value : getDefaultPeriod(period);
|
|
117
|
+
}
|
|
118
|
+
/** The option of an overview whose days are those of a range, if one is: else `null`. */
|
|
119
|
+
function findPeriodOption(range, period, today = /* @__PURE__ */ new Date()) {
|
|
120
|
+
if (!isFilterRange(range)) return null;
|
|
121
|
+
const { from, to } = range;
|
|
122
|
+
return period.options.filter(isOverviewPeriod).find((option) => {
|
|
123
|
+
const days = getPeriodRange(option, today);
|
|
124
|
+
return days.from === String(from) && days.to === String(to);
|
|
125
|
+
}) ?? null;
|
|
126
|
+
}
|
|
127
|
+
//#endregion
|
|
128
|
+
export { OVERVIEW_PERIODS, PERIOD_PARAM, findPeriodOption, getDefaultPeriod, getPeriodRange, getPreviousRange, isDay, isOverviewPeriod, localDay, readPeriodOption };
|
|
129
|
+
|
|
130
|
+
//# sourceMappingURL=periods.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"periods.js","names":[],"sources":["../src/periods.ts"],"sourcesContent":["import { type FilterRange, isFilterRange } from './query';\n\n/**\n * The periods an overview can offer (decision 0084): the 7, 30 or 90 days ending today, the current\n * calendar month, and the last 12 months.\n */\nexport const OVERVIEW_PERIODS = ['7d', '30d', '90d', 'month', 'year'] as const;\n\nexport type OverviewPeriodOption = (typeof OVERVIEW_PERIODS)[number];\n\n/** The query parameter of the chosen period, in the URL of a dashboard page or a list. */\nexport const PERIOD_PARAM = 'period';\n\n/** A period as the helpers read it: the `period` of a dashboard page or of a summary. */\nexport interface PeriodLike {\n options: readonly string[];\n default?: string | undefined;\n}\n\n/** The days of a period, both inclusive: `2026-10-19` to `2026-11-17`. */\nexport interface PeriodRange {\n from: string;\n to: string;\n}\n\n/** The chosen period of an overview, with its days, as widgets with an endpoint get it. */\nexport interface WidgetPeriod extends PeriodRange {\n option: OverviewPeriodOption;\n}\n\nconst DAY = /^(\\d{4})-(\\d{2})-(\\d{2})$/;\nconst DAYS: Record<string, number> = { '7d': 7, '30d': 30, '90d': 90 };\n\nexport function isOverviewPeriod(value: unknown): value is OverviewPeriodOption {\n return (OVERVIEW_PERIODS as readonly unknown[]).includes(value);\n}\n\n/** Whether a string is a day, `2026-11-17`, that exists. */\nexport function isDay(value: unknown): value is string {\n if (typeof value !== 'string') {\n return false;\n }\n const match = DAY.exec(value);\n if (match === null) {\n return false;\n }\n const date = new Date(Date.UTC(Number(match[1]), Number(match[2]) - 1, Number(match[3])));\n return date.toISOString().slice(0, 10) === value;\n}\n\n/** The day of a date in the time zone of the browser (or of the runtime): `2026-11-17`. */\nexport function localDay(date: Date = new Date()): string {\n const pad = (value: number) => String(value).padStart(2, '0');\n return `${String(date.getFullYear())}-${pad(date.getMonth() + 1)}-${pad(date.getDate())}`;\n}\n\n/** A day as a date at midnight UTC, for the arithmetic of days. */\nfunction utcDay(day: string): Date {\n const match = DAY.exec(day);\n if (match === null) {\n throw new Error(`Not a day: ${day}.`);\n }\n return new Date(Date.UTC(Number(match[1]), Number(match[2]) - 1, Number(match[3])));\n}\n\nconst toDay = (date: Date) => date.toISOString().slice(0, 10);\n\n/**\n * The days of a period, both inclusive, ending `today` (decision 0084):\n *\n * - `7d`, `30d`, `90d`: the 7, 30 or 90 days ending today, today included;\n * - `month`: the current calendar month, from its first day to today;\n * - `year`: the last 12 months, the current month and the 11 before it, from the first day of the\n * month 11 months ago to today.\n *\n * `today` is a day (`2026-11-17`), or a date read in the local time zone: the browser's, for the\n * user.\n */\nexport function getPeriodRange(\n option: OverviewPeriodOption,\n today: string | Date = new Date(),\n): PeriodRange {\n const to = typeof today === 'string' ? today : localDay(today);\n const end = utcDay(to);\n const days = DAYS[option];\n if (days !== undefined) {\n return { from: toDay(new Date(end.getTime() - (days - 1) * 86_400_000)), to };\n }\n const back = option === 'year' ? 11 : 0;\n return {\n from: toDay(new Date(Date.UTC(end.getUTCFullYear(), end.getUTCMonth() - back, 1))),\n to,\n };\n}\n\nconst DAY_MS = 86_400_000;\n\n/** The number of days of a month, of a year and a month from 0. */\nconst daysInMonth = (year: number, month: number) =>\n new Date(Date.UTC(year, month + 1, 0)).getUTCDate();\n\n/**\n * The days a period is compared with, both inclusive (decision 0089): the change of a `metric` or a\n * `table` is from them.\n *\n * - `7d`, `30d`, `90d`, and a range without an option: the same number of days, just before it;\n * - `month`: the same days of the month before, to its last day when it is shorter (March 1 to 31\n * after February 1 to 28);\n * - `year`: the same days a year before.\n *\n * A backend computes `previous` of the data of a `metric` over these days.\n */\nexport function getPreviousRange(\n range: PeriodRange,\n option?: OverviewPeriodOption | null,\n): PeriodRange {\n const from = utcDay(range.from);\n const to = utcDay(range.to);\n if (option === 'month' || option === 'year') {\n const back = option === 'month' ? 1 : 12;\n const shift = (date: Date) => {\n const year = date.getUTCFullYear();\n const month = date.getUTCMonth() - back;\n const target = new Date(Date.UTC(year, month, 1));\n const last = daysInMonth(target.getUTCFullYear(), target.getUTCMonth());\n return toDay(\n new Date(\n Date.UTC(\n target.getUTCFullYear(),\n target.getUTCMonth(),\n Math.min(date.getUTCDate(), last),\n ),\n ),\n );\n };\n return { from: shift(from), to: shift(to) };\n }\n const days = Math.round((to.getTime() - from.getTime()) / DAY_MS) + 1;\n return {\n from: toDay(new Date(from.getTime() - days * DAY_MS)),\n to: toDay(new Date(from.getTime() - DAY_MS)),\n };\n}\n\n/** The period an overview starts on: its `default`, or its first option. */\nexport function getDefaultPeriod(period: PeriodLike): OverviewPeriodOption | null {\n const candidate = period.default ?? period.options[0];\n return isOverviewPeriod(candidate) ? candidate : null;\n}\n\n/**\n * The period chosen in a URL (`?period=90d`), when it is an option of the overview: else its\n * default.\n */\nexport function readPeriodOption(\n value: string | null | undefined,\n period: PeriodLike,\n): OverviewPeriodOption | null {\n return isOverviewPeriod(value) && period.options.includes(value)\n ? value\n : getDefaultPeriod(period);\n}\n\n/** The option of an overview whose days are those of a range, if one is: else `null`. */\nexport function findPeriodOption(\n range: unknown,\n period: PeriodLike,\n today: string | Date = new Date(),\n): OverviewPeriodOption | null {\n if (!isFilterRange(range)) {\n return null;\n }\n const { from, to } = range as FilterRange;\n return (\n period.options.filter(isOverviewPeriod).find((option) => {\n const days = getPeriodRange(option, today);\n return days.from === String(from) && days.to === String(to);\n }) ?? null\n );\n}\n"],"mappings":";;;;;;AAMA,IAAa,mBAAmB;CAAC;CAAM;CAAO;CAAO;CAAS;AAAM;;AAKpE,IAAa,eAAe;AAmB5B,IAAM,MAAM;AACZ,IAAM,OAA+B;CAAE,MAAM;CAAG,OAAO;CAAI,OAAO;AAAG;AAErE,SAAgB,iBAAiB,OAA+C;CAC5E,OAAQ,iBAAwC,SAAS,KAAK;AAClE;;AAGA,SAAgB,MAAM,OAAiC;CACnD,IAAI,OAAO,UAAU,UACjB,OAAO;CAEX,MAAM,QAAQ,IAAI,KAAK,KAAK;CAC5B,IAAI,UAAU,MACV,OAAO;CAGX,OAAO,IADU,KAAK,KAAK,IAAI,OAAO,MAAM,EAAE,GAAG,OAAO,MAAM,EAAE,IAAI,GAAG,OAAO,MAAM,EAAE,CAAC,CAChF,CAAA,CAAK,YAAY,CAAC,CAAC,MAAM,GAAG,EAAE,MAAM;AAC/C;;AAGA,SAAgB,SAAS,uBAAa,IAAI,KAAK,GAAW;CACtD,MAAM,OAAO,UAAkB,OAAO,KAAK,CAAC,CAAC,SAAS,GAAG,GAAG;CAC5D,OAAO,GAAG,OAAO,KAAK,YAAY,CAAC,EAAE,GAAG,IAAI,KAAK,SAAS,IAAI,CAAC,EAAE,GAAG,IAAI,KAAK,QAAQ,CAAC;AAC1F;;AAGA,SAAS,OAAO,KAAmB;CAC/B,MAAM,QAAQ,IAAI,KAAK,GAAG;CAC1B,IAAI,UAAU,MACV,MAAM,IAAI,MAAM,cAAc,IAAI,EAAE;CAExC,OAAO,IAAI,KAAK,KAAK,IAAI,OAAO,MAAM,EAAE,GAAG,OAAO,MAAM,EAAE,IAAI,GAAG,OAAO,MAAM,EAAE,CAAC,CAAC;AACtF;AAEA,IAAM,SAAS,SAAe,KAAK,YAAY,CAAC,CAAC,MAAM,GAAG,EAAE;;;;;;;;;;;;AAa5D,SAAgB,eACZ,QACA,wBAAuB,IAAI,KAAK,GACrB;CACX,MAAM,KAAK,OAAO,UAAU,WAAW,QAAQ,SAAS,KAAK;CAC7D,MAAM,MAAM,OAAO,EAAE;CACrB,MAAM,OAAO,KAAK;CAClB,IAAI,SAAS,KAAA,GACT,OAAO;EAAE,MAAM,sBAAM,IAAI,KAAK,IAAI,QAAQ,KAAK,OAAO,KAAK,KAAU,CAAC;EAAG;CAAG;CAEhF,MAAM,OAAO,WAAW,SAAS,KAAK;CACtC,OAAO;EACH,MAAM,MAAM,IAAI,KAAK,KAAK,IAAI,IAAI,eAAe,GAAG,IAAI,YAAY,IAAI,MAAM,CAAC,CAAC,CAAC;EACjF;CACJ;AACJ;AAEA,IAAM,SAAS;;AAGf,IAAM,eAAe,MAAc,UAC/B,IAAI,KAAK,KAAK,IAAI,MAAM,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW;;;;;;;;;;;;AAatD,SAAgB,iBACZ,OACA,QACW;CACX,MAAM,OAAO,OAAO,MAAM,IAAI;CAC9B,MAAM,KAAK,OAAO,MAAM,EAAE;CAC1B,IAAI,WAAW,WAAW,WAAW,QAAQ;EACzC,MAAM,OAAO,WAAW,UAAU,IAAI;EACtC,MAAM,SAAS,SAAe;GAC1B,MAAM,OAAO,KAAK,eAAe;GACjC,MAAM,QAAQ,KAAK,YAAY,IAAI;GACnC,MAAM,SAAS,IAAI,KAAK,KAAK,IAAI,MAAM,OAAO,CAAC,CAAC;GAChD,MAAM,OAAO,YAAY,OAAO,eAAe,GAAG,OAAO,YAAY,CAAC;GACtE,OAAO,MACH,IAAI,KACA,KAAK,IACD,OAAO,eAAe,GACtB,OAAO,YAAY,GACnB,KAAK,IAAI,KAAK,WAAW,GAAG,IAAI,CACpC,CACJ,CACJ;EACJ;EACA,OAAO;GAAE,MAAM,MAAM,IAAI;GAAG,IAAI,MAAM,EAAE;EAAE;CAC9C;CACA,MAAM,OAAO,KAAK,OAAO,GAAG,QAAQ,IAAI,KAAK,QAAQ,KAAK,MAAM,IAAI;CACpE,OAAO;EACH,MAAM,sBAAM,IAAI,KAAK,KAAK,QAAQ,IAAI,OAAO,MAAM,CAAC;EACpD,IAAI,sBAAM,IAAI,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC;CAC/C;AACJ;;AAGA,SAAgB,iBAAiB,QAAiD;CAC9E,MAAM,YAAY,OAAO,WAAW,OAAO,QAAQ;CACnD,OAAO,iBAAiB,SAAS,IAAI,YAAY;AACrD;;;;;AAMA,SAAgB,iBACZ,OACA,QAC2B;CAC3B,OAAO,iBAAiB,KAAK,KAAK,OAAO,QAAQ,SAAS,KAAK,IACzD,QACA,iBAAiB,MAAM;AACjC;;AAGA,SAAgB,iBACZ,OACA,QACA,wBAAuB,IAAI,KAAK,GACL;CAC3B,IAAI,CAAC,cAAc,KAAK,GACpB,OAAO;CAEX,MAAM,EAAE,MAAM,OAAO;CACrB,OACI,OAAO,QAAQ,OAAO,gBAAgB,CAAC,CAAC,MAAM,WAAW;EACrD,MAAM,OAAO,eAAe,QAAQ,KAAK;EACzC,OAAO,KAAK,SAAS,OAAO,IAAI,KAAK,KAAK,OAAO,OAAO,EAAE;CAC9D,CAAC,KAAK;AAEd"}
|
package/dist/problem.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { Problem } from './schemas/api';
|
|
1
|
+
import type { Problem } from './schemas/api.js';
|
|
2
2
|
/**
|
|
3
3
|
* Whether a value is a problem details object (an API error). It checks the same shape as the
|
|
4
4
|
* `Problem` schema, without zod, so that UI packages can detect errors without loading the schemas.
|
package/dist/query.d.ts
CHANGED
|
@@ -18,12 +18,18 @@ export declare function isFilterRange(value: unknown): value is FilterRange;
|
|
|
18
18
|
* backend reads them. Numbers compare as numbers. Other values compare as strings, on the length of
|
|
19
19
|
* the bound, so that a day (`2026-01-31`) includes the times of that day (`2026-01-31T18:00:00Z`).
|
|
20
20
|
* An empty value is never in a range.
|
|
21
|
+
*
|
|
22
|
+
* A `daterange` value (`{ start, end }`) is in the range when it overlaps it: it starts on or
|
|
23
|
+
* before `to`, and ends on or after `from`. Its open bounds never limit the overlap (decision
|
|
24
|
+
* 0053).
|
|
21
25
|
*/
|
|
22
26
|
export declare function matchesFilterRange(value: unknown, range: FilterRange): boolean;
|
|
23
27
|
/** Query of a list request (`GET /resources/{resource}`). */
|
|
24
28
|
export interface ListQuery {
|
|
25
29
|
page?: number;
|
|
26
30
|
perPage?: number;
|
|
31
|
+
/** The page to get of a list whose `pagination` is `cursor`: `nextCursor` of the page before. */
|
|
32
|
+
cursor?: string;
|
|
27
33
|
/** Fields to sort by, in order. A `-` prefix sorts descending. */
|
|
28
34
|
sort?: string[];
|
|
29
35
|
filter?: Record<string, FilterValue>;
|
|
@@ -38,4 +44,16 @@ export declare function toSearchParams(query: ListQuery): URLSearchParams;
|
|
|
38
44
|
* bounds of a range (`filter[id][from]`, `filter[id][to]`) become a `FilterRange`.
|
|
39
45
|
*/
|
|
40
46
|
export declare function fromSearchParams(params: URLSearchParams): ListQuery;
|
|
47
|
+
/** The meta of a page of a list paged with cursors (`pagination: "cursor"`). */
|
|
48
|
+
export interface CursorPageMeta {
|
|
49
|
+
perPage: number;
|
|
50
|
+
nextCursor: string | null;
|
|
51
|
+
previousCursor?: string | null;
|
|
52
|
+
total?: number | null;
|
|
53
|
+
}
|
|
54
|
+
/**
|
|
55
|
+
* Whether the meta of a page of a list comes from a list paged with cursors (`nextCursor`), rather
|
|
56
|
+
* than numbered pages (`page`, `lastPage`, `total`).
|
|
57
|
+
*/
|
|
58
|
+
export declare function isCursorPage(meta: object): meta is CursorPageMeta;
|
|
41
59
|
//# sourceMappingURL=query.d.ts.map
|
package/dist/query.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"query.d.ts","sourceRoot":"","sources":["../src/query.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,WAAW;IACxB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACvB,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,MAAM,WAAW,GACnB,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,GAAG,WAAW,CAAC;AAE/E,8FAA8F;AAC9F,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,WAAW,CAElE;
|
|
1
|
+
{"version":3,"file":"query.d.ts","sourceRoot":"","sources":["../src/query.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,WAAW;IACxB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACvB,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,MAAM,WAAW,GACnB,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,GAAG,WAAW,CAAC;AAE/E,8FAA8F;AAC9F,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,WAAW,CAElE;AAqBD;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,GAAG,OAAO,CAkB9E;AAED,6DAA6D;AAC7D,MAAM,WAAW,SAAS;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,iGAAiG;IACjG,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kEAAkE;IAClE,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACrC,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,sCAAsC;IACtC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB;AAED,qEAAqE;AACrE,wBAAgB,cAAc,CAAC,KAAK,EAAE,SAAS,GAAG,eAAe,CAmChE;AAID;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,eAAe,GAAG,SAAS,CAsDnE;AAED,gFAAgF;AAChF,MAAM,WAAW,cAAc;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,IAAI,cAAc,CAEjE"}
|
package/dist/query.js
CHANGED
|
@@ -4,26 +4,43 @@ function isFilterRange(value) {
|
|
|
4
4
|
return value !== null && typeof value === "object" && !Array.isArray(value);
|
|
5
5
|
}
|
|
6
6
|
var RANGE_BOUNDS = ["from", "to"];
|
|
7
|
+
/** Compares a value with a bound: numbers as numbers, other values on the length of the bound. */
|
|
8
|
+
function compareBound(value, bound) {
|
|
9
|
+
if (typeof value === "number" || typeof bound === "number") return Number(value) - Number(bound);
|
|
10
|
+
const prefix = String(value).slice(0, bound.length);
|
|
11
|
+
return prefix < bound ? -1 : prefix > bound ? 1 : 0;
|
|
12
|
+
}
|
|
13
|
+
function isOpen(bound) {
|
|
14
|
+
return bound === void 0 || bound === "";
|
|
15
|
+
}
|
|
16
|
+
function isEmptyBound(value) {
|
|
17
|
+
return value === null || value === void 0 || value === "";
|
|
18
|
+
}
|
|
7
19
|
/**
|
|
8
20
|
* Whether a value is within the bounds of a range filter, both inclusive: the reference of how a
|
|
9
21
|
* backend reads them. Numbers compare as numbers. Other values compare as strings, on the length of
|
|
10
22
|
* the bound, so that a day (`2026-01-31`) includes the times of that day (`2026-01-31T18:00:00Z`).
|
|
11
23
|
* An empty value is never in a range.
|
|
24
|
+
*
|
|
25
|
+
* A `daterange` value (`{ start, end }`) is in the range when it overlaps it: it starts on or
|
|
26
|
+
* before `to`, and ends on or after `from`. Its open bounds never limit the overlap (decision
|
|
27
|
+
* 0053).
|
|
12
28
|
*/
|
|
13
29
|
function matchesFilterRange(value, range) {
|
|
14
|
-
if (value
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
return
|
|
19
|
-
}
|
|
20
|
-
return (range.from
|
|
30
|
+
if (isEmptyBound(value)) return false;
|
|
31
|
+
if (typeof value === "object" && !Array.isArray(value) && value !== null) {
|
|
32
|
+
const { start, end } = value;
|
|
33
|
+
if (isEmptyBound(start) && isEmptyBound(end)) return false;
|
|
34
|
+
return (isOpen(range.from) || isEmptyBound(end) || compareBound(end, range.from) >= 0) && (isOpen(range.to) || isEmptyBound(start) || compareBound(start, range.to) <= 0);
|
|
35
|
+
}
|
|
36
|
+
return (isOpen(range.from) || compareBound(value, range.from) >= 0) && (isOpen(range.to) || compareBound(value, range.to) <= 0);
|
|
21
37
|
}
|
|
22
38
|
/** Serializes a list query to the protocol's query string format. */
|
|
23
39
|
function toSearchParams(query) {
|
|
24
40
|
const params = new URLSearchParams();
|
|
25
41
|
if (query.page !== void 0) params.set("page", String(query.page));
|
|
26
42
|
if (query.perPage !== void 0) params.set("perPage", String(query.perPage));
|
|
43
|
+
if (query.cursor !== void 0 && query.cursor !== "") params.set("cursor", query.cursor);
|
|
27
44
|
if (query.sort !== void 0 && query.sort.length > 0) params.set("sort", query.sort.join(","));
|
|
28
45
|
Object.entries(query.filter ?? {}).forEach(([key, value]) => {
|
|
29
46
|
if (Array.isArray(value)) value.forEach((item) => params.append(`filter[${key}][]`, String(item)));
|
|
@@ -52,6 +69,8 @@ function fromSearchParams(params) {
|
|
|
52
69
|
if (page !== void 0) query.page = page;
|
|
53
70
|
const perPage = integer(params.get("perPage"));
|
|
54
71
|
if (perPage !== void 0) query.perPage = perPage;
|
|
72
|
+
const cursor = params.get("cursor");
|
|
73
|
+
if (cursor !== null && cursor !== "") query.cursor = cursor;
|
|
55
74
|
const sort = params.get("sort");
|
|
56
75
|
if (sort !== null && sort !== "") query.sort = sort.split(",").filter((part) => part !== "");
|
|
57
76
|
const q = params.get("q");
|
|
@@ -74,7 +93,14 @@ function fromSearchParams(params) {
|
|
|
74
93
|
});
|
|
75
94
|
return query;
|
|
76
95
|
}
|
|
96
|
+
/**
|
|
97
|
+
* Whether the meta of a page of a list comes from a list paged with cursors (`nextCursor`), rather
|
|
98
|
+
* than numbered pages (`page`, `lastPage`, `total`).
|
|
99
|
+
*/
|
|
100
|
+
function isCursorPage(meta) {
|
|
101
|
+
return "nextCursor" in meta;
|
|
102
|
+
}
|
|
77
103
|
//#endregion
|
|
78
|
-
export { fromSearchParams, isFilterRange, matchesFilterRange, toSearchParams };
|
|
104
|
+
export { fromSearchParams, isCursorPage, isFilterRange, matchesFilterRange, toSearchParams };
|
|
79
105
|
|
|
80
106
|
//# sourceMappingURL=query.js.map
|
package/dist/query.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"query.js","names":[],"sources":["../src/query.ts"],"sourcesContent":["/**\n * The bounds of a range filter (`date-range`), both inclusive. An open end is left out. Sent as\n * `filter[published_at][from]=2026-01-01&filter[published_at][to]=2026-01-31`.\n */\nexport interface FilterRange {\n from?: string | number;\n to?: string | number;\n}\n\n/**\n * The value of a filter: one value (`filter[status]=draft`), a list that matches any of its values\n * (`filter[tags][]=a&filter[tags][]=b`), or the bounds of a range.\n */\nexport type FilterValue =\n string | number | boolean | Array<string | number | boolean> | FilterRange;\n\n/** Whether a filter value is the bounds of a range, and not one value or a list of values. */\nexport function isFilterRange(value: unknown): value is FilterRange {\n return value !== null && typeof value === 'object' && !Array.isArray(value);\n}\n\nconst RANGE_BOUNDS = ['from', 'to'] as const;\n\n/**\n * Whether a value is within the bounds of a range filter, both inclusive: the reference of how a\n * backend reads them. Numbers compare as numbers. Other values compare as strings, on the length of\n * the bound, so that a day (`2026-01-31`) includes the times of that day (`2026-01-31T18:00:00Z`).\n * An empty value is never in a range.\n */\nexport function matchesFilterRange(value: unknown, range: FilterRange): boolean {\n if (value === null || value === undefined || value === '') {\n return false;\n }\n const compare = (bound: string | number): number => {\n if (typeof value === 'number' || typeof bound === 'number') {\n return Number(value) - Number(bound);\n }\n const prefix = String(value).slice(0, bound.length);\n return prefix < bound ? -1 : prefix > bound ? 1 : 0;\n };\n return (\n (range.from === undefined || range.from === '' || compare(range.from) >= 0) &&\n (range.to === undefined || range.to === '' || compare(range.to) <= 0)\n );\n}\n\n/** Query of a list request (`GET /resources/{resource}`). */\nexport interface ListQuery {\n page?: number;\n perPage?: number;\n /** Fields to sort by, in order. A `-` prefix sorts descending. */\n sort?: string[];\n filter?: Record<string, FilterValue>;\n q?: string;\n /** Fields to include in each item. */\n fields?: string[];\n}\n\n/** Serializes a list query to the protocol's query string format. */\nexport function toSearchParams(query: ListQuery): URLSearchParams {\n const params = new URLSearchParams();\n if (query.page !== undefined) {\n params.set('page', String(query.page));\n }\n if (query.perPage !== undefined) {\n params.set('perPage', String(query.perPage));\n }\n if (query.sort !== undefined && query.sort.length > 0) {\n params.set('sort', query.sort.join(','));\n }\n Object.entries(query.filter ?? {}).forEach(([key, value]) => {\n if (Array.isArray(value)) {\n value.forEach((item) => params.append(`filter[${key}][]`, String(item)));\n } else if (isFilterRange(value)) {\n RANGE_BOUNDS.forEach((bound) => {\n const limit = value[bound];\n if (limit !== undefined && limit !== '') {\n params.set(`filter[${key}][${bound}]`, String(limit));\n }\n });\n } else {\n params.set(`filter[${key}]`, String(value));\n }\n });\n if (query.q !== undefined && query.q !== '') {\n params.set('q', query.q);\n }\n if (query.fields !== undefined && query.fields.length > 0) {\n params.set('fields', query.fields.join(','));\n }\n return params;\n}\n\nconst FILTER_KEY = /^filter\\[([^\\]]+)\\](?:\\[(|from|to)\\])?$/;\n\n/**\n * Parses a list query from the protocol's query string format. Filter values stay strings, and the\n * bounds of a range (`filter[id][from]`, `filter[id][to]`) become a `FilterRange`.\n */\nexport function fromSearchParams(params: URLSearchParams): ListQuery {\n const query: ListQuery = {};\n const integer = (value: string | null): number | undefined => {\n if (value === null || !/^\\d+$/.test(value)) {\n return undefined;\n }\n return Number.parseInt(value, 10);\n };\n const page = integer(params.get('page'));\n if (page !== undefined) {\n query.page = page;\n }\n const perPage = integer(params.get('perPage'));\n if (perPage !== undefined) {\n query.perPage = perPage;\n }\n const sort = params.get('sort');\n if (sort !== null && sort !== '') {\n query.sort = sort.split(',').filter((part) => part !== '');\n }\n const q = params.get('q');\n if (q !== null && q !== '') {\n query.q = q;\n }\n const fields = params.get('fields');\n if (fields !== null && fields !== '') {\n query.fields = fields.split(',').filter((part) => part !== '');\n }\n params.forEach((value, key) => {\n const match = FILTER_KEY.exec(key);\n if (match?.[1] === undefined) {\n return;\n }\n query.filter ??= {};\n const name = match[1];\n const current = query.filter[name];\n if (match[2] === '') {\n query.filter[name] = [...(Array.isArray(current) ? current : []), value];\n } else if (match[2] !== undefined) {\n if (value !== '') {\n query.filter[name] = {\n ...(isFilterRange(current) ? current : {}),\n [match[2]]: value,\n };\n }\n } else {\n query.filter[name] = value;\n }\n });\n return query;\n}\n"],"mappings":";;AAiBA,SAAgB,cAAc,OAAsC;CAChE,OAAO,UAAU,QAAQ,OAAO,UAAU,YAAY,CAAC,MAAM,QAAQ,KAAK;AAC9E;AAEA,IAAM,eAAe,CAAC,QAAQ,IAAI;;;;;;;AAQlC,SAAgB,mBAAmB,OAAgB,OAA6B;CAC5E,IAAI,UAAU,QAAQ,UAAU,KAAA,KAAa,UAAU,IACnD,OAAO;CAEX,MAAM,WAAW,UAAmC;EAChD,IAAI,OAAO,UAAU,YAAY,OAAO,UAAU,UAC9C,OAAO,OAAO,KAAK,IAAI,OAAO,KAAK;EAEvC,MAAM,SAAS,OAAO,KAAK,CAAC,CAAC,MAAM,GAAG,MAAM,MAAM;EAClD,OAAO,SAAS,QAAQ,KAAK,SAAS,QAAQ,IAAI;CACtD;CACA,QACK,MAAM,SAAS,KAAA,KAAa,MAAM,SAAS,MAAM,QAAQ,MAAM,IAAI,KAAK,OACxE,MAAM,OAAO,KAAA,KAAa,MAAM,OAAO,MAAM,QAAQ,MAAM,EAAE,KAAK;AAE3E;;AAeA,SAAgB,eAAe,OAAmC;CAC9D,MAAM,SAAS,IAAI,gBAAgB;CACnC,IAAI,MAAM,SAAS,KAAA,GACf,OAAO,IAAI,QAAQ,OAAO,MAAM,IAAI,CAAC;CAEzC,IAAI,MAAM,YAAY,KAAA,GAClB,OAAO,IAAI,WAAW,OAAO,MAAM,OAAO,CAAC;CAE/C,IAAI,MAAM,SAAS,KAAA,KAAa,MAAM,KAAK,SAAS,GAChD,OAAO,IAAI,QAAQ,MAAM,KAAK,KAAK,GAAG,CAAC;CAE3C,OAAO,QAAQ,MAAM,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,WAAW;EACzD,IAAI,MAAM,QAAQ,KAAK,GACnB,MAAM,SAAS,SAAS,OAAO,OAAO,UAAU,IAAI,MAAM,OAAO,IAAI,CAAC,CAAC;OACpE,IAAI,cAAc,KAAK,GAC1B,aAAa,SAAS,UAAU;GAC5B,MAAM,QAAQ,MAAM;GACpB,IAAI,UAAU,KAAA,KAAa,UAAU,IACjC,OAAO,IAAI,UAAU,IAAI,IAAI,MAAM,IAAI,OAAO,KAAK,CAAC;EAE5D,CAAC;OAED,OAAO,IAAI,UAAU,IAAI,IAAI,OAAO,KAAK,CAAC;CAElD,CAAC;CACD,IAAI,MAAM,MAAM,KAAA,KAAa,MAAM,MAAM,IACrC,OAAO,IAAI,KAAK,MAAM,CAAC;CAE3B,IAAI,MAAM,WAAW,KAAA,KAAa,MAAM,OAAO,SAAS,GACpD,OAAO,IAAI,UAAU,MAAM,OAAO,KAAK,GAAG,CAAC;CAE/C,OAAO;AACX;AAEA,IAAM,aAAa;;;;;AAMnB,SAAgB,iBAAiB,QAAoC;CACjE,MAAM,QAAmB,CAAC;CAC1B,MAAM,WAAW,UAA6C;EAC1D,IAAI,UAAU,QAAQ,CAAC,QAAQ,KAAK,KAAK,GACrC;EAEJ,OAAO,OAAO,SAAS,OAAO,EAAE;CACpC;CACA,MAAM,OAAO,QAAQ,OAAO,IAAI,MAAM,CAAC;CACvC,IAAI,SAAS,KAAA,GACT,MAAM,OAAO;CAEjB,MAAM,UAAU,QAAQ,OAAO,IAAI,SAAS,CAAC;CAC7C,IAAI,YAAY,KAAA,GACZ,MAAM,UAAU;CAEpB,MAAM,OAAO,OAAO,IAAI,MAAM;CAC9B,IAAI,SAAS,QAAQ,SAAS,IAC1B,MAAM,OAAO,KAAK,MAAM,GAAG,CAAC,CAAC,QAAQ,SAAS,SAAS,EAAE;CAE7D,MAAM,IAAI,OAAO,IAAI,GAAG;CACxB,IAAI,MAAM,QAAQ,MAAM,IACpB,MAAM,IAAI;CAEd,MAAM,SAAS,OAAO,IAAI,QAAQ;CAClC,IAAI,WAAW,QAAQ,WAAW,IAC9B,MAAM,SAAS,OAAO,MAAM,GAAG,CAAC,CAAC,QAAQ,SAAS,SAAS,EAAE;CAEjE,OAAO,SAAS,OAAO,QAAQ;EAC3B,MAAM,QAAQ,WAAW,KAAK,GAAG;EACjC,IAAI,QAAQ,OAAO,KAAA,GACf;EAEJ,MAAM,WAAW,CAAC;EAClB,MAAM,OAAO,MAAM;EACnB,MAAM,UAAU,MAAM,OAAO;EAC7B,IAAI,MAAM,OAAO,IACb,MAAM,OAAO,QAAQ,CAAC,GAAI,MAAM,QAAQ,OAAO,IAAI,UAAU,CAAC,GAAI,KAAK;OACpE,IAAI,MAAM,OAAO,KAAA,GAChB;OAAA,UAAU,IACV,MAAM,OAAO,QAAQ;IACjB,GAAI,cAAc,OAAO,IAAI,UAAU,CAAC;KACvC,MAAM,KAAK;GAChB;EAAA,OAGJ,MAAM,OAAO,QAAQ;CAE7B,CAAC;CACD,OAAO;AACX"}
|
|
1
|
+
{"version":3,"file":"query.js","names":[],"sources":["../src/query.ts"],"sourcesContent":["/**\n * The bounds of a range filter (`date-range`), both inclusive. An open end is left out. Sent as\n * `filter[published_at][from]=2026-01-01&filter[published_at][to]=2026-01-31`.\n */\nexport interface FilterRange {\n from?: string | number;\n to?: string | number;\n}\n\n/**\n * The value of a filter: one value (`filter[status]=draft`), a list that matches any of its values\n * (`filter[tags][]=a&filter[tags][]=b`), or the bounds of a range.\n */\nexport type FilterValue =\n string | number | boolean | Array<string | number | boolean> | FilterRange;\n\n/** Whether a filter value is the bounds of a range, and not one value or a list of values. */\nexport function isFilterRange(value: unknown): value is FilterRange {\n return value !== null && typeof value === 'object' && !Array.isArray(value);\n}\n\nconst RANGE_BOUNDS = ['from', 'to'] as const;\n\n/** Compares a value with a bound: numbers as numbers, other values on the length of the bound. */\nfunction compareBound(value: unknown, bound: string | number): number {\n if (typeof value === 'number' || typeof bound === 'number') {\n return Number(value) - Number(bound);\n }\n const prefix = String(value).slice(0, bound.length);\n return prefix < bound ? -1 : prefix > bound ? 1 : 0;\n}\n\nfunction isOpen(bound: string | number | undefined): bound is undefined | '' {\n return bound === undefined || bound === '';\n}\n\nfunction isEmptyBound(value: unknown): boolean {\n return value === null || value === undefined || value === '';\n}\n\n/**\n * Whether a value is within the bounds of a range filter, both inclusive: the reference of how a\n * backend reads them. Numbers compare as numbers. Other values compare as strings, on the length of\n * the bound, so that a day (`2026-01-31`) includes the times of that day (`2026-01-31T18:00:00Z`).\n * An empty value is never in a range.\n *\n * A `daterange` value (`{ start, end }`) is in the range when it overlaps it: it starts on or\n * before `to`, and ends on or after `from`. Its open bounds never limit the overlap (decision\n * 0053).\n */\nexport function matchesFilterRange(value: unknown, range: FilterRange): boolean {\n if (isEmptyBound(value)) {\n return false;\n }\n if (typeof value === 'object' && !Array.isArray(value) && value !== null) {\n const { start, end } = value as { start?: unknown; end?: unknown };\n if (isEmptyBound(start) && isEmptyBound(end)) {\n return false;\n }\n return (\n (isOpen(range.from) || isEmptyBound(end) || compareBound(end, range.from) >= 0) &&\n (isOpen(range.to) || isEmptyBound(start) || compareBound(start, range.to) <= 0)\n );\n }\n return (\n (isOpen(range.from) || compareBound(value, range.from) >= 0) &&\n (isOpen(range.to) || compareBound(value, range.to) <= 0)\n );\n}\n\n/** Query of a list request (`GET /resources/{resource}`). */\nexport interface ListQuery {\n page?: number;\n perPage?: number;\n /** The page to get of a list whose `pagination` is `cursor`: `nextCursor` of the page before. */\n cursor?: string;\n /** Fields to sort by, in order. A `-` prefix sorts descending. */\n sort?: string[];\n filter?: Record<string, FilterValue>;\n q?: string;\n /** Fields to include in each item. */\n fields?: string[];\n}\n\n/** Serializes a list query to the protocol's query string format. */\nexport function toSearchParams(query: ListQuery): URLSearchParams {\n const params = new URLSearchParams();\n if (query.page !== undefined) {\n params.set('page', String(query.page));\n }\n if (query.perPage !== undefined) {\n params.set('perPage', String(query.perPage));\n }\n if (query.cursor !== undefined && query.cursor !== '') {\n params.set('cursor', query.cursor);\n }\n if (query.sort !== undefined && query.sort.length > 0) {\n params.set('sort', query.sort.join(','));\n }\n Object.entries(query.filter ?? {}).forEach(([key, value]) => {\n if (Array.isArray(value)) {\n value.forEach((item) => params.append(`filter[${key}][]`, String(item)));\n } else if (isFilterRange(value)) {\n RANGE_BOUNDS.forEach((bound) => {\n const limit = value[bound];\n if (limit !== undefined && limit !== '') {\n params.set(`filter[${key}][${bound}]`, String(limit));\n }\n });\n } else {\n params.set(`filter[${key}]`, String(value));\n }\n });\n if (query.q !== undefined && query.q !== '') {\n params.set('q', query.q);\n }\n if (query.fields !== undefined && query.fields.length > 0) {\n params.set('fields', query.fields.join(','));\n }\n return params;\n}\n\nconst FILTER_KEY = /^filter\\[([^\\]]+)\\](?:\\[(|from|to)\\])?$/;\n\n/**\n * Parses a list query from the protocol's query string format. Filter values stay strings, and the\n * bounds of a range (`filter[id][from]`, `filter[id][to]`) become a `FilterRange`.\n */\nexport function fromSearchParams(params: URLSearchParams): ListQuery {\n const query: ListQuery = {};\n const integer = (value: string | null): number | undefined => {\n if (value === null || !/^\\d+$/.test(value)) {\n return undefined;\n }\n return Number.parseInt(value, 10);\n };\n const page = integer(params.get('page'));\n if (page !== undefined) {\n query.page = page;\n }\n const perPage = integer(params.get('perPage'));\n if (perPage !== undefined) {\n query.perPage = perPage;\n }\n const cursor = params.get('cursor');\n if (cursor !== null && cursor !== '') {\n query.cursor = cursor;\n }\n const sort = params.get('sort');\n if (sort !== null && sort !== '') {\n query.sort = sort.split(',').filter((part) => part !== '');\n }\n const q = params.get('q');\n if (q !== null && q !== '') {\n query.q = q;\n }\n const fields = params.get('fields');\n if (fields !== null && fields !== '') {\n query.fields = fields.split(',').filter((part) => part !== '');\n }\n params.forEach((value, key) => {\n const match = FILTER_KEY.exec(key);\n if (match?.[1] === undefined) {\n return;\n }\n query.filter ??= {};\n const name = match[1];\n const current = query.filter[name];\n if (match[2] === '') {\n query.filter[name] = [...(Array.isArray(current) ? current : []), value];\n } else if (match[2] !== undefined) {\n if (value !== '') {\n query.filter[name] = {\n ...(isFilterRange(current) ? current : {}),\n [match[2]]: value,\n };\n }\n } else {\n query.filter[name] = value;\n }\n });\n return query;\n}\n\n/** The meta of a page of a list paged with cursors (`pagination: \"cursor\"`). */\nexport interface CursorPageMeta {\n perPage: number;\n nextCursor: string | null;\n previousCursor?: string | null;\n total?: number | null;\n}\n\n/**\n * Whether the meta of a page of a list comes from a list paged with cursors (`nextCursor`), rather\n * than numbered pages (`page`, `lastPage`, `total`).\n */\nexport function isCursorPage(meta: object): meta is CursorPageMeta {\n return 'nextCursor' in meta;\n}\n"],"mappings":";;AAiBA,SAAgB,cAAc,OAAsC;CAChE,OAAO,UAAU,QAAQ,OAAO,UAAU,YAAY,CAAC,MAAM,QAAQ,KAAK;AAC9E;AAEA,IAAM,eAAe,CAAC,QAAQ,IAAI;;AAGlC,SAAS,aAAa,OAAgB,OAAgC;CAClE,IAAI,OAAO,UAAU,YAAY,OAAO,UAAU,UAC9C,OAAO,OAAO,KAAK,IAAI,OAAO,KAAK;CAEvC,MAAM,SAAS,OAAO,KAAK,CAAC,CAAC,MAAM,GAAG,MAAM,MAAM;CAClD,OAAO,SAAS,QAAQ,KAAK,SAAS,QAAQ,IAAI;AACtD;AAEA,SAAS,OAAO,OAA6D;CACzE,OAAO,UAAU,KAAA,KAAa,UAAU;AAC5C;AAEA,SAAS,aAAa,OAAyB;CAC3C,OAAO,UAAU,QAAQ,UAAU,KAAA,KAAa,UAAU;AAC9D;;;;;;;;;;;AAYA,SAAgB,mBAAmB,OAAgB,OAA6B;CAC5E,IAAI,aAAa,KAAK,GAClB,OAAO;CAEX,IAAI,OAAO,UAAU,YAAY,CAAC,MAAM,QAAQ,KAAK,KAAK,UAAU,MAAM;EACtE,MAAM,EAAE,OAAO,QAAQ;EACvB,IAAI,aAAa,KAAK,KAAK,aAAa,GAAG,GACvC,OAAO;EAEX,QACK,OAAO,MAAM,IAAI,KAAK,aAAa,GAAG,KAAK,aAAa,KAAK,MAAM,IAAI,KAAK,OAC5E,OAAO,MAAM,EAAE,KAAK,aAAa,KAAK,KAAK,aAAa,OAAO,MAAM,EAAE,KAAK;CAErF;CACA,QACK,OAAO,MAAM,IAAI,KAAK,aAAa,OAAO,MAAM,IAAI,KAAK,OACzD,OAAO,MAAM,EAAE,KAAK,aAAa,OAAO,MAAM,EAAE,KAAK;AAE9D;;AAiBA,SAAgB,eAAe,OAAmC;CAC9D,MAAM,SAAS,IAAI,gBAAgB;CACnC,IAAI,MAAM,SAAS,KAAA,GACf,OAAO,IAAI,QAAQ,OAAO,MAAM,IAAI,CAAC;CAEzC,IAAI,MAAM,YAAY,KAAA,GAClB,OAAO,IAAI,WAAW,OAAO,MAAM,OAAO,CAAC;CAE/C,IAAI,MAAM,WAAW,KAAA,KAAa,MAAM,WAAW,IAC/C,OAAO,IAAI,UAAU,MAAM,MAAM;CAErC,IAAI,MAAM,SAAS,KAAA,KAAa,MAAM,KAAK,SAAS,GAChD,OAAO,IAAI,QAAQ,MAAM,KAAK,KAAK,GAAG,CAAC;CAE3C,OAAO,QAAQ,MAAM,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,WAAW;EACzD,IAAI,MAAM,QAAQ,KAAK,GACnB,MAAM,SAAS,SAAS,OAAO,OAAO,UAAU,IAAI,MAAM,OAAO,IAAI,CAAC,CAAC;OACpE,IAAI,cAAc,KAAK,GAC1B,aAAa,SAAS,UAAU;GAC5B,MAAM,QAAQ,MAAM;GACpB,IAAI,UAAU,KAAA,KAAa,UAAU,IACjC,OAAO,IAAI,UAAU,IAAI,IAAI,MAAM,IAAI,OAAO,KAAK,CAAC;EAE5D,CAAC;OAED,OAAO,IAAI,UAAU,IAAI,IAAI,OAAO,KAAK,CAAC;CAElD,CAAC;CACD,IAAI,MAAM,MAAM,KAAA,KAAa,MAAM,MAAM,IACrC,OAAO,IAAI,KAAK,MAAM,CAAC;CAE3B,IAAI,MAAM,WAAW,KAAA,KAAa,MAAM,OAAO,SAAS,GACpD,OAAO,IAAI,UAAU,MAAM,OAAO,KAAK,GAAG,CAAC;CAE/C,OAAO;AACX;AAEA,IAAM,aAAa;;;;;AAMnB,SAAgB,iBAAiB,QAAoC;CACjE,MAAM,QAAmB,CAAC;CAC1B,MAAM,WAAW,UAA6C;EAC1D,IAAI,UAAU,QAAQ,CAAC,QAAQ,KAAK,KAAK,GACrC;EAEJ,OAAO,OAAO,SAAS,OAAO,EAAE;CACpC;CACA,MAAM,OAAO,QAAQ,OAAO,IAAI,MAAM,CAAC;CACvC,IAAI,SAAS,KAAA,GACT,MAAM,OAAO;CAEjB,MAAM,UAAU,QAAQ,OAAO,IAAI,SAAS,CAAC;CAC7C,IAAI,YAAY,KAAA,GACZ,MAAM,UAAU;CAEpB,MAAM,SAAS,OAAO,IAAI,QAAQ;CAClC,IAAI,WAAW,QAAQ,WAAW,IAC9B,MAAM,SAAS;CAEnB,MAAM,OAAO,OAAO,IAAI,MAAM;CAC9B,IAAI,SAAS,QAAQ,SAAS,IAC1B,MAAM,OAAO,KAAK,MAAM,GAAG,CAAC,CAAC,QAAQ,SAAS,SAAS,EAAE;CAE7D,MAAM,IAAI,OAAO,IAAI,GAAG;CACxB,IAAI,MAAM,QAAQ,MAAM,IACpB,MAAM,IAAI;CAEd,MAAM,SAAS,OAAO,IAAI,QAAQ;CAClC,IAAI,WAAW,QAAQ,WAAW,IAC9B,MAAM,SAAS,OAAO,MAAM,GAAG,CAAC,CAAC,QAAQ,SAAS,SAAS,EAAE;CAEjE,OAAO,SAAS,OAAO,QAAQ;EAC3B,MAAM,QAAQ,WAAW,KAAK,GAAG;EACjC,IAAI,QAAQ,OAAO,KAAA,GACf;EAEJ,MAAM,WAAW,CAAC;EAClB,MAAM,OAAO,MAAM;EACnB,MAAM,UAAU,MAAM,OAAO;EAC7B,IAAI,MAAM,OAAO,IACb,MAAM,OAAO,QAAQ,CAAC,GAAI,MAAM,QAAQ,OAAO,IAAI,UAAU,CAAC,GAAI,KAAK;OACpE,IAAI,MAAM,OAAO,KAAA,GAChB;OAAA,UAAU,IACV,MAAM,OAAO,QAAQ;IACjB,GAAI,cAAc,OAAO,IAAI,UAAU,CAAC;KACvC,MAAM,KAAK;GAChB;EAAA,OAGJ,MAAM,OAAO,QAAQ;CAE7B,CAAC;CACD,OAAO;AACX;;;;;AAcA,SAAgB,aAAa,MAAsC;CAC/D,OAAO,gBAAgB;AAC3B"}
|