@cosmicdrift/kumiko-bundled-features 0.422.0 → 0.424.1

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 (117) hide show
  1. package/dist/auth-email-password/handlers/login.write.d.ts +10 -1
  2. package/dist/auth-email-password/handlers/login.write.js +29 -0
  3. package/dist/auth-email-password/index.d.ts +1 -0
  4. package/dist/auth-email-password/index.js +1 -0
  5. package/dist/channel-push/push-channel.d.ts +2 -6
  6. package/dist/document-draft/entity.d.ts +320 -0
  7. package/dist/document-draft/entity.js +98 -0
  8. package/dist/document-draft/feature.d.ts +3 -0
  9. package/dist/document-draft/feature.js +42 -0
  10. package/dist/document-draft/handlers/blocks.query.d.ts +28 -0
  11. package/dist/document-draft/handlers/blocks.query.js +48 -0
  12. package/dist/document-draft/handlers/by-subject.query.d.ts +16 -0
  13. package/dist/document-draft/handlers/by-subject.query.js +42 -0
  14. package/dist/document-draft/handlers/create.write.d.ts +17 -0
  15. package/dist/document-draft/handlers/create.write.js +83 -0
  16. package/dist/document-draft/handlers/discard.write.d.ts +8 -0
  17. package/dist/document-draft/handlers/discard.write.js +27 -0
  18. package/dist/document-draft/handlers/finalize.write.d.ts +21 -0
  19. package/dist/document-draft/handlers/finalize.write.js +73 -0
  20. package/dist/document-draft/handlers/patch.write.d.ts +1420 -0
  21. package/dist/document-draft/handlers/patch.write.js +65 -0
  22. package/dist/document-draft/handlers/revise.write.d.ts +12 -0
  23. package/dist/document-draft/handlers/revise.write.js +39 -0
  24. package/dist/document-draft/handlers/save.write.d.ts +12 -0
  25. package/dist/document-draft/handlers/save.write.js +40 -0
  26. package/dist/document-draft/i18n.d.ts +6 -0
  27. package/dist/document-draft/i18n.js +20 -0
  28. package/dist/document-draft/index.d.ts +5 -0
  29. package/dist/document-draft/index.js +3 -0
  30. package/dist/document-draft/lib.d.ts +13 -0
  31. package/dist/document-draft/lib.js +42 -0
  32. package/dist/document-draft/options.d.ts +35 -0
  33. package/dist/document-draft/options.js +1 -0
  34. package/dist/document-draft/payloads.d.ts +1440 -0
  35. package/dist/document-draft/payloads.js +35 -0
  36. package/dist/document-draft/screens/editor-screen.d.ts +3 -0
  37. package/dist/document-draft/screens/editor-screen.js +13 -0
  38. package/dist/document-draft/user-data.d.ts +13 -0
  39. package/dist/document-draft/user-data.js +43 -0
  40. package/dist/document-draft/web/client-plugin.d.ts +7 -0
  41. package/dist/document-draft/web/client-plugin.js +13 -0
  42. package/dist/document-draft/web/constants.d.ts +41 -0
  43. package/dist/document-draft/web/constants.js +42 -0
  44. package/dist/document-draft/web/editor-screen.d.ts +2 -0
  45. package/dist/document-draft/web/editor-screen.js +181 -0
  46. package/dist/document-draft/web/i18n.d.ts +99 -0
  47. package/dist/document-draft/web/i18n.js +52 -0
  48. package/dist/document-draft/web/index.d.ts +3 -0
  49. package/dist/document-draft/web/index.js +3 -0
  50. package/dist/shared/index.d.ts +1 -0
  51. package/dist/shared/index.js +1 -0
  52. package/dist/shared/subject-scope.d.ts +21 -0
  53. package/dist/signature/feature.js +1 -1
  54. package/dist/signature/handlers/cancel.write.d.ts +1 -1
  55. package/dist/signature/handlers/issue-link.write.d.ts +1 -1
  56. package/dist/signature/handlers/request.write.d.ts +1 -1
  57. package/dist/signature/handlers/revoke-link.write.d.ts +1 -1
  58. package/dist/signature/handlers/sign-in-person.write.d.ts +1 -1
  59. package/dist/signature/options.d.ts +2 -1
  60. package/dist/signature/subject-queries.d.ts +1 -1
  61. package/dist/template-resolver/api.d.ts +3 -1
  62. package/dist/template-resolver/boot-rules.d.ts +5 -0
  63. package/dist/template-resolver/boot-rules.js +5 -0
  64. package/dist/template-resolver/feature.d.ts +2 -0
  65. package/dist/template-resolver/feature.js +15 -1
  66. package/dist/template-resolver/handlers/create-variant.write.d.ts +17 -0
  67. package/dist/template-resolver/handlers/create-variant.write.js +112 -0
  68. package/dist/template-resolver/handlers/document-base.d.ts +1 -0
  69. package/dist/template-resolver/handlers/document-base.js +2 -0
  70. package/dist/template-resolver/handlers/overview.query.d.ts +6 -0
  71. package/dist/template-resolver/handlers/overview.query.js +29 -3
  72. package/dist/template-resolver/handlers/patch-draft.write.js +9 -1
  73. package/dist/template-resolver/handlers/template-write.d.ts +8 -2
  74. package/dist/template-resolver/handlers/template-write.js +87 -12
  75. package/dist/template-resolver/handlers/toggle-status.write.js +26 -5
  76. package/dist/template-resolver/handlers/upsert-tenant.write.js +1 -0
  77. package/dist/template-resolver/handlers/variants.query.d.ts +11 -0
  78. package/dist/template-resolver/handlers/variants.query.js +62 -0
  79. package/dist/template-resolver/i18n.js +1 -0
  80. package/dist/template-resolver/index.d.ts +5 -1
  81. package/dist/template-resolver/index.js +5 -1
  82. package/dist/template-resolver/seeding.d.ts +2 -0
  83. package/dist/template-resolver/seeding.js +12 -1
  84. package/dist/template-resolver/template-delivery-policy.d.ts +13 -4
  85. package/dist/template-resolver/template-delivery-policy.js +38 -2
  86. package/dist/template-resolver/template-edit-policy.d.ts +3 -0
  87. package/dist/template-resolver/template-edit-policy.js +2 -2
  88. package/dist/template-resolver/template-meta.d.ts +1 -0
  89. package/dist/template-resolver/template-meta.js +1 -0
  90. package/dist/template-resolver/template-variants.d.ts +11 -0
  91. package/dist/template-resolver/template-variants.js +43 -0
  92. package/dist/template-resolver/web/document-tiptap-content.js +7 -2
  93. package/dist/template-resolver/web/document-tiptap-toolbar.js +8 -4
  94. package/dist/template-resolver/web/i18n.js +22 -0
  95. package/dist/template-resolver/web/index.d.ts +1 -0
  96. package/dist/template-resolver/web/index.js +1 -0
  97. package/dist/template-resolver/web/qualified-names.d.ts +5 -0
  98. package/dist/template-resolver/web/qualified-names.js +5 -0
  99. package/dist/template-resolver/web/system-placeholders.d.ts +4 -0
  100. package/dist/template-resolver/web/system-placeholders.js +13 -0
  101. package/dist/tenant/handlers/update-member-roles.write.js +1 -1
  102. package/dist/tenant/i18n.js +0 -1
  103. package/dist/tenant-inactivity/constants.d.ts +1 -1
  104. package/dist/tenant-inactivity/constants.js +1 -1
  105. package/dist/tenant-lifecycle/constants.d.ts +1 -1
  106. package/dist/tenant-lifecycle/constants.js +1 -1
  107. package/package.json +27 -11
  108. package/src/channel-push/changes.json +8 -1
  109. package/src/document-draft/changes.json +8 -0
  110. package/src/helpdesk/changes.json +6 -0
  111. package/src/signature/changes.json +6 -0
  112. package/src/template-resolver/changes.json +30 -0
  113. package/src/tenant/changes.json +7 -0
  114. package/src/tenant-inactivity/changes.json +7 -0
  115. package/src/tenant-lifecycle/changes.json +7 -0
  116. package/dist/signature/subject-scope.d.ts +0 -11
  117. /package/dist/{signature → shared}/subject-scope.js +0 -0
