Trusted server-side SDK for EdgeBase
Database admin, user management, SQL, analytics, push, storage, and function calls from secure environments
Node.js · Edge runtimes · Server actions · Background jobs · Trusted workers
Database Admin SDK · Admin Users · Push Admin SDK · Analytics Admin SDK
--- `@edge-base/admin` is the trusted server-side SDK for EdgeBase. Use it when you need: - Service Key authenticated access - server-side database operations that bypass access rules - admin user management - raw SQL - push and analytics from secure environments - server-to-server function calls If code runs in a browser, use [`@edge-base/web`](https://www.npmjs.com/package/@edge-base/web) instead. If code runs on the server but should act as the current signed-in user through cookies, use [`@edge-base/ssr`](https://www.npmjs.com/package/@edge-base/ssr). EdgeBase is the open-source edge-native BaaS that runs on Edge, Docker, and Node.js. This package is one part of the wider EdgeBase platform. For the full platform, CLI, Admin Dashboard, server runtime, docs, and all public SDKs, see the main repository: [edge-base/edgebase](https://github.com/edge-base/edgebase). > Beta: the package is already usable, but some APIs may still evolve before general availability. ## Documentation Map - [Database Admin SDK](https://edgebase.fun/docs/database/admin-sdk) Server-side database access with a Service Key - [Admin Users](https://edgebase.fun/docs/authentication/admin-users) Create, update, list, revoke, and manage users - [Push Admin SDK](https://edgebase.fun/docs/push/admin-sdk) Send push notifications from secure environments - [Analytics Admin SDK](https://edgebase.fun/docs/analytics/admin-sdk) Query request analytics and track server-side events - [Admin SDK Reference](https://edgebase.fun/docs/admin-sdk/reference) Public admin SDK surface by category ## For AI Coding Assistants This package ships with an `llms.txt` file for AI-assisted server SDK usage. You can find it: - after install: `node_modules/@edge-base/admin/llms.txt` - in the repository: [llms.txt](https://github.com/edge-base/edgebase/blob/main/packages/sdk/js/packages/admin/llms.txt) Use it when you want an agent to: - keep Service Key logic on the server - choose between `web`, `ssr`, and `admin` - use the correct `db(namespace, id?)` and `sql(...)` signatures - avoid shipping privileged SDK code to the browser ## Installation ```bash npm install @edge-base/admin ``` ## Quick Start ```ts import { createAdminClient } from '@edge-base/admin'; const admin = createAdminClient(process.env.EDGEBASE_URL!, { serviceKey: process.env.EDGEBASE_SERVICE_KEY, }); const { items: posts } = await admin .db('app') .table('posts') .orderBy('createdAt', 'desc') .limit(20) .getList(); console.log(posts); ``` Inside EdgeBase App Functions, you can also rely on environment detection: ```ts import { createAdminClient } from '@edge-base/admin'; const admin = createAdminClient(); ``` ## Core API Once you create an admin client, these are the main surfaces you will use: - `admin.db(namespace, id?)` Server-side database access - `admin.auth` Admin user management - `admin.sql(...)` Raw SQL execution - `admin.storage` Server-side storage access - `admin.functions` Call app functions from trusted code - `admin.push` Send push notifications - `admin.analytics` Query analytics and track server-side events - `admin.kv(namespace)`, `admin.d1(database)`, `admin.vector(index)` Access platform resources from trusted code ## Database Access ```ts type Post = { id: string; title: string; status: 'draft' | 'published'; }; const posts = admin.db('app').table