@talex-touch/utils 1.0.42 → 1.0.45

package/transport/events/types/storage.ts

@@ -0,0 +1,208 @@
+/**
+ * @fileoverview Type definitions for Storage domain events
+ * @module @talex-touch/utils/transport/events/types/storage
+ */
+
+// ============================================================================
+// App Storage Types
+// ============================================================================
+
+/**
+ * Request to get a storage value.
+ */
+export interface StorageGetRequest {
+  /**
+   * Storage key to retrieve.
+   */
+  key: string
+}
+
+/**
+ * Versioned storage response payload.
+ */
+export interface StorageGetVersionedResponse {
+  /**
+   * Stored data.
+   */
+  data: unknown
+
+  /**
+   * Current version number.
+   */
+  version: number
+}
+
+/**
+ * Request to set a storage value.
+ */
+export interface StorageSetRequest {
+  /**
+   * Storage key.
+   */
+  key: string
+
+  /**
+   * Value to store.
+   */
+  value: unknown
+}
+
+/**
+ * Request to save a storage value with version tracking.
+ */
+export interface StorageSaveRequest {
+  /**
+   * Storage key.
+   */
+  key: string
+
+  /**
+   * Serialized JSON content.
+   */
+  content?: string
+
+  /**
+   * Raw value to serialize (fallback when content not provided).
+   */
+  value?: unknown
+
+  /**
+   * Clear stored data for the key.
+   */
+  clear?: boolean
+
+  /**
+   * Force save even if content is unchanged.
+   */
+  force?: boolean
+
+  /**
+   * Client version for conflict detection.
+   */
+  version?: number
+}
+
+/**
+ * Result for versioned storage save.
+ */
+export interface StorageSaveResult {
+  success: boolean
+  version: number
+  conflict?: boolean
+}
+
+/**
+ * Request to delete a storage value.
+ */
+export interface StorageDeleteRequest {
+  /**
+   * Storage key to delete.
+   */
+  key: string
+}
+
+// ============================================================================
+// Plugin Storage Types
+// ============================================================================
+
+/**
+ * Request to get a plugin storage value.
+ */
+export interface PluginStorageGetRequest {
+  /**
+   * Plugin name.
+   */
+  pluginName: string
+
+  /**
+   * Storage key.
+   */
+  key: string
+}
+
+/**
+ * Request to set a plugin storage value.
+ */
+export interface PluginStorageSetRequest {
+  /**
+   * Plugin name.
+   */
+  pluginName: string
+
+  /**
+   * Storage key.
+   */
+  key: string
+
+  /**
+   * Value to store.
+   */
+  value: unknown
+}
+
+/**
+ * Request to delete a plugin storage value.
+ */
+export interface PluginStorageDeleteRequest {
+  /**
+   * Plugin name.
+   */
+  pluginName: string
+
+  /**
+   * Storage key to delete.
+   */
+  key: string
+}
+
+/**
+ * Storage subscription notification.
+ */
+export interface StorageUpdateNotification {
+  /**
+   * Storage key that was updated.
+   */
+  key: string
+
+  /**
+   * New value (undefined if deleted).
+   */
+  value?: unknown
+
+  /**
+   * Version number if available.
+   */
+  version?: number
+
+  /**
+   * Update timestamp.
+   */
+  timestamp: number
+
+  /**
+   * Source of the update.
+   */
+  source?: 'local' | 'remote' | 'sync'
+}
+
+export interface StorageLegacyUpdatePayload {
+  /**
+   * Legacy storage key name.
+   */
+  name: string
+
+  /**
+   * Version number if available.
+   */
+  version?: number
+}
+
+/**
+ * Plugin storage update notification.
+ */
+export interface PluginStorageUpdateNotification extends StorageUpdateNotification {
+  /**
+   * Plugin name.
+   */
+  pluginName: string
+}

package/transport/events/types/transport.ts

@@ -0,0 +1,60 @@
+/**
+ * @fileoverview Type definitions for Transport port upgrade events
+ * @module @talex-touch/utils/transport/events/types/transport
+ * @since v0.9.0
+ */
+
+export type TransportPortScope = 'app' | 'window' | 'plugin'
+
+export interface TransportPortError {
+  code: string
+  message: string
+}
+
+export interface TransportPortUpgradeRequest {
+  channel: string
+  scope?: TransportPortScope
+  windowId?: number
+  plugin?: string
+  permissions?: string[]
+}
+
+export interface TransportPortUpgradeResponse {
+  accepted: boolean
+  channel: string
+  scope?: TransportPortScope
+  permissions?: string[]
+  portId?: string
+  error?: TransportPortError
+}
+
+export interface TransportPortConfirmPayload {
+  channel: string
+  portId: string
+  scope?: TransportPortScope
+  permissions?: string[]
+}
+
+export interface TransportPortClosePayload {
+  channel: string
+  portId?: string
+  scope?: TransportPortScope
+  reason?: string
+}
+
+export interface TransportPortErrorPayload {
+  channel: string
+  portId?: string
+  scope?: TransportPortScope
+  error: TransportPortError
+}
+
+export interface TransportPortEnvelope<TPayload = unknown> {
+  channel: string
+  portId?: string
+  streamId?: string
+  sequence?: number
+  type: 'data' | 'close' | 'error'
+  payload?: TPayload
+  error?: TransportPortError
+}

