@tomradex/plugin-sdk 0.2.18 → 0.2.24

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,41 @@ 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
+     * with its `topicId`.
+     */
+    topics?: {
+        open(command: {
+            operationId: string;
+            address: ImAddress;
+            title: string;
+        }): Promise<{
+            topicId: string;
+        }>;
+        /** Renames it, and closes it out of the way or opens it again. */
+        update(command: {
+            address: ImAddress & {
+                topicId: string;
+            };
+            title: string;
+            closed: boolean;
+        }): Promise<void>;
+    };
     close(): void | Promise<void>;
 }
 /** SDK 0.2.5. One value a person copies from the platform's developer console. */
@@ -210,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 {
@@ -221,6 +275,8 @@ export interface ImCapabilities {
     maxFileBytes: number;
     /** SDK 0.2.5. Replies can go into a thread under the triggering message. */
     threads?: boolean;
+    /** SDK 0.2.19. The bot opens a topic per ticket in a group, through `session.topics`. */
+    topics?: boolean;
     reactions?: boolean;
     typing?: boolean;
     /** `native`: session.stream. `edit`: throttled edits of one message. `none`: only the final message. */
@@ -254,6 +310,7 @@ export declare const ImCapabilitiesSchema: z.ZodObject<{
     maxTextLength: z.ZodNumber;
     maxFileBytes: z.ZodNumber;
     threads: z.ZodOptional<z.ZodBoolean>;
+    topics: z.ZodOptional<z.ZodBoolean>;
     reactions: z.ZodOptional<z.ZodBoolean>;
     typing: z.ZodOptional<z.ZodBoolean>;
     stream: z.ZodOptional<z.ZodEnum<{
@@ -305,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/im.js

@@ -10,6 +10,7 @@ export const ImCapabilitiesSchema = z.object({
     maxTextLength: z.number().int().min(128),
     maxFileBytes: z.number().int().min(0),
     threads: z.boolean().optional(),
+    topics: z.boolean().optional(),
     reactions: z.boolean().optional(),
     typing: z.boolean().optional(),
     stream: z.enum(["native", "edit", "none"]).optional(),
@@ -28,6 +29,7 @@ export function resolveImCapabilities(caps) {
     return {
         ...parsed,
         threads: parsed.threads ?? false,
+        topics: parsed.topics ?? false,
         reactions: parsed.reactions ?? false,
         typing: parsed.typing ?? false,
         stream: parsed.stream ?? "none",

package/dist/local-agents.d.ts

@@ -222,9 +222,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.18";
+export declare const SDK_CONTRACT = "0.2.24";
 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.18";
+export const SDK_CONTRACT = "0.2.24";
 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.18",
+  "version": "0.2.24",
   "type": "module",
   "author": "Haoyuan Tang",
   "engines": {
@@ -29,7 +29,7 @@
     "dist"
   ],
   "dependencies": {
-    "@tomradex/domain": "0.2.18",
+    "@tomradex/domain": "0.2.24",
     "zod": "^4.4.3"
   }
 }