@epam/ai-dial-chat-hooks 1.1.2 → 1.2.0-dev.101

package/usage.d.ts

@@ -0,0 +1,120 @@
+import { DeploymentItemDto } from '@epam/ai-dial-chat-api-client';
+import { ModelLimitPeriodStatuses } from '@epam/ai-dial-usage-dashboard';
+import { ModelLimitRow } from '@epam/ai-dial-usage-dashboard';
+import { UsageLimitCardData } from '@epam/ai-dial-usage-dashboard';
+import { UserLimitStatsResponseDto } from '@epam/ai-dial-chat-api-client';
+
+/** Formats a raw `resetsAt` into display strings, or returns `undefined` when it cannot be formatted. */
+export declare type FormatResetTime = (resetsAt: string | undefined) => ResetTimeDisplay | undefined;
+
+/**
+ * Maps the same top-level Cost budgets used by the aggregate cards into table-header state.
+ *
+ * @param formatResetTime - Formats each period's top-level `resetsAt` into the header's reset trio. Omit it to produce statuses with no reset fields.
+ */
+export declare const mapOverallCostLimitsToPeriodStatuses: (usage: UserLimitStatsResponseDto | undefined, activeLocale: string, t: Translate_2, formatResetTime?: FormatResetTime) => ModelLimitPeriodStatuses;
+
+/**
+ * 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. Each card's reset trio comes from
+ * `formatResetTime`, and is absent when that callback returns `undefined`.
+ */
+export declare const mapUsageDataToDashboard: (usage: UserLimitStatsResponseDto | undefined, t: Translate, formatResetTime: FormatResetTime) => UsageLimitCardData[];
+
+/**
+ * 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_2, resolveIconUrl: ResolveIconUrl, resolveDisplayName: ResolveDisplayName) => ModelLimitRow[];
+
+/**
+ * One reset time, already parsed and formatted by the host. Declared
+ * structurally here so this library never imports an application type; the
+ * host passes a value that satisfies this shape (e.g. `apps/chat`'s own
+ * `ResetTimeDisplay`).
+ */
+export declare interface ResetTimeDisplay {
+    /** Exclusive end of the period as an epoch ms value, for the host's boundary scheduling. */
+    resetsAtMs: number;
+    /** Machine-readable instant for a `<time dateTime>` attribute. */
+    isoValue: string;
+    /** Visible reset line. */
+    label: string;
+    /** Accessible expansion of the reset line. */
+    ariaLabel: string;
+}
+
+/** A callback that resolves a display name from a localized-text value. */
+declare type ResolveDisplayName = (name: string | Record<string, string> | undefined | null, locale: string) => string;
+
+/** A callback that resolves an icon URL from a deployment's raw `iconUrl` field. */
+declare type ResolveIconUrl = (iconUrl: string | undefined) => string | undefined;
+
+/** A translate function compatible with i18next's `TFunction`. */
+declare type Translate = (key: string, options?: Record<string, unknown>) => string;
+
+/** A translate function compatible with i18next's `TFunction`. */
+declare type Translate_2 = (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 current-UTC-day card (e.g. `'Today'`). */
+    readonly todayTitle: "usage.todayTitle";
+    /** Accessible period description for the current-UTC-day card. */
+    readonly todayPeriodDescription: "usage.todayPeriodDescription";
+    /** Title for the current-UTC-week card (e.g. `'This week'`). */
+    readonly thisWeekTitle: "usage.thisWeekTitle";
+    /** Accessible period description for the current-UTC-week card. */
+    readonly thisWeekPeriodDescription: "usage.thisWeekPeriodDescription";
+    /** Title for the current-UTC-month card (e.g. `'This month'`). */
+    readonly thisMonthTitle: "usage.thisMonthTitle";
+    /** Accessible period description for the current-UTC-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";
+};
+
+/**
+ * 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";
+};
+
+export { }

package/usage.js

@@ -0,0 +1,3 @@
+import { USAGE_DATA_I18N_KEYS as e, mapUsageDataToDashboard as t } from "./usage/map-usage-data-to-dashboard.js";
+import { USAGE_MODEL_LIMITS_I18N_KEYS as n, mapOverallCostLimitsToPeriodStatuses as r, mapUserUsageToModelLimits as i } from "./usage/map-user-usage-to-model-limits.js";
+export { e as USAGE_DATA_I18N_KEYS, n as USAGE_MODEL_LIMITS_I18N_KEYS, r as mapOverallCostLimitsToPeriodStatuses, t as mapUsageDataToDashboard, i as mapUserUsageToModelLimits };