@camunda/ccma-api 5.4.0 → 5.5.0

package/dist/services/accounts/logs.service.js

@@ -0,0 +1,41 @@
+import { request } from "../../utils/api.js";
+import { HttpError } from "../../utils/errors.js";
+class AccountsLogsService {
+  /**
+   * The machine-to-machine tokens that were taken for each cluster in the
+   * range, one row for each cluster, and whether the read of the Auth0 log
+   * stopped before the end of the range. See `M2mTokenCountsDto`.
+   */
+  static async getM2mTokenCounts(params) {
+    const serviceContext = {
+      method: {
+        name: "AccountsLogsService.getM2mTokenCounts",
+        url: `api/logs/clients/tokens/count?rangeInHours=${encodeURIComponent(params.params.rangeInHours)}`,
+        normalizedUrl: "api/logs/clients/tokens/count",
+        type: "get"
+      },
+      source: params.config.metrics?.source || "unset",
+      target: { name: "accounts", type: "internal" }
+    };
+    const response = await request({
+      config: params.config,
+      base: { id: "accounts" },
+      url: serviceContext.method.url,
+      method: serviceContext.method.type,
+      metricsDetails: serviceContext,
+      responseType: "json"
+    });
+    if (!response.ok) {
+      throw new HttpError(
+        `${serviceContext.method.name}: ${response.status} ${response.statusText}`,
+        response.status,
+        response.statusText
+      );
+    }
+    return response.body ?? { clusters: [], counted: 0, total: 0, truncated: false };
+  }
+}
+export {
+  AccountsLogsService
+};
+//# sourceMappingURL=logs.service.js.map

package/dist/services/accounts/logs.service.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/services/accounts/logs.service.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 { M2mTokenCountsDto } from '@camunda/ccma-shared-types'\nimport type {\n  RequestBaseParams,\n  RequestBaseServiceContext,\n} from '../../types/general.types.js'\nimport { request } from '../../utils/api.js'\nimport { HttpError } from '../../utils/errors.js'\n\nexport interface GetM2mTokenCountsRequest extends RequestBaseParams {\n  params: {\n    /** How far back the Auth0 log is read, in hours. The accounts tool read 24. */\n    rangeInHours: number\n  }\n}\n\n/**\n * The log reads of accounts-backend (`api/logs`). They answer to\n * `admin.readAll` only.\n */\nexport class AccountsLogsService {\n  /**\n   * The machine-to-machine tokens that were taken for each cluster in the\n   * range, one row for each cluster, and whether the read of the Auth0 log\n   * stopped before the end of the range. See `M2mTokenCountsDto`.\n   */\n  public static async getM2mTokenCounts(\n    params: GetM2mTokenCountsRequest,\n  ): Promise<M2mTokenCountsDto> {\n    const serviceContext: RequestBaseServiceContext = {\n      method: {\n        name: 'AccountsLogsService.getM2mTokenCounts',\n        url: `api/logs/clients/tokens/count?rangeInHours=${encodeURIComponent(params.params.rangeInHours)}`,\n        normalizedUrl: 'api/logs/clients/tokens/count',\n        type: 'get',\n      },\n      source: params.config.metrics?.source || 'unset',\n      target: { name: 'accounts', type: 'internal' },\n    }\n    const response = await request<M2mTokenCountsDto>({\n      config: params.config,\n      base: { id: 'accounts' },\n      url: serviceContext.method.url,\n      method: serviceContext.method.type,\n      metricsDetails: serviceContext,\n      responseType: 'json',\n    })\n    if (!response.ok) {\n      throw new HttpError(\n        `${serviceContext.method.name}: ${response.status} ${response.statusText}`,\n        response.status,\n        response.statusText,\n      )\n    }\n    return (\n      response.body ?? { clusters: [], counted: 0, total: 0, truncated: false }\n    )\n  }\n}\n"],
+  "mappings": "AAWA,SAAS,eAAe;AACxB,SAAS,iBAAiB;AAanB,MAAM,oBAAoB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAM/B,aAAoB,kBAClB,QAC4B;AAC5B,UAAM,iBAA4C;AAAA,MAChD,QAAQ;AAAA,QACN,MAAM;AAAA,QACN,KAAK,8CAA8C,mBAAmB,OAAO,OAAO,YAAY,CAAC;AAAA,QACjG,eAAe;AAAA,QACf,MAAM;AAAA,MACR;AAAA,MACA,QAAQ,OAAO,OAAO,SAAS,UAAU;AAAA,MACzC,QAAQ,EAAE,MAAM,YAAY,MAAM,WAAW;AAAA,IAC/C;AACA,UAAM,WAAW,MAAM,QAA2B;AAAA,MAChD,QAAQ,OAAO;AAAA,MACf,MAAM,EAAE,IAAI,WAAW;AAAA,MACvB,KAAK,eAAe,OAAO;AAAA,MAC3B,QAAQ,eAAe,OAAO;AAAA,MAC9B,gBAAgB;AAAA,MAChB,cAAc;AAAA,IAChB,CAAC;AACD,QAAI,CAAC,SAAS,IAAI;AAChB,YAAM,IAAI;AAAA,QACR,GAAG,eAAe,OAAO,IAAI,KAAK,SAAS,MAAM,IAAI,SAAS,UAAU;AAAA,QACxE,SAAS;AAAA,QACT,SAAS;AAAA,MACX;AAAA,IACF;AACA,WACE,SAAS,QAAQ,EAAE,UAAU,CAAC,GAAG,SAAS,GAAG,OAAO,GAAG,WAAW,MAAM;AAAA,EAE5E;AACF;",
+  "names": []
+}

