shutro-erp 0.3.3 → 0.3.5

package/dist/contacts/demo.js

@@ -9,8 +9,17 @@ const COMPANIES = [
         isVendor: true,
         email: 'orders@bengalsteel.example',
         phone: '+880 31 710000',
+        latitude: '22.3569',
+        longitude: '91.7832',
+    },
+    {
+        name: 'Acme Trading',
+        city: 'Dhaka',
+        isCustomer: true,
+        email: 'hello@acme.example',
+        latitude: '23.8103',
+        longitude: '90.4125',
     },
-    { name: 'Acme Trading', city: 'Dhaka', isCustomer: true, email: 'hello@acme.example' },
     { name: 'Padma Cement', city: 'Narayanganj', isVendor: true, email: 'sales@padmacement.example' },
     { name: 'Meghna Electronics', city: 'Dhaka', isCustomer: true, isVendor: true },
     { name: 'Sylhet Tea Estates', city: 'Sylhet', isCustomer: true },
@@ -29,6 +38,26 @@ export async function contactsDemo(context) {
         const partners = env.model('res.partner');
         const companies = await partners.create(COMPANIES.map((c) => ({ ...c, isCompany: true, country: 'BD' })));
         const byName = new Map(COMPANIES.map((c, i) => [c.name, companies.ids[i]]));
+        // Tags (RFC 0022 step 2): key accounts and the partners we both buy from and sell to.
+        const tags = await env
+            .model('res.partner.tag')
+            .create([{ name: 'Key account' }, { name: 'Both ways' }, { name: 'Prospect' }]);
+        const [keyAccount, bothWays] = tags.ids;
+        for (const c of COMPANIES) {
+            const id = byName.get(c.name);
+            if (id === undefined)
+                continue;
+            const wanted = [
+                ...(c.isCustomer === true &&
+                    c.isVendor === true &&
+                    bothWays !== undefined
+                    ? [bothWays]
+                    : []),
+                ...(c.name === 'Bengal Steel Ltd' && keyAccount !== undefined ? [keyAccount] : []),
+            ];
+            if (wanted.length > 0)
+                await partners.browse([id]).write({ tags: { set: wanted } });
+        }
         await partners.create(PEOPLE.map(({ company, ...p }) => ({
             ...p,
             parent: orm.asId(byName.get(company), 'res.partner'),

package/dist/contacts/index.d.ts

@@ -5,5 +5,5 @@
  */
 import { defineModule } from '../modules-sdk/index.js';
 export { contactsDemo, DINA } from './demo.js';
-export { contactsShutro, ResPartner } from './module.js';
+export { contactsShutro, ResPartner, ResPartnerTag } from './module.js';
 export declare const contacts: ReturnType<typeof defineModule>;

package/dist/contacts/index.js

@@ -4,17 +4,42 @@
  * Purchase and Accounting deal with.
  */
 import { defineModule } from '../modules-sdk/index.js';
+import { reporting } from '../reporting/index.js';
 import { base } from '../server/index.js';
-import { action, form, hierarchy, list, search } from '../views/index.js';
+import { storage } from '../storage/index.js';
+import { action, form, hierarchy, kanban, list, map, search } from '../views/index.js';
 import { contactsDemo } from './demo.js';
-import { contactsShutro, ResPartner } from './module.js';
+import { contactsShutro, ResPartner, ResPartnerTag } from './module.js';
 export { contactsDemo, DINA } from './demo.js';
-export { contactsShutro, ResPartner } from './module.js';
+export { contactsShutro, ResPartner, ResPartnerTag } from './module.js';
 export const contacts = defineModule({
     shutro: contactsShutro,
     kosh: '^0.1.0',
     hooks: { demo: contactsDemo },
-    depends: [base],
+    // What a new contact needs (RFC 0020), per company.
+    settings: {
+        sections: [
+            {
+                key: 'contacts',
+                label: 'New contacts',
+                description: 'What a contact needs before it is saved, in this company.',
+                keywords: 'tax id BIN TIN GSTIN required duplicate email unique',
+                scope: 'company',
+                editors: ['contacts.manager'],
+                fields: [
+                    {
+                        key: 'contactTaxIdRequired',
+                        help: 'A customer cannot be saved without a tax ID (BIN, TIN, GSTIN…).',
+                    },
+                    {
+                        key: 'contactUniqueEmail',
+                        help: 'Two contacts cannot share an email address.',
+                    },
+                ],
+            },
+        ],
+    },
+    depends: [base, storage, reporting],
     app: {
         code: 'contacts',
         label: 'Contacts',
@@ -51,8 +76,70 @@ export const contacts = defineModule({
     actions: {
         'contacts.action_partners': action(ResPartner, {
             label: 'Contacts',
-            views: ['list', 'hierarchy', 'form'],
+            views: ['list', 'kanban', 'map', 'hierarchy', 'form'],
         }),
+        'contacts.action_tags': action(ResPartnerTag, { label: 'Tags', views: ['list', 'form'] }),
+    },
+    // The Overview (RFC 0022 step 2): how many, who buys and who sells, where they are, the month's new ones.
+    overview: {
+        cards: [
+            {
+                id: 'contacts_all',
+                title: 'Contacts',
+                kind: 'kpi',
+                model: 'res.partner',
+                measure: 'count',
+                w: 3,
+            },
+            {
+                id: 'customers',
+                title: 'Customers',
+                kind: 'kpi',
+                model: 'res.partner',
+                measure: 'count',
+                filter: { isCustomer: true },
+                w: 3,
+            },
+            {
+                id: 'vendors',
+                title: 'Vendors',
+                kind: 'kpi',
+                model: 'res.partner',
+                measure: 'count',
+                filter: { isVendor: true },
+                w: 3,
+            },
+            {
+                id: 'new_month',
+                title: 'New this month',
+                kind: 'kpi',
+                model: 'res.partner',
+                measure: 'count',
+                comparison: { field: 'createdAt', mode: 'previous' },
+                w: 3,
+            },
+            {
+                id: 'by_country',
+                title: 'By country',
+                kind: 'chart',
+                model: 'res.partner',
+                measure: 'count',
+                groupBy: 'country',
+                chart: 'pie',
+                w: 6,
+            },
+            {
+                id: 'by_city',
+                title: 'Companies by city',
+                kind: 'chart',
+                model: 'res.partner',
+                measure: 'count',
+                groupBy: 'city',
+                filter: { isCompany: true },
+                chart: 'bar',
+                w: 6,
+            },
+        ],
     },
     menus: [
         { id: 'contacts.root', label: 'Contacts', app: 'contacts' },
@@ -62,12 +149,52 @@ export const contacts = defineModule({
             label: 'Contacts',
             action: 'contacts.action_partners',
         },
+        {
+            id: 'contacts.tags',
+            parent: 'contacts.root',
+            label: 'Tags',
+            action: 'contacts.action_tags',
+            sequence: 9,
+            visibleTo: ['contacts.manager'],
+        },
     ],
     views: {
         'res.partner.list': list(ResPartner, {
-            columns: ['name', 'email', 'phone', 'city', 'country', 'isCustomer', 'isVendor'],
+            columns: [
+                { field: 'image', widget: 'avatar' },
+                'name',
+                { field: 'email', widget: 'email' },
+                { field: 'phone', widget: 'phone' },
+                'city',
+                'country',
+                { field: 'tags', widget: 'tags' },
+                'isCustomer',
+                'isVendor',
+            ],
             defaultOrder: ['name asc'],
         }),
+        'res.partner.kanban': kanban(ResPartner, {
+            groupBy: 'city',
+            card: {
+                title: 'name',
+                subtitle: 'parent',
+                avatar: 'image',
+                footer: [
+                    { field: 'email', widget: 'email' },
+                    { field: 'tags', widget: 'tags' },
+                ],
+            },
+        }),
+        'res.partner.map': map(ResPartner, {
+            latitude: 'latitude',
+            longitude: 'longitude',
+            title: 'name',
+            subtitle: 'city',
+        }),
+        'res.partner.tag.list': list(ResPartnerTag, { columns: ['name'], inlineEdit: ['name'] }),
+        'res.partner.tag.form': form(ResPartnerTag, (k) => ({
+            sheet: [k.group('main', ['name'])],
+        })),
         'res.partner.hierarchy': hierarchy(ResPartner, {
             parent: 'parent',
             title: 'name',
@@ -75,11 +202,29 @@ export const contacts = defineModule({
         }),
         'res.partner.form': form(ResPartner, (k) => ({
             sheet: [
-                k.group('identity', ['name', 'isCompany', 'parent', 'taxId']),
-                k.group('reach', ['email', 'phone', 'mobile', 'website']),
+                // What relates to this contact: Sales, Purchase and Accounting append their tiles (RFC 0022 §3.1).
+                k.stats('related', []),
+                k.group('identity', [
+                    { field: 'image', widget: 'image' },
+                    'name',
+                    'isCompany',
+                    'parent',
+                    'taxId',
+                    { field: 'tags', widget: 'tags' },
+                ]),
+                k.group('reach', [
+                    { field: 'email', widget: 'email' },
+                    { field: 'phone', widget: 'phone' },
+                    { field: 'mobile', widget: 'phone' },
+                    { field: 'website', widget: 'url' },
+                ]),
                 k.notebook('more', [
                     k.page('address', 'Address', [
                         k.group('where', ['street', 'city', 'zip', 'state', 'country']),
+                        k.group('position', ['latitude', 'longitude'], {
+                            label: 'On the map',
+                            description: 'Decimal degrees; the Map view shows contacts that have them.',
+                        }),
                     ]),
                     k.page('sales', 'Sales & purchase', [
                         k.group('roles', ['isCustomer', 'isVendor', 'currency']),
@@ -90,8 +235,9 @@ export const contacts = defineModule({
         })),
     },
     search: {
+        'res.partner.tag': search(ResPartnerTag, { fields: ['name'] }),
         'res.partner': search(ResPartner, {
-            fields: ['name', 'email', 'phone', 'city', 'taxId'],
+            fields: ['name', 'email', 'phone', 'city', 'taxId', 'tags.name'],
             filters: {
                 companies: { label: 'Companies', domain: { isCompany: true }, group: 'kind' },
                 people: { label: 'People', domain: { isCompany: false }, group: 'kind' },

package/dist/contacts/module.d.ts

@@ -1,3 +1,91 @@
+/** A tag on contacts (RFC 0022 step 2): shared by every company, kept by Contacts managers. */
+export declare const ResPartnerTag: import("../server/orm.js").Model<"res.partner.tag", {
+    readonly id: import("../server/orm.js").IdField<"res.partner.tag">;
+    readonly createdAt: import("../server/orm.js").ScalarField<'datetime', Date, Date, {
+        required: true;
+        readonly: true;
+        computed: false;
+        inverse: false;
+        hasDefault: false;
+        sequence: false;
+    }>;
+    readonly updatedAt: import("../server/orm.js").ScalarField<'datetime', Date, Date, {
+        required: true;
+        readonly: true;
+        computed: false;
+        inverse: false;
+        hasDefault: false;
+        sequence: false;
+    }>;
+    readonly createdBy: import("../server/orm.js").Many2oneField<'res.users', {
+        required: false;
+        readonly: true;
+        computed: false;
+        inverse: false;
+        hasDefault: false;
+        sequence: false;
+    }>;
+    readonly updatedBy: import("../server/orm.js").Many2oneField<'res.users', {
+        required: false;
+        readonly: true;
+        computed: false;
+        inverse: false;
+        hasDefault: false;
+        sequence: false;
+    }>;
+    readonly displayName: import("../server/orm.js").CharField<{
+        required: true;
+        readonly: true;
+        computed: true;
+        inverse: false;
+        hasDefault: false;
+        sequence: false;
+    }>;
+    readonly name: import("../server/orm.js").CharField<{
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }, string>;
+}, {} & import("../server/orm.js").TransitionMethods<{
+    readonly name: import("../server/orm.js").CharField<{
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }, string>;
+}>>;
+/** The company's contact settings (RFC 0020): what a contact needs before it is saved. */
+export declare const CompanyContacts: import("../server/orm.js").Extension<"res.company", {
+    readonly contactTaxIdRequired: import("../server/orm.js").ScalarField<"boolean", boolean, boolean, {
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: true;
+        readonly readonly: false;
+    }>;
+    readonly contactUniqueEmail: import("../server/orm.js").ScalarField<"boolean", boolean, boolean, {
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: true;
+        readonly readonly: false;
+    }>;
+}, Record<never, never>>;
 export declare const ResPartner: import("../server/orm.js").Model<"res.partner", {
     readonly id: import("../server/orm.js").IdField<"res.partner">;
     readonly createdAt: import("../server/orm.js").ScalarField<'datetime', Date, Date, {
@@ -52,6 +140,46 @@ export declare const ResPartner: import("../server/orm.js").Model<"res.partner",
         readonly hasDefault: false;
         readonly readonly: false;
     }, string>;
+    readonly image: import("../server/orm.js").Many2oneField<"storage.attachment", {
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }>;
+    readonly tags: import("../server/orm.js").Many2manyField<"res.partner.tag", {
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: true;
+        readonly readonly: false;
+    }>;
+    readonly latitude: import("../server/orm.js").DecimalField<{
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }>;
+    readonly longitude: import("../server/orm.js").DecimalField<{
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }>;
     readonly isCompany: import("../server/orm.js").ScalarField<"boolean", boolean, boolean, {
         readonly required: true;
         readonly computed: false;
@@ -233,6 +361,48 @@ export declare const ResPartner: import("../server/orm.js").Model<"res.partner",
         readonly hasDefault: false;
         readonly readonly: false;
     }, string>;
+    /** A photo or logo: an attachment of the contact (RFC 0022 §3.3), with its 256 px thumbnail. */
+    readonly image: import("../server/orm.js").Many2oneField<"storage.attachment", {
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }>;
+    readonly tags: import("../server/orm.js").Many2manyField<"res.partner.tag", {
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: true;
+        readonly readonly: false;
+    }>;
+    /** Where the contact is on a map (decimal degrees); filled by hand for now. */
+    readonly latitude: import("../server/orm.js").DecimalField<{
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }>;
+    readonly longitude: import("../server/orm.js").DecimalField<{
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }>;
     readonly isCompany: import("../server/orm.js").ScalarField<"boolean", boolean, boolean, {
         readonly required: true;
         readonly computed: false;
@@ -409,7 +579,70 @@ export declare const ResPartner: import("../server/orm.js").Model<"res.partner",
         readonly readonly: false;
     }>;
 }>>;
-export declare const contactsShutro: import("../server/orm.js").Module<readonly [import("../server/orm.js").Model<"res.partner", {
+export declare const contactsShutro: import("../server/orm.js").Module<readonly [import("../server/orm.js").Model<"res.partner.tag", {
+    readonly id: import("../server/orm.js").IdField<"res.partner.tag">;
+    readonly createdAt: import("../server/orm.js").ScalarField<'datetime', Date, Date, {
+        required: true;
+        readonly: true;
+        computed: false;
+        inverse: false;
+        hasDefault: false;
+        sequence: false;
+    }>;
+    readonly updatedAt: import("../server/orm.js").ScalarField<'datetime', Date, Date, {
+        required: true;
+        readonly: true;
+        computed: false;
+        inverse: false;
+        hasDefault: false;
+        sequence: false;
+    }>;
+    readonly createdBy: import("../server/orm.js").Many2oneField<'res.users', {
+        required: false;
+        readonly: true;
+        computed: false;
+        inverse: false;
+        hasDefault: false;
+        sequence: false;
+    }>;
+    readonly updatedBy: import("../server/orm.js").Many2oneField<'res.users', {
+        required: false;
+        readonly: true;
+        computed: false;
+        inverse: false;
+        hasDefault: false;
+        sequence: false;
+    }>;
+    readonly displayName: import("../server/orm.js").CharField<{
+        required: true;
+        readonly: true;
+        computed: true;
+        inverse: false;
+        hasDefault: false;
+        sequence: false;
+    }>;
+    readonly name: import("../server/orm.js").CharField<{
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }, string>;
+}, {} & import("../server/orm.js").TransitionMethods<{
+    readonly name: import("../server/orm.js").CharField<{
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }, string>;
+}>>, import("../server/orm.js").Model<"res.partner", {
     readonly id: import("../server/orm.js").IdField<"res.partner">;
     readonly createdAt: import("../server/orm.js").ScalarField<'datetime', Date, Date, {
         required: true;
@@ -463,6 +696,46 @@ export declare const contactsShutro: import("../server/orm.js").Module<readonly
         readonly hasDefault: false;
         readonly readonly: false;
     }, string>;
+    readonly image: import("../server/orm.js").Many2oneField<"storage.attachment", {
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }>;
+    readonly tags: import("../server/orm.js").Many2manyField<"res.partner.tag", {
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: true;
+        readonly readonly: false;
+    }>;
+    readonly latitude: import("../server/orm.js").DecimalField<{
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }>;
+    readonly longitude: import("../server/orm.js").DecimalField<{
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }>;
     readonly isCompany: import("../server/orm.js").ScalarField<"boolean", boolean, boolean, {
         readonly required: true;
         readonly computed: false;
@@ -644,6 +917,48 @@ export declare const contactsShutro: import("../server/orm.js").Module<readonly
         readonly hasDefault: false;
         readonly readonly: false;
     }, string>;
+    /** A photo or logo: an attachment of the contact (RFC 0022 §3.3), with its 256 px thumbnail. */
+    readonly image: import("../server/orm.js").Many2oneField<"storage.attachment", {
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }>;
+    readonly tags: import("../server/orm.js").Many2manyField<"res.partner.tag", {
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: true;
+        readonly readonly: false;
+    }>;
+    /** Where the contact is on a map (decimal degrees); filled by hand for now. */
+    readonly latitude: import("../server/orm.js").DecimalField<{
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }>;
+    readonly longitude: import("../server/orm.js").DecimalField<{
+        readonly required: false;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: false;
+        readonly readonly: false;
+    }>;
     readonly isCompany: import("../server/orm.js").ScalarField<"boolean", boolean, boolean, {
         readonly required: true;
         readonly computed: false;
@@ -819,4 +1134,25 @@ export declare const contactsShutro: import("../server/orm.js").Module<readonly
         readonly hasDefault: false;
         readonly readonly: false;
     }>;
-}>>], readonly [import("../server/orm.js").Module<readonly import("../server/orm.js").AnyModel[], readonly import("../server/orm.js").ModuleBase[], readonly import("../server/orm.js").AnyExtension[]>], readonly []>;
+}>>], readonly [import("../server/orm.js").Module<readonly import("../server/orm.js").AnyModel[], readonly import("../server/orm.js").ModuleBase[], readonly import("../server/orm.js").AnyExtension[]>, import("../server/orm.js").Module<readonly import("../server/orm.js").AnyModel[], readonly import("../server/orm.js").ModuleBase[], readonly import("../server/orm.js").AnyExtension[]>], readonly [import("../server/orm.js").Extension<"res.company", {
+    readonly contactTaxIdRequired: import("../server/orm.js").ScalarField<"boolean", boolean, boolean, {
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: true;
+        readonly readonly: false;
+    }>;
+    readonly contactUniqueEmail: import("../server/orm.js").ScalarField<"boolean", boolean, boolean, {
+        readonly required: true;
+        readonly computed: false;
+        readonly inverse: false;
+        readonly sequence: false;
+        readonly computeName: undefined;
+        readonly store: true;
+        readonly hasDefault: true;
+        readonly readonly: false;
+    }>;
+}, Record<never, never>>]>;