@cosmicdrift/kumiko-samples 0.418.0 → 0.420.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 (90) hide show
  1. package/package.json +1 -1
  2. package/packages/bundled-features/package.json +11 -1
  3. package/packages/bundled-features/src/shared/index.ts +6 -0
  4. package/packages/bundled-features/src/shared/tenant-scoped-subject.ts +28 -0
  5. package/packages/bundled-features/src/signature/changes.json +6 -0
  6. package/packages/bundled-features/src/signature/feature.ts +1 -1
  7. package/packages/bundled-features/src/signature/grant.ts +13 -14
  8. package/packages/bundled-features/src/signature/png.ts +33 -12
  9. package/packages/bundled-features/src/template-resolver/api.ts +17 -7
  10. package/packages/bundled-features/src/template-resolver/changes.json +62 -0
  11. package/packages/bundled-features/src/template-resolver/compile-document-body.ts +10 -9
  12. package/packages/bundled-features/src/template-resolver/compile-document-styles.ts +170 -0
  13. package/packages/bundled-features/src/template-resolver/document-frames.ts +68 -0
  14. package/packages/bundled-features/src/template-resolver/document-op-blocks.ts +682 -0
  15. package/packages/bundled-features/src/template-resolver/document-ops.ts +170 -128
  16. package/packages/bundled-features/src/template-resolver/document-print-only.ts +65 -0
  17. package/packages/bundled-features/src/template-resolver/document-sanitizer.ts +53 -19
  18. package/packages/bundled-features/src/template-resolver/feature.ts +15 -0
  19. package/packages/bundled-features/src/template-resolver/handlers/apply-layout.write.ts +137 -0
  20. package/packages/bundled-features/src/template-resolver/handlers/create-layout.write.ts +87 -0
  21. package/packages/bundled-features/src/template-resolver/handlers/document-base.ts +2 -2
  22. package/packages/bundled-features/src/template-resolver/handlers/document-blocks.query.ts +13 -8
  23. package/packages/bundled-features/src/template-resolver/handlers/document-region.ts +47 -0
  24. package/packages/bundled-features/src/template-resolver/handlers/failure-reason.ts +13 -0
  25. package/packages/bundled-features/src/template-resolver/handlers/import-bundle-system.write.ts +3 -0
  26. package/packages/bundled-features/src/template-resolver/handlers/layout-source.query.ts +17 -5
  27. package/packages/bundled-features/src/template-resolver/handlers/overview.query.ts +16 -4
  28. package/packages/bundled-features/src/template-resolver/handlers/patch-draft.write.ts +20 -6
  29. package/packages/bundled-features/src/template-resolver/handlers/publish-templates.write.ts +69 -0
  30. package/packages/bundled-features/src/template-resolver/handlers/set.write.ts +7 -0
  31. package/packages/bundled-features/src/template-resolver/handlers/template-write.ts +15 -3
  32. package/packages/bundled-features/src/template-resolver/handlers/tenant-settings.ts +159 -0
  33. package/packages/bundled-features/src/template-resolver/handlers/toggle-status.write.ts +25 -10
  34. package/packages/bundled-features/src/template-resolver/handlers/upsert-system.write.ts +7 -3
  35. package/packages/bundled-features/src/template-resolver/handlers/usage.query.ts +131 -18
  36. package/packages/bundled-features/src/template-resolver/handlers/validate.query.ts +10 -0
  37. package/packages/bundled-features/src/template-resolver/i18n.ts +3 -0
  38. package/packages/bundled-features/src/template-resolver/index.ts +39 -0
  39. package/packages/bundled-features/src/template-resolver/layout-regions.ts +54 -16
  40. package/packages/bundled-features/src/template-resolver/print-document.ts +3 -1
  41. package/packages/bundled-features/src/template-resolver/seeding.ts +4 -0
  42. package/packages/bundled-features/src/template-resolver/template-delivery-policy.ts +11 -1
  43. package/packages/bundled-features/src/template-resolver/template-edit-policy.ts +37 -1
  44. package/packages/bundled-features/src/template-resolver/template-meta.ts +31 -6
  45. package/packages/bundled-features/src/template-resolver/template-preview.ts +29 -9
  46. package/packages/bundled-features/src/template-resolver/template-validation.ts +10 -3
  47. package/packages/bundled-features/src/template-resolver/web/constants.ts +33 -0
  48. package/packages/bundled-features/src/template-resolver/web/document-blocks.ts +5 -0
  49. package/packages/bundled-features/src/template-resolver/web/document-editor-extensions.ts +93 -25
  50. package/packages/bundled-features/src/template-resolver/web/document-editor-fonts.ts +13 -0
  51. package/packages/bundled-features/src/template-resolver/web/document-editor.tsx +4 -1
  52. package/packages/bundled-features/src/template-resolver/web/document-fonts.ts +21 -0
  53. package/packages/bundled-features/src/template-resolver/web/document-frame-control.ts +428 -0
  54. package/packages/bundled-features/src/template-resolver/web/document-frame-node-view.tsx +207 -0
  55. package/packages/bundled-features/src/template-resolver/web/document-print-decorations.ts +246 -0
  56. package/packages/bundled-features/src/template-resolver/web/document-print-defaults.ts +59 -0
  57. package/packages/bundled-features/src/template-resolver/web/document-print-style.ts +381 -0
  58. package/packages/bundled-features/src/template-resolver/web/document-repeat-strip.ts +80 -0
  59. package/packages/bundled-features/src/template-resolver/web/document-schema.ts +87 -19
  60. package/packages/bundled-features/src/template-resolver/web/document-style-css.ts +214 -0
  61. package/packages/bundled-features/src/template-resolver/web/document-tiptap-bubble.tsx +185 -16
  62. package/packages/bundled-features/src/template-resolver/web/document-tiptap-content.tsx +70 -7
  63. package/packages/bundled-features/src/template-resolver/web/document-tiptap-context.ts +13 -1
  64. package/packages/bundled-features/src/template-resolver/web/document-tiptap-editor.tsx +25 -4
  65. package/packages/bundled-features/src/template-resolver/web/document-tiptap-helpers.ts +276 -23
  66. package/packages/bundled-features/src/template-resolver/web/document-tiptap-toolbar-groups.tsx +449 -10
  67. package/packages/bundled-features/src/template-resolver/web/document-tiptap-toolbar.tsx +108 -17
  68. package/packages/bundled-features/src/template-resolver/web/document-toolbar-blocks.ts +20 -0
  69. package/packages/bundled-features/src/template-resolver/web/fontsource-css.d.ts +2 -0
  70. package/packages/bundled-features/src/template-resolver/web/i18n.ts +32 -0
  71. package/packages/bundled-features/src/template-resolver/web/index.ts +38 -0
  72. package/packages/bundled-features/src/template-resolver/web/pdf-constants.ts +16 -0
  73. package/packages/bundled-features/src/template-resolver/web/placeholder-text.ts +6 -3
  74. package/packages/bundled-features/src/template-resolver/web/qualified-names.ts +7 -0
  75. package/packages/bundled-features/src/template-resolver/web/use-document-tiptap-model.ts +74 -5
  76. package/packages/bundled-features/src/tenant/company-config.ts +48 -0
  77. package/packages/bundled-features/src/tenant/feature.ts +11 -0
  78. package/packages/bundled-features/src/tenant/i18n.ts +14 -0
  79. package/samples/apps/ui-walkthrough/src/app/auth-constants.ts +51 -0
  80. package/samples/apps/ui-walkthrough/src/app/seed-print-editor-tenants.ts +118 -0
  81. package/samples/apps/ui-walkthrough/src/app/seed-templates.ts +2 -0
  82. package/samples/apps/ui-walkthrough/src/app/server.ts +9 -1
  83. package/samples/apps/ui-walkthrough/src/app/template-seed-data.ts +27 -1
  84. package/samples/apps/ui-walkthrough/src/features/rental/i18n.ts +8 -0
  85. package/samples/apps/ui-walkthrough/src/features/rental/screens.ts +1 -0
  86. package/samples/apps/ui-walkthrough/src/run-config.ts +1 -0
  87. package/samples/apps/use-all-bundled/feature-manifest.json +236 -0
  88. package/samples/recipes/pdf-letterhead/README.md +23 -0
  89. package/samples/recipes/pdf-letterhead/package.json +12 -0
  90. package/samples/recipes/pdf-letterhead/src/letterhead.ts +92 -0
