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

package/contracts/entities/location/location.types.d.ts

@@ -0,0 +1,30 @@
+import { AXPEntityModel } from '@acorex-platform/framework-shared/entity';
+export interface AXMLocationManagementLocationEntityModel extends AXPEntityModel<string> {
+    title: string;
+    code?: string;
+    locationTypeId?: string;
+    locationType?: {
+        id: string;
+        title: string;
+        description?: string;
+        icon?: string;
+        color?: string;
+    };
+    street1: string;
+    street2?: string;
+    countryId?: string;
+    stateId?: string;
+    cityId?: string;
+    districtId?: string;
+    postalCode: string;
+    coordinates?: string;
+    description?: string;
+    parentLocationId?: string;
+    isPrimary?: boolean;
+    isActive: boolean;
+    validFrom?: Date;
+    validTo?: Date;
+    timezone?: string;
+    /** Computed: formatted address (from computed-property plugin) */
+    fullAddress?: string;
+}

package/contracts/entities/location/location.types.js

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

package/contracts/entities/location-assignment/index.d.ts

@@ -0,0 +1,2 @@
+export * from './location-assignment.entity';
+export * from './location-assignment.types';

package/contracts/entities/location-assignment/index.js

@@ -0,0 +1,2 @@
+export * from './location-assignment.entity';
+export * from './location-assignment.types';

package/contracts/entities/location-assignment/location-assignment.entity.d.ts

@@ -0,0 +1,2 @@
+import { AXPEntity } from '@acorex-platform/framework-shared/entity';
+export declare function locationAssignmentFactory(): Promise<AXPEntity>;

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

