@zerocarbon/erp-config-sdk 1.0.0 → 1.0.2

package/dist/index.d.ts

@@ -1255,6 +1255,13 @@ declare const UI_FEATURES: {
         readonly INTEGRATION_FEATURES: "advanced.integrationFeatures";
     };
 };
+/**
+ * Helper function to get feature value using the constant paths
+ * @param featureConstant - Use UI_FEATURES constants (e.g., UI_FEATURES.DASHBOARD_CARDS.GHG_INTENSITY)
+ * @param username - The username to check
+ * @returns boolean - true if feature is enabled, false if disabled
+ */
+declare const isUIFeatureEnabled: (featureConstant: string, username?: string) => boolean;
 
 type FieldType = "text" | "number" | "dropdown" | "multiDropdown" | "country";
 interface FieldOption {
@@ -3993,5 +4000,5 @@ declare namespace index {
   };
 }
 
-export { API_ENDPOINTS, API_SCOPE3_CEMENT_CONFIG, CARBON_INTENSITY_FIELD_MAPPINGS, 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, EmissionSourceGenerator, FRONTEND_INDUSTRY_CONFIGS, HTTP_STATUS, INDUSTRIES_CONFIG, INDUSTRY_MAPPING, INDUSTRY_SPECIFIC_FIELDS, INTENSITY_FIELD_LABELS, index as Industries, UI_FEATURES, calculateCCTSEmission, calculateIntensityMetrics, categorizeApiItem, createCapitalizedMonthMapping, createEmissionSourceGenerator, createMonthMapping, debugCarbonIntensityMapping, extractCarbonIntensityData, formatEmissionValue, formatIntensityValue, formatKPIEmission, formatMonthlyEmission, formatPercentage, getApiIndustryType, getAvailableFieldsForIndustry, getIndustryConfig$1 as getIndustryConfig, getIndustryFieldConfig, getIntensityFormulas, getNestedValue, getPlantNameConfig, getScope3ConfigByName, getUserNameWaterManagementConfig, hasIntensities, mapIndustryToApiType, supportsIntensityCalculations, validateCarbonIntensityData };
+export { API_ENDPOINTS, API_SCOPE3_CEMENT_CONFIG, CARBON_INTENSITY_FIELD_MAPPINGS, 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, EmissionSourceGenerator, FRONTEND_INDUSTRY_CONFIGS, HTTP_STATUS, INDUSTRIES_CONFIG, INDUSTRY_MAPPING, INDUSTRY_SPECIFIC_FIELDS, INTENSITY_FIELD_LABELS, index as Industries, UI_FEATURES, calculateCCTSEmission, calculateIntensityMetrics, categorizeApiItem, createCapitalizedMonthMapping, createEmissionSourceGenerator, createMonthMapping, debugCarbonIntensityMapping, extractCarbonIntensityData, formatEmissionValue, formatIntensityValue, formatKPIEmission, formatMonthlyEmission, formatPercentage, getApiIndustryType, getAvailableFieldsForIndustry, getIndustryConfig$1 as getIndustryConfig, getIndustryFieldConfig, getIntensityFormulas, getNestedValue, getPlantNameConfig, getScope3ConfigByName, getUserNameWaterManagementConfig, hasIntensities, isUIFeatureEnabled, mapIndustryToApiType, supportsIntensityCalculations, validateCarbonIntensityData };
 export type { AlloyRequest, AlloyResponse, AluminiumRequest, AluminiumResponse, ApiEndpointConfig, ApiResponse, AutomobileRequest, AutomobileResponse, AviationRequest, AviationResponse, BaseRequest, BaseResponse, Bill, BusinessTravelEmission, BusinessTravelEmissionAttributes, BusinessTravelEmissionsResponse, CarbonIntensityApiMapping, CarbonIntensityRequest, CarbonIntensityResponse, ChemicalRequest, ChemicalResponse, DetailedCarbonIntensityResponse, EditableItem, EmissionSource, Emissions$j as Emissions, EmissionsDataAttributes, EmissionsDataResponse, FieldConfig, FieldOption, FieldType, FoodBeveragesRequest, FoodBeveragesResponse, FormData, FormValidationResult, HospitalityRequest, HospitalityResponse, IndustryFieldConfig, IndustryFieldSection, IndustryType, IntensityCalculation, IntensityValue, LogisticsRequest, LogisticsResponse, ManufacturingRequest, ManufacturingResponse, Meta, MetalEnergyRequest, MetalEnergyResponse, PackagingRequest, PackagingResponse, Pagination, PetrochemicalRequest, PetrochemicalResponse, PharmaRequest, PharmaResponse, PlantNameConfig, ProcessedEmissionCategory, ProcessedEmissionItem, ProcessedScope3Data, ProductionData, RealEstateRequest, RealEstateResponse, 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

@@ -35008,17 +35008,23 @@ const UI_FEATURES = {
         INTEGRATION_FEATURES: "advanced.integrationFeatures",
     },
 };
