@restatedev/restate-sdk 1.7.2 → 1.8.0

package/dist/cjs/src/endpoint/withOptions.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withOptions = withOptions;
+function withOptions(endpoint, { identityKeys, defaultServiceOptions, logger, services }) {
+    let endpointWithOptions = endpoint;
+    if (identityKeys && identityKeys.length > 0) {
+        endpointWithOptions = endpointWithOptions.withIdentityV1(...identityKeys);
+    }
+    if (defaultServiceOptions) {
+        endpointWithOptions = endpointWithOptions.defaultServiceOptions(defaultServiceOptions);
+    }
+    if (logger) {
+        endpointWithOptions = endpointWithOptions.setLogger(logger);
+    }
+    return services.reduce((results, service) => {
+        return results.bind(service);
+    }, endpointWithOptions);
+}
+//# sourceMappingURL=withOptions.js.map

package/dist/cjs/src/endpoint/withOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"withOptions.js","sourceRoot":"","sources":["../../../../src/endpoint/withOptions.ts"],"names":[],"mappings":";;AAGA,kCAoBC;AApBD,SAAgB,WAAW,CACzB,QAAW,EACX,EAAE,YAAY,EAAE,qBAAqB,EAAE,MAAM,EAAE,QAAQ,EAAmB;IAE1E,IAAI,mBAAmB,GAAG,QAAQ,CAAC;IACnC,IAAI,YAAY,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5C,mBAAmB,GAAG,mBAAmB,CAAC,cAAc,CAAC,GAAG,YAAY,CAAC,CAAC;IAC5E,CAAC;IACD,IAAI,qBAAqB,EAAE,CAAC;QAC1B,mBAAmB,GAAG,mBAAmB,CAAC,qBAAqB,CAC7D,qBAAqB,CACtB,CAAC;IACJ,CAAC;IACD,IAAI,MAAM,EAAE,CAAC;QACX,mBAAmB,GAAG,mBAAmB,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAC9D,CAAC;IAED,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE;QAC1C,OAAO,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC,EAAE,mBAAmB,CAAC,CAAC;AAC1B,CAAC"}

package/dist/cjs/src/endpoint.d.ts

@@ -1,6 +1,8 @@
 import type { Http2ServerRequest, Http2ServerResponse } from "http2";
 import type { VirtualObjectDefinition, ServiceDefinition, WorkflowDefinition } from "@restatedev/restate-sdk-core";
 import type { LoggerTransport } from "./logging/logger_transport.js";
+import type { ObjectOptions, ServiceOptions, WorkflowOptions } from "./types/rpc.js";
+export type DefaultServiceOptions = ServiceOptions & ObjectOptions & WorkflowOptions;
 export interface RestateEndpointBase<E> {
     /**
      * Binds a new durable service / virtual object / workflow.
@@ -18,34 +20,43 @@ export interface RestateEndpointBase<E> {
      *
      */
     withIdentityV1(...keys: string[]): E;
+    /**
+     * Set default service options that will be used by all services bind to this endpoint.
+     *
+     * Options can be overridden on each service/handler.
+     *
+     * @param options
+     */
+    defaultServiceOptions(options: DefaultServiceOptions): E;
     /**
      * Replace the default console-based {@link LoggerTransport}
      * @param logger
      * @example
      * Using console:
      * ```ts
-     *     restate.setLogger((meta, message, ...o) => {console.log(`${meta.level}: `, message, ...o)})
-     *  ```
+     * restate.setLogger((meta, message, ...o) => {console.log(`${meta.level}: `, message, ...o)})
+     * ```
      * @example
      * Using winston:
      * ```ts
-     *     const logger = createLogger({ ... })
-     *     restate.setLogger((meta, message, ...o) => {logger.log(meta.level, {invocationId: meta.context?.invocationId}, [message, ...o].join(' '))})
-     *  ```
+     * const logger = createLogger({ ... })
+     * restate.setLogger((meta, message, ...o) => {logger.log(meta.level, {invocationId: meta.context?.invocationId}, [message, ...o].join(' '))})
+     * ```
      * @example
      * Using pino:
      * ```ts
-     *     const logger = pino()
-     *     restate.setLogger((meta, message, ...o) => {logger[meta.level]({invocationId: meta.context?.invocationId}, [message, ...o].join(' '))})
-     *  ```
+     * const logger = pino()
+     * restate.setLogger((meta, message, ...o) => {logger[meta.level]({invocationId: meta.context?.invocationId}, [message, ...o].join(' '))})
+     * ```
      */
     setLogger(logger: LoggerTransport): E;
 }
 /**
  * RestateEndpoint encapsulates all the Restate services served by this endpoint.
  *
- * A RestateEndpoint can either be served either as HTTP2 server, using the methods {@link listen} or {@link http2Handler},
- * or as Lambda, using the method {@link lambdaHandler}.
+ * A RestateEndpoint can either be served as HTTP2 server, using the methods {@link RestateEndpoint.listen} or {@link RestateEndpoint.http2Handler}.
+ *
+ * For Lambda, check {@link LambdaEndpoint}
  *
  * @example
  * A typical endpoint served as HTTP server would look like this:
@@ -57,16 +68,6 @@ export interface RestateEndpointBase<E> {
  *   .bind(myService)
  *   .listen(8000);
  * ```
- * @example
- * A typical endpoint served as AWS Lambda would look like this:
- * ```
- * import * as restate from "@restatedev/restate-sdk/lambda";
- *
- * export const handler = restate
- *   .endpoint()
- *   .bind(myService)
- *   .handler();
- * ```
  */
 export interface RestateEndpoint extends RestateEndpointBase<RestateEndpoint> {
     /**
@@ -86,14 +87,14 @@ export interface RestateEndpoint extends RestateEndpointBase<RestateEndpoint> {
      * httpServer.listen(port);
      * ```
      *
-     * If you need to manually control the server lifecycle, we suggest to manually instantiate the http2 server and use {@link http2Handler}.
+     * If you need to manually control the server lifecycle, we suggest to manually instantiate the http2 server and use {@link RestateEndpoint.http2Handler}.
      *
      * @param port The port to listen at. May be undefined (see above).
      * @returns a Promise that resolves with the bound port, or rejects with a failure otherwise.
      */
     listen(port?: number): Promise<number>;
     /**
-     * Returns an http2 server handler. See {@link listen} for more details.
+     * Returns an http2 server handler. See {@link RestateEndpoint.listen} for more details.
      */
     http2Handler(): (request: Http2ServerRequest, response: Http2ServerResponse) => void;
 }

