@camunda/ccma-shared-types 7.4.0 → 7.5.0

package/dist/types/ClusterTtl.type.d.ts

@@ -94,3 +94,30 @@ export declare function validateClusterTtlUnlimited(input: {
     reason?: unknown;
     link?: unknown;
 }): string | undefined;
+/**
+ * ClusterTtlDeletionPayload is the payload of a `cluster-ttl-deletion`
+ * approval request. The action reads `clusterId` and `orgId`: console-backend
+ * tests the TTL again, and keeps a cluster that another org owns now. The
+ * name, the expiry and `ttlSetBy` are copies for a reader.
+ */
+export interface ClusterTtlDeletionPayload {
+    clusterId: string;
+    clusterName?: string;
+    /** The org that owned the cluster when the cron read it. The delete demands it. */
+    orgId: string;
+    /** The end of the TTL, as an ISO date. */
+    ttlExpiresAt: string;
+    /** The email of the person who set the expiry. See `ttlSetBy` of a cluster. */
+    ttlSetBy?: string;
+}
+/**
+ * ClusterTtlDeletionResult is what console-backend answers when a
+ * `cluster-ttl-deletion` request runs. `kept` means that the cluster does not
+ * pass the TTL rules any more, and console-backend did not delete it. An
+ * extension, a move, the flag, or a failover sibling that is not healthy can
+ * each be the cause.
+ */
+export interface ClusterTtlDeletionResult {
+    clusterId: string;
+    outcome: 'deleted' | 'kept';
+}

