@cosmicdrift/kumiko-bundled-features 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.
Files changed (151) hide show
  1. package/dist/agent-tools/agent-doc-lint.d.ts +9 -0
  2. package/dist/agent-tools/agent-doc-lint.js +42 -5
  3. package/dist/agent-tools/agent-manifest.d.ts +0 -1
  4. package/dist/agent-tools/agent-manifest.js +9 -99
  5. package/dist/agent-tools/api-docs/anchors.d.ts +14 -0
  6. package/dist/agent-tools/api-docs/anchors.js +49 -0
  7. package/dist/agent-tools/api-docs/check.d.ts +7 -0
  8. package/dist/agent-tools/api-docs/check.js +15 -0
  9. package/dist/agent-tools/api-docs/collect-events.d.ts +10 -0
  10. package/dist/agent-tools/api-docs/collect-events.js +90 -0
  11. package/dist/agent-tools/api-docs/collect.d.ts +15 -0
  12. package/dist/agent-tools/api-docs/collect.js +108 -0
  13. package/dist/agent-tools/api-docs/curl.d.ts +5 -0
  14. package/dist/agent-tools/api-docs/curl.js +24 -0
  15. package/dist/agent-tools/api-docs/error-table.d.ts +9 -0
  16. package/dist/agent-tools/api-docs/error-table.js +31 -0
  17. package/dist/agent-tools/api-docs/examples.d.ts +16 -0
  18. package/dist/agent-tools/api-docs/examples.js +25 -0
  19. package/dist/agent-tools/api-docs/generate.d.ts +19 -0
  20. package/dist/agent-tools/api-docs/generate.js +104 -0
  21. package/dist/agent-tools/api-docs/index-json.d.ts +15 -0
  22. package/dist/agent-tools/api-docs/index-json.js +6 -0
  23. package/dist/agent-tools/api-docs/index.d.ts +9 -0
  24. package/dist/agent-tools/api-docs/index.js +6 -0
  25. package/dist/agent-tools/api-docs/list-parameters.d.ts +61 -0
  26. package/dist/agent-tools/api-docs/list-parameters.js +28 -0
  27. package/dist/agent-tools/api-docs/markdown.d.ts +29 -0
  28. package/dist/agent-tools/api-docs/markdown.js +48 -0
  29. package/dist/agent-tools/api-docs/menu-path.d.ts +8 -0
  30. package/dist/agent-tools/api-docs/menu-path.js +60 -0
  31. package/dist/agent-tools/api-docs/model.d.ts +76 -0
  32. package/dist/agent-tools/api-docs/model.js +1 -0
  33. package/dist/agent-tools/api-docs/problems.d.ts +32 -0
  34. package/dist/agent-tools/api-docs/problems.js +28 -0
  35. package/dist/agent-tools/api-docs/render-events.d.ts +12 -0
  36. package/dist/agent-tools/api-docs/render-events.js +55 -0
  37. package/dist/agent-tools/api-docs/render-openapi.d.ts +10 -0
  38. package/dist/agent-tools/api-docs/render-openapi.js +170 -0
  39. package/dist/agent-tools/api-docs/render-overview.d.ts +11 -0
  40. package/dist/agent-tools/api-docs/render-overview.js +60 -0
  41. package/dist/agent-tools/api-docs/render-reference.d.ts +14 -0
  42. package/dist/agent-tools/api-docs/render-reference.js +50 -0
  43. package/dist/agent-tools/api-docs/render-tokens.d.ts +12 -0
  44. package/dist/agent-tools/api-docs/render-tokens.js +101 -0
  45. package/dist/agent-tools/api-docs/schema-fields.d.ts +16 -0
  46. package/dist/agent-tools/api-docs/schema-fields.js +141 -0
  47. package/dist/agent-tools/api-docs/section-ids.d.ts +25 -0
  48. package/dist/agent-tools/api-docs/section-ids.js +26 -0
  49. package/dist/agent-tools/api-docs/system-only.d.ts +5 -0
  50. package/dist/agent-tools/api-docs/system-only.js +7 -0
  51. package/dist/agent-tools/api-docs/texts/de.d.ts +123 -0
  52. package/dist/agent-tools/api-docs/texts/de.js +123 -0
  53. package/dist/agent-tools/api-docs/texts/en.d.ts +123 -0
  54. package/dist/agent-tools/api-docs/texts/en.js +123 -0
  55. package/dist/agent-tools/api-docs/texts/es.d.ts +123 -0
  56. package/dist/agent-tools/api-docs/texts/es.js +123 -0
  57. package/dist/agent-tools/api-docs/texts/fr.d.ts +123 -0
  58. package/dist/agent-tools/api-docs/texts/fr.js +123 -0
  59. package/dist/agent-tools/api-docs/texts/index.d.ts +14 -0
  60. package/dist/agent-tools/api-docs/texts/index.js +55 -0
  61. package/dist/agent-tools/api-docs/texts/it.d.ts +123 -0
  62. package/dist/agent-tools/api-docs/texts/it.js +123 -0
  63. package/dist/agent-tools/api-docs/texts/types.d.ts +18 -0
  64. package/dist/agent-tools/api-docs/texts/types.js +104 -0
  65. package/dist/agent-tools/api-docs/ui-writes.d.ts +12 -0
  66. package/dist/agent-tools/api-docs/ui-writes.js +73 -0
  67. package/dist/agent-tools/handler-schema.d.ts +5 -0
  68. package/dist/agent-tools/handler-schema.js +37 -0
  69. package/dist/agent-tools/index.d.ts +2 -1
  70. package/dist/agent-tools/index.js +2 -1
  71. package/dist/agent-tools/labels.d.ts +26 -0
  72. package/dist/agent-tools/labels.js +131 -0
  73. package/dist/auth-email-password/seeding.d.ts +17 -2
  74. package/dist/auth-email-password/seeding.js +68 -6
  75. package/dist/auth-email-password/web/i18n.js +1 -0
  76. package/dist/auth-email-password/web/signup-screen.d.ts +1 -1
  77. package/dist/auth-email-password/web/signup-screen.js +20 -2
  78. package/dist/auth-email-password/web/static-account.d.ts +40 -0
  79. package/dist/auth-email-password/web/static-account.js +94 -0
  80. package/dist/auth-email-password/web/static-client.d.ts +38 -0
  81. package/dist/auth-email-password/web/static-client.js +169 -0
  82. package/dist/foundation-shared/demo-admin-env.d.ts +4 -0
  83. package/dist/foundation-shared/demo-admin-env.js +7 -0
  84. package/dist/foundation-shared/index.d.ts +1 -1
  85. package/dist/foundation-shared/index.js +1 -1
  86. package/dist/inbound-mail-foundation/entities.d.ts +84 -0
  87. package/dist/inbound-mail-foundation/entities.js +96 -71
  88. package/dist/inbound-mail-foundation/feature.js +2 -2
  89. package/dist/inbound-provider-imap/imap-client.d.ts +1 -1
  90. package/dist/inbound-provider-imap/imap-client.js +3 -1
  91. package/dist/personal-access-tokens/feature.d.ts +1 -0
  92. package/dist/personal-access-tokens/feature.js +4 -2
  93. package/dist/personal-access-tokens/handlers/create.write.js +2 -2
  94. package/dist/personal-access-tokens/i18n.js +5 -1
  95. package/dist/personal-access-tokens/index.d.ts +4 -2
  96. package/dist/personal-access-tokens/index.js +29 -2
  97. package/dist/personal-access-tokens/scope-events-check.d.ts +3 -0
  98. package/dist/personal-access-tokens/scope-events-check.js +18 -0
  99. package/dist/personal-access-tokens/screens.js +8 -2
  100. package/dist/personal-access-tokens/web/constants.d.ts +1 -0
  101. package/dist/personal-access-tokens/web/constants.js +1 -0
  102. package/dist/personal-access-tokens/web/scopes.d.ts +2 -0
  103. package/dist/personal-access-tokens/web/scopes.js +12 -0
  104. package/dist/presence/feature.d.ts +3 -0
  105. package/dist/presence/feature.js +20 -0
  106. package/dist/presence/handlers/heartbeat.write.d.ts +12 -0
  107. package/dist/presence/handlers/heartbeat.write.js +31 -0
  108. package/dist/presence/handlers/leave.write.d.ts +8 -0
  109. package/dist/presence/handlers/leave.write.js +33 -0
  110. package/dist/presence/handlers/list.query.d.ts +7 -0
  111. package/dist/presence/handlers/list.query.js +28 -0
  112. package/dist/presence/index.d.ts +3 -0
  113. package/dist/presence/index.js +2 -0
  114. package/dist/presence/options.d.ts +17 -0
  115. package/dist/presence/options.js +13 -0
  116. package/dist/presence/payloads.d.ts +18 -0
  117. package/dist/presence/payloads.js +18 -0
  118. package/dist/presence/room.d.ts +13 -0
  119. package/dist/presence/room.js +35 -0
  120. package/dist/presence/store.d.ts +32 -0
  121. package/dist/presence/store.js +140 -0
  122. package/dist/sessions/feature.js +2 -2
  123. package/dist/sessions/handlers/last-activity-probe.route.d.ts +2 -0
  124. package/dist/sessions/handlers/last-activity-probe.route.js +14 -0
  125. package/dist/tenant-inactivity/check-inactive-tenants.js +12 -6
  126. package/dist/tenant-inactivity/constants.d.ts +1 -1
  127. package/dist/tenant-inactivity/constants.js +3 -1
  128. package/dist/tenant-inactivity/handlers/inactivity-state.query.js +2 -1
  129. package/dist/tenant-inactivity/handlers/keep-account.write.js +2 -1
  130. package/dist/tenant-inactivity/options.d.ts +1 -0
  131. package/dist/tenant-inactivity/remote-activity.d.ts +3 -1
  132. package/dist/tenant-inactivity/remote-activity.js +4 -1
  133. package/dist/tenant-inactivity/static-keep-account.d.ts +6 -0
  134. package/dist/tenant-inactivity/static-keep-account.js +15 -0
  135. package/dist/tenant-lifecycle/constants.d.ts +1 -0
  136. package/dist/tenant-lifecycle/constants.js +1 -0
  137. package/dist/tenant-lifecycle/handlers/cancel-destruction.write.js +2 -2
  138. package/dist/tenant-lifecycle/handlers/request-destruction.write.js +2 -1
  139. package/dist/tenant-lifecycle/index.d.ts +1 -1
  140. package/dist/tenant-lifecycle/index.js +1 -1
  141. package/dist/waitlist/static-submit.d.ts +15 -0
  142. package/dist/waitlist/static-submit.js +24 -0
  143. package/package.json +59 -11
  144. package/src/agent-tools/changes.json +24 -0
  145. package/src/auth-email-password/changes.json +24 -0
  146. package/src/inbound-mail-foundation/changes.json +6 -0
  147. package/src/inbound-provider-imap/changes.json +6 -0
  148. package/src/personal-access-tokens/changes.json +6 -0
  149. package/src/presence/changes.json +8 -0
  150. package/src/tenant-inactivity/changes.json +12 -0
  151. package/src/waitlist/changes.json +6 -0
