@strato-admin/faker-ecommerce 0.1.1 → 0.3.0

package/dist/strato-faker-ecommerce/src/generate.js

@@ -0,0 +1,148 @@
+import { faker } from '@faker-js/faker';
+export const generateEcommerceData = () => {
+    faker.seed(123);
+    // Constants
+    const CATEGORIES = [
+        'animals',
+        'beard',
+        'business',
+        'cars',
+        'city',
+        'flowers',
+        'food',
+        'nature',
+        'sports',
+        'tech',
+        'travel',
+        'water',
+    ];
+    // 1. Generate Categories
+    const categories = CATEGORIES.map((name, id) => ({
+        id,
+        name,
+    }));
+    // 2. Generate Customers
+    const customers = Array.from({ length: 100 }, (_, id) => {
+        const first_name = faker.person.firstName();
+        const last_name = faker.person.lastName();
+        const email = faker.internet.email({ firstName: first_name, lastName: last_name });
+        const birthday = faker.date.birthdate({ min: 18, max: 80, mode: 'age' });
+        const first_seen = faker.date.past({ years: 2 });
+        const last_seen = faker.date.between({ from: first_seen, to: new Date() });
+        const has_ordered = faker.datatype.boolean({ probability: 0.8 });
+        const has_newsletter = faker.datatype.boolean({ probability: 0.3 });
+        const groups = faker.helpers.arrayElements(['collector', 'ordered_once', 'regular', 'reviewer'], { min: 0, max: 2 });
+        return {
+            id,
+            first_name,
+            last_name,
+            email,
+            address: faker.location.streetAddress(),
+            city: faker.location.city(),
+            zipcode: faker.location.zipCode(),
+            avatar: faker.image.avatar(),
+            birthday,
+            first_seen,
+            last_seen,
+            has_ordered,
+            has_newsletter,
+            groups,
+            nb_commands: 0,
+            total_spent: 0,
+        };
+    });
+    // 3. Generate Products
+    const products = Array.from({ length: 50 }, (_, id) => {
+        const category = faker.helpers.arrayElement(categories);
+        const width = faker.number.float({ min: 10, max: 100, fractionDigits: 2 });
+        const height = faker.number.float({ min: 10, max: 100, fractionDigits: 2 });
+        return {
+            id,
+            category_id: category.id,
+            reference: faker.commerce.isbn(),
+            name: faker.commerce.productName(),
+            width,
+            height,
+            price: faker.number.float({ min: 1, max: 500, fractionDigits: 2 }),
+            thumbnail: faker.image.urlLoremFlickr({ category: category.name, width: 120, height: 120 }),
+            image: faker.image.urlLoremFlickr({ category: category.name, width: 800, height: 600 }),
+            description: faker.commerce.productDescription(),
+            stock: faker.number.int({ min: 0, max: 250 }),
+            sales: 0,
+            rating: faker.number.float({ min: 1, max: 5, fractionDigits: 1 }),
+        };
+    });
+    // 4. Generate Reviews
+    const reviews = Array.from({ length: 200 }, (_, id) => {
+        const customer = faker.helpers.arrayElement(customers);
+        const product = faker.helpers.arrayElement(products);
+        const date = faker.date.past({ years: 1 });
+        const status = faker.helpers.arrayElement(['accepted', 'pending', 'rejected']);
+        return {
+            id,
+            date,
+            status: status,
+            customer_id: customer.id,
+            product_id: product.id,
+            rating: faker.number.int({ min: 1, max: 5 }),
+            comment: faker.lorem.paragraph(),
+        };
+    });
+    // 5. Generate Orders
+    const orders = Array.from({ length: 300 }, (_, id) => {
+        const customer = faker.helpers.arrayElement(customers.filter(c => c.has_ordered));
+        const date = faker.date.between({ from: customer.first_seen, to: customer.last_seen });
+        const nbItems = faker.number.int({ min: 1, max: 5 });
+        const basket = Array.from({ length: nbItems }, (_, itemId) => {
+            const product = faker.helpers.arrayElement(products);
+            return {
+                id: id * 10 + itemId,
+                order_id: id,
+                product_id: product.id,
+                quantity: faker.number.int({ min: 1, max: 10 }),
+                unit_price: product.price,
+            };
+        });
+        const total_ex_taxes = basket.reduce((sum, item) => sum + item.quantity * item.unit_price, 0);
+        const delivery_fees = faker.number.float({ min: 0, max: 20, fractionDigits: 2 });
+        const tax_rate = 0.2;
+        const taxes = (total_ex_taxes + delivery_fees) * tax_rate;
+        const total = total_ex_taxes + delivery_fees + taxes;
+        const status = faker.helpers.arrayElement(['ordered', 'delivered', 'cancelled', 'unknown']);
+        const returned = status === 'delivered' && faker.datatype.boolean({ probability: 0.1 });
+        // Update customer stats
+        customer.nb_commands++;
+        customer.total_spent += total;
+        if (!customer.latest_purchase || date > customer.latest_purchase) {
+            customer.latest_purchase = date;
+        }
+        // Update product stats
+        basket.forEach(item => {
+            const product = products.find(p => p.id === item.product_id);
+            if (product) {
+                product.sales += item.quantity;
+            }
+        });
+        return {
+            id,
+            reference: faker.string.alphanumeric({ length: 6, casing: 'upper' }),
+            date,
+            customer_id: customer.id,
+            basket,
+            total_ex_taxes,
+            delivery_fees,
+            tax_rate,
+            taxes,
+            total,
+            status,
+            returned,
+        };
+    });
+    return {
+        categories,
+        customers,
+        products,
+        reviews,
+        orders,
+    };
+};

