@capybara-hq/plugin-sdk 0.0.0-stage → 0.1.0-rc.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,2 @@
+Capybara
+Copyright 2026 Meta-1 (Tianjin Yuanyilian Technology Co., Ltd.)

package/README.md

@@ -1,3 +1,28 @@
-# Temporary Holding Version
+# @capybara-hq/plugin-sdk
 
-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.
+The SDK for writing plugins for [Capybara](https://github.com/capybara-hq/core), an open-source enterprise agent platform. It holds
+the types, extension point contracts (`model-provider@2`, `channel@1`, `connector@1`, `sandbox@1`,
+`object-store@1` and others) and pure functions that a plugin's extension is written against, and the
+package formats: the plugin manifest `.capybara-plugin/plugin.json` (`parsePluginManifest`),
+connector template files `connectors/<id>.json` (`parseConnectorTemplateFile`) and the marketplace
+manifest `marketplace.json` (`parseMarketplaceManifest`), with their JSON Schemas in `schemas/`
+(`plugin.v1`, `connector-template.v1`, `marketplace.v1`; reference them from a file's `$schema` as
+`https://capybarahq.com/schemas/<file>`). An extension depends only on this package and third-party
+npm packages; the host provides it at runtime.
+
+```bash
+npm install @capybara-hq/plugin-sdk
+```
+
+- Writing an extension: [.agents/skills/writing-extensions](https://github.com/capybara-hq/core/tree/main/.agents/skills/writing-extensions)
+  and the reference plugin [plugins/example-counter](https://github.com/capybara-hq/core/tree/main/plugins/example-counter).
+- Writing a plugin (manifest, skills, connector templates, dependencies, marketplaces):
+  [.agents/skills/writing-plugins](https://github.com/capybara-hq/core/tree/main/.agents/skills/writing-plugins).
+- The repository: [capybara-hq/core](https://github.com/capybara-hq/core).
+
+Capybara is on 0.x: the SDK may change in breaking ways between minor versions, and each release's
+notes describe how to migrate.
+
+## License
+
+[Apache-2.0](https://github.com/capybara-hq/core/blob/main/LICENSE). See `NOTICE`.

package/dist/agent-template.d.ts

@@ -0,0 +1,47 @@
+/** The model tier of a template: a kernel purpose, never a model id (spec §5.4). */
+export type AgentTemplateTier = "inherit" | "fast" | "standard" | "capable";
+/** A parsed agent template. Optional fields are absent when the frontmatter omits them. */
+export interface AgentTemplate {
+    /** `^[a-z0-9][a-z0-9-]{0,63}$`; the type name is `<plugin>:<name>`. */
+    name: string;
+    /** When to use it (trimmed, at most 4096 characters). */
+    description: string;
+    /** The body after the frontmatter, unchanged. */
+    instructions: string;
+    /** Tool keys allowed (an allowlist); omitted = the parent's tools. */
+    tools?: string[];
+    /** Tool keys removed. */
+    disallowedTools?: string[];
+    /** Tightened policies by tool key. */
+    toolPolicies?: Record<string, "ask" | "deny">;
+    /** Default `inherit`. */
+    model?: AgentTemplateTier;
+    effort?: "low" | "medium" | "high" | "xhigh" | "max";
+    /** Step limit (the kernel caps it at `runtime.maxSteps`). */
+    maxSteps?: number;
+    /** Skill names preloaded (pinned) in the sub-agent. */
+    skills?: string[];
+}
+/** Limits of agent templates. */
+export declare const AGENT_TEMPLATE_LIMITS: {
+    /** Characters of the body (instructions). */
+    readonly bodyChars: 100000;
+    readonly descriptionChars: 4096;
+    /** Templates in one plugin. */
+    readonly perPlugin: 64;
+    /** Preloaded skills. */
+    readonly skills: 3;
+    /** Entries of `tools` and of `disallowedTools`. */
+    readonly tools: 200;
+};
+/** The name rule of a template (the catalog item name rule). */
+export declare const AGENT_TEMPLATE_NAME_RE: RegExp;
+/**
+ * Parses an agent template file. Returns the template, or every problem found (English, for the
+ * plugin author or an admin). Keys the format does not define are ignored. Never throws.
+ */
+export declare function parseAgentTemplate(text: string): {
+    template: AgentTemplate;
+} | {
+    errors: string[];
+};

package/dist/agent-template.js

@@ -0,0 +1,123 @@
+/**
+ * Agent templates (`agents/<name>.md` in a plugin; sub-agents spec §16.1): Markdown with YAML
+ * frontmatter, the body being the instructions. A template is a type an agent with the builtin
+ * `agent` tool can dispatch as a sub-agent (`<plugin>:<name>` in its roster). Used by the kernel,
+ * the packer and `capybara-plugin check`.
+ */
+import { readFrontmatter } from "./frontmatter.js";
+import { isSkillName } from "./skill.js";
+/** Limits of agent templates. */
+export const AGENT_TEMPLATE_LIMITS = {
+    /** Characters of the body (instructions). */
+    bodyChars: 100_000,
+    descriptionChars: 4096,
+    /** Templates in one plugin. */
+    perPlugin: 64,
+    /** Preloaded skills. */
+    skills: 3,
+    /** Entries of `tools` and of `disallowedTools`. */
+    tools: 200,
+};
+/** The name rule of a template (the catalog item name rule). */
+export const AGENT_TEMPLATE_NAME_RE = /^[a-z0-9][a-z0-9-]{0,63}$/;
+const TIERS = ["inherit", "fast", "standard", "capable"];
+const EFFORTS = ["low", "medium", "high", "xhigh", "max"];
+const FRONTMATTER_MAX_CHARS = 64 * 1024;
+/** The kernel's tool key rule (model-visible keys): no dots, no whitespace, at most 64 chars. */
+const TOOL_KEY_RE = /^[a-zA-Z0-9_-]{1,64}$/;
+const chars = (s) => [...s].length;
+const isToolKey = (v) => typeof v === "string" && TOOL_KEY_RE.test(v);
+const toolList = (v) => Array.isArray(v) &&
+    v.length <= AGENT_TEMPLATE_LIMITS.tools &&
+    v.every(isToolKey) &&
+    new Set(v).size === v.length;
+const toolListRule = `a list of at most ${AGENT_TEMPLATE_LIMITS.tools} distinct tool keys (letters, digits, _ and -, up to 64 characters)`;
+/**
+ * Parses an agent template file. Returns the template, or every problem found (English, for the
+ * plugin author or an admin). Keys the format does not define are ignored. Never throws.
+ */
+export function parseAgentTemplate(text) {
+    const read = readFrontmatter(text, "an agent template", FRONTMATTER_MAX_CHARS);
+    if ("errors" in read)
+        return read;
+    const { frontmatter: fm, body } = read;
+    const errors = [];
+    const L = AGENT_TEMPLATE_LIMITS;
+    const name = fm.name;
+    if (name === undefined || name === null)
+        errors.push("name is required");
+    else if (typeof name !== "string" || !AGENT_TEMPLATE_NAME_RE.test(name)) {
+        errors.push("name must match ^[a-z0-9][a-z0-9-]{0,63}$");
+    }
+    let description = "";
+    if (fm.description === undefined || fm.description === null) {
+        errors.push("description is required");
+    }
+    else if (typeof fm.description !== "string" || fm.description.trim() === "") {
+        errors.push("description must be a non-empty string");
+    }
+    else {
+        description = fm.description.trim();
+        if (chars(description) > L.descriptionChars) {
+            errors.push(`description must be at most ${L.descriptionChars} characters`);
+        }
+    }
+    if (chars(body) > L.bodyChars) {
+        errors.push(`the body (instructions) must be at most ${L.bodyChars} characters`);
+    }
+    const out = { name: name, description, instructions: body };
+    if (fm.tools !== undefined) {
+        if (toolList(fm.tools))
+            out.tools = fm.tools;
+        else
+            errors.push(`tools must be ${toolListRule}`);
+    }
+    if (fm.disallowedTools !== undefined) {
+        if (toolList(fm.disallowedTools))
+            out.disallowedTools = fm.disallowedTools;
+        else
+            errors.push(`disallowedTools must be ${toolListRule}`);
+    }
+    if (fm.toolPolicies !== undefined) {
+        const p = fm.toolPolicies;
+        const ok = p !== null &&
+            typeof p === "object" &&
+            !Array.isArray(p) &&
+            Object.keys(p).length <= L.tools &&
+            Object.entries(p).every(([k, v]) => isToolKey(k) && (v === "ask" || v === "deny"));
+        if (ok)
+            out.toolPolicies = { ...p };
+        else
+            errors.push("toolPolicies must map tool keys to ask or deny");
+    }
+    if (fm.model !== undefined) {
+        if (TIERS.includes(fm.model))
+            out.model = fm.model;
+        else
+            errors.push(`model must be one of ${TIERS.join(", ")}`);
+    }
+    if (fm.effort !== undefined) {
+        if (EFFORTS.includes(fm.effort)) {
+            out.effort = fm.effort;
+        }
+        else
+            errors.push(`effort must be one of ${EFFORTS.join(", ")}`);
+    }
+    if (fm.maxSteps !== undefined) {
+        if (Number.isInteger(fm.maxSteps) && fm.maxSteps >= 1) {
+            out.maxSteps = fm.maxSteps;
+        }
+        else
+            errors.push("maxSteps must be an integer of at least 1");
+    }
+    if (fm.skills !== undefined) {
+        const s = fm.skills;
+        if (Array.isArray(s) && s.length <= L.skills && s.every(isSkillName))
+            out.skills = s;
+        else
+            errors.push(`skills must list at most ${L.skills} skill names`);
+    }
+    if (errors.length > 0)
+        return { errors };
+    return { template: out };
+}

package/dist/bootstrap.d.ts

@@ -0,0 +1,67 @@
+import { z } from "zod";
+/**
+ * The bootstrap manifest `packages/kernel/bootstrap.json` (package ecosystem spec §7): the plugins
+ * a deployment installs at init, each pinned to an exact version and the sha512 of its tgz. The
+ * bootstrap step verifies every tgz against `integrity` before reading it.
+ *
+ * Two entry kinds: `source: "npm"` (the published package; the official `marketplace` commit is then
+ * required, and `check:bootstrap` compares the entries with it) and `source: "workspace"` (until
+ * the official plugins are published: `path` is packed with `packages/plugin-tools`, which is
+ * byte-reproducible, and `integrity` is that pack's sha512).
+ *
+ * Objects are strict (unknown keys rejected, `$schema` allowed): the manifest ships with core, so
+ * there is no older reader to stay compatible with and a misspelt key is a mistake. The committed
+ * JSON Schema (`schemas/bootstrap.v1.schema.json`) is generated from {@link BootstrapManifestSchema}
+ * by `pnpm gen:package-schemas`; the cross-field rules (unique names, `marketplace` required with an
+ * npm entry) are decided only by {@link parseBootstrapManifest}.
+ */
+/** Manifest format version. */
+export declare const BOOTSTRAP_MANIFEST_SCHEMA_VERSION = 1;
+/** One pinned plugin. */
+export type BootstrapEntry = {
+    /** Catalog item name (`^[a-z0-9][a-z0-9-]{0,63}$`). */
+    name: string;
+    source: "npm";
+    /** npm package name. */
+    npm: string;
+    /** Exact semver. */
+    version: string;
+    /** `sha512-<base64>` of the package tgz. */
+    integrity: string;
+    /** Enabled in every org and neither disableable nor uninstallable. */
+    required: boolean;
+} | {
+    name: string;
+    source: "workspace";
+    /** `plugins/<dir>`, relative to the repository root. */
+    path: string;
+    version: string;
+    integrity: string;
+    required: boolean;
+};
+/** `bootstrap.json`. */
+export interface BootstrapManifest {
+    $schema?: string;
+    schemaVersion: 1;
+    /** The official marketplace commit the npm entries are checked against; required with npm entries. */
+    marketplace?: {
+        url: string;
+        commit: string;
+    };
+    /** Names are unique. */
+    plugins: BootstrapEntry[];
+}
+/**
+ * The zod schema of `bootstrap.json` (strict objects). The JSON Schema is generated with
+ * `z.toJSONSchema(BootstrapManifestSchema, { io: "input" })`.
+ */
+export declare const BootstrapManifestSchema: z.ZodType<BootstrapManifest>;
+/**
+ * Validates and parses `bootstrap.json`. Invalid input returns `{ errors }` (`<path>: <reason>`, at
+ * most 50); never throws.
+ */
+export declare function parseBootstrapManifest(json: unknown): BootstrapManifest | {
+    errors: string[];
+};
+/** The file name of an entry's tgz in the bootstrap directory: `<name>-<version>.tgz`. */
+export declare function bootstrapFileName(e: BootstrapEntry): string;

package/dist/bootstrap.js

@@ -0,0 +1,109 @@
+import { z } from "zod";
+import { CATALOG_ITEM_NAME_RE, NPM_PACKAGE_NAME_RE, SEMVER_VERSION_RE, SHA512_INTEGRITY_RE, } from "./plugin-package.js";
+/**
+ * The bootstrap manifest `packages/kernel/bootstrap.json` (package ecosystem spec §7): the plugins
+ * a deployment installs at init, each pinned to an exact version and the sha512 of its tgz. The
+ * bootstrap step verifies every tgz against `integrity` before reading it.
+ *
+ * Two entry kinds: `source: "npm"` (the published package; the official `marketplace` commit is then
+ * required, and `check:bootstrap` compares the entries with it) and `source: "workspace"` (until
+ * the official plugins are published: `path` is packed with `packages/plugin-tools`, which is
+ * byte-reproducible, and `integrity` is that pack's sha512).
+ *
+ * Objects are strict (unknown keys rejected, `$schema` allowed): the manifest ships with core, so
+ * there is no older reader to stay compatible with and a misspelt key is a mistake. The committed
+ * JSON Schema (`schemas/bootstrap.v1.schema.json`) is generated from {@link BootstrapManifestSchema}
+ * by `pnpm gen:package-schemas`; the cross-field rules (unique names, `marketplace` required with an
+ * npm entry) are decided only by {@link parseBootstrapManifest}.
+ */
+/** Manifest format version. */
+export const BOOTSTRAP_MANIFEST_SCHEMA_VERSION = 1;
+const MAX_ERRORS = 50;
+const URL_CHARS = 2000;
+const COMMIT_RE = /^[0-9a-f]{40}$/;
+const HTTPS_URL_RE = /^https:\/\/\S+$/;
+const WORKSPACE_PATH_RE = /^plugins\/[a-z0-9][a-z0-9-]{0,63}$/;
+const common = {
+    name: z
+        .string()
+        .regex(CATALOG_ITEM_NAME_RE, { message: "name must match ^[a-z0-9][a-z0-9-]{0,63}$" }),
+    version: z
+        .string()
+        .max(256)
+        .regex(SEMVER_VERSION_RE, { message: "version must be an exact semver version" }),
+    integrity: z
+        .string()
+        .regex(SHA512_INTEGRITY_RE, { message: "integrity must be sha512-<86 base64 chars>==" }),
+    required: z.boolean(),
+};
+const entry = z.discriminatedUnion("source", [
+    z.strictObject({
+        ...common,
+        source: z.literal("npm"),
+        npm: z
+            .string()
+            .max(214)
+            .regex(NPM_PACKAGE_NAME_RE, { message: "npm must be an npm package name" }),
+    }),
+    z.strictObject({
+        ...common,
+        source: z.literal("workspace"),
+        path: z.string().regex(WORKSPACE_PATH_RE, { message: "path must be plugins/<dir>" }),
+    }),
+]);
+const schema = z
+    .strictObject({
+    $schema: z.string().max(URL_CHARS).optional(),
+    schemaVersion: z.literal(BOOTSTRAP_MANIFEST_SCHEMA_VERSION),
+    marketplace: z
+        .strictObject({
+        url: z.string().max(URL_CHARS).regex(HTTPS_URL_RE, { message: "url must be an https URL" }),
+        commit: z.string().regex(COMMIT_RE, { message: "commit must be 40 hex characters" }),
+    })
+        .optional(),
+    plugins: z.array(entry).max(500),
+})
+    .superRefine((m, ctx) => {
+    const seen = new Set();
+    m.plugins.forEach((e, i) => {
+        if (seen.has(e.name)) {
+            ctx.addIssue({
+                code: "custom",
+                path: ["plugins", i, "name"],
+                message: `duplicate entry ${e.name}`,
+            });
+        }
+        seen.add(e.name);
+    });
+    if (m.marketplace === undefined && m.plugins.some((e) => e.source === "npm")) {
+        ctx.addIssue({
+            code: "custom",
+            path: ["marketplace"],
+            message: 'required when an entry has source "npm"',
+        });
+    }
+});
+/**
+ * The zod schema of `bootstrap.json` (strict objects). The JSON Schema is generated with
+ * `z.toJSONSchema(BootstrapManifestSchema, { io: "input" })`.
+ */
+export const BootstrapManifestSchema = schema;
+/**
+ * Validates and parses `bootstrap.json`. Invalid input returns `{ errors }` (`<path>: <reason>`, at
+ * most 50); never throws.
+ */
+export function parseBootstrapManifest(json) {
+    const r = BootstrapManifestSchema.safeParse(json);
+    if (r.success)
+        return r.data;
+    return {
+        errors: r.error.issues.slice(0, MAX_ERRORS).map((i) => {
+            const path = i.path.map(String).join(".");
+            return path ? `${path}: ${i.message}` : i.message;
+        }),
+    };
+}
+/** The file name of an entry's tgz in the bootstrap directory: `<name>-<version>.tgz`. */
+export function bootstrapFileName(e) {
+    return `${e.name}-${e.version}.tgz`;
+}

package/dist/cards.d.ts

@@ -0,0 +1,64 @@
+import { type FormAnswer, type InputForm } from "./tool.js";
+/**
+ * 渠道中立的 IM 卡片：由内核定义与产出，渠道插件按各自 IM 的原生格式渲染；
+ * 不支持卡片的渠道用 {@link renderCardAsText} 退回为文本。
+ */
+export type ChannelCard = {
+    kind: "approval";
+    id: string;
+    title: string;
+    toolName: string;
+    appName?: string;
+    agentName: string;
+    inputPreview: string;
+    scopes: ("once" | "session" | "always")[];
+    expiresAt: string;
+    state: "pending" | "approved" | "denied" | "expired" | "cancelled";
+    decidedBy?: string;
+    /** A denied approval: the reason the person gave (plain text, never formatted). */
+    denyReason?: string;
+    /** 可决定该审批的会话网页链接。 */
+    webUrl: string;
+} | {
+    kind: "question";
+    id: string;
+    form: InputForm;
+    state: "pending" | "answered" | "expired" | "cancelled";
+    answerSummary?: string;
+    webUrl: string;
+} | {
+    kind: "connect";
+    appName: string;
+    url: string;
+} | {
+    kind: "bind";
+    url: string;
+    text: string;
+};
+/** 用户在 IM 卡片上的操作，由渠道插件解析后经入站事件交给内核。 */
+export interface CardAction {
+    cardKind: "approval" | "question";
+    cardId: string;
+    action: "approve" | "deny" | "answer";
+    scope?: "once" | "session" | "always";
+    answer?: FormAnswer;
+}
+/** 发往 IM 的一条消息：text 为 Markdown（渠道插件转换为原生富文本），可附卡片。 */
+export interface OutboundMessage {
+    text: string;
+    cards?: ChannelCard[];
+}
+/**
+ * 提问能否在 IM 内直接作答：仅当表单恰有一个枚举字段（单选 ≤ 5 项 / 多选 ≤ 10 项）且不允许「其他」时为真；
+ * 否则卡片只给网页链接。
+ */
+export declare function questionRenderableInline(form: InputForm): boolean;
+/** 校验卡片结构，返回问题列表（空 = 合法）。 */
+export declare function validateChannelCard(card: unknown): string[];
+/** A UI locale. */
+export type Locale = "zh" | "en";
+/**
+ * 不支持卡片的渠道的统一退回文本（含链接）；固定话术按 locale 取 zh / en。结果是 Markdown（放进
+ * `OutboundMessage.text`，由渠道插件转换）：模型可控的字段放在代码里（见 `asCode`），不会产生链接。
+ */
+export declare function renderCardAsText(card: ChannelCard, locale: Locale): string;