emissions-api-sdk 1.0.8 → 1.0.10

package/dist/coverage/lcov.info

@@ -1,123 +1,162 @@
 TN:
 SF:src/Client.ts
-FN:19,(anonymous_1)
-FN:77,(anonymous_2)
-FN:113,(anonymous_3)
-FN:135,(anonymous_4)
-FN:156,(anonymous_5)
-FN:186,(anonymous_6)
-FN:200,(anonymous_7)
-FN:214,(anonymous_8)
-FN:236,(anonymous_9)
-FNF:9
-FNH:7
-FNDA:37,(anonymous_1)
-FNDA:40,(anonymous_2)
+FN:20,(anonymous_1)
+FN:87,(anonymous_2)
+FN:137,(anonymous_3)
+FN:159,(anonymous_4)
+FN:180,(anonymous_5)
+FN:219,(anonymous_6)
+FN:233,(anonymous_7)
+FN:247,(anonymous_8)
+FN:269,(anonymous_9)
+FN:303,(anonymous_10)
+FNF:10
+FNH:8
+FNDA:43,(anonymous_1)
+FNDA:48,(anonymous_2)
 FNDA:66,(anonymous_3)
-FNDA:71,(anonymous_4)
-FNDA:3,(anonymous_5)
-FNDA:2,(anonymous_6)
+FNDA:77,(anonymous_4)
+FNDA:6,(anonymous_5)
+FNDA:4,(anonymous_6)
 FNDA:0,(anonymous_7)
 FNDA:0,(anonymous_8)
 FNDA:4,(anonymous_9)
+FNDA:8,(anonymous_10)
 DA:1,5
 DA:3,5
 DA:4,5
 DA:6,5
 DA:7,5
-DA:24,37
-DA:25,37
-DA:26,37
-DA:27,37
-DA:28,1
+DA:25,43
+DA:26,43
+DA:27,43
+DA:28,43
 DA:29,1
-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,39
-DA:84,1
-DA:88,38
+DA:30,1
+DA:31,1
+DA:33,42
+DA:34,42
+DA:35,42
+DA:38,43
+DA:39,43
+DA:40,43
+DA:41,43
+DA:42,43
+DA:43,43
+DA:88,48
 DA:89,1
-DA:94,37
-DA:96,37
-DA:97,1
-DA:98,1
-DA:99,36
-DA:100,37
-DA:114,66
-DA:136,71
-DA:137,1
-DA:141,70
-DA:157,3
-DA:158,2
-DA:159,2
-DA:160,1
+DA:93,47
+DA:94,1
+DA:98,46
+DA:99,1
+DA:103,45
+DA:104,1
+DA:108,44
+DA:109,1
+DA:114,43
+DA:116,43
+DA:117,1
+DA:118,1
+DA:119,42
+DA:120,6
+DA:122,36
+DA:124,43
+DA:138,66
+DA:160,77
 DA:161,1
-DA:167,1
-DA:168,1
+DA:165,76
+DA:181,6
+DA:182,5
+DA:183,5
+DA:184,3
+DA:186,3
 DA:187,2
