@acorex-platform/module-location-management-client 0.0.15 → 0.0.18

package/contracts/entities/location/location.entity.js

@@ -1,1075 +0,0 @@
-import { AXPRegionalSetting, AXPWidgetsCatalog } from '@acorex-platform/framework-shared/core';
-import { createAllQueryView, entityMasterCrudActions, entityMasterRecordActions } from '@acorex-platform/framework-shared/entity';
-import { AXPLocaleManagementDataSourceKeys } from '@acorex-platform/module-locale-management-contracts';
-import { RootConfig } from '../../root-config';
-import { locationAssignmentReadOnlyRelatedActions } from '../../index';
-import { locationAssignmentLocationConditions } from '../../index';
-export async function locationFactory() {
-    const entityDef = {
-        module: RootConfig.module.name,
-        name: RootConfig.entities.location.name,
-        icon: 'fa-solid fa-location-dot',
-        title: RootConfig.entities.location.title,
-        formats: {
-            individual: RootConfig.entities.location.title,
-            plural: RootConfig.entities.location.titlePlural,
-            searchResult: {
-                title: '{{ title }}',
-                description: '{{ fullAddress }}',
-            },
-        },
-        plugins: [
-            { name: 'archive' },
-            {
-                name: 'computed-property',
-                options: {
-                    fields: [
-                        {
-                            name: 'fullAddress',
-                            title: '@general:terms.common.address',
-                            value: '{{ address.format({ street1: context.eval("street1"), street2: context.eval("street2"), country: context.eval("country"), state: context.eval("state"), city: context.eval("city"), postalCode: context.eval("postalCode") }) }}',
-                            group: {
-                                id: 'address',
-                                title: '@location-management:locations.entities.location.groups.address-details',
-                            },
-                            visible: false,
-                            recompute: { middleware: true },
-                            showAs: { type: AXPWidgetsCatalog.text },
-                        },
-                    ],
-                },
-            },
-        ],
-        groups: [
-            {
-                id: 'basic-info',
-                title: '@general:terms.interface.basic-info',
-            },
-            {
-                id: 'address',
-                title: '@location-management:locations.entities.location.groups.address-details',
-            },
-            {
-                id: 'geographic',
-                title: '@general:terms.interface.geographic-details',
-            },
-            {
-                id: 'additional',
-                title: '@general:terms.interface.additional-info',
-            },
-        ],
-        properties: [
-            {
-                name: 'code',
-                title: '@location-management:locations.entities.location.fields.code',
-                groupId: 'basic-info',
-                options: {
-                    sort: {
-                        enabled: true,
-                    },
-                    filter: {
-                        advance: {
-                            enabled: true,
-                        },
-                        inline: {
-                            enabled: true,
-                        },
-                    },
-                },
-                schema: {
-                    dataType: 'string',
-                    interface: {
-                        type: AXPWidgetsCatalog.text,
-                        options: {
-                            placeholder: 'Optional location code',
-                        },
-                    },
-                },
-            },
-            {
-                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: {
-                            placeholder: 'Enter location name',
-                        },
-                    },
-                },
-                validations: [
-                    {
-                        rule: 'required',
-                    },
-                ],
-            },
-            {
-                name: 'locationTypeId',
-                title: '@location-management:locations.entities.location.fields.location-type',
-                groupId: 'basic-info',
-                options: {
-                    sort: {
-                        enabled: true,
-                    },
-                    filter: {
-                        advance: {
-                            enabled: true,
-                        },
-                        inline: {
-                            enabled: true,
-                        },
-                    },
-                },
-                schema: {
-                    dataType: 'object',
-                    interface: {
-                        type: AXPWidgetsCatalog.lookup,
-                        options: {
-                            entity: `${RootConfig.module.name}.${RootConfig.entities.locationType.name}`,
-                            look: 'select',
-                            expose: [
-                                { source: 'id', target: 'locationType.id' },
-                                { source: 'title', target: 'locationType.title' },
-                            ],
-                        },
-                    },
-                },
-                validations: [
-                    {
-                        rule: 'required',
-                    },
-                ],
-            },
-            {
-                name: 'street1',
-                title: '@location-management:locations.entities.location.fields.street1',
-                groupId: 'address',
-                options: {
-                    sort: {
-                        enabled: true,
-                    },
-                    filter: {
-                        advance: {
-                            enabled: true,
-                        },
-                        inline: {
-                            enabled: true,
-                        },
-                    },
-                },
-                schema: {
-                    dataType: 'string',
-                    interface: {
-                        type: AXPWidgetsCatalog.text,
-                        options: {
-                            placeholder: 'Enter street address',
-                        },
-                    },
-                },
-                validations: [
-                    {
-                        rule: 'required',
-                    },
-                ],
-            },
-            {
-                name: 'street2',
-                title: '@location-management:locations.entities.location.fields.street2',
-                groupId: 'address',
-                options: {
-                    filter: {
-                        advance: {
-                            enabled: true,
-                        },
-                    },
-                },
-                schema: {
-                    dataType: 'string',
-                    interface: {
-                        type: AXPWidgetsCatalog.text,
-                        options: {
-                            placeholder: 'Apartment, suite, etc.',
-                        },
-                    },
-                },
-            },
-            {
-                name: 'countryId',
-                title: '@location-management:locations.entities.location.fields.country',
-                groupId: 'address',
-                options: {
-                    sort: {
-                        enabled: true,
-                    },
-                    filter: {
-                        advance: {
-                            enabled: true,
-                        },
-                        inline: {
-                            enabled: true,
-                        },
-                    },
-                },
-                schema: {
-                    dataType: 'object',
-                    interface: {
-                        type: AXPWidgetsCatalog.lookup,
-                        options: {
-                            entity: `${RootConfig.module.name}.${RootConfig.entities.geographicRegion.name}`,
-                            look: 'select',
-                            allowCreate: 'quick',
-                            create: {
-                                enable: true,
-                            },
-                            expose: [
-                                { source: 'id', target: 'country.id' },
-                                { source: 'title', target: 'country.title' },
-                            ],
-                            filter: {
-                                logic: 'and',
-                                filters: [
-                                    { field: 'type.code', operator: { type: 'equal' }, value: 'country' },
-                                ],
-                            },
-                        },
-                    },
-                },
-            },
-            {
-                name: 'stateId',
-                title: '@location-management:locations.entities.location.fields.state',
-                groupId: 'address',
-                options: {
-                    filter: {
-                        advance: {
-                            enabled: true,
-                        },
-                        inline: {
-                            enabled: true,
-                        },
-                    },
-                },
-                schema: {
-                    dataType: 'object',
-                    interface: {
-                        type: AXPWidgetsCatalog.lookup,
-                        options: {
-                            look: 'select',
-                            entity: `${RootConfig.module.name}.${RootConfig.entities.geographicRegion.name}`,
-                            allowCreate: 'quick',
-                            disabled: '{{ !context.eval("countryId") }}',
-                            create: {
-                                enable: true,
-                                context: {
-                                    parentId: '{{ context.eval("countryId") }}',
-                                    type: { code: 'state' },
-                                },
-                            },
-                            expose: [
-                                { source: 'id', target: 'state.id' },
-                                { source: 'title', target: 'state.title' },
-                            ],
-                            filter: {
-                                logic: 'and',
-                                filters: [
-                                    {
-                                        field: 'parentId',
-                                        operator: {
-                                            type: 'equal',
-                                        },
-                                        value: '{{ context.eval("countryId") }}',
-                                    },
-                                    {
-                                        field: 'type.code',
-                                        operator: {
-                                            type: 'equal',
-                                        },
-                                        value: 'state',
-                                    },
-                                ],
-                            },
-                        },
-                        triggers: [
-                            {
-                                event: "{{ events.context('countryId') }}",
-                                action: `{{ widget.setValue(null); context.set('state.title', null); context.set('cityId', null); context.set('city.id', null); context.set('city.title', null); widget.refresh(); }}`,
-                            },
-                        ],
-                    },
-                },
-            },
-            {
-                name: 'cityId',
-                title: '@location-management:locations.entities.location.fields.city',
-                groupId: 'address',
-                options: {
-                    filter: {
-                        advance: {
-                            enabled: true,
-                        },
-                        inline: {
-                            enabled: true,
-                        },
-                    },
-                },
-                schema: {
-                    dataType: 'object',
-                    interface: {
-                        type: AXPWidgetsCatalog.lookup,
-                        options: {
-                            look: 'select',
-                            entity: `${RootConfig.module.name}.${RootConfig.entities.geographicRegion.name}`,
-                            allowCreate: 'quick',
-                            disabled: '{{ !context.eval("stateId") }}',
-                            create: {
-                                enable: true,
-                                context: {
-                                    parentId: '{{ context.eval("stateId") }}',
-                                    type: { code: 'city' },
-                                },
-                            },
-                            expose: [
-                                { source: 'id', target: 'city.id' },
-                                { source: 'title', target: 'city.title' },
-                            ],
-                            filter: {
-                                logic: 'and',
-                                filters: [
-                                    {
-                                        field: 'parentId',
-                                        operator: {
-                                            type: 'equal',
-                                        },
-                                        value: '{{ context.eval("stateId") }}',
-                                    },
-                                    {
-                                        field: 'type.code',
-                                        operator: {
-                                            type: 'equal',
-                                        },
-                                        value: 'city',
-                                    },
-                                ],
-                            },
-                        },
-                        triggers: [
-                            {
-                                event: "{{ events.context('stateId') }}",
-                                action: `{{ widget.setValue(null); context.set('city.title', null); widget.refresh(); }}`,
-                            },
-                            {
-                                event: "{{ events.context('countryId') }}",
-                                action: `{{ widget.setValue(null); context.set('city.title', null); widget.refresh(); }}`,
-                            },
-                        ],
-                    },
-                },
-            },
-            {
-                name: 'postalCode',
-                title: '@location-management:locations.entities.location.fields.postal-code',
-                groupId: 'address',
-                options: {
-                    filter: {
-                        advance: {
-                            enabled: true,
-                        },
-                        inline: {
-                            enabled: true,
-                        },
-                    },
-                },
-                schema: {
-                    dataType: 'string',
-                    interface: {
-                        type: AXPWidgetsCatalog.text,
-                        options: {
-                            placeholder: 'Postal/ZIP code',
-                        },
-                    },
-                },
-                validations: [
-                    {
-                        rule: 'required',
-                    },
-                ],
-            },
-            {
-                name: 'hasCoordinates',
-                title: '@location-management:locations.entities.location.fields.coordinates',
-                groupId: 'geographic',
-                schema: {
-                    dataType: 'boolean',
-                    defaultValue: false,
-                    interface: {
-                        type: AXPWidgetsCatalog.toggle,
-                    },
-                },
-            },
-            {
-                name: 'coordinates',
-                title: '@location-management:locations.entities.location.fields.coordinates',
-                groupId: 'geographic',
-                schema: {
-                    dataType: 'string',
-                    visible: '{{ context.eval("hasCoordinates") == true || !!context.eval("coordinates") }}',
-                    interface: {
-                        type: AXPWidgetsCatalog.map,
-                        options: {
-                            hasDraw: true,
-                            maxPolygon: 0,
-                            fitToDraw: true,
-                        },
-                        triggers: [
-                            {
-                                event: "{{ events.context('hasCoordinates') }}",
-                                action: `{{ widget.clear() }}`,
-                            },
-                        ],
-                    },
-                },
-            },
-            {
-                name: 'timezone',
-                title: '@location-management:locations.entities.location.fields.timezone',
-                groupId: 'geographic',
-                options: {
-                    filter: {
-                        advance: {
-                            enabled: true,
-                        },
-                    },
-                },
-                schema: {
-                    dataType: 'string',
-                    defaultValue: `{{ settings.get('${AXPRegionalSetting.TimeZone}') }}`,
-                    interface: {
-                        type: AXPWidgetsCatalog.select,
-                        options: {
-                            allowSearch: true,
-                            valueField: 'code',
-                            placeholder: 'e.g., America/New_York',
-                            dataSource: AXPLocaleManagementDataSourceKeys.Timezones,
-                        },
-                    },
-                },
-            },
-            {
-                name: 'parentLocationId',
-                title: '@location-management:locations.entities.location.fields.parent-location',
-                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.location.name}`,
-                            expose: [
-                                { source: 'id', target: 'parentLocation.id' },
-                                { source: 'title', target: 'parentLocation.title' },
-                            ],
-                        },
-                    },
-                },
-            },
-            {
-                name: 'description',
-                title: '@general:terms.common.description',
-                groupId: 'basic-info',
-                options: {
-                    filter: {
-                        advance: {
-                            enabled: true,
-                        },
-                    },
-                },
-                schema: {
-                    dataType: 'string',
-                    interface: {
-                        type: AXPWidgetsCatalog.largeText,
-                        options: {
-                            rows: 3,
-                        },
-                    },
-                },
-            },
-        ],
-        columns: [
-            { name: 'code' },
-            { name: 'title' },
-            { name: 'locationTypeId', options: { dataPath: 'locationType.title' } },
-            { name: 'street1' },
-            { name: 'postalCode' },
-            { name: 'cityId', options: { dataPath: 'city.title' } },
-            { name: 'stateId', options: { dataPath: 'state.title' } },
-            { name: 'countryId', options: { dataPath: 'country.title' } },
-        ],
-        relatedEntities: [
-            {
-                entity: `${RootConfig.module.name}.${RootConfig.entities.locationAssignment.name}`,
-                title: '@location-management:locations.entities.location.related-entities.assignments.title',
-                icon: RootConfig.entities.locationAssignment.icon,
-                columns: [
-                    { name: 'ownerRef.id', options: { dataPath: 'ownerRef.title' } },
-                    { name: 'roleId', options: { dataPath: 'role.title' } },
-                    { name: 'personId', options: { dataPath: 'person.fullName' } },
-                    { name: 'person.phones' },
-                    { name: 'notes' },
-                ],
-                conditions: locationAssignmentLocationConditions('id'),
-                actions: [...locationAssignmentReadOnlyRelatedActions()],
-                layout: { type: 'page-list', position: 'after', order: 1 },
-            },
-        ],
-        interfaces: {
-            master: {
-                create: {
-                    sections: [
-                        {
-                            id: 'basic-info',
-                        },
-                        {
-                            id: 'address',
-                        },
-                        {
-                            id: 'geographic',
-                        },
-                        {
-                            id: 'additional',
-                        },
-                    ],
-                    properties: [
-                        {
-                            name: 'code',
-                        },
-                        {
-                            name: 'title',
-                        },
-                        {
-                            name: 'locationTypeId',
-                            layout: {
-                                positions: {
-                                    sm: {
-                                        colSpan: 12,
-                                    },
-                                    md: {
-                                        colSpan: 6,
-                                    },
-                                },
-                            },
-                        },
-                        {
-                            name: 'street1',
-                            layout: {
-                                positions: {
-                                    sm: {
-                                        colSpan: 12,
-                                    },
-                                },
-                            },
-                        },
-                        {
-                            name: 'street2',
-                            layout: {
-                                positions: {
-                                    sm: {
-                                        colSpan: 12,
-                                    },
-                                },
-                            },
-                        },
-                        {
-                            name: 'countryId',
-                            layout: {
-                                positions: {
-                                    sm: {
-                                        colSpan: 12,
-                                    },
-                                    md: {
-                                        colSpan: 4,
-                                    },
-                                },
-                            },
-                        },
-                        {
-                            name: 'stateId',
-                            layout: {
-                                positions: {
-                                    sm: {
-                                        colSpan: 12,
-                                    },
-                                    md: {
-                                        colSpan: 4,
-                                    },
-                                },
-                            },
-                        },
-                        {
-                            name: 'cityId',
-                            layout: {
-                                positions: {
-                                    sm: {
-                                        colSpan: 12,
-                                    },
-                                    md: {
-                                        colSpan: 4,
-                                    },
-                                },
-                            },
-                        },
-                        {
-                            name: 'postalCode',
-                            layout: {
-                                positions: {
-                                    sm: {
-                                        colSpan: 12,
-                                    },
-                                    md: {
-                                        colSpan: 4,
-                                    },
-                                },
-                            },
-                        },
-                        {
-                            name: 'hasCoordinates',
-                            layout: {
-                                positions: {
-                                    sm: {
-                                        colSpan: 6,
-                                    },
-                                },
-                            },
-                        },
-                        {
-                            name: 'coordinates',
-                            layout: {
-                                label: {
-                                    visible: false,
-                                },
-                                positions: {
-                                    sm: {
-                                        colSpan: 12,
-                                    },
-                                },
-                            },
-                        },
-                        {
-                            name: 'timezone',
-                            layout: {
-                                positions: {
-                                    sm: {
-                                        colSpan: 12,
-                                        colStart: 1,
-                                    },
-                                    md: {
-                                        colSpan: 4,
-                                        colStart: 1,
-                                    },
-                                },
-                            },
-                        },
-                        {
-                            name: 'parentLocationId',
-                            layout: {
-                                positions: {
-                                    sm: {
-                                        colSpan: 12,
-                                    },
-                                    md: {
-                                        colSpan: 6,
-                                    },
-                                },
-                            },
-                        },
-                        {
-                            name: 'description',
-                        },
-                    ],
-                },
-                update: {
-                    sections: [
-                        {
-                            id: 'basic-info',
-                        },
-                        {
-                            id: 'address',
-                        },
-                        {
-                            id: 'geographic',
-                        },
-                        {
-                            id: 'additional',
-                        },
-                        {
-                            id: 'settings',
-                        },
-                    ],
-                    properties: [
-                        {
-                            name: 'code',
-                        },
-                        {
-                            name: 'title',
-                        },
-                        {
-                            name: 'locationTypeId',
-                            layout: {
-                                positions: {
-                                    sm: {
-                                        colSpan: 12,
-                                    },
-                                    md: {
-                                        colSpan: 6,
-                                    },
-                                },
-                            },
-                        },
-                        {
-                            name: 'description',
-                        },
-                        {
-                            name: 'parentLocationId',
-                            layout: {
-                                positions: {
-                                    sm: {
-                                        colSpan: 12,
-                                    },
-                                    md: {
-                                        colSpan: 6,
-                                    },
-                                },
-                            },
-                        },
-                        {
-                            name: 'street1',
-                            layout: {
-                                positions: {
-                                    sm: {
-                                        colSpan: 12,
-                                    },
-                                },
-                            },
-                        },
-                        {
-                            name: 'street2',
-                            layout: {
-                                positions: {
-                                    sm: {
-                                        colSpan: 12,
-                                    },
-                                },
-                            },
-                        },
-                        {
-                            name: 'cityId',
-                            layout: {
-                                positions: {
-                                    sm: {
-                                        colSpan: 12,
-                                    },
-                                    md: {
-                                        colSpan: 4,
-                                    },
-                                },
-                            },
-                        },
-                        {
-                            name: 'stateId',
-                            layout: {
-                                positions: {
-                                    sm: {
-                                        colSpan: 12,
-                                    },
-                                    md: {
-                                        colSpan: 4,
-                                    },
-                                },
-                            },
-                        },
-                        {
-                            name: 'countryId',
-                            layout: {
-                                positions: {
-                                    sm: {
-                                        colSpan: 12,
-                                    },
-                                    md: {
-                                        colSpan: 4,
-                                    },
-                                },
-                            },
-                        },
-                        {
-                            name: 'postalCode',
-                            layout: {
-                                positions: {
-                                    sm: {
-                                        colSpan: 12,
-                                    },
-                                    md: {
-                                        colSpan: 4,
-                                    },
-                                },
-                            },
-                        },
-                        {
-                            name: 'hasCoordinates',
-                            layout: {
-                                positions: {
-                                    sm: {
-                                        colSpan: 6,
-                                    },
-                                },
-                            },
-                        },
-                        {
-                            name: 'coordinates',
-                            layout: {
-                                label: {
-                                    visible: false,
-                                },
-                                positions: {
-                                    sm: {
-                                        colSpan: 12,
-                                    },
-                                },
-                            },
-                        },
-                        {
-                            name: 'timezone',
-                            layout: {
-                                positions: {
-                                    sm: {
-                                        colSpan: 12,
-                                        colStart: 1,
-                                    },
-                                    md: {
-                                        colSpan: 4,
-                                        colStart: 1,
-                                    },
-                                },
-                            },
-                        },
-                    ],
-                },
-                single: {
-                    title: '{{title}}',
-                    description: '{{ fullAddress }}',
-                    sections: [
-                        {
-                            id: 'basic-info',
-                            layout: {
-                                positions: {
-                                    lg: {
-                                        colSpan: 12,
-                                    },
-                                },
-                            },
-                        },
-                        {
-                            id: 'address',
-                            layout: {
-                                positions: {
-                                    lg: {
-                                        colSpan: 12,
-                                    },
-                                },
-                            },
-                        },
-                        {
-                            id: 'geographic',
-                            layout: {
-                                positions: {
-                                    lg: {
-                                        colSpan: 12,
-                                    },
-                                },
-                            },
-                        },
-                        {
-                            id: 'additional',
-                            layout: {
-                                positions: {
-                                    lg: {
-                                        colSpan: 12,
-                                    },
-                                },
-                            },
-                        },
-                    ],
-                    properties: [
-                        {
-                            name: 'code',
-                        },
-                        {
-                            name: 'title',
-                        },
-                        {
-                            name: 'locationTypeId',
-                            layout: {
-                                positions: {
-                                    lg: {
-                                        colSpan: 6,
-                                        order: 3,
-                                    },
-                                },
-                            },
-                        },
-                        {
-                            name: 'description',
-                        },
-                        {
-                            name: 'parentLocationId',
-                            layout: {
-                                positions: {
-                                    lg: {
-                                        colSpan: 6,
-                                        order: 11,
-                                    },
-                                },
-                            },
-                        },
-                        {
-                            name: 'street1',
-                            layout: {
-                                positions: {
-                                    lg: {
-                                        colSpan: 12,
-                                        order: 4,
-                                    },
-                                },
-                            },
-                        },
-                        {
-                            name: 'street2',
-                            layout: {
-                                positions: {
-                                    lg: {
-                                        colSpan: 12,
-                                        order: 5,
-                                    },
-                                },
-                            },
-                        },
-                        {
-                            name: 'cityId',
-                            layout: {
-                                positions: {
-                                    lg: {
-                                        colSpan: 4,
-                                        order: 6,
-                                    },
-                                },
-                            },
-                        },
-                        {
-                            name: 'stateId',
-                            layout: {
-                                positions: {
-                                    lg: {
-                                        colSpan: 4,
-                                        order: 7,
-                                    },
-                                },
-                            },
-                        },
-                        {
-                            name: 'countryId',
-                            layout: {
-                                positions: {
-                                    lg: {
-                                        colSpan: 4,
-                                        order: 8,
-                                    },
-                                },
-                            },
-                        },
-                        {
-                            name: 'postalCode',
-                            layout: {
-                                positions: {
-                                    lg: {
-                                        colSpan: 4,
-                                        order: 9,
-                                    },
-                                },
-                            },
-                        },
-                        {
-                            name: 'hasCoordinates',
-                            layout: {
-                                positions: {
-                                    lg: {
-                                        colSpan: 6,
-                                        order: 10,
-                                    },
-                                },
-                            },
-                        },
-                        {
-                            name: 'coordinates',
-                            layout: {
-                                label: {
-                                    visible: false,
-                                },
-                                positions: {
-                                    lg: {
-                                        colSpan: 12,
-                                        order: 11,
-                                    },
-                                },
-                            },
-                        },
-                        {
-                            name: 'timezone',
-                            layout: {
-                                positions: {
-                                    lg: {
-                                        colSpan: 4,
-                                        colStart: 1,
-                                        order: 12,
-                                    },
-                                },
-                            },
-                        },
-                    ],
-                    actions: [...entityMasterRecordActions()],
-                },
-                list: {
-                    actions: [...entityMasterCrudActions()],
-                    views: [
-                        createAllQueryView({
-                            sorts: [{ name: 'title', dir: 'asc' }],
-                        }),
-                    ],
-                },
-            },
-        },
-    };
-    return entityDef;
-}