instructions for TSConfig adjustments don't seem to work

[achou11]

Using Typescript v5.2.2

The instructions currently state that you have to update you tsconfig file as follows:

{
  "compilerOptions": {
+    "typeRoots": ["node_modules/@digidem/types/vendor", "node_modules/@types"]
  }
}

however, this seems to work:

{
  "compilerOptions": {
+    "paths": {
+      "*": ["./node_modules/@digidem/types/vendor/*/index.d.ts"]
+      }
  }
}

Example tsconfig I'm using:

{
  "compilerOptions": {
    "target": "es2022",
    "lib": [
      "es2023"
    ],
    "module": "nodenext",
    "moduleResolution": "nodenext",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true,
    "allowJs": true,
    "checkJs": true,
    "noEmit": true,
    "declaration": false,
    "typeRoots": [
      "node_modules/@types",
      "node_modules/@digidem/types/vendor",
    ]
  },
  "include": [
    "src/**/*",
    "tests/**/*"
  ],
  "exclude": [
    "node_modules",
  ]
}

[achou11]

additional helpful info:

Could not find a declaration file for module 'random-access-memory'. '/Users/andrewchou/GitHub/digidem/comapeo-mobile/src/backend/node_modules/random-access-memory/index.js' implicitly has an 'any' type.

There are types at '/Users/andrewchou/GitHub/digidem/comapeo-mobile/src/backend/node_modules/@digidem/types/vendor/random-access-memory/index.d.ts', but this result could not be resolved when respecting package.json "exports". The 'random-access-memory' library may need to update its package.json or typings.ts(7016)

[achou11]

seems like we should be using the exports field in package.json for pointing to the type defs

https://www.typescriptlang.org/docs/handbook/esm-node.html#packagejson-exports-imports-and-self-referencing