@zerocarbon/erp-config-sdk 1.0.23 → 1.0.25

package/dist/index.d.ts

@@ -1209,6 +1209,18 @@ declare const createEmissionSourceGenerator: (billManager: BillManager) => Emiss
 declare const INDUSTRY_MAPPING: Record<string, IndustryType>;
 declare const getApiIndustryType: (erpIndustry: string) => IndustryType;
 
+declare const normalizeConfigText: (value: unknown) => string;
+declare const normalizeConfigKeyText: (value: unknown) => string;
+declare const buildUserConfigItemKey: ({ scope, category, subCategory, itemName, }: {
+    scope?: unknown;
+    category?: unknown;
+    subCategory?: unknown;
+    itemName?: unknown;
+}) => string;
+declare const sameUserConfigText: (left: unknown, right: unknown) => boolean;
+
+declare const mergeUserItemsIntoIndustryConfig: <T extends BackendIndustryConfig>(baseConfig: T, userItems?: UserConfigItem[]) => T;
+
 type JsonResponse<T> = {
     json: () => Promise<T>;
 };
@@ -1217,6 +1229,9 @@ type UserConfigApiClient = {
     post: <T = any>(path: string, options: {
         json: unknown;
     }) => JsonResponse<T>;
+    put?: <T = any>(path: string, options: {
+        json: unknown;
+    }) => JsonResponse<T>;
     patch?: <T = any>(path: string, options: {
         json: unknown;
     }) => JsonResponse<T>;
@@ -1239,6 +1254,11 @@ type UserConfigItem = {
     };
     requiresMassData?: boolean;
     aliases?: string[];
+    normalizedKey?: string;
+    baseItemKey?: string;
+    baseEmissionFactor?: number;
+    overrideKind?: "custom-item" | "sdk-emission-factor" | string;
+    isOverride?: boolean;
     source?: string;
 };
 type UserEmissionFactorResolution = Partial<UserConfigItem> & {
@@ -1263,14 +1283,32 @@ declare const addItemForUser: (apiClient: UserConfigApiClient, options: {
     category: string;
     items: Partial<UserConfigItem>[];
 }) => Promise<UserConfigItem[]>;
+type UserEmissionFactorApprovalResponse = {
+    success?: boolean;
+    pendingApproval?: boolean;
+    approvalId?: string;
+    approverEmail?: string;
+    message?: string;
+    item?: UserConfigItem;
+    updatedBills?: number;
+};
 declare const updateItemEmissionFactorForUser: (apiClient: UserConfigApiClient, options: {
     itemId: string;
     emissionFactor: number;
-}) => Promise<{
-    item?: UserConfigItem;
-    updatedBills?: number;
-}>;
-declare const mergeUserItemsIntoIndustryConfig: <T extends BackendIndustryConfig>(baseConfig: T, userItems?: UserConfigItem[]) => T;
+    plant?: string;
+}) => Promise<UserEmissionFactorApprovalResponse>;
+declare const updateSdkItemEmissionFactorForUser: (apiClient: UserConfigApiClient, options: {
+    industry: string;
+    scope: string;
+    category: string;
+    subCategory: string;
+    itemName: string;
+    unit: string;
+    emissionFactor: number;
+    baseEmissionFactor?: number;
+    requiresMassData?: boolean;
+    plant?: string;
+}) => Promise<UserEmissionFactorApprovalResponse>;
 
 interface MappingRules {
     includeIfCategoryContains?: string[];
@@ -4271,5 +4309,5 @@ declare namespace index {
   };
 }
 
-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, addItemForUser, 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, getItemsForUser, getPlantNameConfig, getRCOConfigByName, getScope3ConfigByName, getUserNameBackendConfig, getUserNameScopeConfig, hasIntensities, isUIFeatureEnabled, mapIndustryToApiType, mergeUserItemsIntoIndustryConfig, resolveEmissionFactorsForUser, sanitizeNumber, supportsIntensityCalculations, updateItemEmissionFactorForUser, 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, UserConfigApiClient, UserConfigItem, UserData, UserEmissionFactorResolution, 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, addItemForUser, buildUserConfigItemKey, 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, getItemsForUser, getPlantNameConfig, getRCOConfigByName, getScope3ConfigByName, getUserNameBackendConfig, getUserNameScopeConfig, hasIntensities, isUIFeatureEnabled, mapIndustryToApiType, mergeUserItemsIntoIndustryConfig, normalizeConfigKeyText, normalizeConfigText, resolveEmissionFactorsForUser, sameUserConfigText, sanitizeNumber, supportsIntensityCalculations, updateItemEmissionFactorForUser, updateSdkItemEmissionFactorForUser, 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, UserConfigApiClient, UserConfigItem, UserData, UserEmissionFactorApprovalResponse, UserEmissionFactorResolution, UtilitiesRequest, UtilitiesResponse, ValidationError, VehicleEmission, VehicleEmissionAttributes, VehicleEmissionsResponse };

