clarion-shared-types 1.0.108 → 1.0.110

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

@@ -41,6 +41,8 @@ var PermissionActions;
     PermissionActions["READ_USER"] = "read:user";
     PermissionActions["UPDATE_USER"] = "update:user";
     PermissionActions["DELETE_USER"] = "delete:user";
+    // User Analytics - accounts, sign-ups, sign-ins, codes, guardians and deletions over a period, counts only.
+    PermissionActions["READ_USER_ANALYTICS"] = "read:user-analytics";
     // Module: Incident
     PermissionActions["CREATE_INCIDENT"] = "create:incident";
     PermissionActions["READ_INCIDENT"] = "read:incident";
@@ -191,6 +193,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";

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,iBAgRX;AAhRD,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,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,EAhRW,iBAAiB,iCAAjB,iBAAiB,QAgR5B"}
+{"version":3,"file":"permission-actions.enum.js","sourceRoot":"","sources":["../../../../../src/modules/permission/enums/permission-actions.enum.ts"],"names":[],"mappings":";;;AAAA,IAAY,iBAoRX;AApRD,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;IAC3B,4GAA4G;IAC5G,gEAA2C,CAAA;IAE3C,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,EApRW,iBAAiB,iCAAjB,iBAAiB,QAoR5B"}

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

@@ -24,4 +24,5 @@ __exportStar(require("./interfaces/guardian"), exports);
 __exportStar(require("./interfaces/guardian-relation"), exports);
 __exportStar(require("./interfaces/guardians-response"), exports);
 __exportStar(require("./interfaces/user-analytics-data"), exports);
+__exportStar(require("./interfaces/account-analytics"), exports);
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/modules/user/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2DAAyC;AACzC,qEAAmD;AACnD,wEAAsD;AAEtD,oDAAkC;AAClC,4DAA0C;AAC1C,4DAA0C;AAC1C,wDAAsC;AACtC,iEAA+C;AAC/C,kEAAgD;AAChD,mEAAiD"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/modules/user/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2DAAyC;AACzC,qEAAmD;AACnD,wEAAsD;AAEtD,oDAAkC;AAClC,4DAA0C;AAC1C,4DAA0C;AAC1C,wDAAsC;AACtC,iEAA+C;AAC/C,kEAAgD;AAChD,mEAAiD;AACjD,iEAA+C"}

package/dist/cjs/modules/user/interfaces/account-analytics.js

@@ -0,0 +1,17 @@
+"use strict";
+/**
+ * Account analytics (the admin's User Analytics): who has an account and how they got
+ * one, whether they finished signing up, who signs in and how often, what goes wrong
+ * signing in, one-time codes and passwords, guardians, and who asked to leave.
+ *
+ * One read, computed by clarion-authentication from one consistent snapshot, so every
+ * number on a dashboard agrees with every other. Counts only: never a name, an e-mail
+ * address, a phone number or anything a user typed.
+ *
+ * Two kinds of source. Accounts, guardians and deletion requests are records the service
+ * has always kept, so their history goes back to the first account. Sign-ins, one-time
+ * codes and password changes come from the service's activity log, which begins on
+ * `activitySince`: before it, the only trace of a sign-in is each account's LAST one.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=account-analytics.js.map

package/dist/cjs/modules/user/interfaces/account-analytics.js.map

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

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

@@ -38,6 +38,8 @@ export var PermissionActions;
     PermissionActions["READ_USER"] = "read:user";
     PermissionActions["UPDATE_USER"] = "update:user";
     PermissionActions["DELETE_USER"] = "delete:user";
+    // User Analytics - accounts, sign-ups, sign-ins, codes, guardians and deletions over a period, counts only.
+    PermissionActions["READ_USER_ANALYTICS"] = "read:user-analytics";
     // Module: Incident
     PermissionActions["CREATE_INCIDENT"] = "create:incident";
     PermissionActions["READ_INCIDENT"] = "read:incident";
@@ -188,6 +190,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";

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,iBAgRX;AAhRD,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,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,EAhRW,iBAAiB,KAAjB,iBAAiB,QAgR5B"}
+{"version":3,"file":"permission-actions.enum.js","sourceRoot":"","sources":["../../../../../src/modules/permission/enums/permission-actions.enum.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,iBAoRX;AApRD,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;IAC3B,4GAA4G;IAC5G,gEAA2C,CAAA;IAE3C,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,EApRW,iBAAiB,KAAjB,iBAAiB,QAoR5B"}

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

@@ -8,4 +8,5 @@ export * from './interfaces/guardian';
 export * from './interfaces/guardian-relation';
 export * from './interfaces/guardians-response';
 export * from './interfaces/user-analytics-data';
+export * from './interfaces/account-analytics';
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/modules/user/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC;AACzC,cAAc,oCAAoC,CAAC;AACnD,cAAc,uCAAuC,CAAC;AAEtD,cAAc,mBAAmB,CAAC;AAClC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,uBAAuB,CAAC;AACtC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,iCAAiC,CAAC;AAChD,cAAc,kCAAkC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/modules/user/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC;AACzC,cAAc,oCAAoC,CAAC;AACnD,cAAc,uCAAuC,CAAC;AAEtD,cAAc,mBAAmB,CAAC;AAClC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,uBAAuB,CAAC;AACtC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,iCAAiC,CAAC;AAChD,cAAc,kCAAkC,CAAC;AACjD,cAAc,gCAAgC,CAAC"}

package/dist/esm/modules/user/interfaces/account-analytics.js

@@ -0,0 +1,16 @@
+/**
+ * Account analytics (the admin's User Analytics): who has an account and how they got
+ * one, whether they finished signing up, who signs in and how often, what goes wrong
+ * signing in, one-time codes and passwords, guardians, and who asked to leave.
+ *
+ * One read, computed by clarion-authentication from one consistent snapshot, so every
+ * number on a dashboard agrees with every other. Counts only: never a name, an e-mail
+ * address, a phone number or anything a user typed.
+ *
+ * Two kinds of source. Accounts, guardians and deletion requests are records the service
+ * has always kept, so their history goes back to the first account. Sign-ins, one-time
+ * codes and password changes come from the service's activity log, which begins on
+ * `activitySince`: before it, the only trace of a sign-in is each account's LAST one.
+ */
+export {};
+//# sourceMappingURL=account-analytics.js.map

