@prismicio/client/src/types/model/group.ts

The official JavaScript + TypeScript client library for Prismic

import type {
	CustomTypeModelFieldForGroup,
	CustomTypeModelFieldForNestedGroup,
	CustomTypeModelFieldType,
} from "./types"

/**
 * A group custom type field.
 *
 * More details: {@link https://prismic.io/docs/group}
 *
 * @typeParam Fields - A record of fields that can be repeated.
 */
export interface CustomTypeModelGroupField<
	Fields extends Record<string, CustomTypeModelFieldForGroup> = Record<
		string,
		CustomTypeModelFieldForGroup
	>,
> {
	type: typeof CustomTypeModelFieldType.Group
	config?: {
		label?: string | null
		fields?: Fields
	}
}

/**
 * A nested group custom type field.
 *
 * More details: {@link https://prismic.io/docs/group}
 *
 * @typeParam Fields - A record of fields that can be repeated.
 */
export type CustomTypeModelNestedGroupField<
	Fields extends Record<string, CustomTypeModelFieldForNestedGroup> = Record<
		string,
		CustomTypeModelFieldForNestedGroup
	>,
> = CustomTypeModelGroupField<Fields>