@sogni-ai/sogni-client 3.0.0-alpha.8 → 3.0.0

package/src/Projects/types/ControlNetParams.ts

@@ -16,7 +16,8 @@ export type ControlNetName =
   | 'segmentation'
   | 'shuffle'
   | 'softedge'
-  | 'tile';
+  | 'tile'
+  | 'instantid';
 
 /**
  * Raw ControlNet parameters passed to the API
@@ -53,8 +54,13 @@ export interface ControlNetParams {
   name: ControlNetName;
   /**
    * ControlNet input image
+   * Supported types:
+   * `File` - file object from input[type=file]
+   * `Buffer` - Node.js buffer object with image data
+   * `Blob` - blob object with image data
+   * `true` - indicates that the image is already uploaded to the server
    */
-  image?: File | Buffer | Blob;
+  image?: File | Buffer | Blob | boolean;
   /**
    * ControlNet strength 0 to 1. 0 full control to prompt, 1 full control to ControlNet
    */

package/src/Projects/types/events.ts

@@ -29,11 +29,17 @@ export interface JobEventBase {
 export interface JobInitiating extends JobEventBase {
   type: 'initiating';
   workerName: string;
+  positivePrompt?: string;
+  negativePrompt?: string;
+  jobIndex?: number;
 }
 
 export interface JobStarted extends JobEventBase {
   type: 'started';
   workerName: string;
+  positivePrompt?: string;
+  negativePrompt?: string;
+  jobIndex?: number;
 }
 
 export interface JobProgress extends JobEventBase {

package/src/Projects/types/index.ts

@@ -1,5 +1,6 @@
 import { SupernetType } from '../../ApiClient/WebSocketClient/types';
 import { ControlNetParams } from './ControlNetParams';
+import { TokenType } from '../../types/token';
 
 export interface SupportedModel {
   id: string;
@@ -102,12 +103,14 @@ export interface ProjectParams {
    */
   numberOfImages: number;
   /**
-   * Generate images based on starting image.
+   * Generate images based on the starting image.
+   * Supported types:
    * `File` - file object from input[type=file]
-   * `Buffer` - buffer object with image data
+   * `Buffer` - Node.js buffer object with image data
    * `Blob` - blob object with image data
+   * `true` - indicates that the image is already uploaded to the server
    */
-  startingImage?: File | Buffer | Blob;
+  startingImage?: File | Buffer | Blob | boolean;
   /**
    * How strong effect of starting image should be. From 0 to 1, default 0.5
    */
@@ -141,6 +144,11 @@ export interface ProjectParams {
    * ControlNet model parameters
    */
   controlNet?: ControlNetParams;
+  /**
+   * Select which tokens to use for the project.
+   * If not specified, the Sogni token will be used.
+   */
+  tokenType?: TokenType;
 }
 
 export type ImageUrlParams = {
@@ -156,6 +164,10 @@ export interface EstimateRequest {
    * Network to use. Can be 'fast' or 'relaxed'
    */
   network: SupernetType;
+  /**
+   * Token type
+   */
+  tokenType?: TokenType;
   /**
    * Model ID
    */
@@ -195,3 +207,5 @@ export interface EstimateRequest {
    */
   height?: number;
 }
+
+export type EnhancementStrength = 'light' | 'medium' | 'heavy';

package/src/Projects/utils.ts

@@ -0,0 +1,12 @@
+import { EnhancementStrength } from './types';
+
+export function getEnhacementStrength(strength: EnhancementStrength): number {
+  switch (strength) {
+    case 'light':
+      return 0.15;
+    case 'heavy':
+      return 0.49;
+    default:
+      return 0.35;
+  }
+}

package/src/Stats/index.ts

@@ -1,10 +1,10 @@
 import ApiGroup from '../ApiGroup';
-import { ApiReponse } from '../ApiClient';
+import { ApiResponse } from '../ApiClient';
 import { LeaderboardItem, LeaderboardParams } from './types';
 
 class StatsApi extends ApiGroup {
   async leaderboard(params: LeaderboardParams) {
-    const res = await this.client.rest.get<ApiReponse<LeaderboardItem[]>>(
+    const res = await this.client.rest.get<ApiResponse<LeaderboardItem[]>>(
       '/v1/leaderboard/',
       params
     );

package/src/index.ts

@@ -1,4 +1,3 @@
-import { AbstractProvider, JsonRpcProvider, getDefaultProvider } from 'ethers';
 // Account API
 import AccountApi from './Account';
 import CurrentAccount from './Account/CurrentAccount';
@@ -18,6 +17,7 @@ import { AvailableModel, ProjectParams, Scheduler, TimeStepSpacing } from './Pro
 import StatsApi from './Stats';
 // Base Types
 import ErrorData from './types/ErrorData';
+import { TokenType } from './types/token';
 
 export type {
   AvailableModel,
@@ -29,7 +29,8 @@ export type {
   ProjectStatus,
   Scheduler,
   SupernetType,
-  TimeStepSpacing
+  TimeStepSpacing,
+  TokenType
 };
 
 export { ApiError, CurrentAccount, Job, Project };
@@ -49,6 +50,13 @@ export interface SogniClientConfig {
    * @internal
    */
   socketEndpoint?: string;
+  /**
+   * Disable WebSocket connection. Useful for testing or when WebSocket is not needed.
+   * Note that many may not work without WebSocket connection.
+   * @experimental
+   * @internal
+   */
+  disableSocket?: boolean;
   /**
    * Which network to use after logging in. Can be 'fast' or 'relaxed'
    */
@@ -62,10 +70,6 @@ export interface SogniClientConfig {
    * @default 'warn'
    **/
   logLevel?: LogLevel;
-  /**
-   * If provided, the client will connect to this JSON-RPC endpoint to interact with the blockchain
-   */
-  jsonRpcUrl?: string;
   /**
    * If true, the client will connect to the testnet. Ignored if jsonRpcUrl is provided
    */
@@ -92,7 +96,7 @@ export class SogniClient {
   }
 
   /**
-   * Instance creation may involve async operations, so we use a static method
+   * Create client instance, with default configuration
    * @param config
    */
   static async createInstance(config: SogniClientConfig): Promise<SogniClient> {
@@ -100,21 +104,21 @@ export class SogniClient {
     const socketEndpoint = config.socketEndpoint || 'wss://socket.sogni.ai';
     const network = config.network || 'fast';
     const logger = config.logger || new DefaultLogger(config.logLevel || 'warn');
-    const isTestnet = config.testnet !== undefined ? config.testnet : true;
+    const isTestnet = config.testnet !== undefined ? config.testnet : false;
 
-    const client = new ApiClient(restEndpoint, socketEndpoint, config.appId, network, logger);
-    let provider: AbstractProvider;
-    if ('jsonRpcUrl' in config) {
-      provider = new JsonRpcProvider(config.jsonRpcUrl);
-    } else {
-      provider = getDefaultProvider(isTestnet ? 84532 : 8453);
-    }
-    const chainId = await provider.getNetwork().then((network) => network.chainId);
+    const client = new ApiClient(
+      restEndpoint,
+      socketEndpoint,
+      config.appId,
+      network,
+      logger,
+      config.disableSocket
+    );
     const eip712 = new EIP712Helper({
-      name: 'Sogni-testnet',
+      name: isTestnet ? 'Sogni-testnet' : 'Sogni AI',
       version: '1',
-      chainId: chainId.toString()
+      chainId: isTestnet ? '84532' : '8453'
     });
-    return new SogniClient({ client, provider, eip712 });
+    return new SogniClient({ client, eip712 });
   }
 }

package/src/lib/utils.ts

@@ -15,3 +15,7 @@ export function decodeRefreshToken(token: string) {
     expiresAt: new Date(data.exp * 1000)
   };
 }
+
+export async function delay(ms: number) {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+}

package/src/types/token.ts

@@ -0,0 +1 @@
+export type TokenType = 'sogni' | 'spark';

package/src/version.ts

@@ -1 +1,2 @@
-export const LIB_VERSION = "1.0.0-alpha.4";
+import { version } from '../package.json';
+export const LIB_VERSION = version;