wombo-dream-api

Version:

Unofficial API for Wombo Dream

91 lines (80 loc) • 17.8 kB

HTML

<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>wombo-dream-api</title><meta name="description" content="Documentation for wombo-dream-api"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">wombo-dream-api</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility">All<ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1>wombo-dream-api</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><div class="tsd-panel tsd-typography"> <a href="#wombo-dream-api---" id="wombo-dream-api---" style="color: inherit; text-decoration: none;"> <h1>wombo-dream-api <a href="https://github.com/leopoldhub/wombo-dream-api/blob/master/LICENSE"><img src="https://img.shields.io/github/license/leopoldhub/wombo-dream-api.svg" alt="License"></a> <a href="https://www.npmjs.com/package/wombo-dream-api"><img src="https://img.shields.io/npm/v/wombo-dream-api.svg" alt="NPM version"></a> <a href="https://www.npmjs.com/package/wombo-dream-api"><img src="https://img.shields.io/npm/dm/wombo-dream-api.svg" alt="NPM downloads"></a></h1> </a> Unofficial API for <a href="https://app.wombo.art">Wombo Dream</a> ❤ Feel free to contribute to the project ❤ <a href="#upcomming-features" id="upcomming-features" style="color: inherit; text-decoration: none;"> <h2>Upcomming features</h2> </a> <ul> <li>NFT minting</li> <li>change of password/username/email/profile picture</li> <li>ability to browse other users' profiles</li> </ul> <a href="#changelog" id="changelog" style="color: inherit; text-decoration: none;"> <h2>Changelog</h2> </a> <blockquote> <a href="#016" id="016" style="color: inherit; text-decoration: none;"> <h3>0.1.6</h3> </a> <ul> <li>Refactoring</li> <li>Documentation updated</li> <li>API testing</li> </ul> </blockquote> <blockquote> <a href="#015" id="015" style="color: inherit; text-decoration: none;"> <h3>0.1.5</h3> </a> <ul> <li>Can now fetch tasks shop url</li> <li>Can now save, fetch, fetch all and delete tasks in the gallery</li> </ul> </blockquote> <blockquote> <a href="#014-fix" id="014-fix" style="color: inherit; text-decoration: none;"> <h3>0.1.4-fix</h3> </a> <ul> <li>Throw error when task generation fails</li> <li>uploaded images MUST be jpg/jpeg</li> </ul> </blockquote> <blockquote> <a href="#014" id="014" style="color: inherit; text-decoration: none;"> <h3>0.1.4</h3> </a> <ul> <li>Using typedoc to generate <a href="https://leopoldhub.github.io/wombo-dream-api/">Documentation</a></li> <li>Updating <a href="https://leopoldhub.github.io/wombo-dream-api/">Documentation</a></li> </ul> </blockquote> <a href="#installation" id="installation" style="color: inherit; text-decoration: none;"> <h2>Installation</h2> </a> <a href="#nodejs" id="nodejs" style="color: inherit; text-decoration: none;"> <h3>node.js</h3> </a> <pre><code>npm install wombo-dream-api </code></pre> <blockquote> Please read the <a href="https://leopoldhub.github.io/wombo-dream-api/">Documentation</a> to learn more about the api. </blockquote> <a href="#example" id="example" style="color: inherit; text-decoration: none;"> <h2>Example</h2> </a> <pre><code class="language-javascript">const { buildDefaultInstance } = require('wombo-dream-api'); const fs = require('fs'); (async () => { try { const credentials = { email: 'mysuperemail@gmail.com', password: 'mypassword', }; // signin is automatically done when you interract with the api if you pass credentials const wombo = buildDefaultInstance(credentials); // if you want to sign up as new user: // await wombo.authentifier.signUp(credentials); // fetch all styles const styles = await wombo.fetchStyles(); console.log(styles.map((style) => `[${style.id}] ${style.name}`)); // upload image [ONLY JPEG SUPPORTED] const uploadedImage = await wombo.uploadImage( fs.readFileSync('./image.jpeg') ); // generate picture from image const generatedTask = await wombo.generatePicture( 'mountain', styles[0].id, (taskInProgress) => { console.log( `[${taskInProgress.id}]: ${taskInProgress.state} | step: ${taskInProgress.photo_url_list.length}` ); }, { mediastore_id: uploadedImage.id, weight: 'HIGH' } ); console.log( `[${generatedTask.id}]: ${generatedTask.state} | final url: ${generatedTask.result?.final}` ); // to interract with the gallery, YOU NEED TO HAVE A USERNAME! // if you just created the account and it doesn't have a username, set it with: // await wombo.setUsername('myusername'); // save an image in the gallery const savedTask = await wombo.saveTaskToGallery( generatedTask.id, 'my wonderful creation', true, true ); console.log('image saved!'); // obtain gallery tasks const galleryTasks = await wombo.fetchGalleryTasks(); console.log(galleryTasks); } catch (error) { console.error(error); } })(); </code></pre> <blockquote> More examples can be found in the <a href="https://leopoldhub.github.io/wombo-dream-api/">Documentation</a> </blockquote> <a href="#license" id="license" style="color: inherit; text-decoration: none;"> <h2>License</h2> </a> <a href="LICENSE">MIT</a> </div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="modules/_internal_.html"><internal></a></li><li class=" tsd-kind-namespace"><a href="modules/GoogleAuthentifier.html">GoogleAuthentifier</a></li><li class=" tsd-kind-namespace"><a href="modules/Types.html">Types</a></li><li class=" tsd-kind-namespace"><a href="modules/WomboDream.html">WomboDream</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-variable"><a href="modules.html#DEFAULT_AUTHENTIFICATION_KEY" class="tsd-kind-icon">DEFAULT_AUTHENTIFICATION_KEY</a></li><li class="tsd-kind-variable"><a href="modules.html#DEFAULT_GALLERY_API_SUFFIX" class="tsd-kind-icon">DEFAULT_GALLERY_API_SUFFIX</a></li><li class="tsd-kind-variable"><a href="modules.html#DEFAULT_ORIGIN_URL" class="tsd-kind-icon">DEFAULT_ORIGIN_URL</a></li><li class="tsd-kind-variable"><a href="modules.html#DEFAULT_SHOP_API_SUFFIX" class="tsd-kind-icon">DEFAULT_SHOP_API_SUFFIX</a></li><li class="tsd-kind-variable"><a href="modules.html#DEFAULT_STYLE_API_SUFFIX" class="tsd-kind-icon">DEFAULT_STYLE_API_SUFFIX</a></li><li class="tsd-kind-variable"><a href="modules.html#DEFAULT_TASK_API_SUFFIX" class="tsd-kind-icon">DEFAULT_TASK_API_SUFFIX</a></li><li class="tsd-kind-variable"><a href="modules.html#DEFAULT_TASK_API_URL" class="tsd-kind-icon">DEFAULT_TASK_API_URL</a></li><li class="tsd-kind-variable"><a href="modules.html#DEFAULT_UPLOAD_URL" class="tsd-kind-icon">DEFAULT_UPLOAD_URL</a></li><li class="tsd-kind-variable"><a href="modules.html#DEFAULT_USER_API_SUFFIX" class="tsd-kind-icon">DEFAULT_USER_API_SUFFIX</a></li><li class="tsd-kind-function"><a href="modules.html#buildDefaultInstance" class="tsd-kind-icon">buildDefaultInstance</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Settings</h2>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></footer><div class="container tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>