Warning when try to import '@gitbeaker/rest'

[merorafael]

Description

• Node.js version: 19.9.0
• Gitbeaker version: 38.0.1
• Gitbeaker release (cli, node, browser, core, requester-utils): rest
• OS & version: Arch Linux

The eslint shows the warning message below
"@gitbeaker/rest" is not found. eslint[node/no-missing-import](node/no-missing-import) when trying to import GitLab from @gitbeaker/rest.

Steps to reproduce

Import GitLab from @gitbeaker/rest using the structure below:

import {Gitlab} from '@gitbeaker/rest'

It is not relevant information, but the eslint settings use oclif and oclif-typescript rules.

Expected behaviour

No warnings when importing the @gitbeaker/rest

Actual behaviour

Warning node/no-missing-import on @gitbeaker/rest module.

Possible fixes

Checklist

• I have checked that this is not a duplicate issue.
• I have read the documentation.

[jdalrymple]

Odd. From the docs, it seems to say that the module itself does not exist? Do you receive the same errors with different imports ie Projects, Issues, etc? Is it just the Gitlab one?

[jdalrymple]

Following up, any more information?

[merorafael]

It's only this library. Other libraries and project structures don't have this warning.

[jdalrymple]

Hmm, im not sure. Though i doubt it would change, have you tried updating the library version youre using, or perhaps refreshing your package-lock or yarn-lock file?

[tbazin]

Hi! Just starting using this SDK and I am getting a very similar error:
Unable to resolve path to module '@gitbeaker/rest'.eslint (import/no-unresolved).

I suspect that the two error messages are occurrences of the same bug, only in @merorafael's case in the context of a node environment and in mine when using the package within a browser environment.

This is likely due to this open issue on eslint's side and the fact that the @gitbeaker/rest package relies on the exports field in its package.json :

gitbeaker/packages/rest/package.json

Lines 28 to 34 in 56c2540

	"exports": {
	".": {
	"types": "./dist/index.d.ts",
	"import": "./dist/index.mjs",
	"require": "./dist/index.js"
	}
	},

The error can be silenced by adding:

...
"type": "module",
...

to @gitbeaker/rest's package.json, but this field is not officially supported.

Alternate solutions suggested in the issue in eslint's repository include installing custom eslint resolvers that support the exports field in package.json files.

[jdalrymple]

Thanks for the additional info! Ill see if i can find some custom eslint resolvers that i could utilize

[merorafael]

I put an example in a public repository here.
Here is the code: https://github.com/merorafael/gitbeaker-error-example/blob/main/src/commands/hello/index.ts

If you need to test, you must clone this repository and run yarn lint.

[jdalrymple]

Awesome thank you! This week is a rough one on my end, but i will get to it by at least the weekend!

[jdalrymple]

Okay few ways to resovle this:

1. Ignore the rule for this library (similar example):

  "rules": {
    "node/no-missing-import": ["error", { "allowModules": ["@gitbeaker/rest"] }]
  }

2. Use an additional resolver: https://www.npmjs.com/package/eslint-import-resolver-exports, though i didnt have much luck when testing this.

As @tbazin mentioned, this is because the eslint resolver just doesnt support export keyword as of yet.

[nawaz-malla]

File d/contract.py", line 4, in
app = Application("External Example App")

how can I solve the issue

[jdalrymple]

@nawaz-malla Can you provide more information. It looks like the code you included is python..

[nawaz-malla]

from beaker import *
from pyteal import Expr, abi

app = Application("External Example App")

@app.external
def add(a: abi.Uint8, b: abi.Uint8, *, output: abi.Uint8) -> Expr:
return output.set(a.get() + b.get())

[jdalrymple]

Again...thats python.

[nawaz-malla]

how can i solve , i am following some videos , they use beaker, I am using same code but I face the issue.
hoiw can I solve the issue.

algokit doctor
timestamp: 2024-03-27T00:18:17+00:00
AlgoKit: 1.13.1
AlgoKit Python: 3.12.1 (main, Dec 7 2023, 20:45:44) [Clang 15.0.0 (clang-1500.1.0.2.5)] (location: /Users/nawaz/Desktop/Algorand/Library/Application Support/pipx/venvs/algokit)
OS: macOS-14.4-x86_64-i386-64bit
docker: 25.0.2
docker compose: 2.24.3-desktop.1
git: 2.39.3
python: Command not found!
python3: 3.12.1 (location: /usr/local/bin/python3)
pipx: 1.4.3
poetry: 1.8.2
node: 21.6.2
npm: 10.2.4
brew: 4.2.15
there are details I am using

[jdalrymple]

@nawaz-malla Feel free to open a new issue with a template project to outline your problem