adula 2.1.0 → 2.3.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 (269) hide show
  1. package/README.md +149 -18
  2. package/build/agent/AGENTS.template.md +4 -4
  3. package/build/agent/capabilities.md +22 -12
  4. package/build/agent/skills/adula-frontend-design/SKILL.md +6 -4
  5. package/build/agent/skills/idea-review/SKILL.md +2 -2
  6. package/build/commands/adula_assistant_prune.d.ts +10 -0
  7. package/build/commands/adula_assistant_prune.js +12 -0
  8. package/build/commands/adula_outbox.d.ts +10 -0
  9. package/build/commands/adula_outbox.js +11 -0
  10. package/build/commands/adula_restore_reconcile.d.ts +10 -0
  11. package/build/commands/adula_restore_reconcile.js +34 -0
  12. package/build/commands/adula_runtime_health.d.ts +10 -0
  13. package/build/commands/adula_runtime_health.js +27 -0
  14. package/build/commands/adula_uploads_prune.d.ts +10 -0
  15. package/build/commands/adula_uploads_prune.js +16 -0
  16. package/build/commands/app.d.ts +10 -0
  17. package/build/commands/app.js +64 -0
  18. package/build/commands/backup_create.d.ts +11 -0
  19. package/build/commands/backup_create.js +99 -0
  20. package/build/commands/backup_open.d.ts +16 -0
  21. package/build/commands/backup_open.js +48 -0
  22. package/build/commands/backup_restore_files.d.ts +11 -0
  23. package/build/commands/backup_restore_files.js +44 -0
  24. package/build/commands/backup_restore_test.d.ts +12 -0
  25. package/build/commands/backup_restore_test.js +188 -0
  26. package/build/commands/backup_seal.d.ts +12 -0
  27. package/build/commands/backup_seal.js +36 -0
  28. package/build/commands/backup_services.d.ts +33 -0
  29. package/build/commands/backup_services.js +6 -0
  30. package/build/commands/backup_verify.d.ts +9 -0
  31. package/build/commands/backup_verify.js +59 -0
  32. package/build/commands/backup_verify_snapshot.d.ts +10 -0
  33. package/build/commands/backup_verify_snapshot.js +37 -0
  34. package/build/commands/client.d.ts +16 -0
  35. package/build/commands/client.js +71 -0
  36. package/build/commands/doctor.js +21 -1
  37. package/build/commands/install.d.ts +8 -0
  38. package/build/commands/install.js +69 -45
  39. package/build/commands/main.d.ts +3 -2
  40. package/build/commands/main.js +32 -0
  41. package/build/commands/module_add.js +4 -20
  42. package/build/commands/resource.d.ts +2 -0
  43. package/build/commands/resource.js +12 -3
  44. package/build/commands/resource_migration.d.ts +15 -0
  45. package/build/commands/resource_migration.js +81 -0
  46. package/build/commands/resource_snapshot.d.ts +2 -0
  47. package/build/commands/resource_snapshot.js +21 -4
  48. package/build/commands/sla_evaluate.d.ts +14 -0
  49. package/build/commands/sla_evaluate.js +16 -0
  50. package/build/commands/ui.js +4 -2
  51. package/build/commands/ui_css.d.ts +9 -0
  52. package/build/commands/ui_css.js +19 -0
  53. package/build/commands/upgrade.d.ts +1 -1
  54. package/build/commands/upgrade.js +1 -1
  55. package/build/configure.js +1 -1
  56. package/build/database/migrations/1770000000020_two_factor.d.ts +5 -0
  57. package/build/database/migrations/1770000000020_two_factor.js +10 -0
  58. package/build/database/migrations/1770000000041_import_modes.d.ts +5 -0
  59. package/build/database/migrations/1770000000041_import_modes.js +10 -0
  60. package/build/database/migrations/1770000000042_sync_jobs.d.ts +5 -0
  61. package/build/database/migrations/1770000000042_sync_jobs.js +10 -0
  62. package/build/database/migrations/1770000000043_notification_channels.d.ts +5 -0
  63. package/build/database/migrations/1770000000043_notification_channels.js +10 -0
  64. package/build/database/migrations/1770000000044_channel_confirmations.d.ts +5 -0
  65. package/build/database/migrations/1770000000044_channel_confirmations.js +10 -0
  66. package/build/database/migrations/1770000000045_import_leases.d.ts +5 -0
  67. package/build/database/migrations/1770000000045_import_leases.js +10 -0
  68. package/build/database/migrations/1770000000046_workflow_delegation_sla.d.ts +5 -0
  69. package/build/database/migrations/1770000000046_workflow_delegation_sla.js +10 -0
  70. package/build/database/migrations/1770000000049_print_templates.d.ts +5 -0
  71. package/build/database/migrations/1770000000049_print_templates.js +10 -0
  72. package/build/database/migrations/1770000000051_comment_notifications.d.ts +5 -0
  73. package/build/database/migrations/1770000000051_comment_notifications.js +10 -0
  74. package/build/database/migrations/1770000000054_cloud_backups.d.ts +5 -0
  75. package/build/database/migrations/1770000000054_cloud_backups.js +10 -0
  76. package/build/database/migrations/1770000000055_ai_assistant.d.ts +5 -0
  77. package/build/database/migrations/1770000000055_ai_assistant.js +10 -0
  78. package/build/database/migrations/1770000000056_appearance.d.ts +5 -0
  79. package/build/database/migrations/1770000000056_appearance.js +10 -0
  80. package/build/index.d.ts +87 -11
  81. package/build/index.js +50 -7
  82. package/build/providers/adula_provider.d.ts +2 -0
  83. package/build/providers/adula_provider.js +7 -0
  84. package/build/src/admin/contracts.js +1 -1
  85. package/build/src/admin/controller.d.ts +14 -1
  86. package/build/src/admin/controller.js +91 -13
  87. package/build/src/admin/errors.d.ts +32 -0
  88. package/build/src/admin/errors.js +63 -1
  89. package/build/src/admin/presentation.d.ts +21 -2
  90. package/build/src/admin/resource/editor.d.ts +60 -0
  91. package/build/src/admin/resource/editor.js +345 -0
  92. package/build/src/admin/resource/export.d.ts +54 -0
  93. package/build/src/admin/resource/export.js +262 -0
  94. package/build/src/admin/resource/lifecycle.d.ts +23 -0
  95. package/build/src/admin/resource/lifecycle.js +91 -0
  96. package/build/src/admin/resource/query.d.ts +111 -0
  97. package/build/src/admin/resource/query.js +595 -0
  98. package/build/src/admin/resource/read.d.ts +109 -0
  99. package/build/src/admin/resource/read.js +388 -0
  100. package/build/src/admin/resource/shared.d.ts +93 -0
  101. package/build/src/admin/resource/shared.js +265 -0
  102. package/build/src/admin/resource/trash.d.ts +10 -0
  103. package/build/src/admin/resource/trash.js +56 -0
  104. package/build/src/admin/resource/write.d.ts +57 -0
  105. package/build/src/admin/resource/write.js +603 -0
  106. package/build/src/admin/resource_service.d.ts +80 -193
  107. package/build/src/admin/resource_service.js +81 -1343
  108. package/build/src/admin/resource_tools.d.ts +111 -0
  109. package/build/src/admin/resource_tools.js +139 -0
  110. package/build/src/ai/assistant.d.ts +100 -0
  111. package/build/src/ai/assistant.js +487 -0
  112. package/build/src/ai/client.d.ts +49 -0
  113. package/build/src/ai/client.js +85 -0
  114. package/build/src/ai/prompt.d.ts +23 -0
  115. package/build/src/ai/prompt.js +83 -0
  116. package/build/src/ai/settings.d.ts +56 -0
  117. package/build/src/ai/settings.js +214 -0
  118. package/build/src/ai/usage.d.ts +16 -0
  119. package/build/src/ai/usage.js +33 -0
  120. package/build/src/appearance/appearance.d.ts +134 -0
  121. package/build/src/appearance/appearance.js +461 -0
  122. package/build/src/appearance/colors.d.ts +43 -0
  123. package/build/src/appearance/colors.js +99 -0
  124. package/build/src/appearance/logo.d.ts +32 -0
  125. package/build/src/appearance/logo.js +112 -0
  126. package/build/src/attachments/attachment_service.d.ts +46 -2
  127. package/build/src/attachments/attachment_service.js +96 -4
  128. package/build/src/auth/actor_store.d.ts +5 -1
  129. package/build/src/auth/actor_store.js +8 -4
  130. package/build/src/auth/conditions.d.ts +5 -0
  131. package/build/src/auth/conditions.js +26 -3
  132. package/build/src/auth/sql.js +17 -5
  133. package/build/src/auth/two_factor.d.ts +96 -0
  134. package/build/src/auth/two_factor.js +259 -0
  135. package/build/src/backups/archive.d.ts +52 -0
  136. package/build/src/backups/archive.js +362 -0
  137. package/build/src/backups/cloud_backups.d.ts +133 -0
  138. package/build/src/backups/cloud_backups.js +650 -0
  139. package/build/src/backups/doctor.d.ts +7 -0
  140. package/build/src/backups/doctor.js +55 -0
  141. package/build/src/backups/providers.d.ts +81 -0
  142. package/build/src/backups/providers.js +470 -0
  143. package/build/src/collaboration/assignments.d.ts +59 -2
  144. package/build/src/collaboration/assignments.js +196 -74
  145. package/build/src/collaboration/record_collaboration.d.ts +21 -4
  146. package/build/src/collaboration/record_collaboration.js +126 -51
  147. package/build/src/collaboration/shared.d.ts +24 -0
  148. package/build/src/collaboration/shared.js +34 -0
  149. package/build/src/commands/app_scaffold.d.ts +72 -0
  150. package/build/src/commands/app_scaffold.js +285 -0
  151. package/build/src/commands/capabilities.js +35 -9
  152. package/build/src/commands/doctor.d.ts +24 -2
  153. package/build/src/commands/doctor.js +81 -6
  154. package/build/src/commands/gap_report.d.ts +1 -1
  155. package/build/src/commands/gap_report.js +2 -2
  156. package/build/src/commands/generator.d.ts +37 -1
  157. package/build/src/commands/generator.js +61 -18
  158. package/build/src/commands/snapshot.d.ts +24 -13
  159. package/build/src/commands/snapshot.js +54 -14
  160. package/build/src/commands/source_markers.d.ts +10 -0
  161. package/build/src/commands/source_markers.js +29 -0
  162. package/build/src/core/activity.d.ts +2 -0
  163. package/build/src/core/activity.js +7 -1
  164. package/build/src/core/administrators.d.ts +38 -0
  165. package/build/src/core/administrators.js +145 -0
  166. package/build/src/core/avatar_image.d.ts +33 -0
  167. package/build/src/core/avatar_image.js +278 -0
  168. package/build/src/core/html_sanitizer.d.ts +20 -0
  169. package/build/src/core/html_sanitizer.js +261 -0
  170. package/build/src/core/like.d.ts +5 -0
  171. package/build/src/core/like.js +5 -0
  172. package/build/src/core/lookups.d.ts +80 -0
  173. package/build/src/core/lookups.js +319 -0
  174. package/build/src/core/mail_settings.d.ts +83 -0
  175. package/build/src/core/mail_settings.js +274 -0
  176. package/build/src/core/mail_test.d.ts +16 -0
  177. package/build/src/core/mail_test.js +81 -6
  178. package/build/src/core/message_templates.d.ts +15 -2
  179. package/build/src/core/message_templates.js +81 -11
  180. package/build/src/core/module_seed.js +2 -1
  181. package/build/src/core/notification_channels.d.ts +235 -0
  182. package/build/src/core/notification_channels.js +660 -0
  183. package/build/src/core/roles.js +26 -9
  184. package/build/src/core/saved_views.d.ts +8 -1
  185. package/build/src/core/saved_views.js +91 -26
  186. package/build/src/core/sequences.d.ts +32 -0
  187. package/build/src/core/sequences.js +97 -0
  188. package/build/src/core/settings.d.ts +5 -0
  189. package/build/src/core/settings.js +31 -3
  190. package/build/src/core/template_language.d.ts +61 -0
  191. package/build/src/core/template_language.js +141 -0
  192. package/build/src/core/ui_preferences.d.ts +10 -0
  193. package/build/src/core/ui_preferences.js +15 -1
  194. package/build/src/core/user_avatars.d.ts +79 -0
  195. package/build/src/core/user_avatars.js +186 -0
  196. package/build/src/core/user_invitations.d.ts +5 -1
  197. package/build/src/core/user_invitations.js +7 -1
  198. package/build/src/core/user_preferences.d.ts +36 -0
  199. package/build/src/core/user_preferences.js +125 -0
  200. package/build/src/core/users.d.ts +2 -0
  201. package/build/src/core/users.js +5 -3
  202. package/build/src/database/calendar_days.d.ts +19 -0
  203. package/build/src/database/calendar_days.js +36 -0
  204. package/build/src/database/schema.d.ts +201 -2
  205. package/build/src/database/schema.js +713 -59
  206. package/build/src/database/schema_diff.d.ts +70 -0
  207. package/build/src/database/schema_diff.js +190 -0
  208. package/build/src/events/record_mutation.d.ts +2 -1
  209. package/build/src/events/record_mutation.js +1 -0
  210. package/build/src/integrations/api_client.d.ts +37 -0
  211. package/build/src/integrations/api_client.js +567 -0
  212. package/build/src/integrations/import_adapters.d.ts +37 -0
  213. package/build/src/integrations/import_adapters.js +35 -0
  214. package/build/src/integrations/imports.d.ts +130 -16
  215. package/build/src/integrations/imports.js +434 -73
  216. package/build/src/integrations/openapi.d.ts +3 -1
  217. package/build/src/integrations/openapi.js +465 -31
  218. package/build/src/integrations/outbound.d.ts +94 -0
  219. package/build/src/integrations/outbound.js +276 -0
  220. package/build/src/integrations/print.d.ts +22 -1
  221. package/build/src/integrations/print.js +68 -22
  222. package/build/src/integrations/print_templates.d.ts +216 -0
  223. package/build/src/integrations/print_templates.js +1017 -0
  224. package/build/src/integrations/sync_jobs.d.ts +139 -0
  225. package/build/src/integrations/sync_jobs.js +416 -0
  226. package/build/src/integrations/webhooks.d.ts +12 -12
  227. package/build/src/integrations/webhooks.js +34 -43
  228. package/build/src/integrations/xlsx.d.ts +41 -0
  229. package/build/src/integrations/xlsx.js +519 -0
  230. package/build/src/languages/ar.d.ts +11 -0
  231. package/build/src/languages/ar.js +358 -0
  232. package/build/src/languages/ar_ui.d.ts +461 -0
  233. package/build/src/languages/ar_ui.js +464 -0
  234. package/build/src/languages/catalog.d.ts +66 -0
  235. package/build/src/languages/catalog.js +152 -0
  236. package/build/src/languages/en.d.ts +7 -0
  237. package/build/src/languages/en.js +352 -0
  238. package/build/src/languages/en_ui.d.ts +3 -0
  239. package/build/src/languages/en_ui.js +458 -0
  240. package/build/src/languages/validation.d.ts +26 -0
  241. package/build/src/languages/validation.js +60 -0
  242. package/build/src/lists/bulk_actions.d.ts +89 -0
  243. package/build/src/lists/bulk_actions.js +268 -0
  244. package/build/src/lists/dashboards.d.ts +138 -0
  245. package/build/src/lists/dashboards.js +290 -0
  246. package/build/src/mcp/tools.js +9 -104
  247. package/build/src/resource/define_resource.d.ts +18 -1
  248. package/build/src/resource/define_resource.js +212 -18
  249. package/build/src/resource/definition.d.ts +44 -0
  250. package/build/src/resource/definition.js +171 -0
  251. package/build/src/resource/registry.js +15 -4
  252. package/build/src/resource/types.d.ts +313 -16
  253. package/build/src/resource/values.d.ts +56 -1
  254. package/build/src/resource/values.js +237 -5
  255. package/build/src/services/settings.d.ts +2 -0
  256. package/build/src/services/settings.js +5 -1
  257. package/build/src/upgrade/legacy.js +2 -2
  258. package/build/src/workflows/calendar.d.ts +9 -0
  259. package/build/src/workflows/calendar.js +44 -0
  260. package/build/src/workflows/define_workflow.d.ts +48 -3
  261. package/build/src/workflows/define_workflow.js +57 -13
  262. package/build/src/workflows/delegations.d.ts +107 -0
  263. package/build/src/workflows/delegations.js +326 -0
  264. package/build/src/workflows/engine.d.ts +80 -4
  265. package/build/src/workflows/engine.js +466 -86
  266. package/build/src/workflows/sla.d.ts +15 -0
  267. package/build/src/workflows/sla.js +8 -0
  268. package/build/stubs/resource_contract.txt +12 -1
  269. package/package.json +9 -2
