@izara_project/izara-market-library-service-schemas 1.0.84 → 1.0.86

package/src/reStructure/TemplateData/findData/mainFunction/template.ejs

@@ -1,149 +0,0 @@
-/*
-Copyright (C) 2020 Sven Mason <http://izara.io>
-
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU Affero General Public License as
-published by the Free Software Foundation, either version 3 of the
-License, or (at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU Affero General Public License for more details.
-
-You should have received a copy of the GNU Affero General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
-*/
-
-
-
-import findDataSharedLib from '@izara_project/izara-core-library-find-data';
-import graphSharedLib from '@izara_project/izara-core-library-graph-service';
-import dynamodbSharedLib from '@izara_project/izara-core-library-dynamodb'
-
-import { serviceConfig, identifiersObject as identifierObj } from '@izara_project/izara-core-library-service-schemas';
-
-//(<additionalModule>)
-//(</additionalModule>)
-
-/**
- * triggered from searchResult for each requiredData field per one identifiers
- * @param {Object} _izContext
- * @param {string} fieldName
- * @param {Object} objType
- * @param {Object} identifiers
- * @param {Object} requestProperties
- *
- * @returns {object} description of return value
- */
-
-export default async function findData(
-  _izContext,
-  fieldName,
-  objType,
-  identifiers,
-  requestProperties,
-  callingFlow,
-  //(<additionalParams>)
-  //(</additionalParams>)
-) {
-
-  try {
-
-    _izContext.logger.debug('----- findData event params -----', {
-      fieldName: fieldName,
-      objType: objType,
-      identifiers: identifiers,
-      requestProperties: requestProperties,
-      callingFlow: callingFlow
-    });
-
-    // removeAttributes on expired
-    let removeAttributes = [];
-    //(<removeAttributes>)
-    //(</removeAttributes>)
-
-    // Check/create FindDataMain status
-    let [findDataMainStatus, findDataId, findDataMain] = await findDataSharedLib.checkFindDataMainStatus(
-      _izContext,
-      fieldName,
-      objType,
-      identifiers,
-      requestProperties,
-      callingFlow,
-      removeAttributes
-    );
-    _izContext.logger.debug("result after checkFindDataMainStatus is", {
-      findDataMainStatus: findDataMainStatus,
-      findDataId: findDataId,
-      findDataMain: findDataMain
-    })
-
-    if (findDataMainStatus != "process") {
-      _izContext.logger.debug(`findDataMainStatus status isn't process :${findDataMainStatus}`)
-      return; // stop process
-    };
-
-    let errorsFound = [];
-
-    let standardErrorParams = [
-      _izContext,
-      fieldName,
-      objType,
-      identifiers,
-      requestProperties,
-      null,
-      "error",
-      callingFlow
-    ];
-
-  <% for (let idx = 0; idx < datas.length; idx++) { _%>
-    <% let objectType = datas[idx].objectType _%>
-    if (objType.objectType === <%- JSON.stringify(objectType) %>) {
-      _izContext.logger.debug("objectType: ", objType.objectType)
-
-      <% let fieldNames = datas[idx].fieldNames _%>
-      <% for (let idx = 0; idx < fieldNames.length; idx++) { _%>
-        <% let fieldName = Object.keys(fieldNames[idx])[0] _%>
-        <% let storageDetails = (Object.values(fieldNames[idx])[0]) _%>
-        if (fieldName.fieldName == <%- JSON.stringify(fieldName) %>) {
-          _izContext.logger.debug("fieldName: ", fieldName.fieldName)
-
-          <% Object.entries(storageDetails).map(([storage, details]) => { _%>
-            <% let versionedDataLabel = [] _%>
-            <% if (storage === storageTypeGraph && details.hasOwnProperty("versionedDataLabel")){ versionedDataLabel.push(details.versionedDataLabel) } _%>
-            <% if (storage === storageDynamo){ %><%- include(getByDynamoTemplate, {tableName: details.tableName, fieldName: fieldName, objectType: objectType}) %><% } _%>
-            <% if (storage === storageTypeGraph){ %><%- include(getByGraphTemplate, {graphServerTag: details.graphServerTag, versionedDataLabel: versionedDataLabel, fieldName: fieldName, objectType: objectType, getInIdentifiers: details.getInIdentifiers}) %><% } _%>
-          <% }) _%>
-        }<% if (idx + 1 == fieldNames.length) { %>
-        <%- createAdditionalFieldNamesTag(objectType) %>
-        <% } _%>
-          else <% } _%> {
-          errorsFound.push("unrecognized fieldName")
-          standardErrorParams.push(errorsFound)
-          await findDataSharedLib.completeFindDataMain(...standardErrorParams);
-          return;
-        }
-    } <% if (idx + 1 == datas.length) { %>
-      //(<additionalObjectType>)
-      //(</additionalObjectType>)
-      <% } _%>
-      else<% } %> {
-      errorsFound.push("unrecognized objectType")
-      standardErrorParams.push(errorsFound)
-      await findDataSharedLib.completeFindDataMain(...standardErrorParams);
-      return;
-    }
-
-    return "Function FindData Finish";
-
-  } catch (err) {
-    _izContext.logger.error('error FindDataMain: ', err)
-    throw (err)
-  }
-}
-
-<%_ function createAdditionalFieldNamesTag(objectType) {
-  return `//(<additional${objectType}FieldNames>)
-          //(</additional${objectType}FieldNames>)`
-} _%>

