@dimo-network/data-sdk 1.2.1

package/dist/dimo.test.d.ts

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

package/dist/dimo.test.js

@@ -0,0 +1,57 @@
+import { DIMO } from './dimo';
+const PROD = 'Production';
+const DEV = 'Dev';
+const dimo = new DIMO(PROD);
+const devDimo = new DIMO(DEV);
+describe('Production Environment', () => {
+    test('Production resources are initialized with the correct environment', () => {
+        expect(dimo.attestation.env).toBe(PROD);
+        expect(dimo.auth.env).toBe(PROD);
+        expect(dimo.devicedefinitions.env).toBe(PROD);
+        expect(dimo.devices.env).toBe(PROD);
+        expect(dimo.identity.env).toBe(PROD);
+        expect(dimo.telemetry.env).toBe(PROD);
+        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;
+        expect(dimo.auth.api).toBeDefined;
+        expect(dimo.devicedefinitions.api).toBeDefined;
+        expect(dimo.devices.api).toBeDefined;
+        expect(dimo.identity.api).toBeDefined;
+        expect(dimo.telemetry.api).toBeDefined;
+        expect(dimo.tokenexchange.api).toBeDefined;
+        expect(dimo.trips.api).toBeDefined;
+        expect(dimo.valuations.api).toBeDefined;
+        expect(dimo.vehiclesignaldecoding.api).toBeDefined;
+    });
+});
+describe('Dev Environment', () => {
+    test('Dev resources are initialized with the correct environment', () => {
+        expect(devDimo.attestation.env).toBe(DEV);
+        expect(devDimo.auth.env).toBe(DEV);
+        expect(devDimo.devicedefinitions.env).toBe(DEV);
+        expect(devDimo.devices.env).toBe(DEV);
+        expect(devDimo.identity.env).toBe(DEV);
+        expect(devDimo.telemetry.env).toBe(DEV);
+        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;
+        expect(devDimo.auth.api).toBeDefined;
+        expect(devDimo.devicedefinitions.api).toBeDefined;
+        expect(devDimo.devices.api).toBeDefined;
+        expect(devDimo.identity.api).toBeDefined;
+        expect(devDimo.telemetry.api).toBeDefined;
+        expect(devDimo.tokenexchange.api).toBeDefined;
+        expect(devDimo.trips.api).toBeDefined;
+        expect(devDimo.valuations.api).toBeDefined;
+        expect(devDimo.vehiclesignaldecoding.api).toBeDefined;
+    });
+});

package/dist/environments/index.d.ts

@@ -0,0 +1,33 @@
+export declare const DimoEnvironment: {
+    readonly Production: {
+        readonly Attestation: "https://attestation-api.dimo.zone";
+        readonly Auth: "https://auth.dimo.zone";
+        readonly Identity: "https://identity-api.dimo.zone/query";
+        readonly Devices: "https://devices-api.dimo.zone";
+        readonly DeviceData: "https://device-data-api.dimo.zone";
+        readonly DeviceDefinitions: "https://device-definitions-api.dimo.zone";
+        readonly Events: "https://events-api.dimo.zone";
+        readonly Telemetry: "https://telemetry-api.dimo.zone/query";
+        readonly TokenExchange: "https://token-exchange-api.dimo.zone";
+        readonly Trips: "https://trips-api.dimo.zone";
+        readonly User: "https://users-api.dimo.zone";
+        readonly Valuations: "https://valuations-api.dimo.zone";
+        readonly VehicleSignalDecoding: "https://vehicle-signal-decoding.dimo.zone";
+    };
+    readonly Dev: {
+        readonly Attestation: "https://attestation-api.dev.dimo.zone";
+        readonly Auth: "https://auth.dev.dimo.zone";
+        readonly Identity: "https://identity-api.dev.dimo.zone/query";
+        readonly Devices: "https://devices-api.dev.dimo.zone";
+        readonly DeviceData: "https://device-data-api.dev.dimo.zone";
+        readonly DeviceDefinitions: "https://device-definitions-api.dev.dimo.zone";
+        readonly Events: "https://events-api.dev.dimo.zone";
+        readonly Telemetry: "https://telemetry-api.dev.dimo.zone/query";
+        readonly TokenExchange: "https://token-exchange-api.dev.dimo.zone";
+        readonly Trips: "https://trips-api.dev.dimo.zone";
+        readonly User: "https://users-api.dev.dimo.zone";
+        readonly Valuations: "https://valuations-api.dev.dimo.zone";
+        readonly VehicleSignalDecoding: "https://vehicle-signal-decoding.dev.dimo.zone";
+    };
+};
+export type DimoEnvironment = typeof DimoEnvironment.Production | typeof DimoEnvironment.Dev;

