merge dev to main (v2.17.0) (#2191)

Author: ymc9

package.json

@@ -1,6 +1,6 @@
 {
     "name": "zenstack-monorepo",
-    "version": "2.16.1",
+    "version": "2.17.0",
     "description": "",
     "scripts": {
         "build": "pnpm -r --filter=\"!./packages/ide/*\" build",

packages/ide/jetbrains/build.gradle.kts

@@ -9,7 +9,7 @@ plugins {
 }
 
 group = "dev.zenstack"
-version = "2.16.1"
+version = "2.17.0"
 
 repositories {
     mavenCentral()

packages/ide/jetbrains/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jetbrains",
-  "version": "2.16.1",
+  "version": "2.17.0",
   "displayName": "ZenStack JetBrains IDE Plugin",
   "description": "ZenStack JetBrains IDE plugin",
   "homepage": "https://zenstack.dev",

packages/language/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@zenstackhq/language",
-    "version": "2.16.1",
+    "version": "2.17.0",
     "displayName": "ZenStack modeling language compiler",
     "description": "ZenStack modeling language compiler",
     "homepage": "https://zenstack.dev",

packages/misc/redwood/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@zenstackhq/redwood",
     "displayName": "ZenStack RedwoodJS Integration",
-    "version": "2.16.1",
+    "version": "2.17.0",
     "description": "CLI and runtime for integrating ZenStack with RedwoodJS projects.",
     "repository": {
         "type": "git",

packages/plugins/openapi/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zenstackhq/openapi",
   "displayName": "ZenStack Plugin and Runtime for OpenAPI",
-  "version": "2.16.1",
+  "version": "2.17.0",
   "description": "ZenStack plugin and runtime supporting OpenAPI",
   "main": "index.js",
   "repository": {

packages/plugins/openapi/src/rest-generator.ts

@@ -44,13 +44,16 @@ type Policies = ReturnType<typeof analyzePolicies>;
  */
 export class RESTfulOpenAPIGenerator extends OpenAPIGeneratorBase {
     private warnings: string[] = [];
+    private modelNameMapping: Record<string, string>;
 
     constructor(protected model: Model, protected options: PluginOptions, protected dmmf: DMMF.Document) {
         super(model, options, dmmf);
 
         if (this.options.omitInputDetails !== undefined) {
             throw new PluginError(name, '"omitInputDetails" option is not supported for "rest" flavor');
         }
+
+        this.modelNameMapping = this.getOption('modelNameMapping', {} as Record<string, string>);
     }
 
     generate() {
@@ -126,6 +129,10 @@ export class RESTfulOpenAPIGenerator extends OpenAPIGeneratorBase {
         return result;
     }
 
+    private mapModelName(modelName: string): string {
+        return this.modelNameMapping[modelName] ?? modelName;
+    }
+
     private generatePathsForModel(model: DMMF.Model, zmodel: DataModel): OAPI.PathItemObject | undefined {
         const result: Record<string, OAPI.PathItemObject> = {};
 
@@ -139,9 +146,11 @@ export class RESTfulOpenAPIGenerator extends OpenAPIGeneratorBase {
 
         const resourceMeta = getModelResourceMeta(zmodel);
 
+        const modelName = this.mapModelName(model.name);
+
         // GET /resource
         // POST /resource
-        result[`${prefix}/${lowerCaseFirst(model.name)}`] = {
+        result[`${prefix}/${lowerCaseFirst(modelName)}`] = {
             get: this.makeResourceList(zmodel, policies, resourceMeta),
             post: this.makeResourceCreate(zmodel, policies, resourceMeta),
         };
@@ -150,10 +159,10 @@ export class RESTfulOpenAPIGenerator extends OpenAPIGeneratorBase {
         // PUT /resource/{id}
         // PATCH /resource/{id}
         // DELETE /resource/{id}
-        result[`${prefix}/${lowerCaseFirst(model.name)}/{id}`] = {
+        result[`${prefix}/${lowerCaseFirst(modelName)}/{id}`] = {
             get: this.makeResourceFetch(zmodel, policies, resourceMeta),
-            put: this.makeResourceUpdate(zmodel, policies, `update-${model.name}-put`, resourceMeta),
-            patch: this.makeResourceUpdate(zmodel, policies, `update-${model.name}-patch`, resourceMeta),
+            put: this.makeResourceUpdate(zmodel, policies, `update-${modelName}-put`, resourceMeta),
+            patch: this.makeResourceUpdate(zmodel, policies, `update-${modelName}-patch`, resourceMeta),
             delete: this.makeResourceDelete(zmodel, policies, resourceMeta),
         };
 
@@ -165,14 +174,14 @@ export class RESTfulOpenAPIGenerator extends OpenAPIGeneratorBase {
             }
 
             // GET /resource/{id}/{relationship}
-            const relatedDataPath = `${prefix}/${lowerCaseFirst(model.name)}/{id}/${field.name}`;
+            const relatedDataPath = `${prefix}/${lowerCaseFirst(modelName)}/{id}/${field.name}`;
             let container = result[relatedDataPath];
             if (!container) {
                 container = result[relatedDataPath] = {};
             }
             container.get = this.makeRelatedFetch(zmodel, field, relationDecl, resourceMeta);
 
-            const relationshipPath = `${prefix}/${lowerCaseFirst(model.name)}/{id}/relationships/${field.name}`;
+            const relationshipPath = `${prefix}/${lowerCaseFirst(modelName)}/{id}/relationships/${field.name}`;
             container = result[relationshipPath];
             if (!container) {
                 container = result[relationshipPath] = {};

packages/plugins/openapi/tests/openapi-restful.test.ts

@@ -129,7 +129,7 @@ model Bar {
         }
     });
 
-    it('options', async () => {
+    it('common options', async () => {
         const { model, dmmf, modelFile } = await loadZModelAndDmmf(`
 plugin openapi {
     provider = '${normalizePath(path.resolve(__dirname, '../dist'))}'
@@ -396,6 +396,39 @@ model User {
             expect.arrayContaining(['role', 'company'])
         );
     });
+
+    it('works with mapped model name', async () => {
+        const { model, dmmf, modelFile } = await loadZModelAndDmmf(`
+plugin openapi {
+    provider = '${normalizePath(path.resolve(__dirname, '../dist'))}'
+    title = 'My Awesome API'
+    prefix = '/api'
+    modelNameMapping = {
+        User: 'myUser'
+    }
+}
+
+model User {
+    id String @id
+    posts Post[]
+}
+
+model Post {
+    id String @id
+    author User @relation(fields: [authorId], references: [id])
+    authorId String
+}
+        `);
+
+        const { name: output } = tmp.fileSync({ postfix: '.yaml' });
+        const options = buildOptions(model, modelFile, output);
+        await generate(model, options, dmmf);
+        console.log('OpenAPI specification generated:', output);
+        const api = await OpenAPIParser.validate(output);
+        expect(api.paths?.['/api/myUser']).toBeTruthy();
+        expect(api.paths?.['/api/user']).toBeFalsy();
+        expect(api.paths?.['/api/post']).toBeTruthy();
+    });
 });
 
 function buildOptions(model: Model, modelFile: string, output: string, specVersion = '3.0.0') {

packages/plugins/swr/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@zenstackhq/swr",
     "displayName": "ZenStack plugin for generating SWR hooks",
-    "version": "2.16.1",
+    "version": "2.17.0",
     "description": "ZenStack plugin for generating SWR hooks",
     "main": "index.js",
     "repository": {

packages/plugins/tanstack-query/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@zenstackhq/tanstack-query",
     "displayName": "ZenStack plugin for generating tanstack-query hooks",
-    "version": "2.16.1",
+    "version": "2.17.0",
     "description": "ZenStack plugin for generating tanstack-query hooks",
     "main": "index.js",
     "exports": {