@sogni-ai/sogni-client 3.0.0 → 3.1.0

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+# [3.1.0](https://github.com/Sogni-AI/sogni-client/compare/v3.0.1...v3.1.0) (2025-08-07)
+
+
+### Features
+
+* Expose `premiumCredit` Spark amount in account balance ([57e568c](https://github.com/Sogni-AI/sogni-client/commit/57e568cdff0bb29ce61489dab6280f735f497bb8))
+
+## [3.0.1](https://github.com/Sogni-AI/sogni-client/compare/v3.0.0...v3.0.1) (2025-07-15)
+
+
+### Bug Fixes
+
+* Bring back package-lock.json ([28d21e1](https://github.com/Sogni-AI/sogni-client/commit/28d21e192c15fca5b76254572d6fcbd1e8140b29))
+* Update README.md ([3348834](https://github.com/Sogni-AI/sogni-client/commit/3348834163d438ce99c3dfa9d466649544e9b777))
+
 # [3.0.0](https://github.com/Sogni-AI/sogni-client/compare/v2.0.4...v3.0.0) (2025-07-15)
 
 

package/README.md

@@ -14,27 +14,29 @@ or
 yarn add @sogni-ai/sogni-client
 ```
 ## Core concepts
-In order to use Sogni Supernet you need an active Sogni account (in the form of a username and password) with a positive $tSOGNI balance. 
+In order to use Sogni Supernet, you need an active Sogni account (in the form of a username and password) with a positive SOGNI or Spark token balance. 
 You can create a free account in our [Web App](https://app.sogni.ai) or [Mac App](https://www.sogni.ai/studio) which will give you tokens just for signing up and confirming your email. You can get daily bonus tokens by claiming them (under rewards) each 24-hours.
 
-Your account is tied to a [Base](https://www.base.org/) Wallet that is created during signup. The current network is [Base Sepolia](https://chainlist.org/chain/84532) and will be [Base Mainnet](https://chainlist.org/chain/8453) after mainnet launch.
+Spark tokens can be purchased with a credit card in a Mac or Web app.
+
+Your account is tied to a [Base](https://www.base.org/) Wallet that is created during signup.
 
 ### Supernet Types
 There are 2 worker network types available:
-- `fast` - this network runs on high-end GPUs and is optimized for speed. It is more expensive than `relaxed` network at roughly 1 $tSOGNI token per render.
-- `relaxed` - this network runs on Apple Mac devices and is optimized for cost. It is cheaper than `fast` network at roughly 0.5 $tSOGNI token per render.
+- `fast` - this network runs on high-end GPUs and is optimized for speed. It is more expensive than `relaxed` network.
+- `relaxed` - this network runs on Apple Mac devices and is optimized for cost. It is cheaper than `fast` network.
 
-In both options the more complex your query is (the more steps) the higher the cost in tokens.
+In both options, the more complex your query is (the more steps), the higher the cost in tokens.
 
 ### Inference definitions: Projects and Jobs
 One request for image generation is called a **Project**. Project can generate one or more images. 
 Each image is represented by a **Job**.
 
 When you send a project to Supernet, it will be processed by one or more workers. The resulting images will be encrypted and 
-uploaded to Sogni servers where it will be  stored for 24 hours. After this period images will be auto-deleted.
+uploaded to Sogni servers where it will be stored for 24 hours. After this period images will be auto-deleted.
 
 ## Client initialization
-To initialize client you need to provide `appId`, and account credentials.
+To initialize a client, you need to provide `appId`, and account credentials.
 
 ```javascript
 import { SogniClient } from '@sogni-ai/sogni-client';
@@ -62,7 +64,7 @@ const models = await client.projects.waitForModels();
 
 ## Usage
 After calling `login` method, the client will establish a WebSocket connection to Sogni Supernet. Within a short period of time the
-client will receive current balance and list of available models. After this you can start using the client to generate images.
+client will receive the current balance and list of available models. After this you can start using the client to generate images.
 
 ### Creating project
 ```javascript
@@ -85,9 +87,9 @@ const project = await client.projects.create({
 **Note:** Full project parameter list can be found in [ProjectParams](https://sdk-docs.sogni.ai/interfaces/ProjectParams.html) docs.
 
 ### Getting project status and results
-In general there are 2 ways to work with API:
+In general, there are 2 ways to work with API:
 1. Using promises or `async/await` syntax.
-2. Listening events on `Project` and `Job` class instances.
+2. Listening to events on `Project` and `Job` class instances.
 
 #### Using promises
 ```javascript
@@ -153,12 +155,13 @@ project.on('failed', async (errorData) => {
 ```
 
 ### Project parameters
-Here is full list of project parameters that you can use:
+Here is a full list of project parameters that you can use:
 - `modelId` - ID of the model to use for image generation.
-- `positivePrompt` - text prompt that describes what you want to see in the image. Can be empty string.
-- `negativePrompt` - text prompt that describes what you don't want to see in the image. Can be empty string.
-- `stylePrompt` - text prompt that describes the style of the image. Can be empty string.
+- `positivePrompt` - text prompt that describes what you want to see in the image. Can be an empty string.
+- `negativePrompt` - text prompt that describes what you don't want to see in the image. Can be an empty string.
+- `stylePrompt` - text prompt that describes the style of the image. Can be an empty string.
 - `numberOfImages` - number of images to generate.
+- `tokenType` - select token type to pay for render. Can be either `sogni` or `spark`.
 - `sizePreset` - optionally pass the ID of a size preset to use. If not passed, the default output is a square at 
 either 512x512, 768x768 or 1024x1024 (SDXL and Flux) based on the default resolution of the selected model. 
 See **Detecting available output presets** section below for available presets for your model. The token cost and 
@@ -174,7 +177,7 @@ quality images and more details but varies by model, prompt, guidance, and desir
 models 20-40 steps is ideal with 20 being 2x faster to render than 40. For Flux 4 steps is optimal. Lightning, 
 Turbo and LCM models are designed for quality output in as little as 1 step. ([More info](https://docs.sogni.ai/learn/basics/inference-steps)).
 - `guidance` - guidance scale. For most Stable Diffusion models, optimal value is 7.5 ([More info](https://docs.sogni.ai/learn/basics/guidance-scale)).
-- `network` - network type to use, 'fast' or 'relaxed'. This parameter allow to override default network type for this project.
+- `network` - network type to use, `fast` or `relaxed`. This parameter allows to override default network type for this project.
 - `disableNSFWFilter` - disable NSFW filter for this project. NSFW filter is enabled by default and workers won't upload resulting images if they are detected as NSFW.
 - `seed` - uint32 number to use as seed. If not provided, random seed will be used. If `numberOfImages` is greater than 1, provided seed will be user only for one of them. ([More info](https://docs.sogni.ai/learn/basics/generation-seed)).
 - `numberOfPreviews` - number of preview images to generate. If not provided, no preview images will be generated.
@@ -187,7 +190,7 @@ Turbo and LCM models are designed for quality output in as little as 1 step. ([M
 TypeScript type definitions for project parameters can be found in [ProjectParams](https://sdk-docs.sogni.ai/interfaces/ProjectParams.html) docs.
 
 ### Detecting available output presets
-You can get list of available output presets for a specific network and model using `client.projects.getOutputPresets` method.
+You can get a list of available output presets for a specific network and model using `client.projects.getOutputPresets` method.
 ```javascript
 const presets = await client.projects.getSizePresets('fast', 'flux1-schnell-fp8');
 console.log('Available output presets:', presets);
@@ -283,7 +286,7 @@ Sample response:
 ControlNet is a neural network that controls image generation in Stable Diffusion by adding extra conditions. See more 
 info and usage samples in [ControlNets](https://docs.sogni.ai/learn/basics/controlnet) docs for Sogni Studio.
 
-To use ControlNet in your project you need to provide `controlNet` object with the following properties:
+To use ControlNet in your project, you need to provide `controlNet` object with the following properties:
 - `name` - name of the ControlNet to use. Currently supported:
   - `canny`
   - `depth`

package/dist/Account/CurrentAccount.js

@@ -19,7 +19,8 @@ function getDefaults() {
                 credit: '0',
                 debit: '0',
                 net: '0',
-                settled: '0'
+                settled: '0',
+                premiumCredit: '0'
             }
         },
         walletAddress: undefined,

package/dist/Account/CurrentAccount.js.map

@@ -1 +1 @@
-{"version":3,"file":"CurrentAccount.js","sourceRoot":"","sources":["../../src/Account/CurrentAccount.ts"],"names":[],"mappings":";;;;;AAAA,mEAA2C;AAyB3C,SAAS,WAAW;IAClB,OAAO;QACL,aAAa,EAAE,cAAc;QAC7B,OAAO,EAAE,IAAI;QACb,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,GAAG;gBACX,KAAK,EAAE,GAAG;gBACV,GAAG,EAAE,GAAG;gBACR,OAAO,EAAE,GAAG;aACb;YACD,KAAK,EAAE;gBACL,MAAM,EAAE,GAAG;gBACX,KAAK,EAAE,GAAG;gBACV,GAAG,EAAE,GAAG;gBACR,OAAO,EAAE,GAAG;aACb;SACF;QACD,aAAa,EAAE,SAAS;QACxB,QAAQ,EAAE,SAAS;QACnB,KAAK,EAAE,SAAS;QAChB,YAAY,EAAE,SAAS;KACxB,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,cAAe,SAAQ,oBAAuB;IAClD,YAAY,IAAkB;QAC5B,KAAK,CAAC,IAAI,IAAI,WAAW,EAAE,CAAC,CAAC;IAC/B,CAAC;IAED,MAAM;QACJ,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED,IAAI,cAAc;QAChB,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC;IAClC,CAAC;IAED,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC;IACjC,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;IAC3B,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;IAC3B,CAAC;IAED,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC;IACjC,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;IAC5B,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;IACzB,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC;IAChC,CAAC;CACF;AAED,kBAAe,cAAc,CAAC"}
+{"version":3,"file":"CurrentAccount.js","sourceRoot":"","sources":["../../src/Account/CurrentAccount.ts"],"names":[],"mappings":";;;;;AAAA,mEAA2C;AAyB3C,SAAS,WAAW;IAClB,OAAO;QACL,aAAa,EAAE,cAAc;QAC7B,OAAO,EAAE,IAAI;QACb,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,GAAG;gBACX,KAAK,EAAE,GAAG;gBACV,GAAG,EAAE,GAAG;gBACR,OAAO,EAAE,GAAG;aACb;YACD,KAAK,EAAE;gBACL,MAAM,EAAE,GAAG;gBACX,KAAK,EAAE,GAAG;gBACV,GAAG,EAAE,GAAG;gBACR,OAAO,EAAE,GAAG;gBACZ,aAAa,EAAE,GAAG;aACnB;SACF;QACD,aAAa,EAAE,SAAS;QACxB,QAAQ,EAAE,SAAS;QACnB,KAAK,EAAE,SAAS;QAChB,YAAY,EAAE,SAAS;KACxB,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,cAAe,SAAQ,oBAAuB;IAClD,YAAY,IAAkB;QAC5B,KAAK,CAAC,IAAI,IAAI,WAAW,EAAE,CAAC,CAAC;IAC/B,CAAC;IAED,MAAM;QACJ,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED,IAAI,cAAc;QAChB,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC;IAClC,CAAC;IAED,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC;IACjC,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;IAC3B,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;IAC3B,CAAC;IAED,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC;IACjC,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;IAC5B,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;IACzB,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC;IAChC,CAAC;CACF;AAED,kBAAe,cAAc,CAAC"}

package/dist/Account/types.d.ts

@@ -30,8 +30,17 @@ export interface BalanceData {
      */
     unclaimed?: string;
 }
-export type Balances = Record<TokenType, BalanceData>;
-export type FullBalances = Record<TokenType, Required<BalanceData>>;
+export interface SparkBalanceData extends BalanceData {
+    premiumCredit: string;
+}
+export interface Balances {
+    sogni: BalanceData;
+    spark: SparkBalanceData;
+}
+export interface FullBalances {
+    sogni: Required<BalanceData>;
+    spark: Required<SparkBalanceData>;
+}
 export interface TxHistoryParams {
     status: 'completed';
     address: string;

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "Sogni Supernet Client",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/Account/CurrentAccount.ts

@@ -38,7 +38,8 @@ function getDefaults(): AccountData {
         credit: '0',
         debit: '0',
         net: '0',
-        settled: '0'
+        settled: '0',
+        premiumCredit: '0'
       }
     },
     walletAddress: undefined,

package/src/Account/types.ts

@@ -36,9 +36,19 @@ export interface BalanceData {
   unclaimed?: string;
 }
 
-export type Balances = Record<TokenType, BalanceData>;
+export interface SparkBalanceData extends BalanceData {
+  premiumCredit: string;
+}
+
+export interface Balances {
+  sogni: BalanceData;
+  spark: SparkBalanceData;
+}
 
-export type FullBalances = Record<TokenType, Required<BalanceData>>;
+export interface FullBalances {
+  sogni: Required<BalanceData>;
+  spark: Required<SparkBalanceData>;
+}
 
 export interface TxHistoryParams {
   status: 'completed';