package/dist/environments/index.js

@@ -0,0 +1,32 @@
+export const DimoEnvironment = {
+    Production: {
+        'Attestation': 'https://attestation-api.dimo.zone',
+        'Auth': 'https://auth.dimo.zone',
+        'Identity': 'https://identity-api.dimo.zone/query',
+        'Devices': 'https://devices-api.dimo.zone',
+        'DeviceData': 'https://device-data-api.dimo.zone',
+        'DeviceDefinitions': 'https://device-definitions-api.dimo.zone',
+        'Events': 'https://events-api.dimo.zone',
+        'Telemetry': 'https://telemetry-api.dimo.zone/query',
+        'TokenExchange': 'https://token-exchange-api.dimo.zone',
+        'Trips': 'https://trips-api.dimo.zone',
+        'User': 'https://users-api.dimo.zone',
+        'Valuations': 'https://valuations-api.dimo.zone',
+        'VehicleSignalDecoding': 'https://vehicle-signal-decoding.dimo.zone'
+    },
+    Dev: {
+        'Attestation': 'https://attestation-api.dev.dimo.zone',
+        'Auth': 'https://auth.dev.dimo.zone',
+        'Identity': 'https://identity-api.dev.dimo.zone/query',
+        'Devices': 'https://devices-api.dev.dimo.zone',
+        'DeviceData': 'https://device-data-api.dev.dimo.zone',
+        'DeviceDefinitions': 'https://device-definitions-api.dev.dimo.zone',
+        'Events': 'https://events-api.dev.dimo.zone',
+        'Telemetry': 'https://telemetry-api.dev.dimo.zone/query',
+        'TokenExchange': 'https://token-exchange-api.dev.dimo.zone',
+        'Trips': 'https://trips-api.dev.dimo.zone',
+        'User': 'https://users-api.dev.dimo.zone',
+        'Valuations': 'https://valuations-api.dev.dimo.zone',
+        'VehicleSignalDecoding': 'https://vehicle-signal-decoding.dev.dimo.zone'
+    }
+};

package/dist/errors/DimoError.d.ts

@@ -0,0 +1,9 @@
+export declare class DimoError extends Error {
+    readonly statusCode?: number;
+    readonly body?: unknown;
+    constructor({ message, statusCode, body }: {
+        message?: string;
+        statusCode?: number;
+        body?: unknown;
+    });
+}

package/dist/errors/DimoError.js

@@ -0,0 +1,27 @@
+export class DimoError extends Error {
+    statusCode;
+    body;
+    constructor({ message, statusCode, body }) {
+        super(buildMessage({ message, statusCode, body }));
+        Object.setPrototypeOf(this, DimoError.prototype);
+        if (statusCode != null) {
+            this.statusCode = statusCode;
+        }
+        if (body !== undefined) {
+            this.body = body;
+        }
+    }
+}
+function buildMessage({ message, statusCode, body, }) {
+    let lines = [];
+    if (message != null) {
+        lines.push(message);
+    }
+    if (statusCode != null) {
+        lines.push(`Status code: ${statusCode.toString()}`);
+    }
+    if (body != null) {
+        lines.push(`Body: ${JSON.stringify(body, undefined, 2)}`);
+    }
+    return lines.join('\n');
+}

package/dist/errors/index.d.ts

@@ -0,0 +1 @@
+export * from './DimoError';

package/dist/errors/index.js

@@ -0,0 +1 @@
+export * from './DimoError';

package/dist/graphql/Query.d.ts

@@ -0,0 +1,2 @@
+export declare const Query: (resource: any, baseUrl: any, params?: any) => Promise<any>;
+export declare const CustomQuery: (resource: any, baseUrl: string, params?: any) => Promise<any>;

package/dist/graphql/Query.js

