@camunda/ccma-shared-types 4.0.0 → 6.0.0

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

@@ -0,0 +1,33 @@
+import type { Limits } from '../dtos/SalesPlan.dto.js';
+/**
+ * Returns the value of a number limit as a finite number, or `undefined`.
+ * Accepts only a finite number and a string with a decimal number, such as
+ * `'8'`, `'-1'` or `'1.5'`. `Number` alone also accepts `true` (1), `[8]`
+ * (8), `''` (0) and `'0x8'` (8), and limits are JSON that nothing types at
+ * run time.
+ */
+export declare function parseNumericLimit(value: unknown): number | undefined;
+/**
+ * Returns `true` for the stages `dev` and `int`, where the
+ * `preprodClusterTtlHours` limit applies. Returns `false` for every other
+ * stage, `prod` and `local` included.
+ */
+export declare const isPreprodClusterTtlStage: (stage: string) => boolean;
+/**
+ * Returns the `preprodClusterTtlHours` limit of an org when it applies, or
+ * `undefined`. The limit applies only on dev and int, so a prod org with the
+ * limit keeps its clusters. The value goes through `parseNumericLimit`.
+ */
+export declare function getPreprodClusterTtlHours({ limits, stage, }: {
+    limits: Pick<Limits, 'preprodClusterTtlHours'> | undefined;
+    stage: string;
+}): number | undefined;
+/**
+ * Returns whether a cluster is older than the TTL of its org. A cluster with
+ * no valid `created` is never past the TTL.
+ */
+export declare function isPastPreprodClusterTtl({ created, ttlHours, now, }: {
+    created: Date | string | undefined;
+    ttlHours: number | undefined;
+    now?: Date;
+}): boolean;

package/dist/types/PreprodClusterTtl.type.js

@@ -0,0 +1,37 @@
+const HOUR = 60 * 60 * 1e3;
+function parseNumericLimit(value) {
+  if (typeof value === "number") {
+    return Number.isFinite(value) ? value : void 0;
+  }
+  if (typeof value !== "string" || !/^-?\d+(\.\d+)?$/.test(value.trim())) {
+    return void 0;
+  }
+  const parsed = Number(value);
+  return Number.isFinite(parsed) ? parsed : void 0;
+}
+const isPreprodClusterTtlStage = (stage) => stage === "dev" || stage === "int";
+function getPreprodClusterTtlHours({
+  limits,
+  stage
+}) {
+  if (!isPreprodClusterTtlStage(stage)) return void 0;
+  const ttlHours = parseNumericLimit(limits?.preprodClusterTtlHours);
+  return ttlHours !== void 0 && Number.isInteger(ttlHours) && ttlHours >= 1 ? ttlHours : void 0;
+}
+function isPastPreprodClusterTtl({
+  created,
+  ttlHours,
+  now = /* @__PURE__ */ new Date()
+}) {
+  if (ttlHours === void 0 || created === void 0) return false;
+  const createdMs = new Date(created).getTime();
+  if (Number.isNaN(createdMs)) return false;
+  return now.getTime() - createdMs > ttlHours * HOUR;
+}
+export {
+  getPreprodClusterTtlHours,
+  isPastPreprodClusterTtl,
+  isPreprodClusterTtlStage,
+  parseNumericLimit
+};
+//# sourceMappingURL=PreprodClusterTtl.type.js.map

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

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/types/PreprodClusterTtl.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 type { Limits } from '../dtos/SalesPlan.dto.js'\n\nconst HOUR = 60 * 60 * 1000\n\n/**\n * Returns the value of a number limit as a finite number, or `undefined`.\n * Accepts only a finite number and a string with a decimal number, such as\n * `'8'`, `'-1'` or `'1.5'`. `Number` alone also accepts `true` (1), `[8]`\n * (8), `''` (0) and `'0x8'` (8), and limits are JSON that nothing types at\n * run time.\n */\nexport function parseNumericLimit(value: unknown): number | undefined {\n  if (typeof value === 'number') {\n    return Number.isFinite(value) ? value : undefined\n  }\n  if (typeof value !== 'string' || !/^-?\\d+(\\.\\d+)?$/.test(value.trim())) {\n    return undefined\n  }\n  // A string of 309 or more digits is `Infinity`.\n  const parsed = Number(value)\n  return Number.isFinite(parsed) ? parsed : undefined\n}\n\n/**\n * Returns `true` for the stages `dev` and `int`, where the\n * `preprodClusterTtlHours` limit applies. Returns `false` for every other\n * stage, `prod` and `local` included.\n */\nexport const isPreprodClusterTtlStage = (stage: string): boolean =>\n  stage === 'dev' || stage === 'int'\n\n/**\n * Returns the `preprodClusterTtlHours` limit of an org when it applies, or\n * `undefined`. The limit applies only on dev and int, so a prod org with the\n * limit keeps its clusters. The value goes through `parseNumericLimit`.\n */\nexport function getPreprodClusterTtlHours({\n  limits,\n  stage,\n}: {\n  limits: Pick<Limits, 'preprodClusterTtlHours'> | undefined\n  stage: string\n}): number | undefined {\n  if (!isPreprodClusterTtlStage(stage)) return undefined\n  const ttlHours = parseNumericLimit(limits?.preprodClusterTtlHours)\n  return ttlHours !== undefined && Number.isInteger(ttlHours) && ttlHours >= 1\n    ? ttlHours\n    : undefined\n}\n\n/**\n * Returns whether a cluster is older than the TTL of its org. A cluster with\n * no valid `created` is never past the TTL.\n */\nexport function isPastPreprodClusterTtl({\n  created,\n  ttlHours,\n  now = new Date(),\n}: {\n  created: Date | string | undefined\n  ttlHours: number | undefined\n  now?: Date\n}): boolean {\n  if (ttlHours === undefined || created === undefined) return false\n  const createdMs = new Date(created).getTime()\n  if (Number.isNaN(createdMs)) return false\n  return now.getTime() - createdMs > ttlHours * HOUR\n}\n"],
+  "mappings": "AAQA,MAAM,OAAO,KAAK,KAAK;AAShB,SAAS,kBAAkB,OAAoC;AACpE,MAAI,OAAO,UAAU,UAAU;AAC7B,WAAO,OAAO,SAAS,KAAK,IAAI,QAAQ;AAAA,EAC1C;AACA,MAAI,OAAO,UAAU,YAAY,CAAC,kBAAkB,KAAK,MAAM,KAAK,CAAC,GAAG;AACtE,WAAO;AAAA,EACT;AAEA,QAAM,SAAS,OAAO,KAAK;AAC3B,SAAO,OAAO,SAAS,MAAM,IAAI,SAAS;AAC5C;AAOO,MAAM,2BAA2B,CAAC,UACvC,UAAU,SAAS,UAAU;AAOxB,SAAS,0BAA0B;AAAA,EACxC;AAAA,EACA;AACF,GAGuB;AACrB,MAAI,CAAC,yBAAyB,KAAK,EAAG,QAAO;AAC7C,QAAM,WAAW,kBAAkB,QAAQ,sBAAsB;AACjE,SAAO,aAAa,UAAa,OAAO,UAAU,QAAQ,KAAK,YAAY,IACvE,WACA;AACN;AAMO,SAAS,wBAAwB;AAAA,EACtC;AAAA,EACA;AAAA,EACA,MAAM,oBAAI,KAAK;AACjB,GAIY;AACV,MAAI,aAAa,UAAa,YAAY,OAAW,QAAO;AAC5D,QAAM,YAAY,IAAI,KAAK,OAAO,EAAE,QAAQ;AAC5C,MAAI,OAAO,MAAM,SAAS,EAAG,QAAO;AACpC,SAAO,IAAI,QAAQ,IAAI,YAAY,WAAW;AAChD;",
+  "names": []
+}

