Merge pull request dynamodb-toolbox#1009 from dynamodb-toolbox/improve-parser-errors-path

improve parser errors path

Author: ThomasAribart

src/schema/actions/format/anyOf.ts

@@ -1,10 +1,10 @@
 import type { AnyOfAttribute, Attribute } from '~/attributes/index.js'
 import { DynamoDBToolboxError } from '~/errors/index.js'
+import { formatValuePath } from '~/schema/actions/utils/formatValuePath.js'
 
 import { attrFormatter } from './attribute.js'
 import type { FormatterReturn, FormatterYield } from './formatter.js'
 import type { FormatAttrValueOptions } from './options.js'
-import { formatValuePath } from './utils.js'
 
 export function* anyOfAttrFormatter(
  attribute: AnyOfAttribute,

src/schema/actions/format/attribute.ts

@@ -1,5 +1,6 @@
 import type { Attribute, RequiredOption } from '~/attributes/index.js'
 import { DynamoDBToolboxError } from '~/errors/index.js'
+import { formatValuePath } from '~/schema/actions/utils/formatValuePath.js'
 
 import { anyAttrFormatter } from './any.js'
 import { anyOfAttrFormatter } from './anyOf.js'
@@ -10,7 +11,6 @@ import type { FormatAttrValueOptions } from './options.js'
 import { primitiveAttrFormatter } from './primitive.js'
 import { recordAttrFormatter } from './record.js'
 import { setAttrFormatter } from './set.js'
-import { formatValuePath } from './utils.js'
 
 export const requiringOptions = new Set<RequiredOption>(['always', 'atLeastOnce'])
 

src/schema/actions/format/list.ts

@@ -1,11 +1,11 @@
 import type { ListAttribute } from '~/attributes/index.js'
 import { DynamoDBToolboxError } from '~/errors/index.js'
+import { formatValuePath } from '~/schema/actions/utils/formatValuePath.js'
 import { isArray } from '~/utils/validation/isArray.js'
 
 import { attrFormatter } from './attribute.js'
 import type { FormatterReturn, FormatterYield } from './formatter.js'
 import type { FormatAttrValueOptions } from './options.js'
-import { formatValuePath } from './utils.js'
 import { matchProjection } from './utils.js'
 
 export function* listAttrFormatter(

src/schema/actions/format/map.ts

@@ -1,11 +1,11 @@
 import type { MapAttribute } from '~/attributes/index.js'
 import { DynamoDBToolboxError } from '~/errors/index.js'
+import { formatValuePath } from '~/schema/actions/utils/formatValuePath.js'
 import { isObject } from '~/utils/validation/isObject.js'
 
 import { attrFormatter } from './attribute.js'
 import type { FormatterReturn, FormatterYield } from './formatter.js'
 import type { FormatAttrValueOptions } from './options.js'
-import { formatValuePath } from './utils.js'
 import { matchProjection, sanitize } from './utils.js'
 
 export function* mapAttrFormatter(

src/schema/actions/format/primitive.ts

@@ -1,11 +1,11 @@
 import type { PrimitiveAttribute } from '~/attributes/index.js'
 import { DynamoDBToolboxError } from '~/errors/index.js'
+import { formatValuePath } from '~/schema/actions/utils/formatValuePath.js'
 import type { Transformer } from '~/transformers/index.js'
 import { isValidPrimitive } from '~/utils/validation/isValidPrimitive.js'
 
 import type { FormatterReturn, FormatterYield } from './formatter.js'
 import type { FormatAttrValueOptions } from './options.js'
-import { formatValuePath } from './utils.js'
 
 export function* primitiveAttrFormatter(
  attribute: PrimitiveAttribute,

src/schema/actions/format/record.ts

@@ -1,11 +1,11 @@
 import type { RecordAttribute } from '~/attributes/index.js'
 import { DynamoDBToolboxError } from '~/errors/index.js'
+import { formatValuePath } from '~/schema/actions/utils/formatValuePath.js'
 import { isObject } from '~/utils/validation/isObject.js'
 
 import { attrFormatter } from './attribute.js'
 import { Formatter, type FormatterReturn, type FormatterYield } from './formatter.js'
 import type { FormatAttrValueOptions } from './options.js'
-import { formatValuePath } from './utils.js'
 import { matchProjection, sanitize } from './utils.js'
 
 export function* recordAttrFormatter(

src/schema/actions/format/set.ts

@@ -1,11 +1,11 @@
 import type { SetAttribute } from '~/attributes/index.js'
 import { DynamoDBToolboxError } from '~/errors/index.js'
+import { formatValuePath } from '~/schema/actions/utils/formatValuePath.js'
 import { isSet } from '~/utils/validation/isSet.js'
 
 import { attrFormatter } from './attribute.js'
 import type { FormatterReturn, FormatterYield } from './formatter.js'
 import type { FormatAttrValueOptions } from './options.js'
-import { formatValuePath } from './utils.js'
 
 export function* setAttrFormatter(
  attribute: SetAttribute,

src/schema/actions/format/utils.ts

@@ -1,7 +1,3 @@
-import type { CharsToEscape } from '~/schema/types/paths.js'
-import { isNumber } from '~/utils/validation/isNumber.js'
-import { isString } from '~/utils/validation/isString.js'
-
 export const sanitize = (str: string): string =>
  str.replace(/\\/g, '\\\\').replace(/[-[\]/{}()*+?.^$|]/g, '\\$&')
 
@@ -37,35 +33,3 @@ export const matchProjection = (
 
  return { isProjected: true, childrenAttributes }
 }
-
-const charsToEscape: CharsToEscape[] = ['[', ']', '.']
-export const formatValuePath = (valuePath: (string | number)[] | undefined): string | undefined => {
- if (valuePath === undefined || valuePath.length === 0) {
- return undefined
- }
-
- let path = ''
- let isRoot = true
-
- for (const valuePathPart of valuePath) {
- if (isString(valuePathPart)) {
- const shouldBeEscaped = charsToEscape.some(charToEscape =>
- valuePathPart.includes(charToEscape)
- )
-
- if (shouldBeEscaped) {
- path += `['${valuePathPart}']`
- } else {
- path += `${isRoot ? '' : '.'}${valuePathPart}`
- }
- }
-
- if (isNumber(valuePathPart)) {
- path += `[${valuePathPart}]`
- }
-
- isRoot = false
- }
-
- return path
-}

src/schema/actions/format/utils.unit.test.ts

@@ -1,4 +1,4 @@
-import { formatValuePath, matchProjection, sanitize } from './utils.js'
+import { matchProjection, sanitize } from './utils.js'
 
 describe('sanitizes', () => {
  test('sanitizes str with special chars', () => {
@@ -64,14 +64,3 @@ describe('matchProjection', () => {
  })
  })
 })
-
-describe('formatValuePath', () => {
- test('it correctly formats simple paths', () => {
- expect(formatValuePath(['foo', 'bar'])).toStrictEqual('foo.bar')
- expect(formatValuePath(['foo', 1, 2, 'bar'])).toStrictEqual('foo[1][2].bar')
- })
-
- test('it correctly formats complex paths', () => {
- expect(formatValuePath(['f.oo', 'ba[r', 'ba]z'])).toStrictEqual(`['f.oo']['ba[r']['ba]z']`)
- })
-})

src/schema/actions/parse/any.ts

@@ -1,11 +1,11 @@
 import type { AnyAttribute } from '~/attributes/index.js'
 import { cloneDeep } from '~/utils/cloneDeep.js'
 
-import type { ParseValueOptions } from './options.js'
+import type { ParseAttrValueOptions } from './options.js'
 import type { ParserReturn, ParserYield } from './parser.js'
 import { applyCustomValidation } from './utils.js'
 
-export function* anyAttrParser<OPTIONS extends ParseValueOptions = {}>(
+export function* anyAttrParser<OPTIONS extends ParseAttrValueOptions = {}>(
  attribute: AnyAttribute,
  inputValue: unknown,
  options: OPTIONS = {} as OPTIONS