@talex-touch/utils 1.0.42 → 1.0.44

package/transport/events/types/app.ts

@@ -0,0 +1,475 @@
+import type { AnalyticsWindowType } from '../../../analytics'
+import type { StartupInfo } from '../../../types'
+/**
+ * @fileoverview Type definitions for App domain events
+ * @module @talex-touch/utils/transport/events/types/app
+ */
+
+// ============================================================================
+// App Window Types
+// ============================================================================
+
+/**
+ * Options for opening developer tools.
+ */
+export interface DevToolsOptions {
+  /**
+   * DevTools display mode.
+   * @defaultValue 'undocked'
+   */
+  mode?: 'undocked' | 'detach' | 'right' | 'bottom'
+}
+
+// ============================================================================
+// System Types
+// ============================================================================
+
+/**
+ * Operating system information.
+ */
+export interface OSInfo {
+  /**
+   * Operating system platform.
+   * @example 'darwin', 'win32', 'linux'
+   */
+  platform: NodeJS.Platform
+
+  /**
+   * CPU architecture.
+   * @example 'x64', 'arm64'
+   */
+  arch: string
+
+  /**
+   * OS version string.
+   */
+  version: string
+
+  /**
+   * OS release string.
+   */
+  release: string
+
+  /**
+   * OS type.
+   * @example 'Darwin', 'Windows_NT', 'Linux'
+   */
+  type: string
+
+  /**
+   * Home directory path.
+   */
+  homedir: string
+
+  /**
+   * Hostname.
+   */
+  hostname: string
+
+  /**
+   * Total system memory in bytes.
+   */
+  totalmem: number
+
+  /**
+   * Free system memory in bytes.
+   */
+  freemem: number
+
+  /**
+   * System uptime in seconds.
+   */
+  uptime: number
+
+  /**
+   * CPU information.
+   */
+  cpus: Array<{
+    model: string
+    speed: number
+  }>
+}
+
+/**
+ * Application package information.
+ */
+export interface PackageInfo {
+  /**
+   * Package name.
+   */
+  name: string
+
+  /**
+   * Package version.
+   */
+  version: string
+
+  /**
+   * Package description.
+   */
+  description?: string
+
+  /**
+   * Package author.
+   */
+  author?: string | { name: string, email?: string }
+
+  /**
+   * Package license.
+   */
+  license?: string
+
+  /**
+   * Build timestamp (if available).
+   */
+  buildTime?: string
+
+  /**
+   * Git commit hash (if available).
+   */
+  commit?: string
+}
+
+/**
+ * Request to open an external URL.
+ */
+export interface OpenExternalRequest {
+  /**
+   * URL to open in the default browser.
+   */
+  url: string
+}
+
+/**
+ * Request to show item in folder.
+ */
+export interface ShowInFolderRequest {
+  /**
+   * Path to the file or folder.
+   */
+  path: string
+}
+
+/**
+ * Request to open an application.
+ */
+export interface OpenAppRequest {
+  /**
+   * Application name or path.
+   */
+  appName?: string
+
+  /**
+   * Application path (alternative to appName).
+   */
+  path?: string
+}
+
+/**
+ * Request to execute a command/open a path.
+ */
+export interface ExecuteCommandRequest {
+  /**
+   * Command or path to execute.
+   */
+  command: string
+}
+
+/**
+ * Response from execute command.
+ */
+export interface ExecuteCommandResponse {
+  /**
+   * Whether the command executed successfully.
+   */
+  success: boolean
+
+  /**
+   * Error message if failed.
+   */
+  error?: string
+}
+
+/**
+ * Request to read a local file as text.
+ */
+export interface ReadFileRequest {
+  /**
+   * File path or local file URL (file://, tfile://).
+   */
+  source: string
+
+  /**
+   * If true, ENOENT returns an empty string instead of throwing.
+   */
+  allowMissing?: boolean
+}
+
+/**
+ * Request to resolve an app path.
+ */
+export interface GetPathRequest {
+  /**
+   * Electron app.getPath key.
+   */
+  name: string
+}
+
+/**
+ * Request to read a value from secure local storage.
+ */
+export interface SecureValueGetRequest {
+  /**
+   * Storage key.
+   */
+  key: string
+}
+
+/**
+ * Request to write a value into secure local storage.
+ */
+export interface SecureValueSetRequest {
+  /**
+   * Storage key.
+   */
+  key: string
+
+  /**
+   * Plain value before encryption. Null removes the key.
+   */
+  value: string | null
+}
+
+/**
+ * Startup handshake payload.
+ */
+export interface StartupRequest {
+  rendererStartTime: number
+}
+
+/**
+ * Startup handshake response.
+ */
+export type StartupResponse = StartupInfo
+
+// =========================================================================
+// UI / Navigation Types
+// =========================================================================
+
+export interface NavigateRequest {
+  path: string
+}
+
+// =========================================================================
+// Locale / I18n Types
+// =========================================================================
+
+export type Locale = 'zh-CN' | 'en-US'
+
+export interface SetLocaleRequest {
+  locale: Locale
+}
+
+// =========================================================================
+// Renderer Perf Report Types
+// =========================================================================
+
+export type RendererPerfReportKind
+  = | 'channel.sendSync.slow'
+    | 'channel.send.slow'
+    | 'channel.send.timeout'
+    | 'channel.send.errorReply'
+    | 'ui.route.navigate'
+    | 'ui.route.render'
+    | 'ui.route.transition'
+    | 'ui.details.fetch'
+    | 'ui.details.render'
+    | 'ui.details.total'
+    | 'ui.component.load'
+
+export interface RendererPerfReport {
+  kind: RendererPerfReportKind
+  eventName: string
+  durationMs: number
+  at: number
+  payloadPreview?: string
+  stack?: string
+  meta?: Record<string, unknown>
+}
+
+// ============================================================================
+// Build Verification Types
+// ============================================================================
+
+/**
+ * Build verification status.
+ */
+export interface BuildVerificationStatus {
+  /**
+   * Whether this is an official build.
+   */
+  isOfficialBuild: boolean
+
+  /**
+   * Whether verification failed.
+   */
+  verificationFailed: boolean
+
+  /**
+   * Whether the build has an official key.
+   */
+  hasOfficialKey: boolean
+}
+
+export interface BatteryStatusPayload {
+  /**
+   * Whether the device is on battery power.
+   */
+  onBattery?: boolean
+
+  /**
+   * Battery percentage (null if unavailable).
+   */
+  percent?: number | null
+}
+
+// ============================================================================
+// Analytics Types
+// ============================================================================
+
+/**
+ * Current performance metrics.
+ *
+ * @deprecated Use AnalyticsSnapshot/CoreMetrics from @talex-touch/utils/analytics instead.
+ */
+export interface CurrentMetrics {
+  startupTime?: number
+  memoryUsage?: number
+  cpuUsage?: number
+  [key: string]: unknown
+}
+
+/**
+ * Toggle request for analytics reporting.
+ */
+export interface AnalyticsToggleRequest {
+  enabled: boolean
+}
+
+/**
+ * Snapshot request by window type.
+ */
+export interface AnalyticsSnapshotRequest {
+  windowType: AnalyticsWindowType
+}
+
+export type {
+  AnalyticsExportPayload,
+  AnalyticsExportResult,
+  AnalyticsMessage,
+  AnalyticsMessageListRequest,
+  AnalyticsMessageUpdateRequest,
+  AnalyticsRangeRequest,
+  AnalyticsSnapshot,
+  AnalyticsWindowType,
+  CounterPayload,
+  FeatureStats,
+  GaugePayload,
+  HistogramPayload,
+  PluginStats,
+  TrackDurationPayload,
+  TrackEventPayload,
+} from '../../../analytics'
+
+/**
+ * Performance history entry.
+ */
+export interface PerformanceHistoryEntry {
+  /**
+   * Timestamp of the entry.
+   */
+  timestamp: number
+
+  /**
+   * Metrics at this point in time.
+   */
+  metrics: CurrentMetrics
+}
+
+/**
+ * Performance summary statistics.
+ */
+export interface PerformanceSummary {
+  /**
+   * Average startup time.
+   */
+  avgStartupTime?: number
+
+  /**
+   * Average memory usage.
+   */
+  avgMemoryUsage?: number
+
+  /**
+   * Number of samples.
+   */
+  sampleCount: number
+
+  /**
+   * Time range covered.
+   */
+  timeRange?: {
+    start: number
+    end: number
+  }
+}
+
+/**
+ * Exported metrics data.
+ */
+export interface ExportedMetrics {
+  /**
+   * Export timestamp.
+   */
+  exportedAt: number
+
+  /**
+   * Application version.
+   */
+  appVersion: string
+
+  /**
+   * Current metrics.
+   */
+  current: CurrentMetrics
+
+  /**
+   * Historical data.
+   */
+  history: PerformanceHistoryEntry[]
+
+  /**
+   * Summary statistics.
+   */
+  summary: PerformanceSummary
+}
+
+/**
+ * Request to report metrics.
+ */
+export interface ReportMetricsRequest {
+  /**
+   * Optional endpoint to report to.
+   */
+  endpoint?: string
+}
+
+/**
+ * Response from report metrics.
+ */
+export interface ReportMetricsResponse {
+  /**
+   * Whether reporting succeeded.
+   */
+  success: boolean
+}

