emissions-api-sdk 1.0.10 → 1.0.12

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

@@ -25,7 +25,7 @@
             <div class='fl pad1y space-right2'>
                 <span class="strong">100% </span>
                 <span class="quiet">Statements</span>
-                <span class='fraction'>2/2</span>
+                <span class='fraction'>5/5</span>
             </div>
         
             
@@ -46,7 +46,7 @@
             <div class='fl pad1y space-right2'>
                 <span class="strong">100% </span>
                 <span class="quiet">Lines</span>
-                <span class='fraction'>2/2</span>
+                <span class='fraction'>5/5</span>
             </div>
         
             
@@ -82,7 +82,55 @@
 <a name='L17'></a><a href='#L17'>17</a>
 <a name='L18'></a><a href='#L18'>18</a>
 <a name='L19'></a><a href='#L19'>19</a>
-<a name='L20'></a><a href='#L20'>20</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
+<a name='L20'></a><a href='#L20'>20</a>
+<a name='L21'></a><a href='#L21'>21</a>
+<a name='L22'></a><a href='#L22'>22</a>
+<a name='L23'></a><a href='#L23'>23</a>
+<a name='L24'></a><a href='#L24'>24</a>
+<a name='L25'></a><a href='#L25'>25</a>
+<a name='L26'></a><a href='#L26'>26</a>
+<a name='L27'></a><a href='#L27'>27</a>
+<a name='L28'></a><a href='#L28'>28</a>
+<a name='L29'></a><a href='#L29'>29</a>
+<a name='L30'></a><a href='#L30'>30</a>
+<a name='L31'></a><a href='#L31'>31</a>
+<a name='L32'></a><a href='#L32'>32</a>
+<a name='L33'></a><a href='#L33'>33</a>
+<a name='L34'></a><a href='#L34'>34</a>
+<a name='L35'></a><a href='#L35'>35</a>
+<a name='L36'></a><a href='#L36'>36</a>
+<a name='L37'></a><a href='#L37'>37</a>
+<a name='L38'></a><a href='#L38'>38</a>
+<a name='L39'></a><a href='#L39'>39</a>
+<a name='L40'></a><a href='#L40'>40</a>
+<a name='L41'></a><a href='#L41'>41</a>
+<a name='L42'></a><a href='#L42'>42</a>
+<a name='L43'></a><a href='#L43'>43</a>
+<a name='L44'></a><a href='#L44'>44</a>
+<a name='L45'></a><a href='#L45'>45</a>
+<a name='L46'></a><a href='#L46'>46</a>
+<a name='L47'></a><a href='#L47'>47</a>
+<a name='L48'></a><a href='#L48'>48</a>
+<a name='L49'></a><a href='#L49'>49</a>
+<a name='L50'></a><a href='#L50'>50</a>
+<a name='L51'></a><a href='#L51'>51</a>
+<a name='L52'></a><a href='#L52'>52</a>
+<a name='L53'></a><a href='#L53'>53</a>
+<a name='L54'></a><a href='#L54'>54</a>
+<a name='L55'></a><a href='#L55'>55</a>
+<a name='L56'></a><a href='#L56'>56</a>
+<a name='L57'></a><a href='#L57'>57</a>
+<a name='L58'></a><a href='#L58'>58</a>
+<a name='L59'></a><a href='#L59'>59</a>
+<a name='L60'></a><a href='#L60'>60</a>
+<a name='L61'></a><a href='#L61'>61</a>
+<a name='L62'></a><a href='#L62'>62</a>
+<a name='L63'></a><a href='#L63'>63</a>
+<a name='L64'></a><a href='#L64'>64</a>
+<a name='L65'></a><a href='#L65'>65</a>
+<a name='L66'></a><a href='#L66'>66</a>
+<a name='L67'></a><a href='#L67'>67</a>
+<a name='L68'></a><a href='#L68'>68</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">1x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
@@ -100,6 +148,54 @@
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">1x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">1x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">1x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">1x</span>
 <span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">import { SearchRequest } from "../../src/interfaces/Api";
 &nbsp;
@@ -119,6 +215,54 @@ const SearchPayload: SearchRequest = {
   }
 };
 &nbsp;
