emissions-api-sdk 1.0.4 → 1.0.5

package/dist/coverage/lcov-report/test/mocks/FactorRequest.ts.html

@@ -118,7 +118,7 @@ export default FactorPayload;
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at 2026-01-23T09:26:49.327Z
+                at 2026-02-17T12:36:50.828Z
             </div>
         <script src="../../prettify.js"></script>
         <script>

package/dist/coverage/lcov-report/test/mocks/GenericCalculationRequest.ts.html

@@ -127,7 +127,7 @@ export default GenericCalculationPayload;
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at 2026-01-23T09:26:49.327Z
+                at 2026-02-17T12:36:50.828Z
             </div>
         <script src="../../prettify.js"></script>
         <script>

package/dist/coverage/lcov-report/test/mocks/LocationRequest.ts.html

@@ -124,7 +124,7 @@ export default locationPayload;</pre></td></tr></table></pre>
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at 2026-01-23T09:26:49.327Z
+                at 2026-02-17T12:36:50.828Z
             </div>
         <script src="../../prettify.js"></script>
         <script>

package/dist/coverage/lcov-report/test/mocks/SearchRequest.ts.html

@@ -127,7 +127,7 @@ export default SearchPayload;
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at 2026-01-23T09:26:49.327Z
+                at 2026-02-17T12:36:50.828Z
             </div>
         <script src="../../prettify.js"></script>
         <script>

package/dist/coverage/lcov-report/test/mocks/index.html

@@ -161,7 +161,7 @@
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at 2026-01-23T09:26:49.327Z
+                at 2026-02-17T12:36:50.828Z
             </div>
         <script src="../../prettify.js"></script>
         <script>

package/dist/coverage/lcov-report/test/testUtils.ts.html

@@ -82,7 +82,7 @@
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at 2026-01-23T09:26:49.327Z
+                at 2026-02-17T12:36:50.828Z
             </div>
         <script src="../prettify.js"></script>
         <script>

package/dist/coverage/lcov.info

@@ -11,10 +11,10 @@ FN:214,(anonymous_8)
 FN:236,(anonymous_9)
 FNF:9
 FNH:7
-FNDA:38,(anonymous_1)
-FNDA:41,(anonymous_2)
-FNDA:68,(anonymous_3)
-FNDA:73,(anonymous_4)
+FNDA:46,(anonymous_1)
+FNDA:49,(anonymous_2)
+FNDA:84,(anonymous_3)
+FNDA:89,(anonymous_4)
 FNDA:3,(anonymous_5)
 FNDA:2,(anonymous_6)
 FNDA:0,(anonymous_7)
@@ -25,36 +25,36 @@ DA:3,4
 DA:4,4
 DA:6,4
 DA:7,4
-DA:24,38
-DA:25,38
-DA:26,38
-DA:27,38
+DA:24,46
+DA:25,46
+DA:26,46
+DA:27,46
 DA:28,1
 DA:29,1
-DA:31,37
-DA:32,37
-DA:35,38
-DA:36,38
-DA:37,38
-DA:38,38
-DA:39,38
-DA:40,38
-DA:78,41
+DA:31,45
+DA:32,45
+DA:35,46
+DA:36,46
+DA:37,46
+DA:38,46
+DA:39,46
+DA:40,46
+DA:78,49
 DA:79,1
-DA:83,40
+DA:83,48
 DA:84,1
-DA:88,39
+DA:88,47
 DA:89,1
-DA:94,38
-DA:96,38
+DA:94,46
+DA:96,46
 DA:97,1
 DA:98,1
-DA:99,37
-DA:100,38
-DA:114,68
-DA:136,73
+DA:99,45
+DA:100,46
+DA:114,84
+DA:136,89
 DA:137,1
-DA:141,72
+DA:141,88
 DA:157,3
 DA:158,2
 DA:159,2
@@ -74,38 +74,38 @@ LH:47
 BRDA:22,0,0,0
 BRDA:24,1,0,1
 BRDA:24,2,0,1
-BRDA:24,3,0,38
+BRDA:24,3,0,46
 BRDA:27,4,0,1
-BRDA:27,4,1,37
+BRDA:27,4,1,45
 BRDA:37,5,0,0
-BRDA:37,5,1,38
-BRDA:37,6,0,38
-BRDA:37,6,1,38
+BRDA:37,5,1,46
+BRDA:37,6,0,46
+BRDA:37,6,1,46
 BRDA:38,7,0,0