@@ -0,0 +1,104 @@
+import axios from 'axios';
+import { DimoError } from '../errors';
+// GraphQL query factory function
+export const Query = async (resource, baseUrl, params = {}) => {
+    /**
+     * 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
+            });
+        }
+    }
+    headers = {
+        ...headers,
+        ...{
+            'Content-Type': 'application/json',
+            'User-Agent': 'dimo-node-sdk'
+        }
+    };
+    const variables = resource.params || {};
+    let query = resource.query;
+    for (const key in variables) {
+        const placeholder = new RegExp(`\\$${key}\\b`, 'g');
+        if (variables[key] === true) {
+            if (!params[key]) {
+                console.error(`Missing required input: ${key}`);
+                throw new DimoError({
+                    message: `Missing required input: ${key}`,
+                    statusCode: 400
+                });
+            }
+            const value = typeof params[key] === 'string' ? `"${params[key]}"` : params[key];
+            query = query.replace(placeholder, value);
+        }
+    }
+    try {
+        const response = await axios({
+            method: 'POST',
+            url: baseUrl,
+            headers: headers,
+            data: {
+                query
+            }
+        });
+        return response.data;
+    }
+    catch (error) {
+        console.error('Error executing GraphQL query:', error);
+        throw new DimoError({
+            message: `Error`,
+            statusCode: 400
+        });
+    }
+};
+export const CustomQuery = async (resource, baseUrl, params = {}) => {
+    /**
+     * 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
+            });
+        }
+    }
+    headers = {
+        ...headers,
+        ...{
+            'Content-Type': 'application/json',
+            'User-Agent': 'dimo-node-sdk'
+        }
+    };
+    const query = params.query || {};
+    try {
+        const response = await axios({
+            method: 'POST',
+            url: baseUrl,
+            headers: headers,
+            data: {
+                query
+            }
+        });
+        return response.data;
+    }
+    catch (error) {
+        console.error('Error executing Custom GraphQL query:', error);
+        throw new DimoError({
+            message: 'Error executing Custom GraphQL query',
+            statusCode: 400
+        });
+    }
+};

package/dist/graphql/Query.test.d.ts

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

package/dist/graphql/Query.test.js

@@ -0,0 +1,47 @@
+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 RESOURCE = {
+    method: 'POST',
+    path: '',
+    queryParams: { param1: true },
+};
+const PARAM = { query: `{
+    vehicles (first:10) {
+      totalCount
+    }
+}` };
+describe('Query Function', () => {
+    test('Valid API Call - Identity API Server is up and returning data', async () => {
+        jest.spyOn(axios, 'request').mockResolvedValue({ query: `{
+            vehicles (first:10) {
+              totalCount
+            }
+        }` });
+        const devResponse = await CustomQuery(RESOURCE, DimoEnvironment.Dev.Identity, PARAM);
+        const prodResponse = await CustomQuery(RESOURCE, DimoEnvironment.Production.Identity, PARAM);
+        // Assertion - Check if the response data is defined
+        expect(devResponse.data).toBeDefined();
+        expect(prodResponse.data).toBeDefined();
+    });
+    test('Missing Required Query Parameter - Throws Error', async () => {
+        // Mock input data with missing required query parameter
+        const devResource = {
+            Query: 'POST',
+            path: '',
+            queryParams: { expectedParam: true },
+        };
+        const prodResource = {
+            Query: 'POST',
+            path: '',
+            queryParams: { expectedParam: true },
+        };
+        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);
+    });
+});

package/dist/graphql/Resource.d.ts

@@ -0,0 +1,16 @@
+import { DimoEnvironment } from '../environments';
+export interface Resource {
+    [key: string]: (...args: any) => any;
+}
+export declare class Resource {
+    api: any;
+    resourceName: any;
+    env: any;
+    constructor(api: any, resourceName: string, env: keyof typeof DimoEnvironment);
+    protected setQueries(resources: any): void;
+    /**
+     * Custom GraphQL Queries
+     * @param resources
+     */
+    query(resources: any): void;
+}

package/dist/graphql/Resource.js