package/dist/types/hdp.types.d.ts

@@ -246,6 +246,12 @@ export interface LlmSpend {
     maxBudget: number;
 }
 export type HdpEntity = 'cluster' | 'clusterBackup' | 'clusterBackupSchedule' | 'clusterRestore' | 'datacenter' | 'generation' | 'channel' | 'clusterPlan' | 'clusterPlanType' | 'alertSubscription' | 'consoleApiClient' | 'connectorSecret' | 'byomClient' | 'secureConnectivity' | 'clusterClient' | 'organization' | 'user' | 'invite' | 'usageAlert' | 'audit' | 'systemAudit' | 'telemetry' | 'userlogin' | 'clusterBulkOperation' | 'clusterModification' | 'clusterModificationConfig' | 'llmSpend';
+/**
+ * The cluster disks that the disk-usage route of accounts-backend accepts.
+ * HDP does not ingest the Zeebe gauge yet, so a Zeebe read returns no rows.
+ */
+export declare const HDP_DISKS: readonly ["elasticsearch", "zeebe"];
+export type HdpDisk = (typeof HDP_DISKS)[number];
 export interface HdpPrometheusDataCapacityDataPoint {
     clusterId?: string;
     ts: number;

package/dist/types/hdp.types.js

@@ -7,8 +7,10 @@ var AlertSubscriptionReportType = /* @__PURE__ */ ((AlertSubscriptionReportType2
   AlertSubscriptionReportType2["Webhook"] = "Webhook";
   return AlertSubscriptionReportType2;
 })(AlertSubscriptionReportType || {});
+const HDP_DISKS = ["elasticsearch", "zeebe"];
 export {
   AlertSubscriptionReportType,
-  AlertSubscriptionType
+  AlertSubscriptionType,
+  HDP_DISKS
 };
 //# sourceMappingURL=hdp.types.js.map

package/dist/types/hdp.types.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/types/hdp.types.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 { Limits } from '../dtos/SalesPlan.dto.js'\nimport type { UsageAlertMetric } from '../dtos/UsageAlert.dto.js'\nimport type { ClusterClientPermission } from '../enums/ClusterClientPermissions.enum.js'\nimport type { ConsoleAPIClientPermission } from '../enums/ConsoleApiClientPermission.enum.js'\nimport type { OrganizationRole } from '../enums/OrganizationRole.enum.js'\nimport type { DisplayedSalesPlan, SalesPlanType } from './SalesPlanType.type.js'\n\nexport interface Cluster {\n  uuid: string\n  name: string\n  clusterPlanType: ClusterPlanType\n  clusterPlan: ClusterPlan\n  generation: Generation\n  channel: Channel\n  datacenter?: Datacenter // is not fetched eagerly, if we do not have it we just gonna omit it\n  amountOfIpWhitelistRules: number\n  ownerUuid: string\n  created: Date\n  autoUpdate: boolean\n  mcpEnabled?: boolean\n  businessIdUniquenessEnabled?: boolean\n  optimizeEnabled?: boolean\n  tags?: string[]\n  sleeping?: boolean\n  activeModifications: boolean\n  encryptionKeysSet?: {\n    primaryConfigured: boolean\n    secondaryConfigured: boolean\n  }\n}\nexport interface ClusterBackup {\n  clusterId: string\n  backupId?: string\n}\n\nexport interface ClusterModification {\n  uuid: string\n  clusterUuid: string\n  owner: string\n  createdAt?: Date\n  archivedAt?: Date\n}\n\nexport interface ClusterModificationConfig {\n  uuid: string\n  clusterUuid: string\n  modificationUuid: string\n  creator: string\n  description: string\n  url?: string\n  createdAt?: Date\n  sealedAt?: Date\n  activatedAt?: Date\n  replacedBy?: string\n  deactivatedAt?: Date\n  deactivatedBy?: string | null\n  expiresAt?: Date | null\n  expiredNotifiedAt?: Date | null\n  yoloJustification?: string\n}\n\n/**\n * HDP-specific interface for ClusterModificationConfig.\n * Used for Holy Data Platform integration - keeps Date objects for timestamp fields.\n */\nexport interface HdpClusterModificationConfig {\n  uuid: string\n  clusterUuid: string\n  modificationUuid: string\n  creator: string\n  description: string\n  url?: string\n  createdAt?: Date\n  sealedAt?: Date\n  activatedAt?: Date\n  replacedBy?: string\n  deactivatedAt?: Date\n  deactivatedBy?: string | null\n  expiresAt?: Date | null\n  expiredNotifiedAt?: Date | null\n}\n\nexport interface ClusterBackupSchedule {\n  clusterId: string\n  schedule?: string\n}\n\nexport interface ClusterPlanType {\n  uuid: string\n  name: string\n  availabilityClass: string\n  isDevelopment: boolean\n}\n\nexport interface ClusterPlan {\n  uuid: string\n  name: string\n}\n\nexport interface Datacenter {\n  uuid: string\n  name: string\n}\nexport interface Generation {\n  uuid: string\n  name: string\n}\nexport interface Channel {\n  uuid: string\n  name: string\n}\n\n// eslint-disable-next-line no-shadow\nexport enum AlertSubscriptionType {\n  ProcessAlert = 'ProcessAlert',\n}\n\n// eslint-disable-next-line no-shadow\nexport enum AlertSubscriptionReportType {\n  Email = 'Email',\n  Webhook = 'Webhook',\n}\nexport interface AlertSubscription {\n  uuid: string\n  clusterUuid?: string\n  target: string // userIdOrWebhook\n  reportType: AlertSubscriptionReportType\n  type: AlertSubscriptionType\n}\n\nexport interface ConsoleApiClient {\n  uuid: string\n  name: string\n  organizationUuid: string\n  permissions: ConsoleAPIClientPermission[]\n}\n\nexport interface ConnectorSecret {\n  clusterUuid: string\n  amountOfSecrets: number\n}\n\nexport interface ByomClient {\n  uuid: string\n  clusterUuid?: string\n  username: string\n}\n\nexport interface SecureConnectivity {\n  clusterUuid: string\n  allowedRegions: string[]\n  allowedPrincipals: string[]\n}\n\nexport interface ClusterClient {\n  uuid: string\n  name: string\n  clusterUuid?: string\n  clientId: string\n  permissions: ClusterClientPermission[]\n}\n\nexport interface Organization {\n  uuid: string\n  name: string\n  salesplan?: {\n    type: SalesPlanType // might be undefined when in limbo\n    displayedType?: DisplayedSalesPlan // might be undefined when in limbo\n    uuid: string // might be undefined when in limbo\n    name: string // might be undefined when in limbo\n    expireDate?: Date\n  }\n  reservations?: {\n    [key: string]: number\n  }\n  earlyAccessFeatures?: string[]\n  justOptedForTheBetaTerms?: boolean\n  salesForceProjectId?: string\n  awsOnly?: boolean\n  limits?: Limits\n}\n\nexport interface User {\n  name: string\n  email: string\n  userId: string\n  orgMemberships?: Array<{ orgUuid: string; roles: OrganizationRole[] }> // can be undefined which means: no new info ;)\n}\n\nexport interface UserLogin {\n  userId: string\n}\n\nexport interface Invite {\n  email: string\n  orgUuid: string\n  roles: OrganizationRole[]\n}\n\nexport interface UsageAlert {\n  orgId: string\n  metric: UsageAlertMetric\n  threshold: number\n  enabled: boolean\n  triggered: boolean\n}\n\nexport interface Audit {\n  service: string\n  orgId: string\n  timestamp: number\n  audit: string\n  auditType: 'c' | 'r' | 'u' | 'd'\n  entity: string\n  entityId: string\n  userId: string\n  entityAttribute?: string\n  entityAttributeValueFrom?: string\n  entityAttributeValueTo?: string\n  parentEntity?: string\n  parentEntityId?: string\n}\n\nexport interface SystemAudit {\n  service: string\n  timestamp: number\n  audit: string\n  auditType: 'c' | 'r' | 'u' | 'd'\n  entity: string\n  entityId: string\n  userId: string\n  entityAttribute?: string | null\n  entityAttributeValueFrom?: string | null\n  entityAttributeValueTo?: string | null\n  orgId?: string | null\n  clusterId?: string | null\n}\n\nexport interface TelemetryData {\n  customerId: string\n  installationId: string\n  entities: Array<{ id: string; type: string }>\n  key: string\n  value: string | number | boolean\n  tags?: Record<string, string>\n  timestampFrom: number\n  timestampTo?: number\n}\n\nexport interface ClusterBulkOperation {\n  uuid: string\n  name: string\n  reason: string\n  eyes: number\n  clusterUuids: string[]\n  type: string\n  created: Date\n  updated?: Date\n  executedAt?: Date\n  createdBy: string\n}\n\nexport interface LlmSpend {\n  orgId: string\n  salesPlanType: SalesPlanType\n  spend: number\n  maxBudget: number\n}\n\nexport type HdpEntity =\n  | 'cluster'\n  | 'clusterBackup'\n  | 'clusterBackupSchedule'\n  | 'clusterRestore'\n  | 'datacenter'\n  | 'generation'\n  | 'channel'\n  | 'clusterPlan'\n  | 'clusterPlanType'\n  | 'alertSubscription'\n  | 'consoleApiClient'\n  | 'connectorSecret'\n  | 'byomClient'\n  | 'secureConnectivity'\n  | 'clusterClient'\n  | 'organization'\n  | 'user'\n  | 'invite'\n  | 'usageAlert'\n  | 'audit'\n  | 'systemAudit'\n  | 'telemetry'\n  | 'userlogin'\n  | 'clusterBulkOperation'\n  | 'clusterModification'\n  | 'clusterModificationConfig'\n  | 'llmSpend'\n\nexport interface HdpPrometheusDataCapacityDataPoint {\n  clusterId?: string\n  ts: number\n  avg: number\n  min: number\n  max: number\n}\n\nexport interface HdpBackendChangeEvent {\n  ts: number\n  data: {\n    stage: string\n    entity: string\n    operation: string\n    data: any\n  }\n}\n"],
-  "mappings": "AAuHO,IAAK,wBAAL,kBAAKA,2BAAL;AACL,EAAAA,uBAAA,kBAAe;AADL,SAAAA;AAAA,GAAA;AAKL,IAAK,8BAAL,kBAAKC,iCAAL;AACL,EAAAA,6BAAA,WAAQ;AACR,EAAAA,6BAAA,aAAU;AAFA,SAAAA;AAAA,GAAA;",
+  "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 { Limits } from '../dtos/SalesPlan.dto.js'\nimport type { UsageAlertMetric } from '../dtos/UsageAlert.dto.js'\nimport type { ClusterClientPermission } from '../enums/ClusterClientPermissions.enum.js'\nimport type { ConsoleAPIClientPermission } from '../enums/ConsoleApiClientPermission.enum.js'\nimport type { OrganizationRole } from '../enums/OrganizationRole.enum.js'\nimport type { DisplayedSalesPlan, SalesPlanType } from './SalesPlanType.type.js'\n\nexport interface Cluster {\n  uuid: string\n  name: string\n  clusterPlanType: ClusterPlanType\n  clusterPlan: ClusterPlan\n  generation: Generation\n  channel: Channel\n  datacenter?: Datacenter // is not fetched eagerly, if we do not have it we just gonna omit it\n  amountOfIpWhitelistRules: number\n  ownerUuid: string\n  created: Date\n  autoUpdate: boolean\n  mcpEnabled?: boolean\n  businessIdUniquenessEnabled?: boolean\n  optimizeEnabled?: boolean\n  tags?: string[]\n  sleeping?: boolean\n  activeModifications: boolean\n  encryptionKeysSet?: {\n    primaryConfigured: boolean\n    secondaryConfigured: boolean\n  }\n}\nexport interface ClusterBackup {\n  clusterId: string\n  backupId?: string\n}\n\nexport interface ClusterModification {\n  uuid: string\n  clusterUuid: string\n  owner: string\n  createdAt?: Date\n  archivedAt?: Date\n}\n\nexport interface ClusterModificationConfig {\n  uuid: string\n  clusterUuid: string\n  modificationUuid: string\n  creator: string\n  description: string\n  url?: string\n  createdAt?: Date\n  sealedAt?: Date\n  activatedAt?: Date\n  replacedBy?: string\n  deactivatedAt?: Date\n  deactivatedBy?: string | null\n  expiresAt?: Date | null\n  expiredNotifiedAt?: Date | null\n  yoloJustification?: string\n}\n\n/**\n * HDP-specific interface for ClusterModificationConfig.\n * Used for Holy Data Platform integration - keeps Date objects for timestamp fields.\n */\nexport interface HdpClusterModificationConfig {\n  uuid: string\n  clusterUuid: string\n  modificationUuid: string\n  creator: string\n  description: string\n  url?: string\n  createdAt?: Date\n  sealedAt?: Date\n  activatedAt?: Date\n  replacedBy?: string\n  deactivatedAt?: Date\n  deactivatedBy?: string | null\n  expiresAt?: Date | null\n  expiredNotifiedAt?: Date | null\n}\n\nexport interface ClusterBackupSchedule {\n  clusterId: string\n  schedule?: string\n}\n\nexport interface ClusterPlanType {\n  uuid: string\n  name: string\n  availabilityClass: string\n  isDevelopment: boolean\n}\n\nexport interface ClusterPlan {\n  uuid: string\n  name: string\n}\n\nexport interface Datacenter {\n  uuid: string\n  name: string\n}\nexport interface Generation {\n  uuid: string\n  name: string\n}\nexport interface Channel {\n  uuid: string\n  name: string\n}\n\n// eslint-disable-next-line no-shadow\nexport enum AlertSubscriptionType {\n  ProcessAlert = 'ProcessAlert',\n}\n\n// eslint-disable-next-line no-shadow\nexport enum AlertSubscriptionReportType {\n  Email = 'Email',\n  Webhook = 'Webhook',\n}\nexport interface AlertSubscription {\n  uuid: string\n  clusterUuid?: string\n  target: string // userIdOrWebhook\n  reportType: AlertSubscriptionReportType\n  type: AlertSubscriptionType\n}\n\nexport interface ConsoleApiClient {\n  uuid: string\n  name: string\n  organizationUuid: string\n  permissions: ConsoleAPIClientPermission[]\n}\n\nexport interface ConnectorSecret {\n  clusterUuid: string\n  amountOfSecrets: number\n}\n\nexport interface ByomClient {\n  uuid: string\n  clusterUuid?: string\n  username: string\n}\n\nexport interface SecureConnectivity {\n  clusterUuid: string\n  allowedRegions: string[]\n  allowedPrincipals: string[]\n}\n\nexport interface ClusterClient {\n  uuid: string\n  name: string\n  clusterUuid?: string\n  clientId: string\n  permissions: ClusterClientPermission[]\n}\n\nexport interface Organization {\n  uuid: string\n  name: string\n  salesplan?: {\n    type: SalesPlanType // might be undefined when in limbo\n    displayedType?: DisplayedSalesPlan // might be undefined when in limbo\n    uuid: string // might be undefined when in limbo\n    name: string // might be undefined when in limbo\n    expireDate?: Date\n  }\n  reservations?: {\n    [key: string]: number\n  }\n  earlyAccessFeatures?: string[]\n  justOptedForTheBetaTerms?: boolean\n  salesForceProjectId?: string\n  awsOnly?: boolean\n  limits?: Limits\n}\n\nexport interface User {\n  name: string\n  email: string\n  userId: string\n  orgMemberships?: Array<{ orgUuid: string; roles: OrganizationRole[] }> // can be undefined which means: no new info ;)\n}\n\nexport interface UserLogin {\n  userId: string\n}\n\nexport interface Invite {\n  email: string\n  orgUuid: string\n  roles: OrganizationRole[]\n}\n\nexport interface UsageAlert {\n  orgId: string\n  metric: UsageAlertMetric\n  threshold: number\n  enabled: boolean\n  triggered: boolean\n}\n\nexport interface Audit {\n  service: string\n  orgId: string\n  timestamp: number\n  audit: string\n  auditType: 'c' | 'r' | 'u' | 'd'\n  entity: string\n  entityId: string\n  userId: string\n  entityAttribute?: string\n  entityAttributeValueFrom?: string\n  entityAttributeValueTo?: string\n  parentEntity?: string\n  parentEntityId?: string\n}\n\nexport interface SystemAudit {\n  service: string\n  timestamp: number\n  audit: string\n  auditType: 'c' | 'r' | 'u' | 'd'\n  entity: string\n  entityId: string\n  userId: string\n  entityAttribute?: string | null\n  entityAttributeValueFrom?: string | null\n  entityAttributeValueTo?: string | null\n  orgId?: string | null\n  clusterId?: string | null\n}\n\nexport interface TelemetryData {\n  customerId: string\n  installationId: string\n  entities: Array<{ id: string; type: string }>\n  key: string\n  value: string | number | boolean\n  tags?: Record<string, string>\n  timestampFrom: number\n  timestampTo?: number\n}\n\nexport interface ClusterBulkOperation {\n  uuid: string\n  name: string\n  reason: string\n  eyes: number\n  clusterUuids: string[]\n  type: string\n  created: Date\n  updated?: Date\n  executedAt?: Date\n  createdBy: string\n}\n\nexport interface LlmSpend {\n  orgId: string\n  salesPlanType: SalesPlanType\n  spend: number\n  maxBudget: number\n}\n\nexport type HdpEntity =\n  | 'cluster'\n  | 'clusterBackup'\n  | 'clusterBackupSchedule'\n  | 'clusterRestore'\n  | 'datacenter'\n  | 'generation'\n  | 'channel'\n  | 'clusterPlan'\n  | 'clusterPlanType'\n  | 'alertSubscription'\n  | 'consoleApiClient'\n  | 'connectorSecret'\n  | 'byomClient'\n  | 'secureConnectivity'\n  | 'clusterClient'\n  | 'organization'\n  | 'user'\n  | 'invite'\n  | 'usageAlert'\n  | 'audit'\n  | 'systemAudit'\n  | 'telemetry'\n  | 'userlogin'\n  | 'clusterBulkOperation'\n  | 'clusterModification'\n  | 'clusterModificationConfig'\n  | 'llmSpend'\n\n/**\n * The cluster disks that the disk-usage route of accounts-backend accepts.\n * HDP does not ingest the Zeebe gauge yet, so a Zeebe read returns no rows.\n */\nexport const HDP_DISKS = ['elasticsearch', 'zeebe'] as const\nexport type HdpDisk = (typeof HDP_DISKS)[number]\n\nexport interface HdpPrometheusDataCapacityDataPoint {\n  clusterId?: string\n  ts: number\n  avg: number\n  min: number\n  max: number\n}\n\nexport interface HdpBackendChangeEvent {\n  ts: number\n  data: {\n    stage: string\n    entity: string\n    operation: string\n    data: any\n  }\n}\n"],
+  "mappings": "AAuHO,IAAK,wBAAL,kBAAKA,2BAAL;AACL,EAAAA,uBAAA,kBAAe;AADL,SAAAA;AAAA,GAAA;AAKL,IAAK,8BAAL,kBAAKC,iCAAL;AACL,EAAAA,6BAAA,WAAQ;AACR,EAAAA,6BAAA,aAAU;AAFA,SAAAA;AAAA,GAAA;AAwLL,MAAM,YAAY,CAAC,iBAAiB,OAAO;",
   "names": ["AlertSubscriptionType", "AlertSubscriptionReportType"]
 }

