@acorex-platform/module-location-management-client 0.0.32 → 0.0.33

package/fesm2022/acorex-platform-module-location-management-client-contracts-entities-geographic-region.mjs

@@ -0,0 +1,782 @@
+import { AXPWidgetsCatalog, AXPRegionalSetting } from '@acorex-platform/framework-shared/core';
+import { createAllQueryView, entityMasterCrudActions, entityMasterRecordActions } from '@acorex-platform/framework-shared/entity';
+
+const config = {
+    i18n: 'location-management',
+};
+const RootConfig = {
+    config,
+    module: {
+        name: 'LocationManagement',
+        title: '@location-management:module.title',
+        icon: 'fa-light fa-map-marker-alt',
+    },
+    entities: {
+        location: {
+            name: 'Location',
+            title: '@location-management:locations.entities.location.title',
+            titlePlural: '@location-management:locations.entities.location.plural',
+            icon: 'fa-light fa-map-marker-alt',
+        },
+        locationType: {
+            name: 'LocationType',
+            title: '@location-management:location-types.entities.location-type.title',
+            titlePlural: '@location-management:location-types.entities.location-type.plural',
+            icon: 'fa-light fa-tags',
+        },
+        locationRole: {
+            name: 'LocationRole',
+            title: '@location-management:location-roles.entities.location-role.title',
+            titlePlural: '@location-management:location-roles.entities.location-role.plural',
+            icon: 'fa-light fa-map-pin',
+        },
+        geographicRegion: {
+            name: 'GeographicRegion',
+            title: '@location-management:geographic-regions.entities.geographic-region.title',
+            titlePlural: '@location-management:geographic-regions.entities.geographic-region.plural',
+            icon: 'fa-light fa-globe',
+        },
+        locationAssignment: {
+            name: 'LocationAssignment',
+            title: `@${config.i18n}:location-assignments.entities.location-assignment.title`,
+            titlePlural: `@${config.i18n}:location-assignments.entities.location-assignment.plural`,
+            icon: 'fa-light fa-building-user',
+        },
+    },
+};
+
+async function geographicRegionFactory() {
+    const entityDef = {
+        module: RootConfig.module.name,
+        name: RootConfig.entities.geographicRegion.name,
+        parentKey: 'parentId',
+        title: RootConfig.entities.geographicRegion.title,
+        icon: RootConfig.entities.geographicRegion.icon,
+        formats: {
+            individual: RootConfig.entities.geographicRegion.title,
+            plural: RootConfig.entities.geographicRegion.titlePlural,
+            searchResult: {
+                title: '{{ title }}',
+                description: '{{ context.eval("type") + (context.eval("parentId") ? " (Child)" : "") }}',
+            },
+        },
+        plugins: [{ name: 'archive' }],
+        groups: [
+            {
+                id: 'basic-info',
+                title: '@general:terms.interface.basic-info',
+            },
+            {
+                id: 'geographic-data',
+                title: '@general:terms.interface.geographic-details',
+            },
+            {
+                id: 'additional-info',
+                title: '@general:terms.interface.additional-info',
+            },
+            {
+                id: 'settings',
+                title: '@general:terms.interface.settings',
+            },
+        ],
+        properties: [
+            {
+                name: 'title',
+                title: '@general:terms.common.title',
+                groupId: 'basic-info',
+                options: {
+                    sort: {
+                        enabled: true,
+                    },
+                    filter: {
+                        advance: {
+                            enabled: true,
+                        },
+                        inline: {
+                            enabled: true,
+                        },
+                    },
+                },
+                schema: {
+                    dataType: 'string',
+                    interface: {
+                        type: AXPWidgetsCatalog.text,
+                        options: {
+                            multiLanguage: true,
+                            placeholder: 'Enter region title',
+                        },
+                    },
+                },
+                validations: [
+                    {
+                        rule: 'required',
+                    },
+                ],
+            },
+            {
+                name: 'code',
+                title: '@general:terms.common.code',
+                groupId: 'basic-info',
+                options: {
+                    sort: {
+                        enabled: true,
+                    },
+                    filter: {
+                        advance: {
+                            enabled: true,
+                        },
+                        inline: {
+                            enabled: true,
+                        },
+                    },
+                },
+                schema: {
+                    dataType: 'string',
+                    interface: {
+                        type: AXPWidgetsCatalog.text,
+                        options: {
+                            placeholder: 'Region code (e.g., CA, US)',
+                        },
+                    },
+                },
+            },
+            {
+                name: 'type',
+                title: '@location-management:geographic-regions.entities.geographic-region.fields.type',
+                groupId: 'basic-info',
+                options: {
+                    sort: {
+                        enabled: true,
+                    },
+                    filter: {
+                        advance: {
+                            enabled: true,
+                        },
+                        inline: {
+                            enabled: true,
+                        },
+                    },
+                },
+                schema: {
+                    dataType: 'string',
+                    interface: {
+                        type: AXPWidgetsCatalog.select,
+                        options: {
+                            valueField: 'code',
+                            textField: 'title',
+                            dataSource: [
+                                { code: 'country', title: 'Country' },
+                                { code: 'state', title: 'State/Province' },
+                                { code: 'city', title: 'City' },
+                                { code: 'district', title: 'District' },
+                                { code: 'subdistrict', title: 'Subdistrict' },
+                                { code: 'territory', title: 'Territory' },
+                            ],
+                        },
+                    },
+                },
+                validations: [
+                    {
+                        rule: 'required',
+                    },
+                ],
+            },
+            {
+                name: 'parentId',
+                title: '@location-management:geographic-regions.entities.geographic-region.fields.parent-region',
+                groupId: 'basic-info',
+                options: {
+                    filter: {
+                        advance: {
+                            enabled: true,
+                        },
+                        inline: {
+                            enabled: true,
+                        },
+                    },
+                },
+                schema: {
+                    dataType: 'object',
+                    interface: {
+                        type: AXPWidgetsCatalog.lookup,
+                        options: {
+                            entity: `${RootConfig.module.name}.${RootConfig.entities.geographicRegion.name}`,
+                            expose: [
+                                { source: 'id', target: 'parentRegion.id' },
+                                { source: 'name', target: 'parentRegion.name' },
+                                { source: 'type', target: 'parentRegion.type' },
+                            ],
+                        },
+                    },
+                },
+            },
+            {
+                name: 'coordinates',
+                title: '@location-management:geographic-regions.entities.geographic-region.fields.coordinates',
+                groupId: 'geographic-data',
+                options: {
+                    filter: {
+                        advance: {
+                            enabled: false,
+                        },
+                    },
+                },
+                schema: {
+                    dataType: 'string',
+                    interface: {
+                        type: AXPWidgetsCatalog.map,
+                        options: {
+                            hasDraw: true,
+                            maxPolygon: 0,
+                            fitToDraw: true,
+                        },
+                    },
+                },
+            },
+            {
+                name: 'timezone',
+                title: '@location-management:geographic-regions.entities.geographic-region.fields.timezone',
+                groupId: 'geographic-data',
+                options: {
+                    filter: {
+                        advance: {
+                            enabled: true,
+                        },
+                    },
+                },
+                schema: {
+                    dataType: 'string',
+                    defaultValue: `{{ settings.get('${AXPRegionalSetting.TimeZone}') }}`,
+                    interface: {
+                        type: AXPWidgetsCatalog.lookup,
+                        options: {
+                            entity: 'LocaleManagement.Timezones',
+                            look: 'select',
+                            allowSearch: true,
+                            valueField: 'code',
+                            textField: 'title',
+                            placeholder: 'e.g., America/New_York',
+                            filter: {
+                                logic: 'and',
+                                filters: [{ field: 'isActive', operator: { type: 'equal' }, value: true }],
+                            },
+                        },
+                    },
+                },
+            },
+            {
+                name: 'population',
+                title: '@location-management:geographic-regions.entities.geographic-region.fields.population',
+                groupId: 'additional-info',
+                options: {
+                    filter: {
+                        advance: {
+                            enabled: true,
+                        },
+                    },
+                },
+                schema: {
+                    dataType: 'number',
+                    interface: {
+                        type: AXPWidgetsCatalog.number,
+                        options: {
+                            minValue: 0,
+                        },
+                    },
+                },
+            },
+            {
+                name: 'area',
+                title: '@location-management:geographic-regions.entities.geographic-region.fields.area',
+                groupId: 'additional-info',
+                options: {
+                    filter: {
+                        advance: {
+                            enabled: true,
+                        },
+                    },
+                },
+                schema: {
+                    dataType: 'number',
+                    interface: {
+                        type: AXPWidgetsCatalog.number,
+                        options: {
+                            minValue: 0,
+                            placeholder: 'Area in square kilometers',
+                        },
+                    },
+                },
+            },
+            {
+                name: 'currencyId',
+                title: '@location-management:geographic-regions.entities.geographic-region.fields.currency',
+                groupId: 'additional-info',
+                options: {
+                    sort: { enabled: false },
+                    filter: {
+                        advance: {
+                            enabled: true,
+                        },
+                        inline: { enabled: false },
+                    },
+                },
+                schema: {
+                    dataType: 'string',
+                    interface: {
+                        type: AXPWidgetsCatalog.lookup,
+                        options: {
+                            entity: `${"FinancialCore"}.${"Currency"}`,
+                            multiple: false,
+                            look: 'select',
+                            textField: 'code',
+                            valueField: 'id',
+                            expose: [
+                                { source: 'id', target: 'currency.id' },
+                                { source: 'code', target: 'currency.code' },
+                                { source: 'title', target: 'currency.title' },
+                                { source: 'symbol', target: 'currency.symbol' },
+                            ],
+                        },
+                    },
+                },
+            },
+        ],
+        columns: [
+            { name: 'title', options: { width: '400px', order: 1 } },
+            { name: 'code', options: { width: '150px', order: 2 } },
+            { name: 'type', options: { width: '150px', dataPath: 'type.title', order: 3 } },
+            { name: 'currencyId', options: { width: '150px', dataPath: 'currency.code', order: 4 } },
+        ],
+        interfaces: {
+            master: {
+                create: {
+                    sections: [
+                        {
+                            id: 'basic-info',
+                        },
+                        {
+                            id: 'geographic-data',
+                        },
+                        {
+                            id: 'additional-info',
+                        },
+                        {
+                            id: 'settings',
+                        },
+                    ],
+                    properties: [
+                        {
+                            name: 'title',
+                            layout: {
+                                positions: {
+                                    sm: {
+                                        colSpan: 12,
+                                    },
+                                    md: {
+                                        colSpan: 6,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'code',
+                            layout: {
+                                positions: {
+                                    sm: {
+                                        colSpan: 12,
+                                    },
+                                    md: {
+                                        colSpan: 6,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'type',
+                            layout: {
+                                positions: {
+                                    sm: {
+                                        colSpan: 12,
+                                    },
+                                    md: {
+                                        colSpan: 6,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'parentId',
+                            layout: {
+                                positions: {
+                                    sm: {
+                                        colSpan: 12,
+                                    },
+                                    md: {
+                                        colSpan: 6,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'coordinates',
+                            layout: {
+                                positions: {
+                                    sm: {
+                                        colSpan: 12,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'timezone',
+                            layout: {
+                                positions: {
+                                    sm: {
+                                        colSpan: 12,
+                                    },
+                                    md: {
+                                        colSpan: 4,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'population',
+                            layout: {
+                                positions: {
+                                    sm: {
+                                        colSpan: 12,
+                                    },
+                                    md: {
+                                        colSpan: 4,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'area',
+                            layout: {
+                                positions: {
+                                    sm: {
+                                        colSpan: 12,
+                                    },
+                                    md: {
+                                        colSpan: 4,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'currencyId',
+                            layout: {
+                                positions: {
+                                    sm: {
+                                        colSpan: 12,
+                                    },
+                                    md: {
+                                        colSpan: 4,
+                                    },
+                                },
+                            },
+                        },
+                    ],
+                },
+                update: {
+                    sections: [
+                        {
+                            id: 'basic-info',
+                        },
+                        {
+                            id: 'geographic-data',
+                        },
+                        {
+                            id: 'additional-info',
+                        },
+                        {
+                            id: 'settings',
+                        },
+                    ],
+                    properties: [
+                        {
+                            name: 'title',
+                            layout: {
+                                positions: {
+                                    sm: {
+                                        colSpan: 12,
+                                    },
+                                    md: {
+                                        colSpan: 6,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'code',
+                            layout: {
+                                positions: {
+                                    sm: {
+                                        colSpan: 12,
+                                    },
+                                    md: {
+                                        colSpan: 6,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'type',
+                            layout: {
+                                positions: {
+                                    sm: {
+                                        colSpan: 12,
+                                    },
+                                    md: {
+                                        colSpan: 6,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'parentId',
+                            layout: {
+                                positions: {
+                                    sm: {
+                                        colSpan: 12,
+                                    },
+                                    md: {
+                                        colSpan: 6,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'coordinates',
+                            layout: {
+                                positions: {
+                                    sm: {
+                                        colSpan: 12,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'timezone',
+                            layout: {
+                                positions: {
+                                    sm: {
+                                        colSpan: 12,
+                                    },
+                                    md: {
+                                        colSpan: 4,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'population',
+                            layout: {
+                                positions: {
+                                    sm: {
+                                        colSpan: 12,
+                                    },
+                                    md: {
+                                        colSpan: 4,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'area',
+                            layout: {
+                                positions: {
+                                    sm: {
+                                        colSpan: 12,
+                                    },
+                                    md: {
+                                        colSpan: 4,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'currencyId',
+                            layout: {
+                                positions: {
+                                    sm: {
+                                        colSpan: 12,
+                                    },
+                                    md: {
+                                        colSpan: 4,
+                                    },
+                                },
+                            },
+                        },
+                    ],
+                },
+                single: {
+                    title: '{{title}}',
+                    sections: [
+                        {
+                            id: 'basic-info',
+                            layout: {
+                                positions: {
+                                    lg: {
+                                        colSpan: 12,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            id: 'geographic-data',
+                            layout: {
+                                positions: {
+                                    lg: {
+                                        colSpan: 12,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            id: 'additional-info',
+                            layout: {
+                                positions: {
+                                    lg: {
+                                        colSpan: 12,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            id: 'settings',
+                            layout: {
+                                positions: {
+                                    lg: {
+                                        colSpan: 12,
+                                    },
+                                },
+                            },
+                        },
+                    ],
+                    properties: [
+                        {
+                            name: 'title',
+                            layout: {
+                                positions: {
+                                    lg: {
+                                        colSpan: 6,
+                                        order: 1,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'code',
+                            layout: {
+                                positions: {
+                                    lg: {
+                                        colSpan: 6,
+                                        order: 2,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'type',
+                            layout: {
+                                positions: {
+                                    lg: {
+                                        colSpan: 6,
+                                        order: 3,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'parentId',
+                            layout: {
+                                positions: {
+                                    lg: {
+                                        colSpan: 6,
+                                        order: 4,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'coordinates',
+                            layout: {
+                                positions: {
+                                    lg: {
+                                        colSpan: 12,
+                                        order: 5,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'timezone',
+                            layout: {
+                                positions: {
+                                    lg: {
+                                        colSpan: 4,
+                                        order: 6,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'population',
+                            layout: {
+                                positions: {
+                                    lg: {
+                                        colSpan: 4,
+                                        order: 7,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'area',
+                            layout: {
+                                positions: {
+                                    lg: {
+                                        colSpan: 4,
+                                        order: 8,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'currencyId',
+                            layout: {
+                                positions: {
+                                    lg: {
+                                        colSpan: 4,
+                                        order: 9,
+                                    },
+                                },
+                            },
+                        },
+                    ],
+                    actions: [...entityMasterRecordActions()],
+                },
+                list: {
+                    actions: [...entityMasterCrudActions()],
+                    views: [
+                        createAllQueryView({
+                            sorts: [{ name: 'title', dir: 'asc' }],
+                        }),
+                    ],
+                },
+            },
+        },
+    };
+    return entityDef;
+}
+
+/**
+ * Generated bundle index. Do not edit.
+ */
+
+export { geographicRegionFactory };
+//# sourceMappingURL=acorex-platform-module-location-management-client-contracts-entities-geographic-region.mjs.map