-DA:201,0
-DA:215,0
-DA:237,4
-DA:238,4
-DA:249,4
-DA:250,4
-LF:49
-LH:47
-BRDA:22,0,0,0
-BRDA:24,1,0,1
-BRDA:24,2,0,1
-BRDA:24,3,0,37
-BRDA:27,4,0,1
-BRDA:27,4,1,36
-BRDA:37,5,0,0
-BRDA:37,5,1,37
-BRDA:37,6,0,37
-BRDA:37,6,1,37
-BRDA:38,7,0,0
-BRDA:38,7,1,37
-BRDA:38,8,0,37
-BRDA:38,8,1,37
-BRDA:40,9,0,0
-BRDA:40,9,1,37
-BRDA:78,10,0,1
-BRDA:78,10,1,39
-BRDA:78,11,0,40
-BRDA:78,11,1,1
-BRDA:83,12,0,1
-BRDA:83,12,1,38
-BRDA:83,13,0,39
-BRDA:83,13,1,2
-BRDA:88,14,0,1
-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,36
-BRDA:96,17,0,37
-BRDA:96,17,1,1
-BRDA:136,18,0,1
-BRDA:136,18,1,70
-BRDA:157,19,0,2
-BRDA:157,19,1,1
-BRDA:159,20,0,1
-BRDA:159,20,1,1
-BRDA:237,21,0,1
-BRDA:237,21,1,3
-BRDA:237,22,0,4
-BRDA:237,22,1,4
-BRDA:249,23,0,0
-BRDA:249,23,1,4
-BRF:45
-BRH:40
+DA:193,1
+DA:200,3
+DA:201,3
+DA:220,4
+DA:234,0
+DA:248,0
+DA:270,4
+DA:271,4
+DA:282,4
+DA:283,4
+DA:304,8
+DA:305,8
+DA:313,8
+DA:314,8
+LF:63
+LH:61
+BRDA:23,0,0,0
+BRDA:25,1,0,7
+BRDA:25,2,0,37
+BRDA:25,3,0,7
+BRDA:25,4,0,43
+BRDA:28,5,0,1
+BRDA:28,5,1,42
+BRDA:40,6,0,0
+BRDA:40,6,1,43
+BRDA:40,7,0,43
+BRDA:40,7,1,43
+BRDA:41,8,0,2
+BRDA:41,8,1,41
+BRDA:41,9,0,43
+BRDA:41,9,1,43
+BRDA:41,10,0,4
+BRDA:41,10,1,37
+BRDA:43,11,0,0
+BRDA:43,11,1,43
+BRDA:88,12,0,1
+BRDA:88,12,1,47
+BRDA:88,13,0,48
+BRDA:88,13,1,1
+BRDA:93,14,0,1
+BRDA:93,14,1,46
+BRDA:93,15,0,47
+BRDA:93,15,1,2
+BRDA:98,16,0,1
+BRDA:98,16,1,45
+BRDA:98,17,0,46
+BRDA:98,17,1,37
+BRDA:98,17,2,36
+BRDA:103,18,0,1
+BRDA:103,18,1,44
+BRDA:103,19,0,45
+BRDA:103,19,1,8
+BRDA:108,20,0,1
+BRDA:108,20,1,43
+BRDA:108,21,0,44
+BRDA:108,21,1,7
+BRDA:116,22,0,1
+BRDA:116,22,1,42
+BRDA:116,23,0,43
+BRDA:116,23,1,1
+BRDA:119,24,0,6
+BRDA:119,24,1,36
+BRDA:119,25,0,42
+BRDA:119,25,1,6
+BRDA:160,26,0,1
+BRDA:160,26,1,76
+BRDA:181,27,0,5
+BRDA:181,27,1,1
+BRDA:183,28,0,3
+BRDA:183,28,1,2
+BRDA:186,29,0,2
+BRDA:186,29,1,1
+BRDA:270,30,0,1
+BRDA:270,30,1,3
+BRDA:270,31,0,4
+BRDA:270,31,1,4
+BRDA:282,32,0,0
+BRDA:282,32,1,4
+BRDA:304,33,0,4
+BRDA:304,33,1,4
+BRDA:304,34,0,8
+BRDA:304,34,1,8
+BRDA:313,35,0,0
+BRDA:313,35,1,8
+BRF:68
+BRH:63
 end_of_record
 TN:
 SF:src/Constants.ts
@@ -136,18 +175,19 @@ DA:10,5
 DA:11,5
 DA:12,5
 DA:13,5
-DA:15,5
-DA:17,5
-DA:19,5
+DA:14,5
+DA:16,5
+DA:18,5
 DA:20,5
 DA:21,5
-DA:23,5
+DA:22,5
 DA:24,5
 DA:25,5
 DA:26,5
 DA:27,5
-LF:23
-LH:23
+DA:28,5
+LF:24
+LH:24
 BRF:0
 BRH:0
 end_of_record
@@ -176,16 +216,16 @@ SF:src/utils.ts
 FN:14,findExpiryTime
 FNF:1
 FNH:1
-FNDA:35,findExpiryTime
+FNDA:38,findExpiryTime
 DA:14,5
