@izara_project/izara-core-generate-service-code 1.0.82 → 1.0.83

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@izara_project/izara-core-generate-service-code",
-  "version": "1.0.82",
+  "version": "1.0.83",
   "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": {

package/src/compile/flowValidator.js

@@ -3,6 +3,29 @@ export function validateFlowSchema(flowSchema) {
     throw new TypeError('flowSchema must be an object');
   }
 
+  if (flowSchema.initiateBy !== undefined) {
+    const validInitiateBy = [
+      'user',
+      'systemWithNoUser',
+      'systemWithUser',
+      'system'
+    ];
+    if (!validInitiateBy.includes(flowSchema.initiateBy)) {
+      throw new Error(
+        `FlowSchema validation error: initiateBy must be one of ${JSON.stringify(validInitiateBy)}, got '${flowSchema.initiateBy}'`
+      );
+    }
+  }
+
+  if (flowSchema.handleObj !== undefined) {
+    const validHandleObj = ['one', 'multi'];
+    if (!validHandleObj.includes(flowSchema.handleObj)) {
+      throw new Error(
+        `FlowSchema validation error: handleObj must be one of ${JSON.stringify(validHandleObj)}, got '${flowSchema.handleObj}'`
+      );
+    }
+  }
+
   const steps = flowSchema.flowSteps;
   if (!Array.isArray(steps) || steps.length === 0) {
     throw new Error(

package/src/compile/loadSchemas.js

@@ -42,6 +42,11 @@ export async function loadLocalSchemaDirectory(project, directoryName) {
     if (Array.isArray(module.default)) {
       loadedSchemas = module.default;
     }
+    loadedSchemas = loadedSchemas.filter(
+      (schema) =>
+        schema && typeof schema === 'object' && Object.keys(schema).length > 0
+    );
+    if (loadedSchemas.length === 0) continue;
 
     if (directoryName === 'FlowSchemas') {
       for (const schema of loadedSchemas) {

package/src/emit/crud/crudActionPlan.js

@@ -31,11 +31,14 @@ export function createCrudActionPlan(
   };
 }
 
+const VALID_CRUD_GENERATED_BY = new Set([
+  'user',
+  'systemWithUser',
+  'systemWithNoUser'
+]);
+
 export function isCrudObject(object) {
-  return (
-    object?.generatedBy === 'userGenerated' ||
-    object?.generatedBy === 'systemGenerated'
-  );
+  return VALID_CRUD_GENERATED_BY.has(object?.generatedBy);
 }
 
 export function hasGraphStorageResource(objects = []) {

package/src/emit/crud/emitDynamicCrudFlowSchemas.js

@@ -103,7 +103,7 @@ function _createDynamicFlow(action, plan, serviceTag = '') {
 
   return {
     flowTag: action,
-    initiateBy: 'system',
+    initiateBy: 'systemWithNoUser',
     handleObj: 'one',
     statusType: 'none',
     event: plan.outputTopic ? ['ownTopic'] : ['lambdaSyncInv', 'lambdaSyncApi'],

package/src/emit/crud/templates/CreateEndpoint_Main.ejs

@@ -82,7 +82,10 @@ export default async function <%- flowTag %>(
 
     // ── Resolve userId / targetId ─────────────────────────────────────────────
     let userId, targetId;
-    if (objectSchema.generatedBy === 'userGenerated') {
+    if (
+      objectSchema.generatedBy === 'user' ||
+      objectSchema.generatedBy === 'systemWithUser'
+    ) {
       userId = _izContext.correlationIds.get(coreConsts.BASE_USER_ID);
       targetId = _izContext.correlationIds.get(coreConsts.TARGET_ID);
       if (!userId) errorsFound.push('Not have userId');
@@ -126,14 +129,34 @@ export default async function <%- flowTag %>(
     );
     _izContext.logger.debug('errorsFound', errorsFound);
 
-    // ── Build field lists ─────────────────────────────────────────────────────
-    const listOfRequiredOnCreate = [];
-    const listOfOptionalOnCreate = [];
+    // ── Resolve fromRequiredOnCreate fields ──────────────────────────────────
+    if (objectSchemas.fieldNames) {
+      if (!requestParams.fieldNames) requestParams.fieldNames = {};
+      for (const [fieldName, val] of Object.entries(objectSchemas.fieldNames)) {
+        if (val.fromRequiredOnCreate && requestParams.fieldNames[fieldName] === undefined) {
+          const fromConfig = val.fromRequiredOnCreate;
+          const sourceField = fromConfig.fieldName || fieldName;
+          if (fromConfig.belongToObjType === true && targetId) {
+            requestParams.fieldNames[fieldName] = targetId;
+          } else if (fromConfig.relType && requestParams.relationships?.length > 0) {
+            const matchedRel = requestParams.relationships.find(
+              (rel) =>
+                rel.relType?.serviceTag === fromConfig.relType.serviceTag &&
+                rel.relType?.relationshipTag === fromConfig.relType.relationshipTag
+            );
+            if (matchedRel?.targetIdentifiers?.[sourceField] !== undefined) {
+              requestParams.fieldNames[fieldName] = matchedRel.targetIdentifiers[sourceField];
+            }
+          }
+        }
+      }
+    }
 
     for (const [key, val] of Object.entries(objectSchemas.fieldNames)) {
       if (
         val.randomOnCreate === true ||
         val.requiredOnCreate === true ||
+        val.fromRequiredOnCreate ||
         val.hashOnCreate?.length
       ) {
         listOfRequiredOnCreate.push(key);
@@ -222,7 +245,7 @@ export default async function <%- flowTag %>(
     }
 
     <%_
-    const rbacObjects = objects.filter(o => (o?.generatedBy === 'userGenerated' || o?.generatedBy === 'systemGenerated') && hasRbacAddOn(o));
+    const rbacObjects = objects.filter(o => isCrudObject(o) && hasRbacAddOn(o));
     const rbacObjectTypes = rbacObjects.map(o => o.objectType);
     const rbacServiceTagMap = {};
     for (const o of rbacObjects) {

package/src/emit/crud/templates/DeleteEndpoint_Main.ejs

@@ -75,7 +75,10 @@ export default async function <%- flowTag %>(
     _izContext.logger.debug('objectSchema', objectSchema);
 
     // ── Resolve userId / targetId ─────────────────────────────────────────────
-    if (objectSchema.generatedBy === 'userGenerated') {
+    if (
+      objectSchema.generatedBy === 'user' ||
+      objectSchema.generatedBy === 'systemWithUser'
+    ) {
       const userId = _izContext.correlationIds.get(coreConsts.BASE_USER_ID);
       const targetId = _izContext.correlationIds.get(coreConsts.TARGET_ID);
       if (!userId) errorsFound.push('Not have userId');
@@ -98,7 +101,7 @@ export default async function <%- flowTag %>(
       );
 
     <%_
-    const rbacObjects = objects.filter(o => (o?.generatedBy === 'userGenerated' || o?.generatedBy === 'systemGenerated') && hasRbacAddOn(o));
+    const rbacObjects = objects.filter(o => isCrudObject(o) && hasRbacAddOn(o));
     const rbacObjectTypes = rbacObjects.map(o => o.objectType);
     const rbacServiceTagMap = {};
     for (const o of rbacObjects) {

package/src/emit/crud/templates/FlowMain_Wbs.ejs

@@ -70,7 +70,10 @@ export default async function <%- typeof functionName !== 'undefined' ? function
 
     _izContext.logger.debug('flowSchema', flowSchema);
 
-    if (flowSchema.initiateBy === 'user') {
+    if (
+      flowSchema.initiateBy === 'user' ||
+      flowSchema.initiateBy === 'systemWithUser'
+    ) {
       _izContext.correlationIds.set(coreConsts.USER_AGENT, 'webSocket');
     }
 

package/src/emit/crud/templates/UpdateEndpoint_Main.ejs

@@ -94,7 +94,7 @@ export default async function <%- flowTag %>(
       );
 
     <%_
-    const rbacObjects = objects.filter(o => (o?.generatedBy === 'userGenerated' || o?.generatedBy === 'systemGenerated') && hasRbacAddOn(o));
+    const rbacObjects = objects.filter(o => isCrudObject(o) && hasRbacAddOn(o));
     const rbacObjectTypes = rbacObjects.map(o => o.objectType);
     const rbacServiceTagMap = {};
     for (const o of rbacObjects) {

package/src/emit/custom/customFlows.js

@@ -23,6 +23,7 @@ export function supportedCustomFlows(flows) {
 }
 
 export function customFlowRoleName(flowTag) {
+  if (!flowTag || typeof flowTag !== 'string') return '';
   return `${upperFirst(flowTag)}Role`;
 }
 
@@ -137,6 +138,7 @@ export function generatedDsqFlows(flows) {
 }
 
 export function upperFirst(value) {
+  if (typeof value !== 'string' || value.length === 0) return '';
   return value[0].toUpperCase() + value.slice(1);
 }
 

package/src/emit/rbac/emitDynamicRbacFlowSchemas.js

@@ -93,7 +93,7 @@ async function _artifact(flowTag, flow) {
 function _createSharedRbacFlow(flowTag, event) {
   return {
     flowTag,
-    initiateBy: 'system',
+    initiateBy: 'systemWithNoUser',
     statusType: 'none',
     event,
     outputTopic: true,
@@ -119,7 +119,7 @@ function _createUserRbacFlow(flowTag, serviceTag, objectType) {
     flowTag,
     objType: { serviceTag, objectType },
     event: ['ownTopic'],
-    initiateBy: 'system',
+    initiateBy: 'systemWithNoUser',
     handleObj: 'one',
     statusType: 'none',
     outputTopic: true,

package/src/emit/relationship/emitDynamicRelationshipFlowSchemas.js

@@ -96,7 +96,7 @@ function createDynamicRelationshipFlow(action) {
 
   return {
     flowTag: action,
-    initiateBy: 'system',
+    initiateBy: 'systemWithNoUser',
     handleObj: 'one',
     statusType: 'none',
     event: outputTopic

package/src/emit/relationship/templates/ChangeRelationship_Main.ejs

@@ -191,8 +191,15 @@ export default async function <%- functionName %>(
             */
             // ? [Fix]: The legacy logic incorrectly blocked "user" from regular execution and allowed non-user values.
             // ? It has been corrected to require changeBy === "user" for normal execution.
-            if (canChangeToRelType.changeBy !== 'user') {
-              errorsFound.push(`CanChangeToRelType changeBy is not user`);
+            const isUserProcess = Boolean(_izContext.correlationIds?.get(consts.BASE_USER_ID));
+            if (isUserProcess) {
+              if (canChangeToRelType.changeBy !== 'user' && canChangeToRelType.changeBy !== 'systemWithUser') {
+                errorsFound.push(`CanChangeToRelType changeBy is not user or systemWithUser`);
+              }
+            } else {
+              if (canChangeToRelType.changeBy !== 'systemWithNoUser' && canChangeToRelType.changeBy !== 'system') {
+                errorsFound.push(`CanChangeToRelType changeBy is not systemWithNoUser`);
+              }
             }
           }
         });

package/src/emit/resource/emitResourceArtifacts.js

@@ -333,7 +333,8 @@ function createResourceState({ objects, relationships, flows }) {
                 (flow) =>
                   (flow?.outputTopic ||
                     (includesEvent(flow, 'ownTopic') &&
-                      flow.initiateBy === 'user')) &&
+                      (flow.initiateBy === 'user' ||
+                        flow.initiateBy === 'systemWithUser'))) &&
                   upperFirst(flow.flowTag) === topic
               ) ||
               (relationships.length > 0 &&
@@ -899,11 +900,14 @@ function keyName(identifier) {
   );
 }
 
+const VALID_CRUD_GENERATED_BY = new Set([
+  'user',
+  'systemWithUser',
+  'systemWithNoUser'
+]);
+
 function isCrudObject(object) {
-  return (
-    object?.generatedBy === 'userGenerated' ||
-    object?.generatedBy === 'systemGenerated'
-  );
+  return VALID_CRUD_GENERATED_BY.has(object?.generatedBy);
 }
 function hasSelfRbacAddOn(object) {
   return (

package/src/emit/system/emitSystemWebSocketArtifacts.js

@@ -125,7 +125,8 @@ export function hasSystemWebSocket(
         (flow.event.includes('s3') ||
           (includeRelationshipOwnTopic &&
             flow.event.includes('ownTopic') &&
-            flow.initiateBy === 'user'))
+            (flow.initiateBy === 'user' ||
+              flow.initiateBy === 'systemWithUser')))
     )
   );
 }

package/src/emit/systemText/emitSystemTextSchemas.js

@@ -177,8 +177,9 @@ export async function emitSystemTextSchemas({
   // Dynamic CRUD flows
   const hasCrudObjects = safeObjects.some(
     (object) =>
-      object?.generatedBy === 'userGenerated' ||
-      object?.generatedBy === 'systemGenerated'
+      object?.generatedBy === 'user' ||
+      object?.generatedBy === 'systemWithUser' ||
+      object?.generatedBy === 'systemWithNoUser'
   );
   if (hasCrudObjects) {
     for (const action of CRUD_ACTIONS) {

package/test/crudApplicationArtifacts.test.js

@@ -280,7 +280,7 @@ test('emits GetRangeHdrApi when an object defines a sortKey identifier', async (
   const rootPath = await createProject(true);
   await writeFile(
     join(rootPath, 'app/src/schemas/ObjectSchemas/Order.js'),
-    "export default { objectType: 'order', generatedBy: 'userGenerated', identifiers: [{ type: 'identifier', fieldName: 'orderId' }, { type: 'sortKey', fieldName: 'createdAt' }], storageResources: { graph: { storageType: 'graph' } } };\n"
+    "export default { objectType: 'order', generatedBy: 'user', identifiers: [{ type: 'identifier', fieldName: 'orderId' }, { type: 'sortKey', fieldName: 'createdAt' }], storageResources: { graph: { storageType: 'graph' } } };\n"
   );
   const result = await generateCrudApplicationArtifacts(rootPath, {
     serviceTag: 'orders'
@@ -352,7 +352,7 @@ async function createProject(withCrudObject) {
   await writeFile(
     join(schemaRoot, 'ObjectSchemas/Order.js'),
     withCrudObject
-      ? "export default { objectType: 'order', generatedBy: 'userGenerated', storageResources: { graph: { storageType: 'graph' } } };\n"
+      ? "export default { objectType: 'order', generatedBy: 'user', storageResources: { graph: { storageType: 'graph' } } };\n"
       : "export default { objectType: 'order' };\n"
   );
   return rootPath;
@@ -368,7 +368,7 @@ async function createRbacProject(withHook = false, withGraph = false) {
   await mkdir(join(schemaRoot, 'FlowSchemas'), { recursive: true });
   await writeFile(
     join(schemaRoot, 'ObjectSchemas/Order.js'),
-    `export default { objectType: 'order', generatedBy: 'userGenerated', belongTo: { serviceTag: 'UserAccount', objectType: 'user' }${withGraph ? ", storageResources: { graph: { storageType: 'graph' } }" : ''} };\n`
+    `export default { objectType: 'order', generatedBy: 'user', belongTo: { serviceTag: 'UserAccount', objectType: 'user' }${withGraph ? ", storageResources: { graph: { storageType: 'graph' } }" : ''} };\n`
   );
   if (withHook) {
     await writeFile(

package/test/dynamicCrudFlowSchemas.test.js

@@ -9,7 +9,7 @@ import { generateDynamicCrudFlowSchemas } from '../src/emit/crud/generateDynamic
 
 test('generates dynamic CRUD schemas from local schema modules', async () => {
   const rootPath = await createProject({
-    generatedBy: 'userGenerated'
+    generatedBy: 'user'
   });
 
   const result = await generateDynamicCrudFlowSchemas(rootPath);
@@ -41,7 +41,7 @@ test('generates dynamic CRUD schemas from local schema modules', async () => {
 
 test('accepts singleton object exports used by existing schema files', async () => {
   const rootPath = await createProject({
-    generatedBy: 'userGenerated',
+    generatedBy: 'user',
     singletonExports: true
   });
 
@@ -57,7 +57,7 @@ test('accepts singleton object exports used by existing schema files', async ()
 });
 
 test('does not generate CRUD schemas without an applicable object', async () => {
-  const rootPath = await createProject({ generatedBy: 'userGenerated' });
+  const rootPath = await createProject({ generatedBy: 'user' });
   await generateDynamicCrudFlowSchemas(rootPath);
   await writeFile(
     join(rootPath, 'app/src/schemas/ObjectSchemas/Order.js'),
@@ -71,7 +71,7 @@ test('does not generate CRUD schemas without an applicable object', async () =>
 });
 
 test('does not allow options to override the rootPath argument', async () => {
-  const rootPath = await createProject({ generatedBy: 'userGenerated' });
+  const rootPath = await createProject({ generatedBy: 'user' });
   const ignoredRootPath = await createProject({ generatedBy: 'external' });
 
   const result = await generateDynamicCrudFlowSchemas(rootPath, {
@@ -101,7 +101,7 @@ test('rejects source modules that do not default-export schema objects or arrays
 
 test('rejects deprecated FlowHook schemas before generating CRUD schemas', async () => {
   const rootPath = await createProject({
-    generatedBy: 'systemGenerated',
+    generatedBy: 'systemWithNoUser',
     flow: createHookFlow(['ownTopic'])
   });
 
@@ -121,7 +121,7 @@ test('generates a direct Complete step for RBAC-only Update flows', async () =>
     join(objectDirectory, 'Order.js'),
     `export default [{
       objectType: 'order',
-      generatedBy: 'userGenerated',
+      generatedBy: 'user',
       belongTo: { serviceTag: 'UserAccount', objectType: 'user' }
     }];\n`
   );
@@ -143,13 +143,13 @@ test('generates a direct Complete step for RBAC-only Update flows', async () =>
 
 test('ignores RBAC for Create even when Graph storage is present', async () => {
   const rootPath = await createProject({
-    generatedBy: 'userGenerated',
+    generatedBy: 'user',
   });
   await writeFile(
     join(rootPath, 'app/src/schemas/ObjectSchemas/Order.js'),
     `export default [{
       objectType: 'order',
-      generatedBy: 'userGenerated',
+      generatedBy: 'user',
       belongTo: { serviceTag: 'UserAccount', objectType: 'user' }
       , storageResources: { graph: { storageType: 'graph' } }
     }];\n`
@@ -173,7 +173,7 @@ test('uses the renamed RBAC callback step when Graph storage is present', async
     join(objectDirectory, 'Order.js'),
     `export default [{
       objectType: 'order',
-      generatedBy: 'userGenerated',
+      generatedBy: 'user',
       belongTo: { serviceTag: 'UserAccount', objectType: 'user' },
       storageResources: { graph: { storageType: 'graph' } }
     }];\n`
@@ -204,7 +204,7 @@ test('chains RbacCallback and Complete for Update with RBAC and Graph', async ()
     join(objectDirectory, 'Order.js'),
     `export default [{
       objectType: 'order',
-      generatedBy: 'userGenerated',
+      generatedBy: 'user',
       belongTo: { serviceTag: 'UserAccount', objectType: 'user' },
       storageResources: { graph: { storageType: 'graph' } }
     }];\n`
@@ -242,7 +242,7 @@ test('omits Complete step when no graph storage resources exist', async () => {
     join(objectDirectory, 'Order.js'),
     `export default [{
       objectType: 'order',
-      generatedBy: 'userGenerated',
+      generatedBy: 'user',
       storageResources: {
         myTable: { storageType: 'dynamoDB', tableName: 'OrderTable' }
       }
@@ -318,3 +318,13 @@ function readGeneratedFile(rootPath, action) {
     'utf8'
   );
 }
+
+test('supports new standard generatedBy values (user, systemWithUser, systemWithNoUser)', async () => {
+  for (const generatedBy of ['user', 'systemWithUser', 'systemWithNoUser']) {
+    const rootPath = await createProject({ generatedBy });
+    await generateDynamicCrudFlowSchemas(rootPath);
+    const create = await readGeneratedFlow(rootPath, 'Create');
+    assert.ok(create, `Create flow should be generated for generatedBy: ${generatedBy}`);
+    assert.deepEqual(create.flowSteps.map((s) => s.stepName), ['Start', 'Complete']);
+  }
+});

package/test/publicApi.test.js

@@ -346,7 +346,7 @@ async function createCrudProject() {
   await mkdir(objectDirectory, { recursive: true });
   await writeFile(
     join(objectDirectory, 'Order.js'),
-    "export default { objectType: 'order', generatedBy: 'userGenerated', storageResources: { graph: { storageType: 'graph' } } };\n"
+    "export default { objectType: 'order', generatedBy: 'user', storageResources: { graph: { storageType: 'graph' } } };\n"
   );
   return rootPath;
 }

package/test/resourceArtifacts.test.js

@@ -250,7 +250,7 @@ test('emits DynamoDB table with number sortKey attribute type when field type is
     join(rootPath, 'app/src/schemas/ObjectSchemas/CartOrder.js'),
     "export default { " +
       "objectType: 'cartOrder', " +
-      "generatedBy: 'userGenerated', " +
+      "generatedBy: 'user', " +
       "fieldNames: { " +
       "  cartId: { type: 'string' }, " +
       "  sortId: { type: 'number' } " +
@@ -329,7 +329,7 @@ async function createProject() {
   );
   await writeFile(
     join(schemas, 'ObjectSchemas/Order.js'),
-    "export default { objectType: 'order', generatedBy: 'userGenerated', addOnDataStructure: [{ type: 'rbac' }], identifiers: [{ type: 'partitionKey', fieldName: 'orderId' }], storageResources: { main: { storageType: 'dynamoDB', tableName: 'Orders' } } };\n"
+    "export default { objectType: 'order', generatedBy: 'user', addOnDataStructure: [{ type: 'rbac' }], identifiers: [{ type: 'partitionKey', fieldName: 'orderId' }], storageResources: { main: { storageType: 'dynamoDB', tableName: 'Orders' } } };\n"
   );
   await writeFile(
     join(schemas, 'RelationshipSchemas/OrderCustomer.js'),

package/test/systemTextSchemas.test.js

@@ -123,7 +123,7 @@ test('generate preserves user hooks inside SystemTextSchemas.js across regenerat
   );
   await writeFile(
     join(rootPath, 'app/src/schemas/ObjectSchemas/Item.js'),
-    "export default { objectType: 'item', fieldNames: { itemId: { type: 'string' } }, generatedBy: 'userGenerated' };\n"
+    "export default { objectType: 'item', fieldNames: { itemId: { type: 'string' } }, generatedBy: 'user' };\n"
   );
 
   // First generate