@managemint-solutions/sdk 0.56.0 → 0.64.0

package/dist/documents/dto.js

@@ -0,0 +1,530 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentPaymentIdDto = exports.RecordDocumentPaymentDto = exports.PayDocumentDto = exports.DocumentPayQueryDto = exports.DocumentPayTokenDto = exports.SendDocumentDto = exports.ReassignPrivateDocumentsDto = exports.DocumentImageUrlsDto = exports.DocumentImageNameDto = exports.VoidDocumentDto = exports.UpdateDocumentDto = exports.CreateDocumentDto = exports.DocumentIdDto = exports.GetDocumentsDto = exports.CreateDocumentTemplateDto = exports.UpdateDocumentTemplateDto = exports.DocumentTemplateIdDto = exports.GetDocumentTemplatesDto = void 0;
+const class_validator_1 = require("class-validator");
+const class_transformer_1 = require("class-transformer");
+const enum_1 = require("@managemint-solutions/entities/documents/enum");
+const transforms_1 = require("../transforms");
+const validators_1 = require("../validators");
+const content_1 = require("./content");
+const values_1 = require("./render/values");
+// class-validator versions of the shared DTO types from @managemint-solutions/entities, so the
+// wire contract cannot drift. The content rules (variables, blocks, values, currency) live in
+// ./content.ts, once, and each decorator there answers with the specific problem it found.
+//
+// class-validator runs a property's decorators bottom-up, and the api answers with the first
+// failure, so each property's type check sits last: a missing title says "Title must be text",
+// not that it is too long.
+// ------------------------------------------------------------
+// Templates
+// ------------------------------------------------------------
+class GetDocumentTemplatesDto {
+    search;
+    category;
+    archive = false;
+    page = 1;
+    page_size = 10;
+}
+exports.GetDocumentTemplatesDto = GetDocumentTemplatesDto;
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, validators_1.IsNullable)(),
+    (0, class_validator_1.MaxLength)(255, { message: 'Search query cannot exceed 255 characters' }),
+    (0, class_validator_1.MinLength)(1, { message: 'Search query cannot be empty' }),
+    (0, class_validator_1.IsString)({ message: 'Search query must be a string' }),
+    __metadata("design:type", Object)
+], GetDocumentTemplatesDto.prototype, "search", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, validators_1.IsNullable)(),
+    (0, content_1.IsDocumentCategory)(),
+    __metadata("design:type", Object)
+], GetDocumentTemplatesDto.prototype, "category", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, validators_1.IsNullable)(),
+    (0, class_transformer_1.Transform)(({ value }) => value ? value === 'true' : false, { toClassOnly: true }),
+    (0, class_validator_1.IsBoolean)({ message: 'Include archived must be a boolean' }),
+    __metadata("design:type", Boolean)
+], GetDocumentTemplatesDto.prototype, "archive", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_transformer_1.Transform)(({ value }) => value ? Number(value) : 1, { toClassOnly: true }),
+    (0, class_validator_1.Min)(1, { message: 'Page must be at least 1' }),
+    (0, class_validator_1.IsNumber)({}, { message: 'Page must be a number' }),
+    __metadata("design:type", Number)
+], GetDocumentTemplatesDto.prototype, "page", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_transformer_1.Transform)(({ value }) => value ? Number(value) : 10, { toClassOnly: true }),
+    (0, class_validator_1.Max)(100, { message: 'Page size cannot exceed 100' }),
+    (0, class_validator_1.Min)(1, { message: 'Page size must be at least 1' }),
+    (0, class_validator_1.IsNumber)({}, { message: 'Page size must be a number' }),
+    __metadata("design:type", Number)
+], GetDocumentTemplatesDto.prototype, "page_size", void 0);
+class DocumentTemplateIdDto {
+    templateId;
+}
+exports.DocumentTemplateIdDto = DocumentTemplateIdDto;
+__decorate([
+    (0, class_validator_1.IsUUID)('7', { message: 'Invalid template ID format' }),
+    __metadata("design:type", String)
+], DocumentTemplateIdDto.prototype, "templateId", void 0);
+/** Saving replaces the whole template. Its visibility changes only through the visibility route. */
+class UpdateDocumentTemplateDto {
+    name;
+    category;
+    number_prefix;
+    variables;
+    blocks;
+}
+exports.UpdateDocumentTemplateDto = UpdateDocumentTemplateDto;
+__decorate([
+    (0, class_validator_1.MaxLength)(100, { message: 'Name cannot exceed 100 characters' }),
+    (0, class_validator_1.MinLength)(1, { message: 'Name cannot be empty' }),
+    (0, class_validator_1.IsString)({ message: 'Name must be text' }),
+    __metadata("design:type", String)
+], UpdateDocumentTemplateDto.prototype, "name", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, content_1.IsDocumentCategory)(),
+    __metadata("design:type", String)
+], UpdateDocumentTemplateDto.prototype, "category", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, content_1.IsDocumentNumberPrefix)(),
+    __metadata("design:type", String)
+], UpdateDocumentTemplateDto.prototype, "number_prefix", void 0);
+__decorate([
+    (0, content_1.IsDocumentVariables)(),
+    __metadata("design:type", Array)
+], UpdateDocumentTemplateDto.prototype, "variables", void 0);
+__decorate([
+    (0, content_1.IsDocumentBlocks)(),
+    __metadata("design:type", Array)
+], UpdateDocumentTemplateDto.prototype, "blocks", void 0);
+/** A new template: what a save holds, plus who sees it (omitted: the organization). */
+class CreateDocumentTemplateDto extends UpdateDocumentTemplateDto {
+    visibility;
+}
+exports.CreateDocumentTemplateDto = CreateDocumentTemplateDto;
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsEnum)(enum_1.DocumentVisibility, { message: `Visibility must be one of: ${Object.values(enum_1.DocumentVisibility).join(', ')}` }),
+    __metadata("design:type", String)
+], CreateDocumentTemplateDto.prototype, "visibility", void 0);
+// ------------------------------------------------------------
+// Documents
+// ------------------------------------------------------------
+class GetDocumentsDto {
+    search;
+    category;
+    status;
+    // A UUID, or the base64-JSON option value the portal's client select sends.
+    client_id;
+    template_id;
+    // Parents only when true; otherwise parents are left out of the list.
+    recurring;
+    repeat_from;
+    payment;
+    page = 1;
+    page_size = 10;
+}
+exports.GetDocumentsDto = GetDocumentsDto;
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, validators_1.IsNullable)(),
+    (0, class_validator_1.MaxLength)(255, { message: 'Search query cannot exceed 255 characters' }),
+    (0, class_validator_1.MinLength)(1, { message: 'Search query cannot be empty' }),
+    (0, class_validator_1.IsString)({ message: 'Search query must be a string' }),
+    __metadata("design:type", Object)
+], GetDocumentsDto.prototype, "search", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, validators_1.IsNullable)(),
+    (0, content_1.IsDocumentCategory)(),
+    __metadata("design:type", Object)
+], GetDocumentsDto.prototype, "category", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, validators_1.IsNullable)(),
+    (0, class_validator_1.IsEnum)(enum_1.DocumentStatus, { message: `Status must be one of: ${Object.values(enum_1.DocumentStatus).join(', ')}` }),
+    __metadata("design:type", Object)
+], GetDocumentsDto.prototype, "status", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, validators_1.IsNullable)(),
+    (0, class_transformer_1.Transform)(({ value }) => (0, transforms_1.parseEntityIdFilter)(value), { toClassOnly: true }),
+    (0, class_validator_1.IsUUID)('7', { message: 'Invalid client ID format' }),
+    __metadata("design:type", Object)
+], GetDocumentsDto.prototype, "client_id", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, validators_1.IsNullable)(),
+    (0, class_validator_1.IsUUID)('7', { message: 'Invalid template ID format' }),
+    __metadata("design:type", Object)
+], GetDocumentsDto.prototype, "template_id", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_transformer_1.Transform)(({ value }) => value === true || value === 'true', { toClassOnly: true }),
+    (0, class_validator_1.IsBoolean)({ message: 'Recurring must be a boolean' }),
+    __metadata("design:type", Boolean)
+], GetDocumentsDto.prototype, "recurring", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, validators_1.IsNullable)(),
+    (0, class_validator_1.IsUUID)('7', { message: 'Invalid recurring document ID format' }),
+    __metadata("design:type", Object)
+], GetDocumentsDto.prototype, "repeat_from", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, validators_1.IsNullable)(),
+    (0, class_validator_1.IsEnum)(enum_1.DocumentPaymentFilter, { message: `Payment must be one of: ${Object.values(enum_1.DocumentPaymentFilter).join(', ')}` }),
+    __metadata("design:type", Object)
+], GetDocumentsDto.prototype, "payment", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_transformer_1.Transform)(({ value }) => value ? Number(value) : 1, { toClassOnly: true }),
+    (0, class_validator_1.Min)(1, { message: 'Page must be at least 1' }),
+    (0, class_validator_1.IsNumber)({}, { message: 'Page must be a number' }),
+    __metadata("design:type", Number)
+], GetDocumentsDto.prototype, "page", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_transformer_1.Transform)(({ value }) => value ? Number(value) : 10, { toClassOnly: true }),
+    (0, class_validator_1.Max)(100, { message: 'Page size cannot exceed 100' }),
+    (0, class_validator_1.Min)(1, { message: 'Page size must be at least 1' }),
+    (0, class_validator_1.IsNumber)({}, { message: 'Page size must be a number' }),
+    __metadata("design:type", Number)
+], GetDocumentsDto.prototype, "page_size", void 0);
+class DocumentIdDto {
+    documentId;
+}
+exports.DocumentIdDto = DocumentIdDto;
+__decorate([
+    (0, class_validator_1.IsUUID)('7', { message: 'Invalid document ID format' }),
+    __metadata("design:type", String)
+], DocumentIdDto.prototype, "documentId", void 0);
+/** How many addresses one send may go to, and copy in, and how long its subject and message may be. */
+const MAX_SEND_ADDRESSES = 5;
+const MAX_SUBJECT_LENGTH = 200;
+const MAX_MESSAGE_LENGTH = 5000;
+/**
+ * A stored email (a recurring parent's, a scheduled draft's): exactly what `SendDocumentDto`
+ * takes, checked by the same rules, so what the cron sends later is what a send would accept now.
+ */
+const IsDocumentEmail = (0, validators_1.fromProblem)('isDocumentEmail', (value) => {
+    if (!(0, values_1.isObject)(value))
+        return 'Email must be an object';
+    const errors = (0, class_validator_1.validateSync)((0, class_transformer_1.plainToInstance)(SendDocumentDto, value), { whitelist: true, forbidNonWhitelisted: true });
+    return errors.length === 0 ? null : `Email: ${Object.values(errors[0].constraints ?? {})[0] ?? 'is not valid'}`;
+});
+/**
+ * A recurring parent's schedule and a draft's issue date, on create and on a draft save. Each is
+ * checked alone here; how they go together (a parent needs its first date, never an issue date)
+ * is the api's.
+ */
+class DocumentScheduleDto {
+    repeat;
+    repeat_next_at;
+    repeat_until;
+    repeat_paused;
+    issue_at;
+    email;
+}
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, validators_1.IsNullable)(),
+    (0, class_validator_1.IsEnum)(enum_1.DocumentRepeat, { message: `Repeat must be one of: ${Object.values(enum_1.DocumentRepeat).join(', ')}` }),
+    __metadata("design:type", Object)
+], DocumentScheduleDto.prototype, "repeat", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, validators_1.IsNullable)(),
+    (0, validators_1.IsCalendarDate)({ message: 'First issue date must be a calendar date (YYYY-MM-DD)' }),
+    __metadata("design:type", Object)
+], DocumentScheduleDto.prototype, "repeat_next_at", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, validators_1.IsNullable)(),
+    (0, validators_1.IsCalendarDate)({ message: 'Repeat until must be a calendar date (YYYY-MM-DD)' }),
+    __metadata("design:type", Object)
+], DocumentScheduleDto.prototype, "repeat_until", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsBoolean)({ message: 'Paused must be true or false' }),
+    __metadata("design:type", Boolean)
+], DocumentScheduleDto.prototype, "repeat_paused", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, validators_1.IsNullable)(),
+    (0, validators_1.IsCalendarDate)({ message: 'Issue date must be a calendar date (YYYY-MM-DD)' }),
+    __metadata("design:type", Object)
+], DocumentScheduleDto.prototype, "issue_at", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, validators_1.IsNullable)(),
+    IsDocumentEmail(),
+    __metadata("design:type", Object)
+], DocumentScheduleDto.prototype, "email", void 0);
+/**
+ * A new draft. Its values cannot be checked here - with a template, the variables they fill are
+ * the template's - so the api checks the draft it composes with `documentProblem`.
+ */
+class CreateDocumentDto extends DocumentScheduleDto {
+    template_id;
+    client_id;
+    title;
+    currency;
+    variable_values;
+    // A blank draft's; one made from a template takes the template's, and its shares.
+    visibility;
+}
+exports.CreateDocumentDto = CreateDocumentDto;
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, validators_1.IsNullable)(),
+    (0, class_validator_1.IsUUID)('7', { message: 'Invalid template ID format' }),
+    __metadata("design:type", Object)
+], CreateDocumentDto.prototype, "template_id", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, validators_1.IsNullable)(),
+    (0, class_validator_1.IsUUID)('7', { message: 'Invalid client ID format' }),
+    __metadata("design:type", Object)
+], CreateDocumentDto.prototype, "client_id", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.MaxLength)(200, { message: 'Title cannot exceed 200 characters' }),
+    (0, class_validator_1.IsString)({ message: 'Title must be text' }),
+    __metadata("design:type", String)
+], CreateDocumentDto.prototype, "title", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, content_1.IsDocumentCurrency)(),
+    __metadata("design:type", Object)
+], CreateDocumentDto.prototype, "currency", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsObject)({ message: 'Variable values must be an object' }),
+    __metadata("design:type", Object)
+], CreateDocumentDto.prototype, "variable_values", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsEnum)(enum_1.DocumentVisibility, { message: `Visibility must be one of: ${Object.values(enum_1.DocumentVisibility).join(', ')}` }),
+    __metadata("design:type", String)
+], CreateDocumentDto.prototype, "visibility", void 0);
+/** A whole draft, under the same content rules as a template, plus its values and currency. */
+class UpdateDocumentDto extends DocumentScheduleDto {
+    client_id;
+    title;
+    category;
+    number_prefix;
+    currency;
+    variables;
+    variable_values;
+    blocks;
+}
+exports.UpdateDocumentDto = UpdateDocumentDto;
+__decorate([
+    (0, validators_1.IsNullable)(),
+    (0, class_validator_1.IsUUID)('7', { message: 'Invalid client ID format' }),
+    __metadata("design:type", Object)
+], UpdateDocumentDto.prototype, "client_id", void 0);
+__decorate([
+    (0, class_validator_1.MaxLength)(200, { message: 'Title cannot exceed 200 characters' }),
+    (0, class_validator_1.IsString)({ message: 'Title must be text' }),
+    __metadata("design:type", String)
+], UpdateDocumentDto.prototype, "title", void 0);
+__decorate([
+    (0, content_1.IsDocumentCategory)(),
+    __metadata("design:type", String)
+], UpdateDocumentDto.prototype, "category", void 0);
+__decorate([
+    (0, content_1.IsDocumentNumberPrefix)(),
+    __metadata("design:type", String)
+], UpdateDocumentDto.prototype, "number_prefix", void 0);
+__decorate([
+    (0, content_1.IsDocumentCurrency)(),
+    __metadata("design:type", Object)
+], UpdateDocumentDto.prototype, "currency", void 0);
+__decorate([
+    (0, content_1.IsDocumentVariables)(),
+    __metadata("design:type", Array)
+], UpdateDocumentDto.prototype, "variables", void 0);
+__decorate([
+    (0, content_1.IsDocumentVariableValues)(),
+    __metadata("design:type", Object)
+], UpdateDocumentDto.prototype, "variable_values", void 0);
+__decorate([
+    (0, content_1.IsDocumentBlocks)(),
+    __metadata("design:type", Array)
+], UpdateDocumentDto.prototype, "blocks", void 0);
+class VoidDocumentDto {
+    reason;
+}
+exports.VoidDocumentDto = VoidDocumentDto;
+__decorate([
+    (0, class_validator_1.MaxLength)(500, { message: 'Reason cannot exceed 500 characters' }),
+    (0, class_validator_1.Matches)(/\S/, { message: 'Give a reason for voiding the document' }),
+    (0, class_validator_1.IsString)({ message: 'Give a reason for voiding the document' }),
+    __metadata("design:type", String)
+], VoidDocumentDto.prototype, "reason", void 0);
+class DocumentImageNameDto {
+    // The resource checks the name itself (characters, length, an image extension) before it
+    // keeps the extension, which a decorator cannot.
+    name;
+}
+exports.DocumentImageNameDto = DocumentImageNameDto;
+__decorate([
+    (0, class_validator_1.MinLength)(1, { message: 'Image name cannot be empty' }),
+    (0, class_validator_1.IsString)({ message: 'Image name must be text' }),
+    __metadata("design:type", String)
+], DocumentImageNameDto.prototype, "name", void 0);
+/** How many image paths one call may sign - more than any document holds. */
+const MAX_IMAGE_PATHS = 50;
+/**
+ * Image paths to sign for reading, as a query (`?paths=a&paths=b`; one `paths` arrives as a plain
+ * string and is taken as a list of one). Each must be one `createImageUploadUrl` handed out
+ * (`documents/images/<uuid>.<ext>`); `imageUrls` then signs it under the caller's own
+ * organization, so nothing outside that folder can be named.
+ */
+class DocumentImageUrlsDto {
+    paths;
+}
+exports.DocumentImageUrlsDto = DocumentImageUrlsDto;
+__decorate([
+    (0, class_validator_1.Matches)(content_1.IMAGE_PATH, { each: true, message: 'Each path must be an image uploaded for documents' }),
+    (0, class_validator_1.IsString)({ each: true, message: 'Each path must be an image uploaded for documents' }),
+    (0, class_validator_1.ArrayMaxSize)(MAX_IMAGE_PATHS, { message: `Cannot sign more than ${MAX_IMAGE_PATHS} images at once` }),
+    (0, class_validator_1.ArrayMinSize)(1, { message: 'Give at least one image path' }),
+    (0, class_validator_1.IsArray)({ message: 'Paths must be a list' }),
+    (0, class_transformer_1.Transform)(({ value }) => (typeof value === 'string' ? [value] : value), { toClassOnly: true }),
+    __metadata("design:type", Array)
+], DocumentImageUrlsDto.prototype, "paths", void 0);
+/** The owner's move of one person's private templates and documents to another; v4 user ids. */
+class ReassignPrivateDocumentsDto {
+    from_user_id;
+    to_user_id;
+}
+exports.ReassignPrivateDocumentsDto = ReassignPrivateDocumentsDto;
+__decorate([
+    (0, class_validator_1.IsUUID)('4', { message: 'Invalid from user ID format' }),
+    __metadata("design:type", String)
+], ReassignPrivateDocumentsDto.prototype, "from_user_id", void 0);
+__decorate([
+    (0, class_validator_1.IsUUID)('4', { message: 'Invalid to user ID format' }),
+    __metadata("design:type", String)
+], ReassignPrivateDocumentsDto.prototype, "to_user_id", void 0);
+// ------------------------------------------------------------
+// Sending and paying
+// ------------------------------------------------------------
+/** A pay link's token: the document's mms_id, a dot, and the api's base64url HMAC-SHA256 of it. */
+const PAY_TOKEN = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\.[A-Za-z0-9_-]{43}$/;
+/** An issued document's email. Who may send it, and whether Pay now may go on it, is the api's. */
+class SendDocumentDto {
+    to;
+    cc;
+    subject;
+    message;
+    pay_now;
+}
+exports.SendDocumentDto = SendDocumentDto;
+__decorate([
+    (0, class_validator_1.IsEmail)({}, { each: true, message: 'Each recipient must be an email address' }),
+    (0, class_validator_1.ArrayMaxSize)(MAX_SEND_ADDRESSES, { message: `Send to ${MAX_SEND_ADDRESSES} addresses at most` }),
+    (0, class_validator_1.ArrayMinSize)(1, { message: 'Give at least one recipient' }),
+    (0, class_validator_1.IsArray)({ message: 'Recipients must be a list' }),
+    __metadata("design:type", Array)
+], SendDocumentDto.prototype, "to", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsEmail)({}, { each: true, message: 'Each copy address must be an email address' }),
+    (0, class_validator_1.ArrayMaxSize)(MAX_SEND_ADDRESSES, { message: `Copy ${MAX_SEND_ADDRESSES} addresses at most` }),
+    (0, class_validator_1.IsArray)({ message: 'Copy addresses must be a list' }),
+    __metadata("design:type", Array)
+], SendDocumentDto.prototype, "cc", void 0);
+__decorate([
+    (0, class_validator_1.MaxLength)(MAX_SUBJECT_LENGTH, { message: `Subject cannot exceed ${MAX_SUBJECT_LENGTH} characters` }),
+    (0, class_validator_1.Matches)(/\S/, { message: 'Give the email a subject' }),
+    (0, class_validator_1.IsString)({ message: 'Give the email a subject' }),
+    __metadata("design:type", String)
+], SendDocumentDto.prototype, "subject", void 0);
+__decorate([
+    (0, class_validator_1.MaxLength)(MAX_MESSAGE_LENGTH, { message: `Message cannot exceed ${MAX_MESSAGE_LENGTH} characters` }),
+    (0, class_validator_1.IsString)({ message: 'Message must be text' }),
+    __metadata("design:type", String)
+], SendDocumentDto.prototype, "message", void 0);
+__decorate([
+    (0, class_validator_1.IsBoolean)({ message: 'Pay now must be true or false' }),
+    __metadata("design:type", Boolean)
+], SendDocumentDto.prototype, "pay_now", void 0);
+/** A public pay link's token. Only its shape is checked here; the api checks the signature. */
+class DocumentPayTokenDto {
+    token;
+}
+exports.DocumentPayTokenDto = DocumentPayTokenDto;
+__decorate([
+    (0, class_validator_1.Matches)(PAY_TOKEN, { message: 'This payment link is not valid' }),
+    (0, class_validator_1.IsString)({ message: 'This payment link is not valid' }),
+    __metadata("design:type", String)
+], DocumentPayTokenDto.prototype, "token", void 0);
+/** Paystack's return to the pay page: its reference - letters, digits and - . = only, as Paystack allows. */
+class DocumentPayQueryDto {
+    reference;
+}
+exports.DocumentPayQueryDto = DocumentPayQueryDto;
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.Matches)(/^[A-Za-z0-9.=-]{1,100}$/, { message: 'Invalid payment reference' }),
+    (0, class_validator_1.IsString)({ message: 'Invalid payment reference' }),
+    __metadata("design:type", String)
+], DocumentPayQueryDto.prototype, "reference", void 0);
+class PayDocumentDto {
+    email;
+}
+exports.PayDocumentDto = PayDocumentDto;
+__decorate([
+    (0, class_validator_1.MaxLength)(254, { message: 'Email cannot exceed 254 characters' }),
+    (0, class_validator_1.IsEmail)({}, { message: 'Give a valid email address for your receipt' }),
+    __metadata("design:type", String)
+], PayDocumentDto.prototype, "email", void 0);
+/** A document marked paid by hand: the date the money arrived, and the bank reference if any. */
+class RecordDocumentPaymentDto {
+    paid_at;
+    reference;
+}
+exports.RecordDocumentPaymentDto = RecordDocumentPaymentDto;
+__decorate([
+    (0, validators_1.IsCalendarDate)({ message: 'Paid on must be a calendar date (YYYY-MM-DD)' }),
+    __metadata("design:type", String)
+], RecordDocumentPaymentDto.prototype, "paid_at", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, validators_1.IsNullable)(),
+    (0, class_validator_1.MaxLength)(100, { message: 'Reference cannot exceed 100 characters' }),
+    (0, class_validator_1.IsString)({ message: 'Reference must be text' }),
+    __metadata("design:type", Object)
+], RecordDocumentPaymentDto.prototype, "reference", void 0);
+class DocumentPaymentIdDto {
+    documentId;
+    paymentId;
+}
+exports.DocumentPaymentIdDto = DocumentPaymentIdDto;
+__decorate([
+    (0, class_validator_1.IsUUID)('7', { message: 'Invalid document ID format' }),
+    __metadata("design:type", String)
+], DocumentPaymentIdDto.prototype, "documentId", void 0);
+__decorate([
+    (0, class_validator_1.IsUUID)('7', { message: 'Invalid payment ID format' }),
+    __metadata("design:type", String)
+], DocumentPaymentIdDto.prototype, "paymentId", void 0);

