Descargar zenstack - Descargar el código fuente de zenstack

zenstack

Código Fuente de IA

v2.10.2

Descargar

Que es

ZenStack es un kit de herramientas Node.js/TypeScript que simplifica el desarrollo del backend de una aplicación web. Mejora el prisma ORM con una capa de autorización flexible y API/ganchos de tipo auto generado, desbloqueando todo su potencial para el desarrollo de la pila completa.

¡Nuestro objetivo es permitirle ahorrar tiempo escribiendo el código de horario y centrarse en construir características reales!

Cómo funciona

Leer la documentación completa en? Zenstack.dev. Únase a Discord para comentarios y preguntas.

Zenstack extiende incrementalmente el poder de Prisma con las siguientes cuatro capas:

1. Zmodel - un lenguaje extendido de esquema de prisma

Zenstack presenta un lenguaje de modelado de datos llamado "ZModel", un superconjunto de lenguaje de esquema de Prisma. Extendió el esquema de prisma con atributos y funciones personalizados y, en base a eso, implementó una capa de control de acceso flexible en torno al prisma.

 // base.zmodel
abstract model Base {
    id String @ id
    author User @ relation ( fields : [ authorId ] , references : [ id ] )
    authorId String

    // ? allow full CRUD by author
    @@ allow ( 'all' , author == auth ( ) )
}

 // schema.zmodel
import "base"
model Post extends Base {
    title String
    published Boolean @ default ( false )

    // ? allow logged-in users to read published posts
    @@ allow ( 'read' , auth ( ) != null && published )
}

La CLI zenstack transpila el ZModel en un esquema PRISMA estándar, que puede usar con los flujos de trabajo de Prisma regulares.

2. Mejoras de tiempo de ejecución al cliente Prisma

En tiempo de ejecución, los proxies transparentes se crean en torno a los clientes de Prisma para interceptar consultas y mutaciones para hacer cumplir las políticas de acceso.

 import { enhance } from '@zenstackhq/runtime' ;

// a regular Prisma client
const prisma = new PrismaClient ( ) ;

async function getPosts ( userId : string ) {
    // create an enhanced Prisma client that has access control enabled
    const enhanced = enhance ( prisma , { user : userId } ) ;

    // only posts that're visible to the user will be returned
    return enhanced . post . findMany ( ) ;
}

3. API automáticas RESTful a través de adaptadores del servidor

Los paquetes de adaptador del servidor lo ayudan a envolver un cliente Prisma habilitado para controlar acceso a las API de backend crud que se pueden llamar de forma segura desde el interfaz. Aquí hay un ejemplo para Next.js:

 // pages/api/model/[...path].ts

import { requestHandler } from '@zenstackhq/next' ;
import { enhance } from '@zenstackhq/runtime' ;
import { getSessionUser } from '@lib/auth' ;
import { prisma } from '@lib/db' ;

// Mount Prisma-style APIs: "/api/model/post/findMany", "/api/model/post/create", etc.
// Can be configured to provide standard RESTful APIs (using JSON:API) instead.
export default requestHandler ( {
    getPrisma : ( req , res ) => enhance ( prisma , { user : getSessionUser ( req , res ) } ) ,
} ) ;

4. Bibliotecas de clientes generadas (ganchos) para el acceso a los datos

Los complementos pueden generar bibliotecas de clientes de tipo fuerte que hablan con las API antes mencionadas. Aquí hay un ejemplo para React:

 // components/MyPosts.tsx

import { useFindManyPost } from '@lib/hooks' ;

const MyPosts = ( ) => {
    // list all posts that're visible to the current user, together with their authors
    const { data : posts } = useFindManyPost ( {
        include : { author : true } ,
        orderBy : { createdAt : 'desc' } ,
    } ) ;

    return (
        < ul >
            { posts ?. map ( ( post ) => (
                < li key = { post . id } >
                    { post . title } by { post . author . name }
                </ li >
            ) ) }
        </ ul >
    ) ;
} ;

Arquitectura

El siguiente diagrama ofrece una descripción de arquitectura de alto nivel de Zenstack.

Campo de golf

Hogar
Documentación
Chat comunitario
Gorjeo
Blog

Características

Control de acceso y reglas de validación de datos dentro de su esquema de prisma
Especificaciones, servicios y bibliotecas de clientes de OpenAPI (RESTFUL)
Seguridad de tipo de extremo a extremo
Extensible: atributos personalizados, funciones y un sistema de complementos
Un núcleo agnóstico marco con adaptadores específicos de marco
Rendimiento sin compromisos

Complementos

Generador de esquema de prisma
Generador de esquema Zod
Generador de ganchos de consultas SWR y TanStack
Generador de especificaciones de OpenAPI
generador de enrutador TRPC
? Solicitud de un complemento

Adaptadores de marco

Next.js
Nux
Seltekit
Rápido
Expressjs
Nidos
Honor
? Solicitud de un adaptador

Extensiones de esquema de prisma

Atributos y funciones personalizados
Esquema de múltiples archivos y herencia de modelo
Relaciones polimórficas
Fuerte JSON Fuerte Fuerte
? Solicitud de una extensión

Ejemplos

Muestras de esquema

El repositorio de la muestra incluye los siguientes patrones:

LCA
RBAC
Abacero
Múltiple tenencia

Puede usar esta publicación de blog como introducción.

Aplicación de TODO de múltiples inquilinos

Echa un vistazo a la aplicación TODO de múltiples inquilinos para obtener un ejemplo en ejecución. Puede encontrar diferentes implementaciones a continuación:

Next.js + nextAuth + consulta de TanStack
Next.js + NextAuth + SWR
Next.js + NextAuth + TRPC
Nuxt + consulta de Tanstack
Sveltekit + consulta de Tanstack
Redwoodjs

Aplicación de blog

Next.js + APP Route + Consulta de TanStack
Next.js + ruta de páginas + swr
Next.js + App Route + TRPC
Nuxt + consulta de Tanstack
Seltekit
Remezclar
API de backend de Nestjs
API de backend expresa
Integración del empleado

Comunidad

¡Únase a nuestro servidor Discord para chat y actualizaciones!

Que contribuye

Si te gusta Zenstack, ¡únete a nosotros para que sea una herramienta mejor! Utilice la guía de contribución para obtener detalles sobre cómo comenzar, y no dude en unirse a Discord para compartir sus pensamientos. Las documentos residen en un repositorio separado: Zenstack-Docs.

Considere también patrocinar nuestro trabajo para acelerar el desarrollo. Su contribución se utilizará al 100% como recompensa de la recompensa para alentar a los miembros de la comunidad a ayudar a arreglar errores, agregar características y mejorar la documentación.