@oneuptime/common 12.0.19 → 12.0.20

package/build/dist/Utils/EnterpriseLicense/EnterpriseLicenseSync.js

@@ -0,0 +1,174 @@
+/*
+ * Maps a license-server response (from /enterprise-license/validate or
+ * /enterprise-license/report-user-count) onto the GlobalConfig columns a
+ * self-hosted installation mirrors locally.
+ *
+ * Every field is three-state, and the distinction is the whole contract:
+ *
+ *   key absent  - the license server did not speak about this field. That is
+ *                 what an oneuptime.com older than this build looks like, so
+ *                 the stored value is left exactly as it is. Collapsing this
+ *                 to null is how a daily report would wipe a perfectly good
+ *                 license expiry and take the installation down.
+ *   null        - the server explicitly says "there is no value". Written as
+ *                 null, so clearing a seat limit on oneuptime.com actually
+ *                 clears it on the customer's installation.
+ *   a value     - validated, then written.
+ *
+ * Anything that is neither absent, null, nor a usable value is treated as
+ * absent and reported as a warning: a malformed response must never be able
+ * to corrupt license state that was correct a moment ago.
+ */
+export default class EnterpriseLicenseSyncUtil {
+    /*
+     * The license key is deliberately NOT synced. The installation authenticates
+     * with the key it already holds, and a response must never be able to swap
+     * it for another one.
+     */
+    static getGlobalConfigUpdateFromLicenseResponse(data) {
+        const payload = data.payload || {};
+        const updateData = {};
+        const warnings = [];
+        /*
+         * The seat limit. This is the field customers change on oneuptime.com and
+         * then wait for: without it here, buying seats never reaches the
+         * installation that is enforcing the old number.
+         */
+        if (this.isPresent(payload, "userLimit")) {
+            const rawUserLimit = payload["userLimit"];
+            if (rawUserLimit === null) {
+                updateData.enterpriseLicenseUserLimit = null;
+            }
+            else if (this.isNonNegativeInteger(rawUserLimit)) {
+                updateData.enterpriseLicenseUserLimit = rawUserLimit;
+            }
+            else {
+                warnings.push(`Ignored userLimit "${String(rawUserLimit)}" from the license server: it is not a non-negative whole number.`);
+            }
+        }
+        /*
+         * The count and its timestamp move together: a count with a stamp from a
+         * previous report would read as "confirmed today", which is the exact
+         * lie this whole sync exists to stop telling.
+         */
+        if (this.isPresent(payload, "currentUserCount")) {
+            const rawUserCount = payload["currentUserCount"];
+            if (this.isNonNegativeInteger(rawUserCount)) {
+                updateData.enterpriseLicenseCurrentUserCount = rawUserCount;
+                updateData.enterpriseLicenseUserCountUpdatedAt =
+                    this.parseDate(payload["userCountUpdatedAt"]) || data.reportedAt;
+            }
+            else if (rawUserCount === null) {
+                /*
+                 * The server has never had a count for this license. Nothing useful to
+                 * store, and blanking the last known count would be worse than keeping
+                 * it, so leave both columns alone.
+                 */
+                warnings.push("The license server reported no user count for this license. Keeping the previously stored usage.");
+            }
+            else {
+                warnings.push(`Ignored currentUserCount "${String(rawUserCount)}" from the license server: it is not a non-negative whole number. Keeping the previously stored usage.`);
+            }
+        }
+        /*
+         * Expiry drives licenseValid on the installation, so a renewal that never
+         * arrives here shows up as a license that expires on its original date
+         * however much the customer paid. Null is treated as absent on purpose: a
+         * report is not the place to strip an installation of its expiry.
+         */
+        if (this.isPresent(payload, "expiresAt") && payload["expiresAt"] !== null) {
+            const expiresAt = this.parseDate(payload["expiresAt"]);
+            if (expiresAt) {
+                updateData.enterpriseLicenseExpiresAt = expiresAt;
+            }
+            else {
+                warnings.push(`Ignored expiresAt "${String(payload["expiresAt"])}" from the license server: it is not a date.`);
+            }
+        }
+        if (this.isPresent(payload, "isEvaluationLicense")) {
+            const rawIsEvaluation = payload["isEvaluationLicense"];
+            if (typeof rawIsEvaluation === "boolean") {
+                updateData.enterpriseLicenseIsEvaluation = rawIsEvaluation;
+            }
+            else {
+                warnings.push(`Ignored isEvaluationLicense "${String(rawIsEvaluation)}" from the license server: it is not a boolean.`);
+            }
+        }
+        if (this.isPresent(payload, "companyName")) {
+            const companyName = this.parseNonEmptyString(payload["companyName"]);
+            /*
+             * An empty company name is what the server sends for a license with none
+             * set, and overwriting a good name with "" would be a visible regression
+             * in the modal. Only a real name is worth writing.
+             */
+            if (companyName) {
+                updateData.enterpriseCompanyName = companyName;
+            }
+        }
+        /*
+         * The token is opaque here - it is signed with the license server's secret
+         * and this side only checks that it exists. It is never cleared: a license
+         * that has expired is legitimately issued no token, and clearing it on the
+         * way past would compound an expiry the customer may be about to renew.
+         */
+        if (this.isPresent(payload, "token")) {
+            const token = this.parseNonEmptyString(payload["token"]);
+            if (token) {
+                updateData.enterpriseLicenseToken = token;
+            }
+        }
+        if (this.isPresent(payload, "instances")) {
+            const rawInstances = payload["instances"];
+            if (Array.isArray(rawInstances)) {
+                updateData.enterpriseLicenseInstances =
+                    rawInstances;
+            }
+            else {
+                warnings.push("Ignored the instance list from the license server: it is not an array.");
+            }
+        }
+        return {
+            updateData: updateData,
+            warnings: warnings,
+        };
+    }
+    /*
+     * Present means the key is on the object, even when it carries null or
+     * undefined. `"x" in payload` rather than a truthiness or undefined check,
+     * because "the server said null" and "the server said nothing" have to stay
+     * distinguishable all the way down.
+     */
+    static isPresent(payload, key) {
+        if (!Object.prototype.hasOwnProperty.call(payload, key)) {
+            return false;
+        }
+        // An explicit undefined is indistinguishable from silence. Treat it as one.
+        return payload[key] !== undefined;
+    }
+    static isNonNegativeInteger(value) {
+        return (typeof value === "number" &&
+            Number.isFinite(value) &&
+            Number.isInteger(value) &&
+            value >= 0);
+    }
+    static parseNonEmptyString(value) {
+        if (typeof value !== "string") {
+            return "";
+        }
+        return value.trim();
+    }
+    static parseDate(value) {
+        if (value instanceof Date) {
+            return Number.isNaN(value.getTime()) ? null : value;
+        }
+        if (typeof value !== "string" || !value.trim()) {
+            return null;
+        }
+        const parsed = new Date(value.trim());
+        if (Number.isNaN(parsed.getTime())) {
+            return null;
+        }
+        return parsed;
+    }
+}
+//# sourceMappingURL=EnterpriseLicenseSync.js.map

