egos-transfer 0.0.8

package/src/interfaces.ts

@@ -0,0 +1,420 @@
+import {
+  InternalApi,
+  MessageStatus,
+  NetworkQuality,
+  PeerAction,
+  TransferError,
+  TransferPriority,
+} from './entity';
+
+import { DataConnection } from 'peerjs';
+
+export type PeerOnOpen = (peerId: string) => void;
+export type PeerOnData = (data: string) => void;
+
+export type PeerOnError = (error: Error) => void;
+
+export type PeerOnClose = () => void;
+
+export type PeerOnConnection = (conn: DataConnection) => void;
+
+// Awesome: Enhanced event types
+export type TransferProgressCallback = (progress: TransferProgress) => void;
+export type TransferStatusCallback = (status: MessageStatus) => void;
+export type NetworkQualityCallback = (quality: NetworkQuality) => void;
+export type ErrorCallback = (error: TransferError) => void;
+
+export interface IMessage {
+  src: string;
+  type: string;
+  payload: Record<string, any>;
+  dst?: string;
+}
+
+export type ConnectionListeners = {
+  onOpen?: PeerOnOpen;
+  onData: PeerOnData;
+  onError?: PeerOnError;
+  onClose?: PeerOnClose;
+};
+
+export interface PeerListeners {
+  onOpen?: PeerOnOpen;
+  onData: PeerOnData;
+  onError?: PeerOnError;
+  onClose?: PeerOnClose;
+}
+
+export interface PeerMessage {
+  id: string;
+  src: string;
+  dest: string;
+  type?: string;
+  method: string;
+  action: string;
+  route: string;
+  body: Record<string, any>;
+  error?: Record<string, any> | string;
+  createdAt: string | number;
+  requestId: string;
+  headers: Record<string, any>;
+  status?: string;
+  // Awesome: Enhanced message properties
+  priority?: TransferPriority;
+  retryCount?: number;
+  timeout?: number;
+  metadata?: Record<string, any>;
+}
+
+export interface FileMessageItem extends PeerMessage {
+  body: {
+    filename: string;
+    size: string;
+    path: string;
+  };
+}
+
+export type PeerRequestPayload = {
+  requestId?: string;
+  body: Record<string, any>;
+  headers?: Record<string, string | number>;
+  route: string;
+  id?: string;
+  method: string;
+  timeout?: number;
+};
+
+export interface FileMessageBody {
+  filename: string;
+  size: number;
+  path: string;
+  type?: string;
+  fileId?: number | string;
+  // Awesome: Enhanced file properties
+  checksum?: string;
+  lastModified?: number;
+  permissions?: string;
+  compression?: boolean;
+  encryption?: boolean;
+}
+
+export interface PeerFileItem {
+  id: number | string;
+  name: string;
+  mtime: number | string;
+  ctime?: number | string;
+  path: string;
+  size: number;
+  mime: string;
+  isFile: boolean;
+  isDirectory: boolean;
+  iconUrl?: string;
+  originalPath?: string;
+  createdAt?: string;
+  updatedAt?: string;
+  action?: string;
+  // Awesome: Enhanced file properties
+  checksum?: string;
+  permissions?: string;
+  owner?: string;
+  group?: string;
+  isHidden?: boolean;
+  isReadOnly?: boolean;
+  thumbnail?: string;
+  tags?: string[];
+  metadata?: Record<string, any>;
+  progress?: number;
+}
+
+export interface MessageTaskEntity {
+  id: number | string;
+  transId: string;
+  deviceId: string;
+  processed: (number | undefined)[];
+  status: string;
+  cacheFile: string;
+  chunkSize: number;
+  size: number;
+  mime?: string;
+  filename: string;
+  hash: string;
+  createdAt: number;
+  updatedAt?: number;
+  algorithm: string;
+  action: string;
+  resource: {
+    fileId: string | number;
+    filePath: string;
+    parent?: { path: string; parentId: number | string };
+    token?: string; // for share file
+  };
+  saved?: Record<string, string>;
+  // Awesome: Enhanced task properties
+  priority?: TransferPriority;
+  retryCount?: number;
+  maxRetries?: number;
+  startTime?: number;
+  endTime?: number;
+  bytesTransferred?: number;
+  speed?: number;
+  estimatedTimeRemaining?: number;
+  error?: TransferError;
+  metadata?: Record<string, any>;
+  tags?: string[];
+  compression?: boolean;
+  encryption?: boolean;
+}
+
+export type RequestCallbackFn = (conn: DataConnection, message: PeerMessage, next?: any) => any;
+
+export interface RouteItem {
+  path: string;
+  method: string;
+  scope: number;
+  callback: RequestCallbackFn;
+  // Awesome: Enhanced route properties
+  priority?: TransferPriority;
+  timeout?: number;
+  retryOnFailure?: boolean;
+  middleware?: string[];
+}
+
+export interface MiddlewareItem {
+  path: string;
+  handler: RequestCallbackFn;
+  // Awesome: Enhanced middleware properties
+  priority?: number;
+  async?: boolean;
+  errorHandler?: (error: Error) => void;
+}
+
+export type DataMessage = {
+  id: string;
+  src: string;
+  dest: string;
+  type: string;
+  body: Record<string, any>;
+  status: string;
+  action: PeerAction;
+  userId?: number;
+  guid?: string;
+  createdAt: number | string;
+  processed?: number;
+  // Awesome: Enhanced data message properties
+  priority?: TransferPriority;
+  retryCount?: number;
+  metadata?: Record<string, any>;
+};
+
+export interface MetaData {
+  size: number;
+  chunkSize: number;
+  fileId: string | number;
+  filePath: string;
+  hash: string;
+  algorithm: string;
+  filename: string;
+  mime?: string;
+}
+
+export interface ChunkData {
+  chunkSize: number;
+  chunkNumber: number;
+  data: FormData | Uint8Array;
+  transId: string;
+  totalChunk: number;
+  http: boolean;
+  // Awesome: Enhanced chunk properties
+  checksum?: string;
+  compressed?: boolean;
+  encrypted?: boolean;
+  timestamp?: number;
+  retryCount?: number;
+}
+
+export interface ApiInfo {
+  url: string;
+  token: string;
+  status: boolean;
+}
+
+export interface TransferPrepareData {
+  fileId: string | number;
+  filePath: string;
+  transId: string;
+  action: string;
+  parent?: {
+    parentId: number | string;
+    path: string;
+  };
+  status?: MessageStatus;
+  mime: string;
+}
+
+// Awesome: New enhanced interfaces
+export interface TransferProgress {
+  transId: string;
+  bytesTransferred: number;
+  totalBytes: number;
+  percentage: number;
+  speed: number; // bytes per second
+  estimatedTimeRemaining: number; // seconds
+  status: MessageStatus;
+  startTime: number;
+  currentTime: number;
+  chunksProcessed: number;
+  totalChunks: number;
+  networkQuality: NetworkQuality;
+  error?: TransferError;
+}
+
+export interface TransferOptions {
+  priority?: TransferPriority;
+  chunkSize?: number;
+  maxConcurrentChunks?: number;
+  retryOnFailure?: boolean;
+  maxRetries?: number;
+  verifyChecksum?: boolean;
+  compression?: boolean;
+  encryption?: boolean;
+  timeout?: number;
+  onProgress?: TransferProgressCallback;
+  onStatus?: TransferStatusCallback;
+  onError?: ErrorCallback;
+  metadata?: Record<string, any>;
+}
+
+export interface BatchTransferOptions extends TransferOptions {
+  concurrent: number;
+  queuePriority: TransferPriority;
+  stopOnError: boolean;
+  resumeOnRestart: boolean;
+}
+
+export interface NetworkMonitor {
+  latency: number;
+  bandwidth: number;
+  quality: NetworkQuality;
+  packetLoss: number;
+  jitter: number;
+  lastUpdated: number;
+  isStable: boolean;
+}
+
+export interface TransferQueue {
+  id: string;
+  items: TransferQueueItem[];
+  maxConcurrent: number;
+  currentRunning: number;
+  paused: boolean;
+  createdAt: number;
+  updatedAt: number;
+}
+
+export interface FilesResponse {
+  data: PeerFileItem[];
+  meta: Record<string, any>;
+}
+
+export interface FileMetaParams {
+  transId: string;
+  fileId: string;
+  filePath: string;
+}
+
+export interface FileChunkParams {
+  fileId: string | number;
+  filePath?: string;
+  transId: string;
+  chunkNumber: number;
+  chunkSize: number;
+  totalChunk: number;
+}
+
+export interface FileStartParams {
+  transId: string;
+  fileId: string;
+  filePath: string;
+  deviceId: string;
+  action: string;
+  parent?: {
+    parentId: number;
+    path: string;
+  };
+}
+
+export interface ExchangeTokenParams {
+  apiInfo: InternalApi;
+  onetimeToken: string;
+  security: boolean;
+}
+
+export interface GetFilesParams {
+  parent: Record<string, any>;
+  offset?: number;
+  limit?: number;
+  order?: Record<string, string>;
+  keyword?: string;
+}
+
+export interface FileBasic {
+  fileId: string | number;
+  filePath: string;
+}
+
+export interface FilePreviewParams {
+  fileId: string | number;
+  filePath: string;
+  thumb: boolean;
+}
+
+export interface ShareParams {
+  token: string;
+  thumb?: boolean;
+  fileId: number;
+  pwd: string;
+}
+
+export type TransmitFailureParams = {
+  transId: string;
+  // Awesome: Enhanced failure params
+  error?: TransferError;
+  retryable?: boolean;
+  suggestedAction?: string;
+};
+
+// Awesome: New utility interfaces
+export interface DeviceInfo {
+  deviceId: string;
+  name: string;
+  platform: string;
+  version: string;
+  capabilities: string[];
+  networkStats: NetworkStats;
+  lastSeen: number;
+  isOnline: boolean;
+}
+
+export interface NetworkStats {
+  latency: number;
+  bandwidth: number;
+  quality: NetworkQuality;
+  packetLoss: number;
+  jitter: number;
+}
+
+export interface TransferQueueItem {
+  id: string;
+  priority: TransferPriority;
+  createdAt: number;
+  scheduledFor?: number;
+  retryCount: number;
+  maxRetries: number;
+  data: TransferPrepareData;
+  options?: TransferOptions;
+}
+
+export interface IDeviceStatus {
+  deviceId: string;
+  isOnline: boolean;
+}