@crowbartools/firebot-types 5.67.0-alpha2 → 5.67.0-alpha4

package/README.md

@@ -2,7 +2,7 @@
 
 Type definitions and the script API contract for [Firebot](https://firebot.app) custom scripts and plugins.
 
-This package is **type-only**. At runtime the `@crowbartools/firebot-types` module is provided by the Firebot host application via a `require()` interceptor — installing this package in a standalone Node project and importing it will throw.
+This package is **type-only**. At runtime the `@crowbartools/firebot-types` module is provided by the Firebot host application via a `require()` interceptor (installing this package in a standalone Node project and importing it will throw).
 
 ## Install
 
@@ -10,32 +10,42 @@ This package is **type-only**. At runtime the `@crowbartools/firebot-types` modu
 npm i -D @crowbartools/firebot-types
 ```
 
-A `@types/node` peer dependency is required (the script API uses `Buffer` / `BufferEncoding`).
+A `@types/node` peer dependency is required.
 
 ## Usage
 
 The default export is the runtime API object provided by Firebot. Named types are re-exported from the package root and can be imported alongside the default in a single statement.
 
 ```ts
-import firebot, { Plugin, EffectScript, Manifest } from "@crowbartools/firebot-types";
+import firebot, { Plugin } from "@crowbartools/firebot-types";
 
-export const manifest: Manifest = {
+type Params = {
+    message: string;
+}
+
+const plugin: Plugin<Params> = {
+  manifest: {
     name: "My Plugin",
     version: "1.0.0",
     author: "you",
     description: "Example",
     type: "plugin"
-};
-
-export function onLoad() {
-    firebot.logger.info(`Running on Firebot ${firebot.version}`);
+  },
+  parametersSchema: [
+    {
+      name: "message",
+      type: "string",
+      default: "Hello World!",
+      title: "Hello!",
+      description: "Message",
+    }
+  ],
+  onLoad: (context) => {
+    firebot.logger.info(`${context.parameters.message} (${firebot.version})`);
+  }
 }
-```
-
-Deep imports for less common types are also supported:
 
-```ts
-import type { EffectHelperService } from "@crowbartools/firebot-types/types/ui/effect-helper-service";
+export default plugin;
 ```
 
 CommonJS style works too (requires `esModuleInterop` in your tsconfig):

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@crowbartools/firebot-types",
-  "version": "5.67.0-alpha2",
-  "description": "Type definitions and script API for Firebot custom scripts and plugins.",
+  "version": "5.67.0-alpha4",
+  "description": "Type definitions and script API for Firebot plugins and custom scripts.",
   "main": "index.js",
   "types": "index.d.ts",
   "exports": {

package/types/events.d.ts

@@ -8,6 +8,8 @@ export type ComparisonType =
     | "greater than or equal to"
     | "less than"
     | "less than or equal to"
+    | "include"
+    | "doesn't include"
     | "contains"
     | "doesn't contain"
     | "doesn't start with"