grm-shared-library 1.1.212 → 1.1.213

package/dist/cjs/modules/notification/dtos/billing-notification.dto.js

@@ -0,0 +1,213 @@
+"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.BillingSmsNotificationDto = exports.BillingPushNotificationDto = exports.BillingEmailNotificationDto = exports.BillingEmailAttachmentDto = exports.BillingDocumentReferenceDto = void 0;
+const swagger_1 = require("@nestjs/swagger");
+const class_transformer_1 = require("class-transformer");
+const class_validator_1 = require("class-validator");
+const billing_notification_enum_1 = require("../enums/billing-notification.enum");
+/**
+ * clarion-billing -> clarion-notification, over HTTP.
+ *
+ * Most billing notifications travel as Kafka events. These three routes exist for
+ * the cases where billing wants to know, synchronously, whether the message left:
+ * `POST /billing/notifications/email | push | sms`.
+ *
+ * Every limit here is a guard on a route that turns a request into outbound
+ * traffic on somebody's behalf, not a tuning choice.
+ */
+/** No line breaks: the value is placed in a header (Subject) or a filename. */
+const SINGLE_LINE = /^[^\r\n]*$/;
+/** A bare file name - no directory part, so it can never be read as a path. */
+const FILE_NAME = /^[^\\/\r\n\0]+$/;
+const HTTPS_ONLY = { protocols: ['https'], require_protocol: true };
+const toArray = ({ value }) => (value === undefined || value === null || Array.isArray(value) ? value : [value]);
+class BillingDocumentReferenceDto {
+}
+exports.BillingDocumentReferenceDto = BillingDocumentReferenceDto;
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: 'The clarion-dms document id.' }),
+    (0, class_transformer_1.Type)(() => Number),
+    (0, class_validator_1.IsInt)(),
+    (0, class_validator_1.IsPositive)(),
+    __metadata("design:type", Number)
+], BillingDocumentReferenceDto.prototype, "documentId", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ enum: billing_notification_enum_1.BillingDocumentType }),
+    (0, class_validator_1.IsEnum)(billing_notification_enum_1.BillingDocumentType),
+    __metadata("design:type", String)
+], BillingDocumentReferenceDto.prototype, "documentType", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({ example: 'INV-2026-000123.pdf' }),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.MaxLength)(150),
+    (0, class_validator_1.Matches)(FILE_NAME, { message: 'fileName must be a bare file name' }),
+    (0, class_validator_1.IsOptional)(),
+    __metadata("design:type", String)
+], BillingDocumentReferenceDto.prototype, "fileName", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({
+        description: 'A pre-signed URL for the document. WITH it the PDF is fetched and attached; WITHOUT it the document ' +
+            'is only named in the email. Billing documents are private and their signed URLs expire within the hour, ' +
+            'so the URL is never placed in the email itself.',
+    }),
+    (0, class_validator_1.IsUrl)(HTTPS_ONLY),
+    (0, class_validator_1.MaxLength)(2048),
+    (0, class_validator_1.IsOptional)(),
+    __metadata("design:type", String)
+], BillingDocumentReferenceDto.prototype, "signedUrl", void 0);
+/** @deprecated Raw attachments. Prefer `documents`. */
+class BillingEmailAttachmentDto {
+}
+exports.BillingEmailAttachmentDto = BillingEmailAttachmentDto;
+__decorate([
+    (0, swagger_1.ApiProperty)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.MaxLength)(150),
+    (0, class_validator_1.Matches)(FILE_NAME, { message: 'filename must be a bare file name' }),
+    __metadata("design:type", String)
+], BillingEmailAttachmentDto.prototype, "filename", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)(),
+    (0, class_validator_1.IsUrl)(HTTPS_ONLY),
+    (0, class_validator_1.MaxLength)(2048),
+    (0, class_validator_1.IsOptional)(),
+    __metadata("design:type", String)
+], BillingEmailAttachmentDto.prototype, "url", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({ description: 'Base64. About 10 MB of file at most.' }),
+    (0, class_validator_1.IsBase64)(),
+    (0, class_validator_1.MaxLength)(14000000),
+    (0, class_validator_1.IsOptional)(),
+    __metadata("design:type", String)
+], BillingEmailAttachmentDto.prototype, "content", void 0);
+class BillingEmailNotificationDto {
+}
+exports.BillingEmailNotificationDto = BillingEmailNotificationDto;
+__decorate([
+    (0, swagger_1.ApiProperty)({ type: [String], description: 'One address or several. Each recipient gets an individual email.' }),
+    (0, class_transformer_1.Transform)(toArray),
+    (0, class_validator_1.IsArray)(),
+    (0, class_validator_1.ArrayMinSize)(1),
+    (0, class_validator_1.ArrayMaxSize)(50),
+    (0, class_validator_1.ArrayUnique)(),
+    (0, class_validator_1.IsEmail)({}, { each: true }),
+    __metadata("design:type", Array)
+], BillingEmailNotificationDto.prototype, "to", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.MinLength)(1),
+    (0, class_validator_1.MaxLength)(200),
+    (0, class_validator_1.Matches)(SINGLE_LINE, { message: 'subject may not contain line breaks' }),
+    __metadata("design:type", String)
+], BillingEmailNotificationDto.prototype, "subject", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ enum: billing_notification_enum_1.BillingEmailTemplate }),
+    (0, class_validator_1.IsEnum)(billing_notification_enum_1.BillingEmailTemplate),
+    __metadata("design:type", String)
+], BillingEmailNotificationDto.prototype, "template", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({
+        description: 'The organization the email is sent on behalf of: decides the branding and the From address.',
+    }),
+    (0, class_transformer_1.Type)(() => Number),
+    (0, class_validator_1.IsInt)(),
+    (0, class_validator_1.IsPositive)(),
+    (0, class_validator_1.IsOptional)(),
+    __metadata("design:type", Number)
+], BillingEmailNotificationDto.prototype, "organizationId", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: 'See BillingEmailTemplateData.' }),
+    (0, class_validator_1.IsObject)(),
+    __metadata("design:type", Object)
+], BillingEmailNotificationDto.prototype, "data", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({ type: [BillingDocumentReferenceDto] }),
+    (0, class_validator_1.IsArray)(),
+    (0, class_validator_1.ArrayMaxSize)(10),
+    (0, class_validator_1.ValidateNested)({ each: true }),
+    (0, class_transformer_1.Type)(() => BillingDocumentReferenceDto),
+    (0, class_validator_1.IsOptional)(),
+    __metadata("design:type", Array)
+], BillingEmailNotificationDto.prototype, "documents", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({ type: [BillingEmailAttachmentDto], deprecated: true }),
+    (0, class_validator_1.IsArray)(),
+    (0, class_validator_1.ArrayMaxSize)(10),
+    (0, class_validator_1.ValidateNested)({ each: true }),
+    (0, class_transformer_1.Type)(() => BillingEmailAttachmentDto),
+    (0, class_validator_1.IsOptional)(),
+    __metadata("design:type", Array)
+], BillingEmailNotificationDto.prototype, "attachments", void 0);
+class BillingPushNotificationDto {
+}
+exports.BillingPushNotificationDto = BillingPushNotificationDto;
+__decorate([
+    (0, swagger_1.ApiProperty)({ type: [Number] }),
+    (0, class_validator_1.IsArray)(),
+    (0, class_validator_1.ArrayMinSize)(1),
+    (0, class_validator_1.ArrayMaxSize)(500),
+    (0, class_validator_1.ArrayUnique)(),
+    (0, class_transformer_1.Type)(() => Number),
+    (0, class_validator_1.IsInt)({ each: true }),
+    (0, class_validator_1.IsPositive)({ each: true }),
+    __metadata("design:type", Array)
+], BillingPushNotificationDto.prototype, "userIds", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.MinLength)(1),
+    (0, class_validator_1.MaxLength)(120),
+    __metadata("design:type", String)
+], BillingPushNotificationDto.prototype, "title", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.MinLength)(1),
+    (0, class_validator_1.MaxLength)(500),
+    __metadata("design:type", String)
+], BillingPushNotificationDto.prototype, "body", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({ description: 'Delivered to the app as FCM data; non-string values are JSON-encoded.' }),
+    (0, class_validator_1.IsObject)(),
+    (0, class_validator_1.IsOptional)(),
+    __metadata("design:type", Object)
+], BillingPushNotificationDto.prototype, "data", void 0);
+class BillingSmsNotificationDto {
+}
+exports.BillingSmsNotificationDto = BillingSmsNotificationDto;
+__decorate([
+    (0, swagger_1.ApiProperty)({ type: [String], description: 'E.164, or local numbers of a supported country.' }),
+    (0, class_validator_1.IsArray)(),
+    (0, class_validator_1.ArrayMinSize)(1),
+    (0, class_validator_1.ArrayMaxSize)(100),
+    (0, class_validator_1.ArrayUnique)(),
+    (0, class_validator_1.IsString)({ each: true }),
+    (0, class_validator_1.MaxLength)(20, { each: true }),
+    __metadata("design:type", Array)
+], BillingSmsNotificationDto.prototype, "phoneNumbers", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: 'At most 1000 characters (about six SMS segments).' }),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.MinLength)(1),
+    (0, class_validator_1.MaxLength)(1000),
+    __metadata("design:type", String)
+], BillingSmsNotificationDto.prototype, "message", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({ description: 'Decides the sender ID the SMS arrives under.' }),
+    (0, class_transformer_1.Type)(() => Number),
+    (0, class_validator_1.IsInt)(),
+    (0, class_validator_1.IsPositive)(),
+    (0, class_validator_1.IsOptional)(),
+    __metadata("design:type", Number)
+], BillingSmsNotificationDto.prototype, "organizationId", void 0);
+//# sourceMappingURL=billing-notification.dto.js.map

