threshold-elgamal 0.1.7 → 0.1.9

package/README.md

@@ -9,6 +9,10 @@ It was written as clearly as possible, modularized, and with long, explicit vari
 
 **This is not a cryptographically audited library, make sure you know what you are doing before using it.**
 
+## Documentation
+
+For a detailed list of exported types and functions, [click here](https://tenemo.github.io/threshold-elgamal/modules.html).
+
 ## Contributing
 
 The JavaScript/TypeScript ecosystem seems to be lacking in modern, functional ElGamal libraries that work out of the box with reasonable default (this library isn't at that point yet). All PRs are welcome.

package/docs/_config.yml

@@ -0,0 +1 @@
+_config.yml.midnight

package/docs/index.md

@@ -11,6 +11,10 @@ It was written as clearly as possible, modularized, and with long, explicit vari
 
 **This is not a cryptographically audited library, make sure you know what you are doing before using it.**
 
+## Documentation
+
+For a detailed list of exported types and functions, [click here](https://tenemo.github.io/threshold-elgamal/modules.html).
+
 ## Contributing
 
 The JavaScript/TypeScript ecosystem seems to be lacking in modern, functional ElGamal libraries that work out of the box with reasonable default (this library isn't at that point yet). All PRs are welcome.

package/docs/modules.md

@@ -40,7 +40,7 @@
 
 #### Defined in
 
-[types.ts:1](https://github.com/Tenemo/threshold-elgamal/blob/10f1361a99b0f5ef342dc456d82e69dcabbdeb55/src/types.ts#L1)
+[types.ts:1](https://github.com/Tenemo/threshold-elgamal/blob/c8e377965a04bb14f4a82cc78ceda3db769c4f77/src/types.ts#L1)
 
 ___
 
@@ -57,7 +57,7 @@ ___
 
 #### Defined in
 
-[types.ts:13](https://github.com/Tenemo/threshold-elgamal/blob/10f1361a99b0f5ef342dc456d82e69dcabbdeb55/src/types.ts#L13)
+[types.ts:13](https://github.com/Tenemo/threshold-elgamal/blob/c8e377965a04bb14f4a82cc78ceda3db769c4f77/src/types.ts#L13)
 
 ___
 
@@ -76,7 +76,7 @@ ___
 
 #### Defined in
 
-[types.ts:6](https://github.com/Tenemo/threshold-elgamal/blob/10f1361a99b0f5ef342dc456d82e69dcabbdeb55/src/types.ts#L6)
+[types.ts:6](https://github.com/Tenemo/threshold-elgamal/blob/c8e377965a04bb14f4a82cc78ceda3db769c4f77/src/types.ts#L6)
 
 ___
 
@@ -93,7 +93,7 @@ ___
 
 #### Defined in
 
-[types.ts:18](https://github.com/Tenemo/threshold-elgamal/blob/10f1361a99b0f5ef342dc456d82e69dcabbdeb55/src/types.ts#L18)
+[types.ts:18](https://github.com/Tenemo/threshold-elgamal/blob/c8e377965a04bb14f4a82cc78ceda3db769c4f77/src/types.ts#L18)
 
 ## Functions
 
@@ -118,7 +118,7 @@ The combined decryption factor.
 
 #### Defined in
 
-[thresholdElgamal.ts:129](https://github.com/Tenemo/threshold-elgamal/blob/10f1361a99b0f5ef342dc456d82e69dcabbdeb55/src/thresholdElgamal.ts#L129)
+[thresholdElgamal.ts:129](https://github.com/Tenemo/threshold-elgamal/blob/c8e377965a04bb14f4a82cc78ceda3db769c4f77/src/thresholdElgamal.ts#L129)
 
 ___
 
@@ -143,7 +143,7 @@ The combined public key.
 
 #### Defined in
 
-[thresholdElgamal.ts:103](https://github.com/Tenemo/threshold-elgamal/blob/10f1361a99b0f5ef342dc456d82e69dcabbdeb55/src/thresholdElgamal.ts#L103)
+[thresholdElgamal.ts:103](https://github.com/Tenemo/threshold-elgamal/blob/c8e377965a04bb14f4a82cc78ceda3db769c4f77/src/thresholdElgamal.ts#L103)
 
 ___
 
@@ -169,7 +169,7 @@ The result of the partial decryption.
 
 #### Defined in
 
-[thresholdElgamal.ts:116](https://github.com/Tenemo/threshold-elgamal/blob/10f1361a99b0f5ef342dc456d82e69dcabbdeb55/src/thresholdElgamal.ts#L116)
+[thresholdElgamal.ts:116](https://github.com/Tenemo/threshold-elgamal/blob/c8e377965a04bb14f4a82cc78ceda3db769c4f77/src/thresholdElgamal.ts#L116)
 
 ___
 
@@ -195,7 +195,7 @@ The decrypted secret as an integer.
 
 #### Defined in
 
-[elgamal.ts:77](https://github.com/Tenemo/threshold-elgamal/blob/10f1361a99b0f5ef342dc456d82e69dcabbdeb55/src/elgamal.ts#L77)
+[elgamal.ts:77](https://github.com/Tenemo/threshold-elgamal/blob/c8e377965a04bb14f4a82cc78ceda3db769c4f77/src/elgamal.ts#L77)
 
 ___
 
@@ -222,7 +222,7 @@ The encrypted secret, consisting of two BigIntegers (c1 and c2).
 
 #### Defined in
 
-[elgamal.ts:51](https://github.com/Tenemo/threshold-elgamal/blob/10f1361a99b0f5ef342dc456d82e69dcabbdeb55/src/elgamal.ts#L51)
+[elgamal.ts:51](https://github.com/Tenemo/threshold-elgamal/blob/c8e377965a04bb14f4a82cc78ceda3db769c4f77/src/elgamal.ts#L51)
 
 ___
 
@@ -248,7 +248,7 @@ An array of key shares, each containing a private and public key share.
 
 #### Defined in
 
-[thresholdElgamal.ts:83](https://github.com/Tenemo/threshold-elgamal/blob/10f1361a99b0f5ef342dc456d82e69dcabbdeb55/src/thresholdElgamal.ts#L83)
+[thresholdElgamal.ts:83](https://github.com/Tenemo/threshold-elgamal/blob/c8e377965a04bb14f4a82cc78ceda3db769c4f77/src/thresholdElgamal.ts#L83)
 
 ___
 
@@ -273,7 +273,7 @@ The generated parameters including the prime, generator, publicKey, and privateK
 
 #### Defined in
 
-[elgamal.ts:14](https://github.com/Tenemo/threshold-elgamal/blob/10f1361a99b0f5ef342dc456d82e69dcabbdeb55/src/elgamal.ts#L14)
+[elgamal.ts:14](https://github.com/Tenemo/threshold-elgamal/blob/c8e377965a04bb14f4a82cc78ceda3db769c4f77/src/elgamal.ts#L14)
 
 ___
 
@@ -299,7 +299,7 @@ The key share containing a private and public key share for the participant.
 
 #### Defined in
 
-[thresholdElgamal.ts:56](https://github.com/Tenemo/threshold-elgamal/blob/10f1361a99b0f5ef342dc456d82e69dcabbdeb55/src/thresholdElgamal.ts#L56)
+[thresholdElgamal.ts:56](https://github.com/Tenemo/threshold-elgamal/blob/c8e377965a04bb14f4a82cc78ceda3db769c4f77/src/thresholdElgamal.ts#L56)
 
 ___
 
@@ -324,7 +324,7 @@ A random bigint within the specified range.
 
 #### Defined in
 
-[utils.ts:11](https://github.com/Tenemo/threshold-elgamal/blob/10f1361a99b0f5ef342dc456d82e69dcabbdeb55/src/utils.ts#L11)
+[utils.ts:11](https://github.com/Tenemo/threshold-elgamal/blob/c8e377965a04bb14f4a82cc78ceda3db769c4f77/src/utils.ts#L11)
 
 ___
 
@@ -350,7 +350,7 @@ The result of the multiplication, as a new encrypted message.
 
 #### Defined in
 
-[utils.ts:33](https://github.com/Tenemo/threshold-elgamal/blob/10f1361a99b0f5ef342dc456d82e69dcabbdeb55/src/utils.ts#L33)
+[utils.ts:33](https://github.com/Tenemo/threshold-elgamal/blob/c8e377965a04bb14f4a82cc78ceda3db769c4f77/src/utils.ts#L33)
 
 ___
 
@@ -378,4 +378,4 @@ The decrypted secret, assuming it was small enough to be directly encrypted.
 
 #### Defined in
 
-[thresholdElgamal.ts:148](https://github.com/Tenemo/threshold-elgamal/blob/10f1361a99b0f5ef342dc456d82e69dcabbdeb55/src/thresholdElgamal.ts#L148)
+[thresholdElgamal.ts:148](https://github.com/Tenemo/threshold-elgamal/blob/c8e377965a04bb14f4a82cc78ceda3db769c4f77/src/thresholdElgamal.ts#L148)

package/jsdoc.config.js

@@ -0,0 +1,31 @@
+BigInt.prototype.toJSON = function () {
+    return this.toString() + 'n';
+};
+module.exports = {
+    opts: {
+        template: 'node_modules/docdash',
+    },
+    plugins: ['plugins/markdown'],
+    docdash: {
+        static: true,
+        sort: true,
+        search: true,
+        collapse: true,
+        typedefs: true,
+        removeQuotes: 'none',
+        scripts: [],
+        menu: {
+            'Github repo': {
+                href: 'https://github.com/Tenemo/threshold-elgamal',
+                target: '_blank',
+                class: 'menu-item',
+                id: 'repository',
+            },
+        },
+    },
+    templates: {
+        default: {
+            useLongnameInNav: true,
+        },
+    },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "threshold-elgamal",
-    "version": "0.1.7",
+    "version": "0.1.9",
     "author": "Piotr Piech <piotr@piech.dev>",
     "license": "MIT",
     "description": "threshold-elgamal",
@@ -19,13 +19,13 @@
         "eslint": "eslint . -c eslint.config.js",
         "eslint:fix": "eslint . --fix -c eslint.config.js",
         "tsc": "tsc",
-        "prebuild": "npm run eslint && npm run tsc && npm run test && rimraf dist",
+        "prebuild": "npm run eslint && npm run tsc && npm run test && del-cli dist",
         "build": "tsc --project tsconfig.build.json",
         "build:skip": "tsc --project tsconfig.build.json",
         "test": "vitest --watch=false --reporter=verbose",
         "test:watch": "vitest --watch=true --reporter=verbose",
-        "pretypedoc": "rimraf docs",
-        "typedoc": "typedoc --plugin typedoc-plugin-markdown src --out docs  --darkHighlightTheme dark-plus --githubPages false --entryDocument index.md",
+        "pretypedoc": "del-cli 'docs/*' '!docs/_config.yml'",
+        "typedoc": "typedoc --plugin typedoc-plugin-markdown src --out docs  --darkHighlightTheme dark-plus --githubPages false --entryDocument index.md --cleanOutputDir false",
         "prepublish:public": "npm run prebuild",
         "publish:public": "npm publish --access public"
     },
@@ -43,6 +43,7 @@
         "@types/prettier": "^2.7.3",
         "@typescript-eslint/eslint-plugin": "^7.5.0",
         "@typescript-eslint/parser": "^7.5.0",
+        "del-cli": "^5.1.0",
         "eslint": "^8.57.0",
         "eslint-config-prettier": "^9.1.0",
         "eslint-import-resolver-typescript": "^3.6.1",
@@ -52,7 +53,6 @@
         "globals": "^15.0.0",
         "prettier": "^3.2.5",
         "prettier-eslint": "^16.3.0",
-        "rimraf": "^5.0.5",
         "tsx": "^4.7.2",
         "typedoc": "^0.25.13",
         "typedoc-plugin-markdown": "^3.17.1",