package/dist/utils/elasticsearchPlanPath.utils.d.ts

@@ -0,0 +1,18 @@
+/**
+ * canonicalPlanKey maps a dotted plan key to the path that Console reads. A
+ * legacy `operate.elasticsearch.*` key becomes `elasticsearch.*`. Other keys
+ * come back unchanged.
+ */
+export declare const canonicalPlanKey: (key: string) => string;
+/**
+ * canonicalPlan returns a cluster plan config with `operate.elasticsearch`
+ * merged under the top-level `elasticsearch`. If a field is set in both places,
+ * the top-level value wins. The input does not change. A plan without the
+ * legacy block comes back as the same object, and a value that is not a record
+ * comes back unchanged.
+ *
+ * The result is typed as a plain record, not as the input type: the input type
+ * still declares `operate.elasticsearch`, which the result does not have.
+ */
+export declare function canonicalPlan(plan: Record<string, unknown>): Record<string, unknown>;
+export declare function canonicalPlan(plan: unknown): unknown;

package/dist/utils/elasticsearchPlanPath.utils.js

@@ -0,0 +1,23 @@
+import { ObjectMergeUtils } from "./objectMerge.utils.js";
+const LEGACY_ELASTICSEARCH_PREFIX = "operate.elasticsearch.";
+const canonicalPlanKey = (key) => key.startsWith(LEGACY_ELASTICSEARCH_PREFIX) ? key.slice("operate.".length) : key;
+const isRecord = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
+function canonicalPlan(plan) {
+  if (!isRecord(plan) || !isRecord(plan.operate) || plan.operate.elasticsearch === void 0) {
+    return plan;
+  }
+  const { elasticsearch: legacy, ...operate } = plan.operate;
+  return {
+    ...plan,
+    operate,
+    elasticsearch: ObjectMergeUtils.merge({
+      objectA: legacy,
+      objectB: plan.elasticsearch
+    })
+  };
+}
+export {
+  canonicalPlan,
+  canonicalPlanKey
+};
+//# sourceMappingURL=elasticsearchPlanPath.utils.js.map