package/dist/documents/index.d.ts

@@ -0,0 +1,4 @@
+export * from './dto';
+export { documentProblem } from './content';
+export { DocumentTemplatesResource, type DocumentTemplateRecord } from './document-templates';
+export { DocumentsResource, type CreateDocumentRow, type DocumentListRecord, type DocumentRecord, type DocumentSendEvent, type UpdateDocumentRow, } from './documents';

package/dist/documents/index.js

@@ -0,0 +1,24 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentsResource = exports.DocumentTemplatesResource = exports.documentProblem = void 0;
+__exportStar(require("./dto"), exports);
+var content_1 = require("./content");
+Object.defineProperty(exports, "documentProblem", { enumerable: true, get: function () { return content_1.documentProblem; } });
+var document_templates_1 = require("./document-templates");
+Object.defineProperty(exports, "DocumentTemplatesResource", { enumerable: true, get: function () { return document_templates_1.DocumentTemplatesResource; } });
+var documents_1 = require("./documents");
+Object.defineProperty(exports, "DocumentsResource", { enumerable: true, get: function () { return documents_1.DocumentsResource; } });

package/dist/documents/render/html.d.ts

@@ -0,0 +1,64 @@
+import type { DocumentBlock, DocumentVariable, DocumentVariableValues } from '@managemint-solutions/entities/documents';
+import { DocumentStatus } from '@managemint-solutions/entities/documents/enum';
+/** What is printed: a document, or a template (saved, or unsaved in the builder). */
+export type PrintableDocument = {
+    title: string;
+    number: string | null;
+    /** Null for a template. */
+    status: DocumentStatus | null;
+    /** The document's currency, or the organization's when it has none. */
+    currency: string;
+    variables: DocumentVariable[];
+    /** Every value to print, the system values included. */
+    values: DocumentVariableValues;
+    blocks: DocumentBlock[];
+};
+/**
+ * Plain text with each `{{key}}` replaced by its value as the document prints it - money in its
+ * currency, dates written out - and a key with no value left empty: a stored email's subject and
+ * message, written before the document had a number, filled when it is sent. Text, not HTML, so
+ * nothing is escaped; the email template shows it as text.
+ */
+export declare const fillText: (text: string, document: Pick<PrintableDocument, "variables" | "values" | "currency" | "status">) => string;
+/** A running header or footer: its left and right text as HTML, escaped, page counters as spans. */
+export type DocumentBand = {
+    left: string;
+    right: string;
+};
+/** A document rendered: the page body, and the bands that repeat on every page. */
+export type RenderedDocument = {
+    /** Self-contained HTML: the first page's letterhead, then the blocks. Header and footer blocks are not in it. */
+    html: string;
+    /** The header block's text, or null without one (no header at all). */
+    header: DocumentBand | null;
+    /** The footer block's text - or, with none, the organization, title and number, and "Page X of Y". */
+    footer: DocumentBand;
+};
+/**
+ * The page geometry, in inches: the side and bottom margins, and the top margin - grown to make
+ * room when the document has a header. The api's PDF and the portal's paged preview use the same.
+ */
+export declare const DOCUMENT_PAGE_MARGINS: {
+    readonly top: 0.62;
+    readonly topWithHeader: 0.95;
+    readonly bottom: 0.7;
+    readonly side: 0.7;
+};
+/**
+ * One band as a styled block: left text left, right text right, in the footer's small grey type.
+ * The styles are inline (a placeholder's included) because Chromium's header and footer templates
+ * ignore the document's CSS; the side margins mirror the page's. The api hands it to Chromium as
+ * the header or footer template; the portal's preview places it on each page.
+ */
+export declare const renderBand: (band: DocumentBand, edge: "top" | "bottom") => string;
+/**
+ * A document's blocks and values as HTML, plus its running header and footer - the only way a
+ * document or template is shown, so what is seen is what prints. Styled as the subscription
+ * invoice is: the first page's letterhead - the organization top left against the title, number,
+ * issue date and status top right - then the blocks. Header and footer blocks print nothing in the
+ * body: their text is `header` / `footer`, with `{{key}}`s printed as in the body and
+ * `{{page_number}}` / `{{page_count}}` as page-counter spans. `imageUrls` maps the image blocks'
+ * paths to URLs the caller signed; a path without one prints as `[Image]` on a draft or template
+ * and as nothing once issued.
+ */
+export declare const renderDocument: (document: PrintableDocument, imageUrls: Record<string, string>) => RenderedDocument;