@@ -0,0 +1,216 @@
1
+ import type { Knex } from 'knex';
2
+ import type { Actor } from '../auth/ability.js';
3
+ import type { ResourceService } from '../admin/resource_service.js';
4
+ import type { ResourceDescription, ResourceField } from '../admin/presentation.js';
5
+ import type { ResourceRegistry } from '../resource/registry.js';
6
+ import type { Field, Label, PrintOrientation, PrintPaper, PrintTemplate, Resource, SerializedRecord } from '../resource/types.js';
7
+ import { type TemplateNode } from '../core/template_language.js';
8
+ import { type CalendarPreference, type DigitsPreference } from '../core/ui_preferences.js';
9
+ import { type PrintIdentity } from './print.js';
10
+ /** The implicit template of every resource: the generic layout of renderPrintHtml. */
11
+ export declare const DEFAULT_PRINT_TEMPLATE = "default";
12
+ export declare const PRINT_PAPERS: readonly PrintPaper[];
13
+ export declare const PRINT_ORIENTATIONS: readonly PrintOrientation[];
14
+ /** Helpers a template may call; nothing else is callable. */
15
+ export declare const PRINT_HELPERS: readonly ["date", "money", "number", "digits", "label", "total"];
16
+ /** Document values addressable by bare name. */
17
+ export declare const PRINT_VALUES: readonly ["id", "resource", "template", "company", "status", "printedBy", "printedAt", "rowNumber", "logo"];
18
+ /** What a template may name: the resource's stored fields and its line groups' columns. */
19
+ export type PrintSchema = {
20
+ fields: Record<string, Field>;
21
+ groups: Record<string, Record<string, Field>>;
22
+ };
23
+ export type PrintTemplateSource = 'generic' | 'code' | 'custom';
24
+ export type PrintTemplateOption = {
25
+ key: string;
26
+ label: Label;
27
+ source: PrintTemplateSource;
28
+ };
29
+ export type PrintTemplateSummary = {
30
+ resource: string;
31
+ resourceLabel: string;
32
+ key: string;
33
+ label: string;
34
+ source: 'code' | 'custom';
35
+ /** The current version: an integer for custom templates, `code:<hash>` for code ones. */
36
+ version: string;
37
+ active: boolean;
38
+ paper: PrintPaper;
39
+ orientation: PrintOrientation;
40
+ updatedAt: string | null;
41
+ };
42
+ export type PrintTemplateDraft = {
43
+ label: string;
44
+ body: string;
45
+ paper: PrintPaper;
46
+ orientation: PrintOrientation;
47
+ header: string;
48
+ footer: string;
49
+ };
50
+ export type PrintTemplateDetail = PrintTemplateSummary & PrintTemplateDraft;
51
+ export type PrintTemplateVersion = PrintTemplateDraft & {
52
+ version: number;
53
+ createdBy: string | null;
54
+ createdAt: string;
55
+ };
56
+ export type PrintTemplateInput = {
57
+ key?: unknown;
58
+ label?: unknown;
59
+ body?: unknown;
60
+ paper?: unknown;
61
+ orientation?: unknown;
62
+ header?: unknown;
63
+ footer?: unknown;
64
+ active?: unknown;
65
+ /** Update only: the version the editor started from (optimistic lock, 409 on mismatch). */
66
+ expectedVersion?: unknown;
67
+ };
68
+ export type PrintOptions = {
69
+ identity: PrintIdentity;
70
+ printedBy: string;
71
+ printedAt?: Date;
72
+ /** Defaults to the stored ui.preferences (calendar and digits). */
73
+ calendar?: CalendarPreference;
74
+ digits?: DigitsPreference;
75
+ /** IANA zone of printed date-times and the print time; defaults to UTC. */
76
+ timeZone?: string;
77
+ };
78
+ export type PrintedDocument = {
79
+ html: string;
80
+ template: {
81
+ key: string;
82
+ version: string;
83
+ source: PrintTemplateSource;
84
+ };
85
+ };
86
+ /** Checks the printTemplates of one resource definition; called by defineResource. */
87
+ export declare function assertPrintTemplates(resource: Pick<Resource, 'name' | 'fields' | 'printTemplates'>): void;
88
+ /** Checks line columns of code templates against the child resources; called on register. */
89
+ export declare function assertPrintTemplateColumns(resource: Resource, registry: ResourceRegistry): void;
90
+ /** Most lines one printed group holds; a longer document is refused, never truncated. */
91
+ export declare const PRINT_LINE_LIMIT = 1000;
92
+ /**
93
+ * The hasMany fields a print may read: those the record exposes (`serialize`, or `list`
94
+ * and `show`) and those the resource's own code print templates declare. The resource
95
+ * author decides both; an administrator template cannot reach any other line group.
96
+ */
97
+ export declare function printableGroups(resource: Resource): string[];
98
+ /** The names a template of this registered resource may use. */
99
+ export declare function printSchema(registry: ResourceRegistry, name: string): PrintSchema;
100
+ /**
101
+ * Refuses unknown names and helpers and misplaced values with a 422 E_PRINT_TEMPLATE.
102
+ * `text` mode (header and footer) allows only document values and record fields.
103
+ */
104
+ export declare function checkTemplate(nodes: TemplateNode[], schema: PrintSchema, mode?: 'html' | 'text'): void;
105
+ /** A version label of a code template: a hash of its declaration, so a change is visible. */
106
+ export declare function codeTemplateVersion(template: PrintTemplate): string;
107
+ /** A record as one reader may read it: the input of renderTemplateDocument. */
108
+ export type PrintSource = {
109
+ /** The reader's description: only its fields are printable. */
110
+ resource: ResourceDescription;
111
+ record: SerializedRecord;
112
+ related?: Record<string, SerializedRecord[]>;
113
+ lookups?: Record<string, {
114
+ value: string;
115
+ label: string;
116
+ }[]>;
117
+ /** Line groups with the reader's description of the line resource. */
118
+ lines?: Record<string, {
119
+ label: Label;
120
+ fields: ResourceField[];
121
+ rows: SerializedRecord[];
122
+ related?: Record<string, SerializedRecord[]>;
123
+ lookups?: Record<string, {
124
+ value: string;
125
+ label: string;
126
+ }[]>;
127
+ }>;
128
+ };
129
+ /** What to print: administrator markup (`body`) or a code template (`code`). */
130
+ export type PrintLayout = {
131
+ title: string;
132
+ paper: PrintPaper;
133
+ orientation: PrintOrientation;
134
+ header?: string;
135
+ footer?: string;
136
+ } & ({
137
+ body: string;
138
+ } | {
139
+ code: PrintTemplate;
140
+ });
141
+ /**
142
+ * Renders a print template for one reader (ADR 048). A value prints only when its field
143
+ * is in the reader's description (`source.resource.fields`, `lines[*].fields`), even if
144
+ * the record object holds more; the markup is sanitized again and every value escaped.
145
+ */
146
+ export declare function renderTemplateDocument(source: PrintSource, layout: PrintLayout, options: PrintOptions): string;
147
+ /**
148
+ * Print templates (ADR 048): code templates declared on resources, administrator
149
+ * templates stored with immutable versions in print_templates / print_template_versions,
150
+ * and the generic layout as the implicit `default`. Every print reads the record through
151
+ * ResourceService as the actor, so the printed values are those the record page shows.
152
+ */
153
+ export declare class PrintTemplates {
154
+ private db;
155
+ private registry;
156
+ constructor(db: Knex, registry: ResourceRegistry);
157
+ private resource;
158
+ /** Every template of every registered resource, for the administration screen. */
159
+ list(): Promise<PrintTemplateSummary[]>;
160
+ private summary;
161
+ /** One administrator template with the content of its current version. */
162
+ get(name: string, key: string): Promise<PrintTemplateDetail>;
163
+ /** The version history of an administrator template, newest first. */
164
+ versions(name: string, key: string): Promise<PrintTemplateVersion[]>;
165
+ /**
166
+ * Checks and sanitizes a draft: the markup goes through sanitizePrintHtml, then every
167
+ * name and helper is checked against the resource. Returns the stored form.
168
+ */
169
+ validate(name: string, input: PrintTemplateInput): PrintTemplateDraft;
170
+ /** Creates an administrator template at version 1; 409 when the key already exists. */
171
+ create(name: string, input: PrintTemplateInput, actorId: number): Promise<{
172
+ resource: string;
173
+ key: string;
174
+ version: number;
175
+ }>;
176
+ /**
177
+ * Saves a new version of an existing administrator template (404 when there is none).
178
+ * `active` keeps its stored value when the input leaves it out. `expectedVersion` must
179
+ * equal the current version, so a concurrent edit is refused (409) rather than lost.
180
+ */
181
+ update(name: string, key: string, input: PrintTemplateInput, actorId: number): Promise<{
182
+ resource: string;
183
+ key: string;
184
+ version: number;
185
+ }>;
186
+ /** Versions are never changed; the template row points to the current one. */
187
+ private save;
188
+ /** Templates the actor may print a record of this resource with (403 without view). */
189
+ available(resources: ResourceService, name: string, actor: Actor): Promise<PrintTemplateOption[]>;
190
+ /** The record as the actor may read it, with its lines and display maps. */
191
+ /** The record, its lines and display maps as the actor may read them. */
192
+ private source;
193
+ private formatting;
194
+ /**
195
+ * Renders one record with a template (`default` for the generic layout). Call
196
+ * recordPrinted once the document was delivered (after a PDF conversion succeeded).
197
+ */
198
+ print(resources: ResourceService, name: string, id: number, actor: Actor, options: PrintOptions & {
199
+ template?: string;
200
+ }): Promise<PrintedDocument>;
201
+ /**
202
+ * Records a `printed` activity on the record with the template key, version and format.
203
+ * Call it after the document was produced (HTML rendered, or PDF converted).
204
+ */
205
+ recordPrinted(name: string, id: number, actor: Actor, template: PrintedDocument['template'], format: 'html' | 'pdf'): Promise<void>;
206
+ /**
207
+ * Renders an unsaved draft against a record the actor may read: `recordId`, or the
208
+ * newest record of the actor's list. Nothing is stored or audited.
209
+ */
210
+ preview(resources: ResourceService, name: string, input: PrintTemplateInput, actor: Actor, options: PrintOptions & {
211
+ recordId?: number | null;
212
+ }): Promise<{
213
+ html: string;
214
+ recordId: number;
215
+ }>;
216
+ }