How can this module be used globally?

[TCH68k]

Question

I've installed the module by npm -g install bgutils-js youtubei.js jsdom ts-node and tried to run the source got from you

import { BG } from 'bgutils-js';
import type { BgConfig } from 'bgutils-js';
import { JSDOM } from 'jsdom';
// Bun:
// import { Innertube, UniversalCache } from 'youtubei.js/web';
import { Innertube, UniversalCache } from 'youtubei.js';

// Create a barebones Innertube instance so we can get a visitor data string from YouTube.
let innertube = await Innertube.create({ retrieve_player: false });

const requestKey = 'O43z0dpjhgX20SCx4KAo';
const visitorData = innertube.session.context.client.visitorData;

if (!visitorData)
  throw new Error('Could not get visitor data');

const dom = new JSDOM();

Object.assign(globalThis, {
  window: dom.window,
  document: dom.window.document
});

const bgConfig: BgConfig = {
  fetch: (input: string | URL | globalThis.Request, init?: RequestInit) => fetch(input, init), 
  globalObj: globalThis,
  identifier: visitorData,
  requestKey
};

const bgChallenge = await BG.Challenge.create(bgConfig);

if (!bgChallenge)
  throw new Error('Could not get challenge');

const interpreterJavascript = bgChallenge.interpreterJavascript.privateDoNotAccessOrElseSafeScriptWrappedValue;

if (interpreterJavascript) {
  new Function(interpreterJavascript)();
} else throw new Error('Could not load VM');

const poTokenResult = await BG.PoToken.generate({
  program: bgChallenge.program,
  globalName: bgChallenge.globalName,
  bgConfig
});

const placeholderPoToken = BG.PoToken.generatePlaceholder(visitorData);

console.info('Session Info:', {
  visitorData,
  placeholderPoToken,
  poToken: poTokenResult.poToken,
  integrityTokenData: poTokenResult.integrityTokenData
});

innertube = await Innertube.create({
  po_token: poTokenResult.poToken,
  visitor_data: visitorData,
  cache: new UniversalCache(true),
  generate_session_locally: true
});

const info = await innertube.getBasicInfo('v8SlCIo0DRs');
if (info.streaming_data) {
  const format = info.streaming_data.adaptive_formats.find((fmt) => fmt.itag === 299);

  if (format) {
    console.log('Stream URL:', format.decipher(innertube.session.player));
  }
}

by npx ts-node test.ts and only got these errors:

/opt/node.js/23.6.0/lib/node_modules/ts-node/src/index.ts:859
    return new TSError(diagnosticText, diagnosticCodes, diagnostics);
           ^
TSError: ⨯ Unable to compile TypeScript:
test.ts:1:20 - error TS2307: Cannot find module 'bgutils-js' or its corresponding type declarations.

1 import { BG } from 'bgutils-js';
                     ~~~~~~~~~~~~
test.ts:2:31 - error TS2307: Cannot find module 'bgutils-js' or its corresponding type declarations.

2 import type { BgConfig } from 'bgutils-js';
                                ~~~~~~~~~~~~
test.ts:3:23 - error TS2307: Cannot find module 'jsdom' or its corresponding type declarations.

3 import { JSDOM } from 'jsdom';
                        ~~~~~~~
test.ts:6:43 - error TS2307: Cannot find module 'youtubei.js' or its corresponding type declarations.

6 import { Innertube, UniversalCache } from 'youtubei.js';
                                            ~~~~~~~~~~~~~
test.ts:66:61 - error TS7006: Parameter 'fmt' implicitly has an 'any' type.

66   const format = info.streaming_data.adaptive_formats.find((fmt) => fmt.itag === 299);
                                                               ~~~

    at createTSError (/opt/node.js/23.6.0/lib/node_modules/ts-node/src/index.ts:859:12)
    at reportTSError (/opt/node.js/23.6.0/lib/node_modules/ts-node/src/index.ts:863:19)
    at getOutput (/opt/node.js/23.6.0/lib/node_modules/ts-node/src/index.ts:1077:36)
    at Object.compile (/opt/node.js/23.6.0/lib/node_modules/ts-node/src/index.ts:1433:41)
    at Module.m._compile (/opt/node.js/23.6.0/lib/node_modules/ts-node/src/index.ts:1617:30)
    at loadTS (node:internal/modules/cjs/loader:1831:10)
    at Object.require.extensions.<computed> [as .ts] (/opt/node.js/23.6.0/lib/node_modules/ts-node/src/index.ts:1621:12)
    at Module.load (node:internal/modules/cjs/loader:1473:32)
    at Function._load (node:internal/modules/cjs/loader:1285:12)
    at TracingChannel.traceSync (node:diagnostics_channel:322:14) {
  diagnosticCodes: [ 2307, 2307, 2307, 2307, 7006 ]
}

