Add zod module

Author: igalshilman

package-lock.json

@@ -19,6 +19,7 @@
     "packages/restate-sdk",
     "packages/restate-sdk-cloudflare-workers",
     "packages/restate-sdk-clients",
+		"packages/restate-sdk-zod",
     "packages/restate-sdk-examples",
     "packages/restate-sdk-testcontainers",
     "packages/restate-e2e-services"
@@ -31,7 +32,7 @@
     "format": "npm run format -ws --if-present",
     "format-check": "npm run format-check -ws --if-present",
     "verify": "npm run verify -ws --if-present",
-    "clean": "rm -rf packages/restate-sdk/dist && rm -rf packages/restate-sdk-cloudflare-workers/dist && rm -rf packages/restate-sdk-examples/dist && rm -rf packages/restate-sdk-ingress/dist && rm -rf packages/restate-e2e-services/dist && rm -rf packages/restate-sdk-core/dist"
+    "clean": "rm -rf packages/restate-sdk-zod/dist && rm -rf packages/restate-sdk/dist && rm -rf packages/restate-sdk-cloudflare-workers/dist && rm -rf packages/restate-sdk-examples/dist && rm -rf packages/restate-sdk-ingress/dist && rm -rf packages/restate-e2e-services/dist && rm -rf packages/restate-sdk-core/dist"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.15.3",

package.json

@@ -3,6 +3,7 @@
   "include": ["src/**/*.ts", "test/**/*.ts"],
   "references": [
     { "path": "../restate-sdk-core" },
+    { "path": "../restate-sdk-zod" },
     { "path": "../restate-sdk-testcontainers" }
   ]
 }

packages/restate-sdk-examples/tsconfig.eslint.json

@@ -7,6 +7,7 @@
   "references": [
     { "path": "../restate-sdk-core" },
     { "path": "../restate-sdk" },
+    { "path": "../restate-sdk-zod" },
     { "path": "../restate-sdk-clients" },
     { "path": "../restate-sdk-testcontainers" }
   ]

packages/restate-sdk-examples/tsconfig.json

@@ -0,0 +1,3 @@
+node_modules
+dist
+src/generated

packages/restate-sdk-zod/.eslintignore