package/dist/strato-faker-ecommerce/src/index.d.ts

@@ -0,0 +1,3 @@
+export * from './types';
+export { generateEcommerceData } from './generate';
+export { dataProvider } from './dataProvider';

package/dist/strato-faker-ecommerce/src/index.js

@@ -0,0 +1,3 @@
+export * from './types';
+export { generateEcommerceData } from './generate';
+export { dataProvider } from './dataProvider';

package/dist/strato-faker-ecommerce/src/types.d.ts

@@ -0,0 +1,69 @@
+export interface Customer {
+    id: number;
+    first_name: string;
+    last_name: string;
+    email: string;
+    address: string;
+    city: string;
+    zipcode: string;
+    avatar: string;
+    birthday: Date;
+    first_seen: Date;
+    last_seen: Date;
+    has_ordered: boolean;
+    latest_purchase?: Date;
+    has_newsletter: boolean;
+    groups: string[];
+    nb_commands: number;
+    total_spent: number;
+}
+export interface Category {
+    id: number;
+    name: string;
+}
+export interface Product {
+    id: number;
+    category_id: number;
+    reference: string;
+    name: string;
+    width: number;
+    height: number;
+    price: number;
+    thumbnail: string;
+    image: string;
+    description: string;
+    stock: number;
+    sales: number;
+    rating: number;
+}
+export interface OrderItem {
+    id: number;
+    order_id: number;
+    product_id: number;
+    quantity: number;
+    unit_price: number;
+}
+export type OrderStatus = 'ordered' | 'delivered' | 'cancelled' | 'unknown';
+export interface Order {
+    id: number;
+    reference: string;
+    date: Date;
+    customer_id: number;
+    basket: OrderItem[];
+    total_ex_taxes: number;
+    delivery_fees: number;
+    tax_rate: number;
+    taxes: number;
+    total: number;
+    status: OrderStatus;
+    returned: boolean;
+}
+export interface Review {
+    id: number;
+    date: Date;
+    status: 'accepted' | 'pending' | 'rejected';
+    customer_id: number;
+    product_id: number;
+    rating: number;
+    comment: string;
+}

