@dimo-network/data-sdk 1.4.0 → 1.5.1

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

@@ -29,12 +29,17 @@ jobs:
   publish-npm:
     needs: build
     runs-on: ubuntu-latest
+    permissions:
+      id-token: write  # Required for OIDC
+      contents: read
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           node-version: 20
           registry-url: https://registry.npmjs.org/
+      - name: Install latest npm
+        run: npm install -g npm@latest
       - name: Clear npm cache
         run: npm cache clean --force
       - name: Install dependencies
@@ -46,5 +51,3 @@ jobs:
       - name: Check dist directory
         run: ls dist/
       - run: npm publish --access public
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/README.md

@@ -293,5 +293,87 @@ const totalNetworkVehicles = await dimo.identity.query({
 
 This GraphQL API query is equivalent to calling `dimo.identity.countDimoVehicles()`.
 
+### Agents API
+
+The DIMO Agents API enables developers to create intelligent AI agents that can interact with vehicle data through natural language. These agents can query vehicle information, real-time telemetry, perform web searches to answer questions about vehicles and nearby services, and more.
+
+#### Create an Agent
+
+Create a new conversational AI agent with the specified configuration:
+
+```ts
+const agent = await dimo.agents.createAgent({
+  ...developerJwt,
+  type: "driver_agent_v1", // Optional: defaults to "driver_agent_v1"
+  personality: "uncle_mechanic", // Optional: defaults to "uncle_mechanic"
+  secrets: {
+    DIMO_API_KEY: "<YOUR_API_KEY>"
+  },
+  variables: {
+    USER_WALLET: "0x1234567890abcdef1234567890abcdef12345678",
+    VEHICLE_IDS: "[872, 1234]"
+  }
+});
+```
+
+Available personalities: `uncle_mechanic`, `master_technician`, `concierge`, `driving_enthusiast`, `fleet_manager_pro`
+
+#### Send a Message
+
+Send a message to an agent and receive a complete response synchronously:
+
+```ts
+const response = await dimo.agents.sendMessage({
+  ...developerJwt,
+  agentId: "agent-abc123def456",
+  message: "What's the make and model of my vehicle?"
+});
+```
+
+#### Stream a Message
+
+Send a message and receive real-time token-by-token streaming response:
+
+```ts
+const stream = await dimo.agents.streamMessage({
+  ...developerJwt,
+  agentId: "agent-abc123def456",
+  message: "What's my current speed?"
+});
+
+stream.on('token', (chunk) => {
+  console.log(chunk.content);
+});
+
+stream.on('done', (metadata) => {
+  console.log('Vehicles queried:', metadata.vehiclesQueried);
+});
+```
+
+#### Get Conversation History
+
+Retrieve the complete conversation history for an agent:
+
+```ts
+const history = await dimo.agents.getHistory({
+  ...developerJwt,
+  agentId: "agent-abc123def456",
+  limit: 50 // Optional
+});
+```
+
+#### Delete an Agent
+
+Permanently delete an agent and all associated resources:
+
+```ts
+await dimo.agents.deleteAgent({
+  ...developerJwt,
+  agentId: "agent-abc123def456"
+});
+```
+
+For more details, visit the [Agents API Documentation](https://www.dimo.org/docs/api-references/agents-api).
+
 ## 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.js

@@ -87,14 +87,19 @@ export const Method = async (resource, baseUrl, params = {}, env) => {
     let body = {};
     if (resource.body) {
         for (const key in resource.body) {
-            if (typeof resource.body[key] === 'boolean') {
+            if (resource.body[key] === true) {
+                // Required field
                 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 (resource.body[key] === false) {
+                // Optional field - include only if provided
+                if (params[key] !== undefined) {
                     body[key] = params[key];
                 }
             }

package/dist/api/Method.test.js

@@ -2,6 +2,8 @@ import axios from 'axios';
 import { Method } from './Method'; // Import the Method function to be tested
 import { DimoError } from '../errors';
 import { DimoEnvironment } from '../environments';
+jest.mock('axios');
+const mockedAxios = axios;
 const PROD = 'Production';
 const DEV = 'Dev';
 const RESOURCE = {
@@ -11,8 +13,11 @@ const RESOURCE = {
 };
 const PARAM = { param1: 'value1' };
 describe('Method Function', () => {
+    beforeEach(() => {
+        jest.clearAllMocks();
+    });
     test('Valid API Call - Device Definitions API Server is up and returning data', async () => {
-        jest.spyOn(axios, 'request').mockResolvedValue({ data: { key: 'value' } });
+        mockedAxios.mockResolvedValue({ data: 'device definitions api running!' });
         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
@@ -20,7 +25,7 @@ describe('Method Function', () => {
         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' } });
+        mockedAxios.mockResolvedValue({ data: { data: 'Server is up and running' } });
         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
@@ -28,7 +33,7 @@ describe('Method Function', () => {
         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' } });
+        mockedAxios.mockResolvedValue({ data: { data: 'Server is up and running' } });
         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
@@ -36,7 +41,7 @@ describe('Method Function', () => {
         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' } });
+        mockedAxios.mockResolvedValue({ data: { code: 200, message: 'Server is up.' } });
         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
@@ -44,7 +49,7 @@ describe('Method Function', () => {
         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' } });
+        mockedAxios.mockResolvedValue({ data: 'healthy' });
         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

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

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

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

@@ -0,0 +1,63 @@
+import { Resource } from '../../Resource';
+export class Agents extends Resource {
+    constructor(api, env) {
+        super(api, 'Agents', env);
+        this.setResource({
+            healthCheck: {
+                method: 'GET',
+                path: '/'
+            },
+            createAgent: {
+                method: 'POST',
+                path: '/agents',
+                body: {
+                    'type': false,
+                    'personality': false,
+                    'secrets': true,
+                    'variables': true,
+                },
+                auth: 'developer_jwt'
+            },
+            deleteAgent: {
+                method: 'DELETE',
+                path: '/agents/:agentId',
+                auth: 'developer_jwt'
+            },
+            sendMessage: {
+                method: 'POST',
+                path: '/agents/:agentId/message',
+                body: {
+                    'message': true,
+                    'vehicleIds': false,
+                    'user': false
+                },
+                auth: 'developer_jwt'
+            },
+            streamMessage: {
+                method: 'POST',
+                path: '/agents/:agentId/stream',
+                body: {
+                    'message': true,
+                    'vehicleIds': false,
+                    'user': false
+                },
+                auth: 'developer_jwt'
+            },
+            getHistory: {
+                method: 'GET',
+                path: '/agents/:agentId/history',
+                queryParams: {
+                    'limit': false
+                },
+                auth: 'developer_jwt'
+            }
+        });
+        const originalCreateAgent = this.createAgent;
+        this.createAgent = (params = {}) => {
+            return originalCreateAgent({
+                type: 'driver_agent_v1',
+                ...params
+            });
+        };
+    }
+}

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

@@ -1,4 +1,5 @@
 /** @format */
+import { Agents } from './Agents';
 import { Attestation } from './Attestation';
 import { Auth } from './Auth';
 import { DeviceDefinitions } from './DeviceDefinitions';
@@ -7,4 +8,4 @@ import { TokenExchange } from './TokenExchange';
 import { Trips } from './Trips';
 import { Valuations } from './Valuations';
 import { VehicleTriggers } from './VehicleTriggers';
-export { Attestation, Auth, DeviceDefinitions, Devices, TokenExchange, Trips, Valuations, VehicleTriggers, };
+export { Agents, Attestation, Auth, DeviceDefinitions, Devices, TokenExchange, Trips, Valuations, VehicleTriggers, };

package/dist/api/resources/DimoRestResources.js

@@ -1,4 +1,5 @@
 /** @format */
+import { Agents } from './Agents';
 import { Attestation } from './Attestation';
 import { Auth } from './Auth';
 import { DeviceDefinitions } from './DeviceDefinitions';
@@ -7,4 +8,4 @@ import { TokenExchange } from './TokenExchange';
 import { Trips } from './Trips';
 import { Valuations } from './Valuations';
 import { VehicleTriggers } from './VehicleTriggers';
-export { Attestation, Auth, DeviceDefinitions, Devices, TokenExchange, Trips, Valuations, VehicleTriggers, };
+export { Agents, Attestation, Auth, DeviceDefinitions, Devices, TokenExchange, Trips, Valuations, VehicleTriggers, };

package/dist/cjs/index.js

@@ -20164,6 +20164,7 @@ const {
 /** @format */
 const DimoEnvironment = {
     Production: {
+        Agents: 'https://agents.dimo.zone',
         Attestation: 'https://attestation-api.dimo.zone',
         Auth: 'https://auth.dimo.zone',
         Identity: 'https://identity-api.dimo.zone/query',
@@ -20177,6 +20178,7 @@ const DimoEnvironment = {
         VehicleTriggers: 'https://vehicle-triggers-api.dimo.zone',
     },
     Dev: {
+        Agents: 'https://agents.dev.dimo.zone',
         Attestation: 'https://attestation-api.dev.dimo.zone',
         Auth: 'https://auth.dev.dimo.zone',
         Identity: 'https://identity-api.dev.dimo.zone/query',
@@ -20632,6 +20634,7 @@ class Telemetry extends Resource$1 {
 /** @format */
 // import { Stream } from './streamr';
 class DIMO {
+    agents;
     attestation;
     auth;
     devicedefinitions;
@@ -20648,6 +20651,7 @@ class DIMO {
         /**
          * Set up all REST Endpoints
          */
+        this.agents = new Agents(DimoEnvironment[env].Agents, env);
         this.attestation = new Attestation(DimoEnvironment[env].Attestation, env);
         this.auth = new Auth(DimoEnvironment[env].Auth, env);
         this.devicedefinitions = new DeviceDefinitions(DimoEnvironment[env].DeviceDefinitions, env);
@@ -142422,14 +142426,19 @@ const Method = async (resource, baseUrl, params = {}, env) => {
     let body = {};
     if (resource.body) {
         for (const key in resource.body) {
-            if (typeof resource.body[key] === 'boolean') {
+            if (resource.body[key] === true) {
+                // Required field
                 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 (resource.body[key] === false) {
+                // Optional field - include only if provided
+                if (params[key] !== undefined) {
                     body[key] = params[key];
                 }
             }
@@ -142487,6 +142496,69 @@ class Resource {
     }
 }
 
+class Agents extends Resource {
+    constructor(api, env) {
+        super(api, 'Agents', env);
+        this.setResource({
+            healthCheck: {
+                method: 'GET',
+                path: '/'
+            },
+            createAgent: {
+                method: 'POST',
+                path: '/agents',
+                body: {
+                    'type': false,
+                    'personality': false,
+                    'secrets': true,
+                    'variables': true,
+                },
+                auth: 'developer_jwt'
+            },
+            deleteAgent: {
+                method: 'DELETE',
+                path: '/agents/:agentId',
+                auth: 'developer_jwt'
+            },
+            sendMessage: {
+                method: 'POST',
+                path: '/agents/:agentId/message',
+                body: {
+                    'message': true,
+                    'vehicleIds': false,
+                    'user': false
+                },
+                auth: 'developer_jwt'
+            },
+            streamMessage: {
+                method: 'POST',
+                path: '/agents/:agentId/stream',
+                body: {
+                    'message': true,
+                    'vehicleIds': false,
+                    'user': false
+                },
+                auth: 'developer_jwt'
+            },
+            getHistory: {
+                method: 'GET',
+                path: '/agents/:agentId/history',
+                queryParams: {
+                    'limit': false
+                },
+                auth: 'developer_jwt'
+            }
+        });
+        const originalCreateAgent = this.createAgent;
+        this.createAgent = (params = {}) => {
+            return originalCreateAgent({
+                type: 'driver_agent_v1',
+                ...params
+            });
+        };
+    }
+}
+
 class Attestation extends Resource {
     constructor(api, env) {
         super(api, 'Attestation', env);
@@ -142743,6 +142815,7 @@ class VehicleTriggers extends Resource {
     }
 }
 
+exports.Agents = Agents;
 exports.Attestation = Attestation;
 exports.Auth = Auth;
 exports.DIMO = DIMO;