Merge pull request #165 from craigharman/main

docs/content/2.composables/1.useDirectusAuth.md

@@ -102,6 +102,48 @@ const onSubmit = async () => {
 </script>
 ```
 
+### `inviteUser`
+
+Invite a user to join Directus. **Email and role are required**. Email is sent by directus server to `email` with a link to directus server or `invite_url` containing invite token.
+
+- **Arguments:**
+  - data: [`DirectusInviteCreation`](https://github.com/Intevel/nuxt-directus/blob/main/src/runtime/types/index.d.ts#L239)
+- **Returns:** `Promise<void>`
+
+```vue
+<script setup lang="ts">
+const { inviteUser } = useDirectusAuth();
+const router = useRouter();
+
+const onSubmit = async () => {
+  try {
+    await inviteUser({ email: "", role: "c86c2761-65d3-43c3-897f-6f74ad6a5bd7" });
+  } catch (e) {}
+};
+</script>
+```
+
+### `acceptInvite`
+
+Accepts an invitation created via `inviteUser`. **Token and password are required**. Token is provided as a query param in the invite_url.
+
+- **Arguments:**
+  - data: [`DirectusAcceptInvite`](https://github.com/Intevel/nuxt-directus/blob/main/src/runtime/types/index.d.ts#L244)
+- **Returns:** `Promise<void>`
+
+```vue
+<script setup lang="ts">
+const { acceptInvite } = useDirectusAuth();
+const router = useRouter();
+
+const onSubmit = async () => {
+  try {
+    await acceptInvite({ token: "", password: "" });
+  } catch (e) {}
+};
+</script>
+```
+
 ## Middleware example
 
 > Check how to Redirect user to login page [over here](/examples/redirectuserlogin).

docs/content/4.Types/8.DirectusInvite.md

@@ -0,0 +1,16 @@
+# DirectusInvite
+
+Types related to Directus user invite procedure.
+
+```ts
+export interface DirectusInviteCreation {
+  email: string;
+  role: string;
+  invite_url?: string
+};
+
+export interface DirectusInviteAccept {
+  token: string;
+  password: string
+};
+```

src/runtime/composables/useDirectusAuth.ts

@@ -1,17 +1,20 @@
-import type { Ref } from 'vue'
-import { useRuntimeConfig, useRoute } from '#app'
 import type {
-  DirectusAuthResponse,
   DirectusAuthCredentials,
-  DirectusUser,
+  DirectusAuthResponse,
+  DirectusAcceptInvite,
+  DirectusInviteCreation,
   DirectusPasswordForgotCredentials,
   DirectusPasswordResetCredentials,
-  DirectusRegisterCredentials
+  DirectusRegisterCredentials,
+  DirectusUser
 } from '../types'
+import { useRoute, useRuntimeConfig } from '#app'
+
+import type { Ref } from 'vue'
 import { useDirectus } from './useDirectus'
-import { useDirectusUser } from './useDirectusUser'
 import { useDirectusToken } from './useDirectusToken'
 import { useDirectusUrl } from './useDirectusUrl'
+import { useDirectusUser } from './useDirectusUser'
 
 export const useDirectusAuth = () => {
   const config = useRuntimeConfig()
@@ -122,6 +125,24 @@ export const useDirectusAuth = () => {
     return createUser(data)
   }
 
+  const inviteUser = async (
+    data: DirectusInviteCreation
+  ): Promise<void> => {
+    return await directus('/users/invite', {
+      method: 'POST',
+      body: data
+    })
+  }
+
+  const acceptInvite = async(
+    data: DirectusAcceptInvite
+  ): Promise<void> => {
+    return await directus('/users/invite/accept', {
+      method: 'POST',
+      body: data
+    })
+  }
+
   const requestPasswordReset = async (
     data: DirectusPasswordForgotCredentials,
     useStaticToken?: boolean
@@ -163,6 +184,8 @@ export const useDirectusAuth = () => {
     logout,
     createUser,
     register,
+    inviteUser,
+    inviteAccept,
     loginWithProvider
   }
 }

src/runtime/types/index.d.ts

@@ -234,4 +234,15 @@ export interface DirectusItems<T> {
 
 export interface DirectusItem<T> {
   data: NonNullable<T>;
-};
+};
+
+export interface DirectusInviteCreation {
+  email: string;
+  role: string;
+  invite_url?: string
+};
+
+export interface DirectusAcceptInvite {
+  token: string;
+  password: string
+};