grm-shared-library 1.1.211 → 1.1.213

package/README.md

@@ -146,6 +146,39 @@ filtering) are delivered in later phases and should build on top of these types.
 npm test   # compiles src/modules/country and runs the country/currency suite
 ```
 
+## Organization notification settings
+
+Clarion is multi-tenant, so what a customer sees in a notification belongs to the
+**organization** that serves them. `modules/notification` carries the contract for
+that, shared by clarion-notification (owner), the gateway (proxy) and
+clarion-authentication (emitter):
+
+- **`organizationId` is the key.** The four auth event payloads (`CreateOTPPayloadDto`,
+  `CreateUserRegisteredPayloadDto`, `PasswordResetPayloadDto`,
+  `AccountDeletionRequestPayloadDto`) gained an optional `organizationId`, and
+  `EmailSendRequest` / `SmsSendRequest` carry one. `appId` stays on every payload, but
+  only as the fallback for an emitter that has not been upgraded. The notification
+  service validates with `whitelist: true`, so it must be on a version that declares
+  the field or the field is stripped before anything reads it.
+- **Branding resolves field by field** - `NotificationBrandingSource`: the
+  organization's profile, then its record in clarion-organization, then the legacy
+  per-app defaults, then the platform. `UpsertOrganizationNotificationBrandingDto`
+  turns `""` into `null`, and null means *inherit again*, not *blank*.
+- **Email senders are verified per provider** (`EmailSenderProviderVerification`). A
+  provider only sends from an address it has `VERIFIED`; otherwise that provider uses
+  the platform sender and keeps the organization's display name and reply-to.
+- **SMS senders are requested, then approved** (`NotificationSenderStatus`). Only
+  `ACTIVE` senders are used; everything else falls back to the country-aware default.
+  `validateSmsSenderId(type, value)` is the one definition of a valid sender.
+- **Providers describe themselves** (`SmsProviderDescriptor`), like tracking providers
+  do. `SmsProviderName` only reserves a code; the catalogue says what is usable.
+- Every send result records `sender` and `senderSource`
+  (`ORGANIZATION` | `PLATFORM_DEFAULT`), so "why was this Upesy-branded?" is a query.
+
+Values that end up inside email CSS or headers are validated as such: colours are
+`#RRGGBB` only, logos are `https` only, and a sender display name may not contain a
+line break. `notification-sender.spec.ts` pins each of those.
+
 ## Roles and permissions
 
 This package is the authority on both. clarion-authentication seeds them into its
@@ -194,6 +227,24 @@ all twelve (everybody who could administer tracking before the split still can);
 `Organization:User` - the five `read` actions; `Control-Centre:User` and `Responder` -
 position and history; `Mobile-User` - **none**.
 
+### The Notification permission module
+
+An organization's notification settings (clarion-notification) decide what its
+**customers** see: how emails are branded, the address they come from, and the sender
+ID its SMS arrive under. They have actions of their own rather than reusing
+`update:organization`, because a wrong logo or sender goes out on every OTP and alert.
+
+| Action | Covers |
+|---|---|
+| `read:notification-settings` | Reading the settings, the effective (resolved) branding and the SMS provider catalogue. |
+| `manage:notification-settings` | Saving branding; adding, verifying and removing email senders; **requesting** SMS senders; sending a test email. |
+| `approve:notification-sender` | Moving an SMS sender to `ACTIVE` / `SUSPENDED` / `REJECTED`. |
+
+Owner and Admin hold the first two. **No role holds `approve:notification-sender`** -
+only Super-Admin (`*`) passes it, and `roles.spec.ts` pins that. Activating a sender
+asserts that it is registered with the provider and the telco; an organization able to
+approve its own could send SMS under any name it typed.
+
 ### Adding a role: every step fails silently on its own
 
 1. **Here** - the `Roles` value, a scope list, and a `ROLES_DATA` entry. `roles.spec.ts`

package/dist/cjs/kafka/dtos/account-deletion/account-deletion-request-payload.dto.js

@@ -22,6 +22,12 @@ __decorate([
     (0, class_validator_1.IsNotEmpty)(),
     __metadata("design:type", String)
 ], AccountDeletionRequestPayloadDto.prototype, "appId", void 0);
