@mimik/api-helper 1.1.1 → 1.1.3

package/README.md

@@ -31,12 +31,14 @@ Setup the API to be use for a service
 
 - <code>Promise</code> An error is thrown if the initiatilization failed.
 
-For the security schemes, the following scheme names are reserved: `SystemSecurity`, `AdminSecurity`, `UserSecurity`, `PeerSecurity`, `ApiKeySecurity`.
-The secOptions in the options porperty passed when using `init` allows the folloing operations:
-- introduce a customer sevurity scheme, in this case secOptions contains: { newSecurityScheme: {function}newSecurityHandler },
+The following scheme names are reserved: `SystemSecurity`, `AdminSecurity`, `UserSecurity`, `PeerSecurity`, `ApiKeySecurity`.
+The following security schemes can be defaulted: `SystemSecurity`, `AdminSecurity`, `UserSecurity`, `ApiKeySecurity`.
+The secOptions in the options property passed when using `init` allows the following operations:
+- introduce a customer security scheme, in this case secOptions contains: { newSecurityScheme: {function}newSecurityHandler },
 - disable a security scheme that is defined in the swagger API, in this case secOptions contains: { securitySchemeToDisable: { {boolean}notEnabled: true } },
 - overwite an existing security scheme, in this case secOptions contains: { securitySchemeToOverwrite: {function}newSecurityHandler }.
 If the secOptions is not present either to introduce, disable or overwrite a security scheme that is present in the swagger API file an error is generated.
+If the secOptions contains unused security schemes, an error is generated.
 
 The default formats for validation are: `date`, `time`, `date-time`, `byte`, `uuid`, `uri`, `email`, `ipv4`, `ipv6`, `semver`, `ip`.
 
@@ -44,9 +46,9 @@ The default formats for validation are: `date`, `time`, `date-time`, `byte`, `uu
 
 | Param | Type | Description |
 | --- | --- | --- |
-| setup | <code>object</code> | Object containing the apiFilename and the exisiting securitySchemes in the API definition. |
+| setup | <code>object</code> | Object containing the apiFilename and the exisiting security schemes in the API definition. |
 | registeredOperations | <code>object</code> | List of the operation to register for the API. |
-| securityHandlers | <code>object</code> | List of the securityHandlers to add for the service. |
+| securityHandlers | <code>object</code> | List of the security handlers to add for the service. |
 | extraFormats | <code>object</code> | list of the formats to add for validatng properties. |
 | config | <code>object</code> | Configuration of the service. |
 | correlationId | <code>UUID.&lt;string&gt;</code> | CorrelationId when logging activites. |

package/index.js

@@ -56,9 +56,9 @@ const {
  * @requires fs
  * @requires jsonwebtoken
  * @requires lodash
- * @param {object} setup -  Object containing the apiFilename and the exisiting securitySchemes in the API definition.
+ * @param {object} setup -  Object containing the apiFilename and the exisiting security schemes in the API definition.
  * @param {object} registeredOperations - List of the operation to register for the API.
- * @param {object} securityHandlers - List of the securityHandlers to add for the service.
+ * @param {object} securityHandlers - List of the security handlers to add for the service.
  * @param {object} extraFormats - list of the formats to add for validatng properties.
  * @param {object} config - Configuration of the service.
  * @param {UUID.<string>} correlationId - CorrelationId when logging activites.
@@ -66,12 +66,14 @@ const {
  * &fulfil {object} The API file itself.
  * @throws {Promise} An error is thrown if the initiatilization failed.
  *
- * For the security schemes, the following scheme names are reserved: `SystemSecurity`, `AdminSecurity`, `UserSecurity`, `PeerSecurity`, `ApiKeySecurity`.
- * The secOptions in the options porperty passed when using `init` allows the folloing operations:
- * - introduce a customer sevurity scheme, in this case secOptions contains: { newSecurityScheme: {function}newSecurityHandler },
+ * The following scheme names are reserved: `SystemSecurity`, `AdminSecurity`, `UserSecurity`, `PeerSecurity`, `ApiKeySecurity`.
+ * The following security schemes can be defaulted: `SystemSecurity`, `AdminSecurity`, `UserSecurity`, `ApiKeySecurity`.
+ * The secOptions in the options property passed when using `init` allows the following operations:
+ * - introduce a customer security scheme, in this case secOptions contains: { newSecurityScheme: {function}newSecurityHandler },
  * - disable a security scheme that is defined in the swagger API, in this case secOptions contains: { securitySchemeToDisable: { {boolean}notEnabled: true } },
  * - overwite an existing security scheme, in this case secOptions contains: { securitySchemeToOverwrite: {function}newSecurityHandler }.
  * If the secOptions is not present either to introduce, disable or overwrite a security scheme that is present in the swagger API file an error is generated.
+ * If the secOptions contains unused security schemes, an error is generated.
  *
  * The default formats for validation are: `date`, `time`, `date-time`, `byte`, `uuid`, `uri`, `email`, `ipv4`, `ipv6`, `semver`, `ip`.
  */
@@ -121,6 +123,9 @@ const apiSetup = (setup, registeredOperations, securityHandlers, extraFormats, c
 
   if (securityHandlers) {
     const securityHandlerNames = Object.keys(securityHandlers);
+    const unusedSecuritySchemes = difference(securityHandlerNames, definedSecuritySchemes);
+
+    if (unusedSecuritySchemes.length !== 0) throw getRichError('System', 'unused handlers for security schemes', { unusedSecuritySchemes });
 
     remainingSecurities.forEach((securityScheme) => {
       if (!securityHandlerNames.includes(securityScheme) && !securityHandlers[securityScheme].notEnabled) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mimik/api-helper",
-  "version": "1.1.1",
+  "version": "1.1.3",
   "description": "helper for openAPI backend and mimik service",
   "main": "index.js",
   "scripts": {