@zenstackhq/server 3.0.0-beta.18 → 3.0.0-beta.20

package/dist/api.d.cts

@@ -108,7 +108,7 @@ declare class RestApiHandler<Schema extends SchemaDef> implements ApiHandler<Sch
     private buildRelationSelect;
     private makeFilterValue;
     private injectRelationQuery;
-    private handleZenStackError;
+    private handleORMError;
     private makeError;
     private makeUnsupportedModelError;
     private makeUnsupportedRelationshipError;
@@ -139,7 +139,7 @@ declare class RPCApiHandler<Schema extends SchemaDef> implements ApiHandler<Sche
     private isValidModel;
     private makeBadInputErrorResponse;
     private makeGenericErrorResponse;
-    private makeZenStackErrorResponse;
+    private makeORMErrorResponse;
     private processRequestPayload;
     private unmarshalQ;
 }

package/dist/api.d.ts

@@ -108,7 +108,7 @@ declare class RestApiHandler<Schema extends SchemaDef> implements ApiHandler<Sch
     private buildRelationSelect;
     private makeFilterValue;
     private injectRelationQuery;
-    private handleZenStackError;
+    private handleORMError;
     private makeError;
     private makeUnsupportedModelError;
     private makeUnsupportedRelationshipError;
@@ -139,7 +139,7 @@ declare class RPCApiHandler<Schema extends SchemaDef> implements ApiHandler<Sche
     private isValidModel;
     private makeBadInputErrorResponse;
     private makeGenericErrorResponse;
-    private makeZenStackErrorResponse;
+    private makeORMErrorResponse;
     private processRequestPayload;
     private unmarshalQ;
 }

package/dist/api.js

