1import { ScalarTypeEnum, SchemaModel } from '@lssm-tech/lib.schema';
2import { defineCommand } from '../../operations';
3import {
4	DOCS_DOMAIN,
5	DOCS_OWNERS,
6	DOCS_STABILITY,
7	DOCS_TAGS,
8} from '../constants';
9import { DocsGeneratedEvent } from '../events/docsGenerated.event';
10import { docId } from '../registry';
11import type { DocBlock } from '../types';
12
13export const DocsGenerateCommand = defineCommand({
14	meta: {
15		key: 'docs.generate',
16		title: 'Generate Documentation',
17		version: '1.0.0',
18		description: 'Generate documentation artifacts from ContractSpecs.',
19		goal: 'Produce up-to-date reference docs and guides from specs and DocBlocks.',
20		context:
21			'Used by CLI and CI to keep docs in sync with contract definitions.',
22		domain: DOCS_DOMAIN,
23		owners: DOCS_OWNERS,
24		tags: [...DOCS_TAGS, 'generation'],
25		stability: DOCS_STABILITY,
26		docId: [docId('docs.tech.docs-generator')],
27	},
28	capability: {
29		key: 'docs.system',
30		version: '1.0.0',
31	},
32	io: {
33		input: DocsGenerateInput,
34		output: DocsGenerateOutput,
35		errors: {
36			OUTPUT_WRITE_FAILED: {
37				description: 'Failed to write generated docs output.',
38				http: 500,
39				when: 'The generator cannot persist artifacts to the output path.',
40			},
41		},
42	},
43	policy: {
44		auth: 'admin',
45		pii: [],
46	},
47	sideEffects: {
48		emits: [
49			{
50				ref: DocsGeneratedEvent.meta,
51				when: 'Docs generation completes successfully.',
52			},
53		],
54	},
55});