+// ==================== DEFAULT CONFIGURATION ====================
+// All features are enabled by default
+const DEFAULT_FEATURES = {};
 // Auto-populate all features as true by default
 const populateDefaults = (obj, prefix = "") => {
     for (const [key, value] of Object.entries(obj)) {
         if (typeof value === "object" && value !== null) {
             populateDefaults(value, prefix ? `${prefix}.${key}` : key);
         }
+        else if (typeof value === "string") {
+            DEFAULT_FEATURES[value] = true;
+        }
     }
 };
 populateDefaults(UI_FEATURES);
 // ==================== USER-SPECIFIC OVERRIDES ====================
-({
+const USER_OVERRIDES = {
     // Example: Gas Lab user with specific features disabled
     "gas lab": {
         [UI_FEATURES.DASHBOARD_CARDS.GHG_INTENSITY]: false,
@@ -35043,7 +35049,40 @@ populateDefaults(UI_FEATURES);
         [UI_FEATURES.ADVANCED.CUSTOM_REPORTS]: false,
         [UI_FEATURES.ADVANCED.API_ACCESS]: false,
         [UI_FEATURES.GRI.BLOCKCHAIN_PUBLISHING]: false,
-    }});
+    },
+    // Example: Admin user with all features enabled (explicitly showing override pattern)
+    admin: {
+    // All features remain true (default), but you could override specific ones to false if needed
+    },
+};
+// ==================== UTILITY FUNCTIONS ====================
+/**
+ * Check if a specific feature is enabled for a user
+ * @param featurePath - The dot notation path to the feature (e.g., 'dashboard.cards.ghgIntensity')
+ * @param username - The username to check (case-insensitive)
+ * @returns boolean - true if feature is enabled, false if disabled
+ */
+const isFeatureEnabled = (featurePath, username) => {
+    var _a, _b, _c;
+    if (!username) {
+        return (_a = DEFAULT_FEATURES[featurePath]) !== null && _a !== void 0 ? _a : true;
+    }
+    const normalizedUsername = username.toLowerCase().trim();
+    const userOverrides = USER_OVERRIDES[normalizedUsername];
+    if (userOverrides && userOverrides.hasOwnProperty(featurePath)) {
+        return (_b = userOverrides[featurePath]) !== null && _b !== void 0 ? _b : true;
+    }
+    return (_c = DEFAULT_FEATURES[featurePath]) !== null && _c !== void 0 ? _c : true;
+};
+/**
+ * Helper function to get feature value using the constant paths
+ * @param featureConstant - Use UI_FEATURES constants (e.g., UI_FEATURES.DASHBOARD_CARDS.GHG_INTENSITY)
+ * @param username - The username to check
+ * @returns boolean - true if feature is enabled, false if disabled
+ */
+const isUIFeatureEnabled = (featureConstant, username) => {
+    return isFeatureEnabled(featureConstant, username);
+};
 // ==================== FEATURE GROUPS FOR EASY ACCESS ====================
 ({
     DASHBOARD: [
@@ -40261,5 +40300,5 @@ var index = /*#__PURE__*/Object.freeze({
     getUserNameScope3Config: getUserNameScope3Config
 });
 
-export { API_ENDPOINTS, API_SCOPE3_CEMENT_CONFIG, CARBON_INTENSITY_FIELD_MAPPINGS, 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, EmissionSourceGenerator, FRONTEND_INDUSTRY_CONFIGS, HTTP_STATUS, INDUSTRIES_CONFIG, INDUSTRY_MAPPING, INDUSTRY_SPECIFIC_FIELDS, INTENSITY_FIELD_LABELS, index as Industries, UI_FEATURES, calculateCCTSEmission, calculateIntensityMetrics, categorizeApiItem, createCapitalizedMonthMapping, createEmissionSourceGenerator, createMonthMapping, debugCarbonIntensityMapping, extractCarbonIntensityData, formatEmissionValue, formatIntensityValue, formatKPIEmission, formatMonthlyEmission, formatPercentage, getApiIndustryType, getAvailableFieldsForIndustry, getIndustryConfig, getIndustryFieldConfig, getIntensityFormulas, getNestedValue, getPlantNameConfig, getScope3ConfigByName, getUserNameWaterManagementConfig, hasIntensities, mapIndustryToApiType, supportsIntensityCalculations, validateCarbonIntensityData };
+export { API_ENDPOINTS, API_SCOPE3_CEMENT_CONFIG, CARBON_INTENSITY_FIELD_MAPPINGS, 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, EmissionSourceGenerator, FRONTEND_INDUSTRY_CONFIGS, HTTP_STATUS, INDUSTRIES_CONFIG, INDUSTRY_MAPPING, INDUSTRY_SPECIFIC_FIELDS, INTENSITY_FIELD_LABELS, index as Industries, UI_FEATURES, calculateCCTSEmission, calculateIntensityMetrics, categorizeApiItem, createCapitalizedMonthMapping, createEmissionSourceGenerator, createMonthMapping, debugCarbonIntensityMapping, extractCarbonIntensityData, formatEmissionValue, formatIntensityValue, formatKPIEmission, formatMonthlyEmission, formatPercentage, getApiIndustryType, getAvailableFieldsForIndustry, getIndustryConfig, getIndustryFieldConfig, getIntensityFormulas, getNestedValue, getPlantNameConfig, getScope3ConfigByName, getUserNameWaterManagementConfig, hasIntensities, isUIFeatureEnabled, mapIndustryToApiType, supportsIntensityCalculations, validateCarbonIntensityData };
 //# sourceMappingURL=index.esm.js.map