+// Search payload with unit parameter
+export const SearchPayloadWithUnit: SearchRequest = {
+  location: {
+    "country": "usa"
+  },
+  time: {
+    date: "2025-06-10",
+  },
+  activity: {
+    "search": "electricity",
+    "unit": "kWh"
+  }
+};
+&nbsp;
+// Search payload with scope parameter
+export const SearchPayloadWithScope: SearchRequest = {
+  location: {
+    "country": "usa"
+  },
+  time: {
+    date: "2025-06-10",
+  },
+  activity: {
+    "search": "natural gas",
+    "scope": "1"
+  }
+};
+&nbsp;
+// Search payload with both unit and scope parameters
+export const SearchPayloadWithBoth: SearchRequest = {
+  location: {
+    "country": "usa",
+    "stateProvince": "california"
+  },
+  time: {
+    date: "2025-06-10",
+  },
+  activity: {
+    "search": "electricity",
+    "unit": "MWh",
+    "scope": "2"
+  },
+  pagination:{
+    "page": 1,
+    "size": 10
+  }
+};
+&nbsp;
 export default SearchPayload;
 &nbsp;</pre></td></tr></table></pre>
 
@@ -127,7 +271,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-04-28T12:54:24.682Z
+                at 2026-05-11T08:42:18.203Z
             </div>
         <script src="../../prettify.js"></script>
         <script>

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

@@ -25,7 +25,7 @@
             <div class='fl pad1y space-right2'>
                 <span class="strong">100% </span>
                 <span class="quiet">Statements</span>
-                <span class='fraction'>10/10</span>
+                <span class='fraction'>13/13</span>
             </div>
         
             
@@ -46,7 +46,7 @@
             <div class='fl pad1y space-right2'>
                 <span class="strong">100% </span>
                 <span class="quiet">Lines</span>
-                <span class='fraction'>10/10</span>
+                <span class='fraction'>13/13</span>
             </div>
         
             
@@ -144,13 +144,13 @@
 	<div class="chart"><div class="cover-fill cover-full" style="width: 100%"></div><div class="cover-empty" style="width: 0%"></div></div>
 	</td>
 	<td data-value="100" class="pct high">100%</td>
-	<td data-value="2" class="abs high">2/2</td>
+	<td data-value="5" class="abs high">5/5</td>
 	<td data-value="100" class="pct high">100%</td>
 	<td data-value="0" class="abs high">0/0</td>
 	<td data-value="100" class="pct high">100%</td>
 	<td data-value="0" class="abs high">0/0</td>
 	<td data-value="100" class="pct high">100%</td>
-	<td data-value="2" class="abs high">2/2</td>
+	<td data-value="5" class="abs high">5/5</td>
 	</tr>
 
 </tbody>
@@ -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-04-28T12:54:24.682Z
+                at 2026-05-11T08:42:18.203Z
             </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-04-28T12:54:24.682Z
+                at 2026-05-11T08:42:18.203Z
             </div>
         <script src="../prettify.js"></script>
         <script>

package/dist/coverage/lcov.info

@@ -268,7 +268,7 @@ end_of_record
 TN:
 SF:src/api/Factor.ts
 FN:41,retrieveFactor
-FN:76,search
+FN:128,search
 FNF:2
 FNH:2
 FNDA:1,retrieveFactor
@@ -280,10 +280,10 @@ DA:41,1
 DA:44,1
 DA:45,1
 DA:47,1
-DA:76,1
-DA:79,1
-DA:80,1
-DA:82,1
+DA:128,1
+DA:131,1
+DA:132,1
+DA:134,1
 LF:11
 LH:11
 BRF:0
@@ -477,17 +477,17 @@ BRH:0
 end_of_record
 TN:
 SF:src/api/TypeRecommender.ts
-FN:54,search
+FN:102,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
+DA:102,1
+DA:105,1
+DA:106,1
+DA:108,1
 LF:7
 LH:7
 BRF:0
@@ -576,9 +576,12 @@ SF:test/mocks/SearchRequest.ts
 FNF:0
 FNH:0
 DA:3,1
-DA:19,1
-LF:2
-LH:2
+DA:20,1
+DA:34,1
+DA:48,1
+DA:67,1
+LF:5
+LH:5
 BRF:0
 BRH:0
 end_of_record

package/dist/types/Constants.d.ts

