Add support for typescript via type definitions in @types folder. #93

BeanTosser · 2022-06-02T00:22:29Z

Add support for typescript via type definitions in @types folder.

Install typescript, emit typedefs, and "fix" index.d.ts.

Replace all BigInteger math function calls with standard BigInt...

... overloads (BigInteger(value).multiply(BigInteger(value2)) ->
BigInt(value) * BigInt(value2))

Type nearly everything in TestSampleCode.ts.

Fix all errors that were due to typing vars in "for...of" statements.

NOTE:
keyImage is defined as string. This is probably correct but can't be
verified due to lack of documentation and my inability to trace the
method chain in the source code.

Intermediate progress writing script to replace BigInteger.compare.

Find lefthand terms of .compare operations.

Replacing BigInteger.compare() with BigIntegerCompare() in progress.

Fix all errors and finish converting TestSampleCode.js to Typescript.

Update "async" to version 2.6.4.

BeanTosser · 2022-06-02T00:23:43Z

This was a messy, messy merge/rebase. Please take a good look at the diffs to make sure nothing screwy is going on.

woodser

Very happy to be getting a PR to support TypeScript :)

See comments throughout my review.

The WASM builds, but I'm getting the following error when ./bin/build_web_worker.sh runs. Rather than debugging this issue, you might just circumvent it by moving to a static utility, GenUtils.compareBigInt().

ERROR in ./src/main/js/common/GenUtils.js 3:26-71
Module not found: Error: Can't resolve '~/main/js/common/BigIntegerCompare' in '/Users/woodser/git/monero-javascript/src/main/js/common'
resolve '~/main/js/common/BigIntegerCompare' in '/Users/woodser/git/monero-javascript/src/main/js/common'
  Parsed request is a module
  using description file: /Users/woodser/git/monero-javascript/package.json (relative path: ./src/main/js/common)
    aliased with mapping '~': '/Users/woodser/git/monero-javascript/app' to '/Users/woodser/git/monero-javascript/app/main/js/common/BigIntegerCompare'
      using description file: /Users/woodser/git/monero-javascript/package.json (relative path: ./src/main/js/common)
        Field 'browser' doesn't contain a valid alias configuration
        root path /Users/woodser/git/monero-javascript
          using description file: /Users/woodser/git/monero-javascript/package.json (relative path: ./Users/woodser/git/monero-javascript/app/main/js/common/BigIntegerCompare)
            no extension
              Field 'browser' doesn't contain a valid alias configuration
              /Users/woodser/git/monero-javascript/Users/woodser/git/monero-javascript/app/main/js/common/BigIntegerCompare doesn't exist
            .js
              Field 'browser' doesn't contain a valid alias configuration
              /Users/woodser/git/monero-javascript/Users/woodser/git/monero-javascript/app/main/js/common/BigIntegerCompare.js doesn't exist
            .jsx
              Field 'browser' doesn't contain a valid alias configuration
              /Users/woodser/git/monero-javascript/Users/woodser/git/monero-javascript/app/main/js/common/BigIntegerCompare.jsx doesn't exist
            .css
              Field 'browser' doesn't contain a valid alias configuration
              /Users/woodser/git/monero-javascript/Users/woodser/git/monero-javascript/app/main/js/common/BigIntegerCompare.css doesn't exist
            .json
              Field 'browser' doesn't contain a valid alias configuration
              /Users/woodser/git/monero-javascript/Users/woodser/git/monero-javascript/app/main/js/common/BigIntegerCompare.json doesn't exist
            otf
              Field 'browser' doesn't contain a valid alias configuration
              /Users/woodser/git/monero-javascript/Users/woodser/git/monero-javascript/app/main/js/common/BigIntegerCompareotf doesn't exist
            ttf
              Field 'browser' doesn't contain a valid alias configuration
              /Users/woodser/git/monero-javascript/Users/woodser/git/monero-javascript/app/main/js/common/BigIntegerComparettf doesn't exist
            eot
              Field 'browser' doesn't contain a valid alias configuration
              /Users/woodser/git/monero-javascript/Users/woodser/git/monero-javascript/app/main/js/common/BigIntegerCompareeot doesn't exist
            svg
              Field 'browser' doesn't contain a valid alias configuration
              /Users/woodser/git/monero-javascript/Users/woodser/git/monero-javascript/app/main/js/common/BigIntegerComparesvg doesn't exist
            .ts
              Field 'browser' doesn't contain a valid alias configuration
              /Users/woodser/git/monero-javascript/Users/woodser/git/monero-javascript/app/main/js/common/BigIntegerCompare.ts doesn't exist
            .tsx
              Field 'browser' doesn't contain a valid alias configuration
              /Users/woodser/git/monero-javascript/Users/woodser/git/monero-javascript/app/main/js/common/BigIntegerCompare.tsx doesn't exist
            as directory
              /Users/woodser/git/monero-javascript/Users/woodser/git/monero-javascript/app/main/js/common/BigIntegerCompare doesn't exist
        using description file: /Users/woodser/git/monero-javascript/package.json (relative path: ./app/main/js/common/BigIntegerCompare)
          no extension
            Field 'browser' doesn't contain a valid alias configuration
            /Users/woodser/git/monero-javascript/app/main/js/common/BigIntegerCompare doesn't exist
          .js
            Field 'browser' doesn't contain a valid alias configuration
            /Users/woodser/git/monero-javascript/app/main/js/common/BigIntegerCompare.js doesn't exist
          .jsx
            Field 'browser' doesn't contain a valid alias configuration
            /Users/woodser/git/monero-javascript/app/main/js/common/BigIntegerCompare.jsx doesn't exist
          .css
            Field 'browser' doesn't contain a valid alias configuration
            /Users/woodser/git/monero-javascript/app/main/js/common/BigIntegerCompare.css doesn't exist
          .json
            Field 'browser' doesn't contain a valid alias configuration
            /Users/woodser/git/monero-javascript/app/main/js/common/BigIntegerCompare.json doesn't exist
          otf
            Field 'browser' doesn't contain a valid alias configuration
            /Users/woodser/git/monero-javascript/app/main/js/common/BigIntegerCompareotf doesn't exist
          ttf
            Field 'browser' doesn't contain a valid alias configuration
            /Users/woodser/git/monero-javascript/app/main/js/common/BigIntegerComparettf doesn't exist
          eot
            Field 'browser' doesn't contain a valid alias configuration
            /Users/woodser/git/monero-javascript/app/main/js/common/BigIntegerCompareeot doesn't exist
          svg
            Field 'browser' doesn't contain a valid alias configuration
            /Users/woodser/git/monero-javascript/app/main/js/common/BigIntegerComparesvg doesn't exist
          .ts
            Field 'browser' doesn't contain a valid alias configuration
            /Users/woodser/git/monero-javascript/app/main/js/common/BigIntegerCompare.ts doesn't exist
          .tsx
            Field 'browser' doesn't contain a valid alias configuration
            /Users/woodser/git/monero-javascript/app/main/js/common/BigIntegerCompare.tsx doesn't exist
          as directory
            /Users/woodser/git/monero-javascript/app/main/js/common/BigIntegerCompare doesn't exist
 @ ./src/main/js/common/MoneroWebWorker.js 3:17-38