package/dist/index.esm.js

@@ -34638,6 +34638,81 @@ const getApiIndustryType = (erpIndustry) => {
     return INDUSTRY_MAPPING[erpIndustry] || "manufacturing";
 };
 
+const normalizeConfigText = (value) => String(value !== null && value !== void 0 ? value : "").replace(/\s+/g, " ").trim();
+const normalizeConfigKeyText = (value) => normalizeConfigText(value)
+    .toLowerCase()
+    .replace(/[^a-z0-9]+/g, " ")
+    .trim();
+const buildUserConfigItemKey = ({ scope, category, subCategory, itemName, }) => [scope, category, subCategory, itemName].map(normalizeConfigKeyText).join("|");
+const sameUserConfigText = (left, right) => normalizeConfigKeyText(left) === normalizeConfigKeyText(right);
+
+const itemMeta = (item) => ({
+    customItemId: item.id,
+    source: item.source === "sdk-override" ? "sdk-override" : "company-custom",
+    isCompanyCustom: item.source !== "sdk-override",
+    isCompanyOverride: item.source === "sdk-override" || item.isOverride,
+    baseEmissionFactor: item.baseEmissionFactor,
+    overrideKind: item.overrideKind,
+});
+const applyScope3Item = (config, item) => {
+    var _a;
+    const scope = config.scope3.find((entry) => sameUserConfigText(entry.name, item.category));
+    const group = scope === null || scope === void 0 ? void 0 : scope.subProducts.find((entry) => sameUserConfigText(entry.category, item.subCategory));
+    if (!group)
+        return;
+    const existing = group.items.find((entry) => sameUserConfigText(entry.item, item.itemName));
+    if (existing) {
+        Object.assign(existing, {
+            emissionFactor: item.emissionFactor,
+            unit: item.unit || existing.unit,
+            requiresMassData: (_a = item.requiresMassData) !== null && _a !== void 0 ? _a : existing.requiresMassData,
+            ...itemMeta(item),
+        });
+        return;
+    }
+    group.items = [{
+            item: item.itemName,
+            unit: item.unit,
+            emissionFactor: item.emissionFactor,
+            requiresMassData: item.requiresMassData,
+            ...itemMeta(item),
+        }, ...group.items];
+};
+const applyFlatItem = (config, item) => {
+    const scopeList = item.scope === "scope2" ? config.scope2 : config.scope1;
+    const scope = scopeList.find((entry) => sameUserConfigText(entry.name, item.category));
+    if (!scope)
+        return;
+    const existing = scope.subProducts.find((entry) => sameUserConfigText(entry.name, item.itemName) &&
+        sameUserConfigText(entry.type, item.subCategory));
+    if (existing) {
+        Object.assign(existing, {
+            emissionFactor: item.emissionFactor,
+            unit: item.unit || existing.unit,
+            ...itemMeta(item),
+        });
+        return;
+    }
+    scope.subProducts = [{
+            name: item.itemName,
+            type: item.subCategory,
+            unit: item.unit,
+            emissionFactor: item.emissionFactor,
+            calorificValue: 0,
+            ...itemMeta(item),
+        }, ...scope.subProducts];
+};
+const mergeUserItemsIntoIndustryConfig = (baseConfig, userItems = []) => {
+    const config = JSON.parse(JSON.stringify(baseConfig));
+    for (const item of userItems.slice().reverse()) {
+        if (item.scope === "scope3")
+            applyScope3Item(config, item);
+        else
+            applyFlatItem(config, item);
+    }
+    return config;
+};
+
 const getItemsForUser = async (apiClient, options = {}) => {
     const params = new URLSearchParams();
     if (options.industry)
@@ -34680,39 +34755,18 @@ const updateItemEmissionFactorForUser = async (apiClient, options) => {
         throw new Error("apiClient.patch is required to update emission factors");
     }
     const data = await apiClient
-        .patch(`erp-config/items/${options.itemId}/emission-factor`, { json: { emissionFactor: options.emissionFactor } })
+        .patch(`erp-config/items/${options.itemId}/emission-factor`, { json: { emissionFactor: options.emissionFactor, plant: options.plant } })
         .json();
     return data;
 };
