clarion-shared-types 1.0.107 → 1.0.109

package/dist/cjs/index.js

@@ -40,6 +40,7 @@ __exportStar(require("./modules/alert-intake/index"), exports);
 __exportStar(require("./modules/partner/index"), exports);
 __exportStar(require("./modules/support/index"), exports);
 __exportStar(require("./modules/safety/index"), exports);
+__exportStar(require("./modules/billing/index"), exports);
 // Interfaces
 __exportStar(require("./modules/common/interfaces/server-message"), exports);
 __exportStar(require("./modules/common/interfaces/pagination"), exports);

package/dist/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,UAAU;AACV,uDAAqC;AACrC,+DAA6C;AAC7C,yDAAuC;AACvC,6DAA2C;AAC3C,uDAAqC;AACrC,uDAAqC;AACrC,iEAA+C;AAC/C,gEAA8C;AAC9C,2DAAyC;AACzC,2DAAyC;AACzC,sDAAoC;AACpC,sDAAoC;AACpC,sDAAoC;AACpC,yDAAuC;AACvC,mEAAiD;AACjD,+DAA6C;AAC7C,uDAAqC;AACrC,0DAAwC;AACxC,2DAAyC;AACzC,8DAA4C;AAC5C,iEAA+C;AAC/C,+DAA6C;AAC7C,0DAAwC;AACxC,0DAAwC;AACxC,yDAAuC;AAEvC,aAAa;AACb,6EAA2D;AAC3D,yEAAuD"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,UAAU;AACV,uDAAqC;AACrC,+DAA6C;AAC7C,yDAAuC;AACvC,6DAA2C;AAC3C,uDAAqC;AACrC,uDAAqC;AACrC,iEAA+C;AAC/C,gEAA8C;AAC9C,2DAAyC;AACzC,2DAAyC;AACzC,sDAAoC;AACpC,sDAAoC;AACpC,sDAAoC;AACpC,yDAAuC;AACvC,mEAAiD;AACjD,+DAA6C;AAC7C,uDAAqC;AACrC,0DAAwC;AACxC,2DAAyC;AACzC,8DAA4C;AAC5C,iEAA+C;AAC/C,+DAA6C;AAC7C,0DAAwC;AACxC,0DAAwC;AACxC,yDAAuC;AACvC,0DAAwC;AAExC,aAAa;AACb,6EAA2D;AAC3D,yEAAuD"}

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

