I am writing this nodeJS project, and I wanted to include the typescript mastodon library but it keeps telling me this. I am kinda unsure how to proceed.

skymtf@lemmy.blahaj.zone · 1 year ago

I am writing this nodeJS project, and I wanted to include the typescript mastodon library but it keeps telling me this. I am kinda unsure how to proceed.

clif@lemmy.world · edit-2 1 year ago

This is usually a side effect of the uneven adoption of ESM vs CommonJS and mixing of the two. It’s a bit annoying, but, usually fairly easy to work around. But, a lot of it depends on how your project is configured - both the package.json and tsconfig.

Do you have the code available somewhere? I’m mostly interested in the package.json (specifically the type property) and tsconfig if you have one (and this is Typescript). Also, is this a Typescript project or a regular Javascript project?

Sorry, there’s several variables here that affect the proper solution.

EDIT : One more question. If this is a Typescript project, how are you executing it? Transpile then run with node? ts-node? ts-node-esm?

EDIT x2 : If you’ll throw the project, or a simplified example that demonstrates the problem, up on github or somewhere else publicly accessible we should be able to fix you up pretty quickly. You can exclude the node_modules/ folder.

skymtf@lemmy.blahaj.zone · 1 year ago

__{ "name": "hourlypets", "version": "1.0.0", "description": "A bot for displaying hourly pets", "main": "dist/index.js", "scripts": { "start": "node dist/index.js", "test": "echo \"Error: no test specified\" && exit 1" }, "keywords": [], "author": "", "license": "ISC", "devDependencies": { "@types/node": "^20.5.1", "typescript": "^5.1.6" }, "dependencies": { "@petfinder/petfinder-js": "^1.0.6", "dotenv": "^16.3.1", "tsl-mastodon-api": "^0.4.0" } } _

{ "compilerOptions": { "module": "es6", "esModuleInterop": true, "target": "es6", "moduleResolution": "node", "sourceMap": true, "outDir": "dist" }, "lib": ["es2015"] }

skymtf@lemmy.blahaj.zone · 1 year ago

I am using ts-node

clif@lemmy.world · 1 year ago

Hehe, this is the same type of answer I get from clients when I ask more than one question at a time 😆

Do you have answers to the other questions? Or, much better, can you post the code including your package.json and tsconfig to github/etc?

skymtf@lemmy.blahaj.zone · 1 year ago

https://pastebin.com/QTsYgRAK

clif@lemmy.world · edit-2 1 year ago

Try simply adding the following to your package.json: "type": "module"

I tested this with import * as Mastodon from 'tsl-mastodon-api'; in a test.js file using the example from their readme, executing with ts-node test.js (NOTE THAT THIS IS A JS FILE! Not a .ts file) and it works. It times out, of course, because the example URL doesn’t exist, but you get the idea. Minimal example (package.json is default from npm init -y but with the "type": "module" added. I also tested with your package.json [adding type:module] and tsconfig.json):

test.js :

import * as Mastodon from 'tsl-mastodon-api';

const mastodon = new Mastodon.API({
    access_token: 'ABC',
    api_url: 'https://mastodon.example/api/v1/'
});

const result = await mastodon.postStatus({
    sensitive: true,
    spoiler_text: 'Hello',
    status: 'World'
});
console.log(JSON.stringify(result));

Full package.json that you provided with the “type” property added :

  {
    "name": "hourlypets",
    "type": "module",
    "version": "1.0.0",
    "description": "A bot for displaying hourly pets",
    "main": "dist/index.js", 
    "scripts": {
      "start": "node dist/index.js", 
      "test": "echo \"Error: no test specified\" &amp;&amp; exit 1"
    },
    "keywords": [],
    "author": "",
    "license": "ISC",
    "devDependencies": {
      "@types/node": "^20.5.1",
      "typescript": "^5.1.6"
    },
    "dependencies": {
      "@petfinder/petfinder-js": "^1.0.6",
      "dotenv": "^16.3.1",
      "tsl-mastodon-api": "^0.4.0"
    }
  }

On the note that I used test.js - if this was instead test.ts and you tried to execute it directly with ts-node like ts-node test.ts it will throw the error TypeError [ERR_UNKNOWN_FILE_EXTENSION]: Unknown file extension ".ts" for test.ts. So, I made the assumption that your file is a JS based solely on that fact.

If you still have problems, post a super simplified script like my test.js above that causes the issue for you and I’ll test with yours. You can exclude all private code - just enough to trigger the module error… meaning you could probably just have the import and console.log('hi'); and that would be sufficient.

skymtf@lemmy.blahaj.zone · 1 year ago

I am using TS for pretty much the entire project, but I know TS and JS are pretty much the same with a few added rules.

skymtf@lemmy.blahaj.zone · 1 year ago

so attempting this causes all typescript stuff to break, sadly some of my code depends on typescript specific things.

skymtf@lemmy.blahaj.zone · 1 year ago

just posted it here, the code is currently not public but I posted the ts-config and package.json

skymtf@lemmy.blahaj.zone · 1 year ago

At one point I did have if set to commonJS too, but it seemed to cause issues. Sending the one the is updated as a suggestion