keycloak / keycloak/keycloak-nodejs-connect

Update TypeScript type definitions

Open
#301 11 comments 4 reactions 0 assignees View on GitHub
kind/enhancement
Dominant language
JavaScript
Stars
740
Forks
442
PR merge metrics
No merged PRs in 30d

Description

### Description

The TypeScript type definitions are out of sync with the JavaScript code which can make it difficult to use, especially for new users. Ideally these should be updated to be in sync with JavaScript and any contributions should require updating these.

This was previously raised in Jira: [KEYCLOAK-13841](https://issues.redhat.com/browse/KEYCLOAK-13841) and [KEYCLOAK-14578](https://issues.redhat.com/browse/KEYCLOAK-14578).

### Discussion

_No response_

### Motivation

TypeScript is very popular and the community has been trying to update these type definitions (#245, #250, #289, #290, #291), but most require review, especially given that there are a few now.

### Details

_No response_

Contributor guide

Open the contributing guide

Research direction

The issue names no files, tests, or entry points. Start by locating the TypeScript definitions and comparing them with the JavaScript API; done means the definitions are in sync and future contributions require updating them, with related work in #245, #250, #289, #290, and #291 reviewed.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
developer-experience
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.