@akis05/akis 0.1.4 → 0.1.6

package/README.md

@@ -1,30 +1,30 @@
 # AKIS - Appwrite CLI Tool
 
-**AKIS** est un outil CLI qui synchronise automatiquement vos collections Appwrite avec vos types TypeScript. Définissez vos types une seule fois, et AKIS crée/met à jour vos collections et génère le schéma correspondant.
+**AKIS** is a CLI tool that automatically syncs your Appwrite collections with your TypeScript types. Define your types once, and AKIS creates/updates your collections and generates the corresponding schema.
 
-## Fonctionnalités
+## Features
 
-- **Génération automatique** : Crée les collections Appwrite depuis vos types TypeScript
-- **Synchronisation** : Détecte les différences entre vos types et Appwrite
-- **Schema auto-généré** : Le fichier `schema.ts` est généré automatiquement lors de la migration
-- **Indexes automatiques** : Crée les indexes pour les champs courants (storeId, email, etc.)
-- **Mode dry-run** : Prévisualisez les changements avant de les appliquer
+- **Auto-generation**: Creates Appwrite collections from your TypeScript types
+- **Synchronization**: Detects differences between your types and Appwrite
+- **Auto-generated schema**: The `schema.ts` file is automatically generated during migration
+- **Automatic indexes**: Creates indexes for common fields (storeId, email, etc.)
+- **Dry-run mode**: Preview changes before applying them
 
 ---
 
 ## Installation
 
-### Avec npm
+### With npm
 ```bash
 npm install @akis05/akis
 ```
 
-### Avec pnpm
+### With pnpm
 ```bash
 pnpm add @akis05/akis
 ```
 
-### Installation globale (optionnel)
+### Global installation (optional)
 ```bash
 npm install -g @akis05/akis
 ```
@@ -33,97 +33,97 @@ npm install -g @akis05/akis
 
 ## Configuration
 
-### 1. Variables d'environnement
+### 1. Environment Variables
 
-Créez un fichier `.env` à la racine de votre projet:
+Create a `.env` file at the root of your project:
 
 ```env
-# Endpoint Appwrite (Cloud ou Self-hosted)
+# Appwrite Endpoint (Cloud or Self-hosted)
 APPWRITE_ENDPOINT=https://cloud.appwrite.io/v1
 
-# ID de votre projet Appwrite
-APPWRITE_PROJECT_ID=votre_project_id
+# Your Appwrite project ID
+APPWRITE_PROJECT_ID=your_project_id
 
-# ID de votre base de données
-APPWRITE_DATABASE_ID=votre_database_id
+# Your database ID
+APPWRITE_DATABASE_ID=your_database_id
 
-# Clé API avec permissions Database (Create, Read, Update, Delete)
-APPWRITE_API_KEY=votre_api_key
+# API Key with Database permissions (Create, Read, Update, Delete)
+APPWRITE_API_KEY=your_api_key
 ```
 
-### 2. Obtenir les identifiants Appwrite
+### 2. Getting Appwrite Credentials
 
