@plumeai/plugin-sdk 0.0.0-stage → 0.1.3

package/template/src/index.ts

@@ -0,0 +1,28 @@
+/**
+ * __NAME__ 的逻辑入口，跑在 agent 进程。
+ *
+ * 模板生成的示例：注册工具 __TOOL__，结果的 details 交给界面入口画成卡片。换成你自己的逻辑；写法见 skill plume-plugin。
+ */
+
+import type { Plugin } from "@plume/contract";
+import type { GreetingDetails } from "./types.ts";
+
+export default {
+	name: "__NAME__",
+	apply(ctx) {
+		ctx.tools.register({
+			name: "__TOOL__",
+			description: "Greet someone by name.",
+			parameters: {
+				type: "object",
+				properties: { name: { type: "string", description: "Who to greet." } },
+				required: ["name"],
+			},
+			async execute(args) {
+				const name = args.name;
+				if (typeof name !== "string" || name.trim() === "") return { output: "name must be a non-empty string", isError: true };
+				return { output: `Hello, ${name}!`, details: { name } satisfies GreetingDetails };
+			},
+		});
+	},
+} satisfies Plugin;

package/template/src/messages.ts

@@ -0,0 +1,16 @@
+/** 界面上给人看的文字，两种界面语言写在一起；界面入口用 @plume/ui 的 useI18n() 取当前语言。 */
+
+import type { Locale } from "@plume/contract";
+
+const zhCN = {
+	greeting: "问候",
+	hello: (name: string) => `你好，${name}！`,
+};
+
+export const MESSAGES: Record<Locale, typeof zhCN> = {
+	"zh-CN": zhCN,
+	en: {
+		greeting: "Greeting",
+		hello: (name: string) => `Hello, ${name}!`,
+	},
+};

package/template/src/types.ts

@@ -0,0 +1,8 @@
+/** 工具结果的 details：逻辑入口写进去，界面入口的卡片读出来。会话里存的可能是旧版本写的，读之前先校验。 */
+export interface GreetingDetails {
+	name: string;
+}
+
+export function isGreeting(value: unknown): value is GreetingDetails {
+	return typeof value === "object" && value !== null && typeof (value as { name?: unknown }).name === "string";
+}

package/template/src/ui.tsx

@@ -0,0 +1,30 @@
+/**
+ * __NAME__ 的界面入口，跑在渲染进程：把 __TOOL__ 的结果画成一张卡片。details 认不出时用通用卡片。
+ *
+ * 样式只用 @plume/ui 的组件（文字用 Text）和 var(--plume-*)，不写 Tailwind 类（插件单独构建，产品扫不到）。
+ */
+
+import type { ToolCardProps, UiPlugin } from "@plume/contract/ui";
+import { Card, Text, useI18n } from "@plume/ui";
+import { MESSAGES } from "./messages.ts";
+import { isGreeting } from "./types.ts";
+
+function GreetingCard({ status, result, fallback }: ToolCardProps) {
+	const text = MESSAGES[useI18n().resolvedLocale];
+	const details = result?.details;
+	if (status === "failed" || !isGreeting(details)) return <>{fallback}</>;
+	return (
+		<Card title={text.greeting}>
+			<Text as="p" size="body" tone="muted">
+				{text.hello(details.name)}
+			</Text>
+		</Card>
+	);
+}
+
+export default {
+	name: "__NAME__",
+	apply(ui) {
+		ui.toolCard("__TOOL__", GreetingCard);
+	},
+} satisfies UiPlugin;

package/template/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "@plumeai/plugin-sdk/tsconfig.json",
+  "compilerOptions": {
+    "types": ["node"]
+  },
+  "include": ["src"]
+}

package/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  // 插件继承这一份：`"extends": "@plumeai/plugin-sdk/tsconfig.json"`。
+  // paths 把宿主的公开接口指到 SDK 生成的声明上（路径相对这个文件），插件的写法和仓库里的一样。
+  "compilerOptions": {
+    "target": "ES2023",
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "lib": ["ES2023", "DOM", "DOM.Iterable"],
+    "strict": true,
+    "noUncheckedIndexedAccess": true,
+    "verbatimModuleSyntax": true,
+    "allowImportingTsExtensions": true,
+    "noEmit": true,
+    "skipLibCheck": true,
+    "isolatedModules": true,
+    "jsx": "react-jsx",
+    "paths": {
+      "@plume/contract": ["./dist/contract/src/index.d.ts"],
+      "@plume/contract/ui": ["./dist/contract/src/ui.d.ts"],
+      "@plume/ui": ["./dist/ui.d.ts"],
+      "@plume/ui/icons": ["./dist/client/ui/src/icons/index.d.ts"],
+      "@plume/styles": ["./dist/client/styles/src/index.d.ts"]
+    }
+  }
+}

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.