@things-factory/notification 10.1.258 → 10.1.259

package/dist-server/controllers/notice/index.d.ts

@@ -1,3 +1,4 @@
 export * from './notice-channels.js';
 export * from './deliver-notice.js';
 export * from './send-notice.js';
+export * from './notice-delivery-record.js';

package/dist-server/controllers/notice/index.js

@@ -4,4 +4,5 @@ const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./notice-channels.js"), exports);
 tslib_1.__exportStar(require("./deliver-notice.js"), exports);
 tslib_1.__exportStar(require("./send-notice.js"), exports);
+tslib_1.__exportStar(require("./notice-delivery-record.js"), exports);
 //# sourceMappingURL=index.js.map

package/dist-server/controllers/notice/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../server/controllers/notice/index.ts"],"names":[],"mappings":";;;AAAA,+DAAoC;AACpC,8DAAmC;AACnC,2DAAgC","sourcesContent":["export * from './notice-channels.js'\nexport * from './deliver-notice.js'\nexport * from './send-notice.js'\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../server/controllers/notice/index.ts"],"names":[],"mappings":";;;AAAA,+DAAoC;AACpC,8DAAmC;AACnC,2DAAgC;AAChC,sEAA2C","sourcesContent":["export * from './notice-channels.js'\nexport * from './deliver-notice.js'\nexport * from './send-notice.js'\nexport * from './notice-delivery-record.js'\n"]}

package/dist-server/controllers/notice/notice-delivery-record.d.ts

@@ -0,0 +1,26 @@
+import type { NoticeResult } from './deliver-notice.js';
+/** One telling - when, why, and what went out. `failed` says nothing could go at all. */
+export type NoticeDelivery = {
+    at: string;
+    kind: string;
+    receivers: number;
+    email: {
+        sent: number;
+        failed: number;
+    };
+    teams: {
+        sent: number;
+        failed: number;
+    };
+    failed?: boolean;
+};
+/** A send that could not go at all counts its receivers, nothing sent. */
+export declare function noticeDeliveryOf(kind: string, result: NoticeResult | undefined, receivers: number, at?: Date): NoticeDelivery;
+/** The record keeps the newest tellings, at most `MAX_NOTICE_DELIVERIES`. */
+export declare const MAX_NOTICE_DELIVERIES = 50;
+export declare function withNoticeDelivery<T>(deliveries: T[] | null | undefined, one: T): T[];
+/**
+ * Adds one telling to `column` of row `id` - in its own transaction, the request's being over. A record that cannot be
+ * kept is reported; what was told of stands.
+ */
+export declare function keepNoticeDelivery(entity: any, id: string, column: string, delivery: NoticeDelivery): Promise<void>;

package/dist-server/controllers/notice/notice-delivery-record.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MAX_NOTICE_DELIVERIES = void 0;
+exports.noticeDeliveryOf = noticeDeliveryOf;
+exports.withNoticeDelivery = withNoticeDelivery;
+exports.keepNoticeDelivery = keepNoticeDelivery;
+/*
+ * What one telling sent, kept on the thing it told of (ADR-0164) - an announcement, an approval. Mail goes out after the
+ * request is over, so whether it went is known only from this record: the screens and an operator read it.
+ */
+const env_1 = require("@things-factory/env");
+const shell_1 = require("@things-factory/shell");
+/** A send that could not go at all counts its receivers, nothing sent. */
+function noticeDeliveryOf(kind, result, receivers, at = new Date()) {
+    return {
+        at: at.toISOString(),
+        kind,
+        receivers: result?.receivers ?? receivers,
+        email: result?.email ?? { sent: 0, failed: 0 },
+        teams: result?.teams ?? { sent: 0, failed: 0 },
+        ...(result ? {} : { failed: true })
+    };
+}
+/** The record keeps the newest tellings, at most `MAX_NOTICE_DELIVERIES`. */
+exports.MAX_NOTICE_DELIVERIES = 50;
+function withNoticeDelivery(deliveries, one) {
+    return [...(deliveries ?? []), one].slice(-exports.MAX_NOTICE_DELIVERIES);
+}
+/**
+ * Adds one telling to `column` of row `id` - in its own transaction, the request's being over. A record that cannot be
+ * kept is reported; what was told of stands.
+ */
+async function keepNoticeDelivery(entity, id, column, delivery) {
+    try {
+        const repository = (0, shell_1.getRepository)(entity);
+        const one = await repository.findOneBy({ id });
+        if (one)
+            await repository.update(id, { [column]: withNoticeDelivery(one[column], delivery) });
+    }
+    catch (error) {
+        env_1.logger.error(`[notification] ${entity?.name ?? 'row'} ${id}: what was sent could not be kept`, error);
+    }
+}
+//# sourceMappingURL=notice-delivery-record.js.map

