@managemint-solutions/sdk 0.33.0 → 0.34.0

package/README.md

@@ -18,7 +18,7 @@ are peer dependencies — the request DTOs (`AddStatusDto`, `UpdateStatusDto`, `
 `UpdateProjectDto`, `GetTasksDto`, `TaskIdDto`, `CreateTaskDto`, `UpdateTaskDto`,
 `GetAuditTrailDto`, `SignInDto`,
 `ExchangeRefreshTokenDto`, `SendPasswordResetEmailDto`, `ExchangeTokenHashDto`,
-`ResetPasswordDto`) ship with their class-validator
+`ResetPasswordDto`, `CreateConfigDto`, `UpdateConfigDto`) ship with their class-validator
 decorators so consumers validate against
 the same rules the SDK's input types describe. `@nestjs/common` (^11) is an optional peer
 dependency, needed only for the `@managemint-solutions/sdk/nest` subpath.
@@ -378,6 +378,27 @@ const total = monthlyTotalMinor(pricebook, ['CRM'], seatCount);
 Each pricebook comes back with its `modules` flattened to `PricedModule`s (the `pricebook_modules`
 row joined with its `billing_modules` catalog entry). Exactly one pricebook is active at a time.
 
+## Configs
+
+`public.configs` holds global named JSON configs — one `value` object per row, with no
+organization on it. Every signed-in caller may read, and only the service role may write, so
+`configs` hangs off the caller's client and the service client alike and a write on the former
+fails at the database (Scott edits the rows in Supabase Studio for now). A feature-flag set is
+just a row someone named, not a concept the SDK knows about, and the table is not audited.
+
+```ts
+import type { ConfigEntity } from '@managemint-solutions/entities/configs';
+
+const all: ConfigEntity[] = await supabase.configs.list();          // user client reads
+const flags = await supabase.configs.getByName('feature_flags');   // whatever rows exist in Studio
+const one = await supabase.configs.getById(flags.mms_id);
+
+const service = createSupabaseServiceClient({ url, serviceRoleKey });
+await service.configs.create({ name: 'maintenance', description: 'Planned downtime banner' });
+await service.configs.update('feature_flags', { value: { ...flags.value, timesheets: false } }); // replaces the object, stamps updated_at
+await service.configs.remove('maintenance');   // hard delete, service role only
+```
+
 ## Errors
 
 Every error the SDK throws is a `SupabaseClientError` carrying the HTTP `status` to respond

package/dist/client.d.ts

@@ -3,6 +3,7 @@ import { type AuthContext } from './auth';
 import { AuditResource, type AuditErrorHandler } from './audit';
 import { AdditionalDetailsResource } from './additional-details';
 import { ClientsResource } from './clients';
+import { ConfigsResource } from './configs';
 import { NotesResource } from './notes';
 import { NotificationsResource } from './notifications';
 import { BillingReadsResource } from './billing';
@@ -41,6 +42,7 @@ export declare class SupabaseClient {
     readonly supabase: TypedSupabaseClient;
     readonly auth: AuthContext;
     readonly audit: AuditResource;
+    readonly configs: ConfigsResource;
     readonly statuses: StatusesResource;
     readonly additionalDetails: AdditionalDetailsResource;
     readonly notes: NotesResource;

package/dist/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 configs_1 = require("./configs");
 const notes_1 = require("./notes");
 const notifications_1 = require("./notifications");
 const billing_1 = require("./billing");
@@ -25,6 +26,8 @@ class SupabaseClient {
     supabase; // escape hatch for not-yet-migrated queries
     auth;
     audit;
+    // Reads run under the authenticated grant; the writes are the service client's.
+    configs;
     statuses;
     additionalDetails;
     notes;
@@ -44,6 +47,7 @@ class SupabaseClient {
             config.client ?? (0, auth_1.createRawClient)(config.url, config.key, config.accessToken);
         // Built before the resources: every write they make goes through it.
         this.audit = new audit_1.AuditResource(this.supabase, this.auth, config.onAuditError);
+        this.configs = new configs_1.ConfigsResource(this.supabase);
         this.statuses = new statuses_1.StatusesResource(this.supabase, this.auth, this.audit);
         this.additionalDetails = new additional_details_1.AdditionalDetailsResource(this.supabase, this.auth, this.audit);
         this.notes = new notes_1.NotesResource(this.supabase, this.auth, this.audit);

package/dist/configs/dto.d.ts

@@ -0,0 +1,11 @@
+import type { ConfigValue } from '@managemint-solutions/entities/configs';
+import type { CreateConfigDto as CreateConfigDtoType, UpdateConfigDto as UpdateConfigDtoType } from '@managemint-solutions/entities/configs/dto';
+export declare class CreateConfigDto implements CreateConfigDtoType {
+    readonly name: string;
+    readonly description?: string;
+    readonly value?: ConfigValue;
+}
+export declare class UpdateConfigDto implements UpdateConfigDtoType {
+    readonly description?: string;
+    readonly value?: ConfigValue;
+}

package/dist/configs/dto.js

@@ -0,0 +1,73 @@
+"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.UpdateConfigDto = exports.CreateConfigDto = void 0;
+const class_validator_1 = require("class-validator");
+const class_transformer_1 = require("class-transformer");
+// class-validator version of the shared DTO type from @managemint-solutions/entities, so the
+// wire contract cannot drift.
+/**
+ * Whitespace on either side of a pasted value is not part of the answer. Trimming here rather
+ * than in the api means the length rules below measure what will actually be stored — a name of
+ * three spaces is empty, not three characters long.
+ */
+const Trim = () => (0, class_transformer_1.Transform)(({ value }) => (typeof value === 'string' ? value.trim() : value), {
+    toClassOnly: true,
+});
+class CreateConfigDto {
+    name;
+    description;
+    // This DTO is the only place the object shape is enforced — the column has no CHECK by
+    // design, so a config may hold whatever keys the row's author named. class-validator's
+    // isObject rejects arrays and scalars, which is exactly the line: one JSON object, nothing
+    // else. `@ValidateIf` rather than `@IsOptional` because the latter skips an explicit null
+    // too, and null is not a config value — an omitted `value` becomes `{}` at the insert.
+    value;
+}
+exports.CreateConfigDto = CreateConfigDto;
+__decorate([
+    Trim(),
+    (0, class_validator_1.IsString)({ message: 'Invalid name' }),
+    (0, class_validator_1.MinLength)(1, { message: 'Name cannot be empty' }),
+    (0, class_validator_1.MaxLength)(100, { message: 'Name cannot exceed 100 characters' }),
+    __metadata("design:type", String)
+], CreateConfigDto.prototype, "name", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    Trim(),
+    (0, class_validator_1.IsString)({ message: 'Invalid description' }),
+    (0, class_validator_1.MaxLength)(1000, { message: 'Description cannot exceed 1000 characters' }),
+    __metadata("design:type", String)
+], CreateConfigDto.prototype, "description", void 0);
+__decorate([
+    (0, class_validator_1.ValidateIf)((o) => o.value !== undefined),
+    (0, class_validator_1.IsObject)({ message: 'Value must be a JSON object' }),
+    __metadata("design:type", Object)
+], CreateConfigDto.prototype, "value", void 0);
+class UpdateConfigDto {
+    description;
+    // Same rule as the create: an absent `value` leaves the column alone, but a null is a value
+    // the column cannot hold. It replaces the whole object rather than merging into it.
+    value;
+}
+exports.UpdateConfigDto = UpdateConfigDto;
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    Trim(),
+    (0, class_validator_1.IsString)({ message: 'Invalid description' }),
+    (0, class_validator_1.MaxLength)(1000, { message: 'Description cannot exceed 1000 characters' }),
+    __metadata("design:type", String)
+], UpdateConfigDto.prototype, "description", void 0);
+__decorate([
+    (0, class_validator_1.ValidateIf)((o) => o.value !== undefined),
+    (0, class_validator_1.IsObject)({ message: 'Value must be a JSON object' }),
+    __metadata("design:type", Object)
+], UpdateConfigDto.prototype, "value", void 0);

package/dist/configs/index.d.ts

@@ -0,0 +1,25 @@
+import type { ConfigEntity } from '@managemint-solutions/entities/configs';
+import type { CreateConfigDto as CreateConfigDtoType, UpdateConfigDto as UpdateConfigDtoType } from '@managemint-solutions/entities/configs/dto';
+import type { TypedSupabaseClient } from '../client';
+export * from './dto';
+/**
+ * Global named JSON configs. Every signed-in caller may read (the READ policy is `true` — there
+ * is no tenant on the row), so this hangs off the user client and the service client alike;
+ * only the service role may write, and a write on the user client fails at the database.
+ * Not audited: Studio is the other writer, and nothing would see its edits anyway.
+ */
+export declare class ConfigsResource {
+    private readonly supabase;
+    constructor(supabase: TypedSupabaseClient);
+    list(): Promise<ConfigEntity[]>;
+    getByName(name: string): Promise<ConfigEntity>;
+    getById(configId: string): Promise<ConfigEntity>;
+    create(input: CreateConfigDtoType): Promise<ConfigEntity>;
+    /** `value` replaces the whole object — it is not merged. */
+    update(name: string, patch: UpdateConfigDtoType): Promise<ConfigEntity>;
+    /**
+     * Hard delete — there is nothing to soft-delete into and nothing references a config row.
+     * Service role only, like every write here; a call on the user client fails at the database.
+     */
+    remove(name: string): Promise<void>;
+}

package/dist/configs/index.js

@@ -0,0 +1,101 @@
+"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.ConfigsResource = void 0;
+const errors_1 = require("../errors");
+__exportStar(require("./dto"), exports);
+// The public contract is ConfigEntity from @managemint-solutions/entities; the casts at the
+// returns declare the shape this select string produces (columns defined in the api's
+// supabase/migrations). `id` never leaves SQL.
+const CONFIG_SELECT = 'mms_id, created_at, updated_at, name, description, value';
+/**
+ * Global named JSON configs. Every signed-in caller may read (the READ policy is `true` — there
+ * is no tenant on the row), so this hangs off the user client and the service client alike;
+ * only the service role may write, and a write on the user client fails at the database.
+ * Not audited: Studio is the other writer, and nothing would see its edits anyway.
+ */
+class ConfigsResource {
+    supabase;
+    constructor(supabase) {
+        this.supabase = supabase;
+    }
+    async list() {
+        const { data, error } = await this.supabase
+            .from('configs')
+            .select(CONFIG_SELECT)
+            .order('name');
+        if (error)
+            throw (0, errors_1.mapPostgrestError)(error);
+        return (data ?? []);
+    }
+    async getByName(name) {
+        const { data, error } = await this.supabase
+            .from('configs')
+            .select(CONFIG_SELECT)
+            .eq('name', name)
+            .single();
+        if (error)
+            throw (0, errors_1.mapPostgrestError)(error);
+        return data;
+    }
+    async getById(configId) {
+        const { data, error } = await this.supabase
+            .from('configs')
+            .select(CONFIG_SELECT)
+            .eq('mms_id', configId)
+            .single();
+        if (error)
+            throw (0, errors_1.mapPostgrestError)(error);
+        return data;
+    }
+    async create(input) {
+        const { data, error } = await this.supabase
+            .from('configs')
+            .insert({
+            name: input.name,
+            description: input.description ?? '',
+            value: input.value ?? {},
+            created_at: new Date().toISOString(),
+        })
+            .select(CONFIG_SELECT)
+            .single();
+        if (error)
+            throw (0, errors_1.mapPostgrestError)(error);
+        return data;
+    }
+    /** `value` replaces the whole object — it is not merged. */
+    async update(name, patch) {
+        const { data, error } = await this.supabase
+            .from('configs')
+            .update({ ...patch, updated_at: new Date().toISOString() })
+            .eq('name', name)
+            .select(CONFIG_SELECT)
+            .single();
+        if (error)
+            throw (0, errors_1.mapPostgrestError)(error);
+        return data;
+    }
+    /**
+     * Hard delete — there is nothing to soft-delete into and nothing references a config row.
+     * Service role only, like every write here; a call on the user client fails at the database.
+     */
+    async remove(name) {
+        const { error } = await this.supabase.from('configs').delete().eq('name', name);
+        if (error)
+            throw (0, errors_1.mapPostgrestError)(error);
+    }
+}
+exports.ConfigsResource = ConfigsResource;

package/dist/index.d.ts

@@ -15,6 +15,7 @@ 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 { CreateSupportRequestDto } from './support';
 export { AddStatusDto, GetStatusesDto, StatusIdDto, UpdateStatusDto } from './statuses';
 export { AddAdditionalDetailsDto, AdditionalDetailsIdDto, GetAdditionalDetailsDto, IsAdditionalDetailsValueByType, UpdateAdditionalDetailsDto, } from './additional-details';

package/dist/index.js

@@ -7,8 +7,8 @@
 // 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.SupportingFileIdDto = exports.GetSupportingFilesDto = exports.UserIdDto = exports.UpdateUserDto = exports.UpdateMyProfileDto = exports.GetUsersQueryDto = exports.AddUserDto = exports.UpdatePermissionsDto = exports.PermissionsResource = exports.UpdateOrganizationDto = exports.CreateOrganizationDto = exports.NotificationIdDto = exports.GetNotificationsDto = exports.NoteIdDto = exports.GetNotesDto = exports.AddNoteDto = exports.UpdateAdditionalDetailsDto = exports.IsAdditionalDetailsValueByType = exports.GetAdditionalDetailsDto = exports.AdditionalDetailsIdDto = exports.AddAdditionalDetailsDto = exports.UpdateStatusDto = exports.StatusIdDto = exports.GetStatusesDto = exports.AddStatusDto = exports.CreateSupportRequestDto = exports.CreateFeatureRequestDto = exports.InvoiceIdDto = exports.GetInvoicesQueryDto = exports.ReinstateSubscriptionDto = exports.PurchaseModuleDto = exports.PaymentIdDto = exports.InitialPaymentDto = exports.GetPaymentsQueryDto = exports.CancelSubscriptionDto = 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.createSupabaseClient = exports.SupabaseClient = void 0;
-exports.monthlyTotalMinor = exports.UpdateTaskDto = exports.TaskIdDto = exports.GetTasksDto = exports.CreateTaskDto = exports.UpdateProjectDto = exports.ProjectIdDto = exports.GetProjectsDto = exports.CreateProjectDto = exports.UpdateClientDto = exports.GetClientsDto = exports.CreateClientDto = exports.ClientIdDto = void 0;
+exports.UserIdDto = exports.UpdateUserDto = exports.UpdateMyProfileDto = exports.GetUsersQueryDto = exports.AddUserDto = exports.UpdatePermissionsDto = exports.PermissionsResource = exports.UpdateOrganizationDto = exports.CreateOrganizationDto = exports.NotificationIdDto = exports.GetNotificationsDto = exports.NoteIdDto = exports.GetNotesDto = exports.AddNoteDto = exports.UpdateAdditionalDetailsDto = exports.IsAdditionalDetailsValueByType = exports.GetAdditionalDetailsDto = exports.AdditionalDetailsIdDto = exports.AddAdditionalDetailsDto = exports.UpdateStatusDto = exports.StatusIdDto = exports.GetStatusesDto = exports.AddStatusDto = exports.CreateSupportRequestDto = exports.UpdateConfigDto = exports.CreateConfigDto = exports.CreateFeatureRequestDto = exports.InvoiceIdDto = exports.GetInvoicesQueryDto = exports.ReinstateSubscriptionDto = exports.PurchaseModuleDto = exports.PaymentIdDto = exports.InitialPaymentDto = exports.GetPaymentsQueryDto = exports.CancelSubscriptionDto = exports.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.createSupabaseClient = exports.SupabaseClient = void 0;
+exports.monthlyTotalMinor = exports.UpdateTaskDto = exports.TaskIdDto = exports.GetTasksDto = exports.CreateTaskDto = exports.UpdateProjectDto = exports.ProjectIdDto = exports.GetProjectsDto = exports.CreateProjectDto = exports.UpdateClientDto = exports.GetClientsDto = exports.CreateClientDto = exports.ClientIdDto = exports.SupportingFileIdDto = exports.GetSupportingFilesDto = 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; } });
@@ -43,6 +43,9 @@ Object.defineProperty(exports, "GetInvoicesQueryDto", { enumerable: true, get: f
 Object.defineProperty(exports, "InvoiceIdDto", { enumerable: true, get: function () { return invoices_1.InvoiceIdDto; } });
 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, "CreateConfigDto", { enumerable: true, get: function () { return configs_1.CreateConfigDto; } });
+Object.defineProperty(exports, "UpdateConfigDto", { enumerable: true, get: function () { return configs_1.UpdateConfigDto; } });
 var support_1 = require("./support");
 Object.defineProperty(exports, "CreateSupportRequestDto", { enumerable: true, get: function () { return support_1.CreateSupportRequestDto; } });
 var statuses_1 = require("./statuses");

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

@@ -2,6 +2,7 @@ import { AuditResource, type AuditActor, type AuditedTable, type AuditedTableOpt
 import type { TypedSupabaseClient } from '../client';
 import { BillingResource } from '../billing';
 import { InvoicesResource } from '../billing/invoices';
+import { ConfigsResource } from '../configs';
 import { FeatureRequestsResource } from '../feature-requests';
 import { NotificationsOutboxResource } from '../notifications';
 import { OrganizationInvitesResource } from '../organization-invites';
@@ -57,6 +58,7 @@ export declare class SupabaseServiceClient {
     readonly supabase: TypedSupabaseClient;
     readonly notifications: NotificationsOutboxResource;
     readonly featureRequests: FeatureRequestsResource;
+    readonly configs: ConfigsResource;
     readonly signup: OrganizationSignupResource;
     readonly paystackEvents: WebhookEventsResource;
     readonly resendEvents: WebhookEventsResource;

package/dist/service-client/index.js

@@ -6,6 +6,7 @@ const audit_1 = require("../audit");
 const enum_1 = require("@managemint-solutions/entities/audit-trail/enum");
 const billing_1 = require("../billing");
 const invoices_1 = require("../billing/invoices");
+const configs_1 = require("../configs");
 const feature_requests_1 = require("../feature-requests");
 const notifications_1 = require("../notifications");
 const errors_1 = require("../errors");
@@ -71,6 +72,8 @@ class SupabaseServiceClient {
     // Tenant-less, like `signup`: a feature request comes from a visitor with no account, so it
     // hangs off the client rather than off an organization scope.
     featureRequests;
+    // Global, with no organization on the row, so it hangs off the client rather than a scope.
+    configs;
     signup;
     paystackEvents;
     resendEvents;
@@ -80,6 +83,7 @@ class SupabaseServiceClient {
         this.paystackEvents = new webhook_events_1.WebhookEventsResource(this.supabase, 'paystack_webhook_events');
         this.resendEvents = new webhook_events_1.WebhookEventsResource(this.supabase, 'resend_webhook_events');
         this.featureRequests = new feature_requests_1.FeatureRequestsResource(this.supabase);
+        this.configs = new configs_1.ConfigsResource(this.supabase);
         this.signup = new organizations_1.OrganizationSignupResource(this.supabase, (organizationId) => this.forOrganization(organizationId).audit);
         // The outbox spans organizations — the row it is about carries its own — so it takes a
         // factory and scopes per write rather than being built inside one organization's scope.

package/package.json

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