@contrail/cli 3.4.0 → 3.4.2-alpha.1

package/dist/helpers/load/validators.js

@@ -1,182 +1,182 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LoadValidators = void 0;
-const helpers_1 = require("./helpers");
-class LoadValidators {
-    static ValidateColorsLoadFile(colorsData, config) {
-        const csvHeaders = Object.keys(colorsData[0]);
-        const errors = [];
-        const warnings = [];
-        if (!config) {
-            errors.push('Config file is empty');
-            return { errors, warnings };
-        }
-        if (!config?.loadType?.length) {
-            errors.push('"loadType" is required in the config file');
-        }
-        if (config?.loadType?.length && config?.loadType[0] !== 'COLOR') {
-            errors.push('"loadType" must be must be single value "COLOR" in the config file');
-        }
-        if (!config?.federatedMappings?.federatedId) {
-            errors.push('"federatedId" is required in the config file');
-        }
-        if (!config?.federatedMappings?.name) {
-            errors.push('"name" is required in the config file');
-        }
-        if (config?.conditionalColumns?.length &&
-            config?.conditionalColumns[0].toProperty === 'typePath' &&
-            config?.conditionalColumns[0].default !== 'color') {
-            errors.push('"typePath" must be "color" in the config file');
-        }
-        else if (csvHeaders.includes('typePath')) {
-            const hasCorrectTypePath = colorsData.every((row) => row.typePath === 'color');
-            if (!hasCorrectTypePath) {
-                errors.push('"typePath" must be "color" in each row in the csv file');
-            }
-        }
-        if (!csvHeaders.includes(config?.federatedMappings?.federatedId)) {
-            errors.push(`Federated ID column (${config?.federatedMappings?.federatedId}) not found in the CSV file`);
-        }
-        if (!csvHeaders.includes(config?.federatedMappings?.name)) {
-            errors.push(`Name column (${config.federatedMappings?.name}) not found in the CSV file`);
-        }
-        const duplicateFederatedIdErrors = (0, helpers_1.getDuplicateFederatedIds)(colorsData, config?.federatedMappings?.federatedId);
-        if (duplicateFederatedIdErrors.length) {
-            errors.push(`Duplicate FederatedIds found: ${duplicateFederatedIdErrors.join(', ')}`);
-        }
-        const redColumn = config?.federatedMappings?.red || 'red';
-        const blueColumn = config?.federatedMappings?.blue || 'blue';
-        const greenColumn = config?.federatedMappings?.green || 'green';
-        const hexColumn = config?.federatedMappings?.hex || 'hex';
-        const hasRedColumn = csvHeaders.includes(redColumn);
-        const hasBlueColumn = csvHeaders.includes(blueColumn);
-        const hasGreenColumn = csvHeaders.includes(greenColumn);
-        const hasHexColumn = csvHeaders.includes(hexColumn);
-        if (hasHexColumn && hasRedColumn && hasGreenColumn && hasBlueColumn) {
-            warnings.push('"Hex" is ignored when red, green, and blue columns are present');
-        }
-        return { errors, warnings };
-    }
-    static ValidateCustomEntityLoadFile(customEntityData, config) {
-        const csvHeaders = Object.keys(customEntityData[0]);
-        const errors = [];
-        const warnings = [];
-        if (!config) {
-            errors.push('Config file is empty');
-            return { errors, warnings };
-        }
-        if (!config?.loadType?.length) {
-            errors.push('"loadType" is required in the config file');
-        }
-        if (config?.loadType?.length && config?.loadType[0] !== 'CUSTOM_ENTITY') {
-            errors.push('"loadType" must be must be single value "CUSTOM_ENTITY" in the config file');
-        }
-        if (!config?.federatedMappings?.federatedId) {
-            errors.push('"federatedId" is required in the config file');
-        }
-        if (!config?.federatedMappings?.name) {
-            errors.push('"name" is required in the config file');
-        }
-        if (!csvHeaders.includes(config?.federatedMappings?.federatedId)) {
-            errors.push(`Federated ID column (${config?.federatedMappings?.federatedId}) not found in the CSV file`);
-        }
-        if (!csvHeaders.includes(config?.federatedMappings?.name)) {
-            errors.push('Name column not found in the CSV file');
-        }
-        const duplicateFederatedIdErrors = (0, helpers_1.getDuplicateFederatedIds)(customEntityData, config?.federatedMappings?.federatedId);
-        if (duplicateFederatedIdErrors.length) {
-            errors.push(`Duplicate FederatedIds found: ${duplicateFederatedIdErrors.join(', ')}`);
-        }
-        if (Array.isArray(config?.conditionalColumns) && config.conditionalColumns.length) {
-            const hasRequiredConditionalColumn = config.conditionalColumns.some((column) => column.toProperty === 'typePath' &&
-                column.default?.startsWith('custom-entity:') &&
-                column.default?.split(':')[1]?.length > 0);
-            if (!hasRequiredConditionalColumn) {
-                errors.push('"typePath" must be "custom-entity:<subtypepath>" in the config file');
-            }
-        }
-        else if (csvHeaders.includes('typePath')) {
-            const hasCorrectTypePath = customEntityData.every((row) => row.typePath?.startsWith('custom-entity:') && row.typePath?.split(':')[1]?.length > 0);
-            if (!hasCorrectTypePath) {
-                errors.push('"typePath" must be "custom-entity:<subtypepath>" in each row in the csv file');
-            }
-        }
-        else {
-            errors.push('Missing "typePath" column in the csv file or config file');
-        }
-        return { errors, warnings };
-    }
-    static ValidateLineSheetLoadFile(lineSheetData, config) {
-        const csvHeaders = Object.keys(lineSheetData[0]);
-        const errors = [];
-        const warnings = [];
-        if (!config) {
-            errors.push('Config file is empty');
-            return { errors, warnings };
-        }
-        if (!config?.loadType?.length) {
-            errors.push('"loadType" is required in the config file');
-        }
-        if (config?.loadType?.length &&
-            !config.loadType.every((type) => ['ITEM', 'PROJECT_ITEM', 'ASSORTMENT'].includes(type))) {
-            errors.push('"loadType" must be either of values ["ITEM", "PROJECT_ITEM", "ASSORTMENT"] in the config file');
-        }
-        if (!config.federatedMappings?.name) {
-            errors.push('"name" is required in the config file and must be mapped to Item Family Name');
-        }
-        if (!config.federatedMappings?.optionName) {
-            warnings.push('"optionName" is not mapped in the config file');
-        }
-        if (!config.federatedMappings?.itemFamilyFederatedId &&
-            config.federatedMappings?.itemFederatedId !== null) {
-            errors.push('"itemFamilyFederatedId" is required in the config file');
-        }
-        if (!config.federatedMappings?.itemOptionFederatedId) {
-            warnings.push('"itemOptionFederatedId" is not mapped in the config file');
-        }
-        if (!csvHeaders.includes(config.federatedMappings?.itemFamilyFederatedId)) {
-            errors.push(`itemFamilyFederatedId column (${config.federatedMappings?.itemFamilyFederatedId}) not found in the CSV file`);
-        }
-        const emptyItemFamilyFedIdRows = [];
-        for (const [index, row] of lineSheetData.entries()) {
-            const familyFedId = row[config.federatedMappings?.itemFamilyFederatedId];
-            if (!familyFedId || familyFedId === '') {
-                emptyItemFamilyFedIdRows.push(index);
-            }
-        }
-        if (emptyItemFamilyFedIdRows.length) {
-            errors.push(`some rows contain itemFamilyFederatedId is null or undefined or empty in the CSV file (rows ${emptyItemFamilyFedIdRows.join(',')})`);
-        }
-        // if the data file contains no names, then every row has to be unique federated ID
-        // otherwise, we need to check that each federated ID is only included with one name
-        const isFamilyNameMapped = Boolean(config?.federatedMappings?.name);
-        if (isFamilyNameMapped) {
-            const conflictingFamilyFedIds = (0, helpers_1.getConflictingFederatedIdsGroupedByField)(lineSheetData, config?.federatedMappings?.itemFamilyFederatedId, config?.federatedMappings?.name);
-            if (conflictingFamilyFedIds.length) {
-                errors.push(`Found conflicting family federated Ids: ${conflictingFamilyFedIds.join(', ')}`);
-            }
-            const conflictingFieldsByFedId = (0, helpers_1.getConflictingFieldForFederatedId)(lineSheetData, config?.federatedMappings?.itemFamilyFederatedId, config?.federatedMappings?.name);
-            if (conflictingFieldsByFedId.length) {
-                let prettyString = '';
-                for (const fedIdConflict of conflictingFieldsByFedId) {
-                    prettyString += `(${fedIdConflict.federatedId}: (${fedIdConflict.values.join(', ')}))`;
-                }
-                errors.push(`Found conflicting fields for family federated Ids: ${prettyString}`);
-            }
-        }
-        else {
-            const duplicateFamilyFedIds = (0, helpers_1.getDuplicateFederatedIds)(lineSheetData, config?.federatedMappings?.itemFamilyFederatedId);
-            if (duplicateFamilyFedIds.length) {
-                errors.push(`Duplicate itemFamilyFederatedId found: ${duplicateFamilyFedIds.join(', ')}`);
-            }
-        }
-        if (config?.federatedMappings?.itemOptionFederatedId) {
-            const duplicateOptionFedIds = (0, helpers_1.getDuplicateFederatedIds)(lineSheetData, config.federatedMappings.itemOptionFederatedId);
-            if (duplicateOptionFedIds.length) {
-                errors.push(`Duplicate itemOptionFederatedId found: ${duplicateOptionFedIds.join(', ')}`);
-            }
-        }
-        return { errors, warnings };
-    }
-}
-exports.LoadValidators = LoadValidators;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LoadValidators = void 0;
+const helpers_1 = require("./helpers");
+class LoadValidators {
+    static ValidateColorsLoadFile(colorsData, config) {
+        const csvHeaders = Object.keys(colorsData[0]);
+        const errors = [];
+        const warnings = [];
+        if (!config) {
+            errors.push('Config file is empty');
+            return { errors, warnings };
+        }
+        if (!config?.loadType?.length) {
+            errors.push('"loadType" is required in the config file');
+        }
+        if (config?.loadType?.length && config?.loadType[0] !== 'COLOR') {
+            errors.push('"loadType" must be must be single value "COLOR" in the config file');
+        }
+        if (!config?.federatedMappings?.federatedId) {
+            errors.push('"federatedId" is required in the config file');
+        }
+        if (!config?.federatedMappings?.name) {
+            errors.push('"name" is required in the config file');
+        }
+        if (config?.conditionalColumns?.length &&
+            config?.conditionalColumns[0].toProperty === 'typePath' &&
+            config?.conditionalColumns[0].default !== 'color') {
+            errors.push('"typePath" must be "color" in the config file');
+        }
+        else if (csvHeaders.includes('typePath')) {
+            const hasCorrectTypePath = colorsData.every((row) => row.typePath === 'color');
+            if (!hasCorrectTypePath) {
+                errors.push('"typePath" must be "color" in each row in the csv file');
+            }
+        }
+        if (!csvHeaders.includes(config?.federatedMappings?.federatedId)) {
+            errors.push(`Federated ID column (${config?.federatedMappings?.federatedId}) not found in the CSV file`);
+        }
+        if (!csvHeaders.includes(config?.federatedMappings?.name)) {
+            errors.push(`Name column (${config.federatedMappings?.name}) not found in the CSV file`);
+        }
+        const duplicateFederatedIdErrors = (0, helpers_1.getDuplicateFederatedIds)(colorsData, config?.federatedMappings?.federatedId);
+        if (duplicateFederatedIdErrors.length) {
+            errors.push(`Duplicate FederatedIds found: ${duplicateFederatedIdErrors.join(', ')}`);
+        }
+        const redColumn = config?.federatedMappings?.red || 'red';
+        const blueColumn = config?.federatedMappings?.blue || 'blue';
+        const greenColumn = config?.federatedMappings?.green || 'green';
+        const hexColumn = config?.federatedMappings?.hex || 'hex';
+        const hasRedColumn = csvHeaders.includes(redColumn);
+        const hasBlueColumn = csvHeaders.includes(blueColumn);
+        const hasGreenColumn = csvHeaders.includes(greenColumn);
+        const hasHexColumn = csvHeaders.includes(hexColumn);
+        if (hasHexColumn && hasRedColumn && hasGreenColumn && hasBlueColumn) {
+            warnings.push('"Hex" is ignored when red, green, and blue columns are present');
+        }
+        return { errors, warnings };
+    }
+    static ValidateCustomEntityLoadFile(customEntityData, config) {
+        const csvHeaders = Object.keys(customEntityData[0]);
+        const errors = [];
+        const warnings = [];
+        if (!config) {
+            errors.push('Config file is empty');
+            return { errors, warnings };
+        }
+        if (!config?.loadType?.length) {
+            errors.push('"loadType" is required in the config file');
+        }
+        if (config?.loadType?.length && config?.loadType[0] !== 'CUSTOM_ENTITY') {
+            errors.push('"loadType" must be must be single value "CUSTOM_ENTITY" in the config file');
+        }
+        if (!config?.federatedMappings?.federatedId) {
+            errors.push('"federatedId" is required in the config file');
+        }
+        if (!config?.federatedMappings?.name) {
+            errors.push('"name" is required in the config file');
+        }
+        if (!csvHeaders.includes(config?.federatedMappings?.federatedId)) {
+            errors.push(`Federated ID column (${config?.federatedMappings?.federatedId}) not found in the CSV file`);
+        }
+        if (!csvHeaders.includes(config?.federatedMappings?.name)) {
+            errors.push('Name column not found in the CSV file');
+        }
+        const duplicateFederatedIdErrors = (0, helpers_1.getDuplicateFederatedIds)(customEntityData, config?.federatedMappings?.federatedId);
+        if (duplicateFederatedIdErrors.length) {
+            errors.push(`Duplicate FederatedIds found: ${duplicateFederatedIdErrors.join(', ')}`);
+        }
+        if (Array.isArray(config?.conditionalColumns) && config.conditionalColumns.length) {
+            const hasRequiredConditionalColumn = config.conditionalColumns.some((column) => column.toProperty === 'typePath' &&
+                column.default?.startsWith('custom-entity:') &&
+                column.default?.split(':')[1]?.length > 0);
+            if (!hasRequiredConditionalColumn) {
+                errors.push('"typePath" must be "custom-entity:<subtypepath>" in the config file');
+            }
+        }
+        else if (csvHeaders.includes('typePath')) {
+            const hasCorrectTypePath = customEntityData.every((row) => row.typePath?.startsWith('custom-entity:') && row.typePath?.split(':')[1]?.length > 0);
+            if (!hasCorrectTypePath) {
+                errors.push('"typePath" must be "custom-entity:<subtypepath>" in each row in the csv file');
+            }
+        }
+        else {
+            errors.push('Missing "typePath" column in the csv file or config file');
+        }
+        return { errors, warnings };
+    }
+    static ValidateLineSheetLoadFile(lineSheetData, config) {
+        const csvHeaders = Object.keys(lineSheetData[0]);
+        const errors = [];
+        const warnings = [];
+        if (!config) {
+            errors.push('Config file is empty');
+            return { errors, warnings };
+        }
+        if (!config?.loadType?.length) {
+            errors.push('"loadType" is required in the config file');
+        }
+        if (config?.loadType?.length &&
+            !config.loadType.every((type) => ['ITEM', 'PROJECT_ITEM', 'ASSORTMENT'].includes(type))) {
+            errors.push('"loadType" must be either of values ["ITEM", "PROJECT_ITEM", "ASSORTMENT"] in the config file');
+        }
+        if (!config.federatedMappings?.name) {
+            errors.push('"name" is required in the config file and must be mapped to Item Family Name');
+        }
+        if (!config.federatedMappings?.optionName) {
+            warnings.push('"optionName" is not mapped in the config file');
+        }
+        if (!config.federatedMappings?.itemFamilyFederatedId &&
+            config.federatedMappings?.itemFederatedId !== null) {
+            errors.push('"itemFamilyFederatedId" is required in the config file');
+        }
+        if (!config.federatedMappings?.itemOptionFederatedId) {
+            warnings.push('"itemOptionFederatedId" is not mapped in the config file');
+        }
+        if (!csvHeaders.includes(config.federatedMappings?.itemFamilyFederatedId)) {
+            errors.push(`itemFamilyFederatedId column (${config.federatedMappings?.itemFamilyFederatedId}) not found in the CSV file`);
+        }
+        const emptyItemFamilyFedIdRows = [];
+        for (const [index, row] of lineSheetData.entries()) {
+            const familyFedId = row[config.federatedMappings?.itemFamilyFederatedId];
+            if (!familyFedId || familyFedId === '') {
+                emptyItemFamilyFedIdRows.push(index);
+            }
+        }
+        if (emptyItemFamilyFedIdRows.length) {
+            errors.push(`some rows contain itemFamilyFederatedId is null or undefined or empty in the CSV file (rows ${emptyItemFamilyFedIdRows.join(',')})`);
+        }
+        // if the data file contains no names, then every row has to be unique federated ID
+        // otherwise, we need to check that each federated ID is only included with one name
+        const isFamilyNameMapped = Boolean(config?.federatedMappings?.name);
+        if (isFamilyNameMapped) {
+            const conflictingFamilyFedIds = (0, helpers_1.getConflictingFederatedIdsGroupedByField)(lineSheetData, config?.federatedMappings?.itemFamilyFederatedId, config?.federatedMappings?.name);
+            if (conflictingFamilyFedIds.length) {
+                errors.push(`Found conflicting family federated Ids: ${conflictingFamilyFedIds.join(', ')}`);
+            }
+            const conflictingFieldsByFedId = (0, helpers_1.getConflictingFieldForFederatedId)(lineSheetData, config?.federatedMappings?.itemFamilyFederatedId, config?.federatedMappings?.name);
+            if (conflictingFieldsByFedId.length) {
+                let prettyString = '';
+                for (const fedIdConflict of conflictingFieldsByFedId) {
+                    prettyString += `(${fedIdConflict.federatedId}: (${fedIdConflict.values.join(', ')}))`;
+                }
+                errors.push(`Found conflicting fields for family federated Ids: ${prettyString}`);
+            }
+        }
+        else {
+            const duplicateFamilyFedIds = (0, helpers_1.getDuplicateFederatedIds)(lineSheetData, config?.federatedMappings?.itemFamilyFederatedId);
+            if (duplicateFamilyFedIds.length) {
+                errors.push(`Duplicate itemFamilyFederatedId found: ${duplicateFamilyFedIds.join(', ')}`);
+            }
+        }
+        if (config?.federatedMappings?.itemOptionFederatedId) {
+            const duplicateOptionFedIds = (0, helpers_1.getDuplicateFederatedIds)(lineSheetData, config.federatedMappings.itemOptionFederatedId);
+            if (duplicateOptionFedIds.length) {
+                errors.push(`Duplicate itemOptionFederatedId found: ${duplicateOptionFedIds.join(', ')}`);
+            }
+        }
+        return { errors, warnings };
+    }
+}
+exports.LoadValidators = LoadValidators;

package/dist/helpers/load/validators.spec.d.ts

@@ -1 +1 @@
-export {};
+export {};