@forklaunch/hyper-express 0.5.19 → 0.5.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/index.d.mts CHANGED
@@ -1,6 +1,6 @@
1
1
  import * as _forklaunch_core_http from '@forklaunch/core/http';
2
- import { ParamsObject, ResponsesObject, Body, QueryObject, HeadersObject, ContractDetails, ExpressLikeSchemaHandler, ForklaunchExpressLikeApplication, OpenTelemetryCollector, MetricsDefinition, DocsConfiguration, ForklaunchExpressLikeRouter, ForklaunchRouter, TypedMiddlewareDefinition } from '@forklaunch/core/http';
3
- import { Request, Response, MiddlewareNext, Server, MiddlewareHandler, ServerConstructorOptions, Router as Router$1 } from '@forklaunch/hyper-express-fork';
2
+ import { ParamsObject, ResponsesObject, Body, QueryObject, HeadersObject, ContractDetails, ExpressLikeSchemaHandler, DocsConfiguration, ForklaunchExpressLikeApplication, OpenTelemetryCollector, MetricsDefinition, ForklaunchExpressLikeRouter, ForklaunchRouter, TypedMiddlewareDefinition } from '@forklaunch/core/http';
3
+ import { Request, Response, MiddlewareNext, ServerConstructorOptions, Server, MiddlewareHandler, Router as Router$1 } from '@forklaunch/hyper-express-fork';
4
4
  export { MiddlewareNext as NextFunction, Request, Response } from '@forklaunch/hyper-express-fork';
5
5
  import { AnySchemaValidator } from '@forklaunch/validator';
6
6
  import { BusboyConfig } from 'busboy';
@@ -703,6 +703,13 @@ declare const put: <SV extends AnySchemaValidator, Path extends `/${string}`, P
703
703
  */
704
704
  declare const trace: <SV extends AnySchemaValidator, Path extends `/${string}`, P extends ParamsObject<SV>, ResBodyMap extends ResponsesObject<SV>, ReqBody extends Body<SV>, ReqQuery extends QueryObject<SV>, ReqHeaders extends HeadersObject<SV>, ResHeaders extends HeadersObject<SV>, LocalsObj extends Record<string, unknown>>(schemaValidator: SV, path: Path, contractDetails: ContractDetails<SV, "trace", Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, Request<LocalsObj>>, ...handlers: ExpressLikeSchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, Request<LocalsObj>, Response<LocalsObj>, MiddlewareNext>[]) => _forklaunch_core_http.ExpressLikeTypedHandler<SV, "trace", Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, Request<LocalsObj>, Response<LocalsObj>, MiddlewareNext>;
705
705
 
706
+ type ExpressOptions = {
707
+ docs?: DocsConfiguration;
708
+ busboy?: BusboyConfig;
709
+ server?: ServerConstructorOptions;
710
+ cors?: CorsOptions;
711
+ };
712
+
706
713
  /**
707
714
  * Represents an application built on top of Hyper-Express and Forklaunch.
708
715
  * This class provides a high-performance web server implementation using uWebSockets.js
@@ -743,12 +750,7 @@ declare class Application<SV extends AnySchemaValidator> extends ForklaunchExpre
743
750
  * );
744
751
  * ```
745
752
  */
