@abyss-project/main 11.8.0 → 12.0.0

package/dist/types/interface/models/commercial-gesture.model.d.ts

@@ -0,0 +1,39 @@
+import { CommercialGestureDestination, CommercialGestureMode, CommercialGestureReason, CommercialGestureStatus } from '../../enum';
+import type { IBillingAccount } from './billing-account.model';
+import type { ICreditNote } from './credit-note.model';
+import type { IInvoice } from './invoice.model';
+import type { IInvoiceLine } from './invoice-line.model';
+export interface ICommercialGesture {
+    id?: string;
+    billingAccountId: string;
+    invoiceId: string;
+    mode: CommercialGestureMode;
+    amountEurCents: number;
+    requestedPercent?: number | null;
+    reason: CommercialGestureReason;
+    internalComment: string | null;
+    customerMessage: string | null;
+    destination: CommercialGestureDestination;
+    status: CommercialGestureStatus;
+    failureReason: string | null;
+    grantedByAdminId: string;
+    supportTicketId: string | null;
+    idempotencyKey: string;
+    creditNoteId: string | null;
+    updatedAt?: Date;
+    createdAt?: Date;
+    billingAccount?: IBillingAccount;
+    invoice?: IInvoice;
+    lines?: ICommercialGestureLine[];
+    creditNote?: ICreditNote | null;
+}
+export interface ICommercialGestureLine {
+    id?: string;
+    gestureId: string;
+    invoiceLineId: string;
+    amountEurCents: number;
+    updatedAt?: Date;
+    createdAt?: Date;
+    gesture?: ICommercialGesture;
+    invoiceLine?: IInvoiceLine;
+}

package/dist/types/interface/models/commercial-gesture.model.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=commercial-gesture.model.js.map

package/dist/types/interface/models/commercial-gesture.model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"commercial-gesture.model.js","sourceRoot":"","sources":["../../../../src/types/interface/models/commercial-gesture.model.ts"],"names":[],"mappings":""}

package/dist/types/interface/models/credit-note.model.d.ts

@@ -0,0 +1,17 @@
+import { CommercialGestureDestination } from '../../enum';
+import type { IBillingAccount } from './billing-account.model';
+import type { IInvoice } from './invoice.model';
+export interface ICreditNote {
+    id?: string;
+    number: string;
+    invoiceId: string;
+    billingAccountId: string;
+    amountEurCents: number;
+    destination: CommercialGestureDestination;
+    stripeCreditNoteId: string;
+    issuedAt: Date;
+    updatedAt?: Date;
+    createdAt?: Date;
+    invoice?: IInvoice;
+    billingAccount?: IBillingAccount;
+}

package/dist/types/interface/models/credit-note.model.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=credit-note.model.js.map

package/dist/types/interface/models/credit-note.model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"credit-note.model.js","sourceRoot":"","sources":["../../../../src/types/interface/models/credit-note.model.ts"],"names":[],"mappings":""}

package/dist/types/interface/models/index.d.ts

@@ -23,6 +23,9 @@ export * from './organization-service-quota.model';
 export * from './organization-project-quota.model';
 export * from './usage-record.model';
 export * from './invoice.model';
+export * from './invoice-line.model';
+export * from './commercial-gesture.model';
+export * from './credit-note.model';
 export * from './credit-transaction.model';
 export * from './eur-transaction.model';
 export * from './organization-quota-alert.model';

package/dist/types/interface/models/index.js

@@ -39,6 +39,9 @@ __exportStar(require("./organization-service-quota.model"), exports);
 __exportStar(require("./organization-project-quota.model"), exports);
 __exportStar(require("./usage-record.model"), exports);
 __exportStar(require("./invoice.model"), exports);
+__exportStar(require("./invoice-line.model"), exports);
+__exportStar(require("./commercial-gesture.model"), exports);
+__exportStar(require("./credit-note.model"), exports);
 __exportStar(require("./credit-transaction.model"), exports);
 __exportStar(require("./eur-transaction.model"), exports);
 __exportStar(require("./organization-quota-alert.model"), exports);

