@dbos-inc/koa-serve 2.11.7-preview.gc208400219 → 2.11.13-preview

package/README.md

@@ -1 +1,280 @@
-# DBOS HTTP Integration
+# Serve DBOS Functions over HTTP with Koa
+
+## Introduction
+
+[DBOS](https://github.com/dbos-inc/dbos-transact-ts) provides a lightweight durable execution framework that can be used as a library within any app. This package provides a simple way to serve DBOS functions with the [Koa](https://koajs.com/) web framework.
+
+## Registering Endpoints
+
+First, create an instance of `DBOSKoa`. This object is used to keep track of which functions are to be registered with routable URLs, so it is OK to create and use it very early in your code. Then, use this instance to register some HTTP endpoint URLs.
+
+```typescript
+const dhttp = new DBOSKoa();
+
+export class HTTPEndpoints {
+  @dhttp.getApi('/foobar')
+  static async foobar(arg: string) {
+    return Promise.resolve(`Value of 'arg': ${arg}`);
+  }
+}
+```
+
+The example above registers an HTTP `GET` endpoint. `postApi`, `deleteApi`, `putApi`, and `patchApi` are also available.
+
+## Starting a Koa App
+
+The Koa server can be started by your main startup function. Note the order of operations below:
+
+```typescript
+DBOS.registerLifecycleCallback(dhttp); // Registers the HTTP function provider with DBOS
+await DBOS.launch(); // Starts DBOS components and begins any necessary recovery
+DBOS.logRegisteredEndpoints(); // Optional - list out all of the registered DBOS event receivers and URLs
+
+// Create a new Koa and router
+app = new Koa();
+appRouter = new Router();
+
+// Add any URLs and middleware registered via DBOS with your Koa
+dhttp.registerWithApp(app, appRouter);
+
+// Tell Koa to serve on port 3000
+app.listen(3000, () => {
+  console.log('Server running on http://localhost:3000');
+});
+```
+
+## Integrating With an Existing App
+
+If you already have a Koa server in your app, you can add the DBOS HTTP endpoints to it:
+
+```
+    dhttp.registerWithApp(app, appRouter);
+```
+
+You should also be sure to call `DBOS.launch` at some point prior to starting request handling.
+
+Node.js HTTP servers are also generally compatible with each other. Your Koa's `app.callback()` can be served within another framework (such as [express](https://expressjs.com/)), or by a HTTP server you set up.
+
+## Inputs and HTTP Requests
+
+When a function has arguments, DBOS automatically parses them from the HTTP request, and returns an error to the client if they are not found.
+
+Automatic argument handling is usually sufficent. If not, see the sections below.
+
+### URL Path Parameters
+
+You can include a path parameter placeholder in a URL by prefixing it with a colon, like `name` in this example:
+
+```typescript
+@dhttp.getApi('/greeting/:name')
+static async greetingEndpoint(name: string) {
+  return `Greeting, ${name}`;
+}
+```
+
+Then, give your method an argument with a matching name (such as `name: string` above) and it is automatically parsed from the path parameter.
+
+For example, if we send our app this request, then our method is called with `name` set to `dbos`:
+
+```
+GET /greeting/dbos
+```
+
+### URL Query String Parameters
+
+`GET` and `DELETE` endpoints automatically parse arguments from query strings.
+
+For example, the following endpoint expects the `id` and `name` parameters to be passed through a query string:
+
+```typescript
+@dhttp.getApi('/example')
+static async exampleGet(id: number, name: string) {
+  return `${id} and ${name} are parsed from URL query string parameters`;
+}
+```
+
+If we send our app this request, then our method is called with `id` set to `123` and `name` set to `dbos`:
+
+```
+GET /example?id=123&name=dbos
+```
+
+### HTTP Body Fields
+
+`POST`, `PATCH`, and `PUT` endpoints automatically parse arguments from the HTTP request body.
+
+For example, the following endpoint expects the `id` and `name` parameters to be passed through the HTTP request body:
+
+```typescript
+@DBOS.postApi('/example')
+static async examplePost(id: number, name: string) {
+  return `${id} and ${name} are parsed from the HTTP request body`;
+}
+```
+
+If we send our app this request, then our method is called with `id` set to `123` and `name` set to `dbos`:
+
+```javascript
+POST /example
+Content-Type: application/json
+{
+  "name": "dbos",
+  "id": 123
+}
+```
+
+When sending an HTTP request with a JSON body, make sure you set the [`Content-Type`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type) header to `application/json`.
+
+### Overriding Argument Sources
+
+Argument sources can be overriden with the `DBOSKoa.argSource` parameter decorator. For example, to force a POST parameter to be taken from the query string instead of the body:
+
+```typescript
+  @dhttp.postApi('/postquery')
+  static async postQuery(@DBOSKoa.argSource(ArgSources.QUERY) name: string) {
+    return Promise.resolve(`hello ${name}`);
+  }
+```
+
+## Raw Requests
+
+If you need finer-grained request parsing, any DBOS method invoked via HTTP request can access raw request information from `DBOSKoa.httpRequest`. This returns the following information:
+
+```typescript
+interface HTTPRequest {
+  readonly headers?: IncomingHttpHeaders; // A node's http.IncomingHttpHeaders object.
+  readonly rawHeaders?: string[]; // Raw headers.
+  readonly params?: unknown; // Parsed path parameters from the URL.
+  readonly body?: unknown; // parsed HTTP body as an object.
+  readonly rawBody?: string; // Unparsed raw HTTP body string.
+  readonly query?: ParsedUrlQuery; // Parsed query string.
+  readonly querystring?: string; // Unparsed raw query string.
+  readonly url?: string; // Request URL.
+  readonly ip?: string; // Request remote address.
+}
+```
+
+### Accessing the Koa Context
+
+For code that needs to access the Koa context to perform a redirect, send a large response, etc., this can be accessed with `DBOSKoa.koaContext`:
+
+```typescript
+DBOSKoa.koaContext.redirect(url + '-dbos');
+```
+
+## Outputs and HTTP Responses
+
+If a function invoked via HTTP request returns successfully, its return value is sent in the HTTP response body with status code `200` (or `204` if nothing is returned).
+
+If the function throws an exception, the error message is sent in the response body with a `400` or `500` status code.
+If the error contains a `status` field, the response uses that status code instead.
+
+If you need custom HTTP response behavior, you can access the HTTP response directly via [`DBOSKoa.koaContext.response`].
+
+## Koa Middleware
+
+Middleware may be set up directly on the Koa app or router. Additionally, DBOS provides class-level decorators for placing middleware onto all URLs registered to methods in the class.
+
+DBOS supports running arbitrary [Koa](https://koajs.com/) middleware for serving HTTP requests.
+Middlewares are configured at the class level through the `@DBOSKoa.koaMiddleware` decorator.
+Here is an example of a simple middleware checking an HTTP header:
+
+```typescript
+import { Middleware } from "koa";
+
+const middleware: Middleware = async (ctx, next) => {
+  const contentType = ctx.request.headers["content-type"];
+  await next();
+};
+
+@dhttp.koaMiddleware(middleware)
+class Hello {
+  ...
+}
+```
+
+### CORS
+
+[Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is a security feature that controls access to resources from different domains. DBOS uses [`@koa/cors`](https://github.com/koajs/cors) with a permissive default configuration.
+
+If more complex logic is needed, or if the CORS configuration differs between operation classes, the `@DBOSKoa.koaCors` class-level decorator can be used to specify the CORS middleware in full.
+
+```typescript
+import cors from '@koa/cors';
+
+@dhttp.koaCors(
+  cors({
+    credentials: true,
+    origin: (o: Context) => {
+      const whitelist = ['https://us.com', 'https://partner.com'];
+      const origin = o.request.header.origin ?? '*';
+      return whitelist.includes(origin) ? origin : '';
+    },
+  }),
+)
+class EndpointsWithSpecialCORS {}
+```
+
+### BodyParser
+
+By default, DBOS uses [`@koa/bodyparser`](https://github.com/koajs/bodyparser) to support JSON in requests. If this default behavior is not desired, you can configure a custom body parser with the `@DBOSKoa.koaBodyParser` decorator.
+
+```typescript
+import { bodyParser } from '@koa/bodyparser';
+
+@dhttp.koaBodyParser(
+  bodyParser({
+    extendTypes: {
+      json: ['application/json', 'application/custom-content-type'],
+    },
+    encoding: 'utf-8',
+  }),
+)
+class OperationEndpoints {}
+```
+
+### Integration With DBOS User Authentication / Authorization
+
+DBOS provides [role-based authorization](https://docs.dbos.dev/typescript/reference/transactapi/dbos-class#declarative-role-based-security). This package provides a middleware-based approach for collecting authentication information, to populate the authenticated user and allowed roles.
+
+First, define an authentication middleware function:
+
+```typescript
+async function authTestMiddleware(ctx: DBOSKoaAuthContext) {
+  if (ctx.requiredRole.length > 0) {
+    const { userid } = ctx.koaContext.request.query; // Or other source of user from request, header, cookie, etc.
+    const uid = userid?.toString();
+
+    if (!uid || uid.length === 0) {
+      return Promise.reject(new DBOSError.DBOSNotAuthorizedError('Not logged in.', 401));
+    } else {
+      if (uid === 'unwelcome') {
+        return Promise.reject(new DBOSError.DBOSNotAuthorizedError('Go away.', 401));
+      }
+      return Promise.resolve({
+        authenticatedUser: uid,
+        authenticatedRoles: uid === 'a_real_user' ? ['user'] : ['other'],
+      });
+    }
+  }
+  return;
+}
+```
+
+Then, attach it to the classes as a middleware:
+
+```typescript
+@DBOS.defaultRequiredRole(['user'])
+@dhttp.authentication(authTestMiddleware)
+class EndpointsWithAuthMiddleware {
+  // ...
+}
+```
+
+### Global Middleware
+
+Middleware that is to be run on all routes should be directly added to your Koa app or router. However, for compatibility with prior "serverless" DBOS SDKs, a `@DBOSKoa.koaGlobalMiddleware` decorator exists.
+
+## Unit Testing
+
+DBOS HTTP functions are easily called in existing test frameworks. See [the unit tests](./tests/basic.test.ts) for examples of setting up DBOS and calling `app.callback()` using `jest` and `supertest`.

package/dist/src/dboshttp.d.ts

@@ -69,8 +69,8 @@ export declare class DBOSHTTPBase extends DBOSLifecycleCallback {
     /** Decorator indicating that the method is the target of HTTP DELETE operations for `url` */
     deleteApi(url: string): <This, Args extends unknown[], Return>(target: object, propertyKey: string, descriptor: TypedPropertyDescriptor<(this: This, ...args: Args) => Promise<Return>>) => TypedPropertyDescriptor<(this: This, ...args: Args) => Promise<Return>>;
     /** Parameter decorator indicating which source to use (URL, BODY, etc) for arg data */
-    argSource(source: ArgSources): (target: object, propertyKey: string | symbol, parameterIndex: number) => void;
-    getArgSource(arg: MethodParameter): ArgSources;
+    static argSource(source: ArgSources): (target: object, propertyKey: string | symbol, parameterIndex: number) => void;
+    protected getArgSource(arg: MethodParameter): ArgSources;
     logRegisteredEndpoints(): void;
     static argRequired(target: object, propertyKey: string | symbol, parameterIndex: number): void;
     static argOptional(target: object, propertyKey: string | symbol, parameterIndex: number): void;

package/dist/src/dboshttp.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dboshttp.d.ts","sourceRoot":"","sources":["../../src/dboshttp.ts"],"names":[],"mappings":";;;AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,MAAM,CAAC;AAC3C,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAG7C,OAAO,EAEL,qBAAqB,EAErB,eAAe,EAShB,MAAM,oBAAoB,CAAC;AAE5B,oBAAY,QAAQ;IAClB,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,GAAG,QAAQ;IACX,KAAK,UAAU;IACf,MAAM,WAAW;CAClB;AAED,oBAAY,UAAU;IACpB,IAAI,SAAS,CAAE,mBAAmB;IAClC,OAAO,YAAY,CAAE,4CAA4C;IACjE,IAAI,SAAS,CAAE,oBAAoB;IACnC,KAAK,UAAU;CAChB;AAED,MAAM,WAAW,kBAAkB;IACjC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,kBAAkB,EAAE,MAAM,EAAE,CAAC;CAC9B;AAED,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,QAAQ,CAAC;CACnB;AAED,MAAM,WAAW,kBAAkB;IACjC,aAAa,CAAC,EAAE,WAAW,EAAE,CAAC;CAC/B;AAED,MAAM,WAAW,eAAe;IAC9B,SAAS,CAAC,EAAE,UAAU,CAAC;CACxB;AAqBD;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,OAAO,CAAC,EAAE,mBAAmB,CAAC;IACvC,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IAC/B,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,KAAK,CAAC,EAAE,cAAc,CAAC;IAChC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,eAAO,MAAM,QAAQ,aAAa,CAAC;AAEnC,eAAO,MAAM,gBAAgB,yBAAyB,CAAC;AAEvD,eAAO,MAAM,eAAe,iBAAiB,CAAC;AAC9C,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,mBAAmB,GAAG,MAAM,CAQ3E;AAED,wBAAgB,oBAAoB,CAAC,CAAC,EAAE,KAAK,WAE5C;AAID,qBAAa,YAAa,SAAQ,qBAAqB;IACrD,MAAM,CAAC,mBAAmB,EAAE,MAAM,CAAU;IAE5C,MAAM,KAAK,WAAW,IAAI,eAAe,CAMxC;IAED,UAAU,CAAC,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,kDAI1B,MAAM,eACD,MAAM,cACP,wBAAwB,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,IAAI,KAAK,QAAQ,MAAM,CAAC,CAAC,oCAAxC,IAAI,WAAW,IAAI,KAAK,QAAQ,MAAM,CAAC;IAkBtF,0FAA0F;IAC1F,MAAM,CAAC,GAAG,EAAE,MAAM;IAIlB,2FAA2F;IAC3F,OAAO,CAAC,GAAG,EAAE,MAAM;IAInB,0FAA0F;IAC1F,MAAM,CAAC,GAAG,EAAE,MAAM;IAIlB,4FAA4F;IAC5F,QAAQ,CAAC,GAAG,EAAE,MAAM;IAIpB,6FAA6F;IAC7F,SAAS,CAAC,GAAG,EAAE,MAAM;IAIrB,uFAAuF;IACvF,SAAS,CAAC,MAAM,EAAE,UAAU,YACD,MAAM,eAAe,MAAM,GAAG,MAAM,kBAAkB,MAAM;IAgBvF,YAAY,CAAC,GAAG,EAAE,eAAe;IAKxB,sBAAsB,IAAI,IAAI;IAmBvC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,cAAc,EAAE,MAAM;IAIvF,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,cAAc,EAAE,MAAM;IAIvF,MAAM,CAAC,OAAO;IAGd,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,MAAM;IAI3B,MAAM,CAAC,kBAAkB,CAAC,CAAC,SAAS;QAAE,KAAK,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,MAAM,CAAA;KAAE,EAAE,IAAI,EAAE,CAAC;IAGjF,MAAM,CAAC,kBAAkB,CAAC,CAAC,SAAS;QAAE,KAAK,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,MAAM,CAAA;KAAE,EAAE,IAAI,EAAE,CAAC;IAGjF,MAAM,CAAC,kBAAkB,CAAC,CAAC,SAAS;QAAE,KAAK,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,MAAM,CAAA;KAAE,EAAE,IAAI,EAAE,CAAC;CAGlF"}
+{"version":3,"file":"dboshttp.d.ts","sourceRoot":"","sources":["../../src/dboshttp.ts"],"names":[],"mappings":";;;AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,MAAM,CAAC;AAC3C,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAG7C,OAAO,EAEL,qBAAqB,EAErB,eAAe,EAShB,MAAM,oBAAoB,CAAC;AAE5B,oBAAY,QAAQ;IAClB,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,GAAG,QAAQ;IACX,KAAK,UAAU;IACf,MAAM,WAAW;CAClB;AAED,oBAAY,UAAU;IACpB,IAAI,SAAS,CAAE,mBAAmB;IAClC,OAAO,YAAY,CAAE,4CAA4C;IACjE,IAAI,SAAS,CAAE,oBAAoB;IACnC,KAAK,UAAU;CAChB;AAED,MAAM,WAAW,kBAAkB;IACjC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,kBAAkB,EAAE,MAAM,EAAE,CAAC;CAC9B;AAED,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,QAAQ,CAAC;CACnB;AAED,MAAM,WAAW,kBAAkB;IACjC,aAAa,CAAC,EAAE,WAAW,EAAE,CAAC;CAC/B;AAED,MAAM,WAAW,eAAe;IAC9B,SAAS,CAAC,EAAE,UAAU,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,OAAO,CAAC,EAAE,mBAAmB,CAAC;IACvC,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IAC/B,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,KAAK,CAAC,EAAE,cAAc,CAAC;IAChC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,eAAO,MAAM,QAAQ,aAAa,CAAC;AAEnC,eAAO,MAAM,gBAAgB,yBAAyB,CAAC;AAEvD,eAAO,MAAM,eAAe,iBAAiB,CAAC;AAC9C,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,mBAAmB,GAAG,MAAM,CAQ3E;AAED,wBAAgB,oBAAoB,CAAC,CAAC,EAAE,KAAK,WAE5C;AAED,qBAAa,YAAa,SAAQ,qBAAqB;IACrD,MAAM,CAAC,mBAAmB,EAAE,MAAM,CAAU;IAE5C,MAAM,KAAK,WAAW,IAAI,eAAe,CAMxC;IAED,UAAU,CAAC,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,kDAI1B,MAAM,eACD,MAAM,cACP,wBAAwB,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,IAAI,KAAK,QAAQ,MAAM,CAAC,CAAC,oCAAxC,IAAI,WAAW,IAAI,KAAK,QAAQ,MAAM,CAAC;IAkBtF,0FAA0F;IAC1F,MAAM,CAAC,GAAG,EAAE,MAAM;IAIlB,2FAA2F;IAC3F,OAAO,CAAC,GAAG,EAAE,MAAM;IAInB,0FAA0F;IAC1F,MAAM,CAAC,GAAG,EAAE,MAAM;IAIlB,4FAA4F;IAC5F,QAAQ,CAAC,GAAG,EAAE,MAAM;IAIpB,6FAA6F;IAC7F,SAAS,CAAC,GAAG,EAAE,MAAM;IAIrB,uFAAuF;IACvF,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,UAAU,YACR,MAAM,eAAe,MAAM,GAAG,MAAM,kBAAkB,MAAM;IAgBvF,SAAS,CAAC,YAAY,CAAC,GAAG,EAAE,eAAe;IAKlC,sBAAsB,IAAI,IAAI;IAmBvC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,cAAc,EAAE,MAAM;IAIvF,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,cAAc,EAAE,MAAM;IAIvF,MAAM,CAAC,OAAO;IAGd,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,MAAM;IAI3B,MAAM,CAAC,kBAAkB,CAAC,CAAC,SAAS;QAAE,KAAK,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,MAAM,CAAA;KAAE,EAAE,IAAI,EAAE,CAAC;IAGjF,MAAM,CAAC,kBAAkB,CAAC,CAAC,SAAS;QAAE,KAAK,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,MAAM,CAAA;KAAE,EAAE,IAAI,EAAE,CAAC;IAGjF,MAAM,CAAC,kBAAkB,CAAC,CAAC,SAAS;QAAE,KAAK,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,MAAM,CAAA;KAAE,EAAE,IAAI,EAAE,CAAC;CAGlF"}

package/dist/src/dboshttp.js

@@ -18,12 +18,6 @@ var ArgSources;
     ArgSources["BODY"] = "BODY";
     ArgSources["QUERY"] = "QUERY";
 })(ArgSources || (exports.ArgSources = ArgSources = {}));
-var ArgRequiredOptions;
-(function (ArgRequiredOptions) {
-    ArgRequiredOptions["REQUIRED"] = "REQUIRED";
-    ArgRequiredOptions["OPTIONAL"] = "OPTIONAL";
-    ArgRequiredOptions["DEFAULT"] = "DEFAULT";
-})(ArgRequiredOptions || (ArgRequiredOptions = {}));
 exports.DBOSHTTP = 'dboshttp';
 exports.WorkflowIDHeader = 'dbos-idempotency-key';
 exports.RequestIDHeader = 'X-Request-ID';
@@ -41,7 +35,6 @@ function isClientRequestError(e) {
     return dbos_sdk_1.Error.isDataValidationError(e);
 }
 exports.isClientRequestError = isClientRequestError;
-const VALIDATOR = 'validator';
 class DBOSHTTPBase extends dbos_sdk_1.DBOSLifecycleCallback {
     static HTTP_OPERATION_TYPE = 'http';
     static get httpRequest() {
@@ -91,7 +84,7 @@ class DBOSHTTPBase extends dbos_sdk_1.DBOSLifecycleCallback {
         return this.httpApiDec(APITypes.DELETE, url);
     }
     /** Parameter decorator indicating which source to use (URL, BODY, etc) for arg data */
-    argSource(source) {
+    static argSource(source) {
         return function (target, propertyKey, parameterIndex) {
             const curParam = dbos_sdk_1.DBOS.associateParamWithInfo(exports.DBOSHTTP, 
             // eslint-disable-next-line @typescript-eslint/no-unsafe-argument

package/dist/src/dboshttp.js.map

@@ -1 +1 @@
-{"version":3,"file":"dboshttp.js","sourceRoot":"","sources":["../../src/dboshttp.ts"],"names":[],"mappings":";;;AAEA,6CAAyC;AAEzC,iDAa4B;AAE5B,IAAY,QAMX;AAND,WAAY,QAAQ;IAClB,uBAAW,CAAA;IACX,yBAAa,CAAA;IACb,uBAAW,CAAA;IACX,2BAAe,CAAA;IACf,6BAAiB,CAAA;AACnB,CAAC,EANW,QAAQ,wBAAR,QAAQ,QAMnB;AAED,IAAY,UAKX;AALD,WAAY,UAAU;IACpB,2BAAa,CAAA;IACb,iCAAmB,CAAA;IACnB,2BAAa,CAAA;IACb,6BAAe,CAAA;AACjB,CAAC,EALW,UAAU,0BAAV,UAAU,QAKrB;AAoBD,IAAK,kBAIJ;AAJD,WAAK,kBAAkB;IACrB,2CAAqB,CAAA;IACrB,2CAAqB,CAAA;IACrB,yCAAmB,CAAA;AACrB,CAAC,EAJI,kBAAkB,KAAlB,kBAAkB,QAItB;AAkCY,QAAA,QAAQ,GAAG,UAAU,CAAC;AAEtB,QAAA,gBAAgB,GAAG,sBAAsB,CAAC;AAE1C,QAAA,eAAe,GAAG,cAAc,CAAC;AAC9C,SAAgB,sBAAsB,CAAC,OAA4B;IACjE,MAAM,KAAK,GAAG,OAAO,CAAC,uBAAe,CAAC,WAAW,EAAE,CAAuB,CAAC,CAAC,uGAAuG;IACnL,IAAI,KAAK,EAAE,CAAC;QACV,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,KAAK,GAAG,IAAA,wBAAU,GAAE,CAAC;IAC3B,OAAO,CAAC,uBAAe,CAAC,WAAW,EAAE,CAAC,GAAG,KAAK,CAAC,CAAC,2CAA2C;IAC3F,OAAO,KAAK,CAAC;AACf,CAAC;AARD,wDAQC;AAED,SAAgB,oBAAoB,CAAC,CAAQ;IAC3C,OAAO,gBAAU,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;AAC7C,CAAC;AAFD,oDAEC;AAED,MAAM,SAAS,GAAG,WAAW,CAAC;AAE9B,MAAa,YAAa,SAAQ,gCAAqB;IACrD,MAAM,CAAC,mBAAmB,GAAW,MAAM,CAAC;IAE5C,MAAM,KAAK,WAAW;QACpB,MAAM,GAAG,GAAG,eAAI,CAAC,aAAa,EAAE,CAAC;QACjC,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;YACtB,MAAM,IAAI,SAAS,CAAC,+DAA+D,CAAC,CAAC;QACvF,CAAC;QACD,OAAO,GAAsB,CAAC;IAChC,CAAC;IAED,UAAU,CAAC,IAAc,EAAE,GAAW;QACpC,4DAA4D;QAC5D,MAAM,EAAE,GAAG,IAAI,CAAC;QAChB,OAAO,SAAS,MAAM,CACpB,MAAc,EACd,WAAmB,EACnB,UAAmF;YAEnF,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,GAAG,eAAI,CAAC,yBAAyB,CAAC,EAAE,EAAE,UAAU,CAAC,KAAM,EAAE;gBACtF,WAAW,EAAE,MAAM;gBACnB,IAAI,EAAE,WAAW;aAClB,CAAC,CAAC;YACH,MAAM,mBAAmB,GAAG,OAA6B,CAAC;YAC1D,IAAI,CAAC,mBAAmB,CAAC,aAAa;gBAAE,mBAAmB,CAAC,aAAa,GAAG,EAAE,CAAC;YAC/E,mBAAmB,CAAC,aAAa,CAAC,IAAI,CAAC;gBACrC,MAAM,EAAE,GAAG;gBACX,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;YACH,IAAA,+BAAoB,EAAC,YAAY,CAAC,CAAC;YAEnC,OAAO,UAAU,CAAC;QACpB,CAAC,CAAC;IACJ,CAAC;IAED,0FAA0F;IAC1F,MAAM,CAAC,GAAW;QAChB,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAC5C,CAAC;IAED,2FAA2F;IAC3F,OAAO,CAAC,GAAW;QACjB,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAC7C,CAAC;IAED,0FAA0F;IAC1F,MAAM,CAAC,GAAW;QAChB,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAC5C,CAAC;IAED,4FAA4F;IAC5F,QAAQ,CAAC,GAAW;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAC9C,CAAC;IAED,6FAA6F;IAC7F,SAAS,CAAC,GAAW;QACnB,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC/C,CAAC;IAED,uFAAuF;IACvF,SAAS,CAAC,MAAkB;QAC1B,OAAO,UAAU,MAAc,EAAE,WAA4B,EAAE,cAAsB;YACnF,MAAM,QAAQ,GAAG,eAAI,CAAC,sBAAsB,CAC1C,gBAAQ;YACR,iEAAiE;YACjE,MAAM,CAAC,wBAAwB,CAAC,MAAM,EAAE,WAAW,CAAE,CAAC,KAAK,EAC3D;gBACE,WAAW,EAAE,MAAM;gBACnB,IAAI,EAAE,WAAW,CAAC,QAAQ,EAAE;gBAC5B,KAAK,EAAE,cAAc;aACtB,CACiB,CAAC;YAErB,QAAQ,CAAC,SAAS,GAAG,MAAM,CAAC;QAC9B,CAAC,CAAC;IACJ,CAAC;IAED,YAAY,CAAC,GAAoB;QAC/B,MAAM,OAAO,GAAG,GAAG,CAAC,iBAAiB,CAAC,gBAAQ,CAAoB,CAAC;QACnE,OAAO,OAAO,EAAE,SAAS,IAAI,UAAU,CAAC,IAAI,CAAC;IAC/C,CAAC;IAEQ,sBAAsB;QAC7B,eAAI,CAAC,MAAM,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;QAC9C,MAAM,GAAG,GAAG,eAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAEzC,KAAK,MAAM,CAAC,IAAI,GAAG,EAAE,CAAC;YACpB,MAAM,EAAE,YAAY,EAAE,SAAS,EAAE,GAAG,CAAC,CAAC;YACtC,MAAM,UAAU,GAAG,YAAkC,CAAC;YACtD,KAAK,MAAM,EAAE,IAAI,UAAU,CAAC,aAAa,IAAI,EAAE,EAAE,CAAC;gBAChD,IAAI,EAAE,CAAC,MAAM,EAAE,CAAC;oBACd,eAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC,CAAC;oBACtE,MAAM,KAAK,GAAG,SAAS,CAAC,gBAAgB,EAAE,CAAC;oBAC3C,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wBACrB,eAAI,CAAC,MAAM,CAAC,IAAI,CAAC,0BAA0B,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;oBACvE,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,CAAC,WAAW,CAAC,MAAc,EAAE,WAA4B,EAAE,cAAsB;QACrF,IAAA,sBAAW,EAAC,MAAM,EAAE,WAAW,EAAE,cAAc,CAAC,CAAC;IACnD,CAAC;IAED,MAAM,CAAC,WAAW,CAAC,MAAc,EAAE,WAA4B,EAAE,cAAsB;QACrF,IAAA,sBAAW,EAAC,MAAM,EAAE,WAAW,EAAE,cAAc,CAAC,CAAC;IACnD,CAAC;IAED,MAAM,CAAC,OAAO;QACZ,OAAO,IAAA,kBAAO,GAAE,CAAC;IACnB,CAAC;IACD,MAAM,CAAC,UAAU,CAAC,CAAS;QACzB,OAAO,IAAA,qBAAU,EAAC,CAAC,CAAC,CAAC;IACvB,CAAC;IAED,MAAM,CAAC,kBAAkB,CAAiD,IAAO;QAC/E,OAAO,IAAA,6BAAkB,EAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IACD,MAAM,CAAC,kBAAkB,CAAiD,IAAO;QAC/E,OAAO,IAAA,6BAAkB,EAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IACD,MAAM,CAAC,kBAAkB,CAAiD,IAAO;QAC/E,OAAO,IAAA,6BAAkB,EAAC,IAAI,CAAC,CAAC;IAClC,CAAC;;AA7HH,oCA8HC"}
+{"version":3,"file":"dboshttp.js","sourceRoot":"","sources":["../../src/dboshttp.ts"],"names":[],"mappings":";;;AAEA,6CAAyC;AAEzC,iDAa4B;AAE5B,IAAY,QAMX;AAND,WAAY,QAAQ;IAClB,uBAAW,CAAA;IACX,yBAAa,CAAA;IACb,uBAAW,CAAA;IACX,2BAAe,CAAA;IACf,6BAAiB,CAAA;AACnB,CAAC,EANW,QAAQ,wBAAR,QAAQ,QAMnB;AAED,IAAY,UAKX;AALD,WAAY,UAAU;IACpB,2BAAa,CAAA;IACb,iCAAmB,CAAA;IACnB,2BAAa,CAAA;IACb,6BAAe,CAAA;AACjB,CAAC,EALW,UAAU,0BAAV,UAAU,QAKrB;AAuCY,QAAA,QAAQ,GAAG,UAAU,CAAC;AAEtB,QAAA,gBAAgB,GAAG,sBAAsB,CAAC;AAE1C,QAAA,eAAe,GAAG,cAAc,CAAC;AAC9C,SAAgB,sBAAsB,CAAC,OAA4B;IACjE,MAAM,KAAK,GAAG,OAAO,CAAC,uBAAe,CAAC,WAAW,EAAE,CAAuB,CAAC,CAAC,uGAAuG;IACnL,IAAI,KAAK,EAAE,CAAC;QACV,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,KAAK,GAAG,IAAA,wBAAU,GAAE,CAAC;IAC3B,OAAO,CAAC,uBAAe,CAAC,WAAW,EAAE,CAAC,GAAG,KAAK,CAAC,CAAC,2CAA2C;IAC3F,OAAO,KAAK,CAAC;AACf,CAAC;AARD,wDAQC;AAED,SAAgB,oBAAoB,CAAC,CAAQ;IAC3C,OAAO,gBAAU,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;AAC7C,CAAC;AAFD,oDAEC;AAED,MAAa,YAAa,SAAQ,gCAAqB;IACrD,MAAM,CAAC,mBAAmB,GAAW,MAAM,CAAC;IAE5C,MAAM,KAAK,WAAW;QACpB,MAAM,GAAG,GAAG,eAAI,CAAC,aAAa,EAAE,CAAC;QACjC,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;YACtB,MAAM,IAAI,SAAS,CAAC,+DAA+D,CAAC,CAAC;QACvF,CAAC;QACD,OAAO,GAAsB,CAAC;IAChC,CAAC;IAED,UAAU,CAAC,IAAc,EAAE,GAAW;QACpC,4DAA4D;QAC5D,MAAM,EAAE,GAAG,IAAI,CAAC;QAChB,OAAO,SAAS,MAAM,CACpB,MAAc,EACd,WAAmB,EACnB,UAAmF;YAEnF,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,GAAG,eAAI,CAAC,yBAAyB,CAAC,EAAE,EAAE,UAAU,CAAC,KAAM,EAAE;gBACtF,WAAW,EAAE,MAAM;gBACnB,IAAI,EAAE,WAAW;aAClB,CAAC,CAAC;YACH,MAAM,mBAAmB,GAAG,OAA6B,CAAC;YAC1D,IAAI,CAAC,mBAAmB,CAAC,aAAa;gBAAE,mBAAmB,CAAC,aAAa,GAAG,EAAE,CAAC;YAC/E,mBAAmB,CAAC,aAAa,CAAC,IAAI,CAAC;gBACrC,MAAM,EAAE,GAAG;gBACX,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;YACH,IAAA,+BAAoB,EAAC,YAAY,CAAC,CAAC;YAEnC,OAAO,UAAU,CAAC;QACpB,CAAC,CAAC;IACJ,CAAC;IAED,0FAA0F;IAC1F,MAAM,CAAC,GAAW;QAChB,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAC5C,CAAC;IAED,2FAA2F;IAC3F,OAAO,CAAC,GAAW;QACjB,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAC7C,CAAC;IAED,0FAA0F;IAC1F,MAAM,CAAC,GAAW;QAChB,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAC5C,CAAC;IAED,4FAA4F;IAC5F,QAAQ,CAAC,GAAW;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAC9C,CAAC;IAED,6FAA6F;IAC7F,SAAS,CAAC,GAAW;QACnB,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC/C,CAAC;IAED,uFAAuF;IACvF,MAAM,CAAC,SAAS,CAAC,MAAkB;QACjC,OAAO,UAAU,MAAc,EAAE,WAA4B,EAAE,cAAsB;YACnF,MAAM,QAAQ,GAAG,eAAI,CAAC,sBAAsB,CAC1C,gBAAQ;YACR,iEAAiE;YACjE,MAAM,CAAC,wBAAwB,CAAC,MAAM,EAAE,WAAW,CAAE,CAAC,KAAK,EAC3D;gBACE,WAAW,EAAE,MAAM;gBACnB,IAAI,EAAE,WAAW,CAAC,QAAQ,EAAE;gBAC5B,KAAK,EAAE,cAAc;aACtB,CACiB,CAAC;YAErB,QAAQ,CAAC,SAAS,GAAG,MAAM,CAAC;QAC9B,CAAC,CAAC;IACJ,CAAC;IAES,YAAY,CAAC,GAAoB;QACzC,MAAM,OAAO,GAAG,GAAG,CAAC,iBAAiB,CAAC,gBAAQ,CAAoB,CAAC;QACnE,OAAO,OAAO,EAAE,SAAS,IAAI,UAAU,CAAC,IAAI,CAAC;IAC/C,CAAC;IAEQ,sBAAsB;QAC7B,eAAI,CAAC,MAAM,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;QAC9C,MAAM,GAAG,GAAG,eAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAEzC,KAAK,MAAM,CAAC,IAAI,GAAG,EAAE,CAAC;YACpB,MAAM,EAAE,YAAY,EAAE,SAAS,EAAE,GAAG,CAAC,CAAC;YACtC,MAAM,UAAU,GAAG,YAAkC,CAAC;YACtD,KAAK,MAAM,EAAE,IAAI,UAAU,CAAC,aAAa,IAAI,EAAE,EAAE,CAAC;gBAChD,IAAI,EAAE,CAAC,MAAM,EAAE,CAAC;oBACd,eAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC,CAAC;oBACtE,MAAM,KAAK,GAAG,SAAS,CAAC,gBAAgB,EAAE,CAAC;oBAC3C,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wBACrB,eAAI,CAAC,MAAM,CAAC,IAAI,CAAC,0BAA0B,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;oBACvE,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,CAAC,WAAW,CAAC,MAAc,EAAE,WAA4B,EAAE,cAAsB;QACrF,IAAA,sBAAW,EAAC,MAAM,EAAE,WAAW,EAAE,cAAc,CAAC,CAAC;IACnD,CAAC;IAED,MAAM,CAAC,WAAW,CAAC,MAAc,EAAE,WAA4B,EAAE,cAAsB;QACrF,IAAA,sBAAW,EAAC,MAAM,EAAE,WAAW,EAAE,cAAc,CAAC,CAAC;IACnD,CAAC;IAED,MAAM,CAAC,OAAO;QACZ,OAAO,IAAA,kBAAO,GAAE,CAAC;IACnB,CAAC;IACD,MAAM,CAAC,UAAU,CAAC,CAAS;QACzB,OAAO,IAAA,qBAAU,EAAC,CAAC,CAAC,CAAC;IACvB,CAAC;IAED,MAAM,CAAC,kBAAkB,CAAiD,IAAO;QAC/E,OAAO,IAAA,6BAAkB,EAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IACD,MAAM,CAAC,kBAAkB,CAAiD,IAAO;QAC/E,OAAO,IAAA,6BAAkB,EAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IACD,MAAM,CAAC,kBAAkB,CAAiD,IAAO;QAC/E,OAAO,IAAA,6BAAkB,EAAC,IAAI,CAAC,CAAC;IAClC,CAAC;;AA7HH,oCA8HC"}