I've tried to search what can be the problem and got tips to install typescript and link it locally and also to install tslib and @types/node; all to no avail.

How can i use this module?

Other details

No response

Checklist

• I am running the latest version.
• I checked the documentation and found no answer.
• I have searched the existing issues and made sure this is not a duplicate.
• I have provided sufficient information.

[ArmelChesnais]

You're already using ts-node, so you don't need to install typescript, ts-node is already a typescript environment.

This seems more an issue with your environment, with ts-node being unable to locate the modules.

Did the call to npm install bgutils-js youtubei.js jsdom ts-node complete successfully? (you should be able to call it again to see the logs and confirm success)

Can you verify that the node_modules folder is present and includes all of those modules inside it? Does your package.json file also lists all those modules in its list of dependencies?

[TCH68k]

Did the call to npm install bgutils-js youtubei.js jsdom ts-node complete successfully? (you should be able to call it again to see the logs and confirm success)

Yes:

added 66 packages in 2s

5 packages are looking for funding
  run `npm fund` for details

Can you verify that the node_modules folder is present and includes all of those modules inside it?

Yes: ls -l /opt/node.js/23.6.0/lib/node_modules/

összesen 24
drwxr-xr-x  4 root root 4096 jan    8 22.07 bgutils-js
drwxr-xr-x  4 1000 1000 4096 jan    7 14.16 corepack
drwxr-xr-x  4 root root 4096 jan    8 22.07 jsdom
drwxr-xr-x  7 1000 1000 4096 jan    7 14.16 npm
drwxr-xr-x 12 root root 4096 jan    8 22.07 ts-node
drwxr-xr-x  5 root root 4096 jan    8 22.07 youtubei.js

However, i forgot to mention that i installed them globally with the -g flag. Sorry for that, the OP has been updated.
And it turned out (because i tried it), that if i do actually omit the -g flag and npm puts the modules in the current directory, then the script does work. But i would like to use it without any local node_modules directory. It has to use the globally installed ones.

Does your package.json file also lists all those modules in its list of dependencies?

That must be the problem. I thought these TS files are stand-alone, i did not know they need external files. Thanks for pointing out. I created a package.json with this content (copied from BgUtils/examples/node/package.json):

{
  "name": "node",
  "version": "1.0.0",
  "description": "",
  "type": "module",
  "main": "./test.ts",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "devDependencies": {
    "@types/jsdom": "^21.1.7",
    "typescript": "^4.6.4"
  },
  "dependencies": {
    "bgutils-js": "^3.1.2",
    "jsdom": "^24.1.3",
    "ts-node": "^10.9.2",
    "youtubei.js": "^12.2.0"
  }
}

The error message is now this:

Error: Cannot find package 'bgutils-js' imported from /media/UTILDISK/potoken/test.ts
Did you mean to import "bgutils-js/bundle/index.cjs"?
    at Object.getPackageJSONURL (node:internal/modules/package_json_reader:267:9)
    at packageResolve (node:internal/modules/esm/resolve:768:81)
    at moduleResolve (node:internal/modules/esm/resolve:854:18)
    at defaultResolve (node:internal/modules/esm/resolve:984:11)
    at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:716:12)
    at ModuleLoader.#cachedDefaultResolve (node:internal/modules/esm/loader:640:25)
    at ModuleLoader.resolve (node:internal/modules/esm/loader:623:38)
    at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:276:38)
    at ModuleJob._link (node:internal/modules/esm/module_job:136:49) {
  code: 'ERR_MODULE_NOT_FOUND'
}

[TCH68k]

Anybody?

[TCH68k]

Any kind of tip, advice? Is this even possible to use the module globally?

[LuanRT]

It is, but I think this is more of JavaScript/NPM/NodeJs question rather than anything related to the library itself.

Is there a reason you need the module available globally? Usually you only do that for cli tools.

[TCH68k]

Yes, i'd like to use it as a CLI tool.

[TCH68k]

Any hint about how can i use it globally?

[TCH68k]

Any kind of tip, advice? Or at least a hint, that where can i ask help about this?

[TCH68k]

Hello?

[TCH68k]

Seriously, come on...

[LuanRT]

I would love to help, but I'm still not entirely sure what exactly it is that you want to do. Installing the project globally is possible, but not ideal.

If you want to use it as a CLI tool, you'll have to create a new project and use the library there.

[TCH68k]

I'd like to use it without putting node_modules directories all over the system and instead use the global node_modules directory of node.js (or NPM), because i'd like to use it as a CLI tool, to be able to call it from shell like nodejs /path/to/bgutils-potoken-generator <YT-URL> and get back the potoken.

Okay, and how do i do that? I am not familiar with TypeScript, node.js, NPM or the ecosystems of these. I am only familiar with vanilla JS.