package/transport/events/types/box-item.ts

@@ -0,0 +1,222 @@
+/**
+ * @fileoverview Type definitions for BoxItem domain events
+ * @module @talex-touch/utils/transport/events/types/box-item
+ */
+
+import type { TuffAction, TuffIcon, TuffMeta } from './core-box'
+
+// ============================================================================
+// BoxItem Core Types
+// ============================================================================
+
+/**
+ * BoxItem represents a searchable item in the CoreBox.
+ */
+export interface BoxItem {
+  /**
+   * Unique item ID (must be unique per source).
+   */
+  id: string
+
+  /**
+   * Display title.
+   */
+  title: string
+
+  /**
+   * Optional subtitle/description.
+   */
+  subtitle?: string
+
+  /**
+   * Item icon.
+   */
+  icon?: string | TuffIcon
+
+  /**
+   * Source identifier (usually plugin name).
+   */
+  source: string
+
+  /**
+   * Keywords for search matching.
+   */
+  keywords?: string[]
+
+  /**
+   * Relevance score hint (0-1).
+   */
+  score?: number
+
+  /**
+   * Item metadata.
+   */
+  meta?: TuffMeta
+
+  /**
+   * Available actions.
+   */
+  actions?: TuffAction[]
+
+  /**
+   * Custom data attached to this item.
+   */
+  data?: Record<string, unknown>
+
+  /**
+   * Creation timestamp.
+   */
+  createdAt?: number
+
+  /**
+   * Last update timestamp.
+   */
+  updatedAt?: number
+}
+
+// ============================================================================
+// CRUD Types
+// ============================================================================
+
+/**
+ * Request to create a BoxItem.
+ */
+export interface BoxItemCreateRequest {
+  /**
+   * Item to create (id may be auto-generated).
+   */
+  item: Omit<BoxItem, 'createdAt' | 'updatedAt'> & { id?: string }
+}
+
+/**
+ * Request to update a BoxItem.
+ */
+export interface BoxItemUpdateRequest {
+  /**
+   * Item ID to update.
+   */
+  id: string
+
+  /**
+   * Fields to update.
+   */
+  updates: Partial<Omit<BoxItem, 'id' | 'source' | 'createdAt' | 'updatedAt'>>
+}
+
+/**
+ * Request to upsert (create or update) a BoxItem.
+ */
+export interface BoxItemUpsertRequest {
+  /**
+   * Item to upsert.
+   */
+  item: BoxItem
+}
+
+/**
+ * Request to delete a BoxItem.
+ */
+export interface BoxItemDeleteRequest {
+  /**
+   * Item ID to delete.
+   */
+  id: string
+}
+
+// ============================================================================
+// Batch Types
+// ============================================================================
+
+/**
+ * Request to batch upsert BoxItems.
+ */
+export interface BoxItemBatchUpsertRequest {
+  /**
+   * Items to upsert.
+   */
+  items: BoxItem[]
+}
+
+/**
+ * Response from batch upsert.
+ */
+export interface BoxItemBatchUpsertResponse {
+  /**
+   * Successfully upserted items.
+   */
+  items: BoxItem[]
+
+  /**
+   * Number of items created.
+   */
+  created: number
+
+  /**
+   * Number of items updated.
+   */
+  updated: number
+}
+
+/**
+ * Request to batch delete BoxItems.
+ */
+export interface BoxItemBatchDeleteRequest {
+  /**
+   * Item IDs to delete.
+   */
+  ids: string[]
+}
+
+/**
+ * Response from batch delete.
+ */
+export interface BoxItemBatchDeleteResponse {
+  /**
+   * Number of items deleted.
+   */
+  deleted: number
+}
+
+/**
+ * Request to clear BoxItems.
+ */
+export interface BoxItemClearRequest {
+  /**
+   * Source to clear (if not specified, clears all).
+   */
+  source?: string
+}
+
+/**
+ * Response from clear operation.
+ */
+export interface BoxItemClearResponse {
+  /**
+   * Number of items cleared.
+   */
+  cleared: number
+}
+
+// ============================================================================
+// Sync Types
+// ============================================================================
+
+/**
+ * Response from sync request (stream of items).
+ */
+export interface BoxItemSyncResponse {
+  /**
+   * Items being synced.
+   */
+  items: BoxItem[]
+
+  /**
+   * Total count of items.
+   */
+  total: number
+
+  /**
+   * Whether this is the last batch.
+   */
+  done: boolean
+}