emissions-api-sdk 1.0.6 → 1.0.8

package/dist/coverage/lcov.info

@@ -11,10 +11,10 @@ FN:214,(anonymous_8)
 FN:236,(anonymous_9)
 FNF:9
 FNH:7
-FNDA:36,(anonymous_1)
-FNDA:39,(anonymous_2)
-FNDA:64,(anonymous_3)
-FNDA:69,(anonymous_4)
+FNDA:37,(anonymous_1)
+FNDA:40,(anonymous_2)
+FNDA:66,(anonymous_3)
+FNDA:71,(anonymous_4)
 FNDA:3,(anonymous_5)
 FNDA:2,(anonymous_6)
 FNDA:0,(anonymous_7)
@@ -25,36 +25,36 @@ DA:3,5
 DA:4,5
 DA:6,5
 DA:7,5
-DA:24,36
-DA:25,36
-DA:26,36
-DA:27,36
+DA:24,37
+DA:25,37
+DA:26,37
+DA:27,37
 DA:28,1
 DA:29,1
-DA:31,35
-DA:32,35
-DA:35,36
-DA:36,36
-DA:37,36
-DA:38,36
-DA:39,36
-DA:40,36
-DA:78,39
+DA:31,36
+DA:32,36
+DA:35,37
+DA:36,37
+DA:37,37
+DA:38,37
+DA:39,37
+DA:40,37
+DA:78,40
 DA:79,1
-DA:83,38
+DA:83,39
 DA:84,1
-DA:88,37
+DA:88,38
 DA:89,1
-DA:94,36
-DA:96,36
+DA:94,37
+DA:96,37
 DA:97,1
 DA:98,1
-DA:99,35
-DA:100,36
-DA:114,64
-DA:136,69
+DA:99,36
+DA:100,37
+DA:114,66
+DA:136,71
 DA:137,1
-DA:141,68
+DA:141,70
 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,36
+BRDA:24,3,0,37
 BRDA:27,4,0,1
-BRDA:27,4,1,35
+BRDA:27,4,1,36
 BRDA:37,5,0,0
-BRDA:37,5,1,36
-BRDA:37,6,0,36
-BRDA:37,6,1,36
+BRDA:37,5,1,37
+BRDA:37,6,0,37
+BRDA:37,6,1,37
 BRDA:38,7,0,0
-BRDA:38,7,1,36
-BRDA:38,8,0,36
-BRDA:38,8,1,36
+BRDA:38,7,1,37
+BRDA:38,8,0,37
+BRDA:38,8,1,37
 BRDA:40,9,0,0
-BRDA:40,9,1,36
+BRDA:40,9,1,37
 BRDA:78,10,0,1
-BRDA:78,10,1,38
-BRDA:78,11,0,39
+BRDA:78,10,1,39
+BRDA:78,11,0,40
 BRDA:78,11,1,1
 BRDA:83,12,0,1
-BRDA:83,12,1,37
-BRDA:83,13,0,38
+BRDA:83,12,1,38
+BRDA:83,13,0,39
 BRDA:83,13,1,2
 BRDA:88,14,0,1
-BRDA:88,14,1,36
-BRDA:88,15,0,37
-BRDA:88,15,1,36
-BRDA:88,15,2,35
+BRDA:88,14,1,37
+BRDA:88,15,0,38
+BRDA:88,15,1,37
+BRDA:88,15,2,36
 BRDA:96,16,0,1
-BRDA:96,16,1,35
-BRDA:96,17,0,36
+BRDA:96,16,1,36
+BRDA:96,17,0,37
 BRDA:96,17,1,1
 BRDA:136,18,0,1
-BRDA:136,18,1,68
+BRDA:136,18,1,70
 BRDA:157,19,0,2
 BRDA:157,19,1,1
 BRDA:159,20,0,1
@@ -138,15 +138,16 @@ DA:12,5
 DA:13,5
 DA:15,5
 DA:17,5
-DA:18,5
 DA:19,5
+DA:20,5
 DA:21,5
-DA:22,5
 DA:23,5
 DA:24,5
 DA:25,5
-LF:22
-LH:22
+DA:26,5
+DA:27,5
+LF:23
+LH:23
 BRF:0
 BRH:0
 end_of_record
