express-zod-api 5.0.0-beta1 → 5.0.0

package/CHANGELOG.md

@@ -2,12 +2,16 @@
 
 ## Version 5
 
+### v5.0.0
+
+- No changes.
+
 ### v5.0.0-beta1
 
 - The ability to configure and run an additional HTTPS server to process requests over a secure protocol.
 - This option is only available when using `createServer()` method.
 - **Breaking changes**: Instead of HTTP Server the method `createServer()` now returns an object with the following
-  entities: app, httpServer, httpsServer, logger.
+  entities: `app, httpServer, httpsServer, logger`.
 - New configuration option `https`:
 
 ```typescript
@@ -17,7 +21,6 @@ const config = createConfig({
   server: {
     listen: 80,
   },
-  cors: true,
   // enables HTTPS server as well
   https: {
     // at least "cert" and "key" options required
@@ -27,11 +30,17 @@ const config = createConfig({
     },
     listen: 443, // port or socket
   },
+  // ...
 });
 ```
 
 ## Version 4
 
+### v4.2.0
+
+- `express` version is 4.17.2.
+- `http-errors` version is 2.0.0.
+
 ### v4.1.0
 
 - Feature #230. The shorthand method `EndpointsFactory::addOptions()`.

package/README.md

@@ -38,14 +38,15 @@ Start your API server with I/O schema validation and custom middlewares in minut
    10. [Usage with your own express app](#usage-with-your-own-express-app)
    11. [Multiple schemas for one route](#multiple-schemas-for-one-route)
    12. [Customizing input sources](#customizing-input-sources)
-   13. [Exporting endpoint types to frontend](#exporting-endpoint-types-to-frontend)
-   14. [Creating a documentation](#creating-a-documentation)
+   13. [Enabling HTTPS](#enabling-https)
+   14. [Exporting endpoint types to frontend](#exporting-endpoint-types-to-frontend)
+   15. [Creating a documentation](#creating-a-documentation)
 5. [Known issues](#known-issues)
    1. [Excessive properties in endpoint output](#excessive-properties-in-endpoint-output)
 6. [Your input to my output](#your-input-to-my-output)
 
 You can find the release notes in [Changelog](CHANGELOG.md). Along with recommendations for migrating from
-[v3](CHANGELOG.md#v400), [v2](CHANGELOG.md#v300-beta1) and [v1](CHANGELOG.md#v200-beta1).
+[v4](CHANGELOG.md#v500-beta1), [v3](CHANGELOG.md#v400), [v2](CHANGELOG.md#v300-beta1) and [v1](CHANGELOG.md#v200-beta1).
 
 # Why and what is it for
 
@@ -573,6 +574,36 @@ createConfig({
 });
 ```
 
+## Enabling HTTPS
+
+The modern API standard often assumes the use of a secure data transfer protocol, confirmed by a TLS certificate, also
+often called an SSL certificate in habit. When using the `createServer()` method, you can additionally configure and
+run the HTTPS server.
+
+```typescript
+import { createConfig, createServer } from "express-zod-api";
+
+const config = createConfig({
+  server: {
+    listen: 80,
+  },
+  https: {
+    options: {
+      cert: fs.readFileSync("fullchain.pem", "utf-8"),
+      key: fs.readFileSync("privkey.pem", "utf-8"),
+    },
+    listen: 443, // port or socket
+  },
+  // ... cors, logger, etc
+});
+
+const { app, httpServer, httpsServer, logger } = createServer(config, routing);
+```
+
+At least you need to specify the port or socket (usually it is 443), certificate and the key, issued by the
+certifying authority. For example, you can acquire a free TLS certificate for your API at
+[Let's Encrypt](https://letsencrypt.org/).
+
 ## Exporting endpoint types to frontend
 
 You can export only the types of your endpoints for your frontend. Here is an approach:

package/SECURITY.md

@@ -4,9 +4,10 @@
 
 | Version | Supported          |
 | ------- | ------------------ |
+| 5.x.x   | :white_check_mark: |
 | 4.x.x   | :white_check_mark: |
 | 3.x.x   | :white_check_mark: |
-| 2.x.x   | :white_check_mark: |
+| 2.x.x   | :x:                |
 | 1.x.x   | :x:                |
 | 0.x.x   | :x:                |
 

package/dist/startup-logo.js

@@ -17,7 +17,7 @@ const getStartupLogo = () => {
 8888888888 888  888 88888P"  888     "Y8888   88888P'  88888P'      d8888888888 "Y88P"   "Y88888      d88P     888 888       8888888
                     888
                     888                                                                      Proudly supports transgender community.
-for Sharlie         888                          Start your API server with I/O schema validation and custom middlewares in minutes.
+for Ella            888                          Start your API server with I/O schema validation and custom middlewares in minutes.
                                                                             Thank you for choosing Express Zod API for your project.
 
 

package/dist-esm/package.json

@@ -1 +1 @@
-{"type":"module","version":"5.0.0-beta1"}
+{"type":"module","version":"5.0.0"}

package/dist-esm/startup-logo.js

@@ -14,7 +14,7 @@ export const getStartupLogo = () => {
 8888888888 888  888 88888P"  888     "Y8888   88888P'  88888P'      d8888888888 "Y88P"   "Y88888      d88P     888 888       8888888
                     888
                     888                                                                      Proudly supports transgender community.
-for Sharlie         888                          Start your API server with I/O schema validation and custom middlewares in minutes.
+for Ella            888                          Start your API server with I/O schema validation and custom middlewares in minutes.
                                                                             Thank you for choosing Express Zod API for your project.
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-zod-api",
-  "version": "5.0.0-beta1",
+  "version": "5.0.0",
   "description": "A Typescript library to help you get an API server up and running with I/O schema validation and custom middlewares in minutes.",
   "license": "MIT",
   "scripts": {
@@ -34,9 +34,9 @@
     "import": "./dist-esm/index.js"
   },
   "dependencies": {
-    "express": "4.17.1",
+    "express": "4.17.2",
     "express-fileupload": "1.2.1",
-    "http-errors": "1.8.1",
+    "http-errors": "2.0.0",
     "mime": "3.0.0",
     "openapi3-ts": "2.0.1",
     "ramda": "0.27.1",