package/transport/events/types/tray.ts

@@ -0,0 +1,16 @@
+/**
+ * @fileoverview Type definitions for Tray domain events
+ * @module @talex-touch/utils/transport/events/types/tray
+ */
+
+export type TrayAutostartUpdateRequest = boolean
+export type TrayAutostartUpdateResponse = boolean
+
+export type TrayAutostartGetResponse = boolean
+
+export type TrayShowGetResponse = boolean
+
+export type TrayShowSetRequest = boolean
+export type TrayShowSetResponse = boolean
+
+export type TrayHideDockSetResponse = boolean

package/transport/events/types/update.ts

@@ -0,0 +1,78 @@
+import type {
+  AppPreviewChannel,
+  CachedUpdateRecord,
+  GitHubRelease,
+  UpdateCheckResult,
+  UpdateSettings,
+  UpdateUserAction,
+} from '../../../types/update'
+
+export interface UpdateOpResponse<T = void> {
+  success: boolean
+  data?: T
+  error?: string
+}
+
+export interface UpdateCheckRequest {
+  force?: boolean
+}
+
+export type UpdateGetStatusResponse = UpdateOpResponse<{
+  enabled: boolean
+  frequency: UpdateSettings['frequency']
+  source: UpdateSettings['source']
+  channel: AppPreviewChannel
+  polling: boolean
+  lastCheck: number | null
+  downloadReady?: boolean
+  downloadReadyVersion?: string | null
+  downloadTaskId?: string | null
+}>
+
+export interface UpdateCachedReleaseRequest {
+  channel?: AppPreviewChannel
+}
+
+export interface UpdateRecordActionRequest {
+  tag: string
+  action: UpdateUserAction
+}
+
+export type UpdateDownloadRequest = GitHubRelease
+
+export type UpdateDownloadResponse = UpdateOpResponse<{
+  taskId?: string
+}>
+
+export interface UpdateInstallRequest {
+  taskId?: string
+}
+
+export interface UpdateIgnoreVersionRequest {
+  version: string
+}
+
+export interface UpdateAutoDownloadRequest {
+  enabled: boolean
+}
+
+export interface UpdateAutoCheckRequest {
+  enabled: boolean
+}
+
+export interface UpdateAvailablePayload {
+  hasUpdate: boolean
+  release: GitHubRelease
+  source: string
+  channel?: AppPreviewChannel
+}
+
+export type UpdateGetCachedReleaseResponse = UpdateOpResponse<CachedUpdateRecord | null>
+
+export type UpdateCheckResponse = UpdateOpResponse<UpdateCheckResult>
+
+export type UpdateGetSettingsResponse = UpdateOpResponse<UpdateSettings>
+
+export interface UpdateUpdateSettingsRequest {
+  settings: Partial<UpdateSettings>
+}

package/transport/index.ts

