@zenstackhq/runtime 0.3.10 → 0.3.12

package/lib/types.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getServerErrorMessage = exports.ServerErrorCode = void 0;
+/**
+ * Error codes for errors on server side
+ */
+var ServerErrorCode;
+(function (ServerErrorCode) {
+    /**
+     * The specified entity cannot be found
+     */
+    ServerErrorCode["ENTITY_NOT_FOUND"] = "ENTITY_NOT_FOUND";
+    /**
+     * The request parameter is invalid, either containing invalid fields or missing required fields
+     */
+    ServerErrorCode["INVALID_REQUEST_PARAMS"] = "INVALID_REQUEST_PARAMS";
+    /**
+     * The request is rejected by policy checks
+     */
+    ServerErrorCode["DENIED_BY_POLICY"] = "DENIED_BY_POLICY";
+    /**
+     * Violation of database unique constraints
+     */
+    ServerErrorCode["UNIQUE_CONSTRAINT_VIOLATION"] = "UNIQUE_CONSTRAINT_VIOLATION";
+    /**
+     * Violation of database reference constraint (aka. foreign key constraints)
+     */
+    ServerErrorCode["REFERENCE_CONSTRAINT_VIOLATION"] = "REFERENCE_CONSTRAINT_VIOLATION";
+    /**
+     * A write operation succeeded but the result cannot be read back due to policy control
+     */
+    ServerErrorCode["READ_BACK_AFTER_WRITE_DENIED"] = "READ_BACK_AFTER_WRITE_DENIED";
+    /**
+     * Unknown error
+     */
+    ServerErrorCode["UNKNOWN"] = "UNKNOWN";
+})(ServerErrorCode = exports.ServerErrorCode || (exports.ServerErrorCode = {}));
+function getServerErrorMessage(code) {
+    switch (code) {
+        case ServerErrorCode.ENTITY_NOT_FOUND:
+            return 'the requested entity is not found';
+        case ServerErrorCode.INVALID_REQUEST_PARAMS:
+            return 'request parameters are invalid';
+        case ServerErrorCode.DENIED_BY_POLICY:
+            return 'the request was denied due to access policy violation';
+        case ServerErrorCode.UNIQUE_CONSTRAINT_VIOLATION:
+            return 'the request failed because of database unique constraint violation';
+        case ServerErrorCode.REFERENCE_CONSTRAINT_VIOLATION:
+            return 'the request failed because of database foreign key constraint violation';
+        case ServerErrorCode.READ_BACK_AFTER_WRITE_DENIED:
+            return 'the write operation succeeded, but the data cannot be read back due to access policy violation';
+        case ServerErrorCode.UNKNOWN:
+            return 'an unknown error occurred';
+        default:
+            return `generic error: ${code}`;
+    }
+}
+exports.getServerErrorMessage = getServerErrorMessage;
+//# sourceMappingURL=types.js.map

package/lib/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":";;;AAqIA;;GAEG;AACH,IAAY,eAmCX;AAnCD,WAAY,eAAe;IACvB;;OAEG;IACH,wDAAqC,CAAA;IAErC;;OAEG;IACH,oEAAiD,CAAA;IAEjD;;OAEG;IACH,wDAAqC,CAAA;IAErC;;OAEG;IACH,8EAA2D,CAAA;IAE3D;;OAEG;IACH,oFAAiE,CAAA;IAEjE;;OAEG;IACH,gFAA6D,CAAA;IAE7D;;OAEG;IACH,sCAAmB,CAAA;AACvB,CAAC,EAnCW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAmC1B;AAED,SAAgB,qBAAqB,CAAC,IAAqB;IACvD,QAAQ,IAAI,EAAE;QACV,KAAK,eAAe,CAAC,gBAAgB;YACjC,OAAO,mCAAmC,CAAC;QAE/C,KAAK,eAAe,CAAC,sBAAsB;YACvC,OAAO,gCAAgC,CAAC;QAE5C,KAAK,eAAe,CAAC,gBAAgB;YACjC,OAAO,uDAAuD,CAAC;QAEnE,KAAK,eAAe,CAAC,2BAA2B;YAC5C,OAAO,oEAAoE,CAAC;QAEhF,KAAK,eAAe,CAAC,8BAA8B;YAC/C,OAAO,yEAAyE,CAAC;QAErF,KAAK,eAAe,CAAC,4BAA4B;YAC7C,OAAO,gGAAgG,CAAC;QAE5G,KAAK,eAAe,CAAC,OAAO;YACxB,OAAO,2BAA2B,CAAC;QAEvC;YACI,OAAO,kBAAkB,IAAI,EAAE,CAAC;KACvC;AACL,CAAC;AA1BD,sDA0BC"}

package/lib/validation.d.ts

@@ -0,0 +1,12 @@
+import { z } from 'zod';
+/**
+ * Error indicating violations of field-level constraints
+ */
+export declare class ValidationError {
+    readonly message: string;
+    constructor(message: string);
+}
+/**
+ * Validate the given data with the given zod schema (for field-level constraints)
+ */
+export declare function validate(validator: z.ZodType, data: unknown): void;

package/lib/validation.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validate = exports.ValidationError = void 0;
+const zod_validation_error_1 = require("zod-validation-error");
+/**
+ * Error indicating violations of field-level constraints
+ */
+class ValidationError {
+    constructor(message) {
+        this.message = message;
+    }
+}
+exports.ValidationError = ValidationError;
+/**
+ * Validate the given data with the given zod schema (for field-level constraints)
+ */
+function validate(validator, data) {
+    try {
+        validator.parse(data);
+    }
+    catch (err) {
+        throw new ValidationError((0, zod_validation_error_1.fromZodError)(err).message);
+    }
+}
+exports.validate = validate;
+//# sourceMappingURL=validation.js.map

