@managemint-solutions/entities 1.13.0 → 1.15.0

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

@@ -12,6 +12,7 @@ export declare enum NotificationType {
     TASK_ASSIGNED = "task_assigned",
     PROJECT_MANAGER_ASSIGNED = "project_manager_assigned",
     PAYMENT_FAILED = "payment_failed",
+    INVOICE_PAID = "invoice_paid",
     SIGNUP_CONFIRMATION = "signup_confirmation",
     PASSWORD_RECOVERY = "password_recovery"
 }

package/dist/notifications/enum/index.js

@@ -20,6 +20,7 @@ var NotificationType;
     NotificationType["TASK_ASSIGNED"] = "task_assigned";
     NotificationType["PROJECT_MANAGER_ASSIGNED"] = "project_manager_assigned";
     NotificationType["PAYMENT_FAILED"] = "payment_failed";
+    NotificationType["INVOICE_PAID"] = "invoice_paid";
     NotificationType["SIGNUP_CONFIRMATION"] = "signup_confirmation";
     NotificationType["PASSWORD_RECOVERY"] = "password_recovery";
 })(NotificationType || (exports.NotificationType = NotificationType = {}));

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

@@ -0,0 +1,29 @@
+import type { SupportTopic } from '../enum';
+/**
+ * The body of `POST /support`. Every field the endpoint accepts is here: the api's global
+ * ValidationPipe runs with `forbidNonWhitelisted`, so anything not on this contract is a 400 —
+ * the honeypot included, which is why it is a declared field rather than a stray one.
+ *
+ * Nothing is stored. The api turns one of these into two emails — the message to the support
+ * inbox, and an acknowledgement back to `email` — and that is the whole record of it.
+ */
+export type CreateSupportRequestDto = {
+    topic: SupportTopic;
+    /** Whatever the sender called themselves. */
+    name: string;
+    /** Where the acknowledgement goes, and the Reply-To on the message to the inbox. */
+    email: string;
+    /** Optional on the form. Empty is normalised to null. */
+    company?: string | null;
+    message: string;
+    /**
+     * Honeypot. The website renders it off-screen and always submits it empty; a bot that fills
+     * every input it can see gets a 201 and no email. Optional so an older client that does not
+     * send it at all still works.
+     */
+    website_url?: string;
+};
+/** All a sender gets back: confirmation that the message was accepted. */
+export type CreateSupportRequestResponse = {
+    message: string;
+};

package/dist/support/dto/index.js

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

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

@@ -0,0 +1,10 @@
+/**
+ * What a message through the website's contact page is about. The three values are the three
+ * chips on the form, and the api turns each into the subject line and the topic wording of
+ * the emails it sends.
+ */
+export declare enum SupportTopic {
+    GETTING_STARTED = "getting-started",
+    SUPPORT = "support",
+    BUILD = "build"
+}

package/dist/support/enum/index.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SupportTopic = void 0;
+/**
+ * What a message through the website's contact page is about. The three values are the three
+ * chips on the form, and the api turns each into the subject line and the topic wording of
+ * the emails it sends.
+ */
+var SupportTopic;
+(function (SupportTopic) {
+    SupportTopic["GETTING_STARTED"] = "getting-started";
+    SupportTopic["SUPPORT"] = "support";
+    SupportTopic["BUILD"] = "build";
+})(SupportTopic || (exports.SupportTopic = SupportTopic = {}));
+;

package/dist/support/index.d.ts

@@ -0,0 +1,8 @@
+export * from './enum';
+/**
+ * The marketing website's contact page, `POST /support`.
+ *
+ * There is no entity here on purpose: a message through the contact page is not stored
+ * anywhere. The api sends it to the support inbox and acknowledges it to the sender, and the
+ * two emails are the only record. The contract lives in `./dto`, the topics in `./enum`.
+ */

package/dist/support/index.js

@@ -0,0 +1,24 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./enum"), exports);
+/**
+ * The marketing website's contact page, `POST /support`.
+ *
+ * There is no entity here on purpose: a message through the contact page is not stored
+ * anywhere. The api sends it to the support inbox and acknowledges it to the sender, and the
+ * two emails are the only record. The contract lives in `./dto`, the topics in `./enum`.
+ */

package/package.json

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