package/src/reStructure/TemplateData/flowSchema/CreateRecordComplete/functionYaml/data.js

@@ -1,129 +0,0 @@
-/*
-Copyright (C) 2020 Sven Mason <http://izara.io>
-
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU Affero General Public License as
-published by the Free Software Foundation, either version 3 of the
-License, or (at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU Affero General Public License for more details.
-
-You should have received a copy of the GNU Affero General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
-*/
-
-import path from 'path';
-import { fileURLToPath } from 'url';
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-import { consts, utils } from '../../../../../MainLibs/index.js';
-
-const {
-  HANDLER,
-  SOURCE_PATH,
-  defaultIamRolePerAction,
-  createIamRole,
-  RESOURCE_CLASSES,
-  SNS_RESOURCE,
-  resourceNames,
-  DYNAMO_RESOURCE,
-  SAVE_FILE_NAME,
-  FUNCTION_NAME,
-  shortNameHandler,
-  SOURCE_GENERATE_IAM_ROLE,
-  FLOW_SCHEMA_EVENT_TYPE
-} = consts;
-const { firstLetterUpperCase: upperCase } = utils;
-
-const templatePath = path.join(__dirname, 'template.ejs');
-/**
- * receive objectSchema
- * create data for WebScoket handler template
- *
- * @param {Object} objectSchema
- * @return {{templatePath, templateData,setting}}
- */
-
-function data(_izContext, flowSchema, srcPath) {
-  return [createSourceParams(_izContext, flowSchema, srcPath)];
-}
-
-function createSourceParams(_izContext, flowSchema, srcPath) {
-  let functionName =
-    upperCase(FUNCTION_NAME.createRecordComplete) +
-    upperCase(flowSchema.flowTag);
-  let handlerType = upperCase(HANDLER.hdrSqs);
-  let additionalResourcePermission = defaultIamRolePerAction();
-  let flowSteps = Object.keys(flowSchema.flowSteps);
-  // let splitFlowSteps = flowSteps[0].split("_")
-  let topicArn;
-  // let serviceTag;
-  for (const event of flowSchema.event) {
-    if (event.includes(FLOW_SCHEMA_EVENT_TYPE.ownTopic)) {
-      topicArn = flowSteps[0];
-    } else {
-      return;
-    }
-  }
-
-  additionalResourcePermission.push(
-    createIamRole(
-      {
-        [RESOURCE_CLASSES.sns]: [SNS_RESOURCE.publish]
-      },
-      [resourceNames(RESOURCE_CLASSES.sns, topicArn)]
-    )
-  );
-
-  additionalResourcePermission.push(
-    createIamRole(
-      {
-        [RESOURCE_CLASSES.dynamoDbTable]: [DYNAMO_RESOURCE.updateItem]
-      },
-      [resourceNames(RESOURCE_CLASSES.dynamoDbTable, 'WebSocketTask')]
-    )
-  );
-  // external lambda role
-  // if (serviceTag) {
-  //   additionalResourcePermission.push(
-  //     createIamRole(
-  //       {
-  //         [RESOURCE_CLASSES.sns]: [SNS_RESOURCE.publish]
-  //       },
-  //       [
-  //         externalResourceYaml(RESOURCE_CLASSES.sns, topicArn, serviceTag)
-  //       ]
-  //     )
-  //   )
-  // }
-  // console.log({ additionalResourcePermission: JSON.stringify(additionalResourcePermission, null, 2) })
-
-  return {
-    templatePath: templatePath,
-    templateData: {
-      resourceLocation: path.join(
-        SOURCE_PATH.resourceLocationCreateRecordComplete,
-        flowSchema.flowTag,
-        'source/'
-      ),
-      functionName,
-      handlerType,
-      additionalResourcePermission,
-      functionNameConfig:
-        upperCase(functionName) + upperCase(shortNameHandler(handlerType)),
-      roleName: SOURCE_GENERATE_IAM_ROLE.CreateRecordComplete
-    },
-    setting: {
-      savePath: path.join(srcPath, SOURCE_PATH.appYaml),
-      saveFileName: upperCase(SAVE_FILE_NAME.flowSchema),
-      fileExtension: '.yml',
-      isAppend: true
-    }
-  };
-}
-
-export default data;