package/dist/cjs/modules/notification/dtos/billing-notification.dto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"billing-notification.dto.js","sourceRoot":"","sources":["../../../../../src/modules/notification/dtos/billing-notification.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,6CAAmE;AACnE,yDAAoD;AACpD,qDAkByB;AACzB,kFAA+F;AAE/F;;;;;;;;;GASG;AAEH,+EAA+E;AAC/E,MAAM,WAAW,GAAG,YAAY,CAAC;AACjC,+EAA+E;AAC/E,MAAM,SAAS,GAAG,iBAAiB,CAAC;AACpC,MAAM,UAAU,GAAG,EAAE,SAAS,EAAE,CAAC,OAAO,CAAC,EAAE,gBAAgB,EAAE,IAAI,EAAE,CAAC;AAEpE,MAAM,OAAO,GAAG,CAAC,EAAE,KAAK,EAAsB,EAAE,EAAE,CAAC,CAAC,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;AAErI,MAAa,2BAA2B;CAqBvC;AArBD,kEAqBC;AAlBG;IAFC,IAAA,qBAAW,EAAC,EAAE,WAAW,EAAE,8BAA8B,EAAE,CAAC;IAC5D,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,MAAM,CAAC;IAAE,IAAA,uBAAK,GAAE;IAAE,IAAA,4BAAU,GAAE;;+DACtB;AAIpB;IAFC,IAAA,qBAAW,EAAC,EAAE,IAAI,EAAE,+CAAmB,EAAE,CAAC;IAC1C,IAAA,wBAAM,EAAC,+CAAmB,CAAC;;iEACO;AAInC;IAFC,IAAA,6BAAmB,EAAC,EAAE,OAAO,EAAE,qBAAqB,EAAE,CAAC;IACvD,IAAA,0BAAQ,GAAE;IAAE,IAAA,2BAAS,EAAC,GAAG,CAAC;IAAE,IAAA,yBAAO,EAAC,SAAS,EAAE,EAAE,OAAO,EAAE,mCAAmC,EAAE,CAAC;IAAE,IAAA,4BAAU,GAAE;;6DAC7F;AASlB;IAPC,IAAA,6BAAmB,EAAC;QACjB,WAAW,EACP,sGAAsG;YACtG,0GAA0G;YAC1G,iDAAiD;KACxD,CAAC;IACD,IAAA,uBAAK,EAAC,UAAU,CAAC;IAAE,IAAA,2BAAS,EAAC,IAAI,CAAC;IAAE,IAAA,4BAAU,GAAE;;8DAC9B;AAGvB,uDAAuD;AACvD,MAAa,yBAAyB;CAYrC;AAZD,8DAYC;AATG;IAFC,IAAA,qBAAW,GAAE;IACb,IAAA,0BAAQ,GAAE;IAAE,IAAA,2BAAS,EAAC,GAAG,CAAC;IAAE,IAAA,yBAAO,EAAC,SAAS,EAAE,EAAE,OAAO,EAAE,mCAAmC,EAAE,CAAC;;2DAC/E;AAIlB;IAFC,IAAA,6BAAmB,GAAE;IACrB,IAAA,uBAAK,EAAC,UAAU,CAAC;IAAE,IAAA,2BAAS,EAAC,IAAI,CAAC;IAAE,IAAA,4BAAU,GAAE;;sDACpC;AAIb;IAFC,IAAA,6BAAmB,EAAC,EAAE,WAAW,EAAE,sCAAsC,EAAE,CAAC;IAC5E,IAAA,0BAAQ,GAAE;IAAE,IAAA,2BAAS,EAAC,QAAU,CAAC;IAAE,IAAA,4BAAU,GAAE;;0DAC/B;AAwBrB,MAAa,2BAA2B;CAgCvC;AAhCD,kEAgCC;AA3BG;IAJC,IAAA,qBAAW,EAAC,EAAE,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,kEAAkE,EAAE,CAAC;IAChH,IAAA,6BAAS,EAAC,OAAO,CAAC;IAClB,IAAA,yBAAO,GAAE;IAAE,IAAA,8BAAY,EAAC,CAAC,CAAC;IAAE,IAAA,8BAAY,EAAC,EAAE,CAAC;IAAE,IAAA,6BAAW,GAAE;IAC3D,IAAA,yBAAO,EAAC,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;;uDACd;AAId;IAFC,IAAA,qBAAW,GAAE;IACb,IAAA,0BAAQ,GAAE;IAAE,IAAA,2BAAS,EAAC,CAAC,CAAC;IAAE,IAAA,2BAAS,EAAC,GAAG,CAAC;IAAE,IAAA,yBAAO,EAAC,WAAW,EAAE,EAAE,OAAO,EAAE,qCAAqC,EAAE,CAAC;;4DAClG;AAIjB;IAFC,IAAA,qBAAW,EAAC,EAAE,IAAI,EAAE,gDAAoB,EAAE,CAAC;IAC3C,IAAA,wBAAM,EAAC,gDAAoB,CAAC;;6DACG;AAMhC;IAJC,IAAA,6BAAmB,EAAC;QACjB,WAAW,EAAE,6FAA6F;KAC7G,CAAC;IACD,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,MAAM,CAAC;IAAE,IAAA,uBAAK,GAAE;IAAE,IAAA,4BAAU,GAAE;IAAE,IAAA,4BAAU,GAAE;;mEAChC;AAIxB;IAFC,IAAA,qBAAW,EAAC,EAAE,WAAW,EAAE,+BAA+B,EAAE,CAAC;IAC7D,IAAA,0BAAQ,GAAE;;yDACqB;AAIhC;IAFC,IAAA,6BAAmB,EAAC,EAAE,IAAI,EAAE,CAAC,2BAA2B,CAAC,EAAE,CAAC;IAC5D,IAAA,yBAAO,GAAE;IAAE,IAAA,8BAAY,EAAC,EAAE,CAAC;IAAE,IAAA,gCAAc,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IAAE,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,2BAA2B,CAAC;IAAE,IAAA,4BAAU,GAAE;;8DACzE;AAI1C;IAFC,IAAA,6BAAmB,EAAC,EAAE,IAAI,EAAE,CAAC,yBAAyB,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;IAC5E,IAAA,yBAAO,GAAE;IAAE,IAAA,8BAAY,EAAC,EAAE,CAAC;IAAE,IAAA,gCAAc,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IAAE,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,yBAAyB,CAAC;IAAE,IAAA,4BAAU,GAAE;;gEACvE;AAG9C,MAAa,0BAA0B;CAiBtC;AAjBD,gEAiBC;AAbG;IAHC,IAAA,qBAAW,EAAC,EAAE,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;IAC/B,IAAA,yBAAO,GAAE;IAAE,IAAA,8BAAY,EAAC,CAAC,CAAC;IAAE,IAAA,8BAAY,EAAC,GAAG,CAAC;IAAE,IAAA,6BAAW,GAAE;IAC5D,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,MAAM,CAAC;IAAE,IAAA,uBAAK,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IAAE,IAAA,4BAAU,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;;2DACnD;AAInB;IAFC,IAAA,qBAAW,GAAE;IACb,IAAA,0BAAQ,GAAE;IAAE,IAAA,2BAAS,EAAC,CAAC,CAAC;IAAE,IAAA,2BAAS,EAAC,GAAG,CAAC;;yDAC1B;AAIf;IAFC,IAAA,qBAAW,GAAE;IACb,IAAA,0BAAQ,GAAE;IAAE,IAAA,2BAAS,EAAC,CAAC,CAAC;IAAE,IAAA,2BAAS,EAAC,GAAG,CAAC;;wDAC3B;AAId;IAFC,IAAA,6BAAmB,EAAC,EAAE,WAAW,EAAE,uEAAuE,EAAE,CAAC;IAC7G,IAAA,0BAAQ,GAAE;IAAE,IAAA,4BAAU,GAAE;;wDACE;AAG/B,MAAa,yBAAyB;CAarC;AAbD,8DAaC;AATG;IAHC,IAAA,qBAAW,EAAC,EAAE,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,iDAAiD,EAAE,CAAC;IAC/F,IAAA,yBAAO,GAAE;IAAE,IAAA,8BAAY,EAAC,CAAC,CAAC;IAAE,IAAA,8BAAY,EAAC,GAAG,CAAC;IAAE,IAAA,6BAAW,GAAE;IAC5D,IAAA,0BAAQ,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IAAE,IAAA,2BAAS,EAAC,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;;+DAChC;AAIxB;IAFC,IAAA,qBAAW,EAAC,EAAE,WAAW,EAAE,mDAAmD,EAAE,CAAC;IACjF,IAAA,0BAAQ,GAAE;IAAE,IAAA,2BAAS,EAAC,CAAC,CAAC;IAAE,IAAA,2BAAS,EAAC,IAAI,CAAC;;0DACzB;AAIjB;IAFC,IAAA,6BAAmB,EAAC,EAAE,WAAW,EAAE,8CAA8C,EAAE,CAAC;IACpF,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,MAAM,CAAC;IAAE,IAAA,uBAAK,GAAE;IAAE,IAAA,4BAAU,GAAE;IAAE,IAAA,4BAAU,GAAE;;iEAChC"}