package/lib/validation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.js","sourceRoot":"","sources":["../../src/validation.ts"],"names":[],"mappings":";;;AACA,+DAAoD;AAEpD;;GAEG;AACH,MAAa,eAAe;IACxB,YAA4B,OAAe;QAAf,YAAO,GAAP,OAAO,CAAQ;IAAG,CAAC;CAClD;AAFD,0CAEC;AAED;;GAEG;AACH,SAAgB,QAAQ,CAAC,SAAoB,EAAE,IAAa;IACxD,IAAI;QACA,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;KACzB;IAAC,OAAO,GAAG,EAAE;QACV,MAAM,IAAI,eAAe,CAAC,IAAA,mCAAY,EAAC,GAAiB,CAAC,CAAC,OAAO,CAAC,CAAC;KACtE;AACL,CAAC;AAND,4BAMC"}

package/package.json

@@ -1,23 +1,49 @@
 {
   "name": "@zenstackhq/runtime",
   "displayName": "ZenStack Runtime Library",
-  "version": "0.3.10",
-  "description": "This package contains runtime library for consuming client and server side code generated by ZenStack.",
+  "version": "0.3.12",
+  "description": "Runtime of ZenStack for both client-side and server-side environments.",
   "repository": {
     "type": "git",
     "url": "https://github.com/zenstackhq/zenstack"
   },
-  "main": "index.js",
-  "types": "index.d.ts",
+  "publishConfig": {
+    "directory": "dist",
+    "linkDirectory": true
+  },
   "dependencies": {
-    "@zenstackhq/internal": "latest"
+    "colors": "1.4.0",
+    "cuid": "^2.1.8",
+    "decimal.js": "^10.4.2",
+    "deepcopy": "^2.1.0",
+    "swr": "^1.3.0",
+    "tslib": "^2.4.1",
+    "@types/bcryptjs": "^2.4.2",
+    "bcryptjs": "^2.4.3",
+    "zod": "^3.19.1",
+    "zod-validation-error": "^0.2.1"
   },
   "peerDependencies": {
-    "@types/bcryptjs": "^2.4.2",
-    "bcryptjs": "^2.4.3"
+    "next": "^12.3.1 || ^13",
+    "react": "^17.0.2 || ^18",
+    "react-dom": "^17.0.2 || ^18"
   },
   "author": {
     "name": "ZenStack Team"
   },
-  "license": "MIT"
+  "license": "MIT",
+  "devDependencies": {
+    "@types/bcryptjs": "^2.4.2",
+    "@types/jest": "^29.0.3",
+    "@types/node": "^14.18.29",
+    "rimraf": "^3.0.2",
+    "typescript": "^4.9.3"
+  },
+  "scripts": {
+    "clean": "rimraf dist",
+    "build": "npm run clean && tsc && cp -r pre/* dist/ && cp ./package.json dist/",
+    "watch": "tsc --watch",
+    "lint": "eslint src --ext ts",
+    "publish-dev": "pnpm publish --tag dev"
+  }
 }

package/server/index.d.ts

@@ -0,0 +1,16 @@
+import service from '.zenstack/lib';
+
+export type {
+    FieldInfo,
+    PolicyKind,
+    PolicyOperationKind,
+    RuntimeAttribute,
+    QueryContext,
+} from '../lib/types';
+
+export {
+    requestHandler,
+    type RequestHandlerOptions,
+} from '../lib/request-handler';
+
+export default service;

package/server/index.js

@@ -0,0 +1,7 @@
+Object.defineProperty(exports, '__esModule', { value: true });
+
+exports.default = require('.zenstack/lib').default;
+
+const exportStar = require('tslib').__exportStar;
+exportStar(require('../lib/types'), exports);
+exportStar(require('../lib/request-handler'), exports);

package/README.md

@@ -1,5 +0,0 @@
-# ZenStack Runtime Library
-
-This package is the runtime library supporting web apps built using ZenStack.
-
-Visit [Homepage](https://github.com/zenstackhq/zenstack#readme) for more details.

package/client.d.ts

@@ -1 +0,0 @@
-export * from '@zenstackhq/internal/lib/client';

package/client.js

@@ -1,3 +0,0 @@
-module.exports = {
-    ...require('@zenstackhq/internal/lib/client'),
-};

package/hooks.d.ts

@@ -1,10 +0,0 @@
-import { ServerErrorCode } from './client';
-
-export * from '.zenstack/lib/hooks';
-export type HooksError = {
-    status: number;
-    info: {
-        code: ServerErrorCode;
-        message: string;
-    };
-};

package/hooks.js

@@ -1,3 +0,0 @@
-module.exports = {
-    ...require('.zenstack/lib/hooks'),
-};

package/index.d.ts

@@ -1,3 +0,0 @@
-export * from '.zenstack/lib';
-import service from '.zenstack/lib';
-export default service;

package/index.js

@@ -1 +0,0 @@
-module.exports = require('.zenstack/lib').default;

package/server.d.ts

@@ -1 +0,0 @@
-export * from '@zenstackhq/internal';

package/server.js

@@ -1,3 +0,0 @@
-module.exports = {
-    ...require('@zenstackhq/internal'),
-};