Add Vitest (#2)

* Add vitest

Add vitest for project testing, ensuring stable quality. Modify new initialization method.

* update package version

Author: connectshark

.gitignore

@@ -11,6 +11,7 @@ node_modules
 dist
 dist-ssr
 *.local
+coverage
 
 # Editor directories and files
 .vscode/*

README.md

@@ -27,11 +27,9 @@ npm install prodia-ai
 ## Usage
 ### Initialization
 ```js
-import ProdiaAI from 'prodia-ai'
+import createProdiaAI from 'prodia-ai'
 
-const prodiai = new ProdiaAI({
-  key: 'prodia-key'
-})
+const prodiai = createProdiaAI('prodia-key')
 
 export default prodiai
 ```

main.d.ts

@@ -1,45 +1,52 @@
-declare module 'prodia-ai' {
+/**
+ * ProdiaAI is a class for handling ProdiaAI images.
+ */
+declare class ProdiaAI {
+  private readonly key: string
+
   /**
-   * ProdiaAI is a class for handling ProdiaAI images.
+   * Initializes a ProdiaAI instance.
+   * @param {Object} obj - Initialization parameters object.
+   * @param {String} obj.key - Your API key.
    */
-  export default class ProdiaAI {
-    #API_DOMAIN: string;
-    #API_VERSION: string;
-  
-    /**
-     * Initializes a ProdiaAI instance.
-     * @param {Object} obj - Initialization parameters object.
-     * @param {String} obj.key - Your API key.
-     */
-    constructor({ key }: { key: string });
-  
-    models: string[];
-    
-    /**
-     * Creates an AI image job.
-     * @param {Object} config - Image job configuration.
-     * @param {String} config.prompt - Image prompt.
-     * @param {String} config.negative_prompt - Negative image prompt.
-     * @param {Number} config.steps - Number of image generation steps.
-     * @param {Number} config.cfg_scale - Image generation scale.
-     * @param {String} config.sampler - Image generation sampler.
-     * @param {String} config.model - Image generation model.
-     * @returns {Promise<String>} - Promise with the API response content.
-     */
-    createJob(config: {
-      prompt: string;
-      negative_prompt: string;
-      steps: number;
-      cfg_scale: number;
-      sampler: string;
-      model: string;
-    }): Promise<string>;
-  
-    /**
-     * Retrieves information about a specific job ID.
-     * @param {String} jobId - Job ID.
-     * @returns {Promise<String>} - Promise with the API response content.
-     */
-    getJob(jobId: string): Promise<string>;
-  }
-}
+  constructor(key: string)
+
+  models: string[]
+
+  /**
+   * Creates an AI image job.
+   * @param {Object} config - Image job configuration.
+   * @param {String} config.prompt - Image prompt.
+   * @param {String} config.negative_prompt - Negative image prompt.
+   * @param {Number} config.steps - Number of image generation steps.
+   * @param {Number} config.cfg_scale - Image generation scale.
+   * @param {String} config.sampler - Image generation sampler.
+   * @param {String} config.model - Image generation model.
+   * @returns {Promise<String>} - Promise with the API response content.
+   */
+  createJob(config: {
+    prompt: string
+    negative_prompt: string
+    steps: number
+    cfg_scale: number
+    sampler: string
+    model: string
+  }): Promise<string>
+
+  /**
+   * Retrieves information about a specific job ID.
+   * @param {String} jobId - Job ID.
+   * @returns {Promise<String>} - Promise with the API response content.
+   */
+  getJob(jobId: string): Promise<string>
+}
+
+/**
+ * Creates an instance of ProdiaAI.
+ * @param {string} key - The API key used for authentication.
+ * @returns {ProdiaAI} The ProdiaAI instance.
+ * @throws {Error} If the API key is missing.
+ */
+declare function createProdiaAI(key: string) : ProdiaAI
+
+export default createProdiaAI

main.js

@@ -4,16 +4,7 @@
 class ProdiaAI {
   #API_DOMAIN = 'https://api.prodia.com'
   #API_VERSION = 'v1'
-
-  /**
-   * Initializes a ProdiaAI instance.
-   * @param {Object} obj - Initialization parameters object.
-   * @param {String} obj.key - Your API key.
-   */
-  constructor({ key }) {
-    this.key = key
-  }
-
+  
   models = [
     'analog-diffusion-1.0.ckpt [9ca13f02]',
     'anythingv3_0-pruned.ckpt [2700c435]',
@@ -43,6 +34,15 @@ class ProdiaAI {
     'timeless-1.0.ckpt [7c4971d4]'
   ]
 
+  /**
+   * Initializes a ProdiaAI instance.
+   * @param {Object} obj - Initialization parameters object.
+   * @param {String} obj.key - Your API key.
+   */
+  constructor (key) {
+    this.key = key
+  }
+
   /**
    * Creates an AI image job.
    * @param {Object} config - Image job configuration.
@@ -54,13 +54,15 @@ class ProdiaAI {
    * @param {String} config.model - Image generation model.
    * @returns {Promise<String>} - Promise with the API response content.
    */
-  async createJob(config){
-    if (!config.prompt) {
+  async createJob(config) {
+    if (!config?.prompt && config.prompt === '') {
       throw new Error('Prompt is required!')
     }
-    const model = this.models.includes(config.model)
-    if (!model) {
-      throw new Error('Model not accepted')
+    if (config?.model) {
+      const model = this.models.includes(config.model)
+      if (!model) {
+        throw new Error('Model not accepted')
+      }
     }
     const fetch_response = await fetch(`${this.#API_DOMAIN}/${this.#API_VERSION}/job`, {
       method: 'POST',
@@ -79,7 +81,7 @@ class ProdiaAI {
    * @param {String} jobId - Job ID.
    * @returns {Promise<String>} - Promise with the API response content.
    */
-  async getJob(jobId){
+  async getJob (jobId) {
     if (!jobId) {
       throw new Error('JobID is required!')
     }
@@ -93,4 +95,18 @@ class ProdiaAI {
   }
 }
 
-export default ProdiaAI
+
+/**
+ * Creates an instance of ProdiaAI.
+ * @param {string} key - The API key used for authentication.
+ * @returns {ProdiaAI} The ProdiaAI instance.
+ * @throws {Error} If the API key is missing.
+ */
+const createProdiaAI = (key) => {
+  if (!key) {
+    throw new Error('API Key is required')
+  }
+  return new ProdiaAI(key)
+}
+
+export default createProdiaAI