feat: add multiple examples for REST and WebSocket API usage, including demo trading, private trading, and public API calls

examples/demo-trading.ts → examples/Rest/demo-trading.ts

@@ -1,4 +1,4 @@
-import { RestClient, WebsocketClient } from '../src/index';
+import { RestClient, WebsocketClient } from '../../src/index.js';
 
 // or
 // import { RestClient} from 'okx-api';
@@ -55,7 +55,7 @@ demoWsClient.on('reconnect', ({ wsKey }) => {
 demoWsClient.on('reconnected', (data) => {
   console.log('ws has reconnected ', data?.wsKey);
 });
-demoWsClient.on('error', (data) => {
+demoWsClient.on('exception', (data) => {
   console.error('ws exception: ', data);
 });
 

examples/my.okx.com.ts → examples/Rest/my.okx.com.ts

@@ -1,4 +1,4 @@
-import { RestClient, WebsocketClient } from '../src/index';
+import { RestClient, WebsocketClient } from '../../src/index.js';
 
 // or
 // import { RestClient } from 'okx-api';

examples/rest-private-trade.ts → examples/Rest/rest-private-trade.ts

@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
-import { RestClient } from '../src/index.js';
-import { OrderRequest } from '../src/types/rest/request/trade.js';
+import { RestClient } from '../../src/index.js';
+import { OrderRequest } from '../../src/types/rest/request/trade.js';
 
 // or
 // import { SpotClient } from 'okx-api';

examples/rest-public.ts → examples/Rest/rest-public.ts

@@ -1,4 +1,4 @@
-import { RestClient } from '../src/index';
+import { RestClient } from '../../src/index.js';
 
 // or
 // import { RestClient } from 'okx-api';

examples/ws-api-client.ts → examples/Websocket/WS-API/ws-api-client.ts

@@ -1,4 +1,4 @@
-import { DefaultLogger, WebsocketAPIClient } from '../src';
+import { DefaultLogger, WebsocketAPIClient } from '../../../src/index.js';
 
 // or use the module installed via `npm install okx-api`:
 // import { WebsocketClient, DefaultLogger } from 'okx-api';
@@ -55,9 +55,9 @@ import { DefaultLogger, WebsocketAPIClient } from '../src';
       accounts: [
         // For private topics, include one or more accounts in an array. Otherwise only public topics will work
         {
-          apiKey: API_KEY,
-          apiSecret: API_SECRET,
-          apiPass: API_PASSPHRASE,
+          apiKey: API_KEY || '',
+          apiSecret: API_SECRET || '',
+          apiPass: API_PASSPHRASE || '',
         },
       ],
     },

examples/ws-api-trade-raw.ts → examples/Websocket/WS-API/ws-api-trade-raw.ts

@@ -1,5 +1,9 @@
 // If you cloned the repo and are using typescript, you can import from src directly:
-import { DefaultLogger, WebsocketClient, WS_KEY_MAP } from '../src';
+import {
+  DefaultLogger,
+  WebsocketClient,
+  WS_KEY_MAP,
+} from '../../../src/index.js';
 
 // or use the module installed via `npm install okx-api`:
 // import { WebsocketClient, DefaultLogger } from 'okx-api';
@@ -26,9 +30,9 @@ import { DefaultLogger, WebsocketClient, WS_KEY_MAP } from '../src';
       accounts: [
         // For private topics, include one or more accounts in an array. Otherwise only public topics will work
         {
-          apiKey: API_KEY,
-          apiSecret: API_SECRET,
-          apiPass: API_PASSPHRASE,
+          apiKey: API_KEY || '',
+          apiSecret: API_SECRET || '',
+          apiPass: API_PASSPHRASE || '',
         },
       ],
     },

examples/ws-private-handle-auth-fail.ts → examples/Websocket/ws-private-handle-auth-fail.ts

@@ -1,5 +1,5 @@
 // If you cloned the repo and are using typescript, you can import from src directly:
-import { WebsocketClient } from '../src';
+import { WebsocketClient } from '../../src/index.js';
 
 /**
  *

examples/ws-private.ts → examples/Websocket/ws-private.ts

@@ -1,5 +1,5 @@
 // If you cloned the repo and are using typescript, you can import from src directly:
-import { DefaultLogger, WebsocketClient } from '../src';
+import { DefaultLogger, WebsocketClient } from '../../src/index.js';
 
 // or use the module installed via `npm install okx-api`:
 // import { WebsocketClient, DefaultLogger } from 'okx-api';

examples/ws-public.ts → examples/Websocket/ws-public.ts

@@ -1,4 +1,4 @@
-import { DefaultLogger, WebsocketClient } from '../src';
+import { DefaultLogger, WebsocketClient } from '../../src/index.js';
 
 // or use the module installed via `npm install okx-api`:
 // import { WebsocketClient, DefaultLogger } from 'okx-api';

examples/app.okx.com.ts

@@ -1,4 +1,4 @@
-import { RestClient, WebsocketClient } from '../src/index';
+import { RestClient, WebsocketClient } from '../src/index.js';
 
 // or
 // import { RestClient } from 'okx-api';

examples/auth/fasterHmacSign.ts

@@ -1,6 +1,10 @@
 import { createHmac } from 'crypto';
 
-import { DefaultLogger, RestClient, WebsocketClient } from '../../src/';
+import {
+  DefaultLogger,
+  RestClient,
+  WebsocketClient,
+} from '../../src/index.js';
 
 // or
 // import { createHmac } from 'crypto';
@@ -62,9 +66,9 @@ const wsClient = new WebsocketClient(
     accounts: [
       // For private topics, include one or more accounts in an array. Otherwise only public topics will work
       {
-        apiKey: API_KEY,
-        apiSecret: API_SECRET,
-        apiPass: API_PASS,
+        apiKey: API_KEY || '',
+        apiSecret: API_SECRET || '',
+        apiPass: API_PASS || '',
       },
     ],
     /**

examples/rest-private-trade-market.ts

@@ -1,4 +1,4 @@
-import { OrderRequest, RestClient } from '../src/index';
+import { OrderRequest, RestClient } from '../src/index.js';
 
 // or
 // import { RestClient, OrderRequest } from 'okx-api';