@@ -0,0 +1,62 @@
+[![Documentation](https://img.shields.io/badge/doc-reference-blue)](https://docs.restate.dev)
+[![Examples](https://img.shields.io/badge/view-examples-blue)](https://github.com/restatedev/examples)
+[![Discord](https://img.shields.io/discord/1128210118216007792?logo=discord)](https://discord.gg/skW3AZ6uGd)
+[![Twitter](https://img.shields.io/twitter/follow/restatedev.svg?style=social&label=Follow)](https://twitter.com/intent/follow?screen_name=restatedev)
+
+# Restate Typescript SDK
+
+[Restate](https://restate.dev/) is a system for easily building resilient applications using *distributed durable async/await*. This repository contains the Restate SDK for writing services in **Node.js / Typescript**.
+
+Restate applications are composed of *durably executed, stateful RPC handlers* that can run either
+as part of long-running processes, or as FaaS (AWS Lambda).
+
+```typescript
+import * as restate from "@restatedev/restate-sdk";
+
+const greeter = restate.service({
+    name: "greeter",
+    handlers: {
+        greet: async (ctx: restate.Context, name: string) => {
+            return `Hello ${name}!`;
+        },
+    },
+});
+
+restate.endpoint()
+    .bind(greeter)
+    .listen(9080);
+```
+
+## Community
+
+* 🤗️ [Join our online community](https://discord.gg/skW3AZ6uGd) for help, sharing feedback and talking to the community.
+* 📖 [Check out our documentation](https://docs.restate.dev) to get quickly started!
+* 📣 [Follow us on Twitter](https://twitter.com/restatedev) for staying up to date.
+* 🙋 [Create a GitHub issue](https://github.com/restatedev/sdk-typescript/issues) for requesting a new feature or reporting a problem.
+* 🏠 [Visit our GitHub org](https://github.com/restatedev) for exploring other repositories.
+
+## Using the SDK
+
+To use this SDK, add the dependency to your project:
+```shell
+npm install @restatedev/restate-sdk
+```
+
+For brand-new projects, we recommend using the [Restate Node Template](https://github.com/restatedev/node-template-generator):
+```shell
+npx -y @restatedev/create-app@latest
+```
+
+## Versions
+
+This library follows [Semantic Versioning](https://semver.org/).
+
+The compatibility with Restate is described in the following table:
+
+| Restate Server\sdk-typescript | 1.0/1.1/1.2/1.3  | 1.4 | 1.5 |
+|-------------------------------|------------------|-----|-----|
+| 1.0                           | ✅                | ❌   | ❌   |
+| 1.1                           | ✅ <sup>(1)</sup> | ✅   | ❌   |
+| 1.2                           | ✅                | ✅   | ✅   |
+
+<sup>(1)</sup> **Only** when upgrading from 1.0 to 1.1 you MUST rediscover all the existing deployments using `restate dp register <address> --force`. You don't need to update the SDK, nor change the code. 

packages/restate-sdk-zod/README.md

@@ -0,0 +1,64 @@
+{
+  "name": "@restatedev/restate-sdk-zod",
+  "version": "1.4.0",
+  "description": "Restate Typescript SDK Zod",
+  "author": "Restate Developers",
+  "license": "MIT",
+  "email": "[email protected]",
+  "homepage": "https://github.com/restatedev/sdk-typescript#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/restatedev/sdk-typescript.git"
+  },
+  "bugs": {
+    "url": "https://github.com/restatedev/sdk-typescript/issues"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/cjs/src/public_api.js",
+  "types": "./dist/cjs/src/public_api.d.ts",
+  "module": "./dist/esm/src/public_api.js",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/esm/src/public_api.d.ts",
+        "default": "./dist/esm/src/public_api.js"
+      },
+      "require": {
+        "types": "./dist/cjs/src/public_api.d.ts",
+        "default": "./dist/cjs/src/public_api.js"
+      }
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "@restatedev/restate-sdk-core": "^1.4.0"
+  },
+  "dependencies": {
+    "zod": "^3.6.0",
+    "zod-to-json-schema": "3.24.3"
+  },
+  "scripts": {
+    "build": "npm run build:cjs && npm run build:esm",
+    "build:cjs": "tsc --module commonjs --verbatimModuleSyntax false --moduleResolution node10 --outDir ./dist/cjs --declaration --declarationDir ./dist/cjs && echo >./dist/cjs/package.json '{\"type\":\"commonjs\"}'",
+    "build:esm": "tsc --outDir ./dist/esm --declaration --declarationDir ./dist/esm",
+    "lint": "eslint --ignore-path .eslintignore --max-warnings=0 --ext .ts .",
+    "format": "prettier --ignore-path .eslintignore --write \"**/*.+(js|ts|json)\"",
+    "format-check": "prettier --ignore-path .eslintignore --check \"**/*.+(js|ts|json)\"",
+    "attw": "attw --pack",
+    "verify": "npm run format-check && npm run lint && npm run build && npm run attw",
+    "release": "release-it"
+  },
+  "engines": {
+    "node": ">= 18.13"
+  },
+  "directories": {
+    "example": "examples",
+    "test": "test"
+  },
+  "publishConfig": {
+    "@restatedev:registry": "https://registry.npmjs.org"
+  }
+}

packages/restate-sdk-zod/package.json

@@ -0,0 +1,12 @@
+/*
+ * Copyright (c) 2023-2024 - Restate Software, Inc., Restate GmbH
+ *
+ * This file is part of the Restate SDK for Node.js/TypeScript,
+ * which is released under the MIT license.
+ *
+ * You can find a copy of the license in file LICENSE in the root
+ * directory of this repository or package, or at
+ * https://github.com/restatedev/sdk-typescript/blob/main/LICENSE
+ */
+
+export { serde } from "./serde_api.js";

packages/restate-sdk-zod/src/public_api.ts

@@ -0,0 +1,66 @@
+/*
+ * Copyright (c) 2023-2024 - Restate Software, Inc., Restate GmbH
+ *
+ * This file is part of the Restate SDK for Node.js/TypeScript,
+ * which is released under the MIT license.
+ *
+ * You can find a copy of the license in file LICENSE in the root
+ * directory of this repository or package, or at
+ * https://github.com/restatedev/sdk-typescript/blob/main/LICENSE
+ */
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/* eslint-disable @typescript-eslint/no-namespace */
+/* eslint-disable @typescript-eslint/ban-types */
+/* eslint-disable @typescript-eslint/no-unsafe-return */
+/* eslint-disable @typescript-eslint/no-unsafe-assignment */
+
+import type { Serde } from "@restatedev/restate-sdk-core";
+
+import type { z } from "zod";
+import { zodToJsonSchema } from "zod-to-json-schema";
+
+class ZodSerde<T extends z.ZodType> implements Serde<z.infer<T>> {
+  contentType = "application/json";
+  jsonSchema?: object | undefined;
+
+  constructor(private readonly schema: T, name: string) {
+    this.jsonSchema = zodToJsonSchema(schema, name);
+  }
+
+  serialize(value: T): Uint8Array {
+    if (value === undefined) {
+      return new Uint8Array(0);
+    }
+    return new TextEncoder().encode(JSON.stringify(value));
+  }
+
+  deserialize(data: Uint8Array): T {
+    if (data.length === 0) {
+      return undefined as any;
+    }
+    const js = JSON.parse(new TextDecoder().decode(data));
+
+    const res = this.schema.safeParse(js);
+    if (res.success) {
+      return res.data;
+    }
+    throw res.error;
+  }
+}
+
+export namespace serde {
+  /**
+   * A Zod based serde.
+   *
+   * @param schema the zod type
+   * @param name the name of the type for the json schema
+   * @returns a serde that will validate the data with the zod schema
+   */
+  export const zod = <T extends z.ZodType>(
+    zodType: T,
+    name: string
+  ): Serde<z.infer<T>> => {
+    return new ZodSerde(zodType, name);
+  };
+}

packages/restate-sdk-zod/src/serde_api.ts

@@ -0,0 +1,5 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["src/**/*.ts", "test/**/*.ts"],
+  "references": [{ "path": "../restate-sdk-core" }]
+}

packages/restate-sdk-zod/tsconfig.eslint.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "./dist/esm"
+  },
+  "include": ["src/**/*.ts"],
+  "references": [{ "path": "../restate-sdk-core" }]
+}

packages/restate-sdk-zod/tsconfig.json

@@ -21,7 +21,8 @@
       "@restatedev/restate-sdk": ["./packages/restate-sdk/src/public_api.ts"],
       "@restatedev/restate-sdk-clients": [
         "./packages/restate-sdk-clients/src/public_api.ts"
-      ]
+      ],
+      "@restatedev/restate-sdk-zod": ["./packages/restate-sdk-zod/src/public_api.ts"]
     }
   }
 }