kucoin-api 2.1.22 → 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 (106) hide show
  1. package/README.md +111 -14
  2. package/dist/cjs/FuturesClient.d.ts +9 -0
  3. package/dist/cjs/FuturesClient.js +7 -0
  4. package/dist/cjs/FuturesClient.js.map +1 -1
  5. package/dist/cjs/WebsocketAPIClient.d.ts +123 -0
  6. package/dist/cjs/WebsocketAPIClient.js +147 -0
  7. package/dist/cjs/WebsocketAPIClient.js.map +1 -0
  8. package/dist/cjs/WebsocketClient.d.ts +14 -9
  9. package/dist/cjs/WebsocketClient.js +277 -37
  10. package/dist/cjs/WebsocketClient.js.map +1 -1
  11. package/dist/cjs/index.d.ts +4 -3
  12. package/dist/cjs/index.js +4 -3
  13. package/dist/cjs/index.js.map +1 -1
  14. package/dist/cjs/lib/BaseRestClient.d.ts +16 -0
  15. package/dist/cjs/lib/BaseRestClient.js +46 -12
  16. package/dist/cjs/lib/BaseRestClient.js.map +1 -1
  17. package/dist/cjs/lib/BaseWSClient.d.ts +30 -17
  18. package/dist/cjs/lib/BaseWSClient.js +248 -55
  19. package/dist/cjs/lib/BaseWSClient.js.map +1 -1
  20. package/dist/cjs/lib/requestUtils.d.ts +11 -0
  21. package/dist/cjs/lib/requestUtils.js.map +1 -1
  22. package/dist/cjs/lib/websocket/WsStore.d.ts +15 -3
  23. package/dist/cjs/lib/websocket/WsStore.js +61 -12
  24. package/dist/cjs/lib/websocket/WsStore.js.map +1 -1
  25. package/dist/cjs/lib/websocket/WsStore.types.d.ts +6 -4
  26. package/dist/cjs/lib/websocket/WsStore.types.js +2 -2
  27. package/dist/cjs/lib/websocket/WsStore.types.js.map +1 -1
  28. package/dist/cjs/lib/websocket/logger.d.ts +1 -0
  29. package/dist/cjs/lib/websocket/websocket-util.d.ts +12 -6
  30. package/dist/cjs/lib/websocket/websocket-util.js +17 -8
  31. package/dist/cjs/lib/websocket/websocket-util.js.map +1 -1
  32. package/dist/cjs/types/request/futures.types.d.ts +1 -0
  33. package/dist/cjs/types/response/futures.types.d.ts +1 -0
  34. package/dist/cjs/types/websockets/ws-api.d.ts +123 -0
  35. package/dist/cjs/types/websockets/ws-api.js +22 -0
  36. package/dist/cjs/types/websockets/ws-api.js.map +1 -0
  37. package/dist/cjs/types/websockets/ws-events.d.ts +11 -0
  38. package/dist/cjs/types/websockets/ws-events.js +11 -0
  39. package/dist/cjs/types/websockets/ws-events.js.map +1 -0
  40. package/dist/cjs/types/websockets/{client.d.ts → ws-general.d.ts} +5 -0
  41. package/dist/cjs/types/websockets/{events.js → ws-general.js} +1 -1
  42. package/dist/cjs/types/websockets/ws-general.js.map +1 -0
  43. package/dist/mjs/FuturesClient.d.ts +9 -0
  44. package/dist/mjs/FuturesClient.js +7 -0
  45. package/dist/mjs/FuturesClient.js.map +1 -1
  46. package/dist/mjs/WebsocketAPIClient.d.ts +123 -0
  47. package/dist/mjs/WebsocketAPIClient.js +143 -0
  48. package/dist/mjs/WebsocketAPIClient.js.map +1 -0
  49. package/dist/mjs/WebsocketClient.d.ts +14 -9
  50. package/dist/mjs/WebsocketClient.js +278 -38
  51. package/dist/mjs/WebsocketClient.js.map +1 -1
  52. package/dist/mjs/index.d.ts +4 -3
  53. package/dist/mjs/index.js +4 -3
  54. package/dist/mjs/index.js.map +1 -1
  55. package/dist/mjs/lib/BaseRestClient.d.ts +16 -0
  56. package/dist/mjs/lib/BaseRestClient.js +47 -13
  57. package/dist/mjs/lib/BaseRestClient.js.map +1 -1
  58. package/dist/mjs/lib/BaseWSClient.d.ts +30 -17
  59. package/dist/mjs/lib/BaseWSClient.js +248 -55
  60. package/dist/mjs/lib/BaseWSClient.js.map +1 -1
  61. package/dist/mjs/lib/requestUtils.d.ts +11 -0
  62. package/dist/mjs/lib/requestUtils.js.map +1 -1
  63. package/dist/mjs/lib/websocket/WsStore.d.ts +15 -3
  64. package/dist/mjs/lib/websocket/WsStore.js +61 -12
  65. package/dist/mjs/lib/websocket/WsStore.js.map +1 -1
  66. package/dist/mjs/lib/websocket/WsStore.types.d.ts +6 -4
  67. package/dist/mjs/lib/websocket/WsStore.types.js +2 -2
  68. package/dist/mjs/lib/websocket/WsStore.types.js.map +1 -1
  69. package/dist/mjs/lib/websocket/logger.d.ts +1 -0
  70. package/dist/mjs/lib/websocket/websocket-util.d.ts +12 -6
  71. package/dist/mjs/lib/websocket/websocket-util.js +15 -7
  72. package/dist/mjs/lib/websocket/websocket-util.js.map +1 -1
  73. package/dist/mjs/types/request/futures.types.d.ts +1 -0
  74. package/dist/mjs/types/response/futures.types.d.ts +1 -0
  75. package/dist/mjs/types/websockets/ws-api.d.ts +123 -0
  76. package/dist/mjs/types/websockets/ws-api.js +19 -0
  77. package/dist/mjs/types/websockets/ws-api.js.map +1 -0
  78. package/dist/mjs/types/websockets/ws-events.d.ts +11 -0
  79. package/dist/mjs/types/websockets/ws-events.js +8 -0
  80. package/dist/mjs/types/websockets/ws-events.js.map +1 -0
  81. package/dist/mjs/types/websockets/{client.d.ts → ws-general.d.ts} +5 -0
  82. package/dist/mjs/types/websockets/ws-general.js +2 -0
  83. package/dist/mjs/types/websockets/ws-general.js.map +1 -0
  84. package/llms.txt +6632 -5613
  85. package/package.json +6 -4
  86. package/dist/cjs/types/websockets/client.js +0 -3
  87. package/dist/cjs/types/websockets/client.js.map +0 -1
  88. package/dist/cjs/types/websockets/events.d.ts +0 -5
  89. package/dist/cjs/types/websockets/events.js.map +0 -1
  90. package/dist/cjs/types/websockets/requests.d.ts +0 -8
  91. package/dist/cjs/types/websockets/requests.js +0 -3
  92. package/dist/cjs/types/websockets/requests.js.map +0 -1
  93. package/dist/cjs/types/websockets/wsAPI.d.ts +0 -9
  94. package/dist/cjs/types/websockets/wsAPI.js +0 -3
  95. package/dist/cjs/types/websockets/wsAPI.js.map +0 -1
  96. package/dist/mjs/types/websockets/client.js +0 -2
  97. package/dist/mjs/types/websockets/client.js.map +0 -1
  98. package/dist/mjs/types/websockets/events.d.ts +0 -5
  99. package/dist/mjs/types/websockets/events.js +0 -2
  100. package/dist/mjs/types/websockets/events.js.map +0 -1
  101. package/dist/mjs/types/websockets/requests.d.ts +0 -8
  102. package/dist/mjs/types/websockets/requests.js +0 -2
  103. package/dist/mjs/types/websockets/requests.js.map +0 -1
  104. package/dist/mjs/types/websockets/wsAPI.d.ts +0 -9
  105. package/dist/mjs/types/websockets/wsAPI.js +0 -2
  106. 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.22",
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":""}