@acorex-platform/module-data-management-client 0.0.30 → 0.0.33

package/fesm2022/acorex-platform-module-data-management-client-contracts-entities-data-source.mjs

@@ -0,0 +1,919 @@
+import { AXPWidgetsCatalog, AXPWidgetsList } from '@acorex-platform/framework-shared/core';
+import { createAllQueryView, createQueryView, entityMasterCrudActions, entityMasterRecordActions } from '@acorex-platform/framework-shared/entity';
+
+const config = {
+    i18n: 'data-management',
+};
+const RootConfig = {
+    config,
+    module: {
+        route: 'data-management',
+        name: 'DataManagement',
+        title: '@data-management:module.title',
+        icon: 'fa-regular fa-database',
+    },
+    entities: {
+        query: {
+            name: 'Query',
+            title: '@data-management:queries.entities.query.title',
+            titlePlural: '@data-management:queries.entities.query.plural',
+            icon: 'fa-regular fa-nfc-magnifying-glass',
+        },
+        queryCategory: {
+            name: 'QueryCategory',
+            title: '@data-management:queries.terms.category',
+            titlePlural: '@data-management:queries.terms.categories',
+            icon: 'fa-regular fa-layer-group',
+        },
+        dataSource: {
+            name: 'DataSource',
+            title: '@data-management:data-sources.entities.data-source.title',
+            titlePlural: '@data-management:data-sources.entities.data-source.plural',
+            icon: 'fa-regular fa-database',
+        },
+        dataSourceCategory: {
+            name: 'DataSourceCategory',
+            title: '@data-management:data-sources.terms.category',
+            titlePlural: '@data-management:data-sources.terms.categories',
+            icon: 'fa-regular fa-layer-group',
+        },
+        metaDataDefinition: {
+            name: 'MetaDataDefinition',
+            title: '@data-management:metadata-definitions.entities.metadata-definition.title',
+            titlePlural: '@data-management:metadata-definitions.entities.metadata-definition.plural',
+            icon: 'fa-light fa-server',
+        },
+        tag: {
+            name: 'Tag',
+            source: 'DataManagement.Tag',
+            title: '@general:terms.common.tag',
+            icon: 'fa-light fa-tags',
+        },
+        equipmentCategory: {
+            name: 'EquipmentCategory',
+            title: '@data-management:equipments.entities.equipment-category.title',
+            titlePlural: '@data-management:equipments.entities.equipment-category.plural',
+            icon: 'fa-light fa-folder-tree',
+        },
+        equipment: {
+            name: 'Equipment',
+            source: 'DataManagement.Equipment',
+            title: '@data-management:equipments.entities.equipment.title',
+            titlePlural: '@data-management:equipments.entities.equipment.plural',
+            icon: 'fa-light fa-plug',
+        },
+    },
+};
+
+//#region ----   Column Definition Widget   ----
+const AXM_COLUMN_DEF_WIDGET = [
+    {
+        type: 'grid-layout',
+        mode: 'view',
+        options: {
+            direction: 'horizontal',
+        },
+        children: [
+            {
+                type: 'grid-item-layout',
+                mode: 'view',
+                options: { colSpan: 3 },
+                children: [
+                    {
+                        type: 'text-editor',
+                        mode: 'edit',
+                        path: 'name',
+                        options: {
+                            placeholder: 'Column Name',
+                            required: true,
+                        },
+                    },
+                ],
+            },
+            {
+                type: 'grid-item-layout',
+                mode: 'view',
+                options: { colSpan: 3 },
+                children: [
+                    {
+                        type: 'text-editor',
+                        mode: 'edit',
+                        path: 'title',
+                        options: {
+                            placeholder: 'Display Title',
+                            required: true,
+                        },
+                    },
+                ],
+            },
+            {
+                type: 'grid-item-layout',
+                options: { colSpan: 3 },
+                mode: 'view',
+                children: [
+                    {
+                        type: 'select-editor',
+                        mode: 'edit',
+                        path: 'type',
+                        options: {
+                            placeholder: 'Widget Type',
+                            valueField: 'name',
+                            textField: 'title',
+                            dataSource: 'PlatformManagement:ListEditorWidgets',
+                            direction: 'horizontal',
+                            multiple: false,
+                            required: true,
+                        },
+                    },
+                ],
+            },
+            {
+                type: 'grid-item-layout',
+                options: { colSpan: 1 },
+                mode: 'view',
+                children: [
+                    {
+                        type: 'checkbox-editor',
+                        mode: 'edit',
+                        path: 'isValueField',
+                        options: {
+                            tooltip: 'Value Field (only one can be selected)',
+                            label: 'Value',
+                        },
+                        triggers: [
+                            {
+                                event: "{{ events.context('columns.isValueField') }}",
+                                action: `{{ context.set('columns.isValueField', context.eval('columns.isValueField')[0]); }}`,
+                            },
+                        ],
+                    },
+                ],
+            },
+            {
+                type: 'grid-item-layout',
+                options: { colSpan: 1 },
+                mode: 'view',
+                children: [
+                    {
+                        type: 'checkbox-editor',
+                        mode: 'edit',
+                        path: 'isTextField',
+                        options: {
+                            tooltip: 'Text Field (multiple allowed)',
+                            label: 'Text',
+                        },
+                    },
+                ],
+            },
+            {
+                type: 'grid-item-layout',
+                options: { colSpan: 1 },
+                mode: 'view',
+                children: [
+                    {
+                        type: 'checkbox-editor',
+                        mode: 'edit',
+                        path: 'isRequired',
+                        options: {
+                            label: 'Required',
+                            tooltip: 'Required field',
+                        },
+                    },
+                ],
+            },
+        ],
+    },
+];
+//#endregion
+
+//#region ----   Output Types   ----
+var AXMDataSourceOutputType;
+(function (AXMDataSourceOutputType) {
+    AXMDataSourceOutputType["Table"] = "table";
+    AXMDataSourceOutputType["SingleObject"] = "single_object";
+    AXMDataSourceOutputType["Value"] = "value";
+})(AXMDataSourceOutputType || (AXMDataSourceOutputType = {}));
+//#endregion
+//#region ----   Source Types   ----
+var AXMDataSourceType;
+(function (AXMDataSourceType) {
+    AXMDataSourceType["Static"] = "static";
+    AXMDataSourceType["Query"] = "query";
+    // ExternalApi = 'external_api' // TODO: Will be implemented later
+})(AXMDataSourceType || (AXMDataSourceType = {}));
+//#endregion
+
+async function dataSourceEntityFactory() {
+    const i18n = RootConfig.config.i18n;
+    const entityDef = {
+        module: RootConfig.module.name,
+        name: RootConfig.entities.dataSource.name,
+        title: RootConfig.entities.dataSource.title,
+        formats: {
+            individual: RootConfig.entities.dataSource.title,
+            plural: RootConfig.entities.dataSource.titlePlural,
+            searchResult: {
+                title: '{{ title }}',
+                description: RootConfig.module.title,
+            },
+        },
+        plugins: [
+            { name: 'history' },
+            { name: 'lock' },
+            { name: 'compare' },
+            { name: 'category' },
+        ],
+        relatedEntities: [],
+        groups: [
+            {
+                id: 'dataSource',
+                title: RootConfig.entities.dataSource.title,
+            },
+            {
+                id: 'columns',
+                title: `@${RootConfig.config.i18n}:columns`,
+            },
+            {
+                id: 'filters',
+                title: `@${RootConfig.config.i18n}:filters`,
+            },
+            {
+                id: 'samples',
+                title: `@${RootConfig.config.i18n}:samples`,
+            },
+        ],
+        properties: [
+            {
+                name: 'name',
+                title: '@general:terms.common.name',
+                groupId: 'dataSource',
+                schema: {
+                    dataType: 'string',
+                    interface: {
+                        type: AXPWidgetsCatalog.text,
+                    },
+                },
+                validations: [
+                    {
+                        rule: 'required',
+                    },
+                ],
+            },
+            {
+                name: 'title',
+                title: '@general:terms.common.title',
+                groupId: 'dataSource',
+                schema: {
+                    dataType: 'string',
+                    interface: {
+                        type: AXPWidgetsCatalog.text,
+                        options: {},
+                    },
+                },
+                validations: [
+                    {
+                        rule: 'required',
+                    },
+                ],
+                options: {
+                    sort: {
+                        enabled: true,
+                    },
+                    filter: {
+                        advance: {
+                            enabled: true,
+                        },
+                        inline: {
+                            enabled: true,
+                        },
+                    },
+                },
+            },
+            {
+                name: 'columns',
+                title: `@${i18n}:columns`,
+                groupId: 'columns',
+                schema: {
+                    defaultValue: [
+                        {
+                            name: 'name',
+                            title: 'Name',
+                            type: 'text-editor',
+                        },
+                        {
+                            name: 'title',
+                            title: 'Title',
+                            type: 'text-editor',
+                        },
+                    ],
+                    dataType: 'object',
+                    interface: {
+                        type: AXPWidgetsCatalog.repeaterLayout,
+                        children: AXM_COLUMN_DEF_WIDGET,
+                        triggers: [
+                            {
+                                event: "{{ events.context('sourceEntity') }}",
+                                action: `{{ widget.setValue(context.eval('sourceEntity')?.columns); }}`,
+                            },
+                            {
+                                event: "{{ events.context('columns') }}",
+                                action: `{{ console.log(context.eval('columns.*.isTextField')); }}`,
+                            },
+                        ],
+                    },
+                },
+            },
+            {
+                name: 'filters',
+                title: `@${i18n}:filters`,
+                groupId: 'filters',
+                schema: {
+                    defaultValue: {
+                        id: 'root',
+                        type: 'group',
+                        logic: 'and',
+                        filters: []
+                    },
+                    dataType: 'object',
+                    interface: {
+                        type: AXPWidgetsList.Editors.QueryBuilder,
+                        options: {
+                            availableColumns: '{{ context.eval("columns") || [] }}',
+                        },
+                    },
+                },
+            },
+            {
+                name: 'samples',
+                title: `@${i18n}:samples`,
+                groupId: 'samples',
+                schema: {
+                    dataType: 'object',
+                    interface: {
+                        type: AXPWidgetsCatalog.table,
+                        options: {
+                            columns: '{{context.eval("columns"); }}',
+                            defaultRowCount: 2,
+                        },
+                    },
+                },
+                validations: [
+                    {
+                        rule: 'required',
+                    },
+                ],
+            },
+            {
+                name: 'sourceType',
+                title: `@${i18n}:sourceType`,
+                groupId: 'dataSource',
+                schema: {
+                    defaultValue: {
+                        name: 'static',
+                        title: 'Static',
+                    },
+                    dataType: 'string',
+                    interface: {
+                        type: AXPWidgetsCatalog.select,
+                        options: {
+                            valueField: 'name',
+                            textField: 'title',
+                            dataSource: [
+                                // TODO: External API temporarily disabled for upgrade
+                                // {
+                                //   name: 'external_api',
+                                //   title: 'External Api',
+                                // },
+                                {
+                                    name: 'query',
+                                    title: 'Query',
+                                },
+                                {
+                                    name: 'static',
+                                    title: 'Static',
+                                },
+                            ],
+                            multiple: false,
+                        },
+                        triggers: [
+                            {
+                                event: "{{ events.context('sourceType') }}",
+                                action: `{{context.set('columns' , []); context.set('sourceEntity' , null); if(context.eval('sourceType')?.name == 'static') { context.set('columns', [ { name: 'name',title: 'Name',type: { title: 'Text', name: 'text-editor', },},{name: 'title',title: 'Title',type: {title: 'Text',name: 'text-editor',},}, ] );} }}`,
+                            },
+                        ],
+                    },
+                },
+                options: {
+                    sort: {
+                        enabled: true,
+                    },
+                    filter: {
+                        advance: {
+                            enabled: true,
+                        },
+                    },
+                },
+                validations: [
+                    {
+                        rule: 'required',
+                    },
+                ],
+            },
+            {
+                name: 'outputType',
+                title: `@${i18n}:outputType`,
+                groupId: 'dataSource',
+                schema: {
+                    defaultValue: {
+                        name: AXMDataSourceOutputType.Table,
+                        title: 'Table',
+                    },
+                    dataType: 'string',
+                    interface: {
+                        type: AXPWidgetsCatalog.select,
+                        options: {
+                            valueField: 'name',
+                            textField: 'title',
+                            dataSource: [
+                                {
+                                    name: AXMDataSourceOutputType.Table,
+                                    title: 'Table (List of Records)',
+                                },
+                                {
+                                    name: AXMDataSourceOutputType.SingleObject,
+                                    title: 'Single Object',
+                                },
+                                {
+                                    name: AXMDataSourceOutputType.Value,
+                                    title: 'Value (Count/Number)',
+                                },
+                            ],
+                            multiple: false,
+                        },
+                    },
+                },
+                validations: [
+                    {
+                        rule: 'required',
+                    },
+                ],
+                options: {
+                    sort: {
+                        enabled: true,
+                    },
+                    filter: {
+                        advance: {
+                            enabled: true,
+                        },
+                    },
+                },
+            },
+            {
+                name: 'sourceStatic',
+                title: `@${i18n}:sourceStatic`,
+                groupId: 'dataSource',
+                schema: {
+                    dataType: 'string',
+                    interface: {
+                        type: AXPWidgetsCatalog.table,
+                        options: {
+                            visibility: '{{context.eval("sourceType")?.name == "static" }}',
+                            columns: '{{context.eval("columns")}}',
+                            defaultRowCount: 2,
+                        },
+                    },
+                },
+                validations: [
+                // Validation removed: field is now auto-derived from columns flags
+                ],
+            },
+            {
+                name: 'sourceEntity',
+                title: `@${i18n}:sourceEntity`,
+                groupId: 'dataSource',
+                schema: {
+                    dataType: 'string',
+                    interface: {
+                        type: AXPWidgetsCatalog.select,
+                        options: {
+                            visibility: '{{context.eval("sourceType")?.name == "query" }}',
+                            valueField: 'name',
+                            textField: 'title',
+                            dataSource: 'PlatformManagement:ListRegisteredQueries',
+                        },
+                        triggers: [
+                            {
+                                event: "{{ events.context('sourceEntity') }}",
+                                action: `{{ 
+                  var selectedDataSource = context.eval('sourceEntity');
+                  if (selectedDataSource) {
+                    context.set('samples', selectedDataSource.samples);
+                    context.set('columns', selectedDataSource.columns || []);
+                    // Reset filters when data source changes
+                    context.set('filters', {
+                      id: 'root',
+                      type: 'group',
+                      logic: 'and',
+                      filters: []
+                    });
+                  }
+                }}`,
+                            },
+                        ],
+                    },
+                },
+                validations: [
+                // Validation removed: field is now auto-derived from columns flags
+                ],
+            },
+        ],
+        columns: [
+            { name: 'name' },
+            { name: 'title' },
+            { name: 'sourceType' },
+            { name: 'outputType' },
+        ],
+        interfaces: {
+            master: {
+                create: {
+                    sections: [
+                        {
+                            id: 'dataSource',
+                        },
+                        {
+                            id: 'columns',
+                        },
+                        {
+                            id: 'filters',
+                        },
+                        {
+                            id: 'samples',
+                        },
+                    ],
+                    properties: [
+                        {
+                            name: 'name',
+                            layout: {
+                                positions: {
+                                    lg: {
+                                        colSpan: 6,
+                                        order: 1,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'title',
+                            layout: {
+                                positions: {
+                                    lg: {
+                                        colSpan: 6,
+                                        order: 2,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'columns',
+                            layout: {
+                                positions: {
+                                    lg: {
+                                        colSpan: 12,
+                                        order: 5,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'samples',
+                            layout: {
+                                positions: {
+                                    lg: {
+                                        colSpan: 12,
+                                        order: 11,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'sourceType',
+                            layout: {
+                                positions: {
+                                    lg: {
+                                        colSpan: 6,
+                                        order: 3,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'sourceStatic',
+                            layout: {
+                                positions: {
+                                    lg: {
+                                        colSpan: 6,
+                                        order: 4,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'sourceEntity',
+                            layout: {
+                                positions: {
+                                    lg: {
+                                        colSpan: 6,
+                                        order: 4,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'outputType',
+                            layout: {
+                                positions: {
+                                    lg: {
+                                        colSpan: 6,
+                                        order: 5,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'filters',
+                            layout: {
+                                positions: {
+                                    lg: {
+                                        colSpan: 12,
+                                        order: 6,
+                                    },
+                                },
+                            },
+                        },
+                    ],
+                },
+                update: {
+                    sections: [
+                        {
+                            id: 'dataSource',
+                        },
+                        {
+                            id: 'columns',
+                        },
+                        {
+                            id: 'filters',
+                        },
+                        {
+                            id: 'samples',
+                        },
+                    ],
+                    properties: [
+                        {
+                            name: 'name',
+                            layout: {
+                                positions: {
+                                    lg: {
+                                        colSpan: 6,
+                                        order: 1,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'title',
+                            layout: {
+                                positions: {
+                                    lg: {
+                                        colSpan: 6,
+                                        order: 2,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'columns',
+                            layout: {
+                                positions: {
+                                    lg: {
+                                        colSpan: 12,
+                                        order: 5,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'sourceType',
+                            layout: {
+                                positions: {
+                                    lg: {
+                                        colSpan: 6,
+                                        order: 3,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'sourceEntity',
+                            layout: {
+                                positions: {
+                                    lg: {
+                                        colSpan: 12,
+                                        order: 4,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'sourceStatic',
+                            layout: {
+                                positions: {
+                                    lg: {
+                                        colSpan: 12,
+                                        order: 4,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'outputType',
+                            layout: {
+                                positions: {
+                                    lg: {
+                                        colSpan: 6,
+                                        order: 5,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'filters',
+                            layout: {
+                                positions: {
+                                    lg: {
+                                        colSpan: 12,
+                                        order: 6,
+                                    },
+                                },
+                            },
+                        },
+                    ],
+                },
+                single: {
+                    title: '{{title}}',
+                    sections: [
+                        {
+                            id: 'dataSource',
+                        },
+                        {
+                            id: 'columns',
+                        },
+                        {
+                            id: 'filters',
+                        },
+                        {
+                            id: 'samples',
+                        },
+                    ],
+                    properties: [
+                        {
+                            name: 'name',
+                            layout: {
+                                positions: {
+                                    lg: {
+                                        colSpan: 6,
+                                        order: 1,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'title',
+                            layout: {
+                                positions: {
+                                    lg: {
+                                        colSpan: 6,
+                                        order: 2,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'columns',
+                            layout: {
+                                positions: {
+                                    lg: {
+                                        colSpan: 12,
+                                        order: 3,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'sourceType',
+                            layout: {
+                                positions: {
+                                    lg: {
+                                        colSpan: 6,
+                                        order: 4,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'sourceEntity',
+                            layout: {
+                                positions: {
+                                    lg: {
+                                        colSpan: 6,
+                                        order: 5,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'sourceStatic',
+                            layout: {
+                                positions: {
+                                    lg: {
+                                        colSpan: 6,
+                                        order: 5,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'outputType',
+                            layout: {
+                                positions: {
+                                    lg: {
+                                        colSpan: 6,
+                                        order: 6,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'filters',
+                            layout: {
+                                positions: {
+                                    lg: {
+                                        colSpan: 12,
+                                        order: 7,
+                                    },
+                                },
+                            },
+                        },
+                        {
+                            name: 'samples',
+                            layout: {
+                                positions: {
+                                    lg: {
+                                        colSpan: 12,
+                                        order: 10,
+                                    },
+                                },
+                            },
+                        },
+                    ],
+                    actions: [...entityMasterRecordActions()],
+                },
+                list: {
+                    actions: [...entityMasterCrudActions()],
+                    views: [
+                        createAllQueryView({ sorts: [{ name: 'title', dir: 'asc' }] }),
+                        createQueryView('static', `@${i18n}:static`, true, {
+                            conditions: [
+                                {
+                                    name: 'sourceType.name',
+                                    operator: {
+                                        type: 'equal',
+                                    },
+                                    value: 'static',
+                                },
+                            ],
+                        }),
+                        createQueryView('query', `@${i18n}:query`, true, {
+                            conditions: [
+                                {
+                                    name: 'sourceType.name',
+                                    operator: {
+                                        type: 'equal',
+                                    },
+                                    value: 'query',
+                                },
+                            ],
+                        }),
+                    ],
+                },
+            },
+        },
+    };
+    return entityDef;
+}
+
+/**
+ * Generated bundle index. Do not edit.
+ */
+
+export { dataSourceEntityFactory };
+//# sourceMappingURL=acorex-platform-module-data-management-client-contracts-entities-data-source.mjs.map