package/dist/utils/elasticsearchPlanPath.utils.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/utils/elasticsearchPlanPath.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 { ObjectMergeUtils } from './objectMerge.utils.js'\n\n// Older cluster plans and modification configs keep the Elasticsearch config\n// under `operate.elasticsearch`. The ZeebeCluster resource reads it from the\n// top-level `spec.elasticsearch` only (camunda-operator#5124), so the top-level\n// `elasticsearch` is the canonical plan path.\nconst LEGACY_ELASTICSEARCH_PREFIX = 'operate.elasticsearch.'\n\n/**\n * canonicalPlanKey maps a dotted plan key to the path that Console reads. A\n * legacy `operate.elasticsearch.*` key becomes `elasticsearch.*`. Other keys\n * come back unchanged.\n */\nexport const canonicalPlanKey = (key: string): string =>\n  key.startsWith(LEGACY_ELASTICSEARCH_PREFIX)\n    ? key.slice('operate.'.length)\n    : key\n\nconst isRecord = (value: unknown): value is Record<string, unknown> =>\n  typeof value === 'object' && value !== null && !Array.isArray(value)\n\n/**\n * canonicalPlan returns a cluster plan config with `operate.elasticsearch`\n * merged under the top-level `elasticsearch`. If a field is set in both places,\n * the top-level value wins. The input does not change. A plan without the\n * legacy block comes back as the same object, and a value that is not a record\n * comes back unchanged.\n *\n * The result is typed as a plain record, not as the input type: the input type\n * still declares `operate.elasticsearch`, which the result does not have.\n */\nexport function canonicalPlan(\n  plan: Record<string, unknown>,\n): Record<string, unknown>\nexport function canonicalPlan(plan: unknown): unknown\nexport function canonicalPlan(plan: unknown): unknown {\n  if (\n    !isRecord(plan) ||\n    !isRecord(plan.operate) ||\n    plan.operate.elasticsearch === undefined\n  ) {\n    return plan\n  }\n  const { elasticsearch: legacy, ...operate } = plan.operate\n  return {\n    ...plan,\n    operate,\n    elasticsearch: ObjectMergeUtils.merge({\n      objectA: legacy,\n      objectB: plan.elasticsearch,\n    }),\n  }\n}\n"],
+  "mappings": "AAMA,SAAS,wBAAwB;AAMjC,MAAM,8BAA8B;AAO7B,MAAM,mBAAmB,CAAC,QAC/B,IAAI,WAAW,2BAA2B,IACtC,IAAI,MAAM,WAAW,MAAM,IAC3B;AAEN,MAAM,WAAW,CAAC,UAChB,OAAO,UAAU,YAAY,UAAU,QAAQ,CAAC,MAAM,QAAQ,KAAK;AAgB9D,SAAS,cAAc,MAAwB;AACpD,MACE,CAAC,SAAS,IAAI,KACd,CAAC,SAAS,KAAK,OAAO,KACtB,KAAK,QAAQ,kBAAkB,QAC/B;AACA,WAAO;AAAA,EACT;AACA,QAAM,EAAE,eAAe,QAAQ,GAAG,QAAQ,IAAI,KAAK;AACnD,SAAO;AAAA,IACL,GAAG;AAAA,IACH;AAAA,IACA,eAAe,iBAAiB,MAAM;AAAA,MACpC,SAAS;AAAA,MACT,SAAS,KAAK;AAAA,IAChB,CAAC;AAAA,EACH;AACF;",
+  "names": []
+}

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/package.json

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

