@dimo-network/data-sdk 1.2.4 → 1.3.0

package/README.jp.md

@@ -0,0 +1,86 @@
+![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
+## 概要
+DIMO Data SDK は、TypeScript で構築された公式ライブラリであり、DIMO API を簡単かつ効率的に利用できるように設計されています。この SDK は、開発者が DIMO プラットフォームと統合する際の複雑さを軽減し、迅速な開発を可能にします。API 呼び出しの抽象化、データ操作の簡素化、そして堅牢な型安全性を提供することで、開発者体験を向上させます。
+
+## インストール
+
+[npm](https://www.npmjs.com/package/@dimo-network/data-sdk) を使用する場合:
+```bash
+npm install @dimo-network/data-sdk
+```
+
+[yarn](https://classic.yarnpkg.com/en/package/@dimo-network/data-sdk) を使用する場合:
+
+```bash
+yarn add @dimo-network/data-sdk
+```
+
+## 単体テスト
+`npm test` または `npm run test` を実行して、Jest テストを実行します。
+
+## API ドキュメント
+DIMO での開発や API に関する詳細情報については、DIMO の [開発者向けドキュメント](https://docs.dimo.org/developer-platform) をご覧ください。
+
+## SDK の使用方法
+### SDK ライブラリ
+
+(TypeScript / ES Modules)
+```ts
+import { DIMO } from '@dimo-network/data-sdk';
+```
+
+(CommonJS)
+```js
+const { DIMO } = require('@dimo-network/data-sdk')
+```
+### SDK 初期化
+
+```ts
+const dimo = new DIMO('Production');
+```
+
+### 開発者登録
+認証プロセスの一環として、[DIMO 開発者コンソール](https://console.dimo.org/) を通じて開発者ライセンスを取得する必要があります。登録を開始するには、以下の手順に従ってください:
+1. [DIMO 開発者コンソール](https://console.dimo.org/) にサインアップします。
+2. 「ライセンスを作成」(Create a License) をクリックし、ライセンスに関する詳細を入力します。
+3. API キー（API Key）を生成し、希望するリダイレクト URI（RedirectURI）を追加します。
+
+### 開発者認証
+本 SDK は、「開発者用 JWT を取得するための[認証フロー](https://docs.dimo.org/developer-platform/getting-started/developer-guide/authentication) に必要なすべての手順」と、「アプリと共有された各車両に対して Vehicle JWT を取得するための手順」を提供します。
+
+#### 認証の前提条件
+1. 開発者ライセンス
+2. API キー、リダイレクト URI（RedirectURI）
+3. 適切な [TypeScript を使用したプロジェクトのセットアップ](https://nodejs.keicode.com/typescript/create-ts-project.php)。
+
+#### 開発者 JWT
+
+```ts
+const developerJwt = await dimo.auth.getDeveloperJwt({
+  client_id: '<client_id>',
+  domain: '<domain/redirect_uri>',
+  private_key: '<api_key>',
+});
+```
+
+#### 車両 JWT
+消費者から車両データを取得するには、アプリケーションが短期間有効な [車両 JWT](https://docs.dimo.org/developer-platform/getting-started/developer-guide/authentication#getting-a-jwt) を交換する必要があります。この 車両 JWT は、アプリに権限を付与した車両に対して取得されます。
+
+消費者は事前に車両の権限を共有する必要があります。そのためには、[Login with DIMO](https://docs.dimo.org/developer-platform/getting-started/developer-guide/login-with-dimo) や DIMO Mobile のような実装が必要です。この手順が完了すると、車両データを取得できるようになります。
+
+```ts
+const vehicleJwt = await dimo.tokenexchange.getVehicleJwt({
+  ...developerJwt,
+  tokenId: 117315
+});
+```
+
+## SDK への貢献方法
+SDK への貢献についての詳細は、[こちら](https://github.com/DIMO-Network/data-sdk/blob/master/CONTRIBUTING.md)をご覧ください。

package/README.md

@@ -49,14 +49,16 @@ const dimo = new DIMO('Production');
 ### 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 (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.
+2. Click on `Create a license` and fill out the details about your license.
+3. 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 a Developer JWT & to get Vehicle JWT for each vehicle shared with your app.
 
+#### Prerequisites for Authentication
+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).
 
 #### Developer JWT
@@ -198,7 +200,7 @@ The GraphQL entry points are designed almost identical to the REST API entry poi
 
 ```ts
 const vehicleJwt = await dimo.tokenexchange.exchange({
-  ...vehicleJwt,
+  ...developerJwt,
   privileges: [1, 3, 4],
   tokenId: <vehicle_token_id>
 });

package/README.zh-tw.md

@@ -0,0 +1,86 @@
+![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
+## 概述
+DIMO Data SDK 是一個以 TypeScript 構建的官方函式庫，旨在讓開發者能夠簡單且高效地使用 DIMO API。此 SDK 減少了開發者在整合 DIMO 平台時的複雜性，並加速開發過程。透過 API 調用的抽象化、簡化數據操作以及提供強大的型別安全性，提升了開發者的使用體驗。
+
+## 安裝
+
+使用 [npm](https://www.npmjs.com/package/@dimo-network/data-sdk):
+```bash
+npm install @dimo-network/data-sdk
+```
+
+使用 [yarn](https://classic.yarnpkg.com/en/package/@dimo-network/data-sdk):
+
+```bash
+yarn add @dimo-network/data-sdk
+```
+
+## 單元測試
+執行 `npm test` 或 `npm run test` 來運行 Jest 測試。
+
+## API 文件
+有關 DIMO 開發或 API 的詳細資訊，請參閱 DIMO 的 [開發者文件](https://docs.dimo.org/developer-platform)。
+
+## SDK 使用方法
+### 訪問函式庫
+
+(TypeScript / ES Modules)
+```ts
+import { DIMO } from '@dimo-network/data-sdk';
+```
+
+(CommonJS)
+```js
+const { DIMO } = require('@dimo-network/data-sdk')
+```
+### SDK 初始化
+
+```ts
+const dimo = new DIMO('Production');
+```
+
+### 開發者註冊
+作為認證流程的一部分，您需要先通過 [DIMO Developer Console](https://console.dimo.org/) 獲取開發者授權身份。請按照以下步驟開始註冊：
+1. 造訪 [DIMO 開發者主控台](https://console.dimo.org/) 並註冊帳號。
+2. 點擊「創建執照」（Create a License），並輸入您的相關執照詳細資訊。
+3. 生成 API 金鑰（API Key），並新增所需的統一資源識別碼（Redirect URI）。
+
+### 開發者認證
+SDK 提供了[認證流程](https://docs.dimo.org/developer-platform/getting-started/developer-guide/authentication) 所需的所有步驟，幫助您獲取「開發者 JWT」（Developer JWT）以及每輛與應用程式共享的車輛所使用的「車輛 JWT」（Vehicle JWT）。
+
+#### 認證的前置條件
+1. 開發者執照
+2. API 金鑰以及至少一組自訂的統一資源識別碼（Redirect URI）
+3. 適當的 [TypeScript 環境設置](https://learn.microsoft.com/zh-tw/visualstudio/javascript/compile-typescript-code-npm?view=vs-2022)。
+
+#### 開發者 JWT
+
+```ts
+const developerJwt = await dimo.auth.getDeveloperJwt({
+    client_id: '<client_id>',
+    domain: '<domain/redirect_uri>',
+    private_key: '<api_key>',
+});
+```
+
+#### 車輛 JWT
+若要從消費者處獲取車輛數據，應用程式需要交換短期有效的 [車輛 JWT](https://docs.dimo.org/developer-platform/getting-started/developer-guide/authentication#getting-a-jwt)。此車輛 JWT 是針對授權應用程式的車輛生成的。
+
+消費者需要事先與您的應用程式共享車輛授權。為此，您可以透過前端整合 [Login with DIMO](https://docs.dimo.org/developer-platform/getting-started/developer-guide/login-with-dimo) 或開發出類似 DIMO Mobile 全端的功能。完成「分享」此步驟後，您將能夠自由獲取車輛數據。
+
+```ts
+const vehicleJwt = await dimo.tokenexchange.getVehicleJwt({
+    ...developerJwt,
+    tokenId: 117315
+});
+```
+
+## SDK 貢獻
+有關如何貢獻於此 SDK 的詳細資訊，請參閱[此處](https://github.com/DIMO-Network/data-sdk/blob/master/CONTRIBUTING.md)。

package/dist/api/Resource.d.ts

@@ -1,11 +1,11 @@
-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 setResource(resources: any): void;
+/** @format */
+import { DimoEnvironment } from "../environments";
+import { ResourceMap } from "./types/Endpoint";
+export declare class Resource<TApi = string> {
+    [key: string]: any;
+    api: TApi;
+    resourceName: string;
+    env: keyof typeof DimoEnvironment;
+    constructor(api: TApi, resourceName: string, env: keyof typeof DimoEnvironment);
+    protected setResource<T extends ResourceMap>(resources: T): void;
 }

package/dist/api/Resource.js

@@ -1,4 +1,5 @@
-import { Method } from './Method';
+/** @format */
+import { Method } from "./Method";
 export class Resource {
     api;
     resourceName;
@@ -9,12 +10,8 @@ export class Resource {
         this.env = env;
     }
     setResource(resources) {
-        Object.keys(resources).forEach(key => {
-            this[key] = (params = {}) => Method(resources[key], // Setup the endpoint resources
-            this.api, // Setup the base URL
-            params, // Pass through the params
-            this.env // Identiy the environment
-            );
+        Object.keys(resources).forEach((key) => {
+            this[key] = (params = {}) => Method(resources[key], this.api, params, this.env);
         });
     }
 }

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

@@ -1,8 +1,10 @@
-import { Attestation } from './Attestation';
-import { Auth } from './Auth';
-import { DeviceDefinitions } from './DeviceDefinitions';
-import { Devices } from './Devices';
-import { TokenExchange } from './TokenExchange';
-import { Trips } from './Trips';
-import { Valuations } from './Valuations';
-export { Attestation, Auth, DeviceDefinitions, Devices, TokenExchange, Trips, Valuations };
+/** @format */
+import { Attestation } from "./Attestation";
+import { Auth } from "./Auth";
+import { DeviceDefinitions } from "./DeviceDefinitions";
+import { Devices } from "./Devices";
+import { TokenExchange } from "./TokenExchange";
+import { Trips } from "./Trips";
+import { Valuations } from "./Valuations";
+import { VehicleEvents } from "./VehicleEvents";
+export { Attestation, Auth, DeviceDefinitions, Devices, TokenExchange, Trips, Valuations, VehicleEvents, };

package/dist/api/resources/DimoRestResources.js

@@ -1,8 +1,10 @@
-import { Attestation } from './Attestation';
-import { Auth } from './Auth';
-import { DeviceDefinitions } from './DeviceDefinitions';
-import { Devices } from './Devices';
-import { TokenExchange } from './TokenExchange';
-import { Trips } from './Trips';
-import { Valuations } from './Valuations';
-export { Attestation, Auth, DeviceDefinitions, Devices, TokenExchange, Trips, Valuations };
+/** @format */
+import { Attestation } from "./Attestation";
+import { Auth } from "./Auth";
+import { DeviceDefinitions } from "./DeviceDefinitions";
+import { Devices } from "./Devices";
+import { TokenExchange } from "./TokenExchange";
+import { Trips } from "./Trips";
+import { Valuations } from "./Valuations";
+import { VehicleEvents } from "./VehicleEvents";
+export { Attestation, Auth, DeviceDefinitions, Devices, TokenExchange, Trips, Valuations, VehicleEvents, };

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

@@ -0,0 +1,7 @@
+/** @format */
+import { Resource } from "api/Resource";
+import { DimoEnvironment } from "environments";
+declare class VehicleEvents extends Resource {
+    constructor(api: any, env: keyof typeof DimoEnvironment);
+}
+export { VehicleEvents };

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

@@ -0,0 +1,85 @@
+/** @format */
+import { Resource } from "api/Resource";
+class VehicleEvents extends Resource {
+    constructor(api, env) {
+        super(api, "VehicleEvents", env);
+        this.setResource({
+            listWebhooks: {
+                method: "GET",
+                path: "/v1/webhooks",
+                auth: "developer_jwt",
+            },
+            createWebhook: {
+                method: "POST",
+                path: "/v1/webhooks",
+                body: {
+                    service: true,
+                    data: true,
+                    trigger: true,
+                    setup: true,
+                    description: false,
+                    target_uri: true,
+                    status: true,
+                    verification_token: true,
+                },
+                auth: "developer_jwt",
+            },
+            updateWebhook: {
+                method: "PUT",
+                path: "/v1/webhooks/:webhookId",
+                body: {
+                    service: true,
+                    data: true,
+                    trigger: true,
+                    setup: true,
+                    description: false,
+                    target_uri: true,
+                    status: true,
+                    verification_token: true,
+                },
+                auth: "developer_jwt",
+            },
+            deleteWebhook: {
+                method: "DELETE",
+                path: "/v1/webhooks/:webhookId",
+                auth: "developer_jwt",
+            },
+            getWebhookSignalNames: {
+                method: "GET",
+                path: "/v1/webhooks/signals",
+                auth: "developer_jwt",
+            },
+            listSubscribedVehicles: {
+                method: "GET",
+                path: "/v1/webhooks/:webhookId",
+                auth: "developer_jwt",
+            },
+            listVehicleSubscriptions: {
+                method: "GET",
+                path: "/v1/webhooks/vehicles/:tokenId",
+                auth: "developer_jwt",
+            },
+            subscribeVehicle: {
+                method: "POST",
+                path: "/v1/webhooks/:webhookId/subscribe/:tokenId",
+                auth: "developer_jwt",
+            },
+            subscribeAllVehicles: {
+                method: "POST",
+                path: "/v1/webhooks/:webhookId/subscribe/all",
+                auth: "developer_jwt",
+            },
+            unsubscribeVehicle: {
+                method: "DELETE",
+                path: "/v1/webhooks/:webhookId/unsubscribe/:tokenId",
+                auth: "developer_jwt",
+            },
+            unsubscribeAllVehicles: {
+                method: "DELETE",
+                path: "/v1/webhooks/:webhookId/unsubscribe/all",
+                auth: "developer_jwt",
+            },
+        });
+    }
+}
+export { VehicleEvents };

package/dist/api/types/Endpoint.d.ts

@@ -0,0 +1,11 @@
+/** @format */
+export type EndpointDefinition = {
+    method: "GET" | "POST" | "PUT" | "DELETE" | "FUNCTION";
+    path: string;
+    auth?: "developer_jwt" | "vehicle_jwt";
+    body?: Record<string, boolean | string | number>;
+    queryParams?: Record<string, boolean | string | number>;
+    headers?: Record<string, string>;
+    return?: string;
+};
+export type ResourceMap = Record<string, EndpointDefinition>;

package/dist/api/types/Endpoint.js

@@ -0,0 +1,2 @@
+/** @format */
+export {};

package/dist/dimo.d.ts

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

package/dist/dimo.js

@@ -1,7 +1,8 @@
-import { DimoEnvironment } from './environments';
-import { DimoError } from './errors';
-import { Identity, Telemetry } from './graphql/resources/DimoGraphqlResources';
-import { Attestation, Auth, DeviceDefinitions, Devices, TokenExchange, Trips, Valuations } from './api/resources/DimoRestResources';
+/** @format */
+import { DimoEnvironment } from "./environments";
+import { DimoError } from "./errors";
+import { Identity, Telemetry } from "./graphql/resources/DimoGraphqlResources";
+import { Attestation, Auth, DeviceDefinitions, Devices, TokenExchange, Trips, Valuations, VehicleEvents, } from "./api/resources/DimoRestResources";
 // import { Stream } from './streamr';
 export class DIMO {
     attestation;
@@ -13,6 +14,7 @@ export class DIMO {
     tokenexchange;
     trips;
     valuations;
+    vehicleEvents;
     constructor(env) {
         this.identity = new Identity(DimoEnvironment[env].Identity, env);
         this.telemetry = new Telemetry(DimoEnvironment[env].Telemetry, env);
@@ -26,26 +28,29 @@ 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.vehicleEvents = new VehicleEvents(DimoEnvironment[env].VehicleEvents, env);
     }
     // Helper Function
     async authenticate() {
         let fs;
         try {
             // Dynamically import fs
-            if (typeof process !== 'undefined' && process.versions && process.versions.node) {
-                fs = await import('fs');
+            if (typeof process !== "undefined" &&
+                process.versions &&
+                process.versions.node) {
+                fs = await import("fs");
             }
             else {
                 // Optionally handle the case where 'fs' is not available, returns null
-                console.log('Not in Node.js environment; `fs` module is not available.');
+                console.log("Not in Node.js environment; `fs` module is not available.");
                 return null;
             }
-            if (!fs.existsSync('.credentials.json')) {
+            if (!fs.existsSync(".credentials.json")) {
                 throw new DimoError({
-                    message: 'Credentials file does not exist'
+                    message: "Credentials file does not exist",
                 });
             }
-            const data = fs.readFileSync('.credentials.json', 'utf8');
+            const data = fs.readFileSync(".credentials.json", "utf8");
             const credentials = JSON.parse(data);
             const authHeader = await this.auth.getDeveloperJwt({
                 client_id: credentials.client_id,
@@ -56,10 +61,10 @@ export class DIMO {
         }
         catch (error) {
             // Handle file not existing and other errors
-            console.error('Failed to authenticate:', error.message);
+            console.error("Failed to authenticate:", error.message);
             // Decide whether to throw the error or handle it differently
             throw new DimoError({
-                message: 'Authentication failed'
+                message: "Authentication failed",
             });
         }
     }

package/dist/environments/index.d.ts

@@ -1,3 +1,4 @@
+/** @format */
 export declare const DimoEnvironment: {
     readonly Production: {
         readonly Attestation: "https://attestation-api.dimo.zone";
@@ -10,6 +11,7 @@ export declare const DimoEnvironment: {
         readonly Trips: "https://trips-api.dimo.zone";
         readonly Valuations: "https://valuations-api.dimo.zone";
         readonly VehicleSignalDecoding: "https://vehicle-signal-decoding.dimo.zone";
+        readonly VehicleEvents: "https://vehicle-events-api.dimo.zone";
     };
     readonly Dev: {
         readonly Attestation: "https://attestation-api.dev.dimo.zone";
@@ -22,6 +24,7 @@ export declare const DimoEnvironment: {
         readonly Trips: "https://trips-api.dev.dimo.zone";
         readonly Valuations: "https://valuations-api.dev.dimo.zone";
         readonly VehicleSignalDecoding: "https://vehicle-signal-decoding.dev.dimo.zone";
+        readonly VehicleEvents: "https://vehicle-events-api.dev.dimo.zone";
     };
 };
 export type DimoEnvironment = typeof DimoEnvironment.Production | typeof DimoEnvironment.Dev;

package/dist/environments/index.js

@@ -1,26 +1,29 @@
+/** @format */
 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',
-        'DeviceDefinitions': 'https://device-definitions-api.dimo.zone',
-        'Telemetry': 'https://telemetry-api.dimo.zone/query',
-        'TokenExchange': 'https://token-exchange-api.dimo.zone',
-        'Trips': 'https://trips-api.dimo.zone',
-        'Valuations': 'https://valuations-api.dimo.zone',
-        'VehicleSignalDecoding': 'https://vehicle-signal-decoding.dimo.zone'
+        Attestation: "https://attestation-api.dimo.zone",
+        Auth: "https://auth.dimo.zone",
+        Identity: "https://identity-api.dimo.zone/query",
+        Devices: "https://devices-api.dimo.zone",
+        DeviceDefinitions: "https://device-definitions-api.dimo.zone",
+        Telemetry: "https://telemetry-api.dimo.zone/query",
+        TokenExchange: "https://token-exchange-api.dimo.zone",
+        Trips: "https://trips-api.dimo.zone",
+        Valuations: "https://valuations-api.dimo.zone",
+        VehicleSignalDecoding: "https://vehicle-signal-decoding.dimo.zone",
+        VehicleEvents: "https://vehicle-events-api.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',
-        'DeviceDefinitions': 'https://device-definitions-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',
-        'Valuations': 'https://valuations-api.dev.dimo.zone',
-        'VehicleSignalDecoding': 'https://vehicle-signal-decoding.dev.dimo.zone'
-    }
+        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",
+        DeviceDefinitions: "https://device-definitions-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",
+        Valuations: "https://valuations-api.dev.dimo.zone",
+        VehicleSignalDecoding: "https://vehicle-signal-decoding.dev.dimo.zone",
+        VehicleEvents: "https://vehicle-events-api.dev.dimo.zone",
+    },
 };

package/dist/index.cjs

@@ -22009,31 +22009,34 @@ const {
   mergeConfig
 } = axios;
 
+/** @format */
 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',
-        'DeviceDefinitions': 'https://device-definitions-api.dimo.zone',
-        'Telemetry': 'https://telemetry-api.dimo.zone/query',
-        'TokenExchange': 'https://token-exchange-api.dimo.zone',
-        'Trips': 'https://trips-api.dimo.zone',
-        'Valuations': 'https://valuations-api.dimo.zone',
-        'VehicleSignalDecoding': 'https://vehicle-signal-decoding.dimo.zone'
+        Attestation: "https://attestation-api.dimo.zone",
+        Auth: "https://auth.dimo.zone",
+        Identity: "https://identity-api.dimo.zone/query",
+        Devices: "https://devices-api.dimo.zone",
+        DeviceDefinitions: "https://device-definitions-api.dimo.zone",
+        Telemetry: "https://telemetry-api.dimo.zone/query",
+        TokenExchange: "https://token-exchange-api.dimo.zone",
+        Trips: "https://trips-api.dimo.zone",
+        Valuations: "https://valuations-api.dimo.zone",
+        VehicleSignalDecoding: "https://vehicle-signal-decoding.dimo.zone",
+        VehicleEvents: "https://vehicle-events-api.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',
-        'DeviceDefinitions': 'https://device-definitions-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',
-        'Valuations': 'https://valuations-api.dev.dimo.zone',
-        'VehicleSignalDecoding': 'https://vehicle-signal-decoding.dev.dimo.zone'
-    }
+        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",
+        DeviceDefinitions: "https://device-definitions-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",
+        Valuations: "https://valuations-api.dev.dimo.zone",
+        VehicleSignalDecoding: "https://vehicle-signal-decoding.dev.dimo.zone",
+        VehicleEvents: "https://vehicle-events-api.dev.dimo.zone",
+    },
 };
 
 class DimoError extends Error {
@@ -22474,6 +22477,7 @@ class Telemetry extends Resource$1 {
     }
 }
 
+/** @format */
 // import { Stream } from './streamr';
 class DIMO {
     attestation;
@@ -22485,6 +22489,7 @@ class DIMO {
     tokenexchange;
     trips;
     valuations;
+    vehicleEvents;
     constructor(env) {
         this.identity = new Identity(DimoEnvironment[env].Identity, env);
         this.telemetry = new Telemetry(DimoEnvironment[env].Telemetry, env);
@@ -22498,26 +22503,29 @@ 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.vehicleEvents = new VehicleEvents(DimoEnvironment[env].VehicleEvents, env);
     }
     // Helper Function
     async authenticate() {
         let fs;
         try {
             // Dynamically import fs
-            if (typeof process !== 'undefined' && process.versions && process.versions.node) {
+            if (typeof process !== "undefined" &&
+                process.versions &&
+                process.versions.node) {
                 fs = await import('fs');
             }
             else {
                 // Optionally handle the case where 'fs' is not available, returns null
-                console.log('Not in Node.js environment; `fs` module is not available.');
+                console.log("Not in Node.js environment; `fs` module is not available.");
                 return null;
             }
-            if (!fs.existsSync('.credentials.json')) {
+            if (!fs.existsSync(".credentials.json")) {
                 throw new DimoError({
-                    message: 'Credentials file does not exist'
+                    message: "Credentials file does not exist",
                 });
             }
-            const data = fs.readFileSync('.credentials.json', 'utf8');
+            const data = fs.readFileSync(".credentials.json", "utf8");
             const credentials = JSON.parse(data);
             const authHeader = await this.auth.getDeveloperJwt({
                 client_id: credentials.client_id,
@@ -22528,10 +22536,10 @@ class DIMO {
         }
         catch (error) {
             // Handle file not existing and other errors
-            console.error('Failed to authenticate:', error.message);
+            console.error("Failed to authenticate:", error.message);
             // Decide whether to throw the error or handle it differently
             throw new DimoError({
-                message: 'Authentication failed'
+                message: "Authentication failed",
             });
         }
     }
@@ -144220,6 +144228,7 @@ const Method = async (resource, baseUrl, params = {}, env) => {
     }
 };
 
+/** @format */
 class Resource {
     api;
     resourceName;
@@ -144230,12 +144239,8 @@ class Resource {
         this.env = env;
     }
     setResource(resources) {
-        Object.keys(resources).forEach(key => {
-            this[key] = (params = {}) => Method(resources[key], // Setup the endpoint resources
-            this.api, // Setup the base URL
-            params, // Pass through the params
-            this.env // Identiy the environment
-            );
+        Object.keys(resources).forEach((key) => {
+            this[key] = (params = {}) => Method(resources[key], this.api, params, this.env);
         });
     }
 }
@@ -144401,6 +144406,90 @@ class Valuations extends Resource {
     }
 }
 
+/** @format */
+class VehicleEvents extends Resource {
+    constructor(api, env) {
+        super(api, "VehicleEvents", env);
+        this.setResource({
+            listWebhooks: {
+                method: "GET",
+                path: "/v1/webhooks",
+                auth: "developer_jwt",
+            },
+            createWebhook: {
+                method: "POST",
+                path: "/v1/webhooks",
+                body: {
+                    service: true,
+                    data: true,
+                    trigger: true,
+                    setup: true,
+                    description: false,
+                    target_uri: true,
+                    status: true,
+                    verification_token: true,
+                },
+                auth: "developer_jwt",
+            },
+            updateWebhook: {
+                method: "PUT",
+                path: "/v1/webhooks/:webhookId",
+                body: {
+                    service: true,
+                    data: true,
+                    trigger: true,
+                    setup: true,
+                    description: false,
+                    target_uri: true,
+                    status: true,
+                    verification_token: true,
+                },
+                auth: "developer_jwt",
+            },
+            deleteWebhook: {
+                method: "DELETE",
+                path: "/v1/webhooks/:webhookId",
+                auth: "developer_jwt",
+            },
+            getWebhookSignalNames: {
+                method: "GET",
+                path: "/v1/webhooks/signals",
+                auth: "developer_jwt",
+            },
+            listSubscribedVehicles: {
+                method: "GET",
+                path: "/v1/webhooks/:webhookId",
+                auth: "developer_jwt",
+            },
+            listVehicleSubscriptions: {
+                method: "GET",
+                path: "/v1/webhooks/vehicles/:tokenId",
+                auth: "developer_jwt",
+            },
+            subscribeVehicle: {
+                method: "POST",
+                path: "/v1/webhooks/:webhookId/subscribe/:tokenId",
+                auth: "developer_jwt",
+            },
+            subscribeAllVehicles: {
+                method: "POST",
+                path: "/v1/webhooks/:webhookId/subscribe/all",
+                auth: "developer_jwt",
+            },
+            unsubscribeVehicle: {
+                method: "DELETE",
+                path: "/v1/webhooks/:webhookId/unsubscribe/:tokenId",
+                auth: "developer_jwt",
+            },
+            unsubscribeAllVehicles: {
+                method: "DELETE",
+                path: "/v1/webhooks/:webhookId/unsubscribe/all",
+                auth: "developer_jwt",
+            },
+        });
+    }
+}
+
 exports.Attestation = Attestation;
 exports.Auth = Auth;
 exports.DIMO = DIMO;
@@ -144414,3 +144503,4 @@ exports.Telemetry = Telemetry;
 exports.TokenExchange = TokenExchange;
 exports.Trips = Trips;
 exports.Valuations = Valuations;
+exports.VehicleEvents = VehicleEvents;

package/jest.config.js

@@ -1,16 +1,19 @@
+/** @format */
+
 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
-  }
+	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: {
+		"^api/(.*)$": "<rootDir>/src/api/$1",
+		"^@/(.*)$": "<rootDir>/src/$1",
+	},
 };

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@dimo-network/data-sdk",
-  "version": "1.2.4",
+  "version": "1.3.0",
   "description": "DIMO Data SDK for JavaScript",
   "main": "dist/index.js",
   "author": "James Li",
-  "contributors": [],
+  "contributors": ["Yusuf Çırak"],
   "license": "Apache-2.0",
   "type": "module",
   "exports": {

package/dist/streamr/index.js

@@ -1,51 +0,0 @@
-"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');
-//         })
-//     );
-// }