emissions-api-sdk 1.0.6 → 1.0.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.secrets.baseline +314 -0
- package/README.md +2 -2
- package/dist/Constants.js +2 -1
- package/dist/api/TypeRecommender.js +62 -0
- package/dist/coverage/clover.xml +45 -34
- package/dist/coverage/coverage-final.json +4 -3
- package/dist/coverage/lcov-report/index.html +15 -15
- package/dist/coverage/lcov-report/src/Client.ts.html +22 -22
- package/dist/coverage/lcov-report/src/Constants.ts.html +10 -4
- package/dist/coverage/lcov-report/src/api/Calculation.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/EconomicActivity.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/Factor.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/FactorSets.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/Fugitive.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/Location.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/Metadata.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/Mobile.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/RealEstate.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/Stationary.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/TransportationAndDistribution.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/TypeRecommender.ts.html +277 -0
- package/dist/coverage/lcov-report/src/api/Usage.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/index.html +19 -4
- package/dist/coverage/lcov-report/src/index.html +7 -7
- package/dist/coverage/lcov-report/src/request.ts.html +1 -1
- package/dist/coverage/lcov-report/src/utils.ts.html +5 -5
- package/dist/coverage/lcov-report/test/index.html +1 -1
- package/dist/coverage/lcov-report/test/mocks/CommonRequest.ts.html +1 -1
- package/dist/coverage/lcov-report/test/mocks/FactorRequest.ts.html +1 -1
- package/dist/coverage/lcov-report/test/mocks/GenericCalculationRequest.ts.html +1 -1
- package/dist/coverage/lcov-report/test/mocks/LocationRequest.ts.html +1 -1
- package/dist/coverage/lcov-report/test/mocks/SearchRequest.ts.html +1 -1
- package/dist/coverage/lcov-report/test/mocks/index.html +1 -1
- package/dist/coverage/lcov-report/test/testUtils.ts.html +1 -1
- package/dist/coverage/lcov.info +75 -56
- package/dist/index.js +2 -1
- package/dist/interfaces/response/TypeRecommenderResponse.js +2 -0
- package/dist/types/Constants.d.ts +1 -0
- package/dist/types/api/TypeRecommender.d.ts +50 -0
- package/dist/types/index.d.ts +2 -0
- package/dist/types/interfaces/response/EmissionResponse.d.ts +4 -0
- package/dist/types/interfaces/response/FactorResponse.d.ts +2 -0
- package/dist/types/interfaces/response/TypeRecommenderResponse.d.ts +14 -0
- package/package.json +7 -6
- package/sphinx-build/requirements.txt +1 -0
- package/src/Constants.ts +2 -0
- package/src/api/TypeRecommender.ts +65 -0
- package/src/index.ts +3 -1
- package/src/interfaces/response/EmissionResponse.ts +6 -0
- package/src/interfaces/response/FactorResponse.ts +3 -0
- package/src/interfaces/response/TypeRecommenderResponse.ts +18 -0
- package/test/apiTest.test.ts +9 -0
|
@@ -0,0 +1,314 @@
|
|
|
1
|
+
{
|
|
2
|
+
"exclude": {
|
|
3
|
+
"files": "^.secrets.baseline$",
|
|
4
|
+
"lines": null
|
|
5
|
+
},
|
|
6
|
+
"generated_at": "2026-03-05T05:02:32Z",
|
|
7
|
+
"plugins_used": [
|
|
8
|
+
{
|
|
9
|
+
"name": "AWSKeyDetector"
|
|
10
|
+
},
|
|
11
|
+
{
|
|
12
|
+
"name": "ArtifactoryDetector"
|
|
13
|
+
},
|
|
14
|
+
{
|
|
15
|
+
"name": "AzureStorageKeyDetector"
|
|
16
|
+
},
|
|
17
|
+
{
|
|
18
|
+
"base64_limit": 4.5,
|
|
19
|
+
"name": "Base64HighEntropyString"
|
|
20
|
+
},
|
|
21
|
+
{
|
|
22
|
+
"name": "BasicAuthDetector"
|
|
23
|
+
},
|
|
24
|
+
{
|
|
25
|
+
"name": "BoxDetector"
|
|
26
|
+
},
|
|
27
|
+
{
|
|
28
|
+
"name": "CloudantDetector"
|
|
29
|
+
},
|
|
30
|
+
{
|
|
31
|
+
"ghe_instance": "github.ibm.com",
|
|
32
|
+
"name": "GheDetector"
|
|
33
|
+
},
|
|
34
|
+
{
|
|
35
|
+
"name": "GitHubTokenDetector"
|
|
36
|
+
},
|
|
37
|
+
{
|
|
38
|
+
"hex_limit": 3,
|
|
39
|
+
"name": "HexHighEntropyString"
|
|
40
|
+
},
|
|
41
|
+
{
|
|
42
|
+
"name": "IbmCloudIamDetector"
|
|
43
|
+
},
|
|
44
|
+
{
|
|
45
|
+
"name": "IbmCosHmacDetector"
|
|
46
|
+
},
|
|
47
|
+
{
|
|
48
|
+
"name": "JwtTokenDetector"
|
|
49
|
+
},
|
|
50
|
+
{
|
|
51
|
+
"keyword_exclude": null,
|
|
52
|
+
"name": "KeywordDetector"
|
|
53
|
+
},
|
|
54
|
+
{
|
|
55
|
+
"name": "MailchimpDetector"
|
|
56
|
+
},
|
|
57
|
+
{
|
|
58
|
+
"name": "NpmDetector"
|
|
59
|
+
},
|
|
60
|
+
{
|
|
61
|
+
"name": "PrivateKeyDetector"
|
|
62
|
+
},
|
|
63
|
+
{
|
|
64
|
+
"name": "SlackDetector"
|
|
65
|
+
},
|
|
66
|
+
{
|
|
67
|
+
"name": "SoftlayerDetector"
|
|
68
|
+
},
|
|
69
|
+
{
|
|
70
|
+
"name": "SquareOAuthDetector"
|
|
71
|
+
},
|
|
72
|
+
{
|
|
73
|
+
"name": "StripeDetector"
|
|
74
|
+
},
|
|
75
|
+
{
|
|
76
|
+
"name": "TwilioKeyDetector"
|
|
77
|
+
}
|
|
78
|
+
],
|
|
79
|
+
"results": {
|
|
80
|
+
"README.md": [
|
|
81
|
+
{
|
|
82
|
+
"hashed_secret": "9eddf3741c2ec20058940c3225b3e387cf6166dd",
|
|
83
|
+
"is_verified": false,
|
|
84
|
+
"line_number": 90,
|
|
85
|
+
"type": "Secret Keyword",
|
|
86
|
+
"verified_result": null
|
|
87
|
+
}
|
|
88
|
+
],
|
|
89
|
+
"docs/_sources/authentication.rst.txt": [
|
|
90
|
+
{
|
|
91
|
+
"hashed_secret": "d92258e9826f7923e5fa45241420653a89db10b0",
|
|
92
|
+
"is_verified": false,
|
|
93
|
+
"line_number": 41,
|
|
94
|
+
"type": "Secret Keyword",
|
|
95
|
+
"verified_result": null
|
|
96
|
+
},
|
|
97
|
+
{
|
|
98
|
+
"hashed_secret": "9eddf3741c2ec20058940c3225b3e387cf6166dd",
|
|
99
|
+
"is_verified": false,
|
|
100
|
+
"line_number": 152,
|
|
101
|
+
"type": "Secret Keyword",
|
|
102
|
+
"verified_result": null
|
|
103
|
+
}
|
|
104
|
+
],
|
|
105
|
+
"docs/_sources/client.rst.txt": [
|
|
106
|
+
{
|
|
107
|
+
"hashed_secret": "9eddf3741c2ec20058940c3225b3e387cf6166dd",
|
|
108
|
+
"is_verified": false,
|
|
109
|
+
"line_number": 108,
|
|
110
|
+
"type": "Secret Keyword",
|
|
111
|
+
"verified_result": null
|
|
112
|
+
}
|
|
113
|
+
],
|
|
114
|
+
"docs/_sources/getting_started.rst.txt": [
|
|
115
|
+
{
|
|
116
|
+
"hashed_secret": "11fa7c37d697f30e6aee828b4426a10f83ab2380",
|
|
117
|
+
"is_verified": false,
|
|
118
|
+
"line_number": 122,
|
|
119
|
+
"type": "Secret Keyword",
|
|
120
|
+
"verified_result": null
|
|
121
|
+
}
|
|
122
|
+
],
|
|
123
|
+
"docs/_sources/troubleshooting.rst.txt": [
|
|
124
|
+
{
|
|
125
|
+
"hashed_secret": "ade7ae7ec3dcbc8e6efab2ad366fd59b4be60bda",
|
|
126
|
+
"is_verified": false,
|
|
127
|
+
"line_number": 129,
|
|
128
|
+
"type": "Secret Keyword",
|
|
129
|
+
"verified_result": null
|
|
130
|
+
},
|
|
131
|
+
{
|
|
132
|
+
"hashed_secret": "24de2a83c833555a5931a357cb9a639830db7851",
|
|
133
|
+
"is_verified": false,
|
|
134
|
+
"line_number": 191,
|
|
135
|
+
"type": "Secret Keyword",
|
|
136
|
+
"verified_result": null
|
|
137
|
+
},
|
|
138
|
+
{
|
|
139
|
+
"hashed_secret": "11fa7c37d697f30e6aee828b4426a10f83ab2380",
|
|
140
|
+
"is_verified": false,
|
|
141
|
+
"line_number": 224,
|
|
142
|
+
"type": "Secret Keyword",
|
|
143
|
+
"verified_result": null
|
|
144
|
+
}
|
|
145
|
+
],
|
|
146
|
+
"docs/authentication.html": [
|
|
147
|
+
{
|
|
148
|
+
"hashed_secret": "7460410433c137c8124a7681126863dcc0172caa",
|
|
149
|
+
"is_verified": false,
|
|
150
|
+
"line_number": 287,
|
|
151
|
+
"type": "Secret Keyword",
|
|
152
|
+
"verified_result": null
|
|
153
|
+
},
|
|
154
|
+
{
|
|
155
|
+
"hashed_secret": "93f64017194ac1d984f80fc133f60bb9ec09215a",
|
|
156
|
+
"is_verified": false,
|
|
157
|
+
"line_number": 417,
|
|
158
|
+
"type": "Secret Keyword",
|
|
159
|
+
"verified_result": null
|
|
160
|
+
}
|
|
161
|
+
],
|
|
162
|
+
"docs/getting_started.html": [
|
|
163
|
+
{
|
|
164
|
+
"hashed_secret": "93f64017194ac1d984f80fc133f60bb9ec09215a",
|
|
165
|
+
"is_verified": false,
|
|
166
|
+
"line_number": 289,
|
|
167
|
+
"type": "Secret Keyword",
|
|
168
|
+
"verified_result": null
|
|
169
|
+
}
|
|
170
|
+
],
|
|
171
|
+
"docs/searchindex.js": [
|
|
172
|
+
{
|
|
173
|
+
"hashed_secret": "0c46900fa1fdf1610a99248b86d76554966d69c6",
|
|
174
|
+
"is_verified": false,
|
|
175
|
+
"line_number": 1,
|
|
176
|
+
"type": "Hex High Entropy String",
|
|
177
|
+
"verified_result": null
|
|
178
|
+
}
|
|
179
|
+
],
|
|
180
|
+
"sphinx-build/source/authentication.rst": [
|
|
181
|
+
{
|
|
182
|
+
"hashed_secret": "d92258e9826f7923e5fa45241420653a89db10b0",
|
|
183
|
+
"is_verified": false,
|
|
184
|
+
"line_number": 41,
|
|
185
|
+
"type": "Secret Keyword",
|
|
186
|
+
"verified_result": null
|
|
187
|
+
},
|
|
188
|
+
{
|
|
189
|
+
"hashed_secret": "9eddf3741c2ec20058940c3225b3e387cf6166dd",
|
|
190
|
+
"is_verified": false,
|
|
191
|
+
"line_number": 152,
|
|
192
|
+
"type": "Secret Keyword",
|
|
193
|
+
"verified_result": null
|
|
194
|
+
}
|
|
195
|
+
],
|
|
196
|
+
"sphinx-build/source/client.rst": [
|
|
197
|
+
{
|
|
198
|
+
"hashed_secret": "9eddf3741c2ec20058940c3225b3e387cf6166dd",
|
|
199
|
+
"is_verified": false,
|
|
200
|
+
"line_number": 108,
|
|
201
|
+
"type": "Secret Keyword",
|
|
202
|
+
"verified_result": null
|
|
203
|
+
}
|
|
204
|
+
],
|
|
205
|
+
"sphinx-build/source/getting_started.rst": [
|
|
206
|
+
{
|
|
207
|
+
"hashed_secret": "11fa7c37d697f30e6aee828b4426a10f83ab2380",
|
|
208
|
+
"is_verified": false,
|
|
209
|
+
"line_number": 122,
|
|
210
|
+
"type": "Secret Keyword",
|
|
211
|
+
"verified_result": null
|
|
212
|
+
}
|
|
213
|
+
],
|
|
214
|
+
"sphinx-build/source/troubleshooting.rst": [
|
|
215
|
+
{
|
|
216
|
+
"hashed_secret": "ade7ae7ec3dcbc8e6efab2ad366fd59b4be60bda",
|
|
217
|
+
"is_verified": false,
|
|
218
|
+
"line_number": 129,
|
|
219
|
+
"type": "Secret Keyword",
|
|
220
|
+
"verified_result": null
|
|
221
|
+
},
|
|
222
|
+
{
|
|
223
|
+
"hashed_secret": "24de2a83c833555a5931a357cb9a639830db7851",
|
|
224
|
+
"is_verified": false,
|
|
225
|
+
"line_number": 191,
|
|
226
|
+
"type": "Secret Keyword",
|
|
227
|
+
"verified_result": null
|
|
228
|
+
},
|
|
229
|
+
{
|
|
230
|
+
"hashed_secret": "11fa7c37d697f30e6aee828b4426a10f83ab2380",
|
|
231
|
+
"is_verified": false,
|
|
232
|
+
"line_number": 224,
|
|
233
|
+
"type": "Secret Keyword",
|
|
234
|
+
"verified_result": null
|
|
235
|
+
}
|
|
236
|
+
],
|
|
237
|
+
"src/Client.ts": [
|
|
238
|
+
{
|
|
239
|
+
"hashed_secret": "1f5e25be9b575e9f5d39c82dfd1d9f4d73f1975c",
|
|
240
|
+
"is_verified": false,
|
|
241
|
+
"line_number": 24,
|
|
242
|
+
"type": "Secret Keyword",
|
|
243
|
+
"verified_result": null
|
|
244
|
+
},
|
|
245
|
+
{
|
|
246
|
+
"hashed_secret": "6303c901093123ff7019188dcd12b2e18d4d9827",
|
|
247
|
+
"is_verified": false,
|
|
248
|
+
"line_number": 28,
|
|
249
|
+
"type": "Secret Keyword",
|
|
250
|
+
"verified_result": null
|
|
251
|
+
},
|
|
252
|
+
{
|
|
253
|
+
"hashed_secret": "f5cbae85fb47446511da4c9974e2da448caee7e1",
|
|
254
|
+
"is_verified": false,
|
|
255
|
+
"line_number": 31,
|
|
256
|
+
"type": "Secret Keyword",
|
|
257
|
+
"verified_result": null
|
|
258
|
+
},
|
|
259
|
+
{
|
|
260
|
+
"hashed_secret": "65e622227634e8876cfa733000233fb80c6f0473",
|
|
261
|
+
"is_verified": false,
|
|
262
|
+
"line_number": 162,
|
|
263
|
+
"type": "Secret Keyword",
|
|
264
|
+
"verified_result": null
|
|
265
|
+
},
|
|
266
|
+
{
|
|
267
|
+
"hashed_secret": "11fa7c37d697f30e6aee828b4426a10f83ab2380",
|
|
268
|
+
"is_verified": false,
|
|
269
|
+
"line_number": 230,
|
|
270
|
+
"type": "Secret Keyword",
|
|
271
|
+
"verified_result": null
|
|
272
|
+
},
|
|
273
|
+
{
|
|
274
|
+
"hashed_secret": "68672f6baf3b3e9b3a80f7baa87e7a95a0ec2afb",
|
|
275
|
+
"is_verified": false,
|
|
276
|
+
"line_number": 240,
|
|
277
|
+
"type": "Secret Keyword",
|
|
278
|
+
"verified_result": null
|
|
279
|
+
}
|
|
280
|
+
],
|
|
281
|
+
"test/apiTest.test.ts": [
|
|
282
|
+
{
|
|
283
|
+
"hashed_secret": "c7139c95c9298c5ca457688f5c1d2e11ffbecc91",
|
|
284
|
+
"is_verified": false,
|
|
285
|
+
"line_number": 163,
|
|
286
|
+
"type": "Secret Keyword",
|
|
287
|
+
"verified_result": null
|
|
288
|
+
}
|
|
289
|
+
],
|
|
290
|
+
"test/client.test.ts": [
|
|
291
|
+
{
|
|
292
|
+
"hashed_secret": "2ace62c1befa19e3ea37dd52be9f6d508c5163e6",
|
|
293
|
+
"is_verified": false,
|
|
294
|
+
"line_number": 19,
|
|
295
|
+
"type": "Secret Keyword",
|
|
296
|
+
"verified_result": null
|
|
297
|
+
}
|
|
298
|
+
],
|
|
299
|
+
"test/metadata.test.ts": [
|
|
300
|
+
{
|
|
301
|
+
"hashed_secret": "c7139c95c9298c5ca457688f5c1d2e11ffbecc91",
|
|
302
|
+
"is_verified": false,
|
|
303
|
+
"line_number": 184,
|
|
304
|
+
"type": "Secret Keyword",
|
|
305
|
+
"verified_result": null
|
|
306
|
+
}
|
|
307
|
+
]
|
|
308
|
+
},
|
|
309
|
+
"version": "0.13.1+ibm.64.dss",
|
|
310
|
+
"word_list": {
|
|
311
|
+
"file": null,
|
|
312
|
+
"hash": null
|
|
313
|
+
}
|
|
314
|
+
}
|
package/README.md
CHANGED
|
@@ -4,11 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
The `emissions-api-sdk` is a Node.js SDK for using Emissions API in your projects.
|
|
6
6
|
|
|
7
|
-
## Sign up
|
|
7
|
+
## Sign up
|
|
8
8
|
|
|
9
9
|
To get started with the Emissions API follow these steps:
|
|
10
10
|
|
|
11
|
-
- Sign up
|
|
11
|
+
- Sign up at the [IBMid sign up](https://www.ibm.com/account/reg/us-en/signup?formid=urx-54311) page.
|
|
12
12
|
- You will be sent an invite email to join to create an account.
|
|
13
13
|
- Read the [Introduction](https://developer.ibm.com/apis/catalog/ghgemissions--ibm-envizi-emissions-api/Introduction) page to get an overview of the Emissions API.
|
|
14
14
|
|
package/dist/Constants.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.CLIENT_SOURCE_SDK = exports.CLIENT_SOURCE_EXCEL = exports.CLIENT_SOURCE_HEADER = exports.POST = exports.GET = exports.METADATA_UNITS_ENDPOINT = exports.METADATA_AREA_ENDPOINT = exports.METADATA_TYPES_ENDPOINT = exports.USAGE_API = exports.REAL_ESTATE_API_PATH = exports.ECONOMIC_ACTIVITY_API_PATH = exports.SEARCH_API_PATH = exports.FACTOR_SET_API_PATH = exports.FACTOR_API_PATH = exports.TRANSPORTATION_AND_DISTRIBUTION_API_PATH = exports.GENERIC_CALCULATION_API_PATH = exports.STATIONARY_API_PATH = exports.FUGITIVE_API_PATH = exports.LOCATION_API_PATH = exports.MOBILE_API_PATH = exports.TOKEN_GENERATION_API = exports.API_DOMAIN = void 0;
|
|
3
|
+
exports.CLIENT_SOURCE_SDK = exports.CLIENT_SOURCE_EXCEL = exports.CLIENT_SOURCE_HEADER = exports.POST = exports.GET = exports.METADATA_UNITS_ENDPOINT = exports.METADATA_AREA_ENDPOINT = exports.METADATA_TYPES_ENDPOINT = exports.USAGE_API = exports.TYPE_RECOMMENDER_API_PATH = exports.REAL_ESTATE_API_PATH = exports.ECONOMIC_ACTIVITY_API_PATH = exports.SEARCH_API_PATH = exports.FACTOR_SET_API_PATH = exports.FACTOR_API_PATH = exports.TRANSPORTATION_AND_DISTRIBUTION_API_PATH = exports.GENERIC_CALCULATION_API_PATH = exports.STATIONARY_API_PATH = exports.FUGITIVE_API_PATH = exports.LOCATION_API_PATH = exports.MOBILE_API_PATH = exports.TOKEN_GENERATION_API = exports.API_DOMAIN = void 0;
|
|
4
4
|
exports.API_DOMAIN = "https://api.ibm.com/ghgemissions/run";
|
|
5
5
|
exports.TOKEN_GENERATION_API = "https://api.ibm.com/saascore/run/authentication-retrieve/api-key";
|
|
6
6
|
exports.MOBILE_API_PATH = "/v3/carbon/mobile";
|
|
@@ -14,6 +14,7 @@ exports.FACTOR_SET_API_PATH = "/v3/carbon/factorset";
|
|
|
14
14
|
exports.SEARCH_API_PATH = "/v3/carbon/factor/search";
|
|
15
15
|
exports.ECONOMIC_ACTIVITY_API_PATH = "/v3/carbon/economic-activity";
|
|
16
16
|
exports.REAL_ESTATE_API_PATH = "/v3/carbon/real-estate";
|
|
17
|
+
exports.TYPE_RECOMMENDER_API_PATH = "/v3/carbon/recommender/type/search";
|
|
17
18
|
exports.USAGE_API = "/v3/carbon/usage";
|
|
18
19
|
exports.METADATA_TYPES_ENDPOINT = "/v3/carbon/metadata/types";
|
|
19
20
|
exports.METADATA_AREA_ENDPOINT = "/v3/carbon/metadata/area";
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.search = search;
|
|
4
|
+
const Client_1 = require("../Client");
|
|
5
|
+
const Constants_1 = require("../Constants");
|
|
6
|
+
const request_1 = require("../request");
|
|
7
|
+
/**
|
|
8
|
+
* Search for activity types using semantic search with location, time, and license context. Supports pagination.
|
|
9
|
+
*
|
|
10
|
+
* @export
|
|
11
|
+
* @param {SearchRequest} payload - The search request data to be sent to the API
|
|
12
|
+
* @return {Promise<TypeResponse>} A promise that resolves to the activity types returned by the API
|
|
13
|
+
* @throws {Error} May throw an error if the API request fails
|
|
14
|
+
*
|
|
15
|
+
* @example
|
|
16
|
+
* const result = await search({
|
|
17
|
+
"location": {
|
|
18
|
+
"country": "usa"
|
|
19
|
+
},
|
|
20
|
+
"activity": {
|
|
21
|
+
"search": "electricity"
|
|
22
|
+
}
|
|
23
|
+
});
|
|
24
|
+
|
|
25
|
+
* @example
|
|
26
|
+
* const result = await search({
|
|
27
|
+
"location": {
|
|
28
|
+
"country": "usa",
|
|
29
|
+
"stateProvince": "california"
|
|
30
|
+
},
|
|
31
|
+
"time": {
|
|
32
|
+
"date": "2025-06-10"
|
|
33
|
+
},
|
|
34
|
+
"activity": {
|
|
35
|
+
"search": "electricity"
|
|
36
|
+
},
|
|
37
|
+
"pagination": {
|
|
38
|
+
"page": 1,
|
|
39
|
+
"size": 10
|
|
40
|
+
}
|
|
41
|
+
});
|
|
42
|
+
|
|
43
|
+
* @example
|
|
44
|
+
* const result = await search({
|
|
45
|
+
"location": {
|
|
46
|
+
"country": "usa",
|
|
47
|
+
"powerGrid": "WECC"
|
|
48
|
+
},
|
|
49
|
+
"activity": {
|
|
50
|
+
"search": "renewable energy"
|
|
51
|
+
}
|
|
52
|
+
});
|
|
53
|
+
*/
|
|
54
|
+
async function search(payload) {
|
|
55
|
+
const client = Client_1.Client.getInstance();
|
|
56
|
+
const url = client.getDomain() + Constants_1.TYPE_RECOMMENDER_API_PATH;
|
|
57
|
+
return (0, request_1.makeApiRequest)({
|
|
58
|
+
method: Constants_1.POST,
|
|
59
|
+
url,
|
|
60
|
+
data: payload,
|
|
61
|
+
});
|
|
62
|
+
}
|
package/dist/coverage/clover.xml
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
<?xml version="1.0" encoding="UTF-8"?>
|
|
2
|
-
<coverage generated="
|
|
3
|
-
<project timestamp="
|
|
4
|
-
<metrics statements="
|
|
2
|
+
<coverage generated="1776072361790" clover="3.2.0">
|
|
3
|
+
<project timestamp="1776072361790" name="All files">
|
|
4
|
+
<metrics statements="215" coveredstatements="213" conditionals="60" coveredconditionals="53" methods="31" coveredmethods="29" elements="306" coveredelements="295" complexity="0" loc="215" ncloc="215" packages="4" files="23" classes="23"/>
|
|
5
5
|
<package name="src">
|
|
6
|
-
<metrics statements="
|
|
6
|
+
<metrics statements="86" coveredstatements="84" conditionals="47" coveredconditionals="41" methods="11" coveredmethods="9"/>
|
|
7
7
|
<file name="Client.ts" path="/Users/santhosh/Documents/GIT/open-source/ibm-envizi-emissions-api-nodejs-sdk/src/Client.ts">
|
|
8
8
|
<metrics statements="49" coveredstatements="47" conditionals="45" coveredconditionals="40" methods="9" coveredmethods="7"/>
|
|
9
9
|
<line num="1" count="5" type="stmt"/>
|
|
@@ -11,36 +11,36 @@
|
|
|
11
11
|
<line num="4" count="5" type="stmt"/>
|
|
12
12
|
<line num="6" count="5" type="stmt"/>
|
|
13
13
|
<line num="7" count="5" type="stmt"/>
|
|
14
|
-
<line num="24" count="
|
|
15
|
-
<line num="25" count="
|
|
16
|
-
<line num="26" count="
|
|
17
|
-
<line num="27" count="
|
|
14
|
+
<line num="24" count="37" type="cond" truecount="3" falsecount="0"/>
|
|
15
|
+
<line num="25" count="37" type="stmt"/>
|
|
16
|
+
<line num="26" count="37" type="stmt"/>
|
|
17
|
+
<line num="27" count="37" type="cond" truecount="2" falsecount="0"/>
|
|
18
18
|
<line num="28" count="1" type="stmt"/>
|
|
19
19
|
<line num="29" count="1" type="stmt"/>
|
|
20
|
-
<line num="31" count="
|
|
21
|
-
<line num="32" count="
|
|
22
|
-
<line num="35" count="
|
|
23
|
-
<line num="36" count="
|
|
24
|
-
<line num="37" count="
|
|
25
|
-
<line num="38" count="
|
|
26
|
-
<line num="39" count="
|
|
27
|
-
<line num="40" count="
|
|
28
|
-
<line num="78" count="
|
|
20
|
+
<line num="31" count="36" type="stmt"/>
|
|
21
|
+
<line num="32" count="36" type="stmt"/>
|
|
22
|
+
<line num="35" count="37" type="stmt"/>
|
|
23
|
+
<line num="36" count="37" type="stmt"/>
|
|
24
|
+
<line num="37" count="37" type="cond" truecount="3" falsecount="1"/>
|
|
25
|
+
<line num="38" count="37" type="cond" truecount="3" falsecount="1"/>
|
|
26
|
+
<line num="39" count="37" type="stmt"/>
|
|
27
|
+
<line num="40" count="37" type="cond" truecount="1" falsecount="1"/>
|
|
28
|
+
<line num="78" count="40" type="cond" truecount="4" falsecount="0"/>
|
|
29
29
|
<line num="79" count="1" type="stmt"/>
|
|
30
|
-
<line num="83" count="
|
|
30
|
+
<line num="83" count="39" type="cond" truecount="4" falsecount="0"/>
|
|
31
31
|
<line num="84" count="1" type="stmt"/>
|
|
32
|
-
<line num="88" count="
|
|
32
|
+
<line num="88" count="38" type="cond" truecount="5" falsecount="0"/>
|
|
33
33
|
<line num="89" count="1" type="stmt"/>
|
|
34
|
-
<line num="94" count="
|
|
35
|
-
<line num="96" count="
|
|
34
|
+
<line num="94" count="37" type="stmt"/>
|
|
35
|
+
<line num="96" count="37" type="cond" truecount="4" falsecount="0"/>
|
|
36
36
|
<line num="97" count="1" type="stmt"/>
|
|
37
37
|
<line num="98" count="1" type="stmt"/>
|
|
38
|
-
<line num="99" count="
|
|
39
|
-
<line num="100" count="
|
|
40
|
-
<line num="114" count="
|
|
41
|
-
<line num="136" count="
|
|
38
|
+
<line num="99" count="36" type="stmt"/>
|
|
39
|
+
<line num="100" count="37" type="stmt"/>
|
|
40
|
+
<line num="114" count="66" type="stmt"/>
|
|
41
|
+
<line num="136" count="71" type="cond" truecount="2" falsecount="0"/>
|
|
42
42
|
<line num="137" count="1" type="stmt"/>
|
|
43
|
-
<line num="141" count="
|
|
43
|
+
<line num="141" count="70" type="stmt"/>
|
|
44
44
|
<line num="157" count="3" type="cond" truecount="2" falsecount="0"/>
|
|
45
45
|
<line num="158" count="2" type="stmt"/>
|
|
46
46
|
<line num="159" count="2" type="cond" truecount="2" falsecount="0"/>
|
|
@@ -57,7 +57,7 @@
|
|
|
57
57
|
<line num="250" count="4" type="stmt"/>
|
|
58
58
|
</file>
|
|
59
59
|
<file name="Constants.ts" path="/Users/santhosh/Documents/GIT/open-source/ibm-envizi-emissions-api-nodejs-sdk/src/Constants.ts">
|
|
60
|
-
<metrics statements="
|
|
60
|
+
<metrics statements="23" coveredstatements="23" conditionals="0" coveredconditionals="0" methods="0" coveredmethods="0"/>
|
|
61
61
|
<line num="1" count="5" type="stmt"/>
|
|
62
62
|
<line num="2" count="5" type="stmt"/>
|
|
63
63
|
<line num="3" count="5" type="stmt"/>
|
|
@@ -73,13 +73,14 @@
|
|
|
73
73
|
<line num="13" count="5" type="stmt"/>
|
|
74
74
|
<line num="15" count="5" type="stmt"/>
|
|
75
75
|
<line num="17" count="5" type="stmt"/>
|
|
76
|
-
<line num="18" count="5" type="stmt"/>
|
|
77
76
|
<line num="19" count="5" type="stmt"/>
|
|
77
|
+
<line num="20" count="5" type="stmt"/>
|
|
78
78
|
<line num="21" count="5" type="stmt"/>
|
|
79
|
-
<line num="22" count="5" type="stmt"/>
|
|
80
79
|
<line num="23" count="5" type="stmt"/>
|
|
81
80
|
<line num="24" count="5" type="stmt"/>
|
|
82
81
|
<line num="25" count="5" type="stmt"/>
|
|
82
|
+
<line num="26" count="5" type="stmt"/>
|
|
83
|
+
<line num="27" count="5" type="stmt"/>
|
|
83
84
|
</file>
|
|
84
85
|
<file name="request.ts" path="/Users/santhosh/Documents/GIT/open-source/ibm-envizi-emissions-api-nodejs-sdk/src/request.ts">
|
|
85
86
|
<metrics statements="9" coveredstatements="9" conditionals="0" coveredconditionals="0" methods="1" coveredmethods="1"/>
|
|
@@ -96,14 +97,14 @@
|
|
|
96
97
|
<file name="utils.ts" path="/Users/santhosh/Documents/GIT/open-source/ibm-envizi-emissions-api-nodejs-sdk/src/utils.ts">
|
|
97
98
|
<metrics statements="5" coveredstatements="5" conditionals="2" coveredconditionals="1" methods="1" coveredmethods="1"/>
|
|
98
99
|
<line num="14" count="5" type="stmt"/>
|
|
99
|
-
<line num="15" count="
|
|
100
|
-
<line num="16" count="
|
|
101
|
-
<line num="17" count="
|
|
102
|
-
<line num="18" count="
|
|
100
|
+
<line num="15" count="35" type="stmt"/>
|
|
101
|
+
<line num="16" count="35" type="stmt"/>
|
|
102
|
+
<line num="17" count="35" type="cond" truecount="1" falsecount="1"/>
|
|
103
|
+
<line num="18" count="35" type="stmt"/>
|
|
103
104
|
</file>
|
|
104
105
|
</package>
|
|
105
106
|
<package name="src.api">
|
|
106
|
-
<metrics statements="
|
|
107
|
+
<metrics statements="115" coveredstatements="115" conditionals="13" coveredconditionals="12" methods="19" coveredmethods="19"/>
|
|
107
108
|
<file name="Calculation.ts" path="/Users/santhosh/Documents/GIT/open-source/ibm-envizi-emissions-api-nodejs-sdk/src/api/Calculation.ts">
|
|
108
109
|
<metrics statements="7" coveredstatements="7" conditionals="0" coveredconditionals="0" methods="1" coveredmethods="1"/>
|
|
109
110
|
<line num="1" count="1" type="stmt"/>
|
|
@@ -238,6 +239,16 @@
|
|
|
238
239
|
<line num="37" count="1" type="stmt"/>
|
|
239
240
|
<line num="39" count="1" type="stmt"/>
|
|
240
241
|
</file>
|
|
242
|
+
<file name="TypeRecommender.ts" path="/Users/santhosh/Documents/GIT/open-source/ibm-envizi-emissions-api-nodejs-sdk/src/api/TypeRecommender.ts">
|
|
243
|
+
<metrics statements="7" coveredstatements="7" conditionals="0" coveredconditionals="0" methods="1" coveredmethods="1"/>
|
|
244
|
+
<line num="1" count="1" type="stmt"/>
|
|
245
|
+
<line num="2" count="1" type="stmt"/>
|
|
246
|
+
<line num="5" count="1" type="stmt"/>
|
|
247
|
+
<line num="54" count="1" type="stmt"/>
|
|
248
|
+
<line num="57" count="1" type="stmt"/>
|
|
249
|
+
<line num="58" count="1" type="stmt"/>
|
|
250
|
+
<line num="60" count="1" type="stmt"/>
|
|
251
|
+
</file>
|
|
241
252
|
<file name="Usage.ts" path="/Users/santhosh/Documents/GIT/open-source/ibm-envizi-emissions-api-nodejs-sdk/src/api/Usage.ts">
|
|
242
253
|
<metrics statements="7" coveredstatements="7" conditionals="1" coveredconditionals="0" methods="1" coveredmethods="1"/>
|
|
243
254
|
<line num="1" count="1" type="stmt"/>
|