@lumiastream/plugin 0.1.8
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 +21 -0
- package/README.md +112 -0
- package/dist/index.d.ts +5 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +10 -0
- package/dist/index.js.map +1 -0
- package/dist/plugin.d.ts +40 -0
- package/dist/plugin.d.ts.map +1 -0
- package/dist/plugin.js +58 -0
- package/dist/plugin.js.map +1 -0
- package/dist/rumble-1.0.0.lumiaplugin +0 -0
- package/dist/types.d.ts +367 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +36 -0
- package/dist/types.js.map +1 -0
- package/package.json +36 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 Lumia Stream
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
# Lumia Stream Plugin SDK
|
|
2
|
+
|
|
3
|
+
Official TypeScript/JavaScript SDK for developing plugins for [Lumia Stream](https://lumiastream.com).
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @lumiastream/plugin
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```ts
|
|
14
|
+
import {
|
|
15
|
+
Plugin,
|
|
16
|
+
type PluginManifest,
|
|
17
|
+
type PluginContext,
|
|
18
|
+
} from "@lumiastream/plugin";
|
|
19
|
+
|
|
20
|
+
export default class MyPlugin extends Plugin {
|
|
21
|
+
constructor(manifest: PluginManifest, context: PluginContext) {
|
|
22
|
+
super(manifest, context);
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
async onload(): Promise<void> {
|
|
26
|
+
this.lumia.addLog("Plugin loaded successfully!");
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
async onunload(): Promise<void> {
|
|
30
|
+
this.lumia.addLog("Plugin unloaded");
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Plugin Manifest
|
|
36
|
+
|
|
37
|
+
Every plugin requires a `manifest.json` file that describes your plugin, its metadata, and configuration:
|
|
38
|
+
|
|
39
|
+
```json
|
|
40
|
+
{
|
|
41
|
+
"id": "my-awesome-plugin",
|
|
42
|
+
"name": "My Awesome Plugin",
|
|
43
|
+
"version": "1.0.0",
|
|
44
|
+
"author": "Your Name",
|
|
45
|
+
"description": "A brief description of what your plugin does",
|
|
46
|
+
"lumiaVersion": "^9.0.0",
|
|
47
|
+
"category": "utilities",
|
|
48
|
+
"config": {
|
|
49
|
+
"settings": [
|
|
50
|
+
{
|
|
51
|
+
"key": "apiKey",
|
|
52
|
+
"label": "API Key",
|
|
53
|
+
"type": "text",
|
|
54
|
+
"required": true
|
|
55
|
+
}
|
|
56
|
+
]
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
## Lifecycle Hooks
|
|
62
|
+
|
|
63
|
+
- `onload()` – invoked when the plugin is enabled inside Lumia Stream.
|
|
64
|
+
- `onunload()` – called when your plugin is disabled or unloaded.
|
|
65
|
+
- `onupdate(oldVersion, newVersion)` – triggered after version upgrades.
|
|
66
|
+
- `onsettingsupdate(settings, previousSettings)` – called whenever settings change.
|
|
67
|
+
- `actions(config)` – handle custom actions invoked from Lumia automations.
|
|
68
|
+
|
|
69
|
+
## Lumia API Highlights
|
|
70
|
+
|
|
71
|
+
Interact with Lumia Stream using the strongly typed `ILumiaAPI` helper on the plugin context:
|
|
72
|
+
|
|
73
|
+
```ts
|
|
74
|
+
await this.lumia.triggerAlert({
|
|
75
|
+
alert: "follow",
|
|
76
|
+
extraSettings: { username: "StreamerFan" },
|
|
77
|
+
});
|
|
78
|
+
await this.lumia.playAudio({ path: "alert.mp3", volume: 0.7 });
|
|
79
|
+
this.lumia.setVariable("follower_count", 1337);
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
See the [API reference](./docs/api-reference.md) for the full surface area.
|
|
83
|
+
|
|
84
|
+
## Scripts
|
|
85
|
+
|
|
86
|
+
- `npm run build` – compile the SDK to the `dist` folder.
|
|
87
|
+
- `npm run lint` – type-check the source without emitting output.
|
|
88
|
+
|
|
89
|
+
## CLI Helpers
|
|
90
|
+
|
|
91
|
+
The CLI is distributed separately via `lumia-plugin`. Use it with `npx` (requires npm 7+).
|
|
92
|
+
|
|
93
|
+
- `npx lumia-plugin create my-plugin` scaffold a feature-rich sample plugin showing logging, variables, and alerts
|
|
94
|
+
- `npx lumia-plugin validate ./path/to/plugin` check `manifest.json`, entry files, and config for common mistakes
|
|
95
|
+
- `npx lumia-plugin build ./path/to/plugin --out ./plugin.lumiaplugin` bundle the directory into a distributable archive
|
|
96
|
+
|
|
97
|
+
## Documentation
|
|
98
|
+
|
|
99
|
+
- [Getting Started](./docs/getting-started.md)
|
|
100
|
+
- [API Reference](./docs/api-reference.md)
|
|
101
|
+
- [Manifest Guide](./docs/manifest-guide.md)
|
|
102
|
+
|
|
103
|
+
## Examples
|
|
104
|
+
|
|
105
|
+
- `examples/basic-logger` – Smallest possible plugin: logs lifecycle events and handles a single action.
|
|
106
|
+
- `examples/toast-notifier` – Demonstrates settings + actions to trigger Lumia toast notifications.
|
|
107
|
+
- `examples/variable-counter` – Shows how to persist state via Lumia variables and support multiple actions.
|
|
108
|
+
- `examples/rumble` – Plain JavaScript Rumble livestream plugin that polls the API, updates variables, and fires alerts.
|
|
109
|
+
|
|
110
|
+
## License
|
|
111
|
+
|
|
112
|
+
The SDK is released under the MIT License. See [LICENSE](./LICENSE) for details.
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
export { Plugin } from './plugin';
|
|
2
|
+
export type { PluginManifest, PluginContext, PluginFormField, PluginAuthConfig, PluginActionsConfig, PluginInstance, PluginConfig, PluginStats, PluginDependency, PluginFile, PluginPackage, PluginVariableDefinition, PluginAlertDefinition, PluginIntegrationConfig, PluginActionDefinition, PluginActionField, PluginSetting, PluginTriggerAlertOptions, PluginDisplayChatOptions, PluginRuntime, ILumiaAPI, } from './types';
|
|
3
|
+
export { PluginStatus, PluginCategory, } from './types';
|
|
4
|
+
export default Plugin;
|
|
5
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,YAAY,EACV,cAAc,EACd,aAAa,EACb,eAAe,EACf,gBAAgB,EAChB,mBAAmB,EACnB,cAAc,EACd,YAAY,EACZ,WAAW,EACX,gBAAgB,EAChB,UAAU,EACV,aAAa,EACb,wBAAwB,EACxB,qBAAqB,EACrB,uBAAuB,EACvB,sBAAsB,EACtB,iBAAiB,EACjB,aAAa,EACb,yBAAyB,EACzB,wBAAwB,EACxB,aAAa,EACb,SAAS,GACV,MAAM,SAAS,CAAC;AACjB,OAAO,EACL,YAAY,EACZ,cAAc,GACf,MAAM,SAAS,CAAC;AACjB,eAAe,MAAM,CAAC"}
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.PluginCategory = exports.PluginStatus = exports.Plugin = void 0;
|
|
4
|
+
var plugin_1 = require("./plugin");
|
|
5
|
+
Object.defineProperty(exports, "Plugin", { enumerable: true, get: function () { return plugin_1.Plugin; } });
|
|
6
|
+
var types_1 = require("./types");
|
|
7
|
+
Object.defineProperty(exports, "PluginStatus", { enumerable: true, get: function () { return types_1.PluginStatus; } });
|
|
8
|
+
Object.defineProperty(exports, "PluginCategory", { enumerable: true, get: function () { return types_1.PluginCategory; } });
|
|
9
|
+
exports.default = Plugin;
|
|
10
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,mCAAkC;AAAzB,gGAAA,MAAM,OAAA;AAwBf,iCAGiB;AAFf,qGAAA,YAAY,OAAA;AACZ,uGAAA,cAAc,OAAA;AAEhB,kBAAe,MAAM,CAAC"}
|
package/dist/plugin.d.ts
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import { type PluginManifest, type PluginContext, type ILumiaAPI } from './types';
|
|
2
|
+
/**
|
|
3
|
+
* Base Plugin Class - every Lumia Stream plugin should extend this class.
|
|
4
|
+
*/
|
|
5
|
+
export declare abstract class Plugin {
|
|
6
|
+
readonly context: PluginContext;
|
|
7
|
+
constructor(_manifest: PluginManifest, context: PluginContext);
|
|
8
|
+
/**
|
|
9
|
+
* Called when the plugin is first loaded or enabled.
|
|
10
|
+
*/
|
|
11
|
+
abstract onload(): Promise<void>;
|
|
12
|
+
/**
|
|
13
|
+
* Called when the plugin is unloaded or disabled.
|
|
14
|
+
*/
|
|
15
|
+
abstract onunload(): Promise<void>;
|
|
16
|
+
/**
|
|
17
|
+
* Called when Lumia upgrades the plugin to a new version.
|
|
18
|
+
*/
|
|
19
|
+
onupdate(_oldVersion: string, _newVersion: string): Promise<void>;
|
|
20
|
+
/**
|
|
21
|
+
* Handle custom actions triggered from the UI or Lumia automations.
|
|
22
|
+
*/
|
|
23
|
+
actions(_config: {
|
|
24
|
+
actions: any[];
|
|
25
|
+
extraSettings?: any;
|
|
26
|
+
}): Promise<void>;
|
|
27
|
+
/**
|
|
28
|
+
* Invoked whenever plugin settings are changed.
|
|
29
|
+
*/
|
|
30
|
+
onsettingsupdate(_settings: Record<string, any>, _previousSettings: Record<string, any>): Promise<void>;
|
|
31
|
+
get settings(): Record<string, any>;
|
|
32
|
+
set settings(value: Record<string, any>);
|
|
33
|
+
updateSettings(updates: Record<string, any>): void;
|
|
34
|
+
get manifest(): PluginManifest;
|
|
35
|
+
get lumia(): ILumiaAPI;
|
|
36
|
+
validateAuth(_data: any): Promise<boolean>;
|
|
37
|
+
refreshAuth<TData>(data: TData): Promise<TData>;
|
|
38
|
+
}
|
|
39
|
+
export default Plugin;
|
|
40
|
+
//# sourceMappingURL=plugin.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,aAAa,EAAE,KAAK,SAAS,EAAE,MAAM,SAAS,CAAC;AAElF;;GAEG;AACH,8BAAsB,MAAM;IAC1B,SAAgB,OAAO,EAAE,aAAa,CAAC;gBAE3B,SAAS,EAAE,cAAc,EAAE,OAAO,EAAE,aAAa;IAI7D;;OAEG;IACH,QAAQ,CAAC,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAEhC;;OAEG;IACH,QAAQ,CAAC,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAElC;;OAEG;IAEG,QAAQ,CAAC,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAEvE;;OAEG;IAEG,OAAO,CAAC,OAAO,EAAE;QAAE,OAAO,EAAE,GAAG,EAAE,CAAC;QAAC,aAAa,CAAC,EAAE,GAAG,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAE9E;;OAEG;IAEG,gBAAgB,CACpB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC9B,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACrC,OAAO,CAAC,IAAI,CAAC;IAEhB,IAAI,QAAQ,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAElC;IAED,IAAI,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAItC;IAED,cAAc,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI;IAMlD,IAAI,QAAQ,IAAI,cAAc,CAE7B;IAED,IAAI,KAAK,IAAI,SAAS,CAErB;IAGK,YAAY,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;IAI1C,WAAW,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;CAGtD;AAED,eAAe,MAAM,CAAC"}
|
package/dist/plugin.js
ADDED
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.Plugin = void 0;
|
|
4
|
+
/**
|
|
5
|
+
* Base Plugin Class - every Lumia Stream plugin should extend this class.
|
|
6
|
+
*/
|
|
7
|
+
class Plugin {
|
|
8
|
+
constructor(_manifest, context) {
|
|
9
|
+
this.context = context;
|
|
10
|
+
}
|
|
11
|
+
/**
|
|
12
|
+
* Called when Lumia upgrades the plugin to a new version.
|
|
13
|
+
*/
|
|
14
|
+
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
15
|
+
async onupdate(_oldVersion, _newVersion) { }
|
|
16
|
+
/**
|
|
17
|
+
* Handle custom actions triggered from the UI or Lumia automations.
|
|
18
|
+
*/
|
|
19
|
+
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
20
|
+
async actions(_config) { }
|
|
21
|
+
/**
|
|
22
|
+
* Invoked whenever plugin settings are changed.
|
|
23
|
+
*/
|
|
24
|
+
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
25
|
+
async onsettingsupdate(_settings, _previousSettings) { }
|
|
26
|
+
get settings() {
|
|
27
|
+
var _a, _b, _c, _d;
|
|
28
|
+
return (_d = (_c = (_b = (_a = this.context) === null || _a === void 0 ? void 0 : _a.lumia) === null || _b === void 0 ? void 0 : _b.getSettings) === null || _c === void 0 ? void 0 : _c.call(_b)) !== null && _d !== void 0 ? _d : {};
|
|
29
|
+
}
|
|
30
|
+
set settings(value) {
|
|
31
|
+
var _a, _b;
|
|
32
|
+
if ((_b = (_a = this.context) === null || _a === void 0 ? void 0 : _a.lumia) === null || _b === void 0 ? void 0 : _b.setSettings) {
|
|
33
|
+
this.context.lumia.setSettings(value);
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
updateSettings(updates) {
|
|
37
|
+
var _a, _b;
|
|
38
|
+
if ((_b = (_a = this.context) === null || _a === void 0 ? void 0 : _a.lumia) === null || _b === void 0 ? void 0 : _b.updateSettings) {
|
|
39
|
+
this.context.lumia.updateSettings(updates);
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
get manifest() {
|
|
43
|
+
return this.context.plugin;
|
|
44
|
+
}
|
|
45
|
+
get lumia() {
|
|
46
|
+
return this.context.lumia;
|
|
47
|
+
}
|
|
48
|
+
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
49
|
+
async validateAuth(_data) {
|
|
50
|
+
return true;
|
|
51
|
+
}
|
|
52
|
+
async refreshAuth(data) {
|
|
53
|
+
return data;
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
exports.Plugin = Plugin;
|
|
57
|
+
exports.default = Plugin;
|
|
58
|
+
//# sourceMappingURL=plugin.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":";;;AAEA;;GAEG;AACH,MAAsB,MAAM;IAG1B,YAAY,SAAyB,EAAE,OAAsB;QAC3D,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAYD;;OAEG;IACH,6DAA6D;IAC7D,KAAK,CAAC,QAAQ,CAAC,WAAmB,EAAE,WAAmB,IAAkB,CAAC;IAE1E;;OAEG;IACH,6DAA6D;IAC7D,KAAK,CAAC,OAAO,CAAC,OAAgD,IAAkB,CAAC;IAEjF;;OAEG;IACH,6DAA6D;IAC7D,KAAK,CAAC,gBAAgB,CACpB,SAA8B,EAC9B,iBAAsC,IACtB,CAAC;IAEnB,IAAI,QAAQ;;QACV,OAAO,MAAC,MAAA,MAAA,MAAA,IAAI,CAAC,OAAO,0CAAE,KAAK,0CAAE,WAAW,kDAA4B,mCAAI,EAAE,CAAC;IAC7E,CAAC;IAED,IAAI,QAAQ,CAAC,KAA0B;;QACrC,IAAI,MAAA,MAAA,IAAI,CAAC,OAAO,0CAAE,KAAK,0CAAE,WAAW,EAAE,CAAC;YACrC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QACxC,CAAC;IACH,CAAC;IAED,cAAc,CAAC,OAA4B;;QACzC,IAAI,MAAA,MAAA,IAAI,CAAC,OAAO,0CAAE,KAAK,0CAAE,cAAc,EAAE,CAAC;YACxC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QAC7C,CAAC;IACH,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IAC7B,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;IAC5B,CAAC;IAED,6DAA6D;IAC7D,KAAK,CAAC,YAAY,CAAC,KAAU;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,WAAW,CAAQ,IAAW;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAtED,wBAsEC;AAED,kBAAe,MAAM,CAAC"}
|
|
Binary file
|
package/dist/types.d.ts
ADDED
|
@@ -0,0 +1,367 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Lumia Stream Plugin SDK - Core Types and Interfaces
|
|
3
|
+
* Provides the type system that plugin developers rely on when building plugins.
|
|
4
|
+
*/
|
|
5
|
+
/**
|
|
6
|
+
* Plugin lifecycle status as represented inside Lumia Stream.
|
|
7
|
+
*/
|
|
8
|
+
export declare enum PluginStatus {
|
|
9
|
+
INSTALLED = "installed",
|
|
10
|
+
ACTIVE = "active",
|
|
11
|
+
INACTIVE = "inactive",
|
|
12
|
+
ERROR = "error",
|
|
13
|
+
UPDATING = "updating",
|
|
14
|
+
PENDING_INSTALL = "pending_install",
|
|
15
|
+
UNINSTALLING = "uninstalling"
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* High level plugin marketplace categories.
|
|
19
|
+
*/
|
|
20
|
+
export declare enum PluginCategory {
|
|
21
|
+
SYSTEM = "system",
|
|
22
|
+
PLATFORMS = "platforms",
|
|
23
|
+
APPS = "apps",
|
|
24
|
+
LIGHTS = "lights",
|
|
25
|
+
SWITCH = "switch",
|
|
26
|
+
DECK = "deck",
|
|
27
|
+
PROTOCOLS = "protocols",
|
|
28
|
+
KEYLIGHT = "keylight",
|
|
29
|
+
DEVICES = "devices"
|
|
30
|
+
}
|
|
31
|
+
export interface PluginVariableDefinition {
|
|
32
|
+
name: string;
|
|
33
|
+
system: boolean;
|
|
34
|
+
origin: string;
|
|
35
|
+
allowedPlaces: string[];
|
|
36
|
+
description?: string;
|
|
37
|
+
value: string | number | boolean | null;
|
|
38
|
+
isFunction?: boolean;
|
|
39
|
+
example?: string;
|
|
40
|
+
}
|
|
41
|
+
export interface PluginAlertVariationSelection {
|
|
42
|
+
label: string;
|
|
43
|
+
message?: string;
|
|
44
|
+
value: string | number;
|
|
45
|
+
}
|
|
46
|
+
export interface PluginAlertVariationCondition {
|
|
47
|
+
type: string;
|
|
48
|
+
description?: string;
|
|
49
|
+
selections?: PluginAlertVariationSelection[];
|
|
50
|
+
}
|
|
51
|
+
export interface PluginAlertExtraOption {
|
|
52
|
+
type: "bool" | "number" | "string";
|
|
53
|
+
property: string;
|
|
54
|
+
title: string;
|
|
55
|
+
info: string;
|
|
56
|
+
min?: number;
|
|
57
|
+
max?: number;
|
|
58
|
+
}
|
|
59
|
+
export interface PluginAlertDefinition {
|
|
60
|
+
title: string;
|
|
61
|
+
untranslated?: boolean;
|
|
62
|
+
alertValue: string;
|
|
63
|
+
key: string;
|
|
64
|
+
info?: string;
|
|
65
|
+
preferences?: string[];
|
|
66
|
+
preferenceDefaultIgnore?: boolean;
|
|
67
|
+
acceptedVariables?: string[];
|
|
68
|
+
defaults?: Record<string, any>;
|
|
69
|
+
defaultMessage?: string;
|
|
70
|
+
variationConditions?: PluginAlertVariationCondition[];
|
|
71
|
+
extraOptions?: PluginAlertExtraOption[];
|
|
72
|
+
withLoyalty?: boolean;
|
|
73
|
+
}
|
|
74
|
+
export interface PluginDependency {
|
|
75
|
+
id: string;
|
|
76
|
+
version?: string;
|
|
77
|
+
optional?: boolean;
|
|
78
|
+
}
|
|
79
|
+
export interface PluginSetting {
|
|
80
|
+
key: string;
|
|
81
|
+
label: string;
|
|
82
|
+
type: "text" | "number" | "select" | "checkbox" | "slider" | "file" | "password" | "toggle" | "textarea" | "email" | "url" | "color";
|
|
83
|
+
placeholder?: string;
|
|
84
|
+
helperText?: string;
|
|
85
|
+
required?: boolean;
|
|
86
|
+
options?: Array<{
|
|
87
|
+
label: string;
|
|
88
|
+
value: string | number | boolean;
|
|
89
|
+
}>;
|
|
90
|
+
defaultValue?: string | number | boolean;
|
|
91
|
+
validation?: {
|
|
92
|
+
pattern?: string;
|
|
93
|
+
min?: number;
|
|
94
|
+
max?: number;
|
|
95
|
+
minLength?: number;
|
|
96
|
+
maxLength?: number;
|
|
97
|
+
};
|
|
98
|
+
}
|
|
99
|
+
export interface PluginActionField {
|
|
100
|
+
key: string;
|
|
101
|
+
label: string;
|
|
102
|
+
type: "text" | "number" | "select" | "checkbox" | "switch" | "slider" | "file" | "email" | "url" | "password" | "textarea";
|
|
103
|
+
placeholder?: string;
|
|
104
|
+
helperText?: string;
|
|
105
|
+
required?: boolean;
|
|
106
|
+
options?: Array<{
|
|
107
|
+
label: string;
|
|
108
|
+
value: string | number | boolean;
|
|
109
|
+
}>;
|
|
110
|
+
min?: number;
|
|
111
|
+
max?: number;
|
|
112
|
+
step?: number;
|
|
113
|
+
defaultValue?: any;
|
|
114
|
+
validation?: {
|
|
115
|
+
min?: number;
|
|
116
|
+
max?: number;
|
|
117
|
+
pattern?: string;
|
|
118
|
+
};
|
|
119
|
+
}
|
|
120
|
+
export interface PluginActionDefinition {
|
|
121
|
+
type: string;
|
|
122
|
+
label: string;
|
|
123
|
+
description?: string;
|
|
124
|
+
icon?: string;
|
|
125
|
+
fields: PluginActionField[];
|
|
126
|
+
preview?: boolean;
|
|
127
|
+
}
|
|
128
|
+
export interface PluginIntegrationConfig {
|
|
129
|
+
settings?: PluginSetting[];
|
|
130
|
+
variables?: PluginVariableDefinition[];
|
|
131
|
+
alerts?: PluginAlertDefinition[];
|
|
132
|
+
actions?: PluginActionDefinition[];
|
|
133
|
+
[key: string]: any;
|
|
134
|
+
}
|
|
135
|
+
export interface PluginManifest {
|
|
136
|
+
id: string;
|
|
137
|
+
name: string;
|
|
138
|
+
version: string;
|
|
139
|
+
author: string;
|
|
140
|
+
email?: string;
|
|
141
|
+
website?: string;
|
|
142
|
+
repository?: string;
|
|
143
|
+
description: string;
|
|
144
|
+
longDescription?: string;
|
|
145
|
+
license: string;
|
|
146
|
+
lumiaVersion: string;
|
|
147
|
+
keywords?: string[];
|
|
148
|
+
category: PluginCategory | string;
|
|
149
|
+
icon?: string;
|
|
150
|
+
screenshots?: string[];
|
|
151
|
+
changelog?: string;
|
|
152
|
+
config: PluginIntegrationConfig;
|
|
153
|
+
}
|
|
154
|
+
export interface PluginFile {
|
|
155
|
+
path: string;
|
|
156
|
+
type: "main" | "icon" | "translation" | "asset" | "config";
|
|
157
|
+
size: number;
|
|
158
|
+
hash: string;
|
|
159
|
+
compressed?: boolean;
|
|
160
|
+
}
|
|
161
|
+
export interface PluginPackage {
|
|
162
|
+
manifest: PluginManifest;
|
|
163
|
+
files: PluginFile[];
|
|
164
|
+
signature: string;
|
|
165
|
+
checksum: string;
|
|
166
|
+
extractedFiles?: Record<string, string>;
|
|
167
|
+
}
|
|
168
|
+
export interface PluginStats {
|
|
169
|
+
activations: number;
|
|
170
|
+
errors: number;
|
|
171
|
+
lastError?: Date;
|
|
172
|
+
performanceMetrics?: {
|
|
173
|
+
avgStartupTime: number;
|
|
174
|
+
avgMemoryUsage: number;
|
|
175
|
+
crashCount: number;
|
|
176
|
+
};
|
|
177
|
+
}
|
|
178
|
+
export interface PluginConfig {
|
|
179
|
+
enabled: boolean;
|
|
180
|
+
autoUpdate: boolean;
|
|
181
|
+
settings?: Record<string, any>;
|
|
182
|
+
}
|
|
183
|
+
export interface PluginInstance<TPlugin extends PluginRuntime = PluginRuntime> {
|
|
184
|
+
manifest: PluginManifest;
|
|
185
|
+
status: PluginStatus;
|
|
186
|
+
installedAt: Date;
|
|
187
|
+
lastUsed?: Date;
|
|
188
|
+
errorMessage?: string;
|
|
189
|
+
config?: PluginConfig;
|
|
190
|
+
stats?: PluginStats;
|
|
191
|
+
instance?: TPlugin;
|
|
192
|
+
developmentPath?: string;
|
|
193
|
+
}
|
|
194
|
+
export interface PluginTriggerAlertOptions {
|
|
195
|
+
alert: string;
|
|
196
|
+
dynamic?: {
|
|
197
|
+
name: string;
|
|
198
|
+
value: string | number | boolean;
|
|
199
|
+
};
|
|
200
|
+
extraSettings?: Record<string, any>;
|
|
201
|
+
}
|
|
202
|
+
export interface PluginDisplayChatOptions {
|
|
203
|
+
platform?: string;
|
|
204
|
+
username: string;
|
|
205
|
+
displayname?: string;
|
|
206
|
+
message: string;
|
|
207
|
+
avatar?: string;
|
|
208
|
+
color?: string;
|
|
209
|
+
badges?: string[];
|
|
210
|
+
messageId?: string;
|
|
211
|
+
extraInfo?: Record<string, any>;
|
|
212
|
+
}
|
|
213
|
+
export interface PluginContext {
|
|
214
|
+
plugin: PluginManifest;
|
|
215
|
+
lumia: ILumiaAPI;
|
|
216
|
+
}
|
|
217
|
+
export interface ILumiaAPI {
|
|
218
|
+
updateConnection: (state: boolean) => Promise<void>;
|
|
219
|
+
getConnectionState: () => boolean;
|
|
220
|
+
getSettings: () => Record<string, any>;
|
|
221
|
+
setSettings: (newSettings: Record<string, any>) => void;
|
|
222
|
+
updateSettings: (updates: Record<string, any>) => void;
|
|
223
|
+
setVariable: (name: string, value: any) => Promise<void>;
|
|
224
|
+
getVariable: (name: string) => any;
|
|
225
|
+
callCommand: (name: string, variableValues?: any) => Promise<any>;
|
|
226
|
+
triggerAlert: (params: PluginTriggerAlertOptions) => Promise<boolean>;
|
|
227
|
+
displayChat: (params: PluginDisplayChatOptions) => void;
|
|
228
|
+
overlaySendCustomContent: (params: {
|
|
229
|
+
layer: string;
|
|
230
|
+
codeId: string;
|
|
231
|
+
content: any;
|
|
232
|
+
}) => Promise<boolean>;
|
|
233
|
+
playAudio: (params: {
|
|
234
|
+
path: string;
|
|
235
|
+
volume?: number;
|
|
236
|
+
waitForAudioToStop?: boolean;
|
|
237
|
+
}) => Promise<boolean>;
|
|
238
|
+
tts: (params: {
|
|
239
|
+
message: string;
|
|
240
|
+
voice?: string;
|
|
241
|
+
volume?: number;
|
|
242
|
+
}) => Promise<boolean>;
|
|
243
|
+
writeFile: (params: {
|
|
244
|
+
path: string;
|
|
245
|
+
message: string;
|
|
246
|
+
append?: boolean;
|
|
247
|
+
value?: string;
|
|
248
|
+
}) => Promise<boolean>;
|
|
249
|
+
readFile: (path: string) => Promise<string | boolean>;
|
|
250
|
+
getAllCommands: (params?: {
|
|
251
|
+
onlyOn?: boolean;
|
|
252
|
+
}) => Promise<any>;
|
|
253
|
+
sendColor: (params: {
|
|
254
|
+
lights?: string[];
|
|
255
|
+
color: string | any;
|
|
256
|
+
power?: boolean;
|
|
257
|
+
brightness?: number;
|
|
258
|
+
transition?: number;
|
|
259
|
+
}) => Promise<boolean>;
|
|
260
|
+
getLights: () => Promise<any>;
|
|
261
|
+
showToast: (params: {
|
|
262
|
+
message: string;
|
|
263
|
+
time?: number;
|
|
264
|
+
}) => Promise<boolean>;
|
|
265
|
+
addLog: (message: string) => Promise<boolean>;
|
|
266
|
+
chatbot: (params: {
|
|
267
|
+
message: string;
|
|
268
|
+
site?: string | string[];
|
|
269
|
+
color?: string;
|
|
270
|
+
chatAsSelf?: boolean;
|
|
271
|
+
}) => Promise<boolean>;
|
|
272
|
+
integration: {
|
|
273
|
+
getId: () => string;
|
|
274
|
+
getConfig: () => Record<string, any>;
|
|
275
|
+
isConnected: () => boolean;
|
|
276
|
+
isEnabled: () => boolean;
|
|
277
|
+
};
|
|
278
|
+
}
|
|
279
|
+
export interface PluginRuntime {
|
|
280
|
+
context: PluginContext;
|
|
281
|
+
onload(): Promise<void>;
|
|
282
|
+
onunload(): Promise<void>;
|
|
283
|
+
onupdate?(oldVersion: string, newVersion: string): Promise<void>;
|
|
284
|
+
actions?(config: {
|
|
285
|
+
actions: any[];
|
|
286
|
+
extraSettings?: any;
|
|
287
|
+
}): Promise<void>;
|
|
288
|
+
settings: Record<string, any>;
|
|
289
|
+
onsettingsupdate?(settings: Record<string, any>, previousSettings: Record<string, any>): Promise<void> | void;
|
|
290
|
+
}
|
|
291
|
+
/**
|
|
292
|
+
* Plugin Form configuration used by the SDK helper UIs.
|
|
293
|
+
*/
|
|
294
|
+
export interface PluginFormField {
|
|
295
|
+
key: string;
|
|
296
|
+
label: string;
|
|
297
|
+
type: "text" | "password" | "number" | "email" | "url" | "textarea" | "select" | "checkbox" | "toggle" | "color" | "file";
|
|
298
|
+
placeholder?: string;
|
|
299
|
+
helperText?: string;
|
|
300
|
+
required?: boolean;
|
|
301
|
+
defaultValue?: any;
|
|
302
|
+
validation?: {
|
|
303
|
+
pattern?: string;
|
|
304
|
+
min?: number;
|
|
305
|
+
max?: number;
|
|
306
|
+
maxLength?: number;
|
|
307
|
+
minLength?: number;
|
|
308
|
+
custom?: string;
|
|
309
|
+
};
|
|
310
|
+
options?: Array<{
|
|
311
|
+
label: string;
|
|
312
|
+
value: any;
|
|
313
|
+
}>;
|
|
314
|
+
disabled?: boolean;
|
|
315
|
+
visible?: boolean;
|
|
316
|
+
}
|
|
317
|
+
export interface PluginAuthConfig {
|
|
318
|
+
title?: string;
|
|
319
|
+
description?: string;
|
|
320
|
+
fields: PluginFormField[];
|
|
321
|
+
testConnection?: {
|
|
322
|
+
enabled: boolean;
|
|
323
|
+
label?: string;
|
|
324
|
+
loadingText?: string;
|
|
325
|
+
successMessage?: string;
|
|
326
|
+
errorMessage?: string;
|
|
327
|
+
};
|
|
328
|
+
buttons?: {
|
|
329
|
+
save?: {
|
|
330
|
+
label: string;
|
|
331
|
+
variant?: "primary" | "secondary";
|
|
332
|
+
};
|
|
333
|
+
cancel?: {
|
|
334
|
+
label: string;
|
|
335
|
+
variant?: "primary" | "secondary";
|
|
336
|
+
};
|
|
337
|
+
test?: {
|
|
338
|
+
label: string;
|
|
339
|
+
variant?: "primary" | "secondary";
|
|
340
|
+
};
|
|
341
|
+
};
|
|
342
|
+
validationRules?: Record<string, (value: any) => string | null>;
|
|
343
|
+
}
|
|
344
|
+
export interface PluginActionsConfig {
|
|
345
|
+
title?: string;
|
|
346
|
+
description?: string;
|
|
347
|
+
actionTypes: Array<{
|
|
348
|
+
type: string;
|
|
349
|
+
label: string;
|
|
350
|
+
description?: string;
|
|
351
|
+
icon?: string;
|
|
352
|
+
fields: PluginFormField[];
|
|
353
|
+
preview?: boolean;
|
|
354
|
+
}>;
|
|
355
|
+
defaults?: {
|
|
356
|
+
type: string;
|
|
357
|
+
data?: any;
|
|
358
|
+
};
|
|
359
|
+
maxActions?: number;
|
|
360
|
+
grouped?: boolean;
|
|
361
|
+
allowReorder?: boolean;
|
|
362
|
+
validation?: {
|
|
363
|
+
requireAtLeastOne?: boolean;
|
|
364
|
+
custom?: string;
|
|
365
|
+
};
|
|
366
|
+
}
|
|
367
|
+
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,oBAAY,YAAY;IACvB,SAAS,cAAc;IACvB,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,KAAK,UAAU;IACf,QAAQ,aAAa;IACrB,eAAe,oBAAoB;IACnC,YAAY,iBAAiB;CAC7B;AAED;;GAEG;AACH,oBAAY,cAAc;IACzB,MAAM,WAAW;IACjB,SAAS,cAAc;IACvB,IAAI,SAAS;IACb,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,IAAI,SAAS;IACb,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,OAAO,YAAY;CACnB;AAED,MAAM,WAAW,wBAAwB;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;IACxC,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,6BAA6B;IAC7C,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,6BAA6B;IAC7C,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,6BAA6B,EAAE,CAAC;CAC7C;AAED,MAAM,WAAW,sBAAsB;IACtC,IAAI,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC;IACnC,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,qBAAqB;IACrC,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC/B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,mBAAmB,CAAC,EAAE,6BAA6B,EAAE,CAAC;IACtD,YAAY,CAAC,EAAE,sBAAsB,EAAE,CAAC;IACxC,WAAW,CAAC,EAAE,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,gBAAgB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,aAAa;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EACD,MAAM,GACN,QAAQ,GACR,QAAQ,GACR,UAAU,GACV,QAAQ,GACR,MAAM,GACN,UAAU,GACV,QAAQ,GACR,UAAU,GACV,OAAO,GACP,KAAK,GACL,OAAO,CAAC;IACX,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,KAAK,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,CAAC;IACrE,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;IACzC,UAAU,CAAC,EAAE;QACZ,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,SAAS,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;CACF;AAED,MAAM,WAAW,iBAAiB;IACjC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EACD,MAAM,GACN,QAAQ,GACR,QAAQ,GACR,UAAU,GACV,QAAQ,GACR,QAAQ,GACR,MAAM,GACN,OAAO,GACP,KAAK,GACL,UAAU,GACV,UAAU,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,KAAK,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,CAAC;IACrE,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,UAAU,CAAC,EAAE;QACZ,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,OAAO,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;CACF;AAED,MAAM,WAAW,sBAAsB;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,iBAAiB,EAAE,CAAC;IAC5B,OAAO,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,uBAAuB;IACvC,QAAQ,CAAC,EAAE,aAAa,EAAE,CAAC;IAC3B,SAAS,CAAC,EAAE,wBAAwB,EAAE,CAAC;IACvC,MAAM,CAAC,EAAE,qBAAqB,EAAE,CAAC;IACjC,OAAO,CAAC,EAAE,sBAAsB,EAAE,CAAC;IACnC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACnB;AAED,MAAM,WAAW,cAAc;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,QAAQ,EAAE,cAAc,GAAG,MAAM,CAAC;IAClC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,uBAAuB,CAAC;CAChC;AAED,MAAM,WAAW,UAAU;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,aAAa,GAAG,OAAO,GAAG,QAAQ,CAAC;IAC3D,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,aAAa;IAC7B,QAAQ,EAAE,cAAc,CAAC;IACzB,KAAK,EAAE,UAAU,EAAE,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACxC;AAED,MAAM,WAAW,WAAW;IAC3B,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,kBAAkB,CAAC,EAAE;QACpB,cAAc,EAAE,MAAM,CAAC;QACvB,cAAc,EAAE,MAAM,CAAC;QACvB,UAAU,EAAE,MAAM,CAAC;KACnB,CAAC;CACF;AAED,MAAM,WAAW,YAAY;IAC5B,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC/B;AAED,MAAM,WAAW,cAAc,CAAC,OAAO,SAAS,aAAa,GAAG,aAAa;IAC5E,QAAQ,EAAE,cAAc,CAAC;IACzB,MAAM,EAAE,YAAY,CAAC;IACrB,WAAW,EAAE,IAAI,CAAC;IAClB,QAAQ,CAAC,EAAE,IAAI,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,eAAe,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,yBAAyB;IACzC,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAC7D,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,wBAAwB;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAChC;AAED,MAAM,WAAW,aAAa;IAC7B,MAAM,EAAE,cAAc,CAAC;IACvB,KAAK,EAAE,SAAS,CAAC;CACjB;AAED,MAAM,WAAW,SAAS;IACzB,gBAAgB,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACpD,kBAAkB,EAAE,MAAM,OAAO,CAAC;IAClC,WAAW,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACvC,WAAW,EAAE,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,IAAI,CAAC;IACxD,cAAc,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,IAAI,CAAC;IACvD,WAAW,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACzD,WAAW,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,GAAG,CAAC;IACnC,WAAW,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,GAAG,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;IAClE,YAAY,EAAE,CAAC,MAAM,EAAE,yBAAyB,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IACtE,WAAW,EAAE,CAAC,MAAM,EAAE,wBAAwB,KAAK,IAAI,CAAC;IACxD,wBAAwB,EAAE,CAAC,MAAM,EAAE;QAClC,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,GAAG,CAAC;KACb,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IACvB,SAAS,EAAE,CAAC,MAAM,EAAE;QACnB,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,kBAAkB,CAAC,EAAE,OAAO,CAAC;KAC7B,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IACvB,GAAG,EAAE,CAAC,MAAM,EAAE;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;KAChB,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IACvB,SAAS,EAAE,CAAC,MAAM,EAAE;QACnB,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,KAAK,CAAC,EAAE,MAAM,CAAC;KACf,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IACvB,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,CAAC;IACtD,cAAc,EAAE,CAAC,MAAM,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;IAChE,SAAS,EAAE,CAAC,MAAM,EAAE;QACnB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;QAClB,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;QACpB,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,UAAU,CAAC,EAAE,MAAM,CAAC;KACpB,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IACvB,SAAS,EAAE,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC;IAC9B,SAAS,EAAE,CAAC,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAC5E,MAAM,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAC9C,OAAO,EAAE,CAAC,MAAM,EAAE;QACjB,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;QACzB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,UAAU,CAAC,EAAE,OAAO,CAAC;KACrB,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IACvB,WAAW,EAAE;QACZ,KAAK,EAAE,MAAM,MAAM,CAAC;QACpB,SAAS,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACrC,WAAW,EAAE,MAAM,OAAO,CAAC;QAC3B,SAAS,EAAE,MAAM,OAAO,CAAC;KACzB,CAAC;CACF;AAED,MAAM,WAAW,aAAa;IAC7B,OAAO,EAAE,aAAa,CAAC;IACvB,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACxB,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1B,QAAQ,CAAC,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACjE,OAAO,CAAC,CAAC,MAAM,EAAE;QAAE,OAAO,EAAE,GAAG,EAAE,CAAC;QAAC,aAAa,CAAC,EAAE,GAAG,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzE,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC9B,gBAAgB,CAAC,CAChB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC7B,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACnC,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EACD,MAAM,GACN,UAAU,GACV,QAAQ,GACR,OAAO,GACP,KAAK,GACL,UAAU,GACV,QAAQ,GACR,UAAU,GACV,QAAQ,GACR,OAAO,GACP,MAAM,CAAC;IACV,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,UAAU,CAAC,EAAE;QACZ,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,MAAM,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,OAAO,CAAC,EAAE,KAAK,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,GAAG,CAAA;KAAE,CAAC,CAAC;IAC/C,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,gBAAgB;IAChC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,eAAe,EAAE,CAAC;IAC1B,cAAc,CAAC,EAAE;QAChB,OAAO,EAAE,OAAO,CAAC;QACjB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,YAAY,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;IACF,OAAO,CAAC,EAAE;QACT,IAAI,CAAC,EAAE;YAAE,KAAK,EAAE,MAAM,CAAC;YAAC,OAAO,CAAC,EAAE,SAAS,GAAG,WAAW,CAAA;SAAE,CAAC;QAC5D,MAAM,CAAC,EAAE;YAAE,KAAK,EAAE,MAAM,CAAC;YAAC,OAAO,CAAC,EAAE,SAAS,GAAG,WAAW,CAAA;SAAE,CAAC;QAC9D,IAAI,CAAC,EAAE;YAAE,KAAK,EAAE,MAAM,CAAC;YAAC,OAAO,CAAC,EAAE,SAAS,GAAG,WAAW,CAAA;SAAE,CAAC;KAC5D,CAAC;IACF,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,MAAM,GAAG,IAAI,CAAC,CAAC;CAChE;AAED,MAAM,WAAW,mBAAmB;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,KAAK,CAAC;QAClB,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,eAAe,EAAE,CAAC;QAC1B,OAAO,CAAC,EAAE,OAAO,CAAC;KAClB,CAAC,CAAC;IACH,QAAQ,CAAC,EAAE;QACV,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,CAAC,EAAE,GAAG,CAAC;KACX,CAAC;IACF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,UAAU,CAAC,EAAE;QACZ,iBAAiB,CAAC,EAAE,OAAO,CAAC;QAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;CACF"}
|
package/dist/types.js
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* Lumia Stream Plugin SDK - Core Types and Interfaces
|
|
4
|
+
* Provides the type system that plugin developers rely on when building plugins.
|
|
5
|
+
*/
|
|
6
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
7
|
+
exports.PluginCategory = exports.PluginStatus = void 0;
|
|
8
|
+
/**
|
|
9
|
+
* Plugin lifecycle status as represented inside Lumia Stream.
|
|
10
|
+
*/
|
|
11
|
+
var PluginStatus;
|
|
12
|
+
(function (PluginStatus) {
|
|
13
|
+
PluginStatus["INSTALLED"] = "installed";
|
|
14
|
+
PluginStatus["ACTIVE"] = "active";
|
|
15
|
+
PluginStatus["INACTIVE"] = "inactive";
|
|
16
|
+
PluginStatus["ERROR"] = "error";
|
|
17
|
+
PluginStatus["UPDATING"] = "updating";
|
|
18
|
+
PluginStatus["PENDING_INSTALL"] = "pending_install";
|
|
19
|
+
PluginStatus["UNINSTALLING"] = "uninstalling";
|
|
20
|
+
})(PluginStatus || (exports.PluginStatus = PluginStatus = {}));
|
|
21
|
+
/**
|
|
22
|
+
* High level plugin marketplace categories.
|
|
23
|
+
*/
|
|
24
|
+
var PluginCategory;
|
|
25
|
+
(function (PluginCategory) {
|
|
26
|
+
PluginCategory["SYSTEM"] = "system";
|
|
27
|
+
PluginCategory["PLATFORMS"] = "platforms";
|
|
28
|
+
PluginCategory["APPS"] = "apps";
|
|
29
|
+
PluginCategory["LIGHTS"] = "lights";
|
|
30
|
+
PluginCategory["SWITCH"] = "switch";
|
|
31
|
+
PluginCategory["DECK"] = "deck";
|
|
32
|
+
PluginCategory["PROTOCOLS"] = "protocols";
|
|
33
|
+
PluginCategory["KEYLIGHT"] = "keylight";
|
|
34
|
+
PluginCategory["DEVICES"] = "devices";
|
|
35
|
+
})(PluginCategory || (exports.PluginCategory = PluginCategory = {}));
|
|
36
|
+
//# sourceMappingURL=types.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH;;GAEG;AACH,IAAY,YAQX;AARD,WAAY,YAAY;IACvB,uCAAuB,CAAA;IACvB,iCAAiB,CAAA;IACjB,qCAAqB,CAAA;IACrB,+BAAe,CAAA;IACf,qCAAqB,CAAA;IACrB,mDAAmC,CAAA;IACnC,6CAA6B,CAAA;AAC9B,CAAC,EARW,YAAY,4BAAZ,YAAY,QAQvB;AAED;;GAEG;AACH,IAAY,cAUX;AAVD,WAAY,cAAc;IACzB,mCAAiB,CAAA;IACjB,yCAAuB,CAAA;IACvB,+BAAa,CAAA;IACb,mCAAiB,CAAA;IACjB,mCAAiB,CAAA;IACjB,+BAAa,CAAA;IACb,yCAAuB,CAAA;IACvB,uCAAqB,CAAA;IACrB,qCAAmB,CAAA;AACpB,CAAC,EAVW,cAAc,8BAAd,cAAc,QAUzB"}
|
package/package.json
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@lumiastream/plugin",
|
|
3
|
+
"version": "0.1.8",
|
|
4
|
+
"description": "Official Lumia Stream Plugin SDK for building Lumia Stream plugins.",
|
|
5
|
+
"main": "dist/index.js",
|
|
6
|
+
"types": "dist/index.d.ts",
|
|
7
|
+
"keywords": [
|
|
8
|
+
"lumia",
|
|
9
|
+
"stream",
|
|
10
|
+
"plugin",
|
|
11
|
+
"sdk",
|
|
12
|
+
"automation"
|
|
13
|
+
],
|
|
14
|
+
"author": "Lumia Stream",
|
|
15
|
+
"license": "MIT",
|
|
16
|
+
"scripts": {
|
|
17
|
+
"build": "tsc -p tsconfig.json",
|
|
18
|
+
"lint": "tsc --noEmit"
|
|
19
|
+
},
|
|
20
|
+
"exports": {
|
|
21
|
+
".": {
|
|
22
|
+
"require": "./dist/index.js",
|
|
23
|
+
"import": "./dist/index.js",
|
|
24
|
+
"types": "./dist/index.d.ts"
|
|
25
|
+
}
|
|
26
|
+
},
|
|
27
|
+
"files": [
|
|
28
|
+
"dist",
|
|
29
|
+
"README.md",
|
|
30
|
+
"LICENSE"
|
|
31
|
+
],
|
|
32
|
+
"devDependencies": {
|
|
33
|
+
"typescript": "^5.3.3"
|
|
34
|
+
},
|
|
35
|
+
"dependencies": {}
|
|
36
|
+
}
|