package/dist/cjs/modules/notification/enums/billing-notification.enum.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BillingDocumentType = exports.BillingEmailTemplate = void 0;
+/**
+ * The emails clarion-billing can ask clarion-notification to send.
+ *
+ * A closed set on purpose. The route renders a template BY NAME on the say-so of
+ * another service; accepting any string would let a caller render any template in
+ * the notification service (an OTP email, a password reset) with a body of its
+ * choosing. Each value here has copy defaults in the notification service - add
+ * the value and the defaults together.
+ */
+var BillingEmailTemplate;
+(function (BillingEmailTemplate) {
+    /** An invoice or settlement invoice is ready. Normally carries the PDF. */
+    BillingEmailTemplate["INVOICE"] = "billing_invoice";
+    /** A payment was received. Normally carries the receipt PDF. */
+    BillingEmailTemplate["RECEIPT"] = "billing_receipt";
+    /** A corporate order was placed or confirmed. */
+    BillingEmailTemplate["ORDER_CONFIRMATION"] = "billing_order_confirmation";
+    /** Anything else billing needs to say; the caller supplies heading and intro. */
+    BillingEmailTemplate["GENERIC"] = "billing_generic";
+})(BillingEmailTemplate || (exports.BillingEmailTemplate = BillingEmailTemplate = {}));
+/** What a referenced billing document is. Mirrors the documents clarion-billing stores in clarion-dms. */
+var BillingDocumentType;
+(function (BillingDocumentType) {
+    BillingDocumentType["INVOICE"] = "INVOICE";
+    BillingDocumentType["RECEIPT"] = "RECEIPT";
+    BillingDocumentType["CORPORATE_ORDER"] = "CORPORATE_ORDER";
+    BillingDocumentType["SETTLEMENT_INVOICE"] = "SETTLEMENT_INVOICE";
+    BillingDocumentType["SETTLEMENT_RECEIPT"] = "SETTLEMENT_RECEIPT";
+})(BillingDocumentType || (exports.BillingDocumentType = BillingDocumentType = {}));
+//# sourceMappingURL=billing-notification.enum.js.map