package/src/reStructure/TemplateData/flowSchema/CreateRecordComplete/functionYaml/template.ejs

@@ -1,20 +0,0 @@
-<%_ const join = require('path').join; _%>
-<%- firstLetterUpperCase(functionNameConfig) %>:
-  handler: <%- join(resourceLocation, `${firstLetterUpperCase(functionName)}_${firstLetterUpperCase(handlerType)}.main`)%>
-  name: ${self:custom.iz_resourcePrefix}<%- firstLetterUpperCase(functionName) %><%- firstLetterUpperCase(handlerType) %>
-  #<#<%- functionName %><%- handlerType %>FunctionSetting#>
-  #<#/<%- functionName %><%- handlerType %>FunctionSetting#>
-  role: <%- roleName %>Role
-  events:
-    - sqs:
-        arn: arn:aws:sqs:${self:custom.iz_region}:${self:custom.iz_accountId}:${self:custom.iz_resourcePrefix}<%- functionName %>
-        batchSize: 10
-        filterPatterns: #**** need to update serverless framework upper v.2.69.1
-          - body: {"MessageAttributes":{"callingFlow":{"Value":["${self:custom.iz_resourcePrefix}<%- functionName %>"]}}} # functionName of callingFlow
-          - body: {"MessageAttributes":{"callingFlow":{"Value":[{"exists":false}]}}}
-<%_ function firstLetterUpperCase(text){
-  return text.charAt(0).toUpperCase() + text.slice(1)
-} _%>
-<%_ function firstLetterLowerCase(str) {
-  return str.charAt(0).toLowerCase() + str.slice(1)
-} _%>

package/src/reStructure/TemplateData/flowSchema/CreateRecordComplete/handler/data.js

@@ -1,68 +0,0 @@
-/*
-Copyright (C) 2020 Sven Mason <http://izara.io>
-
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU Affero General Public License as
-published by the Free Software Foundation, either version 3 of the
-License, or (at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU Affero General Public License for more details.
-
-You should have received a copy of the GNU Affero General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
-*/
-
-import path from 'path';
-import { fileURLToPath } from 'url';
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-import { consts, utils } from '../../../../../MainLibs/index.js';
-const { SOURCE_PATH, FUNCTION_NAME, HANDLER } = consts;
-const { firstLetterLowerCase: lowerCase, firstLetterUpperCase: upperCase } =
-  utils;
-const templatePath = path.join(__dirname, 'template.ejs');
-
-/**
- * receive objectSchema
- * create data for WebScoket handler template
- *
- * @param {Object} objectSchema
- * @return {{templatePath, templateData,setting}}
- */
-
-function data(_izContext, flowSchema, srcPath) {
-  return [createParamsForCreateSource(_izContext, flowSchema, srcPath)];
-}
-
-function createParamsForCreateSource(_izContext, flowSchema, srcPath) {
-  let functionName = upperCase(FUNCTION_NAME.createRecordComplete);
-  let handlerType = upperCase(HANDLER.hdrSqs);
-  let queueName =
-    upperCase(FUNCTION_NAME.createRecordComplete) +
-    upperCase(flowSchema.flowTag) +
-    upperCase(HANDLER.hdrSqs);
-  return {
-    templatePath: templatePath,
-    templateData: {
-      functionName,
-      handlerType,
-      queueName
-    },
-    setting: {
-      savePath: path.join(
-        srcPath,
-        SOURCE_PATH.createRecordComplete,
-        flowSchema.flowTag,
-        'source/'
-      ),
-      saveFileName: `${functionName}_${handlerType}`,
-      fileExtension: '.js',
-      isAppend: false
-    }
-  };
-}
-export default data;

package/src/reStructure/TemplateData/flowSchema/CreateRecordComplete/handler/template.ejs