-BRDA:38,7,1,38
-BRDA:38,8,0,38
-BRDA:38,8,1,38
+BRDA:38,7,1,46
+BRDA:38,8,0,46
+BRDA:38,8,1,46
 BRDA:40,9,0,0
-BRDA:40,9,1,38
+BRDA:40,9,1,46
 BRDA:78,10,0,1
-BRDA:78,10,1,40
-BRDA:78,11,0,41
+BRDA:78,10,1,48
+BRDA:78,11,0,49
 BRDA:78,11,1,1
 BRDA:83,12,0,1
-BRDA:83,12,1,39
-BRDA:83,13,0,40
+BRDA:83,12,1,47
+BRDA:83,13,0,48
 BRDA:83,13,1,2
 BRDA:88,14,0,1
-BRDA:88,14,1,38
-BRDA:88,15,0,39
-BRDA:88,15,1,38
-BRDA:88,15,2,37
+BRDA:88,14,1,46
+BRDA:88,15,0,47
+BRDA:88,15,1,46
+BRDA:88,15,2,45
 BRDA:96,16,0,1
-BRDA:96,16,1,37
-BRDA:96,17,0,38
+BRDA:96,16,1,45
+BRDA:96,17,0,46
 BRDA:96,17,1,1
 BRDA:136,18,0,1
-BRDA:136,18,1,72
+BRDA:136,18,1,88
 BRDA:157,19,0,2
 BRDA:157,19,1,1
 BRDA:159,20,0,1
@@ -134,36 +134,44 @@ DA:8,4
 DA:9,4
 DA:10,4
 DA:11,4
+DA:12,4
 DA:13,4
-DA:14,4
 DA:15,4
 DA:16,4
 DA:17,4
 DA:18,4
 DA:19,4
+DA:20,4
 DA:21,4
 DA:22,4
 DA:23,4
-DA:24,4
 DA:25,4
 DA:26,4
 DA:27,4
 DA:28,4
+DA:29,4
 DA:30,4
 DA:31,4
 DA:32,4
 DA:33,4
 DA:34,4
-DA:35,4
 DA:36,4
+DA:37,4
 DA:38,4
+DA:39,4
 DA:40,4
 DA:41,4
 DA:42,4
 DA:43,4
 DA:44,4
-LF:39
-LH:39
+DA:46,4
+DA:48,4
+DA:49,4
+DA:50,4
+DA:51,4
+DA:52,4
+LF:47
+LH:47
 BRF:0
 BRH:0
 end_of_record
@@ -192,16 +200,16 @@ SF:src/utils.ts
 FN:14,findExpiryTime
 FNF:1
 FNH:1
-FNDA:36,findExpiryTime
+FNDA:44,findExpiryTime
 DA:14,4
-DA:15,36
-DA:16,36
-DA:17,36
-DA:18,36
+DA:15,44
+DA:16,44
+DA:17,44
+DA:18,44
 LF:5
 LH:5
 BRDA:17,0,0,0
-BRDA:17,0,1,36
+BRDA:17,0,1,44
 BRF:2
 BRH:1
 end_of_record
@@ -242,6 +250,42 @@ BRF:0
 BRH:0
 end_of_record
 TN:
+SF:src/api/EconomicActivity.ts
+FN:37,calculate
+FN:60,getTypes
+FN:81,getArea
+FN:104,getUnits
+FNF:4
+FNH:4
+FNDA:1,calculate
+FNDA:1,getTypes
+FNDA:1,getArea
+FNDA:1,getUnits
+DA:1,1
+DA:2,1
+DA:9,1
+DA:37,1
+DA:40,1
+DA:41,1
+DA:43,1
+DA:60,1
+DA:62,1
+DA:63,1
+DA:65,1
+DA:81,1
+DA:83,1
+DA:84,1
+DA:86,1
+DA:104,1
+DA:107,1
+DA:108,1
+DA:110,1
+LF:19
+LH:19
+BRF:0
+BRH:0
+end_of_record
+TN:
 SF:src/api/Factor.ts
 FN:44,retrieveFactor
 FN:79,search
@@ -416,6 +460,42 @@ BRF:0
 BRH:0
 end_of_record
 TN:
+SF:src/api/RealEstate.ts
+FN:37,calculate
+FN:60,getTypes
+FN:81,getArea
+FN:105,getUnits
+FNF:4
+FNH:4
+FNDA:1,calculate
+FNDA:1,getTypes
+FNDA:1,getArea
+FNDA:1,getUnits
+DA:1,1
+DA:2,1
+DA:9,1
+DA:37,1
+DA:40,1
+DA:41,1
+DA:43,1
+DA:60,1
+DA:62,1
+DA:63,1
+DA:65,1
+DA:81,1
+DA:83,1
+DA:84,1
+DA:86,1
+DA:105,1
+DA:108,1
+DA:109,1
+DA:111,1
+LF:19
+LH:19
+BRF:0
+BRH:0
+end_of_record
+TN:
 SF:src/api/Stationary.ts
 FN:39,calculate
 FN:62,getTypes