+__decorate([
+    (0, class_validator_1.IsInt)(),
+    (0, class_validator_1.IsPositive)(),
+    (0, class_validator_1.IsOptional)(),
+    __metadata("design:type", Number)
+], AccountDeletionRequestPayloadDto.prototype, "organizationId", void 0);
 __decorate([
     (0, class_validator_1.IsNumber)(),
     (0, class_validator_1.IsNotEmpty)(),

package/dist/cjs/kafka/dtos/account-deletion/account-deletion-request-payload.dto.js.map

@@ -1 +1 @@
-{"version":3,"file":"account-deletion-request-payload.dto.js","sourceRoot":"","sources":["../../../../../src/kafka/dtos/account-deletion/account-deletion-request-payload.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qDAAuH;AACvH,yDAA8C;AAC9C,wDAA0D;AAC1D,uGAA6F;AAE7F,MAAa,gCAAgC;CAkC5C;AAlCD,4EAkCC;AA/BG;IAFC,IAAA,wBAAM,EAAC,wBAAa,CAAC;IACrB,IAAA,4BAAU,GAAE;;+DACS;AAItB;IAFC,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;gEACG;AAIhB;IAFC,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;8DACC;AAId;IAFC,IAAA,yBAAO,GAAE;IACT,IAAA,4BAAU,GAAE;;+DACE;AAIf;IAFC,IAAA,wBAAM,EAAC,gDAAmB,CAAC;IAC3B,IAAA,4BAAU,GAAE;;gEACgB;AAM7B;IAJC,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;IACZ,IAAA,2BAAS,EAAC,GAAG,CAAC;IACd,IAAA,6BAAS,EAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC;;4EAC/B;AAI5B;IAFC,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;mEACM;AAInB;IAFC,IAAA,8BAAY,GAAE;IACd,IAAA,4BAAU,GAAE;;mEACM"}
+{"version":3,"file":"account-deletion-request-payload.dto.js","sourceRoot":"","sources":["../../../../../src/kafka/dtos/account-deletion/account-deletion-request-payload.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qDAA0I;AAC1I,yDAA8C;AAC9C,wDAA0D;AAC1D,uGAA6F;AAE7F,MAAa,gCAAgC;CA4C5C;AA5CD,4EA4CC;AAzCG;IAFC,IAAA,wBAAM,EAAC,wBAAa,CAAC;IACrB,IAAA,4BAAU,GAAE;;+DACS;AAUtB;IAHC,IAAA,uBAAK,GAAE;IACP,IAAA,4BAAU,GAAE;IACZ,IAAA,4BAAU,GAAE;;wEACW;AAIxB;IAFC,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;gEACG;AAIhB;IAFC,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;8DACC;AAId;IAFC,IAAA,yBAAO,GAAE;IACT,IAAA,4BAAU,GAAE;;+DACE;AAIf;IAFC,IAAA,wBAAM,EAAC,gDAAmB,CAAC;IAC3B,IAAA,4BAAU,GAAE;;gEACgB;AAM7B;IAJC,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;IACZ,IAAA,2BAAS,EAAC,GAAG,CAAC;IACd,IAAA,6BAAS,EAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC;;4EAC/B;AAI5B;IAFC,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;mEACM;AAInB;IAFC,IAAA,8BAAY,GAAE;IACd,IAAA,4BAAU,GAAE;;mEACM"}

package/dist/cjs/kafka/dtos/otp/create-otp-payload.dto.js

@@ -21,6 +21,12 @@ __decorate([
     (0, class_validator_1.IsNotEmpty)(),
     __metadata("design:type", String)
 ], CreateOTPPayloadDto.prototype, "appId", void 0);
+__decorate([
+    (0, class_validator_1.IsInt)(),
+    (0, class_validator_1.IsPositive)(),
+    (0, class_validator_1.IsOptional)(),
+    __metadata("design:type", Number)
+], CreateOTPPayloadDto.prototype, "organizationId", void 0);
 __decorate([
     (0, class_validator_1.IsString)(),
     (0, class_validator_1.IsNotEmpty)(),

package/dist/cjs/kafka/dtos/otp/create-otp-payload.dto.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-otp-payload.dto.js","sourceRoot":"","sources":["../../../../../src/kafka/dtos/otp/create-otp-payload.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qDAAqH;AACrH,uEAAmE;AACnE,wDAA0D;AAE1D,MAAa,mBAAmB;CAgD/B;AAhDD,kDAgDC;AA7CG;IAFC,IAAA,wBAAM,EAAC,wBAAa,CAAC;IACrB,IAAA,4BAAU,GAAE;;kDACS;AAItB;IAFC,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;iDACC;AAId;IAFC,IAAA,yBAAO,GAAE;IACT,IAAA,4BAAU,GAAE;;kDACE;AAIf;IAFC,IAAA,+BAAa,GAAE;IACf,IAAA,4BAAU,GAAE;;wDACQ;AAIrB;IAFC,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;iDACC;AAId;IAFC,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;8DACc;AAI3B;IAFC,IAAA,wBAAM,GAAE;IACR,IAAA,4BAAU,GAAE;8BACgB,IAAI;uEAAC;AAIlC;IAFC,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;gDACA;AAIb;IAFC,IAAA,wBAAM,GAAE;IACR,IAAA,4BAAU,GAAE;8BACE,IAAI;yDAAC;AAIpB;IAFC,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;qEACqB;AAIlC;IAFC,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;mDACM;AAInB;IAFC,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;uDACoB"}
+{"version":3,"file":"create-otp-payload.dto.js","sourceRoot":"","sources":["../../../../../src/kafka/dtos/otp/create-otp-payload.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qDAAwI;AACxI,uEAAmE;AACnE,wDAA0D;AAE1D,MAAa,mBAAmB;CA0D/B;AA1DD,kDA0DC;AAvDG;IAFC,IAAA,wBAAM,EAAC,wBAAa,CAAC;IACrB,IAAA,4BAAU,GAAE;;kDACS;AAUtB;IAHC,IAAA,uBAAK,GAAE;IACP,IAAA,4BAAU,GAAE;IACZ,IAAA,4BAAU,GAAE;;2DACW;AAIxB;IAFC,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;iDACC;AAId;IAFC,IAAA,yBAAO,GAAE;IACT,IAAA,4BAAU,GAAE;;kDACE;AAIf;IAFC,IAAA,+BAAa,GAAE;IACf,IAAA,4BAAU,GAAE;;wDACQ;AAIrB;IAFC,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;iDACC;AAId;IAFC,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;8DACc;AAI3B;IAFC,IAAA,wBAAM,GAAE;IACR,IAAA,4BAAU,GAAE;8BACgB,IAAI;uEAAC;AAIlC;IAFC,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;gDACA;AAIb;IAFC,IAAA,wBAAM,GAAE;IACR,IAAA,4BAAU,GAAE;8BACE,IAAI;yDAAC;AAIpB;IAFC,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;qEACqB;AAIlC;IAFC,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;mDACM;AAInB;IAFC,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;uDACoB"}

package/dist/cjs/kafka/dtos/password/password-reset-payload.dto.js

@@ -21,6 +21,12 @@ __decorate([
     (0, class_validator_1.IsNotEmpty)(),
     __metadata("design:type", String)
 ], PasswordResetPayloadDto.prototype, "appId", void 0);
+__decorate([
+    (0, class_validator_1.IsInt)(),
+    (0, class_validator_1.IsPositive)(),
+    (0, class_validator_1.IsOptional)(),
+    __metadata("design:type", Number)
+], PasswordResetPayloadDto.prototype, "organizationId", void 0);
 __decorate([
     (0, class_validator_1.IsString)(),
     (0, class_validator_1.IsNotEmpty)(),

package/dist/cjs/kafka/dtos/password/password-reset-payload.dto.js.map

@@ -1 +1 @@
-{"version":3,"file":"password-reset-payload.dto.js","sourceRoot":"","sources":["../../../../../src/kafka/dtos/password/password-reset-payload.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qDAA0F;AAC1F,yDAA8C;AAC9C,wDAA0D;AAE1D,MAAa,uBAAuB;CAsBnC;AAtBD,0DAsBC;AAnBG;IAFC,IAAA,wBAAM,EAAC,wBAAa,CAAC;IACrB,IAAA,4BAAU,GAAE;;sDACS;AAItB;IAFC,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;qDACC;AAId;IAFC,IAAA,yBAAO,GAAE;IACT,IAAA,4BAAU,GAAE;;sDACE;AAKf;IAHC,IAAA,4BAAU,GAAE;IACZ,IAAA,sBAAI,GAAE;IACN,IAAA,6BAAS,EAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC;;0DACxC;AAKnB;IAHC,IAAA,4BAAU,GAAE;IACZ,IAAA,0BAAQ,GAAE;IACV,IAAA,6BAAS,EAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC;;wDAC1C"}
+{"version":3,"file":"password-reset-payload.dto.js","sourceRoot":"","sources":["../../../../../src/kafka/dtos/password/password-reset-payload.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qDAA6G;AAC7G,yDAA8C;AAC9C,wDAA0D;AAE1D,MAAa,uBAAuB;CAgCnC;AAhCD,0DAgCC;AA7BG;IAFC,IAAA,wBAAM,EAAC,wBAAa,CAAC;IACrB,IAAA,4BAAU,GAAE;;sDACS;AAUtB;IAHC,IAAA,uBAAK,GAAE;IACP,IAAA,4BAAU,GAAE;IACZ,IAAA,4BAAU,GAAE;;+DACW;AAIxB;IAFC,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;qDACC;AAId;IAFC,IAAA,yBAAO,GAAE;IACT,IAAA,4BAAU,GAAE;;sDACE;AAKf;IAHC,IAAA,4BAAU,GAAE;IACZ,IAAA,sBAAI,GAAE;IACN,IAAA,6BAAS,EAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC;;0DACxC;AAKnB;IAHC,IAAA,4BAAU,GAAE;IACZ,IAAA,0BAAQ,GAAE;IACV,IAAA,6BAAS,EAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC;;wDAC1C"}

package/dist/cjs/kafka/dtos/user/create-user-registered-payload.dto.js

@@ -25,6 +25,12 @@ __decorate([
     (0, class_validator_1.IsNotEmpty)(),
     __metadata("design:type", String)
 ], CreateUserRegisteredPayloadDto.prototype, "appId", void 0);
+__decorate([
+    (0, class_validator_1.IsInt)(),
+    (0, class_validator_1.IsPositive)(),
+    (0, class_validator_1.IsOptional)(),
+    __metadata("design:type", Number)
+], CreateUserRegisteredPayloadDto.prototype, "organizationId", void 0);
 __decorate([
     (0, class_validator_1.IsString)(),
     (0, class_validator_1.IsNotEmpty)(),

package/dist/cjs/kafka/dtos/user/create-user-registered-payload.dto.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-user-registered-payload.dto.js","sourceRoot":"","sources":["../../../../../src/kafka/dtos/user/create-user-registered-payload.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qDAA+H;AAC/H,wDAA0D;AAE1D,MAAa,8BAA8B;CA4B1C;AA5BD,wEA4BC;AAzBG;IAFC,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;0DACD;AAIZ;IAFC,IAAA,wBAAM,EAAC,wBAAa,CAAC;IACrB,IAAA,4BAAU,GAAE;;6DACS;AAItB;IAFC,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;4DACC;AAId;IAFC,IAAA,yBAAO,GAAE;IACT,IAAA,4BAAU,GAAE;;6DACE;AAIf;IAFC,IAAA,+BAAa,GAAE;IACf,IAAA,4BAAU,GAAE;;mEACQ;AAIrB;IAFC,IAAA,wBAAM,GAAE;IACR,IAAA,4BAAU,GAAE;8BACD,IAAI;iEAAC;AAIjB;IAFC,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;kEACoB"}
+{"version":3,"file":"create-user-registered-payload.dto.js","sourceRoot":"","sources":["../../../../../src/kafka/dtos/user/create-user-registered-payload.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qDAAkJ;AAClJ,wDAA0D;AAE1D,MAAa,8BAA8B;CAsC1C;AAtCD,wEAsCC;AAnCG;IAFC,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;0DACD;AAIZ;IAFC,IAAA,wBAAM,EAAC,wBAAa,CAAC;IACrB,IAAA,4BAAU,GAAE;;6DACS;AAUtB;IAHC,IAAA,uBAAK,GAAE;IACP,IAAA,4BAAU,GAAE;IACZ,IAAA,4BAAU,GAAE;;sEACW;AAIxB;IAFC,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;4DACC;AAId;IAFC,IAAA,yBAAO,GAAE;IACT,IAAA,4BAAU,GAAE;;6DACE;AAIf;IAFC,IAAA,+BAAa,GAAE;IACf,IAAA,4BAAU,GAAE;;mEACQ;AAIrB;IAFC,IAAA,wBAAM,GAAE;IACR,IAAA,4BAAU,GAAE;8BACD,IAAI;iEAAC;AAIjB;IAFC,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;kEACoB"}

package/dist/cjs/modules/notification/constants/notification-sender.const.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MAX_SMS_SENDERS_PER_ORGANIZATION = exports.MAX_EMAIL_SENDERS_PER_ORGANIZATION = exports.SMS_SENDER_ID_HINTS = exports.SMS_SENDER_ID_PATTERNS = exports.BRAND_COLOUR_PATTERN = void 0;
+const sms_sender_type_enum_1 = require("../enums/sms-sender-type.enum");
+/** `#RRGGBB`. The only colour format accepted, because it is inlined into email CSS. */
+exports.BRAND_COLOUR_PATTERN = /^#[0-9a-fA-F]{6}$/;
+/**
+ * What a sender value must look like, per type.
+ *
+ * ALPHANUMERIC follows the GSM rule every supported provider enforces: 3-11
+ * characters, at least one letter (an all-digit "name" is a number, and telcos
+ * reject it as spoofing).
+ */
+exports.SMS_SENDER_ID_PATTERNS = Object.freeze({
+    [sms_sender_type_enum_1.SmsSenderType.ALPHANUMERIC]: /^(?=.*[A-Za-z])[A-Za-z0-9 _.&-]{3,11}$/,
+    [sms_sender_type_enum_1.SmsSenderType.PHONE_NUMBER]: /^\+[1-9]\d{6,14}$/,
+    [sms_sender_type_enum_1.SmsSenderType.SHORT_CODE]: /^\d{3,8}$/,
+    [sms_sender_type_enum_1.SmsSenderType.MESSAGING_SERVICE]: /^MG[0-9a-fA-F]{32}$/,
+});
+/** Human-readable form of {@link SMS_SENDER_ID_PATTERNS}, for validation messages and form hints. */
+exports.SMS_SENDER_ID_HINTS = Object.freeze({
+    [sms_sender_type_enum_1.SmsSenderType.ALPHANUMERIC]: '3-11 characters (letters, digits, space, _ . & -) with at least one letter, e.g. G4S',
+    [sms_sender_type_enum_1.SmsSenderType.PHONE_NUMBER]: 'an E.164 number, e.g. +254711000000',
+    [sms_sender_type_enum_1.SmsSenderType.SHORT_CODE]: '3-8 digits, e.g. 22384',
+    [sms_sender_type_enum_1.SmsSenderType.MESSAGING_SERVICE]: 'a Twilio Messaging Service SID (MG followed by 32 hex characters)',
+});
+/** Upper bounds that keep one organization from turning its settings into a list to page through. */
+exports.MAX_EMAIL_SENDERS_PER_ORGANIZATION = 10;
+exports.MAX_SMS_SENDERS_PER_ORGANIZATION = 30;
+//# sourceMappingURL=notification-sender.const.js.map

package/dist/cjs/modules/notification/constants/notification-sender.const.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notification-sender.const.js","sourceRoot":"","sources":["../../../../../src/modules/notification/constants/notification-sender.const.ts"],"names":[],"mappings":";;;AAAA,wEAA8D;AAE9D,wFAAwF;AAC3E,QAAA,oBAAoB,GAAG,mBAAmB,CAAC;AAExD;;;;;;GAMG;AACU,QAAA,sBAAsB,GAA4C,MAAM,CAAC,MAAM,CAAC;IACzF,CAAC,oCAAa,CAAC,YAAY,CAAC,EAAE,wCAAwC;IACtE,CAAC,oCAAa,CAAC,YAAY,CAAC,EAAE,mBAAmB;IACjD,CAAC,oCAAa,CAAC,UAAU,CAAC,EAAE,WAAW;IACvC,CAAC,oCAAa,CAAC,iBAAiB,CAAC,EAAE,qBAAqB;CAC3D,CAAC,CAAC;AAEH,qGAAqG;AACxF,QAAA,mBAAmB,GAA4C,MAAM,CAAC,MAAM,CAAC;IACtF,CAAC,oCAAa,CAAC,YAAY,CAAC,EAAE,sFAAsF;IACpH,CAAC,oCAAa,CAAC,YAAY,CAAC,EAAE,qCAAqC;IACnE,CAAC,oCAAa,CAAC,UAAU,CAAC,EAAE,wBAAwB;IACpD,CAAC,oCAAa,CAAC,iBAAiB,CAAC,EAAE,mEAAmE;CACzG,CAAC,CAAC;AAEH,qGAAqG;AACxF,QAAA,kCAAkC,GAAG,EAAE,CAAC;AACxC,QAAA,gCAAgC,GAAG,EAAE,CAAC"}

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"}