[KEYCLOAK-14578] Update KeycloakConfig types #250

beevelop · 2020-06-24T18:24:48Z

Some Types are missing in the current implementation.
Related Jira-Issue: https://issues.redhat.com/browse/KEYCLOAK-14578

abstractj

@beevelop it seems somewhat related to the stale PR here #245. Maybe we could solve it in a single PR? If you would like to do that, I'd suggest to cherry-pick the commit from the original author keeping the authorship and add your commit on top of that.

Otherwise, we can move forward with your PR as is. The issues on Travis seem unrelated to the changes here.

beevelop · 2020-07-01T13:21:56Z

Looks like there are a few more changes in PR #245. So I'd say whatever works best for the reviewers. If the other changes are valid too, I can cherry-pick the respective commits into this PR.

abstractj · 2020-07-01T18:21:42Z

@beevelop if you are ok about this idea, let's do this. We cherry-pick changes from #245 keeping the authorship and update this pull-request with your commit. Thank you!

bruegth

I think we should avoid using quotes around variables.

bruegth · 2020-12-14T11:07:22Z

keycloak.d.ts

+    'clientId': string
+    'secret': string
+    'resource'?: string
+    'public-client'?: string


Type should be changed into boolean here:

keycloak-nodejs-connect/middleware/auth-utils/config.js

Line 117 in 74a0d7f

* @type {String}

bruegth · 2020-12-14T11:09:23Z

keycloak.d.ts

-    'resource': string
-    'ssl-required': string
+    'realm': string
+    'clientId': string


Suggested change

'clientId': string

clientId: string

bruegth · 2020-12-14T11:09:34Z

keycloak.d.ts

+    'realm': string
+    'clientId': string
+    'secret': string
+    'resource'?: string


Suggested change

'resource'?: string

'resource' or 'client-id' see here:

keycloak-nodejs-connect/middleware/auth-utils/config.js

Line 107 in 74a0d7f

this.clientId = resolveValue(config.resource || config['client-id'] || config.clientId);

bruegth · 2020-12-14T11:11:11Z

keycloak.d.ts

    'auth-server-url': string
-    'resource': string
-    'ssl-required': string
+    'realm': string


Suggested change

'realm': string

realm: string

bruegth · 2020-12-14T11:12:05Z

keycloak.d.ts

-    'ssl-required': string
+    'realm': string
+    'clientId': string
+    'secret': string


Suggested change

'secret': string

secret: string

bruegth · 2020-12-14T11:16:49Z

keycloak.d.ts

    'bearer-only'?: boolean
-    realm: string
+    'plainKey'?: string
+    'verifyTokenAudience'?: boolean


Suggested change

'verifyTokenAudience'?: boolean

verifyTokenAudience?: boolean

bruegth · 2020-12-14T11:16:51Z

keycloak.d.ts

    'bearer-only'?: boolean
-    realm: string
+    'plainKey'?: string


Suggested change

'plainKey'?: string

realmPublicKey?: string

bruegth · 2020-12-14T11:18:30Z

keycloak.d.ts

+    'clientId': string
+    'secret': string
+    'resource'?: string
+    'public-client'?: string


Suggested change

'public-client'?: string

public?: string

bruegth · 2020-12-14T11:19:03Z

keycloak.d.ts

@@ -18,12 +18,18 @@ interface KeycloakConnectStatic {
 declare namespace KeycloakConnect {

  interface KeycloakConfig {
-    'confidential-port': string|number
    'auth-server-url': string


Suggested change

'auth-server-url': string

authServerUrl: string

bruegth · 2020-12-14T11:20:15Z

keycloak.d.ts

+    'public-client'?: string
+    'realmUrl'?: string
+    'realmAdminUrl'?: string
+    'minTimeBetweenJwksRequests'?: number
    'bearer-only'?: boolean


Suggested change

'bearer-only'?: boolean

bearerOnly?: boolean

bruegth · 2020-12-14T11:29:37Z

Typescript won't work with this package, maybe it's better to remove .d.ts completely until it's covered by unit tests.

c0bra · 2020-12-30T19:49:46Z

What's the workaround for using this package with typescript in the meantime?

bruegth · 2020-12-31T14:25:45Z

What's the workaround for using this package with typescript in the meantime?

I've created a gulp task to replace the definition file in the node_modules folder with a modified one.

ItsTarik · 2021-03-17T15:22:36Z

Hi and thanks for reporting,I've got an other similar issue! it's hard to find useful information about this issue since the typescript config KeycloakConfig is missing the realm-public-key prop already !
So that's what i get with both version ^11.0.3 and the actual one ^12.0.4:

  interface KeycloakConfig {
    'confidential-port': string|number
    'auth-server-url': string
    'resource': string
    'ssl-required': string
    'bearer-only'?: boolean
    realm: string
  }

So in my case i can use the missing declared property: 'realm-public-key': 'pemkey', while ignoring the ts checking.
I will create a separate issue for this but i think that's important to list in this thread since its similar to the issue subject.

ffleandro · 2021-11-24T20:34:23Z

What is the current status for Typescript support and what was the blocker on this PR?

[KEYCLOAK-14578] Update KeycloakConfig types

8dfef28

ssilvert self-assigned this Jun 26, 2020

abstractj added the kind/bug label Jul 1, 2020

abstractj reviewed Jul 1, 2020

View reviewed changes

abstractj added the status/in-review label Jul 1, 2020

ckwalsh mentioned this pull request Jul 11, 2020

[KEYCLOAK-13841] Update typescript declarations #245

Open

bruegth suggested changes Dec 14, 2020

View reviewed changes

stianst removed kind/bug labels Nov 8, 2021

Fydon mentioned this pull request Nov 10, 2021

Update TypeScript type definitions #301

Open

abstractj requested review from edewit and jonkoops January 12, 2022 22:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[KEYCLOAK-14578] Update KeycloakConfig types #250

[KEYCLOAK-14578] Update KeycloakConfig types #250

beevelop commented Jun 24, 2020

abstractj left a comment

beevelop commented Jul 1, 2020

abstractj commented Jul 1, 2020

bruegth left a comment

bruegth Dec 14, 2020

bruegth Dec 14, 2020

bruegth Dec 14, 2020

bruegth Dec 14, 2020

bruegth Dec 14, 2020

bruegth Dec 14, 2020

bruegth Dec 14, 2020

bruegth Dec 14, 2020

bruegth Dec 14, 2020

bruegth Dec 14, 2020

bruegth Dec 14, 2020

bruegth commented Dec 14, 2020

c0bra commented Dec 30, 2020

bruegth commented Dec 31, 2020

ItsTarik commented Mar 17, 2021

ffleandro commented Nov 24, 2021

	'verifyTokenAudience'?: boolean
	verifyTokenAudience?: boolean

[KEYCLOAK-14578] Update KeycloakConfig types #250

Are you sure you want to change the base?

[KEYCLOAK-14578] Update KeycloakConfig types #250

Conversation

beevelop commented Jun 24, 2020

abstractj left a comment

Choose a reason for hiding this comment

beevelop commented Jul 1, 2020

abstractj commented Jul 1, 2020

bruegth left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bruegth commented Dec 14, 2020

c0bra commented Dec 30, 2020

bruegth commented Dec 31, 2020

ItsTarik commented Mar 17, 2021

ffleandro commented Nov 24, 2021