@@ -1,4 +1,4 @@
-export declare const API_DOMAIN = "https://api.ibm.com/ghgemissions/run";
+export declare const API_DOMAIN = "https://api.envizi.ibm.com/ghgemissions/run";
 export declare const TOKEN_GENERATION_API = "https://api.ibm.com/saascore/run/authentication-retrieve/api-key";
 export declare const PAT_TOKEN_EXCHANGE_API = "https://api.ibm.com/saascore/run/envizi-auth/exchange";
 export declare const MOBILE_API_PATH = "/v3/carbon/mobile";

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

@@ -43,16 +43,68 @@ export declare function retrieveFactor(payload: FactorRequest): Promise<FactorRe
  * @throws {Error} May throw an error if the API request fails
  *
  * @example
+ * // Basic search
  * const searchRequest = {
     "time":{
       "date": "2020-06-10"
     },
     "activity": {
-      "search" : "travel"},
+      "search" : "travel"
+    },
     "location": {
       "country": "USA"
     }
   };
  * const results = await search(searchRequest);
+ *
+ * @example
+ * // Search with optional unit parameter
+ * const searchWithUnit = {
+    "time":{
+      "date": "2020-06-10"
+    },
+    "activity": {
+      "search": "electricity",
+      "unit": "kWh"
+    },
+    "location": {
+      "country": "USA"
+    }
+  };
+ * const results = await search(searchWithUnit);
+ *
+ * @example
+ * // Search with optional scope parameter
+ * const searchWithScope = {
+    "time":{
+      "date": "2020-06-10"
+    },
+    "activity": {
+      "search": "natural gas",
+      "scope": "1"
+    },
+    "location": {
+      "country": "USA"
+    }
+  };
+ * const results = await search(searchWithScope);
+ *
+ * @example
+ * // Search with both unit and scope parameters
+ * const searchWithBoth = {
+    "time":{
+      "date": "2020-06-10"
+    },
+    "activity": {
+      "search": "electricity",
+      "unit": "MWh",
+      "scope": "2"
+    },
+    "location": {
+      "country": "USA",
+      "stateProvince": "california"
+    }
+  };
+ * const results = await search(searchWithBoth);
  */
 export declare function search(payload: SearchRequest): Promise<SearchResponse>;

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

@@ -9,6 +9,7 @@ import { TypeRecommenderResponse } from "../interfaces/response/TypeRecommenderR
  * @throws {Error} May throw an error if the API request fails
  *
  * @example
+ * // Basic search
  * const result = await search({
     "location": {
       "country": "usa"
@@ -19,6 +20,7 @@ import { TypeRecommenderResponse } from "../interfaces/response/TypeRecommenderR
   });
 
  * @example
+ * // Search with time and pagination
  * const result = await search({
     "location": {
       "country": "usa",
@@ -37,6 +39,7 @@ import { TypeRecommenderResponse } from "../interfaces/response/TypeRecommenderR
   });
  
  * @example
+ * // Search with power grid
  * const result = await search({
     "location": {
       "country": "usa",
@@ -46,5 +49,50 @@ import { TypeRecommenderResponse } from "../interfaces/response/TypeRecommenderR
       "search": "renewable energy"
     }
   });
+ *
+ * @example
+ * // Search with optional unit parameter
+ * const result = await search({
+    "location": {
+      "country": "usa"
+    },
+    "activity": {
+      "search": "electricity",
+      "unit": "kWh"
+    }
+  });
+ *
+ * @example
+ * // Search with optional scope parameter
+ * const result = await search({
+    "location": {
+      "country": "usa"
+    },
+    "activity": {
+      "search": "natural gas",
+      "scope": "1"
+    }
+  });
+ *
+ * @example
+ * // Search with both unit and scope parameters
+ * const result = await search({
+    "location": {
+      "country": "usa",
+      "stateProvince": "california"
+    },
+    "time": {
+      "date": "2025-06-10"
+    },
+    "activity": {
+      "search": "electricity",
+      "unit": "MWh",
+      "scope": "2"
+    },
+    "pagination": {
+      "page": 1,
+      "size": 10
+    }
+  });
  */
 export declare function search(payload: SearchRequest): Promise<TypeRecommenderResponse>;

package/dist/types/interfaces/common.d.ts

@@ -135,6 +135,14 @@ export interface SearchActivity {
      * The search query string.
      */
     search: string;
+    /**
+     * Optional unit (symbol) for search activity.
+     */
+    unit?: string;
+    /**
+     * Optional scope(1,2,3,3.1 to 3.15) for search activity.
+     */
+    scope?: string;
 }
 /**
  * Represents pagination parameters for paginated results.