@dimo-network/data-sdk 1.2.1

package/.credentials.json.example

@@ -0,0 +1,5 @@
+{
+  "client_id": "",
+  "private_key": "",
+  "redirect_uri": ""
+}

package/.eslintrc.json

@@ -0,0 +1,20 @@
+{
+    "env": {
+        "browser": true,
+        "es2021": true
+    },
+    "extends": [
+        "airbnb-base",
+        "prettier/@typescript-eslint"
+    ],
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": "latest",
+        "sourceType": "module"
+    },
+    "plugins": [
+        "@typescript-eslint"
+    ],
+    "rules": {
+    }
+}

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,42 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is published
+# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+
+name: Publish Package to npm
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20
+      - run: npm ci
+      - run: npm test
+      - name: Run build
+        run: npm run build
+      - name: Check dist directory
+        run: ls dist/
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm test
+      - name: Run build
+        run: npm run build
+      - name: Check dist directory
+        run: ls dist/
+      - run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/CONTRIBUTING.md

@@ -0,0 +1,82 @@
+# Contributing to DIMO SDK
+Thank you for your interest in contributing to the DIMO Hello World repository! We're excited to collaborate with the community to expand the collection of examples showcasing the diverse capabilities of DIMO's platform, including our REST API, Streamr integration, GraphQL API, and more.
+
+## REST API Resource Data Structure
+In the SDK, each `functionName` maps to a specific path for an API endpoint, the `method` will be passed in the corresponding HTTP calls. The SDK supports CRUD operations for a REST API but also includes a `FUNCTION` method to call utility functions. Add `queryParams`, `body`, `headers`, `auth`, and `return` according to how the endpoint behaves.
+
+- `body` and `queryParams`, : Sets the requirements for body or query parameters. Anything that is marked `true` will be required, whereas `false` marks it as optional. You can also pass in a fixed strings for constants. To source the value of one query parameter from another query parameter, you can simply prepend a `$` (i.e. `queryParam3: '$queryParam1'` fixes queryParam3 to whatever is passed in by the user in queryParam1).
+- `headers`: Dynamically inserts header key-value pair, this is typically used when the endpoint accepts a specific header.
+- `auth`: This defines whether the endpoint requires a `access_token` or a `privilege_token`.
+- `return`: This defines what the endpoint returns for a more user-friendly experience. Only Auth endpoints will return `access_token`, and Token Exchange endpoint will return `privilege_token`. **You will likely not use this at all**.
+
+```js
+<functionName>: {
+  method: '<GET|POST|PUT|PATCH|DELETE|FUNCTION>',
+  path: '/<path>/:pathParameters' || '<functionName>',
+  queryParams: {
+    'queryParam1': false,
+    'queryParam2': true,
+    'queryParam3': '<queryParamValue>' || '<$queryParam1>'
+  },
+  body: {
+    'bodyParam1': false,
+    'bodyParam2': true,
+    'bodyParam3': '<bodyValue>'
+  },
+  headers: {
+    'headerKey': '<headerValue>'
+  },
+  auth: '<web3|privilege>',
+  return: '<web3|privilege>'
+}
+```
+
+## GraphQL API Resource Data Structure
+Similarly in GraphQL, each `queryName` maps to a specific query that is pre-defined in GraphQL's query language.
+
+- `params`: Defined when user inputs are required in the query.
+- `query`: Outlines the query structure, and specifies where each defined `params` will be injected (at where `$` is prepended).
+
+```js
+<queryName>: {
+  params: {
+    param1: true,
+    param2: true
+  },
+  query: `
+    <actual_graphQL_query> { input1: $param1, input2: $param2 }
+  `
+}
+```
+
+## How to Contribute
+Contributions can take many forms, from fixing typos in documentation to mapping new API endpoints. Here's how you can contribute:
+
+### Reporting Issues
+If you find a bug or have a suggestion for improving an existing example, please open an issue. Be as specific as possible and include:
+
+1. A clear title and description
+2. Steps to reproduce the issue, if applicable
+3. Your ideas for solving the issue, if any
+
+### Updating API Endpoints
+1. Locate the endpoint under `/src/api/resources/<directory>/index.ts`
+2. Under the `constructor`, locate a `this.setResource()` function call
+3. Update the endpoint of interest accordingly
+
+[Note] Some Vehicle Signal Decoding API endpoints uses `eth-addr` as one of the query parameters, for clarification and style purposes, please use `address` as the key when you pass a query parameter.
+
+### Updating SDK Functions
+1. Locate the functions under `/src/api/functions`
+2. Update existing functions or create new functions
+3. Export the modified function(s) in `/src/api/functions/index.ts`
+4. Locate the resource mapping under `/src/api/resources/<directory>/index.ts`
+5. Apply the new changes under `this.setResource()` function call
+
+### Updating GraphQL Queries
+1. Locate the queries under `/src/graphql/resources/<directory>/index.ts`
+2. Under the `constructor`, locate a `this.setQueries()` function call
+3. Update the query of interest accordingly
+
+### Translating the README
+DIMO welcomes translation work done on the SDK.