-DA:15,35
-DA:16,35
-DA:17,35
-DA:18,35
+DA:15,38
+DA:16,38
+DA:17,38
+DA:18,38
 LF:5
 LH:5
 BRDA:17,0,0,0
-BRDA:17,0,1,35
+BRDA:17,0,1,38
 BRF:2
 BRH:1
 end_of_record
@@ -477,11 +517,11 @@ SF:test/testUtils.ts
 FN:1,generateMockjwt
 FNF:1
 FNH:1
-FNDA:3,generateMockjwt
+FNDA:8,generateMockjwt
 DA:1,1
-DA:2,3
-DA:3,3
-DA:4,3
+DA:2,8
+DA:3,8
+DA:4,8
 LF:4
 LH:4
 BRF:0

package/dist/types/Client.d.ts

@@ -3,6 +3,7 @@ export declare class Client {
     private static instance;
     private token;
     private readonly apiKey;
+    private readonly patToken;
     private readonly clientId;
     private readonly orgId;
     private expiresAt;
@@ -21,6 +22,7 @@ export declare class Client {
      *  - custom "host" is provided without "authUrl"
      *  - token is provided without "clientId"
      *  - apiKey is provided without "clientId" or "orgId"
+     *  - patToken is provided without "clientId" or with "orgId"
      *
      * @example
      * // Initialize with authentication URL
@@ -43,6 +45,12 @@ export declare class Client {
      *   clientId: 'client123',
      *   orgId: 'org456'
      * });
+     *
+     * // Initialize with PAT token
+     * await Client.getClient({
+     *   patToken: 'your-personal-access-token',
+     *   clientId: 'client123'
+     * });
      */
     static getClient(config: ClientConfig): Promise<void>;
     /**
@@ -143,4 +151,22 @@ export declare class Client {
      * });
      */
     private static requestToken;
+    /**
+     * Requests an authentication token by exchanging a Personal Access Token (PAT).
+     *
+     * @private
+     * @static
+     * @param {ClientConfig} config - The client configuration containing PAT and client details
+     * @return {Promise<string>} A promise that resolves to the authentication token string
+     * @throws {Error} Throws an error if the token response is empty
+     *
+     * @example
+     * // Internal usage within the Client class
+     * const token = await Client.requestTokenFromPAT({
+     *   patToken: 'your-personal-access-token',
+     *   clientId: 'client123',
+     *   authUrl: 'https://custom-auth.example.com/exchange'
+     * });
+     */
+    private static requestTokenFromPAT;
 }

package/dist/types/Constants.d.ts

@@ -1,5 +1,6 @@
 export declare const API_DOMAIN = "https://api.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";
 export declare const LOCATION_API_PATH = "/v3/carbon/location";
 export declare const FUGITIVE_API_PATH = "/v3/carbon/fugitive";

package/dist/types/index.d.ts

@@ -15,7 +15,7 @@ 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';
-export { EmissionResponseWithDetails, UnitInfo, AreaInfo, AreaType, FactorDataTypeCategory, FactorSetInfo, FactorSelectionDefault, FactorDataTypeCode, FactorSetVersion, FactorValue, FactorMetaData, UnitConversion, EmissionData } from './interfaces/response/EmissionResponseWithDetails';
+export { EmissionResponseWithDetails, FactorDetails, FactorSetDetails, IncludeDetails } from './interfaces/response/EmissionResponseWithDetails';
 export { FactorResponse } from './interfaces/response/FactorResponse';
 export { FactorSetResponse, FactorSet } from './interfaces/response/FactorSetResponse';
 export { SearchResponse, Pagination, PaginationBody, SearchLink } from './interfaces/response/SearchResponse';

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

