@forklaunch/core 0.2.3 → 0.2.4

package/dist/http/types/forklaunch.types.d.ts

@@ -1,5 +1,5 @@
 import { AnySchemaValidator } from '@forklaunch/validator';
-import { HttpContractDetails, PathParamHttpContractDetails } from './primitive.types';
+import { HttpContractDetails, Method, PathParamHttpContractDetails } from './primitive.types';
 /**
  * Interface representing a Forklaunch router.
  *
@@ -22,7 +22,7 @@ export interface ForklaunchRoute<SV extends AnySchemaValidator> {
     /** The path for the route, which can be a string, RegExp, or an array of strings or RegExps */
     path: string | RegExp | (string | RegExp)[];
     /** The HTTP method for the route */
-    method: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+    method: Method;
     /** The contract details for the route */
     contractDetails: PathParamHttpContractDetails<SV> | HttpContractDetails<SV>;
 }

package/dist/http/types/forklaunch.types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"forklaunch.types.d.ts","sourceRoot":"","sources":["../../../http/types/forklaunch.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EACL,mBAAmB,EACnB,4BAA4B,EAC7B,MAAM,mBAAmB,CAAC;AAE3B;;;;GAIG;AACH,MAAM,WAAW,gBAAgB,CAAC,EAAE,SAAS,kBAAkB;IAC7D,mCAAmC;IACnC,QAAQ,EAAE,MAAM,CAAC;IACjB,4CAA4C;IAC5C,MAAM,EAAE,eAAe,CAAC,EAAE,CAAC,EAAE,CAAC;CAC/B;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe,CAAC,EAAE,SAAS,kBAAkB;IAC5D,kCAAkC;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,+FAA+F;IAC/F,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IAC5C,oCAAoC;IACpC,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;IACpD,yCAAyC;IACzC,eAAe,EAAE,4BAA4B,CAAC,EAAE,CAAC,GAAG,mBAAmB,CAAC,EAAE,CAAC,CAAC;CAC7E"}
+{"version":3,"file":"forklaunch.types.d.ts","sourceRoot":"","sources":["../../../http/types/forklaunch.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EACL,mBAAmB,EACnB,MAAM,EACN,4BAA4B,EAC7B,MAAM,mBAAmB,CAAC;AAE3B;;;;GAIG;AACH,MAAM,WAAW,gBAAgB,CAAC,EAAE,SAAS,kBAAkB;IAC7D,mCAAmC;IACnC,QAAQ,EAAE,MAAM,CAAC;IACjB,4CAA4C;IAC5C,MAAM,EAAE,eAAe,CAAC,EAAE,CAAC,EAAE,CAAC;CAC/B;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe,CAAC,EAAE,SAAS,kBAAkB;IAC5D,kCAAkC;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,+FAA+F;IAC/F,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IAC5C,oCAAoC;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,yCAAyC;IACzC,eAAe,EAAE,4BAA4B,CAAC,EAAE,CAAC,GAAG,mBAAmB,CAAC,EAAE,CAAC,CAAC;CAC7E"}

package/dist/http/types/primitive.types.d.ts

@@ -64,11 +64,11 @@ export type AuthMethod = 'jwt' | 'session';
  * Interface representing HTTP contract details for path parameters.
  *
  * @template SV - A type that extends AnySchemaValidator.
- * @template ParamSchemas - A type for parameter schemas, defaulting to ParamsObject.
+ * @template ParamsSchema - A type for parameter schemas, defaulting to ParamsObject.
  * @template ResponseSchemas - A type for response schemas, defaulting to ResponsesObject.
- * @template QuerySchemas - A type for query schemas, defaulting to QueryObject.
+ * @template QuerySchema - A type for query schemas, defaulting to QueryObject.
  */
-export interface PathParamHttpContractDetails<SV extends AnySchemaValidator, ParamSchemas extends ParamsObject<SV> = ParamsObject<SV>, ResponseSchemas extends ResponsesObject<SV> = ResponsesObject<SV>, QuerySchemas extends QueryObject<SV> = QueryObject<SV>, ReqHeaders extends HeadersObject<SV> = HeadersObject<SV>, ResHeaders extends HeadersObject<SV> = HeadersObject<SV>> {
+export interface PathParamHttpContractDetails<SV extends AnySchemaValidator, ParamsSchema extends ParamsObject<SV> = ParamsObject<SV>, ResponseSchemas extends ResponsesObject<SV> = ResponsesObject<SV>, QuerySchema extends QueryObject<SV> = QueryObject<SV>, ReqHeaders extends HeadersObject<SV> = HeadersObject<SV>, ResHeaders extends HeadersObject<SV> = HeadersObject<SV>> {
     /** Name of the contract */
     name: string;
     /** Summary of the contract */
@@ -80,9 +80,9 @@ export interface PathParamHttpContractDetails<SV extends AnySchemaValidator, Par
     /** Optional response headers for the contract */
     responseHeaders?: ResHeaders;
     /** Optional parameter schemas for the contract */
-    params?: ParamSchemas;
+    params?: ParamsSchema;
     /** Optional query schemas for the contract */
-    query?: QuerySchemas;
+    query?: QuerySchema;
     /** Optional authentication details for the contract */
     auth?: {
         method: AuthMethod;
@@ -96,15 +96,27 @@ export interface PathParamHttpContractDetails<SV extends AnySchemaValidator, Par
  * Interface representing HTTP contract details.
  *
  * @template SV - A type that extends AnySchemaValidator.
- * @template ParamSchemas - A type for parameter schemas, defaulting to ParamsObject.
+ * @template ParamsSchema - A type for parameter schemas, defaulting to ParamsObject.
  * @template ResponseSchemas - A type for response schemas, defaulting to ResponsesObject.
  * @template BodySchema - A type for the body schema, defaulting to Body.
- * @template QuerySchemas - A type for query schemas, defaulting to QueryObject.
+ * @template QuerySchema - A type for query schemas, defaulting to QueryObject.
  */
-export interface HttpContractDetails<SV extends AnySchemaValidator, ParamSchemas extends ParamsObject<SV> = ParamsObject<SV>, ResponseSchemas extends ResponsesObject<SV> = ResponsesObject<SV>, BodySchema extends Body<SV> = Body<SV>, QuerySchemas extends QueryObject<SV> = QueryObject<SV>, ReqHeaders extends HeadersObject<SV> = HeadersObject<SV>, ResHeaders extends HeadersObject<SV> = HeadersObject<SV>> extends PathParamHttpContractDetails<SV, ParamSchemas, ResponseSchemas, QuerySchemas, ReqHeaders, ResHeaders> {
-    /** Optional body schema for the contract */
-    body?: BodySchema;
+export interface HttpContractDetails<SV extends AnySchemaValidator, ParamsSchema extends ParamsObject<SV> = ParamsObject<SV>, ResponseSchemas extends ResponsesObject<SV> = ResponsesObject<SV>, BodySchema extends Body<SV> = Body<SV>, QuerySchema extends QueryObject<SV> = QueryObject<SV>, ReqHeaders extends HeadersObject<SV> = HeadersObject<SV>, ResHeaders extends HeadersObject<SV> = HeadersObject<SV>> extends PathParamHttpContractDetails<SV, ParamsSchema, ResponseSchemas, QuerySchema, ReqHeaders, ResHeaders> {
+    /** Required body schema for the contract */
+    body: BodySchema;
     /** Optional content type for the contract */
     contentType?: 'application/json' | 'multipart/form-data' | 'application/x-www-form-urlencoded';
 }
+/**
+ * Represents the path parameter methods.
+ */
+export type PathParameterMethod = 'get' | 'delete' | 'options';
+/**
+ * Represents the body parameter methods.
+ */
+export type HttpMethod = 'post' | 'patch' | 'put';
+/**
+ * Represents all supported typed methods.
+ */
+export type Method = PathParameterMethod | HttpMethod;
 //# sourceMappingURL=primitive.types.d.ts.map

package/dist/http/types/primitive.types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"primitive.types.d.ts","sourceRoot":"","sources":["../../../http/types/primitive.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAElE;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,CAAC;AAEzD;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,CAAC,EAAE,SAAS,kBAAkB,IAAI,IAAI,CAChE,mBAAmB,CAAC,EAAE,CAAC,EACvB,MAAM,GAAG,MAAM,CAChB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,CAAC,EAAE,SAAS,kBAAkB,IAAI,IAAI,CAChE,mBAAmB,CAAC,EAAE,CAAC,EACvB,MAAM,GAAG,MAAM,CAChB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,UAAU,CAAC,EAAE,SAAS,kBAAkB,IAAI,gBAAgB,CAAC,EAAE,CAAC,GAC1E,OAAO,CAAC;AAEV;;;;GAIG;AACH,MAAM,MAAM,YAAY,CAAC,EAAE,SAAS,kBAAkB,IAAI,gBAAgB,CAAC,EAAE,CAAC,GAC5E,OAAO,CAAC;AAEV;;;;GAIG;AACH,MAAM,MAAM,WAAW,CAAC,EAAE,SAAS,kBAAkB,IAAI,gBAAgB,CAAC,EAAE,CAAC,GAC3E,OAAO,CAAC;AAEV;;;;GAIG;AACH,MAAM,MAAM,aAAa,CAAC,EAAE,SAAS,kBAAkB,IACrD,gBAAgB,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC;AAEjC;;;;GAIG;AACH,MAAM,MAAM,eAAe,CAAC,EAAE,SAAS,kBAAkB,IAAI;IAC3D,CAAC,GAAG,EAAE,MAAM,GACR,EAAE,CAAC,oBAAoB,CAAC,GACxB,mBAAmB,CAAC,EAAE,CAAC,GACvB,MAAM,GACN,EAAE,CAAC,QAAQ,CAAC,CAAC;CAClB,GAAG,OAAO,CAAC;AAEZ;;;;GAIG;AACH,MAAM,MAAM,IAAI,CAAC,EAAE,SAAS,kBAAkB,IAC1C,UAAU,CAAC,EAAE,CAAC,GACd,EAAE,CAAC,oBAAoB,CAAC,GACxB,EAAE,CAAC,iBAAiB,CAAC,CAAC;AAE1B;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,SAAS,CAAC;AAE3C;;;;;;;GAOG;AACH,MAAM,WAAW,4BAA4B,CAC3C,EAAE,SAAS,kBAAkB,EAC7B,YAAY,SAAS,YAAY,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC,EAAE,CAAC,EACxD,eAAe,SAAS,eAAe,CAAC,EAAE,CAAC,GAAG,eAAe,CAAC,EAAE,CAAC,EACjE,YAAY,SAAS,WAAW,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,EAAE,CAAC,EACtD,UAAU,SAAS,aAAa,CAAC,EAAE,CAAC,GAAG,aAAa,CAAC,EAAE,CAAC,EACxD,UAAU,SAAS,aAAa,CAAC,EAAE,CAAC,GAAG,aAAa,CAAC,EAAE,CAAC;IAExD,2BAA2B;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,8BAA8B;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,wCAAwC;IACxC,SAAS,EAAE,eAAe,CAAC;IAC3B,gDAAgD;IAChD,cAAc,CAAC,EAAE,UAAU,CAAC;IAC5B,iDAAiD;IACjD,eAAe,CAAC,EAAE,UAAU,CAAC;IAC7B,kDAAkD;IAClD,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,8CAA8C;IAC9C,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB,uDAAuD;IACvD,IAAI,CAAC,EAAE;QACL,MAAM,EAAE,UAAU,CAAC;QACnB,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;QAC3B,cAAc,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;QAC7B,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;QAC3B,cAAc,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;KAC9B,CAAC;CACH;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,mBAAmB,CAClC,EAAE,SAAS,kBAAkB,EAC7B,YAAY,SAAS,YAAY,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC,EAAE,CAAC,EACxD,eAAe,SAAS,eAAe,CAAC,EAAE,CAAC,GAAG,eAAe,CAAC,EAAE,CAAC,EACjE,UAAU,SAAS,IAAI,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,EAAE,CAAC,EACtC,YAAY,SAAS,WAAW,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,EAAE,CAAC,EACtD,UAAU,SAAS,aAAa,CAAC,EAAE,CAAC,GAAG,aAAa,CAAC,EAAE,CAAC,EACxD,UAAU,SAAS,aAAa,CAAC,EAAE,CAAC,GAAG,aAAa,CAAC,EAAE,CAAC,CACxD,SAAQ,4BAA4B,CAClC,EAAE,EACF,YAAY,EACZ,eAAe,EACf,YAAY,EACZ,UAAU,EACV,UAAU,CACX;IACD,4CAA4C;IAC5C,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,6CAA6C;IAC7C,WAAW,CAAC,EACR,kBAAkB,GAClB,qBAAqB,GACrB,mCAAmC,CAAC;CACzC"}
+{"version":3,"file":"primitive.types.d.ts","sourceRoot":"","sources":["../../../http/types/primitive.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAElE;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,CAAC;AAEzD;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,CAAC,EAAE,SAAS,kBAAkB,IAAI,IAAI,CAChE,mBAAmB,CAAC,EAAE,CAAC,EACvB,MAAM,GAAG,MAAM,CAChB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,CAAC,EAAE,SAAS,kBAAkB,IAAI,IAAI,CAChE,mBAAmB,CAAC,EAAE,CAAC,EACvB,MAAM,GAAG,MAAM,CAChB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,UAAU,CAAC,EAAE,SAAS,kBAAkB,IAAI,gBAAgB,CAAC,EAAE,CAAC,GAC1E,OAAO,CAAC;AAEV;;;;GAIG;AACH,MAAM,MAAM,YAAY,CAAC,EAAE,SAAS,kBAAkB,IAAI,gBAAgB,CAAC,EAAE,CAAC,GAC5E,OAAO,CAAC;AAEV;;;;GAIG;AACH,MAAM,MAAM,WAAW,CAAC,EAAE,SAAS,kBAAkB,IAAI,gBAAgB,CAAC,EAAE,CAAC,GAC3E,OAAO,CAAC;AAEV;;;;GAIG;AACH,MAAM,MAAM,aAAa,CAAC,EAAE,SAAS,kBAAkB,IACrD,gBAAgB,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC;AAEjC;;;;GAIG;AACH,MAAM,MAAM,eAAe,CAAC,EAAE,SAAS,kBAAkB,IAAI;IAC3D,CAAC,GAAG,EAAE,MAAM,GACR,EAAE,CAAC,oBAAoB,CAAC,GACxB,mBAAmB,CAAC,EAAE,CAAC,GACvB,MAAM,GACN,EAAE,CAAC,QAAQ,CAAC,CAAC;CAClB,GAAG,OAAO,CAAC;AAEZ;;;;GAIG;AACH,MAAM,MAAM,IAAI,CAAC,EAAE,SAAS,kBAAkB,IAC1C,UAAU,CAAC,EAAE,CAAC,GACd,EAAE,CAAC,oBAAoB,CAAC,GACxB,EAAE,CAAC,iBAAiB,CAAC,CAAC;AAE1B;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,SAAS,CAAC;AAE3C;;;;;;;GAOG;AACH,MAAM,WAAW,4BAA4B,CAC3C,EAAE,SAAS,kBAAkB,EAC7B,YAAY,SAAS,YAAY,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC,EAAE,CAAC,EACxD,eAAe,SAAS,eAAe,CAAC,EAAE,CAAC,GAAG,eAAe,CAAC,EAAE,CAAC,EACjE,WAAW,SAAS,WAAW,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,EAAE,CAAC,EACrD,UAAU,SAAS,aAAa,CAAC,EAAE,CAAC,GAAG,aAAa,CAAC,EAAE,CAAC,EACxD,UAAU,SAAS,aAAa,CAAC,EAAE,CAAC,GAAG,aAAa,CAAC,EAAE,CAAC;IAExD,2BAA2B;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,8BAA8B;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,wCAAwC;IACxC,SAAS,EAAE,eAAe,CAAC;IAC3B,gDAAgD;IAChD,cAAc,CAAC,EAAE,UAAU,CAAC;IAC5B,iDAAiD;IACjD,eAAe,CAAC,EAAE,UAAU,CAAC;IAC7B,kDAAkD;IAClD,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,8CAA8C;IAC9C,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,uDAAuD;IACvD,IAAI,CAAC,EAAE;QACL,MAAM,EAAE,UAAU,CAAC;QACnB,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;QAC3B,cAAc,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;QAC7B,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;QAC3B,cAAc,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;KAC9B,CAAC;CACH;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,mBAAmB,CAClC,EAAE,SAAS,kBAAkB,EAC7B,YAAY,SAAS,YAAY,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC,EAAE,CAAC,EACxD,eAAe,SAAS,eAAe,CAAC,EAAE,CAAC,GAAG,eAAe,CAAC,EAAE,CAAC,EACjE,UAAU,SAAS,IAAI,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,EAAE,CAAC,EACtC,WAAW,SAAS,WAAW,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,EAAE,CAAC,EACrD,UAAU,SAAS,aAAa,CAAC,EAAE,CAAC,GAAG,aAAa,CAAC,EAAE,CAAC,EACxD,UAAU,SAAS,aAAa,CAAC,EAAE,CAAC,GAAG,aAAa,CAAC,EAAE,CAAC,CACxD,SAAQ,4BAA4B,CAClC,EAAE,EACF,YAAY,EACZ,eAAe,EACf,WAAW,EACX,UAAU,EACV,UAAU,CACX;IACD,4CAA4C;IAC5C,IAAI,EAAE,UAAU,CAAC;IACjB,6CAA6C;IAC7C,WAAW,CAAC,EACR,kBAAkB,GAClB,qBAAqB,GACrB,mCAAmC,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,KAAK,GAAG,QAAQ,GAAG,SAAS,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC;AAElD;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,mBAAmB,GAAG,UAAU,CAAC"}

package/dist/tests/openApiV3Generator.test.js

@@ -12,7 +12,7 @@ describe('OpenApiV3Generator Tests', () => {
                     {
                         basePath: '/test',
                         path: '/',
-                        method: 'GET',
+                        method: 'get',
                         contractDetails: {
                             name: 'Test Contract',
                             summary: 'Test Contract Summary',