@camunda/ccma-shared-types 5.0.0 → 7.0.0

package/dist/utils/qa-user.utils.d.ts

@@ -0,0 +1,14 @@
+/**
+ * The email of a user that the QA route of accounts-backend creates
+ * (`POST /external/qa/organizations`). The route builds the email with this
+ * function, and every reader that must find a QA user calls
+ * `isQaUserEmail`. Thus the two cannot drift.
+ */
+export declare function qaUserEmail(userId: string): string;
+/**
+ * True when the email belongs to a user from an automated QA run. A token has
+ * no QA claim, but it carries the email, thus the email is the marker. The id
+ * in the email must be a UUID, so a person with the address
+ * `qa-user-admin@ultrawombat.com` is no QA user.
+ */
+export declare function isQaUserEmail(email: string | undefined): boolean;

package/dist/utils/qa-user.utils.js

@@ -0,0 +1,14 @@
+const QA_USER_EMAIL_PREFIX = "qa-user-";
+const QA_USER_EMAIL_DOMAIN = "@ultrawombat.com";
+const QA_USER_EMAIL_PATTERN = /^qa-user-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}@ultrawombat\.com$/;
+function qaUserEmail(userId) {
+  return `${QA_USER_EMAIL_PREFIX}${userId}${QA_USER_EMAIL_DOMAIN}`;
+}
+function isQaUserEmail(email) {
+  return email !== void 0 && QA_USER_EMAIL_PATTERN.test(email.toLowerCase());
+}
+export {
+  isQaUserEmail,
+  qaUserEmail
+};
+//# sourceMappingURL=qa-user.utils.js.map

package/dist/utils/qa-user.utils.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/utils/qa-user.utils.ts"],
+  "sourcesContent": ["/*\n * Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH\n * under one or more contributor license agreements. Licensed under a commercial license.\n * You may not use this file except in compliance with the commercial license.\n */\n\nconst QA_USER_EMAIL_PREFIX = 'qa-user-'\nconst QA_USER_EMAIL_DOMAIN = '@ultrawombat.com'\n\n// The QA route builds the id with `uuidv4()`: five groups of hex digits.\nconst QA_USER_EMAIL_PATTERN =\n  /^qa-user-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}@ultrawombat\\.com$/\n\n/**\n * The email of a user that the QA route of accounts-backend creates\n * (`POST /external/qa/organizations`). The route builds the email with this\n * function, and every reader that must find a QA user calls\n * `isQaUserEmail`. Thus the two cannot drift.\n */\nexport function qaUserEmail(userId: string): string {\n  return `${QA_USER_EMAIL_PREFIX}${userId}${QA_USER_EMAIL_DOMAIN}`\n}\n\n/**\n * True when the email belongs to a user from an automated QA run. A token has\n * no QA claim, but it carries the email, thus the email is the marker. The id\n * in the email must be a UUID, so a person with the address\n * `qa-user-admin@ultrawombat.com` is no QA user.\n */\nexport function isQaUserEmail(email: string | undefined): boolean {\n  return email !== undefined && QA_USER_EMAIL_PATTERN.test(email.toLowerCase())\n}\n"],
+  "mappings": "AAMA,MAAM,uBAAuB;AAC7B,MAAM,uBAAuB;AAG7B,MAAM,wBACJ;AAQK,SAAS,YAAY,QAAwB;AAClD,SAAO,GAAG,oBAAoB,GAAG,MAAM,GAAG,oBAAoB;AAChE;AAQO,SAAS,cAAc,OAAoC;AAChE,SAAO,UAAU,UAAa,sBAAsB,KAAK,MAAM,YAAY,CAAC;AAC9E;",
+  "names": []
+}

package/dist/utils/qa-user.utils.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/utils/upgradeGateReason.utils.d.ts

@@ -0,0 +1,8 @@
+import type { UpgradeReadinessDto } from '../dtos/UpgradeReadiness.dto.js';
+/**
+ * The text for a blocked upgrade gate (PDP-3067). It names the next step.
+ * console-backend sends it as the message of the 409 and of a skipped
+ * cluster in a bulk run, and Control shows it on the cluster page, so the
+ * three always agree.
+ */
+export declare function upgradeGateReason(gate: UpgradeReadinessDto): string;

package/dist/utils/upgradeGateReason.utils.js

