@managemint-solutions/sdk 0.56.0 → 0.65.0

package/dist/payments/index.js

@@ -0,0 +1,137 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PaymentsResource = void 0;
+const enum_1 = require("@managemint-solutions/entities/payments/enum");
+const enum_2 = require("@managemint-solutions/entities/audit-trail/enum");
+const audit_1 = require("../audit");
+const errors_1 = require("../errors");
+const tenancy_1 = require("../tenancy");
+const transforms_1 = require("../transforms");
+const PAYMENT_SELECT = `
+        mms_id,
+        created_at,
+        created_by:user_profiles!created_by ${transforms_1.USER_PROFILE_EMBED},
+        direction,
+        status,
+        amount_minor,
+        currency,
+        method,
+        reference,
+        payer_email,
+        paid_at
+      `;
+/**
+ * `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.
+ */
+class PaymentsResource {
+    supabase;
+    actor;
+    table;
+    constructor(supabase, actor, audit) {
+        this.supabase = supabase;
+        this.actor = actor;
+        this.table = (0, audit_1.auditedTable)(supabase, actor, audit, {
+            table: 'payments',
+            entityType: enum_2.AuditTrailEntityType.PAYMENTS,
+        });
+    }
+    /** The money received for one record, oldest first - paid rows only. */
+    async list(entityType, entityId) {
+        const { data, error } = await (0, tenancy_1.scopeToOrganization)(this.supabase.from('payments').select(PAYMENT_SELECT), this.actor)
+            .eq('entity_type', entityType)
+            .eq('entity_id', entityId)
+            .eq('status', enum_1.PaymentStatus.PAID)
+            .order('paid_at', { ascending: true });
+        if (error)
+            throw (0, errors_1.mapPostgrestError)(error);
+        return data;
+    }
+    /** How many paid payments each of `entityIds` has - one query for a page of a list. */
+    async paidCounts(entityType, entityIds) {
+        if (entityIds.length === 0)
+            return {};
+        const { data, error } = await (0, tenancy_1.scopeToOrganization)(this.supabase.from('payments').select('entity_id'), this.actor)
+            .eq('entity_type', entityType)
+            .eq('status', enum_1.PaymentStatus.PAID)
+            .in('entity_id', entityIds);
+        if (error)
+            throw (0, errors_1.mapPostgrestError)(error);
+        const counts = {};
+        for (const { entity_id } of (data ?? [])) {
+            counts[entity_id] = (counts[entity_id] ?? 0) + 1;
+        }
+        return counts;
+    }
+    /**
+     * 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.
+     */
+    async paidEntityIds(entityType) {
+        const { data, error } = await (0, tenancy_1.scopeToOrganization)(this.supabase.from('payments').select('entity_id'), this.actor)
+            .eq('entity_type', entityType)
+            .eq('status', enum_1.PaymentStatus.PAID);
+        if (error)
+            throw (0, errors_1.mapPostgrestError)(error);
+        return [...new Set((data ?? []).map((row) => row.entity_id))];
+    }
+    /** The record's open checkout, if one is under way. */
+    async findOpen(entityType, entityId) {
+        const { data, error } = await (0, tenancy_1.scopeToOrganization)(this.supabase.from('payments').select(`${PAYMENT_SELECT}, access_code`), this.actor)
+            .eq('entity_type', entityType)
+            .eq('entity_id', entityId)
+            .eq('status', enum_1.PaymentStatus.OPEN)
+            .maybeSingle();
+        if (error)
+            throw (0, errors_1.mapPostgrestError)(error);
+        return (data ?? null);
+    }
+    /** A payment by the provider's reference (unique), whatever its status. */
+    async findByReference(reference) {
+        const { data, error } = await (0, tenancy_1.scopeToOrganization)(this.supabase.from('payments').select(PAYMENT_SELECT), this.actor)
+            .eq('reference', reference)
+            .maybeSingle();
+        if (error)
+            throw (0, errors_1.mapPostgrestError)(error);
+        return (data ?? 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.
+     */
+    async create(row) {
+        await this.table.insert({
+            ...row,
+            organization_id: (0, tenancy_1.requireOrganization)(this.actor),
+            created_by: this.actor.mms_id,
+            created_at: new Date().toISOString(),
+        });
+    }
+    /**
+     * 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.
+     */
+    async removeManual(paymentId, entityType, entityId) {
+        const removed = await this.table.removeWhere(paymentId, (query) => query.eq('entity_type', entityType).eq('entity_id', entityId).eq('method', enum_1.PaymentMethod.EFT));
+        return removed !== null;
+    }
+    /** Settles an open checkout. False when it is no longer open (settled or replaced first). */
+    async settle(paymentId, row) {
+        const settled = await this.table.updateWhere(paymentId, (query) => query.eq('status', enum_1.PaymentStatus.OPEN), {
+            ...row,
+            status: enum_1.PaymentStatus.PAID,
+        });
+        return settled !== null;
+    }
+    /** Drops an open checkout Paystack says failed, so a new one can open. False when it moved on. */
+    async removeOpen(paymentId) {
+        const removed = await this.table.removeWhere(paymentId, (query) => query.eq('status', enum_1.PaymentStatus.OPEN));
+        return removed !== null;
+    }
+}
+exports.PaymentsResource = PaymentsResource;

package/dist/permissions/dto.d.ts

@@ -20,6 +20,10 @@ export declare class UpdatePermissionsDto implements UpdatePermissionsDtoType {
     readonly read_timesheets: boolean;
     readonly update_timesheets: boolean;
     readonly delete_timesheets: boolean;
+    readonly create_documents: boolean;
+    readonly read_documents: boolean;
+    readonly update_documents: boolean;
+    readonly delete_documents: boolean;
     readonly create_leave: boolean;
     readonly read_leave: boolean;
     readonly update_leave: boolean;

package/dist/permissions/dto.js

@@ -42,14 +42,10 @@ class UpdatePermissionsDto {
     read_timesheets;
     update_timesheets;
     delete_timesheets;
-    // @IsBoolean({ message: 'Create Documents must be a boolean' })
-    // readonly create_documents!: boolean;
-    // @IsBoolean({ message: 'Read Documents must be a boolean' })
-    // readonly read_documents!: boolean;
-    // @IsBoolean({ message: 'Update Documents must be a boolean' })
-    // readonly update_documents!: boolean;
-    // @IsBoolean({ message: 'Delete Documents must be a boolean' })
-    // readonly delete_documents!: boolean;
+    create_documents;
+    read_documents;
+    update_documents;
+    delete_documents;
     create_leave;
     read_leave;
     update_leave;
@@ -192,6 +188,22 @@ __decorate([
     (0, class_validator_1.IsBoolean)({ message: 'Delete Timesheets must be a boolean' }),
     __metadata("design:type", Boolean)
 ], UpdatePermissionsDto.prototype, "delete_timesheets", void 0);
+__decorate([
+    (0, class_validator_1.IsBoolean)({ message: 'Create Documents must be a boolean' }),
+    __metadata("design:type", Boolean)
+], UpdatePermissionsDto.prototype, "create_documents", void 0);
+__decorate([
+    (0, class_validator_1.IsBoolean)({ message: 'Read Documents must be a boolean' }),
+    __metadata("design:type", Boolean)
+], UpdatePermissionsDto.prototype, "read_documents", void 0);
+__decorate([
+    (0, class_validator_1.IsBoolean)({ message: 'Update Documents must be a boolean' }),
+    __metadata("design:type", Boolean)
+], UpdatePermissionsDto.prototype, "update_documents", void 0);
+__decorate([
+    (0, class_validator_1.IsBoolean)({ message: 'Delete Documents must be a boolean' }),
+    __metadata("design:type", Boolean)
+], UpdatePermissionsDto.prototype, "delete_documents", void 0);
 __decorate([
     (0, class_validator_1.IsBoolean)({ message: 'Create Leave must be a boolean' }),
     __metadata("design:type", Boolean)

package/dist/service-client/index.d.ts

@@ -4,6 +4,7 @@ import { BillingResource } from '../billing';
 import { InvoicesResource } from '../billing/invoices';
 import { ClientsResource } from '../clients';
 import { ConfigsResource } from '../configs';
+import { DocumentsResource } from '../documents';
 import { EmulationHandshakesResource } from '../emulation-handshakes';
 import { FeatureRequestsResource } from '../feature-requests';
 import { LeaveEntitlementsResource, LeaveRequestsResource, LeaveTypesResource } from '../leave';
@@ -11,11 +12,13 @@ import { NotificationsOutboxResource } from '../notifications';
 import { OrganizationInvitesResource } from '../organization-invites';
 import { OrganizationPaymentMethodsResource, type PaymentMethodLookupColumn } from '../organization-payment-methods';
 import { OrganizationsResource, OrganizationSignupResource } from '../organizations';
+import { PaymentsResource } from '../payments';
 import { PermissionsResource } from '../permissions';
 import { StaffPermissionsResource, StaffResource } from '../staff';
 import { SupportingFilesResource } from '../supporting-files';
 import { UserApiCredentialsResource } from '../user-api-credentials';
 import { UsersResource } from '../users';
+import { VisibilityResource } from '../visibility';
 import { WebhookEventsResource } from '../webhook-events';
 export type SupabaseServiceClientConfig = {
     url: string;
@@ -34,6 +37,13 @@ export declare class SupabaseOrganizationScope {
     readonly actor: AuditActor;
     readonly audit: AuditResource;
     readonly billing: BillingResource;
+    /**
+     * For the public pay page, which has no caller (the document behind a pay link, and its PDF),
+     * the Paystack webhook, and the daily send cap, which counts private documents too.
+     */
+    readonly documents: DocumentsResource;
+    /** Money received: written here alone, by the Paystack webhook. */
+    readonly payments: PaymentsResource;
     readonly invoices: InvoicesResource;
     readonly invites: OrganizationInvitesResource;
     readonly leaveTypes: LeaveTypesResource;
@@ -45,6 +55,8 @@ export declare class SupabaseOrganizationScope {
     /** For the admin api's staff downloads: Storage's read policy names no staff, the service role passes it. */
     readonly supportingFiles: SupportingFilesResource;
     readonly users: UsersResource;
+    /** Who private records are shared with: listed and written here, after the api's own checks. */
+    readonly visibility: VisibilityResource;
     constructor(supabase: TypedSupabaseClient, actor: AuditActor, onAuditError?: AuditErrorHandler);
     /**
      * An audited table bound to this organization and actor - the shape the api hand-rolls today
@@ -52,6 +64,18 @@ export declare class SupabaseOrganizationScope {
      * subscriptions and both webhook handler services.
      */
     table(options: AuditedTableOptions): AuditedTable;
+    /**
+     * The organization's templates whose `column` starts with `start` (literally, any case),
+     * private and archived ones included. Service role because both columns are unique across the
+     * whole organization (`uq_document_templates_organization_name`,
+     * `uq_document_templates_organization_prefix`) while a caller reads only the templates shared
+     * with them.
+     */
+    templatesStartingWith(column: 'name' | 'number_prefix', start: string): Promise<{
+        mms_id: string;
+        name: string;
+        number_prefix: string;
+    }[]>;
     /**
      * Gives `userId` a new leave calendar feed token (stored as its SHA-256), which also retires
      * any address they subscribed with before. Service role only: the token is a credential.
@@ -153,6 +177,26 @@ export declare class SupabaseServiceClient {
         user_id: string;
         organization_id: string;
     } | null>;
+    /**
+     * The recurring parents due a draft: not paused, not ended, `repeat_next_at` on or before
+     * `onOrBefore` (YYYY-MM-DD). Across every organization, like the leave rollover's tenants - the
+     * cron then works inside each row's own organization.
+     */
+    documentsDueForDraft(onOrBefore: string): Promise<{
+        mms_id: string;
+        organization_id: string;
+    }[]>;
+    /** The drafts due to issue: `issue_at` on or before `onOrBefore`, across every organization. */
+    documentsDueToIssue(onOrBefore: string): Promise<{
+        mms_id: string;
+        organization_id: string;
+    }[]>;
+    /**
+     * Which organization a document belongs to, by its id alone. Unscoped by necessity, like the
+     * calendar feed: a public pay link (whose signature the api has checked) names only the
+     * document, and the row is what says which tenant it belongs to.
+     */
+    findDocumentOrganization(documentId: string): Promise<string | null>;
     /**
      * Deletes every audit row written before `cutoff` and says how many went - the daily
      * retention cron. Every tenant at once: the period is the same for all of them. Batched by

package/dist/service-client/index.js

@@ -4,10 +4,12 @@ exports.createSupabaseServiceClient = exports.SupabaseServiceClient = exports.Su
 const auth_1 = require("../auth");
 const audit_1 = require("../audit");
 const enum_1 = require("@managemint-solutions/entities/audit-trail/enum");
+const enum_2 = require("@managemint-solutions/entities/documents/enum");
 const billing_1 = require("../billing");
 const invoices_1 = require("../billing/invoices");
 const clients_1 = require("../clients");
 const configs_1 = require("../configs");
+const documents_1 = require("../documents");
 const emulation_handshakes_1 = require("../emulation-handshakes");
 const feature_requests_1 = require("../feature-requests");
 const leave_1 = require("../leave");
@@ -16,11 +18,13 @@ const errors_1 = require("../errors");
 const organization_invites_1 = require("../organization-invites");
 const organization_payment_methods_1 = require("../organization-payment-methods");
 const organizations_1 = require("../organizations");
+const payments_1 = require("../payments");
 const permissions_1 = require("../permissions");
 const staff_1 = require("../staff");
 const supporting_files_1 = require("../supporting-files");
 const user_api_credentials_1 = require("../user-api-credentials");
 const users_1 = require("../users");
+const visibility_1 = require("../visibility");
 const webhook_events_1 = require("../webhook-events");
 /**
  * The organization-scoped half of the service client. Everything here is attributed to one
@@ -32,6 +36,13 @@ class SupabaseOrganizationScope {
     actor;
     audit;
     billing;
+    /**
+     * For the public pay page, which has no caller (the document behind a pay link, and its PDF),
+     * the Paystack webhook, and the daily send cap, which counts private documents too.
+     */
+    documents;
+    /** Money received: written here alone, by the Paystack webhook. */
+    payments;
     invoices;
     invites;
     leaveTypes;
@@ -43,11 +54,15 @@ class SupabaseOrganizationScope {
     /** For the admin api's staff downloads: Storage's read policy names no staff, the service role passes it. */
     supportingFiles;
     users;
+    /** Who private records are shared with: listed and written here, after the api's own checks. */
+    visibility;
     constructor(supabase, actor, onAuditError) {
         this.supabase = supabase;
         this.actor = actor;
         this.audit = new audit_1.AuditResource(supabase, actor, onAuditError);
         this.billing = new billing_1.BillingResource(supabase, actor, this.audit);
+        this.documents = new documents_1.DocumentsResource(supabase, actor, this.audit);
+        this.payments = new payments_1.PaymentsResource(supabase, actor, this.audit);
         this.invoices = new invoices_1.InvoicesResource(supabase, actor, this.audit);
         this.invites = new organization_invites_1.OrganizationInvitesResource(supabase, actor);
         // The leave-year rollover writes next period's entitlements as the system (`mms_id: null`).
@@ -59,6 +74,7 @@ class SupabaseOrganizationScope {
         this.permissions = new permissions_1.PermissionsResource(supabase, actor, this.audit);
         this.supportingFiles = new supporting_files_1.SupportingFilesResource(supabase, actor, this.audit);
         this.users = new users_1.UsersResource(supabase, actor, this.audit);
+        this.visibility = new visibility_1.VisibilityResource(supabase, actor, this.audit);
     }
     /**
      * An audited table bound to this organization and actor - the shape the api hand-rolls today
@@ -68,6 +84,23 @@ class SupabaseOrganizationScope {
     table(options) {
         return (0, audit_1.auditedTable)(this.supabase, this.actor, this.audit, options);
     }
+    /**
+     * The organization's templates whose `column` starts with `start` (literally, any case),
+     * private and archived ones included. Service role because both columns are unique across the
+     * whole organization (`uq_document_templates_organization_name`,
+     * `uq_document_templates_organization_prefix`) while a caller reads only the templates shared
+     * with them.
+     */
+    async templatesStartingWith(column, start) {
+        const { data, error } = await this.supabase
+            .from('document_templates')
+            .select('mms_id, name, number_prefix')
+            .eq('organization_id', this.actor.organization_id)
+            .ilike(column, `${start.replace(/[\\%_]/g, '\\$&')}%`);
+        if (error)
+            throw (0, errors_1.mapPostgrestError)(error);
+        return (data ?? []);
+    }
     /**
      * Gives `userId` a new leave calendar feed token (stored as its SHA-256), which also retires
      * any address they subscribed with before. Service role only: the token is a credential.
@@ -266,6 +299,50 @@ class SupabaseServiceClient {
             throw (0, errors_1.mapPostgrestError)(error);
         return (data ?? null);
     }
+    /**
+     * The recurring parents due a draft: not paused, not ended, `repeat_next_at` on or before
+     * `onOrBefore` (YYYY-MM-DD). Across every organization, like the leave rollover's tenants - the
+     * cron then works inside each row's own organization.
+     */
+    async documentsDueForDraft(onOrBefore) {
+        const { data, error } = await this.supabase
+            .from('documents')
+            .select('mms_id, organization_id')
+            .not('repeat', 'is', null)
+            .eq('repeat_paused', false)
+            .eq('status', enum_2.DocumentStatus.DRAFT)
+            .lte('repeat_next_at', onOrBefore);
+        if (error)
+            throw (0, errors_1.mapPostgrestError)(error);
+        return (data ?? []);
+    }
+    /** The drafts due to issue: `issue_at` on or before `onOrBefore`, across every organization. */
+    async documentsDueToIssue(onOrBefore) {
+        const { data, error } = await this.supabase
+            .from('documents')
+            .select('mms_id, organization_id')
+            .eq('status', enum_2.DocumentStatus.DRAFT)
+            .is('repeat', null)
+            .lte('issue_at', onOrBefore);
+        if (error)
+            throw (0, errors_1.mapPostgrestError)(error);
+        return (data ?? []);
+    }
+    /**
+     * Which organization a document belongs to, by its id alone. Unscoped by necessity, like the
+     * calendar feed: a public pay link (whose signature the api has checked) names only the
+     * document, and the row is what says which tenant it belongs to.
+     */
+    async findDocumentOrganization(documentId) {
+        const { data, error } = await this.supabase
+            .from('documents')
+            .select('organization_id')
+            .eq('mms_id', documentId)
+            .maybeSingle();
+        if (error)
+            throw (0, errors_1.mapPostgrestError)(error);
+        return data?.organization_id ?? null;
+    }
     /**
      * Deletes every audit row written before `cutoff` and says how many went - the daily
      * retention cron. Every tenant at once: the period is the same for all of them. Batched by

package/dist/staff-client.d.ts

@@ -3,6 +3,7 @@ import { AuditResource } from './audit';
 import { AdditionalDetailsResource } from './additional-details';
 import type { SupabaseClientConfig, TypedSupabaseClient } from './client';
 import { ClientsResource } from './clients';
+import { DocumentsResource, DocumentTemplatesResource } from './documents';
 import { LeadsResource } from './leads';
 import { NotesResource } from './notes';
 import { OrganizationsResource } from './organizations';
@@ -31,6 +32,8 @@ export declare class SupabaseStaffClient {
     readonly notes: NotesResource;
     readonly projects: ProjectsResource;
     readonly tasks: TasksResource;
+    readonly documentTemplates: DocumentTemplatesResource;
+    readonly documents: DocumentsResource;
     readonly users: UsersResource;
     readonly organizations: OrganizationsResource;
     readonly staff: StaffResource;

package/dist/staff-client.js

@@ -5,6 +5,7 @@ const auth_1 = require("./auth");
 const audit_1 = require("./audit");
 const additional_details_1 = require("./additional-details");
 const clients_1 = require("./clients");
+const documents_1 = require("./documents");
 const leads_1 = require("./leads");
 const notes_1 = require("./notes");
 const organizations_1 = require("./organizations");
@@ -30,6 +31,8 @@ class SupabaseStaffClient {
     notes;
     projects;
     tasks;
+    documentTemplates;
+    documents;
     users;
     organizations;
     staff;
@@ -47,6 +50,8 @@ class SupabaseStaffClient {
         this.notes = new notes_1.NotesResource(this.supabase, auth, this.audit);
         this.projects = new projects_1.ProjectsResource(this.supabase, auth, this.audit);
         this.tasks = new tasks_1.TasksResource(this.supabase, auth, this.audit);
+        this.documentTemplates = new documents_1.DocumentTemplatesResource(this.supabase, auth, this.audit);
+        this.documents = new documents_1.DocumentsResource(this.supabase, auth, this.audit);
         this.users = new users_1.UsersResource(this.supabase, auth, this.audit);
         this.organizations = new organizations_1.OrganizationsResource(this.supabase, auth, this.audit);
         this.staff = new staff_1.StaffResource(this.supabase);

package/dist/supporting-files/index.js

@@ -24,8 +24,6 @@ const tenancy_1 = require("../tenancy");
 const paths_1 = require("./paths");
 __exportStar(require("./dto"), exports);
 __exportStar(require("./paths"), exports);
-/** Storage bucket every supporting file lives in. */
-const BUCKET = 'supporting-files';
 /** How long a presigned download URL stays valid. */
 const SIGNED_URL_TTL_SECONDS = 300;
 /** Storage calls per file (minting an upload URL, checking an object) run concurrently in batches of this size. */
@@ -73,7 +71,7 @@ class SupportingFilesResource {
         if (error)
             throw (0, errors_1.mapPostgrestError)(error);
         const { data: signed, error: signedError } = await this.supabase.storage
-            .from(BUCKET)
+            .from(paths_1.SUPPORTING_FILES_BUCKET)
             .createSignedUrl((0, paths_1.storagePath)(data.organization_id, data.entity_type, data.entity_id, data.name, data.extension), SIGNED_URL_TTL_SECONDS);
         if (signedError)
             throw (0, errors_1.mapStorageError)(signedError);
@@ -112,7 +110,7 @@ class SupportingFilesResource {
         for (let index = 0; index < files.length; index += BATCH_SIZE) {
             targets.push(...(await Promise.all(files.slice(index, index + BATCH_SIZE).map(async ({ name, extension, path }) => {
                 const { data, error } = await this.supabase.storage
-                    .from(BUCKET)
+                    .from(paths_1.SUPPORTING_FILES_BUCKET)
                     .createSignedUploadUrl(path, { upsert: true });
                 if (error) {
                     throw (0, errors_1.mapStorageError)(error, `Failed to prepare upload: ${fileNameOf({ name, extension })}`);
@@ -134,7 +132,7 @@ class SupportingFilesResource {
             await Promise.all(files.slice(index, index + BATCH_SIZE).map(async ({ name, extension, path }) => {
                 // A missing object comes back as `data: false` (storage-js keeps the 404 in `error`);
                 // any other failure is thrown by storage-js itself.
-                const { data: present } = await this.supabase.storage.from(BUCKET).exists(path);
+                const { data: present } = await this.supabase.storage.from(paths_1.SUPPORTING_FILES_BUCKET).exists(path);
                 if (!present) {
                     throw new errors_1.SupabaseClientError({
                         status: 400,
@@ -171,7 +169,7 @@ class SupportingFilesResource {
         // The row goes first - the helper's pre-read hands back what the object path is built from.
         const data = await this.table.remove(supportingFileId);
         const { error: storageError } = await this.supabase.storage
-            .from(BUCKET)
+            .from(paths_1.SUPPORTING_FILES_BUCKET)
             .remove([
             (0, paths_1.storagePath)((0, tenancy_1.requireOrganization)(this.auth), data.entity_type, data.entity_id, data.name, data.extension),
         ]);

package/dist/supporting-files/paths.d.ts

@@ -1,3 +1,5 @@
+/** Storage bucket every supporting file lives in, and every document image. */
+export declare const SUPPORTING_FILES_BUCKET = "supporting-files";
 /**
  * The client-supplied file name, checked before it is allowed anywhere near an object key.
  *

package/dist/supporting-files/paths.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.storagePath = exports.splitFileName = exports.sanitizeFileName = void 0;
+exports.storagePath = exports.splitFileName = exports.sanitizeFileName = exports.SUPPORTING_FILES_BUCKET = void 0;
 const errors_1 = require("../errors");
+/** Storage bucket every supporting file lives in, and every document image. */
+exports.SUPPORTING_FILES_BUCKET = 'supporting-files';
 /** Longest object-key segment a file name may become. */
 const MAX_FILE_NAME_LENGTH = 255;
 /** What a file name may be made of - no separators, no control characters, no leading dot. */

package/dist/validators.d.ts

@@ -26,3 +26,15 @@ export declare function IsNullable(validationOptions?: ValidationOptions): Prope
  * blank submission tripping it. Goes above `IsNullable()`, which then skips the rules.
  */
 export declare function EmptyToNull(): PropertyDecorator;
+/**
+ * Whitespace on either side of a pasted value is not part of the answer. Trimming here rather
+ * than in the api means the rules measure what will actually be stored - a name of three spaces
+ * is empty, not three characters long. Goes above `EmptyToNull()`, so a blank box becomes null.
+ */
+export declare function Trim(): PropertyDecorator;
+/**
+ * A class-validator decorator from a check that returns the first problem it finds, or null. The
+ * problem is the message, so a 400 always says exactly what is wrong and where. `object` is the
+ * DTO being validated, for a check that reads a sibling field.
+ */
+export declare const fromProblem: (name: string, problem: (value: unknown, object: Record<string, unknown>) => string | null) => () => PropertyDecorator;

package/dist/validators.js

@@ -6,9 +6,10 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MatchesPasswordRules = exports.IsClockTime = exports.isClockTime = exports.IsCalendarDate = exports.isCalendarDate = void 0;
+exports.fromProblem = exports.MatchesPasswordRules = exports.IsClockTime = exports.isClockTime = exports.IsCalendarDate = exports.isCalendarDate = void 0;
 exports.IsNullable = IsNullable;
 exports.EmptyToNull = EmptyToNull;
+exports.Trim = Trim;
 const class_validator_1 = require("class-validator");
 const class_transformer_1 = require("class-transformer");
 const CALENDAR_DATE = /^\d{4}-\d{2}-\d{2}$/;
@@ -72,3 +73,24 @@ function IsNullable(validationOptions) {
 function EmptyToNull() {
     return (0, class_transformer_1.Transform)(({ value }) => (value === '' ? null : value), { toClassOnly: true });
 }
+/**
+ * Whitespace on either side of a pasted value is not part of the answer. Trimming here rather
+ * than in the api means the rules measure what will actually be stored - a name of three spaces
+ * is empty, not three characters long. Goes above `EmptyToNull()`, so a blank box becomes null.
+ */
+function Trim() {
+    return (0, class_transformer_1.Transform)(({ value }) => (typeof value === 'string' ? value.trim() : value), { toClassOnly: true });
+}
+/**
+ * A class-validator decorator from a check that returns the first problem it finds, or null. The
+ * problem is the message, so a 400 always says exactly what is wrong and where. `object` is the
+ * DTO being validated, for a check that reads a sibling field.
+ */
+const fromProblem = (name, problem) => () => (0, class_validator_1.ValidateBy)({
+    name,
+    validator: {
+        validate: (value, args) => problem(value, args?.object) === null,
+        defaultMessage: (args) => problem(args?.value, args?.object) ?? 'Invalid value',
+    },
+});
+exports.fromProblem = fromProblem;

package/dist/visibility/dto.d.ts

@@ -0,0 +1,15 @@
+import { DocumentVisibility } from '@managemint-solutions/entities/documents/enum';
+import type { UpdateVisibilityDto as UpdateVisibilityDtoType } from '@managemint-solutions/entities/visibility/dto';
+import { VisibilityRole } from '@managemint-solutions/entities/visibility/enum';
+/**
+ * A record's setting and its whole share list, replaced together. That the people belong to the
+ * organization and the creator is not among them is the api's check (the composite key refuses
+ * another organization's user too).
+ */
+export declare class UpdateVisibilityDto implements UpdateVisibilityDtoType {
+    readonly visibility: DocumentVisibility;
+    readonly shares: {
+        user_id: string;
+        role: VisibilityRole;
+    }[];
+}