@dimo-network/data-sdk 1.2.1 → 1.2.2

package/CONTRIBUTING.md

@@ -64,19 +64,17 @@ If you find a bug or have a suggestion for improving an existing example, please
 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
 
+### Updating SDK Utility Functions
+1. Locate the functions under `/src/api/functions` or `/src/graphql/functions`
+2. Update existing functions or create new functions
+3. Export the modified function(s) in `/src/api/functions/index.ts` or `/src/graphql/functions/index.ts`
+4. Locate the resource mapping under `/src/api/resources/<directory>/index.ts` or `/src/graphql/resources/<directory>/index.ts`
+5. Apply the new changes under `this.setResource()` for REST API or `this.setQueries()` for GraphQL API
+
 ### Translating the README
 DIMO welcomes translation work done on the SDK.

package/README.md

@@ -6,7 +6,7 @@
 ![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.
+This is an official DIMO Data SDK written in 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):
@@ -33,53 +33,50 @@ Import the SDK library:
 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:
+Initiate the SDK:
 
 ```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).
+2. Get DIMO Credits (DCX) 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
+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`.
+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 a Developer JWT.
 
 #### Prerequisites for Authentication
-1. A valid Developer License
-2. A valid API key
+1. A valid Developer License with a `client_id`
+2. A valid API key, generated via the Developer Console
+3. A proper [project set up with TypeScript](https://www.digitalocean.com/community/tutorials/setting-up-a-node-project-with-typescript).
 
 #### 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:
+This is a utility function call to get a Developer JWT in one step:
 
 ```ts
-const authHeader = await dimo.auth.getToken({
+const developerJwt = await dimo.auth.getToken({
   client_id: '<client_id>',
   domain: '<domain>',
-  private_key: '<private_key>',
+  private_key: '<api_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.
+Once you have the `developerJwt`, 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 developerJwt object to a protected endpoint
+await dimo.user.get(developerJwt);
 
-// Pass the auth object to a protected endpoint with body parameters
+// Pass the developerJwt object to a protected endpoint with body parameters
 await dimo.tokenexchange.exchange({
-  ...auth,
+  ...developerJwt,
   privileges: [4],
   tokenId: <vehicle_token_id>
 });
@@ -93,7 +90,7 @@ Start by navigating to the SDK directory that was installed, if you used NPM, yo
 
 ```ts
 // After .credentials.json are provided
-const authHeader = await dimo.authenticate();
+const developerJwt = await dimo.authenticate();
 // The rest would be the same as option 1
 ```
 
@@ -102,20 +99,20 @@ The SDK supports async await and your typical JS Promises. HTTP operations can b
 
 ```ts
 // Async Await
-async function getAllDeviceMakes() {
+async function countCars() {
   try {
-    let response = await dimo.devicedefinitions.listDeviceMakes();
+    let response = await dimo.identity.countDimoVehicles();
     // Do something with the response
   }
   catch (err) { /* ... */ }
 }
-getAllDeviceMakes();
+countCars();
 ```
 
 ```js
 // JS Promises
-dimo.devicedefinitions.listDeviceMakes().then((result) => {
-    return result.device_makes.length;
+dimo.identity.countDimoVehicles().then((result) => {
+    return result;
   }).catch((err) => {
   /* ...handle the error... */
 });
@@ -125,9 +122,9 @@ dimo.devicedefinitions.listDeviceMakes().then((result) => {
 
 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',
+dimo.devicedefinitions.search({
+  query: '<query>',
+  makeSlug: '<makeSlug>',
   year: 2021
 });
 ```
@@ -135,17 +132,21 @@ dimo.devicedefinitions.getByMMY({
 
 For path parameters, simply feed in an input that matches with the expected path parameters:
 ```ts
-dimo.devicedefinitions.getById({ id: '26G4j1YDKZhFeCsn12MAlyU3Y2H' })
+dimo.attestation.createVinVC({
+  ...vehicle_jwt,
+  tokenId: 117315,
+  force: false
+})
 ```
 
-#### Permission Tokens
+#### Vehicle JWT
 
-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). 
+As the 2nd leg of the API authentication, applications may exchange for short-lived [Vehicle 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.
+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) or even by sharing on the Vehicle NFT directly. Once vehicles are shared, you will be able to get a Vehicle JWT.
 
 ```ts
-const privToken = await dimo.tokenexchange.exchange({
+const vehicle_jwt = await dimo.tokenexchange.exchange({
   ...auth,
   privileges: [1, 5],
   tokenId: <vehicle_token_id>
@@ -153,19 +154,19 @@ const privToken = await dimo.tokenexchange.exchange({
 
 // Vehicle Status uses privId 1
 await dimo.devicedata.getVehicleStatus({
-  ...privToken,
+  ...vehicle_jwt,
   tokenId: <vehicle_token_id>
 });
 
 // Proof of Movement Verifiable Credentials uses privId 4
 await dimo.attestation.createPomVC({
-  ...privToken,
+  ...vehicle_jwt,
   tokenId: <vehicle_token_id>
 })
 
 // VIN Verifiable Credentials uses privId 5
 await dimo.attestation.createVinVC({
-  ...privToken,
+  ...vehicle_jwt,
   tokenId: <vehicle_token_id>
 });
 ```
@@ -178,14 +179,14 @@ The SDK accepts any type of valid custom GraphQL queries, but we've also include
 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,
+const vehicleJwt = await dimo.tokenexchange.exchange({
+  ...vehicleJwt,
   privileges: [1, 3, 4],
   tokenId: <vehicle_token_id>
 });
 
-const tele = await dimo.telemetry.query({
-  ...privToken,
+const something = await dimo.telemetry.query({
+  ...vehicleJwt,
   query: `
     query {
       some_valid_GraphQL_query
@@ -193,11 +194,24 @@ const tele = await dimo.telemetry.query({
   `
 });
 ```
+#### Getting a Vehicle's VIN
+In order to get to the VIN of a given vehicle, your application (aka Developer License) will need [permissions to view VIN credentials (Privilege ID: 5)](https://docs.dimo.org/developer-platform/api-references/token-exchange-api#privilege-definitions). As long as you have permissions to view the vehicle's VIN, simply call the `getVin` utility function.
+
+```ts
+const getVin = async(vehicle_jwt: any) => {
+    return await dimo.telemetry.getVin({
+        ...vehicle_jwt,
+        tokenId: <vehicle_token_id>
+    });
+}
+```
+
+This utility function streamlines two calls: [Creating a VIN VC on Attestation API](https://docs.dimo.org/developer-platform/api-references/attestation-api#create-a-vehicle-vin-vc) and [Getting the Latest VIN VC on Telemetry API](https://docs.dimo.org/developer-platform/api-references/attestation-api#create-a-vehicle-vin-vc).
 
 #### 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
+```ts
 const yourQuery = `{ 
     vehicles (first:10) {
       totalCount

package/dist/api/Method.js

@@ -6,7 +6,7 @@ export const Method = async (resource, baseUrl, params = {}, env) => {
      * Headers
      */
     let headers = {};
-    if (['access_token', 'privilege_token'].includes(resource.auth)) {
+    if (['developer_jwt', 'vehicle_jwt'].includes(resource.auth)) {
         if (params.headers.Authorization) {
             headers = params.headers;
         }
@@ -115,12 +115,12 @@ export const Method = async (resource, baseUrl, params = {}, env) => {
         if (!resource.return) {
             return response.data;
         }
-        // Special returns for access_token & privilege token
+        // Special returns for different JWTs
         let authHeader = {};
-        if (resource.return === 'access_token') {
+        if (resource.return === 'developer_jwt') {
             authHeader = { Authorization: `Bearer ${response.data.access_token}` };
         }
-        else if (resource.return === 'privilege_token') {
+        else if (resource.return === 'vehicle_jwt') {
             authHeader = { Authorization: `Bearer ${response.data.token}` };
         }
         return { headers: authHeader };

package/dist/api/resources/Attestation/index.js

@@ -6,15 +6,15 @@ export class Attestation extends Resource {
             createVinVC: {
                 method: 'POST',
                 path: '/v1/vc/vin/:tokenId',
-                auth: 'privilege_token',
+                auth: 'vehicle_jwt',
                 queryParams: {
-                    'force': true
+                    'force': false
                 }
             },
             createPomVC: {
                 method: 'POST',
                 path: '/v1/vc/pom/:tokenId',
-                auth: 'privilege_token'
+                auth: 'vehicle_jwt'
             }
         });
     }

package/dist/api/resources/Auth/index.js

@@ -31,7 +31,7 @@ export class Auth extends Resource {
                 headers: {
                     'content-type': 'application/x-www-form-urlencoded'
                 },
-                return: 'access_token'
+                return: 'developer_jwt'
             },
             getToken: {
                 method: 'FUNCTION',

package/dist/api/resources/DeviceDefinitions/index.js

@@ -3,26 +3,26 @@ export class DeviceDefinitions extends Resource {
     constructor(api, env) {
         super(api, 'DeviceDefinitions', env);
         this.setResource({
-            getByMMY: {
-                method: 'GET',
-                queryParams: {
-                    'make': true,
-                    'model': true,
-                    'year': true
+            decodeVin: {
+                method: 'POST',
+                path: '/device-definitions/decode-vin',
+                body: {
+                    countryCode: true,
+                    vin: true
                 },
-                path: '/device-definitions'
-            },
-            getById: {
-                method: 'GET',
-                path: '/device-definitions/:id'
+                auth: 'developer_jwt'
             },
-            listDeviceMakes: {
+            search: {
                 method: 'GET',
-                path: '/device-makes'
-            },
-            getDeviceTypeById: {
-                method: 'GET',
-                path: '/device-types/:id'
+                path: '/device-definitions/search',
+                queryParams: {
+                    query: true,
+                    makeSlug: false,
+                    modelSlug: false,
+                    year: false,
+                    page: false,
+                    pageSize: false
+                }
             }
         });
     }

package/dist/api/resources/Devices/index.js

@@ -2,153 +2,6 @@ import { Resource } from '../../Resource';
 export class Devices extends Resource {
     constructor(api, env) {
         super(api, 'Devices', env);
-        this.setResource({
-            createVehicle: {
-                method: 'POST',
-                path: '/v1/user/devices',
-                body: {
-                    countryCode: true,
-                    deviceDefinitionId: true
-                },
-                auth: 'access_token'
-            },
-            createVehicleFromSmartcar: {
-                method: 'POST',
-                path: '/v1/user/devices/fromsmartcar',
-                body: {
-                    code: true,
-                    countryCode: true,
-                    redirectURI: true
-                },
-                auth: 'access_token'
-            },
-            createVehicleFromVin: {
-                method: 'POST',
-                path: '/v1/user/devices/fromvin',
-                body: {
-                    canProtocol: false,
-                    countryCode: true,
-                    vin: true
-                },
-                auth: 'access_token'
-            },
-            updateVehicleVin: {
-                method: 'PATCH',
-                path: '/v1/user/devices/:userDeviceId/vin',
-                auth: 'access_token'
-            },
-            getClaimingPayload: {
-                method: 'POST',
-                path: '/v1/aftermarket/device/by-serial/:serial/commands/claim',
-                auth: 'access_token'
-            },
-            signClaimingPayload: {
-                method: 'POST',
-                path: '/v1/aftermarket/device/by-serial/:serial/commands/claim',
-                body: {
-                    claimRequest: true
-                },
-                auth: 'access_token'
-            },
-            getMintingPayload: {
-                method: 'POST',
-                path: '/v1/user/devices/:userDeviceId/commands/mint',
-                auth: 'access_token'
-            },
-            signMintingPayload: {
-                method: 'POST',
-                path: '/v1/user/devices/:userDeviceId/commands/mint',
-                body: {
-                    mintRequest: true
-                },
-                auth: 'access_token'
-            },
-            optInShareData: {
-                method: 'POST',
-                path: '/v1/user/devices/:userDeviceId/commands/opt-in',
-                auth: 'access_token'
-            },
-            refreshSmartcarData: {
-                method: 'POST',
-                path: '/v1/user/devices/:userDeviceId/commands/refresh',
-                auth: 'access_token'
-            },
-            getPairingPayload: {
-                method: 'GET',
-                path: '/v1/user/devices/:userDeviceId/aftermarket/commands/pair',
-                auth: 'access_token'
-            },
-            signPairingPayload: {
-                method: 'POST',
-                path: '/v1/user/devices/:userDeviceId/aftermarket/commands/pair',
-                body: {
-                    userSignature: true
-                },
-                auth: 'access_token'
-            },
-            getUnpairingPayload: {
-                method: 'GET',
-                path: '/v1/user/devices/:userDeviceId/aftermarket/commands/unpair',
-                auth: 'access_token'
-            },
-            signUnpairingPayload: {
-                method: 'POST',
-                path: '/v1/user/devices/:userDeviceId/aftermarket/commands/unpair',
-                body: {
-                    userSignature: true
-                },
-                auth: 'access_token'
-            },
-            lockDoors: {
-                method: 'POST',
-                path: '/v1/vehicle/:tokenId/commands/doors/lock',
-                auth: 'privilege_token'
-            },
-            unlockDoors: {
-                method: 'POST',
-                path: '/v1/vehicle/:tokenId/commands/doors/unlock',
-                auth: 'privilege_token'
-            },
-            openFrunk: {
-                method: 'POST',
-                path: '/v1/vehicle/:tokenId/commands/frunk/open',
-                auth: 'privilege_token'
-            },
-            openTrunk: {
-                method: 'POST',
-                path: '/v1/vehicle/:tokenId/commands/trunk/open',
-                auth: 'privilege_token'
-            },
-            listErrorCodes: {
-                method: 'GET',
-                path: '/v1/user/devices/:userDeviceId/error-codes',
-                auth: 'access_token'
-            },
-            submitErrorCodes: {
-                method: 'POST',
-                path: '/v1/user/devices/:userDeviceId/error-codes',
-                body: {
-                    queryDeviceErrorCodes: true
-                },
-                auth: 'access_token'
-            },
-            clearErrorCodes: {
-                method: 'POST',
-                path: '/v1/user/devices/:userDeviceId/error-codes/clear',
-                auth: 'access_token'
-            },
-            getAftermarketDevice: {
-                method: 'GET',
-                path: '/v1/aftermarket/device/:tokenId',
-            },
-            getAftermarketDeviceImage: {
-                method: 'GET',
-                path: '/v1/aftermarket/device/:tokenId/image',
-            },
-            getAftermarketDeviceMetadataByAddress: {
-                method: 'GET',
-                path: '/v1/aftermarket/device/by-address/:address',
-            }
-        });
+        this.setResource({});
     }
 }

package/dist/api/resources/DimoRestResources.d.ts

@@ -5,5 +5,4 @@ import { Devices } from './Devices';
 import { TokenExchange } from './TokenExchange';
 import { Trips } from './Trips';
 import { Valuations } from './Valuations';
-import { VehicleSignalDecoding } from './VehicleSignalDecoding';
-export { Attestation, Auth, DeviceDefinitions, Devices, TokenExchange, Trips, Valuations, VehicleSignalDecoding };
+export { Attestation, Auth, DeviceDefinitions, Devices, TokenExchange, Trips, Valuations };

package/dist/api/resources/DimoRestResources.js

@@ -5,5 +5,4 @@ import { Devices } from './Devices';
 import { TokenExchange } from './TokenExchange';
 import { Trips } from './Trips';
 import { Valuations } from './Valuations';
-import { VehicleSignalDecoding } from './VehicleSignalDecoding';
-export { Attestation, Auth, DeviceDefinitions, Devices, TokenExchange, Trips, Valuations, VehicleSignalDecoding };
+export { Attestation, Auth, DeviceDefinitions, Devices, TokenExchange, Trips, Valuations };

package/dist/api/resources/TokenExchange/index.js

@@ -12,8 +12,8 @@ export class TokenExchange extends Resource {
                     privileges: true,
                     tokenId: true
                 },
-                auth: 'access_token',
-                return: 'privilege_token'
+                auth: 'developer_jwt',
+                return: 'vehicle_jwt'
             }
         });
     }

package/dist/api/resources/Trips/index.js

@@ -9,7 +9,7 @@ export class Trips extends Resource {
                 queryParams: {
                     page: false
                 },
-                auth: 'privilege_token'
+                auth: 'vehicle_jwt'
             }
         });
     }

package/dist/api/resources/Valuations/index.js

@@ -5,18 +5,18 @@ export class Valuations extends Resource {
         this.setResource({
             getValuations: {
                 method: 'GET',
-                path: '/v1/user/devices/:userDeviceId/valuations',
-                auth: 'access_token'
+                path: '/v2/vehicles/:tokenId/valuations',
+                auth: 'vehicle_jwt'
             },
             getInstantOffers: {
                 method: 'GET',
-                path: '/v1/user/devices/:userDeviceId/instant-offer',
-                auth: 'access_token'
+                path: '/v2/vehicles/:tokenId/instant-offer',
+                auth: 'vehicle_jwt'
             },
             getOffers: {
                 method: 'GET',
-                path: '/v1/user/devices/:userDeviceId/offers',
-                auth: 'access_token'
+                path: '/v2/vehicles/:tokenId/offers',
+                auth: 'vehicle_jwt'
             }
         });
     }

package/dist/dimo.d.ts

@@ -1,6 +1,6 @@
 import { DimoEnvironment } from './environments';
 import { Identity, Telemetry } from './graphql/resources/DimoGraphqlResources';
-import { Attestation, Auth, DeviceDefinitions, Devices, TokenExchange, Trips, Valuations, VehicleSignalDecoding } from './api/resources/DimoRestResources';
+import { Attestation, Auth, DeviceDefinitions, Devices, TokenExchange, Trips, Valuations } from './api/resources/DimoRestResources';
 export declare class DIMO {
     attestation: Attestation;
     auth: Auth;
@@ -11,7 +11,6 @@ export declare class DIMO {
     tokenexchange: TokenExchange;
     trips: Trips;
     valuations: Valuations;
-    vehiclesignaldecoding: VehicleSignalDecoding;
     constructor(env: keyof typeof DimoEnvironment);
     authenticate(): Promise<any>;
 }

package/dist/dimo.js

@@ -1,7 +1,7 @@
 import { DimoEnvironment } from './environments';
 import { DimoError } from './errors';
 import { Identity, Telemetry } from './graphql/resources/DimoGraphqlResources';
-import { Attestation, Auth, DeviceDefinitions, Devices, TokenExchange, Trips, Valuations, VehicleSignalDecoding } from './api/resources/DimoRestResources';
+import { Attestation, Auth, DeviceDefinitions, Devices, TokenExchange, Trips, Valuations } from './api/resources/DimoRestResources';
 // import { Stream } from './streamr';
 export class DIMO {
     attestation;
@@ -13,7 +13,6 @@ export class DIMO {
     tokenexchange;
     trips;
     valuations;
-    vehiclesignaldecoding;
     constructor(env) {
         this.identity = new Identity(DimoEnvironment[env].Identity, env);
         this.telemetry = new Telemetry(DimoEnvironment[env].Telemetry, env);
@@ -27,7 +26,6 @@ export class DIMO {
         this.tokenexchange = new TokenExchange(DimoEnvironment[env].TokenExchange, env);
         this.trips = new Trips(DimoEnvironment[env].Trips, env);
         this.valuations = new Valuations(DimoEnvironment[env].Valuations, env);
-        this.vehiclesignaldecoding = new VehicleSignalDecoding(DimoEnvironment[env].VehicleSignalDecoding, env);
     }
     // Helper Function
     async authenticate() {

package/dist/dimo.test.js

@@ -14,7 +14,6 @@ describe('Production Environment', () => {
         expect(dimo.tokenexchange.env).toBe(PROD);
         expect(dimo.trips.env).toBe(PROD);
         expect(dimo.valuations.env).toBe(PROD);
-        expect(dimo.vehiclesignaldecoding.env).toBe(PROD);
     });
     test('Production API endpoints are defined', () => {
         expect(dimo.attestation.api).toBeDefined;
@@ -26,7 +25,6 @@ describe('Production Environment', () => {
         expect(dimo.tokenexchange.api).toBeDefined;
         expect(dimo.trips.api).toBeDefined;
         expect(dimo.valuations.api).toBeDefined;
-        expect(dimo.vehiclesignaldecoding.api).toBeDefined;
     });
 });
 describe('Dev Environment', () => {
@@ -40,7 +38,6 @@ describe('Dev Environment', () => {
         expect(devDimo.tokenexchange.env).toBe(DEV);
         expect(devDimo.trips.env).toBe(DEV);
         expect(devDimo.valuations.env).toBe(DEV);
-        expect(devDimo.vehiclesignaldecoding.env).toBe(DEV);
     });
     test('Dev API endpoints are defined', () => {
         expect(devDimo.attestation.api).toBeDefined;
@@ -52,6 +49,5 @@ describe('Dev Environment', () => {
         expect(devDimo.tokenexchange.api).toBeDefined;
         expect(devDimo.trips.api).toBeDefined;
         expect(devDimo.valuations.api).toBeDefined;
-        expect(devDimo.vehiclesignaldecoding.api).toBeDefined;
     });
 });

package/dist/graphql/Query.d.ts

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

package/dist/graphql/Query.js

@@ -1,12 +1,13 @@
 import axios from 'axios';
+import * as functionIndex from '../graphql/functions/';
 import { DimoError } from '../errors';
 // GraphQL query factory function
-export const Query = async (resource, baseUrl, params = {}) => {
+export const Query = async (resource, baseUrl, params = {}, env) => {
     /**
      * Headers
      */
     let headers = {};
-    if (['access_token', 'privilege_token'].includes(resource.auth)) {
+    if (['developer_jwt', 'vehicle_jwt'].includes(resource.auth)) {
         if (params.headers.Authorization) {
             headers = params.headers;
         }
@@ -24,6 +25,21 @@ export const Query = async (resource, baseUrl, params = {}) => {
             'User-Agent': 'dimo-node-sdk'
         }
     };
+    // If resource.method is 'FUNCTION', call the function defined
+    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
+            });
+        }
+    }
     const variables = resource.params || {};
     let query = resource.query;
     for (const key in variables) {
@@ -64,7 +80,7 @@ export const CustomQuery = async (resource, baseUrl, params = {}) => {
      * Headers
      */
     let headers = {};
-    if (['access_token', 'privilege_token'].includes(resource.auth)) {
+    if (['developer_jwt', 'vehicle_jwt'].includes(resource.auth)) {
         if (params.headers.Authorization) {
             headers = params.headers;
         }

package/dist/graphql/Query.test.js

@@ -2,6 +2,8 @@ import axios from 'axios';
 import { CustomQuery, Query } from './Query'; // Import the Query function to be tested
 import { DimoError } from '../errors';
 import { DimoEnvironment } from '../environments';
+const PROD = 'Production';
+const DEV = 'Dev';
 const RESOURCE = {
     method: 'POST',
     path: '',
@@ -39,9 +41,9 @@ describe('Query Function', () => {
         };
         const params = { unexpectedParam: 'value1' };
         // Call the Query function and expect it to throw an error
-        await expect(Query(devResource, DimoEnvironment.Dev.Identity, params)).rejects.toThrow(DimoError);
-        await expect(Query(prodResource, DimoEnvironment.Production.Identity, params)).rejects.toThrow(DimoError);
-        await expect(Query(devResource, DimoEnvironment.Dev.Telemetry, params)).rejects.toThrow(DimoError);
-        await expect(Query(prodResource, DimoEnvironment.Production.Telemetry, params)).rejects.toThrow(DimoError);
+        await expect(Query(devResource, DimoEnvironment.Dev.Identity, params, DEV)).rejects.toThrow(DimoError);
+        await expect(Query(prodResource, DimoEnvironment.Production.Identity, params, PROD)).rejects.toThrow(DimoError);
+        await expect(Query(devResource, DimoEnvironment.Dev.Telemetry, params, DEV)).rejects.toThrow(DimoError);
+        await expect(Query(prodResource, DimoEnvironment.Production.Telemetry, params, PROD)).rejects.toThrow(DimoError);
     });
 });

package/dist/graphql/Resource.js

@@ -12,7 +12,8 @@ export class Resource {
         Object.keys(resources).forEach(key => {
             this[key] = (params = {}) => Query(resources[key], // Setup the endpoint resources
             this.api, // Setup the base URL
-            params);
+            params, // Pass through the params
+            this.env);
         });
     }
     /**

package/dist/graphql/functions/getVin.d.ts

@@ -0,0 +1,5 @@
+import { DimoEnvironment } from '../../environments';
+export declare const getVin: (input: {
+    headers: any;
+    tokenId: string;
+}, env: keyof typeof DimoEnvironment) => Promise<any>;

package/dist/graphql/functions/getVin.js

@@ -0,0 +1,33 @@
+import { DIMO } from '../../dimo';
+import { DimoError } from '../../errors';
+export const getVin = async (input, env) => {
+    const sdk = new DIMO(env);
+    let result;
+    try {
+        const getVinVC = await sdk.attestation.createVinVC({
+            headers: input.headers,
+            tokenId: input.tokenId
+        });
+        if (getVinVC) {
+            const vin = await sdk.telemetry.getLatestVinVC({
+                headers: input.headers,
+                tokenId: input.tokenId
+            });
+            result = vin.data.vinVCLatest.vin;
+            return result;
+        }
+        else {
+            throw new DimoError({
+                message: `Error getting attestation, make sure that you have the correct permissions.`,
+                statusCode: 400
+            });
+        }
+    }
+    catch (error) {
+        console.error(error);
+        throw new DimoError({
+            message: `Error getting VIN: ${error}`,
+            statusCode: 400
+        });
+    }
+};

package/dist/graphql/functions/index.d.ts

@@ -0,0 +1,2 @@
+import { getVin } from "./getVin";
+export { getVin };

package/dist/graphql/functions/index.js

@@ -0,0 +1,2 @@
+import { getVin } from "./getVin";
+export { getVin };

package/dist/graphql/resources/Telemetry/index.js

@@ -3,12 +3,12 @@ export class Telemetry extends Resource {
     constructor(api, env) {
         super(api, 'Telemetry', env);
         this.query({
-            auth: 'privilege_token',
+            auth: 'vehicle_jwt',
             query: true,
         }),
             this.setQueries({
                 getLatestSignals: {
-                    auth: 'privilege_token',
+                    auth: 'vehicle_jwt',
                     params: {
                         tokenId: true
                     },
@@ -33,6 +33,23 @@ export class Telemetry extends Resource {
                         }
                     }
                 }`
+                },
+                getLatestVinVC: {
+                    auth: 'vehicle_jwt',
+                    params: {
+                        tokenId: true
+                    },
+                    query: `
+                    query {
+                        vinVCLatest(tokenId: $tokenId) {
+                            vin
+                        }
+                }`
+                },
+                getVin: {
+                    auth: 'vehicle_jwt',
+                    method: 'FUNCTION',
+                    path: 'getVin',
                 }
             });
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dimo-network/data-sdk",
-  "version": "1.2.1",
+  "version": "1.2.2",
   "description": "DIMO Data SDK for JavaScript",
   "main": "dist/index.js",
   "author": "James Li",
@@ -8,7 +8,7 @@
   "license": "Apache-2.0",
   "type": "module",
   "keywords": [
-    "data-sdk"
+    "data-sdk", "dimo", "dimo-network"
   ],
   "homepage": "https://dimo.org/developers",
   "bugs": {

package/dist/api/resources/VehicleSignalDecoding/index.d.ts

@@ -1,5 +0,0 @@
-import { Resource } from '../../Resource';
-import { DimoEnvironment } from '../../../environments';
-export declare class VehicleSignalDecoding extends Resource {
-    constructor(api: any, env: keyof typeof DimoEnvironment);
-}

package/dist/api/resources/VehicleSignalDecoding/index.js

@@ -1,59 +0,0 @@
-import { Resource } from '../../Resource';
-export class VehicleSignalDecoding extends Resource {
-    constructor(api, env) {
-        super(api, 'VehicleSignalDecoding', env);
-        this.setResource({
-            listConfigUrlsByVin: {
-                method: 'GET',
-                path: '/v1/device-config/vin/:vin/urls',
-                queryParams: {
-                    protocol: false
-                }
-            },
-            listConfigUrlsByAddress: {
-                method: 'GET',
-                path: '/v1/device-config/eth-addr/:address/urls',
-                queryParams: {
-                    protocol: false
-                }
-            },
-            getPidConfigs: {
-                method: 'GET',
-                path: '/v1/device-config/pids/:templateName',
-            },
-            getDeviceSettings: {
-                method: 'GET',
-                path: '/v1/device-config/settings/:templateName',
-            },
-            getDbcText: {
-                method: 'GET',
-                path: '/v1/device-config/dbc/:templateName'
-            },
-            getDeviceStatusByAddress: {
-                method: 'GET',
-                path: '/v1/device-config/eth-addr/:address/status',
-            },
-            setDeviceStatusByAddress: {
-                method: 'PATCH',
-                path: '/v1/device-config/eth-addr/:address/status',
-                body: {
-                    config: true
-                },
-                auth: 'privilege_token'
-            },
-            getJobsByAddress: {
-                method: 'GET',
-                path: '/v1/device-config/eth-addr/:address/jobs'
-            },
-            getPendingJobsByAddress: {
-                method: 'GET',
-                path: '/v1/device-config/eth-addr/:address/jobs/pending'
-            },
-            setJobStatusByAddress: {
-                method: 'PATCH',
-                path: '/v1/device-config/eth-addr/:address/jobs/:jobId/:status',
-                auth: 'privilege_token'
-            },
-        });
-    }
-}