@@ -1,84 +0,0 @@
-/*
-Copyright (C) 2020 Sven Mason <http://izara.io>
-
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU Affero General Public License as
-published by the Free Software Foundation, either version 3 of the
-License, or (at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU Affero General Public License for more details.
-
-You should have received a copy of the GNU Affero General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
-*/
-
-
-
-// const AWS = require('aws-sdk');
-// const sqs = new AWS.SQS({ apiVersion: '2012-11-05' });
-
-import { middlewareHandler as middleware } from "@izara_project/izara-middleware";
-import { recordHandlerSharedLib } from "@izara_project/izara-core-library-record-handler";
-import Logger from '@izara_project/izara-core-library-logger';
-
-import FlowSchemaOwnTopicEndpoint from './FlowSchemaOwnTopicEndpoint_Main.js';
-
-// validate event properties in body.Message of sqs event
-let perRecordsValidatorSchema = {}
-middleware.setValidatorSchema(recordHandlerSharedLib.baseValidatorSchema());
-
-module.exports.main = middleware.wrap(async (event, context, callback) => {
-
-  try {
-
-    let recordPromises = [];
-
-    // loop each record and send to mainFunction
-    await Promise.all(event.Records.map(async record => { // promise.all for map() function
-
-      let passOnProperties = []
-      record._izContext.logger.debug('record ReceiveMsgOutHdrSqs', record);
-
-      //validate message (and MessageAttributes)
-      await recordHandlerSharedLib.validateRecord(
-        record, // one record will send to mainFunction
-        "<%- queueName %>", // queue name that need to retry or send to dlq
-        perRecordsValidatorSchema, // schema for record.Message
-        // messageAttributeValidatorSchema   // ----- for msgAttr default is null -> do not send this parameter if not want to validate msgAtt
-      );
-
-      // add argument (to invoke lambda) to passOnProperties[]
-      passOnProperties.push(record.body.Message)
-      record._izContext.logger.debug('passOnProperties in handler', passOnProperties);
-
-      // call recordHandlerSharedLib.recordHandler with 3 parameters and return promise(resolve)
-      let recordPromise = recordHandlerSharedLib.recordHandler(
-        record, // one record will send to mainFunction
-        <% - functionName %>, // mainFunction that need to invoke.
-        "<%- queueName %>", // queue name that need to retry or send to dlq
-        passOnProperties, // all parameters that mainFunction needed.
-      );
-      record._izContext.logger.debug('after recordPromise in handler');
-      recordPromises.push(recordPromise); // push promise to recordPromises
-    }))
-
-    Logger.debug('before Promise.all(recordPromises) in handler');
-    try {
-      // --- main await all promises
-      await Promise.all(recordPromises); // await all promises
-
-      return event.Records // return all for local testing
-
-    } catch {
-      Logger.debug('Promise.all(recordPromises) in handler threw error (at least one record did no resolve)');
-    }
-    Logger.debug('after Promise.all(recordPromises) in handler');
-
-  } catch (err) {
-    Logger.error('Unhandled Error, LambdaFunctionHdrSqs: ', err);
-    throw (err);
-  }
-});

package/src/reStructure/TemplateData/flowSchema/CreateRecordComplete/mainFunction/data.js

@@ -1,71 +0,0 @@
-/*
-Copyright (C) 2020 Sven Mason <http://izara.io>
-
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU Affero General Public License as
-published by the Free Software Foundation, either version 3 of the
-License, or (at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU Affero General Public License for more details.
-
-You should have received a copy of the GNU Affero General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
-*/
-
-import path from 'path';
-import { fileURLToPath } from 'url';
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-import { consts, utils } from '../../../../../MainLibs/index.js';
-
-const { SOURCE_PATH, FUNCTION_NAME } = consts;
-
-const { firstLetterLowerCase: lowerCase, firstLetterUpperCase: upperCase } =
-  utils;
-const templatePath = path.join(__dirname, 'template.ejs');
-
-/**
- * receive objectSchema
- * create data for WebScoket handler template
- *
- * @param {Object} objectSchema
- * @return {{templatePath, templateData,setting}}
- */
-
-function data(_izContext, flowSchema, srcPath) {
-  return [createParamsForCreateSource(_izContext, flowSchema, srcPath)];
-}
-
-function createParamsForCreateSource(_izContext, flowSchema, srcPath) {
-  let functionName = upperCase(FUNCTION_NAME.createRecordComplete);
-  let flowSteps = Object.keys(flowSchema.flowSteps);
-  let splitFlowSteps = flowSteps[0].split('_');
-
-  let topicArn = splitFlowSteps[2] + '_' + splitFlowSteps[3];
-  let serviceTag = splitFlowSteps[0];
-  // serviceTag_stage_TopicName_In/Out
-  return {
-    templatePath: templatePath,
-    templateData: {
-      topicArn,
-      serviceTag
-    },
-    setting: {
-      savePath: path.join(
-        srcPath,
-        SOURCE_PATH.createRecordComplete,
-        flowSchema.flowTag,
-        'source/'
-      ),
-      saveFileName: `${functionName}_Main`,
-      fileExtension: '.js',
-      isAppend: false
-    }
-  };
-}
-
-export default data;