.gitignore

woodser · 2022-06-02T13:40:20Z

src/main/cpp/#http_client_wasm.cpp#

@@ -0,0 +1,341 @@
+#include <emscripten.h>


Why creating a new file named #http_client_wasm.cpp#? Probably this file doesn't need changed at all?

Erm... your guess is as good as mine, actually. I definitely did not manually or intentionally create this file. Presumably it was created when I was building the monero-javascript source?

src/main/js/common/BigIntegerCompare.js

src/main/js/common/LibraryUtils.js

src/test/TestMoneroWalletRpc.js

src/test/TestSampleCode.ts

woodser · 2022-06-02T14:30:46Z

types/dist/monero_wallet_full.d.ts

@@ -0,0 +1,5 @@
+export = monero_javascript;


types/src and types/dist exist. I'll need to understand how to generate the source types and what modifications are necessary. I assume files within dist are 100% auto generated.

To generate the initial typedefs, use the following command:

npx -p typescript tsc src/*.js --declaration --allowJs --emitDeclarationOnly --outDir types

After that each entry in index.d.ts needs to be changed to match the format:

import * as MoneroWalletKeys from "./src/main/js/wallet/MoneroWalletKeys"; export import MoneroWalletKeys = MoneroWalletKeys;

...with the exception of functions, which should look like:

export function getVersion(): string; export function connectToDaemonRpc(...args: any[]): MoneroDaemonRpc; export function connectToWalletRpc(...args: any[]): MoneroWalletRpc; export function createWalletFull(...args: any[]): MoneroWalletFull; export function openWalletFull(...args: any[]): MoneroWalletFull; export function createWalletKeys(...args: any[]): MoneroWalletKeys;

There may be more changes necessary in other files in types/src... I can't recall for sure off the top of my head. We will need to generate a new set of typedifs and get the diffs comparing my types folder with the freshly generated folder to see what other manual changes might be needed.

The types/dist folder may actually be completely unnecessary. We'd have to test it with the folder removed to be sure.

woodser · 2022-06-06T19:39:29Z

Related issue: #81

CryptoGrampy · 2022-06-25T06:47:27Z

types/index.d.ts

+  export import MoneroConnectionManager = MoneroConnectionManager;
+  import * as MoneroConnectionManagerListener from "./src/main/js/common/MoneroConnectionManagerListener";
+  export import MoneroConnectionManagerListener = MoneroConnectionManagerListener;
+  import * as MoneroUtils from "./src/main/js/common/MoneroUtils";


I think the import and export lines for all of these things could be replaced with something like:
export * as MoneroUtils from "monero-javascript/types/src/main/js/common/MoneroUtils"; . The index file is pulling all of these declaration files into one place and re-exporting; Note that I've replaced the actual JS location with the type location- this is important. Try importing your branch into a typescript project and call const utils = monerojs.MoneroUtils and you'll see that the definitions and methods now pop up.

Additionally, this index.d.ts file location should (I think) be referenced in the monero-javascript package.json as "types": "types/index.d.ts"

CryptoGrampy · 2022-06-25T06:58:17Z

types/src/main/js/common/MoneroUtils.d.ts

+     * @param {string} privateViewKey is the private view key to validate
+     * @return {bool} true if the private view key is valid, false otherwise
+     */
+    static isValidPrivateViewKey(privateViewKey: string): bool;


