npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@blockadelabs/sdk

v1.1.7

Published

BlockadeLabs SDK

Downloads

421

Readme

BlockadeLabs SDK

BlockadeLabs SDK for TypeScript/JavaScript

Envs Supported

  • Node.js
  • Modern browsers

How to Install

$ yarn add @blockadelabs/sdk

# or

$ npm i @blockadelabs/sdk

Basic Usage

import { BlockadeLabsSdk } from '@blockadelabs/sdk';

const sdk = new BlockadeLabsSdk({
  api_key: YOUR_API_KEY, // REQUIRED
});

Methods Doc

getSkyboxStyles

import { BlockadeLabsSdk } from '@blockadelabs/sdk';

const sdk = new BlockadeLabsSdk({
  api_key: YOUR_API_KEY,
});

const styles = await sdk.getSkyboxStyles();

generateSkybox

import { BlockadeLabsSdk } from '@blockadelabs/sdk';

const sdk = new BlockadeLabsSdk({
  api_key: YOUR_API_KEY,
});

const generation = await sdk.generateSkybox({
  prompt: 'PROMPT_GOES_HERE', // Required
  skybox_style_id: 2, // Required
  webhook_url: 'YOUR_WEBHOOK_URL', // Optional
});

Remix Skybox

import { BlockadeLabsSdk } from '@blockadelabs/sdk';

const sdk = new BlockadeLabsSdk({
  api_key: YOUR_API_KEY,
});

const generation = await sdk.generateSkybox({
  prompt: 'PROMPT_GOES_HERE', // Required
  skybox_style_id: 2, // Required
  remix_id: 1, // OR remix_obfuscated_id
  webhook_url: 'YOUR_WEBHOOK_URL', // Optional
});

getImagineById

import { BlockadeLabsSdk } from '@blockadelabs/sdk';

const sdk = new BlockadeLabsSdk({
  api_key: YOUR_API_KEY,
});

const imagine = await sdk.generateImagine({
  generator: 'stable',
  generator_data: {
    prompt: 'PROMPT_GOES_HERE',
  },
});

const imagineResult = await sdk.getImagineById({
  id: imagine.id, // REQUIRED
});

getImagineByObfuscatedId

import { BlockadeLabsSdk } from '@blockadelabs/sdk';

const sdk = new BlockadeLabsSdk({
  api_key: YOUR_API_KEY,
});

const imagine = await sdk.generateImagine({
  generator: 'stable',
  generator_data: {
    prompt: 'PROMPT_GOES_HERE',
  },
});

const imagineResult = await sdk.getImagineByObfuscatedId({
  obfuscated_id: imagine.obfuscated_id, // REQUIRED
});

getImagineHistory

import { BlockadeLabsSdk } from '@blockadelabs/sdk';

const sdk = new BlockadeLabsSdk({
  api_key: YOUR_API_KEY,
});

const imagineHistory = await sdk.getImagineHistory();

const imagineHistoryWithFilters = await sdk.getImagineHistory({
  status: 'STATUS', // OPTIONAL
  limit: 10, // OPTIONAL
  offset: 0, // OPTIONAL
  order: 'ASC', // OPTIONAL
  imagine_id: 1, // OPTIONAL
  query: 'PROMPT', // OPTIONAL
  generator: 'GENERATOR', // OPTIONAL
});

cancelImagine

import { BlockadeLabsSdk } from '@blockadelabs/sdk';

const sdk = new BlockadeLabsSdk({
  api_key: YOUR_API_KEY,
});

const generateImagine = await sdk.generateImagine({
  generator: 'stable',
  generator_data: { prompt: 'PROMPT_GOES_HERE' },
});

await sdk.cancelImagine({
  id: generateImagine.id, // REQUIRED
});

cancelAllPendingImagines

import { BlockadeLabsSdk } from '@blockadelabs/sdk';

const sdk = new BlockadeLabsSdk({
  api_key: YOUR_API_KEY,
});

await sdk.cancelAllPendingImagines();

deleteImagine

import { BlockadeLabsSdk } from '@blockadelabs/sdk';

const sdk = new BlockadeLabsSdk({
  api_key: YOUR_API_KEY,
});

await sdk.deleteImagine({
  id: IMAGINE_ID_GOES_HERE, // REQUIRED
});