package/dist/cjs/modules/notification/enums/billing-notification.enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"billing-notification.enum.js","sourceRoot":"","sources":["../../../../../src/modules/notification/enums/billing-notification.enum.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;GAQG;AACH,IAAY,oBASX;AATD,WAAY,oBAAoB;IAC5B,2EAA2E;IAC3E,mDAA2B,CAAA;IAC3B,gEAAgE;IAChE,mDAA2B,CAAA;IAC3B,iDAAiD;IACjD,yEAAiD,CAAA;IACjD,iFAAiF;IACjF,mDAA2B,CAAA;AAC/B,CAAC,EATW,oBAAoB,oCAApB,oBAAoB,QAS/B;AAED,0GAA0G;AAC1G,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC3B,0CAAmB,CAAA;IACnB,0CAAmB,CAAA;IACnB,0DAAmC,CAAA;IACnC,gEAAyC,CAAA;IACzC,gEAAyC,CAAA;AAC7C,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}

package/dist/cjs/modules/notification/index.js

@@ -39,4 +39,8 @@ __exportStar(require("./interfaces/organization-notification-settings"), exports
 __exportStar(require("./dtos/organization-notification-settings.dto"), exports);
 __exportStar(require("./constants/notification-sender.const"), exports);
 __exportStar(require("./utils/notification-sender.util"), exports);
+// clarion-billing -> clarion-notification HTTP contract (POST /billing/notifications/*)
+__exportStar(require("./enums/billing-notification.enum"), exports);
+__exportStar(require("./dtos/billing-notification.dto"), exports);
+__exportStar(require("./interfaces/billing-notification-result"), exports);
 //# sourceMappingURL=index.js.map

package/dist/cjs/modules/notification/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/modules/notification/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,QAAQ;AACR,oEAAkD;AAClD,iEAA+C;AAC/C,mEAAiD;AACjD,2EAAyD;AACzD,uEAAqD;AACrD,+DAA6C;AAC7C,0EAAwD;AACxD,yEAAuD;AACvD,0EAAwD;AACxD,4EAA0D;AAE1D,4CAA4C;AAC5C,gEAA8C;AAC9C,kEAAgD;AAChD,+DAA6C;AAC7C,iEAA+C;AAC/C,4EAA0D;AAE1D,0CAA0C;AAC1C,gEAA8C;AAC9C,kEAAgD;AAEhD,kEAAkE;AAClE,kFAAgE;AAChE,gFAA8D;AAC9D,wEAAsD;AACtD,mEAAiD"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/modules/notification/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,QAAQ;AACR,oEAAkD;AAClD,iEAA+C;AAC/C,mEAAiD;AACjD,2EAAyD;AACzD,uEAAqD;AACrD,+DAA6C;AAC7C,0EAAwD;AACxD,yEAAuD;AACvD,0EAAwD;AACxD,4EAA0D;AAE1D,4CAA4C;AAC5C,gEAA8C;AAC9C,kEAAgD;AAChD,+DAA6C;AAC7C,iEAA+C;AAC/C,4EAA0D;AAE1D,0CAA0C;AAC1C,gEAA8C;AAC9C,kEAAgD;AAEhD,kEAAkE;AAClE,kFAAgE;AAChE,gFAA8D;AAC9D,wEAAsD;AACtD,mEAAiD;AAEjD,wFAAwF;AACxF,oEAAkD;AAClD,kEAAgD;AAChD,2EAAyD"}

package/dist/cjs/modules/notification/interfaces/billing-notification-result.js

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

package/dist/cjs/modules/notification/interfaces/billing-notification-result.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"billing-notification-result.js","sourceRoot":"","sources":["../../../../../src/modules/notification/interfaces/billing-notification-result.ts"],"names":[],"mappings":""}

package/dist/esm/modules/notification/dtos/billing-notification.dto.js

