@managemint-solutions/sdk 0.68.0 → 0.69.0

package/dist/additional-details/dto.d.ts

@@ -1,5 +1,5 @@
 import { type ValidationOptions } from 'class-validator';
-import type { AddAdditionalDetailsDto as AddAdditionalDetailsDtoType, AdditionalDetailsIdDto as AdditionalDetailsIdDtoType, GetAdditionalDetailsDto as GetAdditionalDetailsDtoType, UpdateAdditionalDetailsDto as UpdateAdditionalDetailsDtoType } from '@managemint-solutions/entities/additional-details/dto';
+import type { AddAdditionalDetailsDto as AddAdditionalDetailsDtoType, AdditionalDetailsIdDto as AdditionalDetailsIdDtoType, GetAdditionalDetailsDto as GetAdditionalDetailsDtoType, GetAllAdditionalDetailsDto as GetAllAdditionalDetailsDtoType, UpdateAdditionalDetailsDto as UpdateAdditionalDetailsDtoType } from '@managemint-solutions/entities/additional-details/dto';
 import { AdditionalDetailsEntityTypes, AdditionalDetailsTypes } from '@managemint-solutions/entities/additional-details/enum';
 /** Validates `value` against the sibling `type` property (the discriminator). */
 export declare function IsAdditionalDetailsValueByType(typeProperty: string, validationOptions?: ValidationOptions): (object: object, propertyName: string) => void;
@@ -22,3 +22,11 @@ export declare class UpdateAdditionalDetailsDto implements UpdateAdditionalDetai
     readonly type: AdditionalDetailsTypes;
     readonly copyable: boolean;
 }
+/** The admin api's GET /additional-details: every organization's additional details, a page at a time. */
+export declare class GetAllAdditionalDetailsDto implements GetAllAdditionalDetailsDtoType {
+    readonly page: number;
+    readonly page_size: number;
+    readonly organization_id?: string | null;
+    readonly entity_type?: AdditionalDetailsEntityTypes | null;
+    readonly search?: string | null;
+}

package/dist/additional-details/dto.js

@@ -9,10 +9,12 @@ 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.UpdateAdditionalDetailsDto = exports.AddAdditionalDetailsDto = exports.GetAdditionalDetailsDto = exports.AdditionalDetailsIdDto = void 0;
+exports.GetAllAdditionalDetailsDto = exports.UpdateAdditionalDetailsDto = exports.AddAdditionalDetailsDto = exports.GetAdditionalDetailsDto = exports.AdditionalDetailsIdDto = void 0;
 exports.IsAdditionalDetailsValueByType = IsAdditionalDetailsValueByType;
 const class_validator_1 = require("class-validator");
+const class_transformer_1 = require("class-transformer");
 const enum_1 = require("@managemint-solutions/entities/additional-details/enum");
+const validators_1 = require("../validators");
 /** Validates `value` against the sibling `type` property (the discriminator). */
 function IsAdditionalDetailsValueByType(typeProperty, validationOptions) {
     return function (object, propertyName) {
@@ -141,3 +143,46 @@ __decorate([
     (0, class_validator_1.IsBoolean)({ message: 'Invalid copyable value' }),
     __metadata("design:type", Boolean)
 ], UpdateAdditionalDetailsDto.prototype, "copyable", void 0);
+/** The admin api's GET /additional-details: every organization's additional details, a page at a time. */
+class GetAllAdditionalDetailsDto {
+    page = 1;
+    page_size = 25;
+    organization_id;
+    entity_type;
+    search;
+}
+exports.GetAllAdditionalDetailsDto = GetAllAdditionalDetailsDto;
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_transformer_1.Transform)(({ value }) => (value ? Number(value) : 1), { toClassOnly: true }),
+    (0, class_validator_1.IsNumber)({}, { message: 'Page must be a number' }),
+    (0, class_validator_1.Min)(1, { message: 'Page must be at least 1' }),
+    __metadata("design:type", Number)
+], GetAllAdditionalDetailsDto.prototype, "page", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_transformer_1.Transform)(({ value }) => (value ? Number(value) : 25), { toClassOnly: true }),
+    (0, class_validator_1.IsNumber)({}, { message: 'Page size must be a number' }),
+    (0, class_validator_1.Min)(1, { message: 'Page size must be at least 1' }),
+    (0, class_validator_1.Max)(100, { message: 'Page size cannot exceed 100' }),
+    __metadata("design:type", Number)
+], GetAllAdditionalDetailsDto.prototype, "page_size", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, validators_1.IsNullable)(),
+    (0, class_validator_1.IsUUID)('7', { message: 'Invalid organization ID format' }),
+    __metadata("design:type", Object)
+], GetAllAdditionalDetailsDto.prototype, "organization_id", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, validators_1.IsNullable)(),
+    (0, class_validator_1.IsEnum)(enum_1.AdditionalDetailsEntityTypes, { message: 'Invalid record type' }),
+    __metadata("design:type", Object)
+], GetAllAdditionalDetailsDto.prototype, "entity_type", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, validators_1.IsNullable)(),
+    (0, class_validator_1.IsString)({ message: 'Invalid search' }),
+    (0, class_validator_1.MaxLength)(200, { message: 'Search cannot exceed 200 characters' }),
+    __metadata("design:type", Object)
+], GetAllAdditionalDetailsDto.prototype, "search", void 0);