@@ -0,0 +1,141 @@
+/**
+ * @fileoverview TuffTransport - Next-generation IPC communication system for Tuff
+ * @module @talex-touch/utils/transport
+ * @version 2.0.0
+ *
+ * @description
+ * TuffTransport provides a type-safe, high-performance IPC communication layer
+ * with support for batching, streaming, and plugin isolation.
+ *
+ * @example
+ * ```typescript
+ * import { useTuffTransport, CoreBoxEvents } from '@talex-touch/utils/transport'
+ *
+ * const transport = useTuffTransport()
+ * await transport.send(CoreBoxEvents.ui.hide)
+ * ```
+ */
+
+// ============================================================================
+// Event Builder
+// ============================================================================
+
+export {
+  /**
+   * @deprecated Use `useTuffTransport()` instead. Will be removed in v3.0.0.
+   */
+  ChannelType,
+  /**
+   * @deprecated Use `TuffTransportErrorCode` instead. Will be removed in v3.0.0.
+   */
+  DataCode,
+} from '../channel'
+
+// ============================================================================
+// Event Types
+// ============================================================================
+
+export type {
+  /**
+   * @deprecated Use `ITuffTransport` instead. Will be removed in v3.0.0.
+   */
+  ITouchChannel,
+  /**
+   * @deprecated Use `ITuffTransport` instead. Will be removed in v3.0.0.
+   */
+  ITouchClientChannel,
+  /**
+   * @deprecated Use TuffTransport types instead. Will be removed in v3.0.0.
+   */
+  RawStandardChannelData,
+  /**
+   * @deprecated Use TuffTransport types instead. Will be removed in v3.0.0.
+   */
+  StandardChannelData,
+} from '../channel'
+
+// ============================================================================
+// Predefined Events (by domain)
+// ============================================================================
+
+export {
+  TuffTransportError,
+  TuffTransportErrorCode,
+} from './errors'
+
+// ============================================================================
+// SDK Types
+// ============================================================================
+
+export {
+  assertTuffEvent,
+  defineEvent,
+  isTuffEvent,
+  TuffActionBuilder,
+  TuffEventBuilder,
+  TuffModuleBuilder,
+} from './event/builder'
+
+// ============================================================================
+// Error Types
+// ============================================================================
+
+export type {
+  BatchConfig,
+  EventOptions,
+  EventRequest,
+  EventResponse,
+  IsStreamEvent,
+  StreamChunk,
+  StreamConfig,
+  TuffEvent,
+} from './event/types'
+
+// ============================================================================
+// SDK Functions
+// ============================================================================
+
+export * from './events'
+
+// ============================================================================
+// Legacy Compatibility (Deprecated)
+// ============================================================================
+
+export {
+  createPluginTuffTransport,
+  createTuffRendererTransport,
+  useTuffTransport,
+} from './sdk'
+
+export type {
+  // Batch types
+  BatchPayload,
+  BatchResponse,
+  BatchResult,
+
+  // Contexts
+  HandlerContext,
+  IPluginTuffTransport,
+  // Transport interfaces
+  ITuffTransport,
+
+  ITuffTransportMain,
+  PluginKeyManager,
+
+  // Plugin security
+  PluginSecurityContext,
+  // Options
+  SendOptions,
+  StreamContext,
+
+  StreamController,
+  // Stream types
+  StreamMessage,
+
+  StreamMessageType,
+  StreamOptions,
+  TransportPortHandle,
+  TransportPortOpenOptions,
+} from './types'
+
+export * from './prelude'

package/transport/main.ts

@@ -0,0 +1,2 @@
+export * from './index'
+export { getTuffTransportMain } from './sdk/main'

package/transport/prelude.ts

