@jetcrab/pi-desk-sdk 0.0.0-stage → 1.0.0

package/dist/session.js

@@ -0,0 +1,167 @@
+import { randomUUID } from 'node:crypto';
+import { normalizePluginIdentifier } from "./shared.js";
+export { PluginMethodError, isPluginMethodError } from "./errors.js";
+export const SESSION_PLUGIN_STATE_EVENT = 'pi-desk:session-plugins';
+export const SESSION_PLUGIN_METHOD_EVENT = 'pi-desk:session-plugin-methods:v1';
+export const SESSION_PLUGIN_PUSH_EVENT = 'pi-desk:session-plugin-push:v1';
+export const SESSION_PLUGIN_CAPABILITIES_EVENT = 'pi-desk:session-capabilities';
+export function bindSessionPlugin(pi, pluginName) {
+    const name = normalizePluginIdentifier(pluginName, 'pluginName');
+    return {
+        name,
+        setState(state) {
+            pi.events.emit(SESSION_PLUGIN_STATE_EVENT, { [name]: state });
+        },
+        push(eventInput, data) {
+            const event = normalizePluginIdentifier(eventInput, 'event');
+            pi.events.emit(SESSION_PLUGIN_PUSH_EVENT, {
+                pluginName: name,
+                event,
+                data
+            });
+        },
+        registerMethod(methodInput, execute) {
+            const method = normalizePluginIdentifier(methodInput, 'method');
+            const registration = {
+                pluginName: name,
+                method,
+                execute
+            };
+            pi.events.emit(SESSION_PLUGIN_METHOD_EVENT, { type: 'register', registration });
+            let registered = true;
+            return () => {
+                if (!registered)
+                    return;
+                registered = false;
+                pi.events.emit(SESSION_PLUGIN_METHOD_EVENT, { type: 'unregister', registration });
+            };
+        },
+        onCapabilitiesChange(execute) {
+            const registration = {
+                pluginName: name,
+                execute,
+                hostManaged: false
+            };
+            let active = true;
+            pi.events.emit(SESSION_PLUGIN_CAPABILITIES_EVENT, { type: 'register', registration });
+            const unregister = () => {
+                if (!active)
+                    return;
+                active = false;
+                pi.events.emit(SESSION_PLUGIN_CAPABILITIES_EVENT, { type: 'unregister', registration });
+            };
+            pi.on('session_start', async (_event, context) => {
+                if (active && !registration.hostManaged) {
+                    await execute({ tools: {}, skills: {}, capabilities: {} }, context);
+                }
+            });
+            pi.on('session_shutdown', unregister);
+            return unregister;
+        },
+        startTask(input) {
+            return startTask(pi, input);
+        },
+        reportTasks(tasks) {
+            reportTasks(pi, tasks);
+        }
+    };
+}
+export const TASK_REPORT_EVENT = 'pi-desk:task-report:v1';
+function timestamp() {
+    return Date.now();
+}
+function terminalTask(snapshot, status, activity) {
+    const source = snapshot.detailSource;
+    const session = source?.kind === 'pi-conversation' ? source.session : undefined;
+    const detailSource = session?.sessionFile
+        ? { kind: 'pi-conversation', sessionFile: session.sessionFile }
+        : source;
+    return {
+        ...snapshot,
+        status,
+        activity: activity === undefined ? snapshot.activity : activity,
+        endedAt: timestamp(),
+        detailSource,
+        interrupt: null
+    };
+}
+function emit(target, event) {
+    target.events.emit(TASK_REPORT_EVENT, event);
+}
+export function reportTasks(target, tasks) {
+    emit(target, { type: 'upsert', tasks });
+}
+export function startTask(target, input) {
+    let snapshot = {
+        taskId: input.taskId ?? randomUUID(),
+        taskKind: input.taskKind ?? null,
+        taskType: input.taskType ?? null,
+        title: input.title,
+        info: input.info?.map((item) => ({ ...item })) ?? [],
+        ...(input.infoLoader ? { infoLoader: input.infoLoader } : {}),
+        status: 'running',
+        activity: input.activity ?? null,
+        startedAt: input.startedAt ?? timestamp(),
+        endedAt: null,
+        detailSource: input.detailSource ?? null,
+        interrupt: input.interrupt ?? null
+    };
+    let removed = false;
+    const report = () => {
+        if (removed)
+            throw new Error('Task has been removed');
+        emit(target, { type: 'upsert', tasks: [snapshot] });
+    };
+    report();
+    return {
+        get taskId() {
+            return snapshot.taskId;
+        },
+        update(input) {
+            if (snapshot.status !== 'running')
+                throw new Error('Terminal task cannot be updated');
+            snapshot = {
+                ...snapshot,
+                ...input,
+                taskKind: input.taskKind === undefined ? snapshot.taskKind : input.taskKind,
+                taskType: input.taskType === undefined ? snapshot.taskType : input.taskType,
+                info: input.info === undefined ? snapshot.info : input.info.map((item) => ({ ...item })),
+                infoLoader: input.infoLoader === undefined ? snapshot.infoLoader : input.infoLoader,
+                activity: input.activity === undefined ? snapshot.activity : input.activity,
+                detailSource: input.detailSource === undefined ? snapshot.detailSource : input.detailSource,
+                interrupt: input.interrupt === undefined ? snapshot.interrupt : input.interrupt
+            };
+            report();
+        },
+        complete(activity) {
+            if (snapshot.status !== 'running')
+                throw new Error('Task is already terminal');
+            snapshot = terminalTask(snapshot, 'completed', activity);
+            report();
+        },
+        fail(activity) {
+            if (snapshot.status !== 'running')
+                throw new Error('Task is already terminal');
+            snapshot = terminalTask(snapshot, 'failed', activity);
+            report();
+        },
+        stopped(activity) {
+            if (snapshot.status !== 'running')
+                throw new Error('Task is already terminal');
+            snapshot = terminalTask(snapshot, 'stopped', activity);
+            report();
+        },
+        interrupted(activity) {
+            if (snapshot.status !== 'running')
+                throw new Error('Task is already terminal');
+            snapshot = terminalTask(snapshot, 'interrupted', activity);
+            report();
+        },
+        remove() {
+            if (removed)
+                return;
+            removed = true;
+            emit(target, { type: 'remove', taskIds: [snapshot.taskId] });
+        }
+    };
+}