package/dist-server/controllers/notice/notice-delivery-record.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notice-delivery-record.js","sourceRoot":"","sources":["../../../server/controllers/notice/notice-delivery-record.ts"],"names":[],"mappings":";;;AAoBA,4CASC;AAID,gDAEC;AAMD,gDAQC;AAjDD;;;GAGG;AACH,6CAA4C;AAC5C,iDAAqD;AAcrD,0EAA0E;AAC1E,SAAgB,gBAAgB,CAAC,IAAY,EAAE,MAAgC,EAAE,SAAiB,EAAE,EAAE,GAAG,IAAI,IAAI,EAAE;IACjH,OAAO;QACL,EAAE,EAAE,EAAE,CAAC,WAAW,EAAE;QACpB,IAAI;QACJ,SAAS,EAAE,MAAM,EAAE,SAAS,IAAI,SAAS;QACzC,KAAK,EAAE,MAAM,EAAE,KAAK,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE;QAC9C,KAAK,EAAE,MAAM,EAAE,KAAK,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE;QAC9C,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;KACpC,CAAA;AACH,CAAC;AAED,6EAA6E;AAChE,QAAA,qBAAqB,GAAG,EAAE,CAAA;AACvC,SAAgB,kBAAkB,CAAI,UAAkC,EAAE,GAAM;IAC9E,OAAO,CAAC,GAAG,CAAC,UAAU,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,6BAAqB,CAAC,CAAA;AACnE,CAAC;AAED;;;GAGG;AACI,KAAK,UAAU,kBAAkB,CAAC,MAAW,EAAE,EAAU,EAAE,MAAc,EAAE,QAAwB;IACxG,IAAI,CAAC;QACH,MAAM,UAAU,GAAG,IAAA,qBAAa,EAAC,MAAM,CAAC,CAAA;QACxC,MAAM,GAAG,GAAQ,MAAM,UAAU,CAAC,SAAS,CAAC,EAAE,EAAE,EAAS,CAAC,CAAA;QAC1D,IAAI,GAAG;YAAE,MAAM,UAAU,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,kBAAkB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,EAAS,CAAC,CAAA;IACtG,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,YAAM,CAAC,KAAK,CAAC,kBAAkB,MAAM,EAAE,IAAI,IAAI,KAAK,IAAI,EAAE,mCAAmC,EAAE,KAAK,CAAC,CAAA;IACvG,CAAC;AACH,CAAC","sourcesContent":["/*\n * What one telling sent, kept on the thing it told of (ADR-0164) - an announcement, an approval. Mail goes out after the\n * request is over, so whether it went is known only from this record: the screens and an operator read it.\n */\nimport { logger } from '@things-factory/env'\nimport { getRepository } from '@things-factory/shell'\n\nimport type { NoticeResult } from './deliver-notice.js'\n\n/** One telling - when, why, and what went out. `failed` says nothing could go at all. */\nexport type NoticeDelivery = {\n  at: string\n  kind: string\n  receivers: number\n  email: { sent: number; failed: number }\n  teams: { sent: number; failed: number }\n  failed?: boolean\n}\n\n/** A send that could not go at all counts its receivers, nothing sent. */\nexport function noticeDeliveryOf(kind: string, result: NoticeResult | undefined, receivers: number, at = new Date()): NoticeDelivery {\n  return {\n    at: at.toISOString(),\n    kind,\n    receivers: result?.receivers ?? receivers,\n    email: result?.email ?? { sent: 0, failed: 0 },\n    teams: result?.teams ?? { sent: 0, failed: 0 },\n    ...(result ? {} : { failed: true })\n  }\n}\n\n/** The record keeps the newest tellings, at most `MAX_NOTICE_DELIVERIES`. */\nexport const MAX_NOTICE_DELIVERIES = 50\nexport function withNoticeDelivery<T>(deliveries: T[] | null | undefined, one: T): T[] {\n  return [...(deliveries ?? []), one].slice(-MAX_NOTICE_DELIVERIES)\n}\n\n/**\n * Adds one telling to `column` of row `id` - in its own transaction, the request's being over. A record that cannot be\n * kept is reported; what was told of stands.\n */\nexport async function keepNoticeDelivery(entity: any, id: string, column: string, delivery: NoticeDelivery): Promise<void> {\n  try {\n    const repository = getRepository(entity)\n    const one: any = await repository.findOneBy({ id } as any)\n    if (one) await repository.update(id, { [column]: withNoticeDelivery(one[column], delivery) } as any)\n  } catch (error) {\n    logger.error(`[notification] ${entity?.name ?? 'row'} ${id}: what was sent could not be kept`, error)\n  }\n}\n"]}