@@ -0,0 +1,208 @@
+import { DataCode } from '../channel'
+
+type PluginChannelPreludeOptions = {
+  uniqueKey: string
+  initialData?: Record<string, unknown>
+}
+
+export function getPluginChannelPreludeCode(options: PluginChannelPreludeOptions): string {
+  const initialData = options.initialData ?? {}
+
+  return `
+(function() {
+  const uniqueKey = ${JSON.stringify(options.uniqueKey)};
+  window['$tuffInitialData'] = ${JSON.stringify(initialData)};
+  const { ipcRenderer } = require('electron');
+  const DataCode = ${JSON.stringify(DataCode)};
+  const CHANNEL_DEFAULT_TIMEOUT = 60000;
+
+  class TouchChannel {
+    channelMap = new Map();
+    pendingMap = new Map();
+    earlyMessageQueue = new Map();
+
+    constructor() {
+      ipcRenderer.on('@plugin-process-message', this.__handle_main.bind(this));
+    }
+
+    __parse_raw_data(e, arg) {
+      if (arg) {
+        const { name, header, code, plugin, data, sync } = arg;
+        if (header) {
+          const { uniqueKey: thisUniqueKey } = header;
+          if (!thisUniqueKey) {
+            console.warn('[Plugin] uniqueKey missing in header:', arg);
+          } else if (thisUniqueKey !== uniqueKey) {
+            console.error('[Plugin] uniqueKey mismatch:', thisUniqueKey, uniqueKey);
+            return null;
+          }
+          return {
+            header: {
+              status: header.status || 'request',
+              type: 'main',
+              _originData: arg,
+              event: e || undefined
+            },
+            sync,
+            code,
+            data,
+            plugin,
+            name
+          };
+        }
+      }
+      console.error(e, arg);
+      return null;
+    }
+
+    __handle_main(e, arg) {
+      const rawData = this.__parse_raw_data(e, arg);
+      if (!rawData?.header) return;
+      if (rawData.header.status === 'reply' && rawData.sync) {
+        const { id } = rawData.sync;
+        return this.pendingMap.get(id)?.(rawData);
+      }
+      const listeners = this.channelMap.get(rawData.name);
+      if (listeners && listeners.length > 0) {
+        this.__dispatch(e, rawData, listeners);
+      } else {
+        const queue = this.earlyMessageQueue.get(rawData.name) || [];
+        queue.push({ e, rawData });
+        this.earlyMessageQueue.set(rawData.name, queue);
+      }
+    }
+
+    __dispatch(e, rawData, listeners) {
+      listeners.forEach((func) => {
+        const handInData = {
+          reply: (code, data) => {
+            e.sender.send(
+              '@plugin-process-message',
+              this.__parse_sender(code, rawData, data, rawData.sync)
+            );
+          },
+          ...rawData
+        };
+        func(handInData);
+        handInData.reply(DataCode.SUCCESS, undefined);
+      });
+    }
+
+    __parse_sender(code, rawData, data, sync) {
+      return {
+        code,
+        data,
+        sync: !sync ? undefined : {
+          timeStamp: new Date().getTime(),
+          timeout: sync.timeout,
+          id: sync.id
+        },
+        name: rawData.name,
+        header: {
+          status: 'reply',
+          type: rawData.header.type,
+          _originData: rawData.header._originData
+        }
+      };
+    }
+
+    regChannel(eventName, callback) {
+      const listeners = this.channelMap.get(eventName) || [];
+      if (!listeners.includes(callback)) {
+        listeners.push(callback);
+      } else {
+        return () => {};
+      }
+      this.channelMap.set(eventName, listeners);
+
+      const earlyMessages = this.earlyMessageQueue.get(eventName);
+      if (earlyMessages && earlyMessages.length > 0) {
+        this.earlyMessageQueue.delete(eventName);
+        earlyMessages.forEach(({ e, rawData }) => {
+          this.__dispatch(e, rawData, [callback]);
+        });
+      }
+
+      return () => {
+        const index = listeners.indexOf(callback);
+        if (index !== -1) {
+          listeners.splice(index, 1);
+        }
+      };
+    }
+
+    send(eventName, arg) {
+      const uniqueId = Date.now() + '#' + eventName + '@' + Math.random().toString(12);
+      const data = {
+        code: DataCode.SUCCESS,
+        data: arg,
+        sync: {
+          timeStamp: new Date().getTime(),
+          timeout: CHANNEL_DEFAULT_TIMEOUT,
+          id: uniqueId
+        },
+        name: eventName,
+        header: {
+          uniqueKey,
+          status: 'request',
+          type: 'plugin'
+        }
+      };
+      const instance = this;
+      return new Promise((resolve, reject) => {
+        try {
+          ipcRenderer.send('@plugin-process-message', data);
+        } catch (error) {
+          const errorMessage = error instanceof Error ? error.message : String(error);
+          console.error('[Plugin] Failed to send channel message', eventName, errorMessage);
+          const sendError = new Error('Failed to send plugin channel message "' + eventName + '": ' + errorMessage);
+          sendError.code = 'plugin_channel_send_failed';
+          reject(sendError);
+          return;
+        }
+
+        const timeoutMs = data.sync?.timeout ?? CHANNEL_DEFAULT_TIMEOUT;
+        const timeoutHandle = setTimeout(() => {
+          if (!instance.pendingMap.has(uniqueId)) return;
+          instance.pendingMap.delete(uniqueId);
+          const timeoutError = new Error('Plugin channel request "' + eventName + '" timed out after ' + timeoutMs + 'ms');
+          timeoutError.code = 'plugin_channel_timeout';
+          console.warn(timeoutError.message);
+          reject(timeoutError);
+        }, timeoutMs);
+
+        instance.pendingMap.set(uniqueId, (res) => {
+          clearTimeout(timeoutHandle);
+          instance.pendingMap.delete(uniqueId);
+          resolve(res.data);
+        });
+      });
+    }
+
+    sendSync(eventName, arg) {
+      const data = {
+        code: DataCode.SUCCESS,
+        data: arg,
+        name: eventName,
+        header: {
+          uniqueKey,
+          status: 'request',
+          type: 'plugin'
+        }
+      };
+      try {
+        const res = this.__parse_raw_data(null, ipcRenderer.sendSync('@plugin-process-message', data));
+        if (res?.header?.status === 'reply') return res.data;
+        return res;
+      } catch (error) {
+        const errorMessage = error instanceof Error ? error.message : String(error);
+        console.error('[Plugin] Failed to sendSync channel message', eventName, errorMessage);
+        throw new Error('Failed to sendSync plugin channel message "' + eventName + '": ' + errorMessage);
+      }
+    }
+  }
+
+  window['$channel'] = new TouchChannel();
+})();
+`
+}