Skip to content

Commit

Permalink
feat: ✨ Add inviteUser and inviteAccept
Browse files Browse the repository at this point in the history
Allow user invitation and acceptance options.
  • Loading branch information
Craig Harman committed Jun 27, 2023
1 parent 884125f commit 5509f7a
Show file tree
Hide file tree
Showing 3 changed files with 84 additions and 7 deletions.
42 changes: 42 additions & 0 deletions docs/content/2.composables/1.useDirectusAuth.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
```

### `inviteAccept`

Accepts an invitation created via `inviteUser`. **Token and password are required**. Token is provided as a query param in the invite_url.

- **Arguments:**
- data: [`DirectusInviteAccept`](https://github.com/Intevel/nuxt-directus/blob/main/src/runtime/types/index.d.ts#L244)
- **Returns:** `Promise<void>`

```vue
<script setup lang="ts">
const { inviteUser } = useDirectusAuth();
const router = useRouter();
const onSubmit = async () => {
try {
await inviteUser({ token: "", password: "" });
} catch (e) {}
};
</script>
```

## Middleware example

> Check how to Redirect user to login page [over here](/examples/redirectuserlogin).
Expand Down
36 changes: 30 additions & 6 deletions src/runtime/composables/useDirectusAuth.ts
Original file line number Diff line number Diff line change
@@ -1,17 +1,21 @@
import type { Ref } from 'vue'
import { useRuntimeConfig, useRoute } from '#app'
import type {
DirectusAuthResponse,
DirectusAuthCredentials,
DirectusUser,
DirectusAuthResponse,
DirectusInviteAccept,
DirectusInviteCreation,
DirectusInviteResponse,
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()
Expand Down Expand Up @@ -122,6 +126,24 @@ export const useDirectusAuth = () => {
return createUser(data)
}

const inviteUser = async (
data: DirectusInviteCreation
): Promise<void> => {
return await directus('/users/invite', {
method: 'POST',
body: data
})
}

const inviteAccept = async(
data: DirectusInviteAccept
): Promise<void> => {
return await directus('/users/invite/accept', {
method: 'POST',
body: data
})
}

const requestPasswordReset = async (
data: DirectusPasswordForgotCredentials,
useStaticToken?: boolean
Expand Down Expand Up @@ -163,6 +185,8 @@ export const useDirectusAuth = () => {
logout,
createUser,
register,
inviteUser,
inviteAccept,
loginWithProvider
}
}
13 changes: 12 additions & 1 deletion src/runtime/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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 DirectusInviteAccept {
token: string;
password: string
};

0 comments on commit 5509f7a

Please sign in to comment.