@managemint-solutions/sdk 0.65.0 → 0.66.0

package/dist/documents/document-templates.js

@@ -15,6 +15,7 @@ const TEMPLATE_LIST_SELECT = `
         name,
         category,
         number_prefix,
+        due_days,
         archived,
         visibility
       `;
@@ -27,6 +28,7 @@ const TEMPLATE_DETAIL_SELECT = `
         name,
         category,
         number_prefix,
+        due_days,
         variables,
         blocks,
         blocks_version,
@@ -43,6 +45,7 @@ const templateRow = (input) => ({
     name: input.name,
     category: input.category ?? '',
     number_prefix: input.number_prefix ?? '',
+    due_days: input.due_days ?? null,
     variables: input.variables,
     blocks: input.blocks,
 });

package/dist/documents/documents.d.ts

@@ -41,6 +41,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
@@ -58,7 +61,7 @@ export type DocumentSendEvent = Pick<DocumentSend, 'recipients' | 'cc' | 'subjec
  * 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'>;
+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 +85,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

@@ -31,6 +31,8 @@ const DOCUMENT_LIST_SELECT = `
         repeat_paused,
         repeat_from,
         issue_at,
+        due_days,
+        due_at,
         visibility
       `;
 const DOCUMENT_DETAIL_SELECT = `
@@ -67,6 +69,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 +106,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 +151,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

@@ -16,6 +16,7 @@ export declare class UpdateDocumentTemplateDto implements UpdateDocumentTemplate
     readonly name: string;
     readonly category?: string;
     readonly number_prefix?: string;
+    readonly due_days?: number | null;
     readonly variables: DocumentVariable[];
     readonly blocks: DocumentBlock[];
 }
@@ -32,6 +33,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 +53,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

package/dist/documents/dto.js

@@ -79,11 +79,16 @@ __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;
     variables;
     blocks;
 }
@@ -106,6 +111,12 @@ __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, content_1.IsDocumentVariables)(),
     __metadata("design:type", Array)
@@ -138,6 +149,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 +207,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 +268,8 @@ class DocumentScheduleDto {
     repeat_paused;
     issue_at;
     email;
+    due_days;
+    due_at;
 }
 __decorate([
     (0, class_validator_1.IsOptional)(),
@@ -278,6 +306,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`.

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 { 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.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
@@ -12,6 +12,7 @@ Object.defineProperty(exports, "renderBand", { enumerable: true, get: function (
 Object.defineProperty(exports, "renderDocument", { enumerable: true, get: function () { return html_1.renderDocument; } });
 var values_1 = require("./values");
 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

@@ -75,12 +75,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;

package/dist/documents/render/values.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.systemValues = exports.johannesburgDate = exports.startingValues = exports.printsMoney = exports.documentTotals = exports.lineAmounts = exports.MONO_FONT = exports.formatDocumentDate = exports.money = exports.escapeHtml = exports.safeHref = exports.isObject = exports.SYSTEM_VARIABLES = exports.DOCUMENT_VARIABLE_PATTERN = void 0;
+exports.systemValues = exports.dueDateFrom = exports.johannesburgDate = exports.startingValues = exports.printsMoney = exports.documentTotals = exports.lineAmounts = exports.MONO_FONT = exports.formatDocumentDate = exports.money = exports.escapeHtml = exports.safeHref = exports.isObject = exports.SYSTEM_VARIABLES = exports.DOCUMENT_VARIABLE_PATTERN = void 0;
 const enum_1 = require("@managemint-solutions/entities/documents/enum");
 // The values a document prints that nobody types in: one line's amounts, the totals of every line
 // items block, the system values, and how a value is escaped and formatted. Pure functions with
@@ -33,6 +33,7 @@ exports.SYSTEM_VARIABLES = {
     [enum_1.DocumentSystemVariable.CLIENT_ADDRESS]: { label: 'Client address', type: enum_1.DocumentVariableType.TEXT },
     [enum_1.DocumentSystemVariable.CLIENT_REGISTRATION_NUMBER]: { label: 'Client registration number', type: enum_1.DocumentVariableType.TEXT },
     [enum_1.DocumentSystemVariable.CLIENT_VAT_NUMBER]: { label: 'Client VAT number', type: enum_1.DocumentVariableType.TEXT },
+    [enum_1.DocumentSystemVariable.DUE_DATE]: { label: 'Due date', type: enum_1.DocumentVariableType.DATE },
 };
 const isObject = (value) => typeof value === 'object' && value !== null && !Array.isArray(value);
 exports.isObject = isObject;
@@ -108,14 +109,20 @@ exports.startingValues = startingValues;
 /** The calendar date (`YYYY-MM-DD`) `now` falls on in Africa/Johannesburg - a draft's issue date. */
 const johannesburgDate = (now) => new Intl.DateTimeFormat('en-CA', { timeZone: 'Africa/Johannesburg' }).format(now);
 exports.johannesburgDate = johannesburgDate;
+/** `issueDate` plus `days`, as a calendar date: the due date of a document issued that day. */
+const dueDateFrom = (issueDate, days) => {
+    const [year, month, day] = issueDate.split('-').map(Number);
+    return new Date(Date.UTC(year, month - 1, day + days)).toISOString().slice(0, 10);
+};
+exports.dueDateFrom = dueDateFrom;
 /**
  * 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.
  */
-const systemValues = ({ organization, client, number, issueDate }) => {
+const systemValues = ({ organization, client, number, issueDate, dueDate }) => {
     const text = (value) => (typeof value === 'string' ? value.trim() : '');
     const address = (parts) => (parts ?? []).map(text).filter(Boolean).join(', ');
     const [year, month] = issueDate.split('-');
@@ -136,6 +143,7 @@ const systemValues = ({ organization, client, number, issueDate }) => {
         [enum_1.DocumentSystemVariable.ISSUE_DATE]: issueDate,
         [enum_1.DocumentSystemVariable.MONTH]: new Intl.DateTimeFormat('en-ZA', { month: 'long', timeZone: 'UTC' }).format(new Date(Date.UTC(Number(year), Number(month) - 1, 1))),
         [enum_1.DocumentSystemVariable.YEAR]: year,
+        [enum_1.DocumentSystemVariable.DUE_DATE]: dueDate ?? '',
     };
     return Object.fromEntries(Object.entries(values).filter(([, value]) => value !== ''));
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@managemint-solutions/sdk",
-  "version": "0.65.0",
+  "version": "0.66.0",
   "description": "Typed Supabase data-access SDK for ManageMint Solutions",
   "license": "UNLICENSED",
   "author": "Scott Bebington <scottbebington@gmail.com>",
@@ -55,7 +55,7 @@
     "testEnvironment": "node"
   },
   "dependencies": {
-    "@managemint-solutions/entities": "^1.47.0"
+    "@managemint-solutions/entities": "^1.48.0"
   },
   "peerDependencies": {
     "@nestjs/common": "^11.0.0",