package/build/dist/Utils/EnterpriseLicense/EnterpriseLicenseSync.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EnterpriseLicenseSync.js","sourceRoot":"","sources":["../../../../Utils/EnterpriseLicense/EnterpriseLicenseSync.ts"],"names":[],"mappings":"AAqBA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,OAAO,OAAO,yBAAyB;IAC5C;;;;OAIG;IACI,MAAM,CAAC,wCAAwC,CAAC,IAQtD;QACC,MAAM,OAAO,GAAe,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;QAC/C,MAAM,UAAU,GAAgC,EAAE,CAAC;QACnD,MAAM,QAAQ,GAAkB,EAAE,CAAC;QAEnC;;;;WAIG;QACH,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,WAAW,CAAC,EAAE,CAAC;YACzC,MAAM,YAAY,GAAY,OAAO,CAAC,WAAW,CAAC,CAAC;YAEnD,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;gBAC1B,UAAU,CAAC,0BAA0B,GAAG,IAAI,CAAC;YAC/C,CAAC;iBAAM,IAAI,IAAI,CAAC,oBAAoB,CAAC,YAAY,CAAC,EAAE,CAAC;gBACnD,UAAU,CAAC,0BAA0B,GAAG,YAAsB,CAAC;YACjE,CAAC;iBAAM,CAAC;gBACN,QAAQ,CAAC,IAAI,CACX,sBAAsB,MAAM,CAC1B,YAAY,CACb,mEAAmE,CACrE,CAAC;YACJ,CAAC;QACH,CAAC;QAED;;;;WAIG;QACH,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,kBAAkB,CAAC,EAAE,CAAC;YAChD,MAAM,YAAY,GAAY,OAAO,CAAC,kBAAkB,CAAC,CAAC;YAE1D,IAAI,IAAI,CAAC,oBAAoB,CAAC,YAAY,CAAC,EAAE,CAAC;gBAC5C,UAAU,CAAC,iCAAiC,GAAG,YAAsB,CAAC;gBACtE,UAAU,CAAC,mCAAmC;oBAC5C,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC;YACrE,CAAC;iBAAM,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;gBACjC;;;;mBAIG;gBACH,QAAQ,CAAC,IAAI,CACX,kGAAkG,CACnG,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,QAAQ,CAAC,IAAI,CACX,6BAA6B,MAAM,CACjC,YAAY,CACb,wGAAwG,CAC1G,CAAC;YACJ,CAAC;QACH,CAAC;QAED;;;;;WAKG;QACH,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,WAAW,CAAC,IAAI,OAAO,CAAC,WAAW,CAAC,KAAK,IAAI,EAAE,CAAC;YAC1E,MAAM,SAAS,GAAgB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC;YAEpE,IAAI,SAAS,EAAE,CAAC;gBACd,UAAU,CAAC,0BAA0B,GAAG,SAAS,CAAC;YACpD,CAAC;iBAAM,CAAC;gBACN,QAAQ,CAAC,IAAI,CACX,sBAAsB,MAAM,CAC1B,OAAO,CAAC,WAAW,CAAC,CACrB,8CAA8C,CAChD,CAAC;YACJ,CAAC;QACH,CAAC;QAED,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,qBAAqB,CAAC,EAAE,CAAC;YACnD,MAAM,eAAe,GAAY,OAAO,CAAC,qBAAqB,CAAC,CAAC;YAEhE,IAAI,OAAO,eAAe,KAAK,SAAS,EAAE,CAAC;gBACzC,UAAU,CAAC,6BAA6B,GAAG,eAAe,CAAC;YAC7D,CAAC;iBAAM,CAAC;gBACN,QAAQ,CAAC,IAAI,CACX,gCAAgC,MAAM,CACpC,eAAe,CAChB,iDAAiD,CACnD,CAAC;YACJ,CAAC;QACH,CAAC;QAED,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,aAAa,CAAC,EAAE,CAAC;YAC3C,MAAM,WAAW,GAAW,IAAI,CAAC,mBAAmB,CAClD,OAAO,CAAC,aAAa,CAAC,CACvB,CAAC;YAEF;;;;eAIG;YACH,IAAI,WAAW,EAAE,CAAC;gBAChB,UAAU,CAAC,qBAAqB,GAAG,WAAW,CAAC;YACjD,CAAC;QACH,CAAC;QAED;;;;;WAKG;QACH,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,CAAC;YACrC,MAAM,KAAK,GAAW,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;YAEjE,IAAI,KAAK,EAAE,CAAC;gBACV,UAAU,CAAC,sBAAsB,GAAG,KAAK,CAAC;YAC5C,CAAC;QACH,CAAC;QAED,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,WAAW,CAAC,EAAE,CAAC;YACzC,MAAM,YAAY,GAAY,OAAO,CAAC,WAAW,CAAC,CAAC;YAEnD,IAAI,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;gBAChC,UAAU,CAAC,0BAA0B;oBACnC,YAAuD,CAAC;YAC5D,CAAC;iBAAM,CAAC;gBACN,QAAQ,CAAC,IAAI,CACX,wEAAwE,CACzE,CAAC;YACJ,CAAC;QACH,CAAC;QAED,OAAO;YACL,UAAU,EAAE,UAAU;YACtB,QAAQ,EAAE,QAAQ;SACnB,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACK,MAAM,CAAC,SAAS,CAAC,OAAmB,EAAE,GAAW;QACvD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,EAAE,CAAC;YACxD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,4EAA4E;QAC5E,OAAO,OAAO,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC;IACpC,CAAC;IAEO,MAAM,CAAC,oBAAoB,CAAC,KAAc;QAChD,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;YACzB,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;YACtB,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC;YACvB,KAAK,IAAI,CAAC,CACX,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,mBAAmB,CAAC,KAAc;QAC/C,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,OAAO,KAAK,CAAC,IAAI,EAAE,CAAC;IACtB,CAAC;IAEO,MAAM,CAAC,SAAS,CAAC,KAAc;QACrC,IAAI,KAAK,YAAY,IAAI,EAAE,CAAC;YAC1B,OAAO,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;QACtD,CAAC;QAED,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC;YAC/C,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,MAAM,GAAS,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;QAE5C,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC;YACnC,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oneuptime/common",
-  "version": "12.0.19",
+  "version": "12.0.20",
   "description": "",
   "repository": {
     "type": "git",