@contractspec/lib.contracts 1.51.0 → 1.53.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/dist/app-config/{contracts.d.ts → app-config.contracts.d.ts} +51 -51
- package/dist/app-config/{contracts.js → app-config.contracts.js} +1 -1
- package/dist/app-config/events.d.ts +27 -27
- package/dist/app-config/lifecycle-contracts.d.ts +54 -54
- package/dist/app-config/runtime.d.ts +4 -4
- package/dist/app-config/spec.d.ts +3 -3
- package/dist/capabilities/guards.d.ts +1 -1
- package/dist/capabilities/validation.d.ts +1 -1
- package/dist/data-views/data-views.d.ts +1 -1
- package/dist/data-views/index.d.ts +1 -1
- package/dist/data-views/registry.d.ts +1 -1
- package/dist/data-views/report/contractVerificationTable.d.ts +10 -0
- package/dist/data-views/report/contractVerificationTable.js +95 -0
- package/dist/data-views/runtime.d.ts +2 -2
- package/dist/data-views/spec.d.ts +1 -1
- package/dist/data-views/types.d.ts +1 -1
- package/dist/docs/capabilities/documentationSystem.capability.d.ts +7 -0
- package/dist/docs/capabilities/documentationSystem.capability.js +71 -0
- package/dist/docs/capabilities/index.d.ts +2 -0
- package/dist/docs/capabilities/index.js +3 -0
- package/dist/docs/commands/docsGenerate.command.d.ts +95 -0
- package/dist/docs/commands/docsGenerate.command.js +142 -0
- package/dist/docs/commands/docsPublish.command.d.ts +64 -0
- package/dist/docs/commands/docsPublish.command.js +107 -0
- package/dist/docs/commands/index.d.ts +3 -0
- package/dist/docs/commands/index.js +4 -0
- package/dist/docs/constants.d.ts +7 -0
- package/dist/docs/constants.js +10 -0
- package/dist/docs/contracts.d.ts +442 -0
- package/dist/docs/contracts.js +58 -0
- package/dist/docs/ensure-docblocks.d.ts +1 -0
- package/dist/docs/ensure-docblocks.js +1 -0
- package/dist/docs/events/docsGenerated.event.d.ts +62 -0
- package/dist/docs/events/docsGenerated.event.js +53 -0
- package/dist/docs/events/docsPublished.event.d.ts +70 -0
- package/dist/docs/events/docsPublished.event.js +57 -0
- package/dist/docs/events/index.d.ts +3 -0
- package/dist/docs/events/index.js +4 -0
- package/dist/docs/forms/docsSearch.form.d.ts +22 -0
- package/dist/docs/forms/docsSearch.form.js +113 -0
- package/dist/docs/forms/index.d.ts +2 -0
- package/dist/docs/forms/index.js +3 -0
- package/dist/docs/index.d.ts +23 -1
- package/dist/docs/index.js +25 -1
- package/dist/docs/presentations/docsLayout.presentation.d.ts +7 -0
- package/dist/docs/presentations/docsLayout.presentation.js +35 -0
- package/dist/docs/presentations/docsReferencePage.presentation.d.ts +7 -0
- package/dist/docs/presentations/docsReferencePage.presentation.js +35 -0
- package/dist/docs/presentations/index.d.ts +3 -0
- package/dist/docs/presentations/index.js +4 -0
- package/dist/docs/queries/contractReference.query.d.ts +217 -0
- package/dist/docs/queries/contractReference.query.js +125 -0
- package/dist/docs/queries/docsIndex.query.d.ts +272 -0
- package/dist/docs/queries/docsIndex.query.js +133 -0
- package/dist/docs/queries/index.d.ts +3 -0
- package/dist/docs/queries/index.js +4 -0
- package/dist/docs/tech/cli.docblock.js +10 -0
- package/dist/docs/tech/docs-system.docblock.d.ts +1 -0
- package/dist/docs/tech/docs-system.docblock.js +128 -0
- package/dist/docs/tech/report-verification-table.docblock.d.ts +1 -0
- package/dist/docs/tech/report-verification-table.docblock.js +50 -0
- package/dist/docs/views/contractReference.dataView.d.ts +7 -0
- package/dist/docs/views/contractReference.dataView.js +80 -0
- package/dist/docs/views/docsIndex.dataView.d.ts +7 -0
- package/dist/docs/views/docsIndex.dataView.js +136 -0
- package/dist/docs/views/exampleCatalog.dataView.d.ts +7 -0
- package/dist/docs/views/exampleCatalog.dataView.js +91 -0
- package/dist/docs/views/index.d.ts +4 -0
- package/dist/docs/views/index.js +5 -0
- package/dist/events.d.ts +1 -1
- package/dist/examples/schema.d.ts +7 -7
- package/dist/examples/types.d.ts +1 -1
- package/dist/experiments/spec.d.ts +2 -2
- package/dist/features/install.d.ts +1 -1
- package/dist/features/types.d.ts +3 -3
- package/dist/forms/forms.d.ts +1 -1
- package/dist/index.d.ts +40 -22
- package/dist/index.js +20 -2
- package/dist/install.d.ts +1 -1
- package/dist/integrations/openbanking/contracts/accounts.d.ts +66 -66
- package/dist/integrations/openbanking/contracts/balances.d.ts +34 -34
- package/dist/integrations/openbanking/contracts/transactions.d.ts +48 -48
- package/dist/integrations/openbanking/models.d.ts +55 -55
- package/dist/integrations/operations.d.ts +102 -102
- package/dist/integrations/spec.d.ts +2 -2
- package/dist/jsonschema.d.ts +1 -1
- package/dist/knowledge/operations.d.ts +66 -66
- package/dist/knowledge/spec.d.ts +1 -1
- package/dist/llm/exporters.d.ts +3 -3
- package/dist/llm/types.d.ts +1 -1
- package/dist/markdown.d.ts +1 -1
- package/dist/onboarding-base.d.ts +29 -29
- package/dist/operations/index.d.ts +4 -1
- package/dist/operations/index.js +4 -1
- package/dist/operations/operation.d.ts +3 -3
- package/dist/operations/registry.d.ts +1 -1
- package/dist/operations/report/getContractVerificationStatus.d.ts +75 -0
- package/dist/operations/report/getContractVerificationStatus.js +96 -0
- package/dist/operations/report/index.d.ts +13 -0
- package/dist/operations/report/index.js +45 -0
- package/dist/policy/validation.d.ts +1 -1
- package/dist/presentations/registry.d.ts +1 -1
- package/dist/registry.d.ts +1 -1
- package/dist/serialization/serializers.d.ts +3 -3
- package/dist/server/rest-elysia.d.ts +1 -1
- package/dist/server/rest-express.d.ts +1 -1
- package/dist/server/rest-generic.d.ts +1 -1
- package/dist/server/rest-next-app.d.ts +1 -1
- package/dist/server/rest-next-mcp.d.ts +1 -1
- package/dist/server/rest-next-pages.d.ts +1 -1
- package/dist/telemetry/spec.d.ts +1 -1
- package/dist/telemetry/tracker.d.ts +3 -2
- package/dist/tests/runner.d.ts +1 -1
- package/dist/themes.d.ts +1 -1
- package/dist/types.d.ts +2 -2
- package/dist/workflow/spec.d.ts +2 -2
- package/dist/workflow/validation.d.ts +2 -2
- package/dist/workspace-config/contractsrc-schema.d.ts +3 -3
- package/dist/workspace-config/contractsrc-schema.js +1 -0
- package/dist/workspace-config/contractsrc-types.d.ts +7 -8
- package/dist/workspace-config/index.d.ts +2 -2
- package/package.json +35 -8
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
import { defineEvent } from "../../events.js";
|
|
2
|
+
import { DOCS_DOMAIN, DOCS_OWNERS, DOCS_STABILITY, DOCS_TAGS } from "../constants.js";
|
|
3
|
+
import { docId } from "../registry.js";
|
|
4
|
+
import "../ensure-docblocks.js";
|
|
5
|
+
import { ScalarTypeEnum, SchemaModel } from "@contractspec/lib.schema";
|
|
6
|
+
|
|
7
|
+
//#region src/docs/events/docsPublished.event.ts
|
|
8
|
+
const DocsPublishedPayload = new SchemaModel({
|
|
9
|
+
name: "DocsPublishedPayload",
|
|
10
|
+
fields: {
|
|
11
|
+
publishId: {
|
|
12
|
+
type: ScalarTypeEnum.String_unsecure(),
|
|
13
|
+
isOptional: false
|
|
14
|
+
},
|
|
15
|
+
version: {
|
|
16
|
+
type: ScalarTypeEnum.String_unsecure(),
|
|
17
|
+
isOptional: true
|
|
18
|
+
},
|
|
19
|
+
environment: {
|
|
20
|
+
type: ScalarTypeEnum.String_unsecure(),
|
|
21
|
+
isOptional: true
|
|
22
|
+
},
|
|
23
|
+
url: {
|
|
24
|
+
type: ScalarTypeEnum.String_unsecure(),
|
|
25
|
+
isOptional: true
|
|
26
|
+
},
|
|
27
|
+
publishedAt: {
|
|
28
|
+
type: ScalarTypeEnum.DateTime(),
|
|
29
|
+
isOptional: false
|
|
30
|
+
},
|
|
31
|
+
status: {
|
|
32
|
+
type: ScalarTypeEnum.String_unsecure(),
|
|
33
|
+
isOptional: true
|
|
34
|
+
},
|
|
35
|
+
warnings: {
|
|
36
|
+
type: ScalarTypeEnum.String_unsecure(),
|
|
37
|
+
isOptional: true,
|
|
38
|
+
isArray: true
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
});
|
|
42
|
+
const DocsPublishedEvent = defineEvent({
|
|
43
|
+
meta: {
|
|
44
|
+
key: "docs.published",
|
|
45
|
+
version: "1.0.0",
|
|
46
|
+
description: "Emitted when documentation is published.",
|
|
47
|
+
domain: DOCS_DOMAIN,
|
|
48
|
+
owners: DOCS_OWNERS,
|
|
49
|
+
tags: [...DOCS_TAGS, "publish"],
|
|
50
|
+
stability: DOCS_STABILITY,
|
|
51
|
+
docId: [docId("docs.tech.docs-publish")]
|
|
52
|
+
},
|
|
53
|
+
payload: DocsPublishedPayload
|
|
54
|
+
});
|
|
55
|
+
|
|
56
|
+
//#endregion
|
|
57
|
+
export { DocsPublishedEvent, DocsPublishedPayload };
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { FormSpec } from "../../forms/forms.js";
|
|
2
|
+
import "../../index.js";
|
|
3
|
+
import * as _contractspec_lib_schema156 from "@contractspec/lib.schema";
|
|
4
|
+
import { SchemaModel } from "@contractspec/lib.schema";
|
|
5
|
+
|
|
6
|
+
//#region src/docs/forms/docsSearch.form.d.ts
|
|
7
|
+
declare const DocsSearchForm: FormSpec<SchemaModel<{
|
|
8
|
+
query: {
|
|
9
|
+
type: _contractspec_lib_schema156.FieldType<string, string>;
|
|
10
|
+
isOptional: true;
|
|
11
|
+
};
|
|
12
|
+
visibility: {
|
|
13
|
+
type: _contractspec_lib_schema156.FieldType<string, string>;
|
|
14
|
+
isOptional: true;
|
|
15
|
+
};
|
|
16
|
+
kind: {
|
|
17
|
+
type: _contractspec_lib_schema156.FieldType<string, string>;
|
|
18
|
+
isOptional: true;
|
|
19
|
+
};
|
|
20
|
+
}>>;
|
|
21
|
+
//#endregion
|
|
22
|
+
export { DocsSearchForm };
|
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
import { defineFormSpec } from "../../forms/forms.js";
|
|
2
|
+
import { DOCS_DOMAIN, DOCS_OWNERS, DOCS_STABILITY, DOCS_TAGS } from "../constants.js";
|
|
3
|
+
import { docId } from "../registry.js";
|
|
4
|
+
import "../ensure-docblocks.js";
|
|
5
|
+
import { ScalarTypeEnum, SchemaModel } from "@contractspec/lib.schema";
|
|
6
|
+
|
|
7
|
+
//#region src/docs/forms/docsSearch.form.ts
|
|
8
|
+
const DocsSearchFormModel = new SchemaModel({
|
|
9
|
+
name: "DocsSearchFormModel",
|
|
10
|
+
fields: {
|
|
11
|
+
query: {
|
|
12
|
+
type: ScalarTypeEnum.String_unsecure(),
|
|
13
|
+
isOptional: true
|
|
14
|
+
},
|
|
15
|
+
visibility: {
|
|
16
|
+
type: ScalarTypeEnum.String_unsecure(),
|
|
17
|
+
isOptional: true
|
|
18
|
+
},
|
|
19
|
+
kind: {
|
|
20
|
+
type: ScalarTypeEnum.String_unsecure(),
|
|
21
|
+
isOptional: true
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
});
|
|
25
|
+
const DocsSearchForm = defineFormSpec({
|
|
26
|
+
meta: {
|
|
27
|
+
key: "docs.search.form",
|
|
28
|
+
title: "Docs Search",
|
|
29
|
+
version: "1.0.0",
|
|
30
|
+
description: "Search form for documentation discovery.",
|
|
31
|
+
domain: DOCS_DOMAIN,
|
|
32
|
+
owners: DOCS_OWNERS,
|
|
33
|
+
tags: [...DOCS_TAGS, "search"],
|
|
34
|
+
stability: DOCS_STABILITY,
|
|
35
|
+
docId: [docId("docs.tech.docs-search")]
|
|
36
|
+
},
|
|
37
|
+
model: DocsSearchFormModel,
|
|
38
|
+
fields: [
|
|
39
|
+
{
|
|
40
|
+
kind: "text",
|
|
41
|
+
name: "query",
|
|
42
|
+
labelI18n: "Search",
|
|
43
|
+
placeholderI18n: "Search docs"
|
|
44
|
+
},
|
|
45
|
+
{
|
|
46
|
+
kind: "select",
|
|
47
|
+
name: "visibility",
|
|
48
|
+
labelI18n: "Visibility",
|
|
49
|
+
options: {
|
|
50
|
+
kind: "static",
|
|
51
|
+
options: [
|
|
52
|
+
{
|
|
53
|
+
labelI18n: "Public",
|
|
54
|
+
value: "public"
|
|
55
|
+
},
|
|
56
|
+
{
|
|
57
|
+
labelI18n: "Internal",
|
|
58
|
+
value: "internal"
|
|
59
|
+
},
|
|
60
|
+
{
|
|
61
|
+
labelI18n: "Mixed",
|
|
62
|
+
value: "mixed"
|
|
63
|
+
}
|
|
64
|
+
]
|
|
65
|
+
}
|
|
66
|
+
},
|
|
67
|
+
{
|
|
68
|
+
kind: "select",
|
|
69
|
+
name: "kind",
|
|
70
|
+
labelI18n: "Kind",
|
|
71
|
+
options: {
|
|
72
|
+
kind: "static",
|
|
73
|
+
options: [
|
|
74
|
+
{
|
|
75
|
+
labelI18n: "Goal",
|
|
76
|
+
value: "goal"
|
|
77
|
+
},
|
|
78
|
+
{
|
|
79
|
+
labelI18n: "How",
|
|
80
|
+
value: "how"
|
|
81
|
+
},
|
|
82
|
+
{
|
|
83
|
+
labelI18n: "Usage",
|
|
84
|
+
value: "usage"
|
|
85
|
+
},
|
|
86
|
+
{
|
|
87
|
+
labelI18n: "Reference",
|
|
88
|
+
value: "reference"
|
|
89
|
+
},
|
|
90
|
+
{
|
|
91
|
+
labelI18n: "FAQ",
|
|
92
|
+
value: "faq"
|
|
93
|
+
},
|
|
94
|
+
{
|
|
95
|
+
labelI18n: "Changelog",
|
|
96
|
+
value: "changelog"
|
|
97
|
+
}
|
|
98
|
+
]
|
|
99
|
+
}
|
|
100
|
+
}
|
|
101
|
+
],
|
|
102
|
+
actions: [{
|
|
103
|
+
key: "search",
|
|
104
|
+
labelI18n: "Search"
|
|
105
|
+
}],
|
|
106
|
+
policy: {
|
|
107
|
+
flags: [],
|
|
108
|
+
pii: []
|
|
109
|
+
}
|
|
110
|
+
});
|
|
111
|
+
|
|
112
|
+
//#endregion
|
|
113
|
+
export { DocsSearchForm };
|
package/dist/docs/index.d.ts
CHANGED
|
@@ -1,6 +1,28 @@
|
|
|
1
1
|
import { DocBlock, DocBlockLink, DocKind, DocVisibility } from "./types.js";
|
|
2
|
+
import { DOCS_DOMAIN, DOCS_OWNERS, DOCS_STABILITY, DOCS_TAGS } from "./constants.js";
|
|
3
|
+
import { DocsGenerateCommand } from "./commands/docsGenerate.command.js";
|
|
4
|
+
import { DocsPublishCommand } from "./commands/docsPublish.command.js";
|
|
5
|
+
import "./commands/index.js";
|
|
6
|
+
import { DocSummaryModel, DocsIndexInput, DocsIndexOutput, DocsIndexQuery } from "./queries/docsIndex.query.js";
|
|
7
|
+
import { ContractReferenceInput, ContractReferenceModel, ContractReferenceOutput, ContractReferenceQuery } from "./queries/contractReference.query.js";
|
|
8
|
+
import "./queries/index.js";
|
|
9
|
+
import { DocsGeneratedEvent, DocsGeneratedPayload } from "./events/docsGenerated.event.js";
|
|
10
|
+
import { DocsPublishedEvent, DocsPublishedPayload } from "./events/docsPublished.event.js";
|
|
11
|
+
import "./events/index.js";
|
|
12
|
+
import { DocumentationSystemCapability } from "./capabilities/documentationSystem.capability.js";
|
|
13
|
+
import "./capabilities/index.js";
|
|
14
|
+
import { docsDataViewContracts, docsEventContracts, docsFormContracts, docsOperationContracts, docsPresentationContracts, registerDocsDataViews, registerDocsEvents, registerDocsForms, registerDocsOperations, registerDocsPresentations } from "./contracts.js";
|
|
2
15
|
import { DocPresentationOptions, DocPresentationRoute, docBlockToPresentationSpec, docBlocksToPresentationRoutes, docBlocksToPresentationSpecs, mapDocRoutes } from "./presentations.js";
|
|
16
|
+
import { DocsLayoutPresentation } from "./presentations/docsLayout.presentation.js";
|
|
17
|
+
import { DocsReferencePagePresentation } from "./presentations/docsReferencePage.presentation.js";
|
|
18
|
+
import "./presentations/index.js";
|
|
19
|
+
import { DocsSearchForm } from "./forms/docsSearch.form.js";
|
|
20
|
+
import "./forms/index.js";
|
|
21
|
+
import { DocsIndexDataView } from "./views/docsIndex.dataView.js";
|
|
22
|
+
import { ContractReferenceDataView } from "./views/contractReference.dataView.js";
|
|
23
|
+
import { ExampleCatalogDataView } from "./views/exampleCatalog.dataView.js";
|
|
24
|
+
import "./views/index.js";
|
|
3
25
|
import { DocId, DocRegistry, defaultDocRegistry, docId, listRegisteredDocBlocks, registerDocBlocks } from "./registry.js";
|
|
4
26
|
import { techContractsDocs } from "./tech-contracts.docs.js";
|
|
5
27
|
import { metaDocs } from "./meta.docs.js";
|
|
6
|
-
export { DocBlock, DocBlockLink, DocId, DocKind, DocPresentationOptions, DocPresentationRoute, DocRegistry, DocVisibility, defaultDocRegistry, docBlockToPresentationSpec, docBlocksToPresentationRoutes, docBlocksToPresentationSpecs, docId, listRegisteredDocBlocks, mapDocRoutes, metaDocs, registerDocBlocks, techContractsDocs };
|
|
28
|
+
export { ContractReferenceDataView, ContractReferenceInput, ContractReferenceModel, ContractReferenceOutput, ContractReferenceQuery, DOCS_DOMAIN, DOCS_OWNERS, DOCS_STABILITY, DOCS_TAGS, DocBlock, DocBlockLink, DocId, DocKind, DocPresentationOptions, DocPresentationRoute, DocRegistry, DocSummaryModel, DocVisibility, DocsGenerateCommand, DocsGeneratedEvent, DocsGeneratedPayload, DocsIndexDataView, DocsIndexInput, DocsIndexOutput, DocsIndexQuery, DocsLayoutPresentation, DocsPublishCommand, DocsPublishedEvent, DocsPublishedPayload, DocsReferencePagePresentation, DocsSearchForm, DocumentationSystemCapability, ExampleCatalogDataView, defaultDocRegistry, docBlockToPresentationSpec, docBlocksToPresentationRoutes, docBlocksToPresentationSpecs, docId, docsDataViewContracts, docsEventContracts, docsFormContracts, docsOperationContracts, docsPresentationContracts, listRegisteredDocBlocks, mapDocRoutes, metaDocs, registerDocBlocks, registerDocsDataViews, registerDocsEvents, registerDocsForms, registerDocsOperations, registerDocsPresentations, techContractsDocs };
|
package/dist/docs/index.js
CHANGED
|
@@ -1,5 +1,28 @@
|
|
|
1
|
+
import { DOCS_DOMAIN, DOCS_OWNERS, DOCS_STABILITY, DOCS_TAGS } from "./constants.js";
|
|
1
2
|
import { docBlockToPresentationSpec, docBlocksToPresentationRoutes, docBlocksToPresentationSpecs, mapDocRoutes } from "./presentations.js";
|
|
2
3
|
import { DocRegistry, defaultDocRegistry, docId, listRegisteredDocBlocks, registerDocBlocks } from "./registry.js";
|
|
4
|
+
import "./tech/docs-system.docblock.js";
|
|
5
|
+
import { DocsGeneratedEvent, DocsGeneratedPayload } from "./events/docsGenerated.event.js";
|
|
6
|
+
import { DocsGenerateCommand } from "./commands/docsGenerate.command.js";
|
|
7
|
+
import { DocsPublishedEvent, DocsPublishedPayload } from "./events/docsPublished.event.js";
|
|
8
|
+
import { DocsPublishCommand } from "./commands/docsPublish.command.js";
|
|
9
|
+
import "./commands/index.js";
|
|
10
|
+
import { DocSummaryModel, DocsIndexInput, DocsIndexOutput, DocsIndexQuery } from "./queries/docsIndex.query.js";
|
|
11
|
+
import { ContractReferenceInput, ContractReferenceModel, ContractReferenceOutput, ContractReferenceQuery } from "./queries/contractReference.query.js";
|
|
12
|
+
import "./queries/index.js";
|
|
13
|
+
import "./events/index.js";
|
|
14
|
+
import { DocumentationSystemCapability } from "./capabilities/documentationSystem.capability.js";
|
|
15
|
+
import "./capabilities/index.js";
|
|
16
|
+
import { DocsLayoutPresentation } from "./presentations/docsLayout.presentation.js";
|
|
17
|
+
import { DocsReferencePagePresentation } from "./presentations/docsReferencePage.presentation.js";
|
|
18
|
+
import "./presentations/index.js";
|
|
19
|
+
import { DocsSearchForm } from "./forms/docsSearch.form.js";
|
|
20
|
+
import "./forms/index.js";
|
|
21
|
+
import { DocsIndexDataView } from "./views/docsIndex.dataView.js";
|
|
22
|
+
import { ContractReferenceDataView } from "./views/contractReference.dataView.js";
|
|
23
|
+
import { ExampleCatalogDataView } from "./views/exampleCatalog.dataView.js";
|
|
24
|
+
import "./views/index.js";
|
|
25
|
+
import { docsDataViewContracts, docsEventContracts, docsFormContracts, docsOperationContracts, docsPresentationContracts, registerDocsDataViews, registerDocsEvents, registerDocsForms, registerDocsOperations, registerDocsPresentations } from "./contracts.js";
|
|
3
26
|
import { techContractsDocs } from "./tech-contracts.docs.js";
|
|
4
27
|
import { metaDocs } from "./meta.docs.js";
|
|
5
28
|
import "./accessibility_wcag_compliance_specs.docblock.js";
|
|
@@ -26,5 +49,6 @@ import "./tech/studio/project-access-teams.docblock.js";
|
|
|
26
49
|
import "./tech/studio/team-invitations.docblock.js";
|
|
27
50
|
import "./tech/llm/llm-integration.docblock.js";
|
|
28
51
|
import "./tech/cli.docblock.js";
|
|
52
|
+
import "./tech/report-verification-table.docblock.js";
|
|
29
53
|
|
|
30
|
-
export { DocRegistry, defaultDocRegistry, docBlockToPresentationSpec, docBlocksToPresentationRoutes, docBlocksToPresentationSpecs, docId, listRegisteredDocBlocks, mapDocRoutes, metaDocs, registerDocBlocks, techContractsDocs };
|
|
54
|
+
export { ContractReferenceDataView, ContractReferenceInput, ContractReferenceModel, ContractReferenceOutput, ContractReferenceQuery, DOCS_DOMAIN, DOCS_OWNERS, DOCS_STABILITY, DOCS_TAGS, DocRegistry, DocSummaryModel, DocsGenerateCommand, DocsGeneratedEvent, DocsGeneratedPayload, DocsIndexDataView, DocsIndexInput, DocsIndexOutput, DocsIndexQuery, DocsLayoutPresentation, DocsPublishCommand, DocsPublishedEvent, DocsPublishedPayload, DocsReferencePagePresentation, DocsSearchForm, DocumentationSystemCapability, ExampleCatalogDataView, defaultDocRegistry, docBlockToPresentationSpec, docBlocksToPresentationRoutes, docBlocksToPresentationSpecs, docId, docsDataViewContracts, docsEventContracts, docsFormContracts, docsOperationContracts, docsPresentationContracts, listRegisteredDocBlocks, mapDocRoutes, metaDocs, registerDocBlocks, registerDocsDataViews, registerDocsEvents, registerDocsForms, registerDocsOperations, registerDocsPresentations, techContractsDocs };
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { PresentationSpec } from "../../presentations/presentations.js";
|
|
2
|
+
import "../../index.js";
|
|
3
|
+
|
|
4
|
+
//#region src/docs/presentations/docsLayout.presentation.d.ts
|
|
5
|
+
declare const DocsLayoutPresentation: PresentationSpec;
|
|
6
|
+
//#endregion
|
|
7
|
+
export { DocsLayoutPresentation };
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { definePresentation } from "../../presentations/presentations.js";
|
|
2
|
+
import "../../presentations/index.js";
|
|
3
|
+
import { DOCS_DOMAIN, DOCS_OWNERS, DOCS_STABILITY, DOCS_TAGS } from "../constants.js";
|
|
4
|
+
import { docId } from "../registry.js";
|
|
5
|
+
import "../ensure-docblocks.js";
|
|
6
|
+
|
|
7
|
+
//#region src/docs/presentations/docsLayout.presentation.ts
|
|
8
|
+
const DocsLayoutPresentation = definePresentation({
|
|
9
|
+
meta: {
|
|
10
|
+
key: "docs.layout",
|
|
11
|
+
title: "Docs Layout",
|
|
12
|
+
version: "1.0.0",
|
|
13
|
+
description: "Shared layout shell for documentation pages.",
|
|
14
|
+
goal: "Provide consistent navigation, layout, and docs UI scaffolding.",
|
|
15
|
+
context: "Used by web docs surfaces to render DocBlock-based content.",
|
|
16
|
+
domain: DOCS_DOMAIN,
|
|
17
|
+
owners: DOCS_OWNERS,
|
|
18
|
+
tags: [...DOCS_TAGS, "layout"],
|
|
19
|
+
stability: DOCS_STABILITY,
|
|
20
|
+
docId: [docId("docs.tech.docs-system")]
|
|
21
|
+
},
|
|
22
|
+
capability: {
|
|
23
|
+
key: "docs.system",
|
|
24
|
+
version: "1.0.0"
|
|
25
|
+
},
|
|
26
|
+
source: {
|
|
27
|
+
type: "component",
|
|
28
|
+
framework: "react",
|
|
29
|
+
componentKey: "docsLayout"
|
|
30
|
+
},
|
|
31
|
+
targets: ["react"]
|
|
32
|
+
});
|
|
33
|
+
|
|
34
|
+
//#endregion
|
|
35
|
+
export { DocsLayoutPresentation };
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { PresentationSpec } from "../../presentations/presentations.js";
|
|
2
|
+
import "../../index.js";
|
|
3
|
+
|
|
4
|
+
//#region src/docs/presentations/docsReferencePage.presentation.d.ts
|
|
5
|
+
declare const DocsReferencePagePresentation: PresentationSpec;
|
|
6
|
+
//#endregion
|
|
7
|
+
export { DocsReferencePagePresentation };
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { definePresentation } from "../../presentations/presentations.js";
|
|
2
|
+
import "../../presentations/index.js";
|
|
3
|
+
import { DOCS_DOMAIN, DOCS_OWNERS, DOCS_STABILITY, DOCS_TAGS } from "../constants.js";
|
|
4
|
+
import { docId } from "../registry.js";
|
|
5
|
+
import "../ensure-docblocks.js";
|
|
6
|
+
|
|
7
|
+
//#region src/docs/presentations/docsReferencePage.presentation.ts
|
|
8
|
+
const DocsReferencePagePresentation = definePresentation({
|
|
9
|
+
meta: {
|
|
10
|
+
key: "docs.reference.page",
|
|
11
|
+
title: "Docs Reference Page",
|
|
12
|
+
version: "1.0.0",
|
|
13
|
+
description: "Reference page layout for contract documentation.",
|
|
14
|
+
goal: "Render contract references with consistent metadata and formatting.",
|
|
15
|
+
context: "Used by docs surfaces to present contract reference content and schemas.",
|
|
16
|
+
domain: DOCS_DOMAIN,
|
|
17
|
+
owners: DOCS_OWNERS,
|
|
18
|
+
tags: [...DOCS_TAGS, "reference"],
|
|
19
|
+
stability: DOCS_STABILITY,
|
|
20
|
+
docId: [docId("docs.tech.docs-reference")]
|
|
21
|
+
},
|
|
22
|
+
capability: {
|
|
23
|
+
key: "docs.system",
|
|
24
|
+
version: "1.0.0"
|
|
25
|
+
},
|
|
26
|
+
source: {
|
|
27
|
+
type: "component",
|
|
28
|
+
framework: "react",
|
|
29
|
+
componentKey: "docsReferencePage"
|
|
30
|
+
},
|
|
31
|
+
targets: ["react", "markdown"]
|
|
32
|
+
});
|
|
33
|
+
|
|
34
|
+
//#endregion
|
|
35
|
+
export { DocsReferencePagePresentation };
|
|
@@ -0,0 +1,217 @@
|
|
|
1
|
+
import { OperationSpec } from "../../operations/operation.js";
|
|
2
|
+
import "../../index.js";
|
|
3
|
+
import * as _contractspec_lib_schema213 from "@contractspec/lib.schema";
|
|
4
|
+
import { SchemaModel } from "@contractspec/lib.schema";
|
|
5
|
+
|
|
6
|
+
//#region src/docs/queries/contractReference.query.d.ts
|
|
7
|
+
declare const ContractReferenceInput: SchemaModel<{
|
|
8
|
+
key: {
|
|
9
|
+
type: _contractspec_lib_schema213.FieldType<string, string>;
|
|
10
|
+
isOptional: false;
|
|
11
|
+
};
|
|
12
|
+
version: {
|
|
13
|
+
type: _contractspec_lib_schema213.FieldType<string, string>;
|
|
14
|
+
isOptional: true;
|
|
15
|
+
};
|
|
16
|
+
type: {
|
|
17
|
+
type: _contractspec_lib_schema213.FieldType<string, string>;
|
|
18
|
+
isOptional: true;
|
|
19
|
+
};
|
|
20
|
+
format: {
|
|
21
|
+
type: _contractspec_lib_schema213.FieldType<string, string>;
|
|
22
|
+
isOptional: true;
|
|
23
|
+
};
|
|
24
|
+
includeSchema: {
|
|
25
|
+
type: _contractspec_lib_schema213.FieldType<boolean, boolean>;
|
|
26
|
+
isOptional: true;
|
|
27
|
+
};
|
|
28
|
+
}>;
|
|
29
|
+
declare const ContractReferenceModel: SchemaModel<{
|
|
30
|
+
key: {
|
|
31
|
+
type: _contractspec_lib_schema213.FieldType<string, string>;
|
|
32
|
+
isOptional: false;
|
|
33
|
+
};
|
|
34
|
+
version: {
|
|
35
|
+
type: _contractspec_lib_schema213.FieldType<string, string>;
|
|
36
|
+
isOptional: false;
|
|
37
|
+
};
|
|
38
|
+
type: {
|
|
39
|
+
type: _contractspec_lib_schema213.FieldType<string, string>;
|
|
40
|
+
isOptional: false;
|
|
41
|
+
};
|
|
42
|
+
title: {
|
|
43
|
+
type: _contractspec_lib_schema213.FieldType<string, string>;
|
|
44
|
+
isOptional: true;
|
|
45
|
+
};
|
|
46
|
+
description: {
|
|
47
|
+
type: _contractspec_lib_schema213.FieldType<string, string>;
|
|
48
|
+
isOptional: true;
|
|
49
|
+
};
|
|
50
|
+
markdown: {
|
|
51
|
+
type: _contractspec_lib_schema213.FieldType<string, string>;
|
|
52
|
+
isOptional: true;
|
|
53
|
+
};
|
|
54
|
+
route: {
|
|
55
|
+
type: _contractspec_lib_schema213.FieldType<string, string>;
|
|
56
|
+
isOptional: true;
|
|
57
|
+
};
|
|
58
|
+
schema: {
|
|
59
|
+
type: _contractspec_lib_schema213.FieldType<Record<string, unknown>, Record<string, unknown>>;
|
|
60
|
+
isOptional: true;
|
|
61
|
+
};
|
|
62
|
+
policy: {
|
|
63
|
+
type: _contractspec_lib_schema213.FieldType<Record<string, unknown>, Record<string, unknown>>;
|
|
64
|
+
isOptional: true;
|
|
65
|
+
};
|
|
66
|
+
tags: {
|
|
67
|
+
type: _contractspec_lib_schema213.FieldType<string, string>;
|
|
68
|
+
isOptional: true;
|
|
69
|
+
isArray: true;
|
|
70
|
+
};
|
|
71
|
+
owners: {
|
|
72
|
+
type: _contractspec_lib_schema213.FieldType<string, string>;
|
|
73
|
+
isOptional: true;
|
|
74
|
+
isArray: true;
|
|
75
|
+
};
|
|
76
|
+
stability: {
|
|
77
|
+
type: _contractspec_lib_schema213.FieldType<string, string>;
|
|
78
|
+
isOptional: true;
|
|
79
|
+
};
|
|
80
|
+
}>;
|
|
81
|
+
declare const ContractReferenceOutput: SchemaModel<{
|
|
82
|
+
reference: {
|
|
83
|
+
type: SchemaModel<{
|
|
84
|
+
key: {
|
|
85
|
+
type: _contractspec_lib_schema213.FieldType<string, string>;
|
|
86
|
+
isOptional: false;
|
|
87
|
+
};
|
|
88
|
+
version: {
|
|
89
|
+
type: _contractspec_lib_schema213.FieldType<string, string>;
|
|
90
|
+
isOptional: false;
|
|
91
|
+
};
|
|
92
|
+
type: {
|
|
93
|
+
type: _contractspec_lib_schema213.FieldType<string, string>;
|
|
94
|
+
isOptional: false;
|
|
95
|
+
};
|
|
96
|
+
title: {
|
|
97
|
+
type: _contractspec_lib_schema213.FieldType<string, string>;
|
|
98
|
+
isOptional: true;
|
|
99
|
+
};
|
|
100
|
+
description: {
|
|
101
|
+
type: _contractspec_lib_schema213.FieldType<string, string>;
|
|
102
|
+
isOptional: true;
|
|
103
|
+
};
|
|
104
|
+
markdown: {
|
|
105
|
+
type: _contractspec_lib_schema213.FieldType<string, string>;
|
|
106
|
+
isOptional: true;
|
|
107
|
+
};
|
|
108
|
+
route: {
|
|
109
|
+
type: _contractspec_lib_schema213.FieldType<string, string>;
|
|
110
|
+
isOptional: true;
|
|
111
|
+
};
|
|
112
|
+
schema: {
|
|
113
|
+
type: _contractspec_lib_schema213.FieldType<Record<string, unknown>, Record<string, unknown>>;
|
|
114
|
+
isOptional: true;
|
|
115
|
+
};
|
|
116
|
+
policy: {
|
|
117
|
+
type: _contractspec_lib_schema213.FieldType<Record<string, unknown>, Record<string, unknown>>;
|
|
118
|
+
isOptional: true;
|
|
119
|
+
};
|
|
120
|
+
tags: {
|
|
121
|
+
type: _contractspec_lib_schema213.FieldType<string, string>;
|
|
122
|
+
isOptional: true;
|
|
123
|
+
isArray: true;
|
|
124
|
+
};
|
|
125
|
+
owners: {
|
|
126
|
+
type: _contractspec_lib_schema213.FieldType<string, string>;
|
|
127
|
+
isOptional: true;
|
|
128
|
+
isArray: true;
|
|
129
|
+
};
|
|
130
|
+
stability: {
|
|
131
|
+
type: _contractspec_lib_schema213.FieldType<string, string>;
|
|
132
|
+
isOptional: true;
|
|
133
|
+
};
|
|
134
|
+
}>;
|
|
135
|
+
isOptional: false;
|
|
136
|
+
};
|
|
137
|
+
}>;
|
|
138
|
+
declare const ContractReferenceQuery: OperationSpec<SchemaModel<{
|
|
139
|
+
key: {
|
|
140
|
+
type: _contractspec_lib_schema213.FieldType<string, string>;
|
|
141
|
+
isOptional: false;
|
|
142
|
+
};
|
|
143
|
+
version: {
|
|
144
|
+
type: _contractspec_lib_schema213.FieldType<string, string>;
|
|
145
|
+
isOptional: true;
|
|
146
|
+
};
|
|
147
|
+
type: {
|
|
148
|
+
type: _contractspec_lib_schema213.FieldType<string, string>;
|
|
149
|
+
isOptional: true;
|
|
150
|
+
};
|
|
151
|
+
format: {
|
|
152
|
+
type: _contractspec_lib_schema213.FieldType<string, string>;
|
|
153
|
+
isOptional: true;
|
|
154
|
+
};
|
|
155
|
+
includeSchema: {
|
|
156
|
+
type: _contractspec_lib_schema213.FieldType<boolean, boolean>;
|
|
157
|
+
isOptional: true;
|
|
158
|
+
};
|
|
159
|
+
}>, SchemaModel<{
|
|
160
|
+
reference: {
|
|
161
|
+
type: SchemaModel<{
|
|
162
|
+
key: {
|
|
163
|
+
type: _contractspec_lib_schema213.FieldType<string, string>;
|
|
164
|
+
isOptional: false;
|
|
165
|
+
};
|
|
166
|
+
version: {
|
|
167
|
+
type: _contractspec_lib_schema213.FieldType<string, string>;
|
|
168
|
+
isOptional: false;
|
|
169
|
+
};
|
|
170
|
+
type: {
|
|
171
|
+
type: _contractspec_lib_schema213.FieldType<string, string>;
|
|
172
|
+
isOptional: false;
|
|
173
|
+
};
|
|
174
|
+
title: {
|
|
175
|
+
type: _contractspec_lib_schema213.FieldType<string, string>;
|
|
176
|
+
isOptional: true;
|
|
177
|
+
};
|
|
178
|
+
description: {
|
|
179
|
+
type: _contractspec_lib_schema213.FieldType<string, string>;
|
|
180
|
+
isOptional: true;
|
|
181
|
+
};
|
|
182
|
+
markdown: {
|
|
183
|
+
type: _contractspec_lib_schema213.FieldType<string, string>;
|
|
184
|
+
isOptional: true;
|
|
185
|
+
};
|
|
186
|
+
route: {
|
|
187
|
+
type: _contractspec_lib_schema213.FieldType<string, string>;
|
|
188
|
+
isOptional: true;
|
|
189
|
+
};
|
|
190
|
+
schema: {
|
|
191
|
+
type: _contractspec_lib_schema213.FieldType<Record<string, unknown>, Record<string, unknown>>;
|
|
192
|
+
isOptional: true;
|
|
193
|
+
};
|
|
194
|
+
policy: {
|
|
195
|
+
type: _contractspec_lib_schema213.FieldType<Record<string, unknown>, Record<string, unknown>>;
|
|
196
|
+
isOptional: true;
|
|
197
|
+
};
|
|
198
|
+
tags: {
|
|
199
|
+
type: _contractspec_lib_schema213.FieldType<string, string>;
|
|
200
|
+
isOptional: true;
|
|
201
|
+
isArray: true;
|
|
202
|
+
};
|
|
203
|
+
owners: {
|
|
204
|
+
type: _contractspec_lib_schema213.FieldType<string, string>;
|
|
205
|
+
isOptional: true;
|
|
206
|
+
isArray: true;
|
|
207
|
+
};
|
|
208
|
+
stability: {
|
|
209
|
+
type: _contractspec_lib_schema213.FieldType<string, string>;
|
|
210
|
+
isOptional: true;
|
|
211
|
+
};
|
|
212
|
+
}>;
|
|
213
|
+
isOptional: false;
|
|
214
|
+
};
|
|
215
|
+
}>, undefined>;
|
|
216
|
+
//#endregion
|
|
217
|
+
export { ContractReferenceInput, ContractReferenceModel, ContractReferenceOutput, ContractReferenceQuery };
|