Add optional jsonSchema field to Serde (#500)

Author: igalshilman

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

@@ -15,30 +15,13 @@
 
 export interface Serde<T> {
   readonly contentType: string;
+  readonly jsonSchema?: object;
 
   serialize(value: T): Uint8Array;
 
   deserialize(data: Uint8Array): T;
 }
 
-class JsonSerde<T> implements Serde<T | undefined> {
-  contentType = "application/json";
-
-  serialize(value: T): Uint8Array {
-    if (value === undefined) {
-      return new Uint8Array(0);
-    }
-    return new TextEncoder().encode(JSON.stringify(value));
-  }
-
-  deserialize(data: Uint8Array): T | undefined {
-    if (data.length === 0) {
-      return undefined;
-    }
-    return JSON.parse(new TextDecoder().decode(data)) as T;
-  }
-}
-
 class BinarySerde implements Serde<Uint8Array> {
   contentType = "application/octet-stream";
 
@@ -69,7 +52,31 @@ class VoidSerde implements Serde<void> {
 }
 
 export namespace serde {
-  export const json: Serde<any> = new JsonSerde<any>();
+  export class JsonSerde<T> implements Serde<T | undefined> {
+    contentType = "application/json";
+
+    constructor(readonly jsonSchema?: object) {}
+
+    serialize(value: T): Uint8Array {
+      if (value === undefined) {
+        return new Uint8Array(0);
+      }
+      return new TextEncoder().encode(JSON.stringify(value));
+    }
+
+    deserialize(data: Uint8Array): T | undefined {
+      if (data.length === 0) {
+        return undefined;
+      }
+      return JSON.parse(new TextDecoder().decode(data)) as T;
+    }
+
+    schema<U>(schema: object): JsonSerde<U> {
+      return new JsonSerde<U>(schema);
+    }
+  }
+
+  export const json: JsonSerde<any> = new JsonSerde<any>();
   export const binary: Serde<Uint8Array> = new BinarySerde();
   export const empty: Serde<void> = new VoidSerde();
 }

packages/restate-sdk/src/types/components.ts

@@ -64,13 +64,13 @@ export class ServiceComponent implements Component {
             required: false,
             contentType:
               serviceHandler.handlerWrapper.accept ?? "application/json",
-            jsonSchema: serviceHandler.handlerWrapper.inputSchema,
+            jsonSchema: serviceHandler.handlerWrapper.inputSerde.jsonSchema,
           },
           output: {
             setContentTypeIfEmpty: false,
             contentType:
               serviceHandler.handlerWrapper.contentType ?? "application/json",
-            jsonSchema: serviceHandler.handlerWrapper.outputSchema,
+            jsonSchema: serviceHandler.handlerWrapper.outputSerde.jsonSchema,
           },
           documentation: serviceHandler.handlerWrapper.description,
           metadata: serviceHandler.handlerWrapper.metadata,
@@ -153,12 +153,12 @@ export class VirtualObjectComponent implements Component {
           input: {
             required: false,
             contentType: opts.accept ?? "application/json",
-            jsonSchema: opts.inputSchema,
+            jsonSchema: opts.inputSerde.jsonSchema,
           },
           output: {
             setContentTypeIfEmpty: false,
             contentType: opts.contentType ?? "application/json",
-            jsonSchema: opts.outputSchema,
+            jsonSchema: opts.outputSerde.jsonSchema,
           },
           ty:
             opts.kind === HandlerKind.EXCLUSIVE
@@ -239,12 +239,12 @@ export class WorkflowComponent implements Component {
           input: {
             required: false,
             contentType: handler.accept ?? "application/json",
-            jsonSchema: handler.inputSchema,
+            jsonSchema: handler.inputSerde.jsonSchema,
           },
           output: {
             setContentTypeIfEmpty: false,
             contentType: handler.contentType ?? "application/json",
-            jsonSchema: handler.outputSchema,
+            jsonSchema: handler.outputSerde.jsonSchema,
           },
           ty:
             handler.kind === HandlerKind.WORKFLOW

packages/restate-sdk/src/types/rpc.ts

@@ -284,18 +284,6 @@ export type ServiceHandlerOpts = {
    * Additional metadata for the handler.
    */
   metadata?: Record<string, string>;
-
-  /**
-   * An optional JSON schema definition for the input parameter.
-   * Please note that this is not enforced,  but only used as a documentation hint.
-   */
-  inputSchema?: object;
-
-  /**
-   * An optional JSON schema definition for the input parameter.
-   * Please note that this is not enforced,  but only used as a documentation hint.
-   */
-  outputSchema?: object;
 };
 
 export type ObjectHandlerOpts = {
@@ -337,18 +325,6 @@ export type ObjectHandlerOpts = {
    * Additional metadata for the handler.
    */
   metadata?: Record<string, string>;
-
-  /**
-   * An optional JSON schema definition for the input parameter.
-   * Please note that this is not enforced,  but only used as a documentation hint.
-   */
-  inputSchema?: object;
-
-  /**
-   * An optional JSON schema definition for the input parameter.
-   * Please note that this is not enforced,  but only used as a documentation hint.
-   */
-  outputSchema?: object;
 };
 
 export type WorkflowHandlerOpts = {
@@ -390,18 +366,6 @@ export type WorkflowHandlerOpts = {
    * Additional metadata for the handler.
    */
   metadata?: Record<string, string>;
-
-  /**
-   * An optional JSON schema definition for the input parameter.
-   * Please note that this is not enforced,  but only used as a documentation hint.
-   */
-  inputSchema?: object;
-
-  /**
-   * An optional JSON schema definition for the input parameter.
-   * Please note that this is not enforced,  but only used as a documentation hint.
-   */
-  outputSchema?: object;
 };
 
 const HANDLER_SYMBOL = Symbol("Handler");
@@ -429,9 +393,7 @@ export class HandlerWrapper {
       outputSerde,
       opts?.accept,
       opts?.description,
-      opts?.metadata,
-      opts?.inputSchema,
-      opts?.outputSchema
+      opts?.metadata
     );
   }
 
@@ -450,9 +412,7 @@ export class HandlerWrapper {
     public readonly outputSerde: Serde<unknown>,
     accept?: string,
     public readonly description?: string,
-    public readonly metadata?: Record<string, string>,
-    public readonly inputSchema?: object,
-    public readonly outputSchema?: object
+    public readonly metadata?: Record<string, string>
   ) {
     this.accept = accept ? accept : inputSerde.contentType;
     this.contentType = outputSerde.contentType;