@intl-party/client

This package contains generated type-safe translations and runtime utilities for your IntlParty project. It's automatically generated by running intl-party generate and provides a clean API similar to @prisma/client.

Usage

import {
  TranslationKey,
  Locale,
  defaultMessages,
  createTranslationFunction,
} from "@intl-party/client";

// Type-safe translation keys
const key: TranslationKey = "common.welcome"; // ✅ TypeScript will validate this

// Type-safe locales
const locale: Locale = "en"; // ✅ Only valid locales are allowed

// Runtime messages
const messages = defaultMessages;
console.log(messages.en.common.welcome); // "Welcome to IntlParty!"

// Create a translation function
const t = createTranslationFunction("en", defaultMessages);
const translated = t("common.welcome"); // "Welcome to IntlParty!"

Runtime Utilities

import {
  getLocaleMessages,
  getAllMessages,
  validateTranslationKey,
  getAvailableLocales,
} from "@intl-party/client/runtime";

// Get messages for a specific locale
const enMessages = getLocaleMessages("en");

// Get all messages
const allMessages = getAllMessages();

// Validate translation keys at runtime
const isValid = validateTranslationKey("common.welcome"); // true

// Get available locales
const locales = getAvailableLocales(); // ['en', 'es', 'fr', 'de']

Generation

This package is automatically generated when you run:

npx intl-party generate

The generated files include:

• Type definitions for all translation keys and locales
• Runtime message data
• Utility functions for working with translations
• Validation helpers

File Structure

@intl-party/client/
├── generated/
│   ├── translations.generated.ts    # Type definitions
│   ├── messages.generated.ts        # Runtime message data
│   └── index.generated.ts           # Main exports
├── src/
│   ├── index.ts                     # Main package exports
│   └── runtime.ts                   # Runtime utilities
└── dist/                            # Built files