CHANGELOG.md

Change Log (@egomobile/http-server)

0.67.0

• add server:created event
• add getTests() to IControllersResult interface

0.66.0

• add noAutoEnd to IControllerRouteOptions

0.65.3

• can define custom settings to setup IDs for Swagger operations
• add parameterFormat to IControllersOptions and IControllerRouteOptions interfaces
• npm updates

0.64.2

• BREAKING CHANGE: module requires at least Node 18+ now
• add deprecated property to IControllerRouteOptions interface
• add noJSON and noYAML to IControllersSwaggerOptions interface
• npm updates, Swagger UI 5+
• (bug-)fixes

0.63.1

• revert to version 0.61.x
• npm updates

0.62.3

• add ESM and CommonJS support
• npm updates
• (bug-)fixes

0.61.0

• add noAutoUpdate to IValidateAjvOptions interface

0.60.4

• can export afterEach and beforeEach function in .spec files now
• add after and before props to ITestSettings interface
• code cleanups and improvements
• (bug-)fixes

0.59.0

• BREAKING CHANGE: tests are sorted now the following way:
  • by sortBy value of @Describe() decorator
  • then: by name argument of @Describe() decorator (case-insensitive)
  • then: by sortBy value of ITestSettings interface
  • then: by unescaped route path (case-insensitive)
  • then: by HTTP method (case-insensitive)
  • then: by name argument of @It() decorator (case-insensitive)
• (bug-)fixes

0.58.0

• BREAKING CHANGE: props of IAfterAllTestsContext, IAfterEachTestContext, IBeforeAllTestsContext and IBeforeEachTestContext interfaces are marked as readonly now
• add session prop to IAfterAllTestsContext, IAfterEachTestContext, IBeforeAllTestsContext, IBeforeEachTestContext and ITestEventHandlerContext interfaces

0.57.0

• BREAKING CHANGE: running tests will now execute process.exit(1) by default now on error
• IHttpServer.test() method will now return a result value now

0.56.2

• BREAKING CHANGE: running tests will now execute process.exit(0) by default now on success
• (bug-)fixes

0.55.0

• BREAKING CHANGE: remove validate prop from IControllersSwaggerOptions interface and SwaggerValidationError class

0.54.0

• BREAKING CHANGE: controllers() method now returns an IControllersResult object instead of the service instance itself
• add tests prop to IControllerMethodInfo interface

0.53.0

• name argument of @It() decorator now also supports the following placeholders:
  • {{query}}: list of query parameters
  • {{query-parameter:myQueryParameter}}: submitted value of query parameter myQueryParameter
• code cleanups and improvements

0.52.0

• add support for query parameters in tests
• fix use of ITestEventHandlerContext interface
• extend ITestSettingValueGetterContext interface
• replace all .split().join() workarrounds with replaceAll()

0.51.3

• BREAKING CHANGE: move loadOpenAPIFiles and requiresDocumentationEverywhere props from IControllersSwaggerOptions to IControllersOptions
• (bug-)fixes

0.50.2

