@ibdop/platform-kit 1.0.0

package/src/services/api.ts

@@ -0,0 +1,290 @@
+/**
+ * API Service - Централизованный API клиент
+ * 
+ * Предоставляет axios клиент с interceptors для auth и error handling
+ */
+
+import axios, { AxiosInstance, AxiosError, InternalAxiosRequestConfig } from 'axios'
+import type { ApiError, ApiResponse } from '../types'
+
+// MF Name for logging
+const MF_NAME = 'platform-kit'
+
+// Development mode flag
+const isDev = import.meta.env?.DEV === true || import.meta.env?.MODE === 'development'
+
+/**
+ * Logger for API
+ */
+const logger = {
+  log: (...args: unknown[]) => {
+    if (isDev) console.log(`[${MF_NAME}]`, ...args)
+  },
+  warn: (...args: unknown[]) => {
+    if (isDev) console.warn(`[${MF_NAME}]`, ...args)
+  },
+  error: (...args: unknown[]) => {
+    console.error(`[${MF_NAME}]`, ...args)
+  },
+  info: (...args: unknown[]) => {
+    if (isDev) console.info(`[${MF_NAME}]`, ...args)
+  },
+}
+
+/**
+ * Interface для конфигурации API клиента
+ */
+export interface ApiConfig {
+  timeout?: number
+  baseURL?: string
+  name?: string
+}
+
+/**
+ * Interface для ответа ошибки API
+ */
+export interface ApiErrorResponse {
+  message?: string
+  code?: string
+  status?: number
+}
+
+/**
+ * Получить состояние авторизации из shell
+ */
+function getAuthState(): { isAuthenticated: boolean; user?: { profile?: { access_token?: string } } } | null {
+  if (typeof window === 'undefined') {
+    return { isAuthenticated: false }
+  }
+
+  // Try __SHELL_AUTH_INSTANCE__
+  const shellAuth = (window as unknown as { __SHELL_AUTH_INSTANCE__?: { isAuthenticated: boolean; user?: { profile?: { access_token?: string } } } }).__SHELL_AUTH_INSTANCE__
+  if (shellAuth) {
+    return shellAuth
+  }
+
+  // Try __SHELL_AUTH__ format
+  const shellAuth2 = (window as unknown as { __SHELL_AUTH__?: { authInstance?: { isAuthenticated: boolean; user?: { profile?: { access_token?: string } } } } }).__SHELL_AUTH__
+  if (shellAuth2?.authInstance) {
+    return shellAuth2.authInstance
+  }
+
+  return { isAuthenticated: false }
+}
+
+/**
+ * Получить mfeName из window
+ */
+function getMfeName(): string {
+  if (typeof window !== 'undefined') {
+    const win = window as unknown as { __MF_NAME__?: string }
+    if (win.__MF_NAME__) return win.__MF_NAME__
+  }
+  return MF_NAME
+}
+
+/**
+ * Обработка ошибок авторизации - редирект на логин
+ */
+function handleAuthError(): void {
+  if (typeof window === 'undefined') return
+
+  const shellAuth = (window as unknown as { __SHELL_AUTH_INSTANCE__?: { signinRedirect?: () => Promise<void> } }).__SHELL_AUTH_INSTANCE__
+
+  if (shellAuth?.signinRedirect) {
+    shellAuth.signinRedirect().catch((err) => {
+      logger.error('Failed to redirect to login:', err)
+    })
+  } else {
+    window.location.href = '/'
+  }
+}
+
+/**
+ * Форматирование API ошибки в консистентную структуру
+ */
+function formatApiError(error: AxiosError<ApiErrorResponse>): ApiError {
+  const response = error.response
+
+  let errorType: ApiError['type'] = 'unknown'
+
+  if (!response) {
+    errorType = 'network'
+  } else if (response.status === 401) {
+    errorType = 'unauthorized'
+  } else if (response.status === 403) {
+    errorType = 'forbidden'
+  } else if (response.status === 404) {
+    errorType = 'not_found'
+  } else if (response.status >= 500) {
+    errorType = 'server'
+  }
+
+  return {
+    message: response?.data?.message ?? error.message ?? 'Unknown error',
+    code: response?.data?.code,
+    status: response?.status,
+    type: errorType,
+    timestamp: Date.now(),
+    url: error.config?.url,
+  }
+}
+
+/**
+ * Создание API клиента с interceptors
+ * 
+ * @param config - конфигурация клиента
+ * @returns AxiosInstance
+ * 
+ * @example
+ * ```ts
+ * const api = createApiClient({ timeout: 10000 })
+ * const response = await api.get('/api/users')
+ * ```
+ */
+export function createApiClient(config: ApiConfig = {}): AxiosInstance {
+  const clientName = config.name || MF_NAME
+
+  const clientLogger = {
+    log: (...args: unknown[]) => logger.log(`[API:${clientName}]`, ...args),
+    warn: (...args: unknown[]) => logger.warn(`[API:${clientName}]`, ...args),
+    error: (...args: unknown[]) => logger.error(`[API:${clientName}]`, ...args),
+    info: (...args: unknown[]) => logger.info(`[API:${clientName}]`, ...args),
+  }
+
+  const client = axios.create({
+    timeout: config.timeout ?? 10000,
+    baseURL: config.baseURL ?? '',
+    headers: {
+      'Content-Type': 'application/json',
+    },
+  })
+
+  // Request interceptor - добавление auth токена
+  client.interceptors.request.use(
+    (config: InternalAxiosRequestConfig) => {
+      const authState = getAuthState()
+
+      // Attach token ONLY if user is authenticated
+      if (authState?.isAuthenticated) {
+        const token = authState.user?.profile?.access_token
+        if (token && config.headers) {
+          config.headers.Authorization = `Bearer ${token}`
+          clientLogger.info('Auth token attached')
+        }
+      } else {
+        clientLogger.info('User not authenticated - request without token')
+      }
+
+      clientLogger.log(`${config.method?.toUpperCase()} ${config.url}`)
+      return config
+    },
+    (error: AxiosError) => {
+      clientLogger.error('Request interceptor error:', error.message)
+      return Promise.reject(error)
+    }
+  )
+
+  // Response interceptor - обработка ошибок
+  client.interceptors.response.use(
+    (response) => {
+      clientLogger.log(`Response ${response.status}:`, response.config.url)
+      return response
+    },
+    (error: AxiosError<ApiErrorResponse>) => {
+      const status = error.response?.status
+      const url = error.config?.url
+
+      // Categorize errors
+      if (status === 401) {
+        clientLogger.warn('401 Unauthorized - triggering re-auth')
+        handleAuthError()
+      } else if (status === 403) {
+        clientLogger.warn('403 Forbidden - insufficient permissions')
+      } else if (status === 404) {
+        clientLogger.warn('404 Not found:', url)
+      } else if (status === 429) {
+        clientLogger.warn('429 Rate limited')
+      } else if (status === 500) {
+        clientLogger.error('500 Server error:', url)
+      } else if (!error.response) {
+        clientLogger.error('Network error - backend may be unavailable:', url)
+      } else {
+        clientLogger.warn(`Error ${status}:`, error.message)
+      }
+
+      return Promise.reject(formatApiError(error))
+    }
+  )
+
+  return client
+}
+
+// Default API client instance
+export const api = createApiClient()
+
+/**
+ * GET запрос
+ */
+export async function get<T>(
+  url: string,
+  params?: Record<string, unknown>,
+  client: AxiosInstance = api
+): Promise<ApiResponse<T>> {
+  const response = await client.get<T>(url, { params })
+  return {
+    data: response.data,
+    status: response.status,
+    ok: response.status >= 200 && response.status < 300,
+  }
+}
+
+/**
+ * POST запрос
+ */
+export async function post<T>(
+  url: string,
+  data?: unknown,
+  client: AxiosInstance = api
+): Promise<ApiResponse<T>> {
+  const response = await client.post<T>(url, data)
+  return {
+    data: response.data,
+    status: response.status,
+    ok: response.status >= 200 && response.status < 300,
+  }
+}
+
+/**
+ * PUT запрос
+ */
+export async function put<T>(
+  url: string,
+  data?: unknown,
+  client: AxiosInstance = api
+): Promise<ApiResponse<T>> {
+  const response = await client.put<T>(url, data)
+  return {
+    data: response.data,
+    status: response.status,
+    ok: response.status >= 200 && response.status < 300,
+  }
+}
+
+/**
+ * DELETE запрос
+ */
+export async function del<T>(
+  url: string,
+  client: AxiosInstance = api
+): Promise<ApiResponse<T>> {
+  const response = await client.delete<T>(url)
+  return {
+    data: response.data,
+    status: response.status,
+    ok: response.status >= 200 && response.status < 300,
+  }
+}
+
+// Export logger for use in other modules
+export { logger }

