@managemint-solutions/sdk 0.65.0 → 0.67.0

package/dist/audit/index.d.ts

@@ -95,7 +95,7 @@ export declare const diffChanges: (before: AuditRow, after: AuditRow, whole?: re
  */
 export declare const snapshotChanges: (row: AuditRow, side: "new" | "old") => AuditChanges;
 /** The tables a history's foreign-key values can be named from. */
-export type AuditNameTable = 'users' | 'statuses' | 'clients' | 'projects' | 'tasks' | 'leave_types';
+export type AuditNameTable = 'users' | 'statuses' | 'clients' | 'projects' | 'tasks' | 'leave_types' | 'inventory_items' | 'inventory_locations';
 /**
  * Runs `work` as one event: every audit entry recorded inside it - by any client or service
  * scope - is held, then written once it settles (or throws, since its writes still happened)

package/dist/audit/index.js

@@ -160,6 +160,20 @@ const NAME_SOURCES = {
         name: (row) => `TASK-${row.task_id} ${row.name}`,
     },
     leave_types: { from: 'leave_types', select: 'mms_id, name', search: ['name'], scoped: true, name: (row) => String(row.name) },
+    inventory_items: {
+        from: 'inventory_items',
+        select: 'mms_id, name, sku',
+        search: ['name', 'sku'],
+        scoped: true,
+        name: (row) => String(row.name),
+    },
+    inventory_locations: {
+        from: 'inventory_locations',
+        select: 'mms_id, name',
+        search: ['name'],
+        scoped: true,
+        name: (row) => String(row.name),
+    },
 };
 // How many matching names per table a history search widens itself by.
 const SEARCH_NAME_LIMIT = 20;

package/dist/client.d.ts

@@ -9,6 +9,7 @@ import { NotesResource } from './notes';
 import { NotificationsResource } from './notifications';
 import { BillingReadsResource } from './billing';
 import { InvoicesReadsResource } from './billing/invoices';
+import { InventoryItemsResource, InventoryLevelsResource, InventoryLocationsResource, InventoryMovementsResource, InventoryStocktakesResource, InventoryTransfersResource } from './inventory';
 import { LabelsResource } from './labels';
 import { LeadsResource } from './leads';
 import { LeaveAdjustmentsResource, LeaveEntitlementsResource, LeaveRequestsResource, LeaveTypesResource } from './leave';
@@ -76,6 +77,12 @@ export declare class SupabaseClient {
     readonly leaveRequests: LeaveRequestsResource;
     readonly timesheets: TimesheetsResource;
     readonly timesheetEntries: TimesheetEntriesResource;
+    readonly inventoryLocations: InventoryLocationsResource;
+    readonly inventoryItems: InventoryItemsResource;
+    readonly inventoryLevels: InventoryLevelsResource;
+    readonly inventoryMovements: InventoryMovementsResource;
+    readonly inventoryTransfers: InventoryTransfersResource;
+    readonly inventoryStocktakes: InventoryStocktakesResource;
     constructor(config: SupabaseClientConfig);
 }
 export declare const createSupabaseClient: (config: SupabaseClientConfig) => SupabaseClient;

package/dist/client.js

@@ -11,6 +11,7 @@ const notes_1 = require("./notes");
 const notifications_1 = require("./notifications");
 const billing_1 = require("./billing");
 const invoices_1 = require("./billing/invoices");
+const inventory_1 = require("./inventory");
 const labels_1 = require("./labels");
 const leads_1 = require("./leads");
 const leave_1 = require("./leave");
@@ -61,6 +62,13 @@ class SupabaseClient {
     leaveRequests;
     timesheets;
     timesheetEntries;
+    // The inventory module: items, where they are kept, how many are there, the ledger, transfers, stocktakes.
+    inventoryLocations;
+    inventoryItems;
+    inventoryLevels;
+    inventoryMovements;
+    inventoryTransfers;
+    inventoryStocktakes;
     constructor(config) {
         this.auth = config.auth;
         this.supabase =
@@ -95,6 +103,12 @@ class SupabaseClient {
         this.leaveRequests = new leave_1.LeaveRequestsResource(this.supabase, this.auth, this.audit);
         this.timesheets = new timesheets_1.TimesheetsResource(this.supabase, this.auth, this.audit);
         this.timesheetEntries = new timesheets_1.TimesheetEntriesResource(this.supabase, this.auth, this.audit);
+        this.inventoryLocations = new inventory_1.InventoryLocationsResource(this.supabase, this.auth, this.audit);
+        this.inventoryItems = new inventory_1.InventoryItemsResource(this.supabase, this.auth, this.audit);
+        this.inventoryLevels = new inventory_1.InventoryLevelsResource(this.supabase, this.auth, this.audit);
+        this.inventoryMovements = new inventory_1.InventoryMovementsResource(this.supabase, this.auth, this.audit);
+        this.inventoryTransfers = new inventory_1.InventoryTransfersResource(this.supabase, this.auth, this.audit);
+        this.inventoryStocktakes = new inventory_1.InventoryStocktakesResource(this.supabase, this.auth, this.audit);
     }
 }
 exports.SupabaseClient = SupabaseClient;

package/dist/documents/content.js

@@ -158,6 +158,11 @@ const entryProblem = (entry, properties, ...checks) => {
     }
     return null;
 };
+/** A line's stock item or location: left out, null, or a UUID. */
+const idProblem = (value, what) => value === undefined || value === null || (typeof value === 'string' && UUID_PATTERN.test(value))
+    ? null
+    : `${what} must be an id`;
+const UUID_PATTERN = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;
 const percentProblem = (value, what) => typeof value === 'number' && value >= 0 && value <= 100 ? null : `${what} must be a percentage from 0 to 100`;
 /**
  * A line's quantity or unit price: a number written in, or `{ variable }` naming a declared
@@ -334,7 +339,7 @@ const blocksProblem = (blocks, variables) => {
                 problem = listProblem(block.fields, 'fields', 'Field', MAX_FIELDS, (field) => entryProblem(field, ['label', 'value'], () => textProblem(field.label, 'Label', MAX_LABEL_LENGTH, known), () => textProblem(field.value, 'Value', MAX_TEXT_LENGTH, known)));
                 break;
             case enum_1.DocumentBlockType.LINE_ITEMS:
-                problem = listProblem(block.items, 'lines', 'Line', MAX_LINES, (line) => entryProblem(line, ['description', 'quantity', 'unit_price_minor', 'discount_percent', 'tax_rate'], () => textProblem(line.description, 'Description', MAX_TEXT_LENGTH, known), () => amountProblem(line.quantity, 'Quantity', enum_1.DocumentVariableType.NUMBER, declared, {
+                problem = listProblem(block.items, 'lines', 'Line', MAX_LINES, (line) => entryProblem(line, ['description', 'quantity', 'unit_price_minor', 'discount_percent', 'tax_rate', 'item_id', 'location_id'], () => textProblem(line.description, 'Description', MAX_TEXT_LENGTH, known), () => idProblem(line.item_id, 'Item'), () => idProblem(line.location_id, 'Location'), () => amountProblem(line.quantity, 'Quantity', enum_1.DocumentVariableType.NUMBER, declared, {
                     holds: (amount) => Number.isFinite(amount) && amount > 0,
                     message: 'must be greater than 0',
                 }), () => amountProblem(line.unit_price_minor, 'Unit price', enum_1.DocumentVariableType.MONEY, declared, {

package/dist/documents/document-templates.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DocumentTemplatesResource = void 0;
-const enum_1 = require("@managemint-solutions/entities/audit-trail/enum");
+const enum_1 = require("@managemint-solutions/entities/documents/enum");
+const enum_2 = require("@managemint-solutions/entities/audit-trail/enum");
 const audit_1 = require("../audit");
 const errors_1 = require("../errors");
 const tenancy_1 = require("../tenancy");
@@ -15,6 +16,9 @@ const TEMPLATE_LIST_SELECT = `
         name,
         category,
         number_prefix,
+        due_days,
+        stock_effect,
+        payable,
         archived,
         visibility
       `;
@@ -27,6 +31,9 @@ const TEMPLATE_DETAIL_SELECT = `
         name,
         category,
         number_prefix,
+        due_days,
+        stock_effect,
+        payable,
         variables,
         blocks,
         blocks_version,
@@ -43,6 +50,9 @@ const templateRow = (input) => ({
     name: input.name,
     category: input.category ?? '',
     number_prefix: input.number_prefix ?? '',
+    due_days: input.due_days ?? null,
+    stock_effect: input.stock_effect ?? enum_1.DocumentStockEffect.NONE,
+    payable: input.payable ?? true,
     variables: input.variables,
     blocks: input.blocks,
 });
@@ -62,10 +72,10 @@ class DocumentTemplatesResource {
         this.auth = auth;
         this.table = (0, audit_1.auditedTable)(supabase, auth, audit, {
             table: 'document_templates',
-            entityType: enum_1.AuditTrailEntityType.DOCUMENT_TEMPLATES,
+            entityType: enum_2.AuditTrailEntityType.DOCUMENT_TEMPLATES,
             documentContent: true,
         });
-        this.audit = new audit_1.EntityAuditTrail(supabase, auth, enum_1.AuditTrailEntityType.DOCUMENT_TEMPLATES);
+        this.audit = new audit_1.EntityAuditTrail(supabase, auth, enum_2.AuditTrailEntityType.DOCUMENT_TEMPLATES);
     }
     /** Newest first; `search` matches the name and the category. */
     async list(query) {
@@ -123,12 +133,12 @@ class DocumentTemplatesResource {
         return this.getById(templateId);
     }
     async archive(templateId) {
-        await this.table.transition(templateId, enum_1.AuditTrailAction.ARCHIVE, (0, transforms_1.archivedPatch)(this.auth.mms_id));
+        await this.table.transition(templateId, enum_2.AuditTrailAction.ARCHIVE, (0, transforms_1.archivedPatch)(this.auth.mms_id));
         return this.getById(templateId);
     }
     /** The table keeps no unarchive stamps, so the archive ones are cleared; the history keeps both. */
     async unarchive(templateId) {
-        await this.table.transition(templateId, enum_1.AuditTrailAction.UNARCHIVE, {
+        await this.table.transition(templateId, enum_2.AuditTrailAction.UNARCHIVE, {
             archived: false,
             archived_at: null,
             archived_by: null,

package/dist/documents/documents.d.ts

@@ -1,6 +1,6 @@
 import type { MmsList } from '@managemint-solutions/entities/common';
 import type { DocumentBlock, DocumentEmail, DocumentEntity, DocumentImageUploadTarget, DocumentSend, DocumentSummary, DocumentVariable, DocumentVariableValues } from '@managemint-solutions/entities/documents';
-import { DocumentStatus, type DocumentRepeat, type DocumentVisibility } from '@managemint-solutions/entities/documents/enum';
+import { DocumentStatus, DocumentStockEffect, type DocumentRepeat, type DocumentVisibility } from '@managemint-solutions/entities/documents/enum';
 import { EntityAuditTrail, type AuditResource, type ResourceActor } from '../audit';
 import type { TypedSupabaseClient } from '../client';
 import type { GetDocumentsDto } from './dto';
@@ -32,6 +32,11 @@ type DocumentRow = {
     voided_at: string | null;
     voided_by: string | null;
     void_reason: string | null;
+    /** Copied from the template at create; the stamp is written when the stock moves. */
+    stock_effect: DocumentStockEffect;
+    stock_moved_at: string | null;
+    /** Copied from the template at create: a client pays this. */
+    payable: boolean;
     /** A recurring parent's schedule (dates YYYY-MM-DD), a scheduled draft's issue date and email. */
     repeat: DocumentRepeat | null;
     repeat_next_at: string | null;
@@ -41,6 +46,9 @@ type DocumentRow = {
     repeat_from: string | null;
     issue_at: string | null;
     email: DocumentEmail | null;
+    /** When it falls due: days after issue on a draft, the date itself (YYYY-MM-DD) once picked or issued. */
+    due_days: number | null;
+    due_at: string | null;
 };
 /**
  * A document as the sdk reads it. `my_role` (what the caller may do with it), `payments` (read
@@ -57,8 +65,8 @@ export type DocumentSendEvent = Pick<DocumentSend, 'recipients' | 'cc' | 'subjec
  * draft has none of. The schedule columns are optional (a plain draft has none); `repeat_from` is
  * the cron's, for the drafts it makes.
  */
-export type CreateDocumentRow = Omit<DocumentRow, 'status' | 'number_sequence' | 'number' | 'issued_at' | 'issued_by' | 'voided_at' | 'voided_by' | 'void_reason' | keyof DocumentScheduleRow> & Partial<DocumentScheduleRow>;
-type DocumentScheduleRow = Pick<DocumentRow, 'repeat' | 'repeat_next_at' | 'repeat_until' | 'repeat_paused' | 'repeat_from' | 'issue_at' | 'email'>;
+export type CreateDocumentRow = Omit<DocumentRow, 'status' | 'number_sequence' | 'number' | 'issued_at' | 'issued_by' | 'voided_at' | 'voided_by' | 'void_reason' | 'stock_moved_at' | keyof DocumentScheduleRow> & Partial<DocumentScheduleRow>;
+type DocumentScheduleRow = Pick<DocumentRow, 'repeat' | 'repeat_next_at' | 'repeat_until' | 'repeat_paused' | 'repeat_from' | 'issue_at' | 'email' | 'due_days' | 'due_at'>;
 /**
  * A draft save, an issue or a void: whichever columns it changes - never the visibility, which
  * members hold no grant on after create (the visibility route changes it on the service role).
@@ -82,8 +90,9 @@ export declare class DocumentsResource {
      * Newest first; `search` matches the title and the number. Recurring parents are a list of
      * their own: `recurring` lists them alone, and every other list leaves them out. `ids` keeps
      * the list to (`in`) or away from (`not_in`) the documents named - the api's payment filter
-     * passes the paid ones - and `payable` to issued documents with a total above zero. The
-     * DTO's `payment` itself is the api's to turn into those two; the list ignores it.
+     * passes the paid ones - and `payable` to issued documents with a total above zero;
+     * `due_before` to documents due on or before that date. The DTO's `payment` and `overdue`
+     * are the api's to turn into those; the list ignores them.
      */
     list(query: GetDocumentsDto & {
         organization_id?: string | null;

package/dist/documents/documents.js

@@ -24,6 +24,7 @@ const DOCUMENT_LIST_SELECT = `
         client:clients!documents_client_fkey ( mms_id, name ),
         currency,
         total_minor,
+        payable,
         issued_at,
         repeat,
         repeat_next_at,
@@ -31,6 +32,8 @@ const DOCUMENT_LIST_SELECT = `
         repeat_paused,
         repeat_from,
         issue_at,
+        due_days,
+        due_at,
         visibility
       `;
 const DOCUMENT_DETAIL_SELECT = `
@@ -60,6 +63,9 @@ const DOCUMENT_DETAIL_SELECT = `
         voided_at,
         voided_by:user_profiles!voided_by ${transforms_1.USER_PROFILE_EMBED},
         void_reason,
+        stock_effect,
+        stock_moved_at,
+        payable,
         repeat,
         repeat_next_at,
         repeat_until,
@@ -67,6 +73,8 @@ const DOCUMENT_DETAIL_SELECT = `
         repeat_from,
         issue_at,
         email,
+        due_days,
+        due_at,
         visibility
       `;
 /** How long a signed image URL in rendered HTML stays valid - long enough to keep a preview open. */
@@ -102,8 +110,9 @@ class DocumentsResource {
      * Newest first; `search` matches the title and the number. Recurring parents are a list of
      * their own: `recurring` lists them alone, and every other list leaves them out. `ids` keeps
      * the list to (`in`) or away from (`not_in`) the documents named - the api's payment filter
-     * passes the paid ones - and `payable` to issued documents with a total above zero. The
-     * DTO's `payment` itself is the api's to turn into those two; the list ignores it.
+     * passes the paid ones - and `payable` to issued documents with a total above zero;
+     * `due_before` to documents due on or before that date. The DTO's `payment` and `overdue`
+     * are the api's to turn into those; the list ignores them.
      */
     async list(query) {
         const page = query.page;
@@ -146,6 +155,9 @@ class DocumentsResource {
         if (query.payable) {
             documentsQuery = documentsQuery.eq('status', enum_1.DocumentStatus.ISSUED).gt('total_minor', 0);
         }
+        if (query.due_before) {
+            documentsQuery = documentsQuery.lte('due_at', query.due_before);
+        }
         if (trimmedSearch) {
             documentsQuery = documentsQuery.or((0, transforms_1.orIlike)(['title', 'number'], trimmedSearch));
         }

package/dist/documents/dto.d.ts

@@ -1,6 +1,6 @@
 import type { DocumentBlock, DocumentEmail, DocumentVariable, DocumentVariableValues } from '@managemint-solutions/entities/documents';
-import type { CatalogueTemplateSlugDto as CatalogueTemplateSlugDtoType, CopyCatalogueTemplateDto as CopyCatalogueTemplateDtoType, CreateDocumentDto as CreateDocumentDtoType, CreateDocumentTemplateDto as CreateDocumentTemplateDtoType, DocumentIdDto as DocumentIdDtoType, DocumentImageNameDto as DocumentImageNameDtoType, DocumentImageUrlsDto as DocumentImageUrlsDtoType, DocumentPayQueryDto as DocumentPayQueryDtoType, DocumentPayTokenDto as DocumentPayTokenDtoType, DocumentPaymentIdDto as DocumentPaymentIdDtoType, DocumentTemplateIdDto as DocumentTemplateIdDtoType, GetCatalogueTemplatesDto as GetCatalogueTemplatesDtoType, GetDocumentsDto as GetDocumentsDtoType, GetDocumentTemplatesDto as GetDocumentTemplatesDtoType, PayDocumentDto as PayDocumentDtoType, RecordDocumentPaymentDto as RecordDocumentPaymentDtoType, ReassignPrivateDocumentsDto as ReassignPrivateDocumentsDtoType, SendDocumentDto as SendDocumentDtoType, UpdateDocumentDto as UpdateDocumentDtoType, UpdateDocumentTemplateDto as UpdateDocumentTemplateDtoType, VoidDocumentDto as VoidDocumentDtoType } from '@managemint-solutions/entities/documents/dto';
-import { DocumentPaymentFilter, DocumentRepeat, DocumentStatus, DocumentVisibility } from '@managemint-solutions/entities/documents/enum';
+import type { CatalogueTemplateSlugDto as CatalogueTemplateSlugDtoType, CopyCatalogueTemplateDto as CopyCatalogueTemplateDtoType, CreateDocumentDto as CreateDocumentDtoType, CreateDocumentTemplateDto as CreateDocumentTemplateDtoType, DocumentIdDto as DocumentIdDtoType, DocumentImageNameDto as DocumentImageNameDtoType, DocumentImageUrlsDto as DocumentImageUrlsDtoType, DocumentPayQueryDto as DocumentPayQueryDtoType, DocumentPayTokenDto as DocumentPayTokenDtoType, DocumentPaymentIdDto as DocumentPaymentIdDtoType, DocumentTemplateIdDto as DocumentTemplateIdDtoType, GetCatalogueTemplatesDto as GetCatalogueTemplatesDtoType, GetDocumentsDto as GetDocumentsDtoType, GetDocumentTemplatesDto as GetDocumentTemplatesDtoType, PayDocumentDto as PayDocumentDtoType, RecordDocumentPaymentDto as RecordDocumentPaymentDtoType, ReassignPrivateDocumentsDto as ReassignPrivateDocumentsDtoType, SendDocumentDto as SendDocumentDtoType, UpdateDocumentDto as UpdateDocumentDtoType, UpdateDocumentTemplateDto as UpdateDocumentTemplateDtoType, ConvertDocumentDto as ConvertDocumentDtoType, VoidDocumentDto as VoidDocumentDtoType } from '@managemint-solutions/entities/documents/dto';
+import { DocumentPaymentFilter, DocumentRepeat, DocumentStatus, DocumentStockEffect, DocumentVisibility } from '@managemint-solutions/entities/documents/enum';
 export declare class GetDocumentTemplatesDto implements GetDocumentTemplatesDtoType {
     readonly search?: string | null;
     readonly category?: string | null;
@@ -16,6 +16,9 @@ export declare class UpdateDocumentTemplateDto implements UpdateDocumentTemplate
     readonly name: string;
     readonly category?: string;
     readonly number_prefix?: string;
+    readonly due_days?: number | null;
+    readonly stock_effect?: DocumentStockEffect;
+    readonly payable?: boolean;
     readonly variables: DocumentVariable[];
     readonly blocks: DocumentBlock[];
 }
@@ -32,6 +35,8 @@ export declare class GetDocumentsDto implements GetDocumentsDtoType {
     readonly recurring?: boolean;
     readonly repeat_from?: string | null;
     readonly payment?: DocumentPaymentFilter | null;
+    readonly due_before?: string | null;
+    readonly overdue?: boolean;
     readonly page: number;
     readonly page_size: number;
 }
@@ -50,6 +55,8 @@ declare class DocumentScheduleDto {
     readonly repeat_paused?: boolean;
     readonly issue_at?: string | null;
     readonly email?: DocumentEmail | null;
+    readonly due_days?: number | null;
+    readonly due_at?: string | null;
 }
 /**
  * A new draft. Its values cannot be checked here - with a template, the variables they fill are
@@ -74,6 +81,9 @@ export declare class UpdateDocumentDto extends DocumentScheduleDto implements Up
     readonly variable_values: DocumentVariableValues;
     readonly blocks: DocumentBlock[];
 }
+export declare class ConvertDocumentDto implements ConvertDocumentDtoType {
+    readonly template_id: string;
+}
 export declare class VoidDocumentDto implements VoidDocumentDtoType {
     readonly reason: string;
 }

package/dist/documents/dto.js

@@ -9,7 +9,7 @@ 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.CopyCatalogueTemplateDto = exports.CatalogueTemplateSlugDto = exports.GetCatalogueTemplatesDto = 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;
+exports.CopyCatalogueTemplateDto = exports.CatalogueTemplateSlugDto = exports.GetCatalogueTemplatesDto = exports.DocumentPaymentIdDto = exports.RecordDocumentPaymentDto = exports.PayDocumentDto = exports.DocumentPayQueryDto = exports.DocumentPayTokenDto = exports.SendDocumentDto = exports.ReassignPrivateDocumentsDto = exports.DocumentImageUrlsDto = exports.DocumentImageNameDto = exports.VoidDocumentDto = exports.ConvertDocumentDto = 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");
@@ -79,11 +79,18 @@ __decorate([
     (0, class_validator_1.IsUUID)('7', { message: 'Invalid template ID format' }),
     __metadata("design:type", String)
 ], DocumentTemplateIdDto.prototype, "templateId", void 0);
+/** Days after issue a document falls due: a whole number from 0 to 365. */
+const IsDueDays = (0, validators_1.fromProblem)('isDueDays', (value) => Number.isInteger(value) && value >= 0 && value <= 365
+    ? null
+    : 'Due days must be a whole number from 0 to 365');
 /** Saving replaces the whole template. Its visibility changes only through the visibility route. */
 class UpdateDocumentTemplateDto {
     name;
     category;
     number_prefix;
+    due_days;
+    stock_effect;
+    payable;
     variables;
     blocks;
 }
@@ -106,6 +113,22 @@ __decorate([
     (0, content_1.IsDocumentNumberPrefix)(),
     __metadata("design:type", String)
 ], UpdateDocumentTemplateDto.prototype, "number_prefix", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, validators_1.IsNullable)(),
+    IsDueDays(),
+    __metadata("design:type", Object)
+], UpdateDocumentTemplateDto.prototype, "due_days", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsEnum)(enum_1.DocumentStockEffect, { message: 'Stock effect must be none, issue or receive' }),
+    __metadata("design:type", String)
+], UpdateDocumentTemplateDto.prototype, "stock_effect", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsBoolean)({ message: 'Payable must be true or false' }),
+    __metadata("design:type", Boolean)
+], UpdateDocumentTemplateDto.prototype, "payable", void 0);
 __decorate([
     (0, content_1.IsDocumentVariables)(),
     __metadata("design:type", Array)
@@ -138,6 +161,9 @@ class GetDocumentsDto {
     recurring;
     repeat_from;
     payment;
+    due_before;
+    // Issued, due before today, nothing settled - resolved by the api; the sdk list ignores it.
+    overdue;
     page = 1;
     page_size = 10;
 }
@@ -193,6 +219,18 @@ __decorate([
     (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, validators_1.IsNullable)(),
+    (0, validators_1.IsCalendarDate)({ message: 'Due before must be a calendar date (YYYY-MM-DD)' }),
+    __metadata("design:type", Object)
+], GetDocumentsDto.prototype, "due_before", 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: 'Overdue must be a boolean' }),
+    __metadata("design:type", Boolean)
+], GetDocumentsDto.prototype, "overdue", void 0);
 __decorate([
     (0, class_validator_1.IsOptional)(),
     (0, class_transformer_1.Transform)(({ value }) => value ? Number(value) : 1, { toClassOnly: true }),
@@ -242,6 +280,8 @@ class DocumentScheduleDto {
     repeat_paused;
     issue_at;
     email;
+    due_days;
+    due_at;
 }
 __decorate([
     (0, class_validator_1.IsOptional)(),
@@ -278,6 +318,18 @@ __decorate([
     IsDocumentEmail(),
     __metadata("design:type", Object)
 ], DocumentScheduleDto.prototype, "email", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, validators_1.IsNullable)(),
+    IsDueDays(),
+    __metadata("design:type", Object)
+], DocumentScheduleDto.prototype, "due_days", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, validators_1.IsNullable)(),
+    (0, validators_1.IsCalendarDate)({ message: 'Due date must be a calendar date (YYYY-MM-DD)' }),
+    __metadata("design:type", Object)
+], DocumentScheduleDto.prototype, "due_at", 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`.
@@ -372,6 +424,14 @@ __decorate([
     (0, content_1.IsDocumentBlocks)(),
     __metadata("design:type", Array)
 ], UpdateDocumentDto.prototype, "blocks", void 0);
+class ConvertDocumentDto {
+    template_id;
+}
+exports.ConvertDocumentDto = ConvertDocumentDto;
+__decorate([
+    (0, class_validator_1.IsUUID)('7', { message: 'Pick the invoice template to make it from' }),
+    __metadata("design:type", String)
+], ConvertDocumentDto.prototype, "template_id", void 0);
 class VoidDocumentDto {
     reason;
 }

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

@@ -3,6 +3,11 @@ 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;
+    /**
+     * The template's word for what this is ("Invoice", "Quote"): the printed heading when given,
+     * with the title under it. Null or '' prints the title as the heading (a blank document).
+     */
+    category?: string | null;
     number: string | null;
     /** Null for a template. */
     status: DocumentStatus | null;

package/dist/documents/render/html.js

@@ -286,8 +286,13 @@ exports.renderBand = renderBand;
  */
 const renderDocument = (document, imageUrls) => {
     const ctx = contextOf(document);
-    const title = (0, values_1.escapeHtml)(document.title || 'Document');
-    const status = document.status ? STATUS_LABELS[document.status] : 'Template';
+    // The heading is what the document is (30 Oct 2026: a client read "Block A board 1 - materials"
+    // where "Invoice" belonged); the title, when it adds something, sits under it. Issued prints no
+    // stamp: a draft or a void says so, an issued document is simply the document.
+    const category = (document.category ?? '').trim();
+    const title = (0, values_1.escapeHtml)(category || document.title || 'Document');
+    const subtitle = category && document.title && document.title.trim() !== category ? (0, values_1.escapeHtml)(document.title) : '';
+    const status = document.status === enum_1.DocumentStatus.ISSUED ? '' : document.status ? STATUS_LABELS[document.status] : 'Template';
     const statusColour = document.status === enum_1.DocumentStatus.ISSUED ? '#1d6b4a'
         : document.status === enum_1.DocumentStatus.VOID ? '#b3261e'
             : '#6b6960';
@@ -321,6 +326,7 @@ const renderDocument = (document, imageUrls) => {
   .doc-number { font-family: ${values_1.MONO_FONT}; font-size: 10.5pt; color: #5f5d56; margin-top: 8px; }
   .doc-date { font-size: 10pt; color: #5f5d56; margin-top: 4px; }
   .doc-status { font-size: 11pt; font-weight: 700; letter-spacing: 0.3px; color: ${statusColour}; margin-top: 10px; }
+  .doc-subtitle { font-size: 11pt; color: #6b6960; margin-top: 4px; }
 
   .block { margin-top: 18px; }
   .text p { margin: 0 0 8px; }
@@ -390,10 +396,11 @@ const renderDocument = (document, imageUrls) => {
     </div>
     <div class="doc">
       <div class="doc-title">${title}</div>
+      ${subtitle ? `<div class="doc-subtitle">${subtitle}</div>` : ''}
       <!-- The number line is kept on drafts too, so issuing never reflows the pages. -->
       <div class="doc-number">${document.number ? (0, values_1.escapeHtml)(document.number) : '&nbsp;'}</div>
       <div class="doc-date">${valueHtml(enum_1.DocumentSystemVariable.ISSUE_DATE, ctx)}</div>
-      <div class="doc-status">${status}</div>
+      <div class="doc-status">${status || '&nbsp;'}</div>
     </div>
   </div>
   ${document.blocks.map((block) => blockHtml(block, ctx, imageUrls)).join('')}

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

@@ -1,2 +1,2 @@
 export { DOCUMENT_PAGE_MARGINS, fillText, renderBand, renderDocument, type DocumentBand, type PrintableDocument, type RenderedDocument, } from './html';
-export { documentTotals, escapeHtml, formatDocumentDate, johannesburgDate, money, MONO_FONT, printsMoney, startingValues, SYSTEM_VARIABLES, systemValues, type DocumentTotals, type SystemValueInputs, } from './values';
+export { amountOf, documentTotals, dueDateFrom, escapeHtml, formatDocumentDate, johannesburgDate, money, MONO_FONT, printsMoney, startingValues, SYSTEM_VARIABLES, systemValues, type DocumentTotals, type SystemValueInputs, } from './values';

package/dist/documents/render/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.systemValues = exports.SYSTEM_VARIABLES = exports.startingValues = exports.printsMoney = exports.MONO_FONT = exports.money = exports.johannesburgDate = exports.formatDocumentDate = exports.escapeHtml = exports.documentTotals = exports.renderDocument = exports.renderBand = exports.fillText = exports.DOCUMENT_PAGE_MARGINS = void 0;
+exports.systemValues = exports.SYSTEM_VARIABLES = exports.startingValues = exports.printsMoney = exports.MONO_FONT = exports.money = exports.johannesburgDate = exports.formatDocumentDate = exports.escapeHtml = exports.dueDateFrom = exports.documentTotals = exports.amountOf = exports.renderDocument = exports.renderBand = exports.fillText = exports.DOCUMENT_PAGE_MARGINS = void 0;
 // `@managemint-solutions/sdk/documents`: the document renderer and the values it prints, as pure
 // functions with no dependency beyond the shared entities - no Node, no Nest, no supabase-js, no
 // DOM - so the api's PDF and the portal's in-browser preview are one renderer. The caller loads
@@ -11,7 +11,9 @@ Object.defineProperty(exports, "fillText", { enumerable: true, get: function ()
 Object.defineProperty(exports, "renderBand", { enumerable: true, get: function () { return html_1.renderBand; } });
 Object.defineProperty(exports, "renderDocument", { enumerable: true, get: function () { return html_1.renderDocument; } });
 var values_1 = require("./values");
+Object.defineProperty(exports, "amountOf", { enumerable: true, get: function () { return values_1.amountOf; } });
 Object.defineProperty(exports, "documentTotals", { enumerable: true, get: function () { return values_1.documentTotals; } });
+Object.defineProperty(exports, "dueDateFrom", { enumerable: true, get: function () { return values_1.dueDateFrom; } });
 Object.defineProperty(exports, "escapeHtml", { enumerable: true, get: function () { return values_1.escapeHtml; } });
 Object.defineProperty(exports, "formatDocumentDate", { enumerable: true, get: function () { return values_1.formatDocumentDate; } });
 Object.defineProperty(exports, "johannesburgDate", { enumerable: true, get: function () { return values_1.johannesburgDate; } });

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

@@ -1,4 +1,4 @@
-import type { DocumentBlock, DocumentLineItem, DocumentVariable, DocumentVariableValues } from '@managemint-solutions/entities/documents';
+import type { DocumentBlock, DocumentLineAmount, DocumentLineItem, DocumentVariable, DocumentVariableValues } from '@managemint-solutions/entities/documents';
 import { DocumentSystemVariable } from '@managemint-solutions/entities/documents/enum';
 /**
  * A variable in plain text (field values, table cells, line descriptions, signer labels, header
@@ -32,6 +32,9 @@ export type DocumentTotals = {
     tax_minor: number;
     total_minor: number;
 };
+/** A line's quantity or unit price: the number written in, or its variable's value (0 while it has none). */
+/** A line's quantity or price as a figure: written in, or read from its variable (0 when unset). */
+export declare const amountOf: (amount: DocumentLineAmount, values: DocumentVariableValues) => number;
 /**
  * One line's amounts in cents: gross = quantity x unit price, the discount a percentage of the
  * gross, net = gross - discount, the tax a percentage of the net - each rounded to the cent.
@@ -75,12 +78,16 @@ export type SystemValueInputs = {
     number: string | null;
     /** `YYYY-MM-DD`: today on a draft (`johannesburgDate(new Date())`), the issue date once issued. */
     issueDate: string;
+    /** `YYYY-MM-DD`: when the document falls due; left out (prints as missing) without one. */
+    dueDate?: string | null;
 };
+/** `issueDate` plus `days`, as a calendar date: the due date of a document issued that day. */
+export declare const dueDateFrom: (issueDate: string, days: number) => string;
 /**
  * The values filled in for the system variables: the organization's name (its trading name
  * first), address, registration and VAT numbers, email and phone; the client's name, email, phone,
- * address, registration and VAT numbers; the document number; and the issue date with its month
- * name and year. A value that is empty is left out, so it prints as missing. The
- * page number and count are not values: they are counted page by page as the PDF prints.
+ * address, registration and VAT numbers; the document number; the issue date with its month
+ * name and year; and the due date. A value that is empty is left out, so it prints as missing.
+ * The page number and count are not values: they are counted page by page as the PDF prints.
  */
-export declare const systemValues: ({ organization, client, number, issueDate }: SystemValueInputs) => DocumentVariableValues;
+export declare const systemValues: ({ organization, client, number, issueDate, dueDate }: SystemValueInputs) => DocumentVariableValues;