@crowbartools/firebot-types 5.67.0-alpha1 → 5.67.0-alpha1.2

package/README.md

@@ -14,13 +14,12 @@ A `@types/node` peer dependency is required (the script API uses `Buffer` / `Buf
 
 ## Usage
 
-The default export is the runtime API object provided by Firebot. Named types live under the `@crowbartools/firebot-types/types` subpath.
+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 from "@crowbartools/firebot-types";
-import type { Plugin, EffectScript } from "@crowbartools/firebot-types/types";
+import firebot, { Plugin, EffectScript, Manifest } from "@crowbartools/firebot-types";
 
-export const manifest: Plugin["manifest"] = {
+export const manifest: Manifest = {
     name: "My Plugin",
     version: "1.0.0",
     author: "you",
@@ -33,10 +32,16 @@ export function onLoad() {
 }
 ```
 
-CommonJS style works too:
+Deep imports for less common types are also supported:
+
+```ts
+import type { EffectHelperService } from "@crowbartools/firebot-types/types/ui/effect-helper-service";
+```
+
+CommonJS style works too (requires `esModuleInterop` in your tsconfig):
 
 ```js
-const firebot = require("@crowbartools/firebot-types");
+const firebot = require("@crowbartools/firebot-types").default;
 firebot.logger.info(firebot.version);
 ```
 

package/index.d.ts

@@ -1,5 +1,7 @@
 // Auto-generated by grunt publish-types. Do not edit by hand.
 import { FirebotScriptApi } from "./types/script-api";
 
+export * from "./types";
+
 declare const firebot: FirebotScriptApi;
-export = firebot;
+export default firebot;

package/package.json

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

package/types/plugins.d.ts

@@ -21,9 +21,9 @@ export type InstalledPluginConfig<Params extends GenericParameters = GenericPara
     parameters: Params;
 };
 
-export type ScriptContext = {
+export type ScriptContext<Params extends FirebotParams = FirebotParams> = {
     trigger?: Trigger;
-    parameters: Record<string, unknown>;
+    parameters: Params;
 };
 
 type DynamicArray<T> = Array<T | ((context: ScriptContext) => Awaitable<T>)>;
@@ -80,12 +80,12 @@ export interface ScriptBase<Params extends FirebotParams = FirebotParams> {
 
     // if uninstalled is true, the script is being removed by the user, thus the script should remove related data files/assets
     // otherwise the script should assume firebot is closing or the script is being reloaded
-    onUnload?: (context: ScriptContext, isUninstalling?: boolean) => NoResult;
+    onUnload?: (context: ScriptContext<Params>, isUninstalling?: boolean) => NoResult;
 }
 
 // Supplants the "Run Script" effect script functionality
 export interface EffectScript<Params extends FirebotParams = FirebotParams> extends ScriptBase<Params> {
-    run: (context: ScriptContext) => Awaitable<void | EffectScriptResult>;
+    run: (context: ScriptContext<Params>) => Awaitable<void | EffectScriptResult>;
 }
 
 // Supplants the "Start up" script functionality
@@ -111,13 +111,13 @@ export interface Plugin<Params extends FirebotParams = FirebotParams> extends Sc
     };
 
     // Called when the script is loaded
-    onLoad?: (context: ScriptContext, isInstalling?: boolean) => NoResult;
+    onLoad?: (context: ScriptContext<Params>, isInstalling?: boolean) => NoResult;
 
     // Called when firebot is closing or plugin is disabled / removed
-    onUnload?: (context: ScriptContext, isUninstalling?: boolean) => NoResult;
+    onUnload?: (context: ScriptContext<Params>, isUninstalling?: boolean) => NoResult;
 
     // called when the user updates plugin-specific parameters
-    onParameterUpdate?: (context: ScriptContext) => NoResult;
+    onParameterUpdate?: (context: ScriptContext<Params>) => NoResult;
 }
 
 export type ScriptDetails = Pick<ScriptBase, "manifest" | "parametersSchema">;