@camunda/ccma-api 3.0.0 → 4.0.0

package/dist/services/control/control.dashboards.service.js

@@ -0,0 +1,180 @@
+import { request } from "../../utils/api.js";
+import { HttpError } from "../../utils/errors.js";
+const BASE = { id: "control" };
+function contextFor(name, url, normalizedUrl, type, source) {
+  return {
+    method: {
+      name: `ControlDashboardsService.${name}`,
+      url,
+      normalizedUrl,
+      type
+    },
+    source,
+    target: { name: "control", type: "internal" }
+  };
+}
+function queryOf(params = {}) {
+  const query = new URLSearchParams();
+  for (const [key, value] of Object.entries(params)) {
+    if (value !== void 0) {
+      query.set(key, String(value));
+    }
+  }
+  return query.size > 0 ? `?${query.toString()}` : "";
+}
+class ControlDashboardsService {
+  /**
+   * What a dashboard definition can hold on this stage: the kinds of tiles,
+   * the cards, the chart metrics and the limits. The chart metrics are empty
+   * where `control.dashboardCharts` is off.
+   */
+  static async catalogue(params) {
+    return ControlDashboardsService.send(
+      params,
+      "catalogue",
+      "api/dashboards/catalogue",
+      "api/dashboards/catalogue",
+      "get"
+    );
+  }
+  /**
+   * Checks a chart query and gives the spec of a chart tile. A query with a
+   * mistake is an answer with `valid: false`, and not a failure. Answers 404
+   * where `control.dashboardCharts` is off.
+   */
+  static async checkChartQuery(params) {
+    return ControlDashboardsService.send(
+      params,
+      "checkChartQuery",
+      "api/dashboards/chart-queries/check",
+      "api/dashboards/chart-queries/check",
+      "post",
+      { query: params.params.query }
+    );
+  }
+  /** One page of the live or the archived dashboards, with no tiles. */
+  static async list(params) {
+    const url = `api/dashboards${queryOf(params.params)}`;
+    return ControlDashboardsService.send(
+      params,
+      "list",
+      url,
+      "api/dashboards",
+      "get"
+    );
+  }
+  static async get(params) {
+    const { dashboard } = await ControlDashboardsService.send(
+      params,
+      "get",
+      `api/dashboards/${params.params.id}`,
+      "api/dashboards/:id",
+      "get"
+    );
+    return dashboard;
+  }
+  static async create(params) {
+    const { dashboard } = await ControlDashboardsService.send(
+      params,
+      "create",
+      "api/dashboards",
+      "api/dashboards",
+      "post",
+      params.params
+    );
+    return dashboard;
+  }
+  /** Saves the title and the tiles. Answers 409 for a stale `version`. */
+  static async update(params) {
+    const { id, ...body } = params.params;
+    const { dashboard } = await ControlDashboardsService.send(
+      params,
+      "update",
+      `api/dashboards/${id}`,
+      "api/dashboards/:id",
+      "put",
+      body
+    );
+    return dashboard;
+  }
+  /**
+   * Adds a tile after the last tile: to the right of the last row when it
+   * fits there, else under every tile. It needs no version.
+   */
+  static async addTile(params) {
+    const { dashboard } = await ControlDashboardsService.send(
+      params,
+      "addTile",
+      `api/dashboards/${params.params.id}/tiles`,
+      "api/dashboards/:id/tiles",
+      "post",
+      { tile: params.params.tile }
+    );
+    return dashboard;
+  }
+  static async archive(params) {
+    return ControlDashboardsService.action(params, "archive");
+  }
+  static async restore(params) {
+    return ControlDashboardsService.action(params, "restore");
+  }
+  /** Pins the dashboard for the caller alone. */
+  static async pin(params) {
+    await ControlDashboardsService.send(
+      params,
+      "pin",
+      `api/dashboards/${params.params.id}/pin`,
+      "api/dashboards/:id/pin",
+      "post"
+    );
+  }
+  static async unpin(params) {
+    await ControlDashboardsService.send(
+      params,
+      "unpin",
+      `api/dashboards/${params.params.id}/pin`,
+      "api/dashboards/:id/pin",
+      "delete"
+    );
+  }
+  static async action(params, name) {
+    const { dashboard } = await ControlDashboardsService.send(
+      params,
+      name,
+      `api/dashboards/${params.params.id}/${name}`,
+      `api/dashboards/:id/${name}`,
+      "post"
+    );
+    return dashboard;
+  }
+  static async send(params, name, url, normalizedUrl, method, body) {
+    const serviceContext = contextFor(
+      name,
+      url,
+      normalizedUrl,
+      method,
+      params.config.metrics?.source || "unset"
+    );
+    const response = await request({
+      ...params,
+      config: params.config,
+      base: BASE,
+      url,
+      method,
+      metricsDetails: serviceContext,
+      body
+    });
+    if (!response.ok) {
+      throw new HttpError(
+        `${serviceContext.method.name}: ${response.status} ${response.statusText}`,
+        response.status,
+        response.statusText
+      );
+    }
+    return response.body;
+  }
+}
+export {
+  ControlDashboardsService
+};
+//# sourceMappingURL=control.dashboards.service.js.map