@@ -0,0 +1,205 @@
+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);
+};
+import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
+import { Transform, Type } from 'class-transformer';
+import { ArrayMaxSize, ArrayMinSize, ArrayUnique, IsArray, IsBase64, IsEmail, IsEnum, IsInt, IsObject, IsOptional, IsPositive, IsString, IsUrl, Matches, MaxLength, MinLength, ValidateNested, } from 'class-validator';
+import { BillingDocumentType, BillingEmailTemplate } from '../enums/billing-notification.enum';
+/**
+ * clarion-billing -> clarion-notification, over HTTP.
+ *
+ * Most billing notifications travel as Kafka events. These three routes exist for
+ * the cases where billing wants to know, synchronously, whether the message left:
+ * `POST /billing/notifications/email | push | sms`.
+ *
+ * Every limit here is a guard on a route that turns a request into outbound
+ * traffic on somebody's behalf, not a tuning choice.
+ */
+/** No line breaks: the value is placed in a header (Subject) or a filename. */
+const SINGLE_LINE = /^[^\r\n]*$/;
+/** A bare file name - no directory part, so it can never be read as a path. */
+const FILE_NAME = /^[^\\/\r\n\0]+$/;
+const HTTPS_ONLY = { protocols: ['https'], require_protocol: true };
+const toArray = ({ value }) => (value === undefined || value === null || Array.isArray(value) ? value : [value]);
+export class BillingDocumentReferenceDto {
+}
+__decorate([
+    ApiProperty({ description: 'The clarion-dms document id.' }),
+    Type(() => Number),
+    IsInt(),
+    IsPositive(),
+    __metadata("design:type", Number)
+], BillingDocumentReferenceDto.prototype, "documentId", void 0);
+__decorate([
+    ApiProperty({ enum: BillingDocumentType }),
+    IsEnum(BillingDocumentType),
+    __metadata("design:type", String)
+], BillingDocumentReferenceDto.prototype, "documentType", void 0);
+__decorate([
+    ApiPropertyOptional({ example: 'INV-2026-000123.pdf' }),
+    IsString(),
+    MaxLength(150),
+    Matches(FILE_NAME, { message: 'fileName must be a bare file name' }),
+    IsOptional(),
+    __metadata("design:type", String)
+], BillingDocumentReferenceDto.prototype, "fileName", void 0);
+__decorate([
+    ApiPropertyOptional({
+        description: 'A pre-signed URL for the document. WITH it the PDF is fetched and attached; WITHOUT it the document ' +
+            'is only named in the email. Billing documents are private and their signed URLs expire within the hour, ' +
+            'so the URL is never placed in the email itself.',
+    }),
+    IsUrl(HTTPS_ONLY),
+    MaxLength(2048),
+    IsOptional(),
+    __metadata("design:type", String)
+], BillingDocumentReferenceDto.prototype, "signedUrl", void 0);
+/** @deprecated Raw attachments. Prefer `documents`. */
+export class BillingEmailAttachmentDto {
+}
+__decorate([
+    ApiProperty(),
+    IsString(),
+    MaxLength(150),
+    Matches(FILE_NAME, { message: 'filename must be a bare file name' }),
+    __metadata("design:type", String)
+], BillingEmailAttachmentDto.prototype, "filename", void 0);
+__decorate([
+    ApiPropertyOptional(),
+    IsUrl(HTTPS_ONLY),
+    MaxLength(2048),
+    IsOptional(),
+    __metadata("design:type", String)
+], BillingEmailAttachmentDto.prototype, "url", void 0);
+__decorate([
+    ApiPropertyOptional({ description: 'Base64. About 10 MB of file at most.' }),
+    IsBase64(),
+    MaxLength(14000000),
+    IsOptional(),
+    __metadata("design:type", String)
+], BillingEmailAttachmentDto.prototype, "content", void 0);
+export class BillingEmailNotificationDto {
+}
+__decorate([
+    ApiProperty({ type: [String], description: 'One address or several. Each recipient gets an individual email.' }),
+    Transform(toArray),
+    IsArray(),
+    ArrayMinSize(1),
+    ArrayMaxSize(50),
+    ArrayUnique(),
+    IsEmail({}, { each: true }),
+    __metadata("design:type", Array)
+], BillingEmailNotificationDto.prototype, "to", void 0);
+__decorate([
+    ApiProperty(),
+    IsString(),
+    MinLength(1),
+    MaxLength(200),
+    Matches(SINGLE_LINE, { message: 'subject may not contain line breaks' }),
+    __metadata("design:type", String)
+], BillingEmailNotificationDto.prototype, "subject", void 0);
+__decorate([
+    ApiProperty({ enum: BillingEmailTemplate }),
+    IsEnum(BillingEmailTemplate),
+    __metadata("design:type", String)
+], BillingEmailNotificationDto.prototype, "template", void 0);
+__decorate([
+    ApiPropertyOptional({
+        description: 'The organization the email is sent on behalf of: decides the branding and the From address.',
+    }),
+    Type(() => Number),
+    IsInt(),
+    IsPositive(),
+    IsOptional(),
+    __metadata("design:type", Number)
+], BillingEmailNotificationDto.prototype, "organizationId", void 0);
+__decorate([
+    ApiProperty({ description: 'See BillingEmailTemplateData.' }),
+    IsObject(),
+    __metadata("design:type", Object)
+], BillingEmailNotificationDto.prototype, "data", void 0);
+__decorate([
+    ApiPropertyOptional({ type: [BillingDocumentReferenceDto] }),
+    IsArray(),
+    ArrayMaxSize(10),
+    ValidateNested({ each: true }),
+    Type(() => BillingDocumentReferenceDto),
+    IsOptional(),
+    __metadata("design:type", Array)
+], BillingEmailNotificationDto.prototype, "documents", void 0);
+__decorate([
+    ApiPropertyOptional({ type: [BillingEmailAttachmentDto], deprecated: true }),
+    IsArray(),
+    ArrayMaxSize(10),
+    ValidateNested({ each: true }),
+    Type(() => BillingEmailAttachmentDto),
+    IsOptional(),
+    __metadata("design:type", Array)
+], BillingEmailNotificationDto.prototype, "attachments", void 0);
+export class BillingPushNotificationDto {
+}
+__decorate([
+    ApiProperty({ type: [Number] }),
+    IsArray(),
+    ArrayMinSize(1),
+    ArrayMaxSize(500),
+    ArrayUnique(),
+    Type(() => Number),
+    IsInt({ each: true }),
+    IsPositive({ each: true }),
+    __metadata("design:type", Array)
+], BillingPushNotificationDto.prototype, "userIds", void 0);
+__decorate([
+    ApiProperty(),
+    IsString(),
+    MinLength(1),
+    MaxLength(120),
+    __metadata("design:type", String)
+], BillingPushNotificationDto.prototype, "title", void 0);
+__decorate([
+    ApiProperty(),
+    IsString(),
+    MinLength(1),
+    MaxLength(500),
+    __metadata("design:type", String)
+], BillingPushNotificationDto.prototype, "body", void 0);
+__decorate([
+    ApiPropertyOptional({ description: 'Delivered to the app as FCM data; non-string values are JSON-encoded.' }),
+    IsObject(),
+    IsOptional(),
+    __metadata("design:type", Object)
+], BillingPushNotificationDto.prototype, "data", void 0);
+export class BillingSmsNotificationDto {
+}
+__decorate([
+    ApiProperty({ type: [String], description: 'E.164, or local numbers of a supported country.' }),
+    IsArray(),
+    ArrayMinSize(1),
+    ArrayMaxSize(100),
+    ArrayUnique(),
+    IsString({ each: true }),
+    MaxLength(20, { each: true }),
+    __metadata("design:type", Array)
+], BillingSmsNotificationDto.prototype, "phoneNumbers", void 0);
+__decorate([
+    ApiProperty({ description: 'At most 1000 characters (about six SMS segments).' }),
+    IsString(),
+    MinLength(1),
+    MaxLength(1000),
+    __metadata("design:type", String)
+], BillingSmsNotificationDto.prototype, "message", void 0);
+__decorate([
+    ApiPropertyOptional({ description: 'Decides the sender ID the SMS arrives under.' }),
+    Type(() => Number),
+    IsInt(),
+    IsPositive(),
+    IsOptional(),
+    __metadata("design:type", Number)
+], BillingSmsNotificationDto.prototype, "organizationId", void 0);
+//# sourceMappingURL=billing-notification.dto.js.map

