@monosmith/plugin-sdk 2.0.0-beta.1 → 2.0.0-beta.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@monosmith/plugin-sdk",
-  "version": "2.0.0-beta.1",
+  "version": "2.0.0-beta.3",
   "description": "The TypeScript SDK for writing smith plugins: the protocol's types, the serve loop, a test host, the conformance checks, templating and key-order-keeping JSON editing. No runtime dependencies.",
   "license": "MIT",
   "type": "module",

package/protocol/protocol-schema.contract.js

@@ -616,6 +616,10 @@ export const protocolSchema = {
                 "channels": {
                     "type": "boolean",
                     "description": "Channels says a prerelease version the plugin publishes never takes the place of the stable one: the plugin publishes under PublishParams.Tag, a release channel's name, without moving the registry's stable pointer (npm's latest), or its registry orders a prerelease below the release (PyPI, NuGet) and needs no tag. A host does not publish a package of a release channel with a plugin that lacks it."
+                },
+                "declared": {
+                    "type": "boolean",
+                    "description": "Declared says the plugin describes the projects smith.toml declares for its language (DiscoverParams.declared): folders with no manifest of their own. A plugin without it finds a project by its manifest only, and the host refuses a declaration for its language with a message that says so."
                 }
             }
         },
@@ -941,6 +945,28 @@ export const protocolSchema = {
                 "projects"
             ]
         },
+        "DeclaredProject": {
+            "description": "DeclaredProject is a project smith.toml declares: a folder with no manifest.",
+            "type": "object",
+            "properties": {
+                "name": {
+                    "type": "string",
+                    "description": "Name is the project's name, the key of its [projects.<name>] table."
+                },
+                "root": {
+                    "type": "string",
+                    "description": "Root is the workspace-relative folder."
+                },
+                "kind": {
+                    "$ref": "#/$defs/ProjectKind",
+                    "description": "Kind is \"app\", \"lib\" or \"package\", or empty for the plugin's choice."
+                }
+            },
+            "required": [
+                "name",
+                "root"
+            ]
+        },
         "DeclaredResult": {
             "description": "DeclaredResult is every declaration, and the version installed of each name where the plugin can tell.",
             "type": "object",
@@ -1116,6 +1142,13 @@ export const protocolSchema = {
                     "items": {
                         "type": "string"
                     }
+                },
+                "declared": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/DeclaredProject"
+                    },
+                    "description": "Declared are the projects smith.toml declares for this plugin's language ([projects.<name>] with a root and a language): folders with no manifest of their own, such as a program that is a package of the Go module above it. The plugin describes each one in its result, or answers with an error saying why it cannot."
                 }
             },
             "required": [

package/protocol/protocol-types.contract.d.ts

@@ -204,6 +204,13 @@ export interface Capabilities {
      * plugin that lacks it.
      */
     channels?: boolean;
+    /**
+     * Declared says the plugin describes the projects smith.toml declares for its language
+     * (DiscoverParams.declared): folders with no manifest of their own. A plugin without it finds a
+     * project by its manifest only, and the host refuses a declaration for its language with a
+     * message that says so.
+     */
+    declared?: boolean;
 }
 /**
  * ChangeKindParams asks a plugin what changing a project's kind edits. The plugin writes nothing:
@@ -406,6 +413,15 @@ export interface Declaration {
 export interface DeclaredParams {
     projects: Project[];
 }
+/** DeclaredProject is a project smith.toml declares: a folder with no manifest. */
+export interface DeclaredProject {
+    /** Name is the project's name, the key of its [projects.<name>] table. */
+    name: string;
+    /** Root is the workspace-relative folder. */
+    root: string;
+    /** Kind is "app", "lib" or "package", or empty for the plugin's choice. */
+    kind?: ProjectKind;
+}
 /**
  * DeclaredResult is every declaration, and the version installed of each name where the plugin can
  * tell.
@@ -502,6 +518,13 @@ export interface DevcontainerFeature {
  */
 export interface DiscoverParams {
     manifests: string[];
+    /**
+     * Declared are the projects smith.toml declares for this plugin's language ([projects.<name>]
+     * with a root and a language): folders with no manifest of their own, such as a program that is a
+     * package of the Go module above it. The plugin describes each one in its result, or answers with
+     * an error saying why it cannot.
+     */
+    declared?: DeclaredProject[];
 }
 /**
  * DiscoverResult describes every manifest that is a project of this plugin. A manifest the plugin