package/dist/settings.d.ts

@@ -0,0 +1,24 @@
+import { z } from 'zod';
+import type { PluginDisposer } from './shared.js';
+export declare const HostRegionSchema: z.ZodReadonly<z.ZodObject<{
+    locale: z.ZodEnum<{
+        "zh-CN": "zh-CN";
+        en: "en";
+    }>;
+    timeZone: z.ZodString;
+}, z.core.$strict>>;
+export declare const HostSettingsSchema: z.ZodReadonly<z.ZodObject<{
+    region: z.ZodReadonly<z.ZodObject<{
+        locale: z.ZodEnum<{
+            "zh-CN": "zh-CN";
+            en: "en";
+        }>;
+        timeZone: z.ZodString;
+    }, z.core.$strict>>;
+}, z.core.$strict>>;
+export type HostRegion = z.infer<typeof HostRegionSchema>;
+export type HostSettingsSnapshot = z.infer<typeof HostSettingsSchema>;
+export interface HostSettings {
+    getSnapshot(): HostSettingsSnapshot;
+    subscribe(listener: () => void): PluginDisposer;
+}

package/dist/settings.js

@@ -0,0 +1,22 @@
+import { z } from 'zod';
+export const HostRegionSchema = z
+    .object({
+    locale: z.enum(['zh-CN', 'en']),
+    timeZone: z
+        .string()
+        .trim()
+        .min(1)
+        .max(100)
+        .refine((value) => {
+        try {
+            new Intl.DateTimeFormat('en', { timeZone: value });
+            return true;
+        }
+        catch {
+            return false;
+        }
+    }, '无效的 IANA 时区')
+})
+    .strict()
+    .readonly();
+export const HostSettingsSchema = z.object({ region: HostRegionSchema }).strict().readonly();

package/dist/shared.d.ts

@@ -0,0 +1,31 @@
+export type PluginJsonValue = null | boolean | number | string | PluginJsonValue[] | {
+    [key: string]: PluginJsonValue;
+};
+export type PluginJsonObject = {
+    [key: string]: PluginJsonValue;
+};
+export type PluginDisposer = () => void | Promise<void>;
+export type PluginNotificationLevel = 'info' | 'success' | 'warning' | 'error';
+export interface PluginSource {
+    readonly workId: string;
+    readonly sessionId: string;
+    readonly branchId: string;
+}
+export interface PluginWorkSession {
+    readonly source: PluginSource;
+    readonly cwd: string;
+    readonly status: 'main_running' | 'background_running' | 'completed' | 'idle';
+}
+export interface BrowserApplicationContext {
+    source: PluginSource;
+    cwd: string;
+}
+export type BrowserBuiltinIconName = 'plugin' | 'server' | 'rocket' | 'settings' | 'panel' | 'message' | 'terminal' | 'file' | 'folder' | 'bot' | 'wrench' | 'database' | 'globe';
+export type BrowserContributionIcon = {
+    type: 'builtin';
+    name: BrowserBuiltinIconName;
+} | {
+    type: 'svg';
+    content: string;
+};
+export declare function normalizePluginIdentifier(value: string, field: 'pluginName' | 'method' | 'contributionName' | 'declarationName' | 'event'): string;