package/dist/types/interface/models/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/types/interface/models/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B;AAC7B,kDAAgC;AAChC,yDAAuC;AACvC,qEAAmD;AACnD,sDAAoC;AACpC,4DAA0C;AAC1C,wDAAsC;AACtC,wDAAsC;AACtC,uDAAqC;AACrC,4DAA0C;AAC1C,6DAA2C;AAG3C,oDAAkC;AAClC,+DAA6C;AAG7C,gDAA8B;AAG9B,iDAA+B;AAG/B,uDAAqC;AACrC,mEAAiD;AACjD,8DAA4C;AAG5C,wDAAsC;AACtC,0DAAwC;AACxC,gEAA8C;AAC9C,qEAAmD;AACnD,qEAAmD;AACnD,uDAAqC;AACrC,kDAAgC;AAChC,6DAA2C;AAC3C,0DAAwC;AACxC,mEAAiD;AACjD,sDAAoC;AACpC,+DAA6C;AAC7C,4DAA0C;AAC1C,4DAA0C;AAC1C,2DAAyC;AACzC,8DAA4C;AAC5C,iEAA+C;AAC/C,wDAAsC;AACtC,uDAAqC;AACrC,8DAA4C;AAC5C,+CAA6B;AAC7B,sDAAoC;AACpC,8DAA4C;AAC5C,0EAAwD;AACxD,0DAAwC;AACxC,6EAA2D;AAG3D,2DAAyC;AAGzC,4DAA0C;AAG1C,wDAAsC;AAGtC,yDAAuC;AACvC,iEAA+C;AAC/C,oEAAkD;AAClD,yDAAuC;AACvC,6DAA2C;AAC3C,kEAAgD;AAGhD,qDAAmC;AAGnC,qDAAmC;AAGnC,8DAA4C;AAG5C,8DAA4C;AAG5C,2DAAyC;AAGzC,0DAAwC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/types/interface/models/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B;AAC7B,kDAAgC;AAChC,yDAAuC;AACvC,qEAAmD;AACnD,sDAAoC;AACpC,4DAA0C;AAC1C,wDAAsC;AACtC,wDAAsC;AACtC,uDAAqC;AACrC,4DAA0C;AAC1C,6DAA2C;AAG3C,oDAAkC;AAClC,+DAA6C;AAG7C,gDAA8B;AAG9B,iDAA+B;AAG/B,uDAAqC;AACrC,mEAAiD;AACjD,8DAA4C;AAG5C,wDAAsC;AACtC,0DAAwC;AACxC,gEAA8C;AAC9C,qEAAmD;AACnD,qEAAmD;AACnD,uDAAqC;AACrC,kDAAgC;AAChC,uDAAqC;AACrC,6DAA2C;AAC3C,sDAAoC;AACpC,6DAA2C;AAC3C,0DAAwC;AACxC,mEAAiD;AACjD,sDAAoC;AACpC,+DAA6C;AAC7C,4DAA0C;AAC1C,4DAA0C;AAC1C,2DAAyC;AACzC,8DAA4C;AAC5C,iEAA+C;AAC/C,wDAAsC;AACtC,uDAAqC;AACrC,8DAA4C;AAC5C,+CAA6B;AAC7B,sDAAoC;AACpC,8DAA4C;AAC5C,0EAAwD;AACxD,0DAAwC;AACxC,6EAA2D;AAG3D,2DAAyC;AAGzC,4DAA0C;AAG1C,wDAAsC;AAGtC,yDAAuC;AACvC,iEAA+C;AAC/C,oEAAkD;AAClD,yDAAuC;AACvC,6DAA2C;AAC3C,kEAAgD;AAGhD,qDAAmC;AAGnC,qDAAmC;AAGnC,8DAA4C;AAG5C,8DAA4C;AAG5C,2DAAyC;AAGzC,0DAAwC"}

package/dist/types/interface/models/invoice-line.model.d.ts

@@ -0,0 +1,25 @@
+import { BillingMetric, BillingService, InvoiceLineType } from '../../enum';
+import { BillingModuleId } from '../../../constants/module-catalog.constants';
+import type { PlanNameKey } from '../../../plan-name/plan-name.utils';
+import type { IInvoice } from './invoice.model';
+export interface IInvoiceLine {
+    id?: string;
+    invoiceId: string;
+    position: number;
+    type: InvoiceLineType;
+    label: string;
+    amountEurCents: number;
+    quantity: number | null;
+    unitPriceEur: number | null;
+    service: BillingService | null;
+    metric: BillingMetric | null;
+    moduleId: BillingModuleId | null;
+    planNameKey: PlanNameKey | null;
+    periodStart: Date | null;
+    periodEnd: Date | null;
+    proration: boolean;
+    stripeInvoiceLineItemId: string | null;
+    updatedAt?: Date;
+    createdAt?: Date;
+    invoice?: IInvoice;
+}

package/dist/types/interface/models/invoice-line.model.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=invoice-line.model.js.map

package/dist/types/interface/models/invoice-line.model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"invoice-line.model.js","sourceRoot":"","sources":["../../../../src/types/interface/models/invoice-line.model.ts"],"names":[],"mappings":""}

package/dist/types/interface/models/invoice.model.d.ts

