@managemint-solutions/sdk 0.56.0 → 0.64.0

package/dist/audit/index.d.ts

@@ -34,6 +34,25 @@ export type AuditEntry = {
     changes: AuditChanges;
     relatedEntityType?: string | null;
     relatedEntityId?: string | null;
+    /**
+     * Fields in `changes` that name the row rather than change it (a table's `identity` option):
+     * kept when an audit batch folds the entry even though they did not move, and never counted as
+     * a change of their own. Not written to the audit row.
+     */
+    identity?: readonly string[];
+    /**
+     * Set on a template's or document's entry (the table's `documentContent` option): its bulk
+     * columns are held whole in `changes` until the entry is written, then stored as what changed
+     * inside them (`compactDocumentChanges`) - so a batch that folds two saves still diffs the
+     * first against the last. `variables` is the row's definitions before and after, which label
+     * the values. Not written to the audit row.
+     */
+    documentContent?: {
+        variables: {
+            old: unknown;
+            new: unknown;
+        };
+    };
 };
 /** Called when the audit insert itself fails. The business write has already succeeded. */
 export type AuditErrorHandler = (error: unknown, entries: AuditEntry[]) => void;
@@ -50,7 +69,11 @@ export declare const AUDIT_EXCLUDED_COLUMNS: ReadonlySet<string>;
  * subscription codes, card metadata, tokens, an idempotency key that would let a replay be
  * forged, an api credential's secret hash) or content the base table deliberately withholds
  * (`authenticated` has no grant on `notifications.rendered_content`, so the rendered email must
- * not arrive by the back door).
+ * not arrive by the back door). Two more are bulk rather than secret: a document's and a
+ * template's `blocks` and `variables` are saved whole every time, and copying both sides of that
+ * JSON into the trail on each save would dwarf everything else in it - so a created or deleted
+ * row records only the markers, and an update records what changed inside them instead
+ * (`compactDocumentChanges`, through the table's `documentContent` option).
  * The column still shows up in the trail - that it changed is the point - with both sides
  * replaced by `'[redacted]'`.
  */
@@ -62,8 +85,9 @@ export declare const isRedactedColumn: (name: string) => boolean;
  * JSON (booleans stay booleans, jsonb stays an object) and are compared by serialized value, so
  * arrays and objects are equal when their contents are. A redacted column is compared on its
  * real values and only then redacted, so it is reported when - and only when - it truly moved.
+ * The `whole` columns keep both real values even when redacted, for the caller to compact.
  */
-export declare const diffChanges: (before: AuditRow, after: AuditRow) => AuditChanges;
+export declare const diffChanges: (before: AuditRow, after: AuditRow, whole?: readonly string[]) => AuditChanges;
 /**
  * A whole row as a change set - `'new'` for an insert, `'old'` for a hard delete - so the trail
  * stays self-contained once the row is gone. Columns that hold nothing are left out; a redacted
@@ -150,6 +174,17 @@ export type AuditedTableOptions = {
      * these leaves nothing to record, so it writes no audit row at all.
      */
     untracked?: readonly string[];
+    /**
+     * Columns recorded on every entry - insert, update and delete - even when unchanged or normally
+     * excluded, because they say whose row it is: a share's `user_id`, without which "Role: Admin
+     * -> Read" would not say whose role changed. On an update they appear with the same old and new.
+     */
+    identity?: readonly string[];
+    /**
+     * A template's or document's table: its `blocks`, `variables`, `variable_values` and `email`
+     * are recorded as what changed inside them, block by block and key by key, rather than whole.
+     */
+    documentContent?: boolean;
 };
 /** The payload to write, or a function of the pre-read row (`togglePin`'s `!before.pinned`). */
 type AuditedPayload = AuditRow | ((before: AuditRow) => AuditRow);
