@izara_project/izara-core-library-service-schemas 1.0.74 → 1.0.75

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@izara_project/izara-core-library-service-schemas",
-  "version": "1.0.74",
+  "version": "1.0.75",
   "description": "Schemas for the service and objects it controls",
   "main": "index.js",
   "scripts": {
@@ -14,22 +14,22 @@
   "license": "AGPL-3.0-or-later",
   "homepage": "https://bitbucket.org/izara-core-libraries/izara-core-library-service-schemas/src/master/README.md",
   "devDependencies": {
-    "jest": "^30.0.3"
+    "jest": "^30.0.4"
   },
   "jest": {
     "testEnvironment": "node"
   },
   "dependencies": {
+    "@aws-sdk/client-api-gateway": "^3.840.0",
     "@aws-sdk/client-lambda": "^3.840.0",
-    "@aws-sdk/client-s3": "^3.840.0",
+    "@aws-sdk/client-s3": "^3.842.0",
     "@aws-sdk/crc64-nvme-crt": "^3.840.0",
-    "@aws-sdk/client-api-gateway": "^3.840.0",
     "@izara_project/izara-core-library-core": "^1.0.19",
     "@izara_project/izara-core-library-external-request": "^1.0.20",
     "@izara_project/izara-core-library-lambda": "^1.0.4",
     "@izara_project/izara-core-library-logger": "^1.0.7",
     "@izara_project/izara-shared-core": "^1.0.2",
-    "@izara_project/izara-shared-service-schemas": "^1.0.20",
+    "@izara_project/izara-shared-service-schemas": "^1.0.21",
     "glob": "^11.0.3",
     "lodash": "^4.17.21",
     "object-hash": "^3.0.0",

package/src/Consts.js

@@ -297,13 +297,16 @@ function createValidationFieldNameForEachType(type, validation) {
   }[type]
 }
 
-function flowSchemaPathS3(_izContext, flowType) {
-  validateFlowType(flowType);
-  return `${PREFIX_PATH_S3.perServiceSchemas}/${flowType.serviceTag}/FlowSchema/${flowType.flowTag}.json`
-}
+// function flowSchemaPathS3(_izContext, flowType) {
+//   validateFlowType(flowType);
+//   return `${PREFIX_PATH_S3.perServiceSchemas}/${flowType.serviceTag}/FlowSchema/${flowType.flowTag}.json`
+// }
 
 function getEndpointPerObjectType(_izContext, objType) {
-  validateObjType(objType);
+  let validateObjTypeResult = validateObjType(objType);
+  if (validateObjTypeResult.errorsFound.length > 0) {
+    throw new NoRetryError(`function flowSchemaPathS3: invalid flowType ${flowType.name} - ${validateFlowTypeResult.errorsFound.join(", ")}`);
+  }
   return `${PREFIX_PATH_S3.perServiceSchemas}/${objType.serviceTag}/FrontEnd/Endpoint/Endpoint_Get_${objType.objectType}.json`
 }
 

package/src/GetObjectSchema.js

@@ -36,7 +36,9 @@ const {
   getObjectRelationship: getObjectRelationshipShared,
   getRequiredOnCreateLinks: getRequiredOnCreateLinksShared,
   getLinkConfigByLinkTypeId: getLinkConfigByLinkTypeIdShared,
-  getObjTypeHierarchy: getObjTypeHierarchyShared
+  getObjTypeHierarchy: getObjTypeHierarchyShared,
+  getObjectSchemaForCreate: getObjectSchemaForCreateShared,
+  getObjectSchemaForUpdate: getObjectSchemaForUpdateShared,
 } = sharedServiceSchema.getObjectSchema;
 const { validateObjType, validateFlowType } = sharedServiceSchema.validateObjType;
 const {
@@ -1124,6 +1126,14 @@ const getObjTypeHierarchyWithCache = inMemoryCacheLib(
   }
 )
 
+async function getObjectSchemaForCreate(_izContext, objType) {
+  return await getObjectSchemaForCreateShared(getSchemaByNameWithCache, objType)
+}
+
+async function getObjectSchemaForUpdate(_izContext, objType) {
+  return await getObjectSchemaForUpdateShared(getSchemaByNameWithCache, objType)
+}
+
 module.exports = {
   // getObjectTypes,
   getDataFromPath,
@@ -1178,7 +1188,10 @@ module.exports = {
   getFlowSchemaS3WithCache,
 
   getObjTypeHierarchy,
-  getObjTypeHierarchyWithCache
+  getObjTypeHierarchyWithCache,
+
+  getObjectSchemaForCreate,
+  getObjectSchemaForUpdate,
 }
 
 

package/src/Utils.js

@@ -35,6 +35,9 @@ const {
     validateObjType,
     validateRelType,
     validateFlowType
+  },
+  reformatObjectSchema: {
+    getUsedFieldNamesOfIdentifiers: getUsedFieldNamesOfIdentifiersShared
   }
 } = require('@izara_project/izara-shared-service-schemas');
 
@@ -106,21 +109,22 @@ function getIdentifierTypeByPriority(_izContext, storageTypes = [], objSchema) {
  * @returns {string[]}                    - array of fieldName from objectSchema.identifiers
  */
 function getUsedFieldNamesOfIdentifiers(_izContext, identifiers, identifierTypes = []) {
-  let identifierFieldNames = [];
-
-  for (let identifier of identifiers) {
-    if (Array.isArray(identifierTypes) && identifierTypes.length && !identifierTypes.includes(identifier.type)) {
-      continue;
-    }
-
-    if (identifier.fieldName) {
-      identifierFieldNames.push(identifier.fieldName);
-    } else if (identifier.fieldNames) {
-      identifierFieldNames = identifierFieldNames.concat(identifier.fieldNames);
-    }
-  }
-
-  return [...new Set(identifierFieldNames)];
+  return getUsedFieldNamesOfIdentifiersShared(identifiers, identifierTypes)
+  // let identifierFieldNames = [];
+
+  // for (let identifier of identifiers) {
+  //   if (Array.isArray(identifierTypes) && identifierTypes.length && !identifierTypes.includes(identifier.type)) {
+  //     continue;
+  //   }
+
+  //   if (identifier.fieldName) {
+  //     identifierFieldNames.push(identifier.fieldName);
+  //   } else if (identifier.fieldNames) {
+  //     identifierFieldNames = identifierFieldNames.concat(identifier.fieldNames);
+  //   }
+  // }
+
+  // return [...new Set(identifierFieldNames)];
 }
 
 

package/src/libs/UploadUseCase.js

@@ -18,7 +18,11 @@ along with this program.If not, see < http://www.gnu.org/licenses/>.
 'use strict';
 
 const { NoRetryError } = require('@izara_project/izara-core-library-core');
-
+const {
+  generateObjectSchemaForCreate: generateObjectSchemaForCreateShared,
+  generateObjectSchemaForUpdate: generateObjectSchemaForUpdateShared,
+  generateObjectSchemaForCombineFieldNames: generateObjectSchemaForCombineFieldNamesShared
+} = require('@izara_project/izara-shared-service-schemas').reformatObjectSchema
 const {
   getUsedFieldNamesOfIdentifiers,
   findLinkByObjType,
@@ -45,44 +49,6 @@ const DEFAULT_REL_ID_SETTING = {
   }
 }
 
-
-// add default versionedData fieldNames when upload
-function defaultVersionedDataFieldNames(_izContext, versionedDataLabel, storageTag) {
-  return {
-    [`versionedDataField_${versionedDataLabel}_versionedDataId`]: {
-      type: "string",
-      generatedField: true,
-      versionedDataLabel: versionedDataLabel,
-      storageResourceTags: [storageTag],
-      requiredOnCreate: false,
-      optionalOnCreate: false,
-      canUpdate: false,
-      validation: {},
-    },
-    [`versionedDataField_${versionedDataLabel}_forMatchedId`]: {
-      type: "string",
-      generatedField: true,
-      versionedDataLabel: versionedDataLabel,
-      storageResourceTags: [storageTag],
-      requiredOnCreate: false,
-      optionalOnCreate: false,
-      canUpdate: false,
-      validation: {},
-    },
-    [`versionedDataField_${versionedDataLabel}_originTimestamp`]: {
-      type: "number",
-      generatedField: true,
-      versionedDataLabel: versionedDataLabel,
-      storageResourceTags: [storageTag],
-      requiredOnCreate: false,
-      optionalOnCreate: false,
-      canUpdate: false,
-      validation: {},
-    },
-  }
-}
-
-
 /**
  * create object schema for create case
  *
@@ -92,55 +58,56 @@ function defaultVersionedDataFieldNames(_izContext, versionedDataLabel, storageT
  */
 function generateObjectSchemaForCreate(_izContext, objSchema) {
 
-  // generate data for case create
-  let initReturnObj = {
-    objectType: objSchema.objectType,
-    fieldNames: {}
-  };
-
-  for (let [fieldName, fieldNameSetting] of Object.entries(objSchema.fieldNames)) {
-
-    if (!fieldNameSetting.requiredOnCreate && !fieldNameSetting.optionalOnCreate) {
-      continue;
-    }
-
-    if (!initReturnObj.fieldNames.hasOwnProperty(fieldName)) {
-      initReturnObj.fieldNames[fieldName] = {}
-    }
-
-    initReturnObj.fieldNames[fieldName].type = fieldNameSetting.type;
-    initReturnObj.fieldNames[fieldName].validation = fieldNameSetting.validation || {};
-    initReturnObj.fieldNames[fieldName].requiredOnCreate = (fieldNameSetting.requiredOnCreate === true) ? true : false;
-    initReturnObj.fieldNames[fieldName].optionalOnCreate = (fieldNameSetting.optionalOnCreate === true) ? true : false;
-  }
-
-  // add fieldNames from versionedData
-  if (objSchema.addOnDataStructure?.length) {
-    for (let addOn of objSchema.addOnDataStructure) {
-      if (addOn.type === "versionedData") {
-        for (let [versionedFieldName, fieldNameData] of Object.entries(addOn.fieldNames)) {
-
-          if (!fieldNameData.requiredOnCreate && !fieldNameData.optionalOnCreate) {
-            continue;
-          }
-
-          Object.assign(
-            initReturnObj.fieldNames,
-            {
-              [versionedFieldName]: {
-                type: fieldNameData.type,
-                validation: fieldNameData.validation || {},
-                requiredOnCreate: fieldNameData.requiredOnCreate || false,
-                optionalOnCreate: fieldNameData.optionalOnCreate || false,
-              }
-            });
-        }
-      }
-    }
-  }
-
-
-  return initReturnObj;
+  return generateObjectSchemaForCreateShared(objSchema)
+  // // generate data for case create
+  // let initReturnObj = {
+  //   objectType: objSchema.objectType,
+  //   fieldNames: {}
+  // };
+
+  // for (let [fieldName, fieldNameSetting] of Object.entries(objSchema.fieldNames)) {
+
+  //   if (!fieldNameSetting.requiredOnCreate && !fieldNameSetting.optionalOnCreate) {
+  //     continue;
+  //   }
+
+  //   if (!initReturnObj.fieldNames.hasOwnProperty(fieldName)) {
+  //     initReturnObj.fieldNames[fieldName] = {}
+  //   }
+
+  //   initReturnObj.fieldNames[fieldName].type = fieldNameSetting.type;
+  //   initReturnObj.fieldNames[fieldName].validation = fieldNameSetting.validation || {};
+  //   initReturnObj.fieldNames[fieldName].requiredOnCreate = (fieldNameSetting.requiredOnCreate === true) ? true : false;
+  //   initReturnObj.fieldNames[fieldName].optionalOnCreate = (fieldNameSetting.optionalOnCreate === true) ? true : false;
+  // }
+
+  // // add fieldNames from versionedData
+  // if (objSchema.addOnDataStructure?.length) {
+  //   for (let addOn of objSchema.addOnDataStructure) {
+  //     if (addOn.type === "versionedData") {
+  //       for (let [versionedFieldName, fieldNameData] of Object.entries(addOn.fieldNames)) {
+
+  //         if (!fieldNameData.requiredOnCreate && !fieldNameData.optionalOnCreate) {
+  //           continue;
+  //         }
+
+  //         Object.assign(
+  //           initReturnObj.fieldNames,
+  //           {
+  //             [versionedFieldName]: {
+  //               type: fieldNameData.type,
+  //               validation: fieldNameData.validation || {},
+  //               requiredOnCreate: fieldNameData.requiredOnCreate || false,
+  //               optionalOnCreate: fieldNameData.optionalOnCreate || false,
+  //             }
+  //           });
+  //       }
+  //     }
+  //   }
+  // }
+
+
+  // return initReturnObj;
 }
 
 /**
@@ -151,65 +118,67 @@ function generateObjectSchemaForCreate(_izContext, objSchema) {
  * @returns {Object}            - objectSchema that has property for case update
  */
 function generateObjectSchemaForUpdate(_izContext, objSchema) {
-  // generate data for case update
-  let initReturnObj = {
-    objectType: objSchema.objectType,
-    fieldNames: {},
-    identifiers: objSchema.identifiers,
-  };
-
-  if (objSchema.extendObjType) {
-    initReturnObj.extendObjType = objSchema.extendObjType;
-  } else {
-    initReturnObj.identifierFieldNames = getUsedFieldNamesOfIdentifiers(_izContext, objSchema.identifiers);
-  }
-
-  for (let [fieldName, fieldNameSetting] of Object.entries(objSchema.fieldNames)) {
 
-    if (!initReturnObj.fieldNames.hasOwnProperty(fieldName)) {
-      initReturnObj.fieldNames[fieldName] = {}
-    }
-
-    if (fieldNameSetting.canUpdate === true || fieldNameSetting.canUpdate === undefined) {
-      initReturnObj.fieldNames[fieldName].type = fieldNameSetting.type;
-      initReturnObj.fieldNames[fieldName].validation = fieldNameSetting.validation || {};
-      initReturnObj.fieldNames[fieldName].canUpdate = true;
-    } else {
-      initReturnObj.fieldNames[fieldName].type = fieldNameSetting.type;
-    }
-  }
-
-  // add fieldNames from versionedData
-  if (objSchema.addOnDataStructure?.length) {
-    for (let addOn of objSchema.addOnDataStructure) {
-      if (addOn.type === "versionedData") {
-        for (let [versionedFieldName, fieldNameData] of Object.entries(addOn.fieldNames)) {
-
-          if (fieldNameData.canUpdate === true || fieldNameData.canUpdate === undefined) {
-            Object.assign(
-              initReturnObj.fieldNames,
-              {
-                [versionedFieldName]: {
-                  type: fieldNameData.type,
-                  canUpdate: true,
-                  validation: fieldNameData.validation || {},
-                }
-              });
-          } else {
-            Object.assign(
-              initReturnObj.fieldNames,
-              {
-                [versionedFieldName]: {
-                  type: fieldNameData.type,
-                }
-              });
-          }
-        }
-      }
-    }
-  }
-
-  return initReturnObj;
+  return generateObjectSchemaForUpdateShared(objSchema)
+  // // generate data for case update
+  // let initReturnObj = {
+  //   objectType: objSchema.objectType,
+  //   fieldNames: {},
+  //   identifiers: objSchema.identifiers,
+  // };
+
+  // if (objSchema.extendObjType) {
+  //   initReturnObj.extendObjType = objSchema.extendObjType;
+  // } else {
+  //   initReturnObj.identifierFieldNames = getUsedFieldNamesOfIdentifiers(_izContext, objSchema.identifiers);
+  // }
+
+  // for (let [fieldName, fieldNameSetting] of Object.entries(objSchema.fieldNames)) {
+
+  //   if (!initReturnObj.fieldNames.hasOwnProperty(fieldName)) {
+  //     initReturnObj.fieldNames[fieldName] = {}
+  //   }
+
+  //   if (fieldNameSetting.canUpdate === true || fieldNameSetting.canUpdate === undefined) {
+  //     initReturnObj.fieldNames[fieldName].type = fieldNameSetting.type;
+  //     initReturnObj.fieldNames[fieldName].validation = fieldNameSetting.validation || {};
+  //     initReturnObj.fieldNames[fieldName].canUpdate = true;
+  //   } else {
+  //     initReturnObj.fieldNames[fieldName].type = fieldNameSetting.type;
+  //   }
+  // }
+
+  // // add fieldNames from versionedData
+  // if (objSchema.addOnDataStructure?.length) {
+  //   for (let addOn of objSchema.addOnDataStructure) {
+  //     if (addOn.type === "versionedData") {
+  //       for (let [versionedFieldName, fieldNameData] of Object.entries(addOn.fieldNames)) {
+
+  //         if (fieldNameData.canUpdate === true || fieldNameData.canUpdate === undefined) {
+  //           Object.assign(
+  //             initReturnObj.fieldNames,
+  //             {
+  //               [versionedFieldName]: {
+  //                 type: fieldNameData.type,
+  //                 canUpdate: true,
+  //                 validation: fieldNameData.validation || {},
+  //               }
+  //             });
+  //         } else {
+  //           Object.assign(
+  //             initReturnObj.fieldNames,
+  //             {
+  //               [versionedFieldName]: {
+  //                 type: fieldNameData.type,
+  //               }
+  //             });
+  //         }
+  //       }
+  //     }
+  //   }
+  // }
+
+  // return initReturnObj;
 }
 
 
@@ -223,55 +192,57 @@ function generateObjectSchemaForUpdate(_izContext, objSchema) {
  * @returns {Object}            - objectSchema that has property for case update
  */
 function generateObjectSchemaForCombineFieldNames(_izContext, objSchema) {
-  // generate data for case update
-  let initReturnObj = {
-    objectType: objSchema.objectType,
-    fieldNames: objSchema.fieldNames,
-    canDelete: objSchema.canDelete,
-    storageResources: objSchema.storageResources
-  };
-
-  if (objSchema.extendObjType) {
-    initReturnObj.extendObjType = objSchema.extendObjType;
-  }
 
-  if (objSchema.identifiers) {
-    initReturnObj.identifiers = objSchema.identifiers;
-    initReturnObj.identifierFieldNames = getUsedFieldNamesOfIdentifiers(_izContext, objSchema.identifiers);
-  }
-
-  // add fieldNames from versionedData
-  if (objSchema.addOnDataStructure?.length) {
-    let versionedDataLabels = [];
-    // versionedDataField_ceo_versionedDataId
-    for (let addOn of objSchema.addOnDataStructure) {
-      if (addOn.type === "versionedData") {
-        // add default fieldNames of versionedData to main fieldNames
-        Object.assign(
-          initReturnObj.fieldNames,
-          defaultVersionedDataFieldNames(_izContext, addOn.versionedDataLabel, addOn.storageResourceTag)
-        );
-
-        // add each versionedData fieldName to main fieldNames
-        for (let [versionedFieldName, fieldNameData] of Object.entries(addOn.fieldNames)) {
-          Object.assign(initReturnObj.fieldNames, {
-            [versionedFieldName]: {
-              ...fieldNameData,
-              versionedDataLabel: addOn.versionedDataLabel,
-              storageResourceTags: [addOn.storageResourceTag]
-            }
-          });
-        }
-        versionedDataLabels.push(addOn.versionedDataLabel);
-      }
-    }
-
-    if (versionedDataLabels.length) {
-      initReturnObj.versionedDataLabels = versionedDataLabels;
-    }
-  }
-
-  return initReturnObj;
+  return generateObjectSchemaForCombineFieldNamesShared(objSchema)
+  // generate data for case update
+  // let initReturnObj = {
+  //   objectType: objSchema.objectType,
+  //   fieldNames: objSchema.fieldNames,
+  //   canDelete: objSchema.canDelete,
+  //   storageResources: objSchema.storageResources
+  // };
+
+  // if (objSchema.extendObjType) {
+  //   initReturnObj.extendObjType = objSchema.extendObjType;
+  // }
+
+  // if (objSchema.identifiers) {
+  //   initReturnObj.identifiers = objSchema.identifiers;
+  //   initReturnObj.identifierFieldNames = getUsedFieldNamesOfIdentifiers(_izContext, objSchema.identifiers);
+  // }
+
+  // // add fieldNames from versionedData
+  // if (objSchema.addOnDataStructure?.length) {
+  //   let versionedDataLabels = [];
+  //   // versionedDataField_ceo_versionedDataId
+  //   for (let addOn of objSchema.addOnDataStructure) {
+  //     if (addOn.type === "versionedData") {
+  //       // add default fieldNames of versionedData to main fieldNames
+  //       Object.assign(
+  //         initReturnObj.fieldNames,
+  //         defaultVersionedDataFieldNames(_izContext, addOn.versionedDataLabel, addOn.storageResourceTag)
+  //       );
+
+  //       // add each versionedData fieldName to main fieldNames
+  //       for (let [versionedFieldName, fieldNameData] of Object.entries(addOn.fieldNames)) {
+  //         Object.assign(initReturnObj.fieldNames, {
+  //           [versionedFieldName]: {
+  //             ...fieldNameData,
+  //             versionedDataLabel: addOn.versionedDataLabel,
+  //             storageResourceTags: [addOn.storageResourceTag]
+  //           }
+  //         });
+  //       }
+  //       versionedDataLabels.push(addOn.versionedDataLabel);
+  //     }
+  //   }
+
+  //   if (versionedDataLabels.length) {
+  //     initReturnObj.versionedDataLabels = versionedDataLabels;
+  //   }
+  // }
+
+  // return initReturnObj;
 }