package/dist/services/control/control.dashboards.service.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/services/control/control.dashboards.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 {\n  ChartQueryCheck,\n  DashboardCatalogue,\n  DashboardDefinition,\n  DashboardDto,\n  DashboardListDto,\n  DashboardNewTile,\n} from '@camunda/ccma-shared-types'\nimport type {\n  RequestBaseMethodType,\n  RequestBaseParams,\n  RequestBaseServiceContext,\n} from '../../types/general.types.js'\nimport { request } from '../../utils/api.js'\nimport { HttpError } from '../../utils/errors.js'\n\n/**\n * The dashboards of control-backend. A tile holds the filters of a page and\n * never its data, so the client runs each tile itself.\n *\n * Every route answers 404 while the feature flag `control.dashboards` is off\n * on the stage. The chart check answers 404 while `control.dashboardCharts` is\n * off too.\n */\n\nconst BASE = { id: 'control' } as const\n\nexport interface ListDashboardsRequest extends RequestBaseParams {\n  params?: { archived?: boolean; limit?: number; offset?: number }\n}\n\nexport interface DashboardIdRequest extends RequestBaseParams {\n  params: { id: string }\n}\n\nexport interface CreateDashboardRequest extends RequestBaseParams {\n  params: { title: string; definition?: DashboardDefinition }\n}\n\nexport interface UpdateDashboardRequest extends RequestBaseParams {\n  params: {\n    id: string\n    title: string\n    definition: DashboardDefinition\n    /**\n     * The `version` of the read that the edit started from. The backend\n     * answers 409 when the row moved on, so a stale tab never replaces a\n     * newer save.\n     */\n    version: number\n  }\n}\n\nexport interface AddDashboardTileRequest extends RequestBaseParams {\n  params: { id: string; tile: DashboardNewTile }\n}\n\nexport interface CheckChartQueryRequest extends RequestBaseParams {\n  params: { query: string }\n}\n\nfunction contextFor(\n  name: string,\n  url: string,\n  normalizedUrl: string,\n  type: RequestBaseMethodType,\n  source: string,\n): RequestBaseServiceContext {\n  return {\n    method: {\n      name: `ControlDashboardsService.${name}`,\n      url,\n      normalizedUrl,\n      type,\n    },\n    source,\n    target: { name: 'control', type: 'internal' },\n  }\n}\n\nfunction queryOf(params: Record<string, unknown> = {}): string {\n  const query = new URLSearchParams()\n  for (const [key, value] of Object.entries(params)) {\n    if (value !== undefined) {\n      query.set(key, String(value))\n    }\n  }\n  return query.size > 0 ? `?${query.toString()}` : ''\n}\n\nexport class ControlDashboardsService {\n  /**\n   * What a dashboard definition can hold on this stage: the kinds of tiles,\n   * the cards, the chart metrics and the limits. The chart metrics are empty\n   * where `control.dashboardCharts` is off.\n   */\n  public static async catalogue(\n    params: RequestBaseParams,\n  ): Promise<DashboardCatalogue> {\n    return ControlDashboardsService.send<DashboardCatalogue>(\n      params,\n      'catalogue',\n      'api/dashboards/catalogue',\n      'api/dashboards/catalogue',\n      'get',\n    )\n  }\n\n  /**\n   * Checks a chart query and gives the spec of a chart tile. A query with a\n   * mistake is an answer with `valid: false`, and not a failure. Answers 404\n   * where `control.dashboardCharts` is off.\n   */\n  public static async checkChartQuery(\n    params: CheckChartQueryRequest,\n  ): Promise<ChartQueryCheck> {\n    return ControlDashboardsService.send<ChartQueryCheck>(\n      params,\n      'checkChartQuery',\n      'api/dashboards/chart-queries/check',\n      'api/dashboards/chart-queries/check',\n      'post',\n      { query: params.params.query },\n    )\n  }\n\n  /** One page of the live or the archived dashboards, with no tiles. */\n  public static async list(\n    params: ListDashboardsRequest,\n  ): Promise<DashboardListDto> {\n    const url = `api/dashboards${queryOf(params.params)}`\n    return ControlDashboardsService.send<DashboardListDto>(\n      params,\n      'list',\n      url,\n      'api/dashboards',\n      'get',\n    )\n  }\n\n  public static async get(params: DashboardIdRequest): Promise<DashboardDto> {\n    const { dashboard } = await ControlDashboardsService.send<{\n      dashboard: DashboardDto\n    }>(\n      params,\n      'get',\n      `api/dashboards/${params.params.id}`,\n      'api/dashboards/:id',\n      'get',\n    )\n    return dashboard\n  }\n\n  public static async create(\n    params: CreateDashboardRequest,\n  ): Promise<DashboardDto> {\n    const { dashboard } = await ControlDashboardsService.send<{\n      dashboard: DashboardDto\n    }>(\n      params,\n      'create',\n      'api/dashboards',\n      'api/dashboards',\n      'post',\n      params.params,\n    )\n    return dashboard\n  }\n\n  /** Saves the title and the tiles. Answers 409 for a stale `version`. */\n  public static async update(\n    params: UpdateDashboardRequest,\n  ): Promise<DashboardDto> {\n    const { id, ...body } = params.params\n    const { dashboard } = await ControlDashboardsService.send<{\n      dashboard: DashboardDto\n    }>(\n      params,\n      'update',\n      `api/dashboards/${id}`,\n      'api/dashboards/:id',\n      'put',\n      body,\n    )\n    return dashboard\n  }\n\n  /**\n   * Adds a tile after the last tile: to the right of the last row when it\n   * fits there, else under every tile. It needs no version.\n   */\n  public static async addTile(\n    params: AddDashboardTileRequest,\n  ): Promise<DashboardDto> {\n    const { dashboard } = await ControlDashboardsService.send<{\n      dashboard: DashboardDto\n    }>(\n      params,\n      'addTile',\n      `api/dashboards/${params.params.id}/tiles`,\n      'api/dashboards/:id/tiles',\n      'post',\n      { tile: params.params.tile },\n    )\n    return dashboard\n  }\n\n  public static async archive(\n    params: DashboardIdRequest,\n  ): Promise<DashboardDto> {\n    return ControlDashboardsService.action(params, 'archive')\n  }\n\n  public static async restore(\n    params: DashboardIdRequest,\n  ): Promise<DashboardDto> {\n    return ControlDashboardsService.action(params, 'restore')\n  }\n\n  /** Pins the dashboard for the caller alone. */\n  public static async pin(params: DashboardIdRequest): Promise<void> {\n    await ControlDashboardsService.send<undefined>(\n      params,\n      'pin',\n      `api/dashboards/${params.params.id}/pin`,\n      'api/dashboards/:id/pin',\n      'post',\n    )\n  }\n\n  public static async unpin(params: DashboardIdRequest): Promise<void> {\n    await ControlDashboardsService.send<undefined>(\n      params,\n      'unpin',\n      `api/dashboards/${params.params.id}/pin`,\n      'api/dashboards/:id/pin',\n      'delete',\n    )\n  }\n\n  private static async action(\n    params: DashboardIdRequest,\n    name: 'archive' | 'restore',\n  ): Promise<DashboardDto> {\n    const { dashboard } = await ControlDashboardsService.send<{\n      dashboard: DashboardDto\n    }>(\n      params,\n      name,\n      `api/dashboards/${params.params.id}/${name}`,\n      `api/dashboards/:id/${name}`,\n      'post',\n    )\n    return dashboard\n  }\n\n  private static async send<TResponse>(\n    params: RequestBaseParams,\n    name: string,\n    url: string,\n    normalizedUrl: string,\n    method: RequestBaseMethodType,\n    body?: object,\n  ): Promise<TResponse> {\n    const serviceContext = contextFor(\n      name,\n      url,\n      normalizedUrl,\n      method,\n      params.config.metrics?.source || 'unset',\n    )\n    const response = await request<TResponse>({\n      ...params,\n      config: params.config,\n      base: BASE,\n      url,\n      method,\n      metricsDetails: serviceContext,\n      body,\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    // `pin` and `unpin` answer 204 with no body, and their callers read\n    // nothing.\n    return response.body as TResponse\n  }\n}\n"],
+  "mappings": "AAmBA,SAAS,eAAe;AACxB,SAAS,iBAAiB;AAW1B,MAAM,OAAO,EAAE,IAAI,UAAU;AAoC7B,SAAS,WACP,MACA,KACA,eACA,MACA,QAC2B;AAC3B,SAAO;AAAA,IACL,QAAQ;AAAA,MACN,MAAM,4BAA4B,IAAI;AAAA,MACtC;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAAA,IACA;AAAA,IACA,QAAQ,EAAE,MAAM,WAAW,MAAM,WAAW;AAAA,EAC9C;AACF;AAEA,SAAS,QAAQ,SAAkC,CAAC,GAAW;AAC7D,QAAM,QAAQ,IAAI,gBAAgB;AAClC,aAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,MAAM,GAAG;AACjD,QAAI,UAAU,QAAW;AACvB,YAAM,IAAI,KAAK,OAAO,KAAK,CAAC;AAAA,IAC9B;AAAA,EACF;AACA,SAAO,MAAM,OAAO,IAAI,IAAI,MAAM,SAAS,CAAC,KAAK;AACnD;AAEO,MAAM,yBAAyB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMpC,aAAoB,UAClB,QAC6B;AAC7B,WAAO,yBAAyB;AAAA,MAC9B;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,aAAoB,gBAClB,QAC0B;AAC1B,WAAO,yBAAyB;AAAA,MAC9B;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,EAAE,OAAO,OAAO,OAAO,MAAM;AAAA,IAC/B;AAAA,EACF;AAAA;AAAA,EAGA,aAAoB,KAClB,QAC2B;AAC3B,UAAM,MAAM,iBAAiB,QAAQ,OAAO,MAAM,CAAC;AACnD,WAAO,yBAAyB;AAAA,MAC9B;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAAA,EAEA,aAAoB,IAAI,QAAmD;AACzE,UAAM,EAAE,UAAU,IAAI,MAAM,yBAAyB;AAAA,MAGnD;AAAA,MACA;AAAA,MACA,kBAAkB,OAAO,OAAO,EAAE;AAAA,MAClC;AAAA,MACA;AAAA,IACF;AACA,WAAO;AAAA,EACT;AAAA,EAEA,aAAoB,OAClB,QACuB;AACvB,UAAM,EAAE,UAAU,IAAI,MAAM,yBAAyB;AAAA,MAGnD;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,OAAO;AAAA,IACT;AACA,WAAO;AAAA,EACT;AAAA;AAAA,EAGA,aAAoB,OAClB,QACuB;AACvB,UAAM,EAAE,IAAI,GAAG,KAAK,IAAI,OAAO;AAC/B,UAAM,EAAE,UAAU,IAAI,MAAM,yBAAyB;AAAA,MAGnD;AAAA,MACA;AAAA,MACA,kBAAkB,EAAE;AAAA,MACpB;AAAA,MACA;AAAA,MACA;AAAA,IACF;AACA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,aAAoB,QAClB,QACuB;AACvB,UAAM,EAAE,UAAU,IAAI,MAAM,yBAAyB;AAAA,MAGnD;AAAA,MACA;AAAA,MACA,kBAAkB,OAAO,OAAO,EAAE;AAAA,MAClC;AAAA,MACA;AAAA,MACA,EAAE,MAAM,OAAO,OAAO,KAAK;AAAA,IAC7B;AACA,WAAO;AAAA,EACT;AAAA,EAEA,aAAoB,QAClB,QACuB;AACvB,WAAO,yBAAyB,OAAO,QAAQ,SAAS;AAAA,EAC1D;AAAA,EAEA,aAAoB,QAClB,QACuB;AACvB,WAAO,yBAAyB,OAAO,QAAQ,SAAS;AAAA,EAC1D;AAAA;AAAA,EAGA,aAAoB,IAAI,QAA2C;AACjE,UAAM,yBAAyB;AAAA,MAC7B;AAAA,MACA;AAAA,MACA,kBAAkB,OAAO,OAAO,EAAE;AAAA,MAClC;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAAA,EAEA,aAAoB,MAAM,QAA2C;AACnE,UAAM,yBAAyB;AAAA,MAC7B;AAAA,MACA;AAAA,MACA,kBAAkB,OAAO,OAAO,EAAE;AAAA,MAClC;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAAA,EAEA,aAAqB,OACnB,QACA,MACuB;AACvB,UAAM,EAAE,UAAU,IAAI,MAAM,yBAAyB;AAAA,MAGnD;AAAA,MACA;AAAA,MACA,kBAAkB,OAAO,OAAO,EAAE,IAAI,IAAI;AAAA,MAC1C,sBAAsB,IAAI;AAAA,MAC1B;AAAA,IACF;AACA,WAAO;AAAA,EACT;AAAA,EAEA,aAAqB,KACnB,QACA,MACA,KACA,eACA,QACA,MACoB;AACpB,UAAM,iBAAiB;AAAA,MACrB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,OAAO,OAAO,SAAS,UAAU;AAAA,IACnC;AACA,UAAM,WAAW,MAAM,QAAmB;AAAA,MACxC,GAAG;AAAA,MACH,QAAQ,OAAO;AAAA,MACf,MAAM;AAAA,MACN;AAAA,MACA;AAAA,MACA,gBAAgB;AAAA,MAChB;AAAA,IACF,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;AAGA,WAAO,SAAS;AAAA,EAClB;AACF;",
+  "names": []
+}

package/dist/services/control/control.dashboards.service.spec.d.ts

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

package/dist/services/control/control.feature-flags.service.d.ts

@@ -0,0 +1,53 @@
+import type { CreateFeatureFlagDto, FeatureFlagAnswer, FeatureFlagDto, FeatureFlagListDto, UpdateFeatureFlagDto } from '@camunda/ccma-shared-types';
+import type { RequestBaseParams } from '../../types/general.types.js';
+/**
+ * How long `evaluate` waits, unless the caller gives its own `timeout`. A
+ * frontend waits for the first answer before its first page, thus a
+ * control-backend that does not answer must not hold the loading screen.
+ */
+export declare const EVALUATE_TIMEOUT_MS = 3000;
+export interface CreateFeatureFlagRequest extends RequestBaseParams {
+    params: CreateFeatureFlagDto;
+}
+export interface UpdateFeatureFlagRequest extends RequestBaseParams {
+    params: {
+        id: string;
+    } & UpdateFeatureFlagDto;
+}
+export interface FeatureFlagIdRequest extends RequestBaseParams {
+    params: {
+        id: string;
+    };
+}
+export interface EvaluateFeatureFlagsRequest extends RequestBaseParams {
+    /** The org of the caller. It must be in the org claim of the token. */
+    params: {
+        orgId?: string;
+    };
+}
+export declare class ControlFeatureFlagsService {
+    /** Every row of the stage, by key. Needs `READ_ALL`. */
+    static list(params: RequestBaseParams): Promise<FeatureFlagDto[]>;
+    /**
+     * The rows, and the versions of the table and of the Redis key. The page of
+     * Control compares the two, and warns while the other services read the
+     * rows before. Needs `READ_ALL`.
+     */
+    static listWithVersions(params: RequestBaseParams): Promise<FeatureFlagListDto>;
+    static create(params: CreateFeatureFlagRequest): Promise<FeatureFlagDto>;
+    /** A field that the request does not hold stays as it is. */
+    static update(params: UpdateFeatureFlagRequest): Promise<FeatureFlagDto>;
+    static remove(params: FeatureFlagIdRequest): Promise<void>;
+    /**
+     * The flags of the caller of the token. Needs a valid token and no
+     * permission. The email comes from the token alone.
+     *
+     * A 429 is NOT tried again. `request` tries a 429 up to 8 times with a
+     * growing wait, and `config.timeout` applies to each try, thus one call could
+     * hang for minutes. The caller has an answer of its own: the last answer,
+     * or the code before the first one. For the same reason the call stops
+     * after `EVALUATE_TIMEOUT_MS`, unless `config.timeout` says otherwise.
+     */
+    static evaluate(params: EvaluateFeatureFlagsRequest): Promise<FeatureFlagAnswer>;
+    private static send;
+}

package/dist/services/control/control.feature-flags.service.js

@@ -0,0 +1,123 @@
+import { request } from "../../utils/api.js";
+import { HttpError } from "../../utils/errors.js";
+const BASE = { id: "control" };
+const EVALUATE_TIMEOUT_MS = 3e3;
+class ControlFeatureFlagsService {
+  /** Every row of the stage, by key. Needs `READ_ALL`. */
+  static async list(params) {
+    const { flags } = await ControlFeatureFlagsService.listWithVersions(params);
+    return flags;
+  }
+  /**
+   * The rows, and the versions of the table and of the Redis key. The page of
+   * Control compares the two, and warns while the other services read the
+   * rows before. Needs `READ_ALL`.
+   */
+  static async listWithVersions(params) {
+    return ControlFeatureFlagsService.send(
+      params,
+      "list",
+      "api/feature-flags",
+      "api/feature-flags",
+      "get"
+    );
+  }
+  static async create(params) {
+    const { flag } = await ControlFeatureFlagsService.send(
+      params,
+      "create",
+      "api/feature-flags",
+      "api/feature-flags",
+      "post",
+      params.params
+    );
+    return flag;
+  }
+  /** A field that the request does not hold stays as it is. */
+  static async update(params) {
+    const { id, ...body } = params.params;
+    const { flag } = await ControlFeatureFlagsService.send(
+      params,
+      "update",
+      `api/feature-flags/${encodeURIComponent(id)}`,
+      "api/feature-flags/:id",
+      "patch",
+      body
+    );
+    return flag;
+  }
+  static async remove(params) {
+    await ControlFeatureFlagsService.send(
+      params,
+      "remove",
+      `api/feature-flags/${encodeURIComponent(params.params.id)}`,
+      "api/feature-flags/:id",
+      "delete"
+    );
+  }
+  /**
+   * The flags of the caller of the token. Needs a valid token and no
+   * permission. The email comes from the token alone.
+   *
+   * A 429 is NOT tried again. `request` tries a 429 up to 8 times with a
+   * growing wait, and `config.timeout` applies to each try, thus one call could
+   * hang for minutes. The caller has an answer of its own: the last answer,
+   * or the code before the first one. For the same reason the call stops
+   * after `EVALUATE_TIMEOUT_MS`, unless `config.timeout` says otherwise.
+   */
+  static async evaluate(params) {
+    const query = params.params.orgId ? `?orgId=${encodeURIComponent(params.params.orgId)}` : "";
+    return ControlFeatureFlagsService.send(
+      {
+        ...params,
+        config: {
+          ...params.config,
+          timeout: params.config.timeout ?? EVALUATE_TIMEOUT_MS
+        }
+      },
+      "evaluate",
+      `api/feature-flags/evaluate${query}`,
+      "api/feature-flags/evaluate",
+      "get",
+      void 0,
+      { attempts: 1, remaining: 0 }
+    );
+  }
+  static async send(params, name, url, normalizedUrl, method, body, retry) {
+    const serviceContext = {
+      method: {
+        name: `ControlFeatureFlagsService.${name}`,
+        url,
+        normalizedUrl,
+        type: method
+      },
+      source: params.config.metrics?.source || "unset",
+      target: { name: "control", type: "internal" }
+    };
+    const response = await request({
+      // `...params` first, so `cacheControl` and `onCachedResponse` reach the
+      // request. See the same note in `control.annotations.service.ts`.
+      ...params,
+      config: params.config,
+      base: BASE,
+      url,
+      method,
+      metricsDetails: serviceContext,
+      body,
+      retry
+    });
+    if (!response.ok) {
+      throw new HttpError(
+        `${serviceContext.method.name}: ${response.status} ${response.statusText}`,
+        response.status,
+        response.statusText
+      );
+    }
+    return response.body;
+  }
+}
+export {
+  ControlFeatureFlagsService,
+  EVALUATE_TIMEOUT_MS
+};
+//# sourceMappingURL=control.feature-flags.service.js.map

package/dist/services/control/control.feature-flags.service.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/services/control/control.feature-flags.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 {\n  CreateFeatureFlagDto,\n  FeatureFlagAnswer,\n  FeatureFlagDto,\n  FeatureFlagListDto,\n  UpdateFeatureFlagDto,\n} from '@camunda/ccma-shared-types'\nimport type {\n  RequestBaseMethodType,\n  RequestBaseParams,\n} from '../../types/general.types.js'\nimport { request } from '../../utils/api.js'\nimport { HttpError } from '../../utils/errors.js'\n\n/**\n * The feature flag table of control-backend.\n *\n * Each stage holds its own table, thus a row is the value of the flag on that\n * stage. `evaluate` answers the flags of the caller of the token, in the\n * shape of `FeatureFlagAnswer`.\n */\n\nconst BASE = { id: 'control' } as const\n\n/**\n * How long `evaluate` waits, unless the caller gives its own `timeout`. A\n * frontend waits for the first answer before its first page, thus a\n * control-backend that does not answer must not hold the loading screen.\n */\nexport const EVALUATE_TIMEOUT_MS = 3_000\n\nexport interface CreateFeatureFlagRequest extends RequestBaseParams {\n  params: CreateFeatureFlagDto\n}\n\nexport interface UpdateFeatureFlagRequest extends RequestBaseParams {\n  params: { id: string } & UpdateFeatureFlagDto\n}\n\nexport interface FeatureFlagIdRequest extends RequestBaseParams {\n  params: { id: string }\n}\n\nexport interface EvaluateFeatureFlagsRequest extends RequestBaseParams {\n  /** The org of the caller. It must be in the org claim of the token. */\n  params: { orgId?: string }\n}\n\nexport class ControlFeatureFlagsService {\n  /** Every row of the stage, by key. Needs `READ_ALL`. */\n  public static async list(\n    params: RequestBaseParams,\n  ): Promise<FeatureFlagDto[]> {\n    const { flags } = await ControlFeatureFlagsService.listWithVersions(params)\n    return flags\n  }\n\n  /**\n   * The rows, and the versions of the table and of the Redis key. The page of\n   * Control compares the two, and warns while the other services read the\n   * rows before. Needs `READ_ALL`.\n   */\n  public static async listWithVersions(\n    params: RequestBaseParams,\n  ): Promise<FeatureFlagListDto> {\n    return ControlFeatureFlagsService.send<FeatureFlagListDto>(\n      params,\n      'list',\n      'api/feature-flags',\n      'api/feature-flags',\n      'get',\n    )\n  }\n\n  public static async create(\n    params: CreateFeatureFlagRequest,\n  ): Promise<FeatureFlagDto> {\n    const { flag } = await ControlFeatureFlagsService.send<{\n      flag: FeatureFlagDto\n    }>(\n      params,\n      'create',\n      'api/feature-flags',\n      'api/feature-flags',\n      'post',\n      params.params,\n    )\n    return flag\n  }\n\n  /** A field that the request does not hold stays as it is. */\n  public static async update(\n    params: UpdateFeatureFlagRequest,\n  ): Promise<FeatureFlagDto> {\n    const { id, ...body } = params.params\n    const { flag } = await ControlFeatureFlagsService.send<{\n      flag: FeatureFlagDto\n    }>(\n      params,\n      'update',\n      `api/feature-flags/${encodeURIComponent(id)}`,\n      'api/feature-flags/:id',\n      'patch',\n      body,\n    )\n    return flag\n  }\n\n  public static async remove(params: FeatureFlagIdRequest): Promise<void> {\n    await ControlFeatureFlagsService.send<undefined>(\n      params,\n      'remove',\n      `api/feature-flags/${encodeURIComponent(params.params.id)}`,\n      'api/feature-flags/:id',\n      'delete',\n    )\n  }\n\n  /**\n   * The flags of the caller of the token. Needs a valid token and no\n   * permission. The email comes from the token alone.\n   *\n   * A 429 is NOT tried again. `request` tries a 429 up to 8 times with a\n   * growing wait, and `config.timeout` applies to each try, thus one call could\n   * hang for minutes. The caller has an answer of its own: the last answer,\n   * or the code before the first one. For the same reason the call stops\n   * after `EVALUATE_TIMEOUT_MS`, unless `config.timeout` says otherwise.\n   */\n  public static async evaluate(\n    params: EvaluateFeatureFlagsRequest,\n  ): Promise<FeatureFlagAnswer> {\n    const query = params.params.orgId\n      ? `?orgId=${encodeURIComponent(params.params.orgId)}`\n      : ''\n    return ControlFeatureFlagsService.send<FeatureFlagAnswer>(\n      {\n        ...params,\n        config: {\n          ...params.config,\n          timeout: params.config.timeout ?? EVALUATE_TIMEOUT_MS,\n        },\n      },\n      'evaluate',\n      `api/feature-flags/evaluate${query}`,\n      'api/feature-flags/evaluate',\n      'get',\n      undefined,\n      { attempts: 1, remaining: 0 },\n    )\n  }\n\n  private static async send<TResponse>(\n    params: RequestBaseParams,\n    name: string,\n    url: string,\n    normalizedUrl: string,\n    method: RequestBaseMethodType,\n    body?: object,\n    retry?: { attempts: number; remaining: number },\n  ): Promise<TResponse> {\n    const serviceContext = {\n      method: {\n        name: `ControlFeatureFlagsService.${name}`,\n        url,\n        normalizedUrl,\n        type: method,\n      },\n      source: params.config.metrics?.source || 'unset',\n      target: { name: 'control', type: 'internal' as const },\n    }\n    const response = await request<TResponse>({\n      // `...params` first, so `cacheControl` and `onCachedResponse` reach the\n      // request. See the same note in `control.annotations.service.ts`.\n      ...params,\n      config: params.config,\n      base: BASE,\n      url,\n      method,\n      metricsDetails: serviceContext,\n      body,\n      retry,\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    // `remove` answers 204 with no body, and its caller reads nothing.\n    return response.body as TResponse\n  }\n}\n"],
+  "mappings": "AAiBA,SAAS,eAAe;AACxB,SAAS,iBAAiB;AAU1B,MAAM,OAAO,EAAE,IAAI,UAAU;AAOtB,MAAM,sBAAsB;AAmB5B,MAAM,2BAA2B;AAAA;AAAA,EAEtC,aAAoB,KAClB,QAC2B;AAC3B,UAAM,EAAE,MAAM,IAAI,MAAM,2BAA2B,iBAAiB,MAAM;AAC1E,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,aAAoB,iBAClB,QAC6B;AAC7B,WAAO,2BAA2B;AAAA,MAChC;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAAA,EAEA,aAAoB,OAClB,QACyB;AACzB,UAAM,EAAE,KAAK,IAAI,MAAM,2BAA2B;AAAA,MAGhD;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,OAAO;AAAA,IACT;AACA,WAAO;AAAA,EACT;AAAA;AAAA,EAGA,aAAoB,OAClB,QACyB;AACzB,UAAM,EAAE,IAAI,GAAG,KAAK,IAAI,OAAO;AAC/B,UAAM,EAAE,KAAK,IAAI,MAAM,2BAA2B;AAAA,MAGhD;AAAA,MACA;AAAA,MACA,qBAAqB,mBAAmB,EAAE,CAAC;AAAA,MAC3C;AAAA,MACA;AAAA,MACA;AAAA,IACF;AACA,WAAO;AAAA,EACT;AAAA,EAEA,aAAoB,OAAO,QAA6C;AACtE,UAAM,2BAA2B;AAAA,MAC/B;AAAA,MACA;AAAA,MACA,qBAAqB,mBAAmB,OAAO,OAAO,EAAE,CAAC;AAAA,MACzD;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,aAAoB,SAClB,QAC4B;AAC5B,UAAM,QAAQ,OAAO,OAAO,QACxB,UAAU,mBAAmB,OAAO,OAAO,KAAK,CAAC,KACjD;AACJ,WAAO,2BAA2B;AAAA,MAChC;AAAA,QACE,GAAG;AAAA,QACH,QAAQ;AAAA,UACN,GAAG,OAAO;AAAA,UACV,SAAS,OAAO,OAAO,WAAW;AAAA,QACpC;AAAA,MACF;AAAA,MACA;AAAA,MACA,6BAA6B,KAAK;AAAA,MAClC;AAAA,MACA;AAAA,MACA;AAAA,MACA,EAAE,UAAU,GAAG,WAAW,EAAE;AAAA,IAC9B;AAAA,EACF;AAAA,EAEA,aAAqB,KACnB,QACA,MACA,KACA,eACA,QACA,MACA,OACoB;AACpB,UAAM,iBAAiB;AAAA,MACrB,QAAQ;AAAA,QACN,MAAM,8BAA8B,IAAI;AAAA,QACxC;AAAA,QACA;AAAA,QACA,MAAM;AAAA,MACR;AAAA,MACA,QAAQ,OAAO,OAAO,SAAS,UAAU;AAAA,MACzC,QAAQ,EAAE,MAAM,WAAW,MAAM,WAAoB;AAAA,IACvD;AACA,UAAM,WAAW,MAAM,QAAmB;AAAA;AAAA;AAAA,MAGxC,GAAG;AAAA,MACH,QAAQ,OAAO;AAAA,MACf,MAAM;AAAA,MACN;AAAA,MACA;AAAA,MACA,gBAAgB;AAAA,MAChB;AAAA,MACA;AAAA,IACF,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;AAEA,WAAO,SAAS;AAAA,EAClB;AACF;",
+  "names": []
+}

package/dist/services/control/control.feature-flags.service.spec.d.ts

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

package/dist/services/control/control.platform.service.d.ts

@@ -19,6 +19,20 @@ export interface ControlWhoamiDto {
     /** The raw permission claims, HiBob roles included. */
     permissions: string[];
 }
+/** The build of control-backend, as `GET /info` reports it. */
+export interface ControlInfoDto {
+    info: {
+        /**
+         * The short commit SHA that CI gives the image. Two values name no
+         * commit: `local` when `SHORT_SHA` is not set, and an empty string for an
+         * image built with no `SHORT_SHA`, as the CI check builds it.
+         */
+        shortSha: string;
+        /** The git ref of the build: `main` on dev, the release tag on int and prod. */
+        version: string;
+    };
+}
 export declare class ControlPlatformService {
+    static info(params: RequestBaseParams): Promise<ControlInfoDto>;
     static whoami(params: RequestBaseParams): Promise<ControlWhoamiDto>;
 }

package/dist/services/control/control.platform.service.js

@@ -2,6 +2,33 @@ import { request } from "../../utils/api.js";
 import { HttpError } from "../../utils/errors.js";
 const BASE = { id: "control" };
 class ControlPlatformService {
+  static async info(params) {
+    const serviceContext = {
+      method: {
+        name: "ControlPlatformService.info",
+        url: "info",
+        normalizedUrl: "info",
+        type: "get"
+      },
+      source: params.config.metrics?.source || "unset",
+      target: { name: "control", type: "internal" }
+    };
+    const response = await request({
+      config: params.config,
+      base: BASE,
+      url: serviceContext.method.url,
+      method: "get",
+      metricsDetails: serviceContext
+    });
+    if (!response.ok || !response.body) {
+      throw new HttpError(
+        `${serviceContext.method.name}: ${response.status} ${response.statusText}`,
+        response.status,
+        response.statusText
+      );
+    }
+    return response.body;
+  }
   static async whoami(params) {
     const serviceContext = {
       method: {

package/dist/services/control/control.platform.service.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/services/control/control.platform.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 { RequestBaseParams } from '../../types/general.types.js'\nimport { request } from '../../utils/api.js'\nimport { HttpError } from '../../utils/errors.js'\n\n/**\n * The platform routes of control-backend. They carry no business rule.\n *\n * `whoami` is the one that a frontend needs: it reports the identity that\n * control-backend built from the token of the caller, with the permission\n * claims that the token carries. Every rule of the approval mechanism runs\n * against THAT actor, so a view that wants to disable a button the service\n * would refuse has to ask this route and not another service.\n */\n\nconst BASE = { id: 'control' } as const\n\n/** The actor of control-backend, as `GET /api/whoami` reports it. */\nexport interface ControlWhoamiDto {\n  /** The `sub` claim of the token. */\n  userId: string\n  /**\n   * The address of the caller, as control-backend resolves it.\n   *\n   * Three sources, and the service holds their order: the namespaced claim, a\n   * top-level `email` claim, and the subject of the token. A token that names\n   * no person \u2014 a machine token \u2014 answers `UNKNOWN_ACTOR_EMAIL` and never an\n   * empty string, because `emailFromClaims` of `shared-backend-fastify` ends\n   * its chain with that value. The rules of the approval policy read it as\n   * \"no person\": `isSameActorEmail` holds that two unknown addresses are not\n   * one human, and `hasActorEmail` answers false for it. A reader that tests\n   * for an empty string instead would take a machine for a person.\n   */\n  email: string\n  /** The raw permission claims, HiBob roles included. */\n  permissions: string[]\n}\n\nexport class ControlPlatformService {\n  public static async whoami(\n    params: RequestBaseParams,\n  ): Promise<ControlWhoamiDto> {\n    const serviceContext = {\n      method: {\n        name: 'ControlPlatformService.whoami',\n        url: 'api/whoami',\n        normalizedUrl: 'api/whoami',\n        type: 'get' as const,\n      },\n      source: params.config.metrics?.source || 'unset',\n      target: { name: 'control', type: 'internal' as const },\n    }\n    const response = await request<ControlWhoamiDto>({\n      config: params.config,\n      base: BASE,\n      url: serviceContext.method.url,\n      method: 'get',\n      metricsDetails: serviceContext,\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 response.body!\n  }\n}\n"],
-  "mappings": "AAOA,SAAS,eAAe;AACxB,SAAS,iBAAiB;AAY1B,MAAM,OAAO,EAAE,IAAI,UAAU;AAuBtB,MAAM,uBAAuB;AAAA,EAClC,aAAoB,OAClB,QAC2B;AAC3B,UAAM,iBAAiB;AAAA,MACrB,QAAQ;AAAA,QACN,MAAM;AAAA,QACN,KAAK;AAAA,QACL,eAAe;AAAA,QACf,MAAM;AAAA,MACR;AAAA,MACA,QAAQ,OAAO,OAAO,SAAS,UAAU;AAAA,MACzC,QAAQ,EAAE,MAAM,WAAW,MAAM,WAAoB;AAAA,IACvD;AACA,UAAM,WAAW,MAAM,QAA0B;AAAA,MAC/C,QAAQ,OAAO;AAAA,MACf,MAAM;AAAA,MACN,KAAK,eAAe,OAAO;AAAA,MAC3B,QAAQ;AAAA,MACR,gBAAgB;AAAA,IAClB,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,WAAO,SAAS;AAAA,EAClB;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 type { RequestBaseParams } from '../../types/general.types.js'\nimport { request } from '../../utils/api.js'\nimport { HttpError } from '../../utils/errors.js'\n\n/**\n * The platform routes of control-backend. They carry no business rule.\n *\n * `whoami` is the one that the approval views need: it reports the identity that\n * control-backend built from the token of the caller, with the permission\n * claims that the token carries. Every rule of the approval mechanism runs\n * against THAT actor, so a view that wants to disable a button the service\n * would refuse has to ask this route and not another service.\n */\n\nconst BASE = { id: 'control' } as const\n\n/** The actor of control-backend, as `GET /api/whoami` reports it. */\nexport interface ControlWhoamiDto {\n  /** The `sub` claim of the token. */\n  userId: string\n  /**\n   * The address of the caller, as control-backend resolves it.\n   *\n   * Three sources, and the service holds their order: the namespaced claim, a\n   * top-level `email` claim, and the subject of the token. A token that names\n   * no person \u2014 a machine token \u2014 answers `UNKNOWN_ACTOR_EMAIL` and never an\n   * empty string, because `emailFromClaims` of `shared-backend-fastify` ends\n   * its chain with that value. The rules of the approval policy read it as\n   * \"no person\": `isSameActorEmail` holds that two unknown addresses are not\n   * one human, and `hasActorEmail` answers false for it. A reader that tests\n   * for an empty string instead would take a machine for a person.\n   */\n  email: string\n  /** The raw permission claims, HiBob roles included. */\n  permissions: string[]\n}\n\n/** The build of control-backend, as `GET /info` reports it. */\nexport interface ControlInfoDto {\n  info: {\n    /**\n     * The short commit SHA that CI gives the image. Two values name no\n     * commit: `local` when `SHORT_SHA` is not set, and an empty string for an\n     * image built with no `SHORT_SHA`, as the CI check builds it.\n     */\n    shortSha: string\n    /** The git ref of the build: `main` on dev, the release tag on int and prod. */\n    version: string\n  }\n}\n\nexport class ControlPlatformService {\n  public static async info(params: RequestBaseParams): Promise<ControlInfoDto> {\n    const serviceContext = {\n      method: {\n        name: 'ControlPlatformService.info',\n        url: 'info',\n        normalizedUrl: 'info',\n        type: 'get' as const,\n      },\n      source: params.config.metrics?.source || 'unset',\n      target: { name: 'control', type: 'internal' as const },\n    }\n    const response = await request<ControlInfoDto>({\n      config: params.config,\n      base: BASE,\n      url: serviceContext.method.url,\n      method: 'get',\n      metricsDetails: serviceContext,\n    })\n    if (!response.ok || !response.body) {\n      throw new HttpError(\n        `${serviceContext.method.name}: ${response.status} ${response.statusText}`,\n        response.status,\n        response.statusText,\n      )\n    }\n    return response.body\n  }\n\n  public static async whoami(\n    params: RequestBaseParams,\n  ): Promise<ControlWhoamiDto> {\n    const serviceContext = {\n      method: {\n        name: 'ControlPlatformService.whoami',\n        url: 'api/whoami',\n        normalizedUrl: 'api/whoami',\n        type: 'get' as const,\n      },\n      source: params.config.metrics?.source || 'unset',\n      target: { name: 'control', type: 'internal' as const },\n    }\n    const response = await request<ControlWhoamiDto>({\n      config: params.config,\n      base: BASE,\n      url: serviceContext.method.url,\n      method: 'get',\n      metricsDetails: serviceContext,\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 response.body!\n  }\n}\n"],
+  "mappings": "AAOA,SAAS,eAAe;AACxB,SAAS,iBAAiB;AAY1B,MAAM,OAAO,EAAE,IAAI,UAAU;AAqCtB,MAAM,uBAAuB;AAAA,EAClC,aAAoB,KAAK,QAAoD;AAC3E,UAAM,iBAAiB;AAAA,MACrB,QAAQ;AAAA,QACN,MAAM;AAAA,QACN,KAAK;AAAA,QACL,eAAe;AAAA,QACf,MAAM;AAAA,MACR;AAAA,MACA,QAAQ,OAAO,OAAO,SAAS,UAAU;AAAA,MACzC,QAAQ,EAAE,MAAM,WAAW,MAAM,WAAoB;AAAA,IACvD;AACA,UAAM,WAAW,MAAM,QAAwB;AAAA,MAC7C,QAAQ,OAAO;AAAA,MACf,MAAM;AAAA,MACN,KAAK,eAAe,OAAO;AAAA,MAC3B,QAAQ;AAAA,MACR,gBAAgB;AAAA,IAClB,CAAC;AACD,QAAI,CAAC,SAAS,MAAM,CAAC,SAAS,MAAM;AAClC,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,WAAO,SAAS;AAAA,EAClB;AAAA,EAEA,aAAoB,OAClB,QAC2B;AAC3B,UAAM,iBAAiB;AAAA,MACrB,QAAQ;AAAA,QACN,MAAM;AAAA,QACN,KAAK;AAAA,QACL,eAAe;AAAA,QACf,MAAM;AAAA,MACR;AAAA,MACA,QAAQ,OAAO,OAAO,SAAS,UAAU;AAAA,MACzC,QAAQ,EAAE,MAAM,WAAW,MAAM,WAAoB;AAAA,IACvD;AACA,UAAM,WAAW,MAAM,QAA0B;AAAA,MAC/C,QAAQ,OAAO;AAAA,MACf,MAAM;AAAA,MACN,KAAK,eAAe,OAAO;AAAA,MAC3B,QAAQ;AAAA,MACR,gBAAgB;AAAA,IAClB,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,WAAO,SAAS;AAAA,EAClB;AACF;",
   "names": []
 }

package/dist/services/control/control.platform.service.spec.d.ts

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

package/dist/services/external/external.accounts.service.d.ts

@@ -1,4 +1,4 @@
-import type { ExternalClickwrapConfigDto, ExternalOrganizationDto, Features } from '@camunda/ccma-shared-types';
+import type { ExternalClickwrapConfigDto, ExternalOrganizationDto, FeatureFlagAnswer } from '@camunda/ccma-shared-types';
 import type { RequestBaseParams } from '../../types/general.types.js';
 export type UserThemePreference = 'light' | 'dark' | 'system';
 export interface UpdateUserThemeParams extends RequestBaseParams {
@@ -37,7 +37,7 @@ export declare class ExternalAccountsService {
      * stage that the client thinks it runs on. The email comes from the access
      * token alone.
      */
-    static getFeatureFlags(params: GetFeatureFlagsParams): Promise<Features>;
+    static getFeatureFlags(params: GetFeatureFlagsParams): Promise<FeatureFlagAnswer>;
     /**
      * The clickwrap config for the opt-in to alpha features
      * (`GET external/clickwrap-config`). The deployed accounts-backend owns the

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

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/services/external/external.accounts.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 {\n  ExternalClickwrapConfigDto,\n  ExternalOrganizationDto,\n  Features,\n} 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 type UserThemePreference = 'light' | 'dark' | 'system'\n\nexport interface UpdateUserThemeParams extends RequestBaseParams {\n  theme: UserThemePreference\n}\n\nexport interface GetFeatureFlagsParams extends RequestBaseParams {\n  params?: {\n    /**\n     * The organization to evaluate the org-scoped flags for. Omit it before\n     * the user selects an organization. The caller must be a member, because\n     * the backend answers 403 for every other organization.\n     */\n    orgId?: string\n  }\n}\n\n/**\n * Accounts backend **external** (CORS-enabled) endpoints used to build webapp\n * navigation. Distinct from `OrgsService`/`UsersService`, which target the\n * internal accounts API with admin-scoped DTOs. Use this from any Camunda\n * webapp (console, modeler, operate, \u2026); use the internal services from\n * console/accounts' own admin surfaces.\n */\nexport class ExternalAccountsService {\n  /**\n   * Organizations the current user belongs to\n   * (`GET external/organizations/my`). Source for the org breadcrumb and the\n   * organization switcher.\n   */\n  public static async getMyOrganizations(\n    params: RequestBaseParams,\n  ): Promise<ExternalOrganizationDto[]> {\n    const serviceContext: RequestBaseServiceContext = {\n      method: {\n        name: 'ExternalAccountsService.getMyOrganizations',\n        url: 'external/organizations/my',\n        normalizedUrl: 'external/organizations/my',\n        type: 'get',\n      },\n      source: params.config.metrics?.source || 'unset',\n      target: {\n        name: 'accounts',\n        type: 'internal',\n      },\n    }\n\n    const response = await request<ExternalOrganizationDto[]>({\n      ...params,\n      base: { id: 'accounts' },\n      url: serviceContext.method.url,\n      method: serviceContext.method.type,\n      metricsDetails: serviceContext,\n      responseType: 'json',\n    })\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\n    return response.body ?? []\n  }\n\n  /**\n   * The evaluated feature flags for the current user\n   * (`GET external/feature-flags`). The deployed accounts-backend decides the\n   * values, thus a host does not hold a copy of the rules.\n   *\n   * The stage of the flags is the stage of the backend that answers, not the\n   * stage that the client thinks it runs on. The email comes from the access\n   * token alone.\n   */\n  public static async getFeatureFlags(\n    params: GetFeatureFlagsParams,\n  ): Promise<Features> {\n    const orgId = params.params?.orgId\n    const serviceContext: RequestBaseServiceContext = {\n      method: {\n        name: 'ExternalAccountsService.getFeatureFlags',\n        url: orgId\n          ? `external/feature-flags?orgId=${encodeURIComponent(orgId)}`\n          : 'external/feature-flags',\n        normalizedUrl: 'external/feature-flags',\n        type: 'get',\n      },\n      source: params.config.metrics?.source || 'unset',\n      target: {\n        name: 'accounts',\n        type: 'internal',\n      },\n    }\n\n    const response = await request<Features>({\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\n    if (!response.ok || !response.body) {\n      throw new HttpError(\n        `${serviceContext.method.name}: ${response.status} ${response.statusText}`,\n        response.status,\n        response.statusText,\n      )\n    }\n\n    return response.body\n  }\n\n  /**\n   * The clickwrap config for the opt-in to alpha features\n   * (`GET external/clickwrap-config`). The deployed accounts-backend owns the\n   * PactSafe identifiers, thus a host does not hold a copy.\n   *\n   * A field is absent when the backend has no value for it. A host with no\n   * `accessId` shows no opt-in.\n   */\n  public static async getClickwrapConfig(\n    params: RequestBaseParams,\n  ): Promise<ExternalClickwrapConfigDto> {\n    const serviceContext: RequestBaseServiceContext = {\n      method: {\n        name: 'ExternalAccountsService.getClickwrapConfig',\n        url: 'external/clickwrap-config',\n        normalizedUrl: 'external/clickwrap-config',\n        type: 'get',\n      },\n      source: params.config.metrics?.source || 'unset',\n      target: {\n        name: 'accounts',\n        type: 'internal',\n      },\n    }\n\n    const response = await request<ExternalClickwrapConfigDto>({\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\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\n    return response.body ?? {}\n  }\n\n  /**\n   * Persist the user's theme preference (`PATCH external/user/theme`). The\n   * backend stores it on the user profile and reflects it in the next access\n   * token's `https://camunda.com/settings.theme` claim. Response is empty.\n   */\n  public static async updateUserTheme(\n    params: UpdateUserThemeParams,\n  ): Promise<void> {\n    const serviceContext: RequestBaseServiceContext = {\n      method: {\n        name: 'ExternalAccountsService.updateUserTheme',\n        url: 'external/user/theme',\n        normalizedUrl: 'external/user/theme',\n        type: 'patch',\n      },\n      source: params.config.metrics?.source || 'unset',\n      target: {\n        name: 'accounts',\n        type: 'internal',\n      },\n    }\n\n    const response = await request({\n      config: params.config,\n      base: { id: 'accounts' },\n      url: serviceContext.method.url,\n      method: serviceContext.method.type,\n      metricsDetails: serviceContext,\n      body: { theme: params.theme },\n      responseType: 'none',\n    })\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  }\n}\n"],
-  "mappings": "AAeA,SAAS,eAAe;AACxB,SAAS,iBAAiB;AA0BnB,MAAM,wBAAwB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMnC,aAAoB,mBAClB,QACoC;AACpC,UAAM,iBAA4C;AAAA,MAChD,QAAQ;AAAA,QACN,MAAM;AAAA,QACN,KAAK;AAAA,QACL,eAAe;AAAA,QACf,MAAM;AAAA,MACR;AAAA,MACA,QAAQ,OAAO,OAAO,SAAS,UAAU;AAAA,MACzC,QAAQ;AAAA,QACN,MAAM;AAAA,QACN,MAAM;AAAA,MACR;AAAA,IACF;AAEA,UAAM,WAAW,MAAM,QAAmC;AAAA,MACxD,GAAG;AAAA,MACH,MAAM,EAAE,IAAI,WAAW;AAAA,MACvB,KAAK,eAAe,OAAO;AAAA,MAC3B,QAAQ,eAAe,OAAO;AAAA,MAC9B,gBAAgB;AAAA,MAChB,cAAc;AAAA,IAChB,CAAC;AAED,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;AAEA,WAAO,SAAS,QAAQ,CAAC;AAAA,EAC3B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,aAAoB,gBAClB,QACmB;AACnB,UAAM,QAAQ,OAAO,QAAQ;AAC7B,UAAM,iBAA4C;AAAA,MAChD,QAAQ;AAAA,QACN,MAAM;AAAA,QACN,KAAK,QACD,gCAAgC,mBAAmB,KAAK,CAAC,KACzD;AAAA,QACJ,eAAe;AAAA,QACf,MAAM;AAAA,MACR;AAAA,MACA,QAAQ,OAAO,OAAO,SAAS,UAAU;AAAA,MACzC,QAAQ;AAAA,QACN,MAAM;AAAA,QACN,MAAM;AAAA,MACR;AAAA,IACF;AAEA,UAAM,WAAW,MAAM,QAAkB;AAAA,MACvC,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;AAED,QAAI,CAAC,SAAS,MAAM,CAAC,SAAS,MAAM;AAClC,YAAM,IAAI;AAAA,QACR,GAAG,eAAe,OAAO,IAAI,KAAK,SAAS,MAAM,IAAI,SAAS,UAAU;AAAA,QACxE,SAAS;AAAA,QACT,SAAS;AAAA,MACX;AAAA,IACF;AAEA,WAAO,SAAS;AAAA,EAClB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,aAAoB,mBAClB,QACqC;AACrC,UAAM,iBAA4C;AAAA,MAChD,QAAQ;AAAA,QACN,MAAM;AAAA,QACN,KAAK;AAAA,QACL,eAAe;AAAA,QACf,MAAM;AAAA,MACR;AAAA,MACA,QAAQ,OAAO,OAAO,SAAS,UAAU;AAAA,MACzC,QAAQ;AAAA,QACN,MAAM;AAAA,QACN,MAAM;AAAA,MACR;AAAA,IACF;AAEA,UAAM,WAAW,MAAM,QAAoC;AAAA,MACzD,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;AAED,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;AAEA,WAAO,SAAS,QAAQ,CAAC;AAAA,EAC3B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,aAAoB,gBAClB,QACe;AACf,UAAM,iBAA4C;AAAA,MAChD,QAAQ;AAAA,QACN,MAAM;AAAA,QACN,KAAK;AAAA,QACL,eAAe;AAAA,QACf,MAAM;AAAA,MACR;AAAA,MACA,QAAQ,OAAO,OAAO,SAAS,UAAU;AAAA,MACzC,QAAQ;AAAA,QACN,MAAM;AAAA,QACN,MAAM;AAAA,MACR;AAAA,IACF;AAEA,UAAM,WAAW,MAAM,QAAQ;AAAA,MAC7B,QAAQ,OAAO;AAAA,MACf,MAAM,EAAE,IAAI,WAAW;AAAA,MACvB,KAAK,eAAe,OAAO;AAAA,MAC3B,QAAQ,eAAe,OAAO;AAAA,MAC9B,gBAAgB;AAAA,MAChB,MAAM,EAAE,OAAO,OAAO,MAAM;AAAA,MAC5B,cAAc;AAAA,IAChB,CAAC;AAED,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;AAAA,EACF;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 type {\n  ExternalClickwrapConfigDto,\n  ExternalOrganizationDto,\n  FeatureFlagAnswer,\n} 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 type UserThemePreference = 'light' | 'dark' | 'system'\n\nexport interface UpdateUserThemeParams extends RequestBaseParams {\n  theme: UserThemePreference\n}\n\nexport interface GetFeatureFlagsParams extends RequestBaseParams {\n  params?: {\n    /**\n     * The organization to evaluate the org-scoped flags for. Omit it before\n     * the user selects an organization. The caller must be a member, because\n     * the backend answers 403 for every other organization.\n     */\n    orgId?: string\n  }\n}\n\n/**\n * Accounts backend **external** (CORS-enabled) endpoints used to build webapp\n * navigation. Distinct from `OrgsService`/`UsersService`, which target the\n * internal accounts API with admin-scoped DTOs. Use this from any Camunda\n * webapp (console, modeler, operate, \u2026); use the internal services from\n * console/accounts' own admin surfaces.\n */\nexport class ExternalAccountsService {\n  /**\n   * Organizations the current user belongs to\n   * (`GET external/organizations/my`). Source for the org breadcrumb and the\n   * organization switcher.\n   */\n  public static async getMyOrganizations(\n    params: RequestBaseParams,\n  ): Promise<ExternalOrganizationDto[]> {\n    const serviceContext: RequestBaseServiceContext = {\n      method: {\n        name: 'ExternalAccountsService.getMyOrganizations',\n        url: 'external/organizations/my',\n        normalizedUrl: 'external/organizations/my',\n        type: 'get',\n      },\n      source: params.config.metrics?.source || 'unset',\n      target: {\n        name: 'accounts',\n        type: 'internal',\n      },\n    }\n\n    const response = await request<ExternalOrganizationDto[]>({\n      ...params,\n      base: { id: 'accounts' },\n      url: serviceContext.method.url,\n      method: serviceContext.method.type,\n      metricsDetails: serviceContext,\n      responseType: 'json',\n    })\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\n    return response.body ?? []\n  }\n\n  /**\n   * The evaluated feature flags for the current user\n   * (`GET external/feature-flags`). The deployed accounts-backend decides the\n   * values, thus a host does not hold a copy of the rules.\n   *\n   * The stage of the flags is the stage of the backend that answers, not the\n   * stage that the client thinks it runs on. The email comes from the access\n   * token alone.\n   */\n  public static async getFeatureFlags(\n    params: GetFeatureFlagsParams,\n  ): Promise<FeatureFlagAnswer> {\n    const orgId = params.params?.orgId\n    const serviceContext: RequestBaseServiceContext = {\n      method: {\n        name: 'ExternalAccountsService.getFeatureFlags',\n        url: orgId\n          ? `external/feature-flags?orgId=${encodeURIComponent(orgId)}`\n          : 'external/feature-flags',\n        normalizedUrl: 'external/feature-flags',\n        type: 'get',\n      },\n      source: params.config.metrics?.source || 'unset',\n      target: {\n        name: 'accounts',\n        type: 'internal',\n      },\n    }\n\n    const response = await request<FeatureFlagAnswer>({\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\n    if (!response.ok || !response.body) {\n      throw new HttpError(\n        `${serviceContext.method.name}: ${response.status} ${response.statusText}`,\n        response.status,\n        response.statusText,\n      )\n    }\n\n    return response.body\n  }\n\n  /**\n   * The clickwrap config for the opt-in to alpha features\n   * (`GET external/clickwrap-config`). The deployed accounts-backend owns the\n   * PactSafe identifiers, thus a host does not hold a copy.\n   *\n   * A field is absent when the backend has no value for it. A host with no\n   * `accessId` shows no opt-in.\n   */\n  public static async getClickwrapConfig(\n    params: RequestBaseParams,\n  ): Promise<ExternalClickwrapConfigDto> {\n    const serviceContext: RequestBaseServiceContext = {\n      method: {\n        name: 'ExternalAccountsService.getClickwrapConfig',\n        url: 'external/clickwrap-config',\n        normalizedUrl: 'external/clickwrap-config',\n        type: 'get',\n      },\n      source: params.config.metrics?.source || 'unset',\n      target: {\n        name: 'accounts',\n        type: 'internal',\n      },\n    }\n\n    const response = await request<ExternalClickwrapConfigDto>({\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\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\n    return response.body ?? {}\n  }\n\n  /**\n   * Persist the user's theme preference (`PATCH external/user/theme`). The\n   * backend stores it on the user profile and reflects it in the next access\n   * token's `https://camunda.com/settings.theme` claim. Response is empty.\n   */\n  public static async updateUserTheme(\n    params: UpdateUserThemeParams,\n  ): Promise<void> {\n    const serviceContext: RequestBaseServiceContext = {\n      method: {\n        name: 'ExternalAccountsService.updateUserTheme',\n        url: 'external/user/theme',\n        normalizedUrl: 'external/user/theme',\n        type: 'patch',\n      },\n      source: params.config.metrics?.source || 'unset',\n      target: {\n        name: 'accounts',\n        type: 'internal',\n      },\n    }\n\n    const response = await request({\n      config: params.config,\n      base: { id: 'accounts' },\n      url: serviceContext.method.url,\n      method: serviceContext.method.type,\n      metricsDetails: serviceContext,\n      body: { theme: params.theme },\n      responseType: 'none',\n    })\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  }\n}\n"],
+  "mappings": "AAeA,SAAS,eAAe;AACxB,SAAS,iBAAiB;AA0BnB,MAAM,wBAAwB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMnC,aAAoB,mBAClB,QACoC;AACpC,UAAM,iBAA4C;AAAA,MAChD,QAAQ;AAAA,QACN,MAAM;AAAA,QACN,KAAK;AAAA,QACL,eAAe;AAAA,QACf,MAAM;AAAA,MACR;AAAA,MACA,QAAQ,OAAO,OAAO,SAAS,UAAU;AAAA,MACzC,QAAQ;AAAA,QACN,MAAM;AAAA,QACN,MAAM;AAAA,MACR;AAAA,IACF;AAEA,UAAM,WAAW,MAAM,QAAmC;AAAA,MACxD,GAAG;AAAA,MACH,MAAM,EAAE,IAAI,WAAW;AAAA,MACvB,KAAK,eAAe,OAAO;AAAA,MAC3B,QAAQ,eAAe,OAAO;AAAA,MAC9B,gBAAgB;AAAA,MAChB,cAAc;AAAA,IAChB,CAAC;AAED,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;AAEA,WAAO,SAAS,QAAQ,CAAC;AAAA,EAC3B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,aAAoB,gBAClB,QAC4B;AAC5B,UAAM,QAAQ,OAAO,QAAQ;AAC7B,UAAM,iBAA4C;AAAA,MAChD,QAAQ;AAAA,QACN,MAAM;AAAA,QACN,KAAK,QACD,gCAAgC,mBAAmB,KAAK,CAAC,KACzD;AAAA,QACJ,eAAe;AAAA,QACf,MAAM;AAAA,MACR;AAAA,MACA,QAAQ,OAAO,OAAO,SAAS,UAAU;AAAA,MACzC,QAAQ;AAAA,QACN,MAAM;AAAA,QACN,MAAM;AAAA,MACR;AAAA,IACF;AAEA,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;AAED,QAAI,CAAC,SAAS,MAAM,CAAC,SAAS,MAAM;AAClC,YAAM,IAAI;AAAA,QACR,GAAG,eAAe,OAAO,IAAI,KAAK,SAAS,MAAM,IAAI,SAAS,UAAU;AAAA,QACxE,SAAS;AAAA,QACT,SAAS;AAAA,MACX;AAAA,IACF;AAEA,WAAO,SAAS;AAAA,EAClB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,aAAoB,mBAClB,QACqC;AACrC,UAAM,iBAA4C;AAAA,MAChD,QAAQ;AAAA,QACN,MAAM;AAAA,QACN,KAAK;AAAA,QACL,eAAe;AAAA,QACf,MAAM;AAAA,MACR;AAAA,MACA,QAAQ,OAAO,OAAO,SAAS,UAAU;AAAA,MACzC,QAAQ;AAAA,QACN,MAAM;AAAA,QACN,MAAM;AAAA,MACR;AAAA,IACF;AAEA,UAAM,WAAW,MAAM,QAAoC;AAAA,MACzD,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;AAED,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;AAEA,WAAO,SAAS,QAAQ,CAAC;AAAA,EAC3B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,aAAoB,gBAClB,QACe;AACf,UAAM,iBAA4C;AAAA,MAChD,QAAQ;AAAA,QACN,MAAM;AAAA,QACN,KAAK;AAAA,QACL,eAAe;AAAA,QACf,MAAM;AAAA,MACR;AAAA,MACA,QAAQ,OAAO,OAAO,SAAS,UAAU;AAAA,MACzC,QAAQ;AAAA,QACN,MAAM;AAAA,QACN,MAAM;AAAA,MACR;AAAA,IACF;AAEA,UAAM,WAAW,MAAM,QAAQ;AAAA,MAC7B,QAAQ,OAAO;AAAA,MACf,MAAM,EAAE,IAAI,WAAW;AAAA,MACvB,KAAK,eAAe,OAAO;AAAA,MAC3B,QAAQ,eAAe,OAAO;AAAA,MAC9B,gBAAgB;AAAA,MAChB,MAAM,EAAE,OAAO,OAAO,MAAM;AAAA,MAC5B,cAAc;AAAA,IAChB,CAAC;AAED,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;AAAA,EACF;AACF;",
   "names": []
 }

package/dist/services/github/github.service.d.ts

@@ -34,8 +34,13 @@ export interface GithubRelease {
     url: string;
     tag_name: string;
     body: string;
+    /** The date of the tagged commit, not of the release. */
     created_at: string;
     prerelease: boolean;
+    html_url?: string;
+    /** When the release was made. A draft has none. */
+    published_at?: string | undefined;
+    draft?: boolean;
 }
 export interface GithubListDirectoryContentRequest extends RequestBaseParams {
     options: {
@@ -64,6 +69,20 @@ export interface GithubContentItem {
     download_url: string | undefined;
     type: string;
 }
+export interface GithubCompareCommitsRequest extends RequestBaseParams {
+    options: {
+        owner: string;
+        repo: string;
+        apiToken: string;
+        base: string;
+        head: string;
+    };
+}
+export interface GithubCommitComparison {
+    /** Commits that `head` has and `base` does not have. */
+    aheadBy: number;
+    htmlUrl: string;
+}
 export declare class GithubService {
     static getNextBugfixReleaseVersion(params: GithubGetNextBugfixReleaseVersionRequest): Promise<string>;
     static listMajorMinorReleases(params: GithubListMajorMinorReleasesRequest): Promise<GithubRelease[]>;
@@ -71,4 +90,5 @@ export declare class GithubService {
     static getReleases(params: GithubListReleasesRequest): Promise<GithubRelease[]>;
     static listDirectoryContent(params: GithubListDirectoryContentRequest): Promise<GithubContentItem[]>;
     static getRawFile(params: GithubGetRawFileRequest): Promise<string>;
+    static compareCommits(params: GithubCompareCommitsRequest): Promise<GithubCommitComparison>;
 }