More bulletproof, intuitive options format

[osdiab]

The options format as is is pretty brittle, with a lot of stuff failing if you don't specify them just right. For example, levels need to be duplicated in multiple places, changing behavior in the i18n blob, and specifying incorrectly can lead to confusing behavior and crashing, when one would assume an i18n blob would be totally optional and only impact display.

With a major version bump let's make a cleaner, less failure-prone options format that better allows for partial inclusion of options and avoid contradictory settings. Using TypeScript will also help us make sure that we don't blow things up unexpectedly. #11

[osdiab]

we should do this before a lot of people start using the donate button, or else it will be hard to move

[osdiab]

This is the current interface, as I typed out based on the actual usage on site, taken from options-types.ts:

export enum LayoutMode {
	SINGLE = 'SINGLE',
	SPLIT = 'SPLIT'
}
export type DonationFrequency = 'ONCE' | 'MONTHLY';
export interface DonationLevel {
	amount: string;
	bgColor?: string;
	default?: boolean;
	img?: string;
	classes?: readonly string[];
}

/**
 * Donation level as expected in the i18n object
 * TODO: don't duplicate info from DonationLevel
 */
export interface I18NDonationLevel {
	amount: string;
	name?: string;
	description1?: string;
	description2?: string;
}

export type OnSubmitFunction = (parameters: {
	amount: string;
	frequency: DonationFrequency;
}) => void;
export interface OnSubmitObject {
	readonly charity: string;
	readonly params?: {
		readonly share_info?: 0 | 1;
		readonly no_exit?: 0 | 1;
	};
}
export type OnSubmit = OnSubmitFunction | OnSubmitObject;

export interface MonthlyOptions {
	readonly levels: readonly DonationLevel[];
}
export interface OneTimeOptions {
	readonly img?: string;
	readonly levels: number[];
	readonly allowCustom: boolean;
	readonly bgColor?: string;
}
export interface I18NFrequencyOptions {
	readonly logo: {
		readonly header: string;
		readonly text: string;
		readonly link: string;
	};
	readonly name?: string;
	readonly description?: string;
	readonly header: string;
	readonly info: string;
	readonly levels?: readonly I18NDonationLevel[];
	readonly custom: {
		readonly label?: string;
		readonly placeholder: string;
	};
	readonly button: string;
	readonly switch: string;
}
export interface I18NOptions {
	readonly company: {
		readonly logo: string;
		readonly name: string;
		readonly location: string;
	};
	readonly monthly: I18NFrequencyOptions;
	readonly oneTime: I18NFrequencyOptions;
	readonly footer: string;
}
export enum DefaultFrequency {
	MONTHLY = 'monthly',
	ONE_TIME = 'one-time'
}
export interface DonateButtonOptions {
	readonly monthly: MonthlyOptions;
	readonly oneTime: OneTimeOptions;
	readonly onSubmit: OnSubmit;
	readonly defaultMode: DefaultFrequency;
	readonly currency: string;
	readonly mode: LayoutMode;
	readonly show: boolean;
	readonly i18n: Partial<Record<string, I18NOptions>>;
	readonly language: string;
}

[osdiab]

I'm going to work on this now, by making a beta version of the donate button package to allow for sweeping breaking changes under a new version number, in order to expedite getting a simplified button out that directs people to specifically do crypto donations.