package/dist/types/ClusterTtl.type.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/types/ClusterTtl.type.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 { DAY, WEEK } from '../constants/duration.const.js'\n\n/**\n * CLUSTER_TTL_FEATURE_FLAG gates the TTL of a single cluster. It is not the\n * org-level `preprodClusterTtlHours` limit: both apply, and the earlier one\n * deletes the cluster.\n */\nexport const CLUSTER_TTL_FEATURE_FLAG = 'console.clusterTtl'\n\n/**\n * isClusterTtlStage tells if the cluster TTL can be on at the stage `stage`.\n * That is only dev and int. On prod, and on each other stage, the feature is\n * off for every reader, also when the flag is on.\n */\nexport const isClusterTtlStage = (stage: string | undefined): boolean =>\n  stage === 'dev' || stage === 'int'\n\n/** CLUSTER_TTL_DURATIONS are the TTLs that end at a time. */\nexport const CLUSTER_TTL_DURATIONS = ['24h', '3d', '1w', '4w'] as const\n\nexport type ClusterTtlDuration = (typeof CLUSTER_TTL_DURATIONS)[number]\n\n/** CLUSTER_TTL_OPTIONS are the choices of the create form, in display order. */\nexport const CLUSTER_TTL_OPTIONS = [\n  ...CLUSTER_TTL_DURATIONS,\n  'unlimited',\n] as const\n\nexport type ClusterTtlOption = (typeof CLUSTER_TTL_OPTIONS)[number]\n\n/** DEFAULT_CLUSTER_TTL_OPTION applies when an eligible create sends no `ttl`. */\nexport const DEFAULT_CLUSTER_TTL_OPTION: ClusterTtlOption = '24h'\n\nexport const CLUSTER_TTL_DURATION_MS: Readonly<\n  Record<ClusterTtlDuration, number>\n> = {\n  '24h': DAY,\n  '3d': 3 * DAY,\n  '1w': WEEK,\n  '4w': 4 * WEEK,\n}\n\nexport const CLUSTER_TTL_UNLIMITED_REASON_MAX_LENGTH = 500\nexport const CLUSTER_TTL_UNLIMITED_LINK_MAX_LENGTH = 2048\n\n/**\n * CLUSTER_TTL_BACKFILL_REASON is the reason that the schema migration wrote\n * for each cluster that existed before the TTL. These rows are the only\n * unlimited TTLs with a reason and no link.\n */\nexport const CLUSTER_TTL_BACKFILL_REASON = 'Created before cluster TTL existed'\n\n/**\n * ClusterTtlDto is the TTL of one cluster. A response carries it only when\n * the reader may see the feature, thus an absent `ttl` means \"not shown\", not\n * \"unlimited\".\n */\nexport interface ClusterTtlDto {\n  /** ISO-8601. Absent when the TTL is unlimited. */\n  expiresAt?: string\n  /**\n   * Why the TTL is unlimited. Absent for a cluster that got no TTL, for\n   * example one that a failover or a customer org created.\n   */\n  unlimitedReason?: string\n  /** An http(s) URL, for example a GitHub issue. */\n  unlimitedLink?: string\n}\n\n/** ClusterTtlUnlimited is the input that sets an unlimited TTL. */\nexport interface ClusterTtlUnlimited {\n  reason: string\n  link: string\n}\n\n/**\n * UpdateClusterTtlBody is the body of `PATCH api/admin/clusters/:clusterId/ttl`.\n * Give exactly one of the two fields.\n */\nexport type UpdateClusterTtlBody =\n  | { extend: ClusterTtlDuration; unlimited?: never }\n  | { unlimited: ClusterTtlUnlimited; extend?: never }\n\nexport const isClusterTtlDuration = (\n  value: unknown,\n): value is ClusterTtlDuration =>\n  (CLUSTER_TTL_DURATIONS as readonly unknown[]).includes(value)\n\nexport const isClusterTtlOption = (value: unknown): value is ClusterTtlOption =>\n  (CLUSTER_TTL_OPTIONS as readonly unknown[]).includes(value)\n\n/** clusterTtlExpiresAt gives the expiry of a new TTL that starts at `now`. */\nexport function clusterTtlExpiresAt(\n  duration: ClusterTtlDuration,\n  now: Date = new Date(),\n): Date {\n  return new Date(now.getTime() + CLUSTER_TTL_DURATION_MS[duration])\n}\n\n/**\n * extendClusterTtl gives the expiry after an extension. The extension starts\n * at the current expiry, or at `now` when that is in the past or when the TTL\n * is unlimited (`currentExpiresAt` undefined). Thus an extension never makes\n * the TTL shorter.\n */\nexport function extendClusterTtl({\n  currentExpiresAt,\n  duration,\n  now = new Date(),\n}: {\n  currentExpiresAt: Date | string | undefined\n  duration: ClusterTtlDuration\n  now?: Date\n}): Date {\n  const currentMs =\n    currentExpiresAt === undefined\n      ? Number.NaN\n      : new Date(currentExpiresAt).getTime()\n  const startMs = Number.isNaN(currentMs)\n    ? now.getTime()\n    : Math.max(now.getTime(), currentMs)\n  return new Date(startMs + CLUSTER_TTL_DURATION_MS[duration])\n}\n\n/**\n * isPastClusterTtl tells if the TTL of a cluster ran out. An unlimited TTL\n * (`expiresAt` undefined) or a value that is not a date never runs out.\n */\nexport function isPastClusterTtl({\n  expiresAt,\n  now = new Date(),\n}: {\n  expiresAt: Date | string | undefined\n  now?: Date\n}): boolean {\n  if (expiresAt === undefined) return false\n  const expiresMs = new Date(expiresAt).getTime()\n  if (Number.isNaN(expiresMs)) return false\n  return expiresMs < now.getTime()\n}\n\n/** isHttpUrl accepts an absolute `http:` or `https:` URL with a host. */\nexport function isHttpUrl(value: unknown): value is string {\n  if (typeof value !== 'string' || /\\s/.test(value)) return false\n  try {\n    const url = new URL(value)\n    return (\n      (url.protocol === 'http:' || url.protocol === 'https:') &&\n      url.hostname.length > 0\n    )\n  } catch {\n    return false\n  }\n}\n\n/**\n * validateClusterTtlUnlimited gives the first problem of an unlimited TTL\n * input as a message for the caller, or `undefined` when the input is valid.\n * The reason must hold text, and the link must be an http(s) URL. The length\n * limits apply to the trimmed values, because the server stores those.\n */\nexport function validateClusterTtlUnlimited(input: {\n  reason?: unknown\n  link?: unknown\n}): string | undefined {\n  const reason =\n    typeof input.reason === 'string' ? input.reason.trim() : undefined\n  const link = typeof input.link === 'string' ? input.link.trim() : undefined\n  if (!reason) {\n    return 'An unlimited TTL needs a reason.'\n  }\n  if (reason.length > CLUSTER_TTL_UNLIMITED_REASON_MAX_LENGTH) {\n    return `The reason must not be longer than ${CLUSTER_TTL_UNLIMITED_REASON_MAX_LENGTH} characters.`\n  }\n  if (!link) {\n    return 'An unlimited TTL needs a link.'\n  }\n  if (link.length > CLUSTER_TTL_UNLIMITED_LINK_MAX_LENGTH) {\n    return `The link must not be longer than ${CLUSTER_TTL_UNLIMITED_LINK_MAX_LENGTH} characters.`\n  }\n  if (!isHttpUrl(link)) {\n    return 'The link must be an http or https URL.'\n  }\n  return undefined\n}\n"],
+  "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 { DAY, WEEK } from '../constants/duration.const.js'\n\n/**\n * CLUSTER_TTL_FEATURE_FLAG gates the TTL of a single cluster. It is not the\n * org-level `preprodClusterTtlHours` limit: both apply, and the earlier one\n * deletes the cluster.\n */\nexport const CLUSTER_TTL_FEATURE_FLAG = 'console.clusterTtl'\n\n/**\n * isClusterTtlStage tells if the cluster TTL can be on at the stage `stage`.\n * That is only dev and int. On prod, and on each other stage, the feature is\n * off for every reader, also when the flag is on.\n */\nexport const isClusterTtlStage = (stage: string | undefined): boolean =>\n  stage === 'dev' || stage === 'int'\n\n/** CLUSTER_TTL_DURATIONS are the TTLs that end at a time. */\nexport const CLUSTER_TTL_DURATIONS = ['24h', '3d', '1w', '4w'] as const\n\nexport type ClusterTtlDuration = (typeof CLUSTER_TTL_DURATIONS)[number]\n\n/** CLUSTER_TTL_OPTIONS are the choices of the create form, in display order. */\nexport const CLUSTER_TTL_OPTIONS = [\n  ...CLUSTER_TTL_DURATIONS,\n  'unlimited',\n] as const\n\nexport type ClusterTtlOption = (typeof CLUSTER_TTL_OPTIONS)[number]\n\n/** DEFAULT_CLUSTER_TTL_OPTION applies when an eligible create sends no `ttl`. */\nexport const DEFAULT_CLUSTER_TTL_OPTION: ClusterTtlOption = '24h'\n\nexport const CLUSTER_TTL_DURATION_MS: Readonly<\n  Record<ClusterTtlDuration, number>\n> = {\n  '24h': DAY,\n  '3d': 3 * DAY,\n  '1w': WEEK,\n  '4w': 4 * WEEK,\n}\n\nexport const CLUSTER_TTL_UNLIMITED_REASON_MAX_LENGTH = 500\nexport const CLUSTER_TTL_UNLIMITED_LINK_MAX_LENGTH = 2048\n\n/**\n * CLUSTER_TTL_BACKFILL_REASON is the reason that the schema migration wrote\n * for each cluster that existed before the TTL. These rows are the only\n * unlimited TTLs with a reason and no link.\n */\nexport const CLUSTER_TTL_BACKFILL_REASON = 'Created before cluster TTL existed'\n\n/**\n * ClusterTtlDto is the TTL of one cluster. A response carries it only when\n * the reader may see the feature, thus an absent `ttl` means \"not shown\", not\n * \"unlimited\".\n */\nexport interface ClusterTtlDto {\n  /** ISO-8601. Absent when the TTL is unlimited. */\n  expiresAt?: string\n  /**\n   * Why the TTL is unlimited. Absent for a cluster that got no TTL, for\n   * example one that a failover or a customer org created.\n   */\n  unlimitedReason?: string\n  /** An http(s) URL, for example a GitHub issue. */\n  unlimitedLink?: string\n}\n\n/** ClusterTtlUnlimited is the input that sets an unlimited TTL. */\nexport interface ClusterTtlUnlimited {\n  reason: string\n  link: string\n}\n\n/**\n * UpdateClusterTtlBody is the body of `PATCH api/admin/clusters/:clusterId/ttl`.\n * Give exactly one of the two fields.\n */\nexport type UpdateClusterTtlBody =\n  | { extend: ClusterTtlDuration; unlimited?: never }\n  | { unlimited: ClusterTtlUnlimited; extend?: never }\n\nexport const isClusterTtlDuration = (\n  value: unknown,\n): value is ClusterTtlDuration =>\n  (CLUSTER_TTL_DURATIONS as readonly unknown[]).includes(value)\n\nexport const isClusterTtlOption = (value: unknown): value is ClusterTtlOption =>\n  (CLUSTER_TTL_OPTIONS as readonly unknown[]).includes(value)\n\n/** clusterTtlExpiresAt gives the expiry of a new TTL that starts at `now`. */\nexport function clusterTtlExpiresAt(\n  duration: ClusterTtlDuration,\n  now: Date = new Date(),\n): Date {\n  return new Date(now.getTime() + CLUSTER_TTL_DURATION_MS[duration])\n}\n\n/**\n * extendClusterTtl gives the expiry after an extension. The extension starts\n * at the current expiry, or at `now` when that is in the past or when the TTL\n * is unlimited (`currentExpiresAt` undefined). Thus an extension never makes\n * the TTL shorter.\n */\nexport function extendClusterTtl({\n  currentExpiresAt,\n  duration,\n  now = new Date(),\n}: {\n  currentExpiresAt: Date | string | undefined\n  duration: ClusterTtlDuration\n  now?: Date\n}): Date {\n  const currentMs =\n    currentExpiresAt === undefined\n      ? Number.NaN\n      : new Date(currentExpiresAt).getTime()\n  const startMs = Number.isNaN(currentMs)\n    ? now.getTime()\n    : Math.max(now.getTime(), currentMs)\n  return new Date(startMs + CLUSTER_TTL_DURATION_MS[duration])\n}\n\n/**\n * isPastClusterTtl tells if the TTL of a cluster ran out. An unlimited TTL\n * (`expiresAt` undefined) or a value that is not a date never runs out.\n */\nexport function isPastClusterTtl({\n  expiresAt,\n  now = new Date(),\n}: {\n  expiresAt: Date | string | undefined\n  now?: Date\n}): boolean {\n  if (expiresAt === undefined) return false\n  const expiresMs = new Date(expiresAt).getTime()\n  if (Number.isNaN(expiresMs)) return false\n  return expiresMs < now.getTime()\n}\n\n/** isHttpUrl accepts an absolute `http:` or `https:` URL with a host. */\nexport function isHttpUrl(value: unknown): value is string {\n  if (typeof value !== 'string' || /\\s/.test(value)) return false\n  try {\n    const url = new URL(value)\n    return (\n      (url.protocol === 'http:' || url.protocol === 'https:') &&\n      url.hostname.length > 0\n    )\n  } catch {\n    return false\n  }\n}\n\n/**\n * validateClusterTtlUnlimited gives the first problem of an unlimited TTL\n * input as a message for the caller, or `undefined` when the input is valid.\n * The reason must hold text, and the link must be an http(s) URL. The length\n * limits apply to the trimmed values, because the server stores those.\n */\nexport function validateClusterTtlUnlimited(input: {\n  reason?: unknown\n  link?: unknown\n}): string | undefined {\n  const reason =\n    typeof input.reason === 'string' ? input.reason.trim() : undefined\n  const link = typeof input.link === 'string' ? input.link.trim() : undefined\n  if (!reason) {\n    return 'An unlimited TTL needs a reason.'\n  }\n  if (reason.length > CLUSTER_TTL_UNLIMITED_REASON_MAX_LENGTH) {\n    return `The reason must not be longer than ${CLUSTER_TTL_UNLIMITED_REASON_MAX_LENGTH} characters.`\n  }\n  if (!link) {\n    return 'An unlimited TTL needs a link.'\n  }\n  if (link.length > CLUSTER_TTL_UNLIMITED_LINK_MAX_LENGTH) {\n    return `The link must not be longer than ${CLUSTER_TTL_UNLIMITED_LINK_MAX_LENGTH} characters.`\n  }\n  if (!isHttpUrl(link)) {\n    return 'The link must be an http or https URL.'\n  }\n  return undefined\n}\n\n/**\n * ClusterTtlDeletionPayload is the payload of a `cluster-ttl-deletion`\n * approval request. The action reads `clusterId` and `orgId`: console-backend\n * tests the TTL again, and keeps a cluster that another org owns now. The\n * name, the expiry and `ttlSetBy` are copies for a reader.\n */\nexport interface ClusterTtlDeletionPayload {\n  clusterId: string\n  clusterName?: string\n  /** The org that owned the cluster when the cron read it. The delete demands it. */\n  orgId: string\n  /** The end of the TTL, as an ISO date. */\n  ttlExpiresAt: string\n  /** The email of the person who set the expiry. See `ttlSetBy` of a cluster. */\n  ttlSetBy?: string\n}\n\n/**\n * ClusterTtlDeletionResult is what console-backend answers when a\n * `cluster-ttl-deletion` request runs. `kept` means that the cluster does not\n * pass the TTL rules any more, and console-backend did not delete it. An\n * extension, a move, the flag, or a failover sibling that is not healthy can\n * each be the cause.\n */\nexport interface ClusterTtlDeletionResult {\n  clusterId: string\n  outcome: 'deleted' | 'kept'\n}\n"],
   "mappings": "AAMA,SAAS,KAAK,YAAY;AAOnB,MAAM,2BAA2B;AAOjC,MAAM,oBAAoB,CAAC,UAChC,UAAU,SAAS,UAAU;AAGxB,MAAM,wBAAwB,CAAC,OAAO,MAAM,MAAM,IAAI;AAKtD,MAAM,sBAAsB;AAAA,EACjC,GAAG;AAAA,EACH;AACF;AAKO,MAAM,6BAA+C;AAErD,MAAM,0BAET;AAAA,EACF,OAAO;AAAA,EACP,MAAM,IAAI;AAAA,EACV,MAAM;AAAA,EACN,MAAM,IAAI;AACZ;AAEO,MAAM,0CAA0C;AAChD,MAAM,wCAAwC;AAO9C,MAAM,8BAA8B;AAiCpC,MAAM,uBAAuB,CAClC,UAEC,sBAA6C,SAAS,KAAK;AAEvD,MAAM,qBAAqB,CAAC,UAChC,oBAA2C,SAAS,KAAK;AAGrD,SAAS,oBACd,UACA,MAAY,oBAAI,KAAK,GACf;AACN,SAAO,IAAI,KAAK,IAAI,QAAQ,IAAI,wBAAwB,QAAQ,CAAC;AACnE;AAQO,SAAS,iBAAiB;AAAA,EAC/B;AAAA,EACA;AAAA,EACA,MAAM,oBAAI,KAAK;AACjB,GAIS;AACP,QAAM,YACJ,qBAAqB,SACjB,OAAO,MACP,IAAI,KAAK,gBAAgB,EAAE,QAAQ;AACzC,QAAM,UAAU,OAAO,MAAM,SAAS,IAClC,IAAI,QAAQ,IACZ,KAAK,IAAI,IAAI,QAAQ,GAAG,SAAS;AACrC,SAAO,IAAI,KAAK,UAAU,wBAAwB,QAAQ,CAAC;AAC7D;AAMO,SAAS,iBAAiB;AAAA,EAC/B;AAAA,EACA,MAAM,oBAAI,KAAK;AACjB,GAGY;AACV,MAAI,cAAc,OAAW,QAAO;AACpC,QAAM,YAAY,IAAI,KAAK,SAAS,EAAE,QAAQ;AAC9C,MAAI,OAAO,MAAM,SAAS,EAAG,QAAO;AACpC,SAAO,YAAY,IAAI,QAAQ;AACjC;AAGO,SAAS,UAAU,OAAiC;AACzD,MAAI,OAAO,UAAU,YAAY,KAAK,KAAK,KAAK,EAAG,QAAO;AAC1D,MAAI;AACF,UAAM,MAAM,IAAI,IAAI,KAAK;AACzB,YACG,IAAI,aAAa,WAAW,IAAI,aAAa,aAC9C,IAAI,SAAS,SAAS;AAAA,EAE1B,QAAQ;AACN,WAAO;AAAA,EACT;AACF;AAQO,SAAS,4BAA4B,OAGrB;AACrB,QAAM,SACJ,OAAO,MAAM,WAAW,WAAW,MAAM,OAAO,KAAK,IAAI;AAC3D,QAAM,OAAO,OAAO,MAAM,SAAS,WAAW,MAAM,KAAK,KAAK,IAAI;AAClE,MAAI,CAAC,QAAQ;AACX,WAAO;AAAA,EACT;AACA,MAAI,OAAO,SAAS,yCAAyC;AAC3D,WAAO,sCAAsC,uCAAuC;AAAA,EACtF;AACA,MAAI,CAAC,MAAM;AACT,WAAO;AAAA,EACT;AACA,MAAI,KAAK,SAAS,uCAAuC;AACvD,WAAO,oCAAoC,qCAAqC;AAAA,EAClF;AACA,MAAI,CAAC,UAAU,IAAI,GAAG;AACpB,WAAO;AAAA,EACT;AACA,SAAO;AACT;",
   "names": []
 }

package/package.json

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