kucoin-api 2.1.23 → 2.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (98) hide show
  1. package/README.md +111 -14
  2. package/dist/cjs/WebsocketAPIClient.d.ts +123 -0
  3. package/dist/cjs/WebsocketAPIClient.js +147 -0
  4. package/dist/cjs/WebsocketAPIClient.js.map +1 -0
  5. package/dist/cjs/WebsocketClient.d.ts +14 -9
  6. package/dist/cjs/WebsocketClient.js +277 -37
  7. package/dist/cjs/WebsocketClient.js.map +1 -1
  8. package/dist/cjs/index.d.ts +4 -3
  9. package/dist/cjs/index.js +4 -3
  10. package/dist/cjs/index.js.map +1 -1
  11. package/dist/cjs/lib/BaseRestClient.d.ts +16 -0
  12. package/dist/cjs/lib/BaseRestClient.js +46 -12
  13. package/dist/cjs/lib/BaseRestClient.js.map +1 -1
  14. package/dist/cjs/lib/BaseWSClient.d.ts +30 -17
  15. package/dist/cjs/lib/BaseWSClient.js +248 -55
  16. package/dist/cjs/lib/BaseWSClient.js.map +1 -1
  17. package/dist/cjs/lib/requestUtils.d.ts +11 -0
  18. package/dist/cjs/lib/requestUtils.js.map +1 -1
  19. package/dist/cjs/lib/websocket/WsStore.d.ts +15 -3
  20. package/dist/cjs/lib/websocket/WsStore.js +61 -12
  21. package/dist/cjs/lib/websocket/WsStore.js.map +1 -1
  22. package/dist/cjs/lib/websocket/WsStore.types.d.ts +6 -4
  23. package/dist/cjs/lib/websocket/WsStore.types.js +2 -2
  24. package/dist/cjs/lib/websocket/WsStore.types.js.map +1 -1
  25. package/dist/cjs/lib/websocket/logger.d.ts +1 -0
  26. package/dist/cjs/lib/websocket/websocket-util.d.ts +12 -6
  27. package/dist/cjs/lib/websocket/websocket-util.js +17 -8
  28. package/dist/cjs/lib/websocket/websocket-util.js.map +1 -1
  29. package/dist/cjs/types/request/futures.types.d.ts +1 -0
  30. package/dist/cjs/types/websockets/ws-api.d.ts +123 -0
  31. package/dist/cjs/types/websockets/ws-api.js +22 -0
  32. package/dist/cjs/types/websockets/ws-api.js.map +1 -0
  33. package/dist/cjs/types/websockets/ws-events.d.ts +11 -0
  34. package/dist/cjs/types/websockets/ws-events.js +11 -0
  35. package/dist/cjs/types/websockets/ws-events.js.map +1 -0
  36. package/dist/cjs/types/websockets/{client.d.ts → ws-general.d.ts} +5 -0
  37. package/dist/cjs/types/websockets/{events.js → ws-general.js} +1 -1
  38. package/dist/cjs/types/websockets/ws-general.js.map +1 -0
  39. package/dist/mjs/WebsocketAPIClient.d.ts +123 -0
  40. package/dist/mjs/WebsocketAPIClient.js +143 -0
  41. package/dist/mjs/WebsocketAPIClient.js.map +1 -0
  42. package/dist/mjs/WebsocketClient.d.ts +14 -9
  43. package/dist/mjs/WebsocketClient.js +278 -38
  44. package/dist/mjs/WebsocketClient.js.map +1 -1
  45. package/dist/mjs/index.d.ts +4 -3
  46. package/dist/mjs/index.js +4 -3
  47. package/dist/mjs/index.js.map +1 -1
  48. package/dist/mjs/lib/BaseRestClient.d.ts +16 -0
  49. package/dist/mjs/lib/BaseRestClient.js +47 -13
  50. package/dist/mjs/lib/BaseRestClient.js.map +1 -1
  51. package/dist/mjs/lib/BaseWSClient.d.ts +30 -17
  52. package/dist/mjs/lib/BaseWSClient.js +248 -55
  53. package/dist/mjs/lib/BaseWSClient.js.map +1 -1
  54. package/dist/mjs/lib/requestUtils.d.ts +11 -0
  55. package/dist/mjs/lib/requestUtils.js.map +1 -1
  56. package/dist/mjs/lib/websocket/WsStore.d.ts +15 -3
  57. package/dist/mjs/lib/websocket/WsStore.js +61 -12
  58. package/dist/mjs/lib/websocket/WsStore.js.map +1 -1
  59. package/dist/mjs/lib/websocket/WsStore.types.d.ts +6 -4
  60. package/dist/mjs/lib/websocket/WsStore.types.js +2 -2
  61. package/dist/mjs/lib/websocket/WsStore.types.js.map +1 -1
  62. package/dist/mjs/lib/websocket/logger.d.ts +1 -0
  63. package/dist/mjs/lib/websocket/websocket-util.d.ts +12 -6
  64. package/dist/mjs/lib/websocket/websocket-util.js +15 -7
  65. package/dist/mjs/lib/websocket/websocket-util.js.map +1 -1
  66. package/dist/mjs/types/request/futures.types.d.ts +1 -0
  67. package/dist/mjs/types/websockets/ws-api.d.ts +123 -0
  68. package/dist/mjs/types/websockets/ws-api.js +19 -0
  69. package/dist/mjs/types/websockets/ws-api.js.map +1 -0
  70. package/dist/mjs/types/websockets/ws-events.d.ts +11 -0
  71. package/dist/mjs/types/websockets/ws-events.js +8 -0
  72. package/dist/mjs/types/websockets/ws-events.js.map +1 -0
  73. package/dist/mjs/types/websockets/{client.d.ts → ws-general.d.ts} +5 -0
  74. package/dist/mjs/types/websockets/ws-general.js +2 -0
  75. package/dist/mjs/types/websockets/ws-general.js.map +1 -0
  76. package/llms.txt +5985 -4979
  77. package/package.json +6 -4
  78. package/dist/cjs/types/websockets/client.js +0 -3
  79. package/dist/cjs/types/websockets/client.js.map +0 -1
  80. package/dist/cjs/types/websockets/events.d.ts +0 -5
  81. package/dist/cjs/types/websockets/events.js.map +0 -1
  82. package/dist/cjs/types/websockets/requests.d.ts +0 -8
  83. package/dist/cjs/types/websockets/requests.js +0 -3
  84. package/dist/cjs/types/websockets/requests.js.map +0 -1
  85. package/dist/cjs/types/websockets/wsAPI.d.ts +0 -9
  86. package/dist/cjs/types/websockets/wsAPI.js +0 -3
  87. package/dist/cjs/types/websockets/wsAPI.js.map +0 -1
  88. package/dist/mjs/types/websockets/client.js +0 -2
  89. package/dist/mjs/types/websockets/client.js.map +0 -1
  90. package/dist/mjs/types/websockets/events.d.ts +0 -5
  91. package/dist/mjs/types/websockets/events.js +0 -2
  92. package/dist/mjs/types/websockets/events.js.map +0 -1
  93. package/dist/mjs/types/websockets/requests.d.ts +0 -8
  94. package/dist/mjs/types/websockets/requests.js +0 -2
  95. package/dist/mjs/types/websockets/requests.js.map +0 -1
  96. package/dist/mjs/types/websockets/wsAPI.d.ts +0 -9
  97. package/dist/mjs/types/websockets/wsAPI.js +0 -2
  98. package/dist/mjs/types/websockets/wsAPI.js.map +0 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "kucoin-api",
