@tomradex/plugin-sdk 0.2.19 → 0.2.26

package/dist/im.d.ts

@@ -65,6 +65,20 @@ export type ImInbound = {
 });
 /** How an adapter writes formatted text. `markdown` passes the common layer's Markdown through unchanged. */
 export type ImMarkdownDialect = "plain" | "markdown" | "slack" | "telegram-html" | "discord" | "lark" | "dingtalk" | "wecom";
+/** SDK 0.2.20. */
+export interface ImLink {
+    label: Localized;
+    url: string;
+}
+/** SDK 0.2.20. Something on a connection the person has to fix, such as a permission the bot lacks. */
+export interface ImNotice {
+    /** Said once per key, until `clearNotice` withdraws it. */
+    key: string;
+    text: Localized;
+    /** The conversation it happened in hears one line; when it cannot, the paired people's direct chats do. */
+    address?: ImAddress;
+    link?: ImLink;
+}
 export interface ImButton {
     label: string;
     token: string;
@@ -185,6 +199,19 @@ export interface ImAdapterSession {
         id: string;
         name?: string;
     };
+    /**
+     * SDK 0.2.20. Links the person may need once the connection is up, such as
+     * the one that adds the bot to a server; shown on the connection and in the
+     * pairing reply. Older hosts ignore them.
+     */
+    links?: ImLink[];
+    /**
+     * SDK 0.2.24. A conversation's name as the platform shows it (`#tomrade-work`, a group's title), for Settings to
+     * show instead of its id; null when it has none or the bot may not see it. Older hosts never ask.
+     */
+    describe?(address: ImAddress): Promise<{
+        name?: string;
+    } | null>;
     /**
      * SDK 0.2.19. Topics the bot opens itself, when `topics`: one per ticket
      * being worked in a group conversation. Messages people write in one arrive
@@ -232,6 +259,11 @@ export interface ImAdapterSetup {
         text: string;
     };
     docsUrl?: string;
+    /**
+     * SDK 0.2.22. How to start using the connected bot in a group or server, in order; Markdown. Settings shows them
+     * under the connection, then what each kind of channel does. Without them it shows generic steps.
+     */
+    groupSteps?: Localized[];
 }
 /** What the platform can do. Fields marked 0.2.5 are optional; leaving them out declares the 0.2.2 behaviour. */
 export interface ImCapabilities {
@@ -330,6 +362,28 @@ export interface ImAdapter {
         status(state: ImConnectionState, detail?: string): void;
         /** Reads only handles explicitly included in a delivery for this connection. */
         readOutboundFile(id: string): Promise<Uint8Array>;
+        /** SDK 0.2.20, absent on older hosts. Shows a notice on the connection and tells it where it happened. */
+        notice?(notice: ImNotice): void;
+        /** SDK 0.2.20, absent on older hosts. The notice's cause is gone; the same key may be said again. */
+        clearNotice?(key: string): void;
+        /** SDK 0.2.21, absent on older hosts. The projects a person paired on this connection may give a conversation, the one they used last first; none for anyone else. */
+        projects?(actorId: string): {
+            id: string;
+            name: string;
+        }[];
+        /**
+         * SDK 0.2.21, absent on older hosts. For an adapter's own setup: a paired person makes a group conversation a
+         * work channel (a thread per ticket), a status channel (news only) or a chat channel of the project, as the card
+         * in a group with no route does, and the conversation is told. One already allowed is left as it is. False when
+         * they may not.
+         */
+        allow?(request: {
+            actorId: string;
+            address: ImAddress;
+            kind: "work" | "status" | "chat";
+            projectId: string; /** SDK 0.2.24. The conversation's name, when the adapter knows it. */
+            name?: string;
+        }): boolean;
     }): Promise<ImAdapterSession>;
 }
 export interface ImApi {

package/dist/local-agents.d.ts

@@ -46,21 +46,41 @@ export interface LocalAgentPick {
 /**
  * SDK 0.2.18. An installer script the app runs for the person: `script` (a
  * POSIX shell installer) as `curl -fsSL <url> | bash`, `powershell` as
- * `irm <url> | iex`. Plugin code names only the address.
+ * `irm <url> | iex`. SDK 0.2.26 adds `npm`, a package installed with
+ * `npm install -g` — through the app's own npm on a machine without Node.
+ * Plugin code names only the address or package; these also run as the
+ * one-click setup, in the declared order, each on the platforms it fits.
  */
 export type LocalAgentInstaller = {
     script: string;
 } | {
     powershell: string;
+} | {
+    npm: string;
 };
 /** How the agent is installed and signed in, for setup screens. */
 export interface LocalAgentSetup {
-    /** Install commands, the recommended one first; an installer script by its address (SDK 0.2.18). */
+    /** Install commands, the recommended one first; an installer by its address or package (SDK 0.2.18, npm 0.2.26). */
     install: (string | LocalAgentInstaller)[];
     signIn?: string;
     /** Signing in starts the agent itself, which then asks; otherwise the command signs in and returns. */
     signInRuns?: boolean;
+    /**
+     * SDK 0.2.26. A sign-in command the app runs and watches itself: it opens or
+     * prints a browser address and needs no typing; the agent counts as signed in
+     * once `probe`/`signedIn` says so. Without it, signing in takes a terminal.
+     */
+    signInRun?: {
+        args: string[];
+    };
     docs?: string;
+    /** SDK 0.2.25. The agent's official download page, opened in the system browser beside these commands, for those without the tools they need: one that offers the CLI. */
+    download?: string;
+    /** SDK 0.2.25. The agent's desktop app, when it has one: whether installing it puts the CLI where Tomrade finds it. Setup screens say so either way. */
+    desktop?: {
+        title: string;
+        shipsCli: boolean;
+    };
     suggested?: boolean;
 }
 /** The machine a CLI is looked for on, for `cli.bundled`. */
@@ -222,9 +242,14 @@ export interface LocalAgentAcp<O> {
     efforts?: string[];
     /** The agent's own words for a turn it ended on "refusal". */
     failure?(response: Record<string, any>): string | undefined;
-    /** Its CLI can also be handed a ticket in a terminal. */
-    terminal?: boolean;
-    /** In a terminal it reaches Tomrade only through its user-level connection (`mcpLink`). */
+    /**
+     * Its CLI can also be handed a ticket in a terminal. SDK 0.2.23: `{ via: "link" }` says it reaches Tomrade
+     * there only through its user-level connection (`mcpLink`); absent `via` is `"session"`.
+     */
+    terminal?: boolean | {
+        via?: "session" | "link";
+    };
+    /** @deprecated since SDK 0.2.23: `terminal: { via: "link" }`. Still read, for plugins built before it. */
     terminalViaLink?: boolean;
 }
 /**

package/dist/manifest.d.ts

@@ -1,6 +1,6 @@
 import { z } from "zod";
 /** The contract this SDK describes. A plugin's `engines.sdk` range is checked against the host's. */
-export declare const SDK_CONTRACT = "0.2.19";
+export declare const SDK_CONTRACT = "0.2.26";
 export declare const PLUGIN_ID: RegExp;
 export declare const NAMESPACE: RegExp;
 /** The app's own names, and the official publisher's. */

package/dist/manifest.js

@@ -2,7 +2,7 @@ import { z } from "zod";
 import { LANGUAGE_PACK_LIMITS, LanguageEntrySchema } from "./language.js";
 import { isRange, isVersion } from "./semver.js";
 /** The contract this SDK describes. A plugin's `engines.sdk` range is checked against the host's. */
-export const SDK_CONTRACT = "0.2.19";
+export const SDK_CONTRACT = "0.2.26";
 export const PLUGIN_ID = /^[a-z0-9][a-z0-9-]{0,38}\/[a-z0-9][a-z0-9-]{0,63}$/;
 export const NAMESPACE = /^[a-z][a-z0-9_]{1,31}$/;
 /** The app's own names, and the official publisher's. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tomradex/plugin-sdk",
-  "version": "0.2.19",
+  "version": "0.2.26",
   "type": "module",
   "author": "Haoyuan Tang",
   "engines": {
@@ -29,7 +29,7 @@
     "dist"
   ],
   "dependencies": {
-    "@tomradex/domain": "0.2.19",
+    "@tomradex/domain": "0.2.26",
     "zod": "^4.4.3"
   }
 }