quantumcoin 7.0.9 → 7.0.11

package/examples/node_modules/resolve-pkg-maps/README.md

@@ -0,0 +1,216 @@
+# resolve-pkg-maps
+
+Utils to resolve `package.json` subpath & conditional [`exports`](https://nodejs.org/api/packages.html#exports)/[`imports`](https://nodejs.org/api/packages.html#imports) in resolvers.
+
+Implements the [ESM resolution algorithm](https://nodejs.org/api/esm.html#resolver-algorithm-specification). Tested [against Node.js](/tests/) for accuracy.
+
+<sub>Support this project by ⭐️ starring and sharing it. [Follow me](https://github.com/privatenumber) to see what other cool projects I'm working on! ❤️</sub>
+
+## Usage
+
+### Resolving `exports`
+
+_utils/package.json_
+```json5
+{
+    // ...
+    "exports": {
+        "./reverse": {
+            "require": "./file.cjs",
+            "default": "./file.mjs"
+        }
+    },
+    // ...
+}
+```
+
+```ts
+import { resolveExports } from 'resolve-pkg-maps'
+
+const [packageName, packageSubpath] = parseRequest('utils/reverse')
+
+const resolvedPaths: string[] = resolveExports(
+    getPackageJson(packageName).exports,
+    packageSubpath,
+    ['import', ...otherConditions]
+)
+// => ['./file.mjs']
+```
+
+### Resolving `imports`
+
+_package.json_
+```json5
+{
+    // ...
+    "imports": {
+        "#supports-color": {
+            "node": "./index.js",
+            "default": "./browser.js"
+        }
+    },
+    // ...
+}
+```
+
+```ts
+import { resolveImports } from 'resolve-pkg-maps'
+
+const resolvedPaths: string[] = resolveImports(
+    getPackageJson('.').imports,
+    '#supports-color',
+    ['node', ...otherConditions]
+)
+// => ['./index.js']
+```
+
+## API
+
+### resolveExports(exports, request, conditions)
+
+Returns: `string[]`
+
+Resolves the `request` based on `exports` and `conditions`. Returns an array of paths (e.g. in case a fallback array is matched).
+
+#### exports
+
+Type:
+```ts
+type Exports = PathOrMap | readonly PathOrMap[]
+
+type PathOrMap = string | PathConditionsMap
+
+type PathConditionsMap = {
+    [condition: string]: PathConditions | null
+}
+```
+
+The [`exports` property](https://nodejs.org/api/packages.html#exports) value in `package.json`.
+
+#### request
+
+Type: `string`
+
+The package subpath to resolve. Assumes a normalized path is passed in (eg. [repeating slashes `//`](https://github.com/nodejs/node/issues/44316)).
+
+It _should not_ start with `/` or `./`.
+
+Example: if the full import path is `some-package/subpath/file`, the request is `subpath/file`.
+
+
+#### conditions
+
+Type: `readonly string[]`
+
+An array of conditions to use when resolving the request. For reference, Node.js's default conditions are [`['node', 'import']`](https://nodejs.org/api/esm.html#:~:text=defaultConditions%20is%20the%20conditional%20environment%20name%20array%2C%20%5B%22node%22%2C%20%22import%22%5D.).
+
+The order of this array does not matter; the order of condition keys in the export map is what matters instead.
+
+Not all conditions in the array need to be met to resolve the request. It just needs enough to resolve to a path.
+
+---
+
+### resolveImports(imports, request, conditions)
+
+Returns: `string[]`
+
+Resolves the `request` based on `imports` and `conditions`. Returns an array of paths (e.g. in case a fallback array is matched).
+
+#### imports
+
+Type:
+```ts
+type Imports = {
+    [condition: string]: PathOrMap | readonly PathOrMap[] | null
+}
+
+type PathOrMap = string | Imports
+```
+
+The [`imports` property](https://nodejs.org/api/packages.html#imports) value in `package.json`.
+
+
+#### request
+
+Type: `string`
+
+The request resolve. Assumes a normalized path is passed in (eg. [repeating slashes `//`](https://github.com/nodejs/node/issues/44316)).
+
+> **Note:** In Node.js, imports resolutions are limited to requests prefixed with `#`. However, this package does not enforce that requirement in case you want to add custom support for non-prefixed entries.
+
+#### conditions
+
+Type: `readonly string[]`
+
+An array of conditions to use when resolving the request. For reference, Node.js's default conditions are [`['node', 'import']`](https://nodejs.org/api/esm.html#:~:text=defaultConditions%20is%20the%20conditional%20environment%20name%20array%2C%20%5B%22node%22%2C%20%22import%22%5D.).
+
+The order of this array does not matter; the order of condition keys in the import map is what matters instead.
+
+Not all conditions in the array need to be met to resolve the request. It just needs enough to resolve to a path.
+
+---
+
+### Errors
+
+#### `ERR_PACKAGE_PATH_NOT_EXPORTED`
+ - If the request is not exported by the export map
+
+#### `ERR_PACKAGE_IMPORT_NOT_DEFINED`
+  - If the request is not defined by the import map
+
+#### `ERR_INVALID_PACKAGE_CONFIG`
+
+  - If an object contains properties that are both paths and conditions (e.g. start with and without `.`)
+  - If an object contains numeric properties 
+  
+#### `ERR_INVALID_PACKAGE_TARGET`
+  - If a resolved exports path is not a valid path (e.g. not relative or has protocol)
+  - If a resolved path includes `..` or `node_modules`
+  - If a resolved path is a type that cannot be parsed
+
+## FAQ
+
+### Why do the APIs return an array of paths?
+
+`exports`/`imports` supports passing in a [fallback array](https://github.com/jkrems/proposal-pkg-exports/#:~:text=Whenever%20there%20is,to%20new%20cases.) to provide fallback paths if the previous one is invalid:
+
+```json5
+{
+    "exports": {
+        "./feature": [
+            "./file.js",
+            "./fallback.js"
+        ]
+    }
+}
+```
+
+Node.js's implementation [picks the first valid path (without attempting to resolve it)](https://github.com/nodejs/node/issues/44282#issuecomment-1220151715) and throws an error if it can't be resolved. Node.js's fallback array is designed for [forward compatibility with features](https://github.com/jkrems/proposal-pkg-exports/#:~:text=providing%20forwards%20compatiblitiy%20for%20new%20features) (e.g. protocols) that can be immediately/inexpensively validated:
+
+```json5
+{
+    "exports": {
+        "./core-polyfill": ["std:core-module", "./core-polyfill.js"]
+    }
+}
+```
+
+However, [Webpack](https://webpack.js.org/guides/package-exports/#alternatives) and [TypeScript](https://github.com/microsoft/TypeScript/blob/71e852922888337ef51a0e48416034a94a6c34d9/src/compiler/moduleSpecifiers.ts#L695) have deviated from this behavior and attempts to resolve the next path if a path cannot be resolved.
+
+By returning an array of matched paths instead of just the first one, the user can decide which behavior to adopt.
+
+### How is it different from [`resolve.exports`](https://github.com/lukeed/resolve.exports)?
+
+`resolve.exports` only resolves `exports`, whereas this package resolves both `exports` & `imports`. This comparison will only cover resolving `exports`.
+
+- Despite it's name, `resolve.exports` handles more than just `exports`. It takes in the entire `package.json` object to handle resolving `.` and [self-references](https://nodejs.org/api/packages.html#self-referencing-a-package-using-its-name). This package only accepts `exports`/`imports` maps from `package.json` and is scoped to only resolving what's defined in the maps.
+
+- `resolve.exports` accepts the full request (e.g. `foo/bar`), whereas this package only accepts the requested subpath (e.g. `bar`).
+
+- `resolve.exports` only returns the first result in a fallback array. This package returns an array of results for the user to decide how to handle it.
+
+- `resolve.exports` supports [subpath folder mapping](https://nodejs.org/docs/latest-v16.x/api/packages.html#subpath-folder-mappings) (deprecated in Node.js v16 & removed in v17) but seems to [have a bug](https://github.com/lukeed/resolve.exports/issues/7). This package does not support subpath folder mapping because Node.js has removed it in favor of using subpath patterns.
+
+- Neither resolvers rely on a file-system
+
+This package also addresses many of the bugs in `resolve.exports`, demonstrated in [this test](/tests/exports/compare-resolve.exports.ts).

package/examples/node_modules/resolve-pkg-maps/dist/index.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});const d=r=>r!==null&&typeof r=="object",s=(r,t)=>Object.assign(new Error(`[${r}]: ${t}`),{code:r}),g="ERR_INVALID_PACKAGE_CONFIG",E="ERR_INVALID_PACKAGE_TARGET",I="ERR_PACKAGE_PATH_NOT_EXPORTED",P="ERR_PACKAGE_IMPORT_NOT_DEFINED",R=/^\d+$/,O=/^(\.{1,2}|node_modules)$/i,u=/\/|\\/;var h=(r=>(r.Export="exports",r.Import="imports",r))(h||{});const f=(r,t,n,o,c)=>{if(t==null)return[];if(typeof t=="string"){const[e,...i]=t.split(u);if(e===".."||i.some(l=>O.test(l)))throw s(E,`Invalid "${r}" target "${t}" defined in the package config`);return[c?t.replace(/\*/g,c):t]}if(Array.isArray(t))return t.flatMap(e=>f(r,e,n,o,c));if(d(t)){for(const e of Object.keys(t)){if(R.test(e))throw s(g,"Cannot contain numeric property keys");if(e==="default"||o.includes(e))return f(r,t[e],n,o,c)}return[]}throw s(E,`Invalid "${r}" target "${t}"`)},a="*",v=(r,t)=>{const n=r.indexOf(a),o=t.indexOf(a);return n===o?t.length>r.length:o>n};function A(r,t){if(!t.includes(a)&&r.hasOwnProperty(t))return[t];let n,o;for(const c of Object.keys(r))if(c.includes(a)){const[e,i,l]=c.split(a);if(l===void 0&&t.startsWith(e)&&t.endsWith(i)){const _=t.slice(e.length,-i.length||void 0);_&&(!n||v(n,c))&&(n=c,o=_)}}return[n,o]}const p=r=>Object.keys(r).reduce((t,n)=>{const o=n===""||n[0]!==".";if(t===void 0||t===o)return o;throw s(g,'"exports" cannot contain some keys starting with "." and some not')},void 0),w=/^\w+:/,m=(r,t,n)=>{if(!r)throw new Error('"exports" is required');t=t===""?".":`./${t}`,(typeof r=="string"||Array.isArray(r)||d(r)&&p(r))&&(r={".":r});const[o,c]=A(r,t),e=f(h.Export,r[o],t,n,c);if(e.length===0)throw s(I,t==="."?'No "exports" main defined':`Package subpath '${t}' is not defined by "exports"`);for(const i of e)if(!i.startsWith("./")&&!w.test(i))throw s(E,`Invalid "exports" target "${i}" defined in the package config`);return e},T=(r,t,n)=>{if(!r)throw new Error('"imports" is required');const[o,c]=A(r,t),e=f(h.Import,r[o],t,n,c);if(e.length===0)throw s(P,`Package import specifier "${t}" is not defined in package`);return e};exports.resolveExports=m,exports.resolveImports=T;

package/examples/node_modules/resolve-pkg-maps/dist/index.d.cts

@@ -0,0 +1,11 @@
+type PathConditionsMap = {
+    [condition: string]: PathConditions | null;
+};
+type PathOrMap = string | PathConditionsMap;
+type PathConditions = PathOrMap | readonly PathOrMap[];
+
+declare const resolveExports: (exports: PathConditions, request: string, conditions: readonly string[]) => string[];
+
+declare const resolveImports: (imports: PathConditionsMap, request: string, conditions: readonly string[]) => string[];
+
+export { PathConditions, PathConditionsMap, resolveExports, resolveImports };

package/examples/node_modules/resolve-pkg-maps/dist/index.d.mts

@@ -0,0 +1,11 @@
+type PathConditionsMap = {
+    [condition: string]: PathConditions | null;
+};
+type PathOrMap = string | PathConditionsMap;
+type PathConditions = PathOrMap | readonly PathOrMap[];
+
+declare const resolveExports: (exports: PathConditions, request: string, conditions: readonly string[]) => string[];
+
+declare const resolveImports: (imports: PathConditionsMap, request: string, conditions: readonly string[]) => string[];
+
+export { PathConditions, PathConditionsMap, resolveExports, resolveImports };

package/examples/node_modules/resolve-pkg-maps/dist/index.mjs

@@ -0,0 +1 @@
+const A=r=>r!==null&&typeof r=="object",a=(r,t)=>Object.assign(new Error(`[${r}]: ${t}`),{code:r}),_="ERR_INVALID_PACKAGE_CONFIG",E="ERR_INVALID_PACKAGE_TARGET",I="ERR_PACKAGE_PATH_NOT_EXPORTED",P="ERR_PACKAGE_IMPORT_NOT_DEFINED",R=/^\d+$/,O=/^(\.{1,2}|node_modules)$/i,w=/\/|\\/;var h=(r=>(r.Export="exports",r.Import="imports",r))(h||{});const f=(r,t,e,o,c)=>{if(t==null)return[];if(typeof t=="string"){const[n,...i]=t.split(w);if(n===".."||i.some(l=>O.test(l)))throw a(E,`Invalid "${r}" target "${t}" defined in the package config`);return[c?t.replace(/\*/g,c):t]}if(Array.isArray(t))return t.flatMap(n=>f(r,n,e,o,c));if(A(t)){for(const n of Object.keys(t)){if(R.test(n))throw a(_,"Cannot contain numeric property keys");if(n==="default"||o.includes(n))return f(r,t[n],e,o,c)}return[]}throw a(E,`Invalid "${r}" target "${t}"`)},s="*",m=(r,t)=>{const e=r.indexOf(s),o=t.indexOf(s);return e===o?t.length>r.length:o>e};function d(r,t){if(!t.includes(s)&&r.hasOwnProperty(t))return[t];let e,o;for(const c of Object.keys(r))if(c.includes(s)){const[n,i,l]=c.split(s);if(l===void 0&&t.startsWith(n)&&t.endsWith(i)){const g=t.slice(n.length,-i.length||void 0);g&&(!e||m(e,c))&&(e=c,o=g)}}return[e,o]}const p=r=>Object.keys(r).reduce((t,e)=>{const o=e===""||e[0]!==".";if(t===void 0||t===o)return o;throw a(_,'"exports" cannot contain some keys starting with "." and some not')},void 0),u=/^\w+:/,v=(r,t,e)=>{if(!r)throw new Error('"exports" is required');t=t===""?".":`./${t}`,(typeof r=="string"||Array.isArray(r)||A(r)&&p(r))&&(r={".":r});const[o,c]=d(r,t),n=f(h.Export,r[o],t,e,c);if(n.length===0)throw a(I,t==="."?'No "exports" main defined':`Package subpath '${t}' is not defined by "exports"`);for(const i of n)if(!i.startsWith("./")&&!u.test(i))throw a(E,`Invalid "exports" target "${i}" defined in the package config`);return n},T=(r,t,e)=>{if(!r)throw new Error('"imports" is required');const[o,c]=d(r,t),n=f(h.Import,r[o],t,e,c);if(n.length===0)throw a(P,`Package import specifier "${t}" is not defined in package`);return n};export{v as resolveExports,T as resolveImports};

package/examples/node_modules/resolve-pkg-maps/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "resolve-pkg-maps",
+  "version": "1.0.0",
+  "description": "Resolve package.json exports & imports maps",
+  "keywords": [
+    "node.js",
+    "package.json",
+    "exports",
+    "imports"
+  ],
+  "license": "MIT",
+  "repository": "privatenumber/resolve-pkg-maps",
+  "funding": "https://github.com/privatenumber/resolve-pkg-maps?sponsor=1",
+  "author": {
+    "name": "Hiroki Osame",
+    "email": "hiroki.osame@gmail.com"
+  },
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.cts",
+  "exports": {
+    "require": {
+      "types": "./dist/index.d.cts",
+      "default": "./dist/index.cjs"
+    },
+    "import": {
+      "types": "./dist/index.d.mts",
+      "default": "./dist/index.mjs"
+    }
+  },
+  "imports": {
+    "#resolve-pkg-maps": {
+      "types": "./src/index.ts",
+      "development": "./src/index.ts",
+      "default": "./dist/index.mjs"
+    }
+  }
+}

package/examples/node_modules/seed-words/.github/workflows/publish-npmjs.yaml

@@ -0,0 +1,22 @@
+name: Publish Package to npmjs
+on:
+  workflow_dispatch:
+  
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write    
+    steps:
+      - uses: actions/checkout@v4
+      # Setup .npmrc file to publish to npm
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm install
+      - run: npm ci      
+      - run: npm publish --provenance --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/examples/node_modules/seed-words/BUILD.md

@@ -0,0 +1,7 @@
+## Generating Typescript Definitions
+
+    npx -p typescript tsc seedwords.js --declaration --allowJs --emitDeclarationOnly --outDir dist
+
+## Generating README.md
+
+    jsdoc2md seedwords.js >README.md

package/examples/node_modules/seed-words/LICENSE

@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

package/examples/node_modules/seed-words/README.md

@@ -0,0 +1,67 @@
+<a name="module_seed-words"></a>
+
+## seed-words
+Seed Words is a list of English words to be used in mnemonic seed phrases. There are a total of 256 x 256 = 65536 words. They can be used to represent any arbitrary 2 byte array with a single
+
+**Example**  
+```js
+Requires Node.js version v20.18.1 or higher
     if (initResult === false) {
         console.log("error initializing");
     } else {
        console.log("initialized");
     }
+```
+
+* [seed-words](#module_seed-words)
+    * [~initialize()](#module_seed-words..initialize) ⇒ <code>Promise.&lt;boolean&gt;</code>
+    * [~getAllSeedWords()](#module_seed-words..getAllSeedWords) ⇒ <code>array</code>
+    * [~getWordListFromSeedArray(seedArray)](#module_seed-words..getWordListFromSeedArray) ⇒ <code>array</code>
+    * [~getSeedArrayFromWordList(wordList)](#module_seed-words..getSeedArrayFromWordList) ⇒ <code>array</code>
+    * [~doesSeedWordExist(word)](#module_seed-words..doesSeedWordExist) ⇒ <code>boolean</code>
+
+<a name="module_seed-words..initialize"></a>
+
+### seed-words~initialize() ⇒ <code>Promise.&lt;boolean&gt;</code>
+The initialize function has to be called before attempting to invoke any other function. This function should be called only once.
+
+**Kind**: inner method of [<code>seed-words</code>](#module_seed-words)  
+**Returns**: <code>Promise.&lt;boolean&gt;</code> - Returns a promise of type boolean; true if the initialization succeeded, else false.  
+<a name="module_seed-words..getAllSeedWords"></a>
+
+### seed-words~getAllSeedWords() ⇒ <code>array</code>
+The getAllSeedWords function returns all the seed words in an array.
+
+**Kind**: inner method of [<code>seed-words</code>](#module_seed-words)  
+**Returns**: <code>array</code> - Returns an array with the list of all seed words.  
+<a name="module_seed-words..getWordListFromSeedArray"></a>
+
+### seed-words~getWordListFromSeedArray(seedArray) ⇒ <code>array</code>
+The getWordListFromSeedArray function returns the word list corresponding to a byte array.
+
+**Kind**: inner method of [<code>seed-words</code>](#module_seed-words)  
+**Returns**: <code>array</code> - Returns the array of words (string) corresponding to the input seed array. Returns null on failure. This function can fail if the seedArray is invalid or initialize() hasn't been called.  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| seedArray | <code>array</code> | An array of bytes. This array should have an even number of elements. |
+
+<a name="module_seed-words..getSeedArrayFromWordList"></a>
+
+### seed-words~getSeedArrayFromWordList(wordList) ⇒ <code>array</code>
+The getSeedArrayFromWordList function a byte array that corresponds to the seed word list.
+
+**Kind**: inner method of [<code>seed-words</code>](#module_seed-words)  
+**Returns**: <code>array</code> - Returns an array of bytes that correspond to the wordList. Returns null on failure. This function can fail if initialize() function was not called or the word doesn't exist.  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| wordList | <code>array</code> | An array of seed words. |
+
+<a name="module_seed-words..doesSeedWordExist"></a>
+
+### seed-words~doesSeedWordExist(word) ⇒ <code>boolean</code>
+The doesSeedWordExist function returns the word list corresponding to a byte array.
+
+**Kind**: inner method of [<code>seed-words</code>](#module_seed-words)  
+**Returns**: <code>boolean</code> - Returns true if the seed word exists. Returns false if it doesn't exist. Returns null on failure. This function can fail if initialize() function was not called.  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| word | <code>string</code> | A seed word to find whether it exists in the list or not. |
+

package/examples/node_modules/seed-words/dist/seedwords.d.ts

@@ -0,0 +1,39 @@
+/**
+ * The initialize function has to be called before attempting to invoke any other function. This function should be called only once.
+ *
+ * @async
+ * @function initialize
+ * @return {Promise<boolean>} Returns a promise of type boolean; true if the initialization succeeded, else false.
+ */
+export function initialize(): Promise<boolean>;
+/**
+ * The getWordListFromSeedArray function returns the word list corresponding to a byte array.
+ *
+ * @function getWordListFromSeedArray
+ * @param {array} seedArray - An array of bytes. This array should have an even number of elements.
+ * @return {array} Returns the array of words (string) corresponding to the input seed array. Returns null on failure. This function can fail if the seedArray is invalid or initialize() hasn't been called.
+ */
+export function getWordListFromSeedArray(seedArray: any[]): any[];
+/**
+ * The doesSeedWordExist function returns the word list corresponding to a byte array.
+ *
+ * @function doesSeedWordExist
+ * @param {string} word - A seed word to find whether it exists in the list or not.
+ * @return {boolean} Returns true if the seed word exists. Returns false if it doesn't exist. Returns null on failure. This function can fail if initialize() function was not called.
+ */
+export function doesSeedWordExist(word: string): boolean;
+/**
+ * The getAllSeedWords function returns all the seed words in an array.
+ *
+ * @function getAllSeedWords
+ * @return {array} Returns an array with the list of all seed words.
+ */
+export function getAllSeedWords(): any[];
+/**
+ * The getSeedArrayFromWordList function a byte array that corresponds to the seed word list.
+ *
+ * @function getSeedArrayFromWordList
+ * @param {array} wordList - An array of seed words.
+ * @return {array} Returns an array of bytes that correspond to the wordList. Returns null on failure. This function can fail if initialize() function was not called or the word doesn't exist.
+ */
+export function getSeedArrayFromWordList(wordList: any[]): any[];

package/examples/node_modules/seed-words/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "seed-words",
+  "version": "1.0.2",
+  "description": "Seed Words JS SDK",
+  "main": "seedwords.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "npx -p typescript tsc seedwords.js --declaration --allowJs --emitDeclarationOnly --outDir dist && jsdoc2md seedwords.js >README.md"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/quantumcoinproject/seed-words.git"
+  },
+  "keywords": [
+    "seed-words",
+    "seed-phrases",
+    "mnemonics",
+    "seeds",
+    "quantumcoin"
+  ],
+  "author": "QuantumCoin Community",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/quantumcoinproject/seed-words/issues"
+  },
+  "homepage": "https://github.com/quantumcoinproject/seed-words#readme"
+}