bstp-agent-widget 0.2.73 → 0.2.74

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bstp-agent-widget",
-  "version": "0.2.73",
+  "version": "0.2.74",
   "private": false,
   "type": "module",
   "main": "./dist/agent-widget.js",
@@ -21,6 +21,7 @@
   "files": [
     "README.md",
     "src/lib/index.d.ts",
+    "src/types",
     "dist/agent-widget.js",
     "dist/agent-widget.js.map",
     "dist/bstp-agent-widget.css",

package/src/types/dto/api-error.ts

@@ -0,0 +1,12 @@
+export interface ApiError {
+  status: string;
+  errorId: string;
+  errorCode: string;
+  message: string;
+  code: string;
+  instance: string;
+  timestamp: string;
+  title: string;
+  traceId: string;
+  type: string;
+}

package/src/types/dto/genai-agent-message-request.dto.ts

@@ -0,0 +1,12 @@
+export interface GenaiAgentMessageRequest {
+  message: string;
+  chat_id: number | null;
+  assistant_id: number;
+  is_sync: boolean;
+  unique_user_id: string;
+  tool_headers: {
+    _default: {
+      Authorization: string;
+    };
+  };
+}

package/src/types/dto/genai-agent-message-response.dto.ts

@@ -0,0 +1,10 @@
+export interface GenaiAgentMessageItem {
+  chat_id?: number | null;
+  message?: string | null;
+  created_at?: string | null;
+}
+
+export interface GenaiAgentMessageResponse {
+  message?: GenaiAgentMessageItem;
+  messages?: GenaiAgentMessageItem[];
+}

package/src/types/dto/genai-agent-reply.dto.ts

@@ -0,0 +1,5 @@
+export interface GenaiAgentReply {
+  chatId: number | null;
+  text: string;
+  createdAt: string;
+}

package/src/types/dto/genai-login-request.dto.ts

@@ -0,0 +1,4 @@
+export interface GenaiLoginRequest {
+  email: string;
+  clientSecret: string;
+}

package/src/types/dto/genai-login.dto.ts

@@ -0,0 +1,8 @@
+export interface GenAiLoginRequest {
+  username: string;
+  password: string;
+}
+
+export interface GenAiLoginResponse {
+  access_token: string;
+}

package/src/types/dto/genai-send-agent-message-request.dto.ts

@@ -0,0 +1,5 @@
+import type { GenaiAgentMessageRequest } from './genai-agent-message-request.dto';
+
+export interface GenaiSendAgentMessageRequest {
+  payload: GenaiAgentMessageRequest;
+}

package/src/types/dto/generic-error.ts

@@ -0,0 +1,24 @@
+/*
+Example:
+{
+ "status": 400,
+ "type": "https://etiya.com/problems/bss/common/busines-validation",
+ "code": "BSN_INTER_ALREADY_EXIST",
+ "detail": "Some message",
+ "traceId": "acbd0001-7b8e-4e81-9d6b-3e34ce7c9a9e",
+ "errorId": 1746796609,
+ "timestamp": "2024-03-19T01:10:23.937+00:00",
+ "instance": "https://.../crm/v1/customer/12345"
+}
+*/
+export interface GenericError {
+  status: number;
+  type: string;
+  code: string;
+  detail: string;
+  traceId: string;
+  errorId: number;
+  timestamp: string;
+  instance: string;
+  properties: Record<string, number | string | boolean>;
+}

package/src/types/dto/keycloak-api-error.ts

@@ -0,0 +1,4 @@
+/** @public */
+export interface KeycloakApiError {
+  errorMessage: string;
+}

package/src/types/dto/operation-result.ts

@@ -0,0 +1,6 @@
+export interface OperationResult {
+  description: string;
+  operationResultCode: string;
+  resultCode: string;
+  successResult: boolean;
+}

package/src/types/dto/page.ts

@@ -0,0 +1,31 @@
+/** @public */
+export interface Page<T> {
+  content: T[];
+  pageable: Pageable;
+  last: boolean;
+  totalElements: number;
+  totalPages: number;
+  size: number;
+  number: number;
+  sort: Sort;
+  first: boolean;
+  numberOfElements: number;
+  empty: boolean;
+}
+
+/** @public */
+export interface Pageable {
+  sort: Sort;
+  offset: number;
+  pageSize: number;
+  pageNumber: number;
+  paged: boolean;
+  unpaged: boolean;
+}
+
+/** @public */
+export interface Sort {
+  sorted: boolean;
+  unsorted: boolean;
+  empty: boolean;
+}

package/src/types/dto/permission.ts

@@ -0,0 +1,7 @@
+export interface Permission {
+  id: number;
+  shortCode: string;
+  visible: boolean;
+  disabled?: boolean;
+  items?: Permission[];
+}

package/src/types/dto/spring-error.ts

@@ -0,0 +1,6 @@
+export interface SpringError {
+  error: string;
+  path: string;
+  status: number;
+  timestamp: number;
+}

package/src/types/dto/user.ts

@@ -0,0 +1,9 @@
+export interface User {
+  customerId: number;
+  name: string;
+  saleChannelId: number;
+  saleChannelName: string;
+  saleChannelShortCode: string;
+  userId: number;
+  username: string;
+}

package/src/types/enums/markdown-renderer-response-type.ts

@@ -0,0 +1,9 @@
+export enum MarkdownRendererResponseType {
+  ACCOUNT_OVERVIEW = 'accountOverview',
+  CUSTOMER_PROFILE = 'customerProfile',
+  OFFER_RECOMMENDATION = 'offerRecommendation',
+  BASKET = 'basket',
+  USAGE_ANALYSIS = 'usageAnalysis',
+  TWIN_INSIGHT = 'twinInsight',
+  UNKNOWN = 'unknown',
+}

package/src/types/enums/markdown-renderer-visualization-type.ts

@@ -0,0 +1,6 @@
+export enum MarkdownRendererVisualizationType {
+  CARD = 'card',
+  LINK = 'link',
+  CHART = 'chart',
+  HIGHLIGHT_BOX = 'highlightBox',
+}

package/src/types/markdown-ui__react.d.ts

@@ -0,0 +1,24 @@
+declare module '@markdown-ui/react' {
+  export type WidgetEvent = {
+    type: string;
+    data?: Record<string, unknown>;
+  };
+
+  export function MarkdownUI(props: {
+    html: string;
+    onWidgetEvent?: (event: WidgetEvent) => void;
+    renderWidget?: (widgetData: unknown) => React.ReactNode;
+  }): JSX.Element;
+
+  export const ButtonGroup: unknown;
+  export const Chart: unknown;
+  export const Form: unknown;
+  export const Incomplete: unknown;
+  export const MultipleChoiceQuestion: unknown;
+  export const Quiz: unknown;
+  export const Select: unknown;
+  export const SelectMulti: unknown;
+  export const ShortAnswerQuestion: unknown;
+  export const Slider: unknown;
+  export const TextInput: unknown;
+}

package/src/types/models/agent-chat-config.ts

@@ -0,0 +1,49 @@
+export type AgentChatAssistantConfig = {
+  assistantKey: string;
+  assistantId: number;
+  label: string;
+  initialMessage?: string;
+};
+
+export type AgentChatGenAiInit = {
+  email: string;
+  clientSecret: string;
+};
+
+export type AgentChatConfigValue = {
+  assistantId: number;
+  assistants?: AgentChatAssistantConfig[];
+  genaiInit?: AgentChatGenAiInit;
+};
+
+export type AgentChatConfigGetter = {
+  getAssistantId: () => number | null;
+  getAssistants?: () => AgentChatAssistantConfig[];
+  getGenaiInit?: () => AgentChatGenAiInit | null;
+};
+
+export type AgentChatConfig = AgentChatConfigValue | AgentChatConfigGetter;
+
+export function resolveAssistantId(config: AgentChatConfig): number | null {
+  if ('assistantId' in config) return config.assistantId;
+  return config.getAssistantId();
+}
+
+export function resolveAssistants(config: AgentChatConfig): AgentChatAssistantConfig[] {
+  if ('assistants' in config) return config.assistants ?? [];
+  return 'getAssistants' in config ? (config.getAssistants?.() ?? []) : [];
+}
+
+export function resolveGenaiInit(config: AgentChatConfig): AgentChatGenAiInit | null {
+  if ('genaiInit' in config) return config.genaiInit ?? null;
+  return 'getGenaiInit' in config ? (config.getGenaiInit?.() ?? null) : null;
+}
+
+export function resolveInitialMessage(config: AgentChatConfig): string | null {
+  const assistantId = resolveAssistantId(config);
+  if (!assistantId) return null;
+
+  const assistants = resolveAssistants(config);
+  const assistant = assistants.find((a) => a.assistantId === assistantId);
+  return assistant?.initialMessage ?? null;
+}

package/src/types/models/agent-chat-runtime.ts

@@ -0,0 +1,29 @@
+export type AgentChatRuntimeValue = {
+  customerId: string;
+  customerToken: string;
+  language?: string;
+};
+
+export type AgentChatRuntimeGetter = {
+  getCustomerId: () => string | null;
+  getCustomerToken: () => string | null | Promise<string | null>;
+  getLanguage?: () => string | null;
+};
+
+export type AgentChatRuntime = AgentChatRuntimeValue | AgentChatRuntimeGetter;
+
+export function resolveCustomerId(runtime: AgentChatRuntime): string | null {
+  if ('customerId' in runtime) return runtime.customerId;
+  return runtime.getCustomerId();
+}
+
+export async function resolveCustomerToken(runtime: AgentChatRuntime): Promise<string | null> {
+  if ('customerToken' in runtime) return runtime.customerToken;
+  return runtime.getCustomerToken();
+}
+
+export function resolveLanguage(runtime: AgentChatRuntime): string | null {
+  if ('language' in runtime) return runtime.language ?? null;
+  if ('getLanguage' in runtime && runtime.getLanguage) return runtime.getLanguage();
+  return null;
+}

package/src/types/models/agent-chat-usage-chart-item.ts

@@ -0,0 +1,12 @@
+export type AgentChatUsageChartItem = {
+  key: string;
+  label: string;
+  used: number;
+  total: number;
+  unit: string;
+  percentUsed?: number;
+  remaining?: number;
+  expireDate?: string;
+  valueRaw?: string;
+  currentValueRaw?: string;
+};

package/src/types/models/agent-chat-widget-ui.ts

@@ -0,0 +1,26 @@
+export type AgentChatWidgetUiOptions = {
+  /** Panel width in px */
+  panelWidth?: number;
+  /** Panel height in px or CSS value */
+  panelHeight?: number | string;
+  /** Panel header height in px */
+  panelHeaderHeight?: number;
+  /** Text shown in panel header title */
+  panelTitle?: string;
+  /** Accent color used by widget surfaces */
+  accentColor?: string;
+  /** FAB button bottom offset in px */
+  fabBottomOffset?: number;
+  /** FAB button top offset in px (takes precedence over bottom offset when provided) */
+  fabTopOffset?: number;
+  /** FAB button right offset in px */
+  fabRightOffset?: number;
+  /** FAB button left offset in px (takes precedence over right offset when provided) */
+  fabLeftOffset?: number;
+  /** FAB button label text */
+  fabButtonLabel?: string;
+  /** Widget z-index (affects both FAB and panel) */
+  zIndex?: number;
+  /** CSS selector for the host layout node that should reserve space for the widget */
+  hostContainerSelector?: string;
+};

package/src/types/models/app-config.ts

@@ -0,0 +1,46 @@
+import { AppFeatureConfig } from './app-feature-config';
+import { GrowthBookConfig } from './growth-book-config';
+
+export interface AppConfig {
+  url: AppConfigUrl;
+  keycloak: AppConfigKeycloak;
+  features: AppFeatureConfig;
+  growthBook?: GrowthBookConfig;
+  genai?: AppConfigGenai;
+}
+
+interface AppConfigUrl {
+  app: string;
+  api: string;
+  apiPaths: ApiPathsConfig;
+}
+
+interface ApiPathsConfig {
+  crm: string;
+  uiAuthz: string;
+  genai?: string;
+}
+
+interface AppConfigKeycloak {
+  url: string;
+  realm: string;
+  clientId: string;
+}
+
+interface AppConfigGenaiAssistant {
+  assistantKey: string;
+  assistantId: number;
+  label: string;
+  initialMessage?: string;
+}
+
+interface AppConfigGenai {
+  config: {
+    assistantId: number;
+    agents?: AppConfigGenaiAssistant[];
+  };
+  init: {
+    email: string;
+    clientSecret: string;
+  };
+}

package/src/types/models/app-feature-config.ts

@@ -0,0 +1,3 @@
+export interface AppFeatureConfig {
+  enableThemeManager?: boolean;
+}

package/src/types/models/base-button-props.ts

@@ -0,0 +1,3 @@
+import { ButtonProps, ElementProps } from '@mantine/core';
+
+export interface BaseButtonProps extends ButtonProps, ElementProps<'button', keyof ButtonProps> {}

package/src/types/models/confirmation-modal-types.ts

@@ -0,0 +1,34 @@
+import { ExtendedButtonVariant } from '@/type-augmentation';
+import { ModalProps } from '@mantine/core';
+import { ReactNode } from 'react';
+
+export type ConfirmationModalVariant = 'danger' | 'warning' | 'info' | 'success';
+
+export interface ModalTitleProps {
+  title: string;
+  variant: ConfirmationModalVariant;
+}
+
+export interface BaseConfirmationModalProps {
+  modalId?: string;
+  title?: string;
+  children: ReactNode;
+  onConfirm?: () => void;
+  onCancel?: () => void;
+  variant?: ConfirmationModalVariant;
+  confirmButtonVariant?: ExtendedButtonVariant;
+  cancelButtonVariant?: ExtendedButtonVariant;
+  confirmLabel?: string;
+  cancelLabel?: string;
+  confirmButtonVisible?: boolean;
+  loading?: boolean;
+  disabled?: boolean;
+  autoCloseOnConfirm?: boolean;
+  size?: ModalProps['size'];
+}
+
+export interface ShowConfirmationModalReturnType {
+  modalId: string;
+  closeModal: () => void;
+  updateModal: (props: Partial<BaseConfirmationModalProps>) => void;
+}

package/src/types/models/create-genai-client-options.ts

@@ -0,0 +1,5 @@
+export interface CreateGenaiClientOptions {
+  baseUrl: string;
+  prefix?: string;
+  withCollation?: boolean;
+}

package/src/types/models/error-types.ts

@@ -0,0 +1,3 @@
+export type ErrorParams = Record<string, string | number>;
+
+export type ErrorMessageMap = Record<string, string>;

package/src/types/models/form-types.ts

@@ -0,0 +1,63 @@
+// oxlint-disable no-explicit-any
+import type { BaseFieldComponents } from '@/hooks/useAppFormSetup';
+import type {
+  AppFieldExtendedReactFormApi,
+  FormApi,
+  FormAsyncValidateOrFn,
+  FormValidateOrFn,
+  FormValidators,
+} from '@tanstack/react-form';
+import { ComponentType } from 'react';
+import { BaseIssue, BaseSchema, InferOutput, ObjectSchema } from 'valibot';
+
+export type FormValidatorsType<TSchema extends BaseSchema<any, any, BaseIssue<any>>> = FormValidators<
+  InferOutput<TSchema>,
+  FormValidateOrFn<InferOutput<TSchema>> | undefined,
+  FormValidateOrFn<InferOutput<TSchema>> | undefined,
+  FormAsyncValidateOrFn<InferOutput<TSchema>> | undefined,
+  FormValidateOrFn<InferOutput<TSchema>> | undefined,
+  FormAsyncValidateOrFn<InferOutput<TSchema>> | undefined,
+  FormValidateOrFn<InferOutput<TSchema>> | undefined,
+  FormAsyncValidateOrFn<InferOutput<TSchema>> | undefined,
+  FormValidateOrFn<InferOutput<TSchema>> | undefined,
+  FormAsyncValidateOrFn<InferOutput<TSchema>> | undefined
+>;
+
+export type GenericObjectSchema = ObjectSchema<any, any>;
+
+/** @public */
+export type GenericAppFieldExtendedReactFormApi<
+  T,
+  TSubmitMeta = never,
+  TFieldComponents extends Record<string, ComponentType<any>> = BaseFieldComponents,
+  TFormComponents extends Record<string, ComponentType<any>> = Record<string, never>,
+> = AppFieldExtendedReactFormApi<
+  T,
+  FormValidateOrFn<T> | undefined,
+  FormValidateOrFn<T> | undefined,
+  FormAsyncValidateOrFn<T> | undefined,
+  FormValidateOrFn<T> | undefined,
+  FormAsyncValidateOrFn<T> | undefined,
+  FormValidateOrFn<T> | undefined,
+  FormAsyncValidateOrFn<T> | undefined,
+  FormValidateOrFn<T> | undefined,
+  FormAsyncValidateOrFn<T> | undefined,
+  FormAsyncValidateOrFn<T> | undefined,
+  TSubmitMeta,
+  TFieldComponents,
+  TFormComponents
+>;
+
+export type GenericFormApi<T> = FormApi<
+  T,
+  FormValidateOrFn<T> | undefined,
+  FormValidateOrFn<T> | undefined,
+  FormAsyncValidateOrFn<T> | undefined,
+  FormValidateOrFn<T> | undefined,
+  FormAsyncValidateOrFn<T> | undefined,
+  FormValidateOrFn<T> | undefined,
+  FormAsyncValidateOrFn<T> | undefined,
+  FormValidateOrFn<T> | undefined,
+  FormAsyncValidateOrFn<T> | undefined,
+  FormAsyncValidateOrFn<T> | undefined
+>;

package/src/types/models/growth-book-config.ts

@@ -0,0 +1,5 @@
+export interface GrowthBookConfig {
+  apiHost: string;
+  clientKey: string;
+  enabled: boolean;
+}

package/src/types/models/hierarchy-item.ts

@@ -0,0 +1,8 @@
+/** @public */
+export interface HierarchyItem<ID = string> {
+  id: ID;
+  parentId?: string | null;
+  label: string;
+  children?: HierarchyItem[];
+  disabled?: boolean;
+}

package/src/types/models/keycloak-extended.ts

@@ -0,0 +1,18 @@
+import type Keycloak from 'keycloak-js';
+import type { KeycloakTokenParsed } from 'keycloak-js';
+import { PartyRoleToken } from './party-role-token';
+
+export interface KeycloakTokenParsedExtended extends KeycloakTokenParsed {
+  mainSub: string;
+  name: string;
+  partyId: number;
+  partyRoles: PartyRoleToken[];
+  partyRoleType: string;
+  preferred_username: string;
+  saleChannelCode: string;
+  locale: string;
+}
+
+export interface KeycloakExtended extends Keycloak {
+  tokenParsed: KeycloakTokenParsedExtended;
+}

package/src/types/models/logger-type.ts

@@ -0,0 +1,32 @@
+export type LogLevel = 'DEBUG' | 'INFO' | 'WARN' | 'ERROR';
+
+export interface LogEntry {
+  '@timestamp': string;
+  message: string;
+  logger_name: string;
+  level: LogLevel;
+  level_value: number;
+  applicationName: string;
+  traceId: string;
+  spanId: string;
+  [key: string]: unknown;
+}
+
+export interface LoggerOptions {
+  name: string;
+  enabled?: boolean;
+  minLogLevel?: LogLevel;
+  additionalFields?: Record<string, unknown>;
+}
+
+export interface LoggerConfig {
+  enabled: boolean;
+  minLogLevel: LogLevel;
+}
+
+export const LOG_LEVEL_VALUES: Record<LogLevel, number> = {
+  DEBUG: 10000,
+  INFO: 20000,
+  WARN: 30000,
+  ERROR: 40000,
+} as const;

package/src/types/models/meta.ts

@@ -0,0 +1,13 @@
+import { I18n } from '@lingui/core';
+
+export type MetaObject =
+  | {
+      title: string;
+    }
+  | { name: string; content: string }
+  | { property: string; content: string };
+
+export type MetaFunction<T extends Record<string, unknown> = Record<string, unknown>> = (
+  i18n: I18n,
+  args?: Partial<T>,
+) => MetaObject[];

package/src/types/models/nested-key-value.ts

@@ -0,0 +1,6 @@
+/** @public */
+export interface NestedKeyValue<T = string, K = string> {
+  key: T;
+  value: K;
+  children?: NestedKeyValue<T, K>[];
+}

package/src/types/models/party-role-token.ts

@@ -0,0 +1,7 @@
+export interface PartyRoleToken {
+  entityId: number;
+  partyRoleId: number;
+  roles: string[];
+  saleChannelCode: string[];
+  type: string;
+}

package/src/types/models/root-route-context.ts

@@ -0,0 +1,7 @@
+import { MetaFunction } from './meta';
+
+export interface RootRouteContext {}
+
+export interface LoaderData extends Record<string, unknown> {
+  meta?: MetaFunction;
+}

package/src/types/models/v-table-sort-info.ts

@@ -0,0 +1,14 @@
+import { ColumnSortingValues } from '@/enums/column-sorting-values.enum';
+import { ComboboxItem } from '@mantine/core';
+
+export interface VTableSortInfo {
+  field: string;
+  direction: ColumnSortingValues;
+}
+
+/** Sorting configuration for VTable - use with useUrlMetadata hook */
+export interface VTableSorting {
+  sortState: VTableSortInfo | null;
+  sortOptions: ComboboxItem[];
+  onServerSort: (sortInfo: VTableSortInfo) => void;
+}

package/src/types/models/v-table-types.ts

@@ -0,0 +1,7 @@
+export interface VTableColumn<T> {
+  accessor?: keyof T | Array<keyof T>;
+  header?: string | React.ReactNode;
+  render?: (row: T, rowIndex: number) => React.ReactNode;
+  sortable?: boolean;
+  sortFn?: (a: T[keyof T], b: T[keyof T]) => number;
+}

package/src/types/speech-recognition.d.ts

@@ -0,0 +1,56 @@
+interface SpeechRecognitionEvent extends Event {
+  readonly resultIndex: number;
+  readonly results: SpeechRecognitionResultList;
+}
+
+interface SpeechRecognitionResultList {
+  readonly length: number;
+  item(index: number): SpeechRecognitionResult;
+  [index: number]: SpeechRecognitionResult;
+}
+
+interface SpeechRecognitionResult {
+  readonly isFinal: boolean;
+  readonly length: number;
+  item(index: number): SpeechRecognitionAlternative;
+  [index: number]: SpeechRecognitionAlternative;
+}
+
+interface SpeechRecognitionAlternative {
+  readonly transcript: string;
+  readonly confidence: number;
+}
+
+interface SpeechRecognitionErrorEvent extends Event {
+  readonly error: string;
+  readonly message: string;
+}
+
+interface SpeechRecognition extends EventTarget {
+  lang: string;
+  continuous: boolean;
+  interimResults: boolean;
+  maxAlternatives: number;
+  start(): void;
+  stop(): void;
+  abort(): void;
+  onerror: ((this: SpeechRecognition, ev: SpeechRecognitionErrorEvent) => void) | null;
+  onresult: ((this: SpeechRecognition, ev: SpeechRecognitionEvent) => void) | null;
+  onend: ((this: SpeechRecognition, ev: Event) => void) | null;
+  onstart: ((this: SpeechRecognition, ev: Event) => void) | null;
+}
+
+declare var SpeechRecognition: {
+  prototype: SpeechRecognition;
+  new (): SpeechRecognition;
+};
+
+declare var webkitSpeechRecognition: {
+  prototype: SpeechRecognition;
+  new (): SpeechRecognition;
+};
+
+interface Window {
+  SpeechRecognition: typeof SpeechRecognition;
+  webkitSpeechRecognition: typeof webkitSpeechRecognition;
+}