Merge branch 'master' into fix-generate-order

README.md

@@ -1,7 +1,6 @@
 # HMAC Auth Express
 
 [![npm](https://img.shields.io/npm/v/hmac-auth-express)](https://www.npmjs.com/package/hmac-auth-express)
-[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/connorjburton/hmac-auth-express/Node.js%20CI)](https://github.com/connorjburton/hmac-auth-express/actions/workflows/ci.yml)
 [![GitHub](https://img.shields.io/github/license/connorjburton/hmac-auth-express)](https://github.com/connorjburton/hmac-auth-express/blob/master/LICENSE)
 
 This package provides [Express](https://expressjs.com/) middleware for [HMAC](https://en.wikipedia.org/wiki/HMAC) authentication.

docs/classes/AuthError.html

@@ -22,7 +22,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">AuthError</span></li></ul></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/ba66fac/src/errors.ts#L1">src/errors.ts:1</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/b5982f5/src/errors.ts#L1">src/errors.ts:1</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -64,7 +64,7 @@ <h5><span class="tsd-kind-parameter">message</span>: <span class="tsd-signature-
 <h4 class="tsd-returns-title">Returns <a href="AuthError.html" class="tsd-signature-type tsd-kind-class">AuthError</a></h4><aside class="tsd-sources">
 <p>Overrides Error.constructor</p>
 <ul>
-<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/ba66fac/src/errors.ts#L7">src/errors.ts:7</a></li></ul></aside></li></ul></section></section>
+<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/b5982f5/src/errors.ts#L7">src/errors.ts:7</a></li></ul></aside></li></ul></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Properties</h2>
 <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a>
@@ -77,7 +77,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
 <h3 class="tsd-anchor-link"><span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/ba66fac/src/errors.ts#L2">src/errors.ts:2</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/b5982f5/src/errors.ts#L2">src/errors.ts:2</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
@@ -100,17 +100,17 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
 <h3 class="tsd-anchor-link"><span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/ba66fac/src/errors.ts#L3">src/errors.ts:3</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/b5982f5/src/errors.ts#L3">src/errors.ts:3</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="statusCode" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>status<wbr/>Code</span><a href="#statusCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">status<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/ba66fac/src/errors.ts#L4">src/errors.ts:4</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/b5982f5/src/errors.ts#L4">src/errors.ts:4</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="status_code" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>status_<wbr/>code</span><a href="#status_code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">status_<wbr/>code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/ba66fac/src/errors.ts#L5">src/errors.ts:5</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/b5982f5/src/errors.ts#L5">src/errors.ts:5</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div>

docs/functions/HMAC.html

@@ -28,7 +28,7 @@ <h5><span class="tsd-kind-parameter">secret</span>: <a href="../types/DynamicSec
 <h5><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Options.html" class="tsd-signature-type tsd-kind-interface">Options</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = {}</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">RequestHandler</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/ba66fac/src/index.ts#L80">src/index.ts:80</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/b5982f5/src/index.ts#L80">src/index.ts:80</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/functions/generate.html

@@ -38,7 +38,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
 <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <a href="../interfaces/GenerateOptions.html" class="tsd-signature-type tsd-kind-interface">GenerateOptions</a></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Hmac</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/ba66fac/src/generate.ts#L27">src/generate.ts:27</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/b5982f5/src/generate.ts#L27">src/generate.ts:27</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/functions/order-1.html

@@ -26,7 +26,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5><span class="tsd-kind-parameter">o</span>: <a href="../types/UnknownObject.html" class="tsd-signature-type tsd-kind-type-alias">UnknownObject</a></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="../types/UnknownObject.html" class="tsd-signature-type tsd-kind-type-alias">UnknownObject</a></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/ba66fac/src/order.ts#L3">src/order.ts:3</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/b5982f5/src/order.ts#L3">src/order.ts:3</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/index.html

@@ -13,7 +13,6 @@
 <div class="tsd-page-title">
 <h2>hmac-auth-express</h2></div>
 <div class="tsd-panel tsd-typography"><a id="md:hmac-auth-express" class="tsd-anchor"></a><h1><a href="#md:hmac-auth-express">HMAC Auth Express</a></h1><p><a href="https://www.npmjs.com/package/hmac-auth-express"><img src="https://img.shields.io/npm/v/hmac-auth-express" alt="npm"></a>
-<a href="https://github.com/connorjburton/hmac-auth-express/actions/workflows/ci.yml"><img src="https://img.shields.io/github/workflow/status/connorjburton/hmac-auth-express/Node.js%20CI" alt="GitHub Workflow Status"></a>
 <a href="https://github.com/connorjburton/hmac-auth-express/blob/master/LICENSE"><img src="https://img.shields.io/github/license/connorjburton/hmac-auth-express" alt="GitHub"></a></p>
 <p>This package provides <a href="https://expressjs.com/">Express</a> middleware for <a href="https://en.wikipedia.org/wiki/HMAC">HMAC</a> authentication.</p>
 <ul>

docs/interfaces/GenerateOptions.html

@@ -20,7 +20,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">GenerateOptions</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/ba66fac/src/generate.ts#L4">src/generate.ts:4</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/b5982f5/src/generate.ts#L4">src/generate.ts:4</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -36,7 +36,7 @@ <h2>Properties</h2>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>order</span><a href="#order" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">order</span><span class="tsd-signature-symbol">?:</span> <a href="../types/Order.html" class="tsd-signature-type tsd-kind-type-alias">Order</a></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/ba66fac/src/generate.ts#L5">src/generate.ts:5</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/b5982f5/src/generate.ts#L5">src/generate.ts:5</a></li></ul></aside></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/interfaces/Options.html

@@ -20,7 +20,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">Options</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/ba66fac/src/index.ts#L24">src/index.ts:24</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/b5982f5/src/index.ts#L24">src/index.ts:24</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -45,7 +45,7 @@ <h3 class="tsd-anchor-link"><span>algorithm</span><a href="#algorithm" aria-labe
 </div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/ba66fac/src/index.ts#L30">src/index.ts:30</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/b5982f5/src/index.ts#L30">src/index.ts:30</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="header" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>header</span><a href="#header" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">header</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
@@ -54,7 +54,7 @@ <h3 class="tsd-anchor-link"><span>header</span><a href="#header" aria-label="Per
 </div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/ba66fac/src/index.ts#L42">src/index.ts:42</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/b5982f5/src/index.ts#L42">src/index.ts:42</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="identifier" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>identifier</span><a href="#identifier" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">identifier</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
@@ -63,7 +63,7 @@ <h3 class="tsd-anchor-link"><span>identifier</span><a href="#identifier" aria-la
 </div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/ba66fac/src/index.ts#L36">src/index.ts:36</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/b5982f5/src/index.ts#L36">src/index.ts:36</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="maxInterval" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>max<wbr/>Interval</span><a href="#maxInterval" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">max<wbr/>Interval</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
@@ -74,7 +74,7 @@ <h3 class="tsd-anchor-link"><span>max<wbr/>Interval</span><a href="#maxInterval"
 </div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/ba66fac/src/index.ts#L50">src/index.ts:50</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/b5982f5/src/index.ts#L50">src/index.ts:50</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="minInterval" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>min<wbr/>Interval</span><a href="#minInterval" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">min<wbr/>Interval</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
@@ -85,15 +85,15 @@ <h3 class="tsd-anchor-link"><span>min<wbr/>Interval</span><a href="#minInterval"
 </div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/ba66fac/src/index.ts#L58">src/index.ts:58</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/b5982f5/src/index.ts#L58">src/index.ts:58</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="order" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>order</span><a href="#order" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">order</span><span class="tsd-signature-symbol">?:</span> <a href="../types/Order.html" class="tsd-signature-type tsd-kind-type-alias">Order</a></div>
 <div class="tsd-comment tsd-typography"><p>Optional function to order your object before stringifying, see <a href="https://github.com/connorjburton/hmac-auth-express#how-to-handle-non-deterministic-json">How to handle non-deterministic JSON</a></p>
 </div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/ba66fac/src/index.ts#L62">src/index.ts:62</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/b5982f5/src/index.ts#L62">src/index.ts:62</a></li></ul></aside></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/types/DynamicSecret.html

@@ -47,7 +47,7 @@ <h5><span class="tsd-kind-parameter">req</span>: <span class="tsd-signature-type
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/ba66fac/src/index.ts#L18">src/index.ts:18</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/b5982f5/src/index.ts#L18">src/index.ts:18</a></li></ul></aside></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/types/Order.html

@@ -30,7 +30,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5><span class="tsd-kind-parameter">o</span>: <a href="UnknownObject.html" class="tsd-signature-type tsd-kind-type-alias">UnknownObject</a></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="UnknownObject.html" class="tsd-signature-type tsd-kind-type-alias">UnknownObject</a></h4></li></ul></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/ba66fac/src/index.ts#L22">src/index.ts:22</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/connorjburton/hmac-auth-express/blob/b5982f5/src/index.ts#L22">src/index.ts:22</a></li></ul></aside></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">