3
- "version": "2.1.23",
3
+ "version": "2.2.0",
4
4
  "description": "Complete & robust Node.js SDK for Kucoin's REST APIs and WebSockets, with TypeScript & strong end to end tests.",
5
5
  "scripts": {
6
6
  "clean": "rm -rf dist",
@@ -29,14 +29,14 @@
29
29
  ],
30
30
  "dependencies": {
31
31
  "axios": "^1.10.0",
32
- "isomorphic-ws": "^4.0.1",
32
+ "isomorphic-ws": "^5.0.0",
33
33
  "nanoid": "^3.3.11",
34
- "ws": "^7.4.0"
34
+ "ws": "^8.18.3"
35
35
  },
36
36
  "devDependencies": {
37
37
  "@types/jest": "^29.5.12",
38
38
  "@types/node": "^22.11.6",
39
- "@types/ws": "^8.5.10",
39
+ "@types/ws": "^8.18.1",
40
40
  "@typescript-eslint/eslint-plugin": "^8.18.0",
41
41
  "@typescript-eslint/parser": "^8.18.0",
42
42
  "eslint": "^8.29.0",
@@ -56,6 +56,8 @@
56
56
  "kucoin nodejs",
57
57
  "kucoin javascript",
58
58
  "kucoin typescript",
59
+ "kucoin websocket api",
60
+ "kucoin websocket api javascript",
59
61
  "algo trading",
60
62
  "api",
61
63
  "websocket",
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=client.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../src/types/websockets/client.ts"],"names":[],"mappings":""}
@@ -1,5 +0,0 @@
1
- export interface WsDataEvent<TData = any, TWSKey = string> {
2
- data: TData;
3
- table: string;
4
- wsKey: TWSKey;
5
- }
@@ -1 +0,0 @@
1
- {"version":3,"file":"events.js","sourceRoot":"","sources":["../../../../src/types/websockets/events.ts"],"names":[],"mappings":""}
@@ -1,8 +0,0 @@
1
- export type WsOperation = 'subscribe' | 'unsubscribe' | 'login' | 'access' | 'request';
2
- export interface WsRequestOperation<TWSTopic extends string> {
3
- id: number;
4
- type: WsOperation;
5
- topic: TWSTopic;
6
- privateChannel: boolean;
7
- response: boolean;
8
- }
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=requests.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"requests.js","sourceRoot":"","sources":["../../../../src/types/websockets/requests.ts"],"names":[],"mappings":""}
@@ -1,9 +0,0 @@
1
- export interface WsAPIWsKeyTopicMap {
2
- [k: string]: never;
3
- }
4
- export interface WsAPITopicRequestParamMap {
5
- [k: string]: never;
6
- }
7
- export interface WsAPITopicResponseMap {
8
- [k: string]: never;
9
- }
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=wsAPI.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"wsAPI.js","sourceRoot":"","sources":["../../../../src/types/websockets/wsAPI.ts"],"names":[],"mappings":""}
@@ -1,2 +0,0 @@
1
- export {};
2
- //# sourceMappingURL=client.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../src/types/websockets/client.ts"],"names":[],"mappings":""}
@@ -1,5 +0,0 @@
1
- export interface WsDataEvent<TData = any, TWSKey = string> {
2
- data: TData;
3
- table: string;
4
- wsKey: TWSKey;
5
- }
@@ -1,2 +0,0 @@
1
- export {};
2
- //# sourceMappingURL=events.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"events.js","sourceRoot":"","sources":["../../../../src/types/websockets/events.ts"],"names":[],"mappings":""}
@@ -1,8 +0,0 @@
1
- export type WsOperation = 'subscribe' | 'unsubscribe' | 'login' | 'access' | 'request';
2
- export interface WsRequestOperation<TWSTopic extends string> {
3
- id: number;
4
- type: WsOperation;
5
- topic: TWSTopic;
6
- privateChannel: boolean;
7
- response: boolean;
8
- }
@@ -1,2 +0,0 @@
1
- export {};
2
- //# sourceMappingURL=requests.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"requests.js","sourceRoot":"","sources":["../../../../src/types/websockets/requests.ts"],"names":[],"mappings":""}
@@ -1,9 +0,0 @@
1
- export interface WsAPIWsKeyTopicMap {
2
- [k: string]: never;
3
- }
4
- export interface WsAPITopicRequestParamMap {
5
- [k: string]: never;
6
- }
7
- export interface WsAPITopicResponseMap {
8
- [k: string]: never;
9
- }
@@ -1,2 +0,0 @@
1
- export {};
2
- //# sourceMappingURL=wsAPI.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"wsAPI.js","sourceRoot":"","sources":["../../../../src/types/websockets/wsAPI.ts"],"names":[],"mappings":""}