@@ -0,0 +1,29 @@
+import { CustomQuery, Query } from './Query';
+export class Resource {
+    api;
+    resourceName;
+    env;
+    constructor(api, resourceName, env) {
+        this.api = api;
+        this.resourceName = resourceName;
+        this.env = env;
+    }
+    setQueries(resources) {
+        Object.keys(resources).forEach(key => {
+            this[key] = (params = {}) => Query(resources[key], // Setup the endpoint resources
+            this.api, // Setup the base URL
+            params);
+        });
+    }
+    /**
+     * Custom GraphQL Queries
+     * @param resources
+     */
+    query(resources) {
+        Object.keys(resources).forEach(key => {
+            this[key] = (params = {}) => CustomQuery(resources, // Setup the endpoint resources
+            this.api, // Setup the base URL
+            params);
+        });
+    }
+}

package/dist/graphql/index.d.ts

@@ -0,0 +1 @@
+export * from './resources/DimoGraphqlResources';

package/dist/graphql/index.js

@@ -0,0 +1 @@
+export * from './resources/DimoGraphqlResources';

package/dist/graphql/resources/DimoGraphqlResources.d.ts

@@ -0,0 +1,3 @@
+import { Identity } from './Identity';
+import { Telemetry } from './Telemetry';
+export { Identity, Telemetry };

package/dist/graphql/resources/DimoGraphqlResources.js

@@ -0,0 +1,3 @@
+import { Identity } from './Identity';
+import { Telemetry } from './Telemetry';
+export { Identity, Telemetry };

package/dist/graphql/resources/Identity/index.d.ts

@@ -0,0 +1,6 @@
+import { Resource } from '../../Resource';
+import { DimoEnvironment } from '../../../environments';
+export declare class Identity extends Resource {
+    constructor(api: any, env: keyof typeof DimoEnvironment);
+}
+export declare const listVehicleDefinitionsPerAddress: (address: string, limit: number) => string;

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

@@ -0,0 +1,100 @@
+import { Resource } from '../../Resource';
+export class Identity extends Resource {
+    constructor(api, env) {
+        super(api, 'Identity', env);
+        this.query({
+            query: true
+        }),
+            this.setQueries({
+                countDimoVehicles: {
+                    query: `
+                { 
+                    vehicles (first:10) {
+                        totalCount,
+                    }
+                }
+                `
+                },
+                listVehicleDefinitionsPerAddress: {
+                    params: {
+                        address: true,
+                        limit: true
+                    },
+                    query: `
+                {
+                    vehicles(filterBy: {owner: $address}, first: $limit) {
+                      nodes {
+                        aftermarketDevice {
+                            tokenId
+                            address
+                        }
+                          syntheticDevice {
+                            address
+                            tokenId
+                        }
+                        definition {
+                          make
+                          model
+                          year
+                        }
+                      }
+                    }
+                  }
+                `
+                }
+            });
+    }
+}
+export const listVehicleDefinitionsPerAddress = (address, limit) => `
+{
+    vehicles(filterBy: {owner: "${address}"}, first: ${limit}) {
+      nodes {
+        aftermarketDevice {
+            tokenId
+            address
+        }
+          syntheticDevice {
+            address
+            tokenId
+        }
+        definition {
+          make
+          model
+          year
+        }
+      }
+    }
+  }
+`;
+// export const getVehicleDetailsByTokenId = (tokenId: number) => `
+// {
+//     vehicle (tokenId: ${tokenId}) {
+//       aftermarketDevice {
+//         tokenId
+//         address
+//       }
+//       syntheticDevice {
+//         address
+//         tokenId
+//       }
+//       definition {
+//         make
+//         model
+//         year
+//       }
+//     }
+//   }
+// `;
+// export const test = () => `
+// {
+//     vehicles(filterBy: {owner: "0xf9D26323Ab49179A6d57C26515B01De018553787"}, first: 10) {
+//       nodes {
+//         definition {
+//           make
+//           model
+//           year
+//         }
+//       }
+//     }
+//   }
+// `;

package/dist/graphql/resources/Telemetry/index.d.ts

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

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

