Appwrite Exception Translator

A lightweight translator for Appwrite SDK exceptions that provides user-friendly error messages in multiple languages.

Installation

# Using npm
npm install @itishermann/appwrite-exceptions-translator

# Using bun
bun add @itishermann/appwrite-exceptions-translator

# Using yarn
yarn add @itishermann/appwrite-exceptions-translator

Basic Usage

import { createDefaultTranslator } from '@itishermann/appwrite-exceptions-translator';

try {
  // Some Appwrite SDK operation
} catch (error) {
  const translator = createDefaultTranslator();
  const userFriendlyMessage = translator.translate(error);
  console.log(userFriendlyMessage);
}

Advanced Usage

import { AppwriteExceptionTranslator, LocalTranslationProvider } from '@itishermann/appwrite-exceptions-translator';

// Create custom instance with dependency injection
const provider = new LocalTranslationProvider();
const translator = new AppwriteExceptionTranslator(provider);

// Set preferred language (defaults to 'en')
translator.setLanguage('fr');

// Translate different types of errors
try {
  // Appwrite SDK operation
} catch (error) {
  const message = translator.translate(error);
  console.log(message);
}

// Checking available languages
const languages = translator.getAvailableLanguages();
console.log(`Available languages: ${languages.join(', ')}`);

Error Handling Details

The translator prioritizes error lookup in the following order:

By error.type (Appwrite error types like 'argument_invalid')
By error.code (HTTP status codes like 400, 404)
Falls back to the original error message if no translation is found

Contributing Translations

This package uses Crowdin for translation management. To contribute translations:

Join the Crowdin project with this invitation
Select a language and start translating
Submit your translations