Function objectDef

src/lib/item-input/object.ts:119–241

(name: string, inputDefsByProperty: InputDefsByProperty<T>,
		options?: ObjectDefOptions<T>)

 *   Calling `updateIfNeeded` on rolled up properties is not yet implemented.
 */
export function objectDef<T extends object>(name: string, inputDefsByProperty: InputDefsByProperty<T>,
		options?: ObjectDefOptions<T>): InputDefinition<T> {
	const buildFromUserInput = async (context: unknown[] = []): Promise<T | CancelAction> => {
		// Since we're just going to run through all the options and ask for their value, we don't
		// have a menu or any place to put help for the whole object so we'll just display it
		// before asking the questions.
		if (options?.helpText) {
			console.log(`\n${options.helpText}\n`)
		}
		const retVal = {} as Partial<T>
		for (const propertyName in inputDefsByProperty) {
			const propertyInputDefinition = inputDefsByProperty[propertyName]
			// Allow `undefined` definitions, but do nothing with them. This allows callers of
			// `objectDef` to have a field skipped by setting it to `undefined` as well as by leaving
			// it out.
			if (!propertyInputDefinition) {
				continue
			}
			const value = await propertyInputDefinition.buildFromUserInput([{ ...retVal }, ...context])
			if (value !== cancelAction) {
				retVal[propertyName] = value
			} else {
				return cancelAction
			}
		}
		return retVal as T
	}

	const summarizeForEdit = options?.summarizeForEdit ?? defaultSummarizeForEditFn(name)

	const updateFromUserInput = async (original: T, context: unknown[] = []): Promise<T | CancelAction> => {
		const updated = { ...original }
		// eslint-disable-next-line no-constant-condition
		while (true) {
			const contextForChildren = [{ ...updated }, ...context]
			const choices = buildPropertyChoices(inputDefsByProperty, updated, contextForChildren)
			choices.push(new Separator())
			if (options?.helpText) {
				choices.push(helpOption)
			}
			choices.push(finishOption(name))
			choices.push(cancelOption)

			const action = await select({ message: name, choices, default: finishAction, pageSize: inquirerPageSize })

			if (action === helpAction) {
				console.log(`\n${options?.helpText}\n`)
			} else if (action === cancelAction) {
				return cancelAction
			} else if (action === finishAction) {
				return updated
			} else {
				const props = action.split('.')

				const updatedPropertyName = props[0] as keyof T
				const propertyInputDefinition = inputDefsByProperty[updatedPropertyName]
				if (props.length === 1) {
					// top-level property