@crowbartools/firebot-types 5.67.0-alpha14 → 5.67.0-alpha15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +674 -674
- package/package.json +1 -1
- package/types/plugins.d.ts +26 -6
package/package.json
CHANGED
package/types/plugins.d.ts
CHANGED
|
@@ -38,11 +38,35 @@ interface ManifestFirebotVersion {
|
|
|
38
38
|
minor?: number;
|
|
39
39
|
patch?: number;
|
|
40
40
|
}
|
|
41
|
+
type FontAwesomeIcon = {
|
|
42
|
+
type: "font-awesome";
|
|
43
|
+
/**
|
|
44
|
+
* A FontAwesome icon name shown in the UI (eg. "fa-cogs").
|
|
45
|
+
*/
|
|
46
|
+
name: `fa-${string}`;
|
|
47
|
+
/**
|
|
48
|
+
* A css color value (eg. "#FF0000") used for the icon.
|
|
49
|
+
*/
|
|
50
|
+
color?: string;
|
|
51
|
+
};
|
|
52
|
+
type CustomIcon = {
|
|
53
|
+
type: "custom";
|
|
54
|
+
url: string;
|
|
55
|
+
/**
|
|
56
|
+
* A css color value (eg. "#FF0000") used for the background of the icon.
|
|
57
|
+
*/
|
|
58
|
+
backgroundColor?: string;
|
|
59
|
+
};
|
|
60
|
+
export type PluginIcon = FontAwesomeIcon | CustomIcon;
|
|
41
61
|
export interface Manifest {
|
|
42
62
|
name: string;
|
|
43
63
|
version: string;
|
|
44
64
|
author: string;
|
|
45
65
|
description: string | ManifestDescription;
|
|
66
|
+
/**
|
|
67
|
+
* An array of strings that describe or categorize your plugin
|
|
68
|
+
*/
|
|
69
|
+
tags?: string[];
|
|
46
70
|
/**
|
|
47
71
|
* A link to the plugin's source code repository
|
|
48
72
|
*/
|
|
@@ -60,13 +84,9 @@ export interface Manifest {
|
|
|
60
84
|
minimumFirebotVersion?: ManifestFirebotVersion;
|
|
61
85
|
maximumFirebotVersion?: ManifestFirebotVersion;
|
|
62
86
|
/**
|
|
63
|
-
*
|
|
64
|
-
*/
|
|
65
|
-
icon?: `fa-${string}`;
|
|
66
|
-
/**
|
|
67
|
-
* A hex color code (eg. "#FF0000") used for the icon.
|
|
87
|
+
* The icon to be displayed for the plugin.
|
|
68
88
|
*/
|
|
69
|
-
|
|
89
|
+
icon?: PluginIcon;
|
|
70
90
|
/**
|
|
71
91
|
* If true, the plugin will be initialized before parameters are shown to the user,
|
|
72
92
|
* allowing the plugin to provide custom parameter types that can be used in its own parametersSchema.
|