zenstack 0.1.41 → 1.0.0

package/samples/todo/types/next-auth.d.ts

@@ -0,0 +1,14 @@
+import { Session } from 'next-auth';
+import { JWT } from 'next-auth/jwt';
+
+/** Example on how to extend the built-in session types */
+declare module 'next-auth' {
+    interface Session {
+        user: { id: string; name: string; email: string; image?: string };
+    }
+}
+
+/** Example on how to extend the built-in types for JWT */
+declare module 'next-auth/jwt' {
+    interface JWT {}
+}

package/samples/todo/types/next.d.ts

@@ -0,0 +1,16 @@
+import type { NextComponentType, NextPageContext } from 'next';
+import type { Session } from 'next-auth';
+import type { Router } from 'next/router';
+
+declare module 'next/app' {
+    type AppProps<P = Record<string, unknown>> = {
+        Component: NextComponentType<NextPageContext, any, P>;
+        router: Router;
+        __N_SSG?: boolean;
+        __N_SSP?: boolean;
+        pageProps: P & {
+            /** Initial session passed in from `getServerSideProps` or `getInitialProps` */
+            session?: Session;
+        };
+    };
+}

package/samples/todo/zenstack/migrations/20221014084317_init/migration.sql

@@ -0,0 +1,153 @@
+-- CreateEnum
+CREATE TYPE "SpaceUserRole" AS ENUM ('USER', 'ADMIN');
+
+-- CreateTable
+CREATE TABLE "Space" (
+    "id" TEXT NOT NULL,
+    "createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updatedAt" TIMESTAMP(3) NOT NULL,
+    "name" TEXT NOT NULL,
+    "slug" TEXT NOT NULL,
+    "zenstack_guard" BOOLEAN NOT NULL DEFAULT true,
+
+    CONSTRAINT "Space_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateTable
+CREATE TABLE "SpaceUser" (
+    "id" TEXT NOT NULL,
+    "createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updatedAt" TIMESTAMP(3) NOT NULL,
+    "spaceId" TEXT NOT NULL,
+    "userId" TEXT NOT NULL,
+    "role" "SpaceUserRole" NOT NULL,
+    "zenstack_guard" BOOLEAN NOT NULL DEFAULT true,
+
+    CONSTRAINT "SpaceUser_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateTable
+CREATE TABLE "User" (
+    "id" TEXT NOT NULL,
+    "createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updatedAt" TIMESTAMP(3) NOT NULL,
+    "email" TEXT NOT NULL,
+    "emailVerified" TIMESTAMP(3),
+    "password" TEXT,
+    "name" TEXT,
+    "image" TEXT,
+    "zenstack_guard" BOOLEAN NOT NULL DEFAULT true,
+
+    CONSTRAINT "User_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateTable
+CREATE TABLE "List" (
+    "id" TEXT NOT NULL,
+    "createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updatedAt" TIMESTAMP(3) NOT NULL,
+    "spaceId" TEXT NOT NULL,
+    "ownerId" TEXT NOT NULL,
+    "title" TEXT NOT NULL,
+    "private" BOOLEAN NOT NULL DEFAULT false,
+    "zenstack_guard" BOOLEAN NOT NULL DEFAULT true,
+
+    CONSTRAINT "List_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateTable
+CREATE TABLE "Todo" (
+    "id" TEXT NOT NULL,
+    "createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updatedAt" TIMESTAMP(3) NOT NULL,
+    "ownerId" TEXT NOT NULL,
+    "listId" TEXT NOT NULL,
+    "title" TEXT NOT NULL,
+    "completedAt" TIMESTAMP(3),
+    "zenstack_guard" BOOLEAN NOT NULL DEFAULT true,
+
+    CONSTRAINT "Todo_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateTable
+CREATE TABLE "Account" (
+    "id" TEXT NOT NULL,
+    "userId" TEXT NOT NULL,
+    "type" TEXT NOT NULL,
+    "provider" TEXT NOT NULL,
+    "providerAccountId" TEXT NOT NULL,
+    "refresh_token" TEXT,
+    "access_token" TEXT,
+    "expires_at" INTEGER,
+    "token_type" TEXT,
+    "scope" TEXT,
+    "id_token" TEXT,
+    "session_state" TEXT,
+    "zenstack_guard" BOOLEAN NOT NULL DEFAULT true,
+
+    CONSTRAINT "Account_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateTable
+CREATE TABLE "Session" (
+    "id" TEXT NOT NULL,
+    "sessionToken" TEXT NOT NULL,
+    "userId" TEXT NOT NULL,
+    "expires" TIMESTAMP(3) NOT NULL,
+    "zenstack_guard" BOOLEAN NOT NULL DEFAULT true,
+
+    CONSTRAINT "Session_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateTable
+CREATE TABLE "VerificationToken" (
+    "identifier" TEXT NOT NULL,
+    "token" TEXT NOT NULL,
+    "expires" TIMESTAMP(3) NOT NULL,
+    "zenstack_guard" BOOLEAN NOT NULL DEFAULT true
+);
+
+-- CreateIndex
+CREATE UNIQUE INDEX "Space_slug_key" ON "Space"("slug");
+
+-- CreateIndex
+CREATE UNIQUE INDEX "SpaceUser_userId_spaceId_key" ON "SpaceUser"("userId", "spaceId");
+
+-- CreateIndex
+CREATE UNIQUE INDEX "User_email_key" ON "User"("email");
+
+-- CreateIndex
+CREATE UNIQUE INDEX "Account_provider_providerAccountId_key" ON "Account"("provider", "providerAccountId");
+
+-- CreateIndex
+CREATE UNIQUE INDEX "Session_sessionToken_key" ON "Session"("sessionToken");
+
+-- CreateIndex
+CREATE UNIQUE INDEX "VerificationToken_token_key" ON "VerificationToken"("token");
+
+-- CreateIndex
+CREATE UNIQUE INDEX "VerificationToken_identifier_token_key" ON "VerificationToken"("identifier", "token");
+
+-- AddForeignKey
+ALTER TABLE "SpaceUser" ADD CONSTRAINT "SpaceUser_spaceId_fkey" FOREIGN KEY ("spaceId") REFERENCES "Space"("id") ON DELETE CASCADE ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "SpaceUser" ADD CONSTRAINT "SpaceUser_userId_fkey" FOREIGN KEY ("userId") REFERENCES "User"("id") ON DELETE CASCADE ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "List" ADD CONSTRAINT "List_spaceId_fkey" FOREIGN KEY ("spaceId") REFERENCES "Space"("id") ON DELETE CASCADE ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "List" ADD CONSTRAINT "List_ownerId_fkey" FOREIGN KEY ("ownerId") REFERENCES "User"("id") ON DELETE CASCADE ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "Todo" ADD CONSTRAINT "Todo_ownerId_fkey" FOREIGN KEY ("ownerId") REFERENCES "User"("id") ON DELETE CASCADE ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "Todo" ADD CONSTRAINT "Todo_listId_fkey" FOREIGN KEY ("listId") REFERENCES "List"("id") ON DELETE CASCADE ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "Account" ADD CONSTRAINT "Account_userId_fkey" FOREIGN KEY ("userId") REFERENCES "User"("id") ON DELETE CASCADE ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "Session" ADD CONSTRAINT "Session_userId_fkey" FOREIGN KEY ("userId") REFERENCES "User"("id") ON DELETE CASCADE ON UPDATE CASCADE;

package/samples/todo/zenstack/migrations/20221020094651_upate_cli/migration.sql

@@ -0,0 +1,23 @@
+-- AlterTable
+ALTER TABLE "Account" ADD COLUMN     "zenstack_transaction" TEXT;
+
+-- AlterTable
+ALTER TABLE "List" ADD COLUMN     "zenstack_transaction" TEXT;
+
+-- AlterTable
+ALTER TABLE "Session" ADD COLUMN     "zenstack_transaction" TEXT;
+
+-- AlterTable
+ALTER TABLE "Space" ADD COLUMN     "zenstack_transaction" TEXT;
+
+-- AlterTable
+ALTER TABLE "SpaceUser" ADD COLUMN     "zenstack_transaction" TEXT;
+
+-- AlterTable
+ALTER TABLE "Todo" ADD COLUMN     "zenstack_transaction" TEXT;
+
+-- AlterTable
+ALTER TABLE "User" ADD COLUMN     "zenstack_transaction" TEXT;
+
+-- AlterTable
+ALTER TABLE "VerificationToken" ADD COLUMN     "zenstack_transaction" TEXT;

package/samples/todo/zenstack/migrations/migration_lock.toml

@@ -0,0 +1,3 @@
+# Please do not edit this file manually
+# It should be added in your version-control system (i.e. Git)
+provider = "postgresql"

package/samples/todo/zenstack/schema.prisma

@@ -0,0 +1,126 @@
+datasource db {
+    provider="postgresql"
+    url=env("DATABASE_URL")
+}
+
+generator client {
+    provider = "prisma-client-js"
+    output = "../node_modules/.zenstack/.prisma"
+    previewFeatures = ["fieldReference", "interactiveTransactions"]
+}
+
+enum SpaceUserRole {
+    USER
+    ADMIN
+}
+
+model Space {
+    id String @id() @default(uuid())
+    createdAt DateTime @default(now())
+    updatedAt DateTime @updatedAt()
+    name String
+    slug String @unique()
+    members SpaceUser[]
+    lists List[]
+    zenstack_guard Boolean @default(true)
+    zenstack_transaction String?
+}
+
+model SpaceUser {
+    id String @id() @default(uuid())
+    createdAt DateTime @default(now())
+    updatedAt DateTime @updatedAt()
+    space Space @relation(fields: [spaceId], references: [id], onDelete: Cascade)
+    spaceId String
+    user User @relation(fields: [userId], references: [id], onDelete: Cascade)
+    userId String
+    role SpaceUserRole
+    zenstack_guard Boolean @default(true)
+    zenstack_transaction String?
+    @@unique([userId, spaceId])
+}
+
+model User {
+    id String @id() @default(uuid())
+    createdAt DateTime @default(now())
+    updatedAt DateTime @updatedAt()
+    email String @unique()
+    emailVerified DateTime?
+    password String?
+    name String?
+    spaces SpaceUser[]
+    image String?
+    lists List[]
+    todos Todo[]
+    accounts Account[]
+    sessions Session[]
+    zenstack_guard Boolean @default(true)
+    zenstack_transaction String?
+}
+
+model List {
+    id String @id() @default(uuid())
+    createdAt DateTime @default(now())
+    updatedAt DateTime @updatedAt()
+    space Space @relation(fields: [spaceId], references: [id], onDelete: Cascade)
+    spaceId String
+    owner User @relation(fields: [ownerId], references: [id], onDelete: Cascade)
+    ownerId String
+    title String
+    private Boolean @default(false)
+    todos Todo[]
+    zenstack_guard Boolean @default(true)
+    zenstack_transaction String?
+}
+
+model Todo {
+    id String @id() @default(uuid())
+    createdAt DateTime @default(now())
+    updatedAt DateTime @updatedAt()
+    owner User @relation(fields: [ownerId], references: [id], onDelete: Cascade)
+    ownerId String
+    list List @relation(fields: [listId], references: [id], onDelete: Cascade)
+    listId String
+    title String
+    completedAt DateTime?
+    zenstack_guard Boolean @default(true)
+    zenstack_transaction String?
+}
+
+model Account {
+    id String @id() @default(uuid())
+    userId String
+    type String
+    provider String
+    providerAccountId String
+    refresh_token String?
+    access_token String?
+    expires_at Int?
+    token_type String?
+    scope String?
+    id_token String?
+    session_state String?
+    user User @relation(fields: [userId], references: [id], onDelete: Cascade)
+    zenstack_guard Boolean @default(true)
+    zenstack_transaction String?
+    @@unique([provider, providerAccountId])
+}
+
+model Session {
+    id String @id() @default(uuid())
+    sessionToken String @unique()
+    userId String
+    expires DateTime
+    user User @relation(fields: [userId], references: [id], onDelete: Cascade)
+    zenstack_guard Boolean @default(true)
+    zenstack_transaction String?
+}
+
+model VerificationToken {
+    identifier String
+    token String @unique()
+    expires DateTime
+    zenstack_guard Boolean @default(true)
+    zenstack_transaction String?
+    @@unique([identifier, token])
+}

package/samples/todo/zenstack/schema.zmodel

@@ -0,0 +1,161 @@
+/*
+* Sample model for a collaborative Todo app
+*/
+
+datasource db {
+    provider = 'postgresql'
+    url = env('DATABASE_URL')
+}
+
+enum SpaceUserRole {
+    USER
+    ADMIN
+}
+
+model Space {
+    id String @id @default(uuid())
+    createdAt DateTime @default(now())
+    updatedAt DateTime @updatedAt
+    name String @length(1, 100)
+    slug String @unique @length(1, 20)
+    members SpaceUser[]
+    lists List[]
+
+    // require login
+    @@deny('all', auth() == null)
+
+    // everyone can create a space
+    @@allow('create', true)
+
+    // any user in the space can read the space
+    @@allow('read', members?[user == auth()])
+
+    // space admin can update and delete
+    @@allow('update,delete', members?[user == auth() && role == ADMIN])
+}
+
+model SpaceUser {
+    id String @id @default(uuid())
+    createdAt DateTime @default(now())
+    updatedAt DateTime @updatedAt
+    space Space @relation(fields:[spaceId], references: [id], onDelete: Cascade)
+    spaceId String
+    user User @relation(fields: [userId], references: [id], onDelete: Cascade)
+    userId String
+    role SpaceUserRole
+    
+    @@unique([userId, spaceId])
+
+    // require login
+    @@deny('all', auth() == null)
+
+    // space admin can create/update/delete
+    @@allow('create,update,delete', space.members?[user == auth() && role == ADMIN])
+
+    // user can read entries for spaces which he's a member of
+    @@allow('read', space.members?[user == auth()])
+}
+
+model User {
+    id String @id @default(uuid())
+    createdAt DateTime @default(now())
+    updatedAt DateTime @updatedAt
+    email String @unique @email
+    emailVerified DateTime?
+    password String?
+    name String? @length(1, 100)
+    spaces SpaceUser[]
+    image String? @url
+    lists List[]
+    todos Todo[]
+
+    // next-auth
+    accounts      Account[]
+    sessions      Session[]
+
+    // can be created by anyone, even not logged in
+    @@allow('create', true)
+
+    // can be read by current user or users sharing any space
+    @@allow('read', auth() == this || spaces?[space.members?[user == auth()]])
+
+    // can only be updated and deleted by himeself
+    @@allow('update,delete', auth() == this) 
+}
+
+model List {
+    id String @id @default(uuid())
+    createdAt DateTime @default(now())
+    updatedAt DateTime @updatedAt
+    space Space @relation(fields: [spaceId], references: [id], onDelete: Cascade)
+    spaceId String
+    owner User @relation(fields: [ownerId], references: [id], onDelete: Cascade)
+    ownerId String
+    title String @length(1, 20)
+    private Boolean @default(false)
+    todos Todo[]
+
+    // require login
+    @@deny('all', auth() == null)
+
+    // can be read by owner or space members (only if not private) 
+    @@allow('read', owner == auth() || (space.members?[user == auth()] && !private))
+
+    // can be created/updated/deleted by owner
+    @@allow('create,update,delete', owner == auth() && space.members?[user == auth()]) 
+}
+
+model Todo {
+    id String @id @default(uuid())
+    createdAt DateTime @default(now())
+    updatedAt DateTime @updatedAt
+    owner User @relation(fields: [ownerId], references: [id], onDelete: Cascade)
+    ownerId String
+    list List @relation(fields: [listId], references: [id], onDelete: Cascade)
+    listId String
+    title String
+    completedAt DateTime?
+
+    // require login
+    @@deny('all', auth() == null)
+
+    // owner has full access, also space members have full access (if the parent List is not private)
+    @@allow('all', list.owner == auth())
+    @@allow('all', list.space.members?[user == auth()] && !list.private)
+}
+
+// Models used by next-auth
+
+model Account {
+    id                String  @id @default(uuid())
+    userId            String
+    type              String
+    provider          String
+    providerAccountId String
+    refresh_token     String?
+    access_token      String?
+    expires_at        Int?
+    token_type        String?
+    scope             String?
+    id_token          String?
+    session_state     String?
+    user              User  @relation(fields: [userId], references: [id], onDelete: Cascade)
+
+    @@unique([provider, providerAccountId])
+}
+
+model Session {
+    id           String   @id @default(uuid())
+    sessionToken String   @unique
+    userId       String
+    expires      DateTime
+    user         User     @relation(fields: [userId], references: [id], onDelete: Cascade)
+}
+
+model VerificationToken {
+    identifier String
+    token      String   @unique
+    expires    DateTime
+
+    @@unique([identifier, token])
+}

package/tests/integration/jest.config.ts

@@ -0,0 +1,16 @@
+/*
+ * For a detailed explanation regarding each configuration property and type check, visit:
+ * https://jestjs.io/docs/configuration
+ */
+export default {
+    // Automatically clear mock calls, instances, contexts and results before every test
+    clearMocks: true,
+
+    // A map from regular expressions to paths to transformers
+    transform: { '^.+\\.tsx?$': 'ts-jest' },
+
+    testTimeout: 30000,
+
+    // explicitly specify moduel paths so that resolution from local dependencies work
+    modulePaths: ['<rootDir>/tests/test-run/node_modules'],
+};