package/dist/dtos/FeatureFlagOverride.dto.d.ts

@@ -1,226 +0,0 @@
-import type { Stage } from '../constants/misc.const.js';
-/**
- * The wire shapes of the feature flag surface of control-backend.
- *
- * They are here and not in `@camunda-cloud/featureflags`, because
- * `@camunda/ccma-api` is published and cannot name a type from that private
- * package. The RULES stay there: `resolveFlag` decides a value, and
- * `FLAG_REGISTRY` holds the metadata. This file carries the answer over HTTP.
- *
- * `flagPath` is a `string` in every shape below. The typed `FlagPath` needs
- * `Features`, and a caller of the API names a flag that the SERVER validates
- * against its own registry. A type that the browser holds cannot do that job,
- * because the server can be older or newer than the bundle.
- */
-/** Which readers an override reaches. It is `FlagOverrideScope`. */
-export declare const FEATURE_FLAG_OVERRIDE_SCOPES: readonly ["stage", "org"];
-export type FeatureFlagOverrideScope = (typeof FEATURE_FLAG_OVERRIDE_SCOPES)[number];
-/** Why a flag has the value that it has. It is `FlagReason`. */
-export declare const FEATURE_FLAG_REASONS: readonly ["DEFAULT", "OVERRIDE_STAGE", "OVERRIDE_ORG", "OVERRIDE_REFUSED"];
-export type FeatureFlagReason = (typeof FEATURE_FLAG_REASONS)[number];
-/** How long a flag is meant to live. It is `FlagType`. */
-export declare const FEATURE_FLAG_TYPES: readonly ["release", "ops", "perm"];
-export type FeatureFlagType = (typeof FEATURE_FLAG_TYPES)[number];
-/**
- * One condition of the code rule of a flag.
- *
- * The code rule is a LIST of these, and a reader gets the flag when ANY one
- * matches. An empty list is off for every reader. `FLAG_RULES` of
- * `@camunda-cloud/featureflags` holds the rules, and `defaults` evaluates the
- * same objects, thus the description cannot drift from the value.
- */
-export type FeatureFlagCondition = 
-/** On for every reader. */
-{
-    kind: 'always';
-}
-/** On when the stage of the reader is one of `stages`. */
- | {
-    kind: 'stage';
-    stages: Stage[];
-}
-/** On when the email address of the reader is a Camundi address. */
- | {
-    kind: 'camundiEmail';
-}
-/** On when the email address of the reader has one of `domains`. */
- | {
-    kind: 'emailDomain';
-    domains: string[];
-}
-/** On when the organization of the reader is one of `orgIds`. */
- | {
-    kind: 'org';
-    orgIds: string[];
-};
-/** One stored override, as a reader of the API sees it. */
-export interface FeatureFlagOverrideDto {
-    id: string;
-    flagPath: string;
-    scope: FeatureFlagOverrideScope;
-    /** The stage for `stage`, and the organization id for `org`. */
-    target: string;
-    enabled: boolean;
-    /** Why the person asked for it. The approval request demands one. */
-    reason: string;
-    /** The approval request that wrote this row. Every row names one. */
-    approvalId: string;
-    createdBy: {
-        userId: string;
-        email: string;
-    };
-    createdAt: string;
-    /** When the override stops by itself. */
-    expiresAt: string;
-}
-/**
- * One flag, with everything a person needs to decide about it.
- *
- * The row carries the code value AND the effective value on purpose. A page
- * that showed only the effective value would hide the drift, which is the one
- * thing an override makes easy to lose.
- */
-export interface FeatureFlagRowDto {
-    flagPath: string;
-    label: string;
-    type: FeatureFlagType;
-    owner: string;
-    reason: string;
-    /** Whether an override can move this flag at all. */
-    overridable: boolean;
-    /** The date after which a `release` flag is late. */
-    expiresAt?: string;
-    /**
-     * What the code answers for the stage of this service, for NOBODY.
-     *
-     * The evaluation carries the stage alone: no email address and no
-     * organization id. A flag whose condition reads one of those answers
-     * something else for a real reader — `console.clusterSuspendButton` is
-     * `false` here on prod and `true` for a Camundi, and
-     * `console.privateLink87` is `false` here and `true` for an allowlisted
-     * organization.
-     *
-     * It is a BASELINE, and that is the right answer for this surface: one
-     * value that every reader of the page sees, which is what makes two
-     * Camundis able to talk about it. A per-viewer value would answer a
-     * different thing to each of them, and a per-organization value needs an
-     * organization that the route does not take.
-     */
-    codeValue: boolean;
-    /**
-     * The code rule of the flag: it is on when ANY condition matches.
-     *
-     * This is what `codeValue` cannot say. It names the stages, the email
-     * rules and the organization allowlist that decide the value for a real
-     * reader.
-     */
-    rule: FeatureFlagCondition[];
-    /**
-     * The code value on each known stage, for NOBODY.
-     *
-     * The same baseline as `codeValue`, for every stage and not only this one.
-     * It shows how far the flag stands on its rollout ladder.
-     */
-    codeValueByStage: Record<Stage, boolean>;
-    /**
-     * The baseline of `codeValue` with a live override in front of it.
-     *
-     * Same evaluation context, thus the same limit: it is what a reader with
-     * no email address and no organization gets. Use it to see the DRIFT
-     * between the store and the source, which is what this surface exists
-     * for, and not as the answer for one person.
-     */
-    effectiveValue: boolean;
-    /** Why `effectiveValue` is what it is. */
-    effectiveReason: FeatureFlagReason;
-    /** The live override of the stage, if there is one. */
-    stageOverride?: FeatureFlagOverrideDto;
-    /**
-     * How many live overrides name an organization.
-     *
-     * A COUNT, and not the rows. The rows carry an organization id, an email
-     * address and a reason for every organization that holds an override, and
-     * this answer has no page, thus it would grow with the number of customers
-     * and hand all of it to every reader. The page shows the number.
-     */
-    orgOverrideCount: number;
-}
-/** The answer of `GET /api/feature-flags`. */
-export interface FeatureFlagsDto {
-    /** The stage that this service runs on. It decides `codeValue`. */
-    stage: string;
-    /** The moment when the service built this answer. */
-    observedAt: string;
-    flags: FeatureFlagRowDto[];
-}
-/**
- * The permissions that one override payload needs, on top of nothing.
- *
- * It is here, and shared, because BOTH sides run it: `permissionsFor` of the
- * use case stores the answer on the row, and the dialog of control-frontend
- * passes the same answer to `canCreate`. Two copies of this rule would let a
- * button offer an override that the service then refuses with a 403.
- *
- * A prod stage override reaches every customer, thus it asks for the narrower
- * permission as well — to approve AND to ask.
- */
-export declare function featureFlagOverridePermissions(payload: {
-    scope: FeatureFlagOverrideScope;
-    target: string;
-}): string[];
-/**
- * The one written form of a target.
- *
- * A GUID reads the same in either case, and `ABC…` and `abc…` are the same
- * organization. The store and the resolver compare TEXT, so two forms of one
- * id would be two overrides: the unique index would allow both to be live,
- * and a row written in capitals would never match the id that a reader
- * carries. Everything that writes a target passes it through here first, so
- * only one form ever reaches the table.
- *
- * A stage name is lowercase already, thus this does not change one.
- */
-export declare function normalizeFeatureFlagOverrideTarget(target: string): string;
-/**
- * What is wrong with the target of an override, if anything.
- *
- * It answers `undefined` when the target is good, and a sentence for a person
- * when it is not.
- *
- * It is here, and shared, for the same reason as
- * `featureFlagOverridePermissions` above: BOTH sides run it. The dialog of
- * control-frontend keeps the button disabled while it answers, and the create
- * route of control-backend refuses the call. The dialog accepted any text
- * that was not empty before this, thus it offered `prod` on dev and
- * `not-an-org` as an organization, and both ended in a 400 after the person
- * had filled the whole form.
- *
- * TWO rules, and the first surprises people:
- *
- * 1. A stage override names THE STAGE OF THE SERVICE, and no other. Each
- *    deployed stage of control-backend holds its own database, thus an
- *    override written on dev reaches dev readers alone. A request for
- *    another stage would collect its approvals and move nothing.
- * 2. An org override names a GUID.
- */
-export declare function featureFlagOverrideTargetProblem(args: {
-    scope: FeatureFlagOverrideScope;
-    target: string;
-    /** The stage that the service runs on. `FeatureFlagsDto.stage` carries it. */
-    stage: string;
-}): string | undefined;
-/** The payload of a `feature-flag-override` approval request. */
-export interface FeatureFlagOverridePayloadDto {
-    flagPath: string;
-    scope: FeatureFlagOverrideScope;
-    target: string;
-    enabled: boolean;
-    /**
-     * How many days the override holds, from the moment the action RUNS.
-     *
-     * A number of days and not a date, for the same reason as `extend-trial`:
-     * days pass between the request and the run, and a stored date would lose
-     * part of its life while the request waited for its approvals.
-     */
-    days: number;
-}

