npm - @openaddresses/batch-schema - Versions diffs - 9.3.0 → 10.0.0 - Mend

@openaddresses/batch-schema 9.3.0 → 10.0.0

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.

Files changed (45) hide show

package/.eslintrc.json +5 -47
package/.github/workflows/release.yml +5 -2
package/CHANGELOG.md +8 -0
package/LICENSE +1 -1
package/README.md +21 -17
package/{routes/schema.js → lib/api.ts} +11 -4
package/lib/openapi.ts +122 -0
package/lib/schema.ts +293 -0
package/lib/types.ts +32 -0
package/package.json +16 -11
package/test/{schema.srv.test.js → schema.srv.test.ts} +9 -20
package/tsconfig.json +27 -0
package/docs/assets/anchor.js +0 -350
package/docs/assets/bass-addons.css +0 -12
package/docs/assets/bass.css +0 -544
package/docs/assets/fonts/EOT/SourceCodePro-Bold.eot +0 -0
package/docs/assets/fonts/EOT/SourceCodePro-Regular.eot +0 -0
package/docs/assets/fonts/LICENSE.txt +0 -93
package/docs/assets/fonts/OTF/SourceCodePro-Bold.otf +0 -0
package/docs/assets/fonts/OTF/SourceCodePro-Regular.otf +0 -0
package/docs/assets/fonts/TTF/SourceCodePro-Bold.ttf +0 -0
package/docs/assets/fonts/TTF/SourceCodePro-Regular.ttf +0 -0
package/docs/assets/fonts/WOFF/OTF/SourceCodePro-Bold.otf.woff +0 -0
package/docs/assets/fonts/WOFF/OTF/SourceCodePro-Regular.otf.woff +0 -0
package/docs/assets/fonts/WOFF/TTF/SourceCodePro-Bold.ttf.woff +0 -0
package/docs/assets/fonts/WOFF/TTF/SourceCodePro-Regular.ttf.woff +0 -0
package/docs/assets/fonts/WOFF2/OTF/SourceCodePro-Bold.otf.woff2 +0 -0
package/docs/assets/fonts/WOFF2/OTF/SourceCodePro-Regular.otf.woff2 +0 -0
package/docs/assets/fonts/WOFF2/TTF/SourceCodePro-Bold.ttf.woff2 +0 -0
package/docs/assets/fonts/WOFF2/TTF/SourceCodePro-Regular.ttf.woff2 +0 -0
package/docs/assets/fonts/source-code-pro.css +0 -23
package/docs/assets/github.css +0 -123
package/docs/assets/site.js +0 -168
package/docs/assets/split.css +0 -15
package/docs/assets/split.js +0 -782
package/docs/assets/style.css +0 -147
package/docs/index.html +0 -792
package/lib/middleware.js +0 -159
package/lib/openapi.js +0 -96
package/lib/param.js +0 -29
package/lib/schema.js +0 -254
package/schema/req.query.ListSchema.json +0 -25
package/schema/res.ListSchema.json +0 -47
package/test/schema.test.js +0 -33
/package/{index.js → index.ts} +0 -0

package/docs/index.html DELETED Viewed