package/src/services/index.ts

@@ -0,0 +1,9 @@
+/**
+ * Services barrel export
+ */
+
+export { api, createApiClient, get, post, put, del } from './api'
+export type { ApiConfig, ApiErrorResponse } from './api'
+
+export { createMfLogger, authLogger, apiLogger, errorLogger, infoLogger } from './logger'
+export type { Logger, LoggerOptions } from './logger'

package/src/services/logger.ts

@@ -0,0 +1,71 @@
+/**
+ * Logger Service - Централизованный логгер
+ * 
+ * Предоставляет фабрику логгеров с MF именем для консистентного логирования
+ */
+
+// Development mode flag
+const isDev = import.meta.env?.DEV === true || import.meta.env?.MODE === 'development'
+
+/**
+ * Interface для логгера
+ */
+export interface Logger {
+  log: (...args: unknown[]) => void
+  warn: (...args: unknown[]) => void
+  error: (...args: unknown[]) => void
+  info: (...args: unknown[]) => void
+}
+
+/**
+ * Logger options
+ */
+export interface LoggerOptions {
+  prefix?: string
+}
+
+/**
+ * Создание логгера с MF именем
+ * 
+ * @param mfeName - имя MF для префикса
+ * @param options - опции
+ * @returns Logger
+ * 
+ * @example
+ * ```ts
+ * const logger = createMfLogger('mf-home')
+ * logger.log('Info message')
+ * logger.warn('Warning message')
+ * logger.error('Error message')
+ * ```
+ */
+export function createMfLogger(mfeName: string, options?: LoggerOptions): Logger {
+  const prefix = options?.prefix ? `[${options.prefix}]` : `[${mfeName}]`
+
+  return {
+    log: (...args: unknown[]) => {
+      if (isDev) {
+        console.log(prefix, ...args)
+      }
+    },
+    warn: (...args: unknown[]) => {
+      if (isDev) {
+        console.warn(prefix, ...args)
+      }
+    },
+    error: (...args: unknown[]) => {
+      console.error(prefix, ...args)
+    },
+    info: (...args: unknown[]) => {
+      if (isDev) {
+        console.info(prefix, ...args)
+      }
+    },
+  }
+}
+
+// Pre-created loggers for common modules
+export const authLogger = createMfLogger('platform-kit', { prefix: 'AUTH' })
+export const apiLogger = createMfLogger('platform-kit', { prefix: 'API' })
+export const errorLogger = createMfLogger('platform-kit', { prefix: 'ERROR' })
+export const infoLogger = createMfLogger('platform-kit', { prefix: 'INFO' })