package/dist/strato-faker-ecommerce/src/types.js

@@ -0,0 +1 @@
+export {};

package/dist/types.d.ts

@@ -49,7 +49,7 @@ export interface Order {
     reference: string;
     date: Date;
     customer_id: number;
-    basket: OrderItem[];
+    items: OrderItem[];
     total_ex_taxes: number;
     delivery_fees: number;
     tax_rate: number;

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@strato-admin/faker-ecommerce",
-  "version": "0.1.1",
+  "version": "0.3.0",
   "description": "Strato Admin Faker Ecommerce - Mock data for E-commerce domain using faker",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
-      "default": "dist/index.js"
+      "development": "./src/index.ts",
+      "default": "./dist/index.js"
     }
   },
   "files": [
@@ -38,13 +39,13 @@
     "ra-data-fakerest": "^5.14.3"
   },
   "peerDependencies": {
-    "@strato-admin/ra-core": "0.1.1"
+    "@strato-admin/ra-core": "0.3.0"
   },
   "devDependencies": {
     "@types/node": "^22.13.10",
     "typescript": "^5.1.3",
     "vitest": "^4.0.18",
-    "@strato-admin/ra-core": "0.1.1"
+    "@strato-admin/ra-core": "0.3.0"
   },
   "scripts": {
     "build": "tsc -p tsconfig.build.json",

package/src/dataProvider.ts

@@ -5,7 +5,7 @@ import { generateEcommerceData } from './generate';
 const data = generateEcommerceData();
 
 export const dataProvider: DataProvider = fakeRestDataProvider(
-    data,
-    true, // logging
-    500 // simulate network delay
+  data,
+  true, // logging
+  500, // simulate network delay
 );

package/src/generate.test.ts

@@ -4,13 +4,13 @@ import { generateEcommerceData } from './generate';
 describe('generateEcommerceData', () => {
   it('should generate ecommerce data with correct structure', () => {
     const data = generateEcommerceData();
-    
+
     expect(data).toHaveProperty('categories');
     expect(data).toHaveProperty('customers');
     expect(data).toHaveProperty('products');
     expect(data).toHaveProperty('reviews');
     expect(data).toHaveProperty('orders');
-    
+
     expect(data.categories.length).toBeGreaterThan(0);
     expect(data.customers.length).toBe(100);
     expect(data.products.length).toBe(50);
@@ -18,7 +18,7 @@ describe('generateEcommerceData', () => {
     expect(data.orders.length).toBe(300);
 
     // Check if products have a name
-    data.products.forEach(product => {
+    data.products.forEach((product) => {
       expect(product.name).toBeDefined();
       expect(typeof product.name).toBe('string');
     });
@@ -26,19 +26,19 @@ describe('generateEcommerceData', () => {
 
   it('should have valid relationships', () => {
     const data = generateEcommerceData();
-    
+
     // Check orders reference existing customers
-    data.orders.forEach(order => {
-        const customer = data.customers.find(c => c.id === order.customer_id);
-        expect(customer).toBeDefined();
+    data.orders.forEach((order) => {
+      const customer = data.customers.find((c) => c.id === order.customer_id);
+      expect(customer).toBeDefined();
     });
 
     // Check reviews reference existing products and customers
-    data.reviews.forEach(review => {
-        const product = data.products.find(p => p.id === review.product_id);
-        const customer = data.customers.find(c => c.id === review.customer_id);
-        expect(product).toBeDefined();
-        expect(customer).toBeDefined();
+    data.reviews.forEach((review) => {
+      const product = data.products.find((p) => p.id === review.product_id);
+      const customer = data.customers.find((c) => c.id === review.customer_id);
+      expect(product).toBeDefined();
+      expect(customer).toBeDefined();
     });
   });
 });

package/src/generate.ts

@@ -35,7 +35,10 @@ export const generateEcommerceData = () => {
     const last_seen = faker.date.between({ from: first_seen, to: new Date() });
     const has_ordered = faker.datatype.boolean({ probability: 0.8 });
     const has_newsletter = faker.datatype.boolean({ probability: 0.3 });
-    const groups = faker.helpers.arrayElements(['collector', 'ordered_once', 'regular', 'reviewer'], { min: 0, max: 2 });
+    const groups = faker.helpers.arrayElements(['collector', 'ordered_once', 'regular', 'reviewer'], {
+      min: 0,
+      max: 2,
+    });
 
     return {
       id,
@@ -62,7 +65,7 @@ export const generateEcommerceData = () => {
     const category = faker.helpers.arrayElement(categories);
     const width = faker.number.float({ min: 10, max: 100, fractionDigits: 2 });
     const height = faker.number.float({ min: 10, max: 100, fractionDigits: 2 });
-    
+
     return {
       id,
       category_id: category.id,
@@ -99,23 +102,26 @@ export const generateEcommerceData = () => {
   });
 
   // 5. Generate Orders
+  const allOrderItems: OrderItem[] = [];
   const orders: Order[] = Array.from({ length: 300 }, (_, id) => {
-    const customer = faker.helpers.arrayElement(customers.filter(c => c.has_ordered));
+    const customer = faker.helpers.arrayElement(customers.filter((c) => c.has_ordered));
     const date = faker.date.between({ from: customer.first_seen, to: customer.last_seen });
     const nbItems = faker.number.int({ min: 1, max: 5 });
-    
-    const basket: OrderItem[] = Array.from({ length: nbItems }, (_, itemId) => {
+
+    const items: OrderItem[] = Array.from({ length: nbItems }, (_, itemId) => {
       const product = faker.helpers.arrayElement(products);
-      return {
+      const item = {
         id: id * 10 + itemId,
         order_id: id,
         product_id: product.id,
         quantity: faker.number.int({ min: 1, max: 10 }),
         unit_price: product.price,
       };
+      allOrderItems.push(item);
+      return item;
     });
 
-    const total_ex_taxes = basket.reduce((sum, item) => sum + item.quantity * item.unit_price, 0);
+    const total_ex_taxes = items.reduce((sum, item) => sum + item.quantity * item.unit_price, 0);
     const delivery_fees = faker.number.float({ min: 0, max: 20, fractionDigits: 2 });
     const tax_rate = 0.2;
     const taxes = (total_ex_taxes + delivery_fees) * tax_rate;
@@ -127,15 +133,15 @@ export const generateEcommerceData = () => {
     customer.nb_commands++;
     customer.total_spent += total;
     if (!customer.latest_purchase || date > customer.latest_purchase) {
-        customer.latest_purchase = date;
+      customer.latest_purchase = date;
     }
 
     // Update product stats
-    basket.forEach(item => {
-        const product = products.find(p => p.id === item.product_id);
-        if (product) {
-            product.sales += item.quantity;
-        }
+    items.forEach((item) => {
+      const product = products.find((p) => p.id === item.product_id);
+      if (product) {
+        product.sales += item.quantity;
+      }
     });
 
     return {
@@ -143,7 +149,7 @@ export const generateEcommerceData = () => {
       reference: faker.string.alphanumeric({ length: 6, casing: 'upper' }),
       date,
       customer_id: customer.id,
-      basket,
+      items,
       total_ex_taxes,
       delivery_fees,
       tax_rate,
@@ -160,5 +166,6 @@ export const generateEcommerceData = () => {
     products,
     reviews,
     orders,
+    'order-items': allOrderItems,
   };
 };

package/src/types.ts

@@ -54,7 +54,7 @@ export interface Order {
   reference: string;
   date: Date;
   customer_id: number;
-  basket: OrderItem[];
+  items: OrderItem[];
   total_ex_taxes: number;
   delivery_fees: number;
   tax_rate: number;