emissions-api-sdk 1.0.11 → 1.0.12

package/src/api/TypeRecommender.ts

@@ -13,6 +13,7 @@ import { makeApiRequest } from "../request";
  * @throws {Error} May throw an error if the API request fails
  *
  * @example
+ * // Basic search
  * const result = await search({
     "location": {
       "country": "usa"
@@ -23,6 +24,7 @@ import { makeApiRequest } from "../request";
   });
 
  * @example
+ * // Search with time and pagination
  * const result = await search({
     "location": {
       "country": "usa",
@@ -41,6 +43,7 @@ import { makeApiRequest } from "../request";
   });
  
  * @example
+ * // Search with power grid
  * const result = await search({
     "location": {
       "country": "usa",
@@ -50,6 +53,51 @@ import { makeApiRequest } from "../request";
       "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 async function search(
   payload: SearchRequest

package/src/interfaces/common.ts

@@ -155,6 +155,18 @@ 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;
+   
 }
 
 /**

package/test/mocks/SearchRequest.ts

@@ -16,4 +16,52 @@ const SearchPayload: SearchRequest = {
   }
 };
 
+// Search payload with unit parameter
+export const SearchPayloadWithUnit: SearchRequest = {
+  location: {
+    "country": "usa"
+  },
+  time: {
+    date: "2025-06-10",
+  },
+  activity: {
+    "search": "electricity",
+    "unit": "kWh"
+  }
+};
+
+// Search payload with scope parameter
+export const SearchPayloadWithScope: SearchRequest = {
+  location: {
+    "country": "usa"
+  },
+  time: {
+    date: "2025-06-10",
+  },
+  activity: {
+    "search": "natural gas",
+    "scope": "1"
+  }
+};
+
+// 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
+  }
+};
+
 export default SearchPayload;