package/src/reStructure/TemplateData/flowSchema/CreateRecordComplete/mainFunction/template.ejs

@@ -1,118 +0,0 @@
-/*
-Copyright (C) 2020 Sven Mason <http: //izara.io>
-
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU Affero General Public License as
-published by the Free Software Foundation, either version 3 of the
-License, or (at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-GNU Affero General Public License for more details.
-
-You should have received a copy of the GNU Affero General Public License
-along with this program. If not, see
-<http: //www.gnu.org/licenses />.
-*/
-
-
-
-import { getObjectSchema } from '@izara_project/izara-core-library-service-schemas';
-
-import dynamodbSharedLib from '@izara_project/izara-core-library-dynamodb';
-import lambdaSharedLib from '@izara_project/izara-core-library-lambda';
-
-import { NoRetryError } from '@izara_project/izara-core-library-core';
-
-/**
- * description of function.
- * @param {Object} _izContext
- * @param {CorrelationIds} _izContext.correlationIds - property of _izContext
- * @param {Logger} _izContext.logger - property of _izContext
- * @param {Object} requestParams - request params
- * @param {Object} requestParams.identifiers - identifiers for get data
- * @param {Object} requestParams.additionalRequest - additionalRequest
- *
- * @returns {object} description of return value
- */
-export default async function <% - functionMain %> (
-  _izContext,
-  requestParams,
-  callingFlowConfig = {},
-  //(<additionalParams>)
-  //(</additionalParams>)
-) {
-  try {
-    _izContext.logger.debug("WebSocketInvoke _izContext", _izContext)
-    _izContext.logger.debug("WebSocketInvoke requestParams", requestParams)
-    _izContext.logger.debug("WebSocketInvoke callingFlowConfig", callingFlowConfig)
-
-    const connectionId = requestContext.connectionId;
-    let correlationId = _izContext.correlationIds.get(consts.X_CORRELATION_ID);
-
-    const getRegisterRecords = await dynamodbSharedLib.getItem(
-      _izContext,
-      await dynamodbSharedLib.tableName(_izContext, "RegisterRecords"),
-      {
-        taskKey: correlationId,
-        connectionId: connectionId,
-      }
-    );
-    _izContext.logger.debug("getRegisterRecords", getRegisterRecords)
-    if (!getRegisterRecords) {
-      throw new NoRetryError(`connectionId not found ${connectionId}`)
-    }
-
-    const flowType = getRegisterRecords.flowType;
-    const flowTag = flowType.split('_')[0];
-    const getFlowSchema = await getObjectSchema.getFlowSchemaS3WithCache(_izContext, {
-      flowTag: flowTag,
-      serviceTag: process.env.iz_serviceTag
-    })
-    _izContext.logger.debug("getFlowSchema", getFlowSchema)
-    if (!getFlowSchema) {
-      throw new NoRetryError(`flowTag not found ${flowTag}`)
-    }
-
-    switch (flowSchema.statusType) {
-      case "statusField":
-        let payload = {
-          identifiers: requestParams.identifiers,
-          objectType: flowSchema.objType.objectType
-        }
-        let result = await externalRequest.lambda.invokeSync(
-          _izContext,
-          await lambdaSharedLib.lambdaFunctionName(_izContext, "GetHdrInv", flowSchema.objType.serviceTag),
-          payload
-        )
-        if (!result) {
-          throw new NoRetryError(`statusField not found ${requestParams.identifiers}`)
-        }
-        return result
-      case "storedCache":
-        // if statusType=storedCache then query storedCache > post message to client -> remove connectionId if status = error || complete
-        const getStoredCache = await dynamodbSharedLib.getItem(
-          _izContext,
-          await dynamodbSharedLib.tableName(_izContext, flowSchema.flowTag + "Main"),
-          {
-            taskKey: requestParams.identifiers,
-            connectionId: requestParams.connectionId
-          }
-        )
-        if (!getStoredCache) {
-          throw new NoRetryError(`storedCache not found ${requestParams.identifiers}`)
-        }
-        return getStoredCache
-      case "none":
-        // if statusType=none -> post message to client ---- not remove connectionId when post message, can remove connectionId when cannot use connectionId only(user disconnect)
-        break
-      default:
-        throw new NoRetryError(`statusType not found ${flowSchema.statusType}`)
-    }
-
-  } catch (err) {
-    _izContext.logger.error('error WebSocketInvoke: ', err)
-    throw (err)
-  }
-}