@camunda/ccma-shared-types 1.1.0 → 2.0.0

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

@@ -0,0 +1,83 @@
+/**
+ * The wire types of the generic approval mechanism.
+ *
+ * This file holds no logic and no dependency, because three consumers read it:
+ * control-backend, control-frontend and cloudbot. The rules that read these
+ * types are in `../approvals/policy.js`, and they are pure for the same reason.
+ */
+/**
+ * Every state that an approval request can hold.
+ *
+ * A `const` tuple, not an enum, so it is both the union type and the list that
+ * validates a status filter at run time.
+ *
+ * The path of a request: `pending` until it reaches the threshold. Then
+ * `executing` (automatic mode) or `approved` (explicit mode, which waits for a
+ * person to press the button). `executed` or `failed` after the action ran. A
+ * request that never reaches the threshold ends `rejected`, `withdrawn` or
+ * `expired`.
+ */
+export declare const APPROVAL_JOB_STATUSES: readonly ["pending", "approved", "executing", "executed", "failed", "rejected", "withdrawn", "expired"];
+export type ApprovalJobStatus = (typeof APPROVAL_JOB_STATUSES)[number];
+/**
+ * What happens when a request reaches its threshold.
+ *
+ * `auto` runs the action immediately. `explicit` holds the request at
+ * `approved` and waits for a person to run it.
+ */
+export type ApprovalExecutionMode = 'auto' | 'explicit';
+/**
+ * A person, as an approval request records them.
+ *
+ * Both keys are kept. The machine then never has to choose one identity key,
+ * which is what split the earlier acknowledgement flows: some held an email and
+ * some held a user id, and the two could not be compared.
+ */
+export interface ApprovalActor {
+    userId: string;
+    email: string;
+}
+export interface ApprovalAck extends ApprovalActor {
+    /** An ISO timestamp. It is in a json column, so it is a string, not a Date. */
+    date: string;
+}
+/** One approval request, as the API returns it. */
+export interface ApprovalJobDto {
+    id: string;
+    type: string;
+    dedupeKey?: string;
+    payload: Record<string, unknown>;
+    createdBy: ApprovalActor;
+    acks: ApprovalAck[];
+    /** Copied from the use case, so a reader can render "1 of 2". */
+    requiredAcks: number;
+    executionMode: ApprovalExecutionMode;
+    status: ApprovalJobStatus;
+    closedBy?: ApprovalActor;
+    closedReason?: string;
+    /** An ISO timestamp. */
+    expiresAt: string;
+    executedAt?: string;
+    executionError?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * What a use case is, as the API reports it.
+ *
+ * The frontend needs `requiredPermission` to run the same rule as the backend.
+ * PR #9301 kept this registry a second time, by hand, in the frontend. A
+ * registry that the server owns means a new use case needs no frontend deploy.
+ */
+export interface ApprovalUseCaseDto {
+    type: string;
+    /** A short name for a person to read. */
+    label: string;
+    requiredAcks: number;
+    ttlDays: number;
+    executionMode: ApprovalExecutionMode;
+    /** The permission that acknowledge, reject and run all need. */
+    requiredPermission: string;
+    /** The permission to open a request. Absent means any signed-in user. */
+    createPermission?: string;
+}

package/dist/dtos/ApprovalJob.dto.js

@@ -0,0 +1,14 @@
+const APPROVAL_JOB_STATUSES = [
+  "pending",
+  "approved",
+  "executing",
+  "executed",
+  "failed",
+  "rejected",
+  "withdrawn",
+  "expired"
+];
+export {
+  APPROVAL_JOB_STATUSES
+};
+//# sourceMappingURL=ApprovalJob.dto.js.map

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

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/dtos/ApprovalJob.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\n/**\n * The wire types of the generic approval mechanism.\n *\n * This file holds no logic and no dependency, because three consumers read it:\n * control-backend, control-frontend and cloudbot. The rules that read these\n * types are in `../approvals/policy.js`, and they are pure for the same reason.\n */\n\n/**\n * Every state that an approval request can hold.\n *\n * A `const` tuple, not an enum, so it is both the union type and the list that\n * validates a status filter at run time.\n *\n * The path of a request: `pending` until it reaches the threshold. Then\n * `executing` (automatic mode) or `approved` (explicit mode, which waits for a\n * person to press the button). `executed` or `failed` after the action ran. A\n * request that never reaches the threshold ends `rejected`, `withdrawn` or\n * `expired`.\n */\nexport const APPROVAL_JOB_STATUSES = [\n  'pending',\n  'approved',\n  'executing',\n  'executed',\n  'failed',\n  'rejected',\n  'withdrawn',\n  'expired',\n] as const\n\nexport type ApprovalJobStatus = (typeof APPROVAL_JOB_STATUSES)[number]\n\n/**\n * What happens when a request reaches its threshold.\n *\n * `auto` runs the action immediately. `explicit` holds the request at\n * `approved` and waits for a person to run it.\n */\nexport type ApprovalExecutionMode = 'auto' | 'explicit'\n\n/**\n * A person, as an approval request records them.\n *\n * Both keys are kept. The machine then never has to choose one identity key,\n * which is what split the earlier acknowledgement flows: some held an email and\n * some held a user id, and the two could not be compared.\n */\nexport interface ApprovalActor {\n  userId: string\n  email: string\n}\n\nexport interface ApprovalAck extends ApprovalActor {\n  /** An ISO timestamp. It is in a json column, so it is a string, not a Date. */\n  date: string\n}\n\n/** One approval request, as the API returns it. */\nexport interface ApprovalJobDto {\n  id: string\n  type: string\n  dedupeKey?: string\n  payload: Record<string, unknown>\n  createdBy: ApprovalActor\n  acks: ApprovalAck[]\n  /** Copied from the use case, so a reader can render \"1 of 2\". */\n  requiredAcks: number\n  executionMode: ApprovalExecutionMode\n  status: ApprovalJobStatus\n  closedBy?: ApprovalActor\n  closedReason?: string\n  /** An ISO timestamp. */\n  expiresAt: string\n  executedAt?: string\n  executionError?: string\n  createdAt: string\n  updatedAt: string\n}\n\n/**\n * What a use case is, as the API reports it.\n *\n * The frontend needs `requiredPermission` to run the same rule as the backend.\n * PR #9301 kept this registry a second time, by hand, in the frontend. A\n * registry that the server owns means a new use case needs no frontend deploy.\n */\nexport interface ApprovalUseCaseDto {\n  type: string\n  /** A short name for a person to read. */\n  label: string\n  requiredAcks: number\n  ttlDays: number\n  executionMode: ApprovalExecutionMode\n  /** The permission that acknowledge, reject and run all need. */\n  requiredPermission: string\n  /** The permission to open a request. Absent means any signed-in user. */\n  createPermission?: string\n}\n"],
+  "mappings": "AA0BO,MAAM,wBAAwB;AAAA,EACnC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;",
+  "names": []
+}

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