@@ -0,0 +1,194 @@
+import { AXPWidgetsCatalog, AXPWidgetsList } from '@acorex-platform/framework-shared/core';
+import { createAllQueryView, entityMasterCrudActions, entityMasterRecordActions, } from '@acorex-platform/framework-shared/entity';
+//#region ----   Imports   ----
+import { createLocationAssignmentOwnerRefLookupProperty, createLocationAssignmentOwnerRefTypeProperty, RootConfig, } from '../../index';
+//#endregion
+//#region ----   Entity Factory   ----
+export async function locationAssignmentFactory() {
+    const entityDef = {
+        module: RootConfig.module.name,
+        name: RootConfig.entities.locationAssignment.name,
+        title: RootConfig.entities.locationAssignment.title,
+        icon: RootConfig.entities.locationAssignment.icon,
+        formats: {
+            individual: RootConfig.entities.locationAssignment.title,
+            plural: RootConfig.entities.locationAssignment.titlePlural,
+            searchResult: {
+                title: '{{ location.title }}',
+                description: '@location-management:location-assignments.entities.location-assignment.search-result-description',
+            },
+        },
+        plugins: [{ name: 'notes' }],
+        groups: [{ id: 'basic-info', title: '@general:terms.interface.basic-info' }],
+        properties: [
+            {
+                name: 'locationId',
+                title: '@location-management:location-assignments.entities.location-assignment.fields.location.title',
+                groupId: 'basic-info',
+                options: {
+                    sort: { enabled: true },
+                    filter: { advance: { enabled: true }, inline: { enabled: true } },
+                },
+                schema: {
+                    dataType: 'string',
+                    interface: {
+                        type: AXPWidgetsList.Editors.LookupBox,
+                        options: {
+                            entity: `${RootConfig.module.name}.${RootConfig.entities.location.name}`,
+                            multiple: false,
+                            textField: 'title',
+                            columns: ['title', 'code', 'fullAddress', 'locationTypeId'],
+                            allowCreate: 'quick',
+                            expose: [
+                                { source: 'id', target: 'location.id' },
+                                { source: 'title', target: 'location.title' },
+                                { source: 'fullAddress', target: 'location.fullAddress' },
+                                { source: 'street1', target: 'location.street1' },
+                                { source: 'street2', target: 'location.street2' },
+                                { source: 'postalCode', target: 'location.postalCode' },
+                                { source: 'city.title', target: 'location.city.title' },
+                                { source: 'state.title', target: 'location.state.title' },
+                                { source: 'country.title', target: 'location.country.title' },
+                            ],
+                        },
+                    },
+                },
+                validations: [{ rule: 'required' }],
+            },
+            createLocationAssignmentOwnerRefTypeProperty('basic-info'),
+            createLocationAssignmentOwnerRefLookupProperty('basic-info'),
+            {
+                name: 'roleId',
+                title: '@location-management:location-assignments.entities.location-assignment.fields.role.title',
+                groupId: 'basic-info',
+                options: {
+                    sort: { enabled: true },
+                    filter: { advance: { enabled: true }, inline: { enabled: true } },
+                },
+                schema: {
+                    dataType: 'string',
+                    interface: {
+                        type: AXPWidgetsCatalog.lookup,
+                        options: {
+                            look: 'select',
+                            entity: `${RootConfig.module.name}.${RootConfig.entities.locationRole.name}`,
+                            multiple: false,
+                            expose: [
+                                { source: 'id', target: 'role.id' },
+                                { source: 'title', target: 'role.title' },
+                            ],
+                        },
+                    },
+                },
+                validations: [{ rule: 'required' }],
+            },
+            {
+                name: 'personId',
+                title: '@location-management:location-assignments.entities.location-assignment.fields.contact.title',
+                groupId: 'basic-info',
+                options: {
+                    sort: { enabled: true },
+                    filter: { advance: { enabled: true }, inline: { enabled: true } },
+                },
+                schema: {
+                    dataType: 'string',
+                    interface: {
+                        type: AXPWidgetsCatalog.lookup,
+                        options: {
+                            entity: 'PersonCore.Person',
+                            multiple: false,
+                            textField: 'fullName',
+                            columns: ['fullName', 'phones', 'emails'],
+                            allowCreate: 'quick',
+                            expose: [
+                                { source: 'id', target: 'person.id' },
+                                { source: 'fullName', target: 'person.fullName' },
+                                { source: 'phones', target: 'person.phones' },
+                                { source: 'emails', target: 'person.emails' },
+                            ],
+                        },
+                    },
+                },
+            },
+        ],
+        columns: [
+            {
+                name: 'locationId',
+                title: '@general:terms.common.title',
+                options: { dataPath: 'location.title' },
+            },
+            {
+                name: 'roleId',
+                title: '@location-management:location-assignments.entities.location-assignment.fields.role.title',
+                options: { dataPath: 'role.title' },
+            },
+            {
+                name: 'location.fullAddress',
+                title: '@general:terms.geography.address',
+                options: { width: '280px' },
+            },
+            {
+                name: 'personId',
+                title: '@general:terms.people.contact',
+                options: { dataPath: 'person.fullName' },
+            },
+            {
+                name: 'person.phones',
+                title: '@general:terms.communication.phones',
+                options: { width: '180px' },
+            },
+            {
+                name: 'ownerRef.id',
+                title: '@location-management:location-assignments.entities.location-assignment.fields.assignee.title',
+                options: { dataPath: 'ownerRef.title' },
+            },
+            {
+                name: 'notes',
+                title: '@general:terms.common.notes',
+            },
+        ],
+        interfaces: {
+            master: {
+                create: {
+                    sections: [{ id: 'basic-info' }],
+                    properties: [
+                        { name: 'locationId', layout: { positions: { lg: { colSpan: 12, order: 1 } } } },
+                        { name: 'ownerRef.id', layout: { positions: { lg: { colSpan: 6, order: 2 } } } },
+                        { name: 'roleId', layout: { positions: { lg: { colSpan: 6, order: 3 } } } },
+                        { name: 'personId', layout: { positions: { lg: { colSpan: 6, order: 4 } } } },
+                    ],
+                },
+                update: {
+                    sections: [{ id: 'basic-info' }],
+                    properties: [
+                        { name: 'locationId', layout: { positions: { lg: { colSpan: 12, order: 1 } } } },
+                        { name: 'ownerRef.id', layout: { positions: { lg: { colSpan: 6, order: 2 } } } },
+                        { name: 'roleId', layout: { positions: { lg: { colSpan: 6, order: 3 } } } },
+                        { name: 'personId', layout: { positions: { lg: { colSpan: 6, order: 4 } } } },
+                    ],
+                },
+                single: {
+                    title: '{{ location.title }}',
+                    sections: [{ id: 'basic-info', layout: { positions: { lg: { colSpan: 12 } } } }],
+                    properties: [
+                        { name: 'locationId', layout: { positions: { lg: { colSpan: 12, order: 1 } } } },
+                        { name: 'ownerRef.id', layout: { positions: { lg: { colSpan: 6, order: 2 } } } },
+                        { name: 'roleId', layout: { positions: { lg: { colSpan: 6, order: 3 } } } },
+                        { name: 'personId', layout: { positions: { lg: { colSpan: 6, order: 4 } } } },
+                    ],
+                    actions: [...entityMasterRecordActions()],
+                },
+                list: {
+                    actions: [...entityMasterCrudActions()],
+                    views: [
+                        createAllQueryView({
+                            sorts: [{ name: 'locationId', dir: 'asc' }],
+                        }),
+                    ],
+                },
+            },
+        },
+    };
+    return entityDef;
+}
+//#endregion

