feat(runtime): Allow null return value in AuthProvider.getConfig()

CHANGELOG.md

@@ -1,5 +1,15 @@
 # CHANGELOG.md
 
+## Unreleased
+
+- Allow null return value in AuthProvider.getConfig() [#50](https://github.com/Embraser01/typoas/pull/50)
+
+## 3.1.2 - 2024-01-26
+
+> Only the runtime was published, the generator and cli are still at 3.1.5
+
+- Fix AuthProviders configuration [#44](https://github.com/Embraser01/typoas/issues/44)
+
 ## 3.1.5 - 2023-10-25
 
 > Only the generator and cli were published, the runtime is still at 3.1.3

packages/typoas-runtime/src/auth/api-key-auth.ts

@@ -22,7 +22,12 @@ export class ApiKeySecurityAuthentication implements SecurityAuthentication {
 
   async applySecurityAuthentication(context: RequestContext): Promise<void> {
     if (!this.provider) return;
+
     const apiToken = await this.provider.getConfig();
+    if (apiToken === null) {
+      return;
+    }
+
     switch (this.in) {
       case 'query':
         return context.setQueryParam(this.name, apiToken);

packages/typoas-runtime/src/auth/base.ts

@@ -13,5 +13,5 @@ export interface SecurityAuthentication {
 }
 
 export interface AuthProvider<T> {
-  getConfig(): Promise<T> | T;
+  getConfig(): Promise<T> | T | null;
 }

packages/typoas-runtime/src/auth/http-auth-basic.ts

@@ -9,7 +9,12 @@ export class HttpBasicSecurityAuthentication implements SecurityAuthentication {
   async applySecurityAuthentication(context: RequestContext): Promise<void> {
     if (!this.provider) return;
 
-    const { username, password } = await this.provider.getConfig();
+    const res = await this.provider.getConfig();
+    if (res === null) {
+      return;
+    }
+
+    const { username, password } = res;
     const base64 = btoa(`${username}:${password}`);
     return context.setHeaderParam('Authorization', `Basic ${base64}`);
   }

packages/typoas-runtime/src/auth/http-auth-bearer.ts

@@ -12,6 +12,10 @@ export class HttpBearerSecurityAuthentication
     if (!this.provider) return;
 
     const res = await this.provider.getConfig();
+    if (res === null) {
+      return;
+    }
+
     const token = typeof res === 'string' ? res : res.token;
     const prefix =
       typeof res === 'string' ? 'Bearer' : res.prefixName || 'Bearer';

packages/typoas-runtime/src/auth/oauth2-auth.ts

@@ -44,7 +44,13 @@ export class OAuth2SecurityAuthentication implements SecurityAuthentication {
 
   async applySecurityAuthentication(context: RequestContext): Promise<void> {
     if (!this.provider) return;
-    const { accessToken, tokenType } = await this.provider.getConfig();
+
+    const res = await this.provider.getConfig();
+    if (res === null) {
+      return;
+    }
+
+    const { accessToken, tokenType } = res;
     return context.setHeaderParam(
       'Authorization',
       `${tokenType || 'Bearer'} ${accessToken}`,