@zerocarbon/erp-config-sdk 1.0.14 → 1.0.15

package/dist/index.d.ts

@@ -966,32 +966,72 @@ type Scope3Item$2 = {
     subProducts: Emissions$i;
     desc: string;
 };
-type BackendScope = Omit<Scope, 'icon'> & {
+type BackendProduct = {
+    name: string;
+    unit: string;
+    type: string;
+    calorificValue: number;
+    emissionFactor: number;
+    energyConversionFactor?: number;
+};
+type BackendEmissionItem = {
+    item: string;
+    emissionFactor: number;
+    unit: string;
+};
+type BackendEquipmentCategory = {
+    category: string;
+    items: BackendEmissionItem[];
+};
+type BackendEmissions = BackendEquipmentCategory[];
+type BackendScope = {
+    name: string;
     icon?: string;
+    scope: string;
+    unit: string;
+    subProducts: BackendProduct[];
+    desc: string;
+    group?: string;
+    className?: string;
 };
-type BackendScope3Item = Omit<Scope3Item$2, 'icon'> & {
+type BackendScope3Item = {
+    name: string;
+    displayName: string;
     icon?: string;
+    scope: string;
+    unit: string;
+    subProducts: BackendEmissions;
+    desc: string;
+};
+type BackendAdditionalScopeItem = {
+    type: "scope1" | "scope2" | "scope3";
+    route: string;
+    name: string;
+    scope: BackendScope | BackendScope3Item;
 };
 type BackendIndustryConfig = {
     scope1: BackendScope[];
     scope2: BackendScope[];
     scope3: BackendScope3Item[];
     additionalScopes?: {
-        [key: string]: Array<{
-            type: "scope1" | "scope2" | "scope3";
-            route: string;
-            name: string;
-            scope: BackendScope | BackendScope3Item;
-        }>;
+        [key: string]: BackendAdditionalScopeItem[];
     };
 };
+type BackendUserConfig = {
+    scope1?: BackendScope[];
+    scope2?: BackendScope[];
+    scope3?: BackendScope3Item[];
+    waterManagement?: BackendScope;
+};
+type BackendUserConfigs = {
+    [username: string]: BackendUserConfig;
+};
+type BackendIndustries = {
+    [industryName: string]: BackendIndustryConfig;
+};
 type AllConfigurations = {
-    industries: {
-        [key: string]: BackendIndustryConfig;
-    };
-    userConfigs: {
-        [key: string]: any;
-    };
+    industries: BackendIndustries;
+    userConfigs: BackendUserConfigs;
 };
 /**
  * Get all configurations for backend consumption without React icons
@@ -999,6 +1039,26 @@ type AllConfigurations = {
  * in a format that can be safely consumed by backend applications
  */
 declare function getAllConfig(): AllConfigurations;
+/**
+ * Get user-specific backend configuration by username
+ * @param username - The username to get configuration for
+ * @returns Backend-compatible user configuration or undefined if not found
+ */
+declare function getUserNameBackendConfig(username: string): BackendUserConfig | undefined;
+/**
+ * Get industry-specific backend configuration by industry name
+ * @param industryName - The industry name to get configuration for
+ * @returns Backend-compatible industry configuration or undefined if not found
+ */
+declare function getIndustryBackendConfig(industryName: string): BackendIndustryConfig | undefined;
+/**
+ * Get combined industry and user configuration for backend consumption
+ * This applies user-specific overrides to industry configuration when available
+ * @param industryName - The industry name
+ * @param username - Optional username for user-specific customizations
+ * @returns Backend-compatible combined configuration
+ */
+declare function getCombinedBackendConfig(industryName: string, username?: string): BackendIndustryConfig | undefined;
 
 interface BillFilterOptions {
     category?: string;
@@ -4048,5 +4108,5 @@ declare namespace index {
   };
 }
 
-export { API_ENDPOINTS, API_SCOPE3_CEMENT_CONFIG, BILL_CALCULATION_CONFIGS, BillManager, CCTS_ALLSCOPES_CEMENT, CCTS_CALCINATION_PRODUCTS, CCTS_ELECTRICITY_PRODUCTS, CCTS_FIRE_EXTINGUISHER_PRODUCTS, CCTS_FUEL_COMBUSTION_PRODUCTS, CCTS_LPG_PRODUCTS, CCTS_MINING_OPERATIONS_PRODUCTS, CCTS_ONSITE_POWER_PRODUCTS, CCTS_PURCHASED_ELECTRICITY, CCTS_REFRIGERANTS, CCTS_SCOPE1_CEMENT, CCTS_SCOPE2_CEMENT, CCTS_SF6_PRODUCTS, CCTS_TABLE_COLUMNS, DEFAULT_BILL_MATCHING_CONFIG, EmissionSourceGenerator, FRONTEND_INDUSTRY_CONFIGS, HTTP_STATUS, INDUSTRIES_CONFIG, INDUSTRY_MAPPING, INDUSTRY_SPECIFIC_FIELDS, INTENSITY_FIELD_LABELS, ISO_CATEGORIES_PACKAGING, index as Industries, UI_FEATURES, WATER_PRODUCTS, calculateCCTSEmission, calculateIntensityMetrics, categorizeApiItem, cleanValue, createBillManager, createCapitalizedMonthMapping, createEmissionSourceGenerator, createMonthMapping, debugCarbonIntensityMapping, extractCarbonIntensityData, formatEmissionValue, formatIntensityValue, formatKPIEmission, formatMonthlyEmission, formatPercentage, getAllConfig, getApiIndustryType, getAvailableFieldsForIndustry, getIndustryConfig$1 as getIndustryConfig, getIndustryFieldConfig, getIntensityFormulas, getPlantNameConfig, getScope3ConfigByName, getUserNameScopeConfig, hasIntensities, isUIFeatureEnabled, mapIndustryToApiType, sanitizeNumber, supportsIntensityCalculations, validateCarbonIntensityData };
-export type { AllConfigurations, AlloyRequest, AlloyResponse, AluminiumRequest, AluminiumResponse, ApiEndpointConfig, ApiResponse, AutomobileRequest, AutomobileResponse, AviationRequest, AviationResponse, BackendIndustryConfig, BackendScope, BackendScope3Item, BaseRequest, BaseResponse, Bill, BillCalculationConfig, BillFilterOptions, BillMatchingConfig, BusinessTravelEmission, BusinessTravelEmissionAttributes, BusinessTravelEmissionsResponse, BillsAnalyzed$1 as CarbonIntensityBillsAnalyzed, Calculations$1 as CarbonIntensityCalculations, EmissionData$2 as CarbonIntensityEmissionData, ErrorResponse$1 as CarbonIntensityErrorResponse, CarbonIntensityRequest, CarbonIntensityResponse, ChemicalRequest, ChemicalResponse, DetailedCarbonIntensityResponse, EditableItem, EmissionData$3 as EmissionData, EmissionSource, Emissions$j as Emissions, EmissionsDataAttributes, EmissionsDataResponse, FieldConfig, FoodBeveragesRequest, FoodBeveragesResponse, FormData, FormValidationResult, FrontendIndustryConfig, HospitalityRequest, HospitalityResponse, IndustryConfig, EmissionData as IndustryEmissionData, IndustryFieldConfig, IndustryFieldSection, ProductionData as IndustryProductionData, IndustryType, IntensityCalculation, IntensityValue, LogisticsRequest, LogisticsResponse, ManufacturingRequest, ManufacturingResponse, Meta, MetalEnergyRequest, MetalEnergyResponse, PackagingRequest, PackagingResponse, Pagination, PetrochemicalRequest, PetrochemicalResponse, PharmaRequest, PharmaResponse, PlantNameConfig, ProcessedEmissionCategory, ProcessedEmissionItem, ProcessedScope3Data, RealEstateRequest, RealEstateResponse, BillsAnalyzed as ResponseBillsAnalyzed, Calculations as ResponseCalculations, EmissionData$1 as ResponseEmissionData, ErrorResponse as ResponseErrorResponse, ScopeConfig, ScopeProduct, ShippingRequest, ShippingResponse, SteelRequest, SteelResponse, StrapiItem, StrapiResponse, TelecommunicationRequest, TelecommunicationResponse, TextileRequest, TextileResponse, TransportationEmission, TransportationEmissionAttributes, TransportationEmissionsResponse, UserData, UtilitiesRequest, UtilitiesResponse, ValidationError, VehicleEmission, VehicleEmissionAttributes, VehicleEmissionsResponse };
+export { API_ENDPOINTS, API_SCOPE3_CEMENT_CONFIG, BILL_CALCULATION_CONFIGS, BillManager, CCTS_ALLSCOPES_CEMENT, CCTS_CALCINATION_PRODUCTS, CCTS_ELECTRICITY_PRODUCTS, CCTS_FIRE_EXTINGUISHER_PRODUCTS, CCTS_FUEL_COMBUSTION_PRODUCTS, CCTS_LPG_PRODUCTS, CCTS_MINING_OPERATIONS_PRODUCTS, CCTS_ONSITE_POWER_PRODUCTS, CCTS_PURCHASED_ELECTRICITY, CCTS_REFRIGERANTS, CCTS_SCOPE1_CEMENT, CCTS_SCOPE2_CEMENT, CCTS_SF6_PRODUCTS, CCTS_TABLE_COLUMNS, DEFAULT_BILL_MATCHING_CONFIG, EmissionSourceGenerator, FRONTEND_INDUSTRY_CONFIGS, HTTP_STATUS, INDUSTRIES_CONFIG, INDUSTRY_MAPPING, INDUSTRY_SPECIFIC_FIELDS, INTENSITY_FIELD_LABELS, ISO_CATEGORIES_PACKAGING, index as Industries, UI_FEATURES, WATER_PRODUCTS, calculateCCTSEmission, calculateIntensityMetrics, categorizeApiItem, cleanValue, createBillManager, createCapitalizedMonthMapping, createEmissionSourceGenerator, createMonthMapping, debugCarbonIntensityMapping, extractCarbonIntensityData, formatEmissionValue, formatIntensityValue, formatKPIEmission, formatMonthlyEmission, formatPercentage, getAllConfig, getApiIndustryType, getAvailableFieldsForIndustry, getCombinedBackendConfig, getIndustryBackendConfig, getIndustryConfig$1 as getIndustryConfig, getIndustryFieldConfig, getIntensityFormulas, getPlantNameConfig, getScope3ConfigByName, getUserNameBackendConfig, getUserNameScopeConfig, hasIntensities, isUIFeatureEnabled, mapIndustryToApiType, sanitizeNumber, supportsIntensityCalculations, validateCarbonIntensityData };
+export type { AllConfigurations, AlloyRequest, AlloyResponse, AluminiumRequest, AluminiumResponse, ApiEndpointConfig, ApiResponse, AutomobileRequest, AutomobileResponse, AviationRequest, AviationResponse, BackendAdditionalScopeItem, BackendEmissionItem, BackendEmissions, BackendEquipmentCategory, BackendIndustries, BackendIndustryConfig, BackendProduct, BackendScope, BackendScope3Item, BackendUserConfig, BackendUserConfigs, BaseRequest, BaseResponse, Bill, BillCalculationConfig, BillFilterOptions, BillMatchingConfig, BusinessTravelEmission, BusinessTravelEmissionAttributes, BusinessTravelEmissionsResponse, BillsAnalyzed$1 as CarbonIntensityBillsAnalyzed, Calculations$1 as CarbonIntensityCalculations, EmissionData$2 as CarbonIntensityEmissionData, ErrorResponse$1 as CarbonIntensityErrorResponse, CarbonIntensityRequest, CarbonIntensityResponse, ChemicalRequest, ChemicalResponse, DetailedCarbonIntensityResponse, EditableItem, EmissionData$3 as EmissionData, EmissionSource, Emissions$j as Emissions, EmissionsDataAttributes, EmissionsDataResponse, FieldConfig, FoodBeveragesRequest, FoodBeveragesResponse, FormData, FormValidationResult, FrontendIndustryConfig, HospitalityRequest, HospitalityResponse, IndustryConfig, EmissionData as IndustryEmissionData, IndustryFieldConfig, IndustryFieldSection, ProductionData as IndustryProductionData, IndustryType, IntensityCalculation, IntensityValue, LogisticsRequest, LogisticsResponse, ManufacturingRequest, ManufacturingResponse, Meta, MetalEnergyRequest, MetalEnergyResponse, PackagingRequest, PackagingResponse, Pagination, PetrochemicalRequest, PetrochemicalResponse, PharmaRequest, PharmaResponse, PlantNameConfig, ProcessedEmissionCategory, ProcessedEmissionItem, ProcessedScope3Data, RealEstateRequest, RealEstateResponse, BillsAnalyzed as ResponseBillsAnalyzed, Calculations as ResponseCalculations, EmissionData$1 as ResponseEmissionData, ErrorResponse as ResponseErrorResponse, ScopeConfig, ScopeProduct, ShippingRequest, ShippingResponse, SteelRequest, SteelResponse, StrapiItem, StrapiResponse, TelecommunicationRequest, TelecommunicationResponse, TextileRequest, TextileResponse, TransportationEmission, TransportationEmissionAttributes, TransportationEmissionsResponse, UserData, UtilitiesRequest, UtilitiesResponse, ValidationError, VehicleEmission, VehicleEmissionAttributes, VehicleEmissionsResponse };

package/dist/index.esm.js

@@ -34572,7 +34572,8 @@ function transformScopeToBackend(scope) {
     const { icon, ...rest } = scope;
     return {
         ...rest,
-        icon: ((_a = scope.icon) === null || _a === void 0 ? void 0 : _a.name) || undefined // Extract icon name if available
+        icon: ((_a = scope.icon) === null || _a === void 0 ? void 0 : _a.name) || undefined, // Extract icon name if available
+        subProducts: rest.subProducts.map(transformProductToBackend)
     };
 }
 // Transform a scope3 item to be backend-compatible by removing React icons
@@ -34581,7 +34582,8 @@ function transformScope3ToBackend(scope3) {
     const { icon, ...rest } = scope3;
     return {
         ...rest,
-        icon: ((_a = scope3.icon) === null || _a === void 0 ? void 0 : _a.name) || undefined // Extract icon name if available
+        icon: ((_a = scope3.icon) === null || _a === void 0 ? void 0 : _a.name) || undefined, // Extract icon name if available
+        subProducts: transformEmissionsToBackend(rest.subProducts)
     };
 }
 // Transform an industry config to be backend-compatible
@@ -34595,7 +34597,9 @@ function transformIndustryConfigToBackend(config) {
         result.additionalScopes = {};
         for (const [key, scopes] of Object.entries(config.additionalScopes)) {
             result.additionalScopes[key] = scopes.map(item => ({
-                ...item,
+                type: item.type,
+                route: item.route,
+                name: item.name,
                 scope: item.type === 'scope3'
                     ? transformScope3ToBackend(item.scope)
                     : transformScopeToBackend(item.scope)
@@ -34604,6 +34608,59 @@ function transformIndustryConfigToBackend(config) {
     }
     return result;
 }
+// Transform product to backend-compatible format
+function transformProductToBackend(product) {
+    return {
+        name: product.name,
+        unit: product.unit,
+        type: product.type,
+        calorificValue: product.calorificValue,
+        emissionFactor: product.emissionFactor,
+        energyConversionFactor: product.energyConversionFactor
+    };
+}
+// Transform emission item to backend-compatible format
+function transformEmissionItemToBackend(item) {
+    return {
+        item: item.item,
+        emissionFactor: item.emissionFactor,
+        unit: item.unit
+    };
+}
+// Transform equipment category to backend-compatible format
+function transformEquipmentCategoryToBackend(category) {
+    return {
+        category: category.category,
+        items: category.items.map(transformEmissionItemToBackend)
+    };
+}
+// Transform emissions array to backend-compatible format
+function transformEmissionsToBackend(emissions) {
+    return emissions.map(transformEquipmentCategoryToBackend);
+}
+// Transform user config to backend-compatible format
+function transformUserConfigToBackend(userConfig) {
+    const result = {};
+    if (userConfig.scope1) {
+        result.scope1 = Array.isArray(userConfig.scope1)
+            ? userConfig.scope1.map(transformScopeToBackend)
+            : [transformScopeToBackend(userConfig.scope1)];
+    }
+    if (userConfig.scope2) {
+        result.scope2 = Array.isArray(userConfig.scope2)
+            ? userConfig.scope2.map(transformScopeToBackend)
+            : [transformScopeToBackend(userConfig.scope2)];
+    }
+    if (userConfig.scope3) {
+        result.scope3 = Array.isArray(userConfig.scope3)
+            ? userConfig.scope3.map(transformScope3ToBackend)
+            : [transformScope3ToBackend(userConfig.scope3)];
+    }
+    if (userConfig.waterManagement) {
+        result.waterManagement = transformScopeToBackend(userConfig.waterManagement);
+    }
+    return result;
+}
 /**
  * Get all configurations for backend consumption without React icons
  * This function returns all industry configurations and user configurations
@@ -34615,10 +34672,77 @@ function getAllConfig() {
     for (const [industryName, config] of Object.entries(INDUSTRIES_CONFIG)) {
         industries[industryName] = transformIndustryConfigToBackend(config);
     }
+    // Transform user configs to be backend-compatible
+    const userConfigs = {};
+    for (const [username, config] of Object.entries(USER_CONFIGS)) {
+        userConfigs[username] = transformUserConfigToBackend(config);
+    }
     return {
         industries,
-        userConfigs: USER_CONFIGS
+        userConfigs
+    };
+}
+/**
+ * Get user-specific backend configuration by username
+ * @param username - The username to get configuration for
+ * @returns Backend-compatible user configuration or undefined if not found
+ */
+function getUserNameBackendConfig(username) {
+    const normalizedUsername = username.toLowerCase().trim();
+    const userConfig = USER_CONFIGS[normalizedUsername];
+    if (!userConfig) {
+        return undefined;
+    }
+    return transformUserConfigToBackend(userConfig);
+}
+/**
+ * Get industry-specific backend configuration by industry name
+ * @param industryName - The industry name to get configuration for
+ * @returns Backend-compatible industry configuration or undefined if not found
+ */
+function getIndustryBackendConfig(industryName) {
+    const config = INDUSTRIES_CONFIG[industryName];
+    if (!config) {
+        return undefined;
+    }
+    return transformIndustryConfigToBackend(config);
+}
+/**
+ * Get combined industry and user configuration for backend consumption
+ * This applies user-specific overrides to industry configuration when available
+ * @param industryName - The industry name
+ * @param username - Optional username for user-specific customizations
+ * @returns Backend-compatible combined configuration
+ */
+function getCombinedBackendConfig(industryName, username) {
+    const industryConfig = getIndustryBackendConfig(industryName);
+    if (!industryConfig) {
+        return undefined;
+    }
+    if (!username) {
+        return industryConfig;
+    }
+    const userConfig = getUserNameBackendConfig(username);
+    if (!userConfig) {
+        return industryConfig;
+    }
+    // Merge user config with industry config (user overrides industry)
+    const combined = {
+        scope1: userConfig.scope1 || industryConfig.scope1,
+        scope2: userConfig.scope2 || industryConfig.scope2,
+        scope3: userConfig.scope3 || industryConfig.scope3,
+        additionalScopes: industryConfig.additionalScopes
     };
+    // Add user-specific water management if available
+    if (userConfig.waterManagement && combined.additionalScopes) {
+        combined.additionalScopes.waterManagement = [{
+                type: "scope1",
+                route: "/manage/water",
+                name: "Water Management",
+                scope: userConfig.waterManagement
+            }];
+    }
+    return combined;
 }
 
 // Default calculation configurations
@@ -40611,5 +40735,5 @@ var index = /*#__PURE__*/Object.freeze({
     getIndustryConfig: getIndustryConfig$1
 });
 
-export { API_ENDPOINTS, API_SCOPE3_CEMENT_CONFIG, BILL_CALCULATION_CONFIGS, BillManager, CCTS_ALLSCOPES_CEMENT, CCTS_CALCINATION_PRODUCTS, CCTS_ELECTRICITY_PRODUCTS, CCTS_FIRE_EXTINGUISHER_PRODUCTS, CCTS_FUEL_COMBUSTION_PRODUCTS, CCTS_LPG_PRODUCTS, CCTS_MINING_OPERATIONS_PRODUCTS, CCTS_ONSITE_POWER_PRODUCTS, CCTS_PURCHASED_ELECTRICITY, CCTS_REFRIGERANTS, CCTS_SCOPE1_CEMENT, CCTS_SCOPE2_CEMENT, CCTS_SF6_PRODUCTS, CCTS_TABLE_COLUMNS, DEFAULT_BILL_MATCHING_CONFIG, EmissionSourceGenerator, FRONTEND_INDUSTRY_CONFIGS, HTTP_STATUS, INDUSTRIES_CONFIG, INDUSTRY_MAPPING, INDUSTRY_SPECIFIC_FIELDS, INTENSITY_FIELD_LABELS, ISO_CATEGORIES_PACKAGING, index as Industries, UI_FEATURES, WATER_PRODUCTS, calculateCCTSEmission, calculateIntensityMetrics, categorizeApiItem, cleanValue, createBillManager, createCapitalizedMonthMapping, createEmissionSourceGenerator, createMonthMapping, debugCarbonIntensityMapping, extractCarbonIntensityData, formatEmissionValue, formatIntensityValue, formatKPIEmission, formatMonthlyEmission, formatPercentage, getAllConfig, getApiIndustryType, getAvailableFieldsForIndustry, getIndustryConfig, getIndustryFieldConfig, getIntensityFormulas, getPlantNameConfig, getScope3ConfigByName, getUserNameScopeConfig, hasIntensities, isUIFeatureEnabled, mapIndustryToApiType, sanitizeNumber, supportsIntensityCalculations, validateCarbonIntensityData };
+export { API_ENDPOINTS, API_SCOPE3_CEMENT_CONFIG, BILL_CALCULATION_CONFIGS, BillManager, CCTS_ALLSCOPES_CEMENT, CCTS_CALCINATION_PRODUCTS, CCTS_ELECTRICITY_PRODUCTS, CCTS_FIRE_EXTINGUISHER_PRODUCTS, CCTS_FUEL_COMBUSTION_PRODUCTS, CCTS_LPG_PRODUCTS, CCTS_MINING_OPERATIONS_PRODUCTS, CCTS_ONSITE_POWER_PRODUCTS, CCTS_PURCHASED_ELECTRICITY, CCTS_REFRIGERANTS, CCTS_SCOPE1_CEMENT, CCTS_SCOPE2_CEMENT, CCTS_SF6_PRODUCTS, CCTS_TABLE_COLUMNS, DEFAULT_BILL_MATCHING_CONFIG, EmissionSourceGenerator, FRONTEND_INDUSTRY_CONFIGS, HTTP_STATUS, INDUSTRIES_CONFIG, INDUSTRY_MAPPING, INDUSTRY_SPECIFIC_FIELDS, INTENSITY_FIELD_LABELS, ISO_CATEGORIES_PACKAGING, index as Industries, UI_FEATURES, WATER_PRODUCTS, calculateCCTSEmission, calculateIntensityMetrics, categorizeApiItem, cleanValue, createBillManager, createCapitalizedMonthMapping, createEmissionSourceGenerator, createMonthMapping, debugCarbonIntensityMapping, extractCarbonIntensityData, formatEmissionValue, formatIntensityValue, formatKPIEmission, formatMonthlyEmission, formatPercentage, getAllConfig, getApiIndustryType, getAvailableFieldsForIndustry, getCombinedBackendConfig, getIndustryBackendConfig, getIndustryConfig, getIndustryFieldConfig, getIntensityFormulas, getPlantNameConfig, getScope3ConfigByName, getUserNameBackendConfig, getUserNameScopeConfig, hasIntensities, isUIFeatureEnabled, mapIndustryToApiType, sanitizeNumber, supportsIntensityCalculations, validateCarbonIntensityData };
 //# sourceMappingURL=index.esm.js.map