@managemint-solutions/sdk 0.56.0 → 0.64.0

package/dist/documents/render/values.js

@@ -0,0 +1,142 @@
+"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;
+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
+// no I/O, so the api (printing the PDF) and the portal (previewing it) work them out the same way.
+/**
+ * A variable in plain text (field values, table cells, line descriptions, signer labels, header
+ * and footer text): `{{key}}`, spaces inside the braces allowed. The content rules check with it
+ * and the renderer replaces with it, so what is checked is exactly what prints. Global: use it
+ * with `matchAll` or `replace`, never `test`.
+ */
+exports.DOCUMENT_VARIABLE_PATTERN = /\{\{\s*([^{}]*?)\s*\}\}/g;
+/** How each system variable is labelled where it is missing, and the type it prints as. */
+exports.SYSTEM_VARIABLES = {
+    [enum_1.DocumentSystemVariable.ORGANIZATION_NAME]: { label: 'Organization name', type: enum_1.DocumentVariableType.TEXT },
+    [enum_1.DocumentSystemVariable.ORGANIZATION_ADDRESS]: { label: 'Organization address', type: enum_1.DocumentVariableType.TEXT },
+    [enum_1.DocumentSystemVariable.CLIENT_NAME]: { label: 'Client name', type: enum_1.DocumentVariableType.TEXT },
+    [enum_1.DocumentSystemVariable.CLIENT_EMAIL]: { label: 'Client email', type: enum_1.DocumentVariableType.TEXT },
+    [enum_1.DocumentSystemVariable.CLIENT_PHONE]: { label: 'Client phone', type: enum_1.DocumentVariableType.TEXT },
+    [enum_1.DocumentSystemVariable.DOCUMENT_NUMBER]: { label: 'Document number', type: enum_1.DocumentVariableType.TEXT },
+    [enum_1.DocumentSystemVariable.ISSUE_DATE]: { label: 'Issue date', type: enum_1.DocumentVariableType.DATE },
+    [enum_1.DocumentSystemVariable.MONTH]: { label: 'Month', type: enum_1.DocumentVariableType.TEXT },
+    [enum_1.DocumentSystemVariable.YEAR]: { label: 'Year', type: enum_1.DocumentVariableType.TEXT },
+    // Never given a value: they print as page counters in the header and footer.
+    [enum_1.DocumentSystemVariable.PAGE_NUMBER]: { label: 'Page number', type: enum_1.DocumentVariableType.TEXT },
+    [enum_1.DocumentSystemVariable.PAGE_COUNT]: { label: 'Page count', type: enum_1.DocumentVariableType.TEXT },
+    [enum_1.DocumentSystemVariable.ORGANIZATION_REGISTRATION_NUMBER]: { label: 'Organization registration number', type: enum_1.DocumentVariableType.TEXT },
+    [enum_1.DocumentSystemVariable.ORGANIZATION_VAT_NUMBER]: { label: 'Organization VAT number', type: enum_1.DocumentVariableType.TEXT },
+    [enum_1.DocumentSystemVariable.ORGANIZATION_EMAIL]: { label: 'Organization email', type: enum_1.DocumentVariableType.TEXT },
+    [enum_1.DocumentSystemVariable.ORGANIZATION_PHONE]: { label: 'Organization phone', type: enum_1.DocumentVariableType.TEXT },
+    [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 },
+};
+const isObject = (value) => typeof value === 'object' && value !== null && !Array.isArray(value);
+exports.isObject = isObject;
+const LINK_PROTOCOLS = new Set(['http:', 'https:', 'mailto:']);
+/**
+ * A link's href, or null unless it is http, https or mailto. The protocol is read as a browser
+ * reads it: the URL parser drops the tabs and newlines a plain prefix check would let hide a
+ * javascript: link. The content rules refuse what this refuses, and the renderer prints only what
+ * it passes.
+ */
+const safeHref = (href) => typeof href === 'string' && URL.canParse(href) && LINK_PROTOCOLS.has(new URL(href).protocol) ? href : null;
+exports.safeHref = safeHref;
+const escapeHtml = (value) => value
+    .replaceAll('&', '&')
+    .replaceAll('<', '&lt;')
+    .replaceAll('>', '&gt;')
+    .replaceAll('"', '&quot;');
+exports.escapeHtml = escapeHtml;
+/** Integer cents in `currency`, the en-ZA way: `R 1 299,00`. Subscription invoices print with it too. */
+const money = (amountMinor, currency) => new Intl.NumberFormat('en-ZA', { style: 'currency', currency }).format((amountMinor ?? 0) / 100);
+exports.money = money;
+/** `2026-11-01` -> `1 November 2026`. */
+const formatDocumentDate = (date) => new Intl.DateTimeFormat('en-ZA', { day: 'numeric', month: 'long', year: 'numeric', timeZone: 'UTC' }).format(new Date(`${date}T00:00:00Z`));
+exports.formatDocumentDate = formatDocumentDate;
+/** The monospace stack for numbers - the design's JetBrains Mono, self-contained. */
+exports.MONO_FONT = 'ui-monospace, \'Cascadia Mono\', \'Segoe UI Mono\', Consolas, monospace';
+/** A line's quantity or unit price: the number written in, or its variable's value (0 while it has none). */
+const amountOf = (amount, values) => {
+    if (typeof amount === 'number')
+        return amount;
+    const value = values[amount.variable];
+    return typeof value === 'number' ? value : 0;
+};
+/**
+ * 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.
+ */
+const lineAmounts = (line, values) => {
+    const gross = Math.round(amountOf(line.quantity, values) * amountOf(line.unit_price_minor, values));
+    const discount = Math.round((gross * line.discount_percent) / 100);
+    const net = gross - discount;
+    const tax = Math.round((net * line.tax_rate) / 100);
+    return { gross, discount, net, tax };
+};
+exports.lineAmounts = lineAmounts;
+/** The sums over every line of every line items block in `blocks`; all zero without one. */
+const documentTotals = (blocks, values) => {
+    const totals = { subtotal_minor: 0, discount_minor: 0, tax_minor: 0, total_minor: 0 };
+    for (const block of blocks) {
+        if (block.type !== enum_1.DocumentBlockType.LINE_ITEMS)
+            continue;
+        for (const line of block.items) {
+            const { gross, discount, net, tax } = (0, exports.lineAmounts)(line, values);
+            totals.subtotal_minor += gross;
+            totals.discount_minor += discount;
+            totals.tax_minor += tax;
+            totals.total_minor += net + tax;
+        }
+    }
+    return totals;
+};
+exports.documentTotals = documentTotals;
+/** Whether the content prints money - a line items block or a money variable - and so needs a currency. */
+const printsMoney = (blocks, variables) => blocks.some((block) => block.type === enum_1.DocumentBlockType.LINE_ITEMS) ||
+    variables.some((variable) => variable.type === enum_1.DocumentVariableType.MONEY);
+exports.printsMoney = printsMoney;
+/** A new draft's values: each variable's default, overlaid by the values given. */
+const startingValues = (variables, given = {}) => ({
+    ...Object.fromEntries(variables.flatMap((variable) => (variable.default_value === null ? [] : [[variable.key, variable.default_value]]))),
+    ...given,
+});
+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;
+/**
+ * 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.
+ */
+const systemValues = ({ organization, client, number, issueDate }) => {
+    const text = (value) => (typeof value === 'string' ? value.trim() : '');
+    const address = (parts) => (parts ?? []).map(text).filter(Boolean).join(', ');
+    const [year, month] = issueDate.split('-');
+    const values = {
+        [enum_1.DocumentSystemVariable.ORGANIZATION_NAME]: text(organization.trading_name) || text(organization.name),
+        [enum_1.DocumentSystemVariable.ORGANIZATION_ADDRESS]: address(organization.address),
+        [enum_1.DocumentSystemVariable.ORGANIZATION_REGISTRATION_NUMBER]: text(organization.registration_number),
+        [enum_1.DocumentSystemVariable.ORGANIZATION_VAT_NUMBER]: text(organization.vat_number),
+        [enum_1.DocumentSystemVariable.ORGANIZATION_EMAIL]: text(organization.email),
+        [enum_1.DocumentSystemVariable.ORGANIZATION_PHONE]: text(organization.phone),
+        [enum_1.DocumentSystemVariable.CLIENT_NAME]: text(client?.name),
+        [enum_1.DocumentSystemVariable.CLIENT_EMAIL]: text(client?.email),
+        [enum_1.DocumentSystemVariable.CLIENT_PHONE]: text(client?.phone),
+        [enum_1.DocumentSystemVariable.CLIENT_ADDRESS]: address(client?.address),
+        [enum_1.DocumentSystemVariable.CLIENT_REGISTRATION_NUMBER]: text(client?.registration_number),
+        [enum_1.DocumentSystemVariable.CLIENT_VAT_NUMBER]: text(client?.vat_number),
+        [enum_1.DocumentSystemVariable.DOCUMENT_NUMBER]: number ?? '',
+        [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,
+    };
+    return Object.fromEntries(Object.entries(values).filter(([, value]) => value !== ''));
+};
+exports.systemValues = systemValues;

package/dist/index.d.ts

@@ -10,7 +10,7 @@ export type { SupabaseOrganizationScope, SupabaseServiceClientConfig } from './s
 export { SupabaseClientError } from './errors';
 export type { SupabaseClientErrorInit } from './errors';
 export { EmptyToNull, IsNullable } from './validators';
-export type { AuditActor, AuditChanges, AuditEntry, AuditErrorHandler, AuditGuard, AuditNameTable, AuditRow, AuditedTable, AuditedTableOptions, EntityAuditTrail, OrganizationTableFactory, } from './audit';
+export type { AuditActor, AuditChanges, AuditDeleteGuard, AuditEntry, AuditErrorHandler, AuditGuard, AuditNameTable, AuditRow, AuditedTable, AuditedTableOptions, EntityAuditTrail, OrganizationTableFactory, } from './audit';
 export { GetAuditTrailDto, withAuditBatch } from './audit';
 export { CancelSubscriptionDto, GetPaymentsQueryDto, InitialPaymentDto, PaymentIdDto, PurchaseModuleDto, ReinstateSubscriptionDto, } from './billing';
 export { GetInvoicesQueryDto, InvoiceIdDto } from './billing/invoices';
@@ -26,6 +26,7 @@ export type { CreateNotificationInput, CreatedNotification, NotificationContentR
 export { GetNotificationsDto, NotificationIdDto } from './notifications';
 export type { OrganizationInvite } from './organization-invites';
 export type { OrganizationPaymentMethod, PaymentMethodLookupColumn, } from './organization-payment-methods';
+export { UpdateOrganizationPayoutsDto } from './organization-payment-methods';
 export type { CreateOrganizationRow, OrganizationRow } from './organizations';
 export { CreateOrganizationDto, GetOrganizationsDto, OrganizationIdDto, UpdateOrganizationDto, } from './organizations';
 export { PermissionsResource } from './permissions';
@@ -40,6 +41,12 @@ export type { ClaimOutcome, WebhookEventRow, WebhookEventsTable } from './webhoo
 export { GetSupportingFilesDto, SupportingFileIdDto, SupportingFileNamesDto } from './supporting-files';
 export { ClientIdDto, CreateClientDto, GetClientsDto, StaffGetClientsDto, UpdateClientDto } from './clients';
 export { ConvertLeadDto, CreateLeadDto, GetLeadsDto, LeadIdDto, StaffGetLeadsDto, UpdateLeadDto } from './leads';
+export type { CreateDocumentRow, DocumentListRecord, DocumentSendEvent, UpdateDocumentRow } from './documents';
+export type { CreatePaymentRow, OpenPaymentRecord, PaymentRecord, SettlePaymentRow } from './payments';
+export { CreateDocumentDto, CreateDocumentTemplateDto, DocumentIdDto, DocumentImageNameDto, DocumentImageUrlsDto, DocumentPayQueryDto, DocumentPayTokenDto, DocumentPaymentIdDto, DocumentTemplateIdDto, documentProblem, GetDocumentsDto, GetDocumentTemplatesDto, PayDocumentDto, RecordDocumentPaymentDto, SendDocumentDto, UpdateDocumentDto, UpdateDocumentTemplateDto, VoidDocumentDto, ReassignPrivateDocumentsDto, } from './documents';
+export type { DocumentRecord, DocumentTemplateRecord } from './documents';
+export type { VisibilityRecord, VisibilityShareInput } from './visibility';
+export { UpdateVisibilityDto } from './visibility';
 export { CreateProjectDto, GetProjectsDto, ProjectIdDto, StaffGetProjectsDto, UpdateProjectDto } from './projects';
 export { AddTaskLinkDto, CreateTaskDto, GetTasksDto, StaffGetTasksDto, TaskIdDto, TaskLinkIdDto, UpdateTaskDto, } from './tasks';
 export type { CreateLeaveEntitlementInput, CreateLeaveRequestRow, ReviewLeaveRequestRow, UpdateLeaveRequestRow, } from './leave';

package/dist/index.js

@@ -7,9 +7,9 @@
 // their classes are not exported: a consumer never constructs one, and every export is a contract
 // to keep. The row and input types they produce and accept are exported for annotations.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CreateOrganizationDto = exports.NotificationIdDto = exports.GetNotificationsDto = exports.NoteIdDto = exports.GetNotesDto = exports.AddNoteDto = exports.UpdateAdditionalDetailsDto = exports.IsAdditionalDetailsValueByType = exports.GetAdditionalDetailsDto = exports.AdditionalDetailsIdDto = exports.AddAdditionalDetailsDto = exports.UpdateLabelDto = exports.LabelIdDto = exports.GetLabelsDto = exports.AddLabelDto = exports.UpdateStatusDto = exports.StatusIdDto = exports.ReorderStatusesDto = exports.GetStatusesDto = exports.AddStatusDto = exports.CreateSupportRequestDto = exports.UpdateConfigDto = exports.CreateConfigDto = exports.CreateFeatureRequestDto = exports.InvoiceIdDto = exports.GetInvoicesQueryDto = exports.ReinstateSubscriptionDto = exports.PurchaseModuleDto = exports.PaymentIdDto = exports.InitialPaymentDto = exports.GetPaymentsQueryDto = exports.CancelSubscriptionDto = exports.withAuditBatch = exports.GetAuditTrailDto = exports.IsNullable = exports.EmptyToNull = exports.SupabaseClientError = exports.createSupabaseServiceClient = exports.SupabaseServiceClient = exports.SignInDto = exports.SendPasswordResetEmailDto = exports.ResetPasswordDto = exports.ExchangeTokenHashDto = exports.ExchangeRefreshTokenDto = exports.createSupabaseAuthClient = exports.SupabaseAuthClient = exports.createSupabaseStaffClient = exports.SupabaseStaffClient = exports.createSupabaseClient = exports.SupabaseClient = void 0;
-exports.GetLeaveEntitlementsDto = exports.GetLeaveCalendarDto = exports.CreateLeaveTypeDto = exports.CreateLeaveRequestDto = exports.CreateLeaveEntitlementDto = exports.CreateLeaveAdjustmentDto = exports.BulkCreateLeaveEntitlementsDto = exports.UpdateTaskDto = exports.TaskLinkIdDto = exports.TaskIdDto = exports.StaffGetTasksDto = exports.GetTasksDto = exports.CreateTaskDto = exports.AddTaskLinkDto = exports.UpdateProjectDto = exports.StaffGetProjectsDto = exports.ProjectIdDto = exports.GetProjectsDto = exports.CreateProjectDto = exports.UpdateLeadDto = exports.StaffGetLeadsDto = exports.LeadIdDto = exports.GetLeadsDto = exports.CreateLeadDto = exports.ConvertLeadDto = exports.UpdateClientDto = exports.StaffGetClientsDto = exports.GetClientsDto = exports.CreateClientDto = exports.ClientIdDto = exports.SupportingFileNamesDto = exports.SupportingFileIdDto = exports.GetSupportingFilesDto = exports.UserIdDto = exports.UpdateUserDto = exports.UpdateMyProfileDto = exports.StaffGetUsersDto = exports.GetUsersQueryDto = exports.AddUserDto = exports.UserApiCredentialIdDto = exports.MintEmulationTokenDto = exports.CreateUserApiCredentialDto = exports.UpdateStaffPermissionsDto = exports.StaffIdDto = exports.CreateStaffDto = exports.UpdatePermissionsDto = exports.PermissionsResource = exports.UpdateOrganizationDto = exports.OrganizationIdDto = exports.GetOrganizationsDto = void 0;
-exports.monthlyTotalMinor = exports.weekStartOf = exports.minutesBetween = exports.UpdateTimesheetEntryDto = exports.TimesheetIdDto = exports.TimesheetEntryIdDto = exports.ReviewTimesheetDto = exports.GetTimesheetsDto = exports.GetTimesheetReportDto = exports.CreateTimesheetEntryDto = exports.todayInJohannesburg = exports.shiftDays = exports.proRataDays = exports.isWithinPeriod = exports.initialUntil = exports.cyclePeriodFor = exports.countWorkingDays = exports.completedMonths = exports.addMonths = exports.GetPublicHolidaysDto = exports.UpdateLeaveTypeDto = exports.UpdateLeaveRequestDto = exports.UpdateLeaveEntitlementDto = exports.ReviewLeaveRequestDto = exports.LeaveTypeIdDto = exports.LeaveRequestIdDto = exports.LeaveEntitlementIdDto = exports.GetLeaveTypesDto = exports.GetLeaveRequestsDto = void 0;
+exports.UpdateOrganizationPayoutsDto = exports.NotificationIdDto = exports.GetNotificationsDto = exports.NoteIdDto = exports.GetNotesDto = exports.AddNoteDto = exports.UpdateAdditionalDetailsDto = exports.IsAdditionalDetailsValueByType = exports.GetAdditionalDetailsDto = exports.AdditionalDetailsIdDto = exports.AddAdditionalDetailsDto = exports.UpdateLabelDto = exports.LabelIdDto = exports.GetLabelsDto = exports.AddLabelDto = exports.UpdateStatusDto = exports.StatusIdDto = exports.ReorderStatusesDto = exports.GetStatusesDto = exports.AddStatusDto = exports.CreateSupportRequestDto = exports.UpdateConfigDto = exports.CreateConfigDto = exports.CreateFeatureRequestDto = exports.InvoiceIdDto = exports.GetInvoicesQueryDto = exports.ReinstateSubscriptionDto = exports.PurchaseModuleDto = exports.PaymentIdDto = exports.InitialPaymentDto = exports.GetPaymentsQueryDto = exports.CancelSubscriptionDto = exports.withAuditBatch = exports.GetAuditTrailDto = exports.IsNullable = exports.EmptyToNull = exports.SupabaseClientError = exports.createSupabaseServiceClient = exports.SupabaseServiceClient = exports.SignInDto = exports.SendPasswordResetEmailDto = exports.ResetPasswordDto = exports.ExchangeTokenHashDto = exports.ExchangeRefreshTokenDto = exports.createSupabaseAuthClient = exports.SupabaseAuthClient = exports.createSupabaseStaffClient = exports.SupabaseStaffClient = exports.createSupabaseClient = exports.SupabaseClient = void 0;
+exports.VoidDocumentDto = exports.UpdateDocumentTemplateDto = exports.UpdateDocumentDto = exports.SendDocumentDto = exports.RecordDocumentPaymentDto = exports.PayDocumentDto = exports.GetDocumentTemplatesDto = exports.GetDocumentsDto = exports.documentProblem = exports.DocumentTemplateIdDto = exports.DocumentPaymentIdDto = exports.DocumentPayTokenDto = exports.DocumentPayQueryDto = exports.DocumentImageUrlsDto = exports.DocumentImageNameDto = exports.DocumentIdDto = exports.CreateDocumentTemplateDto = exports.CreateDocumentDto = exports.UpdateLeadDto = exports.StaffGetLeadsDto = exports.LeadIdDto = exports.GetLeadsDto = exports.CreateLeadDto = exports.ConvertLeadDto = exports.UpdateClientDto = exports.StaffGetClientsDto = exports.GetClientsDto = exports.CreateClientDto = exports.ClientIdDto = exports.SupportingFileNamesDto = exports.SupportingFileIdDto = exports.GetSupportingFilesDto = exports.UserIdDto = exports.UpdateUserDto = exports.UpdateMyProfileDto = exports.StaffGetUsersDto = exports.GetUsersQueryDto = exports.AddUserDto = exports.UserApiCredentialIdDto = exports.MintEmulationTokenDto = exports.CreateUserApiCredentialDto = exports.UpdateStaffPermissionsDto = exports.StaffIdDto = exports.CreateStaffDto = exports.UpdatePermissionsDto = exports.PermissionsResource = exports.UpdateOrganizationDto = exports.OrganizationIdDto = exports.GetOrganizationsDto = exports.CreateOrganizationDto = void 0;
+exports.monthlyTotalMinor = exports.weekStartOf = exports.minutesBetween = exports.UpdateTimesheetEntryDto = exports.TimesheetIdDto = exports.TimesheetEntryIdDto = exports.ReviewTimesheetDto = exports.GetTimesheetsDto = exports.GetTimesheetReportDto = exports.CreateTimesheetEntryDto = exports.todayInJohannesburg = exports.shiftDays = exports.proRataDays = exports.isWithinPeriod = exports.initialUntil = exports.cyclePeriodFor = exports.countWorkingDays = exports.completedMonths = exports.addMonths = exports.GetPublicHolidaysDto = exports.UpdateLeaveTypeDto = exports.UpdateLeaveRequestDto = exports.UpdateLeaveEntitlementDto = exports.ReviewLeaveRequestDto = exports.LeaveTypeIdDto = exports.LeaveRequestIdDto = exports.LeaveEntitlementIdDto = exports.GetLeaveTypesDto = exports.GetLeaveRequestsDto = exports.GetLeaveEntitlementsDto = exports.GetLeaveCalendarDto = exports.CreateLeaveTypeDto = exports.CreateLeaveRequestDto = exports.CreateLeaveEntitlementDto = exports.CreateLeaveAdjustmentDto = exports.BulkCreateLeaveEntitlementsDto = exports.UpdateTaskDto = exports.TaskLinkIdDto = exports.TaskIdDto = exports.StaffGetTasksDto = exports.GetTasksDto = exports.CreateTaskDto = exports.AddTaskLinkDto = exports.UpdateProjectDto = exports.StaffGetProjectsDto = exports.ProjectIdDto = exports.GetProjectsDto = exports.CreateProjectDto = exports.UpdateVisibilityDto = exports.ReassignPrivateDocumentsDto = void 0;
 var client_1 = require("./client");
 Object.defineProperty(exports, "SupabaseClient", { enumerable: true, get: function () { return client_1.SupabaseClient; } });
 Object.defineProperty(exports, "createSupabaseClient", { enumerable: true, get: function () { return client_1.createSupabaseClient; } });
@@ -77,6 +77,8 @@ Object.defineProperty(exports, "NoteIdDto", { enumerable: true, get: function ()
 var notifications_1 = require("./notifications");
 Object.defineProperty(exports, "GetNotificationsDto", { enumerable: true, get: function () { return notifications_1.GetNotificationsDto; } });
 Object.defineProperty(exports, "NotificationIdDto", { enumerable: true, get: function () { return notifications_1.NotificationIdDto; } });
+var organization_payment_methods_1 = require("./organization-payment-methods");
+Object.defineProperty(exports, "UpdateOrganizationPayoutsDto", { enumerable: true, get: function () { return organization_payment_methods_1.UpdateOrganizationPayoutsDto; } });
 var organizations_1 = require("./organizations");
 Object.defineProperty(exports, "CreateOrganizationDto", { enumerable: true, get: function () { return organizations_1.CreateOrganizationDto; } });
 Object.defineProperty(exports, "GetOrganizationsDto", { enumerable: true, get: function () { return organizations_1.GetOrganizationsDto; } });
@@ -120,6 +122,28 @@ Object.defineProperty(exports, "GetLeadsDto", { enumerable: true, get: function
 Object.defineProperty(exports, "LeadIdDto", { enumerable: true, get: function () { return leads_1.LeadIdDto; } });
 Object.defineProperty(exports, "StaffGetLeadsDto", { enumerable: true, get: function () { return leads_1.StaffGetLeadsDto; } });
 Object.defineProperty(exports, "UpdateLeadDto", { enumerable: true, get: function () { return leads_1.UpdateLeadDto; } });
+var documents_1 = require("./documents");
+Object.defineProperty(exports, "CreateDocumentDto", { enumerable: true, get: function () { return documents_1.CreateDocumentDto; } });
+Object.defineProperty(exports, "CreateDocumentTemplateDto", { enumerable: true, get: function () { return documents_1.CreateDocumentTemplateDto; } });
+Object.defineProperty(exports, "DocumentIdDto", { enumerable: true, get: function () { return documents_1.DocumentIdDto; } });
+Object.defineProperty(exports, "DocumentImageNameDto", { enumerable: true, get: function () { return documents_1.DocumentImageNameDto; } });
+Object.defineProperty(exports, "DocumentImageUrlsDto", { enumerable: true, get: function () { return documents_1.DocumentImageUrlsDto; } });
+Object.defineProperty(exports, "DocumentPayQueryDto", { enumerable: true, get: function () { return documents_1.DocumentPayQueryDto; } });
+Object.defineProperty(exports, "DocumentPayTokenDto", { enumerable: true, get: function () { return documents_1.DocumentPayTokenDto; } });
+Object.defineProperty(exports, "DocumentPaymentIdDto", { enumerable: true, get: function () { return documents_1.DocumentPaymentIdDto; } });
+Object.defineProperty(exports, "DocumentTemplateIdDto", { enumerable: true, get: function () { return documents_1.DocumentTemplateIdDto; } });
+Object.defineProperty(exports, "documentProblem", { enumerable: true, get: function () { return documents_1.documentProblem; } });
+Object.defineProperty(exports, "GetDocumentsDto", { enumerable: true, get: function () { return documents_1.GetDocumentsDto; } });
+Object.defineProperty(exports, "GetDocumentTemplatesDto", { enumerable: true, get: function () { return documents_1.GetDocumentTemplatesDto; } });
+Object.defineProperty(exports, "PayDocumentDto", { enumerable: true, get: function () { return documents_1.PayDocumentDto; } });
+Object.defineProperty(exports, "RecordDocumentPaymentDto", { enumerable: true, get: function () { return documents_1.RecordDocumentPaymentDto; } });
+Object.defineProperty(exports, "SendDocumentDto", { enumerable: true, get: function () { return documents_1.SendDocumentDto; } });
+Object.defineProperty(exports, "UpdateDocumentDto", { enumerable: true, get: function () { return documents_1.UpdateDocumentDto; } });
+Object.defineProperty(exports, "UpdateDocumentTemplateDto", { enumerable: true, get: function () { return documents_1.UpdateDocumentTemplateDto; } });
+Object.defineProperty(exports, "VoidDocumentDto", { enumerable: true, get: function () { return documents_1.VoidDocumentDto; } });
+Object.defineProperty(exports, "ReassignPrivateDocumentsDto", { enumerable: true, get: function () { return documents_1.ReassignPrivateDocumentsDto; } });
+var visibility_1 = require("./visibility");
+Object.defineProperty(exports, "UpdateVisibilityDto", { enumerable: true, get: function () { return visibility_1.UpdateVisibilityDto; } });
 var projects_1 = require("./projects");
 Object.defineProperty(exports, "CreateProjectDto", { enumerable: true, get: function () { return projects_1.CreateProjectDto; } });
 Object.defineProperty(exports, "GetProjectsDto", { enumerable: true, get: function () { return projects_1.GetProjectsDto; } });

package/dist/leads/index.js

@@ -101,8 +101,6 @@ const LEAD_SOURCE_LABELS = {
     [enum_1.LeadSource.EXISTING_CLIENT]: 'Existing client',
     [enum_1.LeadSource.OTHER]: 'Other',
 };
-/** Storage bucket every supporting file lives in (as in SupportingFilesResource). */
-const SUPPORTING_FILES_BUCKET = 'supporting-files';
 const refuse = (status, message) => new errors_1.SupabaseClientError({ status, error: 'Database Error', message });
 class LeadsResource {
     supabase;
@@ -346,7 +344,7 @@ class LeadsResource {
             throw (0, errors_1.mapPostgrestError)(filesError);
         for (const file of files) {
             const { error: storageError } = await this.supabase.storage
-                .from(SUPPORTING_FILES_BUCKET)
+                .from(paths_1.SUPPORTING_FILES_BUCKET)
                 .move((0, paths_1.storagePath)(organizationId, enum_5.SupportingFilesEntityTypes.LEAD, leadId, file.name, file.extension), (0, paths_1.storagePath)(organizationId, enum_5.SupportingFilesEntityTypes.CLIENT, clientId, file.name, file.extension));
             if (storageError) {
                 if (storageError.status === 404 || storageError.statusCode === '404')

package/dist/notifications/index.d.ts

@@ -91,6 +91,12 @@ export declare class NotificationsOutboxResource {
     private auditedFor;
     private rawUpdate;
     create(input: CreateNotificationInput): Promise<CreatedNotification>;
+    /**
+     * Whether `recipientId` has been sent a notification of `type` whose variables include every
+     * one of `variables` - how the documents cron tells a creator about one failure once, not every
+     * morning it retries.
+     */
+    existsFor(type: NotificationType, recipientId: string, variables: Record<string, string>): Promise<boolean>;
     /**
      * The outbox row behind a provider message id. The Resend webhook arrives knowing only that
      * id, and needs the organization before it can attribute anything.

package/dist/notifications/index.js

@@ -239,6 +239,22 @@ class NotificationsOutboxResource {
             throw (0, errors_1.mapPostgrestError)(error);
         return data;
     }
+    /**
+     * Whether `recipientId` has been sent a notification of `type` whose variables include every
+     * one of `variables` - how the documents cron tells a creator about one failure once, not every
+     * morning it retries.
+     */
+    async existsFor(type, recipientId, variables) {
+        const { error, count } = await this.supabase
+            .from('notifications')
+            .select('mms_id', { count: 'exact', head: true })
+            .eq('type', type)
+            .eq('recipient_id', recipientId)
+            .contains('template_variables', variables);
+        if (error)
+            throw (0, errors_1.mapPostgrestError)(error);
+        return (count ?? 0) > 0;
+    }
     /**
      * The outbox row behind a provider message id. The Resend webhook arrives knowing only that
      * id, and needs the organization before it can attribute anything.

package/dist/organization-payment-methods/dto.d.ts

@@ -0,0 +1,10 @@
+import type { UpdateOrganizationPayoutsDto as UpdateOrganizationPayoutsDtoType } from '@managemint-solutions/entities/organization/payouts/dto';
+import { PayoutAccountType, PayoutDocumentType } from '@managemint-solutions/entities/organization/payouts/enum';
+export declare class UpdateOrganizationPayoutsDto implements UpdateOrganizationPayoutsDtoType {
+    readonly business_name: string;
+    readonly account_type: PayoutAccountType;
+    readonly bank_code: string;
+    readonly account_number: string;
+    readonly document_type: PayoutDocumentType;
+    readonly document_number: string;
+}

package/dist/organization-payment-methods/dto.js

@@ -0,0 +1,56 @@
+"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.UpdateOrganizationPayoutsDto = void 0;
+const class_validator_1 = require("class-validator");
+const enum_1 = require("@managemint-solutions/entities/organization/payouts/enum");
+// class-validator version of the shared DTO type from @managemint-solutions/entities. The account
+// itself is checked by Paystack (POST /bank/validate) before anything is stored; these are only
+// the shapes Paystack accepts. Each property's type check sits last (decorators run bottom-up).
+class UpdateOrganizationPayoutsDto {
+    business_name;
+    account_type;
+    bank_code;
+    account_number;
+    document_type;
+    document_number;
+}
+exports.UpdateOrganizationPayoutsDto = UpdateOrganizationPayoutsDto;
+__decorate([
+    (0, class_validator_1.MaxLength)(100, { message: 'Account holder cannot exceed 100 characters' }),
+    (0, class_validator_1.Matches)(/\S/, { message: 'Give the account holder\'s name' }),
+    (0, class_validator_1.IsString)({ message: 'Give the account holder\'s name' }),
+    __metadata("design:type", String)
+], UpdateOrganizationPayoutsDto.prototype, "business_name", void 0);
+__decorate([
+    (0, class_validator_1.IsEnum)(enum_1.PayoutAccountType, { message: `Account type must be one of: ${Object.values(enum_1.PayoutAccountType).join(', ')}` }),
+    __metadata("design:type", String)
+], UpdateOrganizationPayoutsDto.prototype, "account_type", void 0);
+__decorate([
+    (0, class_validator_1.Matches)(/^\d{3,10}$/, { message: 'Choose a bank from the list' }),
+    (0, class_validator_1.IsString)({ message: 'Choose a bank from the list' }),
+    __metadata("design:type", String)
+], UpdateOrganizationPayoutsDto.prototype, "bank_code", void 0);
+__decorate([
+    (0, class_validator_1.Matches)(/^\d{6,16}$/, { message: 'Account number must be 6 to 16 digits' }),
+    (0, class_validator_1.IsString)({ message: 'Account number must be 6 to 16 digits' }),
+    __metadata("design:type", String)
+], UpdateOrganizationPayoutsDto.prototype, "account_number", void 0);
+__decorate([
+    (0, class_validator_1.IsEnum)(enum_1.PayoutDocumentType, { message: `Document type must be one of: ${Object.values(enum_1.PayoutDocumentType).join(', ')}` }),
+    __metadata("design:type", String)
+], UpdateOrganizationPayoutsDto.prototype, "document_type", void 0);
+__decorate([
+    (0, class_validator_1.MaxLength)(30, { message: 'Document number cannot exceed 30 characters' }),
+    (0, class_validator_1.MinLength)(1, { message: 'Give the document number' }),
+    (0, class_validator_1.IsString)({ message: 'Give the document number' }),
+    __metadata("design:type", String)
+], UpdateOrganizationPayoutsDto.prototype, "document_number", void 0);

package/dist/organization-payment-methods/index.d.ts

@@ -1,5 +1,6 @@
 import type { AuditActor } from '../audit';
 import type { TypedSupabaseClient } from '../client';
+export * from './dto';
 /**
  * Everything Paystack knows an organization by, plus the two secrets the billing service acts
  * with. One row per organization; every column is null until the step that creates it runs.
@@ -18,8 +19,14 @@ export type OrganizationPaymentMethod = {
     paystack_subscription_email_token: string | null;
     /** The saved card authorization every off-session charge is made against. */
     paystack_customer_authorization_code: string | null;
+    /** The subaccount every Pay now charge settles to; null while payouts are off. */
+    paystack_subaccount_code: string | null;
+    /** What the organization page shows of the payout account: the holder, the bank, the last four digits. */
+    payout_business_name: string | null;
+    payout_bank_name: string | null;
+    payout_account_last4: string | null;
 };
-export declare const PAYMENT_METHOD_COLUMNS: readonly ["paystack_customer_code", "paystack_customer_created_at", "paystack_plan_code", "paystack_plan_created_at", "paystack_subscription_code", "paystack_subscription_created_at", "paystack_subscription_email_token", "paystack_customer_authorization_code"];
+export declare const PAYMENT_METHOD_COLUMNS: readonly ["paystack_customer_code", "paystack_customer_created_at", "paystack_plan_code", "paystack_plan_created_at", "paystack_subscription_code", "paystack_subscription_created_at", "paystack_subscription_email_token", "paystack_customer_authorization_code", "paystack_subaccount_code", "payout_business_name", "payout_bank_name", "payout_account_last4"];
 /** The payment-method columns a webhook may look an organization up by. */
 export type PaymentMethodLookupColumn = 'paystack_customer_code' | 'paystack_subscription_code';
 /**

package/dist/organization-payment-methods/index.js

@@ -1,7 +1,22 @@
 "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.OrganizationPaymentMethodsResource = exports.PAYMENT_METHOD_COLUMNS = void 0;
 const errors_1 = require("../errors");
+__exportStar(require("./dto"), exports);
 exports.PAYMENT_METHOD_COLUMNS = [
     'paystack_customer_code',
     'paystack_customer_created_at',
@@ -11,6 +26,10 @@ exports.PAYMENT_METHOD_COLUMNS = [
     'paystack_subscription_created_at',
     'paystack_subscription_email_token',
     'paystack_customer_authorization_code',
+    'paystack_subaccount_code',
+    'payout_business_name',
+    'payout_bank_name',
+    'payout_account_last4',
 ];
 const EMPTY = {
     paystack_customer_code: null,
@@ -21,6 +40,10 @@ const EMPTY = {
     paystack_subscription_created_at: null,
     paystack_subscription_email_token: null,
     paystack_customer_authorization_code: null,
+    paystack_subaccount_code: null,
+    payout_business_name: null,
+    payout_bank_name: null,
+    payout_account_last4: null,
 };
 /**
  * The `organization_payment_methods` table: the organization's Paystack identity in one row

package/dist/payments/index.d.ts

@@ -0,0 +1,67 @@
+import type { Payment } from '@managemint-solutions/entities/payments';
+import { type PaymentEntityType } from '@managemint-solutions/entities/payments/enum';
+import { type AuditResource, type ResourceActor } from '../audit';
+import type { TypedSupabaseClient } from '../client';
+/** A payment as the sdk reads it: the shared Payment. */
+export type PaymentRecord = Payment;
+/** An open checkout, with what reopening it needs: the provider's reference and access code. */
+export type OpenPaymentRecord = PaymentRecord & {
+    access_code: string | null;
+};
+/**
+ * A payment as the api records it: an open checkout (no `paid_at`), or a settled charge nobody
+ * opened here (status paid, `paid_at` set).
+ */
+export type CreatePaymentRow = Omit<Payment, 'mms_id' | 'created_at' | 'created_by' | 'paid_at'> & {
+    entity_type: PaymentEntityType;
+    entity_id: string;
+    access_code?: string | null;
+    /** ISO timestamp; null while open. */
+    paid_at: string | null;
+};
+/** What settling an open checkout fills in, from the charge Paystack confirmed. */
+export type SettlePaymentRow = Pick<Payment, 'amount_minor' | 'currency' | 'payer_email'> & {
+    paid_at: string;
+};
+/**
+ * `public.payments`: money received for a record, keyed by `entity_type` + `entity_id` like the
+ * visibility table. Read on the caller's client (RLS shows a payment while its record is
+ * readable); written on the service client's organization scope alone - members hold only a
+ * SELECT grant. A checkout starts as an `open` row (one per record, by a partial unique index)
+ * and is settled to `paid`. Each write is audited and, through its `entity_type`/`entity_id`,
+ * filed under the record it pays for.
+ */
+export declare class PaymentsResource {
+    private readonly supabase;
+    private readonly actor;
+    private readonly table;
+    constructor(supabase: TypedSupabaseClient, actor: ResourceActor, audit: AuditResource);
+    /** The money received for one record, oldest first - paid rows only. */
+    list(entityType: PaymentEntityType, entityId: string): Promise<PaymentRecord[]>;
+    /** How many paid payments each of `entityIds` has - one query for a page of a list. */
+    paidCounts(entityType: PaymentEntityType, entityIds: string[]): Promise<Record<string, number>>;
+    /**
+     * The ids of the organization's records of one kind with a settled payment, each once - the
+     * documents list's payment filter reads it before the page.
+     */
+    paidEntityIds(entityType: PaymentEntityType): Promise<string[]>;
+    /** The record's open checkout, if one is under way. */
+    findOpen(entityType: PaymentEntityType, entityId: string): Promise<OpenPaymentRecord | null>;
+    /** A payment by the provider's reference (unique), whatever its status. */
+    findByReference(reference: string): Promise<PaymentRecord | null>;
+    /**
+     * Records one payment, by the actor (null for the system). A Paystack reference recorded
+     * already, or a second open checkout for the record, is refused by a unique index - 409 with
+     * `code` 23505.
+     */
+    create(row: CreatePaymentRow): Promise<void>;
+    /**
+     * Removes a payment marked by hand (EFT) from the record it pays for. False when it is not one -
+     * a Paystack payment is money Paystack holds, refunded there, never removed here.
+     */
+    removeManual(paymentId: string, entityType: PaymentEntityType, entityId: string): Promise<boolean>;
+    /** Settles an open checkout. False when it is no longer open (settled or replaced first). */
+    settle(paymentId: string, row: SettlePaymentRow): Promise<boolean>;
+    /** Drops an open checkout Paystack says failed, so a new one can open. False when it moved on. */
+    removeOpen(paymentId: string): Promise<boolean>;
+}