@@ -0,0 +1,39 @@
+import { Resource } from '../../Resource';
+export class Telemetry extends Resource {
+    constructor(api, env) {
+        super(api, 'Telemetry', env);
+        this.query({
+            auth: 'privilege_token',
+            query: true,
+        }),
+            this.setQueries({
+                getLatestSignals: {
+                    auth: 'privilege_token',
+                    params: {
+                        tokenId: true
+                    },
+                    query: `
+                query {
+                    SignalsLatest(tokenID: $tokenId){
+                        powertrainTransmissionTravelledDistance {
+                            timestamp
+                            value
+                        }
+                        exteriorAirTemperature {
+                            timestamp
+                            value
+                        }
+                        speed{
+                            timestamp
+                            value
+                        }
+                        powertrainType{
+                            timestamp
+                            value
+                        }
+                    }
+                }`
+                }
+            });
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+/**
+ *                    _..-------++._
+ *                _.-'/ |      _||  \"--._
+ *          __.--'`._/_\j_____/_||___\    `----.
+ *     _.--'_____    | D I M O  \     _____    /
+ *  _j    /,---.\    |  S D K =o|   /,---.\   |_
+ * [__]==// .-. \\==`===========/==// .-. \\=[__]
+ *   `-._|\ `-' /|___\_________/___|\ `-' /|_.'
+ *         `---'                     `---'
+ *
+ *
+ */
+export * from './api';
+export * from './environments';
+export * from './errors';
+export * from './graphql';
+export * from './constants';
+export * from './dimo';

package/dist/index.js

@@ -0,0 +1,18 @@
+/**
+ *                    _..-------++._
+ *                _.-'/ |      _||  \"--._
+ *          __.--'`._/_\j_____/_||___\    `----.
+ *     _.--'_____    | D I M O  \     _____    /
+ *  _j    /,---.\    |  S D K =o|   /,---.\   |_
+ * [__]==// .-. \\==`===========/==// .-. \\=[__]
+ *   `-._|\ `-' /|___\_________/___|\ `-' /|_.'
+ *         `---'                     `---'
+ *
+ *
+ */
+export * from './api';
+export * from './environments';
+export * from './errors';
+export * from './graphql';
+export * from './constants';
+export * from './dimo';

package/dist/streamr/index.js

@@ -0,0 +1,51 @@
+"use strict";
+// import StreamrClient from '@streamr/sdk';
+// import { DimoError } from '../errors';
+// import { Observable } from 'rxjs';
+// import { catchError, finalize } from 'rxjs/operators';
+// type StreamOptions = {
+//     streamId: string,
+//     clientId: string,
+//     privateKey: string,
+//     log?: string
+// };
+// export const Stream = async ({ streamId, clientId, privateKey, log }: StreamOptions) => {
+//     return new Observable(observer => {
+//         const client = new StreamrClient({
+//             logLevel: 'info' || log,
+//             auth: {
+//               //this is the signer private key the developer adds
+//               privateKey: privateKey
+//             },
+//         });
+//         const setupStream = async () => {
+//             try {
+//                 const stream = await client.getStream(streamId);
+//                 await client.subscribe({
+//                     streamId,
+//                     erc1271Contract: clientId,
+//                 }, (msg) => {
+//                     observer.next(msg);
+//                 });
+//             } catch (error) {
+//                 console.error('Streamr connection failed:', error);
+//                 observer.error(new DimoError({
+//                     message: 'Streamr connection failure'
+//                 }));
+//                 observer.complete();
+//             }
+//         };
+//         setupStream();
+//         return async () => {
+//             await client.unsubscribe(streamId);
+//         }
+//     }).pipe(
+//         catchError(error => {
+//             console.error('Streamr subscription error:', error);
+//             return new Observable();
+//         }),
+//         finalize(() => {
+//             console.log('Cleaning up Stream listeners');
+//         })
+//     );
+// }

package/jest.config.js

@@ -0,0 +1,16 @@
+export default {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  roots: ['<rootDir>/src'],
+  testMatch: ['**/__tests__/**/*.ts', '**/?(*.)+(spec|test).ts'],
+  transform: {
+    '^.+\\.tsx?$': 'ts-jest',  // Transform TypeScript files
+    '^.+\\.mjs$': 'babel-jest', // Transform .mjs files using Babel
+    '^.+\\.js$': 'babel-jest',  // Transform JavaScript files
+  },
+  transformIgnorePatterns: ['<rootDir>/node_modules/'],
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node', 'mjs'],  
+  moduleNameMapper: {
+    '^@/(.*)$': '<rootDir>/src/$1'  // Adjust this if you're using path aliases
+  }
+};