package/dist/shared.js

@@ -0,0 +1,11 @@
+const PLUGIN_IDENTIFIER_PATTERN = /^[a-z0-9]+(?:-[a-z0-9]+)*$/;
+const PLUGIN_IDENTIFIER_MAX_LENGTH = 64;
+export function normalizePluginIdentifier(value, field) {
+    const normalized = value.trim();
+    if (normalized.length === 0 ||
+        normalized.length > PLUGIN_IDENTIFIER_MAX_LENGTH ||
+        !PLUGIN_IDENTIFIER_PATTERN.test(normalized)) {
+        throw new Error(`${field} must use lowercase kebab-case and contain 1-64 characters`);
+    }
+    return normalized;
+}

package/package.json

@@ -1,6 +1,121 @@
 {
   "name": "@jetcrab/pi-desk-sdk",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/JetCrab/pi-desk.git",
+    "directory": "plugins/pi-desk-sdk"
+  },
+  "version": "1.0.0",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org",
+    "access": "public"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./settings": {
+      "types": "./dist/settings.d.ts",
+      "import": "./dist/settings.js",
+      "default": "./dist/settings.js"
+    },
+    "./errors": {
+      "types": "./dist/errors.d.ts",
+      "import": "./dist/errors.js",
+      "default": "./dist/errors.js"
+    },
+    "./capabilities": {
+      "types": "./dist/capabilities.d.ts",
+      "import": "./dist/capabilities.js",
+      "default": "./dist/capabilities.js"
+    },
+    "./entry": {
+      "types": "./dist/entry.d.ts",
+      "import": "./dist/entry.js",
+      "default": "./dist/entry.js"
+    },
+    "./session": {
+      "types": "./dist/session.d.ts",
+      "import": "./dist/session.js",
+      "default": "./dist/session.js"
+    },
+    "./browser": {
+      "types": "./dist/browser.d.ts",
+      "import": "./dist/browser.js",
+      "default": "./dist/browser.js"
+    },
+    "./react": {
+      "types": "./dist/react.d.ts",
+      "import": "./dist/react.js",
+      "default": "./dist/react.js"
+    },
+    "./react/base": {
+      "types": "./dist/react-base.d.ts",
+      "import": "./dist/react-base.js",
+      "default": "./dist/react-base.js"
+    },
+    "./react/markdown": {
+      "types": "./dist/react-markdown.d.ts",
+      "import": "./dist/react-markdown.js",
+      "default": "./dist/react-markdown.js"
+    },
+    "./host-runtime/*": "./dist/host-runtime/*"
+  },
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "dependencies": {
+    "zod": "^4.4.3"
+  },
+  "peerDependencies": {
+    "@base-ui/react": "^1.7.0",
+    "@earendil-works/pi-coding-agent": "*",
+    "@streamdown/cjk": "^1.0.3",
+    "lucide-react": "^1.31.0",
+    "react": ">=19",
+    "react-dom": ">=19",
+    "streamdown": "^2.5.0"
+  },
+  "peerDependenciesMeta": {
+    "@base-ui/react": {
+      "optional": true
+    },
+    "@earendil-works/pi-coding-agent": {
+      "optional": true
+    },
+    "@streamdown/cjk": {
+      "optional": true
+    },
+    "lucide-react": {
+      "optional": true
+    },
+    "react": {
+      "optional": true
+    },
+    "react-dom": {
+      "optional": true
+    },
+    "streamdown": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@base-ui/react": "^1.7.0",
+    "@streamdown/cjk": "^1.0.3",
+    "esbuild": "^0.28.2",
+    "lucide-react": "^1.31.0",
+    "react": "19.2.8",
+    "react-dom": "19.2.8",
+    "streamdown": "^2.5.0"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json && node scripts/build-host-runtime.mjs",
+    "test": "pnpm run build && node --test tests/*.test.mjs"
+  }
 }