package/src/types/index.ts

@@ -0,0 +1,215 @@
+// Type definitions for Platform Kit
+
+// ==================== Auth Types ====================
+
+/**
+ * Shell Auth User Profile
+ */
+export interface ShellUserProfile {
+  email?: string
+  name?: string
+  preferred_username?: string
+  roles?: string[]
+  realm_roles?: string[]
+  groups?: string[]
+  access_token?: string
+}
+
+/**
+ * Shell Auth User
+ */
+export interface ShellUser {
+  access_token?: string
+  expires_at?: number
+  id_token?: string
+  profile?: ShellUserProfile
+  session_state?: string
+  token_type?: string
+  [key: string]: unknown
+}
+
+/**
+ * Shell Auth State
+ */
+export interface ShellAuth {
+  user: ShellUser | null
+  isAuthenticated: boolean
+  isLoading: boolean
+  signinRedirect: () => Promise<void>
+  removeUser?: () => Promise<void>
+  error?: string
+}
+
+// ==================== API Types ====================
+
+/**
+ * API Error types
+ */
+export type ApiErrorType =
+  | 'network'
+  | 'unauthorized'
+  | 'forbidden'
+  | 'not_found'
+  | 'server'
+  | 'client'
+  | 'unknown'
+
+/**
+ * API Error interface
+ */
+export interface ApiError {
+  message: string
+  code?: string
+  status?: number
+  type: ApiErrorType
+  timestamp: number
+  url?: string
+}
+
+/**
+ * Generic API Response wrapper
+ */
+export interface ApiResponse<T> {
+  data: T
+  status: number
+  ok: boolean
+}
+
+/**
+ * Interface для конфигурации useApi
+ */
+export interface UseApiConfig<T = never> {
+  notifyOnError?: boolean
+  notifyOnSuccess?: boolean
+  successMessage?: string
+  errorContext?: string
+  onSuccess?: (data: T) => void
+  onError?: (error: ApiError) => void
+}
+
+/**
+ * Interface для результата useApi
+ */
+export interface UseApiResult<T> {
+  data: T | null
+  error: ApiError | null
+  isLoading: boolean
+  isError: boolean
+  isSuccess: boolean
+  execute: () => Promise<T | null>
+  reset: () => void
+}
+
+// ==================== Info Types ====================
+
+/**
+ * MF Info Data from info.json
+ */
+export interface InfoData {
+  APP_NAME?: string
+  BUILD_VERSION?: string
+  IMAGE_VERSION?: string
+  BUILD_DATE?: string
+  GIT_COMMIT?: string
+  GIT_BRANCH?: string
+  COMMIT_SHA?: string
+  CI_JOB_URL?: string
+  CI_PIPELINE_URL?: string
+  CI_COMMIT_AUTHOR?: string
+  CI_COMMIT_TIMESTAMP?: string
+  CI_COMMIT_MESSAGE?: string
+  CI_PROJECT_URL?: string
+  CI_JOB_NAME?: string
+  CI_RUNNER_ID?: string
+  CONTAINER_ID?: string
+  CONTAINER_NAME?: string
+  [key: string]: string | undefined
+}
+
+// ==================== Config Types ====================
+
+/**
+ * V1 Config from sessionStorage
+ */
+export interface V1ConfigData {
+  authority: string
+  client_id: string
+  environment: string
+  front_k8s_ms_info_service_url?: string
+  mf_info?: Record<string, boolean>
+  urls?: Record<string, string>
+  [key: string]: unknown
+}
+
+// ==================== Permission Types ====================
+
+/**
+ * MF Permissions configuration
+ */
+export interface MfPermissionsConfig {
+  canView: string[]
+  canEdit: string[]
+  canDelete: string[]
+  canAdmin: string[]
+  canViewSensitiveData: string[]
+  canExportData: string[]
+  canManageUsers: string[]
+}
+
+/**
+ * User permissions result
+ */
+export interface MfPermissions {
+  canView: boolean
+  canEdit: boolean
+  canDelete: boolean
+  canAdmin: boolean
+  canViewSensitiveData: boolean
+  canExportData: boolean
+  canManageUsers: boolean
+  [key: string]: boolean
+}
+
+// ==================== Notification Types ====================
+
+/**
+ * Notification types
+ */
+export type NotificationType = 'info' | 'success' | 'warning' | 'error'
+
+/**
+ * Notification payload
+ */
+export interface NotificationPayload {
+  type: NotificationType
+  title: string
+  message: string
+  duration?: number
+  mfeName?: string
+  timestamp: number
+}
+
+// ==================== MFE Event Types ====================
+
+/**
+ * MFE Error Event detail
+ */
+export interface MFEErrorEventDetail {
+  mfeName: string
+  error: Error | string
+  stack?: string
+  componentStack?: string
+  timestamp: number
+}
+
+/**
+ * MFE Notification Event detail
+ */
+export interface MFENotificationEventDetail {
+  type: NotificationType
+  title: string
+  message: string
+  mfeName: string
+  timestamp: number
+  duration?: number
+}