package/dist/services/accounts/logs.service.spec.d.ts

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

package/dist/services/console/console.admin.service.d.ts

@@ -1,4 +1,4 @@
-import type { AlertSubscriptionDto, BackupDto, BackupScheduleDto, ByomClientDto, ByomStatus, ClusterBulkOperationAck, ClusterBulkOperationDto, ClusterBulkOperationPostContent, ClusterModificationConfigDto, ClusterModificationDto, ClusterPlanTypeDto, ClusterTtlDto, ClusterUsageMetricsData, ConsoleClusterDto, UniqueTaskUser, UpdateClusterTtlBody, ValueMetrics } from '@camunda/ccma-shared-types';
+import type { AlertSubscriptionDto, BackupDto, BackupScheduleDto, ByomClientDto, ByomStatus, ClusterBulkOperationAck, ClusterBulkOperationDto, ClusterBulkOperationPostContent, ClusterModificationConfigDto, ClusterModificationDto, ClusterPlanTypeDto, ClusterTtlDto, ClusterUsageMetadataDto, ClusterUsageMetricsData, ConsoleClusterDto, UniqueTaskUser, UpdateClusterTtlBody, ValueMetrics } from '@camunda/ccma-shared-types';
 import type { RequestBaseParams } from '../../types/general.types.js';
 import type { OpenIncident } from '../incident-io/incident-io.service.js';
 import type { ConsoleClusterClientDto } from './console.cluster-clients.service.js';
@@ -219,6 +219,18 @@ export interface GetValueMetricsUsageDataRequest extends RequestBaseParams {
         };
     };
 }
