18.0 - Technical Onboarding - AHSL

awesome_dashboard/__manifest__.py

@@ -24,7 +24,11 @@
     'assets': {
         'web.assets_backend': [
             'awesome_dashboard/static/src/**/*',
+            ('remove', 'awesome_dashboard/static/src/dashboard/**/*'),
         ],
+        'awesome_dashboard.dashboard': [
+            'awesome_dashboard/static/src/dashboard/**/*',
+        ]
     },
     'license': 'AGPL-3'
 }

awesome_dashboard/static/src/dashboard/dashboard.js

@@ -0,0 +1,98 @@
+/** @odoo-module **/
+
+import { Component, useState } from '@odoo/owl';
+import { registry } from '@web/core/registry';
+import { Layout } from '@web/search/layout';
+import { useService } from '@web/core/utils/hooks';
+import { DashboardItem } from './dashboard_item/dashboard_item';
+import { Dialog } from '@web/core/dialog/dialog';
+import { CheckBox } from '@web/core/checkbox/checkbox';
+import { browser } from '@web/core/browser/browser';
+
+class AwesomeDashboard extends Component {
+    static template = 'awesome_dashboard.AwesomeDashboard';
+    static components = { Layout, DashboardItem };
+
+    setup() {
+        this.showCustomers = this.showCustomers.bind(this);
+        this.showLeads = this.showLeads.bind(this);
+        this.action = useService('action');
+        this.stats = useState(useService('awesome_dashboard.statistics'));
+        this.items = registry.category('awesome_dashboard').getAll();
+        this.display = {
+            controlPanel: {},
+        };
+        this.dialog = useService('dialog');
+        this.state = useState({
+            disabledItems:
+                browser.localStorage
+                    .getItem('disabledDashboardItems')
+                    ?.split(',') || [],
+        });
+    }
+
+    openConfiguration() {
+        this.dialog.add(ConfigurationDialog, {
+            items: this.items,
+            disabledItems: this.state.disabledItems,
+            onUpdateConfiguration: this.updateConfiguration.bind(this),
+        });
+    }
+
+    updateConfiguration(newDisabledItems) {
+        this.state.disabledItems = newDisabledItems;
+    }
+
+    showCustomers() {
+        this.action.doAction('base.action_partner_form');
+    }
+
+    showLeads() {
+        this.action.doAction({
+            type: 'ir.actions.act_window',
+            name: 'Leads',
+            target: 'current',
+            res_model: 'crm.lead',
+            views: [
+                [false, 'list'],
+                [false, 'form'],
+            ],
+        });
+    }
+}
+
+class ConfigurationDialog extends Component {
+    static template = 'awesome_dashboard.ConfigurationDialog';
+    static components = { Dialog, CheckBox };
+    static props = ['close', 'items', 'disabledItems', 'onUpdateConfiguration'];
+
+    setup() {
+        this.items = useState(
+            this.props.items.map((item) => {
+                return {
+                    ...item,
+                    checked: !this.props.disabledItems.includes(item.id),
+                };
+            })
+        );
+    }
+
+    done() {
+        this.props.close();
+    }
+
+    onChange(checked, changedItem) {
+        changedItem.enabled = checked;
+        const newDisabledItems = Object.values(this.items)
+            .filter((item) => !item.enabled)
+            .map((item) => item.id);
+
+        browser.localStorage.setItem(
+            'disabledDashboardItems',
+            JSON.stringify(newDisabledItems)
+        );
+        this.props.onUpdateConfiguration(newDisabledItems);
+    }
+}
+
+registry.category('lazy_components').add('AwesomeDashboard', AwesomeDashboard);

awesome_dashboard/static/src/dashboard/dashboard.scss

@@ -0,0 +1,5 @@
+.o_dashboard {
+    background-color: gray;
+    font-weight: bold;
+    font-size: 1.5rem;
+}

awesome_dashboard/static/src/dashboard/dashboard.xml

@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<templates xml:space="preserve">
+    <t t-name="awesome_dashboard.AwesomeDashboard">
+        <Layout display="display" className="'o_dashboard h-100'">
+            <t t-set-slot="control-panel-create-button">
+                <button class="btn btn-primary" t-on-click="this.showCustomers">Customers</button>
+                <button class="btn btn-primary" t-on-click="this.showLeads">Leads</button>
+            </t>
+            <t t-set-slot="control-panel-additional-actions">
+                <button class="btn p-0 ms-1 border-0" t-on-click="openConfiguration">
+                    <i class="fa fa-cog"></i>
+                </button>
+            </t>
+            <div class="container d-flex flex-wrap" t-if="stats.isReady">
+                <t t-foreach="items" t-as="item" t-key="item.id">
+                    <DashboardItem size="item.size || 1" t-if="!state.disabledItems.includes(item.id)">
+                        <t t-set="itemProp" t-value="item.props ? item.props(stats) : { 'data': stats }" />
+                        <t t-component="item.Component" t-props="itemProp" />
+                    </DashboardItem>
+                </t>
+            </div>
+        </Layout>
+    </t>
+
+    <t t-name="awesome_dashboard.ConfigurationDialog">
+        <Dialog title="'Dashboard items configuration'">
+            Which cards do you wish to see?
+            <t t-foreach="items" t-as="item" t-key="item.id">
+                <CheckBox value="item.enabled" onChange="(ev) => this.onChange(ev, item)">
+                    <t t-esc="item.description" />
+                </CheckBox>
+            </t>
+            <t t-set-slot="footer">
+                <button class="btn btn-primary" t-on-click="done">
+                    Save
+                </button>
+            </t>
+        </Dialog>
+    </t>
+</templates>

awesome_dashboard/static/src/dashboard/dashboard_item/dashboard_item.js

