@izara_project/izara-core-library-service-schemas 1.0.81 → 1.0.83

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@izara_project/izara-core-library-service-schemas",
-  "version": "1.0.81",
+  "version": "1.0.83",
   "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.4"
+    "jest": "^30.0.5"
   },
   "jest": {
     "testEnvironment": "node"
   },
   "dependencies": {
     "@aws-sdk/client-api-gateway": "^3.848.0",
-    "@aws-sdk/client-lambda": "^3.848.0",
-    "@aws-sdk/client-s3": "^3.848.0",
+    "@aws-sdk/client-lambda": "^3.851.0",
+    "@aws-sdk/client-s3": "^3.850.0",
     "@aws-sdk/crc64-nvme-crt": "^3.848.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.24",
+    "@izara_project/izara-shared-service-schemas": "^1.0.26",
     "glob": "^11.0.3",
     "lodash": "^4.17.21",
     "object-hash": "^3.0.0",

package/src/UploadObjSchema.js

@@ -242,8 +242,7 @@ async function uploadObjectSchemaByUseCase(_izContext, bucketName) {
       uploadObjectToS3(
         _izContext,
         UPLOAD_PATH_S3.lambdaFunctions(_izContext, process.env.iz_serviceTag),
-        lambdaFunctions,
-
+        lambdaFunctions
       )
     );
   }
@@ -253,8 +252,7 @@ async function uploadObjectSchemaByUseCase(_izContext, bucketName) {
     uploadObjectToS3(
       _izContext,
       UPLOAD_PATH_S3.serviceName(_izContext, process.env.iz_serviceTag),
-      { serviceName: process.env.iz_serviceName },
-
+      { serviceName: process.env.iz_serviceName }
     )
   );
 
@@ -272,8 +270,7 @@ async function uploadObjectSchemaByUseCase(_izContext, bucketName) {
             objectType: objSchema.objectType
           }
         ),
-        objSchema,
-
+        objSchema
       )
     );
 
@@ -290,8 +287,7 @@ async function uploadObjectSchemaByUseCase(_izContext, bucketName) {
             objectType: createFieldSchema.objectType
           }
         ),
-        createFieldSchema,
-
+        createFieldSchema
       )
     );
 
@@ -310,8 +306,7 @@ async function uploadObjectSchemaByUseCase(_izContext, bucketName) {
             objectType: createFieldSchema.objectType
           }
         ),
-        updateFieldSchema,
-
+        updateFieldSchema
       )
     );
 
@@ -329,8 +324,7 @@ async function uploadObjectSchemaByUseCase(_izContext, bucketName) {
             objectType: combineFieldNamesObjectSchema.objectType
           }
         ),
-        combineFieldNamesObjectSchema,
-
+        combineFieldNamesObjectSchema
       )
     );
 
@@ -340,8 +334,7 @@ async function uploadObjectSchemaByUseCase(_izContext, bucketName) {
       uploadObjectToS3(
         _izContext,
         UPLOAD_PATH_S3.getEndpointPerObjectType(_izContext, { objectType: objSchema.objectType, serviceTag: process.env.iz_serviceTag }),
-        apiLink,
-
+        apiLink
       )
     )
 
@@ -349,8 +342,7 @@ async function uploadObjectSchemaByUseCase(_izContext, bucketName) {
       uploadObjectToS3(
         _izContext,
         UPLOAD_PATH_S3.getEndpointPerService(process.env.iz_serviceTag),
-        apiLink,
-
+        apiLink
       )
     )
 
@@ -368,8 +360,7 @@ async function uploadObjectSchemaByUseCase(_izContext, bucketName) {
               serviceTag: process.env.iz_serviceTag
             }
           ),
-          existsRefObjectRel,
-
+          existsRefObjectRel
         )
       )
     } else {
@@ -388,8 +379,7 @@ async function uploadObjectSchemaByUseCase(_izContext, bucketName) {
               serviceTag: process.env.iz_serviceTag
             }
           ),
-          await refRelationshipPerObjectSchema(_izContext, objSchema),
-
+          await refRelationshipPerObjectSchema(_izContext, objSchema)
         )
       )
     }
@@ -402,8 +392,7 @@ async function uploadObjectSchemaByUseCase(_izContext, bucketName) {
     uploadObjectToS3(
       _izContext,
       UPLOAD_PATH_S3.objectListAll(_izContext, process.env.iz_serviceTag),
-      foundedObjectTypes,
-
+      foundedObjectTypes
     )
   );
 
@@ -422,12 +411,12 @@ async function uploadObjectSchemaByUseCase(_izContext, bucketName) {
       }
     }
 
