makelore/electron/image-workspace/module.ts

import type {
  DesignAsset,
  DesignAssetUploadInput,
  DesignCapabilities,
  DesignConfirmGenerationInput,
  DesignCreateWorkspaceInput,
  DesignGenerationTask,
  DesignRenameWorkspaceInput,
  DesignSubmitMessageInput,
  DesignWorkspace,
  DesignWorkspaceBootstrap,
  DesignWorkspaceEvent,
} from '../../shared/image-workspace';

export type DesignWorkspaceEventSubscription = {
  events: AsyncIterable<DesignWorkspaceEvent>;
  close(): void;
};

export type DesignWorkspaceEventSubscriptionInput = {
  workspaceId: string;
  afterEventId?: string;
};

export type CloseEventSessionsOptions = {
  accessToken?: string;
  tolerateRemoteFailure?: boolean;
};

export class DesignWorkspaceModuleError extends Error {
  readonly status: number;
  readonly code: string;

  constructor(status: number, code: string, message: string) {
    super(message);
    this.name = 'DesignWorkspaceModuleError';
    this.status = status;
    this.code = code;
  }
}

export interface DesignWorkspaceModule {
  bootstrap(): Promise<DesignWorkspaceBootstrap>;
  getCapabilities(): Promise<DesignCapabilities>;
  createWorkspace(input: DesignCreateWorkspaceInput): Promise<DesignWorkspace>;
  renameWorkspace(input: DesignRenameWorkspaceInput): Promise<DesignWorkspace>;
  getWorkspace(workspaceId: string): Promise<DesignWorkspace>;
  submitMessage(input: DesignSubmitMessageInput): Promise<DesignWorkspace>;
  confirmGeneration(input: DesignConfirmGenerationInput): Promise<DesignWorkspace>;
  listTasks(workspaceId: string): Promise<DesignGenerationTask[]>;
  uploadAsset?(input: DesignAssetUploadInput): Promise<DesignAsset>;
  openWorkspaceEvents?(
    input: DesignWorkspaceEventSubscriptionInput,
  ): Promise<DesignWorkspaceEventSubscription>;
  closeEventSessions?(options?: CloseEventSessionsOptions): Promise<void>;
  openAssetContent(workspaceId: string, assetId: string, range?: string): Promise<Response>;
  reset?(): Promise<DesignWorkspaceBootstrap>;
}