@@ -175,16 +176,16 @@ SF:src/utils.ts
 FN:14,findExpiryTime
 FNF:1
 FNH:1
-FNDA:34,findExpiryTime
+FNDA:35,findExpiryTime
 DA:14,5
-DA:15,34
-DA:16,34
-DA:17,34
-DA:18,34
+DA:15,35
+DA:16,35
+DA:17,35
+DA:18,35
 LF:5
 LH:5
 BRDA:17,0,0,0
-BRDA:17,0,1,34
+BRDA:17,0,1,35
 BRF:2
 BRH:1
 end_of_record
@@ -435,6 +436,24 @@ BRF:0
 BRH:0
 end_of_record
 TN:
+SF:src/api/TypeRecommender.ts
+FN:54,search
+FNF:1
+FNH:1
+FNDA:1,search
+DA:1,1
+DA:2,1
+DA:5,1
+DA:54,1
+DA:57,1
+DA:58,1
+DA:60,1
+LF:7
+LH:7
+BRF:0
+BRH:0
+end_of_record
+TN:
 SF:src/api/Usage.ts
 FN:17,getUsage
 FNF:1

package/dist/index.js

@@ -33,7 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Metadata = 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;
+exports.TypeRecommender = exports.Metadata = 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"));
@@ -48,3 +48,4 @@ exports.FactorSets = __importStar(require("./api/FactorSets"));
 exports.EconomicActivity = __importStar(require("./api/EconomicActivity"));
 exports.RealEstate = __importStar(require("./api/RealEstate"));
 exports.Metadata = __importStar(require("./api/Metadata"));
+exports.TypeRecommender = __importStar(require("./api/TypeRecommender"));

package/dist/interfaces/response/TypeRecommenderResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/Constants.d.ts

@@ -11,6 +11,7 @@ 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 TYPE_RECOMMENDER_API_PATH = "/v3/carbon/recommender/type/search";
 export declare const USAGE_API = "/v3/carbon/usage";
 export declare const METADATA_TYPES_ENDPOINT = "/v3/carbon/metadata/types";
 export declare const METADATA_AREA_ENDPOINT = "/v3/carbon/metadata/area";

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

@@ -0,0 +1,50 @@
+import { SearchRequest } from "../interfaces/Api";
+import { TypeRecommenderResponse } from "../interfaces/response/TypeRecommenderResponse";
+/**
+ * Search for activity types using semantic search with location, time, and license context. Supports pagination.
+ *
+ * @export
+ * @param {SearchRequest} payload - The search request data to be sent to the API
+ * @return {Promise<TypeResponse>} A promise that resolves to the activity types returned by the API
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * const result = await search({
+    "location": {
+      "country": "usa"
+    },
+    "activity": {
+      "search": "electricity"
+    }
+  });
+
+ * @example
+ * const result = await search({
+    "location": {
+      "country": "usa",
+      "stateProvince": "california"
+    },
+    "time": {
+      "date": "2025-06-10"
+    },
+    "activity": {
+      "search": "electricity"
+    },
+    "pagination": {
+      "page": 1,
+      "size": 10
+    }
+  });
+ 
+ * @example
+ * const result = await search({
+    "location": {
+      "country": "usa",
+      "powerGrid": "WECC"
+    },
+    "activity": {
+      "search": "renewable energy"
+    }
+  });
+ */
+export declare function search(payload: SearchRequest): Promise<TypeRecommenderResponse>;

package/dist/types/index.d.ts

@@ -11,6 +11,7 @@ export * as FactorSets from './api/FactorSets';
 export * as EconomicActivity from './api/EconomicActivity';
 export * as RealEstate from './api/RealEstate';
 export * as Metadata from './api/Metadata';
+export * as TypeRecommender from './api/TypeRecommender';
 export { ClientConfig } from './interfaces/Config';
 export { AreaResponse, Location as LocationInfo } from './interfaces/response/AreaResponse';
 export { EmissionResponse } from './interfaces/response/EmissionResponse';
@@ -21,3 +22,4 @@ export { SearchResponse, Pagination, PaginationBody, SearchLink } from './interf
 export { TypeResponse } from './interfaces/response/TypeResponse';
 export { UnitResponse } from './interfaces/response/UnitResponse';
 export { UsageResponse } from './interfaces/response/UsageResponse';
