@contractspec/bundle.library 2.9.0 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.turbo/turbo-build.log +129 -115
- package/CHANGELOG.md +53 -0
- package/dist/components/docs/DocsIndexPage.js +1 -1
- package/dist/components/docs/architecture/ArchitectureControlPlanePage.d.ts +1 -0
- package/dist/components/docs/architecture/ArchitectureControlPlanePage.js +204 -0
- package/dist/components/docs/architecture/ArchitectureOverviewPage.js +17 -1
- package/dist/components/docs/architecture/index.d.ts +1 -0
- package/dist/components/docs/architecture/index.js +507 -289
- package/dist/components/docs/ecosystem/IntegrationsPage.js +6 -3
- package/dist/components/docs/ecosystem/PluginsPage.js +98 -98
- package/dist/components/docs/ecosystem/RegistryPage.js +39 -42
- package/dist/components/docs/ecosystem/TemplatesPage.js +26 -21
- package/dist/components/docs/ecosystem/ecosystem.docblocks.js +10 -10
- package/dist/components/docs/ecosystem/index.js +179 -174
- package/dist/components/docs/index.js +6795 -5376
- package/dist/components/docs/integrations/IntegrationsElevenLabsPage.js +2 -2
- package/dist/components/docs/integrations/IntegrationsGithubPage.d.ts +1 -0
- package/dist/components/docs/integrations/IntegrationsGithubPage.js +155 -0
- package/dist/components/docs/integrations/IntegrationsHealthRoutingPage.d.ts +1 -0
- package/dist/components/docs/integrations/IntegrationsHealthRoutingPage.js +168 -0
- package/dist/components/docs/integrations/IntegrationsMistralPage.d.ts +1 -0
- package/dist/components/docs/integrations/IntegrationsMistralPage.js +203 -0
- package/dist/components/docs/integrations/IntegrationsOpenAIPage.js +2 -2
- package/dist/components/docs/integrations/IntegrationsOverviewPage.js +136 -9
- package/dist/components/docs/integrations/IntegrationsSlackPage.d.ts +1 -0
- package/dist/components/docs/integrations/IntegrationsSlackPage.js +161 -0
- package/dist/components/docs/integrations/IntegrationsSpecModelPage.js +72 -0
- package/dist/components/docs/integrations/IntegrationsTwilioPage.js +2 -2
- package/dist/components/docs/integrations/IntegrationsWhatsappMetaPage.d.ts +1 -0
- package/dist/components/docs/integrations/IntegrationsWhatsappMetaPage.js +157 -0
- package/dist/components/docs/integrations/IntegrationsWhatsappTwilioPage.d.ts +1 -0
- package/dist/components/docs/integrations/IntegrationsWhatsappTwilioPage.js +165 -0
- package/dist/components/docs/integrations/index.d.ts +6 -0
- package/dist/components/docs/integrations/index.js +1688 -492
- package/dist/index.js +8016 -6597
- package/dist/node/components/docs/DocsIndexPage.js +1 -1
- package/dist/node/components/docs/architecture/ArchitectureControlPlanePage.js +203 -0
- package/dist/node/components/docs/architecture/ArchitectureOverviewPage.js +17 -1
- package/dist/node/components/docs/architecture/index.js +507 -289
- package/dist/node/components/docs/ecosystem/IntegrationsPage.js +6 -3
- package/dist/node/components/docs/ecosystem/PluginsPage.js +98 -98
- package/dist/node/components/docs/ecosystem/RegistryPage.js +39 -42
- package/dist/node/components/docs/ecosystem/TemplatesPage.js +26 -21
- package/dist/node/components/docs/ecosystem/ecosystem.docblocks.js +10 -10
- package/dist/node/components/docs/ecosystem/index.js +179 -174
- package/dist/node/components/docs/index.js +6795 -5376
- package/dist/node/components/docs/integrations/IntegrationsElevenLabsPage.js +2 -2
- package/dist/node/components/docs/integrations/IntegrationsGithubPage.js +154 -0
- package/dist/node/components/docs/integrations/IntegrationsHealthRoutingPage.js +167 -0
- package/dist/node/components/docs/integrations/IntegrationsMistralPage.js +202 -0
- package/dist/node/components/docs/integrations/IntegrationsOpenAIPage.js +2 -2
- package/dist/node/components/docs/integrations/IntegrationsOverviewPage.js +136 -9
- package/dist/node/components/docs/integrations/IntegrationsSlackPage.js +160 -0
- package/dist/node/components/docs/integrations/IntegrationsSpecModelPage.js +72 -0
- package/dist/node/components/docs/integrations/IntegrationsTwilioPage.js +2 -2
- package/dist/node/components/docs/integrations/IntegrationsWhatsappMetaPage.js +156 -0
- package/dist/node/components/docs/integrations/IntegrationsWhatsappTwilioPage.js +164 -0
- package/dist/node/components/docs/integrations/index.js +1688 -492
- package/dist/node/index.js +8016 -6597
- package/package.json +104 -20
- package/src/components/docs/DocsIndexPage.tsx +2 -1
- package/src/components/docs/architecture/ArchitectureControlPlanePage.tsx +136 -0
- package/src/components/docs/architecture/ArchitectureOverviewPage.tsx +13 -1
- package/src/components/docs/architecture/index.ts +1 -0
- package/src/components/docs/ecosystem/IntegrationsPage.tsx +4 -3
- package/src/components/docs/ecosystem/PluginsPage.tsx +68 -87
- package/src/components/docs/ecosystem/RegistryPage.tsx +35 -43
- package/src/components/docs/ecosystem/TemplatesPage.tsx +28 -21
- package/src/components/docs/ecosystem/ecosystem.docblocks.ts +12 -10
- package/src/components/docs/generated/docs-index._common.json +240 -0
- package/src/components/docs/generated/docs-index.health.json +98 -0
- package/src/components/docs/generated/docs-index.manifest.json +14 -4
- package/src/components/docs/generated/docs-index.platform-integrations.json +81 -1
- package/src/components/docs/generated/docs-index.video-api-showcase.json +26 -0
- package/src/components/docs/integrations/IntegrationsElevenLabsPage.tsx +2 -2
- package/src/components/docs/integrations/IntegrationsGithubPage.tsx +90 -0
- package/src/components/docs/integrations/IntegrationsHealthRoutingPage.tsx +112 -0
- package/src/components/docs/integrations/IntegrationsMistralPage.tsx +133 -0
- package/src/components/docs/integrations/IntegrationsOpenAIPage.tsx +2 -2
- package/src/components/docs/integrations/IntegrationsOverviewPage.tsx +108 -9
- package/src/components/docs/integrations/IntegrationsSlackPage.tsx +98 -0
- package/src/components/docs/integrations/IntegrationsSpecModelPage.tsx +59 -0
- package/src/components/docs/integrations/IntegrationsTwilioPage.tsx +2 -2
- package/src/components/docs/integrations/IntegrationsWhatsappMetaPage.tsx +90 -0
- package/src/components/docs/integrations/IntegrationsWhatsappTwilioPage.tsx +92 -0
- package/src/components/docs/integrations/index.ts +6 -0
|
@@ -6,70 +6,62 @@ export function EcosystemRegistryPage() {
|
|
|
6
6
|
return (
|
|
7
7
|
<div className="space-y-8">
|
|
8
8
|
<div className="space-y-3">
|
|
9
|
-
<h1 className="text-4xl font-bold">
|
|
9
|
+
<h1 className="text-4xl font-bold">Marketplace manifest</h1>
|
|
10
10
|
<p className="text-muted-foreground text-lg">
|
|
11
|
-
|
|
12
|
-
|
|
11
|
+
ContractSpec publishes a multi-plugin Cursor marketplace catalog from
|
|
12
|
+
a single root manifest.
|
|
13
13
|
</p>
|
|
14
14
|
</div>
|
|
15
15
|
|
|
16
16
|
<div className="card-subtle space-y-4 p-6">
|
|
17
|
-
<h2 className="text-2xl font-bold">
|
|
17
|
+
<h2 className="text-2xl font-bold">Root manifest shape</h2>
|
|
18
18
|
<p className="text-muted-foreground text-sm">
|
|
19
|
-
|
|
20
|
-
|
|
19
|
+
Cursor reads <code>.cursor-plugin/marketplace.json</code> at
|
|
20
|
+
repository root and resolves each plugin source path.
|
|
21
21
|
</p>
|
|
22
22
|
<CodeBlock
|
|
23
23
|
language="json"
|
|
24
|
-
filename=".
|
|
24
|
+
filename=".cursor-plugin/marketplace.json"
|
|
25
25
|
code={`{
|
|
26
|
+
"name": "contractspec-marketplace",
|
|
26
27
|
"plugins": [
|
|
27
28
|
{
|
|
28
|
-
"
|
|
29
|
-
"
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
}
|
|
35
|
-
}
|
|
36
|
-
],
|
|
37
|
-
"pluginRegistry": {
|
|
38
|
-
"resolutionOrder": ["workspace", "npm", "remote"],
|
|
39
|
-
"allowPrerelease": false,
|
|
40
|
-
"sources": {
|
|
41
|
-
"remote": "https://registry.contractspec.io"
|
|
29
|
+
"name": "contractspec",
|
|
30
|
+
"source": "packages/apps-registry/cursor-marketplace/plugins/contractspec"
|
|
31
|
+
},
|
|
32
|
+
{
|
|
33
|
+
"name": "contractspec-contracts-spec",
|
|
34
|
+
"source": "packages/apps-registry/cursor-marketplace/plugins/contractspec-contracts-spec"
|
|
42
35
|
}
|
|
43
|
-
|
|
36
|
+
]
|
|
44
37
|
}`}
|
|
45
38
|
/>
|
|
46
39
|
</div>
|
|
47
40
|
|
|
48
41
|
<div className="card-subtle space-y-4 p-6">
|
|
49
|
-
<h2 className="text-2xl font-bold">
|
|
42
|
+
<h2 className="text-2xl font-bold">Per-plugin contract</h2>
|
|
50
43
|
<p className="text-muted-foreground text-sm">
|
|
51
|
-
|
|
44
|
+
Each plugin source must include a Cursor plugin manifest and
|
|
45
|
+
composable assets.
|
|
52
46
|
</p>
|
|
53
47
|
<CodeBlock
|
|
54
|
-
language="
|
|
55
|
-
filename="
|
|
56
|
-
code={`
|
|
48
|
+
language="text"
|
|
49
|
+
filename="plugin-layout"
|
|
50
|
+
code={`plugins/<plugin-name>/
|
|
51
|
+
.cursor-plugin/plugin.json
|
|
52
|
+
rules/
|
|
53
|
+
commands/
|
|
54
|
+
agents/
|
|
55
|
+
skills/
|
|
56
|
+
.mcp.json`}
|
|
57
|
+
/>
|
|
58
|
+
<CodeBlock
|
|
59
|
+
language="bash"
|
|
60
|
+
filename="validate-catalog"
|
|
61
|
+
code={`bun run plugin:contractspec:validate
|
|
57
62
|
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
id: "private-registry",
|
|
61
|
-
version: "1.0.0",
|
|
62
|
-
type: "registryResolver",
|
|
63
|
-
provides: ["private-registry"],
|
|
64
|
-
},
|
|
65
|
-
resolve: async (request) => {
|
|
66
|
-
// Fetch plugin package metadata from private registry
|
|
67
|
-
const result = await fetch(
|
|
68
|
-
"https://registry.acme.io/" + request.package
|
|
69
|
-
);
|
|
70
|
-
return result.json();
|
|
71
|
-
},
|
|
72
|
-
};`}
|
|
63
|
+
# Optional in offline environments
|
|
64
|
+
SKIP_PLUGIN_NETWORK_CHECK=1 bun run plugin:contractspec:validate`}
|
|
73
65
|
/>
|
|
74
66
|
</div>
|
|
75
67
|
|
|
@@ -78,7 +70,7 @@ export const PrivateRegistryResolver: RegistryResolverPlugin = {
|
|
|
78
70
|
Integrations <ChevronRight size={16} />
|
|
79
71
|
</Link>
|
|
80
72
|
<Link href="/docs/ecosystem/templates" className="btn-ghost">
|
|
81
|
-
Plugin templates
|
|
73
|
+
Plugin authoring templates
|
|
82
74
|
</Link>
|
|
83
75
|
</div>
|
|
84
76
|
</div>
|
|
@@ -7,47 +7,54 @@ export function EcosystemTemplatesPage() {
|
|
|
7
7
|
return (
|
|
8
8
|
<div className="space-y-8">
|
|
9
9
|
<div className="space-y-3">
|
|
10
|
-
<h1 className="text-4xl font-bold">Plugin templates</h1>
|
|
10
|
+
<h1 className="text-4xl font-bold">Plugin authoring templates</h1>
|
|
11
11
|
<p className="text-muted-foreground text-lg">
|
|
12
|
-
Scaffold
|
|
12
|
+
Scaffold focused Cursor plugins for ContractSpec product and core
|
|
13
|
+
libraries.
|
|
13
14
|
</p>
|
|
14
15
|
</div>
|
|
15
16
|
|
|
16
17
|
<div className="card-subtle space-y-4 p-6">
|
|
17
|
-
<h2 className="text-2xl font-bold">Create a
|
|
18
|
+
<h2 className="text-2xl font-bold">Create a focused plugin</h2>
|
|
18
19
|
<p className="text-muted-foreground text-sm">
|
|
19
|
-
|
|
20
|
+
Start from a scoped domain and keep each plugin aligned to one product
|
|
21
|
+
or library surface.
|
|
20
22
|
</p>
|
|
21
23
|
<CodeBlock
|
|
22
24
|
language="bash"
|
|
23
|
-
filename="
|
|
24
|
-
code={`
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
25
|
+
filename="catalog-authoring-layout"
|
|
26
|
+
code={`packages/apps-registry/cursor-marketplace/
|
|
27
|
+
plugins/
|
|
28
|
+
<plugin-name>/
|
|
29
|
+
.cursor-plugin/plugin.json
|
|
30
|
+
rules/
|
|
31
|
+
commands/
|
|
32
|
+
agents/
|
|
33
|
+
skills/
|
|
34
|
+
.mcp.json`}
|
|
28
35
|
/>
|
|
29
36
|
</div>
|
|
30
37
|
|
|
31
38
|
<div className="card-subtle space-y-4 p-6">
|
|
32
39
|
<h2 className="text-2xl font-bold">Template outputs</h2>
|
|
33
40
|
<ul className="text-muted-foreground space-y-2 text-sm">
|
|
34
|
-
<li
|
|
35
|
-
<li>
|
|
36
|
-
<li>.
|
|
37
|
-
<li>README.md
|
|
41
|
+
<li>.cursor-plugin/plugin.json with plugin metadata and paths</li>
|
|
42
|
+
<li>rules/, commands/, agents/, and skills/ content directories</li>
|
|
43
|
+
<li>.mcp.json with all MCP server declarations used by the plugin</li>
|
|
44
|
+
<li>README.md describing scope and governance boundaries</li>
|
|
38
45
|
</ul>
|
|
39
46
|
</div>
|
|
40
47
|
|
|
41
48
|
<div className="card-subtle space-y-4 p-6">
|
|
42
|
-
<h2 className="text-2xl font-bold">
|
|
49
|
+
<h2 className="text-2xl font-bold">Validate before submission</h2>
|
|
43
50
|
<CodeBlock
|
|
44
51
|
language="bash"
|
|
45
|
-
filename="
|
|
46
|
-
code={
|
|
47
|
-
bun
|
|
52
|
+
filename="validate-marketplace-catalog"
|
|
53
|
+
code={`# Validate all plugins referenced by root marketplace manifest
|
|
54
|
+
bun run plugin:contractspec:validate
|
|
48
55
|
|
|
49
|
-
#
|
|
50
|
-
bun
|
|
56
|
+
# Optional in offline environments
|
|
57
|
+
SKIP_PLUGIN_NETWORK_CHECK=1 bun run plugin:contractspec:validate`}
|
|
51
58
|
/>
|
|
52
59
|
</div>
|
|
53
60
|
|
|
@@ -58,10 +65,10 @@ bun add @contractspec/integration.markdown-generator`}
|
|
|
58
65
|
|
|
59
66
|
<div className="flex items-center gap-4 pt-4">
|
|
60
67
|
<Link href="/docs/ecosystem/plugins" className="btn-primary">
|
|
61
|
-
|
|
68
|
+
Marketplace plugins <ChevronRight size={16} />
|
|
62
69
|
</Link>
|
|
63
70
|
<Link href="/docs/ecosystem/registry" className="btn-ghost">
|
|
64
|
-
|
|
71
|
+
Marketplace manifest
|
|
65
72
|
</Link>
|
|
66
73
|
</div>
|
|
67
74
|
</div>
|
|
@@ -4,15 +4,16 @@ import { registerDocBlocks } from '@contractspec/lib.contracts-spec/docs';
|
|
|
4
4
|
const ecosystemDocBlocks: DocBlock[] = [
|
|
5
5
|
{
|
|
6
6
|
id: 'docs.ecosystem.plugins',
|
|
7
|
-
title: '
|
|
8
|
-
summary:
|
|
7
|
+
title: 'Marketplace plugins',
|
|
8
|
+
summary:
|
|
9
|
+
'Focused Cursor marketplace plugins for product and core libraries.',
|
|
9
10
|
kind: 'usage',
|
|
10
11
|
visibility: 'public',
|
|
11
12
|
route: '/docs/ecosystem/plugins',
|
|
12
13
|
tags: ['ecosystem', 'plugins', 'extensions'],
|
|
13
|
-
body: `#
|
|
14
|
+
body: `# Marketplace plugins
|
|
14
15
|
|
|
15
|
-
ContractSpec
|
|
16
|
+
ContractSpec ships a focused Cursor marketplace catalog with plugins for the product and key libraries. Plugin sources live in \`packages/apps-registry/cursor-marketplace/plugins/*\`, while the root manifest at \`.cursor-plugin/marketplace.json\` drives submission.`,
|
|
16
17
|
},
|
|
17
18
|
{
|
|
18
19
|
id: 'docs.ecosystem.integrations',
|
|
@@ -28,24 +29,25 @@ Reference integrations demonstrate how to extend ContractSpec with real-world pl
|
|
|
28
29
|
},
|
|
29
30
|
{
|
|
30
31
|
id: 'docs.ecosystem.templates',
|
|
31
|
-
title: 'Plugin templates',
|
|
32
|
-
summary:
|
|
32
|
+
title: 'Plugin authoring templates',
|
|
33
|
+
summary:
|
|
34
|
+
'Author focused plugins with a consistent marketplace-ready layout.',
|
|
33
35
|
kind: 'usage',
|
|
34
36
|
visibility: 'public',
|
|
35
37
|
route: '/docs/ecosystem/templates',
|
|
36
38
|
tags: ['ecosystem', 'templates'],
|
|
37
|
-
body: '# Plugin templates\n\
|
|
39
|
+
body: '# Plugin authoring templates\n\nCreate each plugin under `packages/apps-registry/cursor-marketplace/plugins/<plugin-name>/` and include `.cursor-plugin/plugin.json`, `rules/`, `commands/`, `agents/`, `skills/`, and `.mcp.json`.',
|
|
38
40
|
},
|
|
39
41
|
|
|
40
42
|
{
|
|
41
43
|
id: 'docs.ecosystem.registry',
|
|
42
|
-
title: '
|
|
43
|
-
summary: '
|
|
44
|
+
title: 'Marketplace manifest',
|
|
45
|
+
summary: 'Manage and validate root marketplace entries for all plugins.',
|
|
44
46
|
kind: 'usage',
|
|
45
47
|
visibility: 'public',
|
|
46
48
|
route: '/docs/ecosystem/registry',
|
|
47
49
|
tags: ['ecosystem', 'registry'],
|
|
48
|
-
body: '#
|
|
50
|
+
body: '# Marketplace manifest\n\nKeep all plugin entries in `.cursor-plugin/marketplace.json` and validate them with `bun run plugin:contractspec:validate` before submission.',
|
|
49
51
|
},
|
|
50
52
|
];
|
|
51
53
|
|
|
@@ -23,6 +23,246 @@
|
|
|
23
23
|
"source": "generated",
|
|
24
24
|
"contentPath": "_common/contractspec.presentations.md"
|
|
25
25
|
},
|
|
26
|
+
{
|
|
27
|
+
"id": "_common/control-plane.approval",
|
|
28
|
+
"title": "control-plane.approval",
|
|
29
|
+
"summary": "Human approval and rejection gates for execution steps.\n- **Type**: capability (capability)\n- **Version**: 1.0.0\n- **Tags**: approval\n- **File**: `packages/libs/contracts-spec/src/control-plane/capabilities/controlPlaneApproval.capability.ts`",
|
|
30
|
+
"route": "/docs/reference/_common/control-plane.approval",
|
|
31
|
+
"source": "generated",
|
|
32
|
+
"contentPath": "_common/control-plane.approval.md"
|
|
33
|
+
},
|
|
34
|
+
{
|
|
35
|
+
"id": "_common/control-plane.audit",
|
|
36
|
+
"title": "control-plane.audit",
|
|
37
|
+
"summary": "Trace, policy explanation, and replay-grade observability.\n- **Type**: capability (capability)\n- **Version**: 1.0.0\n- **Tags**: audit\n- **File**: `packages/libs/contracts-spec/src/control-plane/capabilities/controlPlaneAudit.capability.ts`",
|
|
38
|
+
"route": "/docs/reference/_common/control-plane.audit",
|
|
39
|
+
"source": "generated",
|
|
40
|
+
"contentPath": "_common/control-plane.audit.md"
|
|
41
|
+
},
|
|
42
|
+
{
|
|
43
|
+
"id": "_common/control-plane.channel-runtime",
|
|
44
|
+
"title": "control-plane.channel-runtime",
|
|
45
|
+
"summary": "Channel-facing runtime surfaces for controlled execution.\n- **Type**: capability (capability)\n- **Version**: 1.0.0\n- **Tags**: channels\n- **File**: `packages/libs/contracts-spec/src/control-plane/capabilities/controlPlaneChannelRuntime.capability.ts`",
|
|
46
|
+
"route": "/docs/reference/_common/control-plane.channel-runtime",
|
|
47
|
+
"source": "generated",
|
|
48
|
+
"contentPath": "_common/control-plane.channel-runtime.md"
|
|
49
|
+
},
|
|
50
|
+
{
|
|
51
|
+
"id": "_common/control-plane.core",
|
|
52
|
+
"title": "control-plane.core",
|
|
53
|
+
"summary": "Core intent, planning, and execution surfaces.\n- **Type**: capability (capability)\n- **Version**: 1.0.0\n- **Tags**: core\n- **File**: `packages/libs/contracts-spec/src/control-plane/capabilities/controlPlaneCore.capability.ts`",
|
|
54
|
+
"route": "/docs/reference/_common/control-plane.core",
|
|
55
|
+
"source": "generated",
|
|
56
|
+
"contentPath": "_common/control-plane.core.md"
|
|
57
|
+
},
|
|
58
|
+
{
|
|
59
|
+
"id": "_common/control-plane.skill-registry",
|
|
60
|
+
"title": "control-plane.skill-registry",
|
|
61
|
+
"summary": "Signed skill lifecycle and compatibility governance.\n- **Type**: capability (capability)\n- **Version**: 1.0.0\n- **Tags**: skills\n- **File**: `packages/libs/contracts-spec/src/control-plane/capabilities/controlPlaneSkillRegistry.capability.ts`",
|
|
62
|
+
"route": "/docs/reference/_common/control-plane.skill-registry",
|
|
63
|
+
"source": "generated",
|
|
64
|
+
"contentPath": "_common/control-plane.skill-registry.md"
|
|
65
|
+
},
|
|
66
|
+
{
|
|
67
|
+
"id": "_common/controlPlane.execution.approve",
|
|
68
|
+
"title": "controlPlane.execution.approve",
|
|
69
|
+
"summary": "Approve a pending execution step for continuation.\n- **Type**: operation (command)\n- **Version**: 1.0.0\n- **Tags**: approval\n- **File**: `packages/libs/contracts-spec/src/control-plane/commands/controlPlaneExecutionApprove.command.ts`",
|
|
70
|
+
"route": "/docs/reference/_common/controlPlane.execution.approve",
|
|
71
|
+
"source": "generated",
|
|
72
|
+
"contentPath": "_common/controlPlane.execution.approve.md"
|
|
73
|
+
},
|
|
74
|
+
{
|
|
75
|
+
"id": "_common/controlPlane.execution.cancel",
|
|
76
|
+
"title": "controlPlane.execution.cancel",
|
|
77
|
+
"summary": "Cancel an execution run and transition to terminal state.\n- **Type**: operation (command)\n- **Version**: 1.0.0\n- **Tags**: execution, approval\n- **File**: `packages/libs/contracts-spec/src/control-plane/commands/controlPlaneExecutionCancel.command.ts`",
|
|
78
|
+
"route": "/docs/reference/_common/controlPlane.execution.cancel",
|
|
79
|
+
"source": "generated",
|
|
80
|
+
"contentPath": "_common/controlPlane.execution.cancel.md"
|
|
81
|
+
},
|
|
82
|
+
{
|
|
83
|
+
"id": "_common/controlPlane.execution.completed",
|
|
84
|
+
"title": "controlPlane.execution.completed",
|
|
85
|
+
"summary": "Emitted when an execution run finishes successfully.\n- **Type**: event (event)\n- **Version**: 1.0.0\n- **Tags**: execution\n- **File**: `packages/libs/contracts-spec/src/control-plane/events/controlPlaneExecutionCompleted.event.ts`",
|
|
86
|
+
"route": "/docs/reference/_common/controlPlane.execution.completed",
|
|
87
|
+
"source": "generated",
|
|
88
|
+
"contentPath": "_common/controlPlane.execution.completed.md"
|
|
89
|
+
},
|
|
90
|
+
{
|
|
91
|
+
"id": "_common/controlPlane.execution.failed",
|
|
92
|
+
"title": "controlPlane.execution.failed",
|
|
93
|
+
"summary": "Emitted when an execution run fails.\n- **Type**: event (event)\n- **Version**: 1.0.0\n- **Tags**: execution, failure\n- **File**: `packages/libs/contracts-spec/src/control-plane/events/controlPlaneExecutionFailed.event.ts`",
|
|
94
|
+
"route": "/docs/reference/_common/controlPlane.execution.failed",
|
|
95
|
+
"source": "generated",
|
|
96
|
+
"contentPath": "_common/controlPlane.execution.failed.md"
|
|
97
|
+
},
|
|
98
|
+
{
|
|
99
|
+
"id": "_common/controlPlane.execution.get",
|
|
100
|
+
"title": "controlPlane.execution.get",
|
|
101
|
+
"summary": "Fetch the latest state for one execution.\n- **Type**: operation (query)\n- **Version**: 1.0.0\n- **Tags**: execution\n- **File**: `packages/libs/contracts-spec/src/control-plane/queries/controlPlaneExecutionGet.query.ts`",
|
|
102
|
+
"route": "/docs/reference/_common/controlPlane.execution.get",
|
|
103
|
+
"source": "generated",
|
|
104
|
+
"contentPath": "_common/controlPlane.execution.get.md"
|
|
105
|
+
},
|
|
106
|
+
{
|
|
107
|
+
"id": "_common/controlPlane.execution.list",
|
|
108
|
+
"title": "controlPlane.execution.list",
|
|
109
|
+
"summary": "List execution runs with filtering and pagination.\n- **Type**: operation (query)\n- **Version**: 1.0.0\n- **Tags**: execution\n- **File**: `packages/libs/contracts-spec/src/control-plane/queries/controlPlaneExecutionList.query.ts`",
|
|
110
|
+
"route": "/docs/reference/_common/controlPlane.execution.list",
|
|
111
|
+
"source": "generated",
|
|
112
|
+
"contentPath": "_common/controlPlane.execution.list.md"
|
|
113
|
+
},
|
|
114
|
+
{
|
|
115
|
+
"id": "_common/controlPlane.execution.reject",
|
|
116
|
+
"title": "controlPlane.execution.reject",
|
|
117
|
+
"summary": "Reject a pending execution step.\n- **Type**: operation (command)\n- **Version**: 1.0.0\n- **Tags**: approval\n- **File**: `packages/libs/contracts-spec/src/control-plane/commands/controlPlaneExecutionReject.command.ts`",
|
|
118
|
+
"route": "/docs/reference/_common/controlPlane.execution.reject",
|
|
119
|
+
"source": "generated",
|
|
120
|
+
"contentPath": "_common/controlPlane.execution.reject.md"
|
|
121
|
+
},
|
|
122
|
+
{
|
|
123
|
+
"id": "_common/controlPlane.execution.start",
|
|
124
|
+
"title": "controlPlane.execution.start",
|
|
125
|
+
"summary": "Start executing an approved compiled plan.\n- **Type**: operation (command)\n- **Version**: 1.0.0\n- **Tags**: execution\n- **File**: `packages/libs/contracts-spec/src/control-plane/commands/controlPlaneExecutionStart.command.ts`",
|
|
126
|
+
"route": "/docs/reference/_common/controlPlane.execution.start",
|
|
127
|
+
"source": "generated",
|
|
128
|
+
"contentPath": "_common/controlPlane.execution.start.md"
|
|
129
|
+
},
|
|
130
|
+
{
|
|
131
|
+
"id": "_common/controlPlane.execution.step.blocked",
|
|
132
|
+
"title": "controlPlane.execution.step.blocked",
|
|
133
|
+
"summary": "Emitted when policy blocks an execution step.\n- **Type**: event (event)\n- **Version**: 1.0.0\n- **Tags**: execution, blocked\n- **File**: `packages/libs/contracts-spec/src/control-plane/events/controlPlaneExecutionStepBlocked.event.ts`",
|
|
134
|
+
"route": "/docs/reference/_common/controlPlane.execution.step.blocked",
|
|
135
|
+
"source": "generated",
|
|
136
|
+
"contentPath": "_common/controlPlane.execution.step.blocked.md"
|
|
137
|
+
},
|
|
138
|
+
{
|
|
139
|
+
"id": "_common/controlPlane.execution.step.completed",
|
|
140
|
+
"title": "controlPlane.execution.step.completed",
|
|
141
|
+
"summary": "Emitted when an execution step completes.\n- **Type**: event (event)\n- **Version**: 1.0.0\n- **Tags**: execution\n- **File**: `packages/libs/contracts-spec/src/control-plane/events/controlPlaneExecutionStepCompleted.event.ts`",
|
|
142
|
+
"route": "/docs/reference/_common/controlPlane.execution.step.completed",
|
|
143
|
+
"source": "generated",
|
|
144
|
+
"contentPath": "_common/controlPlane.execution.step.completed.md"
|
|
145
|
+
},
|
|
146
|
+
{
|
|
147
|
+
"id": "_common/controlPlane.execution.step.started",
|
|
148
|
+
"title": "controlPlane.execution.step.started",
|
|
149
|
+
"summary": "Emitted when an execution step starts.\n- **Type**: event (event)\n- **Version**: 1.0.0\n- **Tags**: execution\n- **File**: `packages/libs/contracts-spec/src/control-plane/events/controlPlaneExecutionStepStarted.event.ts`",
|
|
150
|
+
"route": "/docs/reference/_common/controlPlane.execution.step.started",
|
|
151
|
+
"source": "generated",
|
|
152
|
+
"contentPath": "_common/controlPlane.execution.step.started.md"
|
|
153
|
+
},
|
|
154
|
+
{
|
|
155
|
+
"id": "_common/controlPlane.intent.received",
|
|
156
|
+
"title": "controlPlane.intent.received",
|
|
157
|
+
"summary": "Emitted when a new control plane intent is accepted.\n- **Type**: event (event)\n- **Version**: 1.0.0\n- **Tags**: intent\n- **File**: `packages/libs/contracts-spec/src/control-plane/events/controlPlaneIntentReceived.event.ts`",
|
|
158
|
+
"route": "/docs/reference/_common/controlPlane.intent.received",
|
|
159
|
+
"source": "generated",
|
|
160
|
+
"contentPath": "_common/controlPlane.intent.received.md"
|
|
161
|
+
},
|
|
162
|
+
{
|
|
163
|
+
"id": "_common/controlPlane.intent.submit",
|
|
164
|
+
"title": "controlPlane.intent.submit",
|
|
165
|
+
"summary": "Submit a natural-language intent to the control plane.\n- **Type**: operation (command)\n- **Version**: 1.0.0\n- **Tags**: intent\n- **File**: `packages/libs/contracts-spec/src/control-plane/commands/controlPlaneIntentSubmit.command.ts`",
|
|
166
|
+
"route": "/docs/reference/_common/controlPlane.intent.submit",
|
|
167
|
+
"source": "generated",
|
|
168
|
+
"contentPath": "_common/controlPlane.intent.submit.md"
|
|
169
|
+
},
|
|
170
|
+
{
|
|
171
|
+
"id": "_common/controlPlane.plan.compile",
|
|
172
|
+
"title": "controlPlane.plan.compile",
|
|
173
|
+
"summary": "Compile an intent into a deterministic plan DAG.\n- **Type**: operation (command)\n- **Version**: 1.0.0\n- **Tags**: plan\n- **File**: `packages/libs/contracts-spec/src/control-plane/commands/controlPlanePlanCompile.command.ts`",
|
|
174
|
+
"route": "/docs/reference/_common/controlPlane.plan.compile",
|
|
175
|
+
"source": "generated",
|
|
176
|
+
"contentPath": "_common/controlPlane.plan.compile.md"
|
|
177
|
+
},
|
|
178
|
+
{
|
|
179
|
+
"id": "_common/controlPlane.plan.compiled",
|
|
180
|
+
"title": "controlPlane.plan.compiled",
|
|
181
|
+
"summary": "Emitted when an intent is compiled into an executable plan.\n- **Type**: event (event)\n- **Version**: 1.0.0\n- **Tags**: plan\n- **File**: `packages/libs/contracts-spec/src/control-plane/events/controlPlanePlanCompiled.event.ts`",
|
|
182
|
+
"route": "/docs/reference/_common/controlPlane.plan.compiled",
|
|
183
|
+
"source": "generated",
|
|
184
|
+
"contentPath": "_common/controlPlane.plan.compiled.md"
|
|
185
|
+
},
|
|
186
|
+
{
|
|
187
|
+
"id": "_common/controlPlane.plan.rejected",
|
|
188
|
+
"title": "controlPlane.plan.rejected",
|
|
189
|
+
"summary": "Emitted when a plan fails verification or governance checks.\n- **Type**: event (event)\n- **Version**: 1.0.0\n- **Tags**: plan, governance\n- **File**: `packages/libs/contracts-spec/src/control-plane/events/controlPlanePlanRejected.event.ts`",
|
|
190
|
+
"route": "/docs/reference/_common/controlPlane.plan.rejected",
|
|
191
|
+
"source": "generated",
|
|
192
|
+
"contentPath": "_common/controlPlane.plan.rejected.md"
|
|
193
|
+
},
|
|
194
|
+
{
|
|
195
|
+
"id": "_common/controlPlane.plan.verify",
|
|
196
|
+
"title": "controlPlane.plan.verify",
|
|
197
|
+
"summary": "Run policy and risk validation against a compiled plan.\n- **Type**: operation (command)\n- **Version**: 1.0.0\n- **Tags**: plan, governance\n- **File**: `packages/libs/contracts-spec/src/control-plane/commands/controlPlanePlanVerify.command.ts`",
|
|
198
|
+
"route": "/docs/reference/_common/controlPlane.plan.verify",
|
|
199
|
+
"source": "generated",
|
|
200
|
+
"contentPath": "_common/controlPlane.plan.verify.md"
|
|
201
|
+
},
|
|
202
|
+
{
|
|
203
|
+
"id": "_common/controlPlane.policy.explain",
|
|
204
|
+
"title": "controlPlane.policy.explain",
|
|
205
|
+
"summary": "Explain policy outcomes for an execution or step.\n- **Type**: operation (query)\n- **Version**: 1.0.0\n- **Tags**: policy, audit\n- **File**: `packages/libs/contracts-spec/src/control-plane/queries/controlPlanePolicyExplain.query.ts`",
|
|
206
|
+
"route": "/docs/reference/_common/controlPlane.policy.explain",
|
|
207
|
+
"source": "generated",
|
|
208
|
+
"contentPath": "_common/controlPlane.policy.explain.md"
|
|
209
|
+
},
|
|
210
|
+
{
|
|
211
|
+
"id": "_common/controlPlane.skill.disable",
|
|
212
|
+
"title": "controlPlane.skill.disable",
|
|
213
|
+
"summary": "Disable an installed skill in the control plane registry.\n- **Type**: operation (command)\n- **Version**: 1.0.0\n- **Tags**: skills, governance\n- **File**: `packages/libs/contracts-spec/src/control-plane/commands/controlPlaneSkillDisable.command.ts`",
|
|
214
|
+
"route": "/docs/reference/_common/controlPlane.skill.disable",
|
|
215
|
+
"source": "generated",
|
|
216
|
+
"contentPath": "_common/controlPlane.skill.disable.md"
|
|
217
|
+
},
|
|
218
|
+
{
|
|
219
|
+
"id": "_common/controlPlane.skill.install",
|
|
220
|
+
"title": "controlPlane.skill.install",
|
|
221
|
+
"summary": "Install a signed skill artifact after verification checks.\n- **Type**: operation (command)\n- **Version**: 1.0.0\n- **Tags**: skills\n- **File**: `packages/libs/contracts-spec/src/control-plane/commands/controlPlaneSkillInstall.command.ts`",
|
|
222
|
+
"route": "/docs/reference/_common/controlPlane.skill.install",
|
|
223
|
+
"source": "generated",
|
|
224
|
+
"contentPath": "_common/controlPlane.skill.install.md"
|
|
225
|
+
},
|
|
226
|
+
{
|
|
227
|
+
"id": "_common/controlPlane.skill.installed",
|
|
228
|
+
"title": "controlPlane.skill.installed",
|
|
229
|
+
"summary": "Emitted when a skill artifact is verified and installed.\n- **Type**: event (event)\n- **Version**: 1.0.0\n- **Tags**: skills\n- **File**: `packages/libs/contracts-spec/src/control-plane/events/controlPlaneSkillInstalled.event.ts`",
|
|
230
|
+
"route": "/docs/reference/_common/controlPlane.skill.installed",
|
|
231
|
+
"source": "generated",
|
|
232
|
+
"contentPath": "_common/controlPlane.skill.installed.md"
|
|
233
|
+
},
|
|
234
|
+
{
|
|
235
|
+
"id": "_common/controlPlane.skill.list",
|
|
236
|
+
"title": "controlPlane.skill.list",
|
|
237
|
+
"summary": "List installed and available skill artifacts.\n- **Type**: operation (query)\n- **Version**: 1.0.0\n- **Tags**: skills\n- **File**: `packages/libs/contracts-spec/src/control-plane/queries/controlPlaneSkillList.query.ts`",
|
|
238
|
+
"route": "/docs/reference/_common/controlPlane.skill.list",
|
|
239
|
+
"source": "generated",
|
|
240
|
+
"contentPath": "_common/controlPlane.skill.list.md"
|
|
241
|
+
},
|
|
242
|
+
{
|
|
243
|
+
"id": "_common/controlPlane.skill.rejected",
|
|
244
|
+
"title": "controlPlane.skill.rejected",
|
|
245
|
+
"summary": "Emitted when a skill install attempt is rejected.\n- **Type**: event (event)\n- **Version**: 1.0.0\n- **Tags**: skills, governance\n- **File**: `packages/libs/contracts-spec/src/control-plane/events/controlPlaneSkillRejected.event.ts`",
|
|
246
|
+
"route": "/docs/reference/_common/controlPlane.skill.rejected",
|
|
247
|
+
"source": "generated",
|
|
248
|
+
"contentPath": "_common/controlPlane.skill.rejected.md"
|
|
249
|
+
},
|
|
250
|
+
{
|
|
251
|
+
"id": "_common/controlPlane.skill.verify",
|
|
252
|
+
"title": "controlPlane.skill.verify",
|
|
253
|
+
"summary": "Verify skill signature and compatibility constraints.\n- **Type**: operation (query)\n- **Version**: 1.0.0\n- **Tags**: skills, governance\n- **File**: `packages/libs/contracts-spec/src/control-plane/queries/controlPlaneSkillVerify.query.ts`",
|
|
254
|
+
"route": "/docs/reference/_common/controlPlane.skill.verify",
|
|
255
|
+
"source": "generated",
|
|
256
|
+
"contentPath": "_common/controlPlane.skill.verify.md"
|
|
257
|
+
},
|
|
258
|
+
{
|
|
259
|
+
"id": "_common/controlPlane.trace.get",
|
|
260
|
+
"title": "controlPlane.trace.get",
|
|
261
|
+
"summary": "Return the replayable trace timeline for one execution.\n- **Type**: operation (query)\n- **Version**: 1.0.0\n- **Tags**: trace, audit\n- **File**: `packages/libs/contracts-spec/src/control-plane/queries/controlPlaneTraceGet.query.ts`",
|
|
262
|
+
"route": "/docs/reference/_common/controlPlane.trace.get",
|
|
263
|
+
"source": "generated",
|
|
264
|
+
"contentPath": "_common/controlPlane.trace.get.md"
|
|
265
|
+
},
|
|
26
266
|
{
|
|
27
267
|
"id": "_common/docs.contract.reference",
|
|
28
268
|
"title": "docs.contract.reference",
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
[
|
|
2
|
+
{
|
|
3
|
+
"id": "health/health",
|
|
4
|
+
"title": "health",
|
|
5
|
+
"summary": "Unified health and wearable data sync for activities, workouts, sleep, biometrics, nutrition, and webhooks.\n- **Type**: feature\n- **Version**: 1.0.0\n- **Stability**: experimental\n- **Owners**: @platform.integrations",
|
|
6
|
+
"route": "/docs/reference/health/health",
|
|
7
|
+
"source": "generated",
|
|
8
|
+
"contentPath": "health/health.md"
|
|
9
|
+
},
|
|
10
|
+
{
|
|
11
|
+
"id": "health/health.activities.list",
|
|
12
|
+
"title": "health.activities.list",
|
|
13
|
+
"summary": "List normalized activity entries synced from health integrations.\n- **Type**: operation (query)\n- **Version**: 1.0.0\n- **Stability**: experimental\n- **Owners**: @platform.integrations\n- **Tags**: health, activities, wearables",
|
|
14
|
+
"route": "/docs/reference/health/health.activities.list",
|
|
15
|
+
"source": "generated",
|
|
16
|
+
"contentPath": "health/health.activities.list.md"
|
|
17
|
+
},
|
|
18
|
+
{
|
|
19
|
+
"id": "health/health.activities.sync",
|
|
20
|
+
"title": "health.activities.sync",
|
|
21
|
+
"summary": "Synchronize activity entries from the configured health provider.\n- **Type**: operation (command)\n- **Version**: 1.0.0\n- **Stability**: experimental\n- **Owners**: @platform.integrations\n- **Tags**: health, activities, wearables",
|
|
22
|
+
"route": "/docs/reference/health/health.activities.sync",
|
|
23
|
+
"source": "generated",
|
|
24
|
+
"contentPath": "health/health.activities.sync.md"
|
|
25
|
+
},
|
|
26
|
+
{
|
|
27
|
+
"id": "health/health.biometrics.list",
|
|
28
|
+
"title": "health.biometrics.list",
|
|
29
|
+
"summary": "List normalized biometrics synced from connected health providers.\n- **Type**: operation (query)\n- **Version**: 1.0.0\n- **Stability**: experimental\n- **Owners**: @platform.integrations\n- **Tags**: health, biometrics, wearables",
|
|
30
|
+
"route": "/docs/reference/health/health.biometrics.list",
|
|
31
|
+
"source": "generated",
|
|
32
|
+
"contentPath": "health/health.biometrics.list.md"
|
|
33
|
+
},
|
|
34
|
+
{
|
|
35
|
+
"id": "health/health.biometrics.sync",
|
|
36
|
+
"title": "health.biometrics.sync",
|
|
37
|
+
"summary": "Synchronize biometric datapoints from provider sources.\n- **Type**: operation (command)\n- **Version**: 1.0.0\n- **Stability**: experimental\n- **Owners**: @platform.integrations\n- **Tags**: health, biometrics, wearables",
|
|
38
|
+
"route": "/docs/reference/health/health.biometrics.sync",
|
|
39
|
+
"source": "generated",
|
|
40
|
+
"contentPath": "health/health.biometrics.sync.md"
|
|
41
|
+
},
|
|
42
|
+
{
|
|
43
|
+
"id": "health/health.nutrition.list",
|
|
44
|
+
"title": "health.nutrition.list",
|
|
45
|
+
"summary": "List normalized nutrition and hydration records from connected providers.\n- **Type**: operation (query)\n- **Version**: 1.0.0\n- **Stability**: experimental\n- **Owners**: @platform.integrations\n- **Tags**: health, nutrition, wearables",
|
|
46
|
+
"route": "/docs/reference/health/health.nutrition.list",
|
|
47
|
+
"source": "generated",
|
|
48
|
+
"contentPath": "health/health.nutrition.list.md"
|
|
49
|
+
},
|
|
50
|
+
{
|
|
51
|
+
"id": "health/health.nutrition.sync",
|
|
52
|
+
"title": "health.nutrition.sync",
|
|
53
|
+
"summary": "Synchronize nutrition records from provider sources.\n- **Type**: operation (command)\n- **Version**: 1.0.0\n- **Stability**: experimental\n- **Owners**: @platform.integrations\n- **Tags**: health, nutrition, wearables",
|
|
54
|
+
"route": "/docs/reference/health/health.nutrition.sync",
|
|
55
|
+
"source": "generated",
|
|
56
|
+
"contentPath": "health/health.nutrition.sync.md"
|
|
57
|
+
},
|
|
58
|
+
{
|
|
59
|
+
"id": "health/health.sleep.list",
|
|
60
|
+
"title": "health.sleep.list",
|
|
61
|
+
"summary": "List normalized sleep intervals synced from health providers.\n- **Type**: operation (query)\n- **Version**: 1.0.0\n- **Stability**: experimental\n- **Owners**: @platform.integrations\n- **Tags**: health, sleep, wearables",
|
|
62
|
+
"route": "/docs/reference/health/health.sleep.list",
|
|
63
|
+
"source": "generated",
|
|
64
|
+
"contentPath": "health/health.sleep.list.md"
|
|
65
|
+
},
|
|
66
|
+
{
|
|
67
|
+
"id": "health/health.sleep.sync",
|
|
68
|
+
"title": "health.sleep.sync",
|
|
69
|
+
"summary": "Synchronize sleep intervals from connected providers.\n- **Type**: operation (command)\n- **Version**: 1.0.0\n- **Stability**: experimental\n- **Owners**: @platform.integrations\n- **Tags**: health, sleep, wearables",
|
|
70
|
+
"route": "/docs/reference/health/health.sleep.sync",
|
|
71
|
+
"source": "generated",
|
|
72
|
+
"contentPath": "health/health.sleep.sync.md"
|
|
73
|
+
},
|
|
74
|
+
{
|
|
75
|
+
"id": "health/health.webhooks.ingest",
|
|
76
|
+
"title": "health.webhooks.ingest",
|
|
77
|
+
"summary": "Ingest and normalize health provider webhook payloads.\n- **Type**: operation (command)\n- **Version**: 1.0.0\n- **Stability**: experimental\n- **Owners**: @platform.integrations\n- **Tags**: health, webhooks, integrations",
|
|
78
|
+
"route": "/docs/reference/health/health.webhooks.ingest",
|
|
79
|
+
"source": "generated",
|
|
80
|
+
"contentPath": "health/health.webhooks.ingest.md"
|
|
81
|
+
},
|
|
82
|
+
{
|
|
83
|
+
"id": "health/health.workouts.list",
|
|
84
|
+
"title": "health.workouts.list",
|
|
85
|
+
"summary": "List normalized workout entries synced from health integrations.\n- **Type**: operation (query)\n- **Version**: 1.0.0\n- **Stability**: experimental\n- **Owners**: @platform.integrations\n- **Tags**: health, workouts, wearables",
|
|
86
|
+
"route": "/docs/reference/health/health.workouts.list",
|
|
87
|
+
"source": "generated",
|
|
88
|
+
"contentPath": "health/health.workouts.list.md"
|
|
89
|
+
},
|
|
90
|
+
{
|
|
91
|
+
"id": "health/health.workouts.sync",
|
|
92
|
+
"title": "health.workouts.sync",
|
|
93
|
+
"summary": "Synchronize workouts from configured health providers.\n- **Type**: operation (command)\n- **Version**: 1.0.0\n- **Stability**: experimental\n- **Owners**: @platform.integrations\n- **Tags**: health, workouts, wearables",
|
|
94
|
+
"route": "/docs/reference/health/health.workouts.sync",
|
|
95
|
+
"source": "generated",
|
|
96
|
+
"contentPath": "health/health.workouts.sync.md"
|
|
97
|
+
}
|
|
98
|
+
]
|