@managemint-solutions/entities 1.11.0 → 1.13.0

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

@@ -9,7 +9,10 @@ export type InvoiceLineItem = {
     quantity: number;
     amount_minor: number;
 };
-/** One row of GET /billing/invoices. */
+/**
+ * One row of GET /billing/invoices. An invoice is the accounting document a monthly
+ * renewal issues; every other charge is a payment only (see ../payments).
+ */
 export type InvoiceSummary = {
     mms_id: string;
     /** Sequential per organization; displayed as INV-000123. */

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

@@ -0,0 +1,11 @@
+export type GetPaymentsDto = {
+    page: number;
+    page_size: number;
+    /** Comma-joined BillingTransactionStatus values on the wire. Absent = all payments. */
+    status_in?: string | null;
+    /** Comma-joined BillingTransactionType values on the wire. Absent = all payments. */
+    type_in?: string | null;
+};
+export type PaymentIdDto = {
+    paymentId: string;
+};

package/dist/billing/payments/dto/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,31 @@
+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
+ * settled. Invoices are the separate accounting documents that only renewals issue.
+ */
+export type PaymentSummary = {
+    mms_id: string;
+    created_at: string;
+    transaction_type: BillingTransactionType;
+    transaction_status: BillingTransactionStatus;
+    amount_minor: number;
+    currency: string;
+    paid_at: string | null;
+    failure_reason: string | null;
+};
+/** The full payment record behind GET /billing/payments/:paymentId. */
+export type PaymentEntity = PaymentSummary & {
+    updated_at: string | null;
+    active_seat_count: number;
+    paid_seat_count: number;
+    modules: string[];
+    /** The per-seat prices the charge was priced from, keyed by module key. */
+    module_price_snapshot: Record<string, number> | null;
+    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. */
+    invoice_id: string | null;
+};

package/dist/billing/payments/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,25 @@
+/**
+ * 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.
+ *
+ * `source` is absent on purpose: the api sets it from `FeatureRequestSource`, never from the
+ * request.
+ */
+export type CreateFeatureRequestDto = {
+    name: string;
+    /** Markdown. Empty is normalised to null before it is stored. */
+    specification?: string | null;
+    requester_name: string;
+    requester_email: string;
+    /**
+     * Honeypot. The website renders it off-screen and always submits it empty; a bot that fills
+     * every input it can see gets a 201 and no stored row. Optional so an older client that does
+     * not send it at all still works.
+     */
+    website_url?: string;
+};
+/** All a submitter gets back: the id of the row, or a throwaway one when the honeypot tripped. */
+export type CreateFeatureRequestResponse = {
+    mms_id: string;
+};

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,8 @@
+/**
+ * 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.
+ */
+export declare enum FeatureRequestSource {
+    WEBSITE = "website"
+}

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

@@ -0,0 +1,13 @@
+"use strict";
+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
+ * 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.
+ */
+var FeatureRequestSource;
+(function (FeatureRequestSource) {
+    FeatureRequestSource["WEBSITE"] = "website";
+})(FeatureRequestSource || (exports.FeatureRequestSource = FeatureRequestSource = {}));
+;

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

@@ -0,0 +1,21 @@
+import type { UUID } from 'crypto';
+import { FeatureRequestSource } from './enum';
+export * from './enum';
+/**
+ * A "I need something" submission from the marketing website's roadmap page.
+ *
+ * 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.
+ */
+export type FeatureRequestEntity = {
+    mms_id: UUID;
+    created_at: string;
+    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. */
+    requester_name: string;
+    requester_email: string;
+    source: FeatureRequestSource;
+};

package/dist/feature-requests/index.js

@@ -0,0 +1,17 @@
+"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 });
+__exportStar(require("./enum"), exports);

package/package.json

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