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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dbos-inc/koa-serve",
-  "version": "2.11.6-preview.gcb74958171",
+  "version": "2.11.7-preview.gc208400219",
   "description": "DBOS HTTP Package for serving workflows with Koa",
   "license": "MIT",
   "repository": {

package/src/dboshttp.ts

@@ -8,6 +8,13 @@ import {
   Error as DBOSErrors,
   MethodParameter,
   requestArgValidation,
+  ArgRequired,
+  ArgOptional,
+  DefaultArgRequired,
+  DefaultArgValidate,
+  DefaultArgOptional,
+  ArgDate,
+  ArgVarchar,
 } from '@dbos-inc/dbos-sdk';
 
 export enum APITypes {
@@ -43,6 +50,25 @@ export interface DBOSHTTPArgInfo {
   argSource?: ArgSources;
 }
 
+enum ArgRequiredOptions {
+  REQUIRED = 'REQUIRED',
+  OPTIONAL = 'OPTIONAL',
+  DEFAULT = 'DEFAULT',
+}
+
+interface ValidatorClassInfo {
+  defaultArgRequired?: ArgRequiredOptions;
+  defaultArgValidate?: boolean;
+}
+
+interface ValidatorFuncInfo {
+  performArgValidation?: boolean;
+}
+
+interface ValidatorArgInfo {
+  required?: ArgRequiredOptions;
+}
+
 /**
  * HTTPRequest includes useful information from http.IncomingMessage and parsed body,
  *   URL parameters, and parsed query string.
@@ -81,6 +107,8 @@ export function isClientRequestError(e: Error) {
   return DBOSErrors.isDataValidationError(e);
 }
 
+const VALIDATOR = 'validator';
+
 export class DBOSHTTPBase extends DBOSLifecycleCallback {
   static HTTP_OPERATION_TYPE: string = 'http';
 
@@ -182,4 +210,29 @@ export class DBOSHTTPBase extends DBOSLifecycleCallback {
       }
     }
   }
+
+  static argRequired(target: object, propertyKey: string | symbol, parameterIndex: number) {
+    ArgRequired(target, propertyKey, parameterIndex);
+  }
+
+  static argOptional(target: object, propertyKey: string | symbol, parameterIndex: number) {
+    ArgOptional(target, propertyKey, parameterIndex);
+  }
+
+  static argDate() {
+    return ArgDate();
+  }
+  static argVarchar(n: number) {
+    return ArgVarchar(n);
+  }
+
+  static defaultArgRequired<T extends { new (...args: unknown[]): object }>(ctor: T) {
+    return DefaultArgRequired(ctor);
+  }
+  static defaultArgOptional<T extends { new (...args: unknown[]): object }>(ctor: T) {
+    return DefaultArgOptional(ctor);
+  }
+  static defaultArgValidate<T extends { new (...args: unknown[]): object }>(ctor: T) {
+    return DefaultArgValidate(ctor);
+  }
 }

package/tests/argsource.test.ts

@@ -1,7 +1,7 @@
 import Koa from 'koa';
 import Router from '@koa/router';
 
-import { DBOS, DefaultArgRequired } from '@dbos-inc/dbos-sdk';
+import { DBOS } from '@dbos-inc/dbos-sdk';
 
 import { ArgSources, DBOSKoa } from '../src';
 
@@ -108,7 +108,7 @@ describe('httpserver-argsource-tests', () => {
       parsedMethods: ['GET', 'POST'],
     }),
   )
-  @DefaultArgRequired
+  @DBOSKoa.defaultArgRequired
   class ArgTestEndpoints {
     @dhttp.getApi('/getquery')
     static async getQuery(@dhttp.argSource(ArgSources.QUERY) name: string) {

package/tests/endpoints.test.ts

@@ -2,7 +2,7 @@
 import Koa from 'koa';
 import Router from '@koa/router';
 
-import { DBOS, DBOSResponseError, Error as DBOSErrors, DefaultArgRequired, StatusString } from '@dbos-inc/dbos-sdk';
+import { DBOS, DBOSResponseError, Error as DBOSErrors, StatusString } from '@dbos-inc/dbos-sdk';
 
 import { DBOSKoa, DBOSKoaAuthContext, RequestIDHeader, WorkflowIDHeader } from '../src';
 
@@ -351,7 +351,7 @@ describe('httpserver-tests', () => {
       parsedMethods: ['POST', 'PUT', 'PATCH', 'GET', 'DELETE'],
     }),
   )
-  @DefaultArgRequired
+  @DBOSKoa.defaultArgRequired
   class TestEndpoints {
     @dhttp.getApi('/hello')
     static async hello() {

package/tests/validation.test.ts

@@ -2,15 +2,7 @@
 import Koa from 'koa';
 import Router from '@koa/router';
 
-import {
-  ArgDate,
-  ArgOptional,
-  ArgRequired,
-  ArgVarchar,
-  DBOS,
-  DefaultArgOptional,
-  DefaultArgRequired,
-} from '@dbos-inc/dbos-sdk';
+import { DBOS } from '@dbos-inc/dbos-sdk';
 
 import { DBOSKoa } from '../src';
 
@@ -346,7 +338,7 @@ describe('httpserver-datavalidation-tests', () => {
     }
   });
 
-  @DefaultArgRequired
+  @DBOSKoa.defaultArgRequired
   class TestEndpointDataVal {
     @dhttp.getApi('/hello')
     static async hello() {
@@ -370,7 +362,7 @@ describe('httpserver-datavalidation-tests', () => {
     }
 
     @dhttp.getApi('/varchar')
-    static async checkVarcharG(@ArgVarchar(10) v: string) {
+    static async checkVarcharG(@DBOSKoa.argVarchar(10) v: string) {
       if (typeof v !== 'string') {
         return Promise.reject(new Error('THIS SHOULD NEVER HAPPEN'));
       }
@@ -378,7 +370,7 @@ describe('httpserver-datavalidation-tests', () => {
     }
 
     @dhttp.postApi('/varchar')
-    static async checkVarcharP(@ArgVarchar(10) v: string) {
+    static async checkVarcharP(@DBOSKoa.argVarchar(10) v: string) {
       if (typeof v !== 'string') {
         return Promise.reject(new Error('THIS SHOULD NEVER HAPPEN'));
       }
@@ -418,7 +410,7 @@ describe('httpserver-datavalidation-tests', () => {
     }
 
     @dhttp.getApi('/date')
-    static async checkDateG(@ArgDate() v: Date) {
+    static async checkDateG(@DBOSKoa.argDate() v: Date) {
       if (!(v instanceof Date)) {
         return Promise.reject(new Error('THIS SHOULD NEVER HAPPEN'));
       }
@@ -426,7 +418,7 @@ describe('httpserver-datavalidation-tests', () => {
     }
 
     @dhttp.postApi('/date')
-    static async checkDateP(@ArgDate() v: Date) {
+    static async checkDateP(@DBOSKoa.argDate() v: Date) {
       if (!(v instanceof Date)) {
         return Promise.reject(new Error('THIS SHOULD NEVER HAPPEN'));
       }
@@ -457,15 +449,15 @@ describe('httpserver-datavalidation-tests', () => {
     //  JSON
   }
 
-  @DefaultArgRequired
+  @DBOSKoa.defaultArgRequired
   class DefaultArgToRequired {
     @dhttp.postApi('/rrequired')
-    static async checkReqValueR(@ArgRequired v: string) {
+    static async checkReqValueR(@DBOSKoa.argRequired v: string) {
       return Promise.resolve({ message: `Got string ${v}` });
     }
 
     @dhttp.postApi('/roptional')
-    static async checkOptValueR(@ArgOptional v?: string) {
+    static async checkOptValueR(@DBOSKoa.argOptional v?: string) {
       return Promise.resolve({ message: `Got string ${v}` });
     }
 
@@ -475,15 +467,15 @@ describe('httpserver-datavalidation-tests', () => {
     }
   }
 
-  @DefaultArgOptional
+  @DBOSKoa.defaultArgOptional
   class DefaultArgToOptional {
     @dhttp.postApi('/orequired')
-    static async checkReqValueO(@ArgRequired v: string) {
+    static async checkReqValueO(@DBOSKoa.argRequired v: string) {
       return Promise.resolve({ message: `Got string ${v}` });
     }
 
     @dhttp.postApi('/ooptional')
-    static async checkOptValueO(@ArgOptional v?: string) {
+    static async checkOptValueO(@DBOSKoa.argOptional v?: string) {
       return Promise.resolve({ message: `Got string ${v}` });
     }
 
@@ -495,12 +487,12 @@ describe('httpserver-datavalidation-tests', () => {
 
   class DefaultArgToDefault {
     @dhttp.postApi('/drequired')
-    static async checkReqValueD(@ArgRequired v: string) {
+    static async checkReqValueD(@DBOSKoa.argRequired v: string) {
       return Promise.resolve({ message: `Got string ${v}` });
     }
 
     @dhttp.postApi('/doptional')
-    static async checkOptValueD(@ArgOptional v?: string) {
+    static async checkOptValueD(@DBOSKoa.argOptional v?: string) {
       return Promise.resolve({ message: `Got string ${v}` });
     }
 
@@ -510,12 +502,12 @@ describe('httpserver-datavalidation-tests', () => {
     }
 
     @DBOS.workflow()
-    static async opworkflow(@ArgOptional v?: string) {
+    static async opworkflow(@DBOSKoa.argOptional v?: string) {
       return Promise.resolve({ message: v });
     }
 
     @dhttp.postApi('/doworkflow')
-    static async doWorkflow(@ArgOptional v?: string) {
+    static async doWorkflow(@DBOSKoa.argOptional v?: string) {
       return await DefaultArgToDefault.opworkflow(v);
     }
   }