Merge pull request #31 from zenstackhq/dev

merge dev to main (3.0.0-alpha.4)

Author: ymc9

README.md

@@ -100,12 +100,14 @@ For SQLite:
 
 ```bash
 npm install better-sqlite3
+npm install -D @types/better-sqlite3
 ```
 
 For Postgres:
 
 ```bash
-npm install pg
+npm install pg pg-connection-string
+npm install -D @types/pg
 ```
 
 ## Pushing schema to the database
@@ -132,14 +134,32 @@ A `schema.ts` file will be created inside the `zenstack` folder. The file should
 
 ## Creating ZenStack client
 
-Now you can use the compiled TypeScript schema to instantiate a database client:
+Now you can use the compiled TypeScript schema to instantiate a database client.
+
+### SQLite
 
 ```ts
 import { ZenStackClient } from '@zenstackhq/runtime';
 import { schema } from './zenstack/schema';
+import SQLite from 'better-sqlite3';
 
 const client = new ZenStackClient(schema, {
-    dialectConfig: { ... }
+    dialectConfig: { database: new SQLite('./dev.db') },
+});
+```
+
+### Postgres
+
+```ts
+import { ZenStackClient } from '@zenstackhq/runtime';
+import { schema } from './zenstack/schema';
+import { Pool } from 'pg';
+import { parseIntoClientConfig } from 'pg-connection-string';
+
+const client = new ZenStackClient(schema, {
+    dialectConfig: {
+        pool: new Pool(parseIntoClientConfig(process.env.DATABASE_URL)),
+    },
 });
 ```
 
@@ -376,6 +396,8 @@ See [Prisma Migrate](https://www.prisma.io/docs/orm/prisma-migrate) documentatio
 
 # Limitations
 
-1. Only SQLite (better-sqlite3) and Postgres (pg) database providers are supported.
+1. Only SQLite (better-sqlite3) and Postgres (pg) database providers are supported for now.
 1. Prisma client extensions are not supported.
 1. Prisma custom generators are not supported (may add support in the future).
+1. [Filtering on JSON fields](https://www.prisma.io/docs/orm/prisma-client/special-fields-and-types/working-with-json-fields#filter-on-a-json-field-advanced) is not supported yet.
+1. Raw SQL query APIs (`$queryRaw`, `$executeRaw`) are not supported.

TODO.md

@@ -6,7 +6,7 @@
     -   [x] generate
     -   [x] migrate
     -   [x] info
-    -   [ ] init
+    -   [x] init
 -   [ ] ORM
     -   [x] Create
         -   [x] Input validation
@@ -36,6 +36,7 @@
             -   [x] Sorting
             -   [x] Pagination
         -   [x] Distinct
+        -   [ ] JSON filtering
     -   [x] Update
         -   [x] Input validation
         -   [x] Top-level
@@ -65,7 +66,6 @@
         -   [ ] Error system
         -   [x] Custom table name
         -   [x] Custom field name
-        -   [ ] Strict undefined check
         -   [ ] Implement changesets
 -   [ ] Polymorphism
 -   [ ] Validation

package.json

@@ -1,6 +1,6 @@
 {
     "name": "zenstack-v3",
-    "version": "3.0.0-alpha.2",
+    "version": "3.0.0-alpha.4",
     "description": "ZenStack",
     "packageManager": "[email protected]",
     "scripts": {

packages/cli/package.json

@@ -3,7 +3,7 @@
     "publisher": "zenstack",
     "displayName": "ZenStack CLI",
     "description": "FullStack database toolkit with built-in access control and automatic API generation.",
-    "version": "3.0.0-alpha.2",
+    "version": "3.0.0-alpha.4",
     "type": "module",
     "author": {
         "name": "ZenStack Team"

packages/create-zenstack/package.json

@@ -1,6 +1,6 @@
 {
     "name": "create-zenstack",
-    "version": "3.0.0-alpha.2",
+    "version": "3.0.0-alpha.4",
     "description": "Create a new ZenStack project",
     "type": "module",
     "scripts": {

packages/ide/vscode/README.md

@@ -0,0 +1,53 @@
+# ZenStack VS Code Extension
+
+[ZenStack](https://zenstack.dev) is a toolkit that simplifies the development of a web app's backend. It enhances [Prisma ORM](https://prisma.io) with flexible Authorization and auto-generated, type-safe APIs/hooks, simplifying full-stack development.
+
+This VS Code extension provides code editing helpers for authoring ZenStack's schema files (.zmodel files).
+
+## Features
+
+-   Syntax highlighting of `*.zmodel` files
+
+    -   In case the schema file is not recognized automatically, add the following to your settings.json file:
+
+    ```json
+    "files.associations": {
+        "*.zmodel": "zmodel"
+    },
+    ```
+
+-   Auto formatting
+
+    -   To automatically format on save, add the following to your settings.json file:
+
+        ```json
+        "editor.formatOnSave": true
+        ```
+
+    -   To enable formatting in combination with prettier, add the following to your settings.json file:
+        ```json
+        "[zmodel]": {
+        "editor.defaultFormatter": "zenstack.zenstack"
+        },
+        ```
+
+-   Inline error reporting
+-   Go-to definition
+-   Hover documentation
+-   Code section folding
+
+## Links
+
+-   [Home](https://zenstack.dev)
+-   [Documentation](https://zenstack.dev/docs)
+-   [Community chat](https://discord.gg/Ykhr738dUe)
+-   [Twitter](https://twitter.com/zenstackhq)
+-   [Blog](https://dev.to/zenstack)
+
+## Community
+
+Join our [discord server](https://discord.gg/Ykhr738dUe) for chat and updates!
+
+## License
+
+[MIT](https://github.com/zenstackhq/zenstack/blob/main/LICENSE)

packages/ide/vscode/package.json

@@ -1,13 +1,13 @@
 {
     "name": "zenstack",
     "publisher": "zenstack",
-    "version": "3.0.0",
+    "version": "3.0.2",
     "displayName": "ZenStack Language Tools",
     "description": "VSCode extension for ZenStack ZModel language",
     "private": true,
     "repository": {
         "type": "git",
-        "url": "https://github.com/zenstackhq/zenstack-v3"
+        "url": "https://github.com/zenstackhq/zenstack"
     },
     "scripts": {
         "build": "tsc --noEmit && tsup",

packages/language/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@zenstackhq/language",
     "description": "ZenStack ZModel language specification",
-    "version": "3.0.0-alpha.2",
+    "version": "3.0.0-alpha.4",
     "license": "MIT",
     "author": "ZenStack Team",
     "files": [

packages/runtime/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@zenstackhq/runtime",
-    "version": "3.0.0-alpha.2",
+    "version": "3.0.0-alpha.4",
     "description": "ZenStack Runtime",
     "type": "module",
     "scripts": {

packages/runtime/src/client/options.ts

@@ -24,7 +24,7 @@ import type { ToKyselySchema } from './query-builder';
 type DialectConfig<Provider extends DataSourceProvider> =
     Provider['type'] extends 'sqlite'
         ? Optional<SqliteDialectConfig, 'database'>
-        : Provider extends 'postgresql'
+        : Provider['type'] extends 'postgresql'
         ? Optional<PostgresDialectConfig, 'pool'>
         : never;