@@ -3,10 +3,11 @@ var __name = (target, value) => __defProp(target, "name", { value, configurable:
 
 // src/api/rest/index.ts
 import { clone, enumerate, lowerCaseFirst, paramCase } from "@zenstackhq/common-helpers";
-import { InputValidationError, NotFoundError, QueryError, RejectedByPolicyError, ZenStackError } from "@zenstackhq/orm";
+import { ORMError, ORMErrorReason } from "@zenstackhq/orm";
 import { Decimal as Decimal2 } from "decimal.js";
 import SuperJSON2 from "superjson";
 import tsjapi from "ts-japi";
+import { match as match2 } from "ts-pattern";
 import UrlPattern from "url-pattern";
 import z from "zod";
 
@@ -292,17 +293,17 @@ var RestApiHandler = class {
     if (!pattern) {
       throw new InvalidValueError(`Unknown route type: ${routeType}`);
     }
-    const match2 = pattern.match(path);
-    if (!match2) {
+    const match4 = pattern.match(path);
+    if (!match4) {
       return;
     }
-    if (match2.type in this.modelNameMapping) {
-      throw new InvalidValueError(`use the mapped model name: ${this.modelNameMapping[match2.type]} and not ${match2.type}`);
+    if (match4.type in this.modelNameMapping) {
+      throw new InvalidValueError(`use the mapped model name: ${this.modelNameMapping[match4.type]} and not ${match4.type}`);
     }
-    if (match2.type in this.reverseModelNameMapping) {
-      match2.type = this.reverseModelNameMapping[match2.type];
+    if (match4.type in this.reverseModelNameMapping) {
+      match4.type = this.reverseModelNameMapping[match4.type];
     }
-    return match2;
+    return match4;
   }
   async handleRequest({ client, method, path, query, requestBody }) {
     method = method.toUpperCase();
@@ -312,21 +313,21 @@ var RestApiHandler = class {
     try {
       switch (method) {
         case "GET": {
-          let match2 = this.matchUrlPattern(path, "single");
-          if (match2) {
-            return await this.processSingleRead(client, match2.type, match2.id, query);
+          let match4 = this.matchUrlPattern(path, "single");
+          if (match4) {
+            return await this.processSingleRead(client, match4.type, match4.id, query);
           }
-          match2 = this.matchUrlPattern(path, "fetchRelationship");
-          if (match2) {
-            return await this.processFetchRelated(client, match2.type, match2.id, match2.relationship, query);
+          match4 = this.matchUrlPattern(path, "fetchRelationship");
+          if (match4) {
+            return await this.processFetchRelated(client, match4.type, match4.id, match4.relationship, query);
           }
-          match2 = this.matchUrlPattern(path, "relationship");
-          if (match2) {
-            return await this.processReadRelationship(client, match2.type, match2.id, match2.relationship, query);
+          match4 = this.matchUrlPattern(path, "relationship");
+          if (match4) {
+            return await this.processReadRelationship(client, match4.type, match4.id, match4.relationship, query);
           }
-          match2 = this.matchUrlPattern(path, "collection");
-          if (match2) {
-            return await this.processCollectionRead(client, match2.type, query);
+          match4 = this.matchUrlPattern(path, "collection");
+          if (match4) {
+            return await this.processCollectionRead(client, match4.type, query);
           }
           return this.makeError("invalidPath");
         }
@@ -334,19 +335,19 @@ var RestApiHandler = class {
           if (!requestBody) {
             return this.makeError("invalidPayload");
           }
-          let match2 = this.matchUrlPattern(path, "collection");
-          if (match2) {
+          let match4 = this.matchUrlPattern(path, "collection");
+          if (match4) {
             const body = requestBody;
             const upsertMeta = this.upsertMetaSchema.safeParse(body);
             if (upsertMeta.success) {
-              return await this.processUpsert(client, match2.type, query, requestBody);
+              return await this.processUpsert(client, match4.type, query, requestBody);
             } else {
-              return await this.processCreate(client, match2.type, query, requestBody);
+              return await this.processCreate(client, match4.type, query, requestBody);
             }
           }
-          match2 = this.matchUrlPattern(path, "relationship");
-          if (match2) {
-            return await this.processRelationshipCRUD(client, "create", match2.type, match2.id, match2.relationship, query, requestBody);
+          match4 = this.matchUrlPattern(path, "relationship");
+          if (match4) {
+            return await this.processRelationshipCRUD(client, "create", match4.type, match4.id, match4.relationship, query, requestBody);
           }
           return this.makeError("invalidPath");
         }
@@ -356,24 +357,24 @@ var RestApiHandler = class {
           if (!requestBody) {
             return this.makeError("invalidPayload");
           }
-          let match2 = this.matchUrlPattern(path, "single");
-          if (match2) {
-            return await this.processUpdate(client, match2.type, match2.id, query, requestBody);
+          let match4 = this.matchUrlPattern(path, "single");
+          if (match4) {
+            return await this.processUpdate(client, match4.type, match4.id, query, requestBody);
           }
-          match2 = this.matchUrlPattern(path, "relationship");
-          if (match2) {
-            return await this.processRelationshipCRUD(client, "update", match2.type, match2.id, match2.relationship, query, requestBody);
+          match4 = this.matchUrlPattern(path, "relationship");
+          if (match4) {
+            return await this.processRelationshipCRUD(client, "update", match4.type, match4.id, match4.relationship, query, requestBody);
           }
           return this.makeError("invalidPath");
         }
         case "DELETE": {
-          let match2 = this.matchUrlPattern(path, "single");
-          if (match2) {
-            return await this.processDelete(client, match2.type, match2.id);
+          let match4 = this.matchUrlPattern(path, "single");
+          if (match4) {
+            return await this.processDelete(client, match4.type, match4.id);
           }
-          match2 = this.matchUrlPattern(path, "relationship");
-          if (match2) {
-            return await this.processRelationshipCRUD(client, "delete", match2.type, match2.id, match2.relationship, query, requestBody);
+          match4 = this.matchUrlPattern(path, "relationship");
+          if (match4) {
+            return await this.processRelationshipCRUD(client, "delete", match4.type, match4.id, match4.relationship, query, requestBody);
           }
           return this.makeError("invalidPath");
         }
@@ -383,8 +384,8 @@ var RestApiHandler = class {
     } catch (err) {
       if (err instanceof InvalidValueError) {
         return this.makeError("invalidValue", err.message);
-      } else if (err instanceof ZenStackError) {
-        return this.handleZenStackError(err);
+      } else if (err instanceof ORMError) {
+        return this.handleORMError(err);
       } else {
         return this.handleGenericError(err);
       }
@@ -1410,11 +1411,11 @@ ${err.stack}` : "Unknown error");
       if (!value) {
         continue;
       }
-      const match2 = key.match(this.filterParamPattern);
-      if (!match2 || !match2.groups || !match2.groups["match"]) {
+      const match4 = key.match(this.filterParamPattern);
+      if (!match4 || !match4.groups || !match4.groups["match"]) {
         continue;
       }
-      const filterKeys = match2.groups["match"].replaceAll(/[[\]]/g, " ").split(" ").filter((i) => i);
+      const filterKeys = match4.groups["match"].replaceAll(/[[\]]/g, " ").split(" ").filter((i) => i);
       if (!filterKeys.length) {
         continue;
       }
@@ -1737,20 +1738,24 @@ ${err.stack}` : "Unknown error");
       };
     }
   }
-  handleZenStackError(err) {
-    if (err instanceof InputValidationError) {
-      return this.makeError("validationError", err.message, 422, err.cause instanceof Error ? err.cause.message : void 0);
-    } else if (err instanceof RejectedByPolicyError) {
-      return this.makeError("forbidden", err.message, 403, err.reason);
-    } else if (err instanceof NotFoundError) {
-      return this.makeError("notFound", err.message);
-    } else if (err instanceof QueryError) {
-      return this.makeError("queryError", err.message, 400, err.cause instanceof Error ? err.cause.message : void 0);
-    } else {
+  handleORMError(err) {
+    return match2(err.reason).with(ORMErrorReason.INVALID_INPUT, () => {
+      return this.makeError("validationError", err.message, 422);
+    }).with(ORMErrorReason.REJECTED_BY_POLICY, () => {
+      return this.makeError("forbidden", err.message, 403, {
+        reason: err.rejectedByPolicyReason
+      });
+    }).with(ORMErrorReason.NOT_FOUND, () => {
+      return this.makeError("notFound", err.message, 404);
+    }).with(ORMErrorReason.DB_QUERY_ERROR, () => {
+      return this.makeError("queryError", err.message, 400, {
+        dbErrorCode: err.dbErrorCode
+      });
+    }).otherwise(() => {
       return this.makeError("unknownError", err.message);
-    }
+    });
   }
-  makeError(code, detail, status, reason) {
+  makeError(code, detail, status, otherFields = {}) {
     status = status ?? this.errors[code]?.status ?? 500;
     const error = {
       status,
@@ -1760,9 +1765,7 @@ ${err.stack}` : "Unknown error");
     if (detail) {
       error.detail = detail;
     }
-    if (reason) {
-      error.reason = reason;
-    }
+    Object.assign(error, otherFields);
     return {
       status,
       body: {
@@ -1782,8 +1785,9 @@ ${err.stack}` : "Unknown error");
 
 // src/api/rpc/index.ts
 import { lowerCaseFirst as lowerCaseFirst2, safeJSONStringify } from "@zenstackhq/common-helpers";
-import { InputValidationError as InputValidationError2, NotFoundError as NotFoundError2, RejectedByPolicyError as RejectedByPolicyError2, ZenStackError as ZenStackError2 } from "@zenstackhq/orm";
+import { ORMError as ORMError2, ORMErrorReason as ORMErrorReason2 } from "@zenstackhq/orm";
 import SuperJSON3 from "superjson";
+import { match as match3 } from "ts-pattern";
 registerCustomSerializers();
 var RPCApiHandler = class {
   static {
@@ -1896,8 +1900,8 @@ var RPCApiHandler = class {
       return response;
     } catch (err) {
       log(this.options.log, "error", `error occurred when handling "${model}.${op}" request`, err);
-      if (err instanceof ZenStackError2) {
-        return this.makeZenStackErrorResponse(err);
+      if (err instanceof ORMError2) {
+        return this.makeORMErrorResponse(err);
       } else {
         return this.makeGenericErrorResponse(err);
       }
@@ -1930,27 +1934,29 @@ var RPCApiHandler = class {
     log(this.options.log, "debug", () => `sending error response: ${safeJSONStringify(resp)}${err instanceof Error ? "\n" + err.stack : ""}`);
     return resp;
   }
-  makeZenStackErrorResponse(err) {
+  makeORMErrorResponse(err) {
     let status = 400;
     const error = {
-      message: err.message
+      message: err.message,
+      reason: err.reason
     };
-    if (err.cause && err.cause instanceof Error) {
-      error.cause = err.cause.message;
-    }
-    if (err instanceof NotFoundError2) {
+    match3(err.reason).with(ORMErrorReason2.NOT_FOUND, () => {
       status = 404;
       error.model = err.model;
-    } else if (err instanceof InputValidationError2) {
+    }).with(ORMErrorReason2.INVALID_INPUT, () => {
       status = 422;
       error.rejectedByValidation = true;
       error.model = err.model;
-    } else if (err instanceof RejectedByPolicyError2) {
+    }).with(ORMErrorReason2.REJECTED_BY_POLICY, () => {
       status = 403;
       error.rejectedByPolicy = true;
-      error.rejectReason = err.reason;
+      error.rejectReason = err.rejectedByPolicyReason;
       error.model = err.model;
-    }
+    }).with(ORMErrorReason2.DB_QUERY_ERROR, () => {
+      status = 400;
+      error.dbErrorCode = err.dbErrorCode;
+    }).otherwise(() => {
+    });
     const resp = {
       status,
       body: {