gremlin 3.8.1 → 4.0.0-beta.2

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 (411) hide show
  1. package/README.md +18 -4
  2. package/build/cjs/driver/auth.cjs +69 -0
  3. package/build/cjs/driver/auth.d.cts +9 -0
  4. package/build/cjs/driver/client.cjs +134 -0
  5. package/build/cjs/driver/client.d.cts +85 -0
  6. package/build/cjs/driver/connection.cjs +250 -0
  7. package/build/cjs/driver/connection.d.cts +63 -0
  8. package/build/cjs/driver/driver-remote-connection.cjs +141 -0
  9. package/build/cjs/driver/driver-remote-connection.d.cts +33 -0
  10. package/build/cjs/driver/remote-connection.cjs +75 -0
  11. package/build/cjs/driver/remote-connection.d.cts +72 -0
  12. package/build/cjs/driver/request-message.cjs +157 -0
  13. package/build/cjs/driver/request-message.d.cts +49 -0
  14. package/build/cjs/driver/response-error.cjs +45 -0
  15. package/build/cjs/driver/response-error.d.cts +13 -0
  16. package/build/cjs/driver/result-set.cjs +111 -0
  17. package/build/cjs/driver/result-set.d.cts +29 -0
  18. package/build/cjs/index.cjs +125 -0
  19. package/build/cjs/index.d.cts +393 -0
  20. package/build/cjs/language/grammar/GremlinLexer.cjs +1851 -0
  21. package/build/cjs/language/grammar/GremlinLexer.d.cts +340 -0
  22. package/build/cjs/language/grammar/GremlinListener.cjs +4490 -0
  23. package/build/cjs/language/grammar/GremlinListener.d.cts +4898 -0
  24. package/build/cjs/language/grammar/GremlinParser.cjs +35244 -0
  25. package/build/cjs/language/grammar/GremlinParser.d.cts +5881 -0
  26. package/build/cjs/language/index.cjs +48 -0
  27. package/build/cjs/language/index.d.cts +12 -0
  28. package/build/cjs/language/translator/AnonymizedTranslateVisitor.cjs +157 -0
  29. package/build/cjs/language/translator/AnonymizedTranslateVisitor.d.cts +36 -0
  30. package/build/cjs/language/translator/DotNetTranslateVisitor.cjs +826 -0
  31. package/build/cjs/language/translator/DotNetTranslateVisitor.d.cts +155 -0
  32. package/build/cjs/language/translator/GoTranslateVisitor.cjs +339 -0
  33. package/build/cjs/language/translator/GoTranslateVisitor.d.cts +31 -0
  34. package/build/cjs/language/translator/GremlinTranslator.cjs +96 -0
  35. package/build/cjs/language/translator/GremlinTranslator.d.cts +18 -0
  36. package/build/cjs/language/translator/GroovyTranslateVisitor.cjs +287 -0
  37. package/build/cjs/language/translator/GroovyTranslateVisitor.d.cts +34 -0
  38. package/build/cjs/language/translator/JavaTranslateVisitor.cjs +247 -0
  39. package/build/cjs/language/translator/JavaTranslateVisitor.d.cts +23 -0
  40. package/build/cjs/language/translator/JavascriptTranslateVisitor.cjs +220 -0
  41. package/build/cjs/language/translator/JavascriptTranslateVisitor.d.cts +25 -0
  42. package/build/cjs/language/translator/PythonTranslateVisitor.cjs +304 -0
  43. package/build/cjs/language/translator/PythonTranslateVisitor.d.cts +28 -0
  44. package/build/cjs/language/translator/TranslateVisitor.cjs +389 -0
  45. package/build/cjs/language/translator/TranslateVisitor.d.cts +91 -0
  46. package/build/cjs/language/translator/Translation.cjs +47 -0
  47. package/build/cjs/language/translator/Translation.d.cts +13 -0
  48. package/build/cjs/language/translator/Translator.cjs +46 -0
  49. package/build/cjs/language/translator/Translator.d.cts +24 -0
  50. package/build/cjs/language/translator/TranslatorException.cjs +31 -0
  51. package/build/cjs/language/translator/TranslatorException.d.cts +6 -0
  52. package/build/cjs/process/anonymous-traversal.cjs +78 -0
  53. package/build/cjs/process/anonymous-traversal.d.cts +40 -0
  54. package/build/cjs/process/graph-traversal.cjs +1702 -0
  55. package/build/cjs/process/graph-traversal.d.cts +1134 -0
  56. package/build/cjs/process/gremlin-lang.cjs +196 -0
  57. package/build/cjs/process/gremlin-lang.d.cts +15 -0
  58. package/build/cjs/process/transaction.cjs +69 -0
  59. package/build/cjs/process/transaction.d.cts +34 -0
  60. package/build/cjs/process/traversal-strategy.cjs +360 -0
  61. package/build/cjs/process/traversal-strategy.d.cts +211 -0
  62. package/build/cjs/process/traversal.cjs +482 -0
  63. package/build/cjs/process/traversal.d.cts +186 -0
  64. package/build/cjs/structure/graph.cjs +157 -0
  65. package/build/cjs/structure/graph.d.cts +57 -0
  66. package/build/cjs/structure/io/binary/GraphBinary.cjs +148 -0
  67. package/build/cjs/structure/io/binary/GraphBinary.d.cts +91 -0
  68. package/build/cjs/structure/io/binary/internals/AnySerializer.cjs +80 -0
  69. package/build/cjs/structure/io/binary/internals/AnySerializer.d.cts +8 -0
  70. package/build/cjs/structure/io/binary/internals/ArraySerializer.cjs +139 -0
  71. package/build/cjs/structure/io/binary/internals/ArraySerializer.d.cts +15 -0
  72. package/build/cjs/structure/io/binary/internals/BigIntegerSerializer.cjs +136 -0
  73. package/build/cjs/structure/io/binary/internals/BigIntegerSerializer.d.cts +14 -0
  74. package/build/cjs/structure/io/binary/internals/BinarySerializer.cjs +112 -0
  75. package/build/cjs/structure/io/binary/internals/BinarySerializer.d.cts +11 -0
  76. package/build/cjs/structure/io/binary/internals/BooleanSerializer.cjs +93 -0
  77. package/build/cjs/structure/io/binary/internals/BooleanSerializer.d.cts +11 -0
  78. package/build/cjs/structure/io/binary/internals/ByteSerializer.cjs +88 -0
  79. package/build/cjs/structure/io/binary/internals/ByteSerializer.d.cts +10 -0
  80. package/build/cjs/structure/io/binary/internals/DataType.cjs +63 -0
  81. package/build/cjs/structure/io/binary/internals/DataType.d.cts +35 -0
  82. package/build/cjs/structure/io/binary/internals/DateTimeSerializer.cjs +139 -0
  83. package/build/cjs/structure/io/binary/internals/DateTimeSerializer.d.cts +15 -0
  84. package/build/cjs/structure/io/binary/internals/DoubleSerializer.cjs +91 -0
  85. package/build/cjs/structure/io/binary/internals/DoubleSerializer.d.cts +11 -0
  86. package/build/cjs/structure/io/binary/internals/EdgeSerializer.cjs +201 -0
  87. package/build/cjs/structure/io/binary/internals/EdgeSerializer.d.cts +20 -0
  88. package/build/cjs/structure/io/binary/internals/EnumSerializer.cjs +127 -0
  89. package/build/cjs/structure/io/binary/internals/EnumSerializer.d.cts +24 -0
  90. package/build/cjs/structure/io/binary/internals/FloatSerializer.cjs +91 -0
  91. package/build/cjs/structure/io/binary/internals/FloatSerializer.d.cts +11 -0
  92. package/build/cjs/structure/io/binary/internals/GraphBinaryReader.cjs +97 -0
  93. package/build/cjs/structure/io/binary/internals/GraphBinaryReader.d.cts +19 -0
  94. package/build/cjs/structure/io/binary/internals/GraphBinaryWriter.cjs +85 -0
  95. package/build/cjs/structure/io/binary/internals/GraphBinaryWriter.d.cts +9 -0
  96. package/build/cjs/structure/io/binary/internals/IntSerializer.cjs +103 -0
  97. package/build/cjs/structure/io/binary/internals/IntSerializer.d.cts +13 -0
  98. package/build/cjs/structure/io/binary/internals/LongSerializer.cjs +95 -0
  99. package/build/cjs/structure/io/binary/internals/LongSerializer.d.cts +11 -0
  100. package/build/cjs/structure/io/binary/internals/MapSerializer.cjs +144 -0
  101. package/build/cjs/structure/io/binary/internals/MapSerializer.d.cts +13 -0
  102. package/build/cjs/structure/io/binary/internals/MarkerSerializer.cjs +63 -0
  103. package/build/cjs/structure/io/binary/internals/MarkerSerializer.d.cts +8 -0
  104. package/build/cjs/structure/io/binary/internals/NumberSerializationStrategy.cjs +66 -0
  105. package/build/cjs/structure/io/binary/internals/NumberSerializationStrategy.d.cts +9 -0
  106. package/build/cjs/structure/io/binary/internals/PathSerializer.cjs +113 -0
  107. package/build/cjs/structure/io/binary/internals/PathSerializer.d.cts +15 -0
  108. package/build/cjs/structure/io/binary/internals/PropertySerializer.cjs +130 -0
  109. package/build/cjs/structure/io/binary/internals/PropertySerializer.d.cts +15 -0
  110. package/build/cjs/structure/io/binary/internals/SetSerializer.cjs +138 -0
  111. package/build/cjs/structure/io/binary/internals/SetSerializer.d.cts +15 -0
  112. package/build/cjs/structure/io/binary/internals/ShortSerializer.cjs +91 -0
  113. package/build/cjs/structure/io/binary/internals/ShortSerializer.d.cts +11 -0
  114. package/build/cjs/structure/io/binary/internals/StringSerializer.cjs +107 -0
  115. package/build/cjs/structure/io/binary/internals/StringSerializer.d.cts +11 -0
  116. package/{lib/driver/auth/authenticator.js → build/cjs/structure/io/binary/internals/StubSerializer.cjs} +14 -20
  117. package/build/cjs/structure/io/binary/internals/StubSerializer.d.cts +7 -0
  118. package/build/cjs/structure/io/binary/internals/UnspecifiedNullSerializer.cjs +70 -0
  119. package/build/cjs/structure/io/binary/internals/UnspecifiedNullSerializer.d.cts +11 -0
  120. package/build/cjs/structure/io/binary/internals/UuidSerializer.cjs +109 -0
  121. package/build/cjs/structure/io/binary/internals/UuidSerializer.d.cts +14 -0
  122. package/build/cjs/structure/io/binary/internals/VertexPropertySerializer.cjs +163 -0
  123. package/build/cjs/structure/io/binary/internals/VertexPropertySerializer.d.cts +15 -0
  124. package/build/cjs/structure/io/binary/internals/VertexSerializer.cjs +128 -0
  125. package/build/cjs/structure/io/binary/internals/VertexSerializer.d.cts +17 -0
  126. package/build/cjs/structure/io/binary/internals/utils.cjs +53 -0
  127. package/build/cjs/structure/io/binary/internals/utils.d.cts +6 -0
  128. package/build/cjs/utils.cjs +142 -0
  129. package/build/cjs/utils.d.cts +20 -0
  130. package/build/esm/driver/auth.d.ts +9 -0
  131. package/build/esm/driver/auth.js +65 -0
  132. package/build/esm/driver/client.d.ts +85 -0
  133. package/build/esm/driver/client.js +128 -0
  134. package/build/esm/driver/connection.d.ts +63 -0
  135. package/build/esm/driver/connection.js +211 -0
  136. package/build/esm/driver/driver-remote-connection.d.ts +33 -0
  137. package/build/esm/driver/driver-remote-connection.js +102 -0
  138. package/build/esm/driver/remote-connection.d.ts +72 -0
  139. package/build/esm/driver/remote-connection.js +69 -0
  140. package/build/esm/driver/request-message.d.ts +49 -0
  141. package/build/esm/driver/request-message.js +152 -0
  142. package/build/esm/driver/response-error.d.ts +13 -0
  143. package/{lib → build/esm}/driver/response-error.js +21 -26
  144. package/build/esm/driver/result-set.d.ts +29 -0
  145. package/build/esm/driver/result-set.js +75 -0
  146. package/build/esm/index.d.ts +393 -0
  147. package/{index.js → build/esm/index.js} +23 -33
  148. package/build/esm/language/grammar/GremlinLexer.d.ts +340 -0
  149. package/build/esm/language/grammar/GremlinLexer.js +1814 -0
  150. package/build/esm/language/grammar/GremlinListener.d.ts +4898 -0
  151. package/build/esm/language/grammar/GremlinListener.js +4486 -0
  152. package/build/esm/language/grammar/GremlinParser.d.ts +5881 -0
  153. package/build/esm/language/grammar/GremlinParser.js +34711 -0
  154. package/build/esm/language/index.d.ts +12 -0
  155. package/build/esm/language/index.js +30 -0
  156. package/build/esm/language/translator/AnonymizedTranslateVisitor.d.ts +36 -0
  157. package/build/esm/language/translator/AnonymizedTranslateVisitor.js +151 -0
  158. package/build/esm/language/translator/DotNetTranslateVisitor.d.ts +155 -0
  159. package/build/esm/language/translator/DotNetTranslateVisitor.js +820 -0
  160. package/build/esm/language/translator/GoTranslateVisitor.d.ts +31 -0
  161. package/build/esm/language/translator/GoTranslateVisitor.js +333 -0
  162. package/build/esm/language/translator/GremlinTranslator.d.ts +18 -0
  163. package/build/esm/language/translator/GremlinTranslator.js +89 -0
  164. package/build/esm/language/translator/GroovyTranslateVisitor.d.ts +34 -0
  165. package/build/esm/language/translator/GroovyTranslateVisitor.js +281 -0
  166. package/build/esm/language/translator/JavaTranslateVisitor.d.ts +23 -0
  167. package/build/esm/language/translator/JavaTranslateVisitor.js +241 -0
  168. package/build/esm/language/translator/JavascriptTranslateVisitor.d.ts +25 -0
  169. package/build/esm/language/translator/JavascriptTranslateVisitor.js +214 -0
  170. package/build/esm/language/translator/PythonTranslateVisitor.d.ts +28 -0
  171. package/build/esm/language/translator/PythonTranslateVisitor.js +298 -0
  172. package/build/esm/language/translator/TranslateVisitor.d.ts +91 -0
  173. package/build/esm/language/translator/TranslateVisitor.js +386 -0
  174. package/build/esm/language/translator/Translation.d.ts +13 -0
  175. package/build/esm/language/translator/Translation.js +43 -0
  176. package/build/esm/language/translator/Translator.d.ts +24 -0
  177. package/build/esm/language/translator/Translator.js +40 -0
  178. package/build/esm/language/translator/TranslatorException.d.ts +6 -0
  179. package/build/esm/language/translator/TranslatorException.js +27 -0
  180. package/build/esm/process/anonymous-traversal.d.ts +40 -0
  181. package/build/esm/process/anonymous-traversal.js +72 -0
  182. package/build/esm/process/graph-traversal.d.ts +1134 -0
  183. package/build/esm/process/graph-traversal.js +1693 -0
  184. package/build/esm/process/gremlin-lang.d.ts +15 -0
  185. package/build/esm/process/gremlin-lang.js +193 -0
  186. package/build/esm/process/transaction.d.ts +34 -0
  187. package/build/esm/process/transaction.js +65 -0
  188. package/build/esm/process/traversal-strategy.d.ts +211 -0
  189. package/build/esm/process/traversal-strategy.js +319 -0
  190. package/build/esm/process/traversal.d.ts +186 -0
  191. package/build/esm/process/traversal.js +469 -0
  192. package/build/esm/structure/graph.d.ts +57 -0
  193. package/build/esm/structure/graph.js +148 -0
  194. package/build/esm/structure/io/binary/GraphBinary.d.ts +91 -0
  195. package/build/esm/structure/io/binary/GraphBinary.js +108 -0
  196. package/build/esm/structure/io/binary/internals/AnySerializer.d.ts +8 -0
  197. package/build/esm/structure/io/binary/internals/AnySerializer.js +77 -0
  198. package/build/esm/structure/io/binary/internals/ArraySerializer.d.ts +15 -0
  199. package/build/esm/structure/io/binary/internals/ArraySerializer.js +136 -0
  200. package/build/esm/structure/io/binary/internals/BigIntegerSerializer.d.ts +14 -0
  201. package/build/esm/structure/io/binary/internals/BigIntegerSerializer.js +133 -0
  202. package/build/esm/structure/io/binary/internals/BinarySerializer.d.ts +11 -0
  203. package/build/esm/structure/io/binary/internals/BinarySerializer.js +109 -0
  204. package/build/esm/structure/io/binary/internals/BooleanSerializer.d.ts +11 -0
  205. package/build/esm/structure/io/binary/internals/BooleanSerializer.js +90 -0
  206. package/build/esm/structure/io/binary/internals/ByteSerializer.d.ts +10 -0
  207. package/build/esm/structure/io/binary/internals/ByteSerializer.js +85 -0
  208. package/build/esm/structure/io/binary/internals/DataType.d.ts +35 -0
  209. package/{lib/driver/auth/mechanisms/sasl-mechanism-base.js → build/esm/structure/io/binary/internals/DataType.js} +43 -34
  210. package/build/esm/structure/io/binary/internals/DateTimeSerializer.d.ts +15 -0
  211. package/build/esm/structure/io/binary/internals/DateTimeSerializer.js +136 -0
  212. package/build/esm/structure/io/binary/internals/DoubleSerializer.d.ts +11 -0
  213. package/build/esm/structure/io/binary/internals/DoubleSerializer.js +88 -0
  214. package/build/esm/structure/io/binary/internals/EdgeSerializer.d.ts +20 -0
  215. package/build/esm/structure/io/binary/internals/EdgeSerializer.js +198 -0
  216. package/build/esm/structure/io/binary/internals/EnumSerializer.d.ts +24 -0
  217. package/build/esm/structure/io/binary/internals/EnumSerializer.js +124 -0
  218. package/build/esm/structure/io/binary/internals/FloatSerializer.d.ts +11 -0
  219. package/build/esm/structure/io/binary/internals/FloatSerializer.js +88 -0
  220. package/build/esm/structure/io/binary/internals/GraphBinaryReader.d.ts +19 -0
  221. package/build/esm/structure/io/binary/internals/GraphBinaryReader.js +94 -0
  222. package/build/esm/structure/io/binary/internals/GraphBinaryWriter.d.ts +9 -0
  223. package/build/esm/structure/io/binary/internals/GraphBinaryWriter.js +82 -0
  224. package/build/esm/structure/io/binary/internals/IntSerializer.d.ts +13 -0
  225. package/build/esm/structure/io/binary/internals/IntSerializer.js +100 -0
  226. package/build/esm/structure/io/binary/internals/LongSerializer.d.ts +11 -0
  227. package/build/esm/structure/io/binary/internals/LongSerializer.js +92 -0
  228. package/build/esm/structure/io/binary/internals/MapSerializer.d.ts +13 -0
  229. package/build/esm/structure/io/binary/internals/MapSerializer.js +141 -0
  230. package/build/esm/structure/io/binary/internals/MarkerSerializer.d.ts +8 -0
  231. package/build/esm/structure/io/binary/internals/MarkerSerializer.js +60 -0
  232. package/build/esm/structure/io/binary/internals/NumberSerializationStrategy.d.ts +9 -0
  233. package/build/esm/structure/io/binary/internals/NumberSerializationStrategy.js +63 -0
  234. package/build/esm/structure/io/binary/internals/PathSerializer.d.ts +15 -0
  235. package/build/esm/structure/io/binary/internals/PathSerializer.js +110 -0
  236. package/build/esm/structure/io/binary/internals/PropertySerializer.d.ts +15 -0
  237. package/build/esm/structure/io/binary/internals/PropertySerializer.js +127 -0
  238. package/build/esm/structure/io/binary/internals/SetSerializer.d.ts +15 -0
  239. package/build/esm/structure/io/binary/internals/SetSerializer.js +135 -0
  240. package/build/esm/structure/io/binary/internals/ShortSerializer.d.ts +11 -0
  241. package/build/esm/structure/io/binary/internals/ShortSerializer.js +88 -0
  242. package/build/esm/structure/io/binary/internals/StringSerializer.d.ts +11 -0
  243. package/build/esm/structure/io/binary/internals/StringSerializer.js +104 -0
  244. package/build/esm/structure/io/binary/internals/StubSerializer.d.ts +7 -0
  245. package/{.prettierrc.js → build/esm/structure/io/binary/internals/StubSerializer.js} +11 -11
  246. package/build/esm/structure/io/binary/internals/UnspecifiedNullSerializer.d.ts +11 -0
  247. package/build/esm/structure/io/binary/internals/UnspecifiedNullSerializer.js +67 -0
  248. package/build/esm/structure/io/binary/internals/UuidSerializer.d.ts +14 -0
  249. package/build/esm/structure/io/binary/internals/UuidSerializer.js +106 -0
  250. package/build/esm/structure/io/binary/internals/VertexPropertySerializer.d.ts +15 -0
  251. package/build/esm/structure/io/binary/internals/VertexPropertySerializer.js +160 -0
  252. package/build/esm/structure/io/binary/internals/VertexSerializer.d.ts +17 -0
  253. package/build/esm/structure/io/binary/internals/VertexSerializer.js +125 -0
  254. package/build/esm/structure/io/binary/internals/utils.d.ts +6 -0
  255. package/{lib → build/esm}/structure/io/binary/internals/utils.js +23 -35
  256. package/build/esm/utils.d.ts +20 -0
  257. package/build/esm/utils.js +98 -0
  258. package/package.json +56 -20
  259. package/.nvmrc +0 -1
  260. package/NOTICE +0 -5
  261. package/doc/AnonymousTraversalSource.html +0 -793
  262. package/doc/Authenticator.html +0 -303
  263. package/doc/Bytecode.html +0 -941
  264. package/doc/CardinalityValue.html +0 -711
  265. package/doc/Client.html +0 -1869
  266. package/doc/Connection.html +0 -1192
  267. package/doc/DriverRemoteConnection.html +0 -1528
  268. package/doc/EdgeLabelVerificationStrategy.html +0 -238
  269. package/doc/Graph.html +0 -343
  270. package/doc/GraphSON2Reader.html +0 -407
  271. package/doc/GraphSON2Writer.html +0 -558
  272. package/doc/GraphSON3Reader.html +0 -170
  273. package/doc/GraphSON3Writer.html +0 -170
  274. package/doc/GraphTraversal.html +0 -22974
  275. package/doc/GraphTraversalSource.html +0 -3683
  276. package/doc/HaltedTraverserStrategy.html +0 -215
  277. package/doc/MatchAlgorithmStrategy.html +0 -210
  278. package/doc/P.html +0 -2020
  279. package/doc/PartitionStrategy.html +0 -387
  280. package/doc/Path.html +0 -242
  281. package/doc/PlainTextSaslAuthenticator.html +0 -456
  282. package/doc/ProductiveByStrategy.html +0 -258
  283. package/doc/RemoteConnection.html +0 -1086
  284. package/doc/RemoteStrategy.html +0 -307
  285. package/doc/RemoteTraversal.html +0 -170
  286. package/doc/ReservedKeysVerificationStrategy.html +0 -261
  287. package/doc/ResponseError.html +0 -360
  288. package/doc/ResultSet.html +0 -633
  289. package/doc/SaslAuthenticator.html +0 -455
  290. package/doc/SaslMechanismBase.html +0 -506
  291. package/doc/SaslMechanismPlain.html +0 -925
  292. package/doc/SeedStrategy.html +0 -288
  293. package/doc/SubgraphStrategy.html +0 -387
  294. package/doc/TextP.html +0 -1440
  295. package/doc/Transaction.html +0 -655
  296. package/doc/Translator.html +0 -527
  297. package/doc/TraversalStrategies.html +0 -652
  298. package/doc/TraversalStrategy.html +0 -393
  299. package/doc/TypeSerializer.html +0 -166
  300. package/doc/driver_auth_authenticator.js.html +0 -89
  301. package/doc/driver_auth_mechanisms_sasl-mechanism-base.js.html +0 -103
  302. package/doc/driver_auth_mechanisms_sasl-mechanism-plain.js.html +0 -157
  303. package/doc/driver_auth_plain-text-sasl-authenticator.js.html +0 -106
  304. package/doc/driver_auth_sasl-authenticator.js.html +0 -100
  305. package/doc/driver_client.js.html +0 -250
  306. package/doc/driver_connection.js.html +0 -518
  307. package/doc/driver_driver-remote-connection.js.html +0 -193
  308. package/doc/driver_remote-connection.js.html +0 -198
  309. package/doc/driver_response-error.js.html +0 -98
  310. package/doc/driver_result-set.js.html +0 -134
  311. package/doc/fonts/OpenSans-Bold-webfont.eot +0 -0
  312. package/doc/fonts/OpenSans-Bold-webfont.svg +0 -1830
  313. package/doc/fonts/OpenSans-Bold-webfont.woff +0 -0
  314. package/doc/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
  315. package/doc/fonts/OpenSans-BoldItalic-webfont.svg +0 -1830
  316. package/doc/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
  317. package/doc/fonts/OpenSans-Italic-webfont.eot +0 -0
  318. package/doc/fonts/OpenSans-Italic-webfont.svg +0 -1830
  319. package/doc/fonts/OpenSans-Italic-webfont.woff +0 -0
  320. package/doc/fonts/OpenSans-Light-webfont.eot +0 -0
  321. package/doc/fonts/OpenSans-Light-webfont.svg +0 -1831
  322. package/doc/fonts/OpenSans-Light-webfont.woff +0 -0
  323. package/doc/fonts/OpenSans-LightItalic-webfont.eot +0 -0
  324. package/doc/fonts/OpenSans-LightItalic-webfont.svg +0 -1835
  325. package/doc/fonts/OpenSans-LightItalic-webfont.woff +0 -0
  326. package/doc/fonts/OpenSans-Regular-webfont.eot +0 -0
  327. package/doc/fonts/OpenSans-Regular-webfont.svg +0 -1831
  328. package/doc/fonts/OpenSans-Regular-webfont.woff +0 -0
  329. package/doc/global.html +0 -728
  330. package/doc/index.html +0 -185
  331. package/doc/module.exports.html +0 -301
  332. package/doc/process_anonymous-traversal.js.html +0 -138
  333. package/doc/process_bytecode.js.html +0 -175
  334. package/doc/process_graph-traversal.js.html +0 -1936
  335. package/doc/process_transaction.js.html +0 -151
  336. package/doc/process_translator.js.html +0 -172
  337. package/doc/process_traversal-strategy.js.html +0 -466
  338. package/doc/process_traversal.js.html +0 -592
  339. package/doc/scripts/linenumber.js +0 -25
  340. package/doc/scripts/prettify/Apache-License-2.0.txt +0 -202
  341. package/doc/scripts/prettify/lang-css.js +0 -2
  342. package/doc/scripts/prettify/prettify.js +0 -28
  343. package/doc/structure_graph.js.html +0 -233
  344. package/doc/structure_io_binary_internals_DataType.js.html +0 -151
  345. package/doc/structure_io_binary_internals_GraphBinaryReader.js.html +0 -133
  346. package/doc/structure_io_binary_internals_GraphBinaryWriter.js.html +0 -136
  347. package/doc/structure_io_graph-serializer.js.html +0 -354
  348. package/doc/structure_io_type-serializers.js.html +0 -617
  349. package/doc/styles/jsdoc-default.css +0 -358
  350. package/doc/styles/prettify-jsdoc.css +0 -111
  351. package/doc/styles/prettify-tomorrow.css +0 -132
  352. package/doc/utils.js.html +0 -181
  353. package/docker-compose.yml +0 -76
  354. package/eslint.config.mjs +0 -143
  355. package/lib/driver/auth/mechanisms/sasl-mechanism-plain.js +0 -106
  356. package/lib/driver/auth/plain-text-sasl-authenticator.js +0 -55
  357. package/lib/driver/auth/sasl-authenticator.js +0 -49
  358. package/lib/driver/client.js +0 -199
  359. package/lib/driver/connection.js +0 -467
  360. package/lib/driver/driver-remote-connection.js +0 -142
  361. package/lib/driver/remote-connection.js +0 -147
  362. package/lib/driver/result-set.js +0 -83
  363. package/lib/process/anonymous-traversal.js +0 -87
  364. package/lib/process/bytecode.js +0 -124
  365. package/lib/process/graph-traversal.js +0 -1885
  366. package/lib/process/transaction.js +0 -100
  367. package/lib/process/translator.js +0 -121
  368. package/lib/process/traversal-strategy.js +0 -415
  369. package/lib/process/traversal.js +0 -541
  370. package/lib/structure/graph.js +0 -182
  371. package/lib/structure/io/binary/GraphBinary.js +0 -110
  372. package/lib/structure/io/binary/internals/AnySerializer.js +0 -100
  373. package/lib/structure/io/binary/internals/ArraySerializer.js +0 -137
  374. package/lib/structure/io/binary/internals/BigIntegerSerializer.js +0 -153
  375. package/lib/structure/io/binary/internals/BooleanSerializer.js +0 -105
  376. package/lib/structure/io/binary/internals/BulkSetSerializer.js +0 -126
  377. package/lib/structure/io/binary/internals/ByteBufferSerializer.js +0 -126
  378. package/lib/structure/io/binary/internals/ByteSerializer.js +0 -97
  379. package/lib/structure/io/binary/internals/BytecodeSerializer.js +0 -250
  380. package/lib/structure/io/binary/internals/ClassSerializer.js +0 -60
  381. package/lib/structure/io/binary/internals/DataType.js +0 -100
  382. package/lib/structure/io/binary/internals/DateSerializer.js +0 -105
  383. package/lib/structure/io/binary/internals/DoubleSerializer.js +0 -101
  384. package/lib/structure/io/binary/internals/EdgeSerializer.js +0 -216
  385. package/lib/structure/io/binary/internals/EnumSerializer.js +0 -152
  386. package/lib/structure/io/binary/internals/FloatSerializer.js +0 -101
  387. package/lib/structure/io/binary/internals/GraphBinaryReader.js +0 -82
  388. package/lib/structure/io/binary/internals/GraphBinaryWriter.js +0 -85
  389. package/lib/structure/io/binary/internals/IntSerializer.js +0 -114
  390. package/lib/structure/io/binary/internals/LambdaSerializer.js +0 -71
  391. package/lib/structure/io/binary/internals/LongSerializer.js +0 -109
  392. package/lib/structure/io/binary/internals/LongSerializerNg.js +0 -104
  393. package/lib/structure/io/binary/internals/MapSerializer.js +0 -155
  394. package/lib/structure/io/binary/internals/NumberSerializationStrategy.js +0 -73
  395. package/lib/structure/io/binary/internals/OffsetDateTimeSerializer.js +0 -151
  396. package/lib/structure/io/binary/internals/PSerializer.js +0 -152
  397. package/lib/structure/io/binary/internals/PathSerializer.js +0 -124
  398. package/lib/structure/io/binary/internals/PropertySerializer.js +0 -142
  399. package/lib/structure/io/binary/internals/SetSerializer.js +0 -134
  400. package/lib/structure/io/binary/internals/ShortSerializer.js +0 -101
  401. package/lib/structure/io/binary/internals/StringSerializer.js +0 -116
  402. package/lib/structure/io/binary/internals/TextPSerializer.js +0 -146
  403. package/lib/structure/io/binary/internals/TraversalStrategySerializer.js +0 -69
  404. package/lib/structure/io/binary/internals/TraverserSerializer.js +0 -124
  405. package/lib/structure/io/binary/internals/UnspecifiedNullSerializer.js +0 -77
  406. package/lib/structure/io/binary/internals/UuidSerializer.js +0 -121
  407. package/lib/structure/io/binary/internals/VertexPropertySerializer.js +0 -176
  408. package/lib/structure/io/binary/internals/VertexSerializer.js +0 -139
  409. package/lib/structure/io/graph-serializer.js +0 -303
  410. package/lib/structure/io/type-serializers.js +0 -566
  411. package/lib/utils.js +0 -130
