traverseDocument()

traverseDocument(what: Record<string, unknown>, description: Description, options: TraverseOptions) => Promise<Result.Either<ACErrors | ValidationError, {}>>

This function iterates all the properties of a document recursively performing the specified set of operations on each step. If any of the steps returns a Error<T>, then the function returns it immediately, otherwise returns a Result<T> containing the mutated copy of the object.

type TraverseOptions = {
  autoCast?: boolean
  getters?: boolean
  validate?: boolean
  validateRequired?: string[]
  fromProperties?: boolean
  allowOperators?: boolean
  recurseReferences?: boolean
}

Examples

The example below will take the plain rawPayload object and convert the user.$in[0] from a string to a ObjectId, since traverseDocument() will detect that $in is a MongoDB operator (because it is prefixed with a dollar sign). Note that autoCast is combined with allowOperators.

const rawPayload = {
  user: {
    $in: [
      '653c3d448a707ef3d327f624'
    ]
  }
}

const filters = await traverseDocument(rawPayload, context.description, {
  autoCast: true,
  allowOperators: true,
})

assert(filters._id.$in[0] instanceof ObjectId)

Options

• autoCast: Will automatically cast a value into it's expected type according to it's description property, throwing on error. Strings can be casted into ObjectId objects while Javascript date strings and timestamps can be casted into Date objects.
• getters: Will fulfill document with its computed properties, applying the s$getter callback to each one.
• validate: Will fulfill document with its computed properties, applying the s$getter callback to each one.
• validateRequired: When validate is set to true, will consider this array of property names when validating document wholeness.
• fromProperties: If set to true, will consider Description properties instead of document key and values.
• allowOperators: If set to true, will recurse deeper into object properties believed to contain MongoDB operators ($in, $eq, etc). Otherwhise will omit these properties from the returned object.
• recurseReferences: This flags commands whether or not $ref properties should be recursed into.