package/dist/index.js

@@ -33,7 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FactorSets = exports.Factor = exports.Usage = exports.TransportationAndDistribution = exports.Calculation = exports.Stationary = exports.Mobile = exports.Fugitive = exports.Location = exports.Client = void 0;
+exports.RealEstate = exports.EconomicActivity = exports.FactorSets = exports.Factor = exports.Usage = exports.TransportationAndDistribution = exports.Calculation = exports.Stationary = exports.Mobile = exports.Fugitive = exports.Location = exports.Client = void 0;
 var Client_1 = require("./Client");
 Object.defineProperty(exports, "Client", { enumerable: true, get: function () { return Client_1.Client; } });
 exports.Location = __importStar(require("./api/Location"));
@@ -45,3 +45,5 @@ exports.TransportationAndDistribution = __importStar(require("./api/Transportati
 exports.Usage = __importStar(require("./api/Usage"));
 exports.Factor = __importStar(require("./api/Factor"));
 exports.FactorSets = __importStar(require("./api/FactorSets"));
+exports.EconomicActivity = __importStar(require("./api/EconomicActivity"));
+exports.RealEstate = __importStar(require("./api/RealEstate"));

package/dist/types/Constants.d.ts

@@ -9,6 +9,8 @@ export declare const TRANSPORTATION_AND_DISTRIBUTION_API_PATH = "/v3/carbon/tran
 export declare const FACTOR_API_PATH = "/v3/carbon/factor";
 export declare const FACTOR_SET_API_PATH = "/v3/carbon/factorset";
 export declare const SEARCH_API_PATH = "/v3/carbon/factor/search";
+export declare const ECONOMIC_ACTIVITY_API_PATH = "/v3/carbon/economic-activity";
+export declare const REAL_ESTATE_API_PATH = "/v3/carbon/real-estate";
 export declare const CALCULATION_TYPES = "/v3/carbon/calculation/types";
 export declare const LOCATION_TYPES = "/v3/carbon/location/types";
 export declare const FUGITIVE_API_TYPES = "/v3/carbon/fugitive/types";
@@ -16,6 +18,8 @@ export declare const MOBILE_API_TYPES = "/v3/carbon/mobile/types";
 export declare const STATIONARY_API_TYPES = "/v3/carbon/stationary/types";
 export declare const FACTOR_API_TYPES = "/v3/carbon/factor/types";
 export declare const TRANSPORTATION_AND_DISTRIBUTION_API_TYPES = "/v3/carbon/transportation-and-distribution/types";
+export declare const REAL_ESTATE_API_TYPES = "/v3/carbon/real-estate/types";
+export declare const ECONOMIC_ACTIVITY_API_TYPES = "/v3/carbon/economic-activity/types";
 export declare const FUGITIVE_API_AREA = "/v3/carbon/fugitive/area";
 export declare const GENERAL_API_AREA = "/v3/carbon/calculation/area";
 export declare const LOCATION_API_AREA = "/v3/carbon/location/area";
@@ -24,6 +28,8 @@ export declare const STATIONARY_API_AREA = "/v3/carbon/stationary/area";
 export declare const TRANSPORTATION_AND_DISTRIBUTION_API_AREA = "/v3/carbon/transportation-and-distribution/area";
 export declare const SEARCH_API_AREA = "/v3/carbon/factor/search/area";
 export declare const FACTOR_API_AREA = "/v3/carbon/factor/area";
+export declare const REAL_ESTATE_API_AREA = "/v3/carbon/real-estate/area";
+export declare const ECONOMIC_ACTIVITY_API_AREA = "/v3/carbon/economic-activity/area";
 export declare const FUGITIVE_API_UNITS = "/v3/carbon/fugitive/units";
 export declare const LOCATION_API_UNITS = "/v3/carbon/location/units";
 export declare const MOBILE_API_UNITS = "/v3/carbon/mobile/units";
@@ -31,6 +37,8 @@ export declare const STATIONARY_API_UNITS = "/v3/carbon/stationary/units";
 export declare const GENERAL_API_UNITS = "/v3/carbon/calculation/units";
 export declare const FACTOR_API_UNITS = "/v3/carbon/factor/units";
 export declare const TRANSPORTATION_AND_DISTRIBUTION_API_UNITS = "/v3/carbon/transportation-and-distribution/units";
+export declare const REAL_ESTATE_API_UNITS = "/v3/carbon/real-estate/units";
+export declare const ECONOMIC_ACTIVITY_API_UNITS = "/v3/carbon/economic-activity/units";
 export declare const USAGE_API = "/v3/carbon/usage";
 export declare const GET = "GET";
 export declare const POST = "POST";

package/dist/types/api/EconomicActivity.d.ts

@@ -0,0 +1,67 @@
+import { CommonRequest } from "../interfaces/Api";
+import { AreaResponse } from "../interfaces/response/AreaResponse";
+import { EmissionResponse } from "../interfaces/response/EmissionResponse";
+import { EmissionResponseWithDetails } from "../interfaces/response/EmissionResponseWithDetails";
+import { TypeResponse } from "../interfaces/response/TypeResponse";
+import { UnitResponse } from "../interfaces/response/UnitResponse";
+/**
+ * Performs scope 3 Spend based emission calculations by making a POST request to the economic activity API endpoint.
+ *
+ * @export
+ * @param {CommonRequest} payload - The request data to be sent to the API
+ * @return {Promise<EmissionResponse | EmissionResponseWithDetails>} A promise that resolves to the emission calculation result. Returns EmissionResponseWithDetails if includeDetails is true, otherwise EmissionResponse
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * const request = {
+    "time": {
+      "date": "2025-01-04"
+    },
+    "location": {
+      "country": "usa"
+    },
+    "activity": {
+      "type": "accomodation",
+      "value": 1500.12,
+      "unit": "usd"
+    },
+    "includeDetails": false
+  };
+ * const result = await calculate(request);
+ */
+export declare function calculate(payload: CommonRequest): Promise<EmissionResponse | EmissionResponseWithDetails>;
+/**
+ * Retrieves available economic activity emission calculation types by making a GET request to the API endpoint.
+ *
+ * @export
+ * @return {Promise<TypeResponse>} A promise that resolves to a TypeResponse containing the available economic activity emission types
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * const types = await getTypes();
+ */
+export declare function getTypes(): Promise<TypeResponse>;
+/**
+ * Retrieves information about geographical areas supported by the economic activity emissions API.
+ *
+ * @export
+ * @return {Promise<AreaResponse>} A promise that resolves to an AreaResponse containing the supported geographical areas
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * const areas = await getArea();
+ */
+export declare function getArea(): Promise<AreaResponse>;
+/**
+ * Retrieves available units for a specific economic activity emission type.
+ *
+ * @export
+ * @param {string} type - The economic activity emission type to get units for (e.g., "accomodation")
+ * @return {Promise<UnitResponse>} A promise that resolves to a UnitResponse containing the available units
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * // Get units for the "accomodation" emission economic activity type without subtype
+ * const units = await getUnits("accomodation");
+ */
+export declare function getUnits(type: string): Promise<UnitResponse>;

package/dist/types/api/RealEstate.d.ts

@@ -0,0 +1,68 @@
+import { CommonRequest } from "../interfaces/Api";
+import { AreaResponse } from "../interfaces/response/AreaResponse";
+import { EmissionResponse } from "../interfaces/response/EmissionResponse";
+import { EmissionResponseWithDetails } from "../interfaces/response/EmissionResponseWithDetails";
+import { TypeResponse } from "../interfaces/response/TypeResponse";
+import { UnitResponse } from "../interfaces/response/UnitResponse";
+/**
+ * Performs scope 3 Real estate emission calculations by making a POST request to the real estate API endpoint.
+ *
+ * @export
+ * @param {CommonRequest} payload - The request data to be sent to the API
+ * @return {Promise<EmissionResponse | EmissionResponseWithDetails>} A promise that resolves to the emission calculation result. Returns EmissionResponseWithDetails if includeDetails is true, otherwise EmissionResponse
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * const request = {
+    "time": {
+      "date": "2025-01-04"
+    },
+    "location": {
+      "country": "usa"
+    },
+    "activity": {
+      "type": "Commercial Real Estate:Industrial distribution warehouse",
+      "value": 17000.123,
+      "unit": "m2"
+    },
+    "includeDetails": false
+  };
+ * const result = await calculate(request);
+ */
+export declare function calculate(payload: CommonRequest): Promise<EmissionResponse | EmissionResponseWithDetails>;
+/**
+ * Retrieves available Real estate emission calculation types by making a GET request to the API endpoint.
+ *
+ * @export
+ * @return {Promise<TypeResponse>} A promise that resolves to a TypeResponse containing the available Real estate emission types
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * const types = await getTypes();
+ */
+export declare function getTypes(): Promise<TypeResponse>;
+/**
+ * Retrieves information about geographical areas supported by the real estate emissions API.
+ *
+ * @export
+ * @return {Promise<AreaResponse>} A promise that resolves to an AreaResponse containing the supported geographical areas
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * const areas = await getArea();
+ */
+export declare function getArea(): Promise<AreaResponse>;
+/**
+ * Retrieves available units for a specific Real estate emission type.
+ *
+ * @export
+ * @param {string} type - The Real estate emission type to get units for (e.g., "R134A")
+ * @return {Promise<UnitResponse>} A promise that resolves to a UnitResponse containing the available units
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * // Get units for the "Commercial Real Estate:Industrial distribution warehouse" emission real estate type with subtype
+ * const units = await getUnits("Commercial Real Estate:Industrial distribution warehouse");
+
+ */
+export declare function getUnits(type: string): Promise<UnitResponse>;

package/dist/types/index.d.ts

@@ -8,6 +8,8 @@ export * as TransportationAndDistribution from './api/TransportationAndDistribut
 export * as Usage from './api/Usage';
 export * as Factor from './api/Factor';
 export * as FactorSets from './api/FactorSets';
+export * as EconomicActivity from './api/EconomicActivity';
+export * as RealEstate from './api/RealEstate';
 export { ClientConfig } from './interfaces/Config';
 export { AreaResponse, Location as LocationInfo } from './interfaces/response/AreaResponse';
 export { EmissionResponse } from './interfaces/response/EmissionResponse';

package/dist/types/interfaces/response/FactorResponse.d.ts

@@ -42,10 +42,6 @@ export interface FactorResponse {
     publishedFrom?: string;
     /** Publication end date in ISO format (optional) */
     publishedTo?: string;
-    /** Effective start date in ISO format (optional) */
-    effectiveFrom?: string;
-    /** Effective end date in ISO format (optional) */
-    effectiveTo?: string;
     /** Geographic region (e.g., "Earth", "India") */
     region: string;
     /** Unique factor identifier */

package/docs/_sources/index.rst.txt

@@ -20,11 +20,13 @@ The **emissions-api-sdk** is a Node.js SDK for using Emissions API in your proje
 Supported Emission Types
 ------------------------
 
-* **Location** – emissions from region-specific factors  
-* **Fugitive** – emissions from leaks or fugitive sources  
-* **Mobile** – emissions from vehicles and mobile equipment  
-* **Stationary** – emissions from fixed fuel consumption  
-* **Transportation & distribution** – logistics and supply chain activities  
-* **Generic** – custom emission calculations  
+* **Location** – emissions from region-specific factors
+* **Fugitive** – emissions from leaks or fugitive sources
+* **Mobile** – emissions from vehicles and mobile equipment
+* **Stationary** – emissions from fixed fuel consumption
+* **Transportation & distribution** – logistics and supply chain activities
+* **Real Estate** – emissions from commercial and residential properties
+* **Economic Activity** – spend-based emissions from business activities
+* **Generic** – custom emission calculations
 
 The SDK is designed for embedding emission calculations in applications, building sustainability dashboards, automating large-scale datasets, and tracking carbon footprints.

package/docs/_sources/reference.rst.txt

@@ -27,6 +27,10 @@ API
 
 .. js:autofunction:: TransportationAndDistribution.calculate
 
+.. js:autofunction:: RealEstate.calculate
+
+.. js:autofunction:: EconomicActivity.calculate
+
 Metadata APIs
 ===========
 
@@ -47,6 +51,10 @@ getTypes
 
 .. js:autofunction:: Fugitive.getTypes
 
+.. js:autofunction:: RealEstate.getTypes
+
+.. js:autofunction:: EconomicActivity.getTypes
+
 getArea
 -------
 
@@ -66,6 +74,10 @@ getArea
 
 .. js:autofunction:: Fugitive.getArea
 
+.. js:autofunction:: RealEstate.getArea
+
+.. js:autofunction:: EconomicActivity.getArea
+
 getUnits
 --------
 
@@ -83,6 +95,10 @@ getUnits
 
 .. js:autofunction:: Fugitive.getUnits
 
+.. js:autofunction:: RealEstate.getUnits
+
+.. js:autofunction:: EconomicActivity.getUnits
+
 
 Usage API
 ===========