@epam/ai-dial-usage-dashboard 1.1.0-dev.280 → 1.1.0-dev.281

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@epam/ai-dial-usage-dashboard",
   "description": "Presentational aggregate cost-limit cards for the Usage settings dashboard",
-  "version": "1.1.0-dev.280",
+  "version": "1.1.0-dev.281",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./index.js",
@@ -16,7 +16,8 @@
     }
   },
   "peerDependencies": {
-    "@epam/ai-dial-chat-shared": "1.1.0-dev.280",
+    "@epam/ai-dial-chat-api-client": "1.1.0-dev.281",
+    "@epam/ai-dial-chat-shared": "1.1.0-dev.281",
     "@epam/ai-dial-ui-kit": "^0.14.0-dev.9",
     "@tabler/icons-react": "^3.44.0",
     "react": "^19.2.7"

package/utils/map-usage-data-to-dashboard.d.ts

@@ -0,0 +1,35 @@
+import { UserLimitStatsResponseDto } from '@epam/ai-dial-chat-api-client';
+import { UsageLimitCardData } from '../models/usage-limit-card-props';
+/** A translate function compatible with i18next's `TFunction`. */
+type Translate = (key: string, options?: Record<string, unknown>) => string;
+/**
+ * i18n key strings that the consuming app's translation bundle must define for
+ * `mapUsageDataToDashboard` to produce correctly translated strings. The
+ * values are the default key paths used by AI DIAL Chat.
+ */
+export declare const USAGE_DATA_I18N_KEYS: {
+    /** Title for the "today" card (e.g. `'Daily'`). */
+    readonly todayTitle: "usage.todayTitle";
+    /** Period description for the "today" card (e.g. `'Today'`). */
+    readonly todayPeriodDescription: "usage.todayPeriodDescription";
+    /** Title for the "this week" card. */
+    readonly thisWeekTitle: "usage.thisWeekTitle";
+    /** Period description for the "this week" card. */
+    readonly thisWeekPeriodDescription: "usage.thisWeekPeriodDescription";
+    /** Title for the "this month" card. */
+    readonly thisMonthTitle: "usage.thisMonthTitle";
+    /** Period description for the "this month" card. */
+    readonly thisMonthPeriodDescription: "usage.thisMonthPeriodDescription";
+    /** Aria label when there is no limit. Receives `{ used: string }`. */
+    readonly unlimitedProgressAriaLabel: "usage.unlimitedProgressAriaLabel";
+    /** Aria label for a progress bar with a finite limit. Receives `{ used: string, total: string, percent: number }`. */
+    readonly progressAriaLabel: "usage.progressAriaLabel";
+};
+/**
+ * Maps a `UserLimitStatsResponseDto` into `UsageLimitCardGroup`'s `cards` prop,
+ * in Today / This week / This month order. A period is omitted entirely when
+ * the response carries no usable stat for it.
+ */
+export declare const mapUsageDataToDashboard: (usage: UserLimitStatsResponseDto | undefined, t: Translate) => UsageLimitCardData[];
+export {};
+//# sourceMappingURL=map-usage-data-to-dashboard.d.ts.map

package/utils/map-usage-data-to-dashboard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"map-usage-data-to-dashboard.d.ts","sourceRoot":"","sources":["../../src/utils/map-usage-data-to-dashboard.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,yBAAyB,EAC1B,MAAM,+BAA+B,CAAC;AAEvC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AAG3E,kEAAkE;AAClE,KAAK,SAAS,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,MAAM,CAAC;AAsE5E;;;;GAIG;AACH,eAAO,MAAM,oBAAoB;IAC/B,mDAAmD;;IAEnD,gEAAgE;;IAEhE,sCAAsC;;IAEtC,mDAAmD;;IAEnD,uCAAuC;;IAEvC,oDAAoD;;IAEpD,sEAAsE;;IAEtE,sHAAsH;;CAE9G,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,GAClC,OAAO,yBAAyB,GAAG,SAAS,EAC5C,GAAG,SAAS,KACX,kBAAkB,EA4BpB,CAAC"}

package/utils/map-user-usage-to-model-limits.d.ts

@@ -0,0 +1,52 @@
+import { DeploymentItemDto, UserLimitStatsResponseDto } from '@epam/ai-dial-chat-api-client';
+import { ModelLimitPeriodStatuses, ModelLimitRow } from '../models/model-limits-props';
+/** A translate function compatible with i18next's `TFunction`. */
+type Translate = (key: string, options?: Record<string, unknown>) => string;
+/** A callback that resolves an icon URL from a deployment's raw `iconUrl` field. */
+type ResolveIconUrl = (iconUrl: string | undefined) => string | undefined;
+/** A callback that resolves a display name from a localized-text value. */
+type ResolveDisplayName = (name: string | Record<string, string> | undefined | null, locale: string) => string;
+/**
+ * i18n key strings that the consuming app's translation bundle must define for
+ * `mapUserUsageToModelLimits` and `mapOverallCostLimitsToPeriodStatuses` to produce
+ * correctly translated strings. The values are the default key paths used by AI DIAL Chat.
+ */
+export declare const USAGE_MODEL_LIMITS_I18N_KEYS: {
+    /** Period label used in tooltip text. Receives no interpolation. */
+    readonly todayPeriodDescription: "usage.todayPeriodDescription";
+    /** Period label used in tooltip text. Receives no interpolation. */
+    readonly thisWeekPeriodDescription: "usage.thisWeekPeriodDescription";
+    /** Period label used in tooltip text. Receives no interpolation. */
+    readonly thisMonthPeriodDescription: "usage.thisMonthPeriodDescription";
+    /** Tooltip when the overall cost limit is running low. Receives `{ period: string }`. */
+    readonly overallCostLimitRunningLowTooltip: "usage.overallCostLimitRunningLowTooltip";
+    /** Tooltip when the overall cost limit is reached. Receives `{ period: string }`. */
+    readonly overallCostLimitReachedTooltip: "usage.overallCostLimitReachedTooltip";
+    /** Aria label for a metric cell with no data. */
+    readonly unavailableLabel: "usage.unavailableLabel";
+    /** Supporting label when a token limit follows the cost limit. */
+    readonly followsCostLimitLabel: "usage.followsCostLimitLabel";
+    /** Supporting label when there is no per-deployment token limit. */
+    readonly noLimitLabel: "usage.noLimitLabel";
+    /** Aria label when token usage has no limit but follows the cost limit. Receives `{ used: string }`. */
+    readonly followsCostLimitAriaLabel: "usage.followsCostLimitAriaLabel";
+    /** Aria label when there is no limit. Receives `{ used: string }`. */
+    readonly unlimitedProgressAriaLabel: "usage.unlimitedProgressAriaLabel";
+    /** Aria label for a progress bar with a finite limit. Receives `{ used: string, total: string, percent: number }`. */
+    readonly progressAriaLabel: "usage.progressAriaLabel";
+    /** Label for the spent-cost cell. Receives `{ amount: string }`. */
+    readonly spentLabel: "usage.spentLabel";
+};
+/** Maps the same top-level Cost budgets used by the aggregate cards into table-header state. */
+export declare const mapOverallCostLimitsToPeriodStatuses: (usage: UserLimitStatsResponseDto | undefined, activeLocale: string, t: Translate) => ModelLimitPeriodStatuses;
+/**
+ * Maps `usage.deployments` into `ModelLimitsSection`'s `rows` prop, joined with model identity
+ * from `deploymentItems`. Rows are included only when any displayed period stat has nonzero usage.
+ * Order follows `Object.keys(deployments)` — `deploymentItems` is enrichment-only.
+ *
+ * @param resolveIconUrl - Resolves a deployment's raw `iconUrl` to the URL the avatar should load.
+ * @param resolveDisplayName - Resolves a localized-text map or plain string to the display name for `activeLocale`.
+ */
+export declare const mapUserUsageToModelLimits: (usage: UserLimitStatsResponseDto | undefined, deploymentItems: DeploymentItemDto[], activeLocale: string, t: Translate, resolveIconUrl: ResolveIconUrl, resolveDisplayName: ResolveDisplayName) => ModelLimitRow[];
+export {};
+//# sourceMappingURL=map-user-usage-to-model-limits.d.ts.map

package/utils/map-user-usage-to-model-limits.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"map-user-usage-to-model-limits.d.ts","sourceRoot":"","sources":["../../src/utils/map-user-usage-to-model-limits.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,iBAAiB,EAGjB,yBAAyB,EAC1B,MAAM,+BAA+B,CAAC;AAGvC,OAAO,KAAK,EAIV,wBAAwB,EACxB,aAAa,EACd,MAAM,8BAA8B,CAAC;AAMtC,kEAAkE;AAClE,KAAK,SAAS,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,MAAM,CAAC;AAE5E,oFAAoF;AACpF,KAAK,cAAc,GAAG,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,KAAK,MAAM,GAAG,SAAS,CAAC;AAE1E,2EAA2E;AAC3E,KAAK,kBAAkB,GAAG,CACxB,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,GAAG,IAAI,EACxD,MAAM,EAAE,MAAM,KACX,MAAM,CAAC;AAmBZ;;;;GAIG;AACH,eAAO,MAAM,4BAA4B;IACvC,oEAAoE;;IAEpE,oEAAoE;;IAEpE,oEAAoE;;IAEpE,yFAAyF;;IAEzF,qFAAqF;;IAErF,iDAAiD;;IAEjD,kEAAkE;;IAElE,oEAAoE;;IAEpE,wGAAwG;;IAExG,sEAAsE;;IAEtE,sHAAsH;;IAEtH,oEAAoE;;CAE5D,CAAC;AA2GX,gGAAgG;AAChG,eAAO,MAAM,oCAAoC,GAC/C,OAAO,yBAAyB,GAAG,SAAS,EAC5C,cAAc,MAAM,EACpB,GAAG,SAAS,KACX,wBAmBD,CAAC;AAsIH;;;;;;;GAOG;AACH,eAAO,MAAM,yBAAyB,GACpC,OAAO,yBAAyB,GAAG,SAAS,EAC5C,iBAAiB,iBAAiB,EAAE,EACpC,cAAc,MAAM,EACpB,GAAG,SAAS,EACZ,gBAAgB,cAAc,EAC9B,oBAAoB,kBAAkB,KACrC,aAAa,EAyEf,CAAC"}