@zerocarbon/erp-config-sdk 1.0.15 → 1.0.17

package/dist/index.d.ts

@@ -144,7 +144,7 @@ interface ApiEndpointConfig {
     description: string;
     mappingFunction: (data: StrapiItem<any>[]) => ProcessedEmissionItem[];
 }
-interface IndustryConfig {
+interface IndustryConfig$1 {
     industry: string;
     displayName: string;
     apiEndpoints: ApiEndpointConfig[];
@@ -900,35 +900,50 @@ interface ErrorResponse {
 declare function hasIntensities(response: any): response is DetailedCarbonIntensityResponse;
 declare const INTENSITY_FIELD_LABELS: Record<string, string>;
 
+type EmissionItem$l = {
+    item: string;
+    emissionFactor: number;
+    unit: string;
+};
+type EquipmentCategory$7 = {
+    category: string;
+    items: EmissionItem$l[];
+};
+type Scope3Item$3 = {
+    name: string;
+    displayName: string;
+    icon: any;
+    scope: string;
+    unit: string;
+    subProducts: EquipmentCategory$7[];
+    desc: string;
+};
+declare const ALL_SCOPES_3_RCO: Scope3Item$3[];
+declare const getRCOConfigByName: (name: string) => Scope3Item$3 | undefined;
+
 declare const getUserNameScopeConfig: <T = any>(scopeKey: "scope1" | "scope2" | "scope3" | "waterManagement", username?: string, defaultScope?: T) => T;
-declare const INDUSTRIES_CONFIG: {
-    [key: string]: {
-        scope1: Scope[];
-        scope2: Scope[];
-        scope3: Scope3Item$2[];
-        additionalScopes?: {
-            [key: string]: Array<{
-                type: "scope1" | "scope2" | "scope3";
-                route: string;
-                name: string;
-                scope: Scope | Scope3Item$2;
-            }>;
-        };
-    };
+type IndustryAdditionalScopeItem = {
+    type: "scope1" | "scope2" | "scope3";
+    route: string;
+    name: string;
+    scope: Scope | Scope3Item$2;
 };
-declare const getIndustryConfig$1: (industry: string, username?: string) => {
+type IndustryConfig = {
     scope1: Scope[];
     scope2: Scope[];
     scope3: Scope3Item$2[];
+    rco?: Scope3Item$2[];
     additionalScopes?: {
-        [key: string]: Array<{
-            type: "scope1" | "scope2" | "scope3";
-            route: string;
-            name: string;
-            scope: Scope | Scope3Item$2;
-        }>;
+        [key: string]: IndustryAdditionalScopeItem[];
     };
 };
+declare const INDUSTRIES_CONFIG: {
+    [key: string]: IndustryConfig;
+};
+type IndustryConfigWithRCO = IndustryConfig & {
+    rco: Scope3Item$2[];
+};
+declare const getIndustryConfig$1: (industry: string, username?: string) => IndustryConfigWithRCO;
 type Product = {
     name: string;
     unit: string;
@@ -1013,6 +1028,7 @@ type BackendIndustryConfig = {
     scope1: BackendScope[];
     scope2: BackendScope[];
     scope3: BackendScope3Item[];
+    rco: BackendScope3Item[];
     additionalScopes?: {
         [key: string]: BackendAdditionalScopeItem[];
     };
@@ -1336,19 +1352,28 @@ declare const CCTS_SF6_PRODUCTS: {
     emissionFactorUnit: string;
     type: string;
 }[];
-declare const CCTS_ELECTRICITY_PRODUCTS: {
+declare const CCTS_ELECTRICITY_PRODUCTS: ({
     name: string;
     unit: string;
     emissionFactor: number;
     emissionFactorUnit: string;
     type: string;
-}[];
+    source: string;
+} | {
+    name: string;
+    unit: string;
+    emissionFactor: number;
+    emissionFactorUnit: string;
+    type: string;
+    source?: undefined;
+})[];
 declare const CCTS_PURCHASED_ELECTRICITY: {
     name: string;
     unit: string;
     emissionFactor: number;
     emissionFactorUnit: string;
     type: string;
+    source: string;
 }[];
 declare const CCTS_SCOPE1_CEMENT: ({
     name: string;
@@ -1422,13 +1447,21 @@ declare const CCTS_SCOPE2_CEMENT: {
     icon: react_icons_lib.IconType;
     scope: string;
     unit: string;
-    subProducts: {
+    subProducts: ({
         name: string;
         unit: string;
         emissionFactor: number;
         emissionFactorUnit: string;
         type: string;
-    }[];
+        source: string;
+    } | {
+        name: string;
+        unit: string;
+        emissionFactor: number;
+        emissionFactorUnit: string;
+        type: string;
+        source?: undefined;
+    })[];
     desc: string;
     group: string;
 }[];
@@ -2337,16 +2370,29 @@ declare const ALLSCOPES_BATTERY_EV: ({
     desc: string;
 })[];
 
-declare const FUEL_COMBUSTION_PYRO_PROCESS_PRODUCTS: {
+declare const FUEL_COMBUSTION_PYRO_PROCESS_PRODUCTS: ({
     name: string;
     unit: string;
     emissionFactor: number;
     calorificValue: number;
     type: string;
+    ncv: number;
+    ncvUnit: string;
     energyConversionFactor: number;
     ch4EmissionFactor: number;
     n2oEmissionFactor: number;
-}[];
+} | {
+    name: string;
+    unit: string;
+    emissionFactor: number;
+    calorificValue: number;
+    type: string;
+    ch4EmissionFactor: number;
+    n2oEmissionFactor: number;
+    ncv?: undefined;
+    ncvUnit?: undefined;
+    energyConversionFactor?: undefined;
+})[];
 declare const CALCINATION_PROCESS_PRODUCTS: {
     name: string;
     unit: string;
@@ -2354,30 +2400,61 @@ declare const CALCINATION_PROCESS_PRODUCTS: {
     calorificValue: number;
     type: string;
 }[];
-declare const MINING_OPERATIONS_PRODUCTS: {
+declare const MINING_OPERATIONS_PRODUCTS: ({
     name: string;
     unit: string;
     emissionFactor: number;
     calorificValue: number;
     type: string;
+    ncv: number;
+    ncvUnit: string;
     energyConversionFactor: number;
-}[];
-declare const ON_SITE_POWER_PRODUCTS: {
+} | {
+    name: string;
+    unit: string;
+    emissionFactor: number;
+    calorificValue: number;
+    type: string;
+    ncv?: undefined;
+    ncvUnit?: undefined;
+    energyConversionFactor?: undefined;
+})[];
+declare const ON_SITE_POWER_PRODUCTS: ({
     name: string;
     unit: string;
     emissionFactor: number;
     calorificValue: number;
     type: string;
+    ncv: number;
+    ncvUnit: string;
     energyConversionFactor: number;
-}[];
-declare const ELECTRICITY_CONSUMED_PRODUCTS: {
+} | {
     name: string;
     unit: string;
     emissionFactor: number;
     calorificValue: number;
     type: string;
     energyConversionFactor: number;
-}[];
+    ncv?: undefined;
+    ncvUnit?: undefined;
+})[];
+declare const ELECTRICITY_CONSUMED_PRODUCTS: ({
+    name: string;
+    unit: string;
+    emissionFactor: number;
+    calorificValue: number;
+    type: string;
+    energyConversionFactor: number;
+    source: string;
+} | {
+    name: string;
+    unit: string;
+    emissionFactor: number;
+    calorificValue: number;
+    type: string;
+    energyConversionFactor: number;
+    source?: undefined;
+})[];
 declare const LPG_PRODUCTS: {
     name: string;
     unit: string;
@@ -2422,14 +2499,23 @@ declare const SCOPE2_CEMENT: {
     icon: react_icons_lib.IconType;
     scope: string;
     unit: string;
-    subProducts: {
+    subProducts: ({
         name: string;
         unit: string;
         type: string;
         renewable: boolean;
         calorificValue: number;
         emissionFactor: number;
-    }[];
+        source: string;
+    } | {
+        name: string;
+        unit: string;
+        type: string;
+        renewable: boolean;
+        calorificValue: number;
+        emissionFactor: number;
+        source?: undefined;
+    })[];
     desc: string;
 }[];
 declare const ALLSCOPES_CEMENT: ({
@@ -2465,14 +2551,23 @@ declare const ALLSCOPES_CEMENT: ({
     icon: react_icons_lib.IconType;
     scope: string;
     unit: string;
-    subProducts: {
+    subProducts: ({
         name: string;
         unit: string;
         type: string;
         renewable: boolean;
         calorificValue: number;
         emissionFactor: number;
-    }[];
+        source: string;
+    } | {
+        name: string;
+        unit: string;
+        type: string;
+        renewable: boolean;
+        calorificValue: number;
+        emissionFactor: number;
+        source?: undefined;
+    })[];
     desc: string;
 })[];
 type EmissionItem$g = {
@@ -2563,8 +2658,8 @@ declare const WATER_MANAGEMENT_SCOPE: {
     }[];
     desc: string;
 };
-declare const CEMENT_INDUSTRY_CONFIG: IndustryConfig;
-declare const getIndustryConfig: (industry: string) => IndustryConfig | null;
+declare const CEMENT_INDUSTRY_CONFIG: IndustryConfig$1;
+declare const getIndustryConfig: (industry: string) => IndustryConfig$1 | null;
 declare const getEndpointConfig: (industry: string, endpointName: string) => ApiEndpointConfig | undefined;
 
 type EmissionItem$f = {
@@ -3813,6 +3908,7 @@ declare const index_ALL_SCOPES_3_PACKAGING: typeof ALL_SCOPES_3_PACKAGING;
 declare const index_ALL_SCOPES_3_PETRO_CHEMICAL: typeof ALL_SCOPES_3_PETRO_CHEMICAL;
 declare const index_ALL_SCOPES_3_PHARMA: typeof ALL_SCOPES_3_PHARMA;
 declare const index_ALL_SCOPES_3_POLYMER: typeof ALL_SCOPES_3_POLYMER;
+declare const index_ALL_SCOPES_3_RCO: typeof ALL_SCOPES_3_RCO;
 declare const index_ALL_SCOPES_3_REAL_ESTATE: typeof ALL_SCOPES_3_REAL_ESTATE;
 declare const index_ALL_SCOPES_3_SHIPPING: typeof ALL_SCOPES_3_SHIPPING;
 declare const index_ALL_SCOPES_3_STEEL: typeof ALL_SCOPES_3_STEEL;
@@ -3942,6 +4038,7 @@ 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_getRCOConfigByName: typeof getRCOConfigByName;
 declare namespace index {
   export {
     index_ALLSCOPES_ALLOY as ALLSCOPES_ALLOY,
@@ -3976,6 +4073,7 @@ declare namespace index {
     index_ALL_SCOPES_3_PETRO_CHEMICAL as ALL_SCOPES_3_PETRO_CHEMICAL,
     index_ALL_SCOPES_3_PHARMA as ALL_SCOPES_3_PHARMA,
     index_ALL_SCOPES_3_POLYMER as ALL_SCOPES_3_POLYMER,
+    index_ALL_SCOPES_3_RCO as ALL_SCOPES_3_RCO,
     index_ALL_SCOPES_3_REAL_ESTATE as ALL_SCOPES_3_REAL_ESTATE,
     index_ALL_SCOPES_3_SHIPPING as ALL_SCOPES_3_SHIPPING,
     index_ALL_SCOPES_3_STEEL as ALL_SCOPES_3_STEEL,
@@ -4105,8 +4203,9 @@ declare namespace index {
     index_WELDING_PRODUCTS_GAS_LAB as WELDING_PRODUCTS_GAS_LAB,
     index_getEndpointConfig as getEndpointConfig,
     index_getIndustryConfig as getIndustryConfig,
+    index_getRCOConfigByName as getRCOConfigByName,
   };
 }
 
-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 };
+export { ALL_SCOPES_3_RCO, 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, getRCOConfigByName, 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$1 as 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 };