Pondiverse - Reference

This page lists all of the functions that are available to use from the pondiverse script.

For guides, go to the learn page.
For an example tool, look at the basic tool page.

addPondiverseButton(getCreation, { store? })

Add the pondiverse button to your tool.

import { addPondiverseButton } from "https://www.pondiverse.com/pondiverse.js";

addPondiverseButton(() => {
  return {
    title: "My example creation",
    type: "example",
    data: "example data",
    image: canvas?.toDataURL("image/png"),
  };
});

• getCreation - A function that returns your tool’s creation. All properties are optional.
  • title - The title of the creation. Used to prefill the pondiverse dialog.
  • type - A string identifying what type of creation this is. This can be anything.
  • data - A string containing the data for the creation. This can be anything.
  • image - A string containing a base64 encoded image. This can be anything.
• store - The store to publish the creation to. Defaults to the todepondiverse.

openPondiverseDialog(getCreation, { store? })

Programmatically open the pondiverse dialog.

import { openPondiverseDialog } from "https://www.pondiverse.com/pondiverse.js";

openPondiverseDialog(() => {
  return {
    title: "My example creation",
    type: "example",
    data: "example data",
    image: canvas?.toDataURL("image/png"),
  };
});

• getCreation - A function that returns your tool’s creation. All properties are optional.
  • title - The title of the creation. Used to prefill the pondiverse dialog.
  • type - A string identifying what type of creation this is. This can be anything.
  • data - A string containing the data for the creation. This can be anything.
  • image - A string containing a base64 encoded image. This can be anything.
• store - The store to publish the creation to. Defaults to the todepondiverse.

fetchPondiverseCreations({ store? })

Fetch all creations from an store.

import { fetchPondiverseCreations } from "https://www.pondiverse.com/pondiverse.js";

const creations = await fetchPondiverseCreations();

• store - The store to fetch creations from. Defaults to the todepondiverse.

fetchPondiverseCreation(creation, { store? })

Fetch a single creation.

import { fetchPondiverseCreation } from "https://www.pondiverse.com/pondiverse.js";

const creation = await fetchPondiverseCreation(123);

You can also pass in a creation url instead of an ID. This means you can use IDs and URLs interchangeably in your code.

import { fetchPondiverseCreation } from "https://www.pondiverse.com/pondiverse.js";
const creation = await fetchPondiverseCreation(
  "https://pondiverse.val.run/get-creation?id=123"
);

• creation - The ID or the URL of a creation.
• store - The store to fetch the creation from. Defaults to the todepondiverse.

deletePondiverseCreation(creation, { password?, store? })

Delete a creation.

import { deletePondiverseCreation } from "https://www.pondiverse.com/pondiverse.js";

await deletePondiverseCreation(123, {
  password: "password",
});

• creation - The ID of the creation to delete.
• password - The admin password of the store. This is required on some stores.
• store - The store to delete the creation from. Defaults to the todepondiverse.

getPondiverseCreationImage(creation, { store? })

Get the image URL of a creation. This will eventually be deprecated, when the URL of a creation’s image will be returned within fetchPondiverseCreation and fetchPondiverseCreations.

import { getPondiverseCreationImage } from "https://www.pondiverse.com/pondiverse.js";

const creation = await fetchPondiverseCreation(123);
const imageUrl = getPondiverseCreationImage(creation);

• creation - The ID of the creation to get the image for.
• store - The store to get the image from. Defaults to the todepondiverse.

Store

Most functions have an optional store option. This determines the store to use when publishing and fetching creations. If not specified, it defaults to the todepondiverse.

The store option is an object with the following properties. All are optional.

• name - The name of the store. Used in user interfaces.
• home - The URL of the home page of the store (if one exists).
• addCreation - The endpoint used to add new creations. It sends a POST request to this, with its body containing the creation’s info.
• getCreation - The endpoint used to get an individual creation. It sends a GET request to this, appending the ID of the creation to the URL.
• getCreationsImage - The endpoint used to get the image of a creation. It sends a GET request to this, appending the ID of the creation to the URL.
• getCreations - The endpoint used to get all creations. It sends a GET request to this.
• deleteCreation - The endpoint used to delete a creation. It sends a POST request to this, with its body containing the ID of the creation to delete and a password.