+export interface GetValueMetricsUsageDataPerDayRequest extends RequestBaseParams {
+    params: {
+        orgId: string;
+        /** How many days back from now the read covers. */
+        days: number;
+    };
+}
+export interface GetValueMetricsMetadataRequest extends RequestBaseParams {
+    params: {
+        orgId: string;
+    };
+}
 export interface GetValueMetricsRequest extends RequestBaseParams {
     params: {
         orgId: string;
@@ -319,6 +331,18 @@ export interface AdminClusterNonSpotNodesRequest extends RequestBaseParams {
         nonSpotNodesEnabled: boolean;
     };
 }
+/** What `GET api/admin/clusters/modifications` answers. */
+export interface ModificationsAnswer {
+    clusters: ConsoleClusterDto[];
+    modifications: ClusterModificationDto[];
+}
+/**
+ * How many cluster ids one GET of the modifications carries in its query.
+ *
+ * 50 uuids are about 1.9 KB of request line, well under the 8 KB that the
+ * ingress and node accept. The bound is on the request, not on the answer.
+ */
+export declare const CLUSTER_UUIDS_PER_READ = 50;
 export declare class ConsoleAdminService {
     static updateClusterToNewPlanType(params: UpdateClusterToNewPlanTypeRequest): Promise<void>;
     static updateClusterMetricsStartDate(params: UpdateClusterMetricsStartDateRequest): Promise<void>;
@@ -373,6 +397,22 @@ export declare class ConsoleAdminService {
     static getClusterPlanType(params: GetClusterPlanTypeRequest): Promise<ClusterPlanTypeDto>;
     static getAllClusterPlanTypes(params: GetAllClusterPlanTypesRequest): Promise<ClusterPlanTypeDto[]>;
     static getValueMetricsUsageData(params: GetValueMetricsUsageDataRequest): Promise<ClusterUsageMetricsData[]>;
+    /**
+     * The value metrics that console counted itself, one row for each cluster
+     * and day of the last `days` days
+     * (`GET api/orgs/:orgId/clusters/usage/value-metrics/:days`).
+     *
+     * This is the source that HDP replaced for a 2025 organization. The
+     * comparison of the two sources reads it on purpose, so it never reads HDP
+     * under this name: a comparison of a series with itself shows nothing.
+     */
+    static getValueMetricsUsageDataPerDay(params: GetValueMetricsUsageDataPerDayRequest): Promise<ClusterUsageMetricsData[]>;
+    /**
+     * The usage metadata of an organization: the unique task users and the
+     * deployed models for each billing period
+     * (`GET api/orgs/:orgId/clusters/usage/value-metrics-metadata`).
+     */
+    static getValueMetricsMetadata(params: GetValueMetricsMetadataRequest): Promise<ClusterUsageMetadataDto[]>;
     static getValueMetrics(params: GetValueMetricsRequest): Promise<ValueMetrics | undefined>;
     static getValueMetricsForAll(params: GetValueMetricsForAllRequest): Promise<ValueMetrics[]>;
     static getTaskUsers(params: GetTaskUsersRequest): Promise<UniqueTaskUser[]>;
@@ -390,14 +430,26 @@ export declare class ConsoleAdminService {
     static wakeCluster(params: {
         clusterId: string;
     } & RequestBaseParams): Promise<void | undefined>;
+    /**
+     * Every cluster modification, with the clusters they belong to.
+     *
+     * `clusterUuids` bounds the answer to those clusters. Console reads the
+     * whole table without it, and one cluster for each row of the answer, so a
+     * reader that asks about a few clusters names them. The ids go in the
+     * query of a GET, so they travel in groups of `CLUSTER_UUIDS_PER_READ`:
+     * the request line must not grow with the selection, or a large one
+     * answers 414. The groups are read one after the other and merged, with
+     * each cluster one time, so the caller sees one answer of the usual shape.
+     * An empty list reads nothing and answers nothing.
+     */
     static getAllModifications(params: RequestBaseParams & {
+        clusterUuids?: readonly string[];
         headers?: {
             'x-camunda-email'?: string;
         };
-    }): Promise<{
-        clusters: ConsoleClusterDto[];
-        modifications: ClusterModificationDto[];
-    } | undefined>;
+    }): Promise<ModificationsAnswer | undefined>;
+    /** One GET of the modifications, for every cluster or for the ids given. */
+    private static readModifications;
     static createModification(params: RequestBaseParams & {
         clusterUuid: string;
         headers?: {

package/dist/services/console/console.admin.service.js

@@ -1,5 +1,6 @@
 import { request } from "../../utils/api.js";
 import { HttpError } from "../../utils/errors.js";
+const CLUSTER_UUIDS_PER_READ = 50;
 class ConsoleAdminService {
   static async updateClusterToNewPlanType(params) {
     const serviceContext = {
@@ -645,6 +646,84 @@ class ConsoleAdminService {
     }
     return response.body;
   }
+  /**
+   * The value metrics that console counted itself, one row for each cluster
+   * and day of the last `days` days
+   * (`GET api/orgs/:orgId/clusters/usage/value-metrics/:days`).
+   *
+   * This is the source that HDP replaced for a 2025 organization. The
+   * comparison of the two sources reads it on purpose, so it never reads HDP
+   * under this name: a comparison of a series with itself shows nothing.
+   */
+  static async getValueMetricsUsageDataPerDay(params) {
+    const serviceContext = {
+      method: {
+        name: `ConsoleAdminService.getValueMetricsUsageDataPerDay`,
+        url: `api/orgs/${params.params.orgId}/clusters/usage/value-metrics/${params.params.days}`,
+        normalizedUrl: `api/orgs/:orgId/clusters/usage/value-metrics/:days`,
+        type: "get"
+      },
+      source: params.config.metrics?.source || "unset",
+      target: {
+        name: "console",
+        type: "internal"
+      }
+    };
+    const response = await request({
+      config: params.config,
+      base: {
+        id: "console"
+      },
+      url: serviceContext.method.url,
+      method: serviceContext.method.type,
+      metricsDetails: serviceContext
+    });
+    if (!response.ok) {
+      throw new HttpError(
+        `${serviceContext.method.name}: ${response.status} ${response.statusText}`,
+        response.status,
+        response.statusText
+      );
+    }
+    return response.body ?? [];
+  }
+  /**
+   * The usage metadata of an organization: the unique task users and the
+   * deployed models for each billing period
+   * (`GET api/orgs/:orgId/clusters/usage/value-metrics-metadata`).
+   */
+  static async getValueMetricsMetadata(params) {
+    const serviceContext = {
+      method: {
+        name: `ConsoleAdminService.getValueMetricsMetadata`,
+        url: `api/orgs/${params.params.orgId}/clusters/usage/value-metrics-metadata`,
+        normalizedUrl: `api/orgs/:orgId/clusters/usage/value-metrics-metadata`,
+        type: "get"
+      },
+      source: params.config.metrics?.source || "unset",
+      target: {
+        name: "console",
+        type: "internal"
+      }
+    };
+    const response = await request({
+      config: params.config,
+      base: {
+        id: "console"
+      },
+      url: serviceContext.method.url,
+      method: serviceContext.method.type,
+      metricsDetails: serviceContext
+    });
+    if (!response.ok) {
+      throw new HttpError(
+        `${serviceContext.method.name}: ${response.status} ${response.statusText}`,
+        response.status,
+        response.statusText
+      );
+    }
+    return response.body?.metadata ?? [];
+  }
   static async getValueMetrics(params) {
     const serviceContext = {
       method: {
@@ -970,11 +1049,53 @@ class ConsoleAdminService {
     }
     return response.body;
   }
+  /**
+   * Every cluster modification, with the clusters they belong to.
+   *
+   * `clusterUuids` bounds the answer to those clusters. Console reads the
+   * whole table without it, and one cluster for each row of the answer, so a
+   * reader that asks about a few clusters names them. The ids go in the
+   * query of a GET, so they travel in groups of `CLUSTER_UUIDS_PER_READ`:
+   * the request line must not grow with the selection, or a large one
+   * answers 414. The groups are read one after the other and merged, with
+   * each cluster one time, so the caller sees one answer of the usual shape.
+   * An empty list reads nothing and answers nothing.
+   */
   static async getAllModifications(params) {
+    const { clusterUuids, ...rest } = params;
+    if (clusterUuids === void 0) {
+      return ConsoleAdminService.readModifications(rest);
+    }
+    if (clusterUuids.length === 0) {
+      return { clusters: [], modifications: [] };
+    }
+    const merged = { clusters: [], modifications: [] };
+    const seenClusters = /* @__PURE__ */ new Set();
+    for (let start = 0; start < clusterUuids.length; start += CLUSTER_UUIDS_PER_READ) {
+      const page = await ConsoleAdminService.readModifications(
+        rest,
+        clusterUuids.slice(start, start + CLUSTER_UUIDS_PER_READ)
+      );
+      if (!page) {
+        continue;
+      }
+      merged.modifications.push(...page.modifications);
+      for (const cluster of page.clusters) {
+        if (!seenClusters.has(cluster.uuid)) {
+          seenClusters.add(cluster.uuid);
+          merged.clusters.push(cluster);
+        }
+      }
+    }
+    return merged;
+  }
+  /** One GET of the modifications, for every cluster or for the ids given. */
+  static async readModifications(params, clusterUuids) {
+    const query = clusterUuids && clusterUuids.length > 0 ? `?clusterUuids=${clusterUuids.map(encodeURIComponent).join(",")}` : "";
     const serviceContext = {
       method: {
         name: `ConsoleAdminService.getAllModifications`,
-        url: `api/admin/clusters/modifications`,
+        url: `api/admin/clusters/modifications${query}`,
         normalizedUrl: `api/clusters/modifications`,
         type: "get"
       },
@@ -2075,6 +2196,7 @@ class ConsoleAdminService {
   }
 }
 export {
+  CLUSTER_UUIDS_PER_READ,
   ConsoleAdminService
 };
 //# sourceMappingURL=console.admin.service.js.map