package/dist/cjs/src/endpoint.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"endpoint.d.ts","sourceRoot":"","sources":["../../../src/endpoint.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,OAAO,CAAC;AACrE,OAAO,KAAK,EACV,uBAAuB,EACvB,iBAAiB,EACjB,kBAAkB,EACnB,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAErE,MAAM,WAAW,mBAAmB,CAAC,CAAC;IACpC;;;;QAII;IACJ,IAAI,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EACtB,OAAO,EACH,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,GACvB,uBAAuB,CAAC,CAAC,EAAE,CAAC,CAAC,GAC7B,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,GAC3B,CAAC,CAAC;IAEL;;;;;;;;OAQG;IACH,cAAc,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC;IAErC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,CAAC,CAAC;CACvC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,WAAW,eAAgB,SAAQ,mBAAmB,CAAC,eAAe,CAAC;IAC3E;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAEvC;;OAEG;IACH,YAAY,IAAI,CACd,OAAO,EAAE,kBAAkB,EAC3B,QAAQ,EAAE,mBAAmB,KAC1B,IAAI,CAAC;CACX"}
+{"version":3,"file":"endpoint.d.ts","sourceRoot":"","sources":["../../../src/endpoint.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,OAAO,CAAC;AACrE,OAAO,KAAK,EACV,uBAAuB,EACvB,iBAAiB,EACjB,kBAAkB,EACnB,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AACrE,OAAO,KAAK,EACV,aAAa,EACb,cAAc,EACd,eAAe,EAChB,MAAM,gBAAgB,CAAC;AAExB,MAAM,MAAM,qBAAqB,GAAG,cAAc,GAChD,aAAa,GACb,eAAe,CAAC;AAElB,MAAM,WAAW,mBAAmB,CAAC,CAAC;IACpC;;;;QAII;IACJ,IAAI,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EACtB,OAAO,EACH,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,GACvB,uBAAuB,CAAC,CAAC,EAAE,CAAC,CAAC,GAC7B,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,GAC3B,CAAC,CAAC;IAEL;;;;;;;;OAQG;IACH,cAAc,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC;IAErC;;;;;;OAMG;IACH,qBAAqB,CAAC,OAAO,EAAE,qBAAqB,GAAG,CAAC,CAAC;IAEzD;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,CAAC,CAAC;CACvC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,WAAW,eAAgB,SAAQ,mBAAmB,CAAC,eAAe,CAAC;IAC3E;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAEvC;;OAEG;IACH,YAAY,IAAI,CACd,OAAO,EAAE,kBAAkB,EAC3B,QAAQ,EAAE,mBAAmB,KAC1B,IAAI,CAAC;CACX"}

package/dist/cjs/src/fetch.d.ts

@@ -1,8 +1,42 @@
 export * from "./common_api.js";
 import { type FetchEndpoint } from "./endpoint/fetch_endpoint.js";
+import type { EndpointOptions } from "./endpoint/types.js";
 /**
  * Create a new {@link RestateEndpoint} in request response protocol mode.
  * Bidirectional mode (must be served over http2) can be enabled with .enableHttp2()
  */
 export declare function endpoint(): FetchEndpoint;
+interface FetchEndpointOptions extends EndpointOptions {
+    /**
+     * Enables bidirectional communication for the handler.
+     *
+     * When set to `true`, the handler supports bidirectional streaming (e.g., via HTTP/2 or compatible HTTP/1.1 servers).
+     * When `false`, the handler operates in request-response mode only.
+     *
+     * @default false
+     */
+    bidirectional?: boolean;
+}
+/**
+ * Creates a Fetch handler that encapsulates all the Restate services served by this endpoint.
+ *
+ * @param {FetchEndpointOptions} options - Configuration options for the endpoint handler.
+ * @returns A fetch handler function.
+ *
+ * @example
+ * A typical request-response handler would look like this:
+ * ```
+ * import { createEndpointHandler } from "@restatedev/restate-sdk/fetch";
+ *
+ * export const handler = createEndpointHandler({ services: [myService] })
+ *
+ * @example
+ * A typical bidirectional handler (works with http2 and some http1.1 servers) would look like this:
+ * ```
+ * import { createEndpointHandler } from "@restatedev/restate-sdk/fetch";
+ *
+ * export const handler = createEndpointHandler({ services: [myService], bidirectional: true })
+ *
+ */
+export declare function createEndpointHandler(options: FetchEndpointOptions): (request: Request, ...extraArgs: unknown[]) => Promise<Response>;
 //# sourceMappingURL=fetch.d.ts.map

package/dist/cjs/src/fetch.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fetch.d.ts","sourceRoot":"","sources":["../../../src/fetch.ts"],"names":[],"mappings":"AAWA,cAAc,iBAAiB,CAAC;AAEhC,OAAO,EACL,KAAK,aAAa,EAEnB,MAAM,8BAA8B,CAAC;AAEtC;;;GAGG;AACH,wBAAgB,QAAQ,IAAI,aAAa,CAExC"}
+{"version":3,"file":"fetch.d.ts","sourceRoot":"","sources":["../../../src/fetch.ts"],"names":[],"mappings":"AAWA,cAAc,iBAAiB,CAAC;AAEhC,OAAO,EACL,KAAK,aAAa,EAEnB,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAG3D;;;GAGG;AACH,wBAAgB,QAAQ,IAAI,aAAa,CAExC;AAED,UAAU,oBAAqB,SAAQ,eAAe;IACpD;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,oBAAoB,oEAOlE"}

package/dist/cjs/src/fetch.js

@@ -25,8 +25,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.endpoint = endpoint;
+exports.createEndpointHandler = createEndpointHandler;
 __exportStar(require("./common_api.js"), exports);
 const fetch_endpoint_js_1 = require("./endpoint/fetch_endpoint.js");
+const withOptions_js_1 = require("./endpoint/withOptions.js");
 /**
  * Create a new {@link RestateEndpoint} in request response protocol mode.
  * Bidirectional mode (must be served over http2) can be enabled with .enableHttp2()
@@ -34,4 +36,28 @@ const fetch_endpoint_js_1 = require("./endpoint/fetch_endpoint.js");
 function endpoint() {
     return new fetch_endpoint_js_1.FetchEndpointImpl("REQUEST_RESPONSE");
 }
+/**
+ * Creates a Fetch handler that encapsulates all the Restate services served by this endpoint.
+ *
+ * @param {FetchEndpointOptions} options - Configuration options for the endpoint handler.
+ * @returns A fetch handler function.
+ *
+ * @example
+ * A typical request-response handler would look like this:
+ * ```
+ * import { createEndpointHandler } from "@restatedev/restate-sdk/fetch";
+ *
+ * export const handler = createEndpointHandler({ services: [myService] })
+ *
+ * @example
+ * A typical bidirectional handler (works with http2 and some http1.1 servers) would look like this:
+ * ```
+ * import { createEndpointHandler } from "@restatedev/restate-sdk/fetch";
+ *
+ * export const handler = createEndpointHandler({ services: [myService], bidirectional: true })
+ *
+ */
+function createEndpointHandler(options) {
+    return (0, withOptions_js_1.withOptions)(new fetch_endpoint_js_1.FetchEndpointImpl(options.bidirectional ? "BIDI_STREAM" : "REQUEST_RESPONSE"), options).handler().fetch;
+}
 //# sourceMappingURL=fetch.js.map

package/dist/cjs/src/fetch.js.map

@@ -1 +1 @@
-{"version":3,"file":"fetch.js","sourceRoot":"","sources":["../../../src/fetch.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG;;;;;;;;;;;;;;;;AAaH,4BAEC;AAbD,kDAAgC;AAEhC,oEAGsC;AAEtC;;;GAGG;AACH,SAAgB,QAAQ;IACtB,OAAO,IAAI,qCAAiB,CAAC,kBAAkB,CAAC,CAAC;AACnD,CAAC"}
+{"version":3,"file":"fetch.js","sourceRoot":"","sources":["../../../src/fetch.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG;;;;;;;;;;;;;;;;AAeH,4BAEC;AAmCD,sDAOC;AAzDD,kDAAgC;AAEhC,oEAGsC;AAEtC,8DAAwD;AAExD;;;GAGG;AACH,SAAgB,QAAQ;IACtB,OAAO,IAAI,qCAAiB,CAAC,kBAAkB,CAAC,CAAC;AACnD,CAAC;AAcD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,SAAgB,qBAAqB,CAAC,OAA6B;IACjE,OAAO,IAAA,4BAAW,EAChB,IAAI,qCAAiB,CACnB,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,kBAAkB,CAC3D,EACD,OAAO,CACR,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC;AACpB,CAAC"}

package/dist/cjs/src/generated/version.d.ts

@@ -1,2 +1,2 @@
-export declare const SDK_VERSION = "1.7.2";
+export declare const SDK_VERSION = "1.8.0";
 //# sourceMappingURL=version.d.ts.map

package/dist/cjs/src/generated/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = '1.7.2';
+exports.SDK_VERSION = '1.8.0';
 //# sourceMappingURL=version.js.map

package/dist/cjs/src/lambda.d.ts

@@ -1,7 +1,22 @@
 export * from "./common_api.js";
 import { type LambdaEndpoint } from "./endpoint/lambda_endpoint.js";
+import type { EndpointOptions } from "./endpoint/types.js";
 /**
- * Create a new {@link RestateEndpoint}.
+ * Create a new {@link LambdaEndpoint}.
  */
 export declare function endpoint(): LambdaEndpoint;
+/**
+ * Creates a Lambda handler that encapsulates all the Restate services served by this endpoint.
+ *
+ * @param {EndpointOptions} options - Configuration options for the endpoint handler.
+ * @returns A Lambda handler function.
+ *
+ * @example
+ * A typical endpoint served as Lambda would look like this:
+ * ```
+ * import { createEndpointHandler } from "@restatedev/restate-sdk/lambda";
+ *
+ * export const handler = createEndpointHandler({ services: [myService] })
+ */
+export declare function createEndpointHandler(options: EndpointOptions): (event: any, ctx: any) => Promise<any>;
 //# sourceMappingURL=lambda.d.ts.map

package/dist/cjs/src/lambda.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"lambda.d.ts","sourceRoot":"","sources":["../../../src/lambda.ts"],"names":[],"mappings":"AAWA,cAAc,iBAAiB,CAAC;AAEhC,OAAO,EAEL,KAAK,cAAc,EACpB,MAAM,+BAA+B,CAAC;AAEvC;;GAEG;AACH,wBAAgB,QAAQ,IAAI,cAAc,CAEzC"}
+{"version":3,"file":"lambda.d.ts","sourceRoot":"","sources":["../../../src/lambda.ts"],"names":[],"mappings":"AAWA,cAAc,iBAAiB,CAAC;AAEhC,OAAO,EAEL,KAAK,cAAc,EACpB,MAAM,+BAA+B,CAAC;AACvC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAG3D;;GAEG;AACH,wBAAgB,QAAQ,IAAI,cAAc,CAEzC;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,eAAe,0CAK7D"}

package/dist/cjs/src/lambda.js

@@ -25,12 +25,30 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.endpoint = endpoint;
+exports.createEndpointHandler = createEndpointHandler;
 __exportStar(require("./common_api.js"), exports);
 const lambda_endpoint_js_1 = require("./endpoint/lambda_endpoint.js");
+const withOptions_js_1 = require("./endpoint/withOptions.js");
 /**
- * Create a new {@link RestateEndpoint}.
+ * Create a new {@link LambdaEndpoint}.
  */
 function endpoint() {
     return new lambda_endpoint_js_1.LambdaEndpointImpl();
 }
+/**
+ * Creates a Lambda handler that encapsulates all the Restate services served by this endpoint.
+ *
+ * @param {EndpointOptions} options - Configuration options for the endpoint handler.
+ * @returns A Lambda handler function.
+ *
+ * @example
+ * A typical endpoint served as Lambda would look like this:
+ * ```
+ * import { createEndpointHandler } from "@restatedev/restate-sdk/lambda";
+ *
+ * export const handler = createEndpointHandler({ services: [myService] })
+ */
+function createEndpointHandler(options) {
+    return (0, withOptions_js_1.withOptions)(new lambda_endpoint_js_1.LambdaEndpointImpl(), options).handler();
+}
 //# sourceMappingURL=lambda.js.map

package/dist/cjs/src/lambda.js.map

@@ -1 +1 @@
-{"version":3,"file":"lambda.js","sourceRoot":"","sources":["../../../src/lambda.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG;;;;;;;;;;;;;;;;AAYH,4BAEC;AAZD,kDAAgC;AAEhC,sEAGuC;AAEvC;;GAEG;AACH,SAAgB,QAAQ;IACtB,OAAO,IAAI,uCAAkB,EAAE,CAAC;AAClC,CAAC"}
+{"version":3,"file":"lambda.js","sourceRoot":"","sources":["../../../src/lambda.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG;;;;;;;;;;;;;;;;AAcH,4BAEC;AAeD,sDAKC;AAlCD,kDAAgC;AAEhC,sEAGuC;AAEvC,8DAAwD;AAExD;;GAEG;AACH,SAAgB,QAAQ;IACtB,OAAO,IAAI,uCAAkB,EAAE,CAAC;AAClC,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,qBAAqB,CAAC,OAAwB;IAC5D,OAAO,IAAA,4BAAW,EAChB,IAAI,uCAAkB,EAAE,EACxB,OAAO,CACR,CAAC,OAAO,EAAE,CAAC;AACd,CAAC"}

package/dist/cjs/src/node.d.ts

@@ -0,0 +1,38 @@
+export * from "./common_api.js";
+import type { RestateEndpoint } from "./endpoint.js";
+import type { EndpointOptions } from "./endpoint/types.js";
+/**
+ * Create a new {@link RestateEndpoint}.
+ */
+export declare function endpoint(): RestateEndpoint;
+/**
+ * Creates an HTTP/2 request handler for the provided services.
+ *
+ * @example
+ * ```
+ * const httpServer = http2.createServer(createEndpointHandler({ services: [myService] }));
+ * httpServer.listen(port);
+ * ```
+ * @param {EndpointOptions} options - Configuration options for the endpoint handler.
+ * @returns An HTTP/2 request handler function.
+ */
+export declare function createEndpointHandler(options: EndpointOptions): (request: import("http2").Http2ServerRequest, response: import("http2").Http2ServerResponse) => void;
+export interface ServeOptions extends EndpointOptions {
+    port?: number;
+}
+/**
+ * Serves this Restate services as HTTP2 server, listening to the given port.
+ *
+ * If the port is undefined, this method will use the port set in the `PORT`
+ * environment variable. If that variable is undefined as well, the method will
+ * default to port 9080.
+ *
+ * The returned promise resolves with the bound port when the server starts listening, or rejects with a failure otherwise.
+ *
+ * If you need to manually control the server lifecycle, we suggest to manually instantiate the http2 server and use {@link createEndpointHandler}.
+ *
+ * @param {ServeOptions} options - Configuration options for the endpoint handler.
+ * @returns a Promise that resolves with the bound port, or rejects with a failure otherwise.
+ */
+export declare function serve({ port, ...options }: ServeOptions): Promise<number>;
+//# sourceMappingURL=node.d.ts.map

package/dist/cjs/src/node.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../../src/node.ts"],"names":[],"mappings":"AAWA,cAAc,iBAAiB,CAAC;AAChC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAErD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAG3D;;GAEG;AACH,wBAAgB,QAAQ,IAAI,eAAe,CAE1C;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,eAAe,wGAK7D;AAED,MAAM,WAAW,YAAa,SAAQ,eAAe;IACnD,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,KAAK,CAAC,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,EAAE,YAAY,mBAEvD"}

package/dist/cjs/src/node.js

@@ -0,0 +1,70 @@
+"use strict";
+/*
+ * 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
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.endpoint = endpoint;
+exports.createEndpointHandler = createEndpointHandler;
+exports.serve = serve;
+__exportStar(require("./common_api.js"), exports);
+const node_endpoint_js_1 = require("./endpoint/node_endpoint.js");
+const withOptions_js_1 = require("./endpoint/withOptions.js");
+/**
+ * Create a new {@link RestateEndpoint}.
+ */
+function endpoint() {
+    return new node_endpoint_js_1.NodeEndpoint();
+}
+/**
+ * Creates an HTTP/2 request handler for the provided services.
+ *
+ * @example
+ * ```
+ * const httpServer = http2.createServer(createEndpointHandler({ services: [myService] }));
+ * httpServer.listen(port);
+ * ```
+ * @param {EndpointOptions} options - Configuration options for the endpoint handler.
+ * @returns An HTTP/2 request handler function.
+ */
+function createEndpointHandler(options) {
+    return (0, withOptions_js_1.withOptions)(new node_endpoint_js_1.NodeEndpoint(), options).http2Handler();
+}
+/**
+ * Serves this Restate services as HTTP2 server, listening to the given port.
+ *
+ * If the port is undefined, this method will use the port set in the `PORT`
+ * environment variable. If that variable is undefined as well, the method will
+ * default to port 9080.
+ *
+ * The returned promise resolves with the bound port when the server starts listening, or rejects with a failure otherwise.
+ *
+ * If you need to manually control the server lifecycle, we suggest to manually instantiate the http2 server and use {@link createEndpointHandler}.
+ *
+ * @param {ServeOptions} options - Configuration options for the endpoint handler.
+ * @returns a Promise that resolves with the bound port, or rejects with a failure otherwise.
+ */
+function serve({ port, ...options }) {
+    return (0, withOptions_js_1.withOptions)(new node_endpoint_js_1.NodeEndpoint(), options).listen(port);
+}
+//# sourceMappingURL=node.js.map

package/dist/cjs/src/node.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"node.js","sourceRoot":"","sources":["../../../src/node.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG;;;;;;;;;;;;;;;;AAWH,4BAEC;AAaD,sDAKC;AAoBD,sBAEC;AAnDD,kDAAgC;AAEhC,kEAA2D;AAE3D,8DAAwD;AAExD;;GAEG;AACH,SAAgB,QAAQ;IACtB,OAAO,IAAI,+BAAY,EAAE,CAAC;AAC5B,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,qBAAqB,CAAC,OAAwB;IAC5D,OAAO,IAAA,4BAAW,EAChB,IAAI,+BAAY,EAAE,EAClB,OAAO,CACR,CAAC,YAAY,EAAE,CAAC;AACnB,CAAC;AAMD;;;;;;;;;;;;;GAaG;AACH,SAAgB,KAAK,CAAC,EAAE,IAAI,EAAE,GAAG,OAAO,EAAgB;IACtD,OAAO,IAAA,4BAAW,EAAkB,IAAI,+BAAY,EAAE,EAAE,OAAO,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;AAChF,CAAC"}

package/dist/cjs/src/public_api.d.ts

@@ -1,7 +1,2 @@
-export * from "./common_api.js";
-import type { RestateEndpoint } from "./endpoint.js";
-/**
- * Create a new {@link RestateEndpoint}.
- */
-export declare function endpoint(): RestateEndpoint;
+export * from "./node.js";
 //# sourceMappingURL=public_api.d.ts.map

package/dist/cjs/src/public_api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"public_api.d.ts","sourceRoot":"","sources":["../../../src/public_api.ts"],"names":[],"mappings":"AAWA,cAAc,iBAAiB,CAAC;AAEhC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAGrD;;GAEG;AACH,wBAAgB,QAAQ,IAAI,eAAe,CAE1C"}
+{"version":3,"file":"public_api.d.ts","sourceRoot":"","sources":["../../../src/public_api.ts"],"names":[],"mappings":"AAWA,cAAc,WAAW,CAAC"}

package/dist/cjs/src/public_api.js

@@ -24,13 +24,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.endpoint = endpoint;
-__exportStar(require("./common_api.js"), exports);
-const node_endpoint_js_1 = require("./endpoint/node_endpoint.js");
-/**
- * Create a new {@link RestateEndpoint}.
- */
-function endpoint() {
-    return new node_endpoint_js_1.NodeEndpoint();
-}
+__exportStar(require("./node.js"), exports);
 //# sourceMappingURL=public_api.js.map

package/dist/cjs/src/public_api.js.map

@@ -1 +1 @@
-{"version":3,"file":"public_api.js","sourceRoot":"","sources":["../../../src/public_api.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG;;;;;;;;;;;;;;;;AAUH,4BAEC;AAVD,kDAAgC;AAGhC,kEAA2D;AAE3D;;GAEG;AACH,SAAgB,QAAQ;IACtB,OAAO,IAAI,+BAAY,EAAE,CAAC;AAC5B,CAAC"}
+{"version":3,"file":"public_api.js","sourceRoot":"","sources":["../../../src/public_api.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG;;;;;;;;;;;;;;;;AAEH,4CAA0B"}

package/dist/cjs/src/types/errors.d.ts

@@ -1,10 +1,11 @@
+import type { Duration } from "@restatedev/restate-sdk-core";
 export declare const INTERNAL_ERROR_CODE = 500;
 export declare const TIMEOUT_ERROR_CODE = 408;
 export declare const CANCEL_ERROR_CODE = 409;
 export declare const UNKNOWN_ERROR_CODE = 500;
 export declare const CLOSED_ERROR_CODE = 598;
 export declare const SUSPENDED_ERROR_CODE = 599;
-export declare function ensureError(e: unknown): Error;
+export declare function ensureError(e: unknown, asTerminalError?: (error: any) => TerminalError | undefined): Error;
 export declare function logError(log: Console, e: unknown): void;
 export declare class RestateError extends Error {
     readonly code: number;
@@ -14,19 +15,60 @@ export declare class RestateError extends Error {
         cause?: any;
     });
 }
+/**
+ * Does not lead to Restate retries.
+ *
+ * Leads to an output message with a failure defined.
+ */
 export declare class TerminalError extends RestateError {
     name: string;
     constructor(message: string, options?: {
+        /**
+         * Error code. This should be an HTTP status code, and in case the service was invoked from the ingress, this will be propagated back to the caller.
+         */
         errorCode?: number;
+        /**
+         * @deprecated YOU MUST NOT USE THIS FIELD, AS IT WON'T BE RECORDED AND CAN LEAD TO NON-DETERMINISM! From the next SDK version, the constructor won't accept this field anymore.
+         */
         cause?: any;
     });
 }
+/**
+ * Returned by `RestatePromise.withTimeout` when the timeout is reached.
+ */
 export declare class TimeoutError extends TerminalError {
     name: string;
     constructor();
 }
+/**
+ * Returned when the invocation was cancelled.
+ */
 export declare class CancelledError extends TerminalError {
     name: string;
     constructor();
 }
+export interface RetryableErrorOptions {
+    /**
+     * In how long it should retry.
+     */
+    retryAfter?: Duration | number;
+}
+/**
+ * Error that Restate will retry. By using this error type within a `ctx.run` closure,
+ * you can dynamically provide the retry delay specified in {@link RetryableErrorOptions}.
+ *
+ * You can wrap another error using {@link from}.
+ */
+export declare class RetryableError extends RestateError {
+    name: string;
+    readonly retryAfter?: Duration | number;
+    constructor(message: string, options?: RetryableErrorOptions & {
+        errorCode?: number;
+        cause?: any;
+    });
+    /**
+     * Create a `RetryableError` from the given cause.
+     */
+    static from(cause: any, options?: RetryableErrorOptions): RetryableError;
+}
 //# sourceMappingURL=errors.d.ts.map

package/dist/cjs/src/types/errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../../../src/types/errors.ts"],"names":[],"mappings":"AAaA,eAAO,MAAM,mBAAmB,MAAM,CAAC;AACvC,eAAO,MAAM,kBAAkB,MAAM,CAAC;AACtC,eAAO,MAAM,iBAAiB,MAAM,CAAC;AACrC,eAAO,MAAM,kBAAkB,MAAM,CAAC;AAGtC,eAAO,MAAM,iBAAiB,MAAM,CAAC;AACrC,eAAO,MAAM,oBAAoB,MAAM,CAAC;AAExC,wBAAgB,WAAW,CAAC,CAAC,EAAE,OAAO,GAAG,KAAK,CAmB7C;AAED,wBAAgB,QAAQ,CAAC,GAAG,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,QAiBhD;AAED,qBAAa,YAAa,SAAQ,KAAK;IACrC,SAAgB,IAAI,EAAE,MAAM,CAAC;IACtB,IAAI,SAAkB;gBAEjB,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,GAAG,CAAA;KAAE;CAI3E;AAID,qBAAa,aAAc,SAAQ,YAAY;IACtC,IAAI,SAAmB;gBAElB,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,GAAG,CAAA;KAAE;CAG3E;AAED,qBAAa,YAAa,SAAQ,aAAa;IACtC,IAAI,SAAkB;;CAK9B;AAED,qBAAa,cAAe,SAAQ,aAAa;IACxC,IAAI,SAAoB;;CAKhC"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../../../src/types/errors.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AAE7D,eAAO,MAAM,mBAAmB,MAAM,CAAC;AACvC,eAAO,MAAM,kBAAkB,MAAM,CAAC;AACtC,eAAO,MAAM,iBAAiB,MAAM,CAAC;AACrC,eAAO,MAAM,kBAAkB,MAAM,CAAC;AAGtC,eAAO,MAAM,iBAAiB,MAAM,CAAC;AACrC,eAAO,MAAM,oBAAoB,MAAM,CAAC;AAExC,wBAAgB,WAAW,CACzB,CAAC,EAAE,OAAO,EACV,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,aAAa,GAAG,SAAS,GAC1D,KAAK,CA6BP;AAED,wBAAgB,QAAQ,CAAC,GAAG,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,QAiBhD;AAED,qBAAa,YAAa,SAAQ,KAAK;IACrC,SAAgB,IAAI,EAAE,MAAM,CAAC;IACtB,IAAI,SAAkB;gBAEjB,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,GAAG,CAAA;KAAE;CAI3E;AAED;;;;GAIG;AACH,qBAAa,aAAc,SAAQ,YAAY;IACtC,IAAI,SAAmB;gBAG5B,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE;QACR;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB;;WAEG;QACH,KAAK,CAAC,EAAE,GAAG,CAAC;KACb;CAIJ;AAED;;GAEG;AACH,qBAAa,YAAa,SAAQ,aAAa;IACtC,IAAI,SAAkB;;CAK9B;AAED;;GAEG;AACH,qBAAa,cAAe,SAAQ,aAAa;IACxC,IAAI,SAAoB;;CAKhC;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,UAAU,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;CAChC;AAED;;;;;GAKG;AACH,qBAAa,cAAe,SAAQ,YAAY;IACvC,IAAI,SAAoB;IAE/B,QAAQ,CAAC,UAAU,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;gBAGtC,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,qBAAqB,GAAG;QAChC,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,KAAK,CAAC,EAAE,GAAG,CAAC;KACb;IAUH;;OAEG;IACH,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,cAAc;CAQzE"}

package/dist/cjs/src/types/errors.js

@@ -10,10 +10,9 @@
  * https://github.com/restatedev/sdk-typescript/blob/main/LICENSE
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CancelledError = exports.TimeoutError = exports.TerminalError = exports.RestateError = exports.SUSPENDED_ERROR_CODE = exports.CLOSED_ERROR_CODE = exports.UNKNOWN_ERROR_CODE = exports.CANCEL_ERROR_CODE = exports.TIMEOUT_ERROR_CODE = exports.INTERNAL_ERROR_CODE = void 0;
+exports.RetryableError = exports.CancelledError = exports.TimeoutError = exports.TerminalError = exports.RestateError = exports.SUSPENDED_ERROR_CODE = exports.CLOSED_ERROR_CODE = exports.UNKNOWN_ERROR_CODE = exports.CANCEL_ERROR_CODE = exports.TIMEOUT_ERROR_CODE = exports.INTERNAL_ERROR_CODE = void 0;
 exports.ensureError = ensureError;
 exports.logError = logError;
-/* eslint-disable @typescript-eslint/no-explicit-any */
 exports.INTERNAL_ERROR_CODE = 500;
 exports.TIMEOUT_ERROR_CODE = 408;
 exports.CANCEL_ERROR_CODE = 409;
@@ -21,7 +20,15 @@ exports.UNKNOWN_ERROR_CODE = 500;
 // From shared core!
 exports.CLOSED_ERROR_CODE = 598;
 exports.SUSPENDED_ERROR_CODE = 599;
-function ensureError(e) {
+function ensureError(e, asTerminalError) {
+    if (e instanceof TerminalError) {
+        return e;
+    }
+    // Try convert to terminal error
+    const maybeTerminalError = asTerminalError ? asTerminalError(e) : undefined;
+    if (maybeTerminalError) {
+        return maybeTerminalError;
+    }
     if (e instanceof Error) {
         return e;
     }
@@ -31,6 +38,7 @@ function ensureError(e) {
             errorCode: e.code,
         });
     }
+    // None of the types we know
     let msg;
     try {
         msg = JSON.stringify(e);
@@ -65,8 +73,11 @@ class RestateError extends Error {
     }
 }
 exports.RestateError = RestateError;
-// Does not lead to Restate retries
-// Leads to an output message with a failure defined
+/**
+ * Does not lead to Restate retries.
+ *
+ * Leads to an output message with a failure defined.
+ */
 class TerminalError extends RestateError {
     name = "TerminalError";
     constructor(message, options) {
@@ -74,6 +85,9 @@ class TerminalError extends RestateError {
     }
 }
 exports.TerminalError = TerminalError;
+/**
+ * Returned by `RestatePromise.withTimeout` when the timeout is reached.
+ */
 class TimeoutError extends TerminalError {
     name = "TimeoutError";
     constructor() {
@@ -81,6 +95,9 @@ class TimeoutError extends TerminalError {
     }
 }
 exports.TimeoutError = TimeoutError;
+/**
+ * Returned when the invocation was cancelled.
+ */
 class CancelledError extends TerminalError {
     name = "CancelledError";
     constructor() {
@@ -88,4 +105,34 @@ class CancelledError extends TerminalError {
     }
 }
 exports.CancelledError = CancelledError;
+/**
+ * Error that Restate will retry. By using this error type within a `ctx.run` closure,
+ * you can dynamically provide the retry delay specified in {@link RetryableErrorOptions}.
+ *
+ * You can wrap another error using {@link from}.
+ */
+class RetryableError extends RestateError {
+    name = "RetryableError";
+    retryAfter;
+    constructor(message, options) {
+        super(message, {
+            errorCode: options?.errorCode,
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+            cause: options?.cause,
+        });
+        this.retryAfter = options?.retryAfter;
+    }
+    /**
+     * Create a `RetryableError` from the given cause.
+     */
+    static from(cause, options) {
+        const error = ensureError(cause);
+        return new RetryableError(error.message, {
+            errorCode: error["errorCode"],
+            cause: cause,
+            ...options,
+        });
+    }
+}
+exports.RetryableError = RetryableError;
 //# sourceMappingURL=errors.js.map