@@ -1,792 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-  <meta charset='utf-8'>
-  <title>@openaddresses/batch-schema 3.1.3 | Documentation</title>
-  <meta name='description' content='Strongly Validated JSON Schema support for address'>
-  <meta name='viewport' content='width=device-width,initial-scale=1'>
-  <link href='assets/bass.css' rel='stylesheet'>
-  <link href='assets/style.css' rel='stylesheet'>
-  <link href='assets/github.css' rel='stylesheet'>
-  <link href='assets/split.css' rel='stylesheet'>
-</head>
-<body class='documentation m0'>
-    <div class='flex'>
-      <div id='split-left' class='overflow-auto fs0 height-viewport-100'>
-        <div class='py1 px2'>
-          <h3 class='mb0 no-anchor'>@openaddresses/batch-schema</h3>
-          <div class='mb1'><code>3.1.3</code></div>
-          <input
-            placeholder='Filter'
-            id='filter-input'
-            class='col12 block input'
-            spellcheck='false'
-            autocapitalize='off'
-            autocorrect='off'
-            type='text' />
-          <div id='toc'>
-            <ul class='list-reset h5 py1-ul'>
-                <li><a
-                  href='#param'
-                  class="">
-                  Param
-                </a>
-                </li>
-                <li><a
-                  href='#schemas'
-                  class=" toggle-sibling">
-                  Schemas
-                  <span class='icon'>▸</span>
-                </a>
-                <div class='toggle-target display-none'>
-                  <ul class='list-reset py1-ul pl1'>
-                    <li class='h5'><span>Static members</span></li>
-                      <li><a
-                        href='#schemasparam'
-                        class='regular pre-open'>
-                        .param
-                      </a></li>
-                      <li><a
-                        href='#schemasquery'
-                        class='regular pre-open'>
-                        .query
-                      </a></li>
-                    </ul>
-                    <ul class='list-reset py1-ul pl1'>
-                      <li class='h5'><span>Instance members</span></li>
-                      <li><a
-                        href='#schemasquery'
-                        class='regular pre-open'>
-                        #query
-                      </a></li>
-                      <li><a
-                        href='#schemasnot_found'
-                        class='regular pre-open'>
-                        #not_found
-                      </a></li>
-                      <li><a
-                        href='#schemaserror'
-                        class='regular pre-open'>
-                        #error
-                      </a></li>
-                      <li><a
-                        href='#schemaslist'
-                        class='regular pre-open'>
-                        #list
-                      </a></li>
-                    </ul>
-                </div>
-                </li>
-                <li><a
-                  href='#get'
-                  class="">
-                  get
-                </a>
-                </li>
-                <li><a
-                  href='#publicerror'
-                  class="">
-                  PublicError
-                </a>
-                </li>
-            </ul>
-          </div>
-          <div class='mt1 h6 quiet'>
-            <a href='https://documentation.js.org/reading-documentation.html'>Need help reading this?</a>
-          </div>
-        </div>
-      </div>
-      <div id='split-right' class='relative overflow-auto height-viewport-100'>
-          <section class='p2 mb2 clearfix bg-white minishadow'>
-  <div class='clearfix'>
-    <h3 class='fl m0' id='param'>
-      Param
-    </h3>
-  </div>
-    <div class='pre p1 fill-light mt0'>new Param()</div>
-</section>
-          <section class='p2 mb2 clearfix bg-white minishadow'>
-  <div class='clearfix'>
-    <h3 class='fl m0' id='schemas'>
-      Schemas
-    </h3>
-  </div>
-    <div class='pre p1 fill-light mt0'>new Schemas(router: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>, opts: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>)</div>
-    <div class='py1 quiet mt1 prose-big'>Parameters</div>
-    <div class='prose'>
-        <div class='space-bottom0'>
-          <div>
-            <span class='code bold'>router</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>)</code>
-	    Express Router Object
-          </div>
-        </div>
-        <div class='space-bottom0'>
-          <div>
-            <span class='code bold'>opts</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>
-            = <code>{}</code>)</code>
-	    Options Object
-          </div>
-        </div>
-    </div>
-    <div class='py1 quiet mt1 prose-big'>Static Members</div>
-    <div class="clearfix">
-    <div class='border-bottom' id='schemasparam'>
-      <div class="clearfix small pointer toggle-sibling">
-        <div class="py1 contain">
-            <a class='icon pin-right py1 dark-link caret-right'>▸</a>
-            <span class='code strong strong truncate'>param(match, type)</span>
-        </div>
-      </div>
-      <div class="clearfix display-none toggle-target">
-        <section class='p2 mb2 clearfix bg-white minishadow'>
-  <p>Express middleware to identify express params that should be integers/number/booleans
-according to the schema and attempt to cast them as such to ensure they pass the schema</p>
-    <div class='pre p1 fill-light mt0'>param(match: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>, type: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function">Function</a></div>
-    <div class='py1 quiet mt1 prose-big'>Parameters</div>
-    <div class='prose'>
-        <div class='space-bottom0'>
-          <div>
-            <span class='code bold'>match</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>)</code>
-	    Express Param
-          </div>
-        </div>
-        <div class='space-bottom0'>
-          <div>
-            <span class='code bold'>type</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>)</code>
-	    Type to coerce it to
-          </div>
-        </div>
-    </div>
-      <div class='py1 quiet mt1 prose-big'>Returns</div>
-      <code><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function">Function</a></code>:
-</section>
-      </div>
-    </div>
-    <div class='border-bottom' id='schemasquery'>
-      <div class="clearfix small pointer toggle-sibling">
-        <div class="py1 contain">
-            <a class='icon pin-right py1 dark-link caret-right'>▸</a>
-            <span class='code strong strong truncate'>query(schema)</span>
-        </div>
-      </div>
-      <div class="clearfix display-none toggle-target">
-        <section class='p2 mb2 clearfix bg-white minishadow'>
-  <p>Express middleware to identify query params that should be integers/booleans according to the schema
-and attempt to cast them as such to ensure they pass the schema</p>
-    <div class='pre p1 fill-light mt0'>query(schema: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function">Function</a></div>
-    <div class='py1 quiet mt1 prose-big'>Parameters</div>
-    <div class='prose'>
-        <div class='space-bottom0'>
-          <div>
-            <span class='code bold'>schema</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>)</code>
-	    JSON Schema
-          </div>
-        </div>
-    </div>
-      <div class='py1 quiet mt1 prose-big'>Returns</div>
-      <code><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function">Function</a></code>:
-</section>
-      </div>
-    </div>
-</div>
-    <div class='py1 quiet mt1 prose-big'>Instance Members</div>
-    <div class="clearfix">
-    <div class='border-bottom' id='schemasquery'>
-      <div class="clearfix small pointer toggle-sibling">
-        <div class="py1 contain">
-            <a class='icon pin-right py1 dark-link caret-right'>▸</a>
-            <span class='code strong strong truncate'>query(method, url)</span>
-        </div>
-      </div>
-      <div class="clearfix display-none toggle-target">
-        <section class='p2 mb2 clearfix bg-white minishadow'>
-  <p>Return all schemas (body, query, etc) for a given method + url</p>
-    <div class='pre p1 fill-light mt0'>query(method: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>, url: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></div>
-    <div class='py1 quiet mt1 prose-big'>Parameters</div>
-    <div class='prose'>
-        <div class='space-bottom0'>
-          <div>
-            <span class='code bold'>method</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>)</code>
-	    HTTP Method
-          </div>
-        </div>
-        <div class='space-bottom0'>
-          <div>
-            <span class='code bold'>url</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>)</code>
-	    URL
-          </div>
-        </div>
-    </div>
-      <div class='py1 quiet mt1 prose-big'>Returns</div>
-      <code><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></code>:
-</section>
-      </div>
-    </div>
-    <div class='border-bottom' id='schemasnot_found'>
-      <div class="clearfix small pointer toggle-sibling">
-        <div class="py1 contain">
-            <a class='icon pin-right py1 dark-link caret-right'>▸</a>
-            <span class='code strong strong truncate'>not_found()</span>
-        </div>
-      </div>
-      <div class="clearfix display-none toggle-target">
-        <section class='p2 mb2 clearfix bg-white minishadow'>
-  <p>Catch all for unmatched routes</p>
-    <div class='pre p1 fill-light mt0'>not_found()</div>
-</section>
-      </div>
-    </div>
-    <div class='border-bottom' id='schemaserror'>
-      <div class="clearfix small pointer toggle-sibling">
-        <div class="py1 contain">
-            <a class='icon pin-right py1 dark-link caret-right'>▸</a>
-            <span class='code strong strong truncate'>error()</span>
-        </div>
-      </div>
-      <div class="clearfix display-none toggle-target">
-        <section class='p2 mb2 clearfix bg-white minishadow'>
-  <p>Convert validation errors into standardized JSON Error Messages</p>
-    <div class='pre p1 fill-light mt0'>error()</div>
-</section>
-      </div>
-    </div>
-    <div class='border-bottom' id='schemaslist'>
-      <div class="clearfix small pointer toggle-sibling">
-        <div class="py1 contain">
-            <a class='icon pin-right py1 dark-link caret-right'>▸</a>
-            <span class='code strong strong truncate'>list()</span>
-        </div>
-      </div>
-      <div class="clearfix display-none toggle-target">
-        <section class='p2 mb2 clearfix bg-white minishadow'>
-  <p>Return a list of endpoints with schemas</p>
-    <div class='pre p1 fill-light mt0'>list(): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></div>
-      <div class='py1 quiet mt1 prose-big'>Returns</div>
-      <code><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></code>:
-</section>
-      </div>
-    </div>
-</div>
-</section>
-          <section class='p2 mb2 clearfix bg-white minishadow'>
-  <div class='clearfix'>
-    <h3 class='fl m0' id='get'>
-      get
-    </h3>
-  </div>
-    <div class='pre p1 fill-light mt0'>get</div>
-</section>
-          <section class='p2 mb2 clearfix bg-white minishadow'>
-  <div class='clearfix'>
-    <h3 class='fl m0' id='publicerror'>
-      PublicError
-    </h3>
-  </div>
-    <div class='pre p1 fill-light mt0'>new PublicError(status: any, err: any, safe: any, print: any)</div>
-    <div class='py1 quiet mt1 prose-big'>Parameters</div>
-    <div class='prose'>
-        <div class='space-bottom0'>
-          <div>
-            <span class='code bold'>status</span> <code class='quiet'>(any)</code>
-          </div>
-        </div>
-        <div class='space-bottom0'>
-          <div>
-            <span class='code bold'>err</span> <code class='quiet'>(any)</code>
-          </div>
-        </div>
-        <div class='space-bottom0'>
-          <div>
-            <span class='code bold'>safe</span> <code class='quiet'>(any)</code>
-          </div>
-        </div>
-        <div class='space-bottom0'>
-          <div>
-            <span class='code bold'>print</span> <code class='quiet'>(any
-            = <code>true</code>)</code>
-          </div>
-        </div>
-    </div>
-</section>
-      </div>
-    </div>
-  <script src='assets/anchor.js'></script>
-  <script src='assets/split.js'></script>
-  <script src='assets/site.js'></script>
-</body>
-</html>