@@ -160,6 +195,13 @@ declare const buildUpdate: (supabase: SupabaseJsClient, table: string, id: strin
  * guarded write, e.g. `(query) => query.eq('billing_status', expectedFrom)`.
  */
 export type AuditGuard = (builder: ReturnType<typeof buildUpdate>) => ReturnType<typeof buildUpdate>;
+/** The keyed delete every audited delete builds, before any caller-supplied guard. */
+declare const buildDelete: (supabase: SupabaseJsClient, table: string, id: string, organizationId: string | null) => import("@supabase/postgrest-js").PostgrestFilterBuilder<any, any, any, null, string, unknown, "DELETE", false>;
+/**
+ * Narrows an audited delete to the rows it may still remove - the delete's half of a
+ * compare-and-set, e.g. `(query) => query.eq('status', 'draft')`.
+ */
+export type AuditDeleteGuard = (builder: ReturnType<typeof buildDelete>) => ReturnType<typeof buildDelete>;
 export type AuditedTable = {
     insert(payload: AuditRow): Promise<AuditRow>;
     insertMany(payloads: AuditRow[]): Promise<AuditRow[]>;
@@ -175,6 +217,12 @@ export type AuditedTable = {
     transition(id: string, action: AuditTrailAction, payload: AuditedPayload): Promise<AuditRow>;
     /** Hard delete. Returns the row as it was, so the caller can still act on it. */
     remove(id: string): Promise<AuditRow>;
+    /**
+     * A hard delete that only lands while `guard` still holds, as `updateWhere` is for updates.
+     * Resolves to the row as it was, or `null` when the guard matched nothing (the row moved on
+     * first): nothing was deleted, so nothing is audited.
+     */
+    removeWhere(id: string, guard: AuditDeleteGuard): Promise<AuditRow | null>;
 };
 /** How a service-client resource reaches an audited table once it knows a row's organization. */
 export type OrganizationTableFactory = (organizationId: string) => AuditedTable;

package/dist/audit/index.js

@@ -20,6 +20,7 @@ const enum_1 = require("@managemint-solutions/entities/audit-trail/enum");
 const errors_1 = require("../errors");
 const tenancy_1 = require("../tenancy");
 const transforms_1 = require("../transforms");
+const document_changes_1 = require("./document-changes");
 __exportStar(require("./dto"), exports);
 /**
  * Drops the internal `id bigint` from a row on its way out of the SDK. Every table has one
@@ -63,13 +64,19 @@ exports.AUDIT_EXCLUDED_COLUMNS = new Set([
  * subscription codes, card metadata, tokens, an idempotency key that would let a replay be
  * forged, an api credential's secret hash) or content the base table deliberately withholds
  * (`authenticated` has no grant on `notifications.rendered_content`, so the rendered email must
- * not arrive by the back door).
+ * not arrive by the back door). Two more are bulk rather than secret: a document's and a
+ * template's `blocks` and `variables` are saved whole every time, and copying both sides of that
+ * JSON into the trail on each save would dwarf everything else in it - so a created or deleted
+ * row records only the markers, and an update records what changed inside them instead
+ * (`compactDocumentChanges`, through the table's `documentContent` option).
  * The column still shows up in the trail - that it changed is the point - with both sides
  * replaced by `'[redacted]'`.
  */
 exports.AUDIT_REDACTED_COLUMNS = new Set([
     'rendered_content',
     'template_variables',
+    'blocks',
+    'variables',
     'idempotency_key',
     'provider_message_id',
     'card_expiry_date',
@@ -85,6 +92,8 @@ const isRedactedColumn = (name) => exports.AUDIT_REDACTED_COLUMNS.has(name) || n
 exports.isRedactedColumn = isRedactedColumn;
 /** What a redacted column shows instead of its value. */
 const REDACTED = '[redacted]';
+/** Whether `field` is one of the entry's identity columns, which name the row rather than change it. */
+const isIdentity = (entry, field) => entry.identity?.includes(field) ?? false;
 /** `undefined` and `null` are the same absent value as far as a row diff is concerned. */
 const normalize = (value) => value ?? null;
 /**
@@ -92,8 +101,9 @@ const normalize = (value) => value ?? null;
  * JSON (booleans stay booleans, jsonb stays an object) and are compared by serialized value, so
  * arrays and objects are equal when their contents are. A redacted column is compared on its
  * real values and only then redacted, so it is reported when - and only when - it truly moved.
+ * The `whole` columns keep both real values even when redacted, for the caller to compact.
  */
-const diffChanges = (before, after) => {
+const diffChanges = (before, after, whole = []) => {
     const changes = {};
     for (const key of new Set([...Object.keys(before), ...Object.keys(after)])) {
         if (exports.AUDIT_EXCLUDED_COLUMNS.has(key))
@@ -102,7 +112,7 @@ const diffChanges = (before, after) => {
         const newValue = normalize(after[key]);
         if (JSON.stringify(oldValue) === JSON.stringify(newValue))
             continue;
-        changes[key] = (0, exports.isRedactedColumn)(key)
+        changes[key] = (0, exports.isRedactedColumn)(key) && !whole.includes(key)
             ? { old: REDACTED, new: REDACTED }
             : { old: oldValue, new: newValue };
     }
@@ -198,19 +208,24 @@ const withAuditBatch = async (work) => {
             }
             earlier.entry.relatedEntityType ??= entry.relatedEntityType;
             earlier.entry.relatedEntityId ??= entry.relatedEntityId;
+            earlier.entry.identity ??= entry.identity;
+            if (earlier.entry.documentContent && entry.documentContent) {
+                earlier.entry.documentContent = {
+                    variables: { old: earlier.entry.documentContent.variables.old, new: entry.documentContent.variables.new },
+                };
+            }
+            earlier.entry.documentContent ??= entry.documentContent;
         }
         const byWriter = new Map();
         for (const { entry, writer } of merged.values()) {
             // A field that ended where it started is no change (a redacted one reads the same on both
-            // sides by design, so it stays).
+            // sides by design, so it stays; an identity field names the row, so it stays too). An
+            // update left with no change is dropped by `write`.
             for (const [field, change] of Object.entries(entry.changes)) {
-                if (change.old !== REDACTED && JSON.stringify(change.old) === JSON.stringify(change.new)) {
+                if (!isIdentity(entry, field) && change.old !== REDACTED && JSON.stringify(change.old) === JSON.stringify(change.new)) {
                     delete entry.changes[field];
                 }
             }
-            // Updates that cancelled out changed nothing: no row.
-            if (entry.action === enum_1.AuditTrailAction.UPDATE && Object.keys(entry.changes).length === 0)
-                continue;
             byWriter.set(writer, [...(byWriter.get(writer) ?? []), entry]);
         }
         await Promise.all([...byWriter].map(([writer, entries]) => writer.write(entries)));
@@ -252,8 +267,19 @@ class AuditResource {
      * writes what it held.
      */
     async write(entries) {
+        // A template's or document's bulk columns become what changed inside them. An update left
+        // with nothing but its identity fields - cancelled out in a batch, or nothing printable moved
+        // (variables only reordered) - is no event.
+        const rows = entries
+            .map((item) => item.documentContent
+            ? { ...item, changes: (0, document_changes_1.compactDocumentChanges)(item.changes, item.documentContent.variables) }
+            : item)
+            .filter((item) => item.action !== enum_1.AuditTrailAction.UPDATE
+            || Object.keys(item.changes).some((field) => !isIdentity(item, field)));
+        if (rows.length === 0)
+            return;
         try {
-            const { error } = await this.supabase.from('audit_logs').insert(entries.map((item) => ({
+            const { error } = await this.supabase.from('audit_logs').insert(rows.map((item) => ({
                 created_by: this.actor.mms_id,
                 organization_id: this.actor.organization_id,
                 action: item.action,
@@ -268,7 +294,7 @@ class AuditResource {
         }
         catch (error) {
             const handle = this.onError ?? ((thrown, failed) => console.error(thrown, failed));
-            handle(error, entries);
+            handle(error, rows);
         }
     }
     /**
@@ -376,6 +402,14 @@ const buildUpdate = (supabase, table, id, payload, organizationId) => {
         query = query.eq('organization_id', organizationId);
     return query;
 };
+/** The keyed delete every audited delete builds, before any caller-supplied guard. */
+const buildDelete = (supabase, table, id, organizationId) => {
+    // `eq` returns `this`, so the org filter can be reassigned onto the builder without a cast.
+    let query = supabase.from(table).delete().eq('mms_id', id);
+    if (organizationId !== null)
+        query = query.eq('organization_id', organizationId);
+    return query;
+};
 /**
  * The audited write helper every resource writes through: it does the pre-read, the write, the
  * diff and the `audit_logs` insert itself, so no feature carries audit code. The write fails
@@ -411,19 +445,32 @@ const auditedTable = (supabase, actor, audit, options) => {
     const updateOf = (id, before, payload) => buildUpdate(supabase, options.table, id, typeof payload === 'function' ? payload(before) : payload, organizationFilter);
     // The changes with the table's untracked columns taken out.
     const tracked = (changes) => Object.fromEntries(Object.entries(changes).filter(([column]) => !options.untracked?.includes(column)));
+    // The entry for one write of a row (`before` null for an insert, `after` null for a delete): the
+    // tracked changes plus the table's identity columns, a template's or document's variable
+    // definitions to label its values, and the record the row belongs to.
+    const entryOf = (id, action, changes, before, after) => ({
+        action,
+        entityType: options.entityType,
+        entityId: id,
+        changes: {
+            ...tracked(changes),
+            ...Object.fromEntries((options.identity ?? []).map((column) => [column, { old: before?.[column] ?? null, new: after?.[column] ?? null }])),
+        },
+        identity: options.identity,
+        ...(options.documentContent && {
+            documentContent: { variables: { old: before?.variables ?? null, new: after?.variables ?? null } },
+        }),
+        ...relatedOf((before ?? after)),
+    });
     // An update that changed nothing tracked is not an event: no row.
     const recordWrite = async (id, action, before, after) => {
-        const changes = tracked((0, exports.diffChanges)(before, after));
-        if (action === enum_1.AuditTrailAction.UPDATE && Object.keys(changes).length === 0)
+        const changes = (0, exports.diffChanges)(before, after, options.documentContent ? document_changes_1.DOCUMENT_CONTENT_COLUMNS : []);
+        if (action === enum_1.AuditTrailAction.UPDATE && Object.keys(tracked(changes)).length === 0)
             return;
-        await audit.record({
-            action,
-            entityType: options.entityType,
-            entityId: id,
-            changes,
-            ...relatedOf(before),
-        });
+        await audit.record(entryOf(id, action, changes, before, after));
     };
+    // A hard delete keeps the whole row, so the trail survives it.
+    const recordDelete = (id, row) => audit.record(entryOf(id, enum_1.AuditTrailAction.DELETE, (0, exports.snapshotChanges)(row, 'old'), row, null));
     const write = async (id, action, payload) => {
         (0, tenancy_1.requireOrganization)(actor);
         const before = await read(id);
@@ -463,13 +510,7 @@ const auditedTable = (supabase, actor, audit, options) => {
             if (error)
                 throw (0, errors_1.mapPostgrestError)(error);
             const row = data;
-            await audit.record({
-                action: enum_1.AuditTrailAction.INSERT,
-                entityType: options.entityType,
-                entityId: row.mms_id,
-                changes: tracked((0, exports.snapshotChanges)(row, 'new')),
-                ...relatedOf(row),
-            });
+            await audit.record(entryOf(row.mms_id, enum_1.AuditTrailAction.INSERT, (0, exports.snapshotChanges)(row, 'new'), null, row));
             return (0, exports.withoutInternalId)(row);
         },
         async insertMany(payloads) {
@@ -480,13 +521,7 @@ const auditedTable = (supabase, actor, audit, options) => {
             if (error)
                 throw (0, errors_1.mapPostgrestError)(error);
             const rows = (data ?? []);
-            await audit.record(rows.map((row) => ({
-                action: enum_1.AuditTrailAction.INSERT,
-                entityType: options.entityType,
-                entityId: row.mms_id,
-                changes: tracked((0, exports.snapshotChanges)(row, 'new')),
-                ...relatedOf(row),
-            })));
+            await audit.record(rows.map((row) => entryOf(row.mms_id, enum_1.AuditTrailAction.INSERT, (0, exports.snapshotChanges)(row, 'new'), null, row)));
             return rows.map(exports.withoutInternalId);
         },
         update(id, payload) {
@@ -501,21 +536,29 @@ const auditedTable = (supabase, actor, audit, options) => {
         async remove(id) {
             (0, tenancy_1.requireOrganization)(actor);
             const before = await read(id);
-            let query = supabase.from(options.table).delete().eq('mms_id', id);
-            if (organizationFilter !== null)
-                query = query.eq('organization_id', organizationFilter);
-            const { error } = await query;
+            const { error } = await buildDelete(supabase, options.table, id, organizationFilter);
             if (error)
                 throw (0, errors_1.mapPostgrestError)(error);
-            await audit.record({
-                action: enum_1.AuditTrailAction.DELETE,
-                entityType: options.entityType,
-                entityId: id,
-                changes: tracked((0, exports.snapshotChanges)(before, 'old')),
-                ...relatedOf(before),
-            });
+            await recordDelete(id, before);
             return (0, exports.withoutInternalId)(before);
         },
+        async removeWhere(id, guard) {
+            (0, tenancy_1.requireOrganization)(actor);
+            // The pre-read keeps a missing row the usual 406, as for every other write.
+            await read(id);
+            // `maybeSingle`, not `single`: deleting nothing is the guard doing its job, not an error.
+            const { data, error } = await guard(buildDelete(supabase, options.table, id, organizationFilter))
+                .select('*')
+                .maybeSingle();
+            if (error)
+                throw (0, errors_1.mapPostgrestError)(error);
+            // The guard lost the race - the row is untouched, so there is nothing to audit.
+            if (!data)
+                return null;
+            const deleted = data;
+            await recordDelete(id, deleted);
+            return (0, exports.withoutInternalId)(deleted);
+        },
     };
 };
 exports.auditedTable = auditedTable;

package/dist/client.d.ts

@@ -4,6 +4,7 @@ import { AuditResource, type AuditErrorHandler } from './audit';
 import { AdditionalDetailsResource } from './additional-details';
 import { ClientsResource } from './clients';
 import { ConfigsResource } from './configs';
+import { DocumentsResource, DocumentTemplatesResource } from './documents';
 import { NotesResource } from './notes';
 import { NotificationsResource } from './notifications';
 import { BillingReadsResource } from './billing';
@@ -12,6 +13,7 @@ import { LabelsResource } from './labels';
 import { LeadsResource } from './leads';
 import { LeaveAdjustmentsResource, LeaveEntitlementsResource, LeaveRequestsResource, LeaveTypesResource } from './leave';
 import { OrganizationsResource } from './organizations';
+import { PaymentsResource } from './payments';
 import { PermissionsResource } from './permissions';
 import { ProjectsResource } from './projects';
 import { PublicHolidaysResource } from './public-holidays';
@@ -63,6 +65,10 @@ export declare class SupabaseClient {
     readonly clients: ClientsResource;
     readonly projects: ProjectsResource;
     readonly tasks: TasksResource;
+    readonly documentTemplates: DocumentTemplatesResource;
+    readonly documents: DocumentsResource;
+    /** Read only: a member reads the payments of what they can read; the webhook writes them. */
+    readonly payments: PaymentsResource;
     readonly leaveTypes: LeaveTypesResource;
     readonly publicHolidays: PublicHolidaysResource;
     readonly leaveEntitlements: LeaveEntitlementsResource;

package/dist/client.js

@@ -6,6 +6,7 @@ const audit_1 = require("./audit");
 const additional_details_1 = require("./additional-details");
 const clients_1 = require("./clients");
 const configs_1 = require("./configs");
+const documents_1 = require("./documents");
 const notes_1 = require("./notes");
 const notifications_1 = require("./notifications");
 const billing_1 = require("./billing");
@@ -14,6 +15,7 @@ const labels_1 = require("./labels");
 const leads_1 = require("./leads");
 const leave_1 = require("./leave");
 const organizations_1 = require("./organizations");
+const payments_1 = require("./payments");
 const permissions_1 = require("./permissions");
 const projects_1 = require("./projects");
 const public_holidays_1 = require("./public-holidays");
@@ -48,6 +50,10 @@ class SupabaseClient {
     clients;
     projects;
     tasks;
+    documentTemplates;
+    documents;
+    /** Read only: a member reads the payments of what they can read; the webhook writes them. */
+    payments;
     leaveTypes;
     publicHolidays;
     leaveEntitlements;
@@ -78,6 +84,9 @@ class SupabaseClient {
         this.leads = new leads_1.LeadsResource(this.supabase, this.auth, this.audit, this.additionalDetails);
         this.projects = new projects_1.ProjectsResource(this.supabase, this.auth, this.audit);
         this.tasks = new tasks_1.TasksResource(this.supabase, this.auth, this.audit);
+        this.documentTemplates = new documents_1.DocumentTemplatesResource(this.supabase, this.auth, this.audit);
+        this.documents = new documents_1.DocumentsResource(this.supabase, this.auth, this.audit);
+        this.payments = new payments_1.PaymentsResource(this.supabase, this.auth, this.audit);
         this.leaveTypes = new leave_1.LeaveTypesResource(this.supabase, this.auth, this.audit);
         // Global like configs: every signed-in caller reads the same calendar, nobody writes it here.
         this.publicHolidays = new public_holidays_1.PublicHolidaysResource(this.supabase);

package/dist/clients/dto.d.ts

@@ -1,5 +1,5 @@
 import type { UUID } from 'crypto';
-import type { ClientIdDto as ClientIdDtoType, CreateClientDto as CreateClientDtoType, GetClientsDto as GetClientsDtoType, StaffGetClientsDto as StaffGetClientsDtoType, UpdateClientDto as UpdateClientDtoType } from '@managemint-solutions/entities/clients/dto';
+import type { ClientIdDto as ClientIdDtoType, CreateClientDto as CreateClientDtoType, GetClientsDto as GetClientsDtoType, ClientBillingDetailsDto as ClientBillingDetailsDtoType, StaffGetClientsDto as StaffGetClientsDtoType, UpdateClientDto as UpdateClientDtoType } from '@managemint-solutions/entities/clients/dto';
 export declare class GetClientsDto implements Omit<GetClientsDtoType, 'status_id_in'> {
     readonly search?: string | null;
     readonly page: number;
@@ -16,7 +16,21 @@ export declare class StaffGetClientsDto extends GetClientsDto implements Omit<St
 export declare class ClientIdDto implements ClientIdDtoType {
     readonly clientId: string;
 }
-export declare class CreateClientDto implements CreateClientDtoType {
+/**
+ * What a document bills the client by - its address in the organization's shape, its
+ * registration and VAT numbers. Each optional on a create and a save: null clears, left out keeps.
+ */
+declare class ClientBillingDetailsDto implements ClientBillingDetailsDtoType {
+    readonly address_line_1?: string | null;
+    readonly address_line_2?: string | null;
+    readonly city?: string | null;
+    readonly state?: string | null;
+    readonly post_code?: string | null;
+    readonly country?: string | null;
+    readonly registration_number?: string | null;
+    readonly vat_number?: string | null;
+}
+export declare class CreateClientDto extends ClientBillingDetailsDto implements CreateClientDtoType {
     readonly name: string;
     readonly email: string | null;
     readonly phone: string | null;
@@ -24,7 +38,7 @@ export declare class CreateClientDto implements CreateClientDtoType {
     readonly contract_client: boolean;
     readonly contracted_hours: number | null;
 }
-export declare class UpdateClientDto implements UpdateClientDtoType {
+export declare class UpdateClientDto extends ClientBillingDetailsDto implements UpdateClientDtoType {
     readonly name: string;
     readonly email: string | null;
     readonly phone: string | null;
@@ -32,3 +46,4 @@ export declare class UpdateClientDto implements UpdateClientDtoType {
     readonly contract_client: boolean;
     readonly contracted_hours: number | null;
 }
+export {};

package/dist/clients/dto.js

@@ -97,7 +97,77 @@ __decorate([
     (0, class_validator_1.IsUUID)('7', { message: 'Invalid client ID format' }),
     __metadata("design:type", String)
 ], ClientIdDto.prototype, "clientId", void 0);
-class CreateClientDto {
+/**
+ * What a document bills the client by - its address in the organization's shape, its
+ * registration and VAT numbers. Each optional on a create and a save: null clears, left out keeps.
+ */
+class ClientBillingDetailsDto {
+    address_line_1;
+    address_line_2;
+    city;
+    state;
+    post_code;
+    country;
+    registration_number;
+    vat_number;
+}
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, validators_1.IsNullable)(),
+    (0, class_validator_1.MaxLength)(200, { message: 'Address line 1 cannot exceed 200 characters' }),
+    (0, class_validator_1.IsString)({ message: 'Address line 1 must be text' }),
+    __metadata("design:type", Object)
+], ClientBillingDetailsDto.prototype, "address_line_1", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, validators_1.IsNullable)(),
+    (0, class_validator_1.MaxLength)(200, { message: 'Address line 2 cannot exceed 200 characters' }),
+    (0, class_validator_1.IsString)({ message: 'Address line 2 must be text' }),
+    __metadata("design:type", Object)
+], ClientBillingDetailsDto.prototype, "address_line_2", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, validators_1.IsNullable)(),
+    (0, class_validator_1.MaxLength)(100, { message: 'City cannot exceed 100 characters' }),
+    (0, class_validator_1.IsString)({ message: 'City must be text' }),
+    __metadata("design:type", Object)
+], ClientBillingDetailsDto.prototype, "city", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, validators_1.IsNullable)(),
+    (0, class_validator_1.MaxLength)(100, { message: 'State cannot exceed 100 characters' }),
+    (0, class_validator_1.IsString)({ message: 'State must be text' }),
+    __metadata("design:type", Object)
+], ClientBillingDetailsDto.prototype, "state", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, validators_1.IsNullable)(),
+    (0, class_validator_1.MaxLength)(20, { message: 'Post code cannot exceed 20 characters' }),
+    (0, class_validator_1.IsString)({ message: 'Post code must be text' }),
+    __metadata("design:type", Object)
+], ClientBillingDetailsDto.prototype, "post_code", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, validators_1.IsNullable)(),
+    (0, class_validator_1.MaxLength)(100, { message: 'Country cannot exceed 100 characters' }),
+    (0, class_validator_1.IsString)({ message: 'Country must be text' }),
+    __metadata("design:type", Object)
+], ClientBillingDetailsDto.prototype, "country", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, validators_1.IsNullable)(),
+    (0, class_validator_1.MaxLength)(50, { message: 'Registration number cannot exceed 50 characters' }),
+    (0, class_validator_1.IsString)({ message: 'Registration number must be text' }),
+    __metadata("design:type", Object)
+], ClientBillingDetailsDto.prototype, "registration_number", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, validators_1.IsNullable)(),
+    (0, class_validator_1.MaxLength)(50, { message: 'VAT number cannot exceed 50 characters' }),
+    (0, class_validator_1.IsString)({ message: 'VAT number must be text' }),
+    __metadata("design:type", Object)
+], ClientBillingDetailsDto.prototype, "vat_number", void 0);
+class CreateClientDto extends ClientBillingDetailsDto {
     name;
     email;
     phone;
@@ -143,7 +213,7 @@ __decorate([
     (0, class_validator_1.Min)(0, { message: 'Contracted hours must be at least 0' }),
     __metadata("design:type", Object)
 ], CreateClientDto.prototype, "contracted_hours", void 0);
-class UpdateClientDto {
+class UpdateClientDto extends ClientBillingDetailsDto {
     name;
     email;
     phone;

package/dist/clients/index.js

@@ -57,6 +57,14 @@ const CLIENT_DETAIL_SELECT = `
         ),
         contract_client,
         contracted_hours,
+        address_line_1,
+        address_line_2,
+        city,
+        state,
+        post_code,
+        country,
+        registration_number,
+        vat_number,
         updated_at,
         last_updated_by:user_profiles!last_updated_by ${transforms_1.USER_PROFILE_EMBED},
         created_by:user_profiles!created_by ${transforms_1.USER_PROFILE_EMBED},
@@ -138,6 +146,14 @@ class ClientsResource {
                 status: null,
                 contract_client: false,
                 contracted_hours: 0,
+                address_line_1: null,
+                address_line_2: null,
+                city: null,
+                state: null,
+                post_code: null,
+                country: null,
+                registration_number: null,
+                vat_number: null,
             };
         }
         return data;

package/dist/documents/content.d.ts

@@ -0,0 +1,39 @@
+import type { UpdateDocumentDto as UpdateDocumentDtoType } from '@managemint-solutions/entities/documents/dto';
+/** The image types an image block may show - the image types supporting files accept. */
+export declare const IMAGE_EXTENSIONS: ReadonlySet<string>;
+/** The path `documents.createImageUploadUrl` hands out, relative to the organization's folder. */
+export declare const IMAGE_PATH: RegExp;
+/**
+ * A template's or document's variables: each `{ key, label, type, required, default_value }`,
+ * keys lower snake_case (1 to 40 characters), unique, never a system variable's, and a default
+ * that fits the type or null.
+ */
+export declare const variablesProblem: (variables: unknown) => string | null;
+/**
+ * A template's or document's blocks: each block's shape for its type, numbers in range, and every
+ * variable it uses - `{{key}}` in plain text, a variable node in rich text, a line's quantity or
+ * price - declared in `variables` or a system variable; `{{page_number}}` and `{{page_count}}` only
+ * in the header and footer, of which a document has at most one each, anywhere in the list.
+ */
+export declare const blocksProblem: (blocks: unknown, variables: unknown) => string | null;
+/**
+ * Filled-in values by variable key: each key a declared variable (system values are the api's to
+ * fill) and each value fitting its type - text, a number, whole cents 0 or more, a YYYY-MM-DD
+ * date. A variable with no value is simply left out.
+ */
+export declare const variableValuesProblem: (values: unknown, variables: unknown) => string | null;
+/** Three capital letters (ZAR), or nothing - unless a line items block needs one to print in. */
+export declare const currencyProblem: (currency: unknown, blocks: unknown) => string | null;
+/**
+ * Everything `UpdateDocumentDto` checks about a document's content, as one call - for a draft the
+ * api composes itself: `POST /documents` copies a template's variables and blocks and overlays the
+ * caller's values, which no DTO saw together. Null when the draft is sound.
+ */
+export declare const documentProblem: (document: Pick<UpdateDocumentDtoType, "variables" | "variable_values" | "blocks" | "currency">) => string | null;
+export declare const IsDocumentVariables: () => PropertyDecorator;
+export declare const IsDocumentBlocks: () => PropertyDecorator;
+export declare const IsDocumentVariableValues: () => PropertyDecorator;
+/** On a DTO with `blocks`, also required when they hold line items; `@IsOptional()` makes it a format check only. */
+export declare const IsDocumentCurrency: () => PropertyDecorator;
+export declare const IsDocumentCategory: () => PropertyDecorator;
+export declare const IsDocumentNumberPrefix: () => PropertyDecorator;