Giters

edenweb1 / dream-api

NodeJS API for Wombo Dream

Home Page:https://cdgco.github.io/dream-api/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Wombo Dream API

Promise based NodeJS API for Wombo Dream.

Installation

Add dream-api to your project:

npm install dream-api

const WomboDream = require('dream-api');

Usage

Generate an image from a text prompt

let image = await WomboDream.generateImage(1, "dog");

or

WomboDream.generateImage(1, "dog").then(image => {
  console.log(image);
});

Generate an image from a text prompt and input image

let buffer = fs.readFileSync('image.jpg');
let image = await WomboDream.generateImage(1, "dog", null, buffer, "LOW");

or

let buffer = fs.readFileSync('image.jpg');
WomboDream.generateImage(1, "dog", null, buffer, "LOW").then(image => {
  console.log(image);
});

Generate an image, save it, and get the URL to purchase a print

let token = await WomboDream.signUp("email@email.com", "password", "username");
let image = await WomboDream.generateImage(1, "dog", token.idToken, null, null, true);
let purchaseURL = await WomboDream.getTaskShopURL(token.idToken, image.id);

or

WomboDream.signUp("email@email.com", "password", "username").then(token => {
  WomboDream.generateImage(1, "dog", token.idToken, null, null, true).then(image => {
    WomboDream.getTaskShopURL(token.idToken, image.id).then(purchaseURL => {
      console.log(purchaseURL);
    });
  });
});

Generate an image, with a callback function

let image = await WomboDream.generateImage(1, "dog", null, null, null, null, null, console.log));

or

WomboDream.generateImage(1, "dog", null, null, null, null, null, console.log).then(image => {
  console.log(image);
});

Refresh token and print user gallery

let token = await WomboDream.signIn("email@email.com", "password");
token = await WomboDream.refreshToken(token.refreshToken);
let gallery = await WomboDream.getGallery(token.idToken));

or

WomboDream.signIn("email@email.com", "password").then(token => {
  WomboDream.refreshToken(token.refreshToken).then(refresh => {
    WomboDream.getGallery(refresh.idToken).then(gallery => {
      console.log(gallery);
    });
  });
});

See examples/await.js and examples/promise.js for much more example code.

Functions

Authentication

signUp([email, password, username])

  • Creates a new user account. Returns token object.
  • email: string (Optional) Email address. Must not already exist.
  • password: string (Optional) Password.
  • username: string (Optional) Username. Must not already exist.

signIn(email, password)

  • Signs in a user account. Returns token object.
  • email: string Email address.
  • password: string Password.

