sanity-plugin-internationalized-array/src/utils/flattenSchemaType.ts

Store localized fields in an array to save on attributes

import {
  isDocumentSchemaType,
  type ObjectField,
  type Path,
  type SchemaType,
} from 'sanity'

type ObjectFieldWithPath = ObjectField<SchemaType> & {path: Path}

/**
 * Flattens a document's schema type into a flat array of fields and includes their path
 */
export function flattenSchemaType(
  schemaType: SchemaType
): ObjectFieldWithPath[] {
  if (!isDocumentSchemaType(schemaType)) {
    console.error(`Schema type is not a document`)
    return []
  }

  return extractInnerFields(schemaType.fields, [], 3)
}

function extractInnerFields(
  fields: ObjectField<SchemaType>[],
  path: Path,
  maxDepth: number
): ObjectFieldWithPath[] {
  if (path.length >= maxDepth) {
    return []
  }

  return fields.reduce<ObjectFieldWithPath[]>((acc, field) => {
    const thisFieldWithPath = {path: [...path, field.name], ...field}

    if (field.type.jsonType === 'object') {
      const innerFields = extractInnerFields(
        field.type.fields,
        [...path, field.name],
        maxDepth
      )

      return [...acc, thisFieldWithPath, ...innerFields]
    } else if (
      field.type.jsonType === 'array' &&
      field.type.of.length &&
      field.type.of.some((item) => 'fields' in item)
    ) {
      const innerFields = field.type.of.flatMap((innerField) =>
        extractInnerFields(
          // @ts-expect-error - Fix TS assertion for array fields
          innerField.fields,
          [...path, field.name],
          maxDepth
        )
      )

      return [...acc, thisFieldWithPath, ...innerFields]
    }

    return [...acc, thisFieldWithPath]
  }, [])
}