sanity/src/structure/structureBuilder/util/validateId.ts

Sanity is a real-time content infrastructure with a scalable, hosted backend featuring a Graph Oriented Query Language (GROQ), asset pipelines and fast edge caches

import {SerializeError} from '../SerializeError'
import {type SerializePath} from '../StructureNodes'

export const disallowedPattern = /([^A-Za-z0-9-_.])/

export function validateId(
  id: string,
  parentPath: SerializePath,
  pathSegment: string | number | undefined,
): string {
  if (typeof id !== 'string') {
    throw new SerializeError(
      `Structure node id must be of type string, got ${typeof id}`,
      parentPath,
      pathSegment,
    )
  }

  const [disallowedChar] = id.match(disallowedPattern) || []
  if (disallowedChar) {
    throw new SerializeError(
      `Structure node id cannot contain character "${disallowedChar}"`,
      parentPath,
      pathSegment,
    )
  }

  if (id.startsWith('__edit__')) {
    throw new SerializeError(
      `Structure node id cannot start with __edit__`,
      parentPath,
      pathSegment,
    )
  }

  return id
}