refresh(refreshToken)

  • Refreshes a user's access token. Returns token object.
  • Works for anonymous and named users.
  • refreshToken: string Refresh token.
    • (await WomboDream.signUp()).refreshToken
    • (await WomboDream.signUp('email', 'password', 'username')).refreshToken
    • (await WomboDream.signIn('username', 'password)).refreshToken

Styles

getStyles()

  • Retrieve all available styles. Returns array of style objects.
  • Does not require authentication.

printStyles()

  • Print all available styles to console in a formatted table. Returns nothing.
  • Does not require authentication.

Image Generation

generateImage(style, prompt [, token] [, imageBuffer [, weight]] [, save [, saveSettings]] [, callback] [, interval], [, frequency])

  • Generates an image based on the style, prompt and input image. Returns image object.
  • Set any optional parameter to null in order to skip that function and use a later parameter.
  • style: int Style number (from getStyles()).
  • prompt: string Image prompt. String of up to 100 characters.
  • token: string (Optional) Access token.
    • If token is not provided, anonymous token will be generated. Saving will be disabled if token not provided.
    • (await WomboDream.signUp()).idToken
    • (await WomboDream.signUp('email', 'password', 'username')).idToken
    • (await WomboDream.signIn('username', 'password)).idToken
  • imageBuffer: buffer (Optional) Buffer of jpg / jpeg image to use.
  • weight: string (Optional) Influence of the input image.
    • LOW, MEDIUM or HIGH
    • Defaults to MEDIUM
  • save: boolean (Optional) Whether to save the image to the user's account.
    • token must be provided for a user account. Save will fail if username not set or token is for anonymous account.
    • Defaults to false
  • saveSettings: object (Optional) JSON object with settings for saving the image.
    • { "name": nameValue, "public": publicValue, "visible": visibleValue }
      • nameValue: string Name of the image.
      • publicValue: boolean Whether the image is public.
      • visibleValue: boolean Whether the name is visible on the image.
      • Defaults to { "name": "", "public": false, "visible": true }
  • callback: function (Optional) Callback function for intermediate image generation steps.
    • callback is passed 1 argument, the JSON image object containing the status, task info and intermediate images.
  • interval: int (Optional) Milliseconds to wait between status checks and callback function.
    • Defaults to 1000
  • frequency: int (Optional) Frequency of the intermediate image generation.
    • Defaults to 10

getTaskID(token)

  • Returns the ID for a new image generation session (used internally in generateImage()). Returns task id.
  • token: string Access token.
    • (await WomboDream.signUp()).idToken
    • (await WomboDream.signUp('email', 'password', 'username')).idToken
    • (await WomboDream.signIn('username', 'password)).idToken

createTask(token, taskID, prompt, style [, imageId [, weight]] [, frequency])

  • Creates a new image generation task (used internally in generateImage()). Returns image object.
  • token: string Access token.
    • (await WomboDream.signUp()).idToken
    • (await WomboDream.signUp('email', 'password', 'username')).idToken
    • (await WomboDream.signIn('username', 'password)).idToken
  • taskID: string ID of the task.
    • await WomboDream.getTaskID(token)
  • prompt: string Image prompt. String of up to 100 characters.
  • style: int Style number (from getStyles()).
  • imageId: string (Optional) ID of uploaded image to use.
    • await WomboDream.uploadPhoto(buffer)
  • weight: string (Optional) Influence of the input image.
    • LOW, MEDIUM or HIGH
    • Defaults to MEDIUM
  • frequency: int (Optional) Frequency of the intermediate image generation.
    • Defaults to 10

checkStatus(token, taskID [, interval] [, callback])

  • Check status of image generation task (used internally in generateImage()). Returns image object.
  • If loop is unset or null, will check status once. If set to true, will check status every loop ms until task is complete.
  • token: string Access token.
    • (await WomboDream.signUp()).idToken
    • (await WomboDream.signUp('email', 'password', 'username')).idToken
    • (await WomboDream.signIn('username', 'password)).idToken
  • taskID: string ID of the task.
    • await WomboDream.getTaskID(token)
  • interval: int (Optional) Milliseconds to wait between status checks.
  • callback: function (Optional) Callback function for intermediate image generation steps.

Additional Functions

uploadPhoto(buffer [, token])

  • Uploads a photo for later use and returns upload ID (used internally in generateImage()). Returns upload id.
  • Works for anonymous and named users. If token is not supplied, anonymous token will be used.
  • buffer: buffer Buffer of jpg / jpeg image.
  • token: string (Optional) Access token.
    • (await WomboDream.signUp()).idToken
    • (await WomboDream.signUp('email', 'password', 'username')).idToken
    • (await WomboDream.signIn('username', 'password)).idToken

getUploadURL([token])

  • Returns a URL to upload an image for later use (used internally in uploadPhoto()). Returns upload object.
  • Works for anonymous and named users. If token is not supplied, anonymous token will be used.
  • token: string (Optional) Access token.
    • (await WomboDream.signUp()).idToken
    • (await WomboDream.signUp('email', 'password', 'username')).idToken
    • (await WomboDream.signIn('username', 'password)).idToken

getTaskShopURL(token, taskID)

  • Get URL to purchase print of generated image. Returns URL.
  • token: string Access token.
    • (await WomboDream.signUp()).idToken
    • (await WomboDream.signUp('email', 'password', 'username')).idToken
    • (await WomboDream.signIn('username', 'password)).idToken
  • taskID: string ID of the task.
    • await WomboDream.getTaskID(token)

saveToGallery(token, taskID [, saveSettings])

  • Save image to user account (used internally in generateImage()). Returns gallery item.
  • token: string Access token.
    • (await WomboDream.signUp()).idToken
    • (await WomboDream.signUp('email', 'password', 'username')).idToken
    • (await WomboDream.signIn('username', 'password)).idToken
    • token must be provided for a user account. Save will fail if username not set or token is for anonymous account.
  • taskID: string ID of the task.
    • await WomboDream.getTaskID(token)
  • saveSettings: object (Optional) JSON object with settings for saving the image.
    • { "name": nameValue, "public": publicValue, "visible": visibleValue }
      • nameValue: string Name of the image.
      • publicValue: boolean Whether the image is public.
      • visibleValue: boolean Whether the name is visible on the image.
      • Defaults to { "name": "", "public": false, "visible": true }

getGallery(token)

  • Get list of images saved to a user's account. Returns array of gallery items.
  • token: string Access token.
    • (await WomboDream.signUp()).idToken
    • (await WomboDream.signUp('email', 'password', 'username')).idToken
    • (await WomboDream.signIn('username', 'password)).idToken
    • token must be provided for a non-guest user account.

About

NodeJS API for Wombo Dream

https://cdgco.github.io/dream-api/

License:MIT License