@zerocarbon/erp-config-sdk 1.0.13 → 1.0.15

package/dist/index.d.ts

@@ -900,6 +900,7 @@ interface ErrorResponse {
 declare function hasIntensities(response: any): response is DetailedCarbonIntensityResponse;
 declare const INTENSITY_FIELD_LABELS: Record<string, string>;
 
+declare const getUserNameScopeConfig: <T = any>(scopeKey: "scope1" | "scope2" | "scope3" | "waterManagement", username?: string, defaultScope?: T) => T;
 declare const INDUSTRIES_CONFIG: {
     [key: string]: {
         scope1: Scope[];
@@ -915,7 +916,6 @@ declare const INDUSTRIES_CONFIG: {
         };
     };
 };
-declare const getUserNameWaterManagementConfig: (username?: string, defaultWaterManagement?: any) => any;
 declare const getIndustryConfig$1: (industry: string, username?: string) => {
     scope1: Scope[];
     scope2: Scope[];
@@ -966,6 +966,99 @@ type Scope3Item$2 = {
     subProducts: Emissions$i;
     desc: string;
 };
+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 = {
+    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]: BackendAdditionalScopeItem[];
+    };
+};
+type BackendUserConfig = {
+    scope1?: BackendScope[];
+    scope2?: BackendScope[];
+    scope3?: BackendScope3Item[];
+    waterManagement?: BackendScope;
+};
+type BackendUserConfigs = {
+    [username: string]: BackendUserConfig;
+};
+type BackendIndustries = {
+    [industryName: string]: BackendIndustryConfig;
+};
+type AllConfigurations = {
+    industries: BackendIndustries;
+    userConfigs: BackendUserConfigs;
+};
+/**
+ * Get all configurations for backend consumption without React icons
+ * This function returns all industry configurations and user configurations
+ * 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;
@@ -2418,9 +2511,6 @@ type Scope3Item$1 = {
     desc: string;
 };
 declare const ALL_SCOPES_3_CEMENT: Scope3Item$1[];
-declare const getUserNameScope1Config: (username?: string, defaultScope1?: any[]) => any[];
-declare const getUserNameScope2Config: (username?: string, defaultScope2?: any[]) => any[];
-declare const getUserNameScope3Config: (username?: string, defaultScope3?: Scope3Item$1[]) => Scope3Item$1[];
 declare const FUEL_PRODUCTS: {
     name: string;
     unit: string;
@@ -3852,9 +3942,6 @@ declare const index_WATER_USAGE_PRODUCTS: typeof WATER_USAGE_PRODUCTS;
 declare const index_WELDING_PRODUCTS_GAS_LAB: typeof WELDING_PRODUCTS_GAS_LAB;
 declare const index_getEndpointConfig: typeof getEndpointConfig;
 declare const index_getIndustryConfig: typeof getIndustryConfig;
-declare const index_getUserNameScope1Config: typeof getUserNameScope1Config;
-declare const index_getUserNameScope2Config: typeof getUserNameScope2Config;
-declare const index_getUserNameScope3Config: typeof getUserNameScope3Config;
 declare namespace index {
   export {
     index_ALLSCOPES_ALLOY as ALLSCOPES_ALLOY,
@@ -4018,11 +4105,8 @@ declare namespace index {
     index_WELDING_PRODUCTS_GAS_LAB as WELDING_PRODUCTS_GAS_LAB,
     index_getEndpointConfig as getEndpointConfig,
     index_getIndustryConfig as getIndustryConfig,
-    index_getUserNameScope1Config as getUserNameScope1Config,
-    index_getUserNameScope2Config as getUserNameScope2Config,
-    index_getUserNameScope3Config as getUserNameScope3Config,
   };
 }
 
-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, getApiIndustryType, getAvailableFieldsForIndustry, getIndustryConfig$1 as getIndustryConfig, getIndustryFieldConfig, getIntensityFormulas, getPlantNameConfig, getScope3ConfigByName, getUserNameWaterManagementConfig, hasIntensities, isUIFeatureEnabled, mapIndustryToApiType, sanitizeNumber, supportsIntensityCalculations, validateCarbonIntensityData };
-export type { AlloyRequest, AlloyResponse, AluminiumRequest, AluminiumResponse, ApiEndpointConfig, ApiResponse, AutomobileRequest, AutomobileResponse, AviationRequest, AviationResponse, 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 };