+export { TypeRecommenderResponse, ActivityRequest } from './interfaces/response/TypeRecommenderResponse';

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

@@ -24,6 +24,10 @@ export interface EmissionResponse {
     SF6?: number;
     /** Nitrogen trifluoride emissions value (optional) */
     NF3?: number;
+    /** Energy consumption in megawatt-hours (optional) */
+    'energy(MWh)'?: number;
+    /** Asset turnover ratio (optional) */
+    assetTurnoverRatio?: number;
     /** Unit of measurement for emissions (required) */
     unit: string;
     /** Description of the emission calculation (required) */

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

@@ -24,6 +24,8 @@ export interface FactorResponse {
     SF6?: number;
     /** Nitrogen trifluoride emissions value (optional - not present in all responses) */
     NF3?: number;
+    /** Energy consumption in megawatt-hours (optional) */
+    'energy(MWh)'?: number;
     /** Unit of measurement for emissions */
     unit?: string;
     /** Description of the emission factors (optional)*/

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

@@ -0,0 +1,14 @@
+/**
+ * Interface for type recommender API
+ */
+export interface TypeRecommenderResponse {
+    /** Array of string*/
+    types: ActivityRequest[];
+}
+export interface ActivityRequest {
+    activityType: string;
+    /** Array of string*/
+    activityUnit: string[];
+    activityDescription: string;
+    confidence: number;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "emissions-api-sdk",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "sdk for IBM Emissions APIs",
   "main": "dist/index.js",
   "types": "dist/types/index.d.ts",
@@ -35,21 +35,22 @@
   "author": "santhosh0703,Prakhar-sahu,taylorsteffanj",
   "license": "Apache-2.0",
   "resolutions": {
+    "handlebars": "^4.7.9",
     "markdown-it": "^14.1.1",
-    "minimatch": "^10.2.3",
+    "minimatch": "^10.2.5",
     "test-exclude": "^7.0.1"
   },
   "dependencies": {
-    "axios": "^1.13.5"
+    "axios": "1.15.0"
   },
   "devDependencies": {
     "@types/jest": "^30.0.0",
     "@types/node": "^24.0.4",
     "axios-mock-adapter": "^2.1.0",
-    "jest": "^30.0.5",
+    "jest": "^30.3.0",
     "nock": "^14.0.6",
-    "ts-jest": "^29.4.0",
-    "typedoc": "^0.28.13",
+    "ts-jest": "^29.4.6",
+    "typedoc": "^0.28.18",
     "typescript": "^5.9.2"
   }
 }

package/sphinx-build/requirements.txt

@@ -2,3 +2,4 @@ sphinx==8.1.3
 furo==2025.7.19
 sphinxcontrib-httpdomain==1.8.1
 sphinx-js
+requests==2.33.0

package/src/Constants.ts

@@ -12,6 +12,8 @@ export const SEARCH_API_PATH = "/v3/carbon/factor/search";
 export const ECONOMIC_ACTIVITY_API_PATH = "/v3/carbon/economic-activity";
 export const REAL_ESTATE_API_PATH = "/v3/carbon/real-estate";
 
+export const TYPE_RECOMMENDER_API_PATH = "/v3/carbon/recommender/type/search";
+
 export const USAGE_API = "/v3/carbon/usage";
 
 export const METADATA_TYPES_ENDPOINT = "/v3/carbon/metadata/types";

package/src/api/TypeRecommender.ts

@@ -0,0 +1,65 @@
+import { Client } from "../Client";
+import { TYPE_RECOMMENDER_API_PATH, POST } from "../Constants";
+import { SearchRequest } from "../interfaces/Api";
+import { TypeRecommenderResponse } from "../interfaces/response/TypeRecommenderResponse";
+import { makeApiRequest } from "../request";
+
+/**
+ * Search for activity types using semantic search with location, time, and license context. Supports pagination.
+ *
+ * @export
+ * @param {SearchRequest} payload - The search request data to be sent to the API
+ * @return {Promise<TypeResponse>} A promise that resolves to the activity types returned by the API
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * const result = await search({
+    "location": {
+      "country": "usa"
+    },
+    "activity": {
+      "search": "electricity"
+    }
+  });
+
+ * @example
+ * const result = await search({
+    "location": {
+      "country": "usa",
+      "stateProvince": "california"
+    },
+    "time": {
+      "date": "2025-06-10"
+    },
+    "activity": {
+      "search": "electricity"
+    },
+    "pagination": {
+      "page": 1,
+      "size": 10
+    }
+  });
+ 
+ * @example
+ * const result = await search({
+    "location": {
+      "country": "usa",
+      "powerGrid": "WECC"
+    },
+    "activity": {
+      "search": "renewable energy"
+    }
+  });
+ */
+export async function search(
+  payload: SearchRequest
+): Promise<TypeRecommenderResponse> {
+  const client = Client.getInstance();
+  const url = client.getDomain() + TYPE_RECOMMENDER_API_PATH;
+
+  return makeApiRequest<TypeRecommenderResponse>({
+    method: POST,
+    url,
+    data: payload,
+  });
+}

package/src/index.ts

@@ -11,6 +11,7 @@ export * as FactorSets from './api/FactorSets'
 export * as EconomicActivity from './api/EconomicActivity';
 export * as RealEstate from './api/RealEstate';
 export * as Metadata from './api/Metadata';
+export * as TypeRecommender from './api/TypeRecommender';
 export { ClientConfig } from './interfaces/Config';
 
 // Response interfaces
@@ -44,4 +45,5 @@ export {
 } from './interfaces/response/SearchResponse';
 export { TypeResponse } from './interfaces/response/TypeResponse';
 export { UnitResponse } from './interfaces/response/UnitResponse';
-export { UsageResponse } from './interfaces/response/UsageResponse';
+export { UsageResponse } from './interfaces/response/UsageResponse';
+export { TypeRecommenderResponse, ActivityRequest } from './interfaces/response/TypeRecommenderResponse';

package/src/interfaces/response/EmissionResponse.ts

@@ -35,6 +35,12 @@ export interface EmissionResponse {
   /** Nitrogen trifluoride emissions value (optional) */
   NF3?: number;
 
+  /** Energy consumption in megawatt-hours (optional) */
+  'energy(MWh)'?: number;
+
+  /** Asset turnover ratio (optional) */
+  assetTurnoverRatio?: number;
+
    /** Unit of measurement for emissions (required) */
   unit: string;
   

package/src/interfaces/response/FactorResponse.ts

@@ -36,6 +36,9 @@ export interface FactorResponse {
  NF3?: number;
 
   
+  /** Energy consumption in megawatt-hours (optional) */
+  'energy(MWh)'?: number;
+  
   /** Unit of measurement for emissions */
   unit?: string;
   

package/src/interfaces/response/TypeRecommenderResponse.ts

@@ -0,0 +1,18 @@
+/**
+ * Interface for type recommender API 
+ */
+export interface TypeRecommenderResponse {
+  /** Array of string*/
+  types: ActivityRequest[];
+}
+
+export interface ActivityRequest {
+    activityType: string;
+
+    /** Array of string*/
+    activityUnit: string[];
+
+    activityDescription: string;
+
+    confidence: number;
+}

package/test/apiTest.test.ts

@@ -10,6 +10,7 @@ import * as realEstateApi from "../src/api/RealEstate";
 import * as UsageApi from "../src/api/Usage";
 import * as Factors from "../src/api/Factor";
 import * as FactorSets from "../src/api/FactorSets";
+import * as VectorTypeSearch from "../src/api/TypeRecommender";
 
 import {
   LOCATION_API_PATH,
@@ -24,6 +25,7 @@ import {
   USAGE_API,
   ECONOMIC_ACTIVITY_API_PATH,
   REAL_ESTATE_API_PATH,
+  TYPE_RECOMMENDER_API_PATH,
 } from "../src/Constants";
 import locationPayload from "./mocks/LocationRequest";
 import commonpayload from "./mocks/CommonRequest";
@@ -141,6 +143,13 @@ const testCases: ApiTestCase[] = [
     path: USAGE_API,
     queryParams: { history: false },
     method: "GET",
+  },
+  {
+    name: "VectorTypeSearch API",
+    func: VectorTypeSearch.search,
+    path: TYPE_RECOMMENDER_API_PATH,
+    payload: SearchPayload,
+    method: "POST",
   }
 ];