@monosmith/plugin-sdk 0.5.0 → 0.7.0

package/scaffold/index.d.ts

@@ -1,3 +1,3 @@
 export { scaffoldProject } from './scaffold-project.use-case.ts';
 export type { ScaffoldOptions } from './scaffold-project.use-case.ts';
-export { scaffoldData } from './scaffold-data.mapper.ts';
+export { scaffoldData } from './template-fields.mapper.ts';

package/scaffold/index.js

@@ -1,2 +1,2 @@
 export { scaffoldProject } from './scaffold-project.use-case.js';
-export { scaffoldData } from './scaffold-data.mapper.js';
+export { scaffoldData } from './template-fields.mapper.js';

package/scaffold/scaffold-project.use-case.js

@@ -1,5 +1,5 @@
 import { writeTemplates } from '../templating/index.js';
-import { scaffoldData } from './scaffold-data.mapper.js';
+import { scaffoldData } from './template-fields.mapper.js';
 /**
  * The answer to `generate` for a scaffold: renders the templates into the new
  * project, never overwriting a file, and reports what it wrote. A language

package/serve/index.d.ts

@@ -1,4 +1,4 @@
 export { serve, serveStreams } from './serve.use-case.ts';
 export { capabilitiesOf, implementsMethod } from './capabilities-of.algorithm.ts';
-export type { Awaitable, Cancellable, CIContributor, Contributor, DeclarationEditor, DependencyManager, Discoverer, DoctorContributor, Generator, KindChanger, LatestReader, Plugin, PluginDescription, Publisher, RegistryReader, Remover, SmithPlugin, Versioner, } from './plugin.contract.ts';
+export type { APISurfaceReader, Awaitable, Cancellable, CIContributor, ComponentLister, Contributor, DeclarationEditor, DependencyManager, Deriver, Discoverer, DoctorContributor, Generator, KindChanger, LatestReader, Linker, Plugin, PluginDescription, Publisher, RegistryReader, Remover, SmithPlugin, Versioner, } from './plugin.contract.ts';
 export type { FrameSink, ServeStreams } from './protocol-streams.contract.ts';

package/serve/plugin-members.config.js

@@ -20,7 +20,12 @@ export const PLUGIN_MEMBERS = {
     'published': { member: 'published', requires: ['published'] },
     'dependencies/install': { member: 'install', requires: ['install', 'uninstall'] },
     'dependencies/uninstall': { member: 'uninstall', requires: ['install', 'uninstall'] },
+    'dependencies/link': { member: 'link', requires: ['link', 'unlink'] },
+    'dependencies/unlink': { member: 'unlink', requires: ['link', 'unlink'] },
     'dependencies/declared': { member: 'declared', requires: ['declared', 'rewrite'] },
     'dependencies/rewrite': { member: 'rewrite', requires: ['declared', 'rewrite'] },
     'dependencies/latest': { member: 'latest', requires: ['latest'] },
+    'sbom/components': { member: 'components', requires: ['components'] },
+    'derive': { member: 'derive', requires: ['derive'] },
+    'api/surface': { member: 'apiSurface', requires: ['apiSurface'] },
 };

package/serve/plugin.contract.d.ts

@@ -1,4 +1,4 @@
-import type { ChangeKindParams, ChangeKindResult, CIParams, CIResult, ContributeParams, ContributeResult, DeclaredParams, DeclaredResult, DependencyResult, DiscoverParams, DiscoverResult, DoctorParams, DoctorResult, GenerateParams, GenerateResult, InitializeParams, InitializeResult, InstallParams, LatestParams, LatestResult, PublishedParams, PublishedResult, PublishParams, PublishResult, RemoveParams, RemoveResult, RewriteParams, UninstallParams, VersionParams, VersionResult } from '../protocol/index.ts';
+import type { DeriveParams, DeriveResult, APISurfaceParams, APISurfaceResult, ChangeKindParams, ChangeKindResult, CIParams, CIResult, ComponentsParams, ComponentsResult, ContributeParams, ContributeResult, DeclaredParams, DeclaredResult, DependencyResult, DiscoverParams, DiscoverResult, DoctorParams, DoctorResult, GenerateParams, GenerateResult, InitializeParams, InitializeResult, InstallParams, LatestParams, LatestResult, LinkParams, LinkResult, PublishedParams, PublishedResult, PublishParams, PublishResult, RemoveParams, RemoveResult, RewriteParams, UninstallParams, UnlinkParams, VersionParams, VersionResult } from '../protocol/index.ts';
 /** A result now or later: every method of a plugin may be `async`. */
 export type Awaitable<T> = T | Promise<T>;
 /** What a plugin says about itself. The serve loop fills in `protocolVersion` and `capabilities`. */
@@ -44,11 +44,28 @@ export interface Remover {
 export interface KindChanger {
     changeKind: (params: ChangeKindParams, signal: AbortSignal) => Awaitable<ChangeKindResult>;
 }
+/** `sbom/components`: the components a project ships, for the SBOM a release attaches. */
+export interface ComponentLister {
+    components: (params: ComponentsParams, signal: AbortSignal) => Awaitable<ComponentsResult>;
+}
+/** `derive`: the files the plugin derives from facts and the project graph (smith derive). */
+export interface Deriver {
+    derive: (params: DeriveParams, signal: AbortSignal) => Awaitable<DeriveResult>;
+}
+/** `api/surface`: the public API names of a project at a git revision, for the release's version check. */
+export interface APISurfaceReader {
+    apiSurface: (params: APISurfaceParams, signal: AbortSignal) => Awaitable<APISurfaceResult>;
+}
 /** `dependencies/install` and `dependencies/uninstall`: both, or the capability is not advertised. */
 export interface DependencyManager {
     install: (params: InstallParams, signal: AbortSignal) => Awaitable<DependencyResult>;
     uninstall: (params: UninstallParams, signal: AbortSignal) => Awaitable<DependencyResult>;
 }
+/** `dependencies/link` and `dependencies/unlink`: both, or the capability is not advertised. */
+export interface Linker {
+    link: (params: LinkParams, signal: AbortSignal) => Awaitable<LinkResult>;
+    unlink: (params: UnlinkParams, signal: AbortSignal) => Awaitable<DependencyResult>;
+}
 /** `dependencies/declared` and `dependencies/rewrite`: both, or the capability is not advertised. */
 export interface DeclarationEditor {
     declared: (params: DeclaredParams, signal: AbortSignal) => Awaitable<DeclaredResult>;
@@ -81,4 +98,4 @@ export interface Cancellable {
  * from `cancellable`. How many requests it can work on at once is declared in
  * `describe`'s `concurrency`: omit it for one at a time, in order.
  */
-export type SmithPlugin = Plugin & Partial<Discoverer & Generator & Versioner & Publisher & RegistryReader & CIContributor & DoctorContributor & Remover & KindChanger & DependencyManager & DeclarationEditor & LatestReader & Contributor & Cancellable>;
+export type SmithPlugin = Plugin & Partial<Discoverer & Generator & Versioner & Publisher & RegistryReader & CIContributor & DoctorContributor & Remover & KindChanger & ComponentLister & Deriver & APISurfaceReader & DependencyManager & Linker & DeclarationEditor & LatestReader & Contributor & Cancellable>;