feat: add conditional types to createKindeServerClient to select the type of options and client

Author: coel

README.md

@@ -79,7 +79,6 @@ import {
   createKindeServerClient, 
   GrantType,
   type ACClientOptions,
-  type ACClient, 
 } from "@kinde-oss/kinde-typescript-sdk";
 
 const clientOptions: ACClientOptions = {
@@ -90,7 +89,7 @@ const clientOptions: ACClientOptions = {
   redirectURL: process.env.KINDE_REDIRECT_URL
 };
 
-const client = createKindeServerClient<ACClient, ACClientOptions>(
+const client = createKindeServerClient(
   GrantType.AUTHORIZATION_CODE, clientOptions
 );
 ```
@@ -101,7 +100,6 @@ import {
   createKindeServerClient, 
   GrantType,
   type PKCEClientOptions,
-  type ACClient, 
 } from "@kinde-oss/kinde-typescript-sdk";
 
 const clientOptions: PKCEClientOptions = {
@@ -111,7 +109,7 @@ const clientOptions: PKCEClientOptions = {
   redirectURL: process.env.KINDE_REDIRECT_URL
 };
 
-const client = createKindeServerClient<ACClient, PKCEClientOptions>(
+const client = createKindeServerClient(
   GrantType.PKCE, clientOptions
 );
 ```
@@ -122,7 +120,6 @@ import {
   createKindeServerClient, 
   GrantType,
   type CCClientOptions,
-  type CCClient, 
 } from "@kinde-oss/kinde-typescript-sdk";
 
 const clientOptions: CCClientOptions = {
@@ -132,7 +129,7 @@ const clientOptions: CCClientOptions = {
   logoutRedirectURL: process.env.KINDE_LOGOUT_REDIRECT_URL
 };
 
-const client = createKindeServerClient<CCClient, CCClientOptions>(
+const client = createKindeServerClient(
   GrantType.CLIENT_CREDENTIALS, clientOptions
 )
 ```
@@ -181,7 +178,6 @@ import {
   createKindeServerClient, 
   GrantType,
   type ACClientOptions,
-  type ACClient, 
 } from "@kinde-oss/kinde-typescript-sdk";
 
 const clientOptions: ACClientOptions = {
@@ -194,7 +190,7 @@ const clientOptions: ACClientOptions = {
   audience: 'api.example.com/v1'
 };
 
-const client = createKindeServerClient<ACClient, ACClientOptions>(
+const client = createKindeServerClient(
   GrantType.AUTHORIZATION_CODE, clientOptions
 );
 ```
@@ -230,7 +226,6 @@ import {
   createKindeServerClient, 
   GrantType,
   type ACClientOptions,
-  type ACClient, 
 } from "@kinde-oss/kinde-typescript-sdk";
 
 const clientOptions: ACClientOptions = {
@@ -243,7 +238,7 @@ const clientOptions: ACClientOptions = {
   framework: 'ExpressJS'
 };
 
-const client = createKindeServerClient<ACClient, ACClientOptions>(
+const client = createKindeServerClient(
   GrantType.AUTHORIZATION_CODE, clientOptions
 );
 ```

lib/apis/RolesApi.ts

@@ -53,7 +53,6 @@ export interface DeleteRoleRequest {
 
 export interface GetRolePermissionRequest {
     roleId: string;
-    permissionId: string;
     sort?: GetRolePermissionSortEnum;
     pageSize?: number | null;
     nextToken?: string | null;
@@ -173,10 +172,6 @@ export class RolesApi extends runtime.BaseAPI {
             throw new runtime.RequiredError('roleId','Required parameter requestParameters.roleId was null or undefined when calling getRolePermission.');
         }
 
-        if (requestParameters.permissionId === null || requestParameters.permissionId === undefined) {
-            throw new runtime.RequiredError('permissionId','Required parameter requestParameters.permissionId was null or undefined when calling getRolePermission.');
-        }
-
         const queryParameters: any = {};
 
         if (requestParameters.sort !== undefined) {
@@ -202,7 +197,7 @@ export class RolesApi extends runtime.BaseAPI {
             }
         }
         const response = await this.request({
-            path: `/api/v1/roles/{role_id}/permission/{permission_id}`.replace(`{${"role_id"}}`, encodeURIComponent(String(requestParameters.roleId))).replace(`{${"permission_id"}}`, encodeURIComponent(String(requestParameters.permissionId))),
+            path: `/api/v1/roles/{role_id}/permissions`.replace(`{${"role_id"}}`, encodeURIComponent(String(requestParameters.roleId))),
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,

lib/sdk/clients/server/index.ts

@@ -11,12 +11,12 @@ import type {
   CCClientOptions,
 } from '../types';
 
-export const createKindeServerClient = <
-  C extends ACClient | CCClient,
-  O extends ACClientOptions | PKCEClientOptions | CCClientOptions
->(
-  grantType: GrantType,
-  options: O
+type Options<T> = T extends GrantType.PKCE ? PKCEClientOptions : T extends GrantType.AUTHORIZATION_CODE ? ACClientOptions : T extends GrantType.CLIENT_CREDENTIALS ? CCClientOptions : never;
+type Client<T> = T extends PKCEClientOptions ? ACClient : T extends ACClientOptions ? ACClient : T extends  CCClientOptions ? CCClient : never; 
+
+export const createKindeServerClient = <G extends GrantType>(
+  grantType: G,
+  options: Options<G>
 ) => {
   if (!isNodeEnvironment()) {
     throw new Error('this method must be invoked in a node.js environment');
@@ -25,15 +25,15 @@ export const createKindeServerClient = <
   switch (grantType) {
     case GrantType.AUTHORIZATION_CODE: {
       const clientOptions = options as ACClientOptions;
-      return createAuthCodeClient(clientOptions, false) as C;
+      return createAuthCodeClient(clientOptions, false) as Client<Options<G>>;
     }
     case GrantType.PKCE: {
       const clientOptions = options as PKCEClientOptions;
-      return createAuthCodeClient(clientOptions, true) as C;
+      return createAuthCodeClient(clientOptions, true) as Client<Options<G>>;
     }
     case GrantType.CLIENT_CREDENTIALS: {
       const clientOptions = options as CCClientOptions;
-      return createCCClient(clientOptions) as C;
+      return createCCClient(clientOptions) as Client<Options<G>>;
     }
     default: {
       throw new Error('Unrecognized grant type provided');

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kinde-oss/kinde-typescript-sdk",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Kinde Typescript SDK",
   "main": "dist-cjs/index.js",
   "module": "dist/index.js",