package/dist/esm/modules/notification/dtos/billing-notification.dto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"billing-notification.dto.js","sourceRoot":"","sources":["../../../../../src/modules/notification/dtos/billing-notification.dto.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AACnE,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EACH,YAAY,EACZ,YAAY,EACZ,WAAW,EACX,OAAO,EACP,QAAQ,EACR,OAAO,EACP,MAAM,EACN,KAAK,EACL,QAAQ,EACR,UAAU,EACV,UAAU,EACV,QAAQ,EACR,KAAK,EACL,OAAO,EACP,SAAS,EACT,SAAS,EACT,cAAc,GACjB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAE/F;;;;;;;;;GASG;AAEH,+EAA+E;AAC/E,MAAM,WAAW,GAAG,YAAY,CAAC;AACjC,+EAA+E;AAC/E,MAAM,SAAS,GAAG,iBAAiB,CAAC;AACpC,MAAM,UAAU,GAAG,EAAE,SAAS,EAAE,CAAC,OAAO,CAAC,EAAE,gBAAgB,EAAE,IAAI,EAAE,CAAC;AAEpE,MAAM,OAAO,GAAG,CAAC,EAAE,KAAK,EAAsB,EAAE,EAAE,CAAC,CAAC,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;AAErI,MAAM,OAAO,2BAA2B;CAqBvC;AAlBG;IAFC,WAAW,CAAC,EAAE,WAAW,EAAE,8BAA8B,EAAE,CAAC;IAC5D,IAAI,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC;IAAE,KAAK,EAAE;IAAE,UAAU,EAAE;;+DACtB;AAIpB;IAFC,WAAW,CAAC,EAAE,IAAI,EAAE,mBAAmB,EAAE,CAAC;IAC1C,MAAM,CAAC,mBAAmB,CAAC;;iEACO;AAInC;IAFC,mBAAmB,CAAC,EAAE,OAAO,EAAE,qBAAqB,EAAE,CAAC;IACvD,QAAQ,EAAE;IAAE,SAAS,CAAC,GAAG,CAAC;IAAE,OAAO,CAAC,SAAS,EAAE,EAAE,OAAO,EAAE,mCAAmC,EAAE,CAAC;IAAE,UAAU,EAAE;;6DAC7F;AASlB;IAPC,mBAAmB,CAAC;QACjB,WAAW,EACP,sGAAsG;YACtG,0GAA0G;YAC1G,iDAAiD;KACxD,CAAC;IACD,KAAK,CAAC,UAAU,CAAC;IAAE,SAAS,CAAC,IAAI,CAAC;IAAE,UAAU,EAAE;;8DAC9B;AAGvB,uDAAuD;AACvD,MAAM,OAAO,yBAAyB;CAYrC;AATG;IAFC,WAAW,EAAE;IACb,QAAQ,EAAE;IAAE,SAAS,CAAC,GAAG,CAAC;IAAE,OAAO,CAAC,SAAS,EAAE,EAAE,OAAO,EAAE,mCAAmC,EAAE,CAAC;;2DAC/E;AAIlB;IAFC,mBAAmB,EAAE;IACrB,KAAK,CAAC,UAAU,CAAC;IAAE,SAAS,CAAC,IAAI,CAAC;IAAE,UAAU,EAAE;;sDACpC;AAIb;IAFC,mBAAmB,CAAC,EAAE,WAAW,EAAE,sCAAsC,EAAE,CAAC;IAC5E,QAAQ,EAAE;IAAE,SAAS,CAAC,QAAU,CAAC;IAAE,UAAU,EAAE;;0DAC/B;AAwBrB,MAAM,OAAO,2BAA2B;CAgCvC;AA3BG;IAJC,WAAW,CAAC,EAAE,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,kEAAkE,EAAE,CAAC;IAChH,SAAS,CAAC,OAAO,CAAC;IAClB,OAAO,EAAE;IAAE,YAAY,CAAC,CAAC,CAAC;IAAE,YAAY,CAAC,EAAE,CAAC;IAAE,WAAW,EAAE;IAC3D,OAAO,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;;uDACd;AAId;IAFC,WAAW,EAAE;IACb,QAAQ,EAAE;IAAE,SAAS,CAAC,CAAC,CAAC;IAAE,SAAS,CAAC,GAAG,CAAC;IAAE,OAAO,CAAC,WAAW,EAAE,EAAE,OAAO,EAAE,qCAAqC,EAAE,CAAC;;4DAClG;AAIjB;IAFC,WAAW,CAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC;IAC3C,MAAM,CAAC,oBAAoB,CAAC;;6DACG;AAMhC;IAJC,mBAAmB,CAAC;QACjB,WAAW,EAAE,6FAA6F;KAC7G,CAAC;IACD,IAAI,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC;IAAE,KAAK,EAAE;IAAE,UAAU,EAAE;IAAE,UAAU,EAAE;;mEAChC;AAIxB;IAFC,WAAW,CAAC,EAAE,WAAW,EAAE,+BAA+B,EAAE,CAAC;IAC7D,QAAQ,EAAE;;yDACqB;AAIhC;IAFC,mBAAmB,CAAC,EAAE,IAAI,EAAE,CAAC,2BAA2B,CAAC,EAAE,CAAC;IAC5D,OAAO,EAAE;IAAE,YAAY,CAAC,EAAE,CAAC;IAAE,cAAc,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IAAE,IAAI,CAAC,GAAG,EAAE,CAAC,2BAA2B,CAAC;IAAE,UAAU,EAAE;;8DACzE;AAI1C;IAFC,mBAAmB,CAAC,EAAE,IAAI,EAAE,CAAC,yBAAyB,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;IAC5E,OAAO,EAAE;IAAE,YAAY,CAAC,EAAE,CAAC;IAAE,cAAc,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IAAE,IAAI,CAAC,GAAG,EAAE,CAAC,yBAAyB,CAAC;IAAE,UAAU,EAAE;;gEACvE;AAG9C,MAAM,OAAO,0BAA0B;CAiBtC;AAbG;IAHC,WAAW,CAAC,EAAE,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;IAC/B,OAAO,EAAE;IAAE,YAAY,CAAC,CAAC,CAAC;IAAE,YAAY,CAAC,GAAG,CAAC;IAAE,WAAW,EAAE;IAC5D,IAAI,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC;IAAE,KAAK,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IAAE,UAAU,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;;2DACnD;AAInB;IAFC,WAAW,EAAE;IACb,QAAQ,EAAE;IAAE,SAAS,CAAC,CAAC,CAAC;IAAE,SAAS,CAAC,GAAG,CAAC;;yDAC1B;AAIf;IAFC,WAAW,EAAE;IACb,QAAQ,EAAE;IAAE,SAAS,CAAC,CAAC,CAAC;IAAE,SAAS,CAAC,GAAG,CAAC;;wDAC3B;AAId;IAFC,mBAAmB,CAAC,EAAE,WAAW,EAAE,uEAAuE,EAAE,CAAC;IAC7G,QAAQ,EAAE;IAAE,UAAU,EAAE;;wDACE;AAG/B,MAAM,OAAO,yBAAyB;CAarC;AATG;IAHC,WAAW,CAAC,EAAE,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,iDAAiD,EAAE,CAAC;IAC/F,OAAO,EAAE;IAAE,YAAY,CAAC,CAAC,CAAC;IAAE,YAAY,CAAC,GAAG,CAAC;IAAE,WAAW,EAAE;IAC5D,QAAQ,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IAAE,SAAS,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;;+DAChC;AAIxB;IAFC,WAAW,CAAC,EAAE,WAAW,EAAE,mDAAmD,EAAE,CAAC;IACjF,QAAQ,EAAE;IAAE,SAAS,CAAC,CAAC,CAAC;IAAE,SAAS,CAAC,IAAI,CAAC;;0DACzB;AAIjB;IAFC,mBAAmB,CAAC,EAAE,WAAW,EAAE,8CAA8C,EAAE,CAAC;IACpF,IAAI,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC;IAAE,KAAK,EAAE;IAAE,UAAU,EAAE;IAAE,UAAU,EAAE;;iEAChC"}

