@ghentcdh/authentication-vue 0.0.2-2 → 0.0.2-20

package/README.md

@@ -1,116 +1,107 @@
+GhentCdh Keycloak libraries for authentication
+
+# Vue frontend
+
+## Install the libraries
+
+```ssh
+pnpm add @ghentcdh/auth/vue @ghentcdh/auth/backend
+```
 
 # Use the GhentCDH keycloak libraries for authentication
 
 ## Install the libraries
 
 ```ssh
-pnpm add @ghentcdh/auth-vue @ghentcdh/auth-api
+pnpm add @ghentcdh/auth/vue @ghentcdh/auth/backend
 ```
 
 ## Frontend vuejs
 
 Add following environment variables to the `.env` file.
 
-```
+```bash
       - VITE_KEYCLOAK_HOST=$KEYCLOAK_HOST
       - VITE_KEYCLOAK_REALM=$KEYCLOAK_REALM
       - VITE_KEYCLOAK_CLIENT_ID=$KEYCLOAK_CLIENT_ID
 ```
 
-### Check if a user is logged in
+## Enable authentication
 
-```vue
+Enable the authentication plugin in your `main.ts` file.
 
-<script setup lang="ts">
-  import {useAuthenticationStore} from "@ghentcdh/authentication-vue";
+```typescript
+import { createAuth } from '@ghentcdh/authentication-vue';
 
-  const authenticationStore = useAuthenticationStore();
-</script>
+// Other app initialisation ...o
 
-<template>
-  <pre>user: {{ authenticationStore.user() }}</pre>
-</template>
+app.use(
+  createAuth({
+    keycloak: {
+      realm: import.meta.env.VITE_KEYCLOAK_REALM,
+      url: import.meta.env.VITE_KEYCLOAK_HOST,
+      clientId: import.meta.env.VITE_KEYCLOAK_CLIENT_ID,
+    },
+  }),
+);
 
 ```
 
-### Perform backend requests with the token
-
-```vue
-
-<script setup lang="ts">
-  import {useHttpStore} from "@ghentcdh/authentication-vue";
-
-  const httpStore = useHttpStore();
-
-  httpStore.post('/api/auth/login', {}).then(response => {
-    alert('login ok')
-  });
-</script>
+Create auth options 
 
+| Option    | Default | Functionality                                                |
+|-----------|---------|--------------------------------------------------------------|
+| skipAuth  | false   | Skip authentication by default if using HttpRequest function |
 
-```
+## Functions
 
-> TODO list
-> - [ ] Add roles guard to see if routes or parts of the application can be accessed by that user
-> - [ ] Test if it's possible to have public routes
-> - [ ] Add a
-> - [ ] Add logout functionality
+### User related functions
 
-## Backend nestjs
+```typescript
+import { createAuth } from '@ghentcdh/authentication-vue';
 
-Add following environment variables to the `.env` file.
+// Get the user
+await getUser();
 
-```
-      - KEYCLOAK_HOST=$KEYCLOAK_HOST
-      - KEYCLOAK_REALM=$KEYCLOAK_REALM
+// Check if the user is authenticated
+await isAuthenticated();
 ```
 
-### Secure requests
+### Perform backend requests with the token
 
-Add the module to your module.ts imports
+```vue
 
-```typescript
+<script setup lang="ts">
+  import { useHttpRequest } from "@ghentcdh/authentication/vue";
 
-import {AuthenticationApiModule} from "@ghentcdh/authentication-api";
+  const httpRequest = useHttpRequest();
 
-@Module({
-    imports: [AuthenticationApiModule],
-})
-export class MyModule {
-}
+  httpRequest.post('/api/auth/login', {}).then(response => {
+    alert('login ok')
+  });
+</script>
 
 ```
 
-Use the `@GhentCdhGuard` decorator to secure your routes
-
-```typescript
-import {GhentCdhGuard} from "@ghentcdh/authentication-api";
-
-@Controller()
-export class MyController {
-    @UseGuards(GhentCdhGuard)
-    @Post('/secure')
-    async securePath(@User() user: any, @Request() req: any) {
-        return user;
-    }
-}
-```
+Additional a parameter can be provided if the authentication should be skipped.
 
-The `@User()` decorator will give you the user object from the keycloak token.
+```typescript 
 
+```vue
 
-> TODO list
-> - [ ] Add roles decorator and implement logic `@GhentCdhRoles(['admin'])`
+<script setup lang="ts">
+  import { useHttpRequest } from "@ghentcdh/authentication/vue";
 
-## Development environment
+  const httpRequest = useHttpRequest();
 
-Make sure the following is added to your hosts file, if you are running a local keycloak instance. Internally the docker
-containers cannot connect to the localhost:8080 port, so a hook is needed in terms of host rewrite.
+  httpRequest.post('/api/skip-auth', {}, {skipAuth: true}).then(response => {
+    alert('login ok')
+  });
+</script>
 
-```sh
-echo "127.0.0.1 authentication\n" | sudo tee -a /etc/hosts
 ```
 
-## Setup docker
-
-> TODO describe me
+> TODO list
+> - [ ] Add roles guard to see if routes or parts of the application can be accessed by that user
+> - [ ] Add whitelisted routes
+> - [ ] Add logout functionality

package/index.d.ts

@@ -0,0 +1,3 @@
+export * from './lib/createAuth';
+export * from './lib/request';
+export * from './lib/utils';