@lumiastream/lumia-types 3.3.7-alpha.6 → 3.3.7-alpha.7

package/dist/custom-overlays/custom-overlays-cheatsheet.md

@@ -87,7 +87,7 @@ Include these two helper aliases in your embeddings so the model can quickly map
 			"required": ["type", "label"],
 			"properties": {
 				"type": {
-					"enum": ["input", "number", "checkbox", "dropdown", "multiselect", "colorpicker", "fontpicker", "slider"]
+					"enum": ["input", "textarea", "number", "checkbox", "dropdown", "multiselect", "colorpicker", "fontpicker", "slider", "imageupload", "soundupload", "videoupload", "actionbutton"]
 				},
 				"label": { "type": "string" },
 				"value": {},

package/dist/custom-overlays/custom-overlays-documentation.md

@@ -394,7 +394,7 @@ A field object can now contain these properties:
 
 | Property        | Required | Purpose                                                                                                                                                                                                                                                                                            | Example                                                           |
 | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
-| **`type`**      | ✅       | UI control to render. Must be one of the `FieldType` enum values (`input`, `number`, `checkbox`, `dropdown`, `multiselect`, `colorpicker`, `fontpicker`, `slider`).                                                                                                                                | `"type": "dropdown"`                                              |
+| **`type`**      | ✅       | UI control to render. Must be one of the `FieldType` enum values (`input`, `textarea`, `number`, `checkbox`, `dropdown`, `multiselect`, `colorpicker`, `fontpicker`, `slider`, `imageupload`, `soundupload`, `videoupload`, `actionbutton`).                                                       | `"type": "dropdown"`                                              |
 | **`label`**     | ✅       | Human-readable name shown in the sidebar.                                                                                                                                                                                                                                                          | `"label": "Favorite Color:"`                                      |
 | **`value`**     | ❌       | Default value that appears the first time the user opens the overlay (also pre populates `Overlay.data`). Omit it to leave the field blank/unchecked on first load.                                                                                                                                | `"value": 18`                                                     |
 | **`options`**   | ☑️\*     | Key value map of selectable choices. Required **only** for `dropdown`, `multiselect` and `slider`; ignored for other types. For `slider`, `options` supports `step`, `min`, `max`, `prefix`, `suffix`.                                                                                             | `"options": { "step": 5, "min": 0, "max": 100 }`                  |

package/dist/custom-overlays/custom-overlays.d.ts

@@ -25,9 +25,10 @@ export enum CustomTabs {
 export enum ConfigsFieldType {
 	/** Text input field */
 	INPUT = 'input',
+	/** Multi-line text area for long-form content. */
+	TEXTAREA = 'textarea',
 	/** Numeric input field */
 	NUMBER = 'number',
-	// IMAGE = 'image',
 	/** Boolean checkbox */
 	CHECKBOX = 'checkbox',
 	/** Single-select dropdown menu */
@@ -40,6 +41,15 @@ export enum ConfigsFieldType {
 	FONTPICKER = 'fontpicker',
 	/** Number Slider widget */
 	SLIDER = 'slider',
+	/** Image upload picker. Value is the uploaded asset URL. */
+	IMAGEUPLOAD = 'imageupload',
+	/** Audio upload picker. Value is the uploaded asset URL. */
+	SOUNDUPLOAD = 'soundupload',
+	/** Video upload picker. Value is the uploaded asset URL. */
+	VIDEOUPLOAD = 'videoupload',
+	/** Action trigger button. No persisted value; renders a clickable
+	 *  control that custom JS can bind to via `Overlay.on('configAction', …)`. */
+	ACTIONBUTTON = 'actionbutton',
 }
 
 /**
@@ -169,6 +179,65 @@ export interface SliderConfigField extends BaseConfigField {
 	options: SliderOptions;
 }
 
+/** Multi-line textarea for long-form text input. Supports variables. */
+export interface TextareaConfigField extends BaseConfigField {
+	type: ConfigsFieldType.TEXTAREA | 'textarea';
+	/** Default text value. Omit to leave blank on first load. */
+	value?: string;
+	/** Placeholder text shown when the textarea is empty. */
+	placeholder?: string;
+	/** Visible row count for the textarea. Defaults to 4 in the renderer. */
+	rows?: number;
+	/**
+	 * When `true`, renders a variable-enabled textarea. Users can insert Lumia
+	 * variables (e.g. `{{username}}`) via a picker triggered by a `{}` adornment.
+	 */
+	enableVariables?: boolean;
+	/**
+	 * Curated variable list to surface at the top of the picker. Has no effect
+	 * unless `enableVariables` is also `true`.
+	 */
+	allowedVariables?: string[];
+}
+
+/** Image upload picker. Value is the uploaded asset's URL. */
+export interface ImageuploadConfigField extends BaseConfigField {
+	type: ConfigsFieldType.IMAGEUPLOAD | 'imageupload';
+	/** Default image URL. */
+	value?: string;
+	/** Optional comma-separated accept hint, e.g. `image/png,image/jpeg`. */
+	accept?: string;
+}
+
+/** Audio clip upload picker. Value is the uploaded asset's URL. */
+export interface SounduploadConfigField extends BaseConfigField {
+	type: ConfigsFieldType.SOUNDUPLOAD | 'soundupload';
+	/** Default audio URL. */
+	value?: string;
+	/** Optional comma-separated accept hint, e.g. `audio/mpeg,audio/ogg`. */
+	accept?: string;
+}
+
+/** Video upload picker. Value is the uploaded asset's URL. */
+export interface VideouploadConfigField extends BaseConfigField {
+	type: ConfigsFieldType.VIDEOUPLOAD | 'videoupload';
+	/** Default video URL. */
+	value?: string;
+	/** Optional comma-separated accept hint, e.g. `video/mp4,video/webm`. */
+	accept?: string;
+}
+
+/**
+ * Action trigger button. The control surface is a labelled button; clicking it
+ * dispatches an event the overlay's custom JS can subscribe to via
+ * `Overlay.on('configAction', ({ key }) => …)`. No persisted value.
+ */
+export interface ActionbuttonConfigField extends BaseConfigField {
+	type: ConfigsFieldType.ACTIONBUTTON | 'actionbutton';
+	/** Optional button-text override. Defaults to the field `label`. */
+	buttonLabel?: string;
+}
+
 /**
  * Discriminated union of every config-field shape the renderer accepts.
  * Use this when typing the `configs` map for a Lumia custom overlay.
@@ -186,13 +255,18 @@ export interface SliderConfigField extends BaseConfigField {
  */
 export type ConfigField =
 	| InputConfigField
+	| TextareaConfigField
 	| NumberConfigField
 	| CheckboxConfigField
 	| DropdownConfigField
 	| MultiselectConfigField
 	| ColorpickerConfigField
 	| FontpickerConfigField
-	| SliderConfigField;
+	| SliderConfigField
+	| ImageuploadConfigField
+	| SounduploadConfigField
+	| VideouploadConfigField
+	| ActionbuttonConfigField;
 
 /**
  * The configs map a custom overlay declares in its Configs tab.

package/dist/custom-overlays/gpt-instructions.md

@@ -35,7 +35,7 @@ Source of truth (in order): this file > `gpt-instructions-extended.md` (long-for
 - **HTML**: body content only. Stable IDs/classes. No inline `<script>` or `<style>`.
 - **CSS**: stylesheet only. Unquoted CSS variables for colors/sizes/numbers. Quoted only where CSS requires a string (`font-family: "{{font}}";`).
 - **JS**: top-level JS. Use `Overlay.data` for Data values. Use `textContent`/`createElement`/`appendChild` for any chat, alert, or user-generated text — never `innerHTML` with user input. `fetch` is allowed.
-- **Configs**: field types: `input`, `number`, `checkbox`, `dropdown`, `multiselect`, `colorpicker`, `fontpicker`, `slider`. Required: `type`, `label`. Use `value` for defaults. `dropdown`/`multiselect` need `options`. `slider` needs `options.min`/`max` (usually `step`/`prefix`/`suffix`). Use `order` to control sidebar order. Use `visibleIf` for conditional fields. Keys must be machine-friendly (no spaces).
+- **Configs**: field types: `input`, `textarea`, `number`, `checkbox`, `dropdown`, `multiselect`, `colorpicker`, `fontpicker`, `slider`, `imageupload`, `soundupload`, `videoupload`, `actionbutton`. Required: `type`, `label`. Use `value` for defaults. `dropdown`/`multiselect` need `options`. `slider` needs `options.min`/`max` (usually `step`/`prefix`/`suffix`). `imageupload`/`soundupload`/`videoupload` accept an `accept` MIME hint. `actionbutton` has no `value` — bind it via `Overlay.on('configAction', ({ key }) => …)`. Use `order` to control sidebar order. Use `visibleIf` for conditional fields. Keys must be machine-friendly (no spaces).
 - **Data**: every Configs key must have a matching Data key with a matching default. Data can hold internal values that aren't in Configs (rare).
 
 ## Variables

package/dist/custom-overlays.d.js

@@ -10,6 +10,7 @@ exports.CustomTabs = {
 };
 exports.ConfigsFieldType = {
 	INPUT: "input",
+	TEXTAREA: "textarea",
 	NUMBER: "number",
 	CHECKBOX: "checkbox",
 	DROPDOWN: "dropdown",
@@ -17,4 +18,8 @@ exports.ConfigsFieldType = {
 	COLORPICKER: "colorpicker",
 	FONTPICKER: "fontpicker",
 	SLIDER: "slider",
+	IMAGEUPLOAD: "imageupload",
+	SOUNDUPLOAD: "soundupload",
+	VIDEOUPLOAD: "videoupload",
+	ACTIONBUTTON: "actionbutton",
 };

package/dist/custom-overlays.d.ts

@@ -25,9 +25,10 @@ export enum CustomTabs {
 export enum ConfigsFieldType {
 	/** Text input field */
 	INPUT = 'input',
+	/** Multi-line text area for long-form content. */
+	TEXTAREA = 'textarea',
 	/** Numeric input field */
 	NUMBER = 'number',
-	// IMAGE = 'image',
 	/** Boolean checkbox */
 	CHECKBOX = 'checkbox',
 	/** Single-select dropdown menu */
@@ -40,6 +41,15 @@ export enum ConfigsFieldType {
 	FONTPICKER = 'fontpicker',
 	/** Number Slider widget */
 	SLIDER = 'slider',
+	/** Image upload picker. Value is the uploaded asset URL. */
+	IMAGEUPLOAD = 'imageupload',
+	/** Audio upload picker. Value is the uploaded asset URL. */
+	SOUNDUPLOAD = 'soundupload',
+	/** Video upload picker. Value is the uploaded asset URL. */
+	VIDEOUPLOAD = 'videoupload',
+	/** Action trigger button. No persisted value; renders a clickable
+	 *  control that custom JS can bind to via `Overlay.on('configAction', …)`. */
+	ACTIONBUTTON = 'actionbutton',
 }
 
 /**
@@ -169,6 +179,65 @@ export interface SliderConfigField extends BaseConfigField {
 	options: SliderOptions;
 }
 
+/** Multi-line textarea for long-form text input. Supports variables. */
+export interface TextareaConfigField extends BaseConfigField {
+	type: ConfigsFieldType.TEXTAREA | 'textarea';
+	/** Default text value. Omit to leave blank on first load. */
+	value?: string;
+	/** Placeholder text shown when the textarea is empty. */
+	placeholder?: string;
+	/** Visible row count for the textarea. Defaults to 4 in the renderer. */
+	rows?: number;
+	/**
+	 * When `true`, renders a variable-enabled textarea. Users can insert Lumia
+	 * variables (e.g. `{{username}}`) via a picker triggered by a `{}` adornment.
+	 */
+	enableVariables?: boolean;
+	/**
+	 * Curated variable list to surface at the top of the picker. Has no effect
+	 * unless `enableVariables` is also `true`.
+	 */
+	allowedVariables?: string[];
+}
+
+/** Image upload picker. Value is the uploaded asset's URL. */
+export interface ImageuploadConfigField extends BaseConfigField {
+	type: ConfigsFieldType.IMAGEUPLOAD | 'imageupload';
+	/** Default image URL. */
+	value?: string;
+	/** Optional comma-separated accept hint, e.g. `image/png,image/jpeg`. */
+	accept?: string;
+}
+
+/** Audio clip upload picker. Value is the uploaded asset's URL. */
+export interface SounduploadConfigField extends BaseConfigField {
+	type: ConfigsFieldType.SOUNDUPLOAD | 'soundupload';
+	/** Default audio URL. */
+	value?: string;
+	/** Optional comma-separated accept hint, e.g. `audio/mpeg,audio/ogg`. */
+	accept?: string;
+}
+
+/** Video upload picker. Value is the uploaded asset's URL. */
+export interface VideouploadConfigField extends BaseConfigField {
+	type: ConfigsFieldType.VIDEOUPLOAD | 'videoupload';
+	/** Default video URL. */
+	value?: string;
+	/** Optional comma-separated accept hint, e.g. `video/mp4,video/webm`. */
+	accept?: string;
+}
+
+/**
+ * Action trigger button. The control surface is a labelled button; clicking it
+ * dispatches an event the overlay's custom JS can subscribe to via
+ * `Overlay.on('configAction', ({ key }) => …)`. No persisted value.
+ */
+export interface ActionbuttonConfigField extends BaseConfigField {
+	type: ConfigsFieldType.ACTIONBUTTON | 'actionbutton';
+	/** Optional button-text override. Defaults to the field `label`. */
+	buttonLabel?: string;
+}
+
 /**
  * Discriminated union of every config-field shape the renderer accepts.
  * Use this when typing the `configs` map for a Lumia custom overlay.
@@ -186,13 +255,18 @@ export interface SliderConfigField extends BaseConfigField {
  */
 export type ConfigField =
 	| InputConfigField
+	| TextareaConfigField
 	| NumberConfigField
 	| CheckboxConfigField
 	| DropdownConfigField
 	| MultiselectConfigField
 	| ColorpickerConfigField
 	| FontpickerConfigField
-	| SliderConfigField;
+	| SliderConfigField
+	| ImageuploadConfigField
+	| SounduploadConfigField
+	| VideouploadConfigField
+	| ActionbuttonConfigField;
 
 /**
  * The configs map a custom overlay declares in its Configs tab.

package/dist/esm/custom-overlays.d.js

@@ -8,6 +8,7 @@ export const CustomTabs = {
 
 export const ConfigsFieldType = {
 	INPUT: "input",
+	TEXTAREA: "textarea",
 	NUMBER: "number",
 	CHECKBOX: "checkbox",
 	DROPDOWN: "dropdown",
@@ -15,5 +16,9 @@ export const ConfigsFieldType = {
 	COLORPICKER: "colorpicker",
 	FONTPICKER: "fontpicker",
 	SLIDER: "slider",
+	IMAGEUPLOAD: "imageupload",
+	SOUNDUPLOAD: "soundupload",
+	VIDEOUPLOAD: "videoupload",
+	ACTIONBUTTON: "actionbutton",
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lumiastream/lumia-types",
-  "version": "3.3.7-alpha.6",
+  "version": "3.3.7-alpha.7",
   "description": "",
   "main": "./dist/index.js",
   "module": "./dist/esm/index.js",