@@ -1,8 +1,16 @@
-import { InvoiceStatus, InvoiceType, OrganizationLegalForm } from '../../enum';
+import { CommercialGestureRequestBasis, InvoiceStatus, InvoiceType, OrganizationLegalForm } from '../../enum';
 import { IBillingAccount, IBillingAddress } from './billing-account.model';
 import { IUsageRecord } from './usage-record.model';
 import type { ICreditTransaction } from './credit-transaction.model';
 import type { IEurTransaction } from './eur-transaction.model';
+import type { IInvoiceLine } from './invoice-line.model';
+import type { ICommercialGesture } from './commercial-gesture.model';
+import type { ICreditNote } from './credit-note.model';
+export interface IInvoiceCommercialGestureRequest {
+    eligible: boolean;
+    basis: CommercialGestureRequestBasis | null;
+    ticketId: string | null;
+}
 export interface IInvoice {
     id?: string;
     billingAccountId: string;
@@ -15,10 +23,13 @@ export interface IInvoice {
     overageTotalEur: number;
     totalEur: number;
     stripeInvoiceId: string | null;
+    stripeInvoiceNumber: string | null;
     stripeInvoiceUrl: string | null;
     stripePaymentIntentId: string | null;
     dueDate: Date | null;
     paidAt: Date | null;
+    nextCollectAttemptAt: Date | null;
+    collectAttemptCount: number;
     metadata: Record<string, unknown>;
     billingName: string | null;
     billingEmail: string | null;
@@ -32,4 +43,8 @@ export interface IInvoice {
     usageRecords?: IUsageRecord[];
     creditTransactions?: ICreditTransaction[];
     eurTransactions?: IEurTransaction[];
+    lines?: IInvoiceLine[];
+    commercialGestures?: ICommercialGesture[];
+    creditNotes?: ICreditNote[];
+    commercialGestureRequest?: IInvoiceCommercialGestureRequest;
 }

package/dist/utils/index.d.ts

@@ -22,6 +22,7 @@ export * from './pricing-calculator.utils';
 export * from './content-share-scope.utils';
 export * from './invitation.utils';
 export * from './invoice-amounts.utils';
+export * from './invoice-line-label.utils';
 export * from './resolve-user.utils';
 export * from './pricing.utils';
 export * from './plan-capacity.utils';

package/dist/utils/index.js

@@ -38,6 +38,7 @@ __exportStar(require("./pricing-calculator.utils"), exports);
 __exportStar(require("./content-share-scope.utils"), exports);
 __exportStar(require("./invitation.utils"), exports);
 __exportStar(require("./invoice-amounts.utils"), exports);
+__exportStar(require("./invoice-line-label.utils"), exports);
 __exportStar(require("./resolve-user.utils"), exports);
 __exportStar(require("./pricing.utils"), exports);
 __exportStar(require("./plan-capacity.utils"), exports);

package/dist/utils/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wDAAsC;AACtC,gDAA8B;AAC9B,0DAAwC;AACxC,+CAA6B;AAC7B,iDAA+B;AAC/B,uDAAqC;AACrC,gDAA8B;AAC9B,gDAA8B;AAC9B,gDAA8B;AAC9B,gDAA8B;AAC9B,+CAA6B;AAC7B,sDAAoC;AACpC,iDAA+B;AAC/B,mDAAiC;AACjC,mDAAiC;AACjC,sDAAoC;AACpC,kDAAgC;AAChC,wDAAsC;AACtC,wDAAsC;AACtC,wDAAsC;AACtC,6DAA2C;AAC3C,8DAA4C;AAC5C,qDAAmC;AACnC,0DAAwC;AACxC,uDAAqC;AAIrC,kDAAgC;AAChC,wDAAsC;AACtC,4DAA0C"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wDAAsC;AACtC,gDAA8B;AAC9B,0DAAwC;AACxC,+CAA6B;AAC7B,iDAA+B;AAC/B,uDAAqC;AACrC,gDAA8B;AAC9B,gDAA8B;AAC9B,gDAA8B;AAC9B,gDAA8B;AAC9B,+CAA6B;AAC7B,sDAAoC;AACpC,iDAA+B;AAC/B,mDAAiC;AACjC,mDAAiC;AACjC,sDAAoC;AACpC,kDAAgC;AAChC,wDAAsC;AACtC,wDAAsC;AACtC,wDAAsC;AACtC,6DAA2C;AAC3C,8DAA4C;AAC5C,qDAAmC;AACnC,0DAAwC;AACxC,6DAA2C;AAC3C,uDAAqC;AAIrC,kDAAgC;AAChC,wDAAsC;AACtC,4DAA0C"}

package/dist/utils/invoice-amounts.utils.d.ts

@@ -1,9 +1,10 @@
 import type { IInvoice } from '../types/interface';
-export type InvoiceAmounts = {
-    grossEur: number;
-    overageEur: number;
-    creditUsed: number;
-    eurWalletUsed: number;
-    netTotalEur: number;
-};
-export declare const computeInvoiceAmounts: (invoice: IInvoice) => InvoiceAmounts;
+export interface IInvoiceAmounts {
+    grossEurCents: number;
+    deductionsEurCents: number;
+    gesturesEurCents: number;
+    netEurCents: number;
+    paidEurCents: number;
+    remainingEurCents: number;
+}
+export declare const computeInvoiceAmounts: (invoice: IInvoice) => IInvoiceAmounts;

package/dist/utils/invoice-amounts.utils.js

@@ -2,20 +2,38 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.computeInvoiceAmounts = void 0;
 const enum_1 = require("../types/enum");
+const OWED_STATUSES = new Set([
+    enum_1.InvoiceStatus.OPEN,
+    enum_1.InvoiceStatus.UNCOLLECTIBLE,
+]);
 const computeInvoiceAmounts = (invoice) => {
-    const creditUsed = (invoice.creditTransactions ?? [])
-        .filter((t) => t.amount < 0)
-        .reduce((sum, t) => sum + Math.abs(t.amount), 0);
-    const eurWalletUsed = (invoice.eurTransactions ?? [])
-        .filter((t) => t.amount < 0 && t.type === enum_1.EurTransactionType.INVOICE_DEDUCTION)
-        .reduce((sum, t) => sum + Math.abs(t.amount), 0);
-    const netSubtotal = invoice.subtotalEur ?? invoice.totalEur;
+    let grossEurCents = 0;
+    let deductionsEurCents = 0;
+    for (const line of invoice.lines ?? []) {
+        if (enum_1.INVOICE_DEDUCTION_LINE_TYPES.includes(line.type)) {
+            deductionsEurCents -= line.amountEurCents;
+        }
+        else {
+            grossEurCents += line.amountEurCents;
+        }
+    }
+    const applied = (invoice.commercialGestures ?? []).filter((gesture) => gesture.status === enum_1.CommercialGestureStatus.APPLIED);
+    const gesturesEurCents = applied.reduce((sum, gesture) => sum + gesture.amountEurCents, 0);
+    const reducedBeforePaymentEurCents = applied
+        .filter((gesture) => gesture.destination === enum_1.CommercialGestureDestination.REDUCE_AMOUNT_DUE)
+        .reduce((sum, gesture) => sum + gesture.amountEurCents, 0);
+    const netEurCents = grossEurCents - deductionsEurCents - gesturesEurCents;
+    const paidEurCents = invoice.status === enum_1.InvoiceStatus.PAID
+        ? grossEurCents - deductionsEurCents - reducedBeforePaymentEurCents
+        : 0;
+    const remainingEurCents = OWED_STATUSES.has(invoice.status) ? Math.max(0, netEurCents) : 0;
     return {
-        grossEur: netSubtotal + creditUsed + eurWalletUsed,
-        overageEur: invoice.overageTotalEur ?? 0,
-        creditUsed,
-        eurWalletUsed,
-        netTotalEur: invoice.totalEur,
+        grossEurCents,
+        deductionsEurCents,
+        gesturesEurCents,
+        netEurCents,
+        paidEurCents,
+        remainingEurCents,
     };
 };
 exports.computeInvoiceAmounts = computeInvoiceAmounts;

package/dist/utils/invoice-amounts.utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"invoice-amounts.utils.js","sourceRoot":"","sources":["../../src/utils/invoice-amounts.utils.ts"],"names":[],"mappings":";;;AAAA,wCAAmD;AAiC5C,MAAM,qBAAqB,GAAG,CAAC,OAAiB,EAAkB,EAAE;IACzE,MAAM,UAAU,GAAG,CAAC,OAAO,CAAC,kBAAkB,IAAI,EAAE,CAAC;SAClD,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;SAC3B,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;IAEnD,MAAM,aAAa,GAAG,CAAC,OAAO,CAAC,eAAe,IAAI,EAAE,CAAC;SAClD,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,yBAAkB,CAAC,iBAAiB,CAAC;SAC9E,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;IAEnD,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,OAAO,CAAC,QAAQ,CAAC;IAE5D,OAAO;QACL,QAAQ,EAAE,WAAW,GAAG,UAAU,GAAG,aAAa;QAClD,UAAU,EAAE,OAAO,CAAC,eAAe,IAAI,CAAC;QACxC,UAAU;QACV,aAAa;QACb,WAAW,EAAE,OAAO,CAAC,QAAQ;KAC9B,CAAC;AACJ,CAAC,CAAC;AAlBW,QAAA,qBAAqB,yBAkBhC"}
+{"version":3,"file":"invoice-amounts.utils.js","sourceRoot":"","sources":["../../src/utils/invoice-amounts.utils.ts"],"names":[],"mappings":";;;AAAA,wCAKuB;AAuBvB,MAAM,aAAa,GAA+B,IAAI,GAAG,CAAC;IACxD,oBAAa,CAAC,IAAI;IAClB,oBAAa,CAAC,aAAa;CAC5B,CAAC,CAAC;AAoBI,MAAM,qBAAqB,GAAG,CAAC,OAAiB,EAAmB,EAAE;IAC1E,IAAI,aAAa,GAAG,CAAC,CAAC;IACtB,IAAI,kBAAkB,GAAG,CAAC,CAAC;IAC3B,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,KAAK,IAAI,EAAE,EAAE,CAAC;QACvC,IAAI,mCAA4B,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACrD,kBAAkB,IAAI,IAAI,CAAC,cAAc,CAAC;QAC5C,CAAC;aAAM,CAAC;YACN,aAAa,IAAI,IAAI,CAAC,cAAc,CAAC;QACvC,CAAC;IACH,CAAC;IAED,MAAM,OAAO,GAAG,CAAC,OAAO,CAAC,kBAAkB,IAAI,EAAE,CAAC,CAAC,MAAM,CACvD,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,KAAK,8BAAuB,CAAC,OAAO,CAChE,CAAC;IACF,MAAM,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,GAAG,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;IAC3F,MAAM,4BAA4B,GAAG,OAAO;SACzC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,WAAW,KAAK,mCAA4B,CAAC,iBAAiB,CAAC;SAC3F,MAAM,CAAC,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,GAAG,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;IAE7D,MAAM,WAAW,GAAG,aAAa,GAAG,kBAAkB,GAAG,gBAAgB,CAAC;IAC1E,MAAM,YAAY,GAChB,OAAO,CAAC,MAAM,KAAK,oBAAa,CAAC,IAAI;QACnC,CAAC,CAAC,aAAa,GAAG,kBAAkB,GAAG,4BAA4B;QACnE,CAAC,CAAC,CAAC,CAAC;IACR,MAAM,iBAAiB,GAAG,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAE3F,OAAO;QACL,aAAa;QACb,kBAAkB;QAClB,gBAAgB;QAChB,WAAW;QACX,YAAY;QACZ,iBAAiB;KAClB,CAAC;AACJ,CAAC,CAAC;AAlCW,QAAA,qBAAqB,yBAkChC"}

