@hahnpro/ai-sdk 0.11.0 → 0.11.1

package/README.md

@@ -53,3 +53,101 @@ bootstrapApplication(AppComponent, {
   ],
 }).catch((err) => console.error(err));
 ```
+
+## User Authentication
+
+### Overview
+
+The `AuthAdapter` is an interface that provides a unified API for different authentication libraries. It abstracts the specific authentication implementation and allows using various auth providers.
+
+### Interface Definition
+
+``` typescript
+export interface AuthAdapter {
+  init(): Promise<void>;
+  isAuthenticated(): Promise<boolean>;
+  getAccessToken(): Promise<string>;
+  loginRedirect(options?: { redirectUri?: string }): Promise<void>;
+  loginPopup?(): Promise<void>;
+  logout?(): Promise<void>;
+}
+```
+
+### Required Fields
+
+`init()`: Initializes the auth provider (e.g., checks existing sessions)
+
+`isAuthenticated()`: Checks if the user is authenticated
+
+`getAccessToken()`: Returns the current access token
+
+`loginRedirect()`: Starts the login flow with redirect
+
+### Optional Fields
+`loginPopup()`: Starts the login flow in a popup window
+
+`logout()`: Logs out the user
+
+### Implementation with OIDC
+Here's an example implementation using angular-auth-oidc-client:
+``` typescript
+
+import { AUTH_ADAPTER, AuthAdapter } from '@hahnpro/ai-sdk';
+import { OidcSecurityService } from 'angular-auth-oidc-client';
+import { lastValueFrom } from 'rxjs';
+
+export const AUTH_PROVIDERS = [
+  // OIDC Provider configuration...
+  {
+    provide: AUTH_ADAPTER,
+    deps: [OidcSecurityService],
+    useFactory: (oidc: OidcSecurityService): AuthAdapter => ({
+      init: async () => {
+        // Automatically checks existing authentication
+        await lastValueFrom(oidc.checkAuth());
+      },
+      isAuthenticated: () => {
+        return lastValueFrom(oidc.isAuthenticated());
+      },
+      getAccessToken(): Promise<string> {
+        return lastValueFrom(oidc.getAccessToken());
+      },
+      loginRedirect: async (options) => {
+        // Optional: use redirect URL
+        oidc.authorize(options?.redirectUri);
+      },
+      loginPopup: async () => {
+        await lastValueFrom(oidc.authorizeWithPopUp());
+      },
+      logout: async () => {
+        await lastValueFrom(oidc.logoff());
+      },
+    }),
+  },
+];
+```
+
+### Injection in Angular
+1. Register Provider
+``` typescript
+import { provideAiSdk } from '@hahnpro/ai-sdk';
+
+bootstrapApplication(AppComponent, {
+  providers: [
+    provideAiSdk(),
+    ...AUTH_PROVIDERS, // AuthAdapter is provided here
+  ],
+});
+```
+2. Initalize Auth Adapter
+At some point before using the Auth Adapter, you need to initialize it. This can be done by calling the `init()` method of the Auth Adapter:
+``` typescript
+export class AppComponent implements OnInit {
+  private readonly auth = inject(AUTH_ADAPTER);
+
+  ngOnInit() {
+    this.auth.init();
+  }
+  ...
+}
+```