package/dist/dtos/FeatureFlagOverride.dto.js

@@ -1,38 +0,0 @@
-import { AccountsPermissions } from "../permissions/accounts.permissions.js";
-const ACCOUNTS_CONTROL_FLAG_OVERRIDE = AccountsPermissions.CONTROL_FLAG_OVERRIDE;
-const ACCOUNTS_CONTROL_FLAG_OVERRIDE_PROD = AccountsPermissions.CONTROL_FLAG_OVERRIDE_PROD;
-const FEATURE_FLAG_OVERRIDE_SCOPES = ["stage", "org"];
-const FEATURE_FLAG_REASONS = [
-  "DEFAULT",
-  "OVERRIDE_STAGE",
-  "OVERRIDE_ORG",
-  "OVERRIDE_REFUSED"
-];
-const FEATURE_FLAG_TYPES = ["release", "ops", "perm"];
-function featureFlagOverridePermissions(payload) {
-  const base = [ACCOUNTS_CONTROL_FLAG_OVERRIDE];
-  return payload.scope === "stage" && payload.target === "prod" ? [...base, ACCOUNTS_CONTROL_FLAG_OVERRIDE_PROD] : base;
-}
-const GUID = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;
-function normalizeFeatureFlagOverrideTarget(target) {
-  return target.trim().toLowerCase();
-}
-function featureFlagOverrideTargetProblem(args) {
-  const target = normalizeFeatureFlagOverrideTarget(args.target);
-  if (target.length === 0) {
-    return args.scope === "stage" ? "Name the stage to move." : "Name the organization to move.";
-  }
-  if (args.scope === "stage") {
-    return target === args.stage ? void 0 : `This Camunda Control runs on ${args.stage} and can move only that stage. Open the request on the Camunda Control of ${target}.`;
-  }
-  return GUID.test(target) ? void 0 : "An organization id is a GUID, like 11111111-1111-1111-1111-111111111111.";
-}
-export {
-  FEATURE_FLAG_OVERRIDE_SCOPES,
-  FEATURE_FLAG_REASONS,
-  FEATURE_FLAG_TYPES,
-  featureFlagOverridePermissions,
-  featureFlagOverrideTargetProblem,
-  normalizeFeatureFlagOverrideTarget
-};
-//# sourceMappingURL=FeatureFlagOverride.dto.js.map