package/dist/esm/modules/notification/enums/billing-notification.enum.js

@@ -0,0 +1,30 @@
+/**
+ * The emails clarion-billing can ask clarion-notification to send.
+ *
+ * A closed set on purpose. The route renders a template BY NAME on the say-so of
+ * another service; accepting any string would let a caller render any template in
+ * the notification service (an OTP email, a password reset) with a body of its
+ * choosing. Each value here has copy defaults in the notification service - add
+ * the value and the defaults together.
+ */
+export var BillingEmailTemplate;
+(function (BillingEmailTemplate) {
+    /** An invoice or settlement invoice is ready. Normally carries the PDF. */
+    BillingEmailTemplate["INVOICE"] = "billing_invoice";
+    /** A payment was received. Normally carries the receipt PDF. */
+    BillingEmailTemplate["RECEIPT"] = "billing_receipt";
+    /** A corporate order was placed or confirmed. */
+    BillingEmailTemplate["ORDER_CONFIRMATION"] = "billing_order_confirmation";
+    /** Anything else billing needs to say; the caller supplies heading and intro. */
+    BillingEmailTemplate["GENERIC"] = "billing_generic";
+})(BillingEmailTemplate || (BillingEmailTemplate = {}));
+/** What a referenced billing document is. Mirrors the documents clarion-billing stores in clarion-dms. */
+export var BillingDocumentType;
+(function (BillingDocumentType) {
+    BillingDocumentType["INVOICE"] = "INVOICE";
+    BillingDocumentType["RECEIPT"] = "RECEIPT";
+    BillingDocumentType["CORPORATE_ORDER"] = "CORPORATE_ORDER";
+    BillingDocumentType["SETTLEMENT_INVOICE"] = "SETTLEMENT_INVOICE";
+    BillingDocumentType["SETTLEMENT_RECEIPT"] = "SETTLEMENT_RECEIPT";
+})(BillingDocumentType || (BillingDocumentType = {}));
+//# sourceMappingURL=billing-notification.enum.js.map

package/dist/esm/modules/notification/enums/billing-notification.enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"billing-notification.enum.js","sourceRoot":"","sources":["../../../../../src/modules/notification/enums/billing-notification.enum.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,MAAM,CAAN,IAAY,oBASX;AATD,WAAY,oBAAoB;IAC5B,2EAA2E;IAC3E,mDAA2B,CAAA;IAC3B,gEAAgE;IAChE,mDAA2B,CAAA;IAC3B,iDAAiD;IACjD,yEAAiD,CAAA;IACjD,iFAAiF;IACjF,mDAA2B,CAAA;AAC/B,CAAC,EATW,oBAAoB,KAApB,oBAAoB,QAS/B;AAED,0GAA0G;AAC1G,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC3B,0CAAmB,CAAA;IACnB,0CAAmB,CAAA;IACnB,0DAAmC,CAAA;IACnC,gEAAyC,CAAA;IACzC,gEAAyC,CAAA;AAC7C,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B"}

package/dist/esm/modules/notification/index.js

@@ -23,4 +23,8 @@ export * from './interfaces/organization-notification-settings';
 export * from './dtos/organization-notification-settings.dto';
 export * from './constants/notification-sender.const';
 export * from './utils/notification-sender.util';
+// clarion-billing -> clarion-notification HTTP contract (POST /billing/notifications/*)
+export * from './enums/billing-notification.enum';
+export * from './dtos/billing-notification.dto';
+export * from './interfaces/billing-notification-result';
 //# sourceMappingURL=index.js.map

package/dist/esm/modules/notification/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/modules/notification/index.ts"],"names":[],"mappings":"AAAA,QAAQ;AACR,cAAc,mCAAmC,CAAC;AAClD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,kCAAkC,CAAC;AACjD,cAAc,0CAA0C,CAAC;AACzD,cAAc,sCAAsC,CAAC;AACrD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yCAAyC,CAAC;AACxD,cAAc,wCAAwC,CAAC;AACvD,cAAc,yCAAyC,CAAC;AACxD,cAAc,2CAA2C,CAAC;AAE1D,4CAA4C;AAC5C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,iCAAiC,CAAC;AAChD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,2CAA2C,CAAC;AAE1D,0CAA0C;AAC1C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,iCAAiC,CAAC;AAEhD,kEAAkE;AAClE,cAAc,iDAAiD,CAAC;AAChE,cAAc,+CAA+C,CAAC;AAC9D,cAAc,uCAAuC,CAAC;AACtD,cAAc,kCAAkC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/modules/notification/index.ts"],"names":[],"mappings":"AAAA,QAAQ;AACR,cAAc,mCAAmC,CAAC;AAClD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,kCAAkC,CAAC;AACjD,cAAc,0CAA0C,CAAC;AACzD,cAAc,sCAAsC,CAAC;AACrD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yCAAyC,CAAC;AACxD,cAAc,wCAAwC,CAAC;AACvD,cAAc,yCAAyC,CAAC;AACxD,cAAc,2CAA2C,CAAC;AAE1D,4CAA4C;AAC5C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,iCAAiC,CAAC;AAChD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,2CAA2C,CAAC;AAE1D,0CAA0C;AAC1C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,iCAAiC,CAAC;AAEhD,kEAAkE;AAClE,cAAc,iDAAiD,CAAC;AAChE,cAAc,+CAA+C,CAAC;AAC9D,cAAc,uCAAuC,CAAC;AACtD,cAAc,kCAAkC,CAAC;AAEjD,wFAAwF;AACxF,cAAc,mCAAmC,CAAC;AAClD,cAAc,iCAAiC,CAAC;AAChD,cAAc,0CAA0C,CAAC"}