package/contracts/entities/location-assignment/location-assignment.types.d.ts

@@ -0,0 +1,35 @@
+import type { AXPEntityReference } from '@acorex-platform/framework-shared/core';
+import { AXPEntityModel } from '@acorex-platform/framework-shared/entity';
+export interface AXMLocationManagementLocationAssignmentEntityModel extends AXPEntityModel<string> {
+    locationId: string;
+    ownerRef: AXPEntityReference;
+    roleId: string;
+    personId?: string;
+    location?: {
+        id: string;
+        title: string;
+        fullAddress?: string;
+        street1?: string;
+        street2?: string;
+        postalCode?: string;
+        city?: {
+            title: string;
+        };
+        state?: {
+            title: string;
+        };
+        country?: {
+            title: string;
+        };
+    };
+    role?: {
+        id: string;
+        title: string;
+    };
+    person?: {
+        id: string;
+        fullName?: string;
+        phones?: unknown[];
+        emails?: unknown[];
+    };
+}

package/contracts/entities/location-assignment/location-assignment.types.js

@@ -0,0 +1,2 @@
+export {};
+//#endregion

package/contracts/entities/location-role/index.d.ts

@@ -0,0 +1,2 @@
+export * from './location-role.entity';
+export * from './location-role.types';

package/contracts/entities/location-role/index.js

@@ -0,0 +1,2 @@
+export * from './location-role.entity';
+export * from './location-role.types';

package/contracts/entities/location-role/location-role.entity.d.ts

@@ -0,0 +1,2 @@
+import { AXPEntity } from '@acorex-platform/framework-shared/entity';
+export declare function locationRoleFactory(): Promise<AXPEntity>;

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