@@ -1,518 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
- <meta charset="utf-8">
5
- <title>JSDoc: Source: driver/connection.js</title>
6
-
7
- <script src="scripts/prettify/prettify.js"> </script>
8
- <script src="scripts/prettify/lang-css.js"> </script>
9
- <!--[if lt IE 9]>
10
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11
- <![endif]-->
12
- <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
13
- <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
14
- </head>
15
-
16
- <body>
17
-
18
- <div id="main">
19
-
20
- <h1 class="page-title">Source: driver/connection.js</h1>
21
-
22
-
23
-
24
-
25
-
26
-
27
- <section>
28
- <article>
29
- <pre class="prettyprint source linenums"><code>/*
30
- * Licensed to the Apache Software Foundation (ASF) under one
31
- * or more contributor license agreements. See the NOTICE file
32
- * distributed with this work for additional information
33
- * regarding copyright ownership. The ASF licenses this file
34
- * to you under the Apache License, Version 2.0 (the
35
- * "License"); you may not use this file except in compliance
36
- * with the License. You may obtain a copy of the License at
37
- *
38
- * http://www.apache.org/licenses/LICENSE-2.0
39
- *
40
- * Unless required by applicable law or agreed to in writing,
41
- * software distributed under the License is distributed on an
42
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
43
- * KIND, either express or implied. See the License for the
44
- * specific language governing permissions and limitations
45
- * under the License.
46
- */
47
-
48
- /**
49
- * @author Jorge Bay Gondra
50
- */
51
- 'use strict';
52
-
53
- const { Buffer } = require('buffer');
54
- const EventEmitter = require('eventemitter3');
55
- const Stream = require('readable-stream');
56
- const utils = require('../utils');
57
- const { DeferredPromise } = utils;
58
- const serializer = require('../structure/io/graph-serializer');
59
- const { graphBinaryReader, graphBinaryWriter } = require('../structure/io/binary/GraphBinary');
60
- const ResultSet = require('./result-set');
61
- const ResponseError = require('./response-error');
62
-
63
- const responseStatusCode = {
64
- success: 200,
65
- noContent: 204,
66
- partialContent: 206,
67
- authenticationChallenge: 407,
68
- };
69
-
70
- const defaultMimeType = 'application/vnd.graphbinary-v1.0';
71
- const graphSON2MimeType = 'application/vnd.gremlin-v2.0+json';
72
- const graphBinaryMimeType = 'application/vnd.graphbinary-v1.0';
73
-
74
- const uuidPattern = '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}';
75
-
76
- /**
77
- * Represents a single connection to a Gremlin Server.
78
- */
79
- class Connection extends EventEmitter {
80
- /**
81
- * Creates a new instance of {@link Connection}.
82
- * @param {String} url The resource uri.
83
- * @param {Object} [options] The connection options.
84
- * @param {Array} [options.ca] Trusted certificates.
85
- * @param {String|Array|Buffer} [options.cert] The certificate key.
86
- * @param {String} [options.mimeType] The mime type to use.
87
- * @param {String|Buffer} [options.pfx] The private key, certificate, and CA certs.
88
- * @param {GraphSONReader} [options.reader] The reader to use.
89
- * @param {Boolean} [options.rejectUnauthorized] Determines whether to verify or not the server certificate.
90
- * @param {String} [options.traversalSource] The traversal source. Defaults to: 'g'.
91
- * @param {GraphSONWriter} [options.writer] The writer to use.
92
- * @param {Authenticator} [options.authenticator] The authentication handler to use.
93
- * @param {Object} [options.headers] An associative array containing the additional header key/values for the initial request.
94
- * @param {Boolean} [options.enableUserAgentOnConnect] Determines if a user agent will be sent during connection handshake. Defaults to: true
95
- * @param {http.Agent} [options.agent] The http.Agent implementation to use.
96
- * @param {Boolean} [options.enableCompression] Enable per-message deflate compression. Defaults to: false.
97
- * @constructor
98
- */
99
- constructor(url, options) {
100
- super();
101
-
102
- this.url = url;
103
- this.options = options = options || {};
104
-
105
- /**
106
- * Gets the MIME type.
107
- * @type {String}
108
- */
109
- this.mimeType = options.mimeType || defaultMimeType;
110
-
111
- // A map containing the request id and the handler. The id should be in lower case to prevent string comparison issues.
112
- this._responseHandlers = {};
113
- this._reader = options.reader || this.#getDefaultReader(this.mimeType);
114
- this._writer = options.writer || this.#getDefaultWriter(this.mimeType);
115
- this._openPromise = null;
116
- this._openCallback = null;
117
- this._closePromise = null;
118
- this._closeCallback = null;
119
-
120
- this._header = String.fromCharCode(this.mimeType.length) + this.mimeType; // TODO: what if mimeType.length > 255
121
- this._header_buf = Buffer.from(this._header);
122
- this.isOpen = false;
123
- this.traversalSource = options.traversalSource || 'g';
124
- this._authenticator = options.authenticator;
125
- this._enableUserAgentOnConnect = options.enableUserAgentOnConnect !== false;
126
- this._enableCompression = this.options.enableCompression || false;
127
- }
128
-
129
- /**
130
- * Opens the connection, if its not already opened.
131
- * @returns {Promise}
132
- */
133
- async open() {
134
- if (this.isOpen) {
135
- return;
136
- }
137
- if (this._openPromise) {
138
- return this._openPromise;
139
- }
140
-
141
- this._openPromise = DeferredPromise();
142
-
143
- this.emit('log', 'ws open');
144
- let headers = this.options.headers;
145
- if (this._enableUserAgentOnConnect) {
146
- if (!headers) {
147
- headers = [];
148
- }
149
-
150
- const userAgent = await utils.getUserAgent();
151
- if (userAgent !== undefined) {
152
- headers[utils.getUserAgentHeader()] = await utils.getUserAgent();
153
- }
154
- }
155
- // All these options are available to the `ws` package's constructor, but not the global WebSocket class
156
- const wsSpecificOptions = new Set([
157
- 'headers',
158
- 'ca',
159
- 'cert',
160
- 'pfx',
161
- 'rejectUnauthorized',
162
- 'agent',
163
- 'perMessageDeflate',
164
- ]);
165
- // Check if any `ws` specific options are provided and are non-null / non-undefined
166
- const hasWsSpecificOptions =
167
- Object.entries(this.options).some(
168
- ([key, value]) => wsSpecificOptions.has(key) &amp;&amp; ![null, undefined].includes(value),
169
- ) ||
170
- this._enableCompression || // we need to check the presence of this variable and pass this into ws
171
- this._enableUserAgentOnConnect; // global websocket will send "node" as user agent by default which doesn't comply with Gremlin
172
- // Only use the global websocket if we don't have any unsupported options
173
- const useGlobalWebSocket = !hasWsSpecificOptions &amp;&amp; globalThis.WebSocket;
174
- const WebSocket = useGlobalWebSocket || (await import('ws')).default;
175
-
176
- this._ws = new WebSocket(
177
- this.url,
178
- !useGlobalWebSocket
179
- ? {
180
- headers: headers,
181
- ca: this.options.ca,
182
- cert: this.options.cert,
183
- pfx: this.options.pfx,
184
- rejectUnauthorized: this.options.rejectUnauthorized,
185
- agent: this.options.agent,
186
- perMessageDeflate: this._enableCompression,
187
- }
188
- : undefined,
189
- );
190
-
191
- if ('binaryType' in this._ws) {
192
- this._ws.binaryType = 'arraybuffer';
193
- }
194
-
195
- this._ws.addEventListener('open', this.#handleOpen);
196
- this._ws.addEventListener('error', this.#handleError);
197
- // Only attach unexpected-response listener if WebSocket supports .on() method
198
- // Browser WebSocket does not have this event and .on() method
199
- if (this._ws &amp;&amp; 'on' in this._ws) {
200
- // The following listener needs to use `.on` and `.off` because the `ws` package's addEventListener only accepts certain event types
201
- // Ref: https://github.com/websockets/ws/blob/8.16.0/lib/event-target.js#L202-L241
202
- this._ws.on('unexpected-response', this.#handleUnexpectedResponse);
203
- }
204
- this._ws.addEventListener('message', this.#handleMessage);
205
- this._ws.addEventListener('close', this.#handleClose);
206
- return await this._openPromise;
207
- }
208
-
209
- /** @override */
210
- submit(processor, op, args, requestId) {
211
- // TINKERPOP-2847: Use lower case to prevent string comparison issues.
212
- const rid = (requestId || utils.getUuid()).toLowerCase();
213
- if (!rid.match(uuidPattern)) {
214
- throw new Error('Provided requestId "' + rid + '" is not a valid UUID.');
215
- }
216
-
217
- return this.open().then(
218
- () =>
219
- new Promise((resolve, reject) => {
220
- if (op !== 'authentication') {
221
- this._responseHandlers[rid] = {
222
- callback: (err, result) => (err ? reject(err) : resolve(result)),
223
- result: null,
224
- };
225
- }
226
-
227
- const request = {
228
- requestId: rid,
229
- op: op || 'bytecode',
230
- // if using op eval need to ensure processor stays unset if caller didn't set it.
231
- processor: !processor &amp;&amp; op !== 'eval' ? 'traversal' : processor,
232
- args: args || {},
233
- };
234
-
235
- const request_buf = this._writer.writeRequest(request);
236
- const message = utils.toArrayBuffer(Buffer.concat([this._header_buf, request_buf]));
237
- this._ws.send(message);
238
- }),
239
- );
240
- }
241
-
242
- /** @override */
243
- stream(processor, op, args, requestId) {
244
- // TINKERPOP-2847: Use lower case to prevent string comparison issues.
245
- const rid = (requestId || utils.getUuid()).toLowerCase();
246
- if (!rid.match(uuidPattern)) {
247
- throw new Error('Provided requestId "' + rid + '" is not a valid UUID.');
248
- }
249
-
250
- const readableStream = new Stream.Readable({
251
- objectMode: true,
252
- read() {},
253
- });
254
-
255
- this._responseHandlers[rid] = {
256
- callback: (err) => (err ? readableStream.destroy(err) : readableStream.push(null)),
257
- result: readableStream,
258
- };
259
-
260
- this.open()
261
- .then(() => {
262
- const request = {
263
- requestId: rid,
264
- op: op || 'bytecode',
265
- // if using op eval need to ensure processor stays unset if caller didn't set it.
266
- processor: !processor &amp;&amp; op !== 'eval' ? 'traversal' : processor,
267
- args: args || {},
268
- };
269
-
270
- const request_buf = this._writer.writeRequest(request);
271
- const message = utils.toArrayBuffer(Buffer.concat([this._header_buf, request_buf]));
272
- this._ws.send(message);
273
- })
274
- .catch((err) => readableStream.destroy(err));
275
-
276
- return readableStream;
277
- }
278
-
279
- #getDefaultReader(mimeType) {
280
- if (mimeType === graphBinaryMimeType) {
281
- return graphBinaryReader;
282
- }
283
-
284
- return mimeType === graphSON2MimeType ? new serializer.GraphSON2Reader() : new serializer.GraphSONReader();
285
- }
286
-
287
- #getDefaultWriter(mimeType) {
288
- if (mimeType === graphBinaryMimeType) {
289
- return graphBinaryWriter;
290
- }
291
-
292
- return mimeType === graphSON2MimeType ? new serializer.GraphSON2Writer() : new serializer.GraphSONWriter();
293
- }
294
-
295
- #handleOpen = () => {
296
- this._openPromise.resolve();
297
- this.isOpen = true;
298
- };
299
-
300
- /**
301
- * @param {ClientRequest} _req
302
- * @param {IncomingMessage} res
303
- */
304
- #handleUnexpectedResponse = async (_req, res) => {
305
- const body = await new Promise((resolve, reject) => {
306
- const chunks = [];
307
- res.on('data', (data) => {
308
- chunks.push(data instanceof Buffer ? data : Buffer.from(data));
309
- });
310
- res.on('end', () => {
311
- resolve(chunks.length ? Buffer.concat(chunks) : null);
312
- });
313
- res.on('error', reject);
314
- });
315
- const statusCodeErrorMessage = `Unexpected server response code ${res.statusCode}`;
316
- const errorMessage = body ? `${statusCodeErrorMessage} with body:\n${body.toString()}` : statusCodeErrorMessage;
317
- const error = new Error(errorMessage);
318
- this.#handleError({
319
- error,
320
- message: errorMessage,
321
- type: 'unexpected-response',
322
- target: this._ws,
323
- });
324
- };
325
-
326
- /**
327
- * @param {Event} event
328
- */
329
- #handleError = ({ error }) => {
330
- this._openPromise.reject(error);
331
- this.emit('log', `ws error ${error}`);
332
- this.#cleanupWebsocket(error);
333
- this.emit('socketError', error);
334
- };
335
-
336
- /**
337
- * @param {CloseEvent} event
338
- */
339
- #handleClose = ({ code, message }) => {
340
- this.emit('log', `ws close code=${code} message=${message}`);
341
- this.#cleanupWebsocket();
342
- if (this._closeCallback) {
343
- this._closeCallback();
344
- }
345
- this.emit('close', code, message);
346
- };
347
-
348
- /**
349
- * @param {MessageEvent&lt;any>} event
350
- */
351
- #handleMessage = ({ data: _data }) => {
352
- const data = _data instanceof ArrayBuffer ? Buffer.from(_data) : _data;
353
-
354
- const response = this._reader.readResponse(data);
355
- if (response.requestId === null || response.requestId === undefined) {
356
- // There was a serialization issue on the server that prevented the parsing of the request id
357
- // We invoke any of the pending handlers with an error
358
- Object.keys(this._responseHandlers).forEach((requestId) => {
359
- const handler = this._responseHandlers[requestId];
360
- this.#clearHandler(requestId);
361
- if (response.status !== undefined &amp;&amp; response.status.message) {
362
- return handler.callback(
363
- // TINKERPOP-2285: keep the old server error message in case folks are parsing that - fix in a future breaking version
364
- new ResponseError(
365
- `Server error (no request information): ${response.status.message} (${response.status.code})`,
366
- response.status,
367
- ),
368
- );
369
- }
370
- // TINKERPOP-2285: keep the old server error message in case folks are parsing that - fix in a future breaking version
371
- return handler.callback(
372
- new ResponseError(`Server error (no request information): ${JSON.stringify(response)}`, response.status),
373
- );
374
- });
375
- return;
376
- }
377
-
378
- // TINKERPOP-2847: Use lower case to prevent string comparison issues.
379
- response.requestId = response.requestId.toLowerCase();
380
- const handler = this._responseHandlers[response.requestId];
381
-
382
- if (!handler) {
383
- // The handler for a given request id was not found
384
- // It was probably invoked earlier due to a serialization issue.
385
- return;
386
- }
387
-
388
- if (response.status.code === responseStatusCode.authenticationChallenge &amp;&amp; this._authenticator) {
389
- this._authenticator
390
- .evaluateChallenge(response.result.data)
391
- .then((res) => this.submit(undefined, 'authentication', res, response.requestId))
392
- .catch(handler.callback);
393
-
394
- return;
395
- } else if (response.status.code >= 400) {
396
- this.#clearHandler(response.requestId);
397
- // callback in error
398
- return handler.callback(
399
- // TINKERPOP-2285: keep the old server error message in case folks are parsing that - fix in a future breaking version
400
- new ResponseError(`Server error: ${response.status.message} (${response.status.code})`, response.status),
401
- );
402
- }
403
-
404
- const isStreamingResponse = handler.result instanceof Stream.Readable;
405
-
406
- switch (response.status.code) {
407
- case responseStatusCode.noContent:
408
- this.#clearHandler(response.requestId);
409
- if (isStreamingResponse) {
410
- handler.result.push(new ResultSet(utils.emptyArray, response.status.attributes));
411
- return handler.callback(null);
412
- }
413
- return handler.callback(null, new ResultSet(utils.emptyArray, response.status.attributes));
414
- case responseStatusCode.partialContent:
415
- if (isStreamingResponse) {
416
- handler.result.push(new ResultSet(response.result.data, response.status.attributes));
417
- break;
418
- }
419
- handler.result = handler.result || [];
420
- handler.result.push.apply(handler.result, response.result.data);
421
- break;
422
- default:
423
- if (isStreamingResponse) {
424
- handler.result.push(new ResultSet(response.result.data, response.status.attributes));
425
- return handler.callback(null);
426
- }
427
- if (handler.result) {
428
- handler.result.push.apply(handler.result, response.result.data);
429
- } else {
430
- handler.result = response.result.data;
431
- }
432
- this.#clearHandler(response.requestId);
433
- return handler.callback(null, new ResultSet(handler.result, response.status.attributes));
434
- }
435
- };
436
-
437
- /**
438
- * clean websocket context
439
- */
440
- #cleanupWebsocket(err) {
441
- // Invoke waiting callbacks to complete Promises when closing the websocket
442
- Object.keys(this._responseHandlers).forEach((requestId) => {
443
- const handler = this._responseHandlers[requestId];
444
- const isStreamingResponse = handler.result instanceof Stream.Readable;
445
- if (isStreamingResponse) {
446
- handler.callback(null);
447
- } else {
448
- const cause = err ? err : new Error('Connection has been closed.');
449
- handler.callback(cause);
450
- }
451
- });
452
- this._ws.removeEventListener('open', this.#handleOpen);
453
- this._ws.removeEventListener('error', this.#handleError);
454
- // Only remove unexpected-response listener for Node.js WebSocket (ws package)
455
- // Browser WebSocket does not have this event and .off() method
456
- if (this._ws &amp;&amp; 'off' in this._ws) {
457
- // The following listener needs to use `.on` and `.off` because the `ws` package's addEventListener only accepts certain event types
458
- // Ref: https://github.com/websockets/ws/blob/8.16.0/lib/event-target.js#L202-L241
459
- this._ws.off('unexpected-response', this.#handleUnexpectedResponse);
460
- }
461
- this._ws.removeEventListener('message', this.#handleMessage);
462
- this._ws.removeEventListener('close', this.#handleClose);
463
- this._openPromise = null;
464
- this._closePromise = null;
465
- this.isOpen = false;
466
- }
467
-
468
- /**
469
- * Clears the internal state containing the callback and result buffer of a given request.
470
- * @param requestId
471
- * @private
472
- */
473
- #clearHandler(requestId) {
474
- delete this._responseHandlers[requestId];
475
- }
476
-
477
- /**
478
- * Closes the Connection.
479
- * @return {Promise}
480
- */
481
- close() {
482
- if (this.isOpen === false) {
483
- return Promise.resolve();
484
- }
485
- if (!this._closePromise) {
486
- this._closePromise = new Promise((resolve) => {
487
- this._closeCallback = resolve;
488
- this._ws.close();
489
- });
490
- }
491
- return this._closePromise;
492
- }
493
- }
494
-
495
- module.exports = Connection;
496
- </code></pre>
497
- </article>
498
- </section>
499
-
500
-
501
-
502
-
503
- </div>
504
-
505
- <nav>
506
- <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AnonymousTraversalSource.html">AnonymousTraversalSource</a></li><li><a href="Authenticator.html">Authenticator</a></li><li><a href="Bytecode.html">Bytecode</a></li><li><a href="CardinalityValue.html">CardinalityValue</a></li><li><a href="Client.html">Client</a></li><li><a href="Connection.html">Connection</a></li><li><a href="DriverRemoteConnection.html">DriverRemoteConnection</a></li><li><a href="EdgeLabelVerificationStrategy.html">EdgeLabelVerificationStrategy</a></li><li><a href="Graph.html">Graph</a></li><li><a href="GraphSON2Reader.html">GraphSON2Reader</a></li><li><a href="GraphSON2Writer.html">GraphSON2Writer</a></li><li><a href="GraphSON3Reader.html">GraphSON3Reader</a></li><li><a href="GraphSON3Writer.html">GraphSON3Writer</a></li><li><a href="GraphTraversal.html">GraphTraversal</a></li><li><a href="GraphTraversalSource.html">GraphTraversalSource</a></li><li><a href="HaltedTraverserStrategy.html">HaltedTraverserStrategy</a></li><li><a href="MatchAlgorithmStrategy.html">MatchAlgorithmStrategy</a></li><li><a href="P.html">P</a></li><li><a href="PartitionStrategy.html">PartitionStrategy</a></li><li><a href="Path.html">Path</a></li><li><a href="PlainTextSaslAuthenticator.html">PlainTextSaslAuthenticator</a></li><li><a href="ProductiveByStrategy.html">ProductiveByStrategy</a></li><li><a href="RemoteConnection.html">RemoteConnection</a></li><li><a href="RemoteStrategy.html">RemoteStrategy</a></li><li><a href="RemoteTraversal.html">RemoteTraversal</a></li><li><a href="ReservedKeysVerificationStrategy.html">ReservedKeysVerificationStrategy</a></li><li><a href="ResponseError.html">ResponseError</a></li><li><a href="ResultSet.html">ResultSet</a></li><li><a href="SaslAuthenticator.html">SaslAuthenticator</a></li><li><a href="SaslMechanismBase.html">SaslMechanismBase</a></li><li><a href="SaslMechanismPlain.html">SaslMechanismPlain</a></li><li><a href="SeedStrategy.html">SeedStrategy</a></li><li><a href="SubgraphStrategy.html">SubgraphStrategy</a></li><li><a href="TextP.html">TextP</a></li><li><a href="Transaction.html">Transaction</a></li><li><a href="Translator.html">Translator</a></li><li><a href="TraversalStrategies.html">TraversalStrategies</a></li><li><a href="TraversalStrategy.html">TraversalStrategy</a></li><li><a href="TypeSerializer.html">TypeSerializer</a></li><li><a href="module.exports.html">exports</a></li></ul><h3>Global</h3><ul><li><a href="global.html#DataType">DataType</a></li><li><a href="global.html#deserializeProperties">deserializeProperties</a></li><li><a href="global.html#statics">statics</a></li><li><a href="global.html#toArrayBuffer">toArrayBuffer</a></li></ul>
507
- </nav>
508
-
509
- <br class="clear">
510
-
511
- <footer>
512
- Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.5</a> on Mon Apr 06 2026 17:24:03 GMT-0700 (Pacific Daylight Time)
513
- </footer>
514
-
515
- <script> prettyPrint(); </script>
516
- <script src="scripts/linenumber.js"> </script>
517
- </body>
518
- </html>