746
- constructor(schemaValidator: SV, openTelemetryCollector: OpenTelemetryCollector<MetricsDefinition>, configurationOptions?: {
747
- docs?: DocsConfiguration;
748
- busboy?: BusboyConfig;
749
- server?: ServerConstructorOptions;
750
- cors?: CorsOptions;
751
- });
753
+ constructor(schemaValidator: SV, openTelemetryCollector: OpenTelemetryCollector<MetricsDefinition>, configurationOptions?: ExpressOptions);
752
754
  /**
753
755
  * Starts the server and sets up API documentation.
754
756
  * Supports multiple listening configurations including port, host, and UNIX socket path.
@@ -829,4 +831,4 @@ declare const handlers: {
829
831
  trace: typeof trace;
830
832
  };
831
833
 
832
- export { type App, Application, Router, forklaunchExpress, forklaunchRouter, handlers };
834
+ export { type App, Application, type ExpressOptions, Router, forklaunchExpress, forklaunchRouter, handlers };
package/lib/index.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import * as _forklaunch_core_http from '@forklaunch/core/http';
2
- import { ParamsObject, ResponsesObject, Body, QueryObject, HeadersObject, ContractDetails, ExpressLikeSchemaHandler, ForklaunchExpressLikeApplication, OpenTelemetryCollector, MetricsDefinition, DocsConfiguration, ForklaunchExpressLikeRouter, ForklaunchRouter, TypedMiddlewareDefinition } from '@forklaunch/core/http';
3
- import { Request, Response, MiddlewareNext, Server, MiddlewareHandler, ServerConstructorOptions, Router as Router$1 } from '@forklaunch/hyper-express-fork';
2
+ import { ParamsObject, ResponsesObject, Body, QueryObject, HeadersObject, ContractDetails, ExpressLikeSchemaHandler, DocsConfiguration, ForklaunchExpressLikeApplication, OpenTelemetryCollector, MetricsDefinition, ForklaunchExpressLikeRouter, ForklaunchRouter, TypedMiddlewareDefinition } from '@forklaunch/core/http';
3
+ import { Request, Response, MiddlewareNext, ServerConstructorOptions, Server, MiddlewareHandler, Router as Router$1 } from '@forklaunch/hyper-express-fork';
4
4
  export { MiddlewareNext as NextFunction, Request, Response } from '@forklaunch/hyper-express-fork';
5
5
  import { AnySchemaValidator } from '@forklaunch/validator';
6
6
  import { BusboyConfig } from 'busboy';
@@ -703,6 +703,13 @@ declare const put: <SV extends AnySchemaValidator, Path extends `/${string}`, P
703
703
  */
704
704
  declare const trace: <SV extends AnySchemaValidator, Path extends `/${string}`, P extends ParamsObject<SV>, ResBodyMap extends ResponsesObject<SV>, ReqBody extends Body<SV>, ReqQuery extends QueryObject<SV>, ReqHeaders extends HeadersObject<SV>, ResHeaders extends HeadersObject<SV>, LocalsObj extends Record<string, unknown>>(schemaValidator: SV, path: Path, contractDetails: ContractDetails<SV, "trace", Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, Request<LocalsObj>>, ...handlers: ExpressLikeSchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, Request<LocalsObj>, Response<LocalsObj>, MiddlewareNext>[]) => _forklaunch_core_http.ExpressLikeTypedHandler<SV, "trace", Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj, Request<LocalsObj>, Response<LocalsObj>, MiddlewareNext>;
705
705
 
706
+ type ExpressOptions = {
707
+ docs?: DocsConfiguration;
708
+ busboy?: BusboyConfig;
709
+ server?: ServerConstructorOptions;
710
+ cors?: CorsOptions;
711
+ };
712
+
706
713
  /**
707
714
  * Represents an application built on top of Hyper-Express and Forklaunch.
708
715
  * This class provides a high-performance web server implementation using uWebSockets.js
@@ -743,12 +750,7 @@ declare class Application<SV extends AnySchemaValidator> extends ForklaunchExpre
743
750
  * );
744
751
  * ```
745
752
  */
