@zenstackhq/server 3.5.0 → 3.5.2

package/dist/api.js

@@ -353,6 +353,9 @@ var RestApiSpecGenerator = class {
   get queryOptions() {
     return this.handlerOptions?.queryOptions;
   }
+  get nestedRoutes() {
+    return this.handlerOptions.nestedRoutes ?? false;
+  }
   generateSpec(options) {
     this.specOptions = options;
     return {
@@ -408,7 +411,13 @@ var RestApiSpecGenerator = class {
         if (!relModelDef) continue;
         const relIdFields = this.getIdFields(relModelDef);
         if (relIdFields.length === 0) continue;
-        paths[`/${modelPath}/{id}/${fieldName}`] = this.buildFetchRelatedPath(modelName, fieldName, fieldDef, tag);
+        paths[`/${modelPath}/{id}/${fieldName}`] = this.buildRelatedPath(modelName, fieldName, fieldDef, tag);
+        if (this.nestedRoutes && fieldDef.array) {
+          const nestedSinglePath = this.buildNestedSinglePath(modelName, fieldName, fieldDef, relModelDef, tag);
+          if (Object.keys(nestedSinglePath).length > 0) {
+            paths[`/${modelPath}/{id}/${fieldName}/{childId}`] = nestedSinglePath;
+          }
+        }
         paths[`/${modelPath}/{id}/relationships/${fieldName}`] = this.buildRelationshipPath(modelDef, fieldName, fieldDef, tag);
       }
     }
@@ -606,8 +615,9 @@ var RestApiSpecGenerator = class {
     }
     return result;
   }
-  buildFetchRelatedPath(modelName, fieldName, fieldDef, tag) {
+  buildRelatedPath(modelName, fieldName, fieldDef, tag) {
     const isCollection = !!fieldDef.array;
+    const relModelDef = this.schema.models[fieldDef.type];
     const params = [
       {
         $ref: "#/components/parameters/id"
@@ -616,8 +626,7 @@ var RestApiSpecGenerator = class {
         $ref: "#/components/parameters/include"
       }
     ];
-    if (isCollection && this.schema.models[fieldDef.type]) {
-      const relModelDef = this.schema.models[fieldDef.type];
+    if (isCollection && relModelDef) {
       params.push({
         $ref: "#/components/parameters/sort"
       }, {
@@ -626,7 +635,7 @@ var RestApiSpecGenerator = class {
         $ref: "#/components/parameters/pageLimit"
       }, ...this.buildFilterParams(fieldDef.type, relModelDef));
     }
-    return {
+    const pathItem = {
       get: {
         tags: [
           tag
@@ -651,6 +660,201 @@ var RestApiSpecGenerator = class {
         }
       }
     };
+    if (this.nestedRoutes && relModelDef) {
+      const mayDeny = this.mayDenyAccess(relModelDef, isCollection ? "create" : "update");
+      if (isCollection && isOperationIncluded(fieldDef.type, "create", this.queryOptions)) {
+        pathItem["post"] = {
+          tags: [
+            tag
+          ],
+          summary: `Create a nested ${fieldDef.type} under ${modelName}`,
+          operationId: `create${modelName}_${fieldName}`,
+          parameters: [
+            {
+              $ref: "#/components/parameters/id"
+            }
+          ],
+          requestBody: {
+            required: true,
+            content: {
+              "application/vnd.api+json": {
+                schema: {
+                  $ref: `#/components/schemas/${fieldDef.type}CreateRequest`
+                }
+              }
+            }
+          },
+          responses: {
+            "201": {
+              description: `Created ${fieldDef.type} resource`,
+              content: {
+                "application/vnd.api+json": {
+                  schema: {
+                    $ref: `#/components/schemas/${fieldDef.type}Response`
+                  }
+                }
+              }
+            },
+            "400": ERROR_400,
+            ...mayDeny && {
+              "403": ERROR_403
+            },
+            "422": ERROR_422
+          }
+        };
+      } else if (!isCollection && isOperationIncluded(fieldDef.type, "update", this.queryOptions)) {
+        pathItem["patch"] = {
+          tags: [
+            tag
+          ],
+          summary: `Update nested ${fieldDef.type} under ${modelName}`,
+          operationId: `update${modelName}_${fieldName}`,
+          parameters: [
+            {
+              $ref: "#/components/parameters/id"
+            }
+          ],
+          requestBody: {
+            required: true,
+            content: {
+              "application/vnd.api+json": {
+                schema: {
+                  $ref: `#/components/schemas/${fieldDef.type}UpdateRequest`
+                }
+              }
+            }
+          },
+          responses: {
+            "200": {
+              description: `Updated ${fieldDef.type} resource`,
+              content: {
+                "application/vnd.api+json": {
+                  schema: {
+                    $ref: `#/components/schemas/${fieldDef.type}Response`
+                  }
+                }
+              }
+            },
+            "400": ERROR_400,
+            ...mayDeny && {
+              "403": ERROR_403
+            },
+            "404": ERROR_404,
+            "422": ERROR_422
+          }
+        };
+      }
+    }
+    return pathItem;
+  }
+  buildNestedSinglePath(modelName, fieldName, fieldDef, relModelDef, tag) {
+    const childIdParam = {
+      name: "childId",
+      in: "path",
+      required: true,
+      schema: {
+        type: "string"
+      }
+    };
+    const idParam = {
+      $ref: "#/components/parameters/id"
+    };
+    const mayDenyUpdate = this.mayDenyAccess(relModelDef, "update");
+    const mayDenyDelete = this.mayDenyAccess(relModelDef, "delete");
+    const result = {};
+    if (isOperationIncluded(fieldDef.type, "findUnique", this.queryOptions)) {
+      result["get"] = {
+        tags: [
+          tag
+        ],
+        summary: `Get a nested ${fieldDef.type} by ID under ${modelName}`,
+        operationId: `get${modelName}_${fieldName}_single`,
+        parameters: [
+          idParam,
+          childIdParam,
+          {
+            $ref: "#/components/parameters/include"
+          }
+        ],
+        responses: {
+          "200": {
+            description: `${fieldDef.type} resource`,
+            content: {
+              "application/vnd.api+json": {
+                schema: {
+                  $ref: `#/components/schemas/${fieldDef.type}Response`
+                }
+              }
+            }
+          },
+          "404": ERROR_404
+        }
+      };
+    }
+    if (isOperationIncluded(fieldDef.type, "update", this.queryOptions)) {
+      result["patch"] = {
+        tags: [
+          tag
+        ],
+        summary: `Update a nested ${fieldDef.type} by ID under ${modelName}`,
+        operationId: `update${modelName}_${fieldName}_single`,
+        parameters: [
+          idParam,
+          childIdParam
+        ],
+        requestBody: {
+          required: true,
+          content: {
+            "application/vnd.api+json": {
+              schema: {
+                $ref: `#/components/schemas/${fieldDef.type}UpdateRequest`
+              }
+            }
+          }
+        },
+        responses: {
+          "200": {
+            description: `Updated ${fieldDef.type} resource`,
+            content: {
+              "application/vnd.api+json": {
+                schema: {
+                  $ref: `#/components/schemas/${fieldDef.type}Response`
+                }
+              }
+            }
+          },
+          "400": ERROR_400,
+          ...mayDenyUpdate && {
+            "403": ERROR_403
+          },
+          "404": ERROR_404,
+          "422": ERROR_422
+        }
+      };
+    }
+    if (isOperationIncluded(fieldDef.type, "delete", this.queryOptions)) {
+      result["delete"] = {
+        tags: [
+          tag
+        ],
+        summary: `Delete a nested ${fieldDef.type} by ID under ${modelName}`,
+        operationId: `delete${modelName}_${fieldName}_single`,
+        parameters: [
+          idParam,
+          childIdParam
+        ],
+        responses: {
+          "200": {
+            description: "Deleted successfully"
+          },
+          ...mayDenyDelete && {
+            "403": ERROR_403
+          },
+          "404": ERROR_404
+        }
+      };
+    }
+    return result;
   }
   buildRelationshipPath(modelDef, fieldName, fieldDef, tag) {
     const modelName = modelDef.name;