@managemint-solutions/entities 1.22.0 → 1.22.1

package/dist/billing/enum/index.d.ts

@@ -40,7 +40,7 @@ export declare enum BillingEventSource {
     SCHEDULER = "scheduler"
 }
 /**
- * Billing ledger event names — the values written to billing_events.event_type.
+ * Billing ledger event names - the values written to billing_events.event_type.
  * Distinct from BillingStatus (which is the organization's current billing state)
  * even though a couple of values coincide, e.g. cancellation_requested.
  */

package/dist/billing/enum/index.js

@@ -53,7 +53,7 @@ var BillingEventSource;
 })(BillingEventSource || (exports.BillingEventSource = BillingEventSource = {}));
 ;
 /**
- * Billing ledger event names — the values written to billing_events.event_type.
+ * Billing ledger event names - the values written to billing_events.event_type.
  * Distinct from BillingStatus (which is the organization's current billing state)
  * even though a couple of values coincide, e.g. cancellation_requested.
  */

package/dist/billing/index.d.ts

@@ -2,7 +2,7 @@ import { BillingEventSource, BillingEventType, BillingTransactionStatus, Billing
 /**
  * Day of the month every billing period is anchored on. The period containing a
  * given date runs from the most recent 25th (inclusive) to the next 25th
- * (exclusive) — the anchor day itself belongs to the new period.
+ * (exclusive) - the anchor day itself belongs to the new period.
  */
 export declare const BILLING_ANCHOR_DAY = 25;
 export type BillingPeriod = {
@@ -31,7 +31,7 @@ export type CreateTransactionInput = {
     prorationEndAt?: Date | null;
     /**
      * Defaults to INITIALIZED. Pass PAID (with paidAt) for transactions recorded
-     * after the fact, e.g. subscription renewals reported by webhook — inserting
+     * after the fact, e.g. subscription renewals reported by webhook - inserting
      * them directly as paid keeps them out of the one-open-transaction-per-
      * organization unique index.
      */

package/dist/billing/index.js

@@ -4,6 +4,6 @@ exports.BILLING_ANCHOR_DAY = void 0;
 /**
  * Day of the month every billing period is anchored on. The period containing a
  * given date runs from the most recent 25th (inclusive) to the next 25th
- * (exclusive) — the anchor day itself belongs to the new period.
+ * (exclusive) - the anchor day itself belongs to the new period.
  */
 exports.BILLING_ANCHOR_DAY = 25;

package/dist/billing/invoices/index.d.ts

@@ -1,7 +1,7 @@
 import { BillingTransactionStatus, BillingTransactionType } from "../enum";
 /** One priced line on an invoice document, frozen at issue time. */
 export type InvoiceLineItem = {
-    /** The bold line: the module, e.g. "Core — subscription". */
+    /** The bold line: the module, e.g. "Core - subscription". */
     label: string;
     /** The grey sub-line: "12 seats · 2 Sep – 25 Sep 2026 (23 of 31 days)". */
     detail?: string | null;
@@ -27,7 +27,7 @@ export type InvoiceSummary = {
 };
 /**
  * The full invoice document data. `line_items` and `billed_to` are snapshots
- * frozen when the invoice was written — the document must not change when the
+ * frozen when the invoice was written - the document must not change when the
  * organization later edits its billing address or the pricebook moves on.
  */
 export type InvoiceEntity = InvoiceSummary & {
@@ -44,7 +44,7 @@ export type InvoiceEntity = InvoiceSummary & {
         registration_number: string | null;
     };
 };
-/** Response of GET /billing/invoices/:invoiceId/html — the A4 document markup. */
+/** Response of GET /billing/invoices/:invoiceId/html - the A4 document markup. */
 export type InvoiceHtmlResponse = {
     html: string;
 };

package/dist/billing/payments/index.d.ts

@@ -1,8 +1,8 @@
 import { BillingTransactionStatus, BillingTransactionType } from "../enum";
 /**
  * One row of GET /billing/payments: a billing_transactions ledger row as the portal
- * lists it. Every charge is a payment — the initial subscription, a pro-rata seat or
- * module charge, a reinstatement and a monthly renewal alike — whether or not it
+ * lists it. Every charge is a payment - the initial subscription, a pro-rata seat or
+ * module charge, a reinstatement and a monthly renewal alike - whether or not it
  * settled. Invoices are the separate accounting documents that only renewals issue.
  */
 export type PaymentSummary = {
@@ -26,6 +26,6 @@ export type PaymentEntity = PaymentSummary & {
     proration_start_at: string | null;
     proration_end_at: string | null;
     paystack_reference: string | null;
-    /** The invoice this payment issued — renewals only; null for every other type. */
+    /** The invoice this payment issued - renewals only; null for every other type. */
     invoice_id: string | null;
 };

package/dist/configs/dto/index.d.ts

@@ -4,7 +4,7 @@ export type CreateConfigDto = {
     description?: string;
     value?: ConfigValue;
 };
-/** `value` replaces the whole object — it is not merged. `name` is the lookup key and is not editable here. */
+/** `value` replaces the whole object - it is not merged. `name` is the lookup key and is not editable here. */
 export type UpdateConfigDto = {
     description?: string;
     value?: ConfigValue;

package/dist/configs/index.d.ts

@@ -6,7 +6,7 @@ export type JsonValue = string | number | boolean | null | JsonValue[] | {
 /** The `value` column: one JSON object keyed by setting name. */
 export type ConfigValue = Record<string, JsonValue>;
 /**
- * One named config — a row of `public.configs`. Global: there is no organization on the row.
+ * One named config - a row of `public.configs`. Global: there is no organization on the row.
  * Every signed-in caller may read; only the service role writes. A feature-flag set is just a
  * row someone named in Supabase Studio, not a concept the code knows about.
  */

package/dist/feature-requests/dto/index.d.ts

@@ -1,7 +1,7 @@
 /**
  * The body of `POST /feature-requests`. Every field the endpoint accepts is here: the api's
  * global ValidationPipe runs with `forbidNonWhitelisted`, so anything not on this contract is
- * a 400 — the honeypot included, which is why it is a declared field rather than a stray one.
+ * a 400 - the honeypot included, which is why it is a declared field rather than a stray one.
  *
  * `source` is absent on purpose: the api sets it from `FeatureRequestSource`, never from the
  * request.

package/dist/feature-requests/enum/index.d.ts

@@ -1,5 +1,5 @@
 /**
- * Where a feature request came in from. Stored as text and set server-side by the api — the
+ * Where a feature request came in from. Stored as text and set server-side by the api - the
  * client never sends it, so a second intake (an in-portal "suggest a feature", say) adds a
  * member here rather than trusting a request field.
  */

package/dist/feature-requests/enum/index.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FeatureRequestSource = void 0;
 /**
- * Where a feature request came in from. Stored as text and set server-side by the api — the
+ * Where a feature request came in from. Stored as text and set server-side by the api - the
  * client never sends it, so a second intake (an in-portal "suggest a feature", say) adds a
  * member here rather than trusting a request field.
  */

package/dist/feature-requests/index.d.ts

@@ -6,7 +6,7 @@ export * from './enum';
  *
  * Deliberately tenant-less: the person filling the form has no account, so there is no
  * `organization_id` and no `created_by` to record. The row is read in Supabase Studio and
- * nowhere else — nothing in the portal or on the website ever renders one back.
+ * nowhere else - nothing in the portal or on the website ever renders one back.
  */
 export type FeatureRequestEntity = {
     mms_id: UUID;
@@ -14,7 +14,7 @@ export type FeatureRequestEntity = {
     name: string;
     /** Markdown, as typed. Optional on the form, so an empty submission is stored as null. */
     specification: string | null;
-    /** Whatever the requester called themselves — a person, a company, or both. */
+    /** Whatever the requester called themselves - a person, a company, or both. */
     requester_name: string;
     requester_email: string;
     source: FeatureRequestSource;

package/dist/modules/index.d.ts

@@ -1,6 +1,6 @@
 /**
  * Module keys the API gates features on. These MUST match billing_modules.module_key
- * rows in the database — the database decides which modules exist and what they cost;
+ * rows in the database - the database decides which modules exist and what they cost;
  * this only declares which of them unlock which features.
  *
  * Module selection is never validated against this: requests carry module ids, which
@@ -30,7 +30,7 @@ export type PricedModule = {
     currency: string;
 };
 /**
- * A frozen price list version. Exactly one pricebook is active at a time — the
+ * A frozen price list version. Exactly one pricebook is active at a time - the
  * one new organizations are pinned to and the one an organization moves to when
  * it buys a module. Organizations on older pricebooks keep paying those prices
  * until they change something (grandfathering).

package/dist/modules/index.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MODULE_KEYS = void 0;
 /**
  * Module keys the API gates features on. These MUST match billing_modules.module_key
- * rows in the database — the database decides which modules exist and what they cost;
+ * rows in the database - the database decides which modules exist and what they cost;
  * this only declares which of them unlock which features.
  *
  * Module selection is never validated against this: requests carry module ids, which

package/dist/organization/dto/index.d.ts

@@ -21,7 +21,7 @@ export type CreateOrganizationDto = {
     org_billing_state?: string | null;
     org_billing_postal_code?: string | null;
     org_billing_country?: string | null;
-    /** Terms & conditions acceptance — the API refuses anything but `true`. */
+    /** Terms & conditions acceptance - the API refuses anything but `true`. */
     org_consent_given: true;
     org_industry?: string | null;
     org_marketting_consent_given: boolean;

package/dist/organization/enum/index.d.ts

@@ -3,7 +3,7 @@ export declare enum OrganizationTypes {
     SOLE_TRADER = "Sole-Trader"
 }
 /**
- * How often an organization is billed. Only monthly billing exists today — add
+ * How often an organization is billed. Only monthly billing exists today - add
  * members when the product supports more.
  */
 export declare enum PaymentFrequency {

package/dist/organization/enum/index.js

@@ -8,7 +8,7 @@ var OrganizationTypes;
 })(OrganizationTypes || (exports.OrganizationTypes = OrganizationTypes = {}));
 ;
 /**
- * How often an organization is billed. Only monthly billing exists today — add
+ * How often an organization is billed. Only monthly billing exists today - add
  * members when the product supports more.
  */
 var PaymentFrequency;

package/dist/organization/index.d.ts

@@ -39,7 +39,7 @@ export type OrganizationEntity = {
     leave_calendar_start_month: number;
     billing_cycle_locked: boolean;
     /**
-     * The modules the organization subscribes to, priced at ITS pricebook's rates —
+     * The modules the organization subscribes to, priced at ITS pricebook's rates -
      * i.e. what it actually pays, which may be an older pricebook than the active one.
      */
     modules: PricedModule[];

package/dist/paystack/enum/index.d.ts

@@ -13,7 +13,7 @@ export declare enum PaystackWebhookEvent {
     TRANSACTION_SUCCESSFUL = "charge.success"
 }
 /**
- * Paystack's own subscription vocabulary — an external contract we do not own, so
+ * Paystack's own subscription vocabulary - an external contract we do not own, so
  * this is not necessarily exhaustive. Provided for comparison sites only; the
  * `status` fields on the payload interfaces deliberately stay `string`.
  */
@@ -25,7 +25,7 @@ export declare enum PaystackSubscriptionStatus {
     CANCELLED = "cancelled"
 }
 /**
- * Paystack's own transaction vocabulary — an external contract we do not own, so
+ * Paystack's own transaction vocabulary - an external contract we do not own, so
  * this is not necessarily exhaustive. Provided for comparison sites only; the
  * `status` fields on the payload interfaces deliberately stay `string`.
  * Only SUCCESS means the charge completed and the money moved.

package/dist/paystack/enum/index.js

@@ -18,7 +18,7 @@ var PaystackWebhookEvent;
 })(PaystackWebhookEvent || (exports.PaystackWebhookEvent = PaystackWebhookEvent = {}));
 ;
 /**
- * Paystack's own subscription vocabulary — an external contract we do not own, so
+ * Paystack's own subscription vocabulary - an external contract we do not own, so
  * this is not necessarily exhaustive. Provided for comparison sites only; the
  * `status` fields on the payload interfaces deliberately stay `string`.
  */
@@ -32,7 +32,7 @@ var PaystackSubscriptionStatus;
 })(PaystackSubscriptionStatus || (exports.PaystackSubscriptionStatus = PaystackSubscriptionStatus = {}));
 ;
 /**
- * Paystack's own transaction vocabulary — an external contract we do not own, so
+ * Paystack's own transaction vocabulary - an external contract we do not own, so
  * this is not necessarily exhaustive. Provided for comparison sites only; the
  * `status` fields on the payload interfaces deliberately stay `string`.
  * Only SUCCESS means the charge completed and the money moved.

package/dist/paystack/index.d.ts

@@ -143,7 +143,7 @@ export type PaystackChargeAuthorizationResponse = {
     /**
      * A 2xx from Paystack only means the request was accepted. See
      * PaystackTransactionStatus; only PaystackTransactionStatus.SUCCESS means the
-     * charge completed and the money moved — the rest are failure, pending, or
+     * charge completed and the money moved - the rest are failure, pending, or
      * challenge states such as SEND_OTP when the authorization is not reusable.
      */
     status: string;

package/dist/resend/webhook/index.d.ts

@@ -28,7 +28,7 @@ export type ResendEmailEventData = {
 };
 /**
  * One inbound email as `email.received` delivers it. The payload is metadata
- * only — body text and attachment bytes are fetched from the receiving API
+ * only - body text and attachment bytes are fetched from the receiving API
  * with `email_id`.
  */
 export type ResendInboundEmailData = {

package/dist/support/dto/index.d.ts

@@ -1,11 +1,11 @@
 import type { SupportTopic } from '../enum';
 /**
  * The body of `POST /support`. Every field the endpoint accepts is here: the api's global
- * ValidationPipe runs with `forbidNonWhitelisted`, so anything not on this contract is a 400 —
+ * ValidationPipe runs with `forbidNonWhitelisted`, so anything not on this contract is a 400 -
  * the honeypot included, which is why it is a declared field rather than a stray one.
  *
- * Nothing is stored. The api turns one of these into two emails — the message to the support
- * inbox, and an acknowledgement back to `email` — and that is the whole record of it.
+ * Nothing is stored. The api turns one of these into two emails - the message to the support
+ * inbox, and an acknowledgement back to `email` - and that is the whole record of it.
  */
 export type CreateSupportRequestDto = {
     topic: SupportTopic;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@managemint-solutions/entities",
-  "version": "1.22.0",
+  "version": "1.22.1",
   "description": "Entity types used by both the api and portal",
   "homepage": "https://github.com/ManageMint-Solutions/managemint-solutions-entities#readme",
   "bugs": {