package/dist/utils/invoice-line-label.utils.d.ts

@@ -0,0 +1,26 @@
+import { BillingModuleId } from '../constants/module-catalog.constants';
+import type { PlanNameKey } from '../plan-name/plan-name.utils';
+import { BillingMetric, BillingService, InvoiceLineType } from '../types/enum/organization-billing.enum';
+import { UserLanguage } from '../types/enum/user-language.enum';
+export declare const formatOverageLineLabel: (line: {
+    metric: BillingMetric | null;
+    quantity: number | null;
+}, language: UserLanguage) => string;
+export declare const formatInvoiceUnitPrice: (unitPriceEur: number, locale: string) => string;
+export declare const BILLING_SERVICE_NAMES: Record<BillingService, string>;
+export declare const formatOverageLineName: (line: {
+    metric: BillingMetric | null;
+    service: BillingService | null;
+}, language: UserLanguage) => string | null;
+export type PlanLineType = InvoiceLineType.SUBSCRIPTION | InvoiceLineType.PLAN_UPGRADE | InvoiceLineType.MODULE;
+export declare const isPlanLineType: (type: InvoiceLineType) => type is PlanLineType;
+export type PlanLineLabelFields = {
+    type: PlanLineType;
+    amountEurCents: number;
+    planNameKey: PlanNameKey | null;
+    moduleId: BillingModuleId | null;
+    proration: boolean;
+    periodStart: Date | null;
+    periodEnd: Date | null;
+};
+export declare const formatPlanLineLabel: (line: PlanLineLabelFields, language: UserLanguage) => string;

