@izara_project/izara-core-generate-service-code 1.0.72 → 1.0.73

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@izara_project/izara-core-generate-service-code",
-  "version": "1.0.72",
+  "version": "1.0.73",
   "description": "Code for locally generating per service files",
   "homepage": "https://bitbucket.org/izara-core-support-services/izara-core-support-services-generate-service-code#readme",
   "repository": {
@@ -26,12 +26,13 @@
     "@izara_project/izara-shared-core": "^1.0.13",
     "ejs": "^6.0.1",
     "js-beautify": "^2.0.3",
+    "ws": "^8.21.2",
     "yaml": "^2.9.0"
   },
   "devDependencies": {
     "@izara_project/izara-core-library-logger": "^1.0.11",
     "@izara_project/izara-core-library-service-schemas": "1.0.161",
-    "@izara_project/izara-shared-service-schemas": "^1.0.69",
+    "@izara_project/izara-shared-service-schemas": "^1.0.70",
     "jest": "^30.4.2",
     "prettier": "^3.9.6",
     "prettier-plugin-ejs": "^1.0.3"

package/src/emit/coreFunction/templates/InitialSetupRunner.ejs

@@ -27,6 +27,8 @@ if (fs.existsSync(configPath)) {
   process.env.iz_accountId = izConfig.iz_accountId || process.env.iz_accountId;
   process.env.iz_serviceTag =
     izConfig.iz_serviceTag || process.env.iz_serviceTag;
+  process.env.iz_serviceSchemaBucketName =
+    izConfig.iz_serviceSchemaBucketName || process.env.iz_serviceSchemaBucketName;
   process.env.iz_resourcePrefix =
     izConfig.iz_resourcePrefix ||
     process.env.iz_resourcePrefix ||
@@ -53,11 +55,11 @@ function _createContext() {
   _izContext.correlationIds = new CorrelationIds();
   _izContext.correlationIds.set(
     consts.BASE_USER_ID,
-    process.env.iz_userId || ''
+    process.env.iz_userId || 'system'
   );
   _izContext.correlationIds.set(
     consts.RESOURCE_USE_USER_ID,
-    process.env.iz_userId || ''
+    process.env.iz_userId || 'system'
   );
   _izContext.logger = Logger;
   return _izContext;

package/src/emit/custom/emitCustomFlowApplicationArtifacts.js

@@ -657,11 +657,28 @@ function stepConfig(flow, step) {
   };
 }
 
-function mapFields(names = [], definitions = {}) {
-  return names.map((name) => ({
-    propertyName: name,
-    ...(definitions?.[name] ?? {})
-  }));
+function mapFields(items = [], definitions = {}) {
+  return items.map((item) => {
+    if (typeof item === 'string') {
+      const def = definitions?.[item] ?? {};
+      return {
+        propertyName: item,
+        required: def.required ?? false,
+        ...def
+      };
+    }
+    if (typeof item === 'object' && item !== null) {
+      const name = item.key ?? item.propertyName;
+      const def = definitions?.[name] ?? {};
+      return {
+        propertyName: name,
+        required: item.required ?? def.required ?? false,
+        ...def,
+        ...item
+      };
+    }
+    return item;
+  });
 }
 
 function isS3Only(flow) {

package/src/emit/custom/templates/triggerCache/CheckTriggerCache_HdrSqs.ejs

@@ -6,33 +6,37 @@ import callingFlowSharedLib from '@izara_project/izara-core-library-calling-flow
 import <%- functionName %> from './<%- functionName %>_Main.js';
 
 let perRecordsValidatorSchema = {
-  <% if (typeof startConfig !== 'undefined' && startConfig !== null && startConfig.properties && startConfig.properties.length > 0) { -%>
+<%_ if (typeof startConfig !== 'undefined' && startConfig !== null && startConfig.properties && startConfig.properties.length > 0) { _%>
   type: 'object',
   properties: {
-    <% startConfig.properties.forEach((prop, index) => { %> <%- prop.propertyName %>: {
+<%_ startConfig.properties.forEach((prop, index) => { _%>
+    <%- /^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(prop.propertyName) ? prop.propertyName : `'${prop.propertyName}'` %>: {
       type: '<%- prop.type || 'string' %>'
-    }
-    <% }) %>
+    }<%- index < startConfig.properties.length - 1 ? ',' : '' %>
+<%_ }) _%>
   },
   required: [<%- startConfig.properties.filter(p => p.required === true).map(p => `'${p.propertyName}'`).join(', ') %>]
-  <% } -%>
+<%_ } _%>
 };
 
-<% if (typeof startConfig !== 'undefined' && startConfig !== null && startConfig.messageAttributes && startConfig.messageAttributes.length > 0) { -%>
+<%_ if (typeof startConfig !== 'undefined' && startConfig !== null && startConfig.messageAttributes && startConfig.messageAttributes.length > 0) { _%>
 let messageAttributeValidatorSchema = {
   type: 'object',
   properties: {
-    <% startConfig.messageAttributes.forEach((prop, index) => { %> <%- prop.propertyName %>: {
+<%_ startConfig.messageAttributes.forEach((prop, index) => { _%>
+    <%- /^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(prop.propertyName) ? prop.propertyName : `'${prop.propertyName}'` %>: {
       type: 'object',
       properties: {
         Type: { type: 'string' },
         Value: { type: '<%- prop.type || 'string' %>' }
       },
       required: ['Type', 'Value']
-    }
-    <% }) %>
+    }<%- index < startConfig.messageAttributes.length - 1 ? ',' : '' %>
+<%_ }) _%>
   },
   required: [<%- startConfig.messageAttributes.filter(p => p.required === true).map(p => `'${p.propertyName}'`).join(', ') %>]
+  //(<messageAttributeValidatorSchema>)
+  //(</messageAttributeValidatorSchema>)
 };
 <% } else { -%>
 let messageAttributeValidatorSchema = null;

package/src/emit/shared/templates/FlowHandler_HdrApi.ejs

@@ -9,16 +9,16 @@ import <%= functionName %> from './<%= mainFileName %>.js';
 //(</optionalRequire>)
 
 const validatorSchema = {
-  //(<validatorSchema>)
-  <% if (typeof startConfig !== 'undefined' && startConfig !== null && startConfig.properties && startConfig.properties.length > 0) { -%>
+<%_ if (typeof startConfig !== 'undefined' && startConfig !== null && startConfig.properties && startConfig.properties.length > 0) { _%>
   type: 'object',
   properties: {
-    <% startConfig.properties.forEach(prop => { -%>
-    <%- prop.propertyName %>: { type: '<%- prop.type || 'string' %>' }
-    <% }) -%>
+<%_ startConfig.properties.forEach((prop, index) => { _%>
+    <%- /^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(prop.propertyName) ? prop.propertyName : `'${prop.propertyName}'` %>: { type: '<%- prop.type || 'string' %>' }<%- index < startConfig.properties.length - 1 ? ',' : '' %>
+<%_ }) _%>
   },
   required: [<%- startConfig.properties.filter(p => p.required === true).map(p => `'${p.propertyName}'`).join(', ') %>]
-  <% } -%>
+<%_ } _%>
+  //(<validatorSchema>)
   //(</validatorSchema>)
 };
 

package/src/emit/shared/templates/FlowHandler_HdrDsq.ejs

@@ -26,39 +26,43 @@ import <%= functionName %> from './<%= mainFileName %>.js';
 
 // validate event properties in body.Message of sqs event
 let perRecordsValidatorSchema = {
-  //(<validatorSchema>)
-  <% if (typeof startConfig !== 'undefined' && startConfig !== null && startConfig.properties && startConfig.properties.length > 0) { -%>
+<%_ if (typeof startConfig !== 'undefined' && startConfig !== null && startConfig.properties && startConfig.properties.length > 0) { _%>
   type: 'object',
   properties: {
-    <% startConfig.properties.forEach((prop, index) => { %> <%- prop.propertyName %>: {
+<%_ startConfig.properties.forEach((prop, index) => { _%>
+    <%- /^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(prop.propertyName) ? prop.propertyName : `'${prop.propertyName}'` %>: {
       type: '<%- prop.type || 'string' %>'
-    }
-    <% }) %>
+    }<%- index < startConfig.properties.length - 1 ? ',' : '' %>
+<%_ }) _%>
   },
   required: [<%- startConfig.properties.filter(p => p.required === true).map(p => `'${p.propertyName}'`).join(', ') %>]
-  <% } -%>
+<%_ } _%>
+  //(<validatorSchema>)
   //(</validatorSchema>)
 };
 
-<% if (typeof startConfig !== 'undefined' && startConfig !== null && startConfig.messageAttributes && startConfig.messageAttributes.length > 0) { -%>
+<%_ if (typeof startConfig !== 'undefined' && startConfig !== null && startConfig.messageAttributes && startConfig.messageAttributes.length > 0) { _%>
 let messageAttributeValidatorSchema = {
   type: 'object',
   properties: {
-    <% startConfig.messageAttributes.forEach((prop, index) => { %> <%- prop.propertyName %>: {
+<%_ startConfig.messageAttributes.forEach((prop, index) => { _%>
+    <%- /^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(prop.propertyName) ? prop.propertyName : `'${prop.propertyName}'` %>: {
       type: 'object',
       properties: {
         Type: { type: 'string' },
         Value: { type: '<%- prop.type || 'string' %>' }
       },
       required: ['Type', 'Value']
-    }
-    <% }) %>
+    }<%- index < startConfig.messageAttributes.length - 1 ? ',' : '' %>
+<%_ }) _%>
   },
   required: [<%- startConfig.messageAttributes.filter(p => p.required === true).map(p => `'${p.propertyName}'`).join(', ') %>]
+  //(<messageAttributeValidatorSchema>)
+  //(</messageAttributeValidatorSchema>)
 };
-<% } else { -%>
+<%_ } else { _%>
 let messageAttributeValidatorSchema = null;
-<% } -%>
+<%_ } _%>
 
 middleware.setValidatorSchema(
   recordHandlerSharedLib.baseValidatorSchema({

package/src/emit/shared/templates/FlowHandler_HdrInv.ejs

@@ -6,16 +6,16 @@ import <%= functionName %> from './<%= mainFileName %>.js';
 //(</optionalRequire>)
 
 const validatorSchema = {
-  //(<validatorSchema>)
-  <% if (typeof startConfig !== 'undefined' && startConfig !== null && startConfig.properties && startConfig.properties.length > 0) { -%>
+<%_ if (typeof startConfig !== 'undefined' && startConfig !== null && startConfig.properties && startConfig.properties.length > 0) { _%>
   type: 'object',
   properties: {
-    <% startConfig.properties.forEach(prop => { -%>
-    <%- prop.propertyName %>: { type: '<%- prop.type || 'string' %>' }
-    <% }) -%>
+<%_ startConfig.properties.forEach((prop, index) => { _%>
+    <%- /^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(prop.propertyName) ? prop.propertyName : `'${prop.propertyName}'` %>: { type: '<%- prop.type || 'string' %>' }<%- index < startConfig.properties.length - 1 ? ',' : '' %>
+<%_ }) _%>
   },
   required: [<%- startConfig.properties.filter(p => p.required === true).map(p => `'${p.propertyName}'`).join(', ') %>]
-  <% } -%>
+<%_ } _%>
+  //(<validatorSchema>)
   //(</validatorSchema>)
 };
 

package/src/emit/shared/templates/FlowHandler_HdrSqs.ejs

@@ -26,39 +26,43 @@ import <%= functionName %> from './<%= mainFileName %>.js';
 
 // validate event properties in body.Message of sqs event
 let perRecordsValidatorSchema = {
-  //(<validatorSchema>)
-  <% if (typeof startConfig !== 'undefined' && startConfig !== null && startConfig.properties && startConfig.properties.length > 0) { -%>
+<%_ if (typeof startConfig !== 'undefined' && startConfig !== null && startConfig.properties && startConfig.properties.length > 0) { _%>
   type: 'object',
   properties: {
-    <% startConfig.properties.forEach((prop, index) => { %> <%- prop.propertyName %>: {
+<%_ startConfig.properties.forEach((prop, index) => { _%>
+    <%- /^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(prop.propertyName) ? prop.propertyName : `'${prop.propertyName}'` %>: {
       type: '<%- prop.type || 'string' %>'
-    }
-    <% }) %>
+    }<%- index < startConfig.properties.length - 1 ? ',' : '' %>
+<%_ }) _%>
   },
   required: [<%- startConfig.properties.filter(p => p.required === true).map(p => `'${p.propertyName}'`).join(', ') %>]
-  <% } -%>
+<%_ } _%>
+  //(<validatorSchema>)
   //(</validatorSchema>)
 };
 
-<% if (typeof startConfig !== 'undefined' && startConfig !== null && startConfig.messageAttributes && startConfig.messageAttributes.length > 0) { -%>
+<%_ if (typeof startConfig !== 'undefined' && startConfig !== null && startConfig.messageAttributes && startConfig.messageAttributes.length > 0) { _%>
 let messageAttributeValidatorSchema = {
   type: 'object',
   properties: {
-    <% startConfig.messageAttributes.forEach((prop, index) => { %> <%- prop.propertyName %>: {
+<%_ startConfig.messageAttributes.forEach((prop, index) => { _%>
+    <%- /^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(prop.propertyName) ? prop.propertyName : `'${prop.propertyName}'` %>: {
       type: 'object',
       properties: {
         Type: { type: 'string' },
         Value: { type: '<%- prop.type || 'string' %>' }
       },
       required: ['Type', 'Value']
-    }
-    <% }) %>
+    }<%- index < startConfig.messageAttributes.length - 1 ? ',' : '' %>
+<%_ }) _%>
   },
   required: [<%- startConfig.messageAttributes.filter(p => p.required === true).map(p => `'${p.propertyName}'`).join(', ') %>]
+  //(<messageAttributeValidatorSchema>)
+  //(</messageAttributeValidatorSchema>)
 };
-<% } else { -%>
+<%_ } else { _%>
 let messageAttributeValidatorSchema = null;
-<% } -%>
+<%_ } _%>
 middleware.setValidatorSchema(recordHandlerSharedLib.baseValidatorSchema());
 
 export const main = middleware.wrap(async (event, context) => {

package/test/customFlowApplicationArtifacts.test.js

@@ -602,3 +602,74 @@ async function createTriggerCacheProject(triggerFlowTypes) {
   );
   return rootPath;
 }
+
+test('supports step-level required overrides in flowSteps properties and messageAttributes', async () => {
+  const rootPath = await mkdtemp(
+    join(tmpdir(), 'generate-service-code-v2-step-required-')
+  );
+  roots.add(rootPath);
+  const schemaRoot = join(rootPath, 'app/src/schemas/FlowSchemas');
+  await mkdir(schemaRoot, { recursive: true });
+
+  await writeFile(
+    join(schemaRoot, 'Reservations.js'),
+    `export default {
+      flowTag: 'Reservations',
+      event: ['ownTopic'],
+      stepProperties: {
+        reservationItems: { propertyName: 'reservationItems', type: 'array' }
+      },
+      stepMessageAttributes: {
+        userId: { propertyName: 'x-correlation-base-user-id', type: 'string' }
+      },
+      flowSteps: [
+        {
+          stepName: 'Start',
+          properties: [{ key: 'reservationItems', required: true }],
+          messageAttributes: [{ key: 'userId', required: true }]
+        },
+        {
+          stepName: 'Complete',
+          event: ['extTopic'],
+          properties: ['reservationItems'],
+          messageAttributes: ['userId']
+        }
+      ]
+    };\n`
+  );
+
+  const result = await generateCustomFlowApplicationArtifacts(rootPath);
+  assert.ok(result);
+
+  const startHdrContent = await readFile(
+    join(
+      rootPath,
+      'app/src/generatedCode/FlowSchemas/Reservations/source/Reservations_HdrSqs.js'
+    ),
+    'utf8'
+  );
+  assert.match(
+    startHdrContent,
+    /perRecordsValidatorSchema = {[\s\S]*required: \['reservationItems'\]/
+  );
+  assert.match(
+    startHdrContent,
+    /messageAttributeValidatorSchema = {[\s\S]*required: \['x-correlation-base-user-id'\]/
+  );
+
+  const completeHdrContent = await readFile(
+    join(
+      rootPath,
+      'app/src/generatedCode/FlowSchemas/Reservations/source/ReservationsComplete_HdrSqs.js'
+    ),
+    'utf8'
+  );
+  assert.match(
+    completeHdrContent,
+    /perRecordsValidatorSchema = {[\s\S]*required: \[\]/
+  );
+  assert.match(
+    completeHdrContent,
+    /messageAttributeValidatorSchema = {[\s\S]*required: \[\]/
+  );
+});