@@ -0,0 +1,25 @@
1
+ export declare const overviewSectionIds: {
2
+ readonly endpoints: "endpoints";
3
+ readonly auth: "authentication";
4
+ readonly body: "request-body";
5
+ readonly responses: "responses";
6
+ readonly errors: "error-codes";
7
+ readonly versions: "versions";
8
+ readonly lists: "lists";
9
+ readonly batch: "batches";
10
+ readonly retry: "retries";
11
+ };
12
+ export declare const eventsSectionIds: {
13
+ readonly delivery: "delivery";
14
+ readonly versions: "versions";
15
+ readonly list: "events";
16
+ };
17
+ export declare const tokensSectionIds: {
18
+ readonly create: "create-token";
19
+ readonly use: "use-token";
20
+ readonly scopes: "scopes";
21
+ readonly rateLimit: "rate-limit";
22
+ readonly errors: "errors";
23
+ readonly revoke: "revoke-token";
24
+ readonly security: "security";
25
+ };
@@ -0,0 +1,26 @@
1
+ // Fixed per section, not derived from the translated heading, so de and en link alike.
2
+ export const overviewSectionIds = {
3
+ endpoints: "endpoints",
4
+ auth: "authentication",
5
+ body: "request-body",
6
+ responses: "responses",
7
+ errors: "error-codes",
8
+ versions: "versions",
9
+ lists: "lists",
10
+ batch: "batches",
11
+ retry: "retries",
12
+ };
13
+ export const eventsSectionIds = {
14
+ delivery: "delivery",
15
+ versions: "versions",
16
+ list: "events",
17
+ };
18
+ export const tokensSectionIds = {
19
+ create: "create-token",
20
+ use: "use-token",
21
+ scopes: "scopes",
22
+ rateLimit: "rate-limit",
23
+ errors: "errors",
24
+ revoke: "revoke-token",
25
+ security: "security",
26
+ };
@@ -0,0 +1,5 @@
1
+ import type { AccessRule } from "@cosmicdrift/kumiko-types/handlers";
2
+ /** A token never carries the system role, so such a handler is unreachable from the API. */
3
+ export declare function isSystemOnlyHandler(def: {
4
+ readonly access: AccessRule;
5
+ }): boolean;
@@ -0,0 +1,7 @@
1
+ import { SYSTEM_ROLE } from "@cosmicdrift/kumiko-framework/engine";
2
+ /** A token never carries the system role, so such a handler is unreachable from the API. */
3
+ export function isSystemOnlyHandler(def) {
4
+ return ("roles" in def.access &&
5
+ def.access.roles.length > 0 &&
6
+ def.access.roles.every((role) => role === SYSTEM_ROLE));
7
+ }
@@ -0,0 +1,123 @@
1
+ export declare const deApiDocsTexts: {
2
+ readonly text: {
3
+ readonly "overview.title": "HTTP-API";
4
+ readonly "overview.description": "Endpunkte, Request-Body, Antworten, Fehlercodes, Listen und Batches der HTTP-API.";
5
+ readonly "overview.intro": "Jeder Aufruf ist ein POST mit JSON-Body. Das Feld `type` nennt den Handler, `payload` enthält dessen Felder. Die Referenzseiten listen jeden Handler mit seinen Feldern.";
6
+ readonly "overview.endpoints.heading": "Endpunkte";
7
+ readonly "overview.endpoints.query": "Liest Daten. Ändert nie etwas.";
8
+ readonly "overview.endpoints.write": "Ändert Daten: anlegen, ändern, löschen oder eine bestimmte Aktion.";
9
+ readonly "overview.endpoints.batch": "Führt mehrere Schreibaufrufe in einer Transaktion aus.";
10
+ readonly "overview.auth.heading": "Authentifizierung";
11
+ readonly "overview.auth.body": "Sende einen API-Token im Header `Authorization` als `Bearer <token>`. Anfragen mit Token brauchen weder Cookie noch CSRF-Token. Der Token legt auch das Konto fest, in dem die Anfrage läuft. Du sendest also nie eine Konto- oder Mandanten-ID.";
12
+ readonly "overview.body.heading": "Request-Body";
13
+ readonly "overview.body.body": "`type` ist der Name des Handlers, zum Beispiel `{exampleType}`. `payload` enthält die Felder aus der Referenz. `requestId` ist optional, siehe unten. Das Payload darf höchstens {maxDepth} Ebenen tief verschachtelt sein.";
14
+ readonly "overview.responses.heading": "Antworten";
15
+ readonly "overview.responses.success": "Ein erfolgreiches Lesen liefert `data`. Ein erfolgreiches Schreiben liefert `isSuccess: true` und `data`.";
16
+ readonly "overview.responses.error": "Bei einem Fehler ist der HTTP-Status 4xx oder 5xx und der Body enthält `error`. Schreibaufrufe liefern zusätzlich `isSuccess: false`. Werte `error.code` und den Status aus. `message` ist für Menschen gedacht und kann sich ändern.";
17
+ readonly "overview.errors.heading": "Fehlercodes";
18
+ readonly "overview.errors.columns": "Code | HTTP-Status | Bedeutung";
19
+ readonly "overview.versions.heading": "Versionen und Konflikte";
20
+ readonly "overview.versions.body": "Jeder Datensatz hat eine `version`. Ein Update nimmt die `version`, die du zuletzt gelesen hast. Hat jemand den Datensatz zwischenzeitlich geändert, schlägt der Aufruf mit 409 `version_conflict` fehl. Lies den Datensatz neu, prüfe die Änderung und sende sie mit der neuen Version.";
21
+ readonly "overview.lists.heading": "Listen";
22
+ readonly "overview.lists.intro": "Listen-Handler enden auf `:list` und akzeptieren diese Felder:";
23
+ readonly "overview.lists.columns": "Feld | Typ | Beschreibung";
24
+ readonly "overview.lists.response": "Die Antwort enthält `rows` und `nextCursor`. Für die nächste Seite sendest du `nextCursor` als `cursor`. Auf der letzten Seite ist `nextCursor` `null`.";
25
+ readonly "overview.batch.heading": "Batches";
26
+ readonly "overview.batch.body": "`POST /api/batch` nimmt `commands`, eine Liste von Schreibaufrufen `{ type, payload }`. Sie laufen in einer Transaktion: Schlägt einer fehl, wirkt keiner. Die Antwort hat dann `isSuccess: false`, den `error` und `failedIndex`, die Position des fehlgeschlagenen Befehls ab 0 gezählt.";
27
+ readonly "overview.retry.heading": "Sicher wiederholen";
28
+ readonly "overview.retry.body": "Sende bei Schreib- und Batch-Aufrufen eine `requestId` mit. Das ist ein beliebiger String, der pro Änderung eindeutig ist. Reißt die Verbindung ab und du sendest denselben Aufruf mit derselben `requestId` erneut, bekommst du das erste Ergebnis zurück und die Änderung läuft nicht doppelt.";
29
+ readonly "tokens.title": "API-Tokens";
30
+ readonly "tokens.description": "Lege einen API-Token für {appName} an, wähle seine Scopes und sende ihn mit deinen Anfragen.";
31
+ readonly "tokens.intro": "Mit einem API-Token kann ein Skript oder ein anderer Dienst die API von {appName} in deinem Namen aufrufen. Seine Scopes bestimmen, welche Daten er lesen oder ändern darf.";
32
+ readonly "tokens.create.heading": "Token anlegen";
33
+ readonly "tokens.create.step1": "Öffne {menuPath}.";
34
+ readonly "tokens.create.step2": "Wähle **{createLabel}**.";
35
+ readonly "tokens.create.step3": "Gib einen Namen ein, wähle die Scopes und das Ablaufdatum und bestätige mit deinem Passwort.";
36
+ readonly "tokens.create.step4": "Kopiere den Token. Er beginnt mit `kpat_` und wird nur einmal angezeigt.";
37
+ readonly "tokens.expiry": "Ein Token läuft nach {defaultDays} Tagen ab, wenn du keinen anderen Ablauf wählst. Möglich sind höchstens {maxDays} Tage.";
38
+ readonly "tokens.use.heading": "Token verwenden";
39
+ readonly "tokens.use.body": "Sende den Token im Header `Authorization`. Anfragen mit Token brauchen weder Cookie noch CSRF-Token.";
40
+ readonly "tokens.scopes.heading": "Scopes";
41
+ readonly "tokens.scopes.intro": "Jeder Scope hat zwei Stufen. `read` erlaubt die lesenden Handler. `write` erlaubt alles, was `read` erlaubt, und zusätzlich die schreibenden Handler.";
42
+ readonly "tokens.scopes.columns": "Scope | Berechtigung | Handler";
43
+ readonly "tokens.rateLimit.heading": "Ratenbegrenzung";
44
+ readonly "tokens.rateLimit": "Jeder Token darf {max} Anfragen pro {windowSeconds} Sekunden senden. Darüber antwortet die API mit 429 `pat_rate_limited`.";
45
+ readonly "tokens.errors.heading": "Fehler";
46
+ readonly "tokens.errors.columns": "HTTP-Status | Code | Ursache";
47
+ readonly "tokens.errors.missing": "Es fehlt der Header `Authorization`.";
48
+ readonly "tokens.errors.invalid": "Der Token ist unbekannt, widerrufen oder abgelaufen.";
49
+ readonly "tokens.errors.scope": "Dem Token fehlt der Scope für diesen Handler.";
50
+ readonly "tokens.errors.route": "Der Endpunkt nimmt keine Tokens an. Tokens funktionieren nur an den API-Endpunkten.";
51
+ readonly "tokens.errors.rate": "Zu viele Anfragen mit diesem Token.";
52
+ readonly "tokens.errors.disabled": "API-Tokens sind nicht Teil deines Tarifs.";
53
+ readonly "tokens.revoke.heading": "Token widerrufen";
54
+ readonly "tokens.revoke.body": "Widerrufe einen Token in {menuPath}, sobald du ihn nicht mehr brauchst. Wenn du dein Passwort änderst, werden alle deine Tokens widerrufen. Ein Token handelt immer mit deinen aktuellen Rollen. Verlässt du das Konto oder wird dein Benutzer gelöscht, funktioniert er nicht mehr.";
55
+ readonly "tokens.security.heading": "Sicherheit";
56
+ readonly "tokens.security.item1": "Behandle einen Token wie ein Passwort. Bewahre ihn in einem Secret Store auf, nie im Code, in einem Repository, in einer App oder Webseite oder in einem Log.";
57
+ readonly "tokens.security.item2": "Gib jedem Skript einen eigenen Token mit nur den Scopes, die es braucht.";
58
+ readonly "tokens.security.item3": "Widerrufe Tokens, die du nicht mehr nutzt. Widerrufe einen Token sofort, wenn er in fremde Hände gelangt sein könnte.";
59
+ readonly "reference.description": "API-Referenz für {scopeLabel}: jeder Handler mit seinen Feldern und einem Beispiel.";
60
+ readonly "reference.requiredScope": "Benötigter Scope";
61
+ readonly "reference.endpoint": "Endpunkt";
62
+ readonly "reference.fields.columns": "Feld | Typ | Pflicht | Beschreibung";
63
+ readonly "reference.yes": "ja";
64
+ readonly "reference.no": "nein";
65
+ readonly "reference.noFields": "Dieser Handler nimmt keine Felder.";
66
+ readonly "reference.excluded": "Über die API nicht setzbar: {fields}.";
67
+ readonly "reference.exampleRequest": "Beispielanfrage";
68
+ readonly "reference.exampleResponse": "Beispielantwort";
69
+ readonly "reference.status": "Status: {status}";
70
+ readonly "events.title": "Webhook-Ereignisse";
71
+ readonly "events.description": "Webhook-Ereignisse: wann sie ausgelöst werden, welchen Scope sie brauchen und was ihre Nutzlast enthält.";
72
+ readonly "events.intro": "Ein Webhook-Ereignis meldet deinem System, dass sich etwas geändert hat. Jedes Ereignis hat einen Namen, eine Version und eine Nutzlast. Der bei einem Ereignis genannte Scope ist der Token-Scope, der das Abonnieren erlaubt.";
73
+ readonly "events.delivery.heading": "Zustellung";
74
+ readonly "events.versions.heading": "Versionen";
75
+ readonly "events.versions.body": "Ein neues optionales Feld behält die Version. Eine inkompatible Änderung, etwa ein entferntes oder umbenanntes Feld oder ein geänderter Typ, bekommt eine neue Version.";
76
+ readonly "events.list.heading": "Ereignisse";
77
+ readonly "events.version": "Version";
78
+ readonly "events.requiredScope": "Benötigter Scope";
79
+ readonly "events.example": "Beispiel-Nutzlast";
80
+ readonly "events.noFields": "Dieses Ereignis enthält keine Felder.";
81
+ readonly "events.entity.created": "Ein Datensatz vom Typ {entity} wurde angelegt.";
82
+ readonly "events.entity.updated": "Ein Datensatz vom Typ {entity} wurde geändert.";
83
+ readonly "events.entity.deleted": "Ein Datensatz vom Typ {entity} wurde gelöscht.";
84
+ };
85
+ readonly errorMeanings: {
86
+ readonly validation_error: "Das Payload passt nicht zu den Feldern des Handlers. `details` nennt die Felder.";
87
+ readonly unauthenticated: "Es wurden keine gültigen Zugangsdaten gesendet.";
88
+ readonly missing_token: "Der Header `Authorization` fehlt.";
89
+ readonly invalid_token: "Der Token ist unbekannt, widerrufen oder abgelaufen.";
90
+ readonly ambiguous_auth: "Die Anfrage enthielt Session-Cookie und Token. Sende nur eines von beiden.";
91
+ readonly access_denied: "Dem Token fehlt der Scope für diesen Handler, oder der Endpunkt nimmt keine Tokens an.";
92
+ readonly feature_disabled: "Diese Funktion ist abgeschaltet oder nicht Teil deines Tarifs.";
93
+ readonly not_found: "Der Datensatz existiert nicht oder du darfst ihn nicht sehen.";
94
+ readonly conflict: "Die Änderung widerspricht dem aktuellen Stand der Daten.";
95
+ readonly version_conflict: "Der Datensatz hat sich nach deinem Lesen geändert. Lies ihn neu und wiederhole mit der neuen `version`.";
96
+ readonly precondition_failed: "Ein Feld des Datensatzes hat nicht mehr den Wert, den die Änderung erwartet hat. Lies den Datensatz neu und wiederhole.";
97
+ readonly record_locked: "Eine andere Änderung sperrt den Datensatz. Wiederhole gleich.";
98
+ readonly idempotent_replay: "Diese Änderung wurde unter demselben Idempotenz-Schlüssel schon ausgeführt. Der erste Versuch war erfolgreich, sende sie nicht noch einmal.";
99
+ readonly unique_violation: "Ein Datensatz mit diesem Wert existiert bereits.";
100
+ readonly unprocessable: "Die Daten sind gültig, aber eine Fachregel lehnt die Änderung ab. `details.reason` nennt die Regel.";
101
+ readonly unconfigured: "Eine Einstellung, die diese Funktion braucht, ist noch leer. Richte sie zuerst in der App ein und wiederhole dann.";
102
+ readonly internal_error: "Unerwarteter Serverfehler. Wiederhole später.";
103
+ readonly member_read_timeout: "Ein Lesevorgang auf dem Server hat zu lange gedauert und wurde abgebrochen. Wiederhole später.";
104
+ readonly rate_limited: "Zu viele Anfragen. Warte so viele Sekunden, wie der Header `Retry-After` angibt.";
105
+ readonly rate_limit_unavailable: "Die Ratenbegrenzung ist vorübergehend nicht verfügbar, die Anfrage wurde abgelehnt. Wiederhole gleich.";
106
+ readonly pat_rate_limited: "Dieser Token hat in kurzer Zeit zu viele Anfragen gesendet. Warte einen Moment und wiederhole.";
107
+ };
108
+ readonly listParameters: {
109
+ readonly cursor: "Position aus `nextCursor` der vorherigen Seite.";
110
+ readonly limit: "Zeilen pro Seite, standardmäßig {default}, höchstens {max}.";
111
+ readonly search: "Volltextsuche über die durchsuchbaren Felder.";
112
+ readonly sort: "Feld, nach dem sortiert wird.";
113
+ readonly sortDirection: "`asc` oder `desc`.";
114
+ readonly offset: "Anzahl der zu überspringenden Zeilen. Nutze besser `cursor` zum Blättern.";
115
+ readonly totalCount: "Mit `true` bekommst du zusätzlich `total`, die Anzahl der passenden Zeilen.";
116
+ readonly includeDeleted: "Mit `true` sind gelöschte Zeilen enthalten. Nur für Entitäten mit Soft Delete.";
117
+ readonly onlyDeleted: "Mit `true` kommen nur gelöschte Zeilen zurück. Nur für Entitäten mit Soft Delete, nicht zusammen mit `includeDeleted`.";
118
+ readonly filter: "Ein Feldfilter mit `field`, `op` und `value`. `op` ist einer von {ops}.";
119
+ readonly filters: "Mehrere Feldfilter, je mit `field`, `op` und `value`. `op` ist einer von {ops}.";
120
+ readonly namedFilter: "Name eines vordefinierten Filters der Entität, zum Beispiel einer Arbeitsliste.";
121
+ readonly aggregate: "Liefert aggregierte Werte statt Zeilen.";
122
+ };
123
+ };
@@ -0,0 +1,123 @@
1
+ export const deApiDocsTexts = {
2
+ text: {
3
+ "overview.title": "HTTP-API",
4
+ "overview.description": "Endpunkte, Request-Body, Antworten, Fehlercodes, Listen und Batches der HTTP-API.",
5
+ "overview.intro": "Jeder Aufruf ist ein POST mit JSON-Body. Das Feld `type` nennt den Handler, `payload` enthält dessen Felder. Die Referenzseiten listen jeden Handler mit seinen Feldern.",
6
+ "overview.endpoints.heading": "Endpunkte",
7
+ "overview.endpoints.query": "Liest Daten. Ändert nie etwas.",
8
+ "overview.endpoints.write": "Ändert Daten: anlegen, ändern, löschen oder eine bestimmte Aktion.",
9
+ "overview.endpoints.batch": "Führt mehrere Schreibaufrufe in einer Transaktion aus.",
10
+ "overview.auth.heading": "Authentifizierung",
11
+ "overview.auth.body": "Sende einen API-Token im Header `Authorization` als `Bearer <token>`. Anfragen mit Token brauchen weder Cookie noch CSRF-Token. Der Token legt auch das Konto fest, in dem die Anfrage läuft. Du sendest also nie eine Konto- oder Mandanten-ID.",
12
+ "overview.body.heading": "Request-Body",
13
+ "overview.body.body": "`type` ist der Name des Handlers, zum Beispiel `{exampleType}`. `payload` enthält die Felder aus der Referenz. `requestId` ist optional, siehe unten. Das Payload darf höchstens {maxDepth} Ebenen tief verschachtelt sein.",
14
+ "overview.responses.heading": "Antworten",
15
+ "overview.responses.success": "Ein erfolgreiches Lesen liefert `data`. Ein erfolgreiches Schreiben liefert `isSuccess: true` und `data`.",
16
+ "overview.responses.error": "Bei einem Fehler ist der HTTP-Status 4xx oder 5xx und der Body enthält `error`. Schreibaufrufe liefern zusätzlich `isSuccess: false`. Werte `error.code` und den Status aus. `message` ist für Menschen gedacht und kann sich ändern.",
17
+ "overview.errors.heading": "Fehlercodes",
18
+ "overview.errors.columns": "Code | HTTP-Status | Bedeutung",
19
+ "overview.versions.heading": "Versionen und Konflikte",
20
+ "overview.versions.body": "Jeder Datensatz hat eine `version`. Ein Update nimmt die `version`, die du zuletzt gelesen hast. Hat jemand den Datensatz zwischenzeitlich geändert, schlägt der Aufruf mit 409 `version_conflict` fehl. Lies den Datensatz neu, prüfe die Änderung und sende sie mit der neuen Version.",
21
+ "overview.lists.heading": "Listen",
22
+ "overview.lists.intro": "Listen-Handler enden auf `:list` und akzeptieren diese Felder:",
23
+ "overview.lists.columns": "Feld | Typ | Beschreibung",
24
+ "overview.lists.response": "Die Antwort enthält `rows` und `nextCursor`. Für die nächste Seite sendest du `nextCursor` als `cursor`. Auf der letzten Seite ist `nextCursor` `null`.",
25
+ "overview.batch.heading": "Batches",
26
+ "overview.batch.body": "`POST /api/batch` nimmt `commands`, eine Liste von Schreibaufrufen `{ type, payload }`. Sie laufen in einer Transaktion: Schlägt einer fehl, wirkt keiner. Die Antwort hat dann `isSuccess: false`, den `error` und `failedIndex`, die Position des fehlgeschlagenen Befehls ab 0 gezählt.",
27
+ "overview.retry.heading": "Sicher wiederholen",
28
+ "overview.retry.body": "Sende bei Schreib- und Batch-Aufrufen eine `requestId` mit. Das ist ein beliebiger String, der pro Änderung eindeutig ist. Reißt die Verbindung ab und du sendest denselben Aufruf mit derselben `requestId` erneut, bekommst du das erste Ergebnis zurück und die Änderung läuft nicht doppelt.",
29
+ "tokens.title": "API-Tokens",
30
+ "tokens.description": "Lege einen API-Token für {appName} an, wähle seine Scopes und sende ihn mit deinen Anfragen.",
31
+ "tokens.intro": "Mit einem API-Token kann ein Skript oder ein anderer Dienst die API von {appName} in deinem Namen aufrufen. Seine Scopes bestimmen, welche Daten er lesen oder ändern darf.",
32
+ "tokens.create.heading": "Token anlegen",
33
+ "tokens.create.step1": "Öffne {menuPath}.",
34
+ "tokens.create.step2": "Wähle **{createLabel}**.",
35
+ "tokens.create.step3": "Gib einen Namen ein, wähle die Scopes und das Ablaufdatum und bestätige mit deinem Passwort.",
36
+ "tokens.create.step4": "Kopiere den Token. Er beginnt mit `kpat_` und wird nur einmal angezeigt.",
37
+ "tokens.expiry": "Ein Token läuft nach {defaultDays} Tagen ab, wenn du keinen anderen Ablauf wählst. Möglich sind höchstens {maxDays} Tage.",
38
+ "tokens.use.heading": "Token verwenden",
39
+ "tokens.use.body": "Sende den Token im Header `Authorization`. Anfragen mit Token brauchen weder Cookie noch CSRF-Token.",
40
+ "tokens.scopes.heading": "Scopes",
41
+ "tokens.scopes.intro": "Jeder Scope hat zwei Stufen. `read` erlaubt die lesenden Handler. `write` erlaubt alles, was `read` erlaubt, und zusätzlich die schreibenden Handler.",
42
+ "tokens.scopes.columns": "Scope | Berechtigung | Handler",
43
+ "tokens.rateLimit.heading": "Ratenbegrenzung",
44
+ "tokens.rateLimit": "Jeder Token darf {max} Anfragen pro {windowSeconds} Sekunden senden. Darüber antwortet die API mit 429 `pat_rate_limited`.",
45
+ "tokens.errors.heading": "Fehler",
46
+ "tokens.errors.columns": "HTTP-Status | Code | Ursache",
47
+ "tokens.errors.missing": "Es fehlt der Header `Authorization`.",
48
+ "tokens.errors.invalid": "Der Token ist unbekannt, widerrufen oder abgelaufen.",
49
+ "tokens.errors.scope": "Dem Token fehlt der Scope für diesen Handler.",
50
+ "tokens.errors.route": "Der Endpunkt nimmt keine Tokens an. Tokens funktionieren nur an den API-Endpunkten.",
51
+ "tokens.errors.rate": "Zu viele Anfragen mit diesem Token.",
52
+ "tokens.errors.disabled": "API-Tokens sind nicht Teil deines Tarifs.",
53
+ "tokens.revoke.heading": "Token widerrufen",
54
+ "tokens.revoke.body": "Widerrufe einen Token in {menuPath}, sobald du ihn nicht mehr brauchst. Wenn du dein Passwort änderst, werden alle deine Tokens widerrufen. Ein Token handelt immer mit deinen aktuellen Rollen. Verlässt du das Konto oder wird dein Benutzer gelöscht, funktioniert er nicht mehr.",
55
+ "tokens.security.heading": "Sicherheit",
56
+ "tokens.security.item1": "Behandle einen Token wie ein Passwort. Bewahre ihn in einem Secret Store auf, nie im Code, in einem Repository, in einer App oder Webseite oder in einem Log.",
57
+ "tokens.security.item2": "Gib jedem Skript einen eigenen Token mit nur den Scopes, die es braucht.",
58
+ "tokens.security.item3": "Widerrufe Tokens, die du nicht mehr nutzt. Widerrufe einen Token sofort, wenn er in fremde Hände gelangt sein könnte.",
59
+ "reference.description": "API-Referenz für {scopeLabel}: jeder Handler mit seinen Feldern und einem Beispiel.",
60
+ "reference.requiredScope": "Benötigter Scope",
61
+ "reference.endpoint": "Endpunkt",
62
+ "reference.fields.columns": "Feld | Typ | Pflicht | Beschreibung",
63
+ "reference.yes": "ja",
64
+ "reference.no": "nein",
65
+ "reference.noFields": "Dieser Handler nimmt keine Felder.",
66
+ "reference.excluded": "Über die API nicht setzbar: {fields}.",
67
+ "reference.exampleRequest": "Beispielanfrage",
68
+ "reference.exampleResponse": "Beispielantwort",
69
+ "reference.status": "Status: {status}",
70
+ "events.title": "Webhook-Ereignisse",
71
+ "events.description": "Webhook-Ereignisse: wann sie ausgelöst werden, welchen Scope sie brauchen und was ihre Nutzlast enthält.",
72
+ "events.intro": "Ein Webhook-Ereignis meldet deinem System, dass sich etwas geändert hat. Jedes Ereignis hat einen Namen, eine Version und eine Nutzlast. Der bei einem Ereignis genannte Scope ist der Token-Scope, der das Abonnieren erlaubt.",
73
+ "events.delivery.heading": "Zustellung",
74
+ "events.versions.heading": "Versionen",
75
+ "events.versions.body": "Ein neues optionales Feld behält die Version. Eine inkompatible Änderung, etwa ein entferntes oder umbenanntes Feld oder ein geänderter Typ, bekommt eine neue Version.",
76
+ "events.list.heading": "Ereignisse",
77
+ "events.version": "Version",
78
+ "events.requiredScope": "Benötigter Scope",
79
+ "events.example": "Beispiel-Nutzlast",
80
+ "events.noFields": "Dieses Ereignis enthält keine Felder.",
81
+ "events.entity.created": "Ein Datensatz vom Typ {entity} wurde angelegt.",
82
+ "events.entity.updated": "Ein Datensatz vom Typ {entity} wurde geändert.",
83
+ "events.entity.deleted": "Ein Datensatz vom Typ {entity} wurde gelöscht.",
84
+ },
85
+ errorMeanings: {
86
+ validation_error: "Das Payload passt nicht zu den Feldern des Handlers. `details` nennt die Felder.",
87
+ unauthenticated: "Es wurden keine gültigen Zugangsdaten gesendet.",
88
+ missing_token: "Der Header `Authorization` fehlt.",
89
+ invalid_token: "Der Token ist unbekannt, widerrufen oder abgelaufen.",
90
+ ambiguous_auth: "Die Anfrage enthielt Session-Cookie und Token. Sende nur eines von beiden.",
91
+ access_denied: "Dem Token fehlt der Scope für diesen Handler, oder der Endpunkt nimmt keine Tokens an.",
92
+ feature_disabled: "Diese Funktion ist abgeschaltet oder nicht Teil deines Tarifs.",
93
+ not_found: "Der Datensatz existiert nicht oder du darfst ihn nicht sehen.",
94
+ conflict: "Die Änderung widerspricht dem aktuellen Stand der Daten.",
95
+ version_conflict: "Der Datensatz hat sich nach deinem Lesen geändert. Lies ihn neu und wiederhole mit der neuen `version`.",
96
+ precondition_failed: "Ein Feld des Datensatzes hat nicht mehr den Wert, den die Änderung erwartet hat. Lies den Datensatz neu und wiederhole.",
97
+ record_locked: "Eine andere Änderung sperrt den Datensatz. Wiederhole gleich.",
98
+ idempotent_replay: "Diese Änderung wurde unter demselben Idempotenz-Schlüssel schon ausgeführt. Der erste Versuch war erfolgreich, sende sie nicht noch einmal.",
99
+ unique_violation: "Ein Datensatz mit diesem Wert existiert bereits.",
100
+ unprocessable: "Die Daten sind gültig, aber eine Fachregel lehnt die Änderung ab. `details.reason` nennt die Regel.",
101
+ unconfigured: "Eine Einstellung, die diese Funktion braucht, ist noch leer. Richte sie zuerst in der App ein und wiederhole dann.",
102
+ internal_error: "Unerwarteter Serverfehler. Wiederhole später.",
103
+ member_read_timeout: "Ein Lesevorgang auf dem Server hat zu lange gedauert und wurde abgebrochen. Wiederhole später.",
104
+ rate_limited: "Zu viele Anfragen. Warte so viele Sekunden, wie der Header `Retry-After` angibt.",
105
+ rate_limit_unavailable: "Die Ratenbegrenzung ist vorübergehend nicht verfügbar, die Anfrage wurde abgelehnt. Wiederhole gleich.",
106
+ pat_rate_limited: "Dieser Token hat in kurzer Zeit zu viele Anfragen gesendet. Warte einen Moment und wiederhole.",
107
+ },
108
+ listParameters: {
109
+ cursor: "Position aus `nextCursor` der vorherigen Seite.",
110
+ limit: "Zeilen pro Seite, standardmäßig {default}, höchstens {max}.",
111
+ search: "Volltextsuche über die durchsuchbaren Felder.",
112
+ sort: "Feld, nach dem sortiert wird.",
113
+ sortDirection: "`asc` oder `desc`.",
114
+ offset: "Anzahl der zu überspringenden Zeilen. Nutze besser `cursor` zum Blättern.",
115
+ totalCount: "Mit `true` bekommst du zusätzlich `total`, die Anzahl der passenden Zeilen.",
116
+ includeDeleted: "Mit `true` sind gelöschte Zeilen enthalten. Nur für Entitäten mit Soft Delete.",
117
+ onlyDeleted: "Mit `true` kommen nur gelöschte Zeilen zurück. Nur für Entitäten mit Soft Delete, nicht zusammen mit `includeDeleted`.",
118
+ filter: "Ein Feldfilter mit `field`, `op` und `value`. `op` ist einer von {ops}.",
119
+ filters: "Mehrere Feldfilter, je mit `field`, `op` und `value`. `op` ist einer von {ops}.",
120
+ namedFilter: "Name eines vordefinierten Filters der Entität, zum Beispiel einer Arbeitsliste.",
121
+ aggregate: "Liefert aggregierte Werte statt Zeilen.",
122
+ },
123
+ };
@@ -0,0 +1,123 @@
1
+ export declare const enApiDocsTexts: {
2
+ readonly text: {
3
+ readonly "overview.title": "HTTP API";
4
+ readonly "overview.description": "Endpoints, request body, responses, error codes, lists and batches of the HTTP API.";
5
+ readonly "overview.intro": "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.";
6
+ readonly "overview.endpoints.heading": "Endpoints";
7
+ readonly "overview.endpoints.query": "Reads data. Never changes anything.";
8
+ readonly "overview.endpoints.write": "Changes data: create, update, delete or a specific action.";
9
+ readonly "overview.endpoints.batch": "Runs several write calls in one transaction.";
10
+ readonly "overview.auth.heading": "Authentication";
11
+ readonly "overview.auth.body": "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.";
12
+ readonly "overview.body.heading": "Request body";
13
+ readonly "overview.body.body": "`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.";
14
+ readonly "overview.responses.heading": "Responses";
15
+ readonly "overview.responses.success": "A successful read returns `data`. A successful write returns `isSuccess: true` and `data`.";
16
+ readonly "overview.responses.error": "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.";
17
+ readonly "overview.errors.heading": "Error codes";
18
+ readonly "overview.errors.columns": "Code | HTTP status | Meaning";
19
+ readonly "overview.versions.heading": "Versions and conflicts";
20
+ readonly "overview.versions.body": "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.";
21
+ readonly "overview.lists.heading": "Lists";
22
+ readonly "overview.lists.intro": "List handlers end in `:list` and accept these fields:";
23
+ readonly "overview.lists.columns": "Field | Type | Description";
24
+ readonly "overview.lists.response": "The response contains `rows` and `nextCursor`. For the next page send `nextCursor` as `cursor`. On the last page `nextCursor` is `null`.";
25
+ readonly "overview.batch.heading": "Batches";
26
+ readonly "overview.batch.body": "`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.";
27
+ readonly "overview.retry.heading": "Safe retries";
28
+ readonly "overview.retry.body": "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.";
29
+ readonly "tokens.title": "API tokens";
30
+ readonly "tokens.description": "Create an API token for {appName}, choose its scopes and send it with your requests.";
31
+ readonly "tokens.intro": "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.";
32
+ readonly "tokens.create.heading": "Create a token";
33
+ readonly "tokens.create.step1": "Open {menuPath}.";
34
+ readonly "tokens.create.step2": "Choose **{createLabel}**.";
35
+ readonly "tokens.create.step3": "Enter a name, pick the scopes and the expiry, and confirm with your password.";
36
+ readonly "tokens.create.step4": "Copy the token. It starts with `kpat_` and is shown only once.";
37
+ readonly "tokens.expiry": "A token expires after {defaultDays} days unless you pick another expiry. The longest possible expiry is {maxDays} days.";
38
+ readonly "tokens.use.heading": "Use the token";
39
+ readonly "tokens.use.body": "Send the token in the `Authorization` header. Requests with a token need no cookie and no CSRF token.";
40
+ readonly "tokens.scopes.heading": "Scopes";
41
+ readonly "tokens.scopes.intro": "Each scope comes in two levels. `read` allows the read handlers. `write` allows everything `read` allows plus the write handlers.";
42
+ readonly "tokens.scopes.columns": "Scope | Grant | Handlers";
43
+ readonly "tokens.rateLimit.heading": "Rate limit";
44
+ readonly "tokens.rateLimit": "Each token may send {max} requests per {windowSeconds} seconds. Above that the API answers 429 `pat_rate_limited`.";
45
+ readonly "tokens.errors.heading": "Errors";
46
+ readonly "tokens.errors.columns": "HTTP status | Code | Cause";
47
+ readonly "tokens.errors.missing": "No `Authorization` header.";
48
+ readonly "tokens.errors.invalid": "The token is unknown, revoked or expired.";
49
+ readonly "tokens.errors.scope": "The token lacks the scope for this handler.";
50
+ readonly "tokens.errors.route": "The endpoint does not accept tokens. Tokens work only on the API endpoints.";
51
+ readonly "tokens.errors.rate": "Too many requests from this token.";
52
+ readonly "tokens.errors.disabled": "API tokens are not part of your plan.";
53
+ readonly "tokens.revoke.heading": "Revoke a token";
54
+ readonly "tokens.revoke.body": "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.";
55
+ readonly "tokens.security.heading": "Security";
56
+ readonly "tokens.security.item1": "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.";
57
+ readonly "tokens.security.item2": "Give each script its own token with only the scopes it needs.";
58
+ readonly "tokens.security.item3": "Revoke tokens you no longer use. Revoke a token at once if it may have leaked.";
59
+ readonly "reference.description": "API reference for {scopeLabel}: every handler with its fields and an example.";
60
+ readonly "reference.requiredScope": "Required scope";
61
+ readonly "reference.endpoint": "Endpoint";
62
+ readonly "reference.fields.columns": "Field | Type | Required | Description";
63
+ readonly "reference.yes": "yes";
64
+ readonly "reference.no": "no";
65
+ readonly "reference.noFields": "This handler takes no fields.";
66
+ readonly "reference.excluded": "Not settable through the API: {fields}.";
67
+ readonly "reference.exampleRequest": "Example request";
68
+ readonly "reference.exampleResponse": "Example response";
69
+ readonly "reference.status": "Status: {status}";
70
+ readonly "events.title": "Webhook events";
71
+ readonly "events.description": "Webhook events: when they fire, which scope they need and what their payload contains.";
72
+ readonly "events.intro": "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.";
73
+ readonly "events.delivery.heading": "Delivery";
74
+ readonly "events.versions.heading": "Versions";
75
+ readonly "events.versions.body": "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.";
76
+ readonly "events.list.heading": "Events";
77
+ readonly "events.version": "Version";
78
+ readonly "events.requiredScope": "Required scope";
79
+ readonly "events.example": "Example payload";
80
+ readonly "events.noFields": "This event carries no fields.";
81
+ readonly "events.entity.created": "A record of type {entity} was created.";
82
+ readonly "events.entity.updated": "A record of type {entity} was updated.";
83
+ readonly "events.entity.deleted": "A record of type {entity} was deleted.";
84
+ };
85
+ readonly errorMeanings: {
86
+ readonly validation_error: "The payload does not match the handler's fields. `details` names the fields.";
87
+ readonly unauthenticated: "No valid credentials were sent.";
88
+ readonly missing_token: "The `Authorization` header is missing.";
89
+ readonly invalid_token: "The token is unknown, revoked or expired.";
90
+ readonly ambiguous_auth: "The request carried both a session cookie and a token. Send only one.";
91
+ readonly access_denied: "The token lacks the scope for this handler, or the endpoint does not accept tokens.";
92
+ readonly feature_disabled: "This function is switched off or not part of your plan.";
93
+ readonly not_found: "The record does not exist or you cannot see it.";
94
+ readonly conflict: "The change conflicts with the current state of the data.";
95
+ readonly version_conflict: "The record changed after you read it. Read it again and retry with the new `version`.";
96
+ readonly precondition_failed: "A field of the record no longer has the value the change expected. Read the record again and retry.";
97
+ readonly record_locked: "Another change holds a lock on the record. Retry shortly.";
98
+ readonly idempotent_replay: "This change was already applied under the same idempotency key. The first attempt succeeded, so do not send it again.";
99
+ readonly unique_violation: "A record with this value already exists.";
100
+ readonly unprocessable: "The data is valid, but a business rule rejects the change. `details.reason` names the rule.";
101
+ readonly unconfigured: "A setting this function needs is still empty. Set it up in the app first, then retry.";
102
+ readonly internal_error: "Unexpected server error. Retry later.";
103
+ readonly member_read_timeout: "A read on the server took too long and was stopped. Retry later.";
104
+ readonly rate_limited: "Too many requests. Wait as many seconds as the `Retry-After` header says.";
105
+ readonly rate_limit_unavailable: "The rate limiter is temporarily unavailable, so the request was refused. Retry shortly.";
106
+ readonly pat_rate_limited: "This token sent too many requests in a short time. Wait a moment and retry.";
107
+ };
108
+ readonly listParameters: {
109
+ readonly cursor: "Position from `nextCursor` of the previous page.";
110
+ readonly limit: "Rows per page, {default} by default, at most {max}.";
111
+ readonly search: "Full-text search across the searchable fields.";
112
+ readonly sort: "Field to sort by.";
113
+ readonly sortDirection: "`asc` or `desc`.";
114
+ readonly offset: "Number of rows to skip. Prefer `cursor` for paging.";
115
+ readonly totalCount: "Set `true` to also get `total`, the number of matching rows.";
116
+ readonly includeDeleted: "Set `true` to include deleted rows. Only for entities with soft delete.";
117
+ readonly onlyDeleted: "Set `true` to return only deleted rows. Only for entities with soft delete, not together with `includeDeleted`.";
118
+ readonly filter: "One field filter with `field`, `op` and `value`. `op` is one of {ops}.";
119
+ readonly filters: "Several field filters, each with `field`, `op` and `value`. `op` is one of {ops}.";
120
+ readonly namedFilter: "Name of a predefined filter of the entity, for example a work queue.";
121
+ readonly aggregate: "Returns aggregated values instead of rows.";
122
+ };
123
+ };
@@ -0,0 +1,123 @@
1
+ export const enApiDocsTexts = {
2
+ text: {
3
+ "overview.title": "HTTP API",
4
+ "overview.description": "Endpoints, request body, responses, error codes, lists and batches of the HTTP API.",
5
+ "overview.intro": "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.",
6
+ "overview.endpoints.heading": "Endpoints",
7
+ "overview.endpoints.query": "Reads data. Never changes anything.",
8
+ "overview.endpoints.write": "Changes data: create, update, delete or a specific action.",
9
+ "overview.endpoints.batch": "Runs several write calls in one transaction.",
10
+ "overview.auth.heading": "Authentication",
11
+ "overview.auth.body": "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.",
12
+ "overview.body.heading": "Request body",
13
+ "overview.body.body": "`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.",
14
+ "overview.responses.heading": "Responses",
15
+ "overview.responses.success": "A successful read returns `data`. A successful write returns `isSuccess: true` and `data`.",
16
+ "overview.responses.error": "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.",
17
+ "overview.errors.heading": "Error codes",
18
+ "overview.errors.columns": "Code | HTTP status | Meaning",
19
+ "overview.versions.heading": "Versions and conflicts",
20
+ "overview.versions.body": "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.",
21
+ "overview.lists.heading": "Lists",
22
+ "overview.lists.intro": "List handlers end in `:list` and accept these fields:",
23
+ "overview.lists.columns": "Field | Type | Description",
24
+ "overview.lists.response": "The response contains `rows` and `nextCursor`. For the next page send `nextCursor` as `cursor`. On the last page `nextCursor` is `null`.",
25
+ "overview.batch.heading": "Batches",
26
+ "overview.batch.body": "`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.",
27
+ "overview.retry.heading": "Safe retries",
28
+ "overview.retry.body": "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.",
29
+ "tokens.title": "API tokens",
30
+ "tokens.description": "Create an API token for {appName}, choose its scopes and send it with your requests.",
31
+ "tokens.intro": "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.",
32
+ "tokens.create.heading": "Create a token",
33
+ "tokens.create.step1": "Open {menuPath}.",
34
+ "tokens.create.step2": "Choose **{createLabel}**.",
35
+ "tokens.create.step3": "Enter a name, pick the scopes and the expiry, and confirm with your password.",
36
+ "tokens.create.step4": "Copy the token. It starts with `kpat_` and is shown only once.",
37
+ "tokens.expiry": "A token expires after {defaultDays} days unless you pick another expiry. The longest possible expiry is {maxDays} days.",
38
+ "tokens.use.heading": "Use the token",
39
+ "tokens.use.body": "Send the token in the `Authorization` header. Requests with a token need no cookie and no CSRF token.",
40
+ "tokens.scopes.heading": "Scopes",
41
+ "tokens.scopes.intro": "Each scope comes in two levels. `read` allows the read handlers. `write` allows everything `read` allows plus the write handlers.",
42
+ "tokens.scopes.columns": "Scope | Grant | Handlers",
43
+ "tokens.rateLimit.heading": "Rate limit",
44
+ "tokens.rateLimit": "Each token may send {max} requests per {windowSeconds} seconds. Above that the API answers 429 `pat_rate_limited`.",
45
+ "tokens.errors.heading": "Errors",
46
+ "tokens.errors.columns": "HTTP status | Code | Cause",
47
+ "tokens.errors.missing": "No `Authorization` header.",
48
+ "tokens.errors.invalid": "The token is unknown, revoked or expired.",
49
+ "tokens.errors.scope": "The token lacks the scope for this handler.",
50
+ "tokens.errors.route": "The endpoint does not accept tokens. Tokens work only on the API endpoints.",
51
+ "tokens.errors.rate": "Too many requests from this token.",
52
+ "tokens.errors.disabled": "API tokens are not part of your plan.",
53
+ "tokens.revoke.heading": "Revoke a token",
54
+ "tokens.revoke.body": "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.",
55
+ "tokens.security.heading": "Security",
56
+ "tokens.security.item1": "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.",
57
+ "tokens.security.item2": "Give each script its own token with only the scopes it needs.",
58
+ "tokens.security.item3": "Revoke tokens you no longer use. Revoke a token at once if it may have leaked.",
59
+ "reference.description": "API reference for {scopeLabel}: every handler with its fields and an example.",
60
+ "reference.requiredScope": "Required scope",
61
+ "reference.endpoint": "Endpoint",
62
+ "reference.fields.columns": "Field | Type | Required | Description",
63
+ "reference.yes": "yes",
64
+ "reference.no": "no",
65
+ "reference.noFields": "This handler takes no fields.",
66
+ "reference.excluded": "Not settable through the API: {fields}.",
67
+ "reference.exampleRequest": "Example request",
68
+ "reference.exampleResponse": "Example response",
69
+ "reference.status": "Status: {status}",
70
+ "events.title": "Webhook events",
71
+ "events.description": "Webhook events: when they fire, which scope they need and what their payload contains.",
72
+ "events.intro": "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.",
73
+ "events.delivery.heading": "Delivery",
74
+ "events.versions.heading": "Versions",
75
+ "events.versions.body": "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.",
76
+ "events.list.heading": "Events",
77
+ "events.version": "Version",
78
+ "events.requiredScope": "Required scope",
79
+ "events.example": "Example payload",
80
+ "events.noFields": "This event carries no fields.",
81
+ "events.entity.created": "A record of type {entity} was created.",
82
+ "events.entity.updated": "A record of type {entity} was updated.",
83
+ "events.entity.deleted": "A record of type {entity} was deleted.",
84
+ },
85
+ errorMeanings: {
86
+ validation_error: "The payload does not match the handler's fields. `details` names the fields.",
87
+ unauthenticated: "No valid credentials were sent.",
88
+ missing_token: "The `Authorization` header is missing.",
89
+ invalid_token: "The token is unknown, revoked or expired.",
90
+ ambiguous_auth: "The request carried both a session cookie and a token. Send only one.",
91
+ access_denied: "The token lacks the scope for this handler, or the endpoint does not accept tokens.",
92
+ feature_disabled: "This function is switched off or not part of your plan.",
93
+ not_found: "The record does not exist or you cannot see it.",
94
+ conflict: "The change conflicts with the current state of the data.",
95
+ version_conflict: "The record changed after you read it. Read it again and retry with the new `version`.",
96
+ precondition_failed: "A field of the record no longer has the value the change expected. Read the record again and retry.",
97
+ record_locked: "Another change holds a lock on the record. Retry shortly.",
98
+ idempotent_replay: "This change was already applied under the same idempotency key. The first attempt succeeded, so do not send it again.",
99
+ unique_violation: "A record with this value already exists.",
100
+ unprocessable: "The data is valid, but a business rule rejects the change. `details.reason` names the rule.",
101
+ unconfigured: "A setting this function needs is still empty. Set it up in the app first, then retry.",
102
+ internal_error: "Unexpected server error. Retry later.",
103
+ member_read_timeout: "A read on the server took too long and was stopped. Retry later.",
104
+ rate_limited: "Too many requests. Wait as many seconds as the `Retry-After` header says.",
105
+ rate_limit_unavailable: "The rate limiter is temporarily unavailable, so the request was refused. Retry shortly.",
106
+ pat_rate_limited: "This token sent too many requests in a short time. Wait a moment and retry.",
107
+ },
108
+ listParameters: {
109
+ cursor: "Position from `nextCursor` of the previous page.",
110
+ limit: "Rows per page, {default} by default, at most {max}.",
111
+ search: "Full-text search across the searchable fields.",
112
+ sort: "Field to sort by.",
113
+ sortDirection: "`asc` or `desc`.",
114
+ offset: "Number of rows to skip. Prefer `cursor` for paging.",
115
+ totalCount: "Set `true` to also get `total`, the number of matching rows.",
116
+ includeDeleted: "Set `true` to include deleted rows. Only for entities with soft delete.",
117
+ onlyDeleted: "Set `true` to return only deleted rows. Only for entities with soft delete, not together with `includeDeleted`.",
118
+ filter: "One field filter with `field`, `op` and `value`. `op` is one of {ops}.",
119
+ filters: "Several field filters, each with `field`, `op` and `value`. `op` is one of {ops}.",
120
+ namedFilter: "Name of a predefined filter of the entity, for example a work queue.",
121
+ aggregate: "Returns aggregated values instead of rows.",
122
+ },
123
+ };