@@ -0,0 +1,96 @@
+/**
+ * Cluster settings for which an organization can hold a default value.
+ *
+ * A field that is absent keeps the value that the `Cluster` constructor
+ * writes. The defaults apply at creation only: they seed the new row, and
+ * nothing applies them again. A cluster that exists keeps its own values.
+ *
+ * A value on the cluster changes afterwards through the surface of that
+ * setting, with the permissions of that setting — thus the customer changes
+ * most of them alone, and a Camunda-managed setting such as the optional
+ * telemetry needs a Camundi (#9732).
+ */
+export interface ClusterCreationDefaults {
+    autoUpdate?: boolean;
+    businessIdUniquenessEnabled?: boolean;
+    enforceGroups?: boolean;
+    mcpEnabled?: boolean;
+    multiTenancyEnabled?: boolean;
+    optionalTelemetryEnabled?: boolean;
+    rba?: boolean;
+    sessionHeartbeatEnabled?: boolean;
+    sessionMaxInactiveIntervalMinutes?: number;
+}
+export type ClusterCreationDefaultKey = keyof ClusterCreationDefaults;
+/**
+ * Who can write the default of a field today.
+ *
+ * - `planned`: nobody. The backend accepts the field, and Control shows the
+ *   row without a control. The mechanism is there, and the field waits for
+ *   the team that owns the setting.
+ * - `control`: a Camundi in Control, after a support request.
+ * - `customer`: a Camundi in Control, and the organization itself in the
+ *   Console settings.
+ *
+ * The accounts route refuses what this value does not permit, thus a widened
+ * value is the whole rollout of a field.
+ */
+export type ClusterCreationDefaultAvailability = 'planned' | 'control' | 'customer';
+export interface ClusterCreationDefaultField {
+    key: ClusterCreationDefaultKey;
+    /** Name of the field on the Control panel. */
+    label: string;
+    kind: 'boolean' | 'number';
+    availability: ClusterCreationDefaultAvailability;
+    /**
+     * Value that a new cluster gets when the organization holds no default.
+     * It must agree with the `Cluster` constructor, because the panel shows it
+     * as the value that applies.
+     */
+    fallback: boolean | number;
+    /** Bounds of a number field. They mirror the operator CRD validation. */
+    min?: number;
+    max?: number;
+    /**
+     * Console permissions that permit a write of this default. The user needs
+     * ALL of them, in addition to the base permission of the route.
+     *
+     * Each path is a path into `ConsolePermissions.Features`. The frontend adds
+     * the `console.` prefix that the session endpoint uses; the backend reads
+     * the path from `res.locals.permissions`.
+     *
+     * A field without a list is a setting that the customer can change without
+     * help. The default of such a field gives no more power than the customer
+     * has, thus the base permission is sufficient.
+     *
+     * The per-cluster route of a setting can ask for a different permission for
+     * each direction — `autoUpdate` is such a route. A default holds both
+     * directions over time, and one entry cannot say which, thus the list asks
+     * for all permissions of that route. The default is then never easier to
+     * write than the setting itself.
+     */
+    permissionAllOf?: readonly string[];
+    /**
+     * Permissions of accounts that a Camundi needs for this field, in addition
+     * to the permission of the route. The user needs ALL of them.
+     *
+     * Each path is a path into `AccountsPermissions.Features`. The frontend
+     * reads the path as it is, because the session endpoint carries the
+     * accounts keys without a prefix.
+     *
+     * The permission of the route is `admin.readAll`, which is a read
+     * permission that many roles hold. A field that a Camundi may write names
+     * the write permission here, thus the read of the surface and the write of
+     * a value stay two different questions.
+     */
+    accountsPermissionAllOf?: readonly string[];
+}
+/**
+ * The defaultable fields, in the order that the Control panel shows them.
+ *
+ * This list is the only place that knows a field is defaultable. The route
+ * builds its validation from it, the creation path reads it to merge, and the
+ * panel builds its controls from it. A new cluster setting becomes
+ * defaultable through one entry here.
+ */
+export declare const CLUSTER_CREATION_DEFAULT_FIELDS: readonly ClusterCreationDefaultField[];

package/dist/dtos/ClusterCreationDefaults.dto.js