@@ -0,0 +1,65 @@
1
+ import { defineWriteHandler } from "@cosmicdrift/kumiko-framework/engine";
2
+ import { ValidationError, writeFailure } from "@cosmicdrift/kumiko-framework/errors";
3
+ import { applyDocumentOps, parseDocumentJson, serializeDocumentJson, } from "../../template-resolver/index.js";
4
+ import { documentDraftExecutor } from "../entity.js";
5
+ import { draftNotFound, loadScopedDraft, notInStatus, recordOrEmpty } from "../lib.js";
6
+ import { PatchDraftSchema } from "../payloads.js";
7
+ import { DOCUMENT_DRAFT_ERROR, DOCUMENT_DRAFT_LAST_CHANGE_SOURCE, DOCUMENT_DRAFT_STATUS, } from "../web/constants.js";
8
+ // The draft keeps the variables and settings of its template: only the text changes.
9
+ const REFUSED_DRAFT_OPS = new Set([
10
+ "setVariable",
11
+ "setMeta",
12
+ "setResource",
13
+ ]);
14
+ export function createPatchHandler(access, scope) {
15
+ return defineWriteHandler({
16
+ name: "patch",
17
+ schema: PatchDraftSchema,
18
+ access,
19
+ agent: { risk: "low", effect: "proposal" },
20
+ description: "Changes the text of an open document draft with the same structured operations as patch-draft of a template (insertBlock, replaceBody, formatBlock, replaceText, removeBlock; never raw HTML), without touching the template. setVariable, setMeta and setResource are refused with op_not_allowed. Block ids and base (the draft version) come from the blocks query and refer to the state that was read; if the draft changed since, the call fails with version_conflict and nothing is written. Placeholders may be removed. Returns the draft id and its new version.",
21
+ handler: async (event, ctx) => {
22
+ const { id, base, ops } = event.payload;
23
+ const user = event.user;
24
+ const draft = await loadScopedDraft(ctx, user, scope, id);
25
+ if (draft === null)
26
+ return draftNotFound(id);
27
+ if (draft.status !== DOCUMENT_DRAFT_STATUS.Open)
28
+ return notInStatus(DOCUMENT_DRAFT_STATUS.Open);
29
+ const refusedIndex = ops.findIndex((op) => REFUSED_DRAFT_OPS.has(op.op));
30
+ if (refusedIndex !== -1) {
31
+ return writeFailure(new ValidationError({
32
+ fields: [
33
+ {
34
+ path: `ops.${refusedIndex}`,
35
+ code: DOCUMENT_DRAFT_ERROR.OpNotAllowed,
36
+ i18nKey: "documentDraft.errors.opNotAllowed",
37
+ params: { op: ops[refusedIndex]?.op },
38
+ },
39
+ ],
40
+ }));
41
+ }
42
+ const applied = applyDocumentOps({
43
+ doc: parseDocumentJson(String(draft.body)),
44
+ meta: recordOrEmpty(draft.meta),
45
+ variableSchema: recordOrEmpty(draft.variableSchema),
46
+ kind: "document-pdf",
47
+ region: undefined,
48
+ ops,
49
+ });
50
+ if (!applied.ok)
51
+ return writeFailure(new ValidationError({ fields: applied.issues }));
52
+ const updated = await documentDraftExecutor.update({
53
+ id,
54
+ version: base,
55
+ changes: {
56
+ body: serializeDocumentJson(applied.doc),
57
+ lastChange: { source: DOCUMENT_DRAFT_LAST_CHANGE_SOURCE.Ops, ops },
58
+ },
59
+ }, user, ctx.db);
60
+ if (!updated.isSuccess)
61
+ return updated;
62
+ return { isSuccess: true, data: { id, version: updated.data.event.version } };
63
+ },
64
+ });
65
+ }
@@ -0,0 +1,12 @@
1
+ import { type AccessRule } from "@cosmicdrift/kumiko-framework/engine";
2
+ import type { SubjectScope } from "../../shared/index.ts";
3
+ type ReviseData = {
4
+ readonly id: string;
5
+ readonly version: number;
6
+ readonly revision: number;
7
+ };
8
+ export declare function createReviseHandler(access: AccessRule, scope: SubjectScope): import("@cosmicdrift/kumiko-types/define-handler").WriteHandlerDefinition<"revise", import("zod").ZodObject<{
9
+ id: import("zod").ZodUUID;
10
+ base: import("zod").ZodNumber;
11
+ }, import("zod/v4/core").$strip>, ReviseData, import("@cosmicdrift/kumiko-types/event-type-map").KumikoEventTypeMap, undefined, undefined>;
12
+ export {};
@@ -0,0 +1,39 @@
1
+ import { defineWriteHandler } from "@cosmicdrift/kumiko-framework/engine";
2
+ import { documentDraftExecutor } from "../entity.js";
3
+ import { draftNotFound, loadScopedDraft, notInStatus } from "../lib.js";
4
+ import { DraftBaseSchema } from "../payloads.js";
5
+ import { DOCUMENT_DRAFT_STATUS } from "../web/constants.js";
6
+ export function createReviseHandler(access, scope) {
7
+ return defineWriteHandler({
8
+ name: "revise",
9
+ schema: DraftBaseSchema,
10
+ access,
11
+ agent: { risk: "mid" },
12
+ description: "Reopens a finalized document draft for editing: the revision counts up and the file reference is cleared (the stored PDF stays in the files). The next finalize prints a new PDF.",
13
+ handler: async (event, ctx) => {
14
+ const { id, base } = event.payload;
15
+ const user = event.user;
16
+ const draft = await loadScopedDraft(ctx, user, scope, id);
17
+ if (draft === null)
18
+ return draftNotFound(id);
19
+ if (draft.status !== DOCUMENT_DRAFT_STATUS.Finalized) {
20
+ return notInStatus(DOCUMENT_DRAFT_STATUS.Finalized);
21
+ }
22
+ const revision = Number(draft.revision) + 1;
23
+ const updated = await documentDraftExecutor.update({
24
+ id,
25
+ version: base,
26
+ changes: {
27
+ status: DOCUMENT_DRAFT_STATUS.Open,
28
+ revision,
29
+ fileRefId: null,
30
+ fileName: null,
31
+ finalizedAt: null,
32
+ },
33
+ }, user, ctx.db);
34
+ if (!updated.isSuccess)
35
+ return updated;
36
+ return { isSuccess: true, data: { id, version: updated.data.event.version, revision } };
37
+ },
38
+ });
39
+ }
@@ -0,0 +1,12 @@
1
+ import { type AccessRule } from "@cosmicdrift/kumiko-framework/engine";
2
+ import type { SubjectScope } from "../../shared/index.ts";
3
+ type SaveData = {
4
+ readonly id: string;
5
+ readonly version: number;
6
+ };
7
+ export declare function createSaveHandler(access: AccessRule, scope: SubjectScope): import("@cosmicdrift/kumiko-types/define-handler").WriteHandlerDefinition<"save", import("zod").ZodObject<{
8
+ id: import("zod").ZodUUID;
9
+ base: import("zod").ZodNumber;
10
+ content: import("zod").ZodString;
11
+ }, import("zod/v4/core").$strip>, SaveData, import("@cosmicdrift/kumiko-types/event-type-map").KumikoEventTypeMap, undefined, undefined>;
12
+ export {};
@@ -0,0 +1,40 @@
1
+ import { defineWriteHandler } from "@cosmicdrift/kumiko-framework/engine";
2
+ import { ValidationError, writeFailure } from "@cosmicdrift/kumiko-framework/errors";
3
+ import { documentViolationsToFieldIssues, sanitizeDocumentHtml, } from "../../template-resolver/index.js";
4
+ import { documentDraftExecutor } from "../entity.js";
5
+ import { draftNotFound, loadScopedDraft, notInStatus } from "../lib.js";
6
+ import { SaveDraftSchema } from "../payloads.js";
7
+ import { DOCUMENT_DRAFT_LAST_CHANGE_SOURCE, DOCUMENT_DRAFT_STATUS } from "../web/constants.js";
8
+ export function createSaveHandler(access, scope) {
9
+ return defineWriteHandler({
10
+ name: "save",
11
+ schema: SaveDraftSchema,
12
+ access,
13
+ agent: { expose: false },
14
+ description: "Replaces the text of an open document draft with the HTML of the editor; the HTML is checked and cleaned like a template body, and anything it does not allow is refused with the violation codes.",
15
+ handler: async (event, ctx) => {
16
+ const { id, base, content } = event.payload;
17
+ const user = event.user;
18
+ const draft = await loadScopedDraft(ctx, user, scope, id);
19
+ if (draft === null)
20
+ return draftNotFound(id);
21
+ if (draft.status !== DOCUMENT_DRAFT_STATUS.Open)
22
+ return notInStatus(DOCUMENT_DRAFT_STATUS.Open);
23
+ const sanitized = sanitizeDocumentHtml(content);
24
+ if (!sanitized.ok) {
25
+ return writeFailure(new ValidationError({ fields: documentViolationsToFieldIssues(sanitized.violations) }));
26
+ }
27
+ const updated = await documentDraftExecutor.update({
28
+ id,
29
+ version: base,
30
+ changes: {
31
+ body: sanitized.html,
32
+ lastChange: { source: DOCUMENT_DRAFT_LAST_CHANGE_SOURCE.Editor },
33
+ },
34
+ }, user, ctx.db);
35
+ if (!updated.isSuccess)
36
+ return updated;
37
+ return { isSuccess: true, data: { id, version: updated.data.event.version } };
38
+ },
39
+ });
40
+ }
@@ -0,0 +1,6 @@
1
+ type LocalizedString = {
2
+ readonly en: string;
3
+ readonly de: string;
4
+ };
5
+ export declare const DOCUMENT_DRAFT_I18N: Readonly<Record<string, LocalizedString>>;
6
+ export {};
@@ -0,0 +1,20 @@
1
+ export const DOCUMENT_DRAFT_I18N = {
2
+ "document-draft:feature.label": { en: "Document drafts", de: "Dokumententwürfe" },
3
+ "screen:document-draft-editor.title": { en: "Document draft", de: "Dokumententwurf" },
4
+ "documentDraft.errors.notOpen": {
5
+ en: "This draft is not open for editing.",
6
+ de: "Dieser Entwurf ist nicht zur Bearbeitung offen.",
7
+ },
8
+ "documentDraft.errors.notFinalized": {
9
+ en: "This draft is not finalized.",
10
+ de: "Dieser Entwurf ist nicht abgeschlossen.",
11
+ },
12
+ "documentDraft.errors.templateNotFound": {
13
+ en: "The template {slug} does not exist.",
14
+ de: "Die Vorlage {slug} existiert nicht.",
15
+ },
16
+ "documentDraft.errors.opNotAllowed": {
17
+ en: "The operation {op} is not allowed on a draft: only its text can change.",
18
+ de: "Die Operation {op} ist bei einem Entwurf nicht erlaubt: nur der Text ist änderbar.",
19
+ },
20
+ };
@@ -0,0 +1,5 @@
1
+ export type { DocumentDraftRetention } from "./entity.ts";
2
+ export { createDocumentDraftFeature } from "./feature.ts";
3
+ export type { AuthorizeDocumentDraftSubject, DocumentDraftOptions, DocumentDraftPdf, DocumentDraftRenderArgs, DocumentDraftSubject, } from "./options.ts";
4
+ export { forgetDocumentDraftsOfSubject } from "./user-data.ts";
5
+ export { DOCUMENT_DRAFT_EDITOR_SCREEN_ID, DOCUMENT_DRAFT_EDITOR_SCREEN_QN, DOCUMENT_DRAFT_ENTITY, DOCUMENT_DRAFT_ERROR, DOCUMENT_DRAFT_FEATURE, DOCUMENT_DRAFT_STATUS, DocumentDraftHandlers, DocumentDraftQueries, type DocumentDraftStatus, } from "./web/constants.ts";
@@ -0,0 +1,3 @@
1
+ export { createDocumentDraftFeature } from "./feature.js";
2
+ export { forgetDocumentDraftsOfSubject } from "./user-data.js";
3
+ export { DOCUMENT_DRAFT_EDITOR_SCREEN_ID, DOCUMENT_DRAFT_EDITOR_SCREEN_QN, DOCUMENT_DRAFT_ENTITY, DOCUMENT_DRAFT_ERROR, DOCUMENT_DRAFT_FEATURE, DOCUMENT_DRAFT_STATUS, DocumentDraftHandlers, DocumentDraftQueries, } from "./web/constants.js";
@@ -0,0 +1,13 @@
1
+ import type { AccessRule, SessionUser } from "@cosmicdrift/kumiko-framework/engine";
2
+ import type { SubjectScope, SubjectScopeContext } from "../shared/index.ts";
3
+ import { type PdfTemplateMeta } from "../template-resolver/index.ts";
4
+ import { documentDraftExecutor } from "./entity.ts";
5
+ import { type DocumentDraftStatus } from "./web/constants.ts";
6
+ export declare const DEFAULT_DOCUMENT_DRAFT_ACCESS: AccessRule;
7
+ export type DraftRow = NonNullable<Awaited<ReturnType<typeof documentDraftExecutor.detail>>>;
8
+ export declare function draftNotFound(id?: string): import("@cosmicdrift/kumiko-types/write-error-info-types").WriteFailure;
9
+ export declare function loadScopedDraft(ctx: SubjectScopeContext, user: SessionUser, scope: SubjectScope, id: string): Promise<DraftRow | null>;
10
+ export declare function notInStatus(expected: DocumentDraftStatus): import("@cosmicdrift/kumiko-types/write-error-info-types").WriteFailure;
11
+ export declare function checkOpenAtBase(draft: DraftRow, id: string, base: number): import("@cosmicdrift/kumiko-types/write-error-info-types").WriteFailure | null;
12
+ export declare function recordOrEmpty(value: unknown): Readonly<Record<string, unknown>>;
13
+ export declare function pdfMetaOf(raw: unknown): PdfTemplateMeta | null;
@@ -0,0 +1,42 @@
1
+ import { NotFoundError, UnprocessableError, VersionConflictError, writeFailure, } from "@cosmicdrift/kumiko-framework/errors";
2
+ import { isPlainObject } from "@cosmicdrift/kumiko-types/type-guards";
3
+ import { parseTemplateMeta, readPdfTemplateMeta, } from "../template-resolver/index.js";
4
+ import { documentDraftExecutor } from "./entity.js";
5
+ import { DOCUMENT_DRAFT_ENTITY, DOCUMENT_DRAFT_ERROR, DOCUMENT_DRAFT_STATUS, } from "./web/constants.js";
6
+ export const DEFAULT_DOCUMENT_DRAFT_ACCESS = { roles: ["TenantAdmin", "TenantMember"] };
7
+ export function draftNotFound(id) {
8
+ return writeFailure(new NotFoundError(DOCUMENT_DRAFT_ENTITY, id));
9
+ }
10
+ // A draft of another tenant, an unknown id and a subject the user may not see all answer the same.
11
+ export async function loadScopedDraft(ctx, user, scope, id) {
12
+ const row = await documentDraftExecutor.detail({ id }, user, ctx.db);
13
+ if (row === null || !(await scope.allowsRequest(ctx, user, row)))
14
+ return null;
15
+ return row;
16
+ }
17
+ export function notInStatus(expected) {
18
+ const open = expected === DOCUMENT_DRAFT_STATUS.Open;
19
+ return writeFailure(new UnprocessableError(open ? DOCUMENT_DRAFT_ERROR.NotOpen : DOCUMENT_DRAFT_ERROR.NotFinalized, {
20
+ i18nKey: open ? "documentDraft.errors.notOpen" : "documentDraft.errors.notFinalized",
21
+ }));
22
+ }
23
+ // Null when the draft is open at the version the caller read; otherwise the failure to return.
24
+ export function checkOpenAtBase(draft, id, base) {
25
+ if (draft.status !== DOCUMENT_DRAFT_STATUS.Open)
26
+ return notInStatus(DOCUMENT_DRAFT_STATUS.Open);
27
+ if (draft.version !== base) {
28
+ return writeFailure(new VersionConflictError({
29
+ entityId: id,
30
+ expectedVersion: base,
31
+ currentVersion: Number(draft.version),
32
+ }));
33
+ }
34
+ return null;
35
+ }
36
+ export function recordOrEmpty(value) {
37
+ return isPlainObject(value) ? value : {};
38
+ }
39
+ export function pdfMetaOf(raw) {
40
+ const parsed = parseTemplateMeta("document-pdf", raw);
41
+ return parsed.ok ? readPdfTemplateMeta(parsed.meta) : null;
42
+ }
@@ -0,0 +1,35 @@
1
+ import type { AccessRule, BeforeTransactionContext, BeforeTransactionResult, HandlerContext, WriteResult } from "@cosmicdrift/kumiko-framework/engine";
2
+ import type { DocumentPdfDraft } from "../renderer-foundation/index.ts";
3
+ import type { SubjectScopeOptions } from "../shared/index.ts";
4
+ import type { DocumentDraftRetention } from "./entity.ts";
5
+ export type AuthorizeDocumentDraftSubject = NonNullable<SubjectScopeOptions["authorizeSubject"]>;
6
+ export type DocumentDraftSubject = Parameters<AuthorizeDocumentDraftSubject>[2];
7
+ export type DocumentDraftRenderArgs = {
8
+ readonly slug: string;
9
+ /** Slug of a variant of `slug`, printed instead of the base. */
10
+ readonly variant?: string;
11
+ readonly locale: string;
12
+ readonly variables: Readonly<Record<string, unknown>>;
13
+ /** The draft's own body, meta and variable schema, printed instead of the stored template. */
14
+ readonly draft: DocumentPdfDraft;
15
+ };
16
+ export type DocumentDraftPdf<TUpload> = {
17
+ /** Prints the draft to a PDF and uploads it while no transaction is open. */
18
+ readonly render: (ctx: BeforeTransactionContext, args: DocumentDraftRenderArgs) => Promise<BeforeTransactionResult<TUpload>>;
19
+ /** Stores the uploaded PDF as a file inside the finalize transaction. */
20
+ readonly store: (ctx: HandlerContext, upload: TUpload) => Promise<WriteResult<{
21
+ readonly fileRefId: string;
22
+ readonly fileName: string;
23
+ }>>;
24
+ };
25
+ export type DocumentDraftOptions<TUpload> = SubjectScopeOptions & {
26
+ /** The kinds of object a draft can belong to, e.g. `lease`; create refuses any other. */
27
+ readonly subjectTypes: readonly [string, ...string[]];
28
+ readonly pdf: DocumentDraftPdf<TUpload>;
29
+ /** How long drafts are kept, data-retention keepFor syntax, counted from creation. Default 10y. */
30
+ readonly retention?: DocumentDraftRetention;
31
+ /** Access rule of the handlers and queries. Default `{ roles: ["TenantAdmin", "TenantMember"] }`. */
32
+ readonly access?: AccessRule;
33
+ /** Screen per subject type the editor returns to after finalize or discard, opened with the subject id. */
34
+ readonly subjectScreens?: Readonly<Record<string, string>>;
35
+ };
@@ -0,0 +1 @@
1
+ export {};