instance_skel_types.d.ts

/// <reference types="node" />
import { EventEmitter } from 'events'

export interface CompanionSystem extends EventEmitter {}

export type InputValue = number | string | boolean | Array<string | number>

export type CompanionBank = CompanionBankPage | CompanionBankPNG | CompanionBankPreset

export interface CompanionBankPage {
	style: 'pageup' | 'pagedown' | 'pagenum'
}

export type CompanionAlignment =
	| 'left:top'
	| 'center:top'
	| 'right:top'
	| 'left:center'
	| 'center:center'
	| 'right:center'
	| 'left:bottom'
	| 'center:bottom'
	| 'right:bottom'

export type CompanionTextSize = 'auto' | '7' | '14' | '18' | '24' | '30' | '44'

export interface CompanionBankRequiredProps {
	text: string
	size: CompanionTextSize
	color: number
	bgcolor: number
}
export interface CompanionBankAdditionalStyleProps {
	alignment: CompanionAlignment
	pngalignment: CompanionAlignment
	png64?: string
}
export interface CompanionBankAdditionalCoreProps {
	latch: boolean
	relative_delay: boolean
}

export interface CompanionBankPNG
	extends CompanionBankRequiredProps,
		CompanionBankAdditionalStyleProps,
		CompanionBankAdditionalCoreProps {
	style: 'png'
}

export interface CompanionBankPreset
	extends CompanionBankRequiredProps,
		Partial<CompanionBankAdditionalStyleProps>,
		Partial<CompanionBankAdditionalCoreProps> {
	style: 'png' | 'text' // 'text' for backwards compatability
}

export interface CompanionOptionValues {
	[key: string]: InputValue | undefined
}

export interface CompanionAction {
	label: string
	description?: string
	options: SomeCompanionInputField[]
	callback?: (action: CompanionActionEvent, info: CompanionActionEventInfo | null) => void
	subscribe?: (action: CompanionActionEvent) => void
	unsubscribe?: (action: CompanionActionEvent) => void

	/**
	 * The user requested to 'learn' the values for this action.
	 */
	learn?: (
		action: CompanionActionEvent
	) => CompanionOptionValues | undefined | Promise<CompanionOptionValues | undefined>
}
export interface CompanionActionEvent {
	id: string
	action: string
	options: CompanionOptionValues
}

export interface CompanionActionEventInfo {
	deviceId: string | undefined
	page: number
	bank: number
}

export interface CompanionFeedbackEventInfo {
	page: number
	bank: number
	width: number
	height: number
}

export interface CompanionFeedbackEvent {
	id: string
	type: string
	options: CompanionOptionValues
}
export interface CompanionFeedbackResult {
	color?: number
	bgcolor?: number
}

export type ConfigValue = string | number
export interface DropdownChoice {
	id: ConfigValue
	label: string
}

export type SomeCompanionInputField =
	| CompanionInputFieldText
	| CompanionInputFieldColor
	| CompanionInputFieldTextInput
	| CompanionInputFieldTextWithVariablesInput
	| CompanionInputFieldDropdown
	| CompanionInputFieldMultiDropdown
	| CompanionInputFieldNumber
	| CompanionInputFieldCheckbox
export interface CompanionInputField {
	id: string
	type: 'text' | 'textinput' | 'textwithvariables' | 'dropdown' | 'colorpicker' | 'number' | 'checkbox'
	label: string
	tooltip?: string
	isVisible?: (options: any /*CompanionActionEvent | CompanionFeedbackEvent*/) => boolean // TODO - this varies based on where it is used, and in this current structure is not possible to type without breaking every module
}
export interface CompanionInputFieldText extends CompanionInputField {
	type: 'text'
	value: string
}
export interface CompanionInputFieldColor extends CompanionInputField {
	type: 'colorpicker'
	default: number
}
export interface CompanionInputFieldTextInput extends CompanionInputField {
	type: 'textinput'
	regex?: string
	default?: string
	required?: boolean
}
export interface CompanionInputFieldTextWithVariablesInput extends CompanionInputField {
	type: 'textwithvariables'
	default?: string
}
export interface CompanionInputFieldDropdown extends CompanionInputFieldDropdownBase {
	multiple?: false
	default: ConfigValue

	/** Allow custom values to be defined */
	allowCustom?: boolean
	/** Check custom value against refex */
	regex?: string
}
export interface CompanionInputFieldMultiDropdown extends CompanionInputFieldDropdownBase {
	multiple: true
	default: ConfigValue[]

	required?: boolean

