@izara_project/izara-shared-service-schemas 1.0.78 → 1.0.80

package/index.js

@@ -15,7 +15,7 @@ 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 './src/GetObjectSchema.js';
+import errorSchemas from './src/errorSchemas.js';
 import consts from './src/Consts.js';
 import utils from './src/Utils.js';
 
@@ -24,15 +24,33 @@ import relSchemaLib from './src/libs/RelSchemaLib.js';
 import validateObjType from './src/libs/ValidateObjType.js';
 import reformatObjectSchema from './src/libs/ReformatObjectSchema.js';
 
+import getErrorSchema from './src/getSchemas/GetErrorSchema.js';
+import getFlowSchema from './src/getSchemas/GetFlowSchema.js';
+import getNotificationSchema from './src/getSchemas/GetNotificationSchema.js';
+import getObjectSchema from './src/getSchemas/GetObjectSchema.js';
+import getPluginSchema from './src/getSchemas/GetPluginSchema.js';
+import getRelSchema from './src/getSchemas/GetRelSchema.js';
+import getSystemTextSchema from './src/GetSystemTextSchema.js';
+
 export {
   // ./src
-  getObjectSchema,
+  errorSchemas,
   consts,
   utils,
 
+  // getSchemas
+  getObjectSchema,
+  getErrorSchema,
+  getFlowSchema,
+  getNotificationSchema,
+  getPluginSchema,
+  getRelSchema,
+  getSystemTextSchema,
+
   // ./src/libs
   basicValidatorSchema,
   relSchemaLib,
   validateObjType,
-  reformatObjectSchema
+  reformatObjectSchema,
+
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@izara_project/izara-shared-service-schemas",
-  "version": "1.0.78",
+  "version": "1.0.80",
   "description": "Shared Libraries frontend/backend for Service Schemas",
   "type": "module",
   "main": "index.js",

package/src/Consts.js

@@ -68,7 +68,8 @@ const ALLOW_FIELDNAME_TYPES = Object.keys(FIELDNAME_TYPES);
 
 const PREFIX_PATH_S3 = {
   perServiceSchemas: 'perServiceSchemas',
-  serviceConfig: 'serviceConfig'
+  serviceConfig: 'serviceConfig',
+  plugInSchema: 'plugInSchema'
 };
 
 function objectListAllPathS3(serviceTag) {
@@ -286,21 +287,19 @@ function notificationSchemaPathS3(serviceTag) {
   }
 }
 
-function plugInConfigSchemasPathS3(objType) {
-  const validateObjTypeResult = validateObjType.validateObjType(objType);
-  if (validateObjTypeResult.errorsFound.length > 0) {
-    return {
-      errorsFound: validateObjTypeResult.errorsFound,
+function plugInSchemasPathS3(plugInTag) {
+  if (typeof plugInTag !== 'string') {
+ return {
+      errorsFound: `${plugInTag} not string`,
       result: null
     };
   } else {
     return {
       errorsFound: [],
-      result: `${PREFIX_PATH_S3.perServiceSchemas}/${objType.serviceTag}/PlugInConfigSchemas/${objType.objectType}.json`
+      result: `${PREFIX_PATH_S3.plugInSchema}/${plugInTag}.json`
     };
   }
 }
-
 function allErrorSchemasPathS3(serviceTag) {
   if (typeof serviceTag !== 'string') {
     return {
@@ -346,9 +345,9 @@ const SCHEMA_NAME = {
   flowSchema: 'flowSchema',
   systemTextSchemas: 'systemTextSchemas',
   notificationSchemas: 'notificationSchemas',
-  plugInConfigSchemas: 'plugInConfigSchemas',
   allErrorSchemas: 'allErrorSchemas',
-  perErrorSchemaTag: 'perErrorSchemaTag'
+  perErrorSchemaTag: 'perErrorSchemaTag',
+  plugInSchema: 'plugInSchema',
 };
 
 const SCHEMA_NAME_PER_S3_PATH = {
@@ -374,10 +373,13 @@ const SCHEMA_NAME_PER_S3_PATH = {
   [SCHEMA_NAME.systemTextSchemas]: systemTextSchemaPathS3,
   // notification schema
   [SCHEMA_NAME.notificationSchemas]: notificationSchemaPathS3,
-  // plugIn config Schema
-  [SCHEMA_NAME.plugInConfigSchemas]: plugInConfigSchemasPathS3,
+
   [SCHEMA_NAME.allErrorSchemas]: allErrorSchemasPathS3,
   [SCHEMA_NAME.perErrorSchemaTag]: perErrorSchemaTagPathS3,
+
+  // plugIn schema
+  [SCHEMA_NAME.plugInSchema]: plugInSchemasPathS3,
+
 };
 
 const ACTION_LIST = Object.values(ACTIONS);

package/src/getSchemas/GetErrorSchema.js

@@ -0,0 +1,197 @@
+/*
+Copyright(C) 2021 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 consts from '../Consts.js';
+const { SCHEMA_NAME, OBJECT_SCHEMA_BUCKET_NAME } = consts;
+import { validateErrorType } from '../libs/ValidateObjType.js';
+
+/**
+ * Gets all error schemas for a given service tag.
+ * @param {function} getSchemaFn - Function to get the schema.
+ * @param {string} serviceTag - Tag of the service.
+ * @param {string} bucketName - Name of the bucket to get the schema from.
+ * @returns {{errorsFound: string[], result: Object[]}}
+ */
+async function getErrorSchemaAllS3(
+  getSchemaFn,
+  serviceTag,
+  bucketName = OBJECT_SCHEMA_BUCKET_NAME
+) {
+  const errorsFound = [];
+  if (!serviceTag || typeof serviceTag !== 'string') {
+    return {
+      errorsFound: ['serviceTag must be a non-empty string'],
+      result: null
+    };
+  }
+
+  const getDataParams = {
+    schemaName: SCHEMA_NAME.allErrorSchemas,
+    getParams: serviceTag
+  };
+
+  let errorSchemas = await getSchemaFn(getDataParams, bucketName);
+  if (!errorSchemas) {
+    return {
+      errorsFound: errorsFound,
+      result: null
+    };
+  } else {
+    return {
+      errorsFound: errorsFound,
+      result: errorSchemas
+    };
+  }
+}
+
+/**
+ * Gets an error schema for a given error type.
+ * @param {function} getSchemaFn - Function to get the schema.
+ * @param {Object} errorType - The error type.
+ * @param {string} errorType.serviceTag - Tag of the service.
+ * @param {string} errorType.errorTag - Tag of the error.
+ * @param {string} bucketName - Name of the bucket to get the schema from.
+ * @returns {{errorsFound: string[], result: Object[]}}
+ */
+async function getErrorSchemaPerTagS3(
+  getSchemaFn,
+  errorType,
+  bucketName = OBJECT_SCHEMA_BUCKET_NAME
+) {
+  const validateErrorTypeRes = validateErrorType(errorType);
+  if (validateErrorTypeRes.errorsFound.length > 0) {
+    return {
+      errorsFound: validateErrorTypeRes.errorsFound,
+      result: null
+    };
+  }
+
+  const getDataParams = {
+    schemaName: SCHEMA_NAME.perErrorSchemaTag,
+    getParams: errorType
+  };
+
+  let errorSchema = await getSchemaFn(getDataParams, bucketName);
+  if (!errorSchema) {
+    return {
+      errorsFound: [],
+      result: null
+    };
+  } else {
+    return {
+      errorsFound: [],
+      result: errorSchema
+    };
+  }
+}
+
+/**
+ * Gets error schemas with throw action for a given error type.
+ * @param {function} getSchemaFn - Function to get the schema.
+ * @param {Object} errorType - The error type.
+ * @param {string} errorType.serviceTag - Tag of the service.
+ * @param {string} errorType.errorTag - Tag of the error.
+ * @param {string} bucketName - Name of the bucket to get the schema from.
+ * @returns {{errorsFound: string[], result: Object[]}}
+ */
+async function getActionThrowErrorSchemaS3(
+  getSchemaFn,
+  errorType,
+  bucketName = OBJECT_SCHEMA_BUCKET_NAME
+) {
+  const validateErrorTypeRes = validateErrorType(errorType);
+  if (validateErrorTypeRes.errorsFound.length > 0) {
+    return {
+      errorsFound: validateErrorTypeRes.errorsFound,
+      result: null
+    };
+  }
+
+  const getDataParams = {
+    schemaName: SCHEMA_NAME.perErrorSchemaTag,
+    getParams: errorType
+  };
+
+  let errorSchemas = await getSchemaFn(getDataParams, bucketName);
+  if (!errorSchemas) {
+    return {
+      errorsFound: [],
+      result: null
+    };
+  }
+
+  const filterThrowAction = errorSchemas.filter(
+    errorSchema => errorSchema.errorAction === 'throw'
+  );
+  return {
+    errorsFound: [],
+    result: filterThrowAction
+  };
+}
+
+/**
+ * Gets error schemas with return action for a given error type.
+ * @param {function} getSchemaFn - Function to get the schema.
+ * @param {Object} errorType - The error type.
+ * @param {string} errorType.serviceTag - Tag of the service.
+ * @param {string} errorType.errorTag - Tag of the error.
+ * @param {string} bucketName - Name of the bucket to get the schema from.
+ * @returns {{errorsFound: string[], result: Object[]}}
+ */
+async function getActionReturnErrorSchemaS3(
+  getSchemaFn,
+  errorType,
+  bucketName = OBJECT_SCHEMA_BUCKET_NAME
+) {
+  const validateErrorTypeRes = validateErrorType(errorType);
+  if (validateErrorTypeRes.errorsFound.length > 0) {
+    return {
+      errorsFound: validateErrorTypeRes.errorsFound,
+      result: null
+    };
+  }
+
+  const getDataParams = {
+    schemaName: SCHEMA_NAME.perErrorSchemaTag,
+    getParams: errorType
+  };
+
+  let errorSchemas = await getSchemaFn(getDataParams, bucketName);
+  if (!errorSchemas) {
+    return {
+      errorsFound: [],
+      result: null
+    };
+  }
+
+  const filterReturnAction = errorSchemas.filter(
+    errorSchema => errorSchema.errorAction === 'return'
+  );
+  return {
+    errorsFound: [],
+    result: filterReturnAction
+  };
+}
+
+
+export default {
+  validateErrorType,
+  getErrorSchemaAllS3,
+  getErrorSchemaPerTagS3,
+  getActionThrowErrorSchemaS3,
+  getActionReturnErrorSchemaS3
+};

package/src/getSchemas/GetFlowSchema.js

@@ -0,0 +1,61 @@
+/*
+Copyright(C) 2021 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 consts from '../Consts.js';
+import validateObjType from '../libs/ValidateObjType.js';
+
+const { SCHEMA_NAME, OBJECT_SCHEMA_BUCKET_NAME } = consts;
+
+async function getFlowSchemaS3(
+  getSchemaFn,
+  flowType,
+  bucketName = OBJECT_SCHEMA_BUCKET_NAME
+) {
+  let errorsFound = [];
+  try {
+    validateObjType.validateFlowType(flowType);
+  } catch (error) {
+    errorsFound.push(error.message);
+    return {
+      errorsFound: [error.message],
+      result: null
+    };
+  }
+
+  const getDataParams = {
+    schemaName: SCHEMA_NAME.flowSchema,
+    getParams: flowType
+  };
+
+  let flowSchema = await getSchemaFn(getDataParams, bucketName);
+  if (!flowSchema) {
+    // return objSchema;
+    return {
+      errorsFound: errorsFound,
+      result: null
+    };
+  } else {
+    return {
+      errorsFound: errorsFound,
+      result: flowSchema
+    };
+  }
+}
+
+export default {
+  getFlowSchemaS3
+}

package/src/getSchemas/GetNotificationSchema.js

@@ -0,0 +1,62 @@
+/*
+Copyright(C) 2021 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 consts from '../Consts.js';
+
+const { SCHEMA_NAME, OBJECT_SCHEMA_BUCKET_NAME } = consts;
+
+async function getNotificationSchemaS3(
+  getSchemaFn,
+  serviceTag,
+  bucketName = OBJECT_SCHEMA_BUCKET_NAME
+) {
+  const errorsFound = [];
+  try {
+    if (typeof serviceTag !== 'string') {
+      errorsFound.push('serviceTag not String');
+    }
+  } catch (error) {
+    errorsFound.push(error.message);
+    return {
+      errorsFound: [error.message],
+      result: null
+    };
+  }
+
+  const getDataParams = {
+    schemaName: SCHEMA_NAME.notificationSchemas,
+    getParams: serviceTag
+  };
+
+  let notificationSchemas = await getSchemaFn(getDataParams, bucketName);
+  if (!notificationSchemas) {
+    // return objSchema;
+    return {
+      errorsFound: errorsFound,
+      result: null
+    };
+  } else {
+    return {
+      errorsFound: errorsFound,
+      result: notificationSchemas
+    };
+  }
+}
+
+export default {
+  getNotificationSchemaS3
+}