fetch as used in src/request.ts#L54 is not part of the common nodejs runtime and returns in an error (making it difficult to use the backlog api)

• https://developer.nulab.com/docs/backlog/api/2/add-status/
• https://developer.nulab.com/docs/backlog/api/2/update-status/
• https://developer.nulab.com/docs/backlog/api/2/delete-status/
• https://developer.nulab.com/docs/backlog/api/2/update-order-of-status/
• https://developer.nulab.com/docs/backlog/api/2/delete-comment/
• https://developer.nulab.com/docs/backlog/api/2/get-issue-participant-list/

getWikis 's paramter is defined as projectIdOrKey.

But the actual is GetWikiParams.

keyword: string;

This means keyword is necessary, but it's not necessary actually.

For example,

projectIdOrKey: string|number

but in reference,

projectIdOrKey String

One more example.

projectIdOrKey: number

but in reference,

projectIdOrKey String

I think backlog-js should follow the references.

I'm trying to use backlog-js in TypeScript project.

When I run tsc, I get an error:

node_modules/backlog-js/dist/backlog.d.ts:20:19 - error TS2304: Cannot find name 'IResponse'.

20       }): Promise<IResponse>;

How can I resolve this issue?

TypeScript 4.0 and later versions show strikethrough when @deprecated is written in a JSDoc comment.

ref: https://devblogs.microsoft.com/typescript/announcing-typescript-4-0/#deprecated-support

This is useful to inform developers that some APIs, such as https://developer.nulab.com/docs/backlog/api/2/get-list-of-groups/#, are deprecated.

#64 (comment)

Because backlog-js has its own definitions.

https://www.npmjs.com/package/@types/backlog-js
https://docs.npmjs.com/cli/v8/commands/npm-deprecate

es6-promise can be removed after IE11 retirement (June 15, 2022) as we can expect Promise exists in most environments.
es6-promise is currently in:

• README.md
• package.json
• package-lock.json
• test/test.ts

Hi, thank you for great library!
I found subtle issues on Issue declaration.
https://github.com/nulab/backlog-js/blob/master/src/entity.ts#L233

  export interface Issue {
    id: number;
     :
    keyId: 1;    // <---- should be number
     :
    resolution: Resolution; // <----- should be Resolution | undefined
     :
    assignee: User.User; // <------ should be User.User | undefined
     :
  }

Please consider fixing 🙏

There are no type annotations in backlog.ts. This detracts from the developer experience.

I am interested in this task. Can I work on it?

Backlog APIを使わせていただいているのですが、
backlog-jsのバージョンを 0.9.1 から 0.10.0 にアップデートすると、
Backlogへ下記文字列を含んだ課題を投稿すると、失敗するようになりました。

''&color(#ffffff, #ff0000) { 赤背景白文字 }''

回避策などがあれば教えていただけますでしょうか。
よろしくお願いします。

Thanks to Travis CI.

I have confirmed our GitHub Actions CI worked fine in the pull request:
#30

So we can remove Travis CI settings.

• Remove .travis.yml.
• Status badge in README.md.

c.f. #19

https://developer.nulab.com/docs/backlog/api/2/get-rate-limit/#

I tried backlog-js in my Angular project and I got some compile errors.

Error: node_modules/backlog-js/dist/backlog.d.ts:178:5 - error TS7010: 'postWatchingListItem', which lacks return-type annotation, implicitly has an 'any' return type.

178     postWatchingListItem(params: any);
        ~~~~~~~~~~~~~~~~~~~~

Error: node_modules/backlog-js/dist/backlog.d.ts:180:5 - error TS7010: 'deletehWatchingListItem', which lacks return-type annotation, implicitly has an 'any' return type.

180     deletehWatchingListItem(watchId: number);
        ~~~~~~~~~~~~~~~~~~~~~~~

Error: node_modules/backlog-js/dist/backlog.d.ts:183:5 - error TS7010: 'getProjectGroupList', which lacks return-type annotation, implicitly has an 'any' return type.

183     getProjectGroupList(projectIdOrKey: string | number);
        ~~~~~~~~~~~~~~~~~~~

Error: node_modules/backlog-js/dist/backlog.d.ts:185:5 - error TS7010: 'postProjectGroup', which lacks return-type annotation, implicitly has an 'any' return type.

185     postProjectGroup(projectIdOrKey: string | number, params: any);
        ~~~~~~~~~~~~~~~~

Error: node_modules/backlog-js/dist/backlog.d.ts:187:5 - error TS7010: 'deleteProjectGroup', which lacks return-type annotation, implicitly has an 'any' return type.

187     deleteProjectGroup(projectIdOrKey: string | number);

These errors occurred when I enabled noImplicitAny option in tsconfig.json.
And noImplicitAny option is enabled by default in Angular projects.

I think it's better to add types to the return value of these functions.

URL

Parameter

Hello. I using a code example for oauth2. After I click allow and redirect to my web. This is my function handled callback.

app.get('/callback', async (req, res) => {
    const code = req.query.code;
    try {
        const accessToken = await oauth2.getAccessToken({ host, code, redirectUri });
        console.log('Access Token:', accessToken);

        // save access token.

        const myself = await new backlogjs.Backlog({
            host, accessToken: accessToken.access_token
        }).getMyself();
        console.log('Myself:', myself);

        res.redirect('/');
    } catch (e) {
        console.log('Access Token Error:', e.message);
        res.redirect('/login');
    }
});

I got an error: Access Token Error: FormData is not defined.
This exception throw in this line: const accessToken = await oauth2.getAccessToken({ host, code, redirectUri });

When posting the following issue:

{
  categoryId: 22853
  description: "Test 2"
  issueTypeId: 87099
  priorityId: 2
  projectId: 20805
  summary: "Test 2"
}

The following error is returned:

{
  message: "error.unknownParameter : categoryId",
  code: 7,
  moreInfo: ""
}

After removing the categoryId parameter, the issue is successfully posted.

https://github.com/nulab/backlog-js/blob/master/.github/workflows/nodejs.yml#L15

• Remove v12
• Add v16 and v18

In src/backlog.ts:

• patchGroup
  • groupId is not used. It should be in the url parameter.
  • https://developer.nulab.com/docs/backlog/api/2/update-group/#
• deleteCustomFieldItem
  • params is not used. It's not necessary.
  • itemId is necessary in the url parameter.
  • https://developer.nulab.com/docs/backlog/api/2/delete-list-item-for-list-type-custom-field/#
• getSharedFiles
  • params is not used. It should be passed to get method.
  • https://developer.nulab.com/docs/backlog/api/2/get-list-of-shared-files/#

Problem

I have to edit dist/backlog.d.ts by myself if I change a type in src/. There's some problems:

• Risks of forgetting or making a mistake to edit dist/backlog.d.ts.
• Annoying.

Goal

No manually editing dist/backlog.d.ts.

Idea

npm run build-tsd creates declaration files in dist/src/*.d.ts. I want to use the files instead of dist/backlog.d.ts. Can "types": "dist/src/index.d.ts" in package.json do it?

Hi,

I could not find any documents in API list to query all tickets that have startDate is unset. Could you provide some information?

Thanks