Should be boolean. Maybe do a find and replace on the whole types folder.

CryptoGrampy · 2022-06-25T07:16:10Z

Wow. This is a crazy amount of code... it will be extremely useful for anyone using MoneroJs in the future. Great job. I was able to pull your PR into my active project by replacing monero-javascript in the package.json file with "monero-javascript": "BeanTosser/monero-javascript#add_typescript_support" (if anyone's interested)

It may be worth breaking things into additional index.d.ts files in each group (common, daemon, etc) just to make things a little less heavy in the big index file (though you would have to import the group indexes into the main index 🙃 )

Bugs:

I'm not able to run this yet- first bug I'm seeing: Module not found: Error: Can't resolve './src/main/js/common/BigIntegerCompare' in 'node_modules/monero-javascript'

add jsdocs to MoneroTx and MoneroTxWallet

woodser · 2022-10-14T12:18:40Z

Replacing with #108

woodser reviewed Jun 2, 2022

View reviewed changes

BeanTosser force-pushed the add_typescript_support branch from 4166e81 to 2fef886 Compare June 6, 2022 00:51

BeanTosser marked this pull request as draft June 7, 2022 00:28

CryptoGrampy reviewed Jun 25, 2022

View reviewed changes

BeanTosser force-pushed the add_typescript_support branch from 2fef886 to 830af9b Compare June 26, 2022 00:18

BeanTosser force-pushed the add_typescript_support branch from a9b7d19 to 197e3f8 Compare July 31, 2022 17:28

BeanTosser force-pushed the add_typescript_support branch from 4689b71 to 9f7945b Compare August 17, 2022 01:08

BeanTosser force-pushed the add_typescript_support branch from 4cfb35e to 59b1e19 Compare August 28, 2022 13:38

BeanTosser force-pushed the add_typescript_support branch 2 times, most recently from c5f8a26 to c10a641 Compare September 22, 2022 00:36

Add typescript support

e711068

BeanTosser force-pushed the add_typescript_support branch from 0a59eb0 to e711068 Compare October 1, 2022 00:53

BeanTosser and others added 6 commits October 11, 2022 20:12

Add "emit_typedefs_mac" script.

b9eb5de

add jsdocs to MoneroTx and MoneroTxWallet

a61d2f6

Fix build_browser_tests script not working

e315119

ignore /types and /dist/commonjs

a19b09c

Remove dist/commonjs and types folders.

2fac99e

Merge pull request #2 from woodser/pr_93

e21911a

add jsdocs to MoneroTx and MoneroTxWallet

woodser mentioned this pull request Oct 14, 2022

Support typescript #108

Merged

woodser closed this Oct 14, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for typescript via type definitions in @types folder. #93

Add support for typescript via type definitions in @types folder. #93

BeanTosser commented Jun 2, 2022

BeanTosser commented Jun 2, 2022

woodser left a comment •

edited

woodser Jun 2, 2022

BeanTosser Jun 4, 2022 •

edited

woodser Jun 2, 2022

BeanTosser Jun 4, 2022 •

edited

woodser commented Jun 6, 2022

CryptoGrampy Jun 25, 2022

CryptoGrampy Jun 25, 2022

CryptoGrampy Jun 25, 2022

CryptoGrampy commented Jun 25, 2022

woodser commented Oct 14, 2022

Add support for typescript via type definitions in @types folder. #93

Add support for typescript via type definitions in @types folder. #93

Conversation

BeanTosser commented Jun 2, 2022

BeanTosser commented Jun 2, 2022

woodser left a comment • edited

Choose a reason for hiding this comment

woodser Jun 2, 2022

Choose a reason for hiding this comment

BeanTosser Jun 4, 2022 • edited

Choose a reason for hiding this comment

woodser Jun 2, 2022

Choose a reason for hiding this comment

BeanTosser Jun 4, 2022 • edited

Choose a reason for hiding this comment

woodser commented Jun 6, 2022

CryptoGrampy Jun 25, 2022

Choose a reason for hiding this comment

CryptoGrampy Jun 25, 2022

Choose a reason for hiding this comment

CryptoGrampy Jun 25, 2022

Choose a reason for hiding this comment

CryptoGrampy commented Jun 25, 2022

woodser commented Oct 14, 2022

woodser left a comment •

edited

BeanTosser Jun 4, 2022 •

edited

BeanTosser Jun 4, 2022 •

edited