@@ -58,6 +58,12 @@ export interface ClientConfig {
      * If provided, it will be used instead of requesting a new token.
      */
     token?: string;
+    /**
+     * Optional Personal Access Token (PAT) for authentication.
+     * If provided, it will be exchanged for a JWT token.
+     * Requires clientId to be provided.
+     */
+    patToken?: string;
     /**
      * Optional flag indicating whether the client is running as an Excel Add-In.
      * This may affect certain behaviors like authentication flows.

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

@@ -1,148 +1,86 @@
 import { EmissionResponse } from './EmissionResponse';
 /**
- * Interface for unit information in emission details
+ * Interface for factor set details
  */
-export interface UnitInfo {
-    /** Unit name */
-    name: string;
-    /** Unit description (optional) */
-    description?: string;
-}
-/**
- * Interface for area information
- */
-export interface AreaInfo {
-    /** Internal name of the area */
-    internalName: string;
-    /** Standard name of the area */
-    standardName: string;
-    alpha3?: string;
-}
-/**
- * Interface for area type information
- */
-export interface AreaType {
-    /** Type name (e.g., "Planet", "State") */
-    name: string;
-}
-/**
- * Interface for factor data type categories
- */
-export interface FactorDataTypeCategory {
-    /** Category name */
-    name: string;
-}
-/**
- * Interface for factor set information
- */
-export interface FactorSetInfo {
-    /** Factor set type */
-    type: string;
+export interface FactorSetDetails {
+    /** Name of the factor set */
+    name?: string;
     /** Description of the factor set */
     description?: string;
     /** Provider of the factor set */
     provider?: string;
     /** Source URL for the factor set */
     sourceUrl?: string;
-    factorSource?: string;
-}
-export interface FactorSelectionDefault {
-    actorDataType?: string;
-    areaName?: string;
-    factorSetName?: string;
+    /** Citation information for the factor set */
+    citation?: string;
 }
 /**
- * Interface for factor data type code
+ * Interface for factor details
  */
-export interface FactorDataTypeCode {
-    /** Unit of measure */
-    unitOfMeasure: string;
-    /** Activity type */
-    type: string;
+export interface FactorDetails {
+    /** Name of the factor */
+    name?: string;
+    /** Description of the factor */
+    description?: string;
+    /** Total CO2 equivalent emissions */
+    totalCO2e?: number;
+    /** CO2 emissions value */
+    CO2?: number;
+    /** CH4 (Methane) emissions value */
+    CH4?: number;
+    /** N2O (Nitrous Oxide) emissions value */
+    N2O?: number;
+    /** Biogenic CO2 emissions value */
+    bioCO2?: number;
+    /** Indirect CO2 equivalent emissions value */
+    indirectCO2e?: number;
+    /** Hydrofluorocarbon emissions value */
+    HFC?: number;
+    /** Perfluorocarbon emissions value */
+    PFC?: number;
+    /** Sulfur hexafluoride emissions value */
+    SF6?: number;
+    /** Nitrogen trifluoride emissions value */
+    NF3?: number;
+    /** Energy consumption in megawatt-hours */
+    'energy(MWh)'?: number;
+    /** Input unit of measurement */
+    inputUnit?: string;
+    /** Unit of measurement for emissions */
+    unit?: string;
+    /** Conversion ratio */
+    conversionRatio?: string;
+    /** Type of activity */
+    activityType?: string;
     /** Activity subtype */
-    subtype: string;
+    activitySubtype?: string;
     /** Unique factor identifier */
-    factorId: number;
-    /** activity based or spend based */
-    methodology: string;
-    /** scopes data belongs to */
-    scope: string[];
-}
-/**
- * Interface for factor set version information
- */
-export interface FactorSetVersion {
+    factorId?: number;
+    /** Methodology (activity based or spend based) */
+    methodology?: string;
+    /** Scopes data belongs to */
+    scopes?: string[];
+    /** Area name */
+    areaName?: string;
+    /** Area type */
+    areaType?: string;
     /** Publication start date */
     publishedFrom?: string;
-    /** Publication end date (optional) */
+    /** Publication end date */
     publishedTo?: string;
     /** Source of the factor */
-    factorSource: string;
-}
-/**
- * Interface for factor value
- */
-export interface FactorValue {
-    /** Unit information */
-    unit: {
-        /** Unit name */
-        name: string;
-    };
-    /** Factor value */
-    value: number;
-}
-/**
- * Interface for factor metadata
- */
-export interface FactorMetaData {
-    /** Metadata key */
-    key: string;
-    /** Metadata value */
-    value: string;
-}
-/**
- * Interface for unit conversion information
- */
-export interface UnitConversion {
-    /** Input unit */
-    inputUnit: string;
-    /** Unit from database */
-    unitFromDb: string;
-    /** Conversion ratio */
-    conversionRatio: string;
+    source?: string;
 }
 /**
- * Interface for detailed emission data
+ * Interface for include details
  */
-export interface EmissionData {
-    /** Array of unit information */
-    unit: UnitInfo[];
-    /** Array of area information */
-    area: AreaInfo[];
-    /** Array of area types */
-    areaType: AreaType[];
-    /** Array of factor data type categories */
-    factorDataTypeCategories: FactorDataTypeCategory[];
-    factorSelectionDefault?: FactorSelectionDefault[];
-    /** Array of factor set information */
-    factorSet: FactorSetInfo[];
-    /** Array of factor data type codes */
-    factorDataTypeCode: FactorDataTypeCode[];
-    /** Array of factor set versions */
-    factorSetVersion: FactorSetVersion[];
-    /** Array of factor values */
-    factorValue: FactorValue[];
-    /** Array of factor metadata */
-    factorMetaData: FactorMetaData[];
-    /** Array of unit conversions */
-    unitConversion: UnitConversion[];
+export interface IncludeDetails {
+    /** Factor set details */
+    factorSet?: FactorSetDetails;
+    /** Factor details */
+    factor?: FactorDetails;
 }
-/**
- * Interface representing the emission calculation response with detailed information
- */
-export interface EmissionResponseWithDetails {
-    /** Emission calculation result */
-    result: EmissionResponse;
+export interface EmissionResponseWithDetails extends EmissionResponse {
     /** Detailed emission data */
-    data: EmissionData;
+    details?: IncludeDetails;
 }

package/docs/reference.html

@@ -400,6 +400,12 @@ Only refreshes if the token was not provided by the user and is expiring within
 <span class="w">  </span><span class="nx">clientId</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;client123&#39;</span><span class="p">,</span>
 <span class="w">  </span><span class="nx">orgId</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;org456&#39;</span>
 <span class="p">});</span>
+
+<span class="c1">// Initialize with PAT token</span>
+<span class="k">await</span><span class="w"> </span><span class="nx">Client</span><span class="p">.</span><span class="nx">getClient</span><span class="p">({</span>
+<span class="w">  </span><span class="nx">patToken</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;your-personal-access-token&#39;</span><span class="p">,</span>
+<span class="w">  </span><span class="nx">clientId</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;client123&#39;</span>
+<span class="p">});</span>
 </pre></div>
 </div>
 </div>
@@ -838,8 +844,8 @@ Only refreshes if the token was not provided by the user and is expiring within
 <li><p><strong>getUnits/postUnits</strong>: Accept an optional <code class="docutils literal notranslate"><span class="pre">type</span></code> parameter to query units for specific emission types</p></li>
 </ul>
 <p><strong>Supported endpoints</strong> (for getTypes/postTypes and getArea/postArea): <code class="docutils literal notranslate"><span class="pre">calculation</span></code>, <code class="docutils literal notranslate"><span class="pre">location</span></code>, <code class="docutils literal notranslate"><span class="pre">stationary</span></code>, <code class="docutils literal notranslate"><span class="pre">mobile</span></code>, <code class="docutils literal notranslate"><span class="pre">fugitive</span></code>, <code class="docutils literal notranslate"><span class="pre">factor</span></code>, <code class="docutils literal notranslate"><span class="pre">search</span></code>, <code class="docutils literal notranslate"><span class="pre">transportation-and-distribution</span></code>, <code class="docutils literal notranslate"><span class="pre">economic-activity</span></code>, <code class="docutils literal notranslate"><span class="pre">real-estate</span></code></p>
-<section id="id1">
-<h3>getTypes<a class="headerlink" href="#id1" title="Link to this heading">¶</a></h3>
+<section id="gettypes">
+<h3>getTypes<a class="headerlink" href="#gettypes" title="Link to this heading">¶</a></h3>
 <dl class="js function">
 <dt class="sig sig-object js" id="Metadata.getTypes">
 <em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="n"><span class="pre">Metadata</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">getTypes</span></span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#Metadata.getTypes" title="Link to this definition">¶</a></dt>