@genesislcap/blank-app-seed 2.8.0 → 2.10.0

package/.genx/configure.js

@@ -1,5 +1,5 @@
 const versions = require('./versions.json');
-const { registerPartials, generateRoute, generateEmptyCsv, formatRouteData } = require('./utils');
+const { registerPartials, generateRoute, generateEmptyCsv, formatRouteData, validateRoute } = require('./utils');
 
 /**
  * Signature is `async (data: inquirer.Answers, utils: SeedConfigurationUtils)`
@@ -14,15 +14,20 @@ module.exports = async (data, utils) => {
 
   registerPartials(utils);
 
-  data.routes
-    .forEach((route) => {
-      if (!route.name) {
-        console.warn('Invalid route - missing name', route);
-        return;
-      }
-      const routeData = formatRouteData(route);
-      generateRoute(routeData, utils);
-    });
+  data.routes = data.routes
+    .filter(validateRoute)
+    .map(formatRouteData);
+
+  const FDC3EventHandlersEnabled  = data.routes.find(route => route.FDC3EventHandlersEnabled);
+  const FDC3ListenersEnabled = data.ui?.fdc3?.channels?.length;
+  data.FDC3 = {
+    includeDependencies: !!(FDC3ListenersEnabled || FDC3EventHandlersEnabled),
+    channels: data.ui?.fdc3?.channels || []
+  };
+
+  data.routes.forEach(route => {
+    generateRoute(route, utils);
+  });
 
   data.csv
     .map(entity => ({

package/.genx/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/blank-app-seed-config",
   "description": "Genesis Blank App Seed Configuration",
-  "version": "2.8.0",
+  "version": "2.10.0",
   "license": "Apache-2.0",
   "genxSeedConfig": {
     "exclude": [

package/.genx/prompts/server.js

@@ -1,16 +1,7 @@
 const {mavenArtifactVersionRegex} = require('./validators');
+const {parseJSONArgument} = require('../utils');
 
-const parsecsv = (inputEntities) => {
-  if (!inputEntities){
-    return [];
-  }
-  try {
-    return JSON.parse(inputEntities);
-  } catch (error) {
-    console.error("Error parsing `csv` parameter as JSON:", error.message);
-    return [];
-  }
-}
+const parsecsv = parseJSONArgument('csv', []);
 
 module.exports = async (inquirer, prevAns = {}) => {
     const {
@@ -44,7 +35,7 @@ module.exports = async (inquirer, prevAns = {}) => {
       {
         name: 'csv',
         type: 'input',
-        message: 'Generate empty CSV for entities? (config in json format)',
+        message: 'Generate empty CSV for entities? (config in JSON format)',
         when: !prevAns.csv,
         default: '[]'
       },

package/.genx/prompts/ui.js

@@ -1,37 +1,38 @@
-const routesInto = () => console.log(`
+const {parseJSONArgument} = require('../utils');
+
+const defaultRoutes = [{ name: 'home' }];
+const parseRoutes = parseJSONArgument('routes', defaultRoutes);
+const routesIntro = () => console.log(`
   Pages to be added to the navigation header
 `);
 
-const defaultRoutes = '[{"name":"home"}]';
+const defaultUI = {};
+const parseUI = parseJSONArgument('ui', defaultUI);
 
 module.exports = async (inquirer, prevAns = {}) => {
-  routesInto();
+  routesIntro();
   const {
     routes = prevAns.routes,
+    ui = prevAns.ui,
   } = await inquirer.prompt([
     {
       name: 'routes',
       type: 'input',
-      message: 'Pages config in json format',
+      message: 'Pages config in JSON format',
       when: !prevAns.routes,
-      default: defaultRoutes,
+      default: JSON.stringify(defaultRoutes),
+    },
+    {
+      name: 'ui',
+      type: 'input',
+      message: 'UI configuration in JSON format',
+      when: !prevAns.ui,
+      default: JSON.stringify(defaultUI),
     },
   ])
 
-  let routesParsed;
-  if (routes) {
-    try {
-      routesParsed = JSON.parse(routes);
-    } catch (error) {
-      console.error("Error parsing `routes` parameter as JSON:", error.message);
-      console.log("Falling back to the default routes value");
-      routesParsed = JSON.parse(defaultRoutes);
-    }
-  } else {
-    routesParsed = JSON.parse(defaultRoutes);
-  }
-
   return {
-    routes: routesParsed,
+    routes: parseRoutes(routes),
+    ui: parseUI(ui),
   };
 };

package/.genx/prompts.js

@@ -13,7 +13,7 @@ module.exports = async (inquirer, prevAns = {}) => {
 
   const {apiHost, enableSSO} = await apiPrompts(inquirer, prevAns)
   const {groupId, applicationVersion, enableDeployPlugin, csv} = await genesisServerPrompts(inquirer, prevAns);
-  const {routes} = await uiPrompts(inquirer, prevAns);
+  const {routes, ui} = await uiPrompts(inquirer, prevAns);
 
   return {
     apiHost,
@@ -23,5 +23,6 @@ module.exports = async (inquirer, prevAns = {}) => {
     applicationVersion,
     enableDeployPlugin,
     csv,
+    ui,
   };
 };

package/.genx/templates/entityManager.hbs

@@ -22,6 +22,11 @@
     {{#if config.deleteEvent}}
     deleteEvent="{{ config.deleteEvent }}"
     {{/if}}
+    {{#if config.gridOptions}}
+    :gridOptions=${() => (
+      {{{config.gridOptions}}}
+    )}
+    {{/if}}
     {{#if config.snapshot}}
     :datasourceConfig=${() => ({isSnapshot: {{ config.snapshot }} })}
     {{/if}}

package/.genx/templates/grid.hbs

@@ -4,9 +4,9 @@
     {{#if config.snapshot}}
     isSnapshot="{{config.snapshot}}"
     {{/if}}
-    {{#if config.deferredGridOptions}}
+    {{#if config.gridOptions}}
     :deferredGridOptions=${() => (
-      {{{config.deferredGridOptions}}}
+      {{{config.gridOptions}}}
     )}
     {{/if}}
   >

package/.genx/templates/gridLayout.hbs

@@ -0,0 +1,30 @@
+<zero-layout-region type="horizontal">
+    <zero-layout-region type="vertical">
+    {{#each route.tiles}}
+        {{#ifEquals @index 0}}
+        <zero-layout-item title="{{../title}}">
+            {{> (lookup ../this 'type') ../this}}
+        </zero-layout-item>
+        {{/ifEquals}}
+        {{#ifEquals @index 1}}
+        <zero-layout-item title="{{../title}}">
+            {{> (lookup ../this 'type') ../this}}
+        </zero-layout-item>
+        {{/ifEquals}}
+    {{/each}}
+    </zero-layout-region>
+    <zero-layout-region type="vertical">
+    {{#each route.tiles}}
+        {{#ifEquals @index 2}}
+        <zero-layout-item title="{{../title}}">
+            {{> (lookup ../this 'type') ../this}}
+        </zero-layout-item>
+        {{/ifEquals}}
+        {{#ifEquals @index 3}}
+        <zero-layout-item title="{{../title}}">
+            {{> (lookup ../this 'type') ../this}}
+        </zero-layout-item>
+        {{/ifEquals}}
+    {{/each}}
+    </zero-layout-region>
+</zero-layout-region>

package/.genx/templates/horizontalLayout.hbs

@@ -0,0 +1,7 @@
+<zero-layout-region>
+    {{#each route.tiles}}
+    <zero-layout-item title="{{this.title}}">
+        {{> (lookup . 'type') }}
+    </zero-layout-item>
+    {{/each}}
+</zero-layout-region>

package/.genx/templates/route.template.hbs

@@ -1,16 +1,13 @@
 import { html } from '@microsoft/fast-element';
+{{#if route.FDC3EventHandlersEnabled}}
+import { sendEventOnChannel } from '../../utils';
+{{/if}}
 import type { {{pascalCase route.name}} } from './{{kebabCase route.name}}';
 
 export const {{pascalCase route.name}}Template = html<{{pascalCase route.name}}>`
   {{#if route.tiles}}
   <zero-layout auto-save-key="{{route.layoutKey}}">
-      <zero-layout-region>
-          {{#each route.tiles}}
-          <zero-layout-item title="{{this.title}}">
-              {{> (lookup . 'type') }}
-          </zero-layout-item>
-          {{/each}}
-      </zero-layout-region>
+     {{> (lookup ./route 'layoutType') }}
   </zero-layout>
   {{else}}
   <!-- insert template code here -->

package/.genx/templates/tabsLayout.hbs

@@ -0,0 +1,7 @@
+<zero-layout-region type="tabs">
+    {{#each route.tiles}}
+    <zero-layout-item title="{{this.title}}">
+        {{> (lookup . 'type') }}
+    </zero-layout-item>
+    {{/each}}
+</zero-layout-region>

package/.genx/utils.js

@@ -8,6 +8,9 @@ const makeDirectory = (directory) => {
 };
 
 const registerPartials = ({ registerPartial }) => {
+  registerPartial('grid-layout', resolve(__dirname, 'templates/gridLayout.hbs'))
+  registerPartial('tabs-layout', resolve(__dirname, 'templates/tabsLayout.hbs'))
+  registerPartial('horizontal-layout', resolve(__dirname, 'templates/horizontalLayout.hbs'))
   registerPartial('smart-form', resolve(__dirname, 'templates/form.hbs'))
   registerPartial('chart', resolve(__dirname, 'templates/chart.hbs'))
   registerPartial('entity-manager', resolve(__dirname, 'templates/entityManager.hbs'))
@@ -34,15 +37,58 @@ const formatJSONValue = (value) => {
   }
 }
 
+const gridOptionsSerializer = (options, pad = '      ') => {
+  if (!options) {
+    return undefined;
+  }
+  try {
+    let output = `{\n`;
+    Object.keys(options).forEach((key) => {
+      const value = options[key];
+      if (value?.type === 'function') {
+        const args =  value.arguments?.map(JSON.stringify).join(', ');
+        output += `${pad}${key}: ${value.name}(${args}),\n`;
+      } else {
+        output += `${pad}${key}: ${formatJSONValue(value)},\n`;
+      }
+    });
+    output += `${pad}}\n`;
+    return output;
+  } catch (e) {
+    return undefined;
+  }
+};
+
+const validateRoute = (route) => {
+  if (!route.name) {
+    console.warn('Invalid route - missing name', route);
+  }
+  return !!route.name;
+}
+
+const getLayoutType = (route) => {
+  if (route?.tiles?.length < 4) {
+    return 'horizontal-layout'
+  } else if (route?.tiles?.length === 4) {
+    return 'grid-layout'
+  } 
+  return 'tabs-layout'
+}
+
 const formatRouteData = (route) => {
   const layoutKey = route?.layoutKey || `${route.name}_${Date.now()}`;
+  const layoutType = route?.layoutType || getLayoutType(route);
+
+  const FDC3ClickCategory = 'fdc3';
+  const FDC3EventHandlersEnabled = !!route.tiles?.find(t => t.config?.gridOptions?.onRowClicked?.category === FDC3ClickCategory);
+
   const tiles = route.tiles?.map(tile => ({
     ...tile,
     config: {
       ...(tile.config || {}),
+      gridOptions: gridOptionsSerializer(tile.config?.gridOptions),
       createFormUiSchema: formatJSONValue(tile.config?.createFormUiSchema),
       updateFormUiSchema: formatJSONValue(tile.config?.updateFormUiSchema),
-      deferredGridOptions: formatJSONValue(tile.config?.deferredGridOptions),
       uischema: formatJSONValue(tile.config?.uischema),
       columns: formatJSONValue(tile.config?.columns)
     }
@@ -50,15 +96,32 @@ const formatRouteData = (route) => {
 
   return {
     ...route,
+    layoutType,
     layoutKey,
-    tiles
+    tiles,
+    FDC3EventHandlersEnabled,
+  }
+};
+
+const parseJSONArgument = (name, defaultValue) =>
+  (value) => {
+    if (!value){
+      return defaultValue;
+    }
+    try {
+      return JSON.parse(value);
+    } catch (error) {
+      console.error(`Error parsing "${name}" parameter as JSON:`, error.message);
+      return defaultValue;
+    }
   }
-}
 
 module.exports = {
   makeDirectory,
   registerPartials,
   generateRoute,
+  validateRoute,
   generateEmptyCsv,
   formatRouteData,
+  parseJSONArgument,
 };

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [2.10.0](https://github.com/genesiscommunitysuccess/blank-app-seed/compare/v2.9.0...v2.10.0) (2024-04-12)
+
+
+### Features
+
+* new layout types GENC-286 (#182) 06a6641
+
+## [2.9.0](https://github.com/genesiscommunitysuccess/blank-app-seed/compare/v2.8.0...v2.9.0) (2024-04-12)
+
+
+### Features
+
+* FDC3 support GENC-224 (#180) ac35e42
+
 ## [2.8.0](https://github.com/genesiscommunitysuccess/blank-app-seed/compare/v2.7.0...v2.8.0) (2024-04-11)
 
 

package/client/package.json

@@ -87,6 +87,9 @@
     "lint-staged": "^12.4.1"
   },
   "dependencies": {
+    {{#if FDC3.includeDependencies}}
+    "@finos/fdc3": "^1.2.0",
+    {{/if}}
     "@genesislcap/foundation-comms": "{{versions.UI}}",
     "@genesislcap/foundation-entity-management": "{{versions.UI}}",
     "@genesislcap/foundation-events": "{{versions.UI}}",

package/client/src/main/main.ts

@@ -11,6 +11,9 @@ import * as Components from '../components';
 import { MainRouterConfig } from '../routes';
 import { Store, StoreEventDetailMap } from '../store';
 import designTokens from '../styles/design-tokens.json';
+{{#if FDC3.channels.length}}
+import { listenToChannel, onFDC3Ready } from '../utils';
+{{/if}}
 import { MainStyles as styles } from './main.styles';
 import { DynamicTemplate as template, LoadingTemplate, MainTemplate } from './main.template';
 
@@ -44,6 +47,9 @@ export class MainApplication extends EventEmitter<StoreEventDetailMap>(FASTEleme
     this.readyStore();
     await this.loadPBCs();
     await this.loadRemotes();
+    {{#if FDC3.channels.length}}
+    onFDC3Ready(this.FDC3ReadyHandler);
+    {{/if}}
     DOM.queueUpdate(() => {
       configureDesignSystem(this.provider, designTokens);
     });
@@ -89,6 +95,18 @@ export class MainApplication extends EventEmitter<StoreEventDetailMap>(FASTEleme
     return this.ready ? MainTemplate : LoadingTemplate;
   }
 
+  {{#if FDC3.channels.length}}
+  FDC3ReadyHandler = () => {
+    {{#each FDC3.channels}}
+    listenToChannel('{{this.name}}', '{{this.type}}', (result) => {
+      console.log('Received FDC3 channel message on: {{this.name}} channel, type: {{this.type}}', result);
+      // TODO: Add your listener logic here
+      // E.g. open a modal or route to specific page: Route.path.push(`[Route name]`);
+    });
+    {{/each}}
+  };
+
+  {{/if}}
   private registerDIDependencies() {
     this.container.register(
       Registration.transient(DefaultRouteRecognizer, DefaultRouteRecognizer),

package/client/src/utils/fdc3.ts

@@ -0,0 +1,62 @@
+{{#if FDC3.includeDependencies}}
+import { getOrCreateChannel, raiseIntent, addIntentListener } from '@finos/fdc3';
+{{/if}}
+export const isFDC3 = (): boolean => !!(window as any).fdc3;
+{{#if FDC3.includeDependencies}}
+
+export const onFDC3Ready = async (FDC3ReadyCb: () => any): Promise<void> => {
+  isFDC3()
+    ? await FDC3ReadyCb()
+    : window.addEventListener('fdc3Ready', async () => {
+        await FDC3ReadyCb();
+      });
+};
+
+export const sendMessageOnChannel = async (
+  channelName: string,
+  type: string,
+  payload: any,
+): Promise<void> => {
+  const channel = await getOrCreateChannel(channelName);
+
+  const m: any = {
+    type,
+    id: payload,
+  };
+
+  await channel.broadcast(m);
+};
+
+export const listenToChannel = async (
+  channelName: string,
+  type: string,
+  callback: (result: any) => void,
+): Promise<void> => {
+  const channel = await getOrCreateChannel(channelName);
+  channel.addContextListener(type, (result) => callback(result));
+};
+
+export const doRaiseIntent = async (intent: string, type: string, context: any): Promise<void> => {
+  const message = {
+    type,
+    id: context,
+  };
+
+  const result = await raiseIntent(intent, message);
+};
+
+export const listenForIntent = async (
+  intent: string,
+  callback: (result: any) => void,
+): Promise<void> => {
+  addIntentListener(intent, (result) => callback(result));
+};
+
+export const sendEventOnChannel = (channelName: string, type: string) => {
+  return async (e: any) => {
+    // check for ag-grid-specific events, fall back to standard events
+    const payload = e.data?.payload || e.detail;
+    sendMessageOnChannel(channelName, type, payload);
+  };
+};
+{{/if}}

package/client/src/utils/index.ts

@@ -1 +1,2 @@
+export * from './fdc3';
 export * from './logger';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/blank-app-seed",
   "description": "Genesis Blank App Seed",
-  "version": "2.8.0",
+  "version": "2.10.0",
   "license": "Apache-2.0",
   "scripts": {
     "release": "semantic-release"