@@ -0,0 +1,93 @@
+const CLUSTER_CREATION_DEFAULT_FIELDS = [
+  {
+    key: "optionalTelemetryEnabled",
+    label: "Optional telemetry",
+    kind: "boolean",
+    // Camunda-managed: the customer asked for a toggle, and the answer is
+    // a support request. The org default follows that rule.
+    availability: "control",
+    fallback: true,
+    permissionAllOf: ["clusters.canUpdateOptionalTelemetry"]
+  },
+  {
+    key: "sessionMaxInactiveIntervalMinutes",
+    label: "Session idle timeout (minutes)",
+    kind: "number",
+    // The first field that the organization sets itself. A security
+    // posture is the reason for an org-wide idle timeout, and the customer
+    // owns that posture.
+    availability: "customer",
+    // The same permission that a limit of the organization asks for. A
+    // default of a cluster setting is org-wide configuration, thus it
+    // follows the Limits tab and not the read permission of the route.
+    accountsPermissionAllOf: ["admin.mayChangeOrgLimits"],
+    fallback: 30,
+    min: 1,
+    max: 1440
+  },
+  {
+    key: "sessionHeartbeatEnabled",
+    availability: "planned",
+    label: "Session heartbeat",
+    kind: "boolean",
+    fallback: false
+  },
+  {
+    key: "multiTenancyEnabled",
+    availability: "planned",
+    label: "Multi-tenancy",
+    kind: "boolean",
+    fallback: false
+  },
+  {
+    key: "rba",
+    availability: "planned",
+    label: "Resource-based authorizations",
+    kind: "boolean",
+    fallback: false
+  },
+  {
+    key: "enforceGroups",
+    availability: "planned",
+    label: "Enforce groups",
+    kind: "boolean",
+    fallback: true
+  },
+  {
+    key: "mcpEnabled",
+    availability: "planned",
+    label: "MCP",
+    kind: "boolean",
+    fallback: false
+  },
+  {
+    key: "businessIdUniquenessEnabled",
+    availability: "planned",
+    label: "Business ID uniqueness",
+    kind: "boolean",
+    fallback: false
+  },
+  {
+    key: "autoUpdate",
+    availability: "planned",
+    label: "Auto-update",
+    kind: "boolean",
+    // The creation path resolves an absent value to false, and the channel
+    // condition can still remove it: a cluster on a channel that is not
+    // Stable never gets auto-update. The `true` of the `Cluster`
+    // constructor never applies here, because every caller of
+    // `createNewCluster` gives the field a value.
+    fallback: false,
+    // The per-cluster route asks for `canSendToSleep` to turn auto-update
+    // off and for `canUpgradeGenerationYolo` to turn it on. A default holds
+    // both directions, thus it asks for both permissions.
+    permissionAllOf: [
+      "clusters.canSendToSleep",
+      "clusters.canUpgradeGenerationYolo"
+    ]
+  }
+];
+export {
+  CLUSTER_CREATION_DEFAULT_FIELDS
+};
+//# sourceMappingURL=ClusterCreationDefaults.dto.js.map

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

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/dtos/ClusterCreationDefaults.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\n/**\n * Cluster settings for which an organization can hold a default value.\n *\n * A field that is absent keeps the value that the `Cluster` constructor\n * writes. The defaults apply at creation only: they seed the new row, and\n * nothing applies them again. A cluster that exists keeps its own values.\n *\n * A value on the cluster changes afterwards through the surface of that\n * setting, with the permissions of that setting \u2014 thus the customer changes\n * most of them alone, and a Camunda-managed setting such as the optional\n * telemetry needs a Camundi (#9732).\n */\nexport interface ClusterCreationDefaults {\n  autoUpdate?: boolean\n  businessIdUniquenessEnabled?: boolean\n  enforceGroups?: boolean\n  mcpEnabled?: boolean\n  multiTenancyEnabled?: boolean\n  optionalTelemetryEnabled?: boolean\n  rba?: boolean\n  sessionHeartbeatEnabled?: boolean\n  sessionMaxInactiveIntervalMinutes?: number\n}\n\nexport type ClusterCreationDefaultKey = keyof ClusterCreationDefaults\n\n/**\n * Who can write the default of a field today.\n *\n * - `planned`: nobody. The backend accepts the field, and Control shows the\n *   row without a control. The mechanism is there, and the field waits for\n *   the team that owns the setting.\n * - `control`: a Camundi in Control, after a support request.\n * - `customer`: a Camundi in Control, and the organization itself in the\n *   Console settings.\n *\n * The accounts route refuses what this value does not permit, thus a widened\n * value is the whole rollout of a field.\n */\nexport type ClusterCreationDefaultAvailability =\n  | 'planned'\n  | 'control'\n  | 'customer'\n\nexport interface ClusterCreationDefaultField {\n  key: ClusterCreationDefaultKey\n  /** Name of the field on the Control panel. */\n  label: string\n  kind: 'boolean' | 'number'\n  availability: ClusterCreationDefaultAvailability\n  /**\n   * Value that a new cluster gets when the organization holds no default.\n   * It must agree with the `Cluster` constructor, because the panel shows it\n   * as the value that applies.\n   */\n  fallback: boolean | number\n  /** Bounds of a number field. They mirror the operator CRD validation. */\n  min?: number\n  max?: number\n  /**\n   * Console permissions that permit a write of this default. The user needs\n   * ALL of them, in addition to the base permission of the route.\n   *\n   * Each path is a path into `ConsolePermissions.Features`. The frontend adds\n   * the `console.` prefix that the session endpoint uses; the backend reads\n   * the path from `res.locals.permissions`.\n   *\n   * A field without a list is a setting that the customer can change without\n   * help. The default of such a field gives no more power than the customer\n   * has, thus the base permission is sufficient.\n   *\n   * The per-cluster route of a setting can ask for a different permission for\n   * each direction \u2014 `autoUpdate` is such a route. A default holds both\n   * directions over time, and one entry cannot say which, thus the list asks\n   * for all permissions of that route. The default is then never easier to\n   * write than the setting itself.\n   */\n  permissionAllOf?: readonly string[]\n  /**\n   * Permissions of accounts that a Camundi needs for this field, in addition\n   * to the permission of the route. The user needs ALL of them.\n   *\n   * Each path is a path into `AccountsPermissions.Features`. The frontend\n   * reads the path as it is, because the session endpoint carries the\n   * accounts keys without a prefix.\n   *\n   * The permission of the route is `admin.readAll`, which is a read\n   * permission that many roles hold. A field that a Camundi may write names\n   * the write permission here, thus the read of the surface and the write of\n   * a value stay two different questions.\n   */\n  accountsPermissionAllOf?: readonly string[]\n}\n\n/**\n * The defaultable fields, in the order that the Control panel shows them.\n *\n * This list is the only place that knows a field is defaultable. The route\n * builds its validation from it, the creation path reads it to merge, and the\n * panel builds its controls from it. A new cluster setting becomes\n * defaultable through one entry here.\n */\nexport const CLUSTER_CREATION_DEFAULT_FIELDS: readonly ClusterCreationDefaultField[] =\n  [\n    {\n      key: 'optionalTelemetryEnabled',\n      label: 'Optional telemetry',\n      kind: 'boolean',\n      // Camunda-managed: the customer asked for a toggle, and the answer is\n      // a support request. The org default follows that rule.\n      availability: 'control',\n      fallback: true,\n      permissionAllOf: ['clusters.canUpdateOptionalTelemetry'],\n    },\n    {\n      key: 'sessionMaxInactiveIntervalMinutes',\n      label: 'Session idle timeout (minutes)',\n      kind: 'number',\n      // The first field that the organization sets itself. A security\n      // posture is the reason for an org-wide idle timeout, and the customer\n      // owns that posture.\n      availability: 'customer',\n      // The same permission that a limit of the organization asks for. A\n      // default of a cluster setting is org-wide configuration, thus it\n      // follows the Limits tab and not the read permission of the route.\n      accountsPermissionAllOf: ['admin.mayChangeOrgLimits'],\n      fallback: 30,\n      min: 1,\n      max: 1440,\n    },\n    {\n      key: 'sessionHeartbeatEnabled',\n      availability: 'planned',\n      label: 'Session heartbeat',\n      kind: 'boolean',\n      fallback: false,\n    },\n    {\n      key: 'multiTenancyEnabled',\n      availability: 'planned',\n      label: 'Multi-tenancy',\n      kind: 'boolean',\n      fallback: false,\n    },\n    {\n      key: 'rba',\n      availability: 'planned',\n      label: 'Resource-based authorizations',\n      kind: 'boolean',\n      fallback: false,\n    },\n    {\n      key: 'enforceGroups',\n      availability: 'planned',\n      label: 'Enforce groups',\n      kind: 'boolean',\n      fallback: true,\n    },\n    {\n      key: 'mcpEnabled',\n      availability: 'planned',\n      label: 'MCP',\n      kind: 'boolean',\n      fallback: false,\n    },\n    {\n      key: 'businessIdUniquenessEnabled',\n      availability: 'planned',\n      label: 'Business ID uniqueness',\n      kind: 'boolean',\n      fallback: false,\n    },\n    {\n      key: 'autoUpdate',\n      availability: 'planned',\n      label: 'Auto-update',\n      kind: 'boolean',\n      // The creation path resolves an absent value to false, and the channel\n      // condition can still remove it: a cluster on a channel that is not\n      // Stable never gets auto-update. The `true` of the `Cluster`\n      // constructor never applies here, because every caller of\n      // `createNewCluster` gives the field a value.\n      fallback: false,\n      // The per-cluster route asks for `canSendToSleep` to turn auto-update\n      // off and for `canUpgradeGenerationYolo` to turn it on. A default holds\n      // both directions, thus it asks for both permissions.\n      permissionAllOf: [\n        'clusters.canSendToSleep',\n        'clusters.canUpgradeGenerationYolo',\n      ],\n    },\n  ]\n"],
+  "mappings": "AA4GO,MAAM,kCACX;AAAA,EACE;AAAA,IACE,KAAK;AAAA,IACL,OAAO;AAAA,IACP,MAAM;AAAA;AAAA;AAAA,IAGN,cAAc;AAAA,IACd,UAAU;AAAA,IACV,iBAAiB,CAAC,qCAAqC;AAAA,EACzD;AAAA,EACA;AAAA,IACE,KAAK;AAAA,IACL,OAAO;AAAA,IACP,MAAM;AAAA;AAAA;AAAA;AAAA,IAIN,cAAc;AAAA;AAAA;AAAA;AAAA,IAId,yBAAyB,CAAC,0BAA0B;AAAA,IACpD,UAAU;AAAA,IACV,KAAK;AAAA,IACL,KAAK;AAAA,EACP;AAAA,EACA;AAAA,IACE,KAAK;AAAA,IACL,cAAc;AAAA,IACd,OAAO;AAAA,IACP,MAAM;AAAA,IACN,UAAU;AAAA,EACZ;AAAA,EACA;AAAA,IACE,KAAK;AAAA,IACL,cAAc;AAAA,IACd,OAAO;AAAA,IACP,MAAM;AAAA,IACN,UAAU;AAAA,EACZ;AAAA,EACA;AAAA,IACE,KAAK;AAAA,IACL,cAAc;AAAA,IACd,OAAO;AAAA,IACP,MAAM;AAAA,IACN,UAAU;AAAA,EACZ;AAAA,EACA;AAAA,IACE,KAAK;AAAA,IACL,cAAc;AAAA,IACd,OAAO;AAAA,IACP,MAAM;AAAA,IACN,UAAU;AAAA,EACZ;AAAA,EACA;AAAA,IACE,KAAK;AAAA,IACL,cAAc;AAAA,IACd,OAAO;AAAA,IACP,MAAM;AAAA,IACN,UAAU;AAAA,EACZ;AAAA,EACA;AAAA,IACE,KAAK;AAAA,IACL,cAAc;AAAA,IACd,OAAO;AAAA,IACP,MAAM;AAAA,IACN,UAAU;AAAA,EACZ;AAAA,EACA;AAAA,IACE,KAAK;AAAA,IACL,cAAc;AAAA,IACd,OAAO;AAAA,IACP,MAAM;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAMN,UAAU;AAAA;AAAA;AAAA;AAAA,IAIV,iBAAiB;AAAA,MACf;AAAA,MACA;AAAA,IACF;AAAA,EACF;AACF;",
+  "names": []
+}

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

@@ -162,6 +162,7 @@ export interface CommonClusterDto {
         optimizeEnabled?: boolean;
         optimizeFiltering?: OptimizeFilteringConfig;
         secretsFilterMode?: SecretsFilterMode;
+        nonSpotNodesEnabled?: boolean;
     };
     rba?: boolean;
     identityBackendChecksEnabled?: boolean;

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

@@ -1,4 +1,5 @@
 import type { SalesPlanType } from '../types/SalesPlanType.type.js';
+import type { LicensingModelType } from './Organization.dto.js';
 /** Generic cursor-paginated response. `nextCursor === null` on the last page. */
 export interface CursorPage<T> {
     items: T[];
@@ -42,6 +43,19 @@ export interface OrgListItemV2Dto {
     /** Concrete plan name (`SalesPlan.name`), distinct from the tier `salesPlanType`. */
     salesPlanName?: string;
     salesForceId?: string;
+    /** ISO-8601 end of the trial, when the org is or was on a trial plan. */
+    trialExpiresAt?: string;
+    /**
+     * Persisted trial state: `true` when the trial ran out, `false` while it
+     * runs. Absent when the org is not on a trial plan or the state is not set.
+     */
+    trialExpired?: boolean;
+    /** Org metadata flag: the org can only create clusters on AWS. */
+    awsOnly?: boolean;
+    /** Org metadata flag: enterprise plan limited to development use. */
+    enterpriseDevOnly?: boolean;
+    /** Org metadata: which licensing model prices the org. */
+    licensingModel?: LicensingModelType;
 }
 export interface ListOrganizationsV2Params extends CursorParams {
     q?: string;
@@ -129,9 +143,64 @@ export interface ClusterListItemV2Dto {
     channel?: string;
     /** ISO-8601; part of the cursor key. */
     created: string;
+    /**
+     * ISO-8601 instant of the last suspend. Absent when the cluster is awake:
+     * `Cluster.wakeUp()` clears the column, thus this is the time since the last
+     * suspend and not the total time that the cluster was asleep.
+     */
+    suspendedAt?: string;
 }
 /** Detail extends the list shape; richer fields are added in Phase 3. */
 export type ClusterDetailV2Dto = ClusterListItemV2Dto;
+/**
+ * How much work a cluster did, inside the 30-day activity window.
+ *
+ * `idle` and `unknown` are different facts and must stay apart. `idle` is
+ * evidence that the cluster did no work. `unknown` is the absence of
+ * evidence: on the dev stage most clusters have no row at all.
+ *
+ * The source is the Holistic Data Platform (HDP), which holds one row per
+ * cluster, per day, per value metric. The window is 30 days, thus a bucket
+ * for "did work, but more than 30 days ago" is not possible.
+ */
+export type ClusterActivityBucket = 
+/** Work inside the 30-day window. */
+'active'
+/** Rows exist inside the window. All values are zero. */
+ | 'idle'
+/** No row at all inside the window. */
+ | 'unknown';
+/** Quick-filter tiles on the clusters list. */
+export type ClusterActivityTile = 'all' | 'active' | 'idle' | 'unknown'
+/** More than 90 days old, and not active. */
+ | 'old-idle'
+/** No more than 30 days old, with no work and no data. */
+ | 'new-idle';
+export interface ClusterActivityV2Dto {
+    clusterId: string;
+    /**
+     * ISO-8601 instant of the last UTC day with work. HDP buckets by day, thus
+     * the time part is always midnight. Absent when the cluster did no work
+     * inside the window.
+     */
+    lastActiveAt?: string;
+    processInstances30d: number;
+    bucket: ClusterActivityBucket;
+}
+export interface ClusterActivityV2Response {
+    /**
+     * One entry per live cluster that has an HDP row inside the window. A
+     * cluster in the `unknown` bucket has no entry, because the bucket means
+     * that no row exists.
+     */
+    items: ClusterActivityV2Dto[];
+    /** Fleet-wide tile counts. The server joins `cluster.created` for the age tiles. */
+    counts: Record<ClusterActivityTile, number>;
+    /** ISO-8601 instant when the server assembled this response. */
+    fetchedAt: string;
+    /** The number of days that the window covers. */
+    windowDays: number;
+}
 export interface ListClustersV2Params extends CursorParams {
     q?: string;
     /**
@@ -207,8 +276,41 @@ export interface ListClustersV2Params extends CursorParams {
         minorVersion?: string;
         /** Restrict to these release channel names. */
         channels?: string[];
-        /** ISO-8601 lower bound on `created` (e.g. "created in the last 7 days"). */
+        /**
+         * ISO-8601 lower bound on `created` (e.g. "created in the last 7 days").
+         * Inclusive: a cluster created at this instant matches.
+         */
         createdAfter?: string;
+        /**
+         * ISO-8601 upper bound on `created`. Pairs with `createdAfter` for the
+         * age axis. Exclusive: a cluster created at this instant does not match.
+         */
+        createdBefore?: string;
+        /**
+         * ISO-8601 upper bound on `suspendedAt`, thus "asleep since at least N
+         * days". Exclusive, as `createdBefore` is. A cluster that is awake never
+         * matches: `Cluster.wakeUp()` clears the column.
+         *
+         * The bound is the time since the last suspend. A cluster that woke up for
+         * one minute and then slept again starts from zero, thus this filter finds
+         * the clusters that nobody touched, not the clusters that did no work.
+         */
+        suspendedBefore?: string;
+        /**
+         * ISO-8601 lower bound on `suspendedAt`, thus "asleep for not more than N
+         * days". Inclusive, as `createdAfter` is. It makes the suspension-age
+         * range together with `suspendedBefore`.
+         *
+         * A cluster that is awake never matches, for the same reason as
+         * `suspendedBefore`.
+         */
+        suspendedAfter?: string;
+        /**
+         * Restrict to these activity buckets. The controller resolves the buckets
+         * to a cluster id set from the cached HDP activity map, the same way
+         * `filter.status` resolves K8s state to a cluster id set.
+         */
+        activity?: ClusterActivityBucket[];
     };
 }
 export interface ClusterParameterOptionV2Dto {

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

@@ -9,7 +9,7 @@
  * from there. `@camunda-cloud/featureflags` re-exports `Features` from here.
  * Thus the type has one definition, and every existing import path still works.
  *
- * A c4 host reads one flag with `useC4FeatureFlag('console.optionalTelemetry')`
+ * A c4 host reads one flag with `useC4FeatureFlag('console.appIntegrations')`
  * — a dot path into this object.
  */
 export interface Features {
@@ -25,16 +25,18 @@ export interface Features {
         byoidp: boolean;
         optimizeUnsetOnDisable: boolean;
         appIntegrations: boolean;
-        optionalTelemetry: boolean;
+        orgClusterDefaults: boolean;
         releaseTrainSanityFix: boolean;
         hubHelpCenterLinks: boolean;
         legacyModelerApiNaming: boolean;
         backupScheduleApi: boolean;
         clusterCreationBlocked: boolean;
         deferSpecChangeWhileAsleep: boolean;
+        clusterDuplication: boolean;
     };
     control: {
         frontendTelemetry: boolean;
+        sendToExpiredTrialApproval: boolean;
     };
     accounts: {
         moveClusterOrg: boolean;

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

@@ -30,3 +30,13 @@ export declare function sortGenerationBySemverOfZeebe(generationA: {
         zeebe: string;
     };
 }): number;
+/**
+ * Orders generation names by product, then newest first within a product, by
+ * numeric collation: `8.10` comes before `8.9`, and `gen10` before `gen9`.
+ * Products stay in alphabetic order, so the Camunda generations come before
+ * the older Zeebe ones. A release comes before its prereleases, so
+ * `8.10.0` is above `8.10.0-alpha1`. For a list that has no zeebe image to
+ * compare, such as a filter facet. When the image is known, use
+ * `sortGenerationBySemverOfZeebe`.
+ */
+export declare const compareGenerationNamesNewestFirst: (nameA: string, nameB: string) => number;

package/dist/dtos/Generations.dto.js

@@ -14,16 +14,50 @@ function sortGenerationBySemverOfZeebe(generationA, generationB) {
     if (byVersion !== 0) {
       return byVersion;
     }
-    return secfixRank(zeebeB) - secfixRank(zeebeA);
+    const bySecfix = secfixRank(zeebeB) - secfixRank(zeebeA);
+    if (bySecfix !== 0) {
+      return bySecfix;
+    }
+    return compareGenerationNamesNewestFirst(generationA.name, generationB.name);
   } else if (versionAvalid) {
     return -1;
   } else if (versionBvalid) {
     return 1;
   } else {
-    return generationB.name.localeCompare(generationA.name);
+    return compareGenerationNamesNewestFirst(generationA.name, generationB.name);
   }
 }
+const productPrefix = (name) => {
+  const firstDigit = name.search(/\d/);
+  return firstDigit === -1 ? name : name.slice(0, firstDigit);
+};
+const splitPrerelease = (name) => {
+  const dash = name.indexOf("-", name.search(/\d/));
+  return dash === -1 ? [name, ""] : [name.slice(0, dash), name.slice(dash + 1)];
+};
+const compareGenerationNamesNewestFirst = (nameA, nameB) => {
+  const collation = { numeric: true, sensitivity: "base" };
+  const byProduct = productPrefix(nameA).localeCompare(
+    productPrefix(nameB),
+    void 0,
+    collation
+  );
+  if (byProduct !== 0) {
+    return byProduct;
+  }
+  const [baseA, suffixA] = splitPrerelease(nameA);
+  const [baseB, suffixB] = splitPrerelease(nameB);
+  const byBase = baseB.localeCompare(baseA, void 0, collation);
+  if (byBase !== 0) {
+    return byBase;
+  }
+  if (suffixA === "" || suffixB === "") {
+    return suffixA === suffixB ? 0 : suffixA === "" ? -1 : 1;
+  }
+  return suffixB.localeCompare(suffixA, void 0, collation);
+};
 export {
+  compareGenerationNamesNewestFirst,
   sortGenerationBySemverOfZeebe
 };
 //# sourceMappingURL=Generations.dto.js.map

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

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/dtos/Generations.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 semver from 'semver'\nimport type { ZeebeClusterVersionsDto } from '../types/C8ClusterComponentVersions.type.js'\nimport { stripSecfixPostfix } from '../utils/versionCheck.utils.js'\n\nexport interface GenerationDto {\n  name: string\n  uuid: string\n  versions: ZeebeClusterVersionsDto\n  upgradeableFrom: GenerationDto[]\n  createdBy: string\n  createdByName?: string\n  created: Date\n  updatedBy: string\n  updated: Date\n  isUnsupportedStarting?: Date\n  isBespoke?: boolean\n}\n\nexport interface GenerationWithClusterCountDto extends GenerationDto {\n  clusterCount: number\n}\n\nexport interface UpgradableGenerationsDto {\n  preferred: GenerationDto | null\n  options: GenerationDto[]\n}\n\nconst secfixRank = (version: string): number =>\n  version === stripSecfixPostfix(version) ? 0 : 1\n\nexport function sortGenerationBySemverOfZeebe(\n  generationA: { name: string; versions?: { zeebe: string } },\n  generationB: { name: string; versions?: { zeebe: string } },\n) {\n  // magic sorting algorithm\n  // uses the generation version of zeebe for comparison\n  // if version invalid: use localeCompare\n\n  const versionAvalid: boolean =\n    generationA.versions?.zeebe !== undefined &&\n    semver.valid(generationA.versions.zeebe.split(':')[1]) !== null\n  const versionBvalid: boolean =\n    generationB.versions?.zeebe !== undefined &&\n    semver.valid(generationB.versions.zeebe.split(':')[1]) !== null\n\n  if (versionAvalid && versionBvalid) {\n    const zeebeA = generationA.versions!.zeebe.split(':')[1]\n    const zeebeB = generationB.versions!.zeebe.split(':')[1]\n    const byVersion = semver.compare(\n      stripSecfixPostfix(zeebeB),\n      stripSecfixPostfix(zeebeA),\n    )\n    if (byVersion !== 0) {\n      return byVersion\n    }\n    // Both builds carry the same Camunda version here, so only the postfix\n    // separates them. A secfix build holds that version plus a security patch,\n    // thus it is the newer of the two and takes the higher rank.\n    return secfixRank(zeebeB) - secfixRank(zeebeA)\n  } else if (versionAvalid) {\n    return -1\n  } else if (versionBvalid) {\n    return 1\n  } else {\n    return generationB.name.localeCompare(generationA.name)\n  }\n}\n"],
-  "mappings": "AAMA,OAAO,YAAY;AAEnB,SAAS,0BAA0B;AAyBnC,MAAM,aAAa,CAAC,YAClB,YAAY,mBAAmB,OAAO,IAAI,IAAI;AAEzC,SAAS,8BACd,aACA,aACA;AAKA,QAAM,gBACJ,YAAY,UAAU,UAAU,UAChC,OAAO,MAAM,YAAY,SAAS,MAAM,MAAM,GAAG,EAAE,CAAC,CAAC,MAAM;AAC7D,QAAM,gBACJ,YAAY,UAAU,UAAU,UAChC,OAAO,MAAM,YAAY,SAAS,MAAM,MAAM,GAAG,EAAE,CAAC,CAAC,MAAM;AAE7D,MAAI,iBAAiB,eAAe;AAClC,UAAM,SAAS,YAAY,SAAU,MAAM,MAAM,GAAG,EAAE,CAAC;AACvD,UAAM,SAAS,YAAY,SAAU,MAAM,MAAM,GAAG,EAAE,CAAC;AACvD,UAAM,YAAY,OAAO;AAAA,MACvB,mBAAmB,MAAM;AAAA,MACzB,mBAAmB,MAAM;AAAA,IAC3B;AACA,QAAI,cAAc,GAAG;AACnB,aAAO;AAAA,IACT;AAIA,WAAO,WAAW,MAAM,IAAI,WAAW,MAAM;AAAA,EAC/C,WAAW,eAAe;AACxB,WAAO;AAAA,EACT,WAAW,eAAe;AACxB,WAAO;AAAA,EACT,OAAO;AACL,WAAO,YAAY,KAAK,cAAc,YAAY,IAAI;AAAA,EACxD;AACF;",
+  "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 semver from 'semver'\nimport type { ZeebeClusterVersionsDto } from '../types/C8ClusterComponentVersions.type.js'\nimport { stripSecfixPostfix } from '../utils/versionCheck.utils.js'\n\nexport interface GenerationDto {\n  name: string\n  uuid: string\n  versions: ZeebeClusterVersionsDto\n  upgradeableFrom: GenerationDto[]\n  createdBy: string\n  createdByName?: string\n  created: Date\n  updatedBy: string\n  updated: Date\n  isUnsupportedStarting?: Date\n  isBespoke?: boolean\n}\n\nexport interface GenerationWithClusterCountDto extends GenerationDto {\n  clusterCount: number\n}\n\nexport interface UpgradableGenerationsDto {\n  preferred: GenerationDto | null\n  options: GenerationDto[]\n}\n\nconst secfixRank = (version: string): number =>\n  version === stripSecfixPostfix(version) ? 0 : 1\n\nexport function sortGenerationBySemverOfZeebe(\n  generationA: { name: string; versions?: { zeebe: string } },\n  generationB: { name: string; versions?: { zeebe: string } },\n) {\n  // magic sorting algorithm\n  // uses the generation version of zeebe for comparison\n  // if version invalid: use localeCompare\n\n  const versionAvalid: boolean =\n    generationA.versions?.zeebe !== undefined &&\n    semver.valid(generationA.versions.zeebe.split(':')[1]) !== null\n  const versionBvalid: boolean =\n    generationB.versions?.zeebe !== undefined &&\n    semver.valid(generationB.versions.zeebe.split(':')[1]) !== null\n\n  if (versionAvalid && versionBvalid) {\n    const zeebeA = generationA.versions!.zeebe.split(':')[1]\n    const zeebeB = generationB.versions!.zeebe.split(':')[1]\n    const byVersion = semver.compare(\n      stripSecfixPostfix(zeebeB),\n      stripSecfixPostfix(zeebeA),\n    )\n    if (byVersion !== 0) {\n      return byVersion\n    }\n    // Both builds carry the same Camunda version here, so only the postfix\n    // separates them. A secfix build holds that version plus a security patch,\n    // thus it is the newer of the two and takes the higher rank.\n    const bySecfix = secfixRank(zeebeB) - secfixRank(zeebeA)\n    if (bySecfix !== 0) {\n      return bySecfix\n    }\n    // Same image on both (8.9+gen5 and 8.9+gen6 both run 8.9.5). The name is\n    // the only order left, so a picker does not show them in input order.\n    return compareGenerationNamesNewestFirst(generationA.name, generationB.name)\n  } else if (versionAvalid) {\n    return -1\n  } else if (versionBvalid) {\n    return 1\n  } else {\n    return compareGenerationNamesNewestFirst(generationA.name, generationB.name)\n  }\n}\n\n/** The text before the first digit: \"Camunda \" for \"Camunda 8.9+gen20\". */\nconst productPrefix = (name: string): string => {\n  const firstDigit = name.search(/\\d/)\n  return firstDigit === -1 ? name : name.slice(0, firstDigit)\n}\n\n/**\n * Splits a name at the first dash after the version: \"Camunda 8.10.0-alpha1\"\n * gives [\"Camunda 8.10.0\", \"alpha1\"]. A name without a dash gives an empty\n * suffix.\n */\nconst splitPrerelease = (name: string): [base: string, suffix: string] => {\n  const dash = name.indexOf('-', name.search(/\\d/))\n  return dash === -1 ? [name, ''] : [name.slice(0, dash), name.slice(dash + 1)]\n}\n\n/**\n * Orders generation names by product, then newest first within a product, by\n * numeric collation: `8.10` comes before `8.9`, and `gen10` before `gen9`.\n * Products stay in alphabetic order, so the Camunda generations come before\n * the older Zeebe ones. A release comes before its prereleases, so\n * `8.10.0` is above `8.10.0-alpha1`. For a list that has no zeebe image to\n * compare, such as a filter facet. When the image is known, use\n * `sortGenerationBySemverOfZeebe`.\n */\nexport const compareGenerationNamesNewestFirst = (\n  nameA: string,\n  nameB: string,\n): number => {\n  const collation = { numeric: true, sensitivity: 'base' } as const\n  const byProduct = productPrefix(nameA).localeCompare(\n    productPrefix(nameB),\n    undefined,\n    collation,\n  )\n  if (byProduct !== 0) {\n    return byProduct\n  }\n  const [baseA, suffixA] = splitPrerelease(nameA)\n  const [baseB, suffixB] = splitPrerelease(nameB)\n  const byBase = baseB.localeCompare(baseA, undefined, collation)\n  if (byBase !== 0) {\n    return byBase\n  }\n  if (suffixA === '' || suffixB === '') {\n    return suffixA === suffixB ? 0 : suffixA === '' ? -1 : 1\n  }\n  return suffixB.localeCompare(suffixA, undefined, collation)\n}\n"],
+  "mappings": "AAMA,OAAO,YAAY;AAEnB,SAAS,0BAA0B;AAyBnC,MAAM,aAAa,CAAC,YAClB,YAAY,mBAAmB,OAAO,IAAI,IAAI;AAEzC,SAAS,8BACd,aACA,aACA;AAKA,QAAM,gBACJ,YAAY,UAAU,UAAU,UAChC,OAAO,MAAM,YAAY,SAAS,MAAM,MAAM,GAAG,EAAE,CAAC,CAAC,MAAM;AAC7D,QAAM,gBACJ,YAAY,UAAU,UAAU,UAChC,OAAO,MAAM,YAAY,SAAS,MAAM,MAAM,GAAG,EAAE,CAAC,CAAC,MAAM;AAE7D,MAAI,iBAAiB,eAAe;AAClC,UAAM,SAAS,YAAY,SAAU,MAAM,MAAM,GAAG,EAAE,CAAC;AACvD,UAAM,SAAS,YAAY,SAAU,MAAM,MAAM,GAAG,EAAE,CAAC;AACvD,UAAM,YAAY,OAAO;AAAA,MACvB,mBAAmB,MAAM;AAAA,MACzB,mBAAmB,MAAM;AAAA,IAC3B;AACA,QAAI,cAAc,GAAG;AACnB,aAAO;AAAA,IACT;AAIA,UAAM,WAAW,WAAW,MAAM,IAAI,WAAW,MAAM;AACvD,QAAI,aAAa,GAAG;AAClB,aAAO;AAAA,IACT;AAGA,WAAO,kCAAkC,YAAY,MAAM,YAAY,IAAI;AAAA,EAC7E,WAAW,eAAe;AACxB,WAAO;AAAA,EACT,WAAW,eAAe;AACxB,WAAO;AAAA,EACT,OAAO;AACL,WAAO,kCAAkC,YAAY,MAAM,YAAY,IAAI;AAAA,EAC7E;AACF;AAGA,MAAM,gBAAgB,CAAC,SAAyB;AAC9C,QAAM,aAAa,KAAK,OAAO,IAAI;AACnC,SAAO,eAAe,KAAK,OAAO,KAAK,MAAM,GAAG,UAAU;AAC5D;AAOA,MAAM,kBAAkB,CAAC,SAAiD;AACxE,QAAM,OAAO,KAAK,QAAQ,KAAK,KAAK,OAAO,IAAI,CAAC;AAChD,SAAO,SAAS,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,MAAM,GAAG,IAAI,GAAG,KAAK,MAAM,OAAO,CAAC,CAAC;AAC9E;AAWO,MAAM,oCAAoC,CAC/C,OACA,UACW;AACX,QAAM,YAAY,EAAE,SAAS,MAAM,aAAa,OAAO;AACvD,QAAM,YAAY,cAAc,KAAK,EAAE;AAAA,IACrC,cAAc,KAAK;AAAA,IACnB;AAAA,IACA;AAAA,EACF;AACA,MAAI,cAAc,GAAG;AACnB,WAAO;AAAA,EACT;AACA,QAAM,CAAC,OAAO,OAAO,IAAI,gBAAgB,KAAK;AAC9C,QAAM,CAAC,OAAO,OAAO,IAAI,gBAAgB,KAAK;AAC9C,QAAM,SAAS,MAAM,cAAc,OAAO,QAAW,SAAS;AAC9D,MAAI,WAAW,GAAG;AAChB,WAAO;AAAA,EACT;AACA,MAAI,YAAY,MAAM,YAAY,IAAI;AACpC,WAAO,YAAY,UAAU,IAAI,YAAY,KAAK,KAAK;AAAA,EACzD;AACA,SAAO,QAAQ,cAAc,SAAS,QAAW,SAAS;AAC5D;",
   "names": []
 }

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

@@ -22,4 +22,33 @@ export declare namespace Hdp {
         minDate: string;
         maxDate: string;
     }
+    /**
+     * The work of one cluster inside the activity window. HDP aggregates, thus
+     * one row comes back for each cluster and not one for each cluster and day.
+     */
+    interface ClusterActivityRow {
+        clusterId: string;
+        /**
+         * The last UTC day with work, as `YYYY-MM-DD`. When no day inside the
+         * window carries work, this field is absent. accounts-backend makes this
+         * string from the BigQuery DATE, thus no caller reads the shape that the
+         * BigQuery client gives.
+         */
+        lastActiveAt?: string;
+        processInstances: number;
+    }
+    /**
+     * Every cluster that HDP holds inside the window, for the whole fleet.
+     *
+     * The reader joins these rows against its own cluster table. HDP keeps the
+     * rows of clusters that no longer exist, thus the set is bigger than the
+     * live fleet.
+     */
+    interface ClusterActivity {
+        rows: ClusterActivityRow[];
+        /** The window that `rows` covers, in days. */
+        windowDays: number;
+        /** The time of the query, as an ISO instant. */
+        fetchedAt: string;
+    }
 }