package/LICENSE

@@ -0,0 +1,76 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of this License; and
+You must cause any modified files to carry prominent notices stating that You changed the files; and
+You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
+You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+---
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]" replaced with
+   your own identifying information. (Don't include the brackets!)  The text
+   should be enclosed in the appropriate comment syntax for the file format.
+   We also recommend that a file or class name and description of purpose be
+   included on the same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright 2024 DIMO Foundation
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,216 @@
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/dimo-network/data-sdk/npm-publish.yml?style=flat-square)
+![GitHub top language](https://img.shields.io/github/languages/top/dimo-network/data-sdk?style=flat-square)
+![GitHub License](https://img.shields.io/github/license/dimo-network/data-sdk?style=flat-square)
+[![Downloads](https://img.shields.io/npm/d18m/@dimo-network/data-sdk.svg?style=flat-square)](https://www.npmjs.com/package/@dimo-network/data-sdk)
+[![Discord](https://img.shields.io/discord/892438668453740634)](https://chat.dimo.zone/)
+![X (formerly Twitter) URL](https://img.shields.io/twitter/url?url=https%3A%2F%2Ftwitter.com%2FDIMO_Network&style=social)
+
+# DIMO Data SDK
+This is an official DIMO Data SDK written in NodeJS/TypeScript. The objective of this project is to make our API more accessible to the general public.
+
+## Installation
+Use [npm](https://www.npmjs.com/package/@dimo-network/data-sdk):
+```bash
+npm install @dimo-network/data-sdk
+```
+
+or use [yarn](https://classic.yarnpkg.com/en/package/@dimo-network/data-sdk) instead:
+
+```bash
+yarn add @dimo-network/data-sdk
+```
+
+## Unit Testing
+Run `npm test` or `npm run test` to execute the Jest tests.
+
+## API Documentation
+Please visit the DIMO [Developer Documentation](https://docs.dimo.org/developer-platform) to learn more about building on DIMO and detailed information on the API.
+
+## How to Use the SDK
+
+Import the SDK library:
+```ts
+import { DIMO } from '@dimo-network/data-sdk';
+```
+
+Initiate the SDK depending on the environment of your interest, we currently support both `Production` and `Dev` environments:
+
+```ts
+const dimo = new DIMO('Production');
+```
+or
+
+```ts
+const dimo = new DIMO('Dev');
+```
+### Developer Registration
+As part of the authentication process, you will need to obtain a Developer License via the [DIMO Developer Console](https://console.dimo.org/). To get started with registration, follow the steps below:
+1. Sign up on the [DIMO Developer Console](https://console.dimo.org/).
+2. Get DIMO Credits either by paying in your local currency (via Stripe) or paying with a balance (if you have one).
+3. Click on `Create app` and fill out the details about your project namespace (external-facing, e.g. `Drive2Survive LLC.`) and your application name (internal, e.g. `app-prod`)
+4. Generate an API key and add in your preferred redirect URI
+
+### Authentication
+
+The SDK provides you with all the steps needed in the [Authentication Flow](https://docs.dimo.org/developer-platform/getting-started/developer-guide/authentication) to obtain an `access_token`.
+
+#### Prerequisites for Authentication
+1. A valid Developer License
+2. A valid API key
+
+#### API Authentication
+
+##### (Option 1 - PREFERRED) getToken Function
+As mentioned earlier, this is the streamlined function call to directly get the `access_token`. The `address` field in challenge generation is omitted since it is essentially the `client_id` of your application per Developer License:
+
+```ts
+const authHeader = await dimo.auth.getToken({
+  client_id: '<client_id>',
+  domain: '<domain>',
+  private_key: '<private_key>',
+});
+```
+
+Once you have the `authHeader`, you'll have access to the DIMO API endpoints. For endpoints that require the authorization headers, you can simply pass the results.
+
+```ts
+// Pass the auth object to a protected endpoint
+await dimo.user.get(auth);
+
+// Pass the auth object to a protected endpoint with body parameters
+await dimo.tokenexchange.exchange({
+  ...auth,
+  privileges: [4],
+  tokenId: <vehicle_token_id>
+});
+
+```
+
+##### (Option 2) Credentials.json File
+By loading a valid `.credentials.json`, you can easily call `dimo.authenticate()` if you prefer to manage your credentials differently. Instead of calling the `Auth` endpoint, you would directly interact with the SDK main class.
+
+Start by navigating to the SDK directory that was installed, if you used NPM, you can execute `npm list -g | dimo` to find the directory. In the root directory of the SDK, there will be `.credentials.json.example` - simply remove the `.example` extension to proceed with authentication:
+
+```ts
+// After .credentials.json are provided
+const authHeader = await dimo.authenticate();
+// The rest would be the same as option 1
+```
+
+### Querying the DIMO REST API
+The SDK supports async await and your typical JS Promises. HTTP operations can be utilized in either ways:
+
+```ts
+// Async Await
+async function getAllDeviceMakes() {
+  try {
+    let response = await dimo.devicedefinitions.listDeviceMakes();
+    // Do something with the response
+  }
+  catch (err) { /* ... */ }
+}
+getAllDeviceMakes();
+```
+
+```js
+// JS Promises
+dimo.devicedefinitions.listDeviceMakes().then((result) => {
+    return result.device_makes.length;
+  }).catch((err) => {
+  /* ...handle the error... */
+});
+```
+
+#### Query Parameters
+
+For query parameters, simply feed in an input that matches with the expected query parameters:
+```ts
+dimo.devicedefinitions.getByMMY({
+  make: '<vehicle_make>',
+  model: '<vehicle_model',
+  year: 2021
+});
+```
+#### Path Parameters
+
+For path parameters, simply feed in an input that matches with the expected path parameters:
+```ts
+dimo.devicedefinitions.getById({ id: '26G4j1YDKZhFeCsn12MAlyU3Y2H' })
+```
+
+#### Permission Tokens
+
+As the 2nd leg of the API authentication, applications may exchange for short-lived [permissions JWT](https://docs.dimo.org/developer-platform/getting-started/developer-guide/authentication#getting-a-jwt) for specific vehicles that granted permissions to the app. This uses the [DIMO Token Exchange API](https://docs.dimo.org/developer-platform/api-references/dimo-protocol/token-exchange-api/token-exchange-api-endpoints). 
+
+For the end users of your application, they will need to share their vehicle permissions via the DIMO Mobile App or via your implementation of [Login with DIMO](https://docs.dimo.org/developer-platform/getting-started/developer-guide/login-with-dimo). Once vehicles are shared, you will be able to get a permissions JWT.
+
+```ts
+const privToken = await dimo.tokenexchange.exchange({
+  ...auth,
+  privileges: [1, 5],
+  tokenId: <vehicle_token_id>
+});
+
+// Vehicle Status uses privId 1
+await dimo.devicedata.getVehicleStatus({
+  ...privToken,
+  tokenId: <vehicle_token_id>
+});
+
+// Proof of Movement Verifiable Credentials uses privId 4
+await dimo.attestation.createPomVC({
+  ...privToken,
+  tokenId: <vehicle_token_id>
+})
+
+// VIN Verifiable Credentials uses privId 5
+await dimo.attestation.createVinVC({
+  ...privToken,
+  tokenId: <vehicle_token_id>
+});
+```
+
+### Querying the DIMO GraphQL API
+
+The SDK accepts any type of valid custom GraphQL queries, but we've also included a few sample queries to help you understand the DIMO GraphQL APIs. 
+
+#### Authentication for GraphQL API
+The GraphQL entry points are designed almost identical to the REST API entry points. For any GraphQL API that requires auth headers (Telemetry API for example), you can use the same pattern as you would in the REST protected endpoints.
+
+```ts
+const privToken = await dimo.tokenexchange.exchange({
+  ...auth,
+  privileges: [1, 3, 4],
+  tokenId: <vehicle_token_id>
+});
+
+const tele = await dimo.telemetry.query({
+  ...privToken,
+  query: `
+    query {
+      some_valid_GraphQL_query
+    }
+  `
+});
+```
+
+#### Send a custom GraphQL query
+To send a custom GraphQL query, you can simply call the `query` function on any GraphQL API Endpoints and pass in any valid GraphQL query. To check whether your GraphQL query is valid, please visit our [Identity API GraphQL Playground](https://identity-api.dimo.zone/) or [Telemetry API GraphQL Playground](https://telemetry-api.dimo.zone/).
+
+```js
+const yourQuery = `{ 
+    vehicles (first:10) {
+      totalCount
+    }
+}`;
+
+const totalNetworkVehicles = await dimo.identity.query({
+  query: yourQuery
+});
+
+```
+
+This GraphQL API query is equivalent to calling `dimo.identity.countDimoVehicles()`.
+
+## How to Contribute to the SDK
+Read more about contributing [here](https://github.com/DIMO-Network/data-sdk/blob/master/CONTRIBUTING.md).

package/dist/api/Method.d.ts

@@ -0,0 +1,2 @@
+import { DimoEnvironment } from '../environments';
+export declare const Method: (resource: any, baseUrl: any, params: any, env: keyof typeof DimoEnvironment) => Promise<any>;

package/dist/api/Method.js

@@ -0,0 +1,136 @@
+import axios from 'axios';
+import * as functionIndex from '../api/functions/';
+import { DimoError } from '../errors';
+export const Method = async (resource, baseUrl, params = {}, env) => {
+    /**
+     * Headers
+     */
+    let headers = {};
+    if (['access_token', 'privilege_token'].includes(resource.auth)) {
+        if (params.headers.Authorization) {
+            headers = params.headers;
+        }
+        else {
+            throw new DimoError({
+                message: `Access token not provided for ${resource.auth} authentication`,
+                statusCode: 401
+            });
+        }
+    }
+    if (resource.headers) {
+        headers = { ...headers, ...resource.headers };
+    }
+    // If resource.method is 'FUNCTION', call the function defined by 'resource.path'
+    if (resource.method === 'FUNCTION') {
+        const functionName = resource.path;
+        const dynamicFunction = functionIndex[functionName];
+        if (typeof dynamicFunction === 'function') {
+            // Call the dynamic function with params and pass the necessary arguments
+            return dynamicFunction(params, env);
+        }
+        else {
+            throw new DimoError({
+                message: `Function in ${resource.path} is not a valid function.`,
+                statusCode: 400
+            });
+        }
+    }
+    /**
+     * Query Parameters
+     * Extract required queryParams from the resource object
+     */
+    const queryParams = resource.queryParams || {};
+    // Check if required queryParams match with incoming params
+    for (const key in queryParams) {
+        // We'll fail early if there's a missing required query param from the user
+        if (queryParams[key] === true && !params[key]) {
+            console.error(`Missing required query parameter: ${key}`);
+            throw new DimoError({
+                message: `Missing required query parameter: ${key}`,
+                statusCode: 400
+            });
+        }
+        if (queryParams[key][0] === '$') {
+            const variableKey = queryParams[key].substring(1); // Remove the leading $
+            if (params[variableKey]) {
+                params[key] = params[variableKey]; // Set the value based on the value of the variable key
+            }
+            else {
+                console.error(`Variable key '${variableKey}' not found in params`);
+                throw new DimoError({
+                    message: `Variable key '${variableKey}' not found in params`,
+                    statusCode: 400
+                });
+            }
+        }
+        else if (typeof queryParams[key] === 'string') {
+            params[key] = queryParams[key];
+        }
+    }
+    /**
+     * URL Parameters
+     * Check for placeholders in the resource path and replace them with values from params
+     */
+    let url = baseUrl + resource.path;
+    const placeholderRegex = /:([\w]+)/g;
+    let match;
+    while ((match = placeholderRegex.exec(resource.path)) !== null) {
+        const key = match[1];
+        const value = params[key];
+        if (value !== undefined) {
+            url = url.replace(match[0], value.toString());
+        }
+    }
+    /**
+     * Body Parameters
+     */
+    let body = {};
+    if (resource.body) {
+        for (const key in resource.body) {
+            if (typeof resource.body[key] === 'boolean') {
+                if (!params[key]) {
+                    console.error(`Missing required body parameter: ${key}`);
+                    throw new DimoError({
+                        message: `Missing required body parameter: ${key}`
+                    });
+                }
+                else {
+                    body[key] = params[key];
+                }
+            }
+            else if (typeof resource.body[key] === 'string') {
+                body[key] = resource.body[key];
+            }
+        }
+    }
+    try {
+        const response = await axios({
+            method: resource.method,
+            url: url,
+            params: resource.queryParams ? params : {},
+            data: resource.body ? body : '',
+            headers: headers
+        });
+        // Return response.data directly if resource.return does not exist
+        if (!resource.return) {
+            return response.data;
+        }
+        // Special returns for access_token & privilege token
+        let authHeader = {};
+        if (resource.return === 'access_token') {
+            authHeader = { Authorization: `Bearer ${response.data.access_token}` };
+        }
+        else if (resource.return === 'privilege_token') {
+            authHeader = { Authorization: `Bearer ${response.data.token}` };
+        }
+        return { headers: authHeader };
+    }
+    catch (error) {
+        console.error('API call error:', error.response.data);
+        throw new DimoError({
+            message: `API call error: ${error.response.data.message}`,
+            statusCode: error.response.data.code,
+            body: error.response.data
+        });
+    }
+};

package/dist/api/Method.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/api/Method.test.js

@@ -0,0 +1,67 @@
+import axios from 'axios';
+import { Method } from './Method'; // Import the Method function to be tested
+import { DimoError } from '../errors';
+import { DimoEnvironment } from '../environments';
+const PROD = 'Production';
+const DEV = 'Dev';
+const RESOURCE = {
+    method: 'GET',
+    path: '',
+    queryParams: { param1: true },
+};
+const PARAM = { param1: 'value1' };
+describe('Method Function', () => {
+    test('Valid API Call - Device Definitions API Server is up and returning data', async () => {
+        jest.spyOn(axios, 'request').mockResolvedValue({ data: { key: 'value' } });
+        const devResponse = await Method(RESOURCE, DimoEnvironment.Dev.DeviceDefinitions, PARAM, DEV);
+        const prodResponse = await Method(RESOURCE, DimoEnvironment.Production.DeviceDefinitions, PARAM, PROD);
+        // Assertion - Check if the response data is returned correctly
+        expect(devResponse).toEqual('device definitions api running!');
+        expect(prodResponse).toEqual('device definitions api running!');
+    });
+    test('Valid API Call - Devices API Server is up and returning data', async () => {
+        jest.spyOn(axios, 'request').mockResolvedValue({ data: { key: 'value' } });
+        const devResponse = await Method(RESOURCE, DimoEnvironment.Dev.Devices, PARAM, DEV);
+        const prodResponse = await Method(RESOURCE, DimoEnvironment.Production.Devices, PARAM, PROD);
+        // Assertion - Check if the response data is returned correctly
+        expect(devResponse).toEqual({ data: 'Server is up and running' });
+        expect(prodResponse).toEqual({ data: 'Server is up and running' });
+    });
+    test('Valid API Call - Token Exchange API Server is up and returning data', async () => {
+        jest.spyOn(axios, 'request').mockResolvedValue({ data: { key: 'value' } });
+        const devResponse = await Method(RESOURCE, DimoEnvironment.Dev.TokenExchange, PARAM, DEV);
+        const prodResponse = await Method(RESOURCE, DimoEnvironment.Production.TokenExchange, PARAM, PROD);
+        // Assertion - Check if the response data is returned correctly
+        expect(devResponse).toEqual({ data: 'Server is up and running' });
+        expect(prodResponse).toEqual({ data: 'Server is up and running' });
+    });
+    test('Valid API Call - Valuations API Server is up and returning data', async () => {
+        jest.spyOn(axios, 'request').mockResolvedValue({ data: { key: 'value' } });
+        const devResponse = await Method(RESOURCE, DimoEnvironment.Dev.Valuations, PARAM, DEV);
+        const prodResponse = await Method(RESOURCE, DimoEnvironment.Production.Valuations, PARAM, PROD);
+        // Assertion - Check if the response data is returned correctly
+        expect(devResponse).toEqual({ code: 200, message: 'Server is up.' });
+        expect(prodResponse).toEqual({ code: 200, message: 'Server is up.' });
+    });
+    test('Valid API Call - Vehicle Signal Decoding API Server is up and returning data', async () => {
+        jest.spyOn(axios, 'request').mockResolvedValue({ data: { key: 'value' } });
+        const devResponse = await Method(RESOURCE, DimoEnvironment.Dev.VehicleSignalDecoding, PARAM, DEV);
+        const prodResponse = await Method(RESOURCE, DimoEnvironment.Production.VehicleSignalDecoding, PARAM, PROD);
+        // Assertion - Check if the response data is returned correctly
+        expect(devResponse).toEqual('healthy');
+        expect(prodResponse).toEqual('healthy');
+    });
+    test('Missing Required Query Parameter - Throws Error', async () => {
+        // Mock input data with missing required query parameter
+        const resource = {
+            method: 'GET',
+            path: '/example/endpoint',
+            queryParams: { expectedParam: true }, // Expect expectedParam
+        };
+        const baseUrl = 'https://example.com/api';
+        const params = { unexpectedParam: 'value1' };
+        // Call the Method function and expect it to throw an error
+        await expect(Method(resource, baseUrl, params, DEV)).rejects.toThrowError(DimoError);
+        await expect(Method(resource, baseUrl, params, PROD)).rejects.toThrowError(DimoError);
+    });
+});