package/dist/utils/invoice-line-label.utils.js

@@ -0,0 +1,125 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatPlanLineLabel = exports.isPlanLineType = exports.formatOverageLineName = exports.BILLING_SERVICE_NAMES = exports.formatInvoiceUnitPrice = exports.formatOverageLineLabel = void 0;
+const billing_metric_label_labels_1 = require("../billing-metric-label/billing-metric-label.labels");
+const module_catalog_constants_1 = require("../constants/module-catalog.constants");
+const plan_name_labels_1 = require("../plan-name/plan-name.labels");
+const organization_billing_enum_1 = require("../types/enum/organization-billing.enum");
+const user_language_enum_1 = require("../types/enum/user-language.enum");
+const user_language_utils_1 = require("./user-language.utils");
+const OVERAGE_WORD = {
+    [user_language_enum_1.UserLanguage.FRENCH]: 'Dépassement',
+    [user_language_enum_1.UserLanguage.ENGLISH]: 'Overage',
+};
+const formatOverageLineLabel = (line, language) => {
+    if (!line.metric) {
+        return OVERAGE_WORD[language];
+    }
+    const label = `${OVERAGE_WORD[language]} — ${(0, billing_metric_label_labels_1.billingMetricLabel)(line.metric, language)}`;
+    if (line.quantity === null) {
+        return label;
+    }
+    const quantity = new Intl.NumberFormat((0, user_language_utils_1.userLanguageToLocale)(language), {
+        maximumFractionDigits: 2,
+    }).format(line.quantity);
+    return `${label} × ${quantity}`;
+};
+exports.formatOverageLineLabel = formatOverageLineLabel;
+const UNIT_PRICE_SIGNIFICANT_DIGITS = 6;
+const formatInvoiceUnitPrice = (unitPriceEur, locale) => {
+    const magnitude = unitPriceEur === 0 ? 0 : Math.floor(Math.log10(Math.abs(unitPriceEur)));
+    const fractionDigits = Math.min(20, Math.max(2, UNIT_PRICE_SIGNIFICANT_DIGITS - 1 - magnitude));
+    return new Intl.NumberFormat(locale, {
+        style: 'currency',
+        currency: 'EUR',
+        minimumFractionDigits: 2,
+        maximumFractionDigits: fractionDigits,
+    }).format(unitPriceEur);
+};
+exports.formatInvoiceUnitPrice = formatInvoiceUnitPrice;
+exports.BILLING_SERVICE_NAMES = {
+    [organization_billing_enum_1.BillingService.ABYSS_PLATFORM]: 'AbyssProject',
+    [organization_billing_enum_1.BillingService.ABYSS_STORAGE]: 'AbyssStorage',
+    [organization_billing_enum_1.BillingService.ABYSS_MONITOR]: 'AbyssMonitor',
+    [organization_billing_enum_1.BillingService.ABYSS_CLOUD]: 'AbyssCloud',
+    [organization_billing_enum_1.BillingService.ABYSS_CRYPT]: 'AbyssCrypt',
+    [organization_billing_enum_1.BillingService.ABYSS_FORM]: 'AbyssForm',
+    [organization_billing_enum_1.BillingService.ABYSS_TOOLS]: 'AbyssTools',
+    [organization_billing_enum_1.BillingService.ABYSS_SPOTLIGHT]: 'AbyssSpotlight',
+    [organization_billing_enum_1.BillingService.ABYSS_TRAINING]: 'AbyssTraining',
+    [organization_billing_enum_1.BillingService.ABYSS_MEMORIES]: 'AbyssMemories',
+    [organization_billing_enum_1.BillingService.ABYSS_BANKING]: 'AbyssBanking',
+};
+const formatOverageLineName = (line, language) => {
+    if (!line.metric) {
+        return null;
+    }
+    const metric = (0, billing_metric_label_labels_1.billingMetricLabel)(line.metric, language) ?? line.metric;
+    if (!line.service) {
+        return metric;
+    }
+    return `${metric} · ${exports.BILLING_SERVICE_NAMES[line.service] ?? line.service}`;
+};
+exports.formatOverageLineName = formatOverageLineName;
+const PLAN_LINE_TYPES = new Set([
+    organization_billing_enum_1.InvoiceLineType.SUBSCRIPTION,
+    organization_billing_enum_1.InvoiceLineType.PLAN_UPGRADE,
+    organization_billing_enum_1.InvoiceLineType.MODULE,
+]);
+const isPlanLineType = (type) => PLAN_LINE_TYPES.has(type);
+exports.isPlanLineType = isPlanLineType;
+const PLAN_LINE_WORDS = {
+    [user_language_enum_1.UserLanguage.FRENCH]: {
+        subscription: (plan) => (plan ? `Abonnement ${plan}` : 'Abonnement'),
+        planChange: (plan) => (plan ? `Passage à l’abonnement ${plan}` : 'Changement de plan'),
+        module: (module) => (module ? `Module ${module}` : 'Module'),
+        remainingTime: (subject) => `Temps restant sur ${subject}`,
+        unusedTime: (subject) => `Temps non utilisé sur ${subject}`,
+        planSubject: (plan) => (plan ? `l’abonnement ${plan}` : 'l’abonnement'),
+        moduleSubject: (module) => (module ? `le module ${module}` : 'le module'),
+        period: (start, end) => `du ${start} au ${end}`,
+    },
+    [user_language_enum_1.UserLanguage.ENGLISH]: {
+        subscription: (plan) => (plan ? `${plan} subscription` : 'Subscription'),
+        planChange: (plan) => (plan ? `Upgrade to the ${plan} subscription` : 'Plan change'),
+        module: (module) => (module ? `${module} module` : 'Module'),
+        remainingTime: (subject) => `Remaining time on ${subject}`,
+        unusedTime: (subject) => `Unused time on ${subject}`,
+        planSubject: (plan) => (plan ? `the ${plan} subscription` : 'the subscription'),
+        moduleSubject: (module) => (module ? `the ${module} module` : 'the module'),
+        period: (start, end) => `from ${start} to ${end}`,
+    },
+};
+const formatPlanLineLabel = (line, language) => {
+    const words = PLAN_LINE_WORDS[language];
+    const plan = line.planNameKey ? plan_name_labels_1.PLAN_NAME_LABELS[language][line.planNameKey] ?? null : null;
+    const module = line.moduleId ? (0, module_catalog_constants_1.moduleById)(line.moduleId)?.label ?? null : null;
+    const isModule = line.type === organization_billing_enum_1.InvoiceLineType.MODULE;
+    let label;
+    if (line.proration) {
+        const subject = isModule ? words.moduleSubject(module) : words.planSubject(plan);
+        label = line.amountEurCents < 0 ? words.unusedTime(subject) : words.remainingTime(subject);
+    }
+    else if (isModule) {
+        label = words.module(module);
+    }
+    else if (line.type === organization_billing_enum_1.InvoiceLineType.PLAN_UPGRADE) {
+        label = words.planChange(plan);
+    }
+    else {
+        label = words.subscription(plan);
+    }
+    if (!line.periodStart || !line.periodEnd) {
+        return label;
+    }
+    const date = new Intl.DateTimeFormat((0, user_language_utils_1.userLanguageToLocale)(language), {
+        day: 'numeric',
+        month: 'short',
+        year: 'numeric',
+        timeZone: 'UTC',
+    });
+    const period = words.period(date.format(new Date(line.periodStart)), date.format(new Date(line.periodEnd)));
+    return `${label} (${period})`;
+};
+exports.formatPlanLineLabel = formatPlanLineLabel;
+//# sourceMappingURL=invoice-line-label.utils.js.map