• BREAKING CHANGE: @Describe() decorator will throw an exception, if it is tried to be used more than once in a controller class
• improve constructor arguments of [@Describe() decorator][https://egomobile.github.io/node-http-server/functions/describe.html]
• (bug-)fixes

0.49.1

• BREAKING CHANGE: tests are sorted now the following way:
  • by sortBy value of @Describe() decorator
  • then: by name argument of @Describe() decorator (case-insensitive)
  • then: by sortBy value of ITestSettings interface
  • then: by name argument of @It() decorator (case-insensitive)
• update compiler options to es2021
• deactivate building source maps
• add sortBy prop to ITestSettings interface
• add tag prop to ITestSettings and ITestEventHandlerContext interfaces
• add groupTag to ITestEventHandlerContext interface
• @Describe() decorator now supports custom settings, represented by new IDescribeOptions interface
• (bug-)fixes

0.48.3

• BREAKING CHANGE: replace once() method with on in IHttpServer interface
• BREAKING CHANGE: ItSettingsOrValidator type has been replaced with ItArgument2
• improve @It() decorator with additional arguments and type definitions.
• (bug-)fixes

0.47.2

• add following placeholders for name argument of @It() decorator:
  • {{parameters}}: list of comma-separated parameter list, example: "param1" = "param1 value", "param2" = "param2 value"
• (bug-)fixes

0.46.0

• name argument of @It() decorator now supports templating with the following placeholders:
  • {{body}}: expected body
  • {{header:my-header}}: expected value for header my-header
  • {{parameter:myParameter}}: submitted value of URL parameter myParameter
  • {{status}}: expected HTTP status code
• can implement / declare multiple tests / test settings in .spec files now
• add groupIndex and ref props to ITestEventHandlerContext interface
• add ref prop to ITestSettings interface

0.45.0

• add isUIEnabled property to ISwaggerInitializedEventArguments interface
• (bug-)fixes

0.44.1

• BREAKING CHANGE: validateWithDocumentation property in IControllersOptions interface is true by default
• (bug-)fixes

0.43.4

• add loadOpenAPIFiles to IControllerMethodInfo, which can load resources for a Swagger document, organized in .openapi files
• (bug-)fixes

0.42.2

• add resourcePath to IControllerMethodInfo, which can load resources for a Swagger document, organized in a strict structure
• (bug-)fixes

0.41.0

• BREAKING CHANGE: module requires at least Node 16+ now
• BREAKING CHANGE: controller files are now sorted the following way:
  • by number of parts, separated by path chars like /
  • then: all directories, starting with @, will be moved to the bottom
  • then: by directory path (case-insensitive)
  • then: all files, starting with @, will be moved to the bottom
  • then: by file name (case-insensitive)
• add Describe() and It() decorators, that can setup (unit-)tests for controller methods, e.g.
• implement validateAjv() middleware
• if Swagger documentation is activated, all endpoints have to be documented by default now ... this behavior can be controlled by new requiresDocumentationEverywhere prop of IControllersOptions interface
• npm updates
• code cleanups and improvements
• (bug-)fixes

0.40.0

• add doesValidate, doesValidateQuery, hasAuthorize and middlewares properties to IDocumentationUpdaterContext interface
• all build-in middlewares are now of new type UniqueHttpMiddleware, which is compatible to HttpMiddleware
• npm updates

0.39.0

• add use property to IControllersSwaggerOptions interface
• npm updates

0.38.0

• add instance property to IHttpServer interface
• npm updates

0.37.0

• Swagger documents are validated with openapi-schema-validator module by default now ... this behavior can be changed, updating validate property
• implement validateWithSwagger() middleware and its representations inside the controller framework, like @GET() or @POST() decorators
• code cleanups and improvements
• (bug-)fixes

0.36.1

• implement @BodyParseErrorHandler() decorator to handle parse errors in combination with schema validation, configured by decorators
• add onParsingFailed prop to IControllerRouteWithBodyOptions and IHttpBodyParserOptions interfaces
• add onParsingFailed and onSchemaValidationFailed prop to IControllersOptions
• also add onControllerInitialized, onControllerMethodInitialized and onSwaggerInitialized to IControllersOptions, which can help debugging
• (bug-)fixes
• code cleanups and improvements

0.35.2

• implement decorators to import values into a request handler argument / parameter:
  • @Parameter(): Generic way to import a value
  • @Body(): import request body
  • @Headers(): import HTTP request headers as key/value pair object
  • @Query(): import query parameters from URL as key/value pair object
  • @Request(): import request context
  • @Response(): import response context
  • @Url(): import URL parameters as key/value pair object
• HttpPathValidator can be asynchronious now
• fix typings
• apply new eslint-config-ego settings
• module requires at least Node 14+ now
• (bug-)fixes
• npm updates

0.34.0

• implement @Authorize() decorator and authorize options

0.33.1

• remove regexparam by Luke Edwards and use code directly to reduce dependencies
• remove mrmime by Luke Edwards to reduce dependencies
• improve compilation of handlers and middlewares
• fix minor typos
• improve and fix lang()
• improve Swagger features
• move following types to internal:
  • Constructor
  • GetterFunc
• improve tests

0.32.0

• improve and fix lang() middleware
• @CONNECT() does not support input bodies anymore
• type checks for arguments in params() validator
• remove prettyErrors() error handler
• other code cleanups and improvements
• (bug-)fixes

0.31.0

• replace use of substr() with substring()

0.30.2

• type check for key parameter of @Import() decorator
• optimize serializer feature
• update Youch! to version 3.0.0
• add benchmarks to benchmarks sub folder
• fix typos

0.29.0

• implement all() method

0.28.0

• implement validateQuery middleware

0.27.1

• key parameter of @Import() decorator is now optional, what means that, if no key is submitted, the name of the underlying property is used
• (bug-)fixes

0.26.1

• add @Import() decorator, which can import values into a controller's property or provide them there

0.25.0

• BREAKING CHANGE: Nilable<T>, Nullable<T> and Optional<T> are not public anymore and internal types now

0.24.0

• BREAKING CHANGE: auth() and apiKey() using try-catch blocks now
• BREAKING CHANGE: buffer(), json(), text() and yaml() set body prop to (null) now, if HTTP method is not PATCH, POST or PUT
• add notFoundHandler property to IHttpServer
• improve speed of internal helper functions
• fix typos

0.23.0

• implement basicAuth middleware
• code cleanups and improvements

0.22.0

• (bug-)fixes

0.21.0

• do not trim value in auth() middleware anymore

0.20.0

• improve auth() middleware

0.19.0

• implement auth middleware
• improve defaultApiKeyValidationFailedHandler and defaultParseErrorHandler
• code cleanups and improvements
• (bug-)fixes

0.18.1

• implement @Use() decorator
• replace mime-types with mrmime
• can download Swagger documentation over endpoints like /swagger/yaml now
• npm updates
• (bug-)fixes, like issue #11

0.17.1

• removed bind() calls
• (bug-)fixes

0.16.0

• now bind ValidationErrorHandler(), ErrorHandler(), Serializer, DocumentationUpdater() and controller methods to controller instance

0.15.1

• query() middleware is automatically added as 1st middleware to each controller by default now
• add noQueryParams to IControllerRouteOptions and IControllersOptions
• add missing method check, if try to use schema validation in controller methods
• (bug-)fixes

0.14.0

• BREAKING CHANGE: DELETE(), HEAD(), OPTIONS() and TRACE() decorators do not support bodies anymore: https://specs.openstack.org/openstack/api-wg/guidelines/http/methods.html
• add apiKey() middleware
• cleanup tests
• made versions in package.json explicit

0.13.1

• add missing export of ValidationErrorHandler() decorator
• npm update
• (bug-)fixes

0.12.0

• optimize readStreamWithLimit() function
• npm update

0.11.0

• add yaml() middleware
• add optional encoding props for options of json() and text() middlewares

0.10.0

• add text() middleware
• npm update
• fix, cleanup and improve documentation

0.9.1

• bugfixes
• npm update

0.8.0

• implement ValidationErrorHandler() decorator
• add VSCode debugger settings
• bugfixes

0.7.0

• implement controller framework, similar to express-controllers:
  • decorators for CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, TRACE HTTP methods
  • decorators for setting up custom, controller-wide serializers and error handlers
• code cleanups and improvements
• bugfixes

0.6.0

• add prettyErrors() error handler
• fix tests

0.5.0

• BREAKING CHANGE: replace use of querystring with URLSearchParams
• add cookies() and lang() middlewares
• cleanup documentation
• add optional TBody type parameter to IHttpRequest interface to describe body property
• npm update

0.4.0

• add validate() middleware
• add schema namespace as joi alias
• fix documentation
• bugfixes

0.3.1

• add query() middleware
• fix params() path validator
• fix README
• fixes in path validation

0.2.2

• add params() middleware
• next() function of a middleware can receive an error object now
• make sure, that all handlers and middlewares are async functions now
• update type descriptions for handlers and middlewars
• (bug-)fixes

0.1.2

• initial release