@zenstackhq/server 3.5.0-beta.3 → 3.5.0-beta.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +40 -0
- package/dist/api.cjs +1915 -91
- package/dist/api.cjs.map +1 -1
- package/dist/api.d.cts +83 -5
- package/dist/api.d.ts +83 -5
- package/dist/api.js +1873 -49
- package/dist/api.js.map +1 -1
- package/package.json +10 -7
package/README.md
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# @zenstackhq/server
|
|
2
|
+
|
|
3
|
+
Automatic CRUD API handlers and server adapters for ZenStack. Exposes your ZenStack ORM as RESTful or RPC-style API endpoints with built-in OpenAPI spec generation.
|
|
4
|
+
|
|
5
|
+
## Supported Frameworks
|
|
6
|
+
|
|
7
|
+
- **Express**
|
|
8
|
+
- **Fastify**
|
|
9
|
+
- **Next.js**
|
|
10
|
+
- **Nuxt**
|
|
11
|
+
- **SvelteKit**
|
|
12
|
+
- **Hono**
|
|
13
|
+
- **Elysia**
|
|
14
|
+
- **TanStack Start**
|
|
15
|
+
|
|
16
|
+
## API Styles
|
|
17
|
+
|
|
18
|
+
- **REST** — Resource-oriented endpoints with [JSON:API](https://jsonapi.org/) support
|
|
19
|
+
- **RPC** — Procedure-call style endpoints
|
|
20
|
+
|
|
21
|
+
## Installation
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
npm install @zenstackhq/server
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Usage (Express example)
|
|
28
|
+
|
|
29
|
+
```typescript
|
|
30
|
+
import express from 'express';
|
|
31
|
+
import { ZenStackMiddleware } from '@zenstackhq/server/express';
|
|
32
|
+
import { RPCApiHandler } from '@zenstackhq/server/api';
|
|
33
|
+
|
|
34
|
+
const app = express();
|
|
35
|
+
app.use('/api/model', ZenStackMiddleware({...}));
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
## Learn More
|
|
39
|
+
|
|
40
|
+
- [ZenStack Documentation](https://zenstack.dev/docs)
|