Spec composer API

Author: Half-Shot

packages/module-api/src/api/composer.ts

@@ -0,0 +1,13 @@
+/**
+ * API to alter the message composer.
+ * @alpha Likely to change
+ */
+export interface ComposerApi {
+    /**
+     * Insert plaintext into the current composer.
+     * @param text - The plain text to insert
+     * @returns Returns immediately, does not await action.
+     * @alpha Likely to change
+     */
+    insertTextIntoComposer(text: string): void;
+}

packages/module-api/src/api/index.ts

@@ -23,6 +23,7 @@ import { type ClientApi } from "./client.ts";
 import { type WidgetLifecycleApi } from "./widget-lifecycle.ts";
 import { type WidgetApi } from "./widget.ts";
 import { type CustomisationsApi } from "./customisations.ts";
+import { type ComposerApi } from "./composer.ts";
 
 /**
  * Module interface for modules to implement.
@@ -159,6 +160,12 @@ export interface Api
      */
     readonly customisations: CustomisationsApi;
 
+    /**
+     * Allows modules to customise the message composer.
+     * @alpha Subject to change.
+     */
+    readonly composer: ComposerApi;
+
     /**
      * Create a ReactDOM root for rendering React components.
      * Exposed to allow modules to avoid needing to bundle their own ReactDOM.