Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/samk-dev/nuxt-appwrite-ii

Appwrite Client and Server integration for Nuxt. It'a a bit opinionated to suit the projects I am working on
https://github.com/samk-dev/nuxt-appwrite-ii

appwrite nuxt ssr

Last synced: 11 days ago
JSON representation

Appwrite Client and Server integration for Nuxt. It'a a bit opinionated to suit the projects I am working on

Host: GitHub
URL: https://github.com/samk-dev/nuxt-appwrite-ii
Owner: samk-dev
Created: 2024-05-21T20:10:01.000Z (6 months ago)
Default Branch: main
Last Pushed: 2024-05-28T20:02:45.000Z (5 months ago)
Last Synced: 2024-05-29T11:00:48.493Z (5 months ago)
Topics: appwrite, nuxt, ssr
Language: TypeScript
Homepage:
Size: 497 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # Nuxt Appwrite II

[![npm version][npm-version-src]][npm-version-href]

[![npm downloads][npm-downloads-src]][npm-downloads-href]

[![License][license-src]][license-href]

[![Nuxt][nuxt-src]][nuxt-href]

Appwrite Client and Server integration for Nuxt. It'a a bit opinionated to suit the projects I am working on, feel free to use it but before using please checkout [nuxt-appwrite-ii by @Hrdtr](https://nuxt.com/modules/appwrite)

- [✨  Changelog](/CHANGELOG.md)

## Features

- Web SDK

- Server Side SDK

- i18n ready

- Use one at a time or both

- flexibility to have different connections per SDK

## Quick Setup

Install Appwrite official SDK's. The module doesn't install them for better flexibility.

```bash

# Web SDK

npm install appwrite

pnpm add appwrite

yarn install appwrite

# Server side

npm install node-appwrite

pnpm add node-appwrite

yarn install node-appwrite

### ⚠️ THE CURRENT STABLE VERSION OF NODE APPWRITE HAS ISSUES ON EDGE RUNTIMES. TEMPORARY WORKAROUND IS TO INSTALL node-appwrite@next WILL FIX THE ISSUE ⚠️ ###

```

Install the module to your Nuxt application with one command:

```bash

npx nuxi module add nuxt-appwrite-ii

```

That's it! You can now use Nuxt Appwrite II in your Nuxt app

## Web SDK

Add your Appwrite credentials.

- `enabled` Enable/Disable Web SDK - default `true`

- `endpoint` The default endpoint is `https://cloud.appwrite.io/v1`

- `projectId` Project ID __the module will not load if missing__

- `defaultLocale` default `en`

```ts

export default defineNuxtConfig({

  // ...restOfConfig

  modules: ['nuxt-appwrite-ii'],

  nuxtAppwrite: {

    client: {

      enabled: true,

      endpoint: 'https://cloud.appwrite.io/v1',

      projectId: '', // required**

      defaultLocale: 'en'

    },

  },

  // ...restOfConfig

})

```

### `useAppwrite` composable

You can destructure `account, databases, functions, storage, teams, avatars, locale, Permission, Query, Role, AppwriteException, ID` from `useAppwrite()`

```ts

const { account } = useAppwrite()

// example getting current loggedin account

try {

  const user = await account.get()

  console.log(user)

} catch (error) {

  console.log(error)

}

```

## Server Side

Add your Appwrite credentials.

- `enabled` Enable/Disable Web SDK - default `false`

- `endpoint` The default endpoint is `https://cloud.appwrite.io/v1`

- `projectId` Project ID __the module will not load if missing__

- `apiKey` Api Key __the module will not load if missing__

- `cookieName` Session cookie name - default `a_session`

- `i18nCookieKey` nuxt-i18n cookie key - default `i18n_redirected`

- `defaultLocale` default `en`

