@cloudbase/database 1.4.3 → 1.5.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 (196) hide show
  1. package/dist/commonjs/ObjectId/index.d.ts +1 -1
  2. package/dist/commonjs/ObjectId/index.js +16 -9
  3. package/dist/commonjs/aggregate.js +126 -75
  4. package/dist/commonjs/collection.d.ts +3 -2
  5. package/dist/commonjs/collection.js +131 -58
  6. package/dist/commonjs/command.d.ts +5 -5
  7. package/dist/commonjs/command.js +181 -154
  8. package/dist/commonjs/commands/logic.js +30 -20
  9. package/dist/commonjs/commands/query.d.ts +1 -1
  10. package/dist/commonjs/commands/query.js +85 -65
  11. package/dist/commonjs/commands/update.js +9 -7
  12. package/dist/commonjs/config/error.config.js +1 -0
  13. package/dist/commonjs/const/code.js +1 -0
  14. package/dist/commonjs/constant.d.ts +7 -7
  15. package/dist/commonjs/constant.js +13 -11
  16. package/dist/commonjs/document.d.ts +10 -6
  17. package/dist/commonjs/document.js +305 -193
  18. package/dist/commonjs/geo/index.js +20 -9
  19. package/dist/commonjs/geo/lineString.d.ts +1 -1
  20. package/dist/commonjs/geo/lineString.js +62 -33
  21. package/dist/commonjs/geo/multiLineString.d.ts +1 -1
  22. package/dist/commonjs/geo/multiLineString.js +71 -32
  23. package/dist/commonjs/geo/multiPoint.d.ts +1 -1
  24. package/dist/commonjs/geo/multiPoint.js +58 -29
  25. package/dist/commonjs/geo/multiPolygon.d.ts +1 -1
  26. package/dist/commonjs/geo/multiPolygon.js +96 -36
  27. package/dist/commonjs/geo/point.d.ts +1 -1
  28. package/dist/commonjs/geo/point.js +30 -23
  29. package/dist/commonjs/geo/polygon.d.ts +1 -1
  30. package/dist/commonjs/geo/polygon.js +78 -39
  31. package/dist/commonjs/helper/symbol.js +17 -5
  32. package/dist/commonjs/index.d.ts +8 -2
  33. package/dist/commonjs/index.js +73 -20
  34. package/dist/commonjs/lib/util.d.ts +1 -0
  35. package/dist/commonjs/lib/util.js +26 -0
  36. package/dist/commonjs/operator-map.js +7 -6
  37. package/dist/commonjs/query.d.ts +8 -4
  38. package/dist/commonjs/query.js +308 -201
  39. package/dist/commonjs/regexp/index.d.ts +1 -1
  40. package/dist/commonjs/regexp/index.js +16 -9
  41. package/dist/commonjs/serializer/common.d.ts +2 -2
  42. package/dist/commonjs/serializer/common.js +59 -22
  43. package/dist/commonjs/serializer/datatype.d.ts +2 -2
  44. package/dist/commonjs/serializer/datatype.js +58 -21
  45. package/dist/commonjs/serializer/query.d.ts +1 -1
  46. package/dist/commonjs/serializer/query.js +137 -127
  47. package/dist/commonjs/serializer/update.d.ts +1 -1
  48. package/dist/commonjs/serializer/update.js +83 -78
  49. package/dist/commonjs/serverDate/index.d.ts +1 -1
  50. package/dist/commonjs/serverDate/index.js +16 -9
  51. package/dist/commonjs/transaction/collection.d.ts +7 -0
  52. package/dist/commonjs/transaction/collection.js +49 -0
  53. package/dist/commonjs/transaction/document.d.ts +27 -0
  54. package/dist/commonjs/transaction/document.js +205 -0
  55. package/dist/commonjs/transaction/index.js +196 -86
  56. package/dist/commonjs/transaction/query.d.ts +43 -0
  57. package/dist/commonjs/transaction/query.js +261 -0
  58. package/dist/commonjs/typings/index.d.ts +4 -4
  59. package/dist/commonjs/typings/realtime.d.ts +16 -16
  60. package/dist/commonjs/util.js +123 -92
  61. package/dist/commonjs/utils/error.d.ts +2 -1
  62. package/dist/commonjs/utils/error.js +74 -38
  63. package/dist/commonjs/utils/symbol.js +33 -14
  64. package/dist/commonjs/utils/type.d.ts +1 -1
  65. package/dist/commonjs/utils/type.js +25 -13
  66. package/dist/commonjs/utils/utils.d.ts +4 -1
  67. package/dist/commonjs/utils/utils.js +93 -22
  68. package/dist/commonjs/validate.js +79 -63
  69. package/dist/esm/ObjectId/index.d.ts +1 -1
  70. package/dist/esm/ObjectId/index.js +15 -8
  71. package/dist/esm/aggregate.js +118 -66
  72. package/dist/esm/collection.d.ts +3 -2
  73. package/dist/esm/collection.js +125 -52
  74. package/dist/esm/command.d.ts +5 -5
  75. package/dist/esm/command.js +175 -147
  76. package/dist/esm/commands/logic.js +30 -20
  77. package/dist/esm/commands/query.d.ts +1 -1
  78. package/dist/esm/commands/query.js +91 -71
  79. package/dist/esm/commands/update.js +8 -6
  80. package/dist/esm/config/error.config.js +1 -1
  81. package/dist/esm/const/code.js +1 -1
  82. package/dist/esm/constant.d.ts +7 -7
  83. package/dist/esm/constant.js +12 -11
  84. package/dist/esm/document.d.ts +10 -6
  85. package/dist/esm/document.js +297 -185
  86. package/dist/esm/geo/interface.js +1 -0
  87. package/dist/esm/geo/lineString.d.ts +1 -1
  88. package/dist/esm/geo/lineString.js +57 -28
  89. package/dist/esm/geo/multiLineString.d.ts +1 -1
  90. package/dist/esm/geo/multiLineString.js +66 -27
  91. package/dist/esm/geo/multiPoint.d.ts +1 -1
  92. package/dist/esm/geo/multiPoint.js +53 -24
  93. package/dist/esm/geo/multiPolygon.d.ts +1 -1
  94. package/dist/esm/geo/multiPolygon.js +91 -31
  95. package/dist/esm/geo/point.d.ts +1 -1
  96. package/dist/esm/geo/point.js +26 -19
  97. package/dist/esm/geo/polygon.d.ts +1 -1
  98. package/dist/esm/geo/polygon.js +73 -34
  99. package/dist/esm/helper/symbol.js +13 -13
  100. package/dist/esm/index.d.ts +8 -2
  101. package/dist/esm/index.js +62 -9
  102. package/dist/esm/lib/util.d.ts +1 -0
  103. package/dist/esm/lib/util.js +22 -0
  104. package/dist/esm/operator-map.js +4 -4
  105. package/dist/esm/query.d.ts +8 -4
  106. package/dist/esm/query.js +299 -192
  107. package/dist/esm/regexp/index.d.ts +1 -1
  108. package/dist/esm/regexp/index.js +15 -8
  109. package/dist/esm/serializer/common.d.ts +2 -2
  110. package/dist/esm/serializer/common.js +49 -13
  111. package/dist/esm/serializer/datatype.d.ts +2 -2
  112. package/dist/esm/serializer/datatype.js +44 -8
  113. package/dist/esm/serializer/query.d.ts +1 -1
  114. package/dist/esm/serializer/query.js +112 -102
  115. package/dist/esm/serializer/update.d.ts +1 -1
  116. package/dist/esm/serializer/update.js +69 -64
  117. package/dist/esm/serverDate/index.d.ts +1 -1
  118. package/dist/esm/serverDate/index.js +15 -8
  119. package/dist/esm/transaction/collection.d.ts +7 -0
  120. package/dist/esm/transaction/collection.js +46 -0
  121. package/dist/esm/transaction/document.d.ts +27 -0
  122. package/dist/esm/transaction/document.js +202 -0
  123. package/dist/esm/transaction/index.js +191 -81
  124. package/dist/esm/transaction/query.d.ts +43 -0
  125. package/dist/esm/transaction/query.js +258 -0
  126. package/dist/esm/typings/index.d.ts +4 -4
  127. package/dist/esm/typings/index.js +1 -0
  128. package/dist/esm/typings/realtime.d.ts +16 -16
  129. package/dist/esm/typings/realtime.js +1 -0
  130. package/dist/esm/util.js +121 -90
  131. package/dist/esm/utils/error.d.ts +2 -1
  132. package/dist/esm/utils/error.js +70 -35
  133. package/dist/esm/utils/symbol.js +33 -14
  134. package/dist/esm/utils/type.d.ts +1 -1
  135. package/dist/esm/utils/type.js +12 -12
  136. package/dist/esm/utils/utils.d.ts +4 -1
  137. package/dist/esm/utils/utils.js +78 -16
  138. package/dist/esm/validate.js +65 -49
  139. package/jest.config.js +14 -0
  140. package/package.json +14 -10
  141. package/src/aggregate.ts +1 -5
  142. package/src/collection.ts +15 -2
  143. package/src/document.ts +45 -34
  144. package/src/index.ts +51 -4
  145. package/src/query.ts +33 -29
  146. package/src/serializer/query.ts +18 -6
  147. package/src/transaction/index.ts +1 -1
  148. package/src/typings/index.ts +0 -4
  149. package/src/utils/utils.ts +46 -0
  150. package/src/validate.ts +3 -6
  151. package/tests/gateway-contract.test.ts +180 -0
  152. package/tests/index.test.ts +283 -0
  153. package/tests/transaction-query.test.ts +207 -0
  154. package/tsconfig.esm.json +4 -2
  155. package/tsconfig.json +16 -6
  156. package/tsconfig.test.json +15 -0
  157. package/dist/commonjs/realtime/error.d.ts +0 -7
  158. package/dist/commonjs/realtime/error.js +0 -11
  159. package/dist/commonjs/realtime/listener.d.ts +0 -14
  160. package/dist/commonjs/realtime/listener.js +0 -17
  161. package/dist/commonjs/realtime/message.d.ts +0 -3
  162. package/dist/commonjs/realtime/message.js +0 -10
  163. package/dist/commonjs/realtime/snapshot.d.ts +0 -16
  164. package/dist/commonjs/realtime/snapshot.js +0 -42
  165. package/dist/commonjs/realtime/virtual-websocket-client.d.ts +0 -63
  166. package/dist/commonjs/realtime/virtual-websocket-client.js +0 -736
  167. package/dist/commonjs/realtime/websocket-client.d.ts +0 -78
  168. package/dist/commonjs/realtime/websocket-client.js +0 -567
  169. package/dist/commonjs/realtime/ws-event.d.ts +0 -126
  170. package/dist/commonjs/realtime/ws-event.js +0 -139
  171. package/dist/commonjs/transaction.d.ts +0 -42
  172. package/dist/commonjs/transaction.js +0 -126
  173. package/dist/esm/realtime/error.d.ts +0 -7
  174. package/dist/esm/realtime/error.js +0 -8
  175. package/dist/esm/realtime/listener.d.ts +0 -14
  176. package/dist/esm/realtime/listener.js +0 -14
  177. package/dist/esm/realtime/message.d.ts +0 -3
  178. package/dist/esm/realtime/message.js +0 -6
  179. package/dist/esm/realtime/snapshot.d.ts +0 -16
  180. package/dist/esm/realtime/snapshot.js +0 -39
  181. package/dist/esm/realtime/virtual-websocket-client.d.ts +0 -63
  182. package/dist/esm/realtime/virtual-websocket-client.js +0 -733
  183. package/dist/esm/realtime/websocket-client.d.ts +0 -78
  184. package/dist/esm/realtime/websocket-client.js +0 -564
  185. package/dist/esm/realtime/ws-event.d.ts +0 -126
  186. package/dist/esm/realtime/ws-event.js +0 -137
  187. package/dist/esm/transaction.d.ts +0 -42
  188. package/dist/esm/transaction.js +0 -121
  189. package/src/realtime/error.ts +0 -19
  190. package/src/realtime/listener.ts +0 -35
  191. package/src/realtime/message.ts +0 -14
  192. package/src/realtime/snapshot.ts +0 -60
  193. package/src/realtime/virtual-websocket-client.ts +0 -1195
  194. package/src/realtime/websocket-client.ts +0 -995
  195. package/src/realtime/ws-event.ts +0 -163
  196. package/src/transaction.ts +0 -190
