@camunda/ccma-api 0.1.0 → 0.3.0

package/dist/services/external/external.notifications.service.js

@@ -0,0 +1,220 @@
+import { request } from "../../utils/api.js";
+import { getEnvParam } from "../../utils/environments.js";
+import { HttpError } from "../../utils/errors.js";
+import {
+  connectSse
+} from "../../utils/sse.js";
+class ExternalNotificationsService {
+  /** The user's notifications for an org (`GET notifications/orgs/:orgId`). */
+  static async getUserNotifications(params) {
+    const serviceContext = {
+      method: {
+        name: "ExternalNotificationsService.getUserNotifications",
+        url: `notifications/orgs/${params.params.orgId}`,
+        normalizedUrl: "notifications/orgs/:orgId",
+        type: "get"
+      },
+      source: params.config.metrics?.source || "unset",
+      target: {
+        name: "notifications",
+        type: "internal"
+      }
+    };
+    const response = await request({
+      ...params,
+      base: { id: "notifications" },
+      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 ?? [];
+  }
+  /**
+   * Mark a single notification read or dismissed
+   * (`PATCH notifications/:uuid/:state`).
+   */
+  static async setNotificationState(params) {
+    const serviceContext = {
+      method: {
+        name: "ExternalNotificationsService.setNotificationState",
+        url: `notifications/${params.params.uuid}/${params.params.state}`,
+        normalizedUrl: "notifications/:uuid/:state",
+        type: "patch"
+      },
+      source: params.config.metrics?.source || "unset",
+      target: {
+        name: "notifications",
+        type: "internal"
+      }
+    };
+    const response = await request({
+      config: params.config,
+      base: { id: "notifications" },
+      url: serviceContext.method.url,
+      method: serviceContext.method.type,
+      metricsDetails: serviceContext,
+      responseType: "none"
+    });
+    if (!response.ok) {
+      throw new HttpError(
+        `${serviceContext.method.name}: ${response.status} ${response.statusText}`,
+        response.status,
+        response.statusText
+      );
+    }
+  }
+  /**
+   * Mark many notifications read in one call
+   * (`PATCH notifications/batch/state/read`, body `{ uuids }`). No-op for an
+   * empty list.
+   */
+  static async markManyAsRead(params) {
+    if (params.params.uuids.length === 0) {
+      return;
+    }
+    const serviceContext = {
+      method: {
+        name: "ExternalNotificationsService.markManyAsRead",
+        url: "notifications/batch/state/read",
+        normalizedUrl: "notifications/batch/state/read",
+        type: "patch"
+      },
+      source: params.config.metrics?.source || "unset",
+      target: {
+        name: "notifications",
+        type: "internal"
+      }
+    };
+    const response = await request({
+      config: params.config,
+      base: { id: "notifications" },
+      url: serviceContext.method.url,
+      method: serviceContext.method.type,
+      metricsDetails: serviceContext,
+      body: { uuids: params.params.uuids },
+      responseType: "none"
+    });
+    if (!response.ok) {
+      throw new HttpError(
+        `${serviceContext.method.name}: ${response.status} ${response.statusText}`,
+        response.status,
+        response.statusText
+      );
+    }
+  }
+  /**
+   * Dismiss every notification for an org
+   * (`PATCH notifications/dismissAll?orgId=:orgId`).
+   */
+  static async dismissAll(params) {
+    const serviceContext = {
+      method: {
+        name: "ExternalNotificationsService.dismissAll",
+        url: `notifications/dismissAll?orgId=${encodeURIComponent(params.params.orgId)}`,
+        normalizedUrl: "notifications/dismissAll",
+        type: "patch"
+      },
+      source: params.config.metrics?.source || "unset",
+      target: {
+        name: "notifications",
+        type: "internal"
+      }
+    };
+    const response = await request({
+      config: params.config,
+      base: { id: "notifications" },
+      url: serviceContext.method.url,
+      method: serviceContext.method.type,
+      metricsDetails: serviceContext,
+      responseType: "none"
+    });
+    if (!response.ok) {
+      throw new HttpError(
+        `${serviceContext.method.name}: ${response.status} ${response.statusText}`,
+        response.status,
+        response.statusText
+      );
+    }
+  }
+  /**
+   * Fire-and-forget analytics event
+   * (`POST analytics/:orgId/:event`, body `{ id }`). Errors are logged and
+   * swallowed — analytics must never break the UI.
+   */
+  static async trackEvent(params) {
+    const serviceContext = {
+      method: {
+        name: "ExternalNotificationsService.trackEvent",
+        url: `analytics/${encodeURIComponent(params.params.orgId)}/${params.params.event}`,
+        normalizedUrl: "analytics/:orgId/:event",
+        type: "post"
+      },
+      source: params.config.metrics?.source || "unset",
+      target: {
+        name: "notifications",
+        type: "internal"
+      }
+    };
+    try {
+      await request({
+        config: params.config,
+        base: { id: "notifications" },
+        url: serviceContext.method.url,
+        method: serviceContext.method.type,
+        metricsDetails: serviceContext,
+        body: { id: params.params.id },
+        responseType: "text"
+      });
+    } catch (error) {
+      params.config.logger?.debug(
+        "ExternalNotificationsService.trackEvent failed (ignored)",
+        { error }
+      );
+    }
+  }
+  /**
+   * Subscribe to the user's live notification stream
+   * (`GET notifications/events`, `text/event-stream`). `keepAlive` frames are
+   * skipped. Auto-reconnects with a fresh token; heartbeat window is 1h to
+   * match the backend's keep-alive cadence. Call `.close()` to stop.
+   */
+  static streamUserNotifications(params) {
+    const base = getEnvParam("notifications", params.config);
+    const url = `${base}/notifications/events`;
+    return connectSse({
+      url,
+      config: params.config,
+      heartbeatTimeoutMs: 60 * 60 * 1e3,
+      onStateChange: params.onStateChange,
+      onMessage: (message) => {
+        if (!message.data) {
+          return;
+        }
+        try {
+          const parsed = JSON.parse(message.data);
+          if (parsed.keepAlive) {
+            return;
+          }
+          params.onEvent(parsed);
+        } catch (error) {
+          params.config.logger?.debug(
+            "ExternalNotificationsService.streamUserNotifications: failed to parse event",
+            { error }
+          );
+        }
+      }
+    });
+  }
+}
+export {
+  ExternalNotificationsService
+};
+//# sourceMappingURL=external.notifications.service.js.map

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

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/services/external/external.notifications.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 { NotificationDto } from '@camunda/ccma-shared-types'\nimport type {\n  RequestBaseParams,\n  RequestBaseParamsConfig,\n  RequestBaseServiceContext,\n} from '../../types/general.types.js'\nimport { request } from '../../utils/api.js'\nimport { getEnvParam } from '../../utils/environments.js'\nimport { HttpError } from '../../utils/errors.js'\nimport {\n  connectSse,\n  type SseConnection,\n  type SseConnectionState,\n} from '../../utils/sse.js'\n\nexport type UserNotificationAnalyticsEvent =\n  | 'notification-panel-opened'\n  | 'notification-clicked-cta'\n\nexport interface GetUserNotificationsParams extends RequestBaseParams {\n  params: {\n    orgId: string\n  }\n}\n\nexport interface SetNotificationStateParams extends RequestBaseParams {\n  params: {\n    uuid: string\n    state: 'read' | 'dismiss'\n  }\n}\n\nexport interface MarkManyNotificationsReadParams extends RequestBaseParams {\n  params: {\n    uuids: string[]\n  }\n}\n\nexport interface DismissAllNotificationsParams extends RequestBaseParams {\n  params: {\n    orgId: string\n  }\n}\n\nexport interface TrackNotificationEventParams extends RequestBaseParams {\n  params: {\n    orgId: string\n    event: UserNotificationAnalyticsEvent\n    id?: string\n  }\n}\n\nexport interface StreamUserNotificationsParams {\n  config: RequestBaseParamsConfig\n  /** Called for each parsed user notification. `keepAlive` frames are skipped. */\n  onEvent: (notification: NotificationDto) => void\n  onStateChange?: (state: SseConnectionState) => void\n}\n\n/**\n * Per-user notification **feed** on the notifications backend \u2014 the bell-icon\n * inbox (list, mark read/dismiss, live updates), distinct from\n * `NotificationsService`, which is the admin/authoring surface\n * (`notifications/global` CRUD). Use this from webapp navigation; use\n * `NotificationsService` from internal admin tooling.\n */\nexport class ExternalNotificationsService {\n  /** The user's notifications for an org (`GET notifications/orgs/:orgId`). */\n  public static async getUserNotifications(\n    params: GetUserNotificationsParams,\n  ): Promise<NotificationDto[]> {\n    const serviceContext: RequestBaseServiceContext = {\n      method: {\n        name: 'ExternalNotificationsService.getUserNotifications',\n        url: `notifications/orgs/${params.params.orgId}`,\n        normalizedUrl: 'notifications/orgs/:orgId',\n        type: 'get',\n      },\n      source: params.config.metrics?.source || 'unset',\n      target: {\n        name: 'notifications',\n        type: 'internal',\n      },\n    }\n\n    const response = await request<NotificationDto[]>({\n      ...params,\n      base: { id: 'notifications' },\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   * Mark a single notification read or dismissed\n   * (`PATCH notifications/:uuid/:state`).\n   */\n  public static async setNotificationState(\n    params: SetNotificationStateParams,\n  ): Promise<void> {\n    const serviceContext: RequestBaseServiceContext = {\n      method: {\n        name: 'ExternalNotificationsService.setNotificationState',\n        url: `notifications/${params.params.uuid}/${params.params.state}`,\n        normalizedUrl: 'notifications/:uuid/:state',\n        type: 'patch',\n      },\n      source: params.config.metrics?.source || 'unset',\n      target: {\n        name: 'notifications',\n        type: 'internal',\n      },\n    }\n\n    const response = await request({\n      config: params.config,\n      base: { id: 'notifications' },\n      url: serviceContext.method.url,\n      method: serviceContext.method.type,\n      metricsDetails: serviceContext,\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  /**\n   * Mark many notifications read in one call\n   * (`PATCH notifications/batch/state/read`, body `{ uuids }`). No-op for an\n   * empty list.\n   */\n  public static async markManyAsRead(\n    params: MarkManyNotificationsReadParams,\n  ): Promise<void> {\n    if (params.params.uuids.length === 0) {\n      return\n    }\n\n    const serviceContext: RequestBaseServiceContext = {\n      method: {\n        name: 'ExternalNotificationsService.markManyAsRead',\n        url: 'notifications/batch/state/read',\n        normalizedUrl: 'notifications/batch/state/read',\n        type: 'patch',\n      },\n      source: params.config.metrics?.source || 'unset',\n      target: {\n        name: 'notifications',\n        type: 'internal',\n      },\n    }\n\n    const response = await request({\n      config: params.config,\n      base: { id: 'notifications' },\n      url: serviceContext.method.url,\n      method: serviceContext.method.type,\n      metricsDetails: serviceContext,\n      body: { uuids: params.params.uuids },\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  /**\n   * Dismiss every notification for an org\n   * (`PATCH notifications/dismissAll?orgId=:orgId`).\n   */\n  public static async dismissAll(\n    params: DismissAllNotificationsParams,\n  ): Promise<void> {\n    const serviceContext: RequestBaseServiceContext = {\n      method: {\n        name: 'ExternalNotificationsService.dismissAll',\n        url: `notifications/dismissAll?orgId=${encodeURIComponent(params.params.orgId)}`,\n        normalizedUrl: 'notifications/dismissAll',\n        type: 'patch',\n      },\n      source: params.config.metrics?.source || 'unset',\n      target: {\n        name: 'notifications',\n        type: 'internal',\n      },\n    }\n\n    const response = await request({\n      config: params.config,\n      base: { id: 'notifications' },\n      url: serviceContext.method.url,\n      method: serviceContext.method.type,\n      metricsDetails: serviceContext,\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  /**\n   * Fire-and-forget analytics event\n   * (`POST analytics/:orgId/:event`, body `{ id }`). Errors are logged and\n   * swallowed \u2014 analytics must never break the UI.\n   */\n  public static async trackEvent(\n    params: TrackNotificationEventParams,\n  ): Promise<void> {\n    const serviceContext: RequestBaseServiceContext = {\n      method: {\n        name: 'ExternalNotificationsService.trackEvent',\n        url: `analytics/${encodeURIComponent(params.params.orgId)}/${params.params.event}`,\n        normalizedUrl: 'analytics/:orgId/:event',\n        type: 'post',\n      },\n      source: params.config.metrics?.source || 'unset',\n      target: {\n        name: 'notifications',\n        type: 'internal',\n      },\n    }\n\n    try {\n      await request({\n        config: params.config,\n        base: { id: 'notifications' },\n        url: serviceContext.method.url,\n        method: serviceContext.method.type,\n        metricsDetails: serviceContext,\n        body: { id: params.params.id },\n        responseType: 'text',\n      })\n    } catch (error) {\n      params.config.logger?.debug(\n        'ExternalNotificationsService.trackEvent failed (ignored)',\n        { error },\n      )\n    }\n  }\n\n  /**\n   * Subscribe to the user's live notification stream\n   * (`GET notifications/events`, `text/event-stream`). `keepAlive` frames are\n   * skipped. Auto-reconnects with a fresh token; heartbeat window is 1h to\n   * match the backend's keep-alive cadence. Call `.close()` to stop.\n   */\n  public static streamUserNotifications(\n    params: StreamUserNotificationsParams,\n  ): SseConnection {\n    const base = getEnvParam('notifications', params.config)\n    const url = `${base}/notifications/events`\n\n    return connectSse({\n      url,\n      config: params.config,\n      heartbeatTimeoutMs: 60 * 60 * 1000,\n      onStateChange: params.onStateChange,\n      onMessage: (message) => {\n        if (!message.data) {\n          return\n        }\n        try {\n          const parsed = JSON.parse(message.data) as NotificationDto & {\n            keepAlive?: boolean\n          }\n          if (parsed.keepAlive) {\n            return\n          }\n          params.onEvent(parsed)\n        } catch (error) {\n          params.config.logger?.debug(\n            'ExternalNotificationsService.streamUserNotifications: failed to parse event',\n            { error },\n          )\n        }\n      },\n    })\n  }\n}\n"],
+  "mappings": "AAYA,SAAS,eAAe;AACxB,SAAS,mBAAmB;AAC5B,SAAS,iBAAiB;AAC1B;AAAA,EACE;AAAA,OAGK;AAqDA,MAAM,6BAA6B;AAAA;AAAA,EAExC,aAAoB,qBAClB,QAC4B;AAC5B,UAAM,iBAA4C;AAAA,MAChD,QAAQ;AAAA,QACN,MAAM;AAAA,QACN,KAAK,sBAAsB,OAAO,OAAO,KAAK;AAAA,QAC9C,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,GAAG;AAAA,MACH,MAAM,EAAE,IAAI,gBAAgB;AAAA,MAC5B,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,EAMA,aAAoB,qBAClB,QACe;AACf,UAAM,iBAA4C;AAAA,MAChD,QAAQ;AAAA,QACN,MAAM;AAAA,QACN,KAAK,iBAAiB,OAAO,OAAO,IAAI,IAAI,OAAO,OAAO,KAAK;AAAA,QAC/D,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,gBAAgB;AAAA,MAC5B,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;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,aAAoB,eAClB,QACe;AACf,QAAI,OAAO,OAAO,MAAM,WAAW,GAAG;AACpC;AAAA,IACF;AAEA,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,gBAAgB;AAAA,MAC5B,KAAK,eAAe,OAAO;AAAA,MAC3B,QAAQ,eAAe,OAAO;AAAA,MAC9B,gBAAgB;AAAA,MAChB,MAAM,EAAE,OAAO,OAAO,OAAO,MAAM;AAAA,MACnC,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;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,aAAoB,WAClB,QACe;AACf,UAAM,iBAA4C;AAAA,MAChD,QAAQ;AAAA,QACN,MAAM;AAAA,QACN,KAAK,kCAAkC,mBAAmB,OAAO,OAAO,KAAK,CAAC;AAAA,QAC9E,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,gBAAgB;AAAA,MAC5B,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;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,aAAoB,WAClB,QACe;AACf,UAAM,iBAA4C;AAAA,MAChD,QAAQ;AAAA,QACN,MAAM;AAAA,QACN,KAAK,aAAa,mBAAmB,OAAO,OAAO,KAAK,CAAC,IAAI,OAAO,OAAO,KAAK;AAAA,QAChF,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,QAAI;AACF,YAAM,QAAQ;AAAA,QACZ,QAAQ,OAAO;AAAA,QACf,MAAM,EAAE,IAAI,gBAAgB;AAAA,QAC5B,KAAK,eAAe,OAAO;AAAA,QAC3B,QAAQ,eAAe,OAAO;AAAA,QAC9B,gBAAgB;AAAA,QAChB,MAAM,EAAE,IAAI,OAAO,OAAO,GAAG;AAAA,QAC7B,cAAc;AAAA,MAChB,CAAC;AAAA,IACH,SAAS,OAAO;AACd,aAAO,OAAO,QAAQ;AAAA,QACpB;AAAA,QACA,EAAE,MAAM;AAAA,MACV;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,OAAc,wBACZ,QACe;AACf,UAAM,OAAO,YAAY,iBAAiB,OAAO,MAAM;AACvD,UAAM,MAAM,GAAG,IAAI;AAEnB,WAAO,WAAW;AAAA,MAChB;AAAA,MACA,QAAQ,OAAO;AAAA,MACf,oBAAoB,KAAK,KAAK;AAAA,MAC9B,eAAe,OAAO;AAAA,MACtB,WAAW,CAAC,YAAY;AACtB,YAAI,CAAC,QAAQ,MAAM;AACjB;AAAA,QACF;AACA,YAAI;AACF,gBAAM,SAAS,KAAK,MAAM,QAAQ,IAAI;AAGtC,cAAI,OAAO,WAAW;AACpB;AAAA,UACF;AACA,iBAAO,QAAQ,MAAM;AAAA,QACvB,SAAS,OAAO;AACd,iBAAO,OAAO,QAAQ;AAAA,YACpB;AAAA,YACA,EAAE,MAAM;AAAA,UACV;AAAA,QACF;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AACF;",
+  "names": []
+}

package/dist/services/external/external.services.spec.d.ts

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

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

@@ -1,7 +1,51 @@
-import type { NotificationOptions } from '@camunda/ccma-shared-types';
+import type { NotificationDto, NotificationOptions } from '@camunda/ccma-shared-types';
 import type { RequestBaseParams } from '../../types/general.types.js';
+export interface CreateGlobalNotificationParams extends RequestBaseParams {
+    body: {
+        /** Scheduling rides on `meta.scheduleTs` (epoch ms). */
+        notification: NotificationOptions;
+    };
+}
+export interface CreateNotificationBySalesPlanParams extends RequestBaseParams {
+    params: {
+        salesPlanType: string;
+    };
+    body: {
+        notification: NotificationOptions;
+    };
+}
+export interface UpdateNotificationParams extends RequestBaseParams {
+    params: {
+        uuid: string;
+    };
+    body: {
+        /** Only draft/scheduled notifications are editable (backend-enforced). */
+        notification: Partial<NotificationOptions>;
+    };
+}
+export interface DeleteGlobalNotificationParams extends RequestBaseParams {
+    params: {
+        notificationId: string;
+    };
+}
 export declare class NotificationsService {
     static sendNotification(params: {
         notification: NotificationOptions;
     } & RequestBaseParams): Promise<void>;
+    /** All global notifications (sent, draft, scheduled) for the admin list. */
+    static getGlobalNotifications(params: RequestBaseParams): Promise<NotificationDto[]>;
+    /**
+     * Create a global notification (visible to every user). Scheduling rides on
+     * `meta.scheduleTs`; an `initState` of `draft` keeps it unsent.
+     */
+    static createGlobalNotification(params: CreateGlobalNotificationParams): Promise<void>;
+    /**
+     * Create a notification for every member of the orgs on a sales-plan type
+     * (fans out via the accounts backend, `POST api/notifications/:salesPlanType`).
+     */
+    static createNotificationBySalesPlan(params: CreateNotificationBySalesPlanParams): Promise<void>;
+    /** Update a draft/scheduled notification (`PATCH notifications/:uuid`). */
+    static updateNotification(params: UpdateNotificationParams): Promise<void>;
+    /** Delete a global notification (`DELETE notifications/global/:id`). */
+    static deleteGlobalNotification(params: DeleteGlobalNotificationParams): Promise<void>;
 }

package/dist/services/notifications/notifications.service.js

@@ -31,6 +31,168 @@ class NotificationsService {
       );
     }
   }
+  /** All global notifications (sent, draft, scheduled) for the admin list. */
+  static async getGlobalNotifications(params) {
+    const serviceContext = {
+      method: {
+        name: `NotificationsService.getGlobalNotifications`,
+        url: `notifications/global`,
+        normalizedUrl: `notifications/global`,
+        type: "get"
+      },
+      source: params.config.metrics?.source || "unset",
+      target: {
+        name: "notifications",
+        type: "internal"
+      }
+    };
+    const response = await request({
+      ...params,
+      base: { id: "notifications" },
+      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 ?? [];
+  }
+  /**
+   * Create a global notification (visible to every user). Scheduling rides on
+   * `meta.scheduleTs`; an `initState` of `draft` keeps it unsent.
+   */
+  static async createGlobalNotification(params) {
+    const serviceContext = {
+      method: {
+        name: `NotificationsService.createGlobalNotification`,
+        url: `notifications/global`,
+        normalizedUrl: `notifications/global`,
+        type: "post"
+      },
+      source: params.config.metrics?.source || "unset",
+      target: {
+        name: "notifications",
+        type: "internal"
+      }
+    };
+    const response = await request({
+      config: params.config,
+      base: { id: "notifications" },
+      url: serviceContext.method.url,
+      method: serviceContext.method.type,
+      metricsDetails: serviceContext,
+      body: params.body
+    });
+    if (!response.ok) {
+      throw new HttpError(
+        `${serviceContext.method.name}: ${response.status} ${response.statusText}`,
+        response.status,
+        response.statusText
+      );
+    }
+  }
+  /**
+   * Create a notification for every member of the orgs on a sales-plan type
+   * (fans out via the accounts backend, `POST api/notifications/:salesPlanType`).
+   */
+  static async createNotificationBySalesPlan(params) {
+    const serviceContext = {
+      method: {
+        name: `NotificationsService.createNotificationBySalesPlan`,
+        url: `api/notifications/${encodeURIComponent(params.params.salesPlanType)}`,
+        normalizedUrl: `api/notifications/:salesPlanType`,
+        type: "post"
+      },
+      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,
+      body: params.body
+    });
+    if (!response.ok) {
+      throw new HttpError(
+        `${serviceContext.method.name}: ${response.status} ${response.statusText}`,
+        response.status,
+        response.statusText
+      );
+    }
+  }
+  /** Update a draft/scheduled notification (`PATCH notifications/:uuid`). */
+  static async updateNotification(params) {
+    const serviceContext = {
+      method: {
+        name: `NotificationsService.updateNotification`,
+        url: `notifications/${params.params.uuid}`,
+        normalizedUrl: `notifications/:uuid`,
+        type: "patch"
+      },
+      source: params.config.metrics?.source || "unset",
+      target: {
+        name: "notifications",
+        type: "internal"
+      }
+    };
+    const response = await request({
+      config: params.config,
+      base: { id: "notifications" },
+      url: serviceContext.method.url,
+      method: serviceContext.method.type,
+      metricsDetails: serviceContext,
+      body: params.body
+    });
+    if (!response.ok) {
+      throw new HttpError(
+        `${serviceContext.method.name}: ${response.status} ${response.statusText}`,
+        response.status,
+        response.statusText
+      );
+    }
+  }
+  /** Delete a global notification (`DELETE notifications/global/:id`). */
+  static async deleteGlobalNotification(params) {
+    const serviceContext = {
+      method: {
+        name: `NotificationsService.deleteGlobalNotification`,
+        url: `notifications/global/${params.params.notificationId}`,
+        normalizedUrl: `notifications/global/:notificationId`,
+        type: "delete"
+      },
+      source: params.config.metrics?.source || "unset",
+      target: {
+        name: "notifications",
+        type: "internal"
+      }
+    };
+    const response = await request({
+      config: params.config,
+      base: { id: "notifications" },
+      url: serviceContext.method.url,
+      method: serviceContext.method.type,
+      metricsDetails: serviceContext,
+      responseType: "none"
+    });
+    if (!response.ok) {
+      throw new HttpError(
+        `${serviceContext.method.name}: ${response.status} ${response.statusText}`,
+        response.status,
+        response.statusText
+      );
+    }
+  }
 }
 export {
   NotificationsService

package/dist/services/notifications/notifications.service.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/services/notifications/notifications.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 { NotificationOptions } 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 class NotificationsService {\n  public static async sendNotification(\n    params: { notification: NotificationOptions } & RequestBaseParams,\n  ) {\n    const serviceContext: RequestBaseServiceContext = {\n      method: {\n        name: `NotificationsService.sendNotification`,\n        url: `notifications/${params.notification.type}`,\n        normalizedUrl: `notifications/:type`,\n        type: 'post',\n      },\n      source: params.config.metrics?.source || 'unset',\n      target: {\n        name: 'notifications',\n        type: 'internal',\n      },\n    }\n\n    const response = await request({\n      config: params.config,\n      base: { id: 'notifications' },\n      url: serviceContext.method.url,\n      method: serviceContext.method.type,\n      metricsDetails: serviceContext,\n      body: { notification: params.notification },\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": "AAWA,SAAS,eAAe;AACxB,SAAS,iBAAiB;AAEnB,MAAM,qBAAqB;AAAA,EAChC,aAAoB,iBAClB,QACA;AACA,UAAM,iBAA4C;AAAA,MAChD,QAAQ;AAAA,QACN,MAAM;AAAA,QACN,KAAK,iBAAiB,OAAO,aAAa,IAAI;AAAA,QAC9C,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,gBAAgB;AAAA,MAC5B,KAAK,eAAe,OAAO;AAAA,MAC3B,QAAQ,eAAe,OAAO;AAAA,MAC9B,gBAAgB;AAAA,MAChB,MAAM,EAAE,cAAc,OAAO,aAAa;AAAA,IAC5C,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;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  NotificationDto,\n  NotificationOptions,\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 interface CreateGlobalNotificationParams extends RequestBaseParams {\n  body: {\n    /** Scheduling rides on `meta.scheduleTs` (epoch ms). */\n    notification: NotificationOptions\n  }\n}\n\nexport interface CreateNotificationBySalesPlanParams extends RequestBaseParams {\n  params: {\n    salesPlanType: string\n  }\n  body: {\n    notification: NotificationOptions\n  }\n}\n\nexport interface UpdateNotificationParams extends RequestBaseParams {\n  params: {\n    uuid: string\n  }\n  body: {\n    /** Only draft/scheduled notifications are editable (backend-enforced). */\n    notification: Partial<NotificationOptions>\n  }\n}\n\nexport interface DeleteGlobalNotificationParams extends RequestBaseParams {\n  params: {\n    notificationId: string\n  }\n}\n\nexport class NotificationsService {\n  public static async sendNotification(\n    params: { notification: NotificationOptions } & RequestBaseParams,\n  ) {\n    const serviceContext: RequestBaseServiceContext = {\n      method: {\n        name: `NotificationsService.sendNotification`,\n        url: `notifications/${params.notification.type}`,\n        normalizedUrl: `notifications/:type`,\n        type: 'post',\n      },\n      source: params.config.metrics?.source || 'unset',\n      target: {\n        name: 'notifications',\n        type: 'internal',\n      },\n    }\n\n    const response = await request({\n      config: params.config,\n      base: { id: 'notifications' },\n      url: serviceContext.method.url,\n      method: serviceContext.method.type,\n      metricsDetails: serviceContext,\n      body: { notification: params.notification },\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  /** All global notifications (sent, draft, scheduled) for the admin list. */\n  public static async getGlobalNotifications(\n    params: RequestBaseParams,\n  ): Promise<NotificationDto[]> {\n    const serviceContext: RequestBaseServiceContext = {\n      method: {\n        name: `NotificationsService.getGlobalNotifications`,\n        url: `notifications/global`,\n        normalizedUrl: `notifications/global`,\n        type: 'get',\n      },\n      source: params.config.metrics?.source || 'unset',\n      target: {\n        name: 'notifications',\n        type: 'internal',\n      },\n    }\n\n    const response = await request<NotificationDto[]>({\n      ...params,\n      base: { id: 'notifications' },\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 response.body ?? []\n  }\n\n  /**\n   * Create a global notification (visible to every user). Scheduling rides on\n   * `meta.scheduleTs`; an `initState` of `draft` keeps it unsent.\n   */\n  public static async createGlobalNotification(\n    params: CreateGlobalNotificationParams,\n  ): Promise<void> {\n    const serviceContext: RequestBaseServiceContext = {\n      method: {\n        name: `NotificationsService.createGlobalNotification`,\n        url: `notifications/global`,\n        normalizedUrl: `notifications/global`,\n        type: 'post',\n      },\n      source: params.config.metrics?.source || 'unset',\n      target: {\n        name: 'notifications',\n        type: 'internal',\n      },\n    }\n\n    const response = await request({\n      config: params.config,\n      base: { id: 'notifications' },\n      url: serviceContext.method.url,\n      method: serviceContext.method.type,\n      metricsDetails: serviceContext,\n      body: params.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  }\n\n  /**\n   * Create a notification for every member of the orgs on a sales-plan type\n   * (fans out via the accounts backend, `POST api/notifications/:salesPlanType`).\n   */\n  public static async createNotificationBySalesPlan(\n    params: CreateNotificationBySalesPlanParams,\n  ): Promise<void> {\n    const serviceContext: RequestBaseServiceContext = {\n      method: {\n        name: `NotificationsService.createNotificationBySalesPlan`,\n        url: `api/notifications/${encodeURIComponent(params.params.salesPlanType)}`,\n        normalizedUrl: `api/notifications/:salesPlanType`,\n        type: 'post',\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: params.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  }\n\n  /** Update a draft/scheduled notification (`PATCH notifications/:uuid`). */\n  public static async updateNotification(\n    params: UpdateNotificationParams,\n  ): Promise<void> {\n    const serviceContext: RequestBaseServiceContext = {\n      method: {\n        name: `NotificationsService.updateNotification`,\n        url: `notifications/${params.params.uuid}`,\n        normalizedUrl: `notifications/:uuid`,\n        type: 'patch',\n      },\n      source: params.config.metrics?.source || 'unset',\n      target: {\n        name: 'notifications',\n        type: 'internal',\n      },\n    }\n\n    const response = await request({\n      config: params.config,\n      base: { id: 'notifications' },\n      url: serviceContext.method.url,\n      method: serviceContext.method.type,\n      metricsDetails: serviceContext,\n      body: params.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  }\n\n  /** Delete a global notification (`DELETE notifications/global/:id`). */\n  public static async deleteGlobalNotification(\n    params: DeleteGlobalNotificationParams,\n  ): Promise<void> {\n    const serviceContext: RequestBaseServiceContext = {\n      method: {\n        name: `NotificationsService.deleteGlobalNotification`,\n        url: `notifications/global/${params.params.notificationId}`,\n        normalizedUrl: `notifications/global/:notificationId`,\n        type: 'delete',\n      },\n      source: params.config.metrics?.source || 'unset',\n      target: {\n        name: 'notifications',\n        type: 'internal',\n      },\n    }\n\n    const response = await request({\n      config: params.config,\n      base: { id: 'notifications' },\n      url: serviceContext.method.url,\n      method: serviceContext.method.type,\n      metricsDetails: serviceContext,\n      responseType: 'none',\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": "AAcA,SAAS,eAAe;AACxB,SAAS,iBAAiB;AAkCnB,MAAM,qBAAqB;AAAA,EAChC,aAAoB,iBAClB,QACA;AACA,UAAM,iBAA4C;AAAA,MAChD,QAAQ;AAAA,QACN,MAAM;AAAA,QACN,KAAK,iBAAiB,OAAO,aAAa,IAAI;AAAA,QAC9C,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,gBAAgB;AAAA,MAC5B,KAAK,eAAe,OAAO;AAAA,MAC3B,QAAQ,eAAe,OAAO;AAAA,MAC9B,gBAAgB;AAAA,MAChB,MAAM,EAAE,cAAc,OAAO,aAAa;AAAA,IAC5C,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;AAAA,EACF;AAAA;AAAA,EAGA,aAAoB,uBAClB,QAC4B;AAC5B,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,QAA2B;AAAA,MAChD,GAAG;AAAA,MACH,MAAM,EAAE,IAAI,gBAAgB;AAAA,MAC5B,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,WAAO,SAAS,QAAQ,CAAC;AAAA,EAC3B;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,aAAoB,yBAClB,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,gBAAgB;AAAA,MAC5B,KAAK,eAAe,OAAO;AAAA,MAC3B,QAAQ,eAAe,OAAO;AAAA,MAC9B,gBAAgB;AAAA,MAChB,MAAM,OAAO;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;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,aAAoB,8BAClB,QACe;AACf,UAAM,iBAA4C;AAAA,MAChD,QAAQ;AAAA,QACN,MAAM;AAAA,QACN,KAAK,qBAAqB,mBAAmB,OAAO,OAAO,aAAa,CAAC;AAAA,QACzE,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,OAAO;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;AAAA,EACF;AAAA;AAAA,EAGA,aAAoB,mBAClB,QACe;AACf,UAAM,iBAA4C;AAAA,MAChD,QAAQ;AAAA,QACN,MAAM;AAAA,QACN,KAAK,iBAAiB,OAAO,OAAO,IAAI;AAAA,QACxC,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,gBAAgB;AAAA,MAC5B,KAAK,eAAe,OAAO;AAAA,MAC3B,QAAQ,eAAe,OAAO;AAAA,MAC9B,gBAAgB;AAAA,MAChB,MAAM,OAAO;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;AAAA,EACF;AAAA;AAAA,EAGA,aAAoB,yBAClB,QACe;AACf,UAAM,iBAA4C;AAAA,MAChD,QAAQ;AAAA,QACN,MAAM;AAAA,QACN,KAAK,wBAAwB,OAAO,OAAO,cAAc;AAAA,QACzD,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,gBAAgB;AAAA,MAC5B,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;AAAA,EACF;AACF;",
   "names": []
 }

package/dist/types/general.types.d.ts

@@ -41,6 +41,14 @@ export interface RequestBaseParamsConfig {
     metrics?: RequestBaseCustomMetrics;
     timeout?: number;
     proxyAgent?: any;
+    /**
+     * Returns extra headers to add to every outgoing request, evaluated per call.
+     * Used to propagate correlation headers (traceparent, x-cc-session-id) from
+     * the ambient request context. Only wire this for trusted internal services —
+     * not third-party APIs. Explicit per-request headers and auth/content-type
+     * headers take precedence over these. Errors thrown here are ignored.
+     */
+    getDynamicHeaders?: () => Record<string, string>;
     frontendCaching?: {
         enabled: boolean;
         dbName: string;

package/dist/utils/api.d.ts

@@ -10,7 +10,7 @@ export interface RequestPayload extends RequestBaseParams {
         [key: string]: string;
     };
     type?: 'json' | 'text' | 'form' | 'none';
-    responseType?: 'json' | 'text' | 'none';
+    responseType?: 'json' | 'text' | 'blob' | 'none';
     retry?: {
         attempts: number;
         remaining: number;

package/dist/utils/api.js

@@ -110,7 +110,15 @@ async function request(payload) {
   if (payload.config.auth) {
     token = await payload.config.auth.getToken();
   }
-  const headers = payload.headers ?? {};
+  let dynamicHeaders = {};
+  try {
+    dynamicHeaders = payload.config.getDynamicHeaders?.() ?? {};
+  } catch (_error) {
+  }
+  const headers = {
+    ...dynamicHeaders,
+    ...payload.headers ?? {}
+  };
   if (token) {
     headers.Authorization = `Bearer ${token}`;
   }
@@ -296,10 +304,13 @@ async function request(payload) {
         case "text":
           response.body = await fetchResponse.text();
           break;
+        case "blob":
+          response.body = await fetchResponse.blob();
+          break;
         default:
           response.body = await fetchResponse.text();
       }
-      if (payload.method === "get" && payload.config.frontendCaching?.enabled && response.body !== void 0) {
+      if (payload.method === "get" && payload.config.frontendCaching?.enabled && response.body !== void 0 && responseType !== "blob") {
         try {
           await frontendCache.set("get", url, response.body);
           log(payload, "debug", "cache store successful");