Docs and cleaning up

Author: bigmontz

packages/bolt-connection/src/bolt/bolt-protocol-v1.transformer.js

@@ -45,6 +45,10 @@ const UNBOUND_RELATIONSHIP_STRUCT_SIZE = 3
 const PATH = 0x50
 const PATH_STRUCT_SIZE = 3
 
+/**
+ * Creates the Node Transformer
+ * @returns {TypeTransformer}
+ */
 function createNodeTransformer () {
   return new TypeTransformer({
     signature: NODE,
@@ -65,6 +69,10 @@ function createNodeTransformer () {
   })
 }
 
+/**
+ * Creates the Relationship Transformer
+ * @returns {TypeTransformer}
+ */
 function createRelationshipTransformer () {
   return new TypeTransformer({
     signature: RELATIONSHIP,
@@ -85,6 +93,10 @@ function createRelationshipTransformer () {
   })
 }
 
+/**
+ * Creates the Unbound Relationship Transformer
+ * @returns {TypeTransformer}
+ */
 function createUnboundRelationshipTransformer () {
   return new TypeTransformer({
     signature: UNBOUND_RELATIONSHIP,
@@ -109,6 +121,10 @@ function createUnboundRelationshipTransformer () {
   })
 }
 
+/**
+ * Creates the Path Transformer
+ * @returns {TypeTransformer}
+ */
 function createPathTransformer () {
   return new TypeTransformer({
     signature: PATH,

packages/bolt-connection/src/bolt/bolt-protocol-v2.transformer.js

@@ -80,6 +80,10 @@ const DATE_TIME_WITH_ZONE_OFFSET_STRUCT_SIZE = 3
 const DATE_TIME_WITH_ZONE_ID = 0x66
 const DATE_TIME_WITH_ZONE_ID_STRUCT_SIZE = 3
 
+/**
+ * Creates the Point2D Transformer
+ * @returns {TypeTransformer}
+ */
 function createPoint2DTransformer () {
   return new TypeTransformer({
     signature: POINT_2D,
@@ -103,6 +107,10 @@ function createPoint2DTransformer () {
   })
 }
 
+/**
+ * Creates the Point3D Transformer
+ * @returns {TypeTransformer}
+ */
 function createPoint3DTransformer () {
   return new TypeTransformer({
     signature: POINT_3D,
@@ -127,6 +135,10 @@ function createPoint3DTransformer () {
   })
 }
 
+/**
+ * Creates the Duration Transformer
+ * @returns {TypeTransformer}
+ */
 function createDurationTransformer () {
   return new TypeTransformer({
     signature: DURATION,
@@ -149,6 +161,13 @@ function createDurationTransformer () {
   })
 }
 
+/**
+ * Creates the LocalTime Transformer
+ * @param {Object} param
+ * @param {boolean} param.disableLosslessIntegers Disables lossless integers
+ * @param {boolean} param.useBigInt Uses BigInt instead of number or Integer
+ * @returns {TypeTransformer}
+ */
 function createLocalTimeTransformer ({ disableLosslessIntegers, useBigInt }) {
   return new TypeTransformer({
     signature: LOCAL_TIME,
@@ -173,6 +192,13 @@ function createLocalTimeTransformer ({ disableLosslessIntegers, useBigInt }) {
   })
 }
 
+/**
+ * Creates the Time Transformer
+ * @param {Object} param
+ * @param {boolean} param.disableLosslessIntegers Disables lossless integers
+ * @param {boolean} param.useBigInt Uses BigInt instead of number or Integer
+ * @returns {TypeTransformer}
+ */
 function createTimeTransformer ({ disableLosslessIntegers, useBigInt }) {
   return new TypeTransformer({
     signature: TIME,
@@ -205,6 +231,13 @@ function createTimeTransformer ({ disableLosslessIntegers, useBigInt }) {
   })
 }
 
+/**
+ * Creates the Date Transformer
+ * @param {Object} param
+ * @param {boolean} param.disableLosslessIntegers Disables lossless integers
+ * @param {boolean} param.useBigInt Uses BigInt instead of number or Integer
+ * @returns {TypeTransformer}
+ */
 function createDateTransformer ({ disableLosslessIntegers, useBigInt }) {
   return new TypeTransformer({
     signature: DATE,
@@ -224,6 +257,13 @@ function createDateTransformer ({ disableLosslessIntegers, useBigInt }) {
   })
 }
 
+/**
+ * Creates the LocalDateTime Transformer
+ * @param {Object} param
+ * @param {boolean} param.disableLosslessIntegers Disables lossless integers
+ * @param {boolean} param.useBigInt Uses BigInt instead of number or Integer
+ * @returns {TypeTransformer}
+ */
 function createLocalDateTimeTransformer ({ disableLosslessIntegers, useBigInt }) {
   return new TypeTransformer({
     signature: LOCAL_DATE_TIME,
@@ -256,6 +296,13 @@ function createLocalDateTimeTransformer ({ disableLosslessIntegers, useBigInt })
   })
 }
 
+/**
+ * Creates the DateTime with ZoneId Transformer
+ * @param {Object} param
+ * @param {boolean} param.disableLosslessIntegers Disables lossless integers
+ * @param {boolean} param.useBigInt Uses BigInt instead of number or Integer
+ * @returns {TypeTransformer}
+ */
 function createDateTimeWithZoneIdTransformer ({ disableLosslessIntegers, useBigInt }) {
   return new TypeTransformer({
     signature: DATE_TIME_WITH_ZONE_ID,
@@ -301,6 +348,13 @@ function createDateTimeWithZoneIdTransformer ({ disableLosslessIntegers, useBigI
   })
 }
 
+/**
+ * Creates the DateTime with Offset Transformer
+ * @param {Object} param
+ * @param {boolean} param.disableLosslessIntegers Disables lossless integers
+ * @param {boolean} param.useBigInt Uses BigInt instead of number or Integer
+ * @returns {TypeTransformer}
+ */
 function createDateTimeWithOffsetTransformer ({ disableLosslessIntegers, useBigInt }) {
   return new TypeTransformer({
     signature: DATE_TIME_WITH_ZONE_OFFSET,

packages/bolt-connection/src/bolt/bolt-protocol-v5x0.transformer.js

@@ -25,6 +25,11 @@ const NODE_STRUCT_SIZE = 4
 const RELATIONSHIP_STRUCT_SIZE = 8
 const UNBOUND_RELATIONSHIP_STRUCT_SIZE = 4
 
+/**
+ * Create an extend Node transformer with support to elementId
+ * @param {any} config
+ * @returns {TypeTransformer}
+ */
 function createNodeTransformer (config) {
   const node4x4Transformer = v4x4.createNodeTransformer(config)
   return node4x4Transformer.extendsWith({
@@ -43,6 +48,11 @@ function createNodeTransformer (config) {
   })
 }
 
+/**
+ * Create an extend Relationship transformer with support to elementId
+ * @param {any} config
+ * @returns {TypeTransformer}
+ */
 function createRelationshipTransformer (config) {
   const relationship4x4Transformer = v4x4.createRelationshipTransformer(config)
   return relationship4x4Transformer.extendsWith({
@@ -74,6 +84,11 @@ function createRelationshipTransformer (config) {
   })
 }
 
+/**
+ * Create an extend Unbound Relationship transformer with support to elementId
+ * @param {any} config
+ * @returns {TypeTransformer}
+ */
 function createUnboundRelationshipTransformer (config) {
   const unboundRelationshipTransformer = v4x4.createUnboundRelationshipTransformer(config)
   return unboundRelationshipTransformer.extendsWith({

packages/bolt-connection/src/bolt/transformer.js

@@ -19,7 +19,15 @@
 
 import { structure } from '../packstream'
 
+/**
+ * Class responsible for applying the expected {@link TypeTransformer} to
+ * transform the driver types from and to {@link struct.Structure}
+ */
 export default class Transformer {
+  /**
+   * Constructor
+   * @param {TypeTransformer[]} transformers The type transformers
+   */
   constructor (transformers) {
     this._transformers = transformers
     this._transformersPerSignature = new Map(transformers.map(typeTransformer => [typeTransformer.signature, typeTransformer]))
@@ -28,6 +36,12 @@ export default class Transformer {
     Object.freeze(this)
   }
 
+  /**
+   * Transform from structure to specific object
+   *
+   * @param {struct.Structure} struct The structure
+   * @returns {<T>|structure.Structure} The driver object or the structure if the transformer was not found.
+   */
   fromStructure (struct) {
     if (struct instanceof structure.Structure && this._transformersPerSignature.has(struct.signature)) {
       const { fromStructure } = this._transformersPerSignature.get(struct.signature)
@@ -36,6 +50,11 @@ export default class Transformer {
     return struct
   }
 
+  /**
+   * Transform from object to structure
+   * @param {<T>} type The object to be transoformed in structure
+   * @returns {<T>|structure.Structure} The structure or the object, if any transformer was found
+   */
   toStructure (type) {
     const transformer = this._transformers.find(({ isTypeInstance }) => isTypeInstance(type))
     if (transformer !== undefined) {
@@ -45,7 +64,36 @@ export default class Transformer {
   }
 }
 
+/**
+ * @callback isTypeInstanceFunction
+ * @param {any} object The object
+ * @return {boolean} is instance of
+ */
+
+/**
+ * @callback toStructureFunction
+ * @param {any} object The object
+ * @return {structure.Structure} The structure
+ */
+
+/**
+ * @callback fromStructureFunction
+ * @param {structure.Structure} struct The structure
+ * @return {any} The object
+ */
+
+/**
+ * Class responsible for grouping the properties of a TypeTransformer
+ */
 export class TypeTransformer {
+  /**
+   * @param {Object} param
+   * @param {number} param.signature The signature of the structure
+   * @param {isTypeInstanceFunction} param.isTypeInstance The function which checks if object is
+   *                instance of the type described by the TypeTransformer
+   * @param {toStructureFunction} param.toStructure The function which gets the object and converts to structure
+   * @param {fromStructureFunction} param.fromStructure The function which get the structure and covnverts to object
+   */
   constructor ({ signature, fromStructure, toStructure, isTypeInstance }) {
     this.signature = signature
     this.isTypeInstance = isTypeInstance
@@ -55,6 +103,15 @@ export class TypeTransformer {
     Object.freeze(this)
   }
 
+  /**
+   * @param {Object} param
+   * @param {number} [param.signature] The signature of the structure
+   * @param {isTypeInstanceFunction} [param.isTypeInstance] The function which checks if object is
+   *                instance of the type described by the TypeTransformer
+   * @param {toStructureFunction} [param.toStructure] The function which gets the object and converts to structure
+   * @param {fromStructureFunction} pparam.fromStructure] The function which get the structure and covnverts to object
+   * @returns {TypeTransformer} A new type transform extends with new methods
+   */
   extendsWith ({ signature, fromStructure, toStructure, isTypeInstance }) {
     return new TypeTransformer({
       signature: signature || this.signature,

packages/bolt-connection/test/bolt/__snapshots__/bolt-protocol-v2.test.js.snap

@@ -8,54 +8,54 @@ exports[`#unit BoltProtocolV2 .packable() should pack not pack graph types (Rela
 
 exports[`#unit BoltProtocolV2 .packable() should pack not pack graph types (UnboundRelationship) 1`] = `"It is not allowed to pass unbound relationships in query parameters, given: -[:a {b:\\"c\\"}]->"`;
 
-exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size(Date with less fields) 1`] = `"Wrong struct size for Date, expected 1 but was 0"`;
+exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size (Date with less fields) 1`] = `"Wrong struct size for Date, expected 1 but was 0"`;
 
-exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size(Date with more fields) 1`] = `"Wrong struct size for Date, expected 1 but was 2"`;
+exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size (Date with more fields) 1`] = `"Wrong struct size for Date, expected 1 but was 2"`;
 
-exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size(DateTimeWithZoneId with less fields) 1`] = `"Wrong struct size for DateTimeWithZoneId, expected 3 but was 2"`;
+exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size (DateTimeWithZoneId with less fields) 1`] = `"Wrong struct size for DateTimeWithZoneId, expected 3 but was 2"`;
 
-exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size(DateTimeWithZoneId with more fields) 1`] = `"Wrong struct size for DateTimeWithZoneId, expected 3 but was 4"`;
+exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size (DateTimeWithZoneId with more fields) 1`] = `"Wrong struct size for DateTimeWithZoneId, expected 3 but was 4"`;
 
-exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size(DateTimeWithZoneOffset with less fields) 1`] = `"Wrong struct size for DateTimeWithZoneOffset, expected 3 but was 2"`;
+exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size (DateTimeWithZoneOffset with less fields) 1`] = `"Wrong struct size for DateTimeWithZoneOffset, expected 3 but was 2"`;
 
-exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size(DateTimeWithZoneOffset with more fields) 1`] = `"Wrong struct size for DateTimeWithZoneOffset, expected 3 but was 4"`;
+exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size (DateTimeWithZoneOffset with more fields) 1`] = `"Wrong struct size for DateTimeWithZoneOffset, expected 3 but was 4"`;
 
-exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size(Duration with less fields) 1`] = `"Wrong struct size for Duration, expected 4 but was 3"`;
+exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size (Duration with less fields) 1`] = `"Wrong struct size for Duration, expected 4 but was 3"`;
 
-exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size(Duration with more fields) 1`] = `"Wrong struct size for Duration, expected 4 but was 5"`;
+exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size (Duration with more fields) 1`] = `"Wrong struct size for Duration, expected 4 but was 5"`;
 
-exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size(LocalDateTime with less fields) 1`] = `"Wrong struct size for LocalDateTime, expected 2 but was 1"`;
+exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size (LocalDateTime with less fields) 1`] = `"Wrong struct size for LocalDateTime, expected 2 but was 1"`;
 
-exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size(LocalDateTime with more fields) 1`] = `"Wrong struct size for LocalDateTime, expected 2 but was 3"`;
+exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size (LocalDateTime with more fields) 1`] = `"Wrong struct size for LocalDateTime, expected 2 but was 3"`;
 
-exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size(LocalTime with less fields) 1`] = `"Wrong struct size for LocalTime, expected 1 but was 0"`;
+exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size (LocalTime with less fields) 1`] = `"Wrong struct size for LocalTime, expected 1 but was 0"`;
 
-exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size(LocalTime with more fields) 1`] = `"Wrong struct size for LocalTime, expected 1 but was 2"`;
+exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size (LocalTime with more fields) 1`] = `"Wrong struct size for LocalTime, expected 1 but was 2"`;
 
-exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size(Node with less fields) 1`] = `"Wrong struct size for Node, expected 3 but was 2"`;
+exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size (Node with less fields) 1`] = `"Wrong struct size for Node, expected 3 but was 2"`;
 
-exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size(Node with more fields) 1`] = `"Wrong struct size for Node, expected 3 but was 4"`;
+exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size (Node with more fields) 1`] = `"Wrong struct size for Node, expected 3 but was 4"`;
 
-exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size(Path with less fields) 1`] = `"Wrong struct size for Path, expected 3 but was 2"`;
+exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size (Path with less fields) 1`] = `"Wrong struct size for Path, expected 3 but was 2"`;
 
-exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size(Path with more fields) 1`] = `"Wrong struct size for Path, expected 3 but was 4"`;
+exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size (Path with more fields) 1`] = `"Wrong struct size for Path, expected 3 but was 4"`;
 
-exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size(Point with less fields) 1`] = `"Wrong struct size for Point2D, expected 3 but was 2"`;
+exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size (Point with less fields) 1`] = `"Wrong struct size for Point2D, expected 3 but was 2"`;
 
-exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size(Point with more fields) 1`] = `"Wrong struct size for Point2D, expected 3 but was 4"`;
+exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size (Point with more fields) 1`] = `"Wrong struct size for Point2D, expected 3 but was 4"`;
 
-exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size(Point3D with less fields) 1`] = `"Wrong struct size for Point3D, expected 4 but was 3"`;
+exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size (Point3D with less fields) 1`] = `"Wrong struct size for Point3D, expected 4 but was 3"`;
 
-exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size(Point3D with more fields) 1`] = `"Wrong struct size for Point3D, expected 4 but was 5"`;
+exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size (Point3D with more fields) 1`] = `"Wrong struct size for Point3D, expected 4 but was 5"`;
 
-exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size(Relationship with less fields) 1`] = `"Wrong struct size for Relationship, expected 5 but was 4"`;
+exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size (Relationship with less fields) 1`] = `"Wrong struct size for Relationship, expected 5 but was 4"`;
 
-exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size(Relationship with more fields) 1`] = `"Wrong struct size for Relationship, expected 5 but was 8"`;
+exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size (Relationship with more fields) 1`] = `"Wrong struct size for Relationship, expected 5 but was 8"`;
 
-exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size(Time with less fields) 1`] = `"Wrong struct size for Time, expected 2 but was 1"`;
+exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size (Time with less fields) 1`] = `"Wrong struct size for Time, expected 2 but was 1"`;
 
-exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size(Time with more fileds) 1`] = `"Wrong struct size for Time, expected 2 but was 3"`;
+exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size (Time with more fileds) 1`] = `"Wrong struct size for Time, expected 2 but was 3"`;
 
-exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size(UnboundRelationship with less fields) 1`] = `"Wrong struct size for UnboundRelationship, expected 3 but was 2"`;
+exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size (UnboundRelationship with less fields) 1`] = `"Wrong struct size for UnboundRelationship, expected 3 but was 2"`;
 
-exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size(UnboundRelationship with more fields) 1`] = `"Wrong struct size for UnboundRelationship, expected 3 but was 4"`;
+exports[`#unit BoltProtocolV2 .unpack() should not unpack with wrong size (UnboundRelationship with more fields) 1`] = `"Wrong struct size for UnboundRelationship, expected 3 but was 4"`;