@@ -0,0 +1,18 @@
+import { Component } from '@odoo/owl';
+
+export class DashboardItem extends Component {
+    static template = "awesome_dashboard.DashboardItem";
+    static props = {
+        size: {
+            type: Number,
+            optional: true,
+        },
+        slots: {
+            type: Object,
+            optional: true,
+        }
+    };
+    static defaultProps = {
+        size: 1,
+    }
+}

awesome_dashboard/static/src/dashboard/dashboard_item/dashboard_item.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<templates xml:space="preserve">
+    <t t-name="awesome_dashboard.DashboardItem">
+        <div
+            class="card border p-2 m-2"
+            t-att-style="'width: ' + props.size * 18 + 'rem;'"
+        >
+            <div class="card-header">
+                <t t-slot="title" />
+            </div>
+            <div class="card-body">
+                <t t-slot="default" />
+            </div>
+        </div>
+    </t>
+</templates>

awesome_dashboard/static/src/dashboard/dashboard_items.js

@@ -0,0 +1,65 @@
+import { NumberCard } from './number_card/number_card';
+import { PieChartCard } from './pie_chart_card/pie_chart_card';
+import { registry } from '@web/core/registry';
+
+const items = [
+    {
+        id: 'average_quantity',
+        description: 'Average amount of t-shirt by order this month',
+        Component: NumberCard,
+        props: (data) => ({
+            title: 'Average amount of t-shirt by order this month',
+            value: data.average_quantity,
+        }),
+    },
+    {
+        id: 'average_time',
+        description: 'Average time for an order',
+        Component: NumberCard,
+        props: (data) => ({
+            title: "Average time for an order to go from 'new' to 'sent' or 'cancelled'",
+            value: data.average_time,
+        }),
+    },
+    {
+        id: 'number_new_orders',
+        description: 'New orders this month',
+        Component: NumberCard,
+        props: (data) => ({
+            title: 'Number of new orders this month',
+            value: data.nb_new_orders,
+        }),
+    },
+    {
+        id: 'cancelled_orders',
+        description: 'Cancelled orders this month',
+        Component: NumberCard,
+        props: (data) => ({
+            title: 'Number of cancelled orders this month',
+            value: data.nb_cancelled_orders,
+        }),
+    },
+    {
+        id: 'amount_new_orders',
+        description: 'amount orders this month',
+        Component: NumberCard,
+        props: (data) => ({
+            title: 'Total amount of new orders this month',
+            value: data.total_amount,
+        }),
+    },
+    {
+        id: 'pie_chart',
+        description: 'Shirt orders by size',
+        Component: PieChartCard,
+        size: 2,
+        props: (data) => ({
+            title: 'Shirt orders by size',
+            values: data.orders_by_size,
+        }),
+    },
+];
+
+items.forEach((item) => {
+    registry.category('awesome_dashboard').add(item.id, item);
+});

awesome_dashboard/static/src/dashboard/dashboard_service.js

@@ -0,0 +1,27 @@
+import { registry } from '@web/core/registry';
+import { rpc } from '@web/core/network/rpc';
+import { reactive } from '@odoo/owl';
+
+const dashboardService = {
+    start() {
+        let stats = reactive({
+            isReady: false,
+        });
+
+        async function loadData() {
+            const result = await rpc('/awesome_dashboard/statistics');
+            Object.assign(stats, result, { isReady: true });
+            setTimeout(() => {
+                loadData();
+            }, 1000 * 10);
+        }
+
+        loadData();
+
+        return stats;
+    },
+};
+
+registry
+    .category('services')
+    .add('awesome_dashboard.statistics', dashboardService);

awesome_dashboard/static/src/dashboard/number_card/number_card.js

@@ -0,0 +1,13 @@
+import { Component } from '@odoo/owl';
+
+export class NumberCard extends Component {
+    static template = "awesome_dashboard.NumberCard";
+    static props = {
+        title: {
+            type: String,
+        },
+        value: {
+            type: Number,
+        }
+    }
+}

awesome_dashboard/static/src/dashboard/number_card/number_card.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<templates xml:space="preserve">
+    <t t-name="awesome_dashboard.NumberCard">
+        <t t-esc="props.title" />
+        <div class="fs-1 fw-bold text-success text-center">
+            <t t-esc="props.value" />
+        </div>
+    </t>
+</templates>

awesome_dashboard/static/src/dashboard/pie_chart_card/pie_chart_card.js

@@ -0,0 +1,15 @@
+import { Component } from '@odoo/owl';
+import { PieChart } from '../../pie_chart/pie_chart';
+
+export class PieChartCard extends Component {
+    static template = 'awesome_dashboard.PieChartCard';
+    static components = { PieChart };
+    static props = {
+        title: {
+            type: String,
+        },
+        values: {
+            type: Object,
+        },
+    };
+}

awesome_dashboard/static/src/dashboard/pie_chart_card/pie_chart_card.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<templates>
+    <t t-name="awesome_dashboard.PieChartCard">
+        <t t-esc="props.label" />
+        <PieChart data="props.values" label="props.title" />
+    </t>
+</templates>

awesome_dashboard/static/src/dashboard_action.js

@@ -0,0 +1,14 @@
+import { registry } from '@web/core/registry';
+import { LazyComponent } from '@web/core/assets';
+import { Component, xml } from '@odoo/owl';
+
+class AwesomeDashboardLoader extends Component {
+    static template = xml`
+        <LazyComponent bundle="'awesome_dashboard.dashboard'" Component="'AwesomeDashboard'" props="props"/>
+    `;
+    static components = { LazyComponent };
+}
+
+registry
+    .category('actions')
+    .add('awesome_dashboard.dashboard', AwesomeDashboardLoader);