@@ -0,0 +1,2 @@
1
+ // @fontsource packages ship plain CSS files; the dynamic font loader only imports them for their side effect.
2
+ declare module "@fontsource/*";
@@ -61,6 +61,19 @@ export const defaultTranslations: TranslationsByLocale = {
61
61
  "template-resolver.editor.saved": "Saved.",
62
62
  "templateResolver.errors.document.imagesBlockPdfOnly":
63
63
  "Photo blocks are only allowed in PDF documents.",
64
+ "templateResolver.errors.document.printStylePdfOnly":
65
+ "Print styling (fonts, colors, spacing, frames) is only allowed in PDF documents.",
66
+ "templateResolver.errors.template_not_tenant_editable": "You may not edit this template.",
67
+ "templateResolver.errors.template_already_active": "Nothing to publish, no open draft.",
68
+ "templateResolver.errors.layout_not_published": "Publish the layout first.",
69
+ "templateResolver.errors.template_resource_not_found": "Template not found.",
70
+ "templateResolver.errors.invalid_meta": "The template settings are invalid.",
71
+ "templateResolver.errors.unknown_placeholder": "The template uses an unknown placeholder.",
72
+ "templateResolver.errors.missing_required_placeholder": "A required placeholder is missing.",
73
+ "templateResolver.errors.document.frameNotTopLevel":
74
+ "A frame must sit directly in the document body, not inside another block or a layout region.",
75
+ "templateResolver.errors.document.frameOutsidePage":
76
+ "The frame “{detail}” extends past the largest supported paper size.",
64
77
  "templateResolver.errors.document.buttonHrefNotPlaceholder":
65
78
  "The button target “{detail}” must be a placeholder.",
66
79
  "templateResolver.errors.document.disallowedLinkHref":
@@ -85,6 +98,23 @@ export const defaultTranslations: TranslationsByLocale = {
85
98
  "templateResolver.checks.sizeUnderCap": "The mail is within the 10 MiB size limit",
86
99
  "templateResolver.checks.requiredPlaceholders": "All required placeholders are used",
87
100
  "templateResolver.errors.preview.renderFailed": "The preview could not be rendered.",
101
+ "templateResolver.errors.patch.printStyleNotAllowed":
102
+ "Fonts, sizes, colors, spacing, borders and backgrounds are only available in PDF templates, not in {kind}.",
103
+ "templateResolver.errors.patch.textOrRunsRequired":
104
+ "Give either text or runs, not both and not neither.",
105
+ "templateResolver.errors.patch.invalidTable": "The table is not valid: {problem}.",
106
+ "templateResolver.errors.patch.invalidRepeatVariable":
107
+ "The name {each} is not a valid list variable for a repeat row.",
108
+ "templateResolver.errors.patch.tooManyBlocks":
109
+ "The body may have at most {max} blocks, including the ones inside frames.",
110
+ "templateResolver.errors.patch.regionRequired":
111
+ "A PDF layout is edited one region at a time; set region to header, signature or footer.",
112
+ "templateResolver.errors.patch.regionNotAllowed":
113
+ "A region only applies to PDF layouts, not to {kind}.",
114
+ "templateResolver.errors.patch.layoutExists": "A layout with the slug {slug} already exists.",
115
+ "templateResolver.errors.template.reservedLayoutSlug":
116
+ "The prefix {prefix} is reserved for tenant layouts.",
117
+ "templateResolver.errors.patch.emptyFormat": "Give at least one of align, style or textStyle.",
88
118
  "templateResolver.errors.patch.unknownBlock":
89
119
  "The block {blockId} does not exist in the template.",
90
120
  "templateResolver.errors.patch.blockRemoved":
@@ -98,6 +128,8 @@ export const defaultTranslations: TranslationsByLocale = {
98
128
  "The placeholder {find} cannot be replaced as text; set the text around it with another operation or remove the block.",
99
129
  "templateResolver.errors.patch.blockNotAllowed":
100
130
  "The block type {type} is not available in {kind} templates.",
131
+ "templateResolver.errors.patch.bleedNotAllowed":
132
+ "An image can only run to the paper edge (bleed) in the header or footer of a PDF layout, not in {kind}.",
101
133
  "templateResolver.errors.patch.blockTypeMismatch":
102
134
  "This step needs a {expected} block, but the block is a {actual}.",
103
135
  "templateResolver.errors.patch.invalidResourceKey": "The image key {resource} is not valid.",
@@ -6,11 +6,42 @@
6
6
 
7
7
  export { textBlocksClient } from "./client-plugin.tsx";
8
8
  export type { EditableTemplateKind } from "./constants.ts";
9
+ export { COMPANY_PLACEHOLDERS, MAX_SELECTED_TEMPLATES } from "./constants.ts";
9
10
  export { DocumentContentEditor } from "./document-editor.tsx";
11
+ export {
12
+ DOCUMENT_FONT_LABELS,
13
+ DOCUMENT_FONT_PRINT_STACKS,
14
+ DOCUMENT_FONTS,
15
+ type DocumentFont,
16
+ } from "./document-fonts.ts";
17
+ export type { DocumentFrameControl } from "./document-frame-control.ts";
18
+ export {
19
+ COLWIDTH_PX_RANGE,
20
+ type DocumentFrameAttributes,
21
+ type DocumentFramePreset,
22
+ FRAME_MM_RANGE,
23
+ FRAME_PRESETS,
24
+ LINE_HEIGHT_RANGE,
25
+ PARAGRAPH_SPACE_PT_RANGE,
26
+ TEXT_SIZE_PT_RANGE,
27
+ } from "./document-print-style.ts";
28
+ export {
29
+ type DocumentBlockStyle,
30
+ type DocumentFrameBox,
31
+ type DocumentTextStyle,
32
+ documentBlockStyleCss,
33
+ documentCellStyleCss,
34
+ documentFrameCss,
35
+ documentTextStyleCss,
36
+ } from "./document-style-css.ts";
37
+ export { FONT_SIZES_PT } from "./document-tiptap-helpers.ts";
10
38
  export {
11
39
  type DocumentEditorChrome,
12
40
  type DocumentEditorHandle,
13
41
  type DocumentEditorProps,
42
+ type DocumentLayoutValues,
43
+ type DocumentPrintBlock,
44
+ type DocumentPrintMode,
14
45
  type DocumentResourcePreview,
15
46
  type DocumentToolbarBlock,
16
47
  MAIL_DOCUMENT_BLOCKS,
@@ -25,11 +56,18 @@ export {
25
56
  MAIL_LAYOUT_WIDTHS,
26
57
  } from "./mail-layout-constants.ts";
27
58
  export {
59
+ PDF_CORNER_MARK_INSET_MM,
60
+ PDF_CORNER_MARK_LEG_MM,
61
+ PDF_DEFAULT_FONT_SIZE_PT,
28
62
  PDF_DEFAULT_MARGIN_MM,
63
+ PDF_FOLD_MARKS,
29
64
  PDF_FOOTER_MARGIN_MM,
30
65
  PDF_HEADER_MARGIN_MM,
31
66
  PDF_ORIENTATIONS,
32
67
  PDF_PAGE_FORMATS,
68
+ PDF_TABLE_STYLES,
69
+ type PdfFoldMarks,
70
+ type PdfTableStyle,
33
71
  } from "./pdf-constants.ts";
34
72
  export {
35
73
  PlaceholderLineEditor,
@@ -2,6 +2,9 @@
2
2
  export const PDF_PAGE_FORMATS = ["A4", "Letter"] as const;
3
3
  export type PdfPageFormat = (typeof PDF_PAGE_FORMATS)[number];
4
4
 
5
+ // Long edge of the largest supported paper; the sanitizer has no template meta, so a frame is held to this on both axes.
6
+ export const PDF_MAX_PAGE_EDGE_MM = 297;
7
+
5
8
  export const PDF_ORIENTATIONS = ["portrait", "landscape"] as const;
6
9
  export type PdfOrientation = (typeof PDF_ORIENTATIONS)[number];
7
10
 
@@ -9,3 +12,16 @@ export type PdfOrientation = (typeof PDF_ORIENTATIONS)[number];
9
12
  export const PDF_DEFAULT_MARGIN_MM = 15;
10
13
  export const PDF_HEADER_MARGIN_MM = 30;
11
14
  export const PDF_FOOTER_MARGIN_MM = 20;
15
+
16
+ // Body text size of a printed document; header and footer fall back to it, so no region reads smaller than the body.
17
+ export const PDF_DEFAULT_FONT_SIZE_PT = 10.5;
18
+
19
+ export const PDF_FOLD_MARKS = ["none", "din-a", "din-b"] as const;
20
+ export type PdfFoldMarks = (typeof PDF_FOLD_MARKS)[number];
21
+
22
+ export const PDF_TABLE_STYLES = ["plain", "lines", "header", "grid"] as const;
23
+ export type PdfTableStyle = (typeof PDF_TABLE_STYLES)[number];
24
+
25
+ // Corner marks: an angle in each paper corner, its vertex this far from both edges and its legs running toward the sheet's centre.
26
+ export const PDF_CORNER_MARK_INSET_MM = 10;
27
+ export const PDF_CORNER_MARK_LEG_MM = 5;
@@ -1,11 +1,11 @@
1
1
  import type { JSONContent } from "@tiptap/core";
2
- import { isDocumentReferenceName } from "./document-schema.ts";
2
+ import { type DocumentDateStyle, isDocumentReferenceName } from "./document-schema.ts";
3
3
 
4
4
  const PLACEHOLDER_TOKEN = /\{\{([^{}]*)\}\}/g;
5
5
 
6
6
  // Names the schema refuses stay plain text, so a typo never becomes a chip
7
7
  // that the server would reject.
8
- export function lineToContent(text: string): JSONContent[] {
8
+ export function lineToContent(text: string, dateStyle?: DocumentDateStyle): JSONContent[] {
9
9
  const content: JSONContent[] = [];
10
10
  let cursor = 0;
11
11
  const pushText = (value: string): void => {
@@ -15,7 +15,10 @@ export function lineToContent(text: string): JSONContent[] {
15
15
  const name = match[1] ?? "";
16
16
  if (!isDocumentReferenceName(name)) continue;
17
17
  pushText(text.slice(cursor, match.index));
18
- content.push({ type: "variable", attrs: { name } });
18
+ content.push({
19
+ type: "variable",
20
+ attrs: dateStyle === undefined ? { name } : { name, dateStyle },
21
+ });
19
22
  cursor = match.index + match[0].length;
20
23
  }
21
24
  pushText(text.slice(cursor));
@@ -20,8 +20,14 @@ export const TemplateResolverHandlers = {
20
20
  resourceLinkPdf: "template-resolver:write:resource-link-pdf",
21
21
  sendTest: "template-resolver:write:send-test",
22
22
  patchDraft: "template-resolver:write:patch-draft",
23
+ applyLayout: "template-resolver:write:apply-layout",
24
+ createLayout: "template-resolver:write:create-layout",
25
+ publishTemplates: "template-resolver:write:publish-templates",
23
26
  } as const;
24
27
 
28
+ // The config feature's write handler, which applyLayout dispatches to for the tenant default layout.
29
+ export const ConfigHandlers = { set: "config:write:set" } as const;
30
+
25
31
  export const TemplateResolverQueries = {
26
32
  findById: "template-resolver:query:find-by-id",
27
33
  list: "template-resolver:query:list",
@@ -66,6 +72,7 @@ export const TemplateResolverErrors = {
66
72
  systemResourcesNeedSystemTenant: "system_resources_need_system_tenant",
67
73
  systemOnlyTemplate: "system_only_template",
68
74
  templateNotTenantEditable: "template_not_tenant_editable",
75
+ layoutNotPublished: "layout_not_published",
69
76
  bundleLocalesDiffer: "bundle_locales_differ",
70
77
  resourceTooLarge: "template_resource_too_large",
71
78
  resourceUnsupportedImage: "template_resource_unsupported_image",
@@ -1,9 +1,20 @@
1
1
  import type { Translate } from "@cosmicdrift/kumiko-renderer/headless";
2
2
  import { useEditor, useEditorState } from "@tiptap/react";
3
- import { useMemo, useState } from "react";
3
+ import { useCallback, useMemo, useRef, useState } from "react";
4
4
  import { createDocumentEditorExtensions } from "./document-editor-extensions.ts";
5
- import { activeStateOf, type PanelKind, previewsKey } from "./document-tiptap-helpers.ts";
6
- import type { DocumentEditorProps, DocumentResourcePreview } from "./document-toolbar-blocks.ts";
5
+ import type { DocumentFrameControl } from "./document-frame-control.ts";
6
+ import type { FrameViewLabels } from "./document-frame-node-view.tsx";
7
+ import {
8
+ activeStateOf,
9
+ type PanelKind,
10
+ previewsKey,
11
+ variableLabelOf,
12
+ } from "./document-tiptap-helpers.ts";
13
+ import type {
14
+ DocumentEditorProps,
15
+ DocumentPrintMode,
16
+ DocumentResourcePreview,
17
+ } from "./document-toolbar-blocks.ts";
7
18
  import { useEditorHandleReport } from "./editor-handle.ts";
8
19
  import { useStableByKey } from "./use-stable-by-key.ts";
9
20
 
@@ -21,14 +32,38 @@ export function documentEditorLabels(t: Translate) {
21
32
 
22
33
  export type DocumentEditorLabels = ReturnType<typeof documentEditorLabels>;
23
34
 
35
+ function frameLabelsOf(t: Translate): FrameViewLabels {
36
+ return {
37
+ addressFormA: t("documentDesigner.editor.frame.addressFormA"),
38
+ addressFormB: t("documentDesigner.editor.frame.addressFormB"),
39
+ address: t("documentDesigner.editor.frame.address"),
40
+ text: t("documentDesigner.editor.frame.text"),
41
+ };
42
+ }
43
+
24
44
  function useDocumentExtensions(input: {
25
45
  readonly labels: DocumentEditorLabels;
26
46
  readonly canvas: boolean;
47
+ readonly print: DocumentPrintMode;
48
+ readonly frameLabels: FrameViewLabels | undefined;
49
+ readonly reportFrameControl: (control: DocumentFrameControl | null) => void;
50
+ readonly repeatStripName: (listLabel: string) => string;
51
+ readonly repeatHeaderLabel: string;
27
52
  readonly variableLabels: Readonly<Record<string, string>>;
28
53
  readonly systemVariables: readonly string[];
29
54
  readonly resourcePreviews: Readonly<Record<string, DocumentResourcePreview>>;
30
55
  }) {
31
- const { canvas, variableLabels, systemVariables, resourcePreviews } = input;
56
+ const {
57
+ canvas,
58
+ print,
59
+ reportFrameControl,
60
+ repeatStripName,
61
+ repeatHeaderLabel,
62
+ variableLabels,
63
+ systemVariables,
64
+ resourcePreviews,
65
+ } = input;
66
+ const frameLabels = useStableByKey(input.frameLabels, JSON.stringify(input.frameLabels ?? null));
32
67
  const {
33
68
  placeholderLabel,
34
69
  imageLabel,
@@ -55,6 +90,16 @@ function useDocumentExtensions(input: {
55
90
  systemVariables: stableSystem,
56
91
  resourcePreviews: stablePreviews,
57
92
  blockLabels: canvas,
93
+ print,
94
+ reportFrameControl,
95
+ ...(print !== "none" && {
96
+ repeatStrip: {
97
+ label: (lists: readonly string[]) =>
98
+ repeatStripName(lists.map((list) => variableLabelOf(list, stableLabels)).join(", ")),
99
+ headerLabel: repeatHeaderLabel,
100
+ },
101
+ }),
102
+ ...(frameLabels !== undefined && { frameLabels }),
58
103
  }),
59
104
  [
60
105
  placeholderLabel,
@@ -68,6 +113,11 @@ function useDocumentExtensions(input: {
68
113
  stableSystem,
69
114
  stablePreviews,
70
115
  canvas,
116
+ print,
117
+ reportFrameControl,
118
+ repeatStripName,
119
+ repeatHeaderLabel,
120
+ frameLabels,
71
121
  ],
72
122
  );
73
123
  return { extensions, stableLabels };
@@ -75,8 +125,9 @@ function useDocumentExtensions(input: {
75
125
 
76
126
  export type DocumentTiptapModelInput = Pick<
77
127
  DocumentEditorProps,
78
- "id" | "value" | "onChange" | "readOnly" | "onEditorReady"
128
+ "id" | "value" | "onChange" | "readOnly" | "onEditorReady" | "onFrameControlChange"
79
129
  > & {
130
+ readonly print: DocumentPrintMode;
80
131
  readonly variableLabels: Readonly<Record<string, string>>;
81
132
  readonly systemVariables: readonly string[];
82
133
  readonly resourcePreviews: Readonly<Record<string, DocumentResourcePreview>>;
@@ -89,9 +140,27 @@ export function useDocumentTiptapModel(input: DocumentTiptapModelInput, t: Trans
89
140
  const [canvasScroller, setCanvasScroller] = useState<HTMLElement | null>(null);
90
141
  const [showHtml, setShowHtml] = useState(false);
91
142
  const labels = documentEditorLabels(t);
143
+ // Callers pass a fresh function per render; the extension list must not rebuild the editor for it.
144
+ const frameControlRef = useRef(input.onFrameControlChange);
145
+ frameControlRef.current = input.onFrameControlChange;
146
+ const translateRef = useRef(t);
147
+ translateRef.current = t;
148
+ const repeatStripName = useCallback(
149
+ (name: string) => translateRef.current("documentDesigner.editor.table.repeatStrip", { name }),
150
+ [],
151
+ );
152
+ const reportFrameControl = useCallback(
153
+ (control: DocumentFrameControl | null) => frameControlRef.current?.(control),
154
+ [],
155
+ );
92
156
  const { extensions, stableLabels } = useDocumentExtensions({
93
157
  labels,
94
158
  canvas: input.canvas,
159
+ print: input.print,
160
+ frameLabels: input.print === "page" ? frameLabelsOf(t) : undefined,
161
+ reportFrameControl,
162
+ repeatStripName,
163
+ repeatHeaderLabel: t("template-resolver.documentEditor.repeatHeader"),
95
164
  variableLabels: input.variableLabels,
96
165
  systemVariables: input.systemVariables,
97
166
  resourcePreviews: input.resourcePreviews,
@@ -0,0 +1,48 @@
1
+ import { type ConfigKeyDefinition, createTenantConfig } from "@cosmicdrift/kumiko-framework/engine";
2
+ import type { NavIconKey } from "@cosmicdrift/kumiko-types/nav";
3
+
4
+ export const COMPANY_DATA_KEYS = [
5
+ "companyAddress",
6
+ "companyPhone",
7
+ "companyEmail",
8
+ "companyWebsite",
9
+ "companyRegister",
10
+ "companyVatId",
11
+ "companyManagement",
12
+ "companyBank",
13
+ "companyIban",
14
+ "companyBic",
15
+ ] as const;
16
+ export type CompanyDataKey = (typeof COMPANY_DATA_KEYS)[number];
17
+
18
+ export const COMPANY_SECTION_I18N_KEY = "tenant.company.section";
19
+
20
+ const COMPANY_KEY_ICONS: Readonly<Record<CompanyDataKey, NavIconKey>> = {
21
+ companyAddress: "map-pin",
22
+ companyPhone: "phone",
23
+ companyEmail: "mail",
24
+ companyWebsite: "link",
25
+ companyRegister: "file",
26
+ companyVatId: "receipt",
27
+ companyManagement: "user",
28
+ companyBank: "building",
29
+ companyIban: "coins",
30
+ companyBic: "hash",
31
+ };
32
+
33
+ export function companyI18nKey(key: CompanyDataKey): string {
34
+ return `tenant.company.${key}`;
35
+ }
36
+
37
+ // Printed on documents (letterhead, footer); the generated settings screen groups them in one section.
38
+ export function companyDataConfig(key: CompanyDataKey): ConfigKeyDefinition<"text"> {
39
+ return createTenantConfig("text", {
40
+ default: "",
41
+ mask: {
42
+ title: companyI18nKey(key),
43
+ icon: COMPANY_KEY_ICONS[key],
44
+ order: 10 + COMPANY_DATA_KEYS.indexOf(key),
45
+ section: COMPANY_SECTION_I18N_KEY,
46
+ },
47
+ });
48
+ }
@@ -14,6 +14,7 @@ import {
14
14
  i18nKey,
15
15
  } from "@cosmicdrift/kumiko-framework/engine";
16
16
  import { TENANT_BOOT_RULES } from "./boot-rules.ts";
17
+ import { companyDataConfig } from "./company-config.ts";
17
18
  import { activeTenantIdsQuery } from "./handlers/active-tenant-ids.query.ts";
18
19
  import { addMemberWrite } from "./handlers/add-member.write.ts";
19
20
  import { cancelInvitationWrite } from "./handlers/cancel-invitation.write.ts";
@@ -103,6 +104,16 @@ export function createTenantFeature(options?: TenantFeatureOptions): FeatureDefi
103
104
  keys: {
104
105
  // Core tenant settings — tenant admins can change them; all users can read them.
105
106
  companyName: createTenantConfig("text", { default: "" }),
107
+ companyAddress: companyDataConfig("companyAddress"),
108
+ companyPhone: companyDataConfig("companyPhone"),
109
+ companyEmail: companyDataConfig("companyEmail"),
110
+ companyWebsite: companyDataConfig("companyWebsite"),
111
+ companyRegister: companyDataConfig("companyRegister"),
112
+ companyVatId: companyDataConfig("companyVatId"),
113
+ companyManagement: companyDataConfig("companyManagement"),
114
+ companyBank: companyDataConfig("companyBank"),
115
+ companyIban: companyDataConfig("companyIban"),
116
+ companyBic: companyDataConfig("companyBic"),
106
117
  // Curated subset of IANA time zones covering the most relevant practical cases.
107
118
  // Extend it when a real need arises.
108
119
  timezone: createTenantConfig("select", {
@@ -7,6 +7,20 @@ export const TENANT_I18N: Readonly<Record<string, LocalizedString>> = {
7
7
  "screen:invite-create.title": { en: "New invitation" },
8
8
  "screen:member-roles-edit.title": { en: "Edit roles" },
9
9
  "tenant.nav.members": { en: "Team" },
10
+ "tenant.company.section": { en: "Company details" },
11
+ "screen:tenant-tenant.title": { en: "Company details" },
12
+ "screen:tenant-system.title": { en: "Company details of all tenants" },
13
+ "tenant.settings": { en: "Company details" },
14
+ "tenant.company.companyAddress": { en: "Address" },
15
+ "tenant.company.companyPhone": { en: "Phone" },
16
+ "tenant.company.companyEmail": { en: "Email" },
17
+ "tenant.company.companyWebsite": { en: "Website" },
18
+ "tenant.company.companyRegister": { en: "Commercial register" },
19
+ "tenant.company.companyVatId": { en: "VAT ID" },
20
+ "tenant.company.companyManagement": { en: "Management" },
21
+ "tenant.company.companyBank": { en: "Bank" },
22
+ "tenant.company.companyIban": { en: "IBAN" },
23
+ "tenant.company.companyBic": { en: "BIC" },
10
24
  "tenant.members.actions.editRoles": { en: "Edit roles" },
11
25
  "tenant.members.col.email": { en: "Email" },
12
26
  "tenant.members.col.roles": { en: "Roles" },
@@ -28,6 +28,57 @@ export const TENANT_ADMIN_PASSWORD = "nordlicht-berger";
28
28
  export const PLATFORM_ADMIN_EMAIL = "plattform@kumiko.dev";
29
29
  export const PLATFORM_ADMIN_PASSWORD = "kumiko-plattform";
30
30
 
31
+ // Tenants of the print-editor e2e specs. Specs may share a tenant they only read; whatever a test
32
+ // writes lives in a tenant no parallel test reads, so no test sees a layout, template or setting
33
+ // change mid-run.
34
+ export type PrintEditorTenant = {
35
+ readonly tenantId: string;
36
+ readonly tenantKey: string;
37
+ readonly tenantName: string;
38
+ readonly adminEmail: string;
39
+ readonly adminName: string;
40
+ };
41
+ export const PRINT_EDITOR_PASSWORD = "druckeditor-verwaltung";
42
+ export const PRINT_EDITOR_TENANTS = {
43
+ editor: {
44
+ tenantId: "00000000-0000-4000-8000-000000000011",
45
+ tenantKey: "hafenkontor",
46
+ tenantName: "Hafenkontor Verwaltung GmbH",
47
+ adminEmail: "t.brandt@hafenkontor-verwaltung.de",
48
+ adminName: "T. Brandt",
49
+ },
50
+ appearance: {
51
+ tenantId: "00000000-0000-4000-8000-000000000012",
52
+ tenantKey: "werftstrasse",
53
+ tenantName: "Werftstraße Immobilien KG",
54
+ adminEmail: "s.otto@werftstrasse-immobilien.de",
55
+ adminName: "S. Otto",
56
+ },
57
+ applySelected: {
58
+ tenantId: "00000000-0000-4000-8000-000000000013",
59
+ tenantKey: "gartenstadt",
60
+ tenantName: "Gartenstadt Wohnbau eG",
61
+ adminEmail: "m.krause@gartenstadt-wohnbau.de",
62
+ adminName: "M. Krause",
63
+ },
64
+ applyAll: {
65
+ tenantId: "00000000-0000-4000-8000-000000000014",
66
+ tenantKey: "marschland",
67
+ tenantName: "Marschland Hausverwaltung GmbH",
68
+ adminEmail: "j.feddersen@marschland-hausverwaltung.de",
69
+ adminName: "J. Feddersen",
70
+ },
71
+ // Same seed as `editor`. The print-editor tests that save a draft use it, so the parallel tests
72
+ // and specs reading `editor` never see a draft appear mid-test.
73
+ drafts: {
74
+ tenantId: "00000000-0000-4000-8000-000000000015",
75
+ tenantKey: "lotsenhaus",
76
+ tenantName: "Lotsenhaus Verwaltung GmbH",
77
+ adminEmail: "h.lange@lotsenhaus-verwaltung.de",
78
+ adminName: "H. Lange",
79
+ },
80
+ } as const satisfies Record<string, PrintEditorTenant>;
81
+
31
82
  // Signs the unsubscribe links of the sample's mails; the e2e signs its own links with it.
32
83
  // A real app reads it from its secret store.
33
84
  export const UNSUBSCRIBE_SECRET = "ui-walkthrough-unsubscribe-secret-sample-only";
@@ -0,0 +1,118 @@
1
+ // One tenant per print-editor e2e spec (see PRINT_EDITOR_TENANTS). Everything goes through the
2
+ // template and config write handlers, never straight into the tables.
3
+
4
+ import { seedAdmin } from "@cosmicdrift/kumiko-bundled-features/auth-email-password/seeding";
5
+ import {
6
+ TemplateResolverHandlers,
7
+ TemplateResolverQueries,
8
+ } from "@cosmicdrift/kumiko-bundled-features/template-resolver";
9
+ import type { SeedFn } from "@cosmicdrift/kumiko-dev-server";
10
+ import type { SessionUser, TenantId } from "@cosmicdrift/kumiko-framework/engine";
11
+ import {
12
+ PRINT_EDITOR_PASSWORD,
13
+ PRINT_EDITOR_TENANTS,
14
+ type PrintEditorTenant,
15
+ } from "./auth-constants";
16
+ import {
17
+ type SeedTemplate,
18
+ SYSTEM_PDF_LAYOUT,
19
+ TENANT_UTILITY_STATEMENT,
20
+ } from "./template-seed-data";
21
+
22
+ const COMPANY_DATA = {
23
+ "company-address": "Kaistraße 18\n20457 Hamburg",
24
+ "company-phone": "+49 40 5550 1100",
25
+ "company-email": "verwaltung@hafenkontor-beispiel.de",
26
+ "company-register": "HRB 120045 Amtsgericht Hamburg",
27
+ "company-iban": "DE89 3704 0044 0532 0130 00",
28
+ } as const;
29
+
30
+ const LETTER_MARGINS_MM = { top: 32, right: 22, bottom: 27, left: 26 } as const;
31
+
32
+ // Follows the tenant default layout, since it names none of its own.
33
+ const UTILITY_STATEMENT_WITHOUT_LAYOUT: SeedTemplate = {
34
+ ...TENANT_UTILITY_STATEMENT,
35
+ meta: { pageFormat: "A4", fileName: "Nebenkostenabrechnung.pdf" },
36
+ };
37
+
38
+ async function seedTenant(
39
+ stack: Parameters<SeedFn>[0],
40
+ tenant: PrintEditorTenant,
41
+ setup: (user: SessionUser, write: WriteTemplate) => Promise<void>,
42
+ ): Promise<void> {
43
+ const tenantId = tenant.tenantId as TenantId;
44
+ const account = await seedAdmin(stack.db, {
45
+ email: tenant.adminEmail,
46
+ password: PRINT_EDITOR_PASSWORD,
47
+ displayName: tenant.adminName,
48
+ emailVerified: true,
49
+ memberships: [
50
+ {
51
+ tenantId,
52
+ tenantKey: tenant.tenantKey,
53
+ tenantName: tenant.tenantName,
54
+ roles: ["TenantAdmin"],
55
+ },
56
+ ],
57
+ });
58
+ const admin: SessionUser = {
59
+ id: account.id as SessionUser["id"],
60
+ tenantId,
61
+ roles: ["TenantAdmin"],
62
+ };
63
+ const overview = await stack.http.queryOk<{ rows: { origin: string }[] }>(
64
+ TemplateResolverQueries.overview,
65
+ {},
66
+ admin,
67
+ );
68
+ if (overview.rows.some((row) => row.origin === "tenant")) return;
69
+ const write: WriteTemplate = (template) =>
70
+ stack.http.writeOk(
71
+ TemplateResolverHandlers.upsertTenant,
72
+ {
73
+ slug: template.slug,
74
+ kind: template.kind,
75
+ locale: template.locale,
76
+ contentFormat: "html",
77
+ content: template.content,
78
+ status: "active",
79
+ ...(template.title !== undefined && { title: template.title }),
80
+ ...(template.meta !== undefined && { meta: template.meta }),
81
+ ...(template.variableSchema !== undefined && { variableSchema: template.variableSchema }),
82
+ },
83
+ admin,
84
+ );
85
+ await setup(admin, write);
86
+ }
87
+
88
+ type WriteTemplate = (template: SeedTemplate) => Promise<unknown>;
89
+
90
+ export const seedPrintEditorTenants: SeedFn = async (stack) => {
91
+ const { editor, drafts, appearance, applySelected, applyAll } = PRINT_EDITOR_TENANTS;
92
+ const setCompanyData = async (user: SessionUser): Promise<void> => {
93
+ for (const [name, value] of Object.entries(COMPANY_DATA)) {
94
+ await stack.http.writeOk("config:write:set", { key: `tenant:config:${name}`, value }, user);
95
+ }
96
+ };
97
+ const setUpEditorTenant = async (user: SessionUser, write: WriteTemplate): Promise<void> => {
98
+ await setCompanyData(user);
99
+ await write(TENANT_UTILITY_STATEMENT);
100
+ // The ruler's margin marks read the layout's own margins.
101
+ await write({
102
+ ...SYSTEM_PDF_LAYOUT,
103
+ meta: { margins: LETTER_MARGINS_MM },
104
+ });
105
+ };
106
+
107
+ await seedTenant(stack, editor, setUpEditorTenant);
108
+ await seedTenant(stack, drafts, setUpEditorTenant);
109
+ await seedTenant(stack, appearance, async (user) => {
110
+ await setCompanyData(user);
111
+ });
112
+ await seedTenant(stack, applySelected, async (_user, write) => {
113
+ await write(TENANT_UTILITY_STATEMENT);
114
+ });
115
+ await seedTenant(stack, applyAll, async (_user, write) => {
116
+ await write(UTILITY_STATEMENT_WITHOUT_LAYOUT);
117
+ });
118
+ };
@@ -28,6 +28,7 @@ import {
28
28
  PAYMENT_REMINDER_TEMPLATES,
29
29
  type SeedTemplate,
30
30
  SYSTEM_AUTH_MAILS,
31
+ SYSTEM_BRIEFBOGEN_LAYOUT,
31
32
  SYSTEM_INVOICE_DOCUMENTS,
32
33
  SYSTEM_INVOICE_ISSUED,
33
34
  SYSTEM_PDF_LAYOUT,
@@ -165,6 +166,7 @@ export const seedTemplates: SeedFn = async (stack) => {
165
166
  platformAdmin,
166
167
  );
167
168
  await upsertSystem(SYSTEM_PDF_LAYOUT);
169
+ await upsertSystem(SYSTEM_BRIEFBOGEN_LAYOUT);
168
170
  for (const mail of SYSTEM_AUTH_MAILS) await upsertSystem(mail);
169
171
  await upsertSystem(SYSTEM_INVOICE_ISSUED);
170
172
  await upsertSystem(SYSTEM_TERMS_CHANGED);
@@ -23,6 +23,7 @@ import {
23
23
  UNSUBSCRIBE_SECRET,
24
24
  } from "./auth-constants";
25
25
  import { seedTasks } from "./seed";
26
+ import { seedPrintEditorTenants } from "./seed-print-editor-tenants";
26
27
  import { seedRental } from "./seed-rental";
27
28
  import { seedTemplates } from "./seed-templates";
28
29
  import { seedVehicles } from "./seed-vehicles";
@@ -35,7 +36,14 @@ import { seedVehicles } from "./seed-vehicles";
35
36
 
36
37
  await runDevApp({
37
38
  features: [...APP_FEATURES],
38
- seeds: [seedTasks, seedRental, seedVehicles, seedTemplates, seedPlanTerms],
39
+ seeds: [
40
+ seedTasks,
41
+ seedRental,
42
+ seedVehicles,
43
+ seedTemplates,
44
+ seedPrintEditorTenants,
45
+ seedPlanTerms,
46
+ ],
39
47
  // PORT env var override for Playwright e2e runs (config points to 4174);
40
48
  // otherwise local default 4173.
41
49
  port: Number.parseInt(process.env["PORT"] ?? "4173", 10),