-1. Connectez-vous à [Appwrite Console](https://cloud.appwrite.io)
-2. **Project ID** : Settings → Project ID
-3. **Database ID** : Databases → Cliquez sur votre DB → Settings
-4. **API Key** : Settings → API Keys → Create API Key (cochez Database permissions)
+1. Log in to [Appwrite Console](https://cloud.appwrite.io)
+2. **Project ID**: Settings → Project ID
+3. **Database ID**: Databases → Click on your DB → Settings
+4. **API Key**: Settings → API Keys → Create API Key (check Database permissions)
 
 ---
 
-## Démarrage rapide
+## Quick Start
 
-### Étape 1 : Initialiser le projet
+### Step 1: Initialize the project
 
 ```bash
 npx akis init
 ```
 
-Cette commande crée la structure suivante:
+This command creates the following structure:
 
 ```
 core/
 └── appwrite-model/
-    ├── types.ts              # Vos définitions TypeScript
-    ├── schema.ts             # Schéma généré (ne pas modifier manuellement)
-    ├── client.ts             # Client Appwrite configuré
-    └── setup-collections.ts  # Fonctions utilitaires
+    ├── types.ts              # Your TypeScript definitions
+    ├── schema.ts             # Generated schema (do not edit manually)
+    ├── client.ts             # Configured Appwrite client
+    └── setup-collections.ts  # Utility functions
 ```
 
-### Étape 2 : Définir vos types
+### Step 2: Define your types
 
-Éditez `core/appwrite-model/types.ts`:
+Edit `core/appwrite-model/types.ts`:
 
 ```typescript
 export type Client = {
-  _id: string;              // ID Appwrite (obligatoire)
-  _creationTime: number;    // Timestamp création (obligatoire)
-  nom: string;              // Champ requis
-  email?: string;           // Champ optionnel (?)
-  telephone?: string;
-  statut: "actif" | "inactif";  // Enum
-  tags?: string[];          // Array de strings
+  _id: string;              // Appwrite ID (required)
+  _creationTime: number;    // Creation timestamp (required)
+  name: string;             // Required field
+  email?: string;           // Optional field (?)
+  phone?: string;
+  status: "active" | "inactive";  // Enum
+  tags?: string[];          // String array
   storeId: string;
   createdAt: number;
   deletedAt?: number;
 };
 
-export type Produit = {
+export type Product = {
   _id: string;
   _creationTime: number;
-  nom: string;
-  prix: number;
-  quantite: number;
-  categorie: "electronique" | "vetement" | "alimentaire";
+  name: string;
+  price: number;
+  quantity: number;
+  category: "electronics" | "clothing" | "food";
   storeId: string;
   createdAt: number;
 };
 ```
 
-### Étape 3 : Migrer vers Appwrite
+### Step 3: Migrate to Appwrite
 
 ```bash
-# Prévisualiser les changements (recommandé)
+# Preview changes (recommended)
 npx akis migrate --dry-run
 
-# Créer les collections
+# Create collections
 npx akis migrate
 ```
 
-**Résultat** :
-- Collections créées dans Appwrite
-- Fichier `schema.ts` généré automatiquement
+**Result**:
+- Collections created in Appwrite
+- `schema.ts` file automatically generated
 
-### Étape 4 : Vérifier le statut
+### Step 4: Check status
 
 ```bash
 npx akis status
@@ -131,212 +131,212 @@ npx akis status
 
 ---
 
-## Commandes
+## Commands
 
 ### `akis init`
 
-Initialise la structure du projet.
+Initializes the project structure.
 
 ```bash
-npx akis init           # Créer les fichiers
-npx akis init --force   # Écraser les fichiers existants
+npx akis init           # Create files
+npx akis init --force   # Overwrite existing files
 ```
 
 **Options:**
 | Option | Description |
 |--------|-------------|
-| `-f, --force` | Écrase les fichiers existants |
+| `-f, --force` | Overwrites existing files |
 
 ---
 
 ### `akis migrate`
 
-Crée les collections manquantes dans Appwrite et génère `schema.ts`.
+Creates missing collections in Appwrite and generates `schema.ts`.
 
 ```bash
-npx akis migrate                    # Migrer toutes les collections
-npx akis migrate --name clients     # Migrer une collection spécifique
-npx akis migrate --dry-run          # Prévisualiser sans exécuter
+npx akis migrate                    # Migrate all collections
+npx akis migrate --name clients     # Migrate a specific collection
+npx akis migrate --dry-run          # Preview without executing
 ```
 
 **Options:**
 | Option | Description |
 |--------|-------------|
-| `-n, --name <name>` | Nom de la collection à migrer |
-| `-d, --dry-run` | Affiche les actions sans les exécuter |
+| `-n, --name <name>` | Name of the collection to migrate |
+| `-d, --dry-run` | Shows actions without executing them |
 
-**Exemple de sortie:**
+**Example output:**
 ```
-🚀 AKIS Migrate - Création des collections manquantes
+🚀 AKIS Migrate - Creating missing collections
 
-📖 Lecture de types.ts...
-   2 collection(s) à traiter
+📖 Reading types.ts...
+   2 collection(s) to process
 
-📡 Connexion à Appwrite...
+📡 Connecting to Appwrite...
 
-📦 Création de clients...
-   ✓ nom
+📦 Creating clients...
+   ✓ name
    ✓ email
-   ✓ telephone
-   ✓ statut
+   ✓ phone
+   ✓ status
    ✓ storeId
    🔑 idx_storeId
    🔑 idx_email
-   ✅ clients créée
+   ✅ clients created
 
-📝 schema.ts généré avec 2 collections
+📝 schema.ts generated with 2 collections
 
-✨ Migration terminée: 1 créées, 1 ignorées
+✨ Migration complete: 1 created, 1 skipped
 ```
 
 ---
 
 ### `akis update`
 
-Ajoute les nouveaux attributs aux collections existantes.
+Adds new attributes to existing collections.
 
 ```bash
-npx akis update                    # Mettre à jour toutes les collections
-npx akis update --name clients     # Mettre à jour une collection spécifique
-npx akis update --dry-run          # Prévisualiser sans exécuter
+npx akis update                    # Update all collections
+npx akis update --name clients     # Update a specific collection
+npx akis update --dry-run          # Preview without executing
 ```
 
 **Options:**
 | Option | Description |
 |--------|-------------|
-| `-n, --name <name>` | Nom de la collection à mettre à jour |
-| `-d, --dry-run` | Affiche les actions sans les exécuter |
+| `-n, --name <name>` | Name of the collection to update |
+| `-d, --dry-run` | Shows actions without executing them |
 
-**Cas d'utilisation:**
-- Vous avez ajouté un nouveau champ dans `types.ts`
-- Vous voulez synchroniser sans recréer la collection
+**Use cases:**
+- You added a new field in `types.ts`
+- You want to sync without recreating the collection
 
 ---
 
 ### `akis status`
 
-Compare les types locaux avec les collections Appwrite.
+Compares local types with Appwrite collections.
 
 ```bash
-npx akis status                    # Voir toutes les collections
-npx akis status --name clients     # Voir une collection spécifique
+npx akis status                    # View all collections
+npx akis status --name clients     # View a specific collection
 ```
 
 **Options:**
 | Option | Description |
 |--------|-------------|
-| `-n, --name <name>` | Nom de la collection à vérifier |
+| `-n, --name <name>` | Name of the collection to check |
 
-**Exemple de sortie:**
+**Example output:**
 ```
-📊 AKIS Status - État des collections
+📊 AKIS Status - Collection Status
 
 ┌─────────────────────────────┬────────┬────────────┬─────────────┐
-│ Collection                  │ Status │ Attributs  │ Manquants   │
+│ Collection                  │ Status │ Attributes │ Missing     │
 ├─────────────────────────────┼────────┼────────────┼─────────────┤
 │ clients                     │ ✅     │ 9/9        │ 0           │
-│ produits                    │ ⚠️     │ 5/7        │ 2           │
-│ commandes                   │ ❌     │ -          │ -           │
+│ products                    │ ⚠️     │ 5/7        │ 2           │
+│ orders                      │ ❌     │ -          │ -           │
 └─────────────────────────────┴────────┴────────────┴─────────────┘
 
-📈 Résumé:
-   ✅ 1 synchronisées
-   ⚠️  1 à mettre à jour (akis update)
-   ❌ 1 manquantes (akis migrate)
+📈 Summary:
+   ✅ 1 synchronized
+   ⚠️  1 needs update (akis update)
+   ❌ 1 missing (akis migrate)
 ```
 
 ---
 
 ### `akis delete`
 
-Supprime des collections dans Appwrite.
+Deletes collections in Appwrite.
 
 ```bash
-npx akis delete --name clients     # Supprimer une collection (avec confirmation)
-npx akis delete --force            # Supprimer TOUTES les collections sans confirmation
-npx akis delete --name clients -f  # Supprimer sans confirmation
+npx akis delete --name clients     # Delete a collection (with confirmation)
+npx akis delete --force            # Delete ALL collections without confirmation
+npx akis delete --name clients -f  # Delete without confirmation
 ```
 
 **Options:**
 | Option | Description |
 |--------|-------------|
-| `-n, --name <name>` | Nom de la collection à supprimer |
-| `-f, --force` | Supprimer sans demander confirmation |
+| `-n, --name <name>` | Name of the collection to delete |
+| `-f, --force` | Delete without asking for confirmation |
 
-⚠️ **Attention** : Cette action est irréversible !
+⚠️ **Warning**: This action is irreversible!
 
 ---
 
-## Types TypeScript supportés
+## Supported TypeScript Types
 
-AKIS reconnaît automatiquement les types suivants:
+AKIS automatically recognizes the following types:
 
 | TypeScript | Appwrite Attribute |
 |------------|-------------------|
-| `string` | String (size auto-détectée) |
-| `number` | Float ou Integer (selon le nom du champ) |
+| `string` | String (auto-detected size) |
+| `number` | Float or Integer (based on field name) |
 | `boolean` | Boolean |
 | `string[]` | String Array |
 | `number[]` | Integer Array |
 | `"a" \| "b" \| "c"` | Enum |
 
-### Conventions de nommage
+### Naming Conventions
 
-AKIS infère automatiquement certaines propriétés:
+AKIS automatically infers certain properties:
 
-| Nom du champ | Type inféré | Taille |
-|--------------|-------------|--------|
+| Field Name | Inferred Type | Size |
+|------------|---------------|------|
 | `*Id`, `storeId` | string | 36 |
 | `email` | string | 255 |
-| `telephone`, `tel` | string | 50 |
+| `phone`, `tel` | string | 50 |
 | `note`, `description` | string | 2000 |
-| `adresse` | string | 500 |
-| `quantite*`, `*Minutes` | integer | - |
+| `address` | string | 500 |
+| `quantity*`, `*Minutes` | integer | - |
 | `createdAt`, `deletedAt` | integer | - |
 
-### Champs système (ignorés)
+### System Fields (ignored)
 
-Ces champs sont automatiquement ignorés car gérés par Appwrite:
-- `_id` - ID du document
-- `_creationTime` - Timestamp de création
+These fields are automatically ignored as they are managed by Appwrite:
+- `_id` - Document ID
+- `_creationTime` - Creation timestamp
 
 ---
 
-## Workflow recommandé
+## Recommended Workflow
 
 ```
 ┌─────────────────────────────────────────────────────────────┐
-│  1. Définir les types dans types.ts                        │
+│  1. Define types in types.ts                                │
 │     export type Client = { ... }                            │
 └─────────────────────────────────────────────────────────────┘
                               ↓
 ┌─────────────────────────────────────────────────────────────┐
-│  2. Prévisualiser les changements                           │
+│  2. Preview changes                                         │
 │     npx akis migrate --dry-run                              │
 └─────────────────────────────────────────────────────────────┘
                               ↓
 ┌─────────────────────────────────────────────────────────────┐
-│  3. Migrer vers Appwrite                                    │
+│  3. Migrate to Appwrite                                     │
 │     npx akis migrate                                        │
-│     → Collections créées + schema.ts généré                 │
+│     → Collections created + schema.ts generated             │
 └─────────────────────────────────────────────────────────────┘
                               ↓
 ┌─────────────────────────────────────────────────────────────┐
-│  4. Vérifier la synchronisation                             │
+│  4. Verify synchronization                                  │
 │     npx akis status                                         │
 └─────────────────────────────────────────────────────────────┘
                               ↓
 ┌─────────────────────────────────────────────────────────────┐
-│  5. Ajouter de nouveaux champs ? → Retour à l'étape 1       │
+│  5. Adding new fields? → Back to step 1                     │
 │     npx akis update                                         │
 └─────────────────────────────────────────────────────────────┘
 ```
 
 ---
 
-## Utilisation avec pnpm
+## Using with pnpm
 
-Si vous utilisez pnpm, ajoutez un script dans votre `package.json`:
+If you use pnpm, add a script to your `package.json`:
 
 ```json
 {
@@ -346,7 +346,7 @@ Si vous utilisez pnpm, ajoutez un script dans votre `package.json`:
 }
 ```
 
-Puis utilisez:
+Then use:
 ```bash
 pnpm akis status
 pnpm akis migrate
@@ -355,85 +355,85 @@ pnpm akis update
 
 ---
 
-## Exemples
+## Examples
 
-### Exemple complet de types.ts
+### Complete types.ts Example
 
 ```typescript
 /* ═══════════════════════════════════════════════════════════
-   Types pour mon application
+   Types for my application
    ═══════════════════════════════════════════════════════════ */
 
 export type Client = {
   _id: string;
   _creationTime: number;
-  nom: string;
+  name: string;
   email?: string;
-  telephone?: string;
-  adresse?: string;
-  statut: "actif" | "inactif" | "prospect";
-  remise?: number;
+  phone?: string;
+  address?: string;
+  status: "active" | "inactive" | "prospect";
+  discount?: number;
   tags?: string[];
   storeId: string;
   createdAt: number;
   deletedAt?: number;
 };
 
-export type Produit = {
+export type Product = {
   _id: string;
   _creationTime: number;
-  nom: string;
+  name: string;
   description?: string;
-  prix: number;
-  prixAchat?: number;
-  quantite: number;
-  stockMin?: number;
-  categorie: "electronique" | "vetement" | "alimentaire" | "autre";
+  price: number;
+  costPrice?: number;
+  quantity: number;
+  minStock?: number;
+  category: "electronics" | "clothing" | "food" | "other";
   image?: string;
   storeId: string;
   createdAt: number;
 };
 
-export type Vente = {
+export type Sale = {
   _id: string;
   _creationTime: number;
-  numero: string;
+  number: string;
   clientId?: string;
-  lignes: string;  // JSON stringifié
+  lines: string;  // Stringified JSON
   total: number;
-  statut: "brouillon" | "validee" | "payee" | "annulee";
+  status: "draft" | "validated" | "paid" | "cancelled";
   storeId: string;
   createdAt: number;
 };
 
-// Utilitaires
+// Utilities
 export type NewDoc<T> = Omit<T, "_id" | "_creationTime">;
 export type UpdateDoc<T> = Partial<Omit<T, "_id" | "_creationTime">>;
 ```
 
 ---
 
-## Dépannage
+## Troubleshooting
 
-### Erreur: APPWRITE_API_KEY non configurée
+### Error: APPWRITE_API_KEY not configured
 
-Vérifiez que votre fichier `.env` existe et contient la clé API:
+Check that your `.env` file exists and contains the API key:
 ```bash
 cat .env | grep APPWRITE_API_KEY
 ```
 
-### Erreur: Collection non trouvée dans types.ts
+### Error: Collection not found in types.ts
 
-Assurez-vous que le nom du type correspond à un nom reconnu par AKIS:
+Make sure the type name corresponds to a name recognized by AKIS:
 - `Client` → `clients`
-- `Produit` → `produits`
-- `Vente` → `ventes`
+- `Product` → `products`
+- `Sale` → `sales`
 
-### Les attributs ne sont pas créés
+### Attributes are not created
 
-Appwrite a une limite de taille pour les attributs. Vérifiez:
-- Taille des strings (max 16000 caractères)
-- Nombre d'attributs par collection (max ~100)
+Appwrite has size limits for attributes. Check:
+- String size (max 16000 characters)
+- Number of attributes per collection (max ~100)
 
 ---
 
@@ -443,7 +443,7 @@ MIT
 
 ---
 
-## Liens
+## Links
 
 - [Appwrite Documentation](https://appwrite.io/docs)
 - [npm Package](https://www.npmjs.com/package/@akis05/akis)