package/dist/esm/modules/notification/interfaces/billing-notification-result.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=billing-notification-result.js.map

package/dist/esm/modules/notification/interfaces/billing-notification-result.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"billing-notification-result.js","sourceRoot":"","sources":["../../../../../src/modules/notification/interfaces/billing-notification-result.ts"],"names":[],"mappings":""}

package/dist/types/modules/notification/dtos/billing-notification.dto.d.ts

@@ -0,0 +1,56 @@
+import { BillingDocumentType, BillingEmailTemplate } from '../enums/billing-notification.enum';
+export declare class BillingDocumentReferenceDto {
+    documentId: number;
+    documentType: BillingDocumentType;
+    fileName?: string;
+    signedUrl?: string;
+}
+/** @deprecated Raw attachments. Prefer `documents`. */
+export declare class BillingEmailAttachmentDto {
+    filename: string;
+    url?: string;
+    content?: string;
+}
+/**
+ * The keys the billing email layout reads from `data`. All optional: each
+ * template has defaults. Values are rendered as TEXT (escaped), never as markup.
+ * Money arrives already formatted - only billing knows the currency's decimals.
+ */
+export interface BillingEmailTemplateData {
+    /** Greeting name. Defaults to "Customer". */
+    recipientName?: string;
+    heading?: string;
+    /** One paragraph, or several. */
+    intro?: string | string[];
+    /** Label/value rows, e.g. invoice number, amount, due date. At most 30 are rendered. */
+    summary?: Array<{
+        label: string;
+        value: string | number;
+    }>;
+    /** A button. Rendered only when `actionUrl` is https. */
+    actionLabel?: string;
+    actionUrl?: string;
+    /** Small print under the summary. */
+    note?: string;
+    [key: string]: any;
+}
+export declare class BillingEmailNotificationDto {
+    to: string[];
+    subject: string;
+    template: BillingEmailTemplate;
+    organizationId?: number;
+    data: BillingEmailTemplateData;
+    documents?: BillingDocumentReferenceDto[];
+    attachments?: BillingEmailAttachmentDto[];
+}
+export declare class BillingPushNotificationDto {
+    userIds: number[];
+    title: string;
+    body: string;
+    data?: Record<string, any>;
+}
+export declare class BillingSmsNotificationDto {
+    phoneNumbers: string[];
+    message: string;
+    organizationId?: number;
+}

package/dist/types/modules/notification/enums/billing-notification.enum.d.ts

@@ -0,0 +1,27 @@
+/**
+ * The emails clarion-billing can ask clarion-notification to send.
+ *
+ * A closed set on purpose. The route renders a template BY NAME on the say-so of
+ * another service; accepting any string would let a caller render any template in
+ * the notification service (an OTP email, a password reset) with a body of its
+ * choosing. Each value here has copy defaults in the notification service - add
+ * the value and the defaults together.
+ */
+export declare enum BillingEmailTemplate {
+    /** An invoice or settlement invoice is ready. Normally carries the PDF. */
+    INVOICE = "billing_invoice",
+    /** A payment was received. Normally carries the receipt PDF. */
+    RECEIPT = "billing_receipt",
+    /** A corporate order was placed or confirmed. */
+    ORDER_CONFIRMATION = "billing_order_confirmation",
+    /** Anything else billing needs to say; the caller supplies heading and intro. */
+    GENERIC = "billing_generic"
+}
+/** What a referenced billing document is. Mirrors the documents clarion-billing stores in clarion-dms. */
+export declare enum BillingDocumentType {
+    INVOICE = "INVOICE",
+    RECEIPT = "RECEIPT",
+    CORPORATE_ORDER = "CORPORATE_ORDER",
+    SETTLEMENT_INVOICE = "SETTLEMENT_INVOICE",
+    SETTLEMENT_RECEIPT = "SETTLEMENT_RECEIPT"
+}

package/dist/types/modules/notification/index.d.ts

@@ -19,3 +19,6 @@ export * from './interfaces/organization-notification-settings';
 export * from './dtos/organization-notification-settings.dto';
 export * from './constants/notification-sender.const';
 export * from './utils/notification-sender.util';
+export * from './enums/billing-notification.enum';
+export * from './dtos/billing-notification.dto';
+export * from './interfaces/billing-notification-result';

package/dist/types/modules/notification/interfaces/billing-notification-result.d.ts

@@ -0,0 +1,35 @@
+import { NotificationChannel } from '../enums/notification-channel.enum';
+import { EmailSendResult } from './email-send-result';
+import { SmsSendResult } from './sms-send-result';
+/**
+ * What `POST /billing/notifications/*` answers with.
+ *
+ * The status code is the confirmation; the body is the detail:
+ *
+ *   200  everything asked for was handed to a provider
+ *   207  (sms only) some recipients were, some were not - NOT retried by the
+ *        caller, because a retry would message the ones that succeeded again
+ *   422  the request can never succeed as sent (bad number, expired document URL)
+ *   502  a provider or the document store failed; nothing was sent; retry is safe
+ *   503  no provider is configured for the channel
+ *
+ * On 4xx/5xx the same result object is the error body.
+ */
+export interface BillingEmailNotificationResult extends EmailSendResult {
+    documents: {
+        /** File names attached to the email. */
+        attached: string[];
+        /** Documents named in the email but not attached (no signed URL was supplied). */
+        referenced: string[];
+    };
+}
+export type BillingSmsNotificationResult = SmsSendResult;
+export interface BillingPushNotificationResult {
+    channel: NotificationChannel.PUSH;
+    /** True when no send failed. A user with no registered device is not a failure. */
+    success: boolean;
+    /** Devices a send was attempted to. Zero means none of the users has the app registered. */
+    totalAttempted: number;
+    successCount: number;
+    failureCount: number;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "grm-shared-library",
-  "version": "1.1.212",
+  "version": "1.1.213",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/types/index.d.ts",