```ts

export default defineNuxtConfig({

  // ...restOfConfig

  modules: ['nuxt-appwrite-ii'],

  nuxtAppwrite: {

    //client: {...clientoptions},

    server: {

      enabled: true,

      endpoint: 'https://cloud.appwrite.io/v1',

      projectId: '', // required**

      apiKey: '', // required**

      cookieName: 'a_session',

      i18nCookieKey: 'i18n_redirected',

      defaultLocale: 'en'

    }

  },

  // ...restOfConfig

})

```

The server side integration should be used with caution as it exposes 2 clients, `useAppwriteSSRAdminClient` and `useAppwriteSSRSessionClient`

### `useAppwriteSSRAdminClient` Server Util

This composable needs an `API KEY` with at least `session.create` permissions. It can be used to create sessions,

do administrative tasks. *__CAUTION WITH WHAT YOU DO WITH THE UTIL AS IT ACTS ON BEHALF OF APPWRITE SUPER ADMIN AND BYPASS ANY RATE LIMITS AND PERMISSIONS__*

```ts

import { useAppwriteSSRAdminClient } from '#nuxt-appwrite-ssr'

export default defineEventHandler(async (event) => {

  const { email, password } = await readBody<{ email: string, password: string }>(event)

  const { account, AppwriteException } = useAppwriteSSRAdminClient(event)

  const config = useRuntimeConfig(event)

  try {

    const session = await account.createEmailPasswordSession(email, password)

    setCookie(event, config.appwrite.cookieName, session.secret, {

      expires: new Date(session.expire),

      path: '/',

      httpOnly: true,

      secure: true,

      sameSite: 'strict',

    })

    return { status: 'success', message: 'session created' }

  }

  catch (error: any) {

    if (error instanceof AppwriteException) {

      return createError({

        statusCode: error.code,

        statusMessage: error.message,

        message: error.name,

      })

    }

    return createError(error)

  }

})

```

### `useAppwriteSSRSessionClient` Server Util

This composable is used after the `useAppwriteSSRAdminClient` as it uses the session created. And will respect any applied rate limits and permissions for the user.

```ts

import { useAppwriteSSRSessionClient } from '#nuxt-appwrite-ssr'

export default defineEventHandler(async (event) => {

  const { account, AppwriteException } = useAppwriteSSRSessionClient(event)

  try {

    return await account.get()

  }

  catch (error: any) {

    if (error instanceof AppwriteException) {

      return createError({

        statusCode: error.code,

        statusMessage: error.message,

        message: error.name,

      })

    }

    return createError(error)

  }

})

```

## i18n Support

The Web SDK relies on `nuxt-i18n` `i18n:beforeLocaleSwitch` and updates the client locale header automatically.

The Server SDK relies on `nuxt-i18n` `i18nCookieKey` and updates the client locale header automatically.

## Contribution

  Local development

  

  ```bash

  # Install dependencies

  npm install

  

  # Generate type stubs

  npm run dev:prepare

  

  # Develop with the playground

  npm run dev

  

  # Build the playground

  npm run dev:build

  

  # Run ESLint

  npm run lint

  

  # Run Vitest

  npm run test

  npm run test:watch

  

  # Release new version

  npm run release

  ```

## Credits

- Inspiration -> Nuxt Supabase Module

[npm-version-src]: https://img.shields.io/npm/v/nuxt-appwrite-ii/latest.svg?style=flat&colorA=020420&colorB=00DC82

[npm-version-href]: https://npmjs.com/package/nuxt-appwrite-ii

[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-appwrite-ii.svg?style=flat&colorA=020420&colorB=00DC82

[npm-downloads-href]: https://npmjs.com/package/nuxt-appwrite-ii

[license-src]: https://img.shields.io/npm/l/nuxt-appwrite-ii.svg?style=flat&colorA=020420&colorB=00DC82

[license-href]: https://npmjs.com/package/nuxt-appwrite-ii

[nuxt-src]: https://img.shields.io/badge/Nuxt-020420?logo=nuxt.js

[nuxt-href]: https://nuxt.com