@@ -0,0 +1,23 @@
+function upgradeGateReason(gate) {
+  if (gate.gracePeriod) {
+    const hours = gate.gracePeriod.hoursRemaining;
+    return `The cluster got a new minor version recently. Try the upgrade again in about ${hours} ${hours === 1 ? "hour" : "hours"}.`;
+  }
+  switch (gate.readiness?.source) {
+    case "suspended":
+      return "The cluster is suspended and cannot report its migration state. Resume the cluster, then try the upgrade again.";
+    case "updating":
+      return "The cluster still rolls out its last upgrade. Try the upgrade again when the cluster is healthy.";
+    case "timeout":
+    case "error":
+      return "The cluster did not answer the upgrade readiness check. Try the upgrade again later.";
+    case "unsupported":
+      return "Console cannot reach the upgrade readiness check of this cluster. Try the upgrade again later.";
+    default:
+      return gate.readiness?.verdict === "notReady" ? "The cluster still completes the migrations of its last upgrade. Try the upgrade again later." : "The cluster could not read its own migration state. Try the upgrade again later.";
+  }
+}
+export {
+  upgradeGateReason
+};
+//# sourceMappingURL=upgradeGateReason.utils.js.map

package/dist/utils/upgradeGateReason.utils.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/utils/upgradeGateReason.utils.ts"],
+  "sourcesContent": ["/*\n * Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH\n * under one or more contributor license agreements. Licensed under a commercial license.\n * You may not use this file except in compliance with the commercial license.\n */\n\nimport type { UpgradeReadinessDto } from '../dtos/UpgradeReadiness.dto.js'\n\n/**\n * The text for a blocked upgrade gate (PDP-3067). It names the next step.\n * console-backend sends it as the message of the 409 and of a skipped\n * cluster in a bulk run, and Control shows it on the cluster page, so the\n * three always agree.\n */\nexport function upgradeGateReason(gate: UpgradeReadinessDto): string {\n  if (gate.gracePeriod) {\n    // The hours, not the end time: the wait is 24 hours, or half an hour on\n    // dev, and a raw ISO time is hard to read in a 409.\n    const hours = gate.gracePeriod.hoursRemaining\n    return `The cluster got a new minor version recently. Try the upgrade again in about ${hours} ${hours === 1 ? 'hour' : 'hours'}.`\n  }\n  switch (gate.readiness?.source) {\n    case 'suspended':\n      return 'The cluster is suspended and cannot report its migration state. Resume the cluster, then try the upgrade again.'\n    case 'updating':\n      return 'The cluster still rolls out its last upgrade. Try the upgrade again when the cluster is healthy.'\n    case 'timeout':\n    case 'error':\n      return 'The cluster did not answer the upgrade readiness check. Try the upgrade again later.'\n    case 'unsupported':\n      return 'Console cannot reach the upgrade readiness check of this cluster. Try the upgrade again later.'\n    default:\n      return gate.readiness?.verdict === 'notReady'\n        ? 'The cluster still completes the migrations of its last upgrade. Try the upgrade again later.'\n        : 'The cluster could not read its own migration state. Try the upgrade again later.'\n  }\n}\n"],
+  "mappings": "AAcO,SAAS,kBAAkB,MAAmC;AACnE,MAAI,KAAK,aAAa;AAGpB,UAAM,QAAQ,KAAK,YAAY;AAC/B,WAAO,gFAAgF,KAAK,IAAI,UAAU,IAAI,SAAS,OAAO;AAAA,EAChI;AACA,UAAQ,KAAK,WAAW,QAAQ;AAAA,IAC9B,KAAK;AACH,aAAO;AAAA,IACT,KAAK;AACH,aAAO;AAAA,IACT,KAAK;AAAA,IACL,KAAK;AACH,aAAO;AAAA,IACT,KAAK;AACH,aAAO;AAAA,IACT;AACE,aAAO,KAAK,WAAW,YAAY,aAC/B,iGACA;AAAA,EACR;AACF;",
+  "names": []
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@camunda/ccma-shared-types",
-  "version": "5.0.0",
+  "version": "7.0.0",
   "description": "Shared TypeScript types for Camunda Cloud Management Apps",
   "bugs": {
     "url": "https://github.com/camunda/camunda-cloud-management-apps/issues"