@mesadev/sdk
v0.47.3
Published
Official Mesa TypeScript SDK
Keywords
Readme
@mesadev/sdk
Official Mesa TypeScript SDK.
This is the primary TypeScript SDK for Mesa. It includes ergonomic REST resources with default org inference.
Node.js runtime is required.
Install
bun add @mesadev/sdkUsage
import { Mesa } from '@mesadev/sdk';
const mesa = new Mesa({
privateKey: process.env.MESA_PRIVATE_KEY,
});
// The organization comes from the key, so there is nothing to pass.
const repo = await mesa.repos.create({ name: 'my-repo' });
// Somewhere you trust less, use a short-lived token instead of the key.
const scoped = new Mesa({ auth: { accessToken } });
await scoped.repos.list();
console.log(repo.name);This package exposes org-inferred REST resources under mesa.*.
Configuration
Mesa accepts:
privateKey?: string(falls back toMESA_PRIVATE_KEYin Node)auth?: { privateKey } | { accessToken }apiUrl?: string(defaults tohttps://api.mesa.dev/v1)fetch?: typeof fetchuserAgent?: stringwebhookSecret?: string(used bymesa.webhooks.receive(...))
Pass exactly one of privateKey or auth. When neither is present, the SDK reads MESA_PRIVATE_KEY in Node. Private keys and access tokens already name the organization they belong to, so the client picks it up from the credential.
The TypeScript SDK does not accept API keys as client credentials and does not read MESA_API_KEY. API keys remain supported by the Mesa CLI and direct backend interfaces.
Scoped access tokens
Mint a token in your trusted process and hand only that token to the sandbox or job that needs it:
const { token } = await mesa.tokens.create({
authors: [{ name: 'Mesa Bot', email: '[email protected]' }],
scopes: ['read', 'write'],
repos: ['acme/agent-workspace'],
ttl_seconds: 60 * 60, // 1 hour
});A token signed by a private key lasts 15 minutes by default and can be given up to 4 hours. A client built from an access token cannot mint another token.
Webhook Handlers
Register typed handlers with mesa.webhooks.on(...) and pass the incoming
request to mesa.webhooks.receive(...). receive verifies the signature,
parses the payload, and dispatches any registered handlers.
import { Hono } from 'hono';
import { Mesa } from '@mesadev/sdk';
const mesa = new Mesa({
privateKey: process.env.MESA_PRIVATE_KEY,
webhookSecret: process.env.MESA_WEBHOOK_SECRET,
});
mesa.webhooks.on('push', (event) => {
console.log('push:', event.data.updates[0]?.ref);
});
const app = new Hono();
app.post('/webhooks/mesa', async (c) => {
await mesa.webhooks.receive(c.req.raw);
return c.text('ok');
});Package Relationship
@mesadev/sdkis the ergonomic, main SDK.@mesadev/restis the generated REST package used under the hood.
Low-Level REST Access
Use @mesadev/rest directly, or call the API with your own HTTP client, when you need low-level REST access beyond the resource namespaces.
Migration Note
If you previously used the older generated @mesadev/sdk package:
- use
apiUrlinstead ofserverURL - use the organization encoded in the private key or access token
- use resource namespaces (
mesa.repos,mesa.changes, etc.); install@mesadev/restdirectly when you need generated REST operations