-const mergeUserItemsIntoIndustryConfig = (baseConfig, userItems = []) => {
-    const config = JSON.parse(JSON.stringify(baseConfig));
-    for (const item of userItems) {
-        if (item.scope === "scope3") {
-            const scope = config.scope3.find((entry) => entry.name === item.category);
-            const group = scope === null || scope === void 0 ? void 0 : scope.subProducts.find((entry) => entry.category === item.subCategory);
-            if (group && !group.items.some((entry) => entry.item === item.itemName)) {
-                group.items.push({
-                    item: item.itemName,
-                    unit: item.unit,
-                    emissionFactor: item.emissionFactor,
-                    requiresMassData: item.requiresMassData,
-                });
-            }
-            continue;
-        }
-        const scopeList = item.scope === "scope2" ? config.scope2 : config.scope1;
-        const scope = scopeList.find((entry) => entry.name === item.category);
-        if (scope && !scope.subProducts.some((entry) => entry.name === item.itemName)) {
-            scope.subProducts.push({
-                name: item.itemName,
-                type: item.subCategory,
-                unit: item.unit,
-                emissionFactor: item.emissionFactor,
-                calorificValue: 0,
-            });
-        }
+const updateSdkItemEmissionFactorForUser = async (apiClient, options) => {
+    if (!apiClient.put) {
+        throw new Error("apiClient.put is required to override SDK item emission factors");
     }
-    return config;
+    const data = await apiClient
+        .put("erp-config/items/emission-factor-override", { json: options })
+        .json();
+    return data;
 };
 
 // Scope 3 categories configuration for cement industry using API data
@@ -40212,5 +40266,5 @@ var index = /*#__PURE__*/Object.freeze({
     getRCOConfigByName: getRCOConfigByName
 });
 
-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$1 as WATER_PRODUCTS, addItemForUser, calculateCCTSEmission, calculateIntensityMetrics, categorizeApiItem, cleanValue, createBillManager, createCapitalizedMonthMapping, createEmissionSourceGenerator, createMonthMapping, debugCarbonIntensityMapping, extractCarbonIntensityData, formatEmissionValue, formatIntensityValue, formatKPIEmission, formatMonthlyEmission, formatPercentage, getAllConfig, getApiIndustryType, getAvailableFieldsForIndustry, getCombinedBackendConfig, getIndustryBackendConfig, getIndustryConfig, getIndustryFieldConfig, getIntensityFormulas, getItemsForUser, getPlantNameConfig, getRCOConfigByName, getScope3ConfigByName, getUserNameBackendConfig, getUserNameScopeConfig, hasIntensities, isUIFeatureEnabled, mapIndustryToApiType, mergeUserItemsIntoIndustryConfig, resolveEmissionFactorsForUser, sanitizeNumber, supportsIntensityCalculations, updateItemEmissionFactorForUser, validateCarbonIntensityData };
+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$1 as WATER_PRODUCTS, addItemForUser, buildUserConfigItemKey, calculateCCTSEmission, calculateIntensityMetrics, categorizeApiItem, cleanValue, createBillManager, createCapitalizedMonthMapping, createEmissionSourceGenerator, createMonthMapping, debugCarbonIntensityMapping, extractCarbonIntensityData, formatEmissionValue, formatIntensityValue, formatKPIEmission, formatMonthlyEmission, formatPercentage, getAllConfig, getApiIndustryType, getAvailableFieldsForIndustry, getCombinedBackendConfig, getIndustryBackendConfig, getIndustryConfig, getIndustryFieldConfig, getIntensityFormulas, getItemsForUser, getPlantNameConfig, getRCOConfigByName, getScope3ConfigByName, getUserNameBackendConfig, getUserNameScopeConfig, hasIntensities, isUIFeatureEnabled, mapIndustryToApiType, mergeUserItemsIntoIndustryConfig, normalizeConfigKeyText, normalizeConfigText, resolveEmissionFactorsForUser, sameUserConfigText, sanitizeNumber, supportsIntensityCalculations, updateItemEmissionFactorForUser, updateSdkItemEmissionFactorForUser, validateCarbonIntensityData };
 //# sourceMappingURL=index.esm.js.map