	/** The minimum number of selected values */
	minSelection?: number
	/** The maximum number of selected values */
	maxSelection?: number
}
export interface CompanionInputFieldDropdownBase extends CompanionInputField {
	type: 'dropdown'
	// default: ConfigValue
	choices: DropdownChoice[]

	multiple?: boolean

	/** The minimum number of entries the dropdown must have before it allows searching */
	minChoicesForSearch?: number
}
export interface CompanionInputFieldCheckbox extends CompanionInputField {
	type: 'checkbox'
	default: boolean
}
export interface CompanionInputFieldNumber extends CompanionInputField {
	type: 'number'
	min: number
	max: number
	step?: number
	range?: boolean
	required?: boolean
	default: number
}

export interface CompanionConfigField extends CompanionInputField {
	width: number
}
export type SomeCompanionConfigField = SomeCompanionInputField & CompanionConfigField

export interface CompanionVariable {
	label: string
	name: string
}

export interface CompanionFeedbackBase<TRes> {
	type?: 'boolean' | 'advanced'
	label: string
	description?: string
	options: SomeCompanionInputField[]
	callback?: (
		feedback: CompanionFeedbackEvent,
		bank: CompanionBankPNG | null,
		info: CompanionFeedbackEventInfo | null
	) => TRes
	subscribe?: (feedback: CompanionFeedbackEvent) => void
	unsubscribe?: (feedback: CompanionFeedbackEvent) => void

	/**
	 * The user requested to 'learn' the values for this feedback.
	 */
	learn?: (
		feedback: CompanionFeedbackEvent
	) => CompanionOptionValues | undefined | Promise<CompanionOptionValues | undefined>
}
export interface CompanionFeedbackBoolean extends CompanionFeedbackBase<boolean> {
	type: 'boolean'
	style: Partial<CompanionBankRequiredProps & CompanionBankAdditionalStyleProps>
}
export interface CompanionFeedbackAdvanced extends CompanionFeedbackBase<CompanionFeedbackResult> {
	type?: 'advanced'
}
export type CompanionFeedback = CompanionFeedbackBoolean | CompanionFeedbackAdvanced

export interface CompanionPreset {
	category: string
	label: string
	bank: CompanionBankPreset
	feedbacks: Array<{
		type: string
		options: CompanionOptionValues
		style?: Partial<CompanionBankRequiredProps & CompanionBankAdditionalStyleProps>
	}>
	actions: Array<{
		action: string
		options: CompanionOptionValues
	}>
	release_actions?: Array<{
		action: string
		options: CompanionOptionValues
	}>
}

export interface CompanionFeedbacks {
	[id: string]: CompanionFeedback | undefined
}
export interface CompanionActions {
	[id: string]: CompanionAction | undefined
}

export interface CompanionUpgradeContext {
	/** Translate a key index from the old 15 key layout (5x3 grid) to the 32 key layout (8x4 grid) */
	convert15to32(key: number): number
	rgb(red: number, green: number, blue: number): number
	rgbRev(color: number): { r: number; g: number; b: number }
}

export type CompanionStaticUpgradeScript = (
	context: CompanionUpgradeContext,
	config: CompanionCoreInstanceconfig & Record<string, any>,
	affected_actions: CompanionMigrationAction[],
	affected_feedbacks: CompanionMigrationFeedback[]
) => boolean

export interface CompanionUpgradeToBooleanFeedbackMap {
	[feedback_id: string]:
		| true
		| {
				// Option name to style property
				[option_key: string]: 'text' | 'size' | 'color' | 'bgcolor' | 'alignment' | 'pngalignment' | 'png64'
		  }
		| undefined
}

export interface CompanionCoreInstanceconfig {
	instance_type: string
	label: string
}

export interface CompanionMigrationAction {
	readonly id: string
	readonly instance: string
	label: string
	action: string
	options: CompanionOptionValues
}

export interface CompanionMigrationFeedback {
	readonly id: string
	readonly instance_id: string
	type: string
	options: CompanionOptionValues
}

export type OSCArgument = number | string | Uint8Array
export type OSCMetaArgument =
	| { type: 'i' | 'f'; value: number }
	| { type: 's'; value: string }
	| { type: 'b'; value: Uint8Array }
export type OSCSomeArguments = OSCArgument | Array<OSCArgument> | OSCMetaArgument | Array<OSCMetaArgument>

export interface CompanionInstanceHTTPRequest {
	baseUrl: string
	body?: string
	headers: Record<string, string>
	hostname: string
	ip: string
	method: string
	originalUrl: string
	path: string
	query: Record<string, string>
}

export interface CompanionInstanceHTTPResponse {
	status?: number
	headers?: Record<string, any>
	body?: string
}