@cosmicdrift/kumiko-samples 0.410.0 → 0.412.0
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/package.json +1 -1
- package/packages/bundled-features/package.json +31 -1
- package/packages/bundled-features/src/agent-tools/agent-doc-lint.ts +64 -3
- package/packages/bundled-features/src/agent-tools/agent-manifest.ts +13 -130
- package/packages/bundled-features/src/agent-tools/api-docs/anchors.ts +60 -0
- package/packages/bundled-features/src/agent-tools/api-docs/check.ts +25 -0
- package/packages/bundled-features/src/agent-tools/api-docs/collect-events.ts +140 -0
- package/packages/bundled-features/src/agent-tools/api-docs/collect.ts +175 -0
- package/packages/bundled-features/src/agent-tools/api-docs/curl.ts +28 -0
- package/packages/bundled-features/src/agent-tools/api-docs/error-table.ts +45 -0
- package/packages/bundled-features/src/agent-tools/api-docs/examples.ts +43 -0
- package/packages/bundled-features/src/agent-tools/api-docs/generate.ts +179 -0
- package/packages/bundled-features/src/agent-tools/api-docs/index-json.ts +29 -0
- package/packages/bundled-features/src/agent-tools/api-docs/index.ts +21 -0
- package/packages/bundled-features/src/agent-tools/api-docs/list-parameters.ts +38 -0
- package/packages/bundled-features/src/agent-tools/api-docs/markdown.ts +70 -0
- package/packages/bundled-features/src/agent-tools/api-docs/menu-path.ts +82 -0
- package/packages/bundled-features/src/agent-tools/api-docs/model.ts +83 -0
- package/packages/bundled-features/src/agent-tools/api-docs/problems.ts +58 -0
- package/packages/bundled-features/src/agent-tools/api-docs/render-events.ts +76 -0
- package/packages/bundled-features/src/agent-tools/api-docs/render-openapi.ts +216 -0
- package/packages/bundled-features/src/agent-tools/api-docs/render-overview.ts +86 -0
- package/packages/bundled-features/src/agent-tools/api-docs/render-reference.ts +79 -0
- package/packages/bundled-features/src/agent-tools/api-docs/render-tokens.ts +136 -0
- package/packages/bundled-features/src/agent-tools/api-docs/schema-fields.ts +167 -0
- package/packages/bundled-features/src/agent-tools/api-docs/section-ids.ts +28 -0
- package/packages/bundled-features/src/agent-tools/api-docs/system-only.ts +11 -0
- package/packages/bundled-features/src/agent-tools/api-docs/texts/de.ts +166 -0
- package/packages/bundled-features/src/agent-tools/api-docs/texts/en.ts +159 -0
- package/packages/bundled-features/src/agent-tools/api-docs/texts/es.ts +162 -0
- package/packages/bundled-features/src/agent-tools/api-docs/texts/fr.ts +169 -0
- package/packages/bundled-features/src/agent-tools/api-docs/texts/index.ts +67 -0
- package/packages/bundled-features/src/agent-tools/api-docs/texts/it.ts +165 -0
- package/packages/bundled-features/src/agent-tools/api-docs/texts/types.ts +130 -0
- package/packages/bundled-features/src/agent-tools/api-docs/ui-writes.ts +81 -0
- package/packages/bundled-features/src/agent-tools/changes.json +24 -0
- package/packages/bundled-features/src/agent-tools/handler-schema.ts +45 -0
- package/packages/bundled-features/src/agent-tools/index.ts +24 -0
- package/packages/bundled-features/src/agent-tools/labels.ts +181 -0
- package/packages/bundled-features/src/auth-email-password/changes.json +24 -0
- package/packages/bundled-features/src/auth-email-password/seeding.ts +84 -6
- package/packages/bundled-features/src/auth-email-password/web/i18n.ts +1 -0
- package/packages/bundled-features/src/auth-email-password/web/signup-screen.tsx +48 -3
- package/packages/bundled-features/src/auth-email-password/web/static-account.ts +190 -0
- package/packages/bundled-features/src/auth-email-password/web/static-client.ts +226 -0
- package/packages/bundled-features/src/foundation-shared/demo-admin-env.ts +11 -0
- package/packages/bundled-features/src/foundation-shared/index.ts +5 -1
- package/packages/bundled-features/src/inbound-mail-foundation/changes.json +6 -0
- package/packages/bundled-features/src/inbound-mail-foundation/entities.ts +99 -71
- package/packages/bundled-features/src/inbound-mail-foundation/feature.ts +2 -2
- package/packages/bundled-features/src/inbound-provider-imap/changes.json +6 -0
- package/packages/bundled-features/src/inbound-provider-imap/imap-client.ts +3 -1
- package/packages/bundled-features/src/personal-access-tokens/changes.json +6 -0
- package/packages/bundled-features/src/personal-access-tokens/feature.ts +5 -2
- package/packages/bundled-features/src/personal-access-tokens/handlers/create.write.ts +7 -2
- package/packages/bundled-features/src/personal-access-tokens/i18n.ts +6 -1
- package/packages/bundled-features/src/personal-access-tokens/index.ts +37 -2
- package/packages/bundled-features/src/personal-access-tokens/scope-events-check.ts +28 -0
- package/packages/bundled-features/src/personal-access-tokens/screens.ts +9 -1
- package/packages/bundled-features/src/personal-access-tokens/web/constants.ts +1 -0
- package/packages/bundled-features/src/personal-access-tokens/web/scopes.ts +14 -0
- package/packages/bundled-features/src/presence/changes.json +8 -0
- package/packages/bundled-features/src/presence/feature.ts +25 -0
- package/packages/bundled-features/src/presence/handlers/heartbeat.write.ts +52 -0
- package/packages/bundled-features/src/presence/handlers/leave.write.ts +41 -0
- package/packages/bundled-features/src/presence/handlers/list.query.ts +39 -0
- package/packages/bundled-features/src/presence/index.ts +7 -0
- package/packages/bundled-features/src/presence/options.ts +30 -0
- package/packages/bundled-features/src/presence/payloads.ts +26 -0
- package/packages/bundled-features/src/presence/room.ts +65 -0
- package/packages/bundled-features/src/presence/store.ts +185 -0
- package/packages/bundled-features/src/sessions/feature.ts +6 -2
- package/packages/bundled-features/src/sessions/handlers/last-activity-probe.route.ts +19 -0
- package/packages/bundled-features/src/tenant-inactivity/changes.json +12 -0
- package/packages/bundled-features/src/tenant-inactivity/check-inactive-tenants.ts +14 -6
- package/packages/bundled-features/src/tenant-inactivity/constants.ts +4 -1
- package/packages/bundled-features/src/tenant-inactivity/handlers/inactivity-state.query.ts +2 -1
- package/packages/bundled-features/src/tenant-inactivity/handlers/keep-account.write.ts +2 -1
- package/packages/bundled-features/src/tenant-inactivity/options.ts +1 -0
- package/packages/bundled-features/src/tenant-inactivity/remote-activity.ts +6 -1
- package/packages/bundled-features/src/tenant-inactivity/static-keep-account.ts +37 -0
- package/packages/bundled-features/src/tenant-lifecycle/constants.ts +2 -0
- package/packages/bundled-features/src/tenant-lifecycle/handlers/cancel-destruction.write.ts +6 -2
- package/packages/bundled-features/src/tenant-lifecycle/handlers/request-destruction.write.ts +2 -1
- package/packages/bundled-features/src/tenant-lifecycle/index.ts +1 -0
- package/packages/bundled-features/src/waitlist/changes.json +6 -0
- package/packages/bundled-features/src/waitlist/static-submit.ts +56 -0
- package/samples/apps/styleguide/src/features/widgets/i18n.ts +143 -0
- package/samples/apps/styleguide/src/features/widgets/web/VariantsDemo.tsx +276 -0
- package/samples/apps/styleguide/src/features/widgets/web/Widgets.tsx +3 -0
- package/samples/apps/styleguide/src/features/workboard/feature.ts +1 -0
- package/samples/apps/use-all-bundled/feature-manifest.json +23 -1
- package/samples/apps/use-all-bundled/src/run-config.ts +3 -0
- package/samples/recipes/api-docs/README.md +52 -0
- package/samples/recipes/api-docs/api-docs/de/events.md +62 -0
- package/samples/recipes/api-docs/api-docs/de/overview.md +100 -0
- package/samples/recipes/api-docs/api-docs/de/reference/tickets.md +305 -0
- package/samples/recipes/api-docs/api-docs/de/tokens.md +66 -0
- package/samples/recipes/api-docs/api-docs/en/events.md +62 -0
- package/samples/recipes/api-docs/api-docs/en/overview.md +100 -0
- package/samples/recipes/api-docs/api-docs/en/reference/tickets.md +305 -0
- package/samples/recipes/api-docs/api-docs/en/tokens.md +66 -0
- package/samples/recipes/api-docs/api-docs/index.json +371 -0
- package/samples/recipes/api-docs/api-docs/openapi.json +982 -0
- package/samples/recipes/api-docs/api-examples/ticket-close.json +21 -0
- package/samples/recipes/api-docs/api-examples/ticket-create.json +42 -0
- package/samples/recipes/api-docs/api-examples/ticket-detail.json +28 -0
- package/samples/recipes/api-docs/api-examples/ticket-list.json +31 -0
- package/samples/recipes/api-docs/api-examples/ticket-update.json +54 -0
- package/samples/recipes/api-docs/api-examples/webhooks/ticket-closed.json +8 -0
- package/samples/recipes/api-docs/api-examples/webhooks/ticket-created.json +10 -0
- package/samples/recipes/api-docs/kumiko.config.ts +33 -0
- package/samples/recipes/api-docs/package.json +14 -0
- package/samples/recipes/api-docs/src/feature.ts +218 -0
- package/samples/recipes/api-docs/tsconfig.json +22 -0
- package/samples/recipes/realtime-sse/README.md +1 -0
- package/samples/recipes/realtime-sse/package.json +1 -0
- package/samples/recipes/realtime-sse/src/feature.ts +9 -0
- package/samples/recipes/record-detail-layout/README.md +1 -0
- package/samples/recipes/record-detail-layout/src/feature.ts +10 -0
- package/samples/recipes/wizard-form/README.md +9 -0
- package/samples/recipes/wizard-form/src/feature.ts +13 -2
|
@@ -0,0 +1,159 @@
|
|
|
1
|
+
import type { ApiDocsTexts } from "./types.ts";
|
|
2
|
+
|
|
3
|
+
export const enApiDocsTexts = {
|
|
4
|
+
text: {
|
|
5
|
+
"overview.title": "HTTP API",
|
|
6
|
+
"overview.description":
|
|
7
|
+
"Endpoints, request body, responses, error codes, lists and batches of the HTTP API.",
|
|
8
|
+
"overview.intro":
|
|
9
|
+
"Every call is a POST with a JSON body. The `type` field names the handler, `payload` carries its fields. The reference pages list every handler with its fields.",
|
|
10
|
+
"overview.endpoints.heading": "Endpoints",
|
|
11
|
+
"overview.endpoints.query": "Reads data. Never changes anything.",
|
|
12
|
+
"overview.endpoints.write": "Changes data: create, update, delete or a specific action.",
|
|
13
|
+
"overview.endpoints.batch": "Runs several write calls in one transaction.",
|
|
14
|
+
"overview.auth.heading": "Authentication",
|
|
15
|
+
"overview.auth.body":
|
|
16
|
+
"Send an API token in the `Authorization` header as `Bearer <token>`. Requests with a token need no cookie and no CSRF token. The token also fixes the account the request runs in, so you never send an account or tenant ID.",
|
|
17
|
+
"overview.body.heading": "Request body",
|
|
18
|
+
"overview.body.body":
|
|
19
|
+
"`type` is the handler name, for example `{exampleType}`. `payload` holds the fields from the reference. `requestId` is optional, see below. The payload may be nested at most {maxDepth} levels deep.",
|
|
20
|
+
"overview.responses.heading": "Responses",
|
|
21
|
+
"overview.responses.success":
|
|
22
|
+
"A successful read returns `data`. A successful write returns `isSuccess: true` and `data`.",
|
|
23
|
+
"overview.responses.error":
|
|
24
|
+
"On failure the HTTP status is 4xx or 5xx and the body contains `error`. Write calls also return `isSuccess: false`. Branch on `error.code` and the status. `message` is meant for people and may change.",
|
|
25
|
+
"overview.errors.heading": "Error codes",
|
|
26
|
+
"overview.errors.columns": "Code | HTTP status | Meaning",
|
|
27
|
+
"overview.versions.heading": "Versions and conflicts",
|
|
28
|
+
"overview.versions.body":
|
|
29
|
+
"Every record has a `version`. An update takes the `version` you read last. If someone changed the record in between, the call fails with 409 `version_conflict`. Read the record again, check the change and send it with the new version.",
|
|
30
|
+
"overview.lists.heading": "Lists",
|
|
31
|
+
"overview.lists.intro": "List handlers end in `:list` and accept these fields:",
|
|
32
|
+
"overview.lists.columns": "Field | Type | Description",
|
|
33
|
+
"overview.lists.response":
|
|
34
|
+
"The response contains `rows` and `nextCursor`. For the next page send `nextCursor` as `cursor`. On the last page `nextCursor` is `null`.",
|
|
35
|
+
"overview.batch.heading": "Batches",
|
|
36
|
+
"overview.batch.body":
|
|
37
|
+
"`POST /api/batch` takes `commands`, a list of `{ type, payload }` write calls. They run in one transaction: if one fails, none takes effect. The response then has `isSuccess: false`, the `error` and `failedIndex`, the position of the failed command counted from 0.",
|
|
38
|
+
"overview.retry.heading": "Safe retries",
|
|
39
|
+
"overview.retry.body":
|
|
40
|
+
"Send a `requestId` with write and batch calls, any string that is unique per change. If the connection drops and you send the same call again with the same `requestId`, you get the first result back and the change does not run twice.",
|
|
41
|
+
"tokens.title": "API tokens",
|
|
42
|
+
"tokens.description":
|
|
43
|
+
"Create an API token for {appName}, choose its scopes and send it with your requests.",
|
|
44
|
+
"tokens.intro":
|
|
45
|
+
"An API token lets a script or another service call the {appName} API in your name. Its scopes decide which data it may read or change.",
|
|
46
|
+
"tokens.create.heading": "Create a token",
|
|
47
|
+
"tokens.create.step1": "Open {menuPath}.",
|
|
48
|
+
"tokens.create.step2": "Choose **{createLabel}**.",
|
|
49
|
+
"tokens.create.step3":
|
|
50
|
+
"Enter a name, pick the scopes and the expiry, and confirm with your password.",
|
|
51
|
+
"tokens.create.step4": "Copy the token. It starts with `kpat_` and is shown only once.",
|
|
52
|
+
"tokens.expiry":
|
|
53
|
+
"A token expires after {defaultDays} days unless you pick another expiry. The longest possible expiry is {maxDays} days.",
|
|
54
|
+
"tokens.use.heading": "Use the token",
|
|
55
|
+
"tokens.use.body":
|
|
56
|
+
"Send the token in the `Authorization` header. Requests with a token need no cookie and no CSRF token.",
|
|
57
|
+
"tokens.scopes.heading": "Scopes",
|
|
58
|
+
"tokens.scopes.intro":
|
|
59
|
+
"Each scope comes in two levels. `read` allows the read handlers. `write` allows everything `read` allows plus the write handlers.",
|
|
60
|
+
"tokens.scopes.columns": "Scope | Grant | Handlers",
|
|
61
|
+
"tokens.rateLimit.heading": "Rate limit",
|
|
62
|
+
"tokens.rateLimit":
|
|
63
|
+
"Each token may send {max} requests per {windowSeconds} seconds. Above that the API answers 429 `pat_rate_limited`.",
|
|
64
|
+
"tokens.errors.heading": "Errors",
|
|
65
|
+
"tokens.errors.columns": "HTTP status | Code | Cause",
|
|
66
|
+
"tokens.errors.missing": "No `Authorization` header.",
|
|
67
|
+
"tokens.errors.invalid": "The token is unknown, revoked or expired.",
|
|
68
|
+
"tokens.errors.scope": "The token lacks the scope for this handler.",
|
|
69
|
+
"tokens.errors.route":
|
|
70
|
+
"The endpoint does not accept tokens. Tokens work only on the API endpoints.",
|
|
71
|
+
"tokens.errors.rate": "Too many requests from this token.",
|
|
72
|
+
"tokens.errors.disabled": "API tokens are not part of your plan.",
|
|
73
|
+
"tokens.revoke.heading": "Revoke a token",
|
|
74
|
+
"tokens.revoke.body":
|
|
75
|
+
"Revoke a token in {menuPath} as soon as you stop using it. Changing your password revokes all your tokens. A token always acts with your current roles. If you leave the account or your user is deleted, it stops working.",
|
|
76
|
+
"tokens.security.heading": "Security",
|
|
77
|
+
"tokens.security.item1":
|
|
78
|
+
"Treat a token like a password. Keep it in a secret store, never in code, a repository, an app or web page, or a log.",
|
|
79
|
+
"tokens.security.item2": "Give each script its own token with only the scopes it needs.",
|
|
80
|
+
"tokens.security.item3":
|
|
81
|
+
"Revoke tokens you no longer use. Revoke a token at once if it may have leaked.",
|
|
82
|
+
"reference.description":
|
|
83
|
+
"API reference for {scopeLabel}: every handler with its fields and an example.",
|
|
84
|
+
"reference.requiredScope": "Required scope",
|
|
85
|
+
"reference.endpoint": "Endpoint",
|
|
86
|
+
"reference.fields.columns": "Field | Type | Required | Description",
|
|
87
|
+
"reference.yes": "yes",
|
|
88
|
+
"reference.no": "no",
|
|
89
|
+
"reference.noFields": "This handler takes no fields.",
|
|
90
|
+
"reference.excluded": "Not settable through the API: {fields}.",
|
|
91
|
+
"reference.exampleRequest": "Example request",
|
|
92
|
+
"reference.exampleResponse": "Example response",
|
|
93
|
+
"reference.status": "Status: {status}",
|
|
94
|
+
"events.title": "Webhook events",
|
|
95
|
+
"events.description":
|
|
96
|
+
"Webhook events: when they fire, which scope they need and what their payload contains.",
|
|
97
|
+
"events.intro":
|
|
98
|
+
"A webhook event tells your system that something changed. Every event has a name, a version and a payload. The scope listed for an event is the token scope that allows subscribing to it.",
|
|
99
|
+
"events.delivery.heading": "Delivery",
|
|
100
|
+
"events.versions.heading": "Versions",
|
|
101
|
+
"events.versions.body":
|
|
102
|
+
"Adding an optional field keeps the version. A breaking change, such as removing or renaming a field or changing its type, gets a new version.",
|
|
103
|
+
"events.list.heading": "Events",
|
|
104
|
+
"events.version": "Version",
|
|
105
|
+
"events.requiredScope": "Required scope",
|
|
106
|
+
"events.example": "Example payload",
|
|
107
|
+
"events.noFields": "This event carries no fields.",
|
|
108
|
+
"events.entity.created": "A record of type {entity} was created.",
|
|
109
|
+
"events.entity.updated": "A record of type {entity} was updated.",
|
|
110
|
+
"events.entity.deleted": "A record of type {entity} was deleted.",
|
|
111
|
+
},
|
|
112
|
+
errorMeanings: {
|
|
113
|
+
validation_error:
|
|
114
|
+
"The payload does not match the handler's fields. `details` names the fields.",
|
|
115
|
+
unauthenticated: "No valid credentials were sent.",
|
|
116
|
+
missing_token: "The `Authorization` header is missing.",
|
|
117
|
+
invalid_token: "The token is unknown, revoked or expired.",
|
|
118
|
+
ambiguous_auth: "The request carried both a session cookie and a token. Send only one.",
|
|
119
|
+
access_denied:
|
|
120
|
+
"The token lacks the scope for this handler, or the endpoint does not accept tokens.",
|
|
121
|
+
feature_disabled: "This function is switched off or not part of your plan.",
|
|
122
|
+
not_found: "The record does not exist or you cannot see it.",
|
|
123
|
+
conflict: "The change conflicts with the current state of the data.",
|
|
124
|
+
version_conflict:
|
|
125
|
+
"The record changed after you read it. Read it again and retry with the new `version`.",
|
|
126
|
+
precondition_failed:
|
|
127
|
+
"A field of the record no longer has the value the change expected. Read the record again and retry.",
|
|
128
|
+
record_locked: "Another change holds a lock on the record. Retry shortly.",
|
|
129
|
+
idempotent_replay:
|
|
130
|
+
"This change was already applied under the same idempotency key. The first attempt succeeded, so do not send it again.",
|
|
131
|
+
unique_violation: "A record with this value already exists.",
|
|
132
|
+
unprocessable:
|
|
133
|
+
"The data is valid, but a business rule rejects the change. `details.reason` names the rule.",
|
|
134
|
+
unconfigured:
|
|
135
|
+
"A setting this function needs is still empty. Set it up in the app first, then retry.",
|
|
136
|
+
internal_error: "Unexpected server error. Retry later.",
|
|
137
|
+
member_read_timeout: "A read on the server took too long and was stopped. Retry later.",
|
|
138
|
+
rate_limited: "Too many requests. Wait as many seconds as the `Retry-After` header says.",
|
|
139
|
+
rate_limit_unavailable:
|
|
140
|
+
"The rate limiter is temporarily unavailable, so the request was refused. Retry shortly.",
|
|
141
|
+
pat_rate_limited: "This token sent too many requests in a short time. Wait a moment and retry.",
|
|
142
|
+
},
|
|
143
|
+
listParameters: {
|
|
144
|
+
cursor: "Position from `nextCursor` of the previous page.",
|
|
145
|
+
limit: "Rows per page, {default} by default, at most {max}.",
|
|
146
|
+
search: "Full-text search across the searchable fields.",
|
|
147
|
+
sort: "Field to sort by.",
|
|
148
|
+
sortDirection: "`asc` or `desc`.",
|
|
149
|
+
offset: "Number of rows to skip. Prefer `cursor` for paging.",
|
|
150
|
+
totalCount: "Set `true` to also get `total`, the number of matching rows.",
|
|
151
|
+
includeDeleted: "Set `true` to include deleted rows. Only for entities with soft delete.",
|
|
152
|
+
onlyDeleted:
|
|
153
|
+
"Set `true` to return only deleted rows. Only for entities with soft delete, not together with `includeDeleted`.",
|
|
154
|
+
filter: "One field filter with `field`, `op` and `value`. `op` is one of {ops}.",
|
|
155
|
+
filters: "Several field filters, each with `field`, `op` and `value`. `op` is one of {ops}.",
|
|
156
|
+
namedFilter: "Name of a predefined filter of the entity, for example a work queue.",
|
|
157
|
+
aggregate: "Returns aggregated values instead of rows.",
|
|
158
|
+
},
|
|
159
|
+
} as const satisfies ApiDocsTexts;
|
|
@@ -0,0 +1,162 @@
|
|
|
1
|
+
import type { ApiDocsTexts } from "./types.ts";
|
|
2
|
+
|
|
3
|
+
export const esApiDocsTexts = {
|
|
4
|
+
text: {
|
|
5
|
+
"overview.title": "API HTTP",
|
|
6
|
+
"overview.description":
|
|
7
|
+
"Endpoints, cuerpo de la petición, respuestas, códigos de error, listas y lotes de la API HTTP.",
|
|
8
|
+
"overview.intro":
|
|
9
|
+
"Cada llamada es un POST con cuerpo JSON. El campo `type` nombra el handler y `payload` contiene sus campos. Las páginas de referencia listan cada handler con sus campos.",
|
|
10
|
+
"overview.endpoints.heading": "Endpoints",
|
|
11
|
+
"overview.endpoints.query": "Lee datos. Nunca cambia nada.",
|
|
12
|
+
"overview.endpoints.write": "Cambia datos: crear, actualizar, eliminar o una acción concreta.",
|
|
13
|
+
"overview.endpoints.batch": "Ejecuta varias llamadas de escritura en una transacción.",
|
|
14
|
+
"overview.auth.heading": "Autenticación",
|
|
15
|
+
"overview.auth.body":
|
|
16
|
+
"Envía un token de API en la cabecera `Authorization` como `Bearer <token>`. Las peticiones con token no necesitan cookie ni token CSRF. El token también fija la cuenta en la que se ejecuta la petición, así que nunca envías un ID de cuenta o de tenant.",
|
|
17
|
+
"overview.body.heading": "Cuerpo de la petición",
|
|
18
|
+
"overview.body.body":
|
|
19
|
+
"`type` es el nombre del handler, por ejemplo `{exampleType}`. `payload` contiene los campos de la referencia. `requestId` es opcional, ver más abajo. El payload puede anidarse como máximo {maxDepth} niveles.",
|
|
20
|
+
"overview.responses.heading": "Respuestas",
|
|
21
|
+
"overview.responses.success":
|
|
22
|
+
"Una lectura correcta devuelve `data`. Una escritura correcta devuelve `isSuccess: true` y `data`.",
|
|
23
|
+
"overview.responses.error":
|
|
24
|
+
"Si falla, el estado HTTP es 4xx o 5xx y el cuerpo contiene `error`. Las llamadas de escritura devuelven además `isSuccess: false`. Decide según `error.code` y el estado. `message` está pensado para personas y puede cambiar.",
|
|
25
|
+
"overview.errors.heading": "Códigos de error",
|
|
26
|
+
"overview.errors.columns": "Código | Estado HTTP | Significado",
|
|
27
|
+
"overview.versions.heading": "Versiones y conflictos",
|
|
28
|
+
"overview.versions.body":
|
|
29
|
+
"Cada registro tiene una `version`. Una actualización usa la `version` que leíste por última vez. Si alguien cambió el registro entretanto, la llamada falla con 409 `version_conflict`. Vuelve a leer el registro, revisa el cambio y envíalo con la nueva versión.",
|
|
30
|
+
"overview.lists.heading": "Listas",
|
|
31
|
+
"overview.lists.intro": "Los handlers de lista terminan en `:list` y aceptan estos campos:",
|
|
32
|
+
"overview.lists.columns": "Campo | Tipo | Descripción",
|
|
33
|
+
"overview.lists.response":
|
|
34
|
+
"La respuesta contiene `rows` y `nextCursor`. Para la página siguiente envía `nextCursor` como `cursor`. En la última página `nextCursor` es `null`.",
|
|
35
|
+
"overview.batch.heading": "Lotes",
|
|
36
|
+
"overview.batch.body":
|
|
37
|
+
"`POST /api/batch` recibe `commands`, una lista de llamadas de escritura `{ type, payload }`. Se ejecutan en una transacción: si una falla, ninguna surte efecto. La respuesta tiene entonces `isSuccess: false`, el `error` y `failedIndex`, la posición del comando fallido contada desde 0.",
|
|
38
|
+
"overview.retry.heading": "Reintentos seguros",
|
|
39
|
+
"overview.retry.body":
|
|
40
|
+
"Envía un `requestId` en las llamadas de escritura y de lote, cualquier cadena única por cambio. Si se corta la conexión y vuelves a enviar la misma llamada con el mismo `requestId`, recibes el primer resultado y el cambio no se ejecuta dos veces.",
|
|
41
|
+
"tokens.title": "Tokens de API",
|
|
42
|
+
"tokens.description":
|
|
43
|
+
"Crea un token de API para {appName}, elige sus scopes y envíalo con tus peticiones.",
|
|
44
|
+
"tokens.intro":
|
|
45
|
+
"Un token de API permite que un script u otro servicio llame a la API de {appName} en tu nombre. Sus scopes deciden qué datos puede leer o cambiar.",
|
|
46
|
+
"tokens.create.heading": "Crear un token",
|
|
47
|
+
"tokens.create.step1": "Abre {menuPath}.",
|
|
48
|
+
"tokens.create.step2": "Elige **{createLabel}**.",
|
|
49
|
+
"tokens.create.step3":
|
|
50
|
+
"Introduce un nombre, elige los scopes y la caducidad, y confirma con tu contraseña.",
|
|
51
|
+
"tokens.create.step4": "Copia el token. Empieza por `kpat_` y se muestra una sola vez.",
|
|
52
|
+
"tokens.expiry":
|
|
53
|
+
"Un token caduca a los {defaultDays} días si no eliges otra caducidad. La caducidad máxima posible es de {maxDays} días.",
|
|
54
|
+
"tokens.use.heading": "Usar el token",
|
|
55
|
+
"tokens.use.body":
|
|
56
|
+
"Envía el token en la cabecera `Authorization`. Las peticiones con token no necesitan cookie ni token CSRF.",
|
|
57
|
+
"tokens.scopes.heading": "Scopes",
|
|
58
|
+
"tokens.scopes.intro":
|
|
59
|
+
"Cada scope tiene dos niveles. `read` permite los handlers de lectura. `write` permite todo lo que permite `read` y además los handlers de escritura.",
|
|
60
|
+
"tokens.scopes.columns": "Scope | Permiso | Handlers",
|
|
61
|
+
"tokens.rateLimit.heading": "Límite de peticiones",
|
|
62
|
+
"tokens.rateLimit":
|
|
63
|
+
"Cada token puede enviar {max} peticiones cada {windowSeconds} segundos. Por encima, la API responde 429 `pat_rate_limited`.",
|
|
64
|
+
"tokens.errors.heading": "Errores",
|
|
65
|
+
"tokens.errors.columns": "Estado HTTP | Código | Causa",
|
|
66
|
+
"tokens.errors.missing": "Falta la cabecera `Authorization`.",
|
|
67
|
+
"tokens.errors.invalid": "El token es desconocido, está revocado o ha caducado.",
|
|
68
|
+
"tokens.errors.scope": "Al token le falta el scope para este handler.",
|
|
69
|
+
"tokens.errors.route":
|
|
70
|
+
"El endpoint no acepta tokens. Los tokens solo funcionan en los endpoints de la API.",
|
|
71
|
+
"tokens.errors.rate": "Demasiadas peticiones con este token.",
|
|
72
|
+
"tokens.errors.disabled": "Los tokens de API no forman parte de tu plan.",
|
|
73
|
+
"tokens.revoke.heading": "Revocar un token",
|
|
74
|
+
"tokens.revoke.body":
|
|
75
|
+
"Revoca un token en {menuPath} en cuanto dejes de usarlo. Al cambiar tu contraseña se revocan todos tus tokens. Un token actúa siempre con tus roles actuales. Si abandonas la cuenta o se elimina tu usuario, deja de funcionar.",
|
|
76
|
+
"tokens.security.heading": "Seguridad",
|
|
77
|
+
"tokens.security.item1":
|
|
78
|
+
"Trata un token como una contraseña. Guárdalo en un almacén de secretos, nunca en el código, en un repositorio, en una app o página web ni en un log.",
|
|
79
|
+
"tokens.security.item2": "Da a cada script su propio token, solo con los scopes que necesita.",
|
|
80
|
+
"tokens.security.item3":
|
|
81
|
+
"Revoca los tokens que ya no uses. Revoca un token de inmediato si puede haberse filtrado.",
|
|
82
|
+
"reference.description":
|
|
83
|
+
"Referencia de la API para {scopeLabel}: cada handler con sus campos y un ejemplo.",
|
|
84
|
+
"reference.requiredScope": "Scope necesario",
|
|
85
|
+
"reference.endpoint": "Endpoint",
|
|
86
|
+
"reference.fields.columns": "Campo | Tipo | Obligatorio | Descripción",
|
|
87
|
+
"reference.yes": "sí",
|
|
88
|
+
"reference.no": "no",
|
|
89
|
+
"reference.noFields": "Este handler no recibe campos.",
|
|
90
|
+
"reference.excluded": "No se pueden establecer mediante la API: {fields}.",
|
|
91
|
+
"reference.exampleRequest": "Petición de ejemplo",
|
|
92
|
+
"reference.exampleResponse": "Respuesta de ejemplo",
|
|
93
|
+
"reference.status": "Estado: {status}",
|
|
94
|
+
"events.title": "Eventos de webhook",
|
|
95
|
+
"events.description":
|
|
96
|
+
"Eventos de webhook: cuándo se envían, qué scope necesitan y qué contiene su carga.",
|
|
97
|
+
"events.intro":
|
|
98
|
+
"Un evento de webhook avisa a tu sistema de que algo ha cambiado. Cada evento tiene un nombre, una versión y una carga. El scope indicado en un evento es el scope de token que permite suscribirse a él.",
|
|
99
|
+
"events.delivery.heading": "Entrega",
|
|
100
|
+
"events.versions.heading": "Versiones",
|
|
101
|
+
"events.versions.body":
|
|
102
|
+
"Añadir un campo opcional mantiene la versión. Un cambio incompatible, como quitar o renombrar un campo o cambiar su tipo, recibe una versión nueva.",
|
|
103
|
+
"events.list.heading": "Eventos",
|
|
104
|
+
"events.version": "Versión",
|
|
105
|
+
"events.requiredScope": "Scope necesario",
|
|
106
|
+
"events.example": "Carga de ejemplo",
|
|
107
|
+
"events.noFields": "Este evento no contiene campos.",
|
|
108
|
+
"events.entity.created": "Se creó un registro de tipo {entity}.",
|
|
109
|
+
"events.entity.updated": "Se actualizó un registro de tipo {entity}.",
|
|
110
|
+
"events.entity.deleted": "Se eliminó un registro de tipo {entity}.",
|
|
111
|
+
},
|
|
112
|
+
errorMeanings: {
|
|
113
|
+
validation_error:
|
|
114
|
+
"El payload no coincide con los campos del handler. `details` nombra los campos.",
|
|
115
|
+
unauthenticated: "No se enviaron credenciales válidas.",
|
|
116
|
+
missing_token: "Falta la cabecera `Authorization`.",
|
|
117
|
+
invalid_token: "El token es desconocido, está revocado o ha caducado.",
|
|
118
|
+
ambiguous_auth: "La petición llevaba cookie de sesión y token. Envía solo uno de los dos.",
|
|
119
|
+
access_denied: "Al token le falta el scope para este handler, o el endpoint no acepta tokens.",
|
|
120
|
+
feature_disabled: "Esta función está desactivada o no forma parte de tu plan.",
|
|
121
|
+
not_found: "El registro no existe o no puedes verlo.",
|
|
122
|
+
conflict: "El cambio entra en conflicto con el estado actual de los datos.",
|
|
123
|
+
version_conflict:
|
|
124
|
+
"El registro cambió después de leerlo. Léelo de nuevo y reintenta con la nueva `version`.",
|
|
125
|
+
precondition_failed:
|
|
126
|
+
"Un campo del registro ya no tiene el valor que esperaba el cambio. Vuelve a leer el registro y reintenta.",
|
|
127
|
+
record_locked: "Otro cambio bloquea el registro. Reintenta en un momento.",
|
|
128
|
+
idempotent_replay:
|
|
129
|
+
"Este cambio ya se aplicó con la misma clave de idempotencia. El primer intento tuvo éxito, así que no lo envíes otra vez.",
|
|
130
|
+
unique_violation: "Ya existe un registro con este valor.",
|
|
131
|
+
unprocessable:
|
|
132
|
+
"Los datos son válidos, pero una regla de negocio rechaza el cambio. `details.reason` nombra la regla.",
|
|
133
|
+
unconfigured:
|
|
134
|
+
"Un ajuste que necesita esta función sigue vacío. Configúralo primero en la app y reintenta.",
|
|
135
|
+
internal_error: "Error inesperado del servidor. Reintenta más tarde.",
|
|
136
|
+
member_read_timeout:
|
|
137
|
+
"Una lectura en el servidor tardó demasiado y se detuvo. Reintenta más tarde.",
|
|
138
|
+
rate_limited:
|
|
139
|
+
"Demasiadas peticiones. Espera los segundos que indica la cabecera `Retry-After`.",
|
|
140
|
+
rate_limit_unavailable:
|
|
141
|
+
"El límite de frecuencia no está disponible temporalmente y se rechazó la petición. Reintenta en un momento.",
|
|
142
|
+
pat_rate_limited:
|
|
143
|
+
"Este token envió demasiadas peticiones en poco tiempo. Espera un momento y reintenta.",
|
|
144
|
+
},
|
|
145
|
+
listParameters: {
|
|
146
|
+
cursor: "Posición de `nextCursor` de la página anterior.",
|
|
147
|
+
limit: "Filas por página, {default} por defecto, como máximo {max}.",
|
|
148
|
+
search: "Búsqueda de texto completo en los campos con búsqueda.",
|
|
149
|
+
sort: "Campo por el que ordenar.",
|
|
150
|
+
sortDirection: "`asc` o `desc`.",
|
|
151
|
+
offset: "Número de filas que se omiten. Para paginar es mejor `cursor`.",
|
|
152
|
+
totalCount: "Con `true` recibes además `total`, el número de filas que coinciden.",
|
|
153
|
+
includeDeleted:
|
|
154
|
+
"Con `true` se incluyen las filas eliminadas. Solo para entidades con borrado lógico.",
|
|
155
|
+
onlyDeleted:
|
|
156
|
+
"Con `true` solo se devuelven las filas eliminadas. Solo para entidades con borrado lógico, no junto con `includeDeleted`.",
|
|
157
|
+
filter: "Un filtro de campo con `field`, `op` y `value`. `op` es uno de {ops}.",
|
|
158
|
+
filters: "Varios filtros de campo, cada uno con `field`, `op` y `value`. `op` es uno de {ops}.",
|
|
159
|
+
namedFilter: "Nombre de un filtro predefinido de la entidad, por ejemplo una cola de trabajo.",
|
|
160
|
+
aggregate: "Devuelve valores agregados en lugar de filas.",
|
|
161
|
+
},
|
|
162
|
+
} as const satisfies ApiDocsTexts;
|
|
@@ -0,0 +1,169 @@
|
|
|
1
|
+
import type { ApiDocsTexts } from "./types.ts";
|
|
2
|
+
|
|
3
|
+
export const frApiDocsTexts = {
|
|
4
|
+
text: {
|
|
5
|
+
"overview.title": "API HTTP",
|
|
6
|
+
"overview.description":
|
|
7
|
+
"Endpoints, corps de la requête, réponses, codes d'erreur, listes et lots de l'API HTTP.",
|
|
8
|
+
"overview.intro":
|
|
9
|
+
"Chaque appel est un POST avec un corps JSON. Le champ `type` nomme le handler, `payload` contient ses champs. Les pages de référence listent chaque handler avec ses champs.",
|
|
10
|
+
"overview.endpoints.heading": "Endpoints",
|
|
11
|
+
"overview.endpoints.query": "Lit des données. Ne modifie jamais rien.",
|
|
12
|
+
"overview.endpoints.write":
|
|
13
|
+
"Modifie des données : créer, mettre à jour, supprimer ou une action précise.",
|
|
14
|
+
"overview.endpoints.batch": "Exécute plusieurs appels d'écriture dans une transaction.",
|
|
15
|
+
"overview.auth.heading": "Authentification",
|
|
16
|
+
"overview.auth.body":
|
|
17
|
+
"Envoie un jeton d'API dans l'en-tête `Authorization` sous la forme `Bearer <token>`. Les requêtes avec jeton n'ont besoin ni de cookie ni de jeton CSRF. Le jeton fixe aussi le compte dans lequel la requête s'exécute, tu n'envoies donc jamais d'ID de compte ou de tenant.",
|
|
18
|
+
"overview.body.heading": "Corps de la requête",
|
|
19
|
+
"overview.body.body":
|
|
20
|
+
"`type` est le nom du handler, par exemple `{exampleType}`. `payload` contient les champs de la référence. `requestId` est facultatif, voir plus bas. Le payload peut être imbriqué sur {maxDepth} niveaux au maximum.",
|
|
21
|
+
"overview.responses.heading": "Réponses",
|
|
22
|
+
"overview.responses.success":
|
|
23
|
+
"Une lecture réussie renvoie `data`. Une écriture réussie renvoie `isSuccess: true` et `data`.",
|
|
24
|
+
"overview.responses.error":
|
|
25
|
+
"En cas d'échec, le statut HTTP est 4xx ou 5xx et le corps contient `error`. Les appels d'écriture renvoient aussi `isSuccess: false`. Appuie-toi sur `error.code` et le statut. `message` s'adresse aux personnes et peut changer.",
|
|
26
|
+
"overview.errors.heading": "Codes d'erreur",
|
|
27
|
+
"overview.errors.columns": "Code | Statut HTTP | Signification",
|
|
28
|
+
"overview.versions.heading": "Versions et conflits",
|
|
29
|
+
"overview.versions.body":
|
|
30
|
+
"Chaque enregistrement a une `version`. Une mise à jour utilise la `version` que tu as lue en dernier. Si quelqu'un a modifié l'enregistrement entre-temps, l'appel échoue avec 409 `version_conflict`. Relis l'enregistrement, vérifie la modification et envoie-la avec la nouvelle version.",
|
|
31
|
+
"overview.lists.heading": "Listes",
|
|
32
|
+
"overview.lists.intro":
|
|
33
|
+
"Les handlers de liste se terminent par `:list` et acceptent ces champs :",
|
|
34
|
+
"overview.lists.columns": "Champ | Type | Description",
|
|
35
|
+
"overview.lists.response":
|
|
36
|
+
"La réponse contient `rows` et `nextCursor`. Pour la page suivante, envoie `nextCursor` comme `cursor`. Sur la dernière page, `nextCursor` vaut `null`.",
|
|
37
|
+
"overview.batch.heading": "Lots",
|
|
38
|
+
"overview.batch.body":
|
|
39
|
+
"`POST /api/batch` prend `commands`, une liste d'appels d'écriture `{ type, payload }`. Ils s'exécutent dans une transaction : si l'un échoue, aucun n'a d'effet. La réponse contient alors `isSuccess: false`, l'`error` et `failedIndex`, la position de la commande en échec comptée à partir de 0.",
|
|
40
|
+
"overview.retry.heading": "Réessayer sans risque",
|
|
41
|
+
"overview.retry.body":
|
|
42
|
+
"Envoie un `requestId` avec les appels d'écriture et de lot, une chaîne quelconque unique par modification. Si la connexion coupe et que tu renvoies le même appel avec le même `requestId`, tu reçois le premier résultat et la modification ne s'exécute pas deux fois.",
|
|
43
|
+
"tokens.title": "Jetons d'API",
|
|
44
|
+
"tokens.description":
|
|
45
|
+
"Crée un jeton d'API pour {appName}, choisis ses scopes et envoie-le avec tes requêtes.",
|
|
46
|
+
"tokens.intro":
|
|
47
|
+
"Un jeton d'API permet à un script ou à un autre service d'appeler l'API de {appName} en ton nom. Ses scopes décident des données qu'il peut lire ou modifier.",
|
|
48
|
+
"tokens.create.heading": "Créer un jeton",
|
|
49
|
+
"tokens.create.step1": "Ouvre {menuPath}.",
|
|
50
|
+
"tokens.create.step2": "Choisis **{createLabel}**.",
|
|
51
|
+
"tokens.create.step3":
|
|
52
|
+
"Saisis un nom, choisis les scopes et l'expiration, puis confirme avec ton mot de passe.",
|
|
53
|
+
"tokens.create.step4":
|
|
54
|
+
"Copie le jeton. Il commence par `kpat_` et n'est affiché qu'une seule fois.",
|
|
55
|
+
"tokens.expiry":
|
|
56
|
+
"Un jeton expire après {defaultDays} jours si tu ne choisis pas une autre expiration. L'expiration la plus longue possible est de {maxDays} jours.",
|
|
57
|
+
"tokens.use.heading": "Utiliser le jeton",
|
|
58
|
+
"tokens.use.body":
|
|
59
|
+
"Envoie le jeton dans l'en-tête `Authorization`. Les requêtes avec jeton n'ont besoin ni de cookie ni de jeton CSRF.",
|
|
60
|
+
"tokens.scopes.heading": "Scopes",
|
|
61
|
+
"tokens.scopes.intro":
|
|
62
|
+
"Chaque scope a deux niveaux. `read` autorise les handlers de lecture. `write` autorise tout ce que `read` autorise, plus les handlers d'écriture.",
|
|
63
|
+
"tokens.scopes.columns": "Scope | Droit | Handlers",
|
|
64
|
+
"tokens.rateLimit.heading": "Limite de requêtes",
|
|
65
|
+
"tokens.rateLimit":
|
|
66
|
+
"Chaque jeton peut envoyer {max} requêtes par tranche de {windowSeconds} secondes. Au-delà, l'API répond 429 `pat_rate_limited`.",
|
|
67
|
+
"tokens.errors.heading": "Erreurs",
|
|
68
|
+
"tokens.errors.columns": "Statut HTTP | Code | Cause",
|
|
69
|
+
"tokens.errors.missing": "L'en-tête `Authorization` est absent.",
|
|
70
|
+
"tokens.errors.invalid": "Le jeton est inconnu, révoqué ou expiré.",
|
|
71
|
+
"tokens.errors.scope": "Il manque au jeton le scope pour ce handler.",
|
|
72
|
+
"tokens.errors.route":
|
|
73
|
+
"L'endpoint n'accepte pas les jetons. Les jetons ne fonctionnent que sur les endpoints de l'API.",
|
|
74
|
+
"tokens.errors.rate": "Trop de requêtes avec ce jeton.",
|
|
75
|
+
"tokens.errors.disabled": "Les jetons d'API ne font pas partie de ton offre.",
|
|
76
|
+
"tokens.revoke.heading": "Révoquer un jeton",
|
|
77
|
+
"tokens.revoke.body":
|
|
78
|
+
"Révoque un jeton dans {menuPath} dès que tu ne l'utilises plus. Changer ton mot de passe révoque tous tes jetons. Un jeton agit toujours avec tes rôles actuels. Si tu quittes le compte ou si ton utilisateur est supprimé, il cesse de fonctionner.",
|
|
79
|
+
"tokens.security.heading": "Sécurité",
|
|
80
|
+
"tokens.security.item1":
|
|
81
|
+
"Traite un jeton comme un mot de passe. Garde-le dans un coffre à secrets, jamais dans le code, un dépôt, une app ou une page web, ni dans un log.",
|
|
82
|
+
"tokens.security.item2":
|
|
83
|
+
"Donne à chaque script son propre jeton, avec seulement les scopes dont il a besoin.",
|
|
84
|
+
"tokens.security.item3":
|
|
85
|
+
"Révoque les jetons que tu n'utilises plus. Révoque un jeton immédiatement s'il a pu fuiter.",
|
|
86
|
+
"reference.description":
|
|
87
|
+
"Référence de l'API pour {scopeLabel} : chaque handler avec ses champs et un exemple.",
|
|
88
|
+
"reference.requiredScope": "Scope requis",
|
|
89
|
+
"reference.endpoint": "Endpoint",
|
|
90
|
+
"reference.fields.columns": "Champ | Type | Obligatoire | Description",
|
|
91
|
+
"reference.yes": "oui",
|
|
92
|
+
"reference.no": "non",
|
|
93
|
+
"reference.noFields": "Ce handler ne prend aucun champ.",
|
|
94
|
+
"reference.excluded": "Non modifiables via l'API : {fields}.",
|
|
95
|
+
"reference.exampleRequest": "Exemple de requête",
|
|
96
|
+
"reference.exampleResponse": "Exemple de réponse",
|
|
97
|
+
"reference.status": "Statut : {status}",
|
|
98
|
+
"events.title": "Événements webhook",
|
|
99
|
+
"events.description":
|
|
100
|
+
"Événements webhook : quand ils sont envoyés, quel scope ils exigent et ce que contient leur charge utile.",
|
|
101
|
+
"events.intro":
|
|
102
|
+
"Un événement webhook informe votre système qu'une chose a changé. Chaque événement a un nom, une version et une charge utile. Le scope indiqué pour un événement est le scope de jeton qui permet de s'y abonner.",
|
|
103
|
+
"events.delivery.heading": "Livraison",
|
|
104
|
+
"events.versions.heading": "Versions",
|
|
105
|
+
"events.versions.body":
|
|
106
|
+
"Ajouter un champ facultatif conserve la version. Un changement incompatible, comme la suppression ou le renommage d'un champ ou le changement de son type, reçoit une nouvelle version.",
|
|
107
|
+
"events.list.heading": "Événements",
|
|
108
|
+
"events.version": "Version",
|
|
109
|
+
"events.requiredScope": "Scope requis",
|
|
110
|
+
"events.example": "Exemple de charge utile",
|
|
111
|
+
"events.noFields": "Cet événement ne contient aucun champ.",
|
|
112
|
+
"events.entity.created": "Un enregistrement de type {entity} a été créé.",
|
|
113
|
+
"events.entity.updated": "Un enregistrement de type {entity} a été modifié.",
|
|
114
|
+
"events.entity.deleted": "Un enregistrement de type {entity} a été supprimé.",
|
|
115
|
+
},
|
|
116
|
+
errorMeanings: {
|
|
117
|
+
validation_error:
|
|
118
|
+
"Le payload ne correspond pas aux champs du handler. `details` nomme les champs.",
|
|
119
|
+
unauthenticated: "Aucun identifiant valide n'a été envoyé.",
|
|
120
|
+
missing_token: "L'en-tête `Authorization` est absent.",
|
|
121
|
+
invalid_token: "Le jeton est inconnu, révoqué ou expiré.",
|
|
122
|
+
ambiguous_auth:
|
|
123
|
+
"La requête contenait un cookie de session et un jeton. N'envoie que l'un des deux.",
|
|
124
|
+
access_denied:
|
|
125
|
+
"Il manque au jeton le scope pour ce handler, ou l'endpoint n'accepte pas les jetons.",
|
|
126
|
+
feature_disabled: "Cette fonction est désactivée ou ne fait pas partie de ton offre.",
|
|
127
|
+
not_found: "L'enregistrement n'existe pas ou tu ne peux pas le voir.",
|
|
128
|
+
conflict: "La modification est en conflit avec l'état actuel des données.",
|
|
129
|
+
version_conflict:
|
|
130
|
+
"L'enregistrement a changé après ta lecture. Relis-le et réessaie avec la nouvelle `version`.",
|
|
131
|
+
precondition_failed:
|
|
132
|
+
"Un champ de l'enregistrement n'a plus la valeur attendue par la modification. Relis l'enregistrement et réessaie.",
|
|
133
|
+
record_locked: "Une autre modification verrouille l'enregistrement. Réessaie dans un instant.",
|
|
134
|
+
idempotent_replay:
|
|
135
|
+
"Cette modification a déjà été appliquée avec la même clé d'idempotence. La première tentative a réussi, ne l'envoie donc pas de nouveau.",
|
|
136
|
+
unique_violation: "Un enregistrement avec cette valeur existe déjà.",
|
|
137
|
+
unprocessable:
|
|
138
|
+
"Les données sont valides, mais une règle métier refuse la modification. `details.reason` nomme la règle.",
|
|
139
|
+
unconfigured:
|
|
140
|
+
"Un réglage nécessaire à cette fonction est encore vide. Configure-le d'abord dans l'app, puis réessaie.",
|
|
141
|
+
internal_error: "Erreur serveur inattendue. Réessaie plus tard.",
|
|
142
|
+
member_read_timeout:
|
|
143
|
+
"Une lecture sur le serveur a pris trop de temps et a été interrompue. Réessaie plus tard.",
|
|
144
|
+
rate_limited:
|
|
145
|
+
"Trop de requêtes. Attends le nombre de secondes indiqué par l'en-tête `Retry-After`.",
|
|
146
|
+
rate_limit_unavailable:
|
|
147
|
+
"La limitation de débit est temporairement indisponible, la requête a été refusée. Réessaie dans un instant.",
|
|
148
|
+
pat_rate_limited:
|
|
149
|
+
"Ce jeton a envoyé trop de requêtes en peu de temps. Attends un instant et réessaie.",
|
|
150
|
+
},
|
|
151
|
+
listParameters: {
|
|
152
|
+
cursor: "Position issue de `nextCursor` de la page précédente.",
|
|
153
|
+
limit: "Lignes par page, {default} par défaut, au maximum {max}.",
|
|
154
|
+
search: "Recherche plein texte dans les champs interrogeables.",
|
|
155
|
+
sort: "Champ servant au tri.",
|
|
156
|
+
sortDirection: "`asc` ou `desc`.",
|
|
157
|
+
offset: "Nombre de lignes à ignorer. Pour paginer, préfère `cursor`.",
|
|
158
|
+
totalCount: "Avec `true`, tu reçois aussi `total`, le nombre de lignes correspondantes.",
|
|
159
|
+
includeDeleted:
|
|
160
|
+
"Avec `true`, les lignes supprimées sont incluses. Uniquement pour les entités avec suppression logique.",
|
|
161
|
+
onlyDeleted:
|
|
162
|
+
"Avec `true`, seules les lignes supprimées sont renvoyées. Uniquement pour les entités avec suppression logique, pas avec `includeDeleted`.",
|
|
163
|
+
filter: "Un filtre de champ avec `field`, `op` et `value`. `op` est l'un de {ops}.",
|
|
164
|
+
filters:
|
|
165
|
+
"Plusieurs filtres de champ, chacun avec `field`, `op` et `value`. `op` est l'un de {ops}.",
|
|
166
|
+
namedFilter: "Nom d'un filtre prédéfini de l'entité, par exemple une file de travail.",
|
|
167
|
+
aggregate: "Renvoie des valeurs agrégées au lieu de lignes.",
|
|
168
|
+
},
|
|
169
|
+
} as const satisfies ApiDocsTexts;
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
import { isOneOf } from "@cosmicdrift/kumiko-types/type-guards";
|
|
2
|
+
import type { ApiDocsProblem } from "../problems.ts";
|
|
3
|
+
import { deApiDocsTexts } from "./de.ts";
|
|
4
|
+
import { enApiDocsTexts } from "./en.ts";
|
|
5
|
+
import { esApiDocsTexts } from "./es.ts";
|
|
6
|
+
import { frApiDocsTexts } from "./fr.ts";
|
|
7
|
+
import { itApiDocsTexts } from "./it.ts";
|
|
8
|
+
import { type ApiDocsTexts, isParagraphTextKey, placeholdersOf } from "./types.ts";
|
|
9
|
+
|
|
10
|
+
export const apiDocsLocales = ["en", "de", "es", "fr", "it"] as const;
|
|
11
|
+
|
|
12
|
+
export type ApiDocsLocale = (typeof apiDocsLocales)[number];
|
|
13
|
+
|
|
14
|
+
export function isApiDocsLocale(value: string): value is ApiDocsLocale {
|
|
15
|
+
return isOneOf(apiDocsLocales, value);
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
const textsByLocale: Readonly<Record<ApiDocsLocale, ApiDocsTexts>> = {
|
|
19
|
+
en: enApiDocsTexts,
|
|
20
|
+
de: deApiDocsTexts,
|
|
21
|
+
es: esApiDocsTexts,
|
|
22
|
+
fr: frApiDocsTexts,
|
|
23
|
+
it: itApiDocsTexts,
|
|
24
|
+
};
|
|
25
|
+
|
|
26
|
+
export function apiDocsTextsFor(locale: ApiDocsLocale): ApiDocsTexts {
|
|
27
|
+
return textsByLocale[locale];
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
/** Applies the app's paragraph overrides. A bad override is reported and skipped,
|
|
31
|
+
* never half applied, so the page keeps its shipped wording. */
|
|
32
|
+
export function resolveApiDocsTexts(
|
|
33
|
+
locale: ApiDocsLocale,
|
|
34
|
+
overrides: Readonly<Record<string, string>> | undefined,
|
|
35
|
+
): { readonly texts: ApiDocsTexts; readonly problems: readonly ApiDocsProblem[] } {
|
|
36
|
+
const base = textsByLocale[locale];
|
|
37
|
+
if (overrides === undefined) return { texts: base, problems: [] };
|
|
38
|
+
const problems: ApiDocsProblem[] = [];
|
|
39
|
+
const text = { ...base.text };
|
|
40
|
+
for (const [key, value] of Object.entries(overrides)) {
|
|
41
|
+
if (!isParagraphTextKey(key)) {
|
|
42
|
+
problems.push({
|
|
43
|
+
kind: "invalidTextOverride",
|
|
44
|
+
locale,
|
|
45
|
+
key,
|
|
46
|
+
cause: "Not an overridable paragraph key.",
|
|
47
|
+
});
|
|
48
|
+
continue;
|
|
49
|
+
}
|
|
50
|
+
const allowed = placeholdersOf(base.text[key]);
|
|
51
|
+
const unknown = [...placeholdersOf(value)].filter((name) => !allowed.has(name));
|
|
52
|
+
if (unknown.length > 0) {
|
|
53
|
+
problems.push({
|
|
54
|
+
kind: "invalidTextOverride",
|
|
55
|
+
locale,
|
|
56
|
+
key,
|
|
57
|
+
cause: `Unknown placeholders: ${unknown.map((name) => `{${name}}`).join(", ")}. Allowed: ${[...allowed].map((name) => `{${name}}`).join(", ") || "none"}.`,
|
|
58
|
+
});
|
|
59
|
+
continue;
|
|
60
|
+
}
|
|
61
|
+
text[key] = value;
|
|
62
|
+
}
|
|
63
|
+
return { texts: { ...base, text }, problems };
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
export type { ApiDocsTextKey, ApiDocsTexts, DocumentedErrorCode } from "./types.ts";
|
|
67
|
+
export { formatApiDocsText } from "./types.ts";
|