746
- constructor(schemaValidator: SV, openTelemetryCollector: OpenTelemetryCollector<MetricsDefinition>, configurationOptions?: {
747
- docs?: DocsConfiguration;
748
- busboy?: BusboyConfig;
749
- server?: ServerConstructorOptions;
750
- cors?: CorsOptions;
751
- });
753
+ constructor(schemaValidator: SV, openTelemetryCollector: OpenTelemetryCollector<MetricsDefinition>, configurationOptions?: ExpressOptions);
752
754
  /**
753
755
  * Starts the server and sets up API documentation.
754
756
  * Supports multiple listening configurations including port, host, and UNIX socket path.
@@ -829,4 +831,4 @@ declare const handlers: {
829
831
  trace: typeof trace;
830
832
  };
831
833
 
832
- export { type App, Application, Router, forklaunchExpress, forklaunchRouter, handlers };
834
+ export { type App, Application, type ExpressOptions, Router, forklaunchExpress, forklaunchRouter, handlers };
package/lib/index.js CHANGED
@@ -328,8 +328,14 @@ Correlation id: ${(0, import_http13.isForklaunchRequest)(req) ? req.context.corr
328
328
  this.internal.use(
329
329
  `/api/${process.env.VERSION ?? "v1"}${process.env.DOCS_PATH ?? "/docs"}`,
330
330
  (0, import_express_api_reference.apiReference)({
331
- content: openApi,
332
- ...this.docsConfiguration
331
+ ...this.docsConfiguration,
332
+ sources: [
333
+ {
334
+ content: openApi,
335
+ title: "API Reference"
336
+ },
337
+ ...this.docsConfiguration?.sources ?? []
338
+ ]
333
339
  })
334
340
  );
335
341
  } else if (this.docsConfiguration?.type === "swagger") {
package/lib/index.mjs CHANGED
@@ -320,8 +320,14 @@ Correlation id: ${isForklaunchRequest(req) ? req.context.correlationId : "No cor
320
320
  this.internal.use(
321
321
  `/api/${process.env.VERSION ?? "v1"}${process.env.DOCS_PATH ?? "/docs"}`,
322
322
  apiReference({
323
- content: openApi,
324
- ...this.docsConfiguration
323
+ ...this.docsConfiguration,
324
+ sources: [
325
+ {
326
+ content: openApi,
327
+ title: "API Reference"
328
+ },
329
+ ...this.docsConfiguration?.sources ?? []
330
+ ]
325
331
  })
326
332
  );
327
333
  } else if (this.docsConfiguration?.type === "swagger") {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@forklaunch/hyper-express",
3
- "version": "0.5.19",
3
+ "version": "0.5.20",
4
4
  "description": "Forklaunch framework for hyper-express.",
5
5
  "homepage": "https://github.com/forklaunch/forklaunch-js#readme",
6
6
  "bugs": {
@@ -34,9 +34,9 @@
34
34
  "swagger-ui-dist": "^5.24.1",
35
35
  "swagger-ui-express": "^5.0.1",
36
36
  "uWebSockets.js": "github:uNetworking/uWebSockets.js#v20.44.0",
37
- "@forklaunch/common": "0.3.9",
38
- "@forklaunch/core": "0.9.9",
39
- "@forklaunch/validator": "0.6.9"
37
+ "@forklaunch/common": "0.3.10",
38
+ "@forklaunch/core": "0.9.10",
39
+ "@forklaunch/validator": "0.6.10"
40
40
  },
41
41
  "devDependencies": {
42
42
  "@eslint/js": "^9.28.0",
@@ -46,14 +46,14 @@
46
46
  "@types/qs": "^6.14.0",
47
47
  "@types/swagger-ui-dist": "^3.30.5",
48
48
  "@types/swagger-ui-express": "^4.1.8",
49
- "@typescript/native-preview": "7.0.0-dev.20250610.1",
49
+ "@typescript/native-preview": "7.0.0-dev.20250611.1",
50
50
  "jest": "^30.0.0",
51
51
  "kill-port-process": "^3.2.1",
52
52
  "prettier": "^3.5.3",
53
53
  "ts-jest": "^29.3.4",
54
54
  "ts-node": "^10.9.2",
55
55
  "tsup": "^8.5.0",
56
- "tsx": "^4.19.4",
56
+ "tsx": "^4.20.1",
57
57
  "typedoc": "^0.28.5",
58
58
  "typescript": "^5.8.3",
59
59
  "typescript-eslint": "^8.34.0"