-    let serviceTag = objectSchema.extendObjType ? objectSchema.extendObjType.serviceTag : process.env.iz_serviceTag;
+    // let serviceTag = objectSchema.extendObjType ? objectSchema.extendObjType.serviceTag : process.env.iz_serviceTag;
     if (graphServerTags.size) {
       createdBys.push({
         objType: {
           objectType: objectSchema.objectType,
-          serviceTag: serviceTag
+          serviceTag: process.env.iz_serviceTag
         },
         graphServerTags: [...graphServerTags]
       })

package/src/Utils.js

@@ -228,6 +228,10 @@ function validateBasicObjectSchema(_izContext, objectSchema) {
       if (objectSchema.fieldNames[identifierFieldName]?.canUpdate === true) {
         errors.push(`${objectType}.fieldNames.${identifierFieldName}: canUpdate cannot be true because this fieldName is identifier`);
       }
+
+      if (objectSchema.fieldNames[identifierFieldName]?.userCanUpdate === true) {
+        errors.push(`${objectType}.fieldNames.${identifierFieldName}: userCanUpdate cannot be true because this fieldName is identifier`);
+      }
     }
 
     errors.push(...validateFieldNamesWithStorageResources(_izContext, objectSchema))

package/src/ValidatorSchema.js

@@ -20,7 +20,7 @@ along with this program.If not, see < http://www.gnu.org/licenses/>.
 
 const readYamlFile = require('read-yaml-file');
 const lodash = require('lodash')
-const { inMemoryCacheLib, NoRetryError } = require('@izara_project/izara-core-library-core');
+const { inMemoryCacheLib, NoRetryError, consts } = require('@izara_project/izara-core-library-core');
 const Logger = require('@izara_project/izara-core-library-logger');
 const uploadUseCase = require('./libs/UploadUseCase')
 
@@ -89,7 +89,7 @@ async function generateValidatorSchemaTreePerFieldName(_izContext, fieldName, fi
   };
 
 
-  if (fieldNameSetting.fromServiceNameTag && fieldNameSetting.fromObjectType) {
+  if (fieldNameSetting.fromObjType) {
 
     Object.assign(
       validatorTree[fieldName],
@@ -102,10 +102,7 @@ async function generateValidatorSchemaTreePerFieldName(_izContext, fieldName, fi
 
     let childObjectSchema = await getObjSchemaS3WithHierarchy(
       _izContext,
-      {
-        objectType: fieldNameSetting.fromObjectType,
-        serviceTag: fieldNameSetting.fromServiceNameTag
-      }
+      fieldNameSetting.fromObjType
     );
 
     if (!childObjectSchema) {
@@ -466,7 +463,7 @@ async function generateValidatorSchemaForCreate(_izContext, objType, settings =
   // ------- create return validatorSchema -------
   let validatorSchemaForCreate = {
     type: "object",
-    required: ["fieldNames", "objectType"],
+    required: ["fieldNames"],
     properties: {
       fieldNames: {
         additionalProperties: false,
@@ -476,10 +473,6 @@ async function generateValidatorSchemaForCreate(_izContext, objType, settings =
           ...allValidatorSchemaFieldNames
         }
       },
-      objectType: {
-        type: "string",
-        pattern: "^[a-zA-Z0-9_-]+$"
-      },
       additionalParams: {
         type: "object"
       }
@@ -493,6 +486,7 @@ async function generateValidatorSchemaForCreate(_izContext, objType, settings =
   //   Object.assign(validatorSchemaForCreate.properties, { relationships: relationshipValidatorSchemas })
   // }
 
+  _izContext.logger.debug("validatorSchema-create::", validatorSchemaForCreate);
   return validatorSchemaForCreate;
 }
 
@@ -521,18 +515,37 @@ async function generateValidatorSchemaForUpdate(_izContext, objType, settings =
   let identifiersFieldNames = getUsedFieldNamesOfIdentifiers(_izContext, objectSchemas.identifiers, usedIdentifierTypes);
 
   let canUpdateFieldNames = [];
+  let canUpdateProperties = {};
   let usedFieldNames = identifiersFieldNames;
   let versionedDataFieldNames = [];
+
   // collect canUpdate fieldName (all fieldName have CanUpdate setting = true)
   for (let [fieldName, fieldNameSetting] of Object.entries(objectSchemas.fieldNames)) {
-    if (fieldNameSetting.canUpdate === true || fieldNameSetting.canUpdate === undefined) {
-      canUpdateFieldNames.push(fieldName);
-      if (fieldNameSetting.hasOwnProperty("versionedDataLabel")) {
-        versionedDataFieldNames.push(fieldName)
+    if (settings.handler === "ApiGateway") {
+      if (fieldNameSetting.userCanUpdate === true) {
+        canUpdateFieldNames.push(fieldName);
+        canUpdateProperties[fieldName] = {
+          type: fieldNameSetting.type
+        }
+        if (fieldNameSetting.hasOwnProperty("versionedDataLabel")) {
+          versionedDataFieldNames.push(fieldName)
+        }
+      }
+    } else {
+      if (fieldNameSetting.canUpdate === true || fieldNameSetting.canUpdate === undefined) {
+        canUpdateFieldNames.push(fieldName);
+        canUpdateProperties[fieldName] = {
+          type: fieldNameSetting.type,
+        }
+        if (fieldNameSetting.hasOwnProperty("versionedDataLabel")) {
+          versionedDataFieldNames.push(fieldName)
+        }
       }
     }
   }
 
+  _izContext.logger.debug("canUpdate::::", { canUpdateFieldNames, canUpdateProperties });
+
   // collect usedFieldNames
   if (settings?.specificFieldNames) {
     if (settings.specificFieldNames.length) {
@@ -553,13 +566,13 @@ async function generateValidatorSchemaForUpdate(_izContext, objType, settings =
   let defaultFieldNames = usedFieldNames.filter(fieldName => !identifiersFieldNames.includes(fieldName));
 
   _izContext.logger.debug('identifiersFieldNames : ', identifiersFieldNames);
-  _izContext.logger.debug('usedFieldNames : ', usedFieldNames);
+  _izContext.logger.debug('usedFieldNames : ', usedFieldNames); // all fieldName
   _izContext.logger.debug("defaultFieldNames :", defaultFieldNames);
   _izContext.logger.debug("versionedDataFieldNames :", versionedDataFieldNames);
 
   let initialValidatorSchemaForUpdate = {
     type: "object",
-    required: ["objInstanceFull", "objectType"],
+    required: ["objInstanceFull"],
     properties: {
       objectType: {
         type: "string",
@@ -571,21 +584,25 @@ async function generateValidatorSchemaForUpdate(_izContext, objType, settings =
         properties: {
           identifiers: {
             type: "object",
-            ... await filteredFieldNamesOfValidatorSchema(_izContext, objType, identifiersFieldNames, identifiersFieldNames, settings.bucketName)
+            ...await filteredFieldNamesOfValidatorSchema(_izContext, objType, identifiersFieldNames, identifiersFieldNames)
           },
           fields: {
             type: "object",
             additionalProperties: false,
-            required: [],
-            properties: {}
+            // required: [],
+            // properties: {},
+            ...await filteredFieldNamesOfValidatorSchema(_izContext, objType, [], defaultFieldNames)
+
           },
         }
       },
       versionedDataIds: {
         type: "object",
         additionalProperties: false,
-        required: [], // no need to required versionedDataLabel
-        properties: {},
+        // required: [], // no need to required versionedDataLabel
+        // properties: {},
+        ...await filteredFieldNamesOfValidatorSchema(_izContext, objType, [], versionedDataFieldNames)
+
       },
       additionalParams: {
         type: "object"
@@ -612,17 +629,24 @@ async function generateValidatorSchemaForUpdate(_izContext, objType, settings =
     }
   }
 
+  console.debug("versionedDataReturnInFieldsObjInstanceFull::::", versionedDataReturnInFieldsObjInstanceFull);
+  console.debug("initialValidatorSchemaForUpdate:::::", initialValidatorSchemaForUpdate);
+  Object.assign(
+    initialValidatorSchemaForUpdate.properties.objInstanceFull.properties.fields.properties,
+    {
+      ...versionedDataReturnInFieldsObjInstanceFull,
+      ...canUpdateProperties
+    }
+  );
 
-  Object.assign(initialValidatorSchemaForUpdate.properties.objInstanceFull.properties.fields, await filteredFieldNamesOfValidatorSchema(_izContext, objType, [], defaultFieldNames, settings.bucketName))
-  Object.assign(initialValidatorSchemaForUpdate.properties.objInstanceFull.properties.fields.properties, versionedDataReturnInFieldsObjInstanceFull);
-
-  _izContext.logger.debug("validatorSchema", initialValidatorSchemaForUpdate)
-  return initialValidatorSchemaForUpdate
+  _izContext.logger.debug("validatorSchema-update::", initialValidatorSchemaForUpdate);
+  return initialValidatorSchemaForUpdate;
 }
 
 
 
 
+
 /**
  * generate validatorSchema by fieldNames that part of objectSchema.identifiers
  *
@@ -648,12 +672,8 @@ async function generateValidatorSchemaForIdentifier(_izContext, objType, setting
 
   return {
     type: "object",
-    required: ["identifiers", "objectType"],
+    required: ["identifiers"],
     properties: {
-      objectType: {
-        type: "string",
-        pattern: "^[a-zA-Z0-9_-]+$"
-      },
       identifiers: {
         type: "object",
         required: Object.keys(generatedIdentifiersValidatorSchema),
@@ -674,6 +694,7 @@ async function generateValidatorSchemaForIdentifier(_izContext, objType, setting
  * @param {object} objType
  * @param {string[]} requiredFieldNames
  * @param {string[]} usedFieldNames
+ * @param {boolean} required = false
  * @returns
  */
 async function filteredFieldNamesOfValidatorSchema(_izContext, objType, requiredFieldNames, usedFieldNames) {
@@ -688,7 +709,7 @@ async function filteredFieldNamesOfValidatorSchema(_izContext, objType, required
     usedFieldNames
   });
 
-  let allValidatorSchema = await generateValidatorSchemaForExplodedDataWithCache(_izContext, objType, process.env.iz_serviceSchemaBucketName);
+  let allValidatorSchema = await generateValidatorSchemaForExplodedDataWithCache(_izContext, objType);
   _izContext.logger.debug("filteredFieldNamesOfValidatorSchema allValidatorSchema : ", allValidatorSchema)
 
   allValidatorSchema.required = requiredFieldNames;
@@ -698,6 +719,8 @@ async function filteredFieldNamesOfValidatorSchema(_izContext, objType, required
     properties: {}
   }
 
+
+
   // filtered allValidatorSchema depend on usedFieldNames
   for (let validatorFieldName in allValidatorSchema.properties) {
     if (usedFieldNames.includes(validatorFieldName)) {
@@ -824,18 +847,19 @@ const generateValidatorFieldNameWithCache = inMemoryCacheLib(
  */
 async function generateValidatorFieldName(_izContext, fieldName, fieldData) {
 
-  if (fieldData.hasOwnProperty("fromObjectType") || fieldData.hasOwnProperty("fromServiceNameTag")) {
+  if (fieldData.hasOwnProperty("fromObjType")) {
     // validate reference
-    if (!fieldData.hasOwnProperty("fromObjectType") || !fieldData.hasOwnProperty("fromServiceNameTag")) {
+    if (!fieldData.hasOwnProperty("fromObjType")) {
       throw new Error(`Invalid reference fieldName:${fieldName}`);
     }
 
     let objectSchemaChild = await getObjSchemaS3WithHierarchy(
       _izContext,
-      {
-        serviceTag: fieldData.fromServiceNameTag,
-        objectType: fieldData.fromObjectType
-      }
+      // {
+      //   serviceTag: fieldData.fromServiceNameTag,
+      //   objectType: fieldData.fromObjectType
+      // }
+      fieldData.fromObjType
     );
 
     let usedIdentifier = null
@@ -856,12 +880,8 @@ async function generateValidatorFieldName(_izContext, fieldName, fieldData) {
 
     for (let compositeKey of identifierCompositeKeys) {
 
-      if (objectSchemaChild.fieldNames[compositeKey].hasOwnProperty("fromObjectType")
-        || objectSchemaChild.fieldNames[compositeKey].hasOwnProperty("fromServiceNameTag")
-      ) {
-
-        if (!objectSchemaChild.fieldNames[compositeKey].hasOwnProperty("fromObjectType")
-          || !objectSchemaChild.fieldNames[compositeKey].hasOwnProperty("fromServiceNameTag")
+      if (objectSchemaChild.fieldNames[compositeKey].hasOwnProperty("fromObjType")) {
+        if (!objectSchemaChild.fieldNames[compositeKey].hasOwnProperty("fromObjType")
         ) {
           throw new Error(`Invalid reference fieldName:${compositeKey}`);
         }

package/src/libs/DeliminatorTree.js

@@ -49,14 +49,15 @@ async function generateDeliminatorTreePerFieldName(_izContext, fieldName, fieldN
 
   // ------- create tree first -------
 
-  if (fieldNameSetting.fromServiceNameTag && fieldNameSetting.fromObjectType) {
+  if (fieldNameSetting.fromObjType) {
 
     let childObjectSchema = await getObjSchemaS3WithHierarchy(
       _izContext,
-      {
-        objectType: fieldNameSetting.fromObjectType,
-        serviceTag: fieldNameSetting.fromServiceNameTag
-      },
+      // {
+      //   objectType: fieldNameSetting.fromObjectType,
+      //   serviceTag: fieldNameSetting.fromServiceNameTag
+      // },
+      fieldNameSetting.fromObjType,
       process.env.iz_serviceSchemaBucketName
     );
 
@@ -89,10 +90,11 @@ async function generateDeliminatorTreePerFieldName(_izContext, fieldName, fieldN
         _izContext,
         eachKey, // fieldName
         childObjectSchema.fieldNames[eachKey], // fieldName setting
-        {
-          objectType: fieldNameSetting.fromObjectType,
-          serviceTag: fieldNameSetting.fromServiceNameTag
-        },
+        // {
+        //   objectType: fieldNameSetting.fromObjectType,
+        //   serviceTag: fieldNameSetting.fromServiceNameTag
+        // },
+        fieldNameSetting.fromObjType,
         iter
       );
       _izContext.logger.debug("childDeliminator: ", childDeliminator)
@@ -199,9 +201,9 @@ async function generateDeliminatorTreeIdentifier(_izContext, objectSchema) {
 
           // collect deliminatorTree of composite key
           await Promise.all(identifier.fieldNames.map(async (compositeKey) => {
-            let compositeKeyDeliminatortree = await generateDeliminatorTreePerFieldName(_izContext, compositeKey, objectSchema.fieldNames[compositeKey]);
-            _izContext.logger.debug("compositeKeyDeliminatortree each fieldname: ", compositeKeyDeliminatortree);
-            Object.assign(compositeKeysDeliminatorTree, compositeKeyDeliminatortree);
+            let compositeKeyDeliminatorTree = await generateDeliminatorTreePerFieldName(_izContext, compositeKey, objectSchema.fieldNames[compositeKey]);
+            _izContext.logger.debug("compositeKeyDeliminatorTree each fieldname: ", compositeKeyDeliminatorTree);
+            Object.assign(compositeKeysDeliminatorTree, compositeKeyDeliminatorTree);
           }));
 
           // calculate deliminatorTree of identifier

package/src/libs/ExplodedReqParams.js

@@ -122,8 +122,9 @@ function explodeDataField(
  * @param {Object} requestParams
  * @param {Object} objType
  */
-async function explodedDataForCreate(_izContext, requestParams, objectSchema) {
-
+async function explodedDataForCreate(_izContext, requestParams, objectSchema, settings) {
+  _izContext.logger.debug("explodedDataForCreate::", { requestParams, objectSchema });
+  _izContext.logger.debug("settings: ", settings);
   // ------- validate requestParams -------
   let errors = [];
 
@@ -225,10 +226,9 @@ async function explodedDataForCreate(_izContext, requestParams, objectSchema) {
  * @param {Object} requestParams
  * @param {Object} objType
  */
-async function explodedDataForIdentifiers(_izContext, requestParams, objectSchema) {
-  _izContext.logger.debug("explodedDataForIdentifiers: ",
-    { requestParams, objectSchema }
-  );
+async function explodedDataForIdentifiers(_izContext, requestParams, objectSchema, settings) {
+  _izContext.logger.debug("explodedDataForIdentifiers::", { requestParams, objectSchema });
+  _izContext.logger.debug("settings: ", settings);
 
   // ------- manual validate requestParams -------
   let errors = [];
@@ -339,13 +339,10 @@ async function explodedDataForIdentifiers(_izContext, requestParams, objectSchem
   return explodedReqParams;
 }
 
-async function explodedDataForUpdate(_izContext, requestParams, objectSchema) {
+async function explodedDataForUpdate(_izContext, requestParams, objectSchema, settings) {
   //validate requestParams
-  _izContext.logger.debug("explodedDataForUpdate::",
-    {
-      requestParams, objectSchema, settings
-    }
-  )
+  _izContext.logger.debug("explodedDataForUpdate::", { requestParams, objectSchema });
+  _izContext.logger.debug("settings: ", settings);
   let errorsFound = [];
 
   const propertiesTypeForUpdate = {
@@ -465,6 +462,15 @@ async function explodedDataForUpdate(_izContext, requestParams, objectSchema) {
       )
     )
   }
+
+  for (let reqKey in requestParams) {
+    if (reqKey === "fieldNames") {
+      continue;
+    }
+    Object.assign(explodedReqParams, { [reqKey]: requestParams[reqKey] });
+  }
+
+  console.debug("explodedReqParams-update", JSON.stringify(explodedReqParams, null, 2));
   return explodedReqParams
 }