@@ -0,0 +1,143 @@
+import { AXPWidgetsList } from '@acorex-platform/framework-shared/core';
+import { createAllQueryView, entityMasterCrudActions, entityMasterRecordActions } from '@acorex-platform/framework-shared/entity';
+//#region ----   Imports   ----
+import { RootConfig } from '../../root-config';
+//#endregion
+//#region ----   Entity Factory   ----
+export async function locationRoleFactory() {
+    const sections = [{ id: 'basic-info', layout: { positions: { lg: { colSpan: 12 } } } }];
+    const createPropertyLayouts = [
+        { name: 'title', layout: { positions: { lg: { colSpan: 12, order: 1 } } } },
+        { name: 'description', layout: { positions: { lg: { colSpan: 12, order: 2 } } } },
+    ];
+    const modifyPropertyLayouts = [
+        { name: 'name', layout: { positions: { lg: { colSpan: 6, order: 1 } } } },
+        { name: 'title', layout: { positions: { lg: { colSpan: 6, order: 2 } } } },
+        { name: 'description', layout: { positions: { lg: { colSpan: 12, order: 3 } } } },
+    ];
+    const entityDef = {
+        module: RootConfig.module.name,
+        name: RootConfig.entities.locationRole.name,
+        title: RootConfig.entities.locationRole.title,
+        icon: RootConfig.entities.locationRole.icon,
+        formats: {
+            individual: RootConfig.entities.locationRole.title,
+            plural: RootConfig.entities.locationRole.titlePlural,
+            searchResult: {
+                title: '{{ title }}',
+                description: '@location-management:location-roles.entities.location-role.search-result-description',
+            },
+        },
+        plugins: [
+            { name: 'history' },
+            { name: 'compare' },
+            { name: 'clone' },
+            { name: 'derived-name' },
+            {
+                name: 'unique-fields',
+                options: {
+                    fields: 'name',
+                    scope: 'global',
+                },
+            },
+        ],
+        groups: [{ id: 'basic-info', title: '@general:terms.interface.basic-info' }],
+        properties: [
+            {
+                name: 'id',
+                title: '@general:terms.common.id',
+                groupId: 'basic-info',
+                schema: {
+                    dataType: 'uuid',
+                    visible: false,
+                    readonly: true,
+                    unique: { enabled: true },
+                },
+            },
+            {
+                name: 'name',
+                title: '@location-management:location-roles.entities.location-role.fields.name.title',
+                groupId: 'basic-info',
+                options: {
+                    sort: { enabled: true },
+                    filter: { advance: { enabled: true }, inline: { enabled: true } },
+                },
+                schema: {
+                    dataType: 'string',
+                    interface: {
+                        type: AXPWidgetsList.Editors.TextBox,
+                        options: {
+                            placeholder: '@location-management:location-roles.entities.location-role.fields.name.placeholder',
+                        },
+                    },
+                },
+                validations: [{ rule: 'required' }, { rule: 'variable-name' }],
+            },
+            {
+                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: AXPWidgetsList.Editors.TextBox,
+                        options: {
+                            placeholder: '@location-management:location-roles.entities.location-role.fields.title.placeholder',
+                        },
+                    },
+                },
+                validations: [{ rule: 'required' }],
+            },
+            {
+                name: 'description',
+                title: '@general:terms.common.description',
+                groupId: 'basic-info',
+                options: {
+                    sort: { enabled: false },
+                    filter: { advance: { enabled: true }, inline: { enabled: false } },
+                },
+                schema: {
+                    dataType: 'string',
+                    interface: {
+                        type: AXPWidgetsList.Editors.LargeTextBox,
+                        options: {
+                            rows: 3,
+                            placeholder: '@location-management:location-roles.entities.location-role.fields.description.placeholder',
+                        },
+                    },
+                },
+            },
+        ],
+        columns: [
+            { name: 'title', options: { width: '220px', order: 1 } },
+            { name: 'name', options: { width: '140px', order: 2 } },
+            { name: 'description', options: { width: '320px', order: 3 } },
+        ],
+        interfaces: {
+            master: {
+                create: { sections, properties: createPropertyLayouts },
+                update: { sections, properties: modifyPropertyLayouts },
+                single: {
+                    title: '{{ title }}',
+                    sections,
+                    properties: modifyPropertyLayouts,
+                    actions: [...entityMasterRecordActions()],
+                },
+                list: {
+                    actions: [...entityMasterCrudActions()],
+                    views: [
+                        createAllQueryView({
+                            sorts: [{ name: 'title', dir: 'asc' }],
+                        }),
+                    ],
+                },
+            },
+        },
+    };
+    return entityDef;
+}
+//#endregion

package/contracts/entities/location-role/location-role.types.d.ts

@@ -0,0 +1,6 @@
+import { AXPEntityModel } from '@acorex-platform/framework-shared/entity';
+export interface AXMLocationManagementLocationRoleEntityModel extends AXPEntityModel<string> {
+    name: string;
+    title: string;
+    description?: string | null;
+}

package/contracts/entities/location-role/location-role.types.js

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

package/contracts/entities/location-type/index.d.ts

@@ -0,0 +1,2 @@
+export * from './location-type.entity';
+export * from './location-type.types';

package/contracts/entities/location-type/index.js

@@ -0,0 +1,2 @@
+export * from './location-type.entity';
+export * from './location-type.types';

package/contracts/entities/location-type/location-type.entity.d.ts

@@ -0,0 +1,2 @@
+import { AXPEntity } from '@acorex-platform/framework-shared/entity';
+export declare function locationTypeFactory(): Promise<AXPEntity | null>;