Fixing some typing issues (#142)

* fixes: #40 * fixes: #133 * fixing: #127
keycloak · Mar 5, 2021 · c563754 · c563754
1 parent 70a5880
commit c563754
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 10 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@keycloak/keycloak-admin-client",
-  "version": "1.14.7",
+  "version": "1.14.9",
   "description": "keycloak admin client",
   "main": "lib/index.js",
   "files": [

diff --git a/src/resources/clients.ts b/src/resources/clients.ts
@@ -21,7 +21,16 @@ export interface ClientQuery {
 }
 
 export interface PolicyQuery {
-  name: string;
+  id?: string;
+  name?: string;
+  type?: string;
+  resource?: string;
+  scope?: string;
+  permission?: string;
+  owner?: string;
+  fields?: string;
+  first?: number;
+  max?: number;
 }
 
 export class Clients extends Resource<{realm?: string}> {
@@ -501,15 +510,15 @@ export class Clients extends Resource<{realm?: string}> {
    * Policy
    */
   public listPolicies = this.makeRequest<
-    {id: string, name: string},
+    PolicyQuery,
     PolicyRepresentation[]
   >({
     method: 'GET',
     path: '{id}/authz/resource-server/policy',
     urlParamKeys: ['id'],
   });
 
-  public findByName = this.makeRequest<
+  public findPolicyByName = this.makeRequest<
     {id: string; name: string},
     PolicyRepresentation
   >({
@@ -559,7 +568,7 @@ export class Clients extends Resource<{realm?: string}> {
     policyName: string;
     policy: PolicyRepresentation;
   }): Promise<PolicyRepresentation> {
-    const policyFound = await this.findByName({
+    const policyFound = await this.findPolicyByName({
       id: payload.id,
       name: payload.policyName,
     });
@@ -568,7 +577,7 @@ export class Clients extends Resource<{realm?: string}> {
         {id: payload.id, policyId: policyFound.id, type: payload.policy.type},
         payload.policy,
       );
-      return this.findByName({id: payload.id, name: payload.policyName});
+      return this.findPolicyByName({id: payload.id, name: payload.policyName});
     } else {
       return this.createPolicy(
         {id: payload.id, type: payload.policy.type},

diff --git a/src/resources/roles.ts b/src/resources/roles.ts
@@ -47,7 +47,7 @@ export class Roles extends Resource<{realm?: string}> {
   });
 
   public findUsersWithRole = this.makeRequest<
-    {name: string},
+    {name: string; first?: number; max?: number},
     UserRepresentation[]
   >({
     method: 'GET',

diff --git a/src/utils/auth.ts b/src/utils/auth.ts
@@ -6,8 +6,8 @@ import {defaultBaseUrl, defaultRealm} from './constants';
 export type GrantTypes = 'client_credentials' | 'password';
 
 export interface Credentials {
-  username: string;
-  password: string;
+  username?: string;
+  password?: string;
   grantType: GrantTypes;
   clientId: string;
   clientSecret?: string;

diff --git a/test/groupUser.spec.ts b/test/groupUser.spec.ts
@@ -138,12 +138,15 @@ describe('Group user integration', () => {
         resourceName: permissions.resource,
       });
 
+      const policies = await kcAdminClient.clients.listPolicies({id: managementClient.id, resource: permissions.resource, max: 2});
+      expect(policies).to.have.length(2);
+
       expect(scopes).to.have.length(5);
 
       // Search for the id of the management role
       const roleId = scopes.find(scope => scope.name === 'manage').id;
 
-      const userPolicy = await kcAdminClient.clients.findByName({id: managementClient.id, name: `policy.manager.${currentGroup.id}`});
+      const userPolicy = await kcAdminClient.clients.findPolicyByName({id: managementClient.id, name: `policy.manager.${currentGroup.id}`});
 
       expect(userPolicy).to.deep.include({
         name: `policy.manager.${currentGroup.id}`,