JavaScript SDK reference

Install: npm install @canvasmesh/sdk-js. Works in Node.js, browsers, and edge runtimes (Cloudflare Workers, Deno). Ships ESM and CJS.

CanvasClient

import { CanvasClient } from '@canvasmesh/sdk-js';

const client = new CanvasClient({ apiKey, endpoint? });

Constructor options

Option	Type	Required	Default
apiKey	string	yes	—
endpoint	string	no	https://api.canvasmesh.app

Methods

create

client.create(options: CreateCanvasOptions): Promise<CanvasMesh & { view_url: string }>

Option	Type	Required
title	string	yes
ext	string (e.g. 'md')	yes
content	string | Blob | ArrayBuffer	yes
render	RenderType	no
visibility	'private' | 'public'	no

update

client.update(canvasId: string, options: UpdateCanvasOptions): Promise<CanvasMesh>

All options optional. Only pass what you want to change.

Option	Type
title	string
content	string | Blob | ArrayBuffer
visibility	CanvasVisibility
render	RenderType

get

client.get(canvasId: string): Promise<CanvasMesh>

list

client.list(options?: ListCanvasOptions): Promise<{ canvases: CanvasMesh[] }>

Option	Type	Default
visibility	CanvasVisibility	—
limit	number	20 (max 100)
offset	number	0

delete

client.delete(canvasId: string): Promise<void>

share

client.share(canvasId: string, options?: ShareOptions): Promise<CanvasShare & { url: string }>

Option	Type	Example
expiresIn	string	'7d', '24h', '30m'

getContent

client.getContent(canvasId: string): Promise<string>

Fetches the raw file content as a string. For binary files use fetch(canvas.content_url) with appropriate parsing.

Types

type RenderType =
  | 'none' | 'html' | 'markdown' | 'react'
  | 'svg' | 'json' | 'text' | 'image' | 'notebook';

type CanvasVisibility = 'private' | 'public';

interface CanvasMesh {
  canvas_id: string;
  owner_user_id: string;
  title: string;
  ext: string;
  render: RenderType;
  visibility: CanvasVisibility;
  version: number;
  created_at: string;
  updated_at: string;
  expires_at: string | null;
}

interface CanvasShare {
  token: string;
  expires_at: string | null;
  view_count: number;
  created_at: string;
}

interface ListCanvasOptions {
  visibility?: CanvasVisibility;
  limit?: number;
  offset?: number;
}

Errors

All methods throw on non-2xx responses. The thrown Error has a status property (HTTP status code) and body property (parsed JSON or text).

try {
  await client.get('cv_invalid');
} catch (err) {
  if (err.status === 404) {
    // not found
  }
}