TWIGZ Backend API Documentation

Overview

The Seeding API provides comprehensive database initialization and test data generation for development, testing, and demo environments. This system ensures consistent data setup across different environments with UAE-specific content. Location: convex/seed.ts

Seeding Process

Clear Existing Data

Optional: Clear all existing data for fresh start

Seed Core Data

Add cities, areas, banks, categories, and platform configuration

Seed Test Data

Add test customers, stores, products, and orders for development

Verify Setup

Check seeding status and data integrity

Quick Setup

For immediate development environment setup:

// Complete database setup in one call
const result = await convex.mutation(api.seed.seedAllData);
console.log('Database seeded:', result);

// Add test data for development
await convex.mutation(api.seed.seedTestCustomers);
await convex.mutation(api.seed.seedTestOrders);

// Quick development setup
const seedResult = await convex.mutation("seed.seedAllData");
console.log('Seeding complete:', seedResult);

# Create a seeding script for quick setup
cat > seed-dev.js << 'EOF'
import { ConvexHttpClient } from "convex/node";

const convex = new ConvexHttpClient(process.env.CONVEX_URL);

async function seedDevelopment() {
  console.log('🌱 Starting development database seeding...');
  
  // Seed core data
  const coreResult = await convex.mutation("seed.seedAllData");
  console.log('✅ Core data seeded:', coreResult);
  
  // Add test customers
  const customersResult = await convex.mutation("seed.seedTestCustomers");
  console.log('✅ Test customers added:', customersResult);
  
  // Add test orders
  const ordersResult = await convex.mutation("seed.seedTestOrders");
  console.log('✅ Test orders created:', ordersResult);
  
  console.log('🎉 Development environment ready!');
}

seedDevelopment().catch(console.error);
EOF

node seed-dev.js

Seed All Data

Seeds all essential data types in the correct dependency order.

const result = await convex.mutation(api.seed.seedAllData);

const result = await convex.mutation("seed.seedAllData");

{
  "success": true,
  "message": "All data seeded successfully",
  "results": {
    "cities": 7,
    "areas": 156,
    "banks": 15,
    "categories": 25,
    "platformConfig": "pc123456789"
  }
}

Get Seeding Status

Check the current seeding status of the database.

const status = await convex.query(api.seed.getSeedingStatus);

const status = await convex.query("seed.getSeedingStatus");

{
  "isSeeded": true,
  "counts": {
    "cities": 7,
    "areas": 156,
    "banks": 15,
    "categories": 25,
    "platformConfig": 1
  }
}

Individual Seeding Functions

Cities

Function: seedCities
Data: 7 major UAE cities with Arabic names

Areas

Function: seedAreas
Data: 150+ areas across all UAE cities

Banks

Function: seedBanks
Data: 15 major UAE banks with SWIFT codes

Test Data Generation

const customersResult = await convex.mutation(api.seed.seedTestCustomers);
// Creates 10 test customers with realistic profiles

const ordersResult = await convex.mutation(api.seed.seedTestOrders);
// Creates 50 test orders across different stores and customers

const bulkResult = await convex.mutation(api.seed.seedBulkOrders);
// Creates 500+ orders for performance testing

Development Workflow

Fresh Environment Setup

Setting up a completely fresh development environment:

// 1. Clear existing data (optional)
await convex.mutation(api.seed.clearAllData);

// 2. Seed core data
await convex.mutation(api.seed.seedAllData);

// 3. Add test data
await convex.mutation(api.seed.seedTestCustomers);
await convex.mutation(api.seed.seedTestOrders);

// 4. Verify setup
const status = await convex.query(api.seed.getSeedingStatus);
console.log('Environment ready:', status);

Incremental Updates

Adding specific data types:

// Add more areas to existing cities
await convex.mutation(api.seed.seedAreas);

// Update platform configuration
await convex.mutation(api.seed.seedPlatformConfig);

// Add more test customers
await convex.mutation(api.seed.seedTestCustomers);

Performance Testing

Generate large datasets for testing:

// Generate bulk test data
await convex.mutation(api.seed.seedBulkOrders);

// Check database performance
const analytics = await convex.query(api.shared.analytics.getProductCountsByGlobalCategory);

UAE-Specific Data

The seeding system includes comprehensive UAE market data:

UAE Cities

Cities: Dubai, Abu Dhabi, Sharjah, Ajman, Ras Al Khaimah, Fujairah, Umm Al Quwain
Languages: English and Arabic names

UAE Areas

Coverage: 150+ areas across all emirates
Types: Districts, neighborhoods, communities, sectors

UAE Banks

Banks: All major UAE banking institutions
Data: SWIFT codes, Arabic names, regulatory compliance

Local Categories

Categories: UAE market-specific business categories
Structure: Hierarchical organization for local businesses

Seeding functions are designed for development and testing environments. Use with caution in production and always backup data before clearing.

Use getSeedingStatus to check if your database is properly initialized before running your application in development.

Shared Functions

Store Management

Customer Experience

Admin & Platform

HTTP Endpoints

Scheduled Tasks

Database

Development

Seeding Overview

Overview

Seeding Process

Quick Setup

Seed All Data

Get Seeding Status

Individual Seeding Functions

Cities

Areas

Banks

Categories

Test Data Generation

Development Workflow

UAE-Specific Data

UAE Cities

UAE Areas

UAE Banks

Local Categories

​Overview

​Seeding Process

​Quick Setup

​Seed All Data

​Get Seeding Status

​Individual Seeding Functions

Cities

Areas

Banks

Categories

​Test Data Generation

​Development Workflow

​UAE-Specific Data

UAE Cities

UAE Areas

UAE Banks

Local Categories

Overview

Seeding Process

Quick Setup

Seed All Data

Get Seeding Status

Individual Seeding Functions

Test Data Generation

Development Workflow

UAE-Specific Data