package/dist/dtos/FeatureFlagOverride.dto.js.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../src/dtos/FeatureFlagOverride.dto.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 { Stage } from '../constants/misc.const.js'\nimport { AccountsPermissions } from '../permissions/accounts.permissions.js'\n\nconst ACCOUNTS_CONTROL_FLAG_OVERRIDE = AccountsPermissions.CONTROL_FLAG_OVERRIDE\nconst ACCOUNTS_CONTROL_FLAG_OVERRIDE_PROD =\n  AccountsPermissions.CONTROL_FLAG_OVERRIDE_PROD\n\n/**\n * The wire shapes of the feature flag surface of control-backend.\n *\n * They are here and not in `@camunda-cloud/featureflags`, because\n * `@camunda/ccma-api` is published and cannot name a type from that private\n * package. The RULES stay there: `resolveFlag` decides a value, and\n * `FLAG_REGISTRY` holds the metadata. This file carries the answer over HTTP.\n *\n * `flagPath` is a `string` in every shape below. The typed `FlagPath` needs\n * `Features`, and a caller of the API names a flag that the SERVER validates\n * against its own registry. A type that the browser holds cannot do that job,\n * because the server can be older or newer than the bundle.\n */\n\n/** Which readers an override reaches. It is `FlagOverrideScope`. */\nexport const FEATURE_FLAG_OVERRIDE_SCOPES = ['stage', 'org'] as const\n\nexport type FeatureFlagOverrideScope =\n  (typeof FEATURE_FLAG_OVERRIDE_SCOPES)[number]\n\n/** Why a flag has the value that it has. It is `FlagReason`. */\nexport const FEATURE_FLAG_REASONS = [\n  'DEFAULT',\n  'OVERRIDE_STAGE',\n  'OVERRIDE_ORG',\n  'OVERRIDE_REFUSED',\n] as const\n\nexport type FeatureFlagReason = (typeof FEATURE_FLAG_REASONS)[number]\n\n/** How long a flag is meant to live. It is `FlagType`. */\nexport const FEATURE_FLAG_TYPES = ['release', 'ops', 'perm'] as const\n\nexport type FeatureFlagType = (typeof FEATURE_FLAG_TYPES)[number]\n\n/**\n * One condition of the code rule of a flag.\n *\n * The code rule is a LIST of these, and a reader gets the flag when ANY one\n * matches. An empty list is off for every reader. `FLAG_RULES` of\n * `@camunda-cloud/featureflags` holds the rules, and `defaults` evaluates the\n * same objects, thus the description cannot drift from the value.\n */\nexport type FeatureFlagCondition =\n  /** On for every reader. */\n  | { kind: 'always' }\n  /** On when the stage of the reader is one of `stages`. */\n  | { kind: 'stage'; stages: Stage[] }\n  /** On when the email address of the reader is a Camundi address. */\n  | { kind: 'camundiEmail' }\n  /** On when the email address of the reader has one of `domains`. */\n  | { kind: 'emailDomain'; domains: string[] }\n  /** On when the organization of the reader is one of `orgIds`. */\n  | { kind: 'org'; orgIds: string[] }\n\n/** One stored override, as a reader of the API sees it. */\nexport interface FeatureFlagOverrideDto {\n  id: string\n  flagPath: string\n  scope: FeatureFlagOverrideScope\n  /** The stage for `stage`, and the organization id for `org`. */\n  target: string\n  enabled: boolean\n  /** Why the person asked for it. The approval request demands one. */\n  reason: string\n  /** The approval request that wrote this row. Every row names one. */\n  approvalId: string\n  createdBy: { userId: string; email: string }\n  createdAt: string\n  /** When the override stops by itself. */\n  expiresAt: string\n}\n\n/**\n * One flag, with everything a person needs to decide about it.\n *\n * The row carries the code value AND the effective value on purpose. A page\n * that showed only the effective value would hide the drift, which is the one\n * thing an override makes easy to lose.\n */\nexport interface FeatureFlagRowDto {\n  flagPath: string\n  label: string\n  type: FeatureFlagType\n  owner: string\n  reason: string\n  /** Whether an override can move this flag at all. */\n  overridable: boolean\n  /** The date after which a `release` flag is late. */\n  expiresAt?: string\n  /**\n   * What the code answers for the stage of this service, for NOBODY.\n   *\n   * The evaluation carries the stage alone: no email address and no\n   * organization id. A flag whose condition reads one of those answers\n   * something else for a real reader \u2014 `console.clusterSuspendButton` is\n   * `false` here on prod and `true` for a Camundi, and\n   * `console.privateLink87` is `false` here and `true` for an allowlisted\n   * organization.\n   *\n   * It is a BASELINE, and that is the right answer for this surface: one\n   * value that every reader of the page sees, which is what makes two\n   * Camundis able to talk about it. A per-viewer value would answer a\n   * different thing to each of them, and a per-organization value needs an\n   * organization that the route does not take.\n   */\n  codeValue: boolean\n  /**\n   * The code rule of the flag: it is on when ANY condition matches.\n   *\n   * This is what `codeValue` cannot say. It names the stages, the email\n   * rules and the organization allowlist that decide the value for a real\n   * reader.\n   */\n  rule: FeatureFlagCondition[]\n  /**\n   * The code value on each known stage, for NOBODY.\n   *\n   * The same baseline as `codeValue`, for every stage and not only this one.\n   * It shows how far the flag stands on its rollout ladder.\n   */\n  codeValueByStage: Record<Stage, boolean>\n  /**\n   * The baseline of `codeValue` with a live override in front of it.\n   *\n   * Same evaluation context, thus the same limit: it is what a reader with\n   * no email address and no organization gets. Use it to see the DRIFT\n   * between the store and the source, which is what this surface exists\n   * for, and not as the answer for one person.\n   */\n  effectiveValue: boolean\n  /** Why `effectiveValue` is what it is. */\n  effectiveReason: FeatureFlagReason\n  /** The live override of the stage, if there is one. */\n  stageOverride?: FeatureFlagOverrideDto\n  /**\n   * How many live overrides name an organization.\n   *\n   * A COUNT, and not the rows. The rows carry an organization id, an email\n   * address and a reason for every organization that holds an override, and\n   * this answer has no page, thus it would grow with the number of customers\n   * and hand all of it to every reader. The page shows the number.\n   */\n  orgOverrideCount: number\n}\n\n/** The answer of `GET /api/feature-flags`. */\nexport interface FeatureFlagsDto {\n  /** The stage that this service runs on. It decides `codeValue`. */\n  stage: string\n  /** The moment when the service built this answer. */\n  observedAt: string\n  flags: FeatureFlagRowDto[]\n}\n\n/**\n * The permissions that one override payload needs, on top of nothing.\n *\n * It is here, and shared, because BOTH sides run it: `permissionsFor` of the\n * use case stores the answer on the row, and the dialog of control-frontend\n * passes the same answer to `canCreate`. Two copies of this rule would let a\n * button offer an override that the service then refuses with a 403.\n *\n * A prod stage override reaches every customer, thus it asks for the narrower\n * permission as well \u2014 to approve AND to ask.\n */\nexport function featureFlagOverridePermissions(payload: {\n  scope: FeatureFlagOverrideScope\n  target: string\n}): string[] {\n  const base = [ACCOUNTS_CONTROL_FLAG_OVERRIDE]\n  return payload.scope === 'stage' && payload.target === 'prod'\n    ? [...base, ACCOUNTS_CONTROL_FLAG_OVERRIDE_PROD]\n    : base\n}\n\n/**\n * A GUID, as the create route reads one.\n *\n * The server says `z.guid()`. This is the same shape for the browser, which\n * holds no zod: 8-4-4-4-12 hexadecimal characters.\n */\nconst GUID = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i\n\n/**\n * The one written form of a target.\n *\n * A GUID reads the same in either case, and `ABC\u2026` and `abc\u2026` are the same\n * organization. The store and the resolver compare TEXT, so two forms of one\n * id would be two overrides: the unique index would allow both to be live,\n * and a row written in capitals would never match the id that a reader\n * carries. Everything that writes a target passes it through here first, so\n * only one form ever reaches the table.\n *\n * A stage name is lowercase already, thus this does not change one.\n */\nexport function normalizeFeatureFlagOverrideTarget(target: string): string {\n  return target.trim().toLowerCase()\n}\n\n/**\n * What is wrong with the target of an override, if anything.\n *\n * It answers `undefined` when the target is good, and a sentence for a person\n * when it is not.\n *\n * It is here, and shared, for the same reason as\n * `featureFlagOverridePermissions` above: BOTH sides run it. The dialog of\n * control-frontend keeps the button disabled while it answers, and the create\n * route of control-backend refuses the call. The dialog accepted any text\n * that was not empty before this, thus it offered `prod` on dev and\n * `not-an-org` as an organization, and both ended in a 400 after the person\n * had filled the whole form.\n *\n * TWO rules, and the first surprises people:\n *\n * 1. A stage override names THE STAGE OF THE SERVICE, and no other. Each\n *    deployed stage of control-backend holds its own database, thus an\n *    override written on dev reaches dev readers alone. A request for\n *    another stage would collect its approvals and move nothing.\n * 2. An org override names a GUID.\n */\nexport function featureFlagOverrideTargetProblem(args: {\n  scope: FeatureFlagOverrideScope\n  target: string\n  /** The stage that the service runs on. `FeatureFlagsDto.stage` carries it. */\n  stage: string\n}): string | undefined {\n  const target = normalizeFeatureFlagOverrideTarget(args.target)\n  if (target.length === 0) {\n    return args.scope === 'stage'\n      ? 'Name the stage to move.'\n      : 'Name the organization to move.'\n  }\n  if (args.scope === 'stage') {\n    return target === args.stage\n      ? undefined\n      : `This Camunda Control runs on ${args.stage} and can move only that ` +\n          `stage. Open the request on the Camunda Control of ${target}.`\n  }\n  return GUID.test(target)\n    ? undefined\n    : 'An organization id is a GUID, like 11111111-1111-1111-1111-111111111111.'\n}\n\n/** The payload of a `feature-flag-override` approval request. */\nexport interface FeatureFlagOverridePayloadDto {\n  flagPath: string\n  scope: FeatureFlagOverrideScope\n  target: string\n  enabled: boolean\n  /**\n   * How many days the override holds, from the moment the action RUNS.\n   *\n   * A number of days and not a date, for the same reason as `extend-trial`:\n   * days pass between the request and the run, and a stored date would lose\n   * part of its life while the request waited for its approvals.\n   */\n  days: number\n}\n"],
-  "mappings": "AAOA,SAAS,2BAA2B;AAEpC,MAAM,iCAAiC,oBAAoB;AAC3D,MAAM,sCACJ,oBAAoB;AAiBf,MAAM,+BAA+B,CAAC,SAAS,KAAK;AAMpD,MAAM,uBAAuB;AAAA,EAClC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAKO,MAAM,qBAAqB,CAAC,WAAW,OAAO,MAAM;AAuIpD,SAAS,+BAA+B,SAGlC;AACX,QAAM,OAAO,CAAC,8BAA8B;AAC5C,SAAO,QAAQ,UAAU,WAAW,QAAQ,WAAW,SACnD,CAAC,GAAG,MAAM,mCAAmC,IAC7C;AACN;AAQA,MAAM,OAAO;AAcN,SAAS,mCAAmC,QAAwB;AACzE,SAAO,OAAO,KAAK,EAAE,YAAY;AACnC;AAwBO,SAAS,iCAAiC,MAK1B;AACrB,QAAM,SAAS,mCAAmC,KAAK,MAAM;AAC7D,MAAI,OAAO,WAAW,GAAG;AACvB,WAAO,KAAK,UAAU,UAClB,4BACA;AAAA,EACN;AACA,MAAI,KAAK,UAAU,SAAS;AAC1B,WAAO,WAAW,KAAK,QACnB,SACA,gCAAgC,KAAK,KAAK,6EACa,MAAM;AAAA,EACnE;AACA,SAAO,KAAK,KAAK,MAAM,IACnB,SACA;AACN;",
-  "names": []
-}