package/dist/additional-details/index.d.ts

@@ -1,10 +1,13 @@
 import type { AdditionalDetailSummary, AdditionalDetailsEntity } from '@managemint-solutions/entities/additional-details';
+import type { StaffAdditionalDetailRow } from '@managemint-solutions/entities/additional-details';
+import type { MmsList } from '@managemint-solutions/entities/common';
 import type { AddAdditionalDetailsDto, UpdateAdditionalDetailsDto } from '@managemint-solutions/entities/additional-details/dto';
 import { AdditionalDetailsEntityTypes } from '@managemint-solutions/entities/additional-details/enum';
 import type { ClientContext } from '../auth';
 import { type AuditResource } from '../audit';
 import type { TypedSupabaseClient } from '../client';
 export * from './dto';
+import type { GetAllAdditionalDetailsDto } from './dto';
 export * from './values';
 export declare class AdditionalDetailsResource {
     private readonly supabase;
@@ -13,6 +16,11 @@ export declare class AdditionalDetailsResource {
     constructor(supabase: TypedSupabaseClient, auth: ClientContext, audit: AuditResource);
     getById(additionalDetailsId: string): Promise<AdditionalDetailsEntity>;
     list(entity: AdditionalDetailsEntityTypes, entityId: string): Promise<AdditionalDetailSummary[]>;
+    /**
+     * The admin portal's Additional Details list: every detail on a record type in `entityTypes`,
+     * across the organizations staff can see, newest first, its value cast by its type.
+     */
+    listAll(query: GetAllAdditionalDetailsDto, entityTypes: string[]): Promise<MmsList<StaffAdditionalDetailRow>>;
     create(entity: AdditionalDetailsEntityTypes, entityId: string, input: AddAdditionalDetailsDto): Promise<AdditionalDetailsEntity>;
     update(additionalDetailsId: string, input: UpdateAdditionalDetailsDto): Promise<AdditionalDetailsEntity>;
     remove(additionalDetailsId: string): Promise<void>;

package/dist/additional-details/index.js

@@ -20,6 +20,7 @@ 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 won_1 = require("../leads/won");
 const values_1 = require("./values");
 __exportStar(require("./dto"), exports);
@@ -30,6 +31,7 @@ __exportStar(require("./values"), exports);
 // column, and castValueByType turns it into the string | number | boolean | Date | URL union the
 // entity declares.
 const ADDITIONAL_DETAILS_SELECT = 'mms_id, created_at, created_by:user_profiles!created_by(*), updated_at, last_updated_by:user_profiles!last_updated_by(*), key, value, type, copyable';
+const ADDITIONAL_DETAILS_LIST_SELECT = 'mms_id, created_at, key, value, type, copyable, entity_type, entity_id, created_by:user_profiles!created_by(*), organization:organizations!organization_id(mms_id, name)';
 const ADDITIONAL_DETAILS_SUMMARY_SELECT = 'mms_id, key, value, type, copyable';
 const withCastValue = (detail) => ({
     ...detail,
@@ -64,6 +66,16 @@ class AdditionalDetailsResource {
             throw (0, errors_1.mapPostgrestError)(error);
         return data.map(withCastValue);
     }
+    /**
+     * The admin portal's Additional Details list: every detail on a record type in `entityTypes`,
+     * across the organizations staff can see, newest first, its value cast by its type.
+     */
+    async listAll(query, entityTypes) {
+        const { data, error, count } = await (0, tenancy_1.filterStaffList)(this.supabase.from('additional_details').select(ADDITIONAL_DETAILS_LIST_SELECT, { count: 'exact' }), query, ['key', 'value'], entityTypes).order('created_at', { ascending: false });
+        if (error)
+            throw (0, errors_1.mapPostgrestError)(error);
+        return (0, transforms_1.toMmsList)((data ?? []).map(withCastValue), query.page, query.page_size, count);
+    }
     async create(entity, entityId, input) {
         const organizationId = (0, tenancy_1.requireOrganization)(this.auth);
         if (entity === enum_1.AdditionalDetailsEntityTypes.LEAD) {

package/dist/audit/index.d.ts

@@ -2,6 +2,7 @@ import type { SupabaseClient as SupabaseJsClient } from '@supabase/supabase-js';
 import type { AuditTrailEntity } from '@managemint-solutions/entities/audit-trail';
 import { AuditTrailAction, type AuditTrailEntityType } from '@managemint-solutions/entities/audit-trail/enum';
 import type { MmsList } from '@managemint-solutions/entities/common';
+import type { RecordReference } from '@managemint-solutions/entities/audit-trail';
 import type { StaffContext } from '../auth';
 import type { GetAuditTrailDto } from './dto';
 export * from './dto';
@@ -130,6 +131,11 @@ export declare class AuditResource {
      * deleted - is simply absent, and the caller says so.
      */
     names(ids: Partial<Record<AuditNameTable, string[]>>): Promise<Record<string, string>>;
+    /** The record each `{ entity_type, entity_id }` names, keyed by its id; a type with no source is left out. */
+    references(rows: {
+        entity_type: string;
+        entity_id: string;
+    }[]): Promise<Record<string, RecordReference>>;
 }
 /**
  * One record's history: the rows about the record itself and every row that hangs off it (a

package/dist/audit/index.js

@@ -175,6 +175,37 @@ const NAME_SOURCES = {
         name: (row) => String(row.name),
     },
 };
+/** How each record type a note, detail or file hangs off is named, read in one query per type. */
+const REFERENCE_SOURCES = {
+    leads: { from: 'leads', select: 'mms_id, name', reference: (row) => ({ name: String(row.name), leave_type_id: null }) },
+    clients: { from: 'clients', select: 'mms_id, name', reference: (row) => ({ name: String(row.name), leave_type_id: null }) },
+    projects: { from: 'projects', select: 'mms_id, name', reference: (row) => ({ name: String(row.name), leave_type_id: null }) },
+    tasks: { from: 'tasks', select: 'mms_id, name', reference: (row) => ({ name: String(row.name), leave_type_id: null }) },
+    leave_requests: {
+        from: 'leave_requests',
+        select: 'mms_id, start_date, user:users!user_id(name, surname), leave_type:leave_types!leave_type_id(name)',
+        reference: (row) => ({ name: `${personOf(row)}, ${nameOf(row.leave_type)} from ${String(row.start_date)}`, leave_type_id: null }),
+    },
+    leave_entitlements: {
+        from: 'leave_entitlements',
+        select: 'mms_id, leave_type_id, user:users!user_id(name, surname), leave_type:leave_types!leave_type_id(name)',
+        reference: (row) => ({ name: `${personOf(row)}, ${nameOf(row.leave_type)}`, leave_type_id: row.leave_type_id }),
+    },
+    inventory_items: { from: 'inventory_items', select: 'mms_id, name', reference: (row) => ({ name: String(row.name), leave_type_id: null }) },
+    inventory_locations: { from: 'inventory_locations', select: 'mms_id, name', reference: (row) => ({ name: String(row.name), leave_type_id: null }) },
+    inventory_transfers: {
+        from: 'inventory_transfers',
+        select: 'mms_id, from_location:inventory_locations!from_location_id(name), to_location:inventory_locations!to_location_id(name)',
+        reference: (row) => ({ name: `${nameOf(row.from_location)} to ${nameOf(row.to_location)}`, leave_type_id: null }),
+    },
+};
+function nameOf(embed) {
+    return embed?.name ?? '(deleted)';
+}
+function personOf(row) {
+    const user = row.user;
+    return user ? `${user.name ?? ''} ${user.surname ?? ''}`.trim() : '(deleted)';
+}
 // How many matching names per table a history search widens itself by.
 const SEARCH_NAME_LIMIT = 20;
 const AUDIT_TRAIL_SELECT = `
@@ -331,6 +362,22 @@ class AuditResource {
         }));
         return Object.fromEntries(pages.flat());
     }
+    /** The record each `{ entity_type, entity_id }` names, keyed by its id; a type with no source is left out. */
+    async references(rows) {
+        const byType = new Map();
+        for (const row of rows) {
+            if (REFERENCE_SOURCES[row.entity_type])
+                byType.set(row.entity_type, [...(byType.get(row.entity_type) ?? []), row.entity_id]);
+        }
+        const pages = await Promise.all([...byType].map(async ([type, ids]) => {
+            const source = REFERENCE_SOURCES[type];
+            const { data, error } = await this.supabase.from(source.from).select(source.select).in('mms_id', [...new Set(ids)]);
+            if (error)
+                throw (0, errors_1.mapPostgrestError)(error);
+            return (data ?? []).map((row) => [String(row.mms_id), source.reference(row)]);
+        }));
+        return Object.fromEntries(pages.flat());
+    }
 }
 exports.AuditResource = AuditResource;
 /**

package/dist/configs/dto.d.ts

@@ -1,5 +1,5 @@
 import type { ConfigValue } from '@managemint-solutions/entities/configs';
-import type { CreateConfigDto as CreateConfigDtoType, UpdateConfigDto as UpdateConfigDtoType } from '@managemint-solutions/entities/configs/dto';
+import type { ConfigIdDto as ConfigIdDtoType, CreateConfigDto as CreateConfigDtoType, UpdateConfigDto as UpdateConfigDtoType } from '@managemint-solutions/entities/configs/dto';
 export declare class CreateConfigDto implements CreateConfigDtoType {
     readonly name: string;
     readonly description?: string;
@@ -9,3 +9,7 @@ export declare class UpdateConfigDto implements UpdateConfigDtoType {
     readonly description?: string;
     readonly value?: ConfigValue;
 }
+/** The admin api's /configs/:configId. v7: `configs.mms_id` defaults from `uuidv7()`. */
+export declare class ConfigIdDto implements ConfigIdDtoType {
+    readonly configId: string;
+}

package/dist/configs/dto.js

@@ -9,7 +9,7 @@ var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UpdateConfigDto = exports.CreateConfigDto = void 0;
+exports.ConfigIdDto = exports.UpdateConfigDto = exports.CreateConfigDto = void 0;
 const class_validator_1 = require("class-validator");
 const validators_1 = require("../validators");
 // class-validator version of the shared DTO type from @managemint-solutions/entities, so the
@@ -63,3 +63,12 @@ __decorate([
     (0, class_validator_1.IsObject)({ message: 'Value must be a JSON object' }),
     __metadata("design:type", Object)
 ], UpdateConfigDto.prototype, "value", void 0);
+/** The admin api's /configs/:configId. v7: `configs.mms_id` defaults from `uuidv7()`. */
+class ConfigIdDto {
+    configId;
+}
+exports.ConfigIdDto = ConfigIdDto;
+__decorate([
+    (0, class_validator_1.IsUUID)('7', { message: 'Invalid config ID format' }),
+    __metadata("design:type", String)
+], ConfigIdDto.prototype, "configId", void 0);

package/dist/crons/dto.d.ts

@@ -0,0 +1,9 @@
+import type { CronIdDto as CronIdDtoType, GetCronRunsDto as GetCronRunsDtoType } from '@managemint-solutions/entities/crons/dto';
+/** GET /crons/:cronId. v7: `crons.mms_id` defaults from `uuidv7()`. */
+export declare class CronIdDto implements CronIdDtoType {
+    readonly cronId: string;
+}
+export declare class GetCronRunsDto implements GetCronRunsDtoType {
+    readonly page: number;
+    readonly page_size: number;
+}

package/dist/crons/dto.js

@@ -0,0 +1,43 @@
+"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.GetCronRunsDto = exports.CronIdDto = void 0;
+const class_validator_1 = require("class-validator");
+const class_transformer_1 = require("class-transformer");
+/** GET /crons/:cronId. v7: `crons.mms_id` defaults from `uuidv7()`. */
+class CronIdDto {
+    cronId;
+}
+exports.CronIdDto = CronIdDto;
+__decorate([
+    (0, class_validator_1.IsUUID)('7', { message: 'Invalid cron ID format' }),
+    __metadata("design:type", String)
+], CronIdDto.prototype, "cronId", void 0);
+class GetCronRunsDto {
+    page = 1;
+    page_size = 25;
+}
+exports.GetCronRunsDto = GetCronRunsDto;
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_transformer_1.Transform)(({ value }) => (value ? Number(value) : 1), { toClassOnly: true }),
+    (0, class_validator_1.IsNumber)({}, { message: 'Page must be a number' }),
+    (0, class_validator_1.Min)(1, { message: 'Page must be at least 1' }),
+    __metadata("design:type", Number)
+], GetCronRunsDto.prototype, "page", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_transformer_1.Transform)(({ value }) => (value ? Number(value) : 25), { toClassOnly: true }),
+    (0, class_validator_1.IsNumber)({}, { message: 'Page size must be a number' }),
+    (0, class_validator_1.Min)(1, { message: 'Page size must be at least 1' }),
+    (0, class_validator_1.Max)(100, { message: 'Page size cannot exceed 100' }),
+    __metadata("design:type", Number)
+], GetCronRunsDto.prototype, "page_size", void 0);

package/dist/crons/index.d.ts

@@ -0,0 +1,38 @@
+import type { JsonValue } from '@managemint-solutions/entities/configs';
+import type { MmsList } from '@managemint-solutions/entities/common';
+import { CronRunStatus, type CronEntity, type CronRunEntity, type CronSummary } from '@managemint-solutions/entities/crons';
+import type { TypedSupabaseClient } from '../client';
+export * from './dto';
+/**
+ * The api's scheduled jobs, `public.crons`. Global like configs: no organization on the row.
+ * The service client reads a job by name to record its runs; staff read the list with each
+ * job's latest run.
+ */
+export declare class CronsResource {
+    private readonly supabase;
+    constructor(supabase: TypedSupabaseClient);
+    /**
+     * Every job by name, each with its latest run (one embed, newest first, limited to one). When
+     * each is due is the admin api's to work out from the schedule.
+     */
+    list(): Promise<Omit<CronSummary, 'last_due_at' | 'next_due_at'>[]>;
+    getById(cronId: string): Promise<CronEntity>;
+    getByName(name: string): Promise<CronEntity>;
+}
+/** The end of a run: how it went and what it returned or said. */
+export type FinishCronRunRow = {
+    status: CronRunStatus.SUCCEEDED | CronRunStatus.FAILED;
+    result?: JsonValue | null;
+    error?: string | null;
+};
+/**
+ * One row per invocation of a job, `public.cron_runs`. The api's cron routes write them on the
+ * service client (a row as the job starts, finished when it ends); staff read a job's history.
+ */
+export declare class CronRunsResource {
+    private readonly supabase;
+    constructor(supabase: TypedSupabaseClient);
+    list(cronId: string, page: number, pageSize: number): Promise<MmsList<CronRunEntity>>;
+    start(cronId: string): Promise<CronRunEntity>;
+    finish(runId: string, row: FinishCronRunRow): Promise<CronRunEntity>;
+}

package/dist/crons/index.js

@@ -0,0 +1,109 @@
+"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.CronRunsResource = exports.CronsResource = void 0;
+const crons_1 = require("@managemint-solutions/entities/crons");
+const errors_1 = require("../errors");
+const transforms_1 = require("../transforms");
+__exportStar(require("./dto"), exports);
+const CRON_SELECT = 'mms_id, created_at, updated_at, name, path, schedule, description';
+const CRON_RUN_SELECT = 'mms_id, cron_id, started_at, finished_at, status, result, error';
+/**
+ * The api's scheduled jobs, `public.crons`. Global like configs: no organization on the row.
+ * The service client reads a job by name to record its runs; staff read the list with each
+ * job's latest run.
+ */
+class CronsResource {
+    supabase;
+    constructor(supabase) {
+        this.supabase = supabase;
+    }
+    /**
+     * Every job by name, each with its latest run (one embed, newest first, limited to one). When
+     * each is due is the admin api's to work out from the schedule.
+     */
+    async list() {
+        const { data, error } = await this.supabase
+            .from('crons')
+            .select(`${CRON_SELECT}, runs:cron_runs(${CRON_RUN_SELECT})`)
+            .order('name')
+            .order('started_at', { referencedTable: 'cron_runs', ascending: false })
+            .limit(1, { referencedTable: 'cron_runs' });
+        if (error)
+            throw (0, errors_1.mapPostgrestError)(error);
+        return (data ?? []).map(({ runs, ...cron }) => ({
+            ...cron,
+            last_run: (runs[0] ?? null),
+        }));
+    }
+    async getById(cronId) {
+        const { data, error } = await this.supabase.from('crons').select(CRON_SELECT).eq('mms_id', cronId).single();
+        if (error)
+            throw (0, errors_1.mapPostgrestError)(error);
+        return data;
+    }
+    async getByName(name) {
+        const { data, error } = await this.supabase.from('crons').select(CRON_SELECT).eq('name', name).single();
+        if (error)
+            throw (0, errors_1.mapPostgrestError)(error);
+        return data;
+    }
+}
+exports.CronsResource = CronsResource;
+/**
+ * One row per invocation of a job, `public.cron_runs`. The api's cron routes write them on the
+ * service client (a row as the job starts, finished when it ends); staff read a job's history.
+ */
+class CronRunsResource {
+    supabase;
+    constructor(supabase) {
+        this.supabase = supabase;
+    }
+    async list(cronId, page, pageSize) {
+        const from = (page - 1) * pageSize;
+        const { data, error, count } = await this.supabase
+            .from('cron_runs')
+            .select(CRON_RUN_SELECT, { count: 'exact' })
+            .eq('cron_id', cronId)
+            .order('started_at', { ascending: false })
+            .range(from, from + pageSize - 1);
+        if (error)
+            throw (0, errors_1.mapPostgrestError)(error);
+        return (0, transforms_1.toMmsList)(data, page, pageSize, count);
+    }
+    async start(cronId) {
+        const { data, error } = await this.supabase
+            .from('cron_runs')
+            .insert({ cron_id: cronId, status: crons_1.CronRunStatus.RUNNING, started_at: new Date().toISOString() })
+            .select(CRON_RUN_SELECT)
+            .single();
+        if (error)
+            throw (0, errors_1.mapPostgrestError)(error);
+        return data;
+    }
+    async finish(runId, row) {
+        const { data, error } = await this.supabase
+            .from('cron_runs')
+            .update({ ...row, finished_at: new Date().toISOString() })
+            .eq('mms_id', runId)
+            .select(CRON_RUN_SELECT)
+            .single();
+        if (error)
+            throw (0, errors_1.mapPostgrestError)(error);
+        return data;
+    }
+}
+exports.CronRunsResource = CronRunsResource;

package/dist/index.d.ts

@@ -16,12 +16,14 @@ export { CancelSubscriptionDto, GetPaymentsQueryDto, InitialPaymentDto, PaymentI
 export { GetInvoicesQueryDto, InvoiceIdDto } from './billing/invoices';
 export type { CreateFeatureRequestRow, CreatedFeatureRequest } from './feature-requests';
 export { CreateFeatureRequestDto } from './feature-requests';
-export { CreateConfigDto, UpdateConfigDto } from './configs';
+export { ConfigIdDto, CreateConfigDto, UpdateConfigDto } from './configs';
+export type { FinishCronRunRow } from './crons';
+export { CronIdDto, GetCronRunsDto } from './crons';
 export { CreateSupportRequestDto } from './support';
-export { AddStatusDto, GetStatusesDto, ReorderStatusesDto, StatusIdDto, UpdateStatusDto } from './statuses';
+export { AddStatusDto, GetAllStatusesDto, GetStatusesDto, ReorderStatusesDto, StatusIdDto, UpdateStatusDto } from './statuses';
 export { AddLabelDto, GetLabelsDto, LabelIdDto, UpdateLabelDto } from './labels';
-export { AddAdditionalDetailsDto, AdditionalDetailsIdDto, GetAdditionalDetailsDto, IsAdditionalDetailsValueByType, UpdateAdditionalDetailsDto, } from './additional-details';
-export { AddNoteDto, GetNotesDto, NoteIdDto } from './notes';
+export { AddAdditionalDetailsDto, AdditionalDetailsIdDto, GetAdditionalDetailsDto, GetAllAdditionalDetailsDto, IsAdditionalDetailsValueByType, UpdateAdditionalDetailsDto, } from './additional-details';
+export { AddNoteDto, GetAllNotesDto, GetNotesDto, NoteIdDto } from './notes';
 export type { CreateNotificationInput, CreatedNotification, NotificationContentRow, QueuedNotification, } from './notifications';
 export { GetNotificationsDto, NotificationIdDto } from './notifications';
 export type { OrganizationInvite } from './organization-invites';
@@ -38,7 +40,7 @@ export { CreateUserApiCredentialDto, MintEmulationTokenDto, UserApiCredentialIdD
 export type { UserEmploymentRow, UserRow } from './users';
 export { AddUserDto, GetUsersQueryDto, StaffGetUsersDto, UpdateMyProfileDto, UpdateUserDto, UserIdDto, } from './users';
 export type { ClaimOutcome, WebhookEventRow, WebhookEventsTable } from './webhook-events';
-export { GetSupportingFilesDto, SupportingFileIdDto, SupportingFileNamesDto } from './supporting-files';
+export { GetAllSupportingFilesDto, 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 { CreateInventoryMovementRow, InventoryItemRow, InventoryLevelRow, InventoryStocktakeRow, InventoryTransferRow, UpdateInventoryTransferRow, } from './inventory';

package/dist/index.js

@@ -7,10 +7,10 @@
 // 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.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.ModuleSetDto = exports.ChangeModulesDto = 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.InventoryItemIdDto = exports.ImportInventoryItemsDto = exports.ImportInventoryItemDto = exports.GetInventoryTransfersDto = exports.GetInventoryStocktakesDto = exports.GetInventoryMovementsDto = exports.GetInventoryLocationsDto = exports.GetInventoryItemsDto = exports.GeocodeAddressDto = exports.CreateInventoryTransferLineDto = exports.CreateInventoryTransferDto = exports.CreateInventoryMovementDto = exports.CreateInventoryLocationDto = exports.CreateInventoryItemDto = exports.CountInventoryLineDto = exports.CountInventoryDto = 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 = exports.UpdateOrganizationPayoutsDto = exports.NotificationIdDto = void 0;
-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 = exports.ConvertDocumentDto = exports.VoidDocumentDto = exports.UpdateDocumentTemplateDto = exports.UpdateDocumentDto = exports.SendDocumentDto = exports.RecordDocumentPaymentDto = exports.PayDocumentDto = exports.GetDocumentTemplatesDto = exports.GetDocumentsDto = exports.GetCatalogueTemplatesDto = exports.documentProblem = exports.DocumentTemplateIdDto = exports.DocumentPaymentIdDto = exports.DocumentPayTokenDto = exports.DocumentPayQueryDto = exports.DocumentImageUrlsDto = exports.DocumentImageNameDto = exports.DocumentIdDto = exports.CreateDocumentTemplateDto = exports.CreateDocumentDto = exports.CopyCatalogueTemplateDto = exports.CatalogueTemplateSlugDto = exports.UpdateInventoryTransferDto = exports.UpdateInventoryLocationDto = exports.UpdateInventoryLevelDto = exports.UpdateInventoryItemDto = exports.SuggestAddressesDto = exports.StaffGetInventoryItemsDto = exports.ReceiveInventoryTransferDto = exports.InventoryTransferIdDto = exports.InventoryStocktakeIdDto = exports.InventoryLocationIdDto = exports.InventoryLevelKeyDto = 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 = void 0;
+exports.IsAdditionalDetailsValueByType = exports.GetAllAdditionalDetailsDto = exports.GetAdditionalDetailsDto = exports.AdditionalDetailsIdDto = exports.AddAdditionalDetailsDto = exports.UpdateLabelDto = exports.LabelIdDto = exports.GetLabelsDto = exports.AddLabelDto = exports.UpdateStatusDto = exports.StatusIdDto = exports.ReorderStatusesDto = exports.GetStatusesDto = exports.GetAllStatusesDto = exports.AddStatusDto = exports.CreateSupportRequestDto = exports.GetCronRunsDto = exports.CronIdDto = exports.UpdateConfigDto = exports.CreateConfigDto = exports.ConfigIdDto = exports.CreateFeatureRequestDto = exports.InvoiceIdDto = exports.GetInvoicesQueryDto = exports.ReinstateSubscriptionDto = exports.PurchaseModuleDto = exports.ModuleSetDto = exports.ChangeModulesDto = 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.GetInventoryItemsDto = exports.GeocodeAddressDto = exports.CreateInventoryTransferLineDto = exports.CreateInventoryTransferDto = exports.CreateInventoryMovementDto = exports.CreateInventoryLocationDto = exports.CreateInventoryItemDto = exports.CountInventoryLineDto = exports.CountInventoryDto = 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.GetAllSupportingFilesDto = 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 = exports.UpdateOrganizationPayoutsDto = exports.NotificationIdDto = exports.GetNotificationsDto = exports.NoteIdDto = exports.GetNotesDto = exports.GetAllNotesDto = exports.AddNoteDto = exports.UpdateAdditionalDetailsDto = void 0;
+exports.GetTasksDto = exports.CreateTaskDto = exports.AddTaskLinkDto = exports.UpdateProjectDto = exports.StaffGetProjectsDto = exports.ProjectIdDto = exports.GetProjectsDto = exports.CreateProjectDto = exports.UpdateVisibilityDto = exports.ReassignPrivateDocumentsDto = exports.ConvertDocumentDto = exports.VoidDocumentDto = exports.UpdateDocumentTemplateDto = exports.UpdateDocumentDto = exports.SendDocumentDto = exports.RecordDocumentPaymentDto = exports.PayDocumentDto = exports.GetDocumentTemplatesDto = exports.GetDocumentsDto = exports.GetCatalogueTemplatesDto = exports.documentProblem = exports.DocumentTemplateIdDto = exports.DocumentPaymentIdDto = exports.DocumentPayTokenDto = exports.DocumentPayQueryDto = exports.DocumentImageUrlsDto = exports.DocumentImageNameDto = exports.DocumentIdDto = exports.CreateDocumentTemplateDto = exports.CreateDocumentDto = exports.CopyCatalogueTemplateDto = exports.CatalogueTemplateSlugDto = exports.UpdateInventoryTransferDto = exports.UpdateInventoryLocationDto = exports.UpdateInventoryLevelDto = exports.UpdateInventoryItemDto = exports.SuggestAddressesDto = exports.StaffGetInventoryItemsDto = exports.ReceiveInventoryTransferDto = exports.InventoryTransferIdDto = exports.InventoryStocktakeIdDto = exports.InventoryLocationIdDto = exports.InventoryLevelKeyDto = exports.InventoryItemIdDto = exports.ImportInventoryItemsDto = exports.ImportInventoryItemDto = exports.GetInventoryTransfersDto = exports.GetInventoryStocktakesDto = exports.GetInventoryMovementsDto = exports.GetInventoryLocationsDto = 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 = 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; } });
@@ -52,12 +52,17 @@ Object.defineProperty(exports, "InvoiceIdDto", { enumerable: true, get: function
 var feature_requests_1 = require("./feature-requests");
 Object.defineProperty(exports, "CreateFeatureRequestDto", { enumerable: true, get: function () { return feature_requests_1.CreateFeatureRequestDto; } });
 var configs_1 = require("./configs");
+Object.defineProperty(exports, "ConfigIdDto", { enumerable: true, get: function () { return configs_1.ConfigIdDto; } });
 Object.defineProperty(exports, "CreateConfigDto", { enumerable: true, get: function () { return configs_1.CreateConfigDto; } });
 Object.defineProperty(exports, "UpdateConfigDto", { enumerable: true, get: function () { return configs_1.UpdateConfigDto; } });
+var crons_1 = require("./crons");
+Object.defineProperty(exports, "CronIdDto", { enumerable: true, get: function () { return crons_1.CronIdDto; } });
+Object.defineProperty(exports, "GetCronRunsDto", { enumerable: true, get: function () { return crons_1.GetCronRunsDto; } });
 var support_1 = require("./support");
 Object.defineProperty(exports, "CreateSupportRequestDto", { enumerable: true, get: function () { return support_1.CreateSupportRequestDto; } });
 var statuses_1 = require("./statuses");
 Object.defineProperty(exports, "AddStatusDto", { enumerable: true, get: function () { return statuses_1.AddStatusDto; } });
+Object.defineProperty(exports, "GetAllStatusesDto", { enumerable: true, get: function () { return statuses_1.GetAllStatusesDto; } });
 Object.defineProperty(exports, "GetStatusesDto", { enumerable: true, get: function () { return statuses_1.GetStatusesDto; } });
 Object.defineProperty(exports, "ReorderStatusesDto", { enumerable: true, get: function () { return statuses_1.ReorderStatusesDto; } });
 Object.defineProperty(exports, "StatusIdDto", { enumerable: true, get: function () { return statuses_1.StatusIdDto; } });
@@ -71,10 +76,12 @@ var additional_details_1 = require("./additional-details");
 Object.defineProperty(exports, "AddAdditionalDetailsDto", { enumerable: true, get: function () { return additional_details_1.AddAdditionalDetailsDto; } });
 Object.defineProperty(exports, "AdditionalDetailsIdDto", { enumerable: true, get: function () { return additional_details_1.AdditionalDetailsIdDto; } });
 Object.defineProperty(exports, "GetAdditionalDetailsDto", { enumerable: true, get: function () { return additional_details_1.GetAdditionalDetailsDto; } });
+Object.defineProperty(exports, "GetAllAdditionalDetailsDto", { enumerable: true, get: function () { return additional_details_1.GetAllAdditionalDetailsDto; } });
 Object.defineProperty(exports, "IsAdditionalDetailsValueByType", { enumerable: true, get: function () { return additional_details_1.IsAdditionalDetailsValueByType; } });
 Object.defineProperty(exports, "UpdateAdditionalDetailsDto", { enumerable: true, get: function () { return additional_details_1.UpdateAdditionalDetailsDto; } });
 var notes_1 = require("./notes");
 Object.defineProperty(exports, "AddNoteDto", { enumerable: true, get: function () { return notes_1.AddNoteDto; } });
+Object.defineProperty(exports, "GetAllNotesDto", { enumerable: true, get: function () { return notes_1.GetAllNotesDto; } });
 Object.defineProperty(exports, "GetNotesDto", { enumerable: true, get: function () { return notes_1.GetNotesDto; } });
 Object.defineProperty(exports, "NoteIdDto", { enumerable: true, get: function () { return notes_1.NoteIdDto; } });
 var notifications_1 = require("./notifications");
@@ -109,6 +116,7 @@ Object.defineProperty(exports, "UpdateMyProfileDto", { enumerable: true, get: fu
 Object.defineProperty(exports, "UpdateUserDto", { enumerable: true, get: function () { return users_1.UpdateUserDto; } });
 Object.defineProperty(exports, "UserIdDto", { enumerable: true, get: function () { return users_1.UserIdDto; } });
 var supporting_files_1 = require("./supporting-files");
+Object.defineProperty(exports, "GetAllSupportingFilesDto", { enumerable: true, get: function () { return supporting_files_1.GetAllSupportingFilesDto; } });
 Object.defineProperty(exports, "GetSupportingFilesDto", { enumerable: true, get: function () { return supporting_files_1.GetSupportingFilesDto; } });
 Object.defineProperty(exports, "SupportingFileIdDto", { enumerable: true, get: function () { return supporting_files_1.SupportingFileIdDto; } });
 Object.defineProperty(exports, "SupportingFileNamesDto", { enumerable: true, get: function () { return supporting_files_1.SupportingFileNamesDto; } });

package/dist/notes/dto.d.ts

@@ -1,4 +1,4 @@
-import type { AddNoteDto as AddNoteDtoType, GetNotesDto as GetNotesDtoType, NoteIdDto as NoteIdDtoType } from '@managemint-solutions/entities/notes/dto';
+import type { AddNoteDto as AddNoteDtoType, GetAllNotesDto as GetAllNotesDtoType, GetNotesDto as GetNotesDtoType, NoteIdDto as NoteIdDtoType } from '@managemint-solutions/entities/notes/dto';
 import { NotesEntityTypes } from '@managemint-solutions/entities/notes/enum';
 export declare class NoteIdDto implements NoteIdDtoType {
     readonly noteId: string;
@@ -10,3 +10,11 @@ export declare class GetNotesDto implements GetNotesDtoType {
 export declare class AddNoteDto implements AddNoteDtoType {
     readonly content: string;
 }
+/** The admin api's GET /notes: every organization's notes, a page at a time. */
+export declare class GetAllNotesDto implements GetAllNotesDtoType {
+    readonly page: number;
+    readonly page_size: number;
+    readonly organization_id?: string | null;
+    readonly entity_type?: NotesEntityTypes | null;
+    readonly search?: string | null;
+}