@sogni-ai/sogni-client 0.3.3 → 0.4.0-aplha.10

package/src/Projects/index.ts

@@ -14,9 +14,28 @@ import { ApiError, ApiReponse } from '../ApiClient';
 import { EstimationResponse } from './types/EstimationResponse';
 import { JobEvent, ProjectApiEvents, ProjectEvent } from './types/events';
 import getUUID from '../lib/getUUID';
+import { RawProject } from './types/RawProject';
+import ErrorData from '../types/ErrorData';
 
 const GARBAGE_COLLECT_TIMEOUT = 10000;
 
+function mapErrorCodes(code: string): number {
+  switch (code) {
+    case 'serverRestarting':
+      return 5001;
+    case 'workerDisconnected':
+      return 5002;
+    case 'jobTimedOut':
+      return 5003;
+    case 'artistCanceled':
+      return 5004;
+    case 'ç':
+      return 5005;
+    default:
+      return 5000;
+  }
+}
+
 class ProjectsApi extends ApiGroup<ProjectApiEvents> {
   private _availableModels: AvailableModel[] = [];
   private projects: Project[] = [];
@@ -28,6 +47,7 @@ class ProjectsApi extends ApiGroup<ProjectApiEvents> {
   constructor(config: ApiConfig) {
     super(config);
     // Listen to server events and emit them as project and job events
+    this.client.socket.on('changeNetwork', this.handleChangeNetwork.bind(this));
     this.client.socket.on('swarmModels', this.handleSwarmModels.bind(this));
     this.client.socket.on('jobState', this.handleJobState.bind(this));
     this.client.socket.on('jobProgress', this.handleJobProgress.bind(this));
@@ -40,6 +60,11 @@ class ProjectsApi extends ApiGroup<ProjectApiEvents> {
     this.on('job', this.handleJobEvent.bind(this));
   }
 
+  private handleChangeNetwork() {
+    this._availableModels = [];
+    this.emit('availableModels', this._availableModels);
+  }
+
   private handleSwarmModels(data: SocketEventMap['swarmModels']) {
     const modelIndex = models.reduce((acc: Record<string, any>, model) => {
       acc[model.modelId] = model;
@@ -66,10 +91,20 @@ class ProjectsApi extends ApiGroup<ProjectApiEvents> {
         this.emit('project', { type: 'completed', projectId: data.jobID });
         return;
       case 'initiatingModel':
-        this.emit('job', { type: 'initiating', projectId: data.jobID, jobId: data.imgID });
+        this.emit('job', {
+          type: 'initiating',
+          projectId: data.jobID,
+          jobId: data.imgID,
+          workerName: data.workerName
+        });
         return;
       case 'jobStarted': {
-        this.emit('job', { type: 'started', projectId: data.jobID, jobId: data.imgID });
+        this.emit('job', {
+          type: 'started',
+          projectId: data.jobID,
+          jobId: data.imgID,
+          workerName: data.workerName
+        });
         return;
       }
     }
@@ -127,14 +162,25 @@ class ProjectsApi extends ApiGroup<ProjectApiEvents> {
   }
 
   private handleJobError(data: JobErrorData) {
+    const errorCode = Number(data.error);
+    let error: ErrorData;
+    if (!isNaN(errorCode)) {
+      error = {
+        code: errorCode,
+        message: data.error_message
+      };
+    } else {
+      error = {
+        code: mapErrorCodes(data.error as string),
+        originalCode: data.error?.toString(),
+        message: data.error_message
+      };
+    }
     if (!data.imgID) {
       this.emit('project', {
         type: 'error',
         projectId: data.jobID,
-        error: {
-          code: Number(data.error),
-          message: data.error_message
-        }
+        error
       });
       return;
     }
@@ -142,14 +188,11 @@ class ProjectsApi extends ApiGroup<ProjectApiEvents> {
       type: 'error',
       projectId: data.jobID,
       jobId: data.imgID,
-      error: {
-        code: Number(data.error),
-        message: data.error_message
-      }
+      error: error
     });
   }
 
-  handleProjectEvent(event: ProjectEvent) {
+  private handleProjectEvent(event: ProjectEvent) {
     let project = this.projects.find((p) => p.id === event.projectId);
     if (!project) {
       return;
@@ -172,14 +215,18 @@ class ProjectsApi extends ApiGroup<ProjectApiEvents> {
           error: event.error
         });
     }
-    if (project.status === 'completed' || project.status === 'failed') {
+    if (project.finished) {
+      // Sync project data with the server and remove it from the list after some time
+      project._syncToServer().catch((e) => {
+        this.client.logger.error(e);
+      });
       setTimeout(() => {
         this.projects = this.projects.filter((p) => p.id !== event.projectId);
       }, GARBAGE_COLLECT_TIMEOUT);
     }
   }
 
-  handleJobEvent(event: JobEvent) {
+  private handleJobEvent(event: JobEvent) {
     let project = this.projects.find((p) => p.id === event.projectId);
     if (!project) {
       return;
@@ -188,6 +235,7 @@ class ProjectsApi extends ApiGroup<ProjectApiEvents> {
     if (!job) {
       job = project._addJob({
         id: event.jobId,
+        projectId: event.projectId,
         status: 'pending',
         step: 0,
         stepCount: project.params.steps
@@ -195,10 +243,10 @@ class ProjectsApi extends ApiGroup<ProjectApiEvents> {
     }
     switch (event.type) {
       case 'initiating':
-        job._update({ status: 'initiating' });
+        job._update({ status: 'initiating', workerName: event.workerName });
         break;
       case 'started':
-        job._update({ status: 'processing' });
+        job._update({ status: 'processing', workerName: event.workerName });
         break;
       case 'progress':
         job._update({
@@ -268,7 +316,7 @@ class ProjectsApi extends ApiGroup<ProjectApiEvents> {
    * @param data
    */
   async create(data: ProjectParams): Promise<Project> {
-    const project = new Project({ ...data });
+    const project = new Project({ ...data }, { api: this, logger: this.client.logger });
     if (data.startingImage) {
       await this.uploadGuideImage(project.id, data.startingImage);
     }
@@ -278,6 +326,19 @@ class ProjectsApi extends ApiGroup<ProjectApiEvents> {
     return project;
   }
 
+  /**
+   * Get project by id, this API returns project data from the server only if the project is
+   * completed or failed. If the project is still processing, it will throw 404 error.
+   * @internal
+   * @param projectId
+   */
+  async get(projectId: string) {
+    const { data } = await this.client.rest.get<ApiReponse<RawProject>>(
+      `/v1/projects/${projectId}`
+    );
+    return data;
+  }
+
   private async uploadGuideImage(projectId: string, file: File | Buffer | Blob) {
     const imageId = getUUID();
     const presignedUrl = await this.uploadUrl({
@@ -320,6 +381,11 @@ class ProjectsApi extends ApiGroup<ProjectApiEvents> {
     };
   }
 
+  /**
+   * Get upload URL for image
+   * @internal
+   * @param params
+   */
   async uploadUrl(params: ImageUrlParams) {
     const r = await this.client.rest.get<ApiReponse<{ uploadUrl: string }>>(
       `/v1/image/uploadUrl`,
@@ -328,6 +394,11 @@ class ProjectsApi extends ApiGroup<ProjectApiEvents> {
     return r.data.uploadUrl;
   }
 
+  /**
+   * Get download URL for image
+   * @internal
+   * @param params
+   */
   async downloadUrl(params: ImageUrlParams) {
     const r = await this.client.rest.get<ApiReponse<{ downloadUrl: string }>>(
       `/v1/image/downloadUrl`,

package/src/Projects/types/RawProject.ts

@@ -0,0 +1,121 @@
+import { SupernetType } from '../../ApiClient/WebSocketClient/types';
+
+export interface RawProject {
+  id: string;
+  SID: number;
+  artist: Account;
+  model: ProjectModel;
+  imageCount: number;
+  stepCount: number;
+  previewCount: number;
+  hasGuideImage: boolean;
+  denoiseStrength: string;
+  costEstimate: CostEstimate;
+  costActual: CostActual;
+  createTime: number;
+  updateTime: number;
+  endTime: number;
+  status: RawProjectStatus;
+  reason: 'allJobsCompleted' | 'artistCanceled';
+  network: SupernetType;
+  txId: string;
+  workerJobs: RawJob[];
+  completedWorkerJobs: RawJob[];
+}
+
+type RawProjectStatus =
+  | 'pending'
+  | 'active'
+  | 'assigned'
+  | 'progress'
+  | 'errored'
+  | 'completed'
+  | 'cancelled';
+
+export interface Account {
+  id?: string;
+  clientSID?: number;
+  address?: string;
+  addressSID?: number;
+  name?: string;
+  username?: string;
+}
+
+export interface RawJob {
+  id: string;
+  SID: string;
+  imgID?: string;
+  worker: Account;
+  createTime: number;
+  startTime: number | null;
+  updateTime: number;
+  endTime: number;
+  status: WorkerJobStatus;
+  reason: WorkerJobReason;
+  performedSteps: number;
+  triggeredNSFWFilter: boolean;
+  seedUsed: number;
+  costActual: CostActual;
+  network: SupernetType;
+  txId?: string;
+}
+
+export interface CostActual {
+  costInRenderSec: string;
+  costInUSD: string;
+  costInToken: string;
+  calculatedStepCount?: number;
+}
+
+export type WorkerJobReason =
+  | 'artistCanceled'
+  | 'artistDisconnected'
+  | 'genfailure'
+  | 'imgUploadFailure'
+  | 'jobCompleted'
+  | 'jobTimedOut'
+  | 'workerDisconnected'
+  | 'workerReconnected';
+
+export type WorkerJobStatus =
+  | 'created'
+  | 'queued'
+  | 'assigned'
+  | 'initiatingModel'
+  | 'jobStarted'
+  | 'jobProgress'
+  | 'jobCompleted'
+  | 'jobError';
+
+export interface CostEstimate {
+  rate: Rate;
+  quote: Quote;
+}
+
+export interface Quote {
+  model: QuoteModel;
+  job: CostActual;
+  project: CostActual;
+}
+
+export interface QuoteModel {
+  weight: string;
+  secPerStep: string;
+  secPerPreview: string;
+  secForCN: string;
+}
+
+export interface Rate {
+  costPerBaseHQRenderInUSD: string;
+  tokenMarkePriceUSD: string;
+  costPerRenderSecUSD: string;
+  costPerRenderSecToken: string;
+  network: SupernetType;
+  networkCostMultiplier: string;
+}
+
+export interface ProjectModel {
+  id: string;
+  SID: number;
+  name: string;
+}

package/src/Projects/types/events.ts

@@ -28,10 +28,12 @@ export interface JobEventBase {
 
 export interface JobInitiating extends JobEventBase {
   type: 'initiating';
+  workerName: string;
 }
 
 export interface JobStarted extends JobEventBase {
   type: 'started';
+  workerName: string;
 }
 
 export interface JobProgress extends JobEventBase {

package/src/Projects/types/index.ts

@@ -68,6 +68,10 @@ export interface ProjectParams {
    * Guidance scale. For most Stable Diffusion models, optimal value is 7.5
    */
   guidance: number;
+  /**
+   * Override current network type. Default value can be read from `client.account.currentAccount.network`
+   */
+  network?: SupernetType;
   /**
    * Disable NSFW filter for Project. Default is false, meaning NSFW filter is enabled.
    * If image triggers NSFW filter, it will not be available for download.

package/src/lib/DataEntity.ts

@@ -11,6 +11,8 @@ export interface EntityEvents {
 abstract class DataEntity<D, E extends EntityEvents = EntityEvents> extends TypedEventEmitter<E> {
   protected data: D;
 
+  protected lastUpdated: Date = new Date();
+
   constructor(data: D) {
     super();
     this.data = data;
@@ -24,6 +26,7 @@ abstract class DataEntity<D, E extends EntityEvents = EntityEvents> extends Type
     //@ts-ignore
     const changedKeys = Object.keys(delta).filter((key) => this.data[key] !== delta[key]);
     this.data = { ...this.data, ...delta };
+    this.lastUpdated = new Date();
     this.emit('updated', changedKeys);
   }
 

package/src/lib/base64.ts

@@ -1,9 +1,13 @@
-import isNodejs from './isNodejs';
-
 export function base64Encode(str: string): string {
-  return isNodejs ? Buffer.from(str).toString('base64') : btoa(str);
+  const encoder = new TextEncoder();
+  const uint8Array = encoder.encode(str);
+  const binaryString = String.fromCharCode(...uint8Array);
+  return btoa(binaryString);
 }
 
 export function base64Decode(str: string): string {
-  return isNodejs ? Buffer.from(str, 'base64').toString() : atob(str);
+  const binaryString = atob(str);
+  const binaryArray = Uint8Array.from(binaryString, (char) => char.charCodeAt(0));
+  const decoder = new TextDecoder();
+  return decoder.decode(binaryArray);
 }

package/src/types/ErrorData.ts

@@ -1,5 +1,6 @@
 interface ErrorData {
   code: number;
+  originalCode?: string;
   message: string;
 }
 

package/src/version.ts

@@ -1 +1 @@
-export const LIB_VERSION = "0.3.3";
+export const LIB_VERSION = "0.4.0-aplha.10";