package/dist/esm/modules/user/interfaces/account-analytics.js.map

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

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

@@ -26,6 +26,7 @@ export declare enum PermissionActions {
     READ_USER = "read:user",
     UPDATE_USER = "update:user",
     DELETE_USER = "delete:user",
+    READ_USER_ANALYTICS = "read:user-analytics",
     CREATE_INCIDENT = "create:incident",
     READ_INCIDENT = "read:incident",
     UPDATE_INCIDENT = "update:incident",
@@ -152,6 +153,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",

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

@@ -8,3 +8,4 @@ export * from './interfaces/guardian';
 export * from './interfaces/guardian-relation';
 export * from './interfaces/guardians-response';
 export * from './interfaces/user-analytics-data';
+export * from './interfaces/account-analytics';

package/dist/types/modules/user/interfaces/account-analytics.d.ts

@@ -0,0 +1,278 @@
+/**
+ * Account analytics (the admin's User Analytics): who has an account and how they got
+ * one, whether they finished signing up, who signs in and how often, what goes wrong
+ * signing in, one-time codes and passwords, guardians, and who asked to leave.
+ *
+ * One read, computed by clarion-authentication from one consistent snapshot, so every
+ * number on a dashboard agrees with every other. Counts only: never a name, an e-mail
+ * address, a phone number or anything a user typed.
+ *
+ * Two kinds of source. Accounts, guardians and deletion requests are records the service
+ * has always kept, so their history goes back to the first account. Sign-ins, one-time
+ * codes and password changes come from the service's activity log, which begins on
+ * `activitySince`: before it, the only trace of a sign-in is each account's LAST one.
+ */
+/** How the period is cut into points for the charts. Chosen by the service from the length of the period. */
+export type AccountAnalyticsBucket = 'hour' | 'day' | 'week' | 'month';
+export interface AccountAnalyticsRange {
+    /** Inclusive, ISO 8601. The first account when the period asked for was "forever". */
+    from: string;
+    /** Exclusive, ISO 8601. */
+    to: string;
+    bucket: AccountAnalyticsBucket;
+    /** 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 role, a band), largest first unless the section says otherwise. */
+export interface AccountAnalyticsCount<K extends string = string> {
+    key: K;
+    count: number;
+}
+/**
+ * What an account is for, from its roles - one per account, the first that applies:
+ *  - PLATFORM        Super-Admin;
+ *  - ORGANIZATION    an organization's staff (any Organization:* role);
+ *  - CONTROL_CENTRE  a control room's staff (any Control-Centre:* role);
+ *  - RESPONDER       a responder;
+ *  - CORPORATE_CLIENT  a corporate client's own staff;
+ *  - MOBILE          somebody using the app (Mobile-User);
+ *  - NONE            no role.
+ */
+export type AccountKind = 'PLATFORM' | 'ORGANIZATION' | 'CONTROL_CENTRE' | 'RESPONDER' | 'CORPORATE_CLIENT' | 'MOBILE' | 'NONE';
+/** How long ago an account last signed in, as it stands now. */
+export type AccountRecencyBand = '1d' | '7d' | '30d' | '90d' | 'older' | 'never';
+/** A row per brand of app: accounts that belong to it. */
+export interface AccountAnalyticsAppRow {
+    /** IncidentAppId: Upesy, G4S, GardaWorld, GRM, Pasha... */
+    app: string;
+    /** At the end of the period. */
+    total: number;
+    /** Created in the period. */
+    created: number;
+    /** Signed in during the period (as far as is known - see `AccountAnalyticsAccounts.activeInPeriod`). */
+    active: number;
+}
+export interface AccountAnalyticsKindRow {
+    kind: AccountKind;
+    total: number;
+    created: number;
+    active: number;
+}
+/** Of the accounts created in the period, how far each got - as they stand now. */
+export interface AccountAnalyticsFunnel {
+    created: number;
+    /** Confirmed their phone or e-mail with a one-time code. */
+    verified: number;
+    acceptedTerms: number;
+    /** Signed in at least once. */
+    signedIn: number;
+}
+export interface AccountAnalyticsAccounts {
+    /** Null for "forever". */
+    totalAtStart: number | null;
+    totalAtEnd: number;
+    created: number;
+    /** Of those: somebody using the app, and everybody else (staff of any kind). */
+    createdMobile: number;
+    createdStaff: number;
+    /**
+     * Accounts that signed in during the period: every account with a sign-in in the
+     * activity log, and - for the time before the log - every account whose LAST sign-in
+     * falls in the period. Exact from `activitySince` on; a floor before it.
+     */
+    activeInPeriod: number;
+    /** Active accounts that were created in an earlier period. */
+    returning: number;
+    funnel: AccountAnalyticsFunnel;
+    /** Now: never confirmed their phone or e-mail with a one-time code. */
+    pendingNow: number;
+    /** Now: never signed in. */
+    neverSignedIn: number;
+    /** Now: last signed in more than 90 days ago. */
+    dormant: number;
+    /** Hours from creating the account to its first sign-in, for first sign-ins in the period (activity log only). */
+    medianHoursToFirstSignIn: number | null;
+    byKind: AccountAnalyticsKindRow[];
+    byApp: AccountAnalyticsAppRow[];
+    /** At the end of the period: an account is counted under every role it holds. */
+    byRole: AccountAnalyticsCount[];
+    /** Now: active, pending, inactive. */
+    byStatus: AccountAnalyticsCount[];
+    /** At the end of the period: KE, UG, TZ. */
+    byCountry: AccountAnalyticsCount[];
+    /** Now, fixed order, zeros included. */
+    recency: AccountAnalyticsCount<AccountRecencyBand>[];
+}
+/**
+ * How somebody signed in:
+ *  - PASSWORD  e-mail and password (the admin and the web);
+ *  - OTP       phone number and a one-time code (the app);
+ *  - REVIEWER  the app-store reviewers' account.
+ */
+export type AccountSignInMethod = 'PASSWORD' | 'OTP' | 'REVIEWER';
+export interface AccountAnalyticsMethodRow {
+    method: string;
+    succeeded: number;
+    failed: number;
+}
+export interface AccountAnalyticsSignIns {
+    attempts: number;
+    succeeded: number;
+    failed: number;
+    /** succeeded / attempts; null with none. */
+    successRate: number | null;
+    /** Distinct accounts that signed in. */
+    users: number;
+    /** An account's very first sign-in. */
+    firstSignIns: number;
+    /** Failed for an e-mail or a code that matches no account (counted, never stored). */
+    unknownAccount: number;
+    byMethod: AccountAnalyticsMethodRow[];
+    /** INVALID_CREDENTIALS, UNVERIFIED, UNKNOWN_ACCOUNT, INVALID_TOKEN, ERROR... */
+    failureReasons: AccountAnalyticsCount[];
+    averageDailyUsers: number;
+    peakDailyUsers: number;
+    /** YYYY-MM-DD, local to the range's time zone. */
+    peakDay: string | null;
+}
+export interface AccountAnalyticsOtpActionRow {
+    /** What the code was for: login, register, verify_phone, reset_password, create_user... */
+    action: string;
+    sent: number;
+    verified: number;
+}
+export interface AccountAnalyticsOtp {
+    /** First sends and resends. */
+    sent: number;
+    resent: number;
+    /** Refused for asking too often. */
+    refused: number;
+    verified: number;
+    failed: number;
+    /** verified / (verified + failed); null with none. */
+    successRate: number | null;
+    /** From a code being sent to it being confirmed. */
+    medianSecondsToVerify: number | null;
+    byAction: AccountAnalyticsOtpActionRow[];
+    /** INVALID_OTP, EXPIRED_OTP, NO_OTP, INVALID_TOKEN. */
+    failureReasons: AccountAnalyticsCount[];
+}
+export interface AccountAnalyticsPasswords {
+    resetRequested: number;
+    resetCompleted: number;
+    resetFailed: number;
+    changed: number;
+    changeFailed: number;
+}
+/**
+ * The people an account holder chose to be alerted when they raise an SOS: app users
+ * (a two-way link, which the guardian accepts) and people reached by SMS.
+ */
+export interface AccountAnalyticsGuardians {
+    /** Accepted app-guardian links at the end of the period. */
+    links: number;
+    /** Links made in the period. */
+    linksCreated: number;
+    /** Accounts with at least one accepted app guardian, at the end of the period. */
+    protectedAccounts: number;
+    /** Distinct app users guarding somebody. */
+    guardians: number;
+    /** Share of app (Mobile-User) accounts with at least one guardian of either kind, now. */
+    mobileCoverage: number | null;
+    pending: number;
+    rejected: number;
+    /** Links with the guardian marked primary. */
+    primary: number;
+    /** Guardians reached by SMS, and the accounts that have one - now. */
+    smsGuardians: number;
+    accountsWithSmsGuardians: number;
+    byRelationship: AccountAnalyticsCount[];
+}
+/** Requests to delete an account, and why. */
+export interface AccountAnalyticsDeletions {
+    requested: number;
+    /** Every request ever made in scope. */
+    total: number;
+    /** Requesters whose account still exists now. */
+    stillPresent: number;
+    byReason: AccountAnalyticsCount[];
+}
+export interface AccountAnalyticsPoint {
+    /** The bucket's start, local to the range's time zone, without an offset ("2026-09-21T00:00:00"). */
+    bucket: string;
+    created: number;
+    createdMobile: number;
+    createdStaff: number;
+    /** Of those created in the bucket: verified, signed in - as they stand now. */
+    createdVerified: number;
+    createdSignedIn: number;
+    /** Accounts in existence at the end of the bucket. */
+    totalAccounts: number;
+    signIns: number;
+    failedSignIns: number;
+    /** Distinct accounts that signed in during the bucket (activity log). */
+    activeUsers: number;
+    otpSent: number;
+    otpVerified: number;
+    deletionRequests: number;
+    guardianLinks: number;
+}
+/** When accounts are created and used, by weekday (1 = Monday) and hour. */
+export interface AccountAnalyticsHeatCell {
+    weekday: number;
+    hour: number;
+    signUps: number;
+    signIns: number;
+}
+/** The previous period of the same length, for the change on each headline figure. Absent for "forever". */
+export interface AccountAnalyticsPrevious {
+    from: string;
+    to: string;
+    created: number;
+    activeInPeriod: number;
+    signIns: number;
+    failedSignIns: number;
+    otpSent: number;
+    otpVerified: number;
+    deletionRequests: number;
+    guardianLinks: number;
+}
+/** A Super-Admin's view of every organization: one row each, biggest first. */
+export interface AccountAnalyticsOrganizationRow {
+    organizationId: number;
+    total: number;
+    created: number;
+    active: number;
+    mobile: number;
+    staff: number;
+    signIns: number;
+    failedSignIns: number;
+}
+export interface AccountAnalytics {
+    /** Whose figures: one organization (and one control centre in it), or null for every organization. */
+    organizationId: number | null;
+    controlCentreId: number | null;
+    range: AccountAnalyticsRange;
+    generatedAt: string;
+    /** When the activity log's first record in scope was made; null while it is empty. */
+    activitySince: string | null;
+    previous: AccountAnalyticsPrevious | null;
+    timeline: AccountAnalyticsPoint[];
+    /** All 168 hours of the week, Monday first, zeros included. */
+    heatmap: AccountAnalyticsHeatCell[];
+    accounts: AccountAnalyticsAccounts;
+    signIns: AccountAnalyticsSignIns;
+    otp: AccountAnalyticsOtp;
+    passwords: AccountAnalyticsPasswords;
+    guardians: AccountAnalyticsGuardians;
+    deletions: AccountAnalyticsDeletions;
+    /** A Super-Admin looking at every organization only. */
+    byOrganization?: AccountAnalyticsOrganizationRow[];
+}
+/** What a dashboard asks: the period, and - for a Super-Admin - whose figures. */
+export interface AccountAnalyticsQuery {
+    from?: string;
+    to?: string;
+    timeZone?: string;
+    organizationId?: number;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clarion-shared-types",
-  "version": "1.0.108",
+  "version": "1.0.110",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/types/index.d.ts",