wip: first draft

Author: Julusian

packages/companion-module-base/src/module-api/preset.ts

@@ -4,24 +4,47 @@ import type { CompanionButtonStyleProps } from './style.js'
 import type { JsonValue } from '../common/json-value.js'
 
 // Future: Additional types will be added, as part of the graphics overhaul
-export type CompanionPresetDefinition = CompanionSimplePresetDefinition // | CompanionSimplePresetMatrix
+export type CompanionPresetDefinition = CompanionSimplePresetDefinition
 
-// nocommit - is this needed?
-// /**
-//  * The definition of a text preset
-//  */
-// export interface CompanionTextPresetDefinition {
-// 	/** The type of this preset */
-// 	type: 'text'
-// 	/** The category of this preset, for grouping */
-// 	category: string
-// 	/** The name of this preset */
-// 	name: string
-// 	/** The text to display */
-// 	text: string
-// }
+export type CompanionPresetGroup = CompanionPresetGroupCustom // | CompanionSimplePresetMatrix
 
-export interface CompanionPresetDefinitionBase<TType> {
+export interface CompanionPresetGroupBase<TType extends string> {
+	/**
+	 * Unique identifier for the preset
+	 * This should be stable across updates to the presets
+	 */
+	id: string
+
+	/**
+	 * The type of the preset group
+	 */
+	type: TType
+
+	/**
+	 * A name for this preset group
+	 */
+	name: string
+
+	/**
+	 * A description of the preset group
+	 */
+	description?: string
+
+	/**
+	 * Tags for the group
+	 * This allows for the UI to group and filter in different ways
+	 */
+	tags?: string[]
+}
+
+export interface CompanionPresetGroupCustom extends CompanionPresetGroupBase<'custom'> {
+	/**
+	 * The presets which are part of this group
+	 */
+	presets: CompanionPresetDefinition[]
+}
+
+export interface CompanionPresetDefinitionBase<TType extends string> {
 	/**
 	 * Unique identifier for the preset
 	 * This should be stable across updates to the presets
@@ -71,7 +94,8 @@ export interface CompanionSimplePresetDefinition extends CompanionPresetDefiniti
 //  * A preset which generates a series of buttons from a matrix of values
 //  * Tip: This allows you to avoid generating repetetive presets which vary just by a few simple values
 //  */
-// export interface CompanionSimplePresetMatrix extends CompanionSimplePresetDefinition {
+// export interface CompanionPresetGroupMatrix {
+//   definition: CompanionPresetDefinition
 // 	/**
 // 	 * The matrix of values to generate
 // 	 * This will inject values into the local variables you have defined
@@ -123,7 +147,10 @@ export interface CompanionPresetSection {
 	 */
 	description?: string
 
-	presets: CompanionPresetDefinition[]
+	/**
+	 * The definitions of presets or groups in this category
+	 */
+	definitions: CompanionPresetGroup[] | CompanionPresetDefinition[]
 
 	/**
 	 * Tags for the category