package/dist/utils/invoice-line-label.utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"invoice-line-label.utils.js","sourceRoot":"","sources":["../../src/utils/invoice-line-label.utils.ts"],"names":[],"mappings":";;;AAAA,qGAAyF;AACzF,oFAAoF;AACpF,oEAAiE;AAEjE,uFAIiD;AACjD,yEAAgE;AAChE,+DAA6D;AAE7D,MAAM,YAAY,GAAiC;IACjD,CAAC,iCAAY,CAAC,MAAM,CAAC,EAAE,aAAa;IACpC,CAAC,iCAAY,CAAC,OAAO,CAAC,EAAE,SAAS;CAClC,CAAC;AASK,MAAM,sBAAsB,GAAG,CACpC,IAA+D,EAC/D,QAAsB,EACd,EAAE;IACV,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QACjB,OAAO,YAAY,CAAC,QAAQ,CAAC,CAAC;IAChC,CAAC;IACD,MAAM,KAAK,GAAG,GAAG,YAAY,CAAC,QAAQ,CAAC,MAAM,IAAA,gDAAkB,EAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,CAAC;IACzF,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;QAC3B,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,QAAQ,GAAG,IAAI,IAAI,CAAC,YAAY,CAAC,IAAA,0CAAoB,EAAC,QAAQ,CAAC,EAAE;QACrE,qBAAqB,EAAE,CAAC;KACzB,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzB,OAAO,GAAG,KAAK,MAAM,QAAQ,EAAE,CAAC;AAClC,CAAC,CAAC;AAfW,QAAA,sBAAsB,0BAejC;AAGF,MAAM,6BAA6B,GAAG,CAAC,CAAC;AAQjC,MAAM,sBAAsB,GAAG,CAAC,YAAoB,EAAE,MAAc,EAAU,EAAE;IACrF,MAAM,SAAS,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAC1F,MAAM,cAAc,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,6BAA6B,GAAG,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC;IAChG,OAAO,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE;QACnC,KAAK,EAAE,UAAU;QACjB,QAAQ,EAAE,KAAK;QACf,qBAAqB,EAAE,CAAC;QACxB,qBAAqB,EAAE,cAAc;KACtC,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;AAC1B,CAAC,CAAC;AATW,QAAA,sBAAsB,0BASjC;AAOW,QAAA,qBAAqB,GAAmC;IACnE,CAAC,0CAAc,CAAC,cAAc,CAAC,EAAE,cAAc;IAC/C,CAAC,0CAAc,CAAC,aAAa,CAAC,EAAE,cAAc;IAC9C,CAAC,0CAAc,CAAC,aAAa,CAAC,EAAE,cAAc;IAC9C,CAAC,0CAAc,CAAC,WAAW,CAAC,EAAE,YAAY;IAC1C,CAAC,0CAAc,CAAC,WAAW,CAAC,EAAE,YAAY;IAC1C,CAAC,0CAAc,CAAC,UAAU,CAAC,EAAE,WAAW;IACxC,CAAC,0CAAc,CAAC,WAAW,CAAC,EAAE,YAAY;IAC1C,CAAC,0CAAc,CAAC,eAAe,CAAC,EAAE,gBAAgB;IAClD,CAAC,0CAAc,CAAC,cAAc,CAAC,EAAE,eAAe;IAChD,CAAC,0CAAc,CAAC,cAAc,CAAC,EAAE,eAAe;IAChD,CAAC,0CAAc,CAAC,aAAa,CAAC,EAAE,cAAc;CAC/C,CAAC;AASK,MAAM,qBAAqB,GAAG,CACnC,IAAsE,EACtE,QAAsB,EACP,EAAE;IACjB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QACjB,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,MAAM,GAAG,IAAA,gDAAkB,EAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC;IACxE,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;QAClB,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,OAAO,GAAG,MAAM,MAAM,6BAAqB,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;AAC9E,CAAC,CAAC;AAZW,QAAA,qBAAqB,yBAYhC;AAQF,MAAM,eAAe,GAAiC,IAAI,GAAG,CAAC;IAC5D,2CAAe,CAAC,YAAY;IAC5B,2CAAe,CAAC,YAAY;IAC5B,2CAAe,CAAC,MAAM;CACvB,CAAC,CAAC;AAGI,MAAM,cAAc,GAAG,CAAC,IAAqB,EAAwB,EAAE,CAC5E,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AADf,QAAA,cAAc,kBACC;AAyB5B,MAAM,eAAe,GAAwC;IAC3D,CAAC,iCAAY,CAAC,MAAM,CAAC,EAAE;QACrB,YAAY,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,cAAc,IAAI,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC;QACpE,UAAU,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,0BAA0B,IAAI,EAAE,CAAC,CAAC,CAAC,oBAAoB,CAAC;QACtF,MAAM,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,UAAU,MAAM,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;QAC5D,aAAa,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,qBAAqB,OAAO,EAAE;QAC1D,UAAU,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,yBAAyB,OAAO,EAAE;QAC3D,WAAW,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,gBAAgB,IAAI,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC;QACvE,aAAa,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,aAAa,MAAM,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC;QACzE,MAAM,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,MAAM,KAAK,OAAO,GAAG,EAAE;KAChD;IACD,CAAC,iCAAY,CAAC,OAAO,CAAC,EAAE;QACtB,YAAY,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,eAAe,CAAC,CAAC,CAAC,cAAc,CAAC;QACxE,UAAU,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,kBAAkB,IAAI,eAAe,CAAC,CAAC,CAAC,aAAa,CAAC;QACpF,MAAM,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC;QAC5D,aAAa,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,qBAAqB,OAAO,EAAE;QAC1D,UAAU,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,kBAAkB,OAAO,EAAE;QACpD,WAAW,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,IAAI,eAAe,CAAC,CAAC,CAAC,kBAAkB,CAAC;QAC/E,aAAa,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,MAAM,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC;QAC3E,MAAM,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,QAAQ,KAAK,OAAO,GAAG,EAAE;KAClD;CACF,CAAC;AAeK,MAAM,mBAAmB,GAAG,CAAC,IAAyB,EAAE,QAAsB,EAAU,EAAE;IAC/F,MAAM,KAAK,GAAG,eAAe,CAAC,QAAQ,CAAC,CAAC;IACxC,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,mCAAgB,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;IAC5F,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAA,qCAAU,EAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;IAC/E,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,KAAK,2CAAe,CAAC,MAAM,CAAC;IAEtD,IAAI,KAAa,CAAC;IAClB,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;QACnB,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACjF,KAAK,GAAG,IAAI,CAAC,cAAc,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IAC7F,CAAC;SAAM,IAAI,QAAQ,EAAE,CAAC;QACpB,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC/B,CAAC;SAAM,IAAI,IAAI,CAAC,IAAI,KAAK,2CAAe,CAAC,YAAY,EAAE,CAAC;QACtD,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;SAAM,CAAC;QACN,KAAK,GAAG,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IAED,IAAI,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;QACzC,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,cAAc,CAAC,IAAA,0CAAoB,EAAC,QAAQ,CAAC,EAAE;QACnE,GAAG,EAAE,SAAS;QACd,KAAK,EAAE,OAAO;QACd,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,KAAK;KAChB,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CACzB,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,EACvC,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CACtC,CAAC;IACF,OAAO,GAAG,KAAK,KAAK,MAAM,GAAG,CAAC;AAChC,CAAC,CAAC;AAhCW,QAAA,mBAAmB,uBAgC9B"}