@@ -1,163 +0,0 @@
1
- import { CloudSDKError } from '../utils/error'
2
- import { ERR_CODE } from '../config/error.config'
3
-
4
- export const CLOSE_EVENT_CODE_INFO = {
5
- 1000: {
6
- code: 1000,
7
- name: 'Normal Closure',
8
- description:
9
- 'Normal closure; the connection successfully completed whatever purpose for which it was created.'
10
- },
11
- 1001: {
12
- code: 1001,
13
- name: 'Going Away',
14
- description:
15
- 'The endpoint is going away, either because of a server failure or because the browser is navigating away from the page that opened the connection.'
16
- },
17
- 1002: {
18
- code: 1002,
19
- name: 'Protocol Error',
20
- description:
21
- 'The endpoint is terminating the connection due to a protocol error.'
22
- },
23
- 1003: {
24
- code: 1003,
25
- name: 'Unsupported Data',
26
- description:
27
- 'The connection is being terminated because the endpoint received data of a type it cannot accept (for example, a text-only endpoint received binary data).'
28
- },
29
- 1005: {
30
- code: 1005,
31
- name: 'No Status Received',
32
- description:
33
- 'Indicates that no status code was provided even though one was expected.'
34
- },
35
- 1006: {
36
- code: 1006,
37
- name: 'Abnormal Closure',
38
- description:
39
- 'Used to indicate that a connection was closed abnormally (that is, with no close frame being sent) when a status code is expected.'
40
- },
41
- 1007: {
42
- code: 1007,
43
- name: 'Invalid frame payload data',
44
- description:
45
- 'The endpoint is terminating the connection because a message was received that contained inconsistent data (e.g., non-UTF-8 data within a text message).'
46
- },
47
- 1008: {
48
- code: 1008,
49
- name: 'Policy Violation',
50
- description:
51
- 'The endpoint is terminating the connection because it received a message that violates its policy. This is a generic status code, used when codes 1003 and 1009 are not suitable.'
52
- },
53
- 1009: {
54
- code: 1009,
55
- name: 'Message too big',
56
- description:
57
- 'The endpoint is terminating the connection because a data frame was received that is too large.'
58
- },
59
- 1010: {
60
- code: 1010,
61
- name: 'Missing Extension',
62
- description:
63
- "The client is terminating the connection because it expected the server to negotiate one or more extension, but the server didn't."
64
- },
65
- 1011: {
66
- code: 1011,
67
- name: 'Internal Error',
68
- description:
69
- 'The server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request.'
70
- },
71
- 1012: {
72
- code: 1012,
73
- name: 'Service Restart',
74
- description:
75
- 'The server is terminating the connection because it is restarting.'
76
- },
77
- 1013: {
78
- code: 1013,
79
- name: 'Try Again Later',
80
- description:
81
- 'The server is terminating the connection due to a temporary condition, e.g. it is overloaded and is casting off some of its clients.'
82
- },
83
- 1014: {
84
- code: 1014,
85
- name: 'Bad Gateway',
86
- description:
87
- 'The server was acting as a gateway or proxy and received an invalid response from the upstream server. This is similar to 502 HTTP Status Code.'
88
- },
89
- 1015: {
90
- code: 1015,
91
- name: 'TLS Handshake',
92
- description:
93
- "Indicates that the connection was closed due to a failure to perform a TLS handshake (e.g., the server certificate can't be verified)."
94
- },
95
- // custom
96
- 3000: {
97
- code: 3000,
98
- name: 'Reconnect WebSocket',
99
- description:
100
- 'The client is terminating the connection because it wants to reconnect'
101
- },
102
- 3001: {
103
- code: 3001,
104
- name: 'No Realtime Listeners',
105
- description:
106
- 'The client is terminating the connection because no more realtime listeners exist'
107
- },
108
- 3002: {
109
- code: 3002,
110
- name: 'Heartbeat Ping Error',
111
- description:
112
- 'The client is terminating the connection due to its failure in sending heartbeat messages'
113
- },
114
- 3003: {
115
- code: 3003,
116
- name: 'Heartbeat Pong Timeout Error',
117
- description:
118
- 'The client is terminating the connection because no heartbeat response is received from the server'
119
- },
120
- 3050: {
121
- code: 3050,
122
- name: 'Server Close',
123
- description:
124
- 'The client is terminating the connection because no heartbeat response is received from the server'
125
- }
126
- }
127
-
128
- export enum CLOSE_EVENT_CODE {
129
- // spec
130
- NormalClosure = 1000,
131
- GoingAway = 1001,
132
- ProtocolError = 1002,
133
- UnsupportedData = 1003,
134
- NoStatusReceived = 1005,
135
- AbnormalClosure = 1006,
136
- InvalidFramePayloadData = 1007,
137
- PolicyViolation = 1008,
138
- MessageTooBig = 1009,
139
- MissingExtension = 1010,
140
- InternalError = 1011,
141
- ServiceRestart = 1012,
142
- TryAgainLater = 1013,
143
- BadGateway = 1014,
144
- TLSHandshake = 1015,
145
- // custom - client close itself
146
- ReconnectWebSocket = 3000,
147
- NoRealtimeListeners = 3001,
148
- HeartbeatPingError = 3002,
149
- HeartbeatPongTimeoutError = 3003,
150
- // custom - server close
151
- NoAuthentication = 3050
152
- }
153
-
154
- export const getWSCloseError = (code: CLOSE_EVENT_CODE, reason?: string) => {
155
- const info = CLOSE_EVENT_CODE_INFO[code]
156
- const errMsg = !info
157
- ? `code ${code}`
158
- : `${info.name}, code ${code}, reason ${reason || info.description}`
159
- return new CloudSDKError({
160
- errCode: ERR_CODE.SDK_DATABASE_REALTIME_LISTENER_WEBSOCKET_CONNECTION_CLOSED as string,
161
- errMsg
162
- })
163
- }
@@ -1,190 +0,0 @@
1
- import { EJSON } from 'bson'
2
- import { DocumentReference } from './document'
3
- import { Db } from './index'
4
-
5
- class DocumentSnapshot {
6
- private _data: any
7
- requestId: string
8
- constructor(data, requestId) {
9
- this._data = data
10
- this.requestId = requestId
11
- }
12
-
13
- data() {
14
- return this._data
15
- }
16
- }
17
-
18
- const START = 'database.startTransaction'
19
- const COMMIT = 'database.commitTransaction'
20
- const ABORT = 'database.abortTransaction'
21
- const GET_DOC = 'database.getInTransaction'
22
- const UPDATE_DOC = 'database.updateDocInTransaction'
23
- const DELETE_DOC = 'database.deleteDocInTransaction'
24
-
25
- interface TransactionAPI {
26
- send(interfaceName: string, param?: any)
27
- }
28
-
29
- export class Transaction {
30
- private _id: string
31
-
32
- private _db: Db
33
-
34
- private _request: TransactionAPI
35
-
36
- public constructor(db: Db) {
37
- this._db = db
38
- this._request = new Db.reqClass(this._db.config)
39
- }
40
-
41
- async init(): Promise<void> {
42
- const res = await this._request.send(START, {})
43
- if (res.code) {
44
- throw res
45
- }
46
- this._id = res.transactionId
47
- }
48
-
49
- async get(documentRef: DocumentReference): Promise<DocumentSnapshot> {
50
- const param = {
51
- collectionName: documentRef._coll,
52
- transactionId: this._id,
53
- _id: documentRef.id
54
- }
55
- const res = await this._request.send(GET_DOC, param)
56
- if (res.code) throw res
57
- return new DocumentSnapshot(EJSON.parse(res.data), res.requestId)
58
- }
59
-
60
- async set(documentRef: DocumentReference, data: Object): Promise<SetResult> {
61
- const param = {
62
- collectionName: documentRef._coll,
63
- transactionId: this._id,
64
- _id: documentRef.id,
65
- data: EJSON.stringify(data, { relaxed: false }),
66
- upsert: true
67
- }
68
-
69
- const res: SetResult | TcbError = await this._request.send(UPDATE_DOC, param)
70
- if ((res as TcbError).code) throw res
71
- return {
72
- ...res,
73
- updated: EJSON.parse((res as SetResult).updated),
74
- upserted: (res as SetResult).upserted
75
- ? JSON.parse((res as SetResult).upserted as string)
76
- : null
77
- }
78
- }
79
-
80
- async update(documentRef: DocumentReference, data: Object): Promise<UpdateResult> {
81
- const param = {
82
- collectionName: documentRef._coll,
83
- transactionId: this._id,
84
- _id: documentRef.id,
85
- data: EJSON.stringify(
86
- {
87
- $set: data
88
- },
89
- {
90
- relaxed: false
91
- }
92
- )
93
- }
94
-
95
- const res = await this._request.send(UPDATE_DOC, param)
96
- if (res.code) throw res
97
- return {
98
- ...res,
99
- updated: EJSON.parse(res.updated)
100
- }
101
- }
102
-
103
- async delete(documentRef: DocumentReference): Promise<DeleteResult> {
104
- const param = {
105
- collectionName: documentRef._coll,
106
- transactionId: this._id,
107
- _id: documentRef.id
108
- }
109
-
110
- const res: DeleteResult | TcbError = await this._request.send(DELETE_DOC, param)
111
- if ((res as TcbError).code) throw res
112
- return {
113
- ...res,
114
- deleted: EJSON.parse((res as DeleteResult).deleted)
115
- }
116
- }
117
-
118
- async commit(): Promise<CommitResult> {
119
- const param = {
120
- transactionId: this._id
121
- }
122
- const res: CommitResult | TcbError = await this._request.send(COMMIT, param)
123
- if ((res as TcbError).code) throw res
124
- return res as CommitResult
125
- }
126
-
127
- async rollback(): Promise<RollbackResult> {
128
- const param = {
129
- transactionId: this._id
130
- }
131
- const res: RollbackResult | TcbError = await this._request.send(ABORT, param)
132
- if ((res as TcbError).code) throw res
133
- return res as RollbackResult
134
- }
135
- }
136
-
137
- export async function startTransaction(): Promise<Transaction> {
138
- const transaction = new Transaction(this)
139
- await transaction.init()
140
- return transaction
141
- }
142
-
143
- export async function runTransaction(
144
- callback: (transaction: Transaction) => void | Promise<any>,
145
- times: number = 3
146
- ): Promise<void> {
147
- if (times <= 0) {
148
- throw new Error('Transaction failed')
149
- }
150
- try {
151
- const transaction = new Transaction(this)
152
- await transaction.init()
153
- await callback(transaction)
154
- await transaction.commit()
155
- } catch (error) {
156
- console.log(error)
157
- return runTransaction.bind(this)(callback, --times)
158
- }
159
- }
160
-
161
- type JsonString = string
162
-
163
- interface CommitResult {
164
- requestId: string
165
- }
166
-
167
- interface RollbackResult {
168
- requestId: string
169
- }
170
-
171
- interface TcbError {
172
- requestId: string
173
- code: string
174
- message: string
175
- stack?: string
176
- }
177
-
178
- interface UpdateResult {
179
- requestId: string
180
- updated: number
181
- }
182
-
183
- interface SetResult extends UpdateResult {
184
- upserted: JsonString
185
- }
186
-
187
- interface DeleteResult {
188
- requestId: string
189
- deleted: number | string
190
- }