PreconditionContainerSingle.ts

import { container } from '@sapphire/pieces';
import { err } from '@sapphire/result';
import type { ChatInputCommandInteraction, ContextMenuCommandInteraction, Message } from 'discord.js';
import { Identifiers } from '../../errors/Identifiers';
import { UserError } from '../../errors/UserError';
import type { Precondition, PreconditionContext, PreconditionKeys, Preconditions, SimplePreconditionKeys } from '../../structures/Precondition';
import type { ChatInputCommand, ContextMenuCommand, MessageCommand } from '../../types/CommandTypes';
import type { IPreconditionContainer } from './IPreconditionContainer';

/**
 * Defines the simple options for the {@link PreconditionContainerSingle}, where only the name of the precondition can
 * be defined.
 * @since 2.0.0
 */
export interface SimplePreconditionSingleResolvableDetails {
	/**
	 * The name of the precondition to retrieve from {@link SapphireClient.preconditions}.
	 * @since 2.0.0
	 */
	name: SimplePreconditionKeys;
}

/**
 * Defines the detailed options for the {@link PreconditionContainerSingle}, where both the {@link PreconditionContext} and the
 * name of the precondition can be defined.
 * @since 1.0.0
 */
export interface PreconditionSingleResolvableDetails<K extends PreconditionKeys = PreconditionKeys> {
	/**
	 * The name of the precondition to retrieve from {@link SapphireClient.preconditions}.
	 * @since 1.0.0
	 */
	name: K;

	/**
	 * The context to be set at {@link PreconditionContainerSingle.context}.
	 * @since 1.0.0
	 */
	context: Preconditions[K];
}

/**
 * Defines the data accepted by {@link PreconditionContainerSingle}'s constructor.
 * @since 1.0.0
 */
export type PreconditionSingleResolvable = SimplePreconditionKeys | SimplePreconditionSingleResolvableDetails | PreconditionSingleResolvableDetails;

/**
 * An {@link IPreconditionContainer} which runs a single precondition from {@link SapphireClient.preconditions}.
 * @since 1.0.0
 */
export class PreconditionContainerSingle implements IPreconditionContainer {
	/**
	 * The context to be used when calling {@link Precondition.run}. This will always be an empty object (`{}`) when the
	 * container was constructed with a string, otherwise it is a direct reference to the value from
	 * {@link PreconditionSingleResolvableDetails.context}.
	 * @since 1.0.0
	 */
	public readonly context: Record<PropertyKey, unknown>;

	/**
	 * The name of the precondition to run.
	 * @since 1.0.0
	 */
	public readonly name: string;

	public constructor(data: PreconditionSingleResolvable) {
		if (typeof data === 'string') {
			this.context = {};
			this.name = data;
		} else {
			this.context = Reflect.get(data, 'context') ?? {};
			this.name = data.name;
		}
	}

	/**
	 * Runs the container.
	 * @since 1.0.0
	 * @param message The message that ran this precondition.
	 * @param command The command the message invoked.
	 * @param context  The context for the message precondition.
	 */
	public messageRun(message: Message, command: MessageCommand, context: PreconditionContext = {}) {
		const precondition = container.stores.get('preconditions').get(this.name);
		if (precondition) {
			return precondition.messageRun
				? precondition.messageRun(message, command, { ...context, ...this.context })
				: precondition.error({
						identifier: Identifiers.PreconditionMissingMessageHandler,
						message: `The precondition "${precondition.name}" is missing a "messageRun" handler, but it was requested for the "${command.name}" command.`
					});
		}
		return err(new UserError({ identifier: Identifiers.PreconditionUnavailable, message: `The precondition "${this.name}" is not available.` }));
	}

	/**
	 * Runs the container.
	 * @since 3.0.0
	 * @param interaction The interaction that ran this precondition.
	 * @param command The command the interaction invoked.
	 * @param context  The context for the chat input command precondition.
	 */
	public chatInputRun(interaction: ChatInputCommandInteraction, command: ChatInputCommand, context: PreconditionContext = {}) {
		const precondition = container.stores.get('preconditions').get(this.name);
		if (precondition) {
			return precondition.chatInputRun
				? precondition.chatInputRun(interaction, command, { ...context, ...this.context })
				: precondition.error({
						identifier: Identifiers.PreconditionMissingChatInputHandler,
						message: `The precondition "${precondition.name}" is missing a "chatInputRun" handler, but it was requested for the "${command.name}" command.`
					});
		}
		return err(new UserError({ identifier: Identifiers.PreconditionUnavailable, message: `The precondition "${this.name}" is not available.` }));
	}

	/**
	 * Runs the container.
	 * @since 3.0.0
	 * @param interaction The interaction that ran this precondition.
	 * @param command The command the interaction invoked.
	 * @param context  The context for the context menu command precondition.
	 */
	public contextMenuRun(interaction: ContextMenuCommandInteraction, command: ContextMenuCommand, context: PreconditionContext = {}) {
		const precondition = container.stores.get('preconditions').get(this.name);
		if (precondition) {
			return precondition.contextMenuRun
				? precondition.contextMenuRun(interaction, command, { ...context, ...this.context })
				: precondition.error({
						identifier: Identifiers.PreconditionMissingContextMenuHandler,
						message: `The precondition "${precondition.name}" is missing a "contextMenuRun" handler, but it was requested for the "${command.name}" command.`
					});
		}
		return err(new UserError({ identifier: Identifiers.PreconditionUnavailable, message: `The precondition "${this.name}" is not available.` }));
	}
}