@@ -0,0 +1,19 @@
+"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 });
+// Interfaces
+__exportStar(require("./interfaces/billing-analytics"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/modules/billing/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,aAAa;AACb,iEAA+C"}

package/dist/cjs/modules/billing/interfaces/billing-analytics.js

@@ -0,0 +1,17 @@
+"use strict";
+/**
+ * Billing analytics: what came in over a period and what it was for, what was invoiced
+ * and is still owed, how checkouts went, how subscriptions and the people they cover
+ * moved, how trials turned into paying customers, and what is owed to the platform.
+ *
+ * One read, computed by clarion-billing from one consistent snapshot, so every number
+ * on a dashboard agrees with every other. Money is in minor units of ONE currency (the
+ * answer's `currency`): an organization that sells in two currencies is read one
+ * currency at a time, never added up across them.
+ *
+ * Totals and counts only: never a person's name, phone number or e-mail. A corporate
+ * client and a package appear by name - they are the organization's own customers and
+ * products, already on its billing screens.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=billing-analytics.js.map

package/dist/cjs/modules/billing/interfaces/billing-analytics.js.map

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

package/dist/cjs/modules/permission/enums/permission-actions.enum.js

@@ -191,6 +191,8 @@ var PermissionActions;
     PermissionActions["CREATE_SETTLEMENT_BATCH"] = "create:settlement-batch";
     PermissionActions["RECONCILE_SETTLEMENT_BATCH"] = "reconcile:settlement-batch";
     PermissionActions["READ_BILLING_OPERATIONS"] = "read:billing-operations";
+    // Billing Analytics - the organization's billing over a period, totals and counts only.
+    PermissionActions["READ_BILLING_ANALYTICS"] = "read:billing-analytics";
     PermissionActions["READ_PREMIUM_TRIAL"] = "read:premium-trial";
     PermissionActions["GRANT_PREMIUM_TRIAL"] = "grant:premium-trial";
     PermissionActions["REVOKE_PREMIUM_TRIAL"] = "revoke:premium-trial";
@@ -229,6 +231,8 @@ var PermissionActions;
     PermissionActions["USE_SAFETY_CHECK"] = "use:safety-check";
     PermissionActions["READ_SAFETY_CHECK"] = "read:safety-check";
     PermissionActions["MANAGE_SAFETY_CHECK_REASON"] = "manage:safety-check-reason";
+    // Safety Analytics: how Safety Check and Follow Me are used - counts only.
+    PermissionActions["READ_SAFETY_ANALYTICS"] = "read:safety-analytics";
     // Follow Me: use = run and follow journeys in the app; read = staff see sessions
     // (no location); track = staff see WHERE, only for sessions shared with the
     // provider or turned SOS (clarion-safety enforces that condition).

package/dist/cjs/modules/permission/enums/permission-actions.enum.js.map

@@ -1 +1 @@
-{"version":3,"file":"permission-actions.enum.js","sourceRoot":"","sources":["../../../../../src/modules/permission/enums/permission-actions.enum.ts"],"names":[],"mappings":";;;AAAA,IAAY,iBA8QX;AA9QD,WAAY,iBAAiB;IACzB,uBAAuB;IACvB,gEAA2C,CAAA;IAC3C,4DAAuC,CAAA;IACvC,gEAA2C,CAAA;IAC3C,gEAA2C,CAAA;IAE3C,kBAAkB;IAClB,sDAAiC,CAAA;IACjC,kDAA6B,CAAA;IAC7B,sDAAiC,CAAA;IACjC,sDAAiC,CAAA;IACjC,wEAAwE;IACxE,mEAAmE;IACnE,oEAA+C,CAAA;IAC/C,0EAAqD,CAAA;IACrD,wEAAmD,CAAA;IACnD,wEAAmD,CAAA;IACnD,wEAAmD,CAAA;IACnD,2EAA2E;IAC3E,4EAA4E;IAC5E,qEAAqE;IACrE,uDAAuD;IACvD,wEAAmD,CAAA;IACnD,4EAAuD,CAAA;IAEvD,wBAAwB;IACxB,oEAA+C,CAAA;IAC/C,gEAA2C,CAAA;IAC3C,oEAA+C,CAAA;IAC/C,oEAA+C,CAAA;IAE/C,eAAe;IACf,gDAA2B,CAAA;IAC3B,4CAAuB,CAAA;IACvB,gDAA2B,CAAA;IAC3B,gDAA2B,CAAA;IAE3B,eAAe;IACf,gDAA2B,CAAA;IAC3B,4CAAuB,CAAA;IACvB,gDAA2B,CAAA;IAC3B,gDAA2B,CAAA;IAE3B,mBAAmB;IACnB,wDAAmC,CAAA;IACnC,oDAA+B,CAAA;IAC/B,wDAAmC,CAAA;IACnC,wDAAmC,CAAA;IACnC,oFAA+D,CAAA;IAC/D,gFAA2D,CAAA;IAC3D,oFAA+D,CAAA;IAC/D,oFAA+D,CAAA;IAE/D,uBAAuB;IACvB,kEAA6C,CAAA;IAC7C,8DAAyC,CAAA;IACzC,kEAA6C,CAAA;IAC7C,kEAA6C,CAAA;IAE7C,4EAA4E;IAC5E,wEAAwE;IACxE,6EAA6E;IAC7E,qDAAqD;IACrD,gGAA2E,CAAA;IAC3E,4FAAuE,CAAA;IACvE,gGAA2E,CAAA;IAC3E,gGAA2E,CAAA;IAC3E,sFAAiE,CAAA;IACjE,kFAA6D,CAAA;IAC7D,sFAAiE,CAAA;IACjE,sFAAiE,CAAA;IACjE,sEAAiD,CAAA;IACjD,oEAA+C,CAAA;IAC/C,0EAAqD,CAAA;IACrD,8EAAyD,CAAA;IAEzD,kBAAkB;IAClB,EAAE;IACF,2EAA2E;IAC3E,0EAA0E;IAC1E,uEAAuE;IACvE,+BAA+B;IAC/B,oEAA+C,CAAA;IAC/C,gEAA2C,CAAA;IAC3C,oEAA+C,CAAA;IAC/C,oEAA+C,CAAA;IAC/C,kEAA6C,CAAA;IAC7C,gEAA2C,CAAA;IAC3C,kFAA6D,CAAA;IAC7D,sFAAiE,CAAA;IACjE,kEAA6C,CAAA;IAC7C,oEAA+C,CAAA;IAC/C,yEAAyE;IACzE,gEAA2C,CAAA;IAC3C;;;OAGG;IACH,8DAAyC,CAAA;IACzC,mFAAmF;IACnF,wEAAmD,CAAA;IACnD,oEAA+C,CAAA;IAC/C,gFAAgF;IAChF,sEAAiD,CAAA;IACjD,wEAAmD,CAAA;IACnD,0EAAqD,CAAA;IACrD,0EAAqD,CAAA;IACrD,kEAA6C,CAAA;IAC7C,gEAA2C,CAAA;IAC3C,8DAAyC,CAAA;IACzC,kFAA6D,CAAA;IAC7D,gEAA2C,CAAA;IAC3C,4DAAuC,CAAA;IACvC,gEAA2C,CAAA;IAE3C,uBAAuB;IACvB,0EAA0E;IAC1E,4EAA4E;IAC5E,kFAAkF;IAClF,8EAAyD,CAAA;IACzD,kFAA6D,CAAA;IAC7D,0FAAqE,CAAA;IACrE,sFAAiE,CAAA;IACjE,0FAAqE,CAAA;IACrE,0FAAqE,CAAA;IACrE,sFAAiE,CAAA;IACjE,kFAA6D,CAAA;IAC7D,sFAAiE,CAAA;IACjE,sFAAiE,CAAA;IACjE,2EAA2E;IAC3E,uEAAuE;IACvE,gFAA2D,CAAA;IAC3D,yFAAyF;IACzF,8EAAyD,CAAA;IACzD,yFAAyF;IACzF,kFAA6D,CAAA;IAE7D,gFAAgF;IAChF,gFAAgF;IAChF,kFAAkF;IAClF,kFAAkF;IAClF,8EAA8E;IAC9E,kFAAkF;IAClF,8DAAyC,CAAA;IACzC,0DAAqC,CAAA;IACrC,8DAAyC,CAAA;IACzC,8DAAyC,CAAA;IAEzC,oEAA+C,CAAA;IAC/C,gEAA2C,CAAA;IAC3C,oEAA+C,CAAA;IAC/C,oEAA+C,CAAA;IAE/C,wEAAmD,CAAA;IACnD,oEAA+C,CAAA;IAC/C,wEAAmD,CAAA;IACnD,wEAAmD,CAAA;IAEnD,sFAAiE,CAAA;IACjE,kFAA6D,CAAA;IAC7D,sFAAiE,CAAA;IACjE,sFAAiE,CAAA;IAEjE,0EAAqD,CAAA;IACrD,sEAAiD,CAAA;IACjD,0EAAqD,CAAA;IACrD,0EAAqD,CAAA;IAErD,0DAAqC,CAAA;IAErC,sDAAiC,CAAA;IACjC,kDAA6B,CAAA;IAC7B,4DAAuC,CAAA;IAEvC,kDAA6B,CAAA;IAC7B,8CAAyB,CAAA;IACzB,oDAA+B,CAAA;IAE/B,sDAAiC,CAAA;IACjC,kDAA6B,CAAA;IAE7B,sDAAiC,CAAA;IACjC,kDAA6B,CAAA;IAC7B,sDAAiC,CAAA;IACjC,0DAAqC,CAAA;IACrC,8DAAyC,CAAA;IACzC,sDAAiC,CAAA;IAEjC,8DAAyC,CAAA;IACzC,sDAAiC,CAAA;IACjC,kDAA6B,CAAA;IAE7B,8FAAyE,CAAA;IACzE,kFAA6D,CAAA;IAC7D,0GAAqF,CAAA;IACrF,sFAAiE,CAAA;IAEjE,4FAAuE,CAAA;IACvE,gFAA2D,CAAA;IAC3D,wGAAmF,CAAA;IACnF,oFAA+D,CAAA;IAE/D,8DAAyC,CAAA;IAEzC,4DAAuC,CAAA;IACvC,wDAAmC,CAAA;IACnC,wEAAmD,CAAA;IACnD,kEAA6C,CAAA;IAE7C,oEAA+C,CAAA;IAC/C,wEAAmD,CAAA;IACnD,8EAAyD,CAAA;IAEzD,wEAAmD,CAAA;IAEnD,8DAAyC,CAAA;IACzC,gEAA2C,CAAA;IAC3C,kEAA6C,CAAA;IAE7C,iFAAiF;IACjF,2EAA2E;IAC3E,2EAA2E;IAC3E,kEAA6C,CAAA;IAC7C,8DAAyC,CAAA;IACzC,kEAA6C,CAAA;IAC7C,oEAA+C,CAAA;IAC/C,oEAA+C,CAAA;IAC/C,kEAA6C,CAAA;IAC7C,8DAAyC,CAAA;IACzC,kEAA6C,CAAA;IAC7C,4EAAuD,CAAA;IAEvD,uBAAuB;IACvB,+EAA+E;IAC/E,mFAAmF;IACnF,4DAA4D;IAC5D,sFAAiE,CAAA;IACjE,kFAA6D,CAAA;IAC7D,sFAAiE,CAAA;IACjE,sFAAiE,CAAA;IACjE,kFAA6D,CAAA;IAC7D,4EAAuD,CAAA;IACvD,8EAAyD,CAAA;IACzD,8FAAyE,CAAA;IACzE,kGAA6E,CAAA;IAC7E,gFAA2D,CAAA;IAC3D,gFAAgF;IAChF,sFAAsF;IACtF,kFAA6D,CAAA;IAE7D,gFAAgF;IAChF,0EAA0E;IAC1E,gDAAgD;IAChD,0DAAqC,CAAA;IACrC,4DAAuC,CAAA;IACvC,8EAAyD,CAAA;IACzD,iFAAiF;IACjF,4EAA4E;IAC5E,mEAAmE;IACnE,oDAA+B,CAAA;IAC/B,sDAAiC,CAAA;IACjC,wDAAmC,CAAA;IAEnC,4DAA4D;IAC5D,8DAAyC,CAAA;IACzC,wGAAwG;IACxG,4DAAuC,CAAA;IACvC,wGAAwG;IACxG,gEAA2C,CAAA;AAC/C,CAAC,EA9QW,iBAAiB,iCAAjB,iBAAiB,QA8Q5B"}
+{"version":3,"file":"permission-actions.enum.js","sourceRoot":"","sources":["../../../../../src/modules/permission/enums/permission-actions.enum.ts"],"names":[],"mappings":";;;AAAA,IAAY,iBAkRX;AAlRD,WAAY,iBAAiB;IACzB,uBAAuB;IACvB,gEAA2C,CAAA;IAC3C,4DAAuC,CAAA;IACvC,gEAA2C,CAAA;IAC3C,gEAA2C,CAAA;IAE3C,kBAAkB;IAClB,sDAAiC,CAAA;IACjC,kDAA6B,CAAA;IAC7B,sDAAiC,CAAA;IACjC,sDAAiC,CAAA;IACjC,wEAAwE;IACxE,mEAAmE;IACnE,oEAA+C,CAAA;IAC/C,0EAAqD,CAAA;IACrD,wEAAmD,CAAA;IACnD,wEAAmD,CAAA;IACnD,wEAAmD,CAAA;IACnD,2EAA2E;IAC3E,4EAA4E;IAC5E,qEAAqE;IACrE,uDAAuD;IACvD,wEAAmD,CAAA;IACnD,4EAAuD,CAAA;IAEvD,wBAAwB;IACxB,oEAA+C,CAAA;IAC/C,gEAA2C,CAAA;IAC3C,oEAA+C,CAAA;IAC/C,oEAA+C,CAAA;IAE/C,eAAe;IACf,gDAA2B,CAAA;IAC3B,4CAAuB,CAAA;IACvB,gDAA2B,CAAA;IAC3B,gDAA2B,CAAA;IAE3B,eAAe;IACf,gDAA2B,CAAA;IAC3B,4CAAuB,CAAA;IACvB,gDAA2B,CAAA;IAC3B,gDAA2B,CAAA;IAE3B,mBAAmB;IACnB,wDAAmC,CAAA;IACnC,oDAA+B,CAAA;IAC/B,wDAAmC,CAAA;IACnC,wDAAmC,CAAA;IACnC,oFAA+D,CAAA;IAC/D,gFAA2D,CAAA;IAC3D,oFAA+D,CAAA;IAC/D,oFAA+D,CAAA;IAE/D,uBAAuB;IACvB,kEAA6C,CAAA;IAC7C,8DAAyC,CAAA;IACzC,kEAA6C,CAAA;IAC7C,kEAA6C,CAAA;IAE7C,4EAA4E;IAC5E,wEAAwE;IACxE,6EAA6E;IAC7E,qDAAqD;IACrD,gGAA2E,CAAA;IAC3E,4FAAuE,CAAA;IACvE,gGAA2E,CAAA;IAC3E,gGAA2E,CAAA;IAC3E,sFAAiE,CAAA;IACjE,kFAA6D,CAAA;IAC7D,sFAAiE,CAAA;IACjE,sFAAiE,CAAA;IACjE,sEAAiD,CAAA;IACjD,oEAA+C,CAAA;IAC/C,0EAAqD,CAAA;IACrD,8EAAyD,CAAA;IAEzD,kBAAkB;IAClB,EAAE;IACF,2EAA2E;IAC3E,0EAA0E;IAC1E,uEAAuE;IACvE,+BAA+B;IAC/B,oEAA+C,CAAA;IAC/C,gEAA2C,CAAA;IAC3C,oEAA+C,CAAA;IAC/C,oEAA+C,CAAA;IAC/C,kEAA6C,CAAA;IAC7C,gEAA2C,CAAA;IAC3C,kFAA6D,CAAA;IAC7D,sFAAiE,CAAA;IACjE,kEAA6C,CAAA;IAC7C,oEAA+C,CAAA;IAC/C,yEAAyE;IACzE,gEAA2C,CAAA;IAC3C;;;OAGG;IACH,8DAAyC,CAAA;IACzC,mFAAmF;IACnF,wEAAmD,CAAA;IACnD,oEAA+C,CAAA;IAC/C,gFAAgF;IAChF,sEAAiD,CAAA;IACjD,wEAAmD,CAAA;IACnD,0EAAqD,CAAA;IACrD,0EAAqD,CAAA;IACrD,kEAA6C,CAAA;IAC7C,gEAA2C,CAAA;IAC3C,8DAAyC,CAAA;IACzC,kFAA6D,CAAA;IAC7D,gEAA2C,CAAA;IAC3C,4DAAuC,CAAA;IACvC,gEAA2C,CAAA;IAE3C,uBAAuB;IACvB,0EAA0E;IAC1E,4EAA4E;IAC5E,kFAAkF;IAClF,8EAAyD,CAAA;IACzD,kFAA6D,CAAA;IAC7D,0FAAqE,CAAA;IACrE,sFAAiE,CAAA;IACjE,0FAAqE,CAAA;IACrE,0FAAqE,CAAA;IACrE,sFAAiE,CAAA;IACjE,kFAA6D,CAAA;IAC7D,sFAAiE,CAAA;IACjE,sFAAiE,CAAA;IACjE,2EAA2E;IAC3E,uEAAuE;IACvE,gFAA2D,CAAA;IAC3D,yFAAyF;IACzF,8EAAyD,CAAA;IACzD,yFAAyF;IACzF,kFAA6D,CAAA;IAE7D,gFAAgF;IAChF,gFAAgF;IAChF,kFAAkF;IAClF,kFAAkF;IAClF,8EAA8E;IAC9E,kFAAkF;IAClF,8DAAyC,CAAA;IACzC,0DAAqC,CAAA;IACrC,8DAAyC,CAAA;IACzC,8DAAyC,CAAA;IAEzC,oEAA+C,CAAA;IAC/C,gEAA2C,CAAA;IAC3C,oEAA+C,CAAA;IAC/C,oEAA+C,CAAA;IAE/C,wEAAmD,CAAA;IACnD,oEAA+C,CAAA;IAC/C,wEAAmD,CAAA;IACnD,wEAAmD,CAAA;IAEnD,sFAAiE,CAAA;IACjE,kFAA6D,CAAA;IAC7D,sFAAiE,CAAA;IACjE,sFAAiE,CAAA;IAEjE,0EAAqD,CAAA;IACrD,sEAAiD,CAAA;IACjD,0EAAqD,CAAA;IACrD,0EAAqD,CAAA;IAErD,0DAAqC,CAAA;IAErC,sDAAiC,CAAA;IACjC,kDAA6B,CAAA;IAC7B,4DAAuC,CAAA;IAEvC,kDAA6B,CAAA;IAC7B,8CAAyB,CAAA;IACzB,oDAA+B,CAAA;IAE/B,sDAAiC,CAAA;IACjC,kDAA6B,CAAA;IAE7B,sDAAiC,CAAA;IACjC,kDAA6B,CAAA;IAC7B,sDAAiC,CAAA;IACjC,0DAAqC,CAAA;IACrC,8DAAyC,CAAA;IACzC,sDAAiC,CAAA;IAEjC,8DAAyC,CAAA;IACzC,sDAAiC,CAAA;IACjC,kDAA6B,CAAA;IAE7B,8FAAyE,CAAA;IACzE,kFAA6D,CAAA;IAC7D,0GAAqF,CAAA;IACrF,sFAAiE,CAAA;IAEjE,4FAAuE,CAAA;IACvE,gFAA2D,CAAA;IAC3D,wGAAmF,CAAA;IACnF,oFAA+D,CAAA;IAE/D,8DAAyC,CAAA;IAEzC,4DAAuC,CAAA;IACvC,wDAAmC,CAAA;IACnC,wEAAmD,CAAA;IACnD,kEAA6C,CAAA;IAE7C,oEAA+C,CAAA;IAC/C,wEAAmD,CAAA;IACnD,8EAAyD,CAAA;IAEzD,wEAAmD,CAAA;IACnD,wFAAwF;IACxF,sEAAiD,CAAA;IAEjD,8DAAyC,CAAA;IACzC,gEAA2C,CAAA;IAC3C,kEAA6C,CAAA;IAE7C,iFAAiF;IACjF,2EAA2E;IAC3E,2EAA2E;IAC3E,kEAA6C,CAAA;IAC7C,8DAAyC,CAAA;IACzC,kEAA6C,CAAA;IAC7C,oEAA+C,CAAA;IAC/C,oEAA+C,CAAA;IAC/C,kEAA6C,CAAA;IAC7C,8DAAyC,CAAA;IACzC,kEAA6C,CAAA;IAC7C,4EAAuD,CAAA;IAEvD,uBAAuB;IACvB,+EAA+E;IAC/E,mFAAmF;IACnF,4DAA4D;IAC5D,sFAAiE,CAAA;IACjE,kFAA6D,CAAA;IAC7D,sFAAiE,CAAA;IACjE,sFAAiE,CAAA;IACjE,kFAA6D,CAAA;IAC7D,4EAAuD,CAAA;IACvD,8EAAyD,CAAA;IACzD,8FAAyE,CAAA;IACzE,kGAA6E,CAAA;IAC7E,gFAA2D,CAAA;IAC3D,gFAAgF;IAChF,sFAAsF;IACtF,kFAA6D,CAAA;IAE7D,gFAAgF;IAChF,0EAA0E;IAC1E,gDAAgD;IAChD,0DAAqC,CAAA;IACrC,4DAAuC,CAAA;IACvC,8EAAyD,CAAA;IACzD,2EAA2E;IAC3E,oEAA+C,CAAA;IAC/C,iFAAiF;IACjF,4EAA4E;IAC5E,mEAAmE;IACnE,oDAA+B,CAAA;IAC/B,sDAAiC,CAAA;IACjC,wDAAmC,CAAA;IAEnC,4DAA4D;IAC5D,8DAAyC,CAAA;IACzC,wGAAwG;IACxG,4DAAuC,CAAA;IACvC,wGAAwG;IACxG,gEAA2C,CAAA;AAC/C,CAAC,EAlRW,iBAAiB,iCAAjB,iBAAiB,QAkR5B"}

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

@@ -25,6 +25,7 @@ __exportStar(require("./constants/follow-me.const"), exports);
 __exportStar(require("./interfaces/safety-check.dto"), exports);
 __exportStar(require("./interfaces/safety-alert-context"), exports);
 __exportStar(require("./interfaces/follow-me.dto"), exports);
+__exportStar(require("./interfaces/safety-analytics"), exports);
 // Utilities
 __exportStar(require("./utils/safety-display.util"), exports);
 __exportStar(require("./utils/follow-me-display.util"), exports);

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/modules/safety/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,QAAQ;AACR,uDAAqC;AACrC,0DAAwC;AAExC,YAAY;AACZ,wEAAsD;AACtD,oEAAkD;AAClD,8DAA4C;AAE5C,oBAAoB;AACpB,gEAA8C;AAC9C,oEAAkD;AAClD,6DAA2C;AAE3C,YAAY;AACZ,8DAA4C;AAC5C,iEAA+C"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/modules/safety/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,QAAQ;AACR,uDAAqC;AACrC,0DAAwC;AAExC,YAAY;AACZ,wEAAsD;AACtD,oEAAkD;AAClD,8DAA4C;AAE5C,oBAAoB;AACpB,gEAA8C;AAC9C,oEAAkD;AAClD,6DAA2C;AAC3C,gEAA8C;AAE9C,YAAY;AACZ,8DAA4C;AAC5C,iEAA+C"}

package/dist/cjs/modules/safety/interfaces/safety-analytics.js

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * Safety analytics: how Safety Check and Follow Me were used over a period, by whom
+ * and how often, how they ended, what the monitoring caught and how the guardians
+ * followed. One read, computed by clarion-safety from one consistent snapshot, so
+ * every number on a dashboard agrees with every other.
+ *
+ * Counts only: never a location, a destination, a phone number, a name or a reason a
+ * user typed. A check or journey is counted by when it started, as it stands now.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=safety-analytics.js.map

package/dist/cjs/modules/safety/interfaces/safety-analytics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"safety-analytics.js","sourceRoot":"","sources":["../../../../../src/modules/safety/interfaces/safety-analytics.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG"}

package/dist/esm/index.js

@@ -24,6 +24,7 @@ export * from './modules/alert-intake/index';
 export * from './modules/partner/index';
 export * from './modules/support/index';
 export * from './modules/safety/index';
+export * from './modules/billing/index';
 // Interfaces
 export * from './modules/common/interfaces/server-message';
 export * from './modules/common/interfaces/pagination';

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,UAAU;AACV,cAAc,sBAAsB,CAAC;AACrC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,wBAAwB,CAAC;AACvC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,wBAAwB,CAAC;AACvC,cAAc,kCAAkC,CAAC;AACjD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,0BAA0B,CAAC;AACzC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,wBAAwB,CAAC;AAEvC,aAAa;AACb,cAAc,4CAA4C,CAAC;AAC3D,cAAc,wCAAwC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,UAAU;AACV,cAAc,sBAAsB,CAAC;AACrC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,wBAAwB,CAAC;AACvC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,wBAAwB,CAAC;AACvC,cAAc,kCAAkC,CAAC;AACjD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,0BAA0B,CAAC;AACzC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AAExC,aAAa;AACb,cAAc,4CAA4C,CAAC;AAC3D,cAAc,wCAAwC,CAAC"}

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

@@ -0,0 +1,3 @@
+// Interfaces
+export * from './interfaces/billing-analytics';
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/modules/billing/index.ts"],"names":[],"mappings":"AAAA,aAAa;AACb,cAAc,gCAAgC,CAAC"}

package/dist/esm/modules/billing/interfaces/billing-analytics.js

@@ -0,0 +1,16 @@
+/**
+ * Billing analytics: what came in over a period and what it was for, what was invoiced
+ * and is still owed, how checkouts went, how subscriptions and the people they cover
+ * moved, how trials turned into paying customers, and what is owed to the platform.
+ *
+ * One read, computed by clarion-billing from one consistent snapshot, so every number
+ * on a dashboard agrees with every other. Money is in minor units of ONE currency (the
+ * answer's `currency`): an organization that sells in two currencies is read one
+ * currency at a time, never added up across them.
+ *
+ * Totals and counts only: never a person's name, phone number or e-mail. A corporate
+ * client and a package appear by name - they are the organization's own customers and
+ * products, already on its billing screens.
+ */
+export {};
+//# sourceMappingURL=billing-analytics.js.map

package/dist/esm/modules/billing/interfaces/billing-analytics.js.map

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

package/dist/esm/modules/permission/enums/permission-actions.enum.js

@@ -188,6 +188,8 @@ export var PermissionActions;
     PermissionActions["CREATE_SETTLEMENT_BATCH"] = "create:settlement-batch";
     PermissionActions["RECONCILE_SETTLEMENT_BATCH"] = "reconcile:settlement-batch";
     PermissionActions["READ_BILLING_OPERATIONS"] = "read:billing-operations";
+    // Billing Analytics - the organization's billing over a period, totals and counts only.
+    PermissionActions["READ_BILLING_ANALYTICS"] = "read:billing-analytics";
     PermissionActions["READ_PREMIUM_TRIAL"] = "read:premium-trial";
     PermissionActions["GRANT_PREMIUM_TRIAL"] = "grant:premium-trial";
     PermissionActions["REVOKE_PREMIUM_TRIAL"] = "revoke:premium-trial";
@@ -226,6 +228,8 @@ export var PermissionActions;
     PermissionActions["USE_SAFETY_CHECK"] = "use:safety-check";
     PermissionActions["READ_SAFETY_CHECK"] = "read:safety-check";
     PermissionActions["MANAGE_SAFETY_CHECK_REASON"] = "manage:safety-check-reason";
+    // Safety Analytics: how Safety Check and Follow Me are used - counts only.
+    PermissionActions["READ_SAFETY_ANALYTICS"] = "read:safety-analytics";
     // Follow Me: use = run and follow journeys in the app; read = staff see sessions
     // (no location); track = staff see WHERE, only for sessions shared with the
     // provider or turned SOS (clarion-safety enforces that condition).

package/dist/esm/modules/permission/enums/permission-actions.enum.js.map

@@ -1 +1 @@
-{"version":3,"file":"permission-actions.enum.js","sourceRoot":"","sources":["../../../../../src/modules/permission/enums/permission-actions.enum.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,iBA8QX;AA9QD,WAAY,iBAAiB;IACzB,uBAAuB;IACvB,gEAA2C,CAAA;IAC3C,4DAAuC,CAAA;IACvC,gEAA2C,CAAA;IAC3C,gEAA2C,CAAA;IAE3C,kBAAkB;IAClB,sDAAiC,CAAA;IACjC,kDAA6B,CAAA;IAC7B,sDAAiC,CAAA;IACjC,sDAAiC,CAAA;IACjC,wEAAwE;IACxE,mEAAmE;IACnE,oEAA+C,CAAA;IAC/C,0EAAqD,CAAA;IACrD,wEAAmD,CAAA;IACnD,wEAAmD,CAAA;IACnD,wEAAmD,CAAA;IACnD,2EAA2E;IAC3E,4EAA4E;IAC5E,qEAAqE;IACrE,uDAAuD;IACvD,wEAAmD,CAAA;IACnD,4EAAuD,CAAA;IAEvD,wBAAwB;IACxB,oEAA+C,CAAA;IAC/C,gEAA2C,CAAA;IAC3C,oEAA+C,CAAA;IAC/C,oEAA+C,CAAA;IAE/C,eAAe;IACf,gDAA2B,CAAA;IAC3B,4CAAuB,CAAA;IACvB,gDAA2B,CAAA;IAC3B,gDAA2B,CAAA;IAE3B,eAAe;IACf,gDAA2B,CAAA;IAC3B,4CAAuB,CAAA;IACvB,gDAA2B,CAAA;IAC3B,gDAA2B,CAAA;IAE3B,mBAAmB;IACnB,wDAAmC,CAAA;IACnC,oDAA+B,CAAA;IAC/B,wDAAmC,CAAA;IACnC,wDAAmC,CAAA;IACnC,oFAA+D,CAAA;IAC/D,gFAA2D,CAAA;IAC3D,oFAA+D,CAAA;IAC/D,oFAA+D,CAAA;IAE/D,uBAAuB;IACvB,kEAA6C,CAAA;IAC7C,8DAAyC,CAAA;IACzC,kEAA6C,CAAA;IAC7C,kEAA6C,CAAA;IAE7C,4EAA4E;IAC5E,wEAAwE;IACxE,6EAA6E;IAC7E,qDAAqD;IACrD,gGAA2E,CAAA;IAC3E,4FAAuE,CAAA;IACvE,gGAA2E,CAAA;IAC3E,gGAA2E,CAAA;IAC3E,sFAAiE,CAAA;IACjE,kFAA6D,CAAA;IAC7D,sFAAiE,CAAA;IACjE,sFAAiE,CAAA;IACjE,sEAAiD,CAAA;IACjD,oEAA+C,CAAA;IAC/C,0EAAqD,CAAA;IACrD,8EAAyD,CAAA;IAEzD,kBAAkB;IAClB,EAAE;IACF,2EAA2E;IAC3E,0EAA0E;IAC1E,uEAAuE;IACvE,+BAA+B;IAC/B,oEAA+C,CAAA;IAC/C,gEAA2C,CAAA;IAC3C,oEAA+C,CAAA;IAC/C,oEAA+C,CAAA;IAC/C,kEAA6C,CAAA;IAC7C,gEAA2C,CAAA;IAC3C,kFAA6D,CAAA;IAC7D,sFAAiE,CAAA;IACjE,kEAA6C,CAAA;IAC7C,oEAA+C,CAAA;IAC/C,yEAAyE;IACzE,gEAA2C,CAAA;IAC3C;;;OAGG;IACH,8DAAyC,CAAA;IACzC,mFAAmF;IACnF,wEAAmD,CAAA;IACnD,oEAA+C,CAAA;IAC/C,gFAAgF;IAChF,sEAAiD,CAAA;IACjD,wEAAmD,CAAA;IACnD,0EAAqD,CAAA;IACrD,0EAAqD,CAAA;IACrD,kEAA6C,CAAA;IAC7C,gEAA2C,CAAA;IAC3C,8DAAyC,CAAA;IACzC,kFAA6D,CAAA;IAC7D,gEAA2C,CAAA;IAC3C,4DAAuC,CAAA;IACvC,gEAA2C,CAAA;IAE3C,uBAAuB;IACvB,0EAA0E;IAC1E,4EAA4E;IAC5E,kFAAkF;IAClF,8EAAyD,CAAA;IACzD,kFAA6D,CAAA;IAC7D,0FAAqE,CAAA;IACrE,sFAAiE,CAAA;IACjE,0FAAqE,CAAA;IACrE,0FAAqE,CAAA;IACrE,sFAAiE,CAAA;IACjE,kFAA6D,CAAA;IAC7D,sFAAiE,CAAA;IACjE,sFAAiE,CAAA;IACjE,2EAA2E;IAC3E,uEAAuE;IACvE,gFAA2D,CAAA;IAC3D,yFAAyF;IACzF,8EAAyD,CAAA;IACzD,yFAAyF;IACzF,kFAA6D,CAAA;IAE7D,gFAAgF;IAChF,gFAAgF;IAChF,kFAAkF;IAClF,kFAAkF;IAClF,8EAA8E;IAC9E,kFAAkF;IAClF,8DAAyC,CAAA;IACzC,0DAAqC,CAAA;IACrC,8DAAyC,CAAA;IACzC,8DAAyC,CAAA;IAEzC,oEAA+C,CAAA;IAC/C,gEAA2C,CAAA;IAC3C,oEAA+C,CAAA;IAC/C,oEAA+C,CAAA;IAE/C,wEAAmD,CAAA;IACnD,oEAA+C,CAAA;IAC/C,wEAAmD,CAAA;IACnD,wEAAmD,CAAA;IAEnD,sFAAiE,CAAA;IACjE,kFAA6D,CAAA;IAC7D,sFAAiE,CAAA;IACjE,sFAAiE,CAAA;IAEjE,0EAAqD,CAAA;IACrD,sEAAiD,CAAA;IACjD,0EAAqD,CAAA;IACrD,0EAAqD,CAAA;IAErD,0DAAqC,CAAA;IAErC,sDAAiC,CAAA;IACjC,kDAA6B,CAAA;IAC7B,4DAAuC,CAAA;IAEvC,kDAA6B,CAAA;IAC7B,8CAAyB,CAAA;IACzB,oDAA+B,CAAA;IAE/B,sDAAiC,CAAA;IACjC,kDAA6B,CAAA;IAE7B,sDAAiC,CAAA;IACjC,kDAA6B,CAAA;IAC7B,sDAAiC,CAAA;IACjC,0DAAqC,CAAA;IACrC,8DAAyC,CAAA;IACzC,sDAAiC,CAAA;IAEjC,8DAAyC,CAAA;IACzC,sDAAiC,CAAA;IACjC,kDAA6B,CAAA;IAE7B,8FAAyE,CAAA;IACzE,kFAA6D,CAAA;IAC7D,0GAAqF,CAAA;IACrF,sFAAiE,CAAA;IAEjE,4FAAuE,CAAA;IACvE,gFAA2D,CAAA;IAC3D,wGAAmF,CAAA;IACnF,oFAA+D,CAAA;IAE/D,8DAAyC,CAAA;IAEzC,4DAAuC,CAAA;IACvC,wDAAmC,CAAA;IACnC,wEAAmD,CAAA;IACnD,kEAA6C,CAAA;IAE7C,oEAA+C,CAAA;IAC/C,wEAAmD,CAAA;IACnD,8EAAyD,CAAA;IAEzD,wEAAmD,CAAA;IAEnD,8DAAyC,CAAA;IACzC,gEAA2C,CAAA;IAC3C,kEAA6C,CAAA;IAE7C,iFAAiF;IACjF,2EAA2E;IAC3E,2EAA2E;IAC3E,kEAA6C,CAAA;IAC7C,8DAAyC,CAAA;IACzC,kEAA6C,CAAA;IAC7C,oEAA+C,CAAA;IAC/C,oEAA+C,CAAA;IAC/C,kEAA6C,CAAA;IAC7C,8DAAyC,CAAA;IACzC,kEAA6C,CAAA;IAC7C,4EAAuD,CAAA;IAEvD,uBAAuB;IACvB,+EAA+E;IAC/E,mFAAmF;IACnF,4DAA4D;IAC5D,sFAAiE,CAAA;IACjE,kFAA6D,CAAA;IAC7D,sFAAiE,CAAA;IACjE,sFAAiE,CAAA;IACjE,kFAA6D,CAAA;IAC7D,4EAAuD,CAAA;IACvD,8EAAyD,CAAA;IACzD,8FAAyE,CAAA;IACzE,kGAA6E,CAAA;IAC7E,gFAA2D,CAAA;IAC3D,gFAAgF;IAChF,sFAAsF;IACtF,kFAA6D,CAAA;IAE7D,gFAAgF;IAChF,0EAA0E;IAC1E,gDAAgD;IAChD,0DAAqC,CAAA;IACrC,4DAAuC,CAAA;IACvC,8EAAyD,CAAA;IACzD,iFAAiF;IACjF,4EAA4E;IAC5E,mEAAmE;IACnE,oDAA+B,CAAA;IAC/B,sDAAiC,CAAA;IACjC,wDAAmC,CAAA;IAEnC,4DAA4D;IAC5D,8DAAyC,CAAA;IACzC,wGAAwG;IACxG,4DAAuC,CAAA;IACvC,wGAAwG;IACxG,gEAA2C,CAAA;AAC/C,CAAC,EA9QW,iBAAiB,KAAjB,iBAAiB,QA8Q5B"}
+{"version":3,"file":"permission-actions.enum.js","sourceRoot":"","sources":["../../../../../src/modules/permission/enums/permission-actions.enum.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,iBAkRX;AAlRD,WAAY,iBAAiB;IACzB,uBAAuB;IACvB,gEAA2C,CAAA;IAC3C,4DAAuC,CAAA;IACvC,gEAA2C,CAAA;IAC3C,gEAA2C,CAAA;IAE3C,kBAAkB;IAClB,sDAAiC,CAAA;IACjC,kDAA6B,CAAA;IAC7B,sDAAiC,CAAA;IACjC,sDAAiC,CAAA;IACjC,wEAAwE;IACxE,mEAAmE;IACnE,oEAA+C,CAAA;IAC/C,0EAAqD,CAAA;IACrD,wEAAmD,CAAA;IACnD,wEAAmD,CAAA;IACnD,wEAAmD,CAAA;IACnD,2EAA2E;IAC3E,4EAA4E;IAC5E,qEAAqE;IACrE,uDAAuD;IACvD,wEAAmD,CAAA;IACnD,4EAAuD,CAAA;IAEvD,wBAAwB;IACxB,oEAA+C,CAAA;IAC/C,gEAA2C,CAAA;IAC3C,oEAA+C,CAAA;IAC/C,oEAA+C,CAAA;IAE/C,eAAe;IACf,gDAA2B,CAAA;IAC3B,4CAAuB,CAAA;IACvB,gDAA2B,CAAA;IAC3B,gDAA2B,CAAA;IAE3B,eAAe;IACf,gDAA2B,CAAA;IAC3B,4CAAuB,CAAA;IACvB,gDAA2B,CAAA;IAC3B,gDAA2B,CAAA;IAE3B,mBAAmB;IACnB,wDAAmC,CAAA;IACnC,oDAA+B,CAAA;IAC/B,wDAAmC,CAAA;IACnC,wDAAmC,CAAA;IACnC,oFAA+D,CAAA;IAC/D,gFAA2D,CAAA;IAC3D,oFAA+D,CAAA;IAC/D,oFAA+D,CAAA;IAE/D,uBAAuB;IACvB,kEAA6C,CAAA;IAC7C,8DAAyC,CAAA;IACzC,kEAA6C,CAAA;IAC7C,kEAA6C,CAAA;IAE7C,4EAA4E;IAC5E,wEAAwE;IACxE,6EAA6E;IAC7E,qDAAqD;IACrD,gGAA2E,CAAA;IAC3E,4FAAuE,CAAA;IACvE,gGAA2E,CAAA;IAC3E,gGAA2E,CAAA;IAC3E,sFAAiE,CAAA;IACjE,kFAA6D,CAAA;IAC7D,sFAAiE,CAAA;IACjE,sFAAiE,CAAA;IACjE,sEAAiD,CAAA;IACjD,oEAA+C,CAAA;IAC/C,0EAAqD,CAAA;IACrD,8EAAyD,CAAA;IAEzD,kBAAkB;IAClB,EAAE;IACF,2EAA2E;IAC3E,0EAA0E;IAC1E,uEAAuE;IACvE,+BAA+B;IAC/B,oEAA+C,CAAA;IAC/C,gEAA2C,CAAA;IAC3C,oEAA+C,CAAA;IAC/C,oEAA+C,CAAA;IAC/C,kEAA6C,CAAA;IAC7C,gEAA2C,CAAA;IAC3C,kFAA6D,CAAA;IAC7D,sFAAiE,CAAA;IACjE,kEAA6C,CAAA;IAC7C,oEAA+C,CAAA;IAC/C,yEAAyE;IACzE,gEAA2C,CAAA;IAC3C;;;OAGG;IACH,8DAAyC,CAAA;IACzC,mFAAmF;IACnF,wEAAmD,CAAA;IACnD,oEAA+C,CAAA;IAC/C,gFAAgF;IAChF,sEAAiD,CAAA;IACjD,wEAAmD,CAAA;IACnD,0EAAqD,CAAA;IACrD,0EAAqD,CAAA;IACrD,kEAA6C,CAAA;IAC7C,gEAA2C,CAAA;IAC3C,8DAAyC,CAAA;IACzC,kFAA6D,CAAA;IAC7D,gEAA2C,CAAA;IAC3C,4DAAuC,CAAA;IACvC,gEAA2C,CAAA;IAE3C,uBAAuB;IACvB,0EAA0E;IAC1E,4EAA4E;IAC5E,kFAAkF;IAClF,8EAAyD,CAAA;IACzD,kFAA6D,CAAA;IAC7D,0FAAqE,CAAA;IACrE,sFAAiE,CAAA;IACjE,0FAAqE,CAAA;IACrE,0FAAqE,CAAA;IACrE,sFAAiE,CAAA;IACjE,kFAA6D,CAAA;IAC7D,sFAAiE,CAAA;IACjE,sFAAiE,CAAA;IACjE,2EAA2E;IAC3E,uEAAuE;IACvE,gFAA2D,CAAA;IAC3D,yFAAyF;IACzF,8EAAyD,CAAA;IACzD,yFAAyF;IACzF,kFAA6D,CAAA;IAE7D,gFAAgF;IAChF,gFAAgF;IAChF,kFAAkF;IAClF,kFAAkF;IAClF,8EAA8E;IAC9E,kFAAkF;IAClF,8DAAyC,CAAA;IACzC,0DAAqC,CAAA;IACrC,8DAAyC,CAAA;IACzC,8DAAyC,CAAA;IAEzC,oEAA+C,CAAA;IAC/C,gEAA2C,CAAA;IAC3C,oEAA+C,CAAA;IAC/C,oEAA+C,CAAA;IAE/C,wEAAmD,CAAA;IACnD,oEAA+C,CAAA;IAC/C,wEAAmD,CAAA;IACnD,wEAAmD,CAAA;IAEnD,sFAAiE,CAAA;IACjE,kFAA6D,CAAA;IAC7D,sFAAiE,CAAA;IACjE,sFAAiE,CAAA;IAEjE,0EAAqD,CAAA;IACrD,sEAAiD,CAAA;IACjD,0EAAqD,CAAA;IACrD,0EAAqD,CAAA;IAErD,0DAAqC,CAAA;IAErC,sDAAiC,CAAA;IACjC,kDAA6B,CAAA;IAC7B,4DAAuC,CAAA;IAEvC,kDAA6B,CAAA;IAC7B,8CAAyB,CAAA;IACzB,oDAA+B,CAAA;IAE/B,sDAAiC,CAAA;IACjC,kDAA6B,CAAA;IAE7B,sDAAiC,CAAA;IACjC,kDAA6B,CAAA;IAC7B,sDAAiC,CAAA;IACjC,0DAAqC,CAAA;IACrC,8DAAyC,CAAA;IACzC,sDAAiC,CAAA;IAEjC,8DAAyC,CAAA;IACzC,sDAAiC,CAAA;IACjC,kDAA6B,CAAA;IAE7B,8FAAyE,CAAA;IACzE,kFAA6D,CAAA;IAC7D,0GAAqF,CAAA;IACrF,sFAAiE,CAAA;IAEjE,4FAAuE,CAAA;IACvE,gFAA2D,CAAA;IAC3D,wGAAmF,CAAA;IACnF,oFAA+D,CAAA;IAE/D,8DAAyC,CAAA;IAEzC,4DAAuC,CAAA;IACvC,wDAAmC,CAAA;IACnC,wEAAmD,CAAA;IACnD,kEAA6C,CAAA;IAE7C,oEAA+C,CAAA;IAC/C,wEAAmD,CAAA;IACnD,8EAAyD,CAAA;IAEzD,wEAAmD,CAAA;IACnD,wFAAwF;IACxF,sEAAiD,CAAA;IAEjD,8DAAyC,CAAA;IACzC,gEAA2C,CAAA;IAC3C,kEAA6C,CAAA;IAE7C,iFAAiF;IACjF,2EAA2E;IAC3E,2EAA2E;IAC3E,kEAA6C,CAAA;IAC7C,8DAAyC,CAAA;IACzC,kEAA6C,CAAA;IAC7C,oEAA+C,CAAA;IAC/C,oEAA+C,CAAA;IAC/C,kEAA6C,CAAA;IAC7C,8DAAyC,CAAA;IACzC,kEAA6C,CAAA;IAC7C,4EAAuD,CAAA;IAEvD,uBAAuB;IACvB,+EAA+E;IAC/E,mFAAmF;IACnF,4DAA4D;IAC5D,sFAAiE,CAAA;IACjE,kFAA6D,CAAA;IAC7D,sFAAiE,CAAA;IACjE,sFAAiE,CAAA;IACjE,kFAA6D,CAAA;IAC7D,4EAAuD,CAAA;IACvD,8EAAyD,CAAA;IACzD,8FAAyE,CAAA;IACzE,kGAA6E,CAAA;IAC7E,gFAA2D,CAAA;IAC3D,gFAAgF;IAChF,sFAAsF;IACtF,kFAA6D,CAAA;IAE7D,gFAAgF;IAChF,0EAA0E;IAC1E,gDAAgD;IAChD,0DAAqC,CAAA;IACrC,4DAAuC,CAAA;IACvC,8EAAyD,CAAA;IACzD,2EAA2E;IAC3E,oEAA+C,CAAA;IAC/C,iFAAiF;IACjF,4EAA4E;IAC5E,mEAAmE;IACnE,oDAA+B,CAAA;IAC/B,sDAAiC,CAAA;IACjC,wDAAmC,CAAA;IAEnC,4DAA4D;IAC5D,8DAAyC,CAAA;IACzC,wGAAwG;IACxG,4DAAuC,CAAA;IACvC,wGAAwG;IACxG,gEAA2C,CAAA;AAC/C,CAAC,EAlRW,iBAAiB,KAAjB,iBAAiB,QAkR5B"}

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

@@ -9,6 +9,7 @@ export * from './constants/follow-me.const';
 export * from './interfaces/safety-check.dto';
 export * from './interfaces/safety-alert-context';
 export * from './interfaces/follow-me.dto';
+export * from './interfaces/safety-analytics';
 // Utilities
 export * from './utils/safety-display.util';
 export * from './utils/follow-me-display.util';

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/modules/safety/index.ts"],"names":[],"mappings":"AAAA,QAAQ;AACR,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AAExC,YAAY;AACZ,cAAc,uCAAuC,CAAC;AACtD,cAAc,mCAAmC,CAAC;AAClD,cAAc,6BAA6B,CAAC;AAE5C,oBAAoB;AACpB,cAAc,+BAA+B,CAAC;AAC9C,cAAc,mCAAmC,CAAC;AAClD,cAAc,4BAA4B,CAAC;AAE3C,YAAY;AACZ,cAAc,6BAA6B,CAAC;AAC5C,cAAc,gCAAgC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/modules/safety/index.ts"],"names":[],"mappings":"AAAA,QAAQ;AACR,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AAExC,YAAY;AACZ,cAAc,uCAAuC,CAAC;AACtD,cAAc,mCAAmC,CAAC;AAClD,cAAc,6BAA6B,CAAC;AAE5C,oBAAoB;AACpB,cAAc,+BAA+B,CAAC;AAC9C,cAAc,mCAAmC,CAAC;AAClD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,+BAA+B,CAAC;AAE9C,YAAY;AACZ,cAAc,6BAA6B,CAAC;AAC5C,cAAc,gCAAgC,CAAC"}

package/dist/esm/modules/safety/interfaces/safety-analytics.js

@@ -0,0 +1,11 @@
+/**
+ * Safety analytics: how Safety Check and Follow Me were used over a period, by whom
+ * and how often, how they ended, what the monitoring caught and how the guardians
+ * followed. One read, computed by clarion-safety from one consistent snapshot, so
+ * every number on a dashboard agrees with every other.
+ *
+ * Counts only: never a location, a destination, a phone number, a name or a reason a
+ * user typed. A check or journey is counted by when it started, as it stands now.
+ */
+export {};
+//# sourceMappingURL=safety-analytics.js.map

package/dist/esm/modules/safety/interfaces/safety-analytics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"safety-analytics.js","sourceRoot":"","sources":["../../../../../src/modules/safety/interfaces/safety-analytics.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG"}

package/dist/types/index.d.ts

@@ -23,5 +23,6 @@ export * from './modules/alert-intake/index';
 export * from './modules/partner/index';
 export * from './modules/support/index';
 export * from './modules/safety/index';
+export * from './modules/billing/index';
 export * from './modules/common/interfaces/server-message';
 export * from './modules/common/interfaces/pagination';

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

@@ -0,0 +1 @@
+export * from './interfaces/billing-analytics';

package/dist/types/modules/billing/interfaces/billing-analytics.d.ts

@@ -0,0 +1,432 @@
+/**
+ * Billing analytics: what came in over a period and what it was for, what was invoiced
+ * and is still owed, how checkouts went, how subscriptions and the people they cover
+ * moved, how trials turned into paying customers, and what is owed to the platform.
+ *
+ * One read, computed by clarion-billing from one consistent snapshot, so every number
+ * on a dashboard agrees with every other. Money is in minor units of ONE currency (the
+ * answer's `currency`): an organization that sells in two currencies is read one
+ * currency at a time, never added up across them.
+ *
+ * Totals and counts only: never a person's name, phone number or e-mail. A corporate
+ * client and a package appear by name - they are the organization's own customers and
+ * products, already on its billing screens.
+ */
+/** How the period is cut into points for the charts. Chosen by the service from the length of the period. */
+export type BillingAnalyticsBucket = 'hour' | 'day' | 'week' | 'month';
+export interface BillingAnalyticsRange {
+    /** Inclusive, ISO 8601. The first billing record when the period asked for was "forever". */
+    from: string;
+    /** Exclusive, ISO 8601. */
+    to: string;
+    bucket: BillingAnalyticsBucket;
+    /** IANA time zone the buckets are cut in. */
+    timeZone: string;
+}
+/** A count by a key (a status, a band, a provider), largest first unless the section says otherwise. */
+export interface BillingAnalyticsCount<K extends string = string> {
+    key: K;
+    count: number;
+}
+/** A count by a key, and the money in it. */
+export interface BillingAnalyticsAmount<K extends string = string> {
+    key: K;
+    count: number;
+    amountMinor: number;
+}
+/** A currency the scope has done business in, so a dashboard can offer to switch to it. */
+export interface BillingAnalyticsCurrency {
+    currency: string;
+    /** Money received in the period, in this currency. */
+    collectedMinor: number;
+    /** Subscriptions ever started in this currency. */
+    subscriptions: number;
+}
+/**
+ * What a payment was for:
+ *  - NEW      the first period of a subscription;
+ *  - RENEWAL  a later period;
+ *  - SEATS    people added to a running subscription, for what was left of its period;
+ *  - ORDER    a corporate order;
+ *  - OTHER    anything else (a payment from before payments named their invoice).
+ */
+export type BillingRevenueKind = 'NEW' | 'RENEWAL' | 'SEATS' | 'ORDER' | 'OTHER';
+/**
+ * Money received from customers in the period, by when it was paid. A payment made to
+ * the PLATFORM (an organization settling its fees) is not revenue here; it is in
+ * `settlements`.
+ */
+export interface BillingAnalyticsRevenue {
+    /** Every successful customer payment, VAT included. */
+    collectedMinor: number;
+    payments: number;
+    /** Distinct customers who paid: an individual, or a corporate client. */
+    payers: number;
+    /** The VAT in what was collected (from the invoices the payments settled). */
+    taxMinor: number;
+    /** Collected less VAT. */
+    netMinor: number;
+    /** Paid through Paystack or Flutterwave. */
+    gatewayMinor: number;
+    /** Recorded by a person: bank transfer, cheque, LPO, cash... */
+    manualMinor: number;
+    /** Received and not used - the invoice was already paid, void, or for another amount. Included in `collectedMinor`. */
+    unappliedMinor: number;
+    unappliedPayments: number;
+    averagePaymentMinor: number | null;
+    /** Credits and refunds recorded in the period (as positive amounts). */
+    creditsMinor: number;
+    refundsMinor: number;
+    /** Every kind, in a fixed order, zeros included. */
+    byKind: BillingAnalyticsAmount<BillingRevenueKind>[];
+    /** INDIVIDUAL and CORPORATE customers, zeros included. */
+    byProfile: BillingAnalyticsAmount[];
+    /** PAYSTACK, FLUTTERWAVE, MANUAL. */
+    byProvider: BillingAnalyticsAmount[];
+    /** CARD, MOBILE_MONEY, BANK_TRANSFER, UNKNOWN for a gateway; MANUAL_<method> for one recorded by a person. */
+    byMethod: BillingAnalyticsAmount[];
+}
+/**
+ * Recurring revenue at the end of the period: the price of every paid, covered seat on
+ * a recurring plan, as a monthly figure (an annual seat counts a twelfth).
+ */
+export interface BillingAnalyticsRecurring {
+    mrrMinor: number;
+    /** MRR × 12. */
+    arrMinor: number;
+    /** Subscriptions with at least one paid, covered seat. */
+    payingSubscriptions: number;
+    billableSeats: number;
+    averagePerSubscriptionMinor: number | null;
+}
+/** How long an invoice still owed at the end of the period has been due. */
+export type BillingAgingBand = 'NOT_DUE' | 'NO_DUE_DATE' | '1-30' | '31-60' | '61-90' | '90+';
+/**
+ * Customer invoices. A checkout's own invoice that was never paid (DRAFT) is not
+ * counted as issued: nobody was asked to pay it but the person who walked away.
+ */
+export interface BillingAnalyticsInvoices {
+    /** Issued in the period. */
+    issued: number;
+    issuedMinor: number;
+    /** Of those, paid by the end of the period. */
+    paid: number;
+    paidMinor: number;
+    voided: number;
+    voidedMinor: number;
+    /** paidMinor as a share of issuedMinor (voided ones left out); null with nothing issued. */
+    collectionRate: number | null;
+    /** Any invoice paid in the period, whenever it was issued. */
+    paidInPeriod: number;
+    paidInPeriodMinor: number;
+    /** From issued to paid, for the invoices paid in the period. */
+    medianDaysToPay: number | null;
+    averageDaysToPay: number | null;
+    /** Still owed at the end of the period, and the part of it past its due date. */
+    outstanding: number;
+    outstandingMinor: number;
+    overdue: number;
+    overdueMinor: number;
+    /** The period's invoices as they stand now: PAID, ISSUED, OVERDUE, VOID. */
+    byStatus: BillingAnalyticsAmount[];
+    /** What is owed at the end of the period, by how long it has been due. Fixed order, zeros included. */
+    aging: BillingAnalyticsAmount<BillingAgingBand>[];
+    /** The period's invoices by what they were for: SUBSCRIPTION_PERIOD, SEAT_ADJUSTMENT, CORPORATE_ORDER, OTHER. */
+    byPurpose: BillingAnalyticsAmount[];
+}
+/** Gateway checkouts opened in the period, as they stand now. */
+export interface BillingAnalyticsCheckoutProvider {
+    provider: string;
+    attempts: number;
+    succeeded: number;
+    failed: number;
+    abandoned: number;
+    pending: number;
+    successRate: number | null;
+}
+export interface BillingAnalyticsCheckouts {
+    attempts: number;
+    succeeded: number;
+    failed: number;
+    /** Closed without a payment: never completed, or the customer walked away. */
+    abandoned: number;
+    /** Still waiting for the customer or the provider. */
+    pending: number;
+    cancelled: number;
+    /** succeeded / (succeeded + failed + abandoned + cancelled); null when none has finished. */
+    successRate: number | null;
+    /** From opening the checkout to the money arriving, for the ones that succeeded. */
+    medianSecondsToPay: number | null;
+    byProvider: BillingAnalyticsCheckoutProvider[];
+    /** Why the failed ones failed, as the provider (or reconciliation) put it - top 8. */
+    failureReasons: BillingAnalyticsCount[];
+    /** Payments recorded by a person in the period. */
+    manualRecorded: number;
+    manualRecordedMinor: number;
+}
+/** Size of a subscription by the people covered on it at the end of the period. */
+export type BillingPlanSizeBand = '1' | '2-3' | '4-9' | '10-49' | '50+';
+/** What is coming up, counted from NOW - whatever period is being looked at. */
+export interface BillingAnalyticsRenewalsAhead {
+    dueIn7Days: number;
+    dueIn30Days: number;
+    /** What the subscriptions due in the next 30 days cost per period. */
+    dueIn30DaysMinor: number;
+    /** Of those due in 30 days: renew on their own (a saved card), or need somebody to pay. */
+    autoRenewing: number;
+    manualRenewing: number;
+    /** Cancelled for the end of their period: they will not renew. */
+    endingAtPeriodEnd: number;
+    /** A renewal charge failed; still covered until the end of the period. */
+    pastDue: number;
+    /** Waiting for the customer to pay the renewal themselves (mobile money). */
+    manualRenewalRequired: number;
+}
+/**
+ * A subscription is LIVE from its first activation to the end of what was paid for (or
+ * to its cancellation or suspension) - so "live at the start" and "live at the end" can
+ * be read for any date in the past.
+ */
+export interface BillingAnalyticsSubscriptions {
+    /** Null for "forever". */
+    liveAtStart: number | null;
+    liveAtEnd: number;
+    /** First activated in the period. */
+    started: number;
+    /** A second or later period that started in the period. */
+    renewed: number;
+    /** Cover ended in the period because it was cancelled... */
+    cancelled: number;
+    /** ...or because it ran out and was not renewed. */
+    expired: number;
+    /** (cancelled + expired) / liveAtStart; null for "forever" or with nothing live at the start. */
+    churnRate: number | null;
+    /** renewed / (renewed + expired); null when none came up. */
+    renewalRate: number | null;
+    /** Created, never paid, and still waiting now. */
+    awaitingFirstPayment: number;
+    /** Every subscription in scope, as it stands now - every status, zeros included. */
+    byStatus: BillingAnalyticsCount[];
+    /** The subscriptions live at the end of the period, split four ways. */
+    byProfile: BillingAnalyticsCount[];
+    byCycle: BillingAnalyticsCount[];
+    byRenewalMode: BillingAnalyticsCount[];
+    byCollection: BillingAnalyticsCount[];
+    /** Fixed order, zeros included. */
+    sizes: BillingAnalyticsCount<BillingPlanSizeBand>[];
+    ahead: BillingAnalyticsRenewalsAhead;
+}
+/**
+ * Who holds the cover:
+ *  - SUBSCRIBER   an individual on their own plan;
+ *  - BENEFICIARY  somebody covered under a subscriber or a corporate member;
+ *  - MEMBER       a corporate client's member;
+ *  - MANUAL       cover granted by hand.
+ */
+export type BillingCoverKind = 'SUBSCRIBER' | 'BENEFICIARY' | 'MEMBER' | 'MANUAL';
+export interface BillingAnalyticsSeatType {
+    /** PRIMARY, BENEFICIARY, CORPORATE_MEMBER, CORPORATE_MEMBER_BENEFICIARY. */
+    type: string;
+    /** Covered at the end of the period, charged for. */
+    paid: number;
+    /** Covered at no charge (a zero-priced package, or beneficiaries not charged for). */
+    included: number;
+}
+/**
+ * The people covered: from their cover itself (what the incident service is told), so
+ * a person on two plans is one person. Seats are the places on plans that are paid for
+ * - a corporate member without an app account holds a seat but no cover yet.
+ */
+export interface BillingAnalyticsCover {
+    /** Null for "forever". */
+    peopleAtStart: number | null;
+    peopleAtEnd: number;
+    /** People whose first-ever cover started in the period. */
+    newlyCovered: number;
+    /** At the end of the period, every kind in a fixed order. */
+    byKind: BillingAnalyticsCount<BillingCoverKind>[];
+    seats: {
+        /** Covered at the end of the period. */
+        paid: number;
+        included: number;
+        /** Waiting for their charge to be paid now: nobody is covered on them yet. */
+        pending: number;
+        /** Added to a running plan in the period. */
+        addedMidPeriod: number;
+        /** What those additions were charged, for what was left of their period. */
+        addedMidPeriodMinor: number;
+        /** Taken off a plan in the period. */
+        removed: number;
+    };
+    seatsByType: BillingAnalyticsSeatType[];
+}
+/**
+ * Premium trials (a few alerts with full cover, free): started in the period, and
+ * whether the person went on to pay for a plan of their own. Trials carry no currency;
+ * these figures are the same whichever currency is being read.
+ */
+export interface BillingAnalyticsTrials {
+    started: number;
+    /** Started a paid subscription of their own after the trial began. */
+    converted: number;
+    conversionRate: number | null;
+    medianDaysToConvert: number | null;
+    /** Alerts raised on a trial. */
+    alertsUsed: number;
+    /** Of the period's trials: ACTIVE, EXHAUSTED, EXPIRED, REVOKED - now. */
+    byStatus: BillingAnalyticsCount[];
+    /** AUTO_ENROLL (on first use) or MANUAL_GRANT. */
+    bySource: BillingAnalyticsCount[];
+}
+/** One month an organization was charged by the platform. */
+export interface BillingAnalyticsSettlementRow {
+    id: number;
+    organizationId: number;
+    /** ISO 8601. */
+    periodStart: string;
+    periodEnd: string;
+    /** DRAFT, INVOICED, PAID, OVERDUE. */
+    status: string;
+    /** CALCULATED, or MINIMUM when the minimum monthly charge applied. */
+    feeBasis: string;
+    grossRevenueMinor: number;
+    netRevenueMinor: number;
+    feeMinor: number;
+    platformTaxMinor: number;
+    totalDueMinor: number;
+    organizationNetMinor: number;
+    paidAt: string | null;
+}
+/**
+ * What the organization owes the platform for the months the period touches. For a
+ * Super-Admin looking at every organization, what the platform has earned.
+ */
+export interface BillingAnalyticsSettlements {
+    months: number;
+    grossRevenueMinor: number;
+    feesMinor: number;
+    platformTaxMinor: number;
+    totalDueMinor: number;
+    paidMinor: number;
+    /** Invoiced or overdue, not yet paid. */
+    outstandingMinor: number;
+    organizationNetMinor: number;
+    /** Months on which the minimum monthly charge applied. */
+    onMinimum: number;
+    /** Newest first, at most 36. */
+    rows: BillingAnalyticsSettlementRow[];
+}
+export interface BillingAnalyticsTimelinePoint {
+    /** The bucket's start, local to the range's time zone, without an offset ("2026-09-21T00:00:00"). */
+    bucket: string;
+    collectedMinor: number;
+    newMinor: number;
+    renewalMinor: number;
+    seatsMinor: number;
+    orderMinor: number;
+    otherMinor: number;
+    payments: number;
+    invoices: number;
+    invoicedMinor: number;
+    /** Invoices paid in the bucket, and their value. */
+    invoicesPaidMinor: number;
+    attempts: number;
+    succeeded: number;
+    failed: number;
+    abandoned: number;
+    started: number;
+    renewed: number;
+    ended: number;
+    /** Live at the end of the bucket. */
+    liveSubscriptions: number;
+    /** Covered at the end of the bucket. */
+    peopleCovered: number;
+    trialsStarted: number;
+    trialsConverted: number;
+}
+/** The previous period of the same length, for the change on each headline figure. Absent for "forever". */
+export interface BillingAnalyticsPrevious {
+    from: string;
+    to: string;
+    collectedMinor: number;
+    netMinor: number;
+    payments: number;
+    invoices: number;
+    invoicedMinor: number;
+    attempts: number;
+    succeeded: number;
+    started: number;
+    renewed: number;
+    ended: number;
+    seatsAdded: number;
+    trialsStarted: number;
+    trialsConverted: number;
+}
+export interface BillingAnalyticsPackageRow {
+    packageId: number;
+    organizationId: number;
+    name: string;
+    profileType: string;
+    billingCycle: string;
+    liveSubscriptions: number;
+    coveredSeats: number;
+    started: number;
+    collectedMinor: number;
+    mrrMinor: number;
+}
+export interface BillingAnalyticsClientRow {
+    corporateClientId: number;
+    organizationId: number;
+    name: string;
+    liveSubscriptions: number;
+    coveredSeats: number;
+    collectedMinor: number;
+    invoicedMinor: number;
+    outstandingMinor: number;
+    overdueMinor: number;
+}
+/** A Super-Admin's view of every organization: one row each, busiest first. */
+export interface BillingAnalyticsOrganizationRow {
+    organizationId: number;
+    collectedMinor: number;
+    invoicedMinor: number;
+    outstandingMinor: number;
+    mrrMinor: number;
+    liveSubscriptions: number;
+    peopleCovered: number;
+    feesMinor: number;
+}
+export interface BillingAnalytics {
+    /** Whose figures: one organization, or null for every organization (a Super-Admin's view). */
+    organizationId: number | null;
+    range: BillingAnalyticsRange;
+    generatedAt: string;
+    /** The currency every money figure is in. */
+    currency: string;
+    /** Every currency the scope has business in, busiest first. */
+    currencies: BillingAnalyticsCurrency[];
+    previous: BillingAnalyticsPrevious | null;
+    timeline: BillingAnalyticsTimelinePoint[];
+    revenue: BillingAnalyticsRevenue;
+    recurring: BillingAnalyticsRecurring;
+    invoices: BillingAnalyticsInvoices;
+    checkouts: BillingAnalyticsCheckouts;
+    subscriptions: BillingAnalyticsSubscriptions;
+    cover: BillingAnalyticsCover;
+    trials: BillingAnalyticsTrials;
+    settlements: BillingAnalyticsSettlements;
+    /** Packages with anything live or any money in the period, most money first - at most 25. */
+    packages: BillingAnalyticsPackageRow[];
+    /** Corporate clients with anything live, owed or paid, most money first - at most 25. */
+    clients: BillingAnalyticsClientRow[];
+    /** A Super-Admin looking at every organization only. */
+    byOrganization?: BillingAnalyticsOrganizationRow[];
+}
+/** What a dashboard asks: the period, and - for a Super-Admin - whose figures. */
+export interface BillingAnalyticsQuery {
+    from?: string;
+    to?: string;
+    timeZone?: string;
+    currency?: string;
+    organizationId?: number;
+}

package/dist/types/modules/permission/enums/permission-actions.enum.d.ts

@@ -152,6 +152,7 @@ export declare enum PermissionActions {
     CREATE_SETTLEMENT_BATCH = "create:settlement-batch",
     RECONCILE_SETTLEMENT_BATCH = "reconcile:settlement-batch",
     READ_BILLING_OPERATIONS = "read:billing-operations",
+    READ_BILLING_ANALYTICS = "read:billing-analytics",
     READ_PREMIUM_TRIAL = "read:premium-trial",
     GRANT_PREMIUM_TRIAL = "grant:premium-trial",
     REVOKE_PREMIUM_TRIAL = "revoke:premium-trial",
@@ -178,6 +179,7 @@ export declare enum PermissionActions {
     USE_SAFETY_CHECK = "use:safety-check",
     READ_SAFETY_CHECK = "read:safety-check",
     MANAGE_SAFETY_CHECK_REASON = "manage:safety-check-reason",
+    READ_SAFETY_ANALYTICS = "read:safety-analytics",
     USE_FOLLOW_ME = "use:follow-me",
     READ_FOLLOW_ME = "read:follow-me",
     TRACK_FOLLOW_ME = "track:follow-me",

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

@@ -6,5 +6,6 @@ export * from './constants/follow-me.const';
 export * from './interfaces/safety-check.dto';
 export * from './interfaces/safety-alert-context';
 export * from './interfaces/follow-me.dto';
+export * from './interfaces/safety-analytics';
 export * from './utils/safety-display.util';
 export * from './utils/follow-me-display.util';

package/dist/types/modules/safety/interfaces/safety-analytics.d.ts

@@ -0,0 +1,360 @@
+/**
+ * Safety analytics: how Safety Check and Follow Me were used over a period, by whom
+ * and how often, how they ended, what the monitoring caught and how the guardians
+ * followed. One read, computed by clarion-safety from one consistent snapshot, so
+ * every number on a dashboard agrees with every other.
+ *
+ * Counts only: never a location, a destination, a phone number, a name or a reason a
+ * user typed. A check or journey is counted by when it started, as it stands now.
+ */
+/** How the period is cut into points for the charts. Chosen by the service from the length of the period. */
+export type SafetyAnalyticsBucket = 'hour' | 'day' | 'week' | 'month';
+export interface SafetyAnalyticsRange {
+    /** Inclusive, ISO 8601. The first check or journey when the period asked for was "forever". */
+    from: string;
+    /** Exclusive, ISO 8601. */
+    to: string;
+    bucket: SafetyAnalyticsBucket;
+    /** IANA time zone the buckets, the days and the hour-of-week grid are cut in. */
+    timeZone: string;
+}
+/** A count by a key (a status, a trigger, a band), largest first unless the section says otherwise. */
+export interface SafetyAnalyticsCount<K extends string = string> {
+    key: K;
+    count: number;
+}
+/** How many sessions a user started in the period, banded. */
+export type SafetyAnalyticsFrequencyBand = '1' | '2-3' | '4-9' | '10+';
+export interface SafetyAnalyticsFrequencyRow {
+    band: SafetyAnalyticsFrequencyBand;
+    /** Users who started that many Safety Checks. */
+    safetyCheck: number;
+    /** Users who started that many Follow Me journeys. */
+    followMe: number;
+    /** Users who started that many of either, together. */
+    any: number;
+}
+export interface SafetyAnalyticsUsagePoint {
+    /** The bucket's start, local to the range's time zone, without an offset ("2026-09-21T14:00:00"). */
+    bucket: string;
+    /** Distinct users who started either feature in the bucket. */
+    activeUsers: number;
+    safetyCheckUsers: number;
+    followMeUsers: number;
+    /** Users whose very first check or journey started in the bucket. */
+    newUsers: number;
+    safetyChecks: number;
+    followMeJourneys: number;
+}
+/**
+ * Who uses the safety features, and how often. A user is "active" in a period when
+ * they started a Safety Check or a Follow Me journey in it.
+ */
+export interface SafetyAnalyticsUsage {
+    activeUsers: number;
+    safetyCheckUsers: number;
+    followMeUsers: number;
+    /** Used both features in the period. */
+    bothFeatures: number;
+    /** Active users whose first-ever check or journey (in this scope) started in the period. */
+    newUsers: number;
+    /** Active users who had used a safety feature before the period. */
+    returningUsers: number;
+    /** Active in the previous period of the same length AND in this one; null for "forever". */
+    retainedUsers: number | null;
+    /** Safety Checks + Follow Me journeys started. */
+    sessions: number;
+    /** Sessions per active user; null with no active user. */
+    sessionsPerUser: number | null;
+    /** Active users who started two or more sessions. */
+    repeatUsers: number;
+    /** Average number of distinct local days an active user used a feature on. */
+    averageActiveDays: number | null;
+    /** Distinct users per local day, averaged over every day of the period. */
+    averageDailyActiveUsers: number;
+    peakDailyActiveUsers: number;
+    /** The local day (YYYY-MM-DD) of the peak; null when nobody was active. */
+    peakDay: string | null;
+    frequency: SafetyAnalyticsFrequencyRow[];
+    timeline: SafetyAnalyticsUsagePoint[];
+}
+/** The headline figures of the previous period of the same length, for the change on each. */
+export interface SafetyAnalyticsPrevious {
+    from: string;
+    to: string;
+    activeUsers: number;
+    safetyCheckUsers: number;
+    followMeUsers: number;
+    safetyChecks: number;
+    followMeJourneys: number;
+    safetyCheckSos: number;
+    followMeSos: number;
+    checkedIn: number;
+    arrived: number;
+    prompts: number;
+    promptsConfirmedOk: number;
+}
+/** When sessions start, by ISO weekday (1 = Monday) and local hour. All 168 cells are present. */
+export interface SafetyAnalyticsHeatCell {
+    weekday: number;
+    hour: number;
+    safetyChecks: number;
+    followMe: number;
+}
+/** A reason the user chose, by its code (or its label for a reason with none); the user's own words are only counted. */
+export interface SafetyAnalyticsReasonRow {
+    code: string | null;
+    /** The label most recently used for it. "Own reason" for a reason the user typed. */
+    label: string;
+    count: number;
+    /** Ended well: checked in (Safety Check) or arrived (Follow Me). */
+    completed: number;
+    sos: number;
+}
+export interface SafetyCheckAnalyticsTotals {
+    started: number;
+    /** Distinct users who started one. */
+    users: number;
+    checkedIn: number;
+    sosTriggered: number;
+    stopped: number;
+    expired: number;
+    cancelled: number;
+    failed: number;
+    /** Still running: created, active or prompting. */
+    open: number;
+    /** Checked in only after the check-in prompt appeared. */
+    checkedInAfterPrompt: number;
+    /** Checks extended at least once, and how many extensions in all. */
+    extended: number;
+    extensions: number;
+    /** Recorded at least one location point. */
+    withLocation: number;
+    trackPoints: number;
+    /** Asked for the service provider to be alerted, and whether their plan allowed it. */
+    providerRequested: number;
+    providerAllowed: number;
+    notifyGuardiansOnStartEnd: number;
+    /** Chose at least one guardian who does not use the app (reached by SMS). */
+    withExternalGuardians: number;
+    averageGuardians: number | null;
+    /** Typed their own reason instead of choosing one. */
+    customReasons: number;
+    /** An SOS that became an incident, one that has not (yet), and one it took more than one attempt to raise. */
+    sosIncidents: number;
+    sosUndelivered: number;
+    sosRetried: number;
+    /** Planned length, start to check-in time (extensions included). */
+    medianPlannedMinutes: number | null;
+    /** Start to the end, for the checks that ended. */
+    medianActualMinutes: number | null;
+    /** Prompt to check-in, for checks confirmed at the prompt. */
+    medianPromptResponseSeconds: number | null;
+    /** How long before the check-in time a user confirmed they were safe, for those who did before being prompted. */
+    medianMinutesToSpare: number | null;
+}
+export interface SafetyCheckAnalyticsPoint {
+    bucket: string;
+    started: number;
+    checkedIn: number;
+    sos: number;
+    stopped: number;
+    /** Expired, cancelled or failed. */
+    other: number;
+    open: number;
+}
+export interface SafetyCheckAnalytics {
+    totals: SafetyCheckAnalyticsTotals;
+    /** Every status a check can end in (or be in), zeros included. */
+    byStatus: SafetyAnalyticsCount[];
+    timeline: SafetyCheckAnalyticsPoint[];
+    /** What raised the SOS: a missed check-in, or the user asking for help. */
+    sosByTrigger: SafetyAnalyticsCount[];
+    reasons: SafetyAnalyticsReasonRow[];
+    /** Planned length, banded ('<=15m', '15-30m', '30-60m', '1-2h', '2-4h', '4-8h', '8-24h'), in that order. */
+    plannedDuration: SafetyAnalyticsCount[];
+    /** Extensions per check: '0', '1', '2', '3+'. */
+    extensions: SafetyAnalyticsCount[];
+    /** Guardians chosen per check: '1', '2', '3', '4+' (and '0' if a check had none). */
+    guardians: SafetyAnalyticsCount[];
+    /** The user's plan when the check started (FREE, TRIAL, PREMIUM; UNKNOWN when billing could not say). */
+    tiers: SafetyAnalyticsCount[];
+    countries: SafetyAnalyticsCount[];
+}
+export interface FollowMeAnalyticsTotals {
+    started: number;
+    users: number;
+    arrived: number;
+    sosTriggered: number;
+    stopped: number;
+    expired: number;
+    cancelled: number;
+    failed: number;
+    /** Still under way: created, active or prompting. */
+    active: number;
+    /** Started with a planned route, and how many of those were re-planned along the way. */
+    withRoute: number;
+    rerouted: number;
+    recalculations: number;
+    /** Journeys with stops on the way, and how many stops in all. */
+    withStops: number;
+    stops: number;
+    crashDetection: number;
+    /** Started without "allow all the time" location: sharing may stop when the app is closed. */
+    backgroundLocationDenied: number;
+    providerRequested: number;
+    providerAllowed: number;
+    notifyGuardiansOnStartEnd: number;
+    trackPoints: number;
+    medianPlannedMinutes: number | null;
+    /** Start to end, for journeys that ended. */
+    medianActualMinutes: number | null;
+    /** The planned route's length, for journeys with one. */
+    medianPlannedDistanceMeters: number | null;
+    /** The planned distance of every journey that arrived. */
+    arrivedDistanceMeters: number;
+    /** Arrived no later than the arrival the plan promised, or after it - of the journeys that had one. */
+    arrivedOnTime: number;
+    arrivedLate: number;
+    /** Arrival against the promised arrival (negative = early), median. */
+    medianArrivalDelaySeconds: number | null;
+    sosIncidents: number;
+    sosUndelivered: number;
+}
+export interface FollowMeAnalyticsPoint {
+    bucket: string;
+    started: number;
+    arrived: number;
+    sos: number;
+    stopped: number;
+    other: number;
+    active: number;
+}
+export interface FollowMeTransportRow {
+    /** A FollowMeTransportMode, or null for a journey without one. */
+    mode: string | null;
+    journeys: number;
+    arrived: number;
+    sos: number;
+    prompts: number;
+}
+export interface FollowMePromptTriggerRow {
+    /** A FollowMeSafetyTrigger. */
+    trigger: string;
+    prompts: number;
+    confirmedOk: number;
+    expired: number;
+    cancelled: number;
+    active: number;
+    medianResponseSeconds: number | null;
+}
+/** "Are you OK?" prompts the monitoring raised on the period's journeys. */
+export interface FollowMePromptAnalytics {
+    total: number;
+    confirmedOk: number;
+    /** Not answered in time: each raised an SOS. */
+    expired: number;
+    /** Withdrawn because the journey ended or an SOS was raised first. */
+    cancelled: number;
+    active: number;
+    journeysPrompted: number;
+    medianResponseSeconds: number | null;
+    byTrigger: FollowMePromptTriggerRow[];
+}
+export interface FollowMeFollowerKindRow {
+    /** A FollowMeParticipantKind. */
+    kind: string;
+    invited: number;
+    accepted: number;
+    declined: number;
+    pending: number;
+    unanswered: number;
+    stoppedFollowing: number;
+}
+/**
+ * The guardians asked to follow the period's journeys. Counts only - never who.
+ *
+ * Each guardian is in exactly one of accepted, declined, pending and unanswered, so
+ * those add up to `invited`. A guardian's answer is read from the audit trail: when a
+ * journey ends every participation is closed, whatever the answer was.
+ */
+export interface FollowMeFollowerAnalytics {
+    invited: number;
+    /** Followed the journey at some point. */
+    accepted: number;
+    /** Answered no, and never followed. */
+    declined: number;
+    /** Not answered yet, on a journey still under way. */
+    pending: number;
+    /** Never answered before the journey ended. */
+    unanswered: number;
+    /** Followed, then stopped following before the end - a part of `accepted`. */
+    stoppedFollowing: number;
+    /** Journeys at least one guardian followed. */
+    journeysFollowed: number;
+    averageInvited: number | null;
+    /** From the request to the guardian first accepting it. */
+    medianSecondsToAccept: number | null;
+    byKind: FollowMeFollowerKindRow[];
+    /** External guardians who opened their web link at least once. */
+    externalLinksOpened: number;
+    /** Visits to those links, counted at most once every 10 minutes per guardian. */
+    externalVisits: number;
+}
+export interface FollowMeAnalytics {
+    totals: FollowMeAnalyticsTotals;
+    byStatus: SafetyAnalyticsCount[];
+    timeline: FollowMeAnalyticsPoint[];
+    transportModes: FollowMeTransportRow[];
+    /** Where the planned route came from: GOOGLE, ESTIMATE, or NONE (no route). */
+    routeProviders: SafetyAnalyticsCount[];
+    /** Planned distance, banded ('<2km', '2-5km', '5-10km', '10-25km', '25-50km', '50km+', 'none'), in that order. */
+    distance: SafetyAnalyticsCount[];
+    plannedDuration: SafetyAnalyticsCount[];
+    prompts: FollowMePromptAnalytics;
+    /** What the SOS was about (a FollowMeSafetyTrigger), or MANUAL when the user raised it. */
+    sosByCause: SafetyAnalyticsCount[];
+    sosByTrigger: SafetyAnalyticsCount[];
+    followers: FollowMeFollowerAnalytics;
+    /** What the monitoring noticed (FollowMeSafetyEventType), whether or not it prompted. */
+    safetyEvents: SafetyAnalyticsCount[];
+    reasons: SafetyAnalyticsReasonRow[];
+    tiers: SafetyAnalyticsCount[];
+    countries: SafetyAnalyticsCount[];
+}
+/** Platform view across organizations only. The organization is named by the caller. */
+export interface SafetyAnalyticsOrganizationRow {
+    organizationId: number;
+    activeUsers: number;
+    safetyChecks: number;
+    followMeJourneys: number;
+    safetyCheckSos: number;
+    followMeSos: number;
+}
+export interface SafetyAnalytics {
+    /** Null for every organization (a Super-Admin's platform view). */
+    organizationId: number | null;
+    /** Set when the figures are one control centre's (a control-centre admin's). */
+    controlCentreId: number | null;
+    range: SafetyAnalyticsRange;
+    generatedAt: string;
+    usage: SafetyAnalyticsUsage;
+    /** Null for "forever": there is nothing before it to compare with. */
+    previous: SafetyAnalyticsPrevious | null;
+    heatmap: SafetyAnalyticsHeatCell[];
+    safetyCheck: SafetyCheckAnalytics;
+    followMe: FollowMeAnalytics;
+    /** Super-Admin's view of every organization only. */
+    byOrganization?: SafetyAnalyticsOrganizationRow[];
+}
+/**
+ * The period a safety analytics read covers (query string). Both ends optional: no
+ * `from` is "forever", no `to` is now. ISO 8601 instants; `timeZone` is an IANA name.
+ * `organizationId` is honoured for a Super-Admin only.
+ */
+export interface SafetyAnalyticsQuery {
+    from?: string;
+    to?: string;
+    timeZone?: string;
+    organizationId?: number;
+}

package/package.json

@@ -1,45 +1,45 @@
-{
-  "name": "clarion-shared-types",
-  "version": "1.0.107",
-  "main": "dist/cjs/index.js",
-  "module": "dist/esm/index.js",
-  "types": "dist/types/index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./dist/types/index.d.ts",
-      "import": "./dist/esm/index.js",
-      "require": "./dist/cjs/index.js"
-    },
-    "./dist/modules/*": {
-      "types": "./dist/types/modules/*.d.ts",
-      "import": "./dist/esm/modules/*.js",
-      "require": "./dist/cjs/modules/*.js"
-    }
-  },
-  "files": [
-    "dist/**/*"
-  ],
-  "scripts": {
-    "clean": "rimraf dist dist-test",
-    "build:cjs": "tsc -p tsconfig.cjs.json",
-    "build:esm": "tsc -p tsconfig.esm.json",
-    "build:types": "tsc -p tsconfig.types.json",
-    "build": "npm run clean && npm run build:types && npm run build:cjs && npm run build:esm",
-    "prepublishOnly": "npm run build",
-    "pretest": "rimraf dist-test",
-    "test": "tsc -p tsconfig.spec.json && node --test \"dist-test/**/*.spec.js\""
-  },
-  "keywords": [],
-  "author": "vince_lawino",
-  "license": "ISC",
-  "description": "",
-  "publishConfig": {
-    "access": "public"
-  },
-  "devDependencies": {
-    "@types/geojson": "^7946.0.16",
-    "@types/node": "^20.11.2",
-    "rimraf": "^5.0.5",
-    "typescript": "^5.7.3"
-  }
-}
+{
+  "name": "clarion-shared-types",
+  "version": "1.0.109",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js"
+    },
+    "./dist/modules/*": {
+      "types": "./dist/types/modules/*.d.ts",
+      "import": "./dist/esm/modules/*.js",
+      "require": "./dist/cjs/modules/*.js"
+    }
+  },
+  "files": [
+    "dist/**/*"
+  ],
+  "scripts": {
+    "clean": "rimraf dist dist-test",
+    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "build:esm": "tsc -p tsconfig.esm.json",
+    "build:types": "tsc -p tsconfig.types.json",
+    "build": "npm run clean && npm run build:types && npm run build:cjs && npm run build:esm",
+    "prepublishOnly": "npm run build",
+    "pretest": "rimraf dist-test",
+    "test": "tsc -p tsconfig.spec.json && node --test \"dist-test/**/*.spec.js\""
+  },
+  "keywords": [],
+  "author": "vince_lawino",
+  "license": "ISC",
+  "description": "",
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@types/geojson": "^7946.0.16",
+    "@types/node": "^20.11.2",
+    "rimraf": "^5.0.5",
+    "typescript": "^5.7.3"
+  }
+}