@sous-io/plugin-api 0.0.1 → 1.0.2

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 2026 Luke Chavers
+
+   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/README.md

@@ -1,4 +1,98 @@
 # @sous-io/plugin-api
 
-The plugin interface of [sous](https://github.com/sous-io/sous). This 0.0.1 is a placeholder that
-reserves the name so releases can be published from CI; the first real release is 1.0.0.
+The interface for writing a sous plugin, and the one package of sous that outside plugins depend on. It holds `definePlugin`, the types, the `Reporter` and `Prompter` interfaces and the error classes. It has no dependencies.
+
+## Write your first plugin
+
+A plugin is a module whose default export is `definePlugin({...})`. Its `register(sous)` runs once, when the plugin loads. Everything below goes inside it.
+
+```ts
+import { definePlugin } from "@sous-io/plugin-api";
+
+export default definePlugin({
+    name: "sous-plugin-diagrams",
+    version: "1.0.0",
+    dependsOn: { "@sous-io/plugin-skills": "^1.0.0" },
+
+    register(sous) {
+        // 1. A config contributor: adds to the config while it is built.
+        sous.config.contribute({
+            id: "diagrams",
+            contribute(config) {
+                if (config.atPath("diagrams.enabled").valueOr(true)) {
+                    config.atPath("compilation.targets").appendValue({ id: "diagrams" });
+                }
+            },
+        });
+
+        // 2. An intent: a step with typed input. The CLI command and the MCP tool are generated from it.
+        sous.intents.add({
+            intent: "diagrams.render",
+            summary: "Render every diagram",
+            handle: async (input, ctx) => {
+                ctx.reporter.info("Rendering");
+                return { rendered: 0 };
+            },
+        });
+
+        // 3. A listener: runs when an event fires.
+        sous.on("config.built", (event, ctx) => {
+            ctx.reporter.debug("Config built");
+        });
+    },
+});
+```
+
+A contributor re-runs when something it read changes, so it must give the same result for the same input.
+
+### Which contributor wins
+
+When two contributors set the same key, the one whose patch applies last wins. Patches apply by `applyOrder`, a whole number from 0 to 99999 (default 2000): lower numbers apply first, and equal numbers apply in id order. The user's config files use 89900 and up, so they apply after every plugin and win.
+
+`before` and `after` name contributors, plugins or wildcards (`"*"` means every other contributor). They win over the number: a contributor declared `after` another is moved to one past it, and the move is logged at the `debug` level. `sous config show --layers` shows each contributor's number, and the one it moved to.
+
+```ts
+sous.config.contribute({
+    id: "diagrams/fixups",
+    applyOrder: 3000,                   // after plugins left at the default (2000)
+    after: ["@sous-io/plugin-skills"],  // and after every contributor of plugin-skills, whatever its number
+    contribute(config) {
+        config.atPath("diagrams.enabled").setValue(true);
+    },
+});
+```
+
+## Typed access to another plugin
+
+Add your plugin's names to the interfaces in this package (declaration merging), and another plugin gets them typed. To use a plugin's names, import its types file with no runtime cost and list it in `dependsOn`:
+
+```ts
+// In sous-plugin-diagrams: describe what it provides.
+declare module "@sous-io/plugin-api" {
+    interface SousIntents {
+        "diagrams.render": { input: { only?: string }; result: { rendered: number } };
+    }
+}
+
+// In another plugin: the intent is now typed.
+import type {} from "sous-plugin-diagrams/types";
+
+const { rendered } = await ctx.run("diagrams.render", { only: "intro" });
+```
+
+`SousServices`, `SousEvents`, `SousEntities` and `SousConfig` work the same way, for `sous.services.get(name)`, event payloads, entity kinds and config keys.
+
+## Where things are
+
+- `src/plugin.ts`: `definePlugin` and the `sous` object `register` receives (everything a plugin can add).
+- `src/config.ts`: contributors and the config builder they use.
+- `src/intents.ts`, `src/events.ts`, `src/services.ts`, `src/entities.ts`: what each registry takes.
+- `src/registry.ts`: the interfaces plugins add types to.
+- `src/errors.ts`, `src/reporter.ts`, `src/prompter.ts`: the error classes, and how a plugin reports and asks.
+- Real examples: any `packages/plugin-*` directory, for instance `packages/plugin-inspect`.
+
+## Testing
+
+```bash
+pnpm --filter @sous-io/plugin-api test
+```

package/dist/command-variables.d.ts

@@ -0,0 +1,13 @@
+import type { Context } from "./context.js";
+import { IntentOutput } from "./outputs.js";
+/**
+ * The "Command Variables" output most commands open their result with: the project's name (the
+ * config's `name`, else its directory's name), its config file, then `extra` in its key order.
+ * Outside a project it holds only `extra`.
+ *
+ * ```ts
+ * return new IntentOutputs([commandVariables(ctx, { Reading: "the cached indexes" }), listing]);
+ * // Project: my-app / Config: /work/my-app/.sous/sous.config.js / Reading: the cached indexes
+ * ```
+ */
+export declare function commandVariables(ctx: Pick<Context, "project" | "config">, extra?: Readonly<Record<string, unknown>>): IntentOutput;

package/dist/command-variables.js

@@ -0,0 +1,28 @@
+import { IntentOutput, VariableSet } from "./outputs.js";
+import { ReportEntryStyle } from "./report-styles.js";
+/**
+ * The "Command Variables" output most commands open their result with: the project's name (the
+ * config's `name`, else its directory's name), its config file, then `extra` in its key order.
+ * Outside a project it holds only `extra`.
+ *
+ * ```ts
+ * return new IntentOutputs([commandVariables(ctx, { Reading: "the cached indexes" }), listing]);
+ * // Project: my-app / Config: /work/my-app/.sous/sous.config.js / Reading: the cached indexes
+ * ```
+ */
+export function commandVariables(ctx, extra = {}) {
+    const entries = {};
+    if (ctx.project !== undefined) {
+        const name = ctx.config.get(["name"]);
+        entries.Project = typeof name === "string" && name !== "" ? name : baseName(ctx.project.root);
+        if (ctx.project.configPath !== undefined) {
+            entries.Config = ctx.project.configPath;
+        }
+    }
+    return new IntentOutput({ title: "Command Variables", result: new VariableSet({ ...entries, ...extra }), style: ReportEntryStyle.CommandVariables });
+}
+/** The last segment of a path, on any platform. */
+function baseName(directory) {
+    const parts = directory.split(/[\\/]/).filter((part) => part !== "");
+    return parts[parts.length - 1] ?? directory;
+}

package/dist/config.d.ts

@@ -0,0 +1,170 @@
+import type { Environment, ProjectInfo } from "./context.js";
+import type { EntityReader } from "./entities.js";
+import type { JsonObject, JsonValue, Patch, PatchSet, PathInput } from "./json.js";
+import type { DocumentNode } from "./node.js";
+import type { ConfigKeyType, EntityKind, EntityType } from "./registry.js";
+import type { Reporter } from "./reporter.js";
+import type { ServiceReader } from "./services.js";
+/** Reading a built config. Values are plain JSON, frozen. */
+export interface ConfigReader {
+    /** The value at a path, or `undefined`. */
+    get<K extends string>(path: K): ConfigKeyType<K> | undefined;
+    get<T = JsonValue>(path: PathInput): T | undefined;
+    /** Whether a value exists at a path. */
+    has(path: PathInput): boolean;
+    /** The whole config. */
+    value(): Readonly<JsonObject>;
+}
+/** One primitive change to a value, and who made it. */
+export interface ConfigLayer {
+    /** The contributor that made it. */
+    readonly contributor: string;
+    /** The plugin the contributor belongs to. */
+    readonly plugin: string;
+    readonly patch: Patch;
+    /** The patch sets around it, outermost first, after the contributor's own: `["removeWhere"]`. */
+    readonly helpers: readonly string[];
+    /** The contributor's declared apply order. */
+    readonly applyOrder: number;
+    /** Its apply order once `before` and `after` are met; it may pass 99999. */
+    readonly actualApplyOrder: number;
+}
+/** One contributor's part in a build. */
+export interface Contribution {
+    readonly contributor: string;
+    readonly plugin: string;
+    readonly stage: number;
+    /** Its declared apply order, 0 to 99999 (default 2000). */
+    readonly applyOrder: number;
+    /**
+     * Its apply order once `before` and `after` are met: the declared one, or moved to one past
+     * (or one less than) a contributor it must apply after (or before). It may pass 99999.
+     */
+    readonly actualApplyOrder: number;
+    /** Its latest patch set. */
+    readonly patches: PatchSet;
+    /** How many times it ran in this build. */
+    readonly runs: number;
+}
+/** A config the engine built: the values, and the entities and services that belong to it. */
+export interface BuiltConfig extends ConfigReader {
+    /** Counts builds in this process, "what if" builds included. */
+    readonly buildNumber: number;
+    /** True for a "what if" build, which never replaces the real config. */
+    readonly whatIf: boolean;
+    /** Passes the build took, over every stage, counting only passes in which something ran. */
+    readonly passes: number;
+    /** A hash of the values and the entities (ids, sources and data), to tell configs apart. */
+    readonly hash: string;
+    /** The entities of this build. */
+    readonly entities: EntityReader;
+    /** The services of this build: `config` services belong to it. */
+    readonly services: ServiceReader;
+    /** Every change to a path, or anything inside it or around it, in the order it was applied. */
+    layers(path: PathInput): ConfigLayer[];
+    /** Every contributor's part, in the order their patches apply: earlier stages first, then by actual apply order and id. */
+    contributions(): Contribution[];
+}
+/** Watching more than a contributor reads: a path, or an entity kind. */
+export type Monitor = PathInput | {
+    entities: string;
+};
+/** Who is running, as the builder tells a contributor. */
+export interface ContributorInfo {
+    readonly id: string;
+    readonly plugin: string;
+    /** The stage it runs in, after any shift. */
+    readonly stage: number;
+    /** The pass of the current stage, from 1. */
+    readonly pass: number;
+    /** How many times it has run in this build, this run included. */
+    readonly run: number;
+}
+/**
+ * What a contributor is given. It shows the config made from every other
+ * contributor's latest patches, without this contributor's own; every read is recorded, and every
+ * change becomes this run's patch set. It also reports like a reporter (`config.warn(...)`,
+ * `config.log(...)`), through the engine's reporter, with the contributor named in each message
+ * (contributors never print).
+ */
+export interface ConfigBuilder extends Reporter {
+    /** The root, to merge a whole config file: `config.root().merge(data)`. Reading it monitors everything. */
+    root(): DocumentNode;
+    /** A node at a path. */
+    atPath(path: PathInput): DocumentNode;
+    /** Every entity of a kind. Recorded as a read of the list. */
+    entities<K extends EntityKind>(kind: K): EntityType<K>[];
+    /** One entity. Recorded as a read of that entity alone. */
+    entity<K extends EntityKind>(kind: K, id: string): EntityType<K> | undefined;
+    /**
+     * Adds an entity the config creates. It is part of this run's patch, so a re-run replaces it.
+     * Its methods must not use `this` (see `sous.entities.add`).
+     */
+    addEntity<K extends EntityKind>(kind: K, entry: EntityType<K>): void;
+    /** This contributor's patch set from its previous run, if it ran before. */
+    previousPatches(): PatchSet | undefined;
+    /** Applies raw patches, as written in a patch file. */
+    apply(patches: Patch | PatchSet | readonly Patch[]): void;
+    /** This plugin's own options from `plugins.options`. Recorded as a read. */
+    options<T = JsonObject>(): T | undefined;
+    /** Who is running. */
+    readonly contributor: ContributorInfo;
+    readonly project: ProjectInfo | undefined;
+    readonly env: Environment;
+}
+/**
+ * A contributor: anything that adds to the config.
+ *
+ * ```ts
+ * sous.config.contribute({
+ *     id: "diagrams",
+ *     after: ["@sous-io/plugin-skills"],
+ *
+ *     contribute(config) {
+ *         if (config.atPath("diagrams.enabled").valueOr(true)) {
+ *             config.atPath("compilation.targets").appendValue({ id: "diagrams" });
+ *         }
+ *     },
+ * });
+ * ```
+ */
+export interface ContributorDefinition {
+    /** Unique in the engine: `diagrams`, `confd/610-mac.jsonc`, `claude-code/defaults`. */
+    id: string;
+    /** Its config stage; stages run lowest first. Default `0`, shifted for plugins loaded during a stage. */
+    stage?: number;
+    /**
+     * Where its patch applies within its stage: a whole number from 0 to 99999, default `2000`. Higher
+     * numbers apply later, so when two contributors set one key, the one with the higher number
+     * applies after the other and wins; equal numbers apply in id order. The user's files use
+     * 89900 and up, so they apply after every plugin's contributor. `before` and `after` win over
+     * the number: a contributor that must apply after another is moved to one past it (see
+     * `Contribution.actualApplyOrder`). Any other number is refused when the contributor is added.
+     */
+    applyOrder?: number;
+    /**
+     * Plugins, contributor ids or wildcards this one runs and applies before. `"*"` means every
+     * contributor that does not itself declare `before: ["*"]`. Default: its plugin's `before`.
+     */
+    before?: readonly string[];
+    /**
+     * Plugins, contributor ids or wildcards this one runs and applies after. `"*"` means every
+     * contributor that does not itself declare `after: ["*"]`. Default: its plugin's `after`.
+     */
+    after?: readonly string[];
+    /** More to watch than it reads; a change to any re-runs it. */
+    monitors?: readonly Monitor[];
+    /** Builds this contributor's patch. Must give the same result for the same input. */
+    contribute(config: ConfigBuilder): void | Promise<void>;
+}
+/** Options for building a config. */
+export interface BuildOptions {
+    /** More contributors for this build only ("what if" builds). */
+    extraContributors?: readonly ContributorDefinition[];
+    /**
+     * `reportBudgets` (`boolean = true`): `false` keeps the build's over-budget warning from being
+     * printed. A front end passes it for a command that only prints text (help, version, completion),
+     * where the warning is noise above the answer. The build is still timed (`--timings`).
+     */
+    reportBudgets?: boolean;
+}

package/dist/config.js

@@ -0,0 +1 @@
+export {};