@astryxdesign/cli 0.7.2-canary.f16dc9f → 0.7.2-canary.f2b60a0

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.
Files changed (243) hide show
  1. package/README.md +15 -14
  2. package/api/build/help/help.mjs +1 -1
  3. package/api/component/_adapter.d.mts +41 -1
  4. package/api/component/_adapter.mjs +93 -7
  5. package/api/component/component.mjs +22 -5
  6. package/api/component/component.test.mjs +420 -167
  7. package/api/component/integration-export-name.test.mjs +644 -0
  8. package/api/component/list/list.mjs +42 -4
  9. package/api/docs/_adapter.d.mts +11 -0
  10. package/api/docs/_adapter.mjs +244 -1
  11. package/api/docs/integrationDocs.test.mjs +124 -0
  12. package/api/doctor/doctor.mjs +27 -3
  13. package/api/doctor/doctor.test.mjs +43 -0
  14. package/api/doctor/theme-checks.mjs +1 -1
  15. package/api/gap-report/gap-report.mjs +67 -4
  16. package/api/index.d.mts +2 -0
  17. package/api/index.mjs +2 -0
  18. package/api/init/run/run.mjs +2 -2
  19. package/api/integration/_adapter.d.mts +12 -0
  20. package/api/integration/_adapter.mjs +54 -0
  21. package/api/integration/add-contribution.component-names.test.mjs +66 -0
  22. package/api/integration/add-contribution.mjs +8 -4
  23. package/api/integration/add-contribution.test.mjs +4 -2
  24. package/api/integration/authoring-checks.mjs +11 -2
  25. package/api/integration/authoring-checks.test.mjs +39 -0
  26. package/api/integration/authoring-checks.type.d.mts +9 -0
  27. package/api/integration/authoring-checks.type.mjs +14 -1
  28. package/api/integration/check/check.d.mts +96 -0
  29. package/api/integration/check/check.mjs +357 -0
  30. package/api/integration/check/check.test.mjs +489 -0
  31. package/api/integration/integration-check.type.d.mts +118 -0
  32. package/api/integration/integration-check.type.mjs +84 -0
  33. package/api/integration/integrationCheck.doc.d.mts +10 -0
  34. package/api/integration/integrationCheck.doc.mjs +73 -0
  35. package/api/integration/integrationComponentConflicts.doc.mjs +36 -5
  36. package/api/integration/pack-check.mjs +61 -107
  37. package/api/integration/pack-check.test.mjs +359 -0
  38. package/api/integration/validate-integration.mjs +8 -0
  39. package/api/integration/validate-integration.test.mjs +11 -0
  40. package/api/integration/validate-integration.type.d.mts +8 -0
  41. package/api/integration/validate-integration.type.mjs +12 -1
  42. package/api/integration/validateIntegration.doc.mjs +17 -3
  43. package/api/search/search.d.mts +22 -6
  44. package/api/search/search.domain-priority.test.mjs +108 -18
  45. package/api/search/search.integration-check.test.mjs +24 -0
  46. package/api/search/search.mjs +141 -25
  47. package/api/search/search.test.mjs +36 -0
  48. package/api/swizzle/copy/copy.mjs +28 -14
  49. package/api/template/template.test.mjs +120 -3
  50. package/api/theme/build/build.family.test.mjs +64 -0
  51. package/api/theme/build/build.mjs +180 -24
  52. package/api/theme/themeBuild.doc.mjs +4 -4
  53. package/assets/codemods/transforms/next/__tests__/migrate-list-edge-compensation-to-edge.test.mjs +120 -0
  54. package/assets/codemods/transforms/next/index.mjs +11 -1
  55. package/assets/codemods/transforms/next/migrate-list-edge-compensation-to-edge.mjs +198 -0
  56. package/assets/docs/README.md +10 -0
  57. package/assets/docs/author-a-theme.doc.mjs +1 -1
  58. package/assets/docs/getting-started.doc.mjs +3 -3
  59. package/assets/docs/styling-overview.doc.mjs +1 -1
  60. package/assets/docs/theme.doc.dense.mjs +1 -1
  61. package/assets/docs/theme.doc.mjs +1 -1
  62. package/assets/docs/theme.doc.zh.mjs +1 -1
  63. package/assets/docs/tree/add-a-component.doc.mjs +11 -1
  64. package/assets/docs/tree/add-a-theme.doc.mjs +1 -1
  65. package/assets/docs/tree/add-a-topic.doc.mjs +10 -7
  66. package/assets/docs/tree/agent-guidance.doc.mjs +2 -2
  67. package/assets/docs/tree/block-template.doc.mjs +8 -20
  68. package/assets/docs/tree/build-the-template.doc.mjs +1 -1
  69. package/assets/docs/tree/check-the-props.doc.mjs +196 -0
  70. package/assets/docs/tree/check-your-docs.doc.mjs +51 -5
  71. package/assets/docs/tree/checks.doc.mjs +24 -16
  72. package/assets/docs/tree/codemods.doc.mjs +4 -4
  73. package/assets/docs/tree/component-family.doc.mjs +8 -6
  74. package/assets/docs/tree/component-imports.doc.mjs +10 -2
  75. package/assets/docs/tree/components.doc.mjs +1 -1
  76. package/assets/docs/tree/debug-and-gap-reports.doc.mjs +7 -18
  77. package/assets/docs/tree/define-the-theme.doc.mjs +6 -5
  78. package/assets/docs/tree/describe-the-component.doc.mjs +2 -2
  79. package/assets/docs/tree/docs.doc.mjs +3 -3
  80. package/assets/docs/tree/document-the-template.doc.mjs +1 -1
  81. package/assets/docs/tree/document-the-theme.doc.mjs +1 -1
  82. package/assets/docs/tree/export-template-assets.doc.mjs +1 -1
  83. package/assets/docs/tree/extend-or-replace.doc.mjs +6 -6
  84. package/assets/docs/tree/fonts-and-assets.doc.mjs +2 -2
  85. package/assets/docs/tree/generate-a-palette.doc.mjs +5 -3
  86. package/assets/docs/tree/grade-template-with-agent.doc.mjs +1 -1
  87. package/assets/docs/tree/integrations.doc.mjs +8 -0
  88. package/assets/docs/tree/links.doc.mjs +6 -5
  89. package/assets/docs/tree/migration-setup.doc.mjs +1 -0
  90. package/assets/docs/tree/migration-verification.doc.mjs +0 -1
  91. package/assets/docs/tree/migration.doc.mjs +0 -1
  92. package/assets/docs/tree/package-and-test.doc.mjs +1 -1
  93. package/assets/docs/tree/page-template.doc.mjs +4 -8
  94. package/assets/docs/tree/publishing.doc.mjs +1 -1
  95. package/assets/docs/tree/quick-start.doc.mjs +37 -21
  96. package/assets/docs/tree/replace-a-core-component.doc.mjs +4 -6
  97. package/assets/docs/tree/replace-a-core-template.doc.mjs +6 -8
  98. package/assets/docs/tree/sections-and-placement.doc.mjs +4 -6
  99. package/assets/docs/tree/see-it-in-an-app.doc.mjs +4 -2
  100. package/assets/docs/tree/short-and-findable.doc.mjs +6 -5
  101. package/assets/docs/tree/single-component.doc.mjs +15 -6
  102. package/assets/docs/tree/start-a-template.doc.mjs +3 -3
  103. package/assets/docs/tree/subcomponent.doc.mjs +6 -6
  104. package/assets/docs/tree/template-assets.doc.mjs +2 -2
  105. package/assets/docs/tree/template-doc-overview.doc.mjs +4 -15
  106. package/assets/docs/tree/template-fonts.doc.mjs +1 -1
  107. package/assets/docs/tree/template-icons.doc.mjs +1 -1
  108. package/assets/docs/tree/template-images-media.doc.mjs +1 -1
  109. package/assets/docs/tree/template-styles.doc.mjs +2 -2
  110. package/assets/docs/tree/templates.doc.mjs +1 -1
  111. package/assets/docs/tree/test-in-an-app.doc.mjs +3 -3
  112. package/assets/docs/tree/test-template-in-app.doc.mjs +1 -1
  113. package/assets/docs/tree/tokens-and-setup.doc.mjs +19 -15
  114. package/assets/docs/tree/troubleshooting.doc.mjs +13 -5
  115. package/assets/docs/tree/type-scale.doc.mjs +3 -3
  116. package/assets/docs/tree/upgrading.doc.mjs +3 -3
  117. package/assets/docs/tree/use-a-theme-in-an-app.doc.mjs +3 -1
  118. package/assets/docs/tree/verify-packed-template.doc.mjs +1 -1
  119. package/assets/docs/tree/versioning.doc.mjs +7 -6
  120. package/assets/docs/tree/write-the-template-file.doc.mjs +4 -3
  121. package/assets/docs/use-a-theme.doc.mjs +2 -2
  122. package/assets/docs/working-with-ai.doc.mjs +43 -4
  123. package/assets/templates/blocks/components/Drawer/DrawerForm.doc.mjs +24 -0
  124. package/assets/templates/blocks/components/Drawer/DrawerForm.tsx +62 -0
  125. package/assets/templates/blocks/components/Drawer/DrawerScrim.doc.mjs +22 -0
  126. package/assets/templates/blocks/components/Drawer/DrawerScrim.tsx +68 -0
  127. package/assets/templates/blocks/components/Drawer/DrawerShowcase.doc.mjs +22 -0
  128. package/assets/templates/blocks/components/Drawer/DrawerShowcase.tsx +41 -0
  129. package/assets/templates/blocks/components/Drawer/DrawerStart.doc.mjs +21 -0
  130. package/assets/templates/blocks/components/Drawer/DrawerStart.tsx +41 -0
  131. package/assets/templates/blocks/components/Drawer/DrawerWidths.doc.mjs +22 -0
  132. package/assets/templates/blocks/components/Drawer/DrawerWidths.tsx +54 -0
  133. package/assets/templates/blocks/components/DrawerHeader/DrawerHeaderShowcase.doc.mjs +15 -0
  134. package/assets/templates/blocks/components/DrawerHeader/DrawerHeaderShowcase.tsx +73 -0
  135. package/assets/templates/blocks/components/DrawerHeader/DrawerHeaderSubtitleEndContent.doc.mjs +22 -0
  136. package/assets/templates/blocks/components/DrawerHeader/DrawerHeaderSubtitleEndContent.tsx +49 -0
  137. package/assets/templates/blocks/components/DrawerHeader/DrawerHeaderWithCloseButton.doc.mjs +21 -0
  138. package/assets/templates/blocks/components/DrawerHeader/DrawerHeaderWithCloseButton.tsx +42 -0
  139. package/assets/templates/pages/detail-page/page.tsx +3 -3
  140. package/assets/templates/pages/table-inbox/page.tsx +10 -8
  141. package/assets/theme.template.ts +1 -1
  142. package/authoring/codemod/codemod.doc.mjs +7 -3
  143. package/authoring/config/config.doc.mjs +9 -6
  144. package/authoring/config/type.ts +4 -2
  145. package/authoring/discover/discover.doc.mjs +1 -1
  146. package/authoring/doctypes/base/graph-fields.doc.mjs +6 -4
  147. package/authoring/doctypes/base/type.ts +6 -0
  148. package/authoring/doctypes/command/command.doc.mjs +14 -12
  149. package/authoring/doctypes/component/component.doc.mjs +31 -28
  150. package/authoring/doctypes/component/type.ts +13 -8
  151. package/authoring/doctypes/enum/enum.doc.mjs +7 -4
  152. package/authoring/doctypes/function/function.doc.mjs +9 -8
  153. package/authoring/doctypes/hook/hook.doc.mjs +5 -4
  154. package/authoring/doctypes/namespace/namespace.doc.mjs +7 -6
  155. package/authoring/doctypes/reference/reference.doc.mjs +11 -10
  156. package/authoring/doctypes/schema/schema.doc.mjs +9 -9
  157. package/authoring/doctypes/template/integration-template.doc.d.mts +11 -0
  158. package/authoring/doctypes/template/integration-template.doc.mjs +49 -0
  159. package/authoring/doctypes/template/parse.d.mts +6 -2
  160. package/authoring/doctypes/template/parse.mjs +3 -1
  161. package/authoring/doctypes/template/template.doc.mjs +3 -3
  162. package/authoring/doctypes/template/type.ts +22 -0
  163. package/authoring/doctypes/theme/theme.doc.mjs +2 -2
  164. package/authoring/gap-report/gap-report.doc.mjs +2 -2
  165. package/authoring/identity/identity.doc.mjs +3 -3
  166. package/authoring/index.d.ts +1 -0
  167. package/authoring/integration/integration.doc.mjs +12 -4
  168. package/authoring/integration/parse.test.mjs +10 -0
  169. package/authoring/integration/schema.d.mts +2 -0
  170. package/authoring/integration/schema.mjs +1 -0
  171. package/authoring/integration/type.ts +4 -0
  172. package/clients/cli/commands/build-theme.batch-report.test.mjs +3 -1
  173. package/clients/cli/commands/build-theme.mjs +1 -1
  174. package/clients/cli/commands/build-theme.path-safety.test.mjs +224 -6
  175. package/clients/cli/commands/build-theme.registry.test.mjs +5 -2
  176. package/clients/cli/commands/cli-postinstall.test.mjs +49 -1
  177. package/clients/cli/commands/doctor-integration-components.doc.mjs +15 -4
  178. package/clients/cli/commands/doctor-integration-validate.doc.mjs +11 -2
  179. package/clients/cli/commands/doctor-integration.test.mjs +837 -0
  180. package/clients/cli/commands/doctor.mjs +190 -0
  181. package/clients/cli/commands/integration-check.doc.mjs +85 -0
  182. package/clients/cli/commands/integration-check.test.mjs +267 -0
  183. package/clients/cli/commands/integration.doc.mjs +6 -2
  184. package/clients/cli/commands/integration.mjs +107 -1
  185. package/clients/cli/commands/setup-nudge.test.mjs +79 -1
  186. package/clients/cli/commands/swizzle.mjs +5 -3
  187. package/clients/cli/commands/swizzle.routing.test.mjs +18 -1
  188. package/clients/cli/commands/text-json-parity.test.mjs +5 -0
  189. package/clients/cli/commands/theme-build.doc.mjs +2 -2
  190. package/clients/cli/index.mjs +30 -5
  191. package/clients/cli/lib/component-format.mjs +5 -1
  192. package/foundation/agent-docs/agent-doc-state.d.mts +14 -0
  193. package/foundation/agent-docs/agent-doc-state.mjs +38 -0
  194. package/foundation/agent-docs/agent-docs.d.mts +2 -1
  195. package/foundation/agent-docs/agent-docs.mjs +8 -6
  196. package/foundation/config/project.mjs +82 -0
  197. package/foundation/discovery/authoring-self-docs.mjs +2 -1
  198. package/foundation/discovery/component-discovery.d.mts +190 -10
  199. package/foundation/discovery/component-discovery.export-names.test.mjs +760 -0
  200. package/foundation/discovery/component-discovery.mjs +864 -56
  201. package/foundation/discovery/component-discovery.test.mjs +96 -0
  202. package/foundation/discovery/component-replacement.mjs +18 -0
  203. package/foundation/discovery/component-replacement.test.mjs +40 -0
  204. package/foundation/discovery/doc-types.d.mts +157 -0
  205. package/foundation/discovery/doc-types.mjs +1224 -0
  206. package/foundation/discovery/doc-types.test.mjs +652 -0
  207. package/foundation/discovery/docs-discovery.d.mts +81 -0
  208. package/foundation/discovery/docs-discovery.mjs +57 -0
  209. package/foundation/discovery/integration-doc-files.d.mts +22 -0
  210. package/foundation/discovery/integration-doc-files.mjs +231 -0
  211. package/foundation/discovery/integration-doc-files.test.mjs +246 -0
  212. package/foundation/discovery/module-exports.d.mts +27 -0
  213. package/foundation/discovery/module-exports.mjs +356 -31
  214. package/foundation/discovery/module-exports.test.mjs +172 -0
  215. package/foundation/discovery/package-tsconfig.d.mts +14 -0
  216. package/foundation/discovery/package-tsconfig.mjs +228 -0
  217. package/foundation/discovery/package-tsconfig.test.mjs +210 -0
  218. package/foundation/discovery/project-typescript.d.mts +23 -0
  219. package/foundation/discovery/project-typescript.mjs +61 -0
  220. package/foundation/discovery/prop-drift.d.mts +278 -0
  221. package/foundation/discovery/prop-drift.mjs +2263 -0
  222. package/foundation/discovery/prop-drift.test.mjs +2219 -0
  223. package/foundation/discovery/template-adapter.mjs +74 -5
  224. package/foundation/discovery/type-match.d.mts +53 -0
  225. package/foundation/discovery/type-match.mjs +660 -0
  226. package/foundation/discovery/type-match.test.mjs +169 -0
  227. package/foundation/discovery/type-text.d.mts +68 -0
  228. package/foundation/discovery/type-text.mjs +658 -0
  229. package/foundation/discovery/type-text.test.mjs +196 -0
  230. package/foundation/discovery/unresolved-references.d.mts +62 -0
  231. package/foundation/discovery/unresolved-references.mjs +790 -0
  232. package/foundation/discovery/unresolved-references.test.mjs +567 -0
  233. package/foundation/doc-compiler/doc-loads.test.mjs +11 -1
  234. package/foundation/doc-compiler/inputs.mjs +23 -0
  235. package/foundation/doc-compiler/inputs.test.mjs +0 -1
  236. package/foundation/doc-compiler/links.d.mts +9 -5
  237. package/foundation/doc-compiler/links.mjs +4 -2
  238. package/foundation/integrations/contribution-inventory.mjs +6 -1
  239. package/foundation/response/response-types.doc.mjs +7 -2
  240. package/foundation/xle/registry.mjs +4 -0
  241. package/foundation/xle/registry.test.mjs +28 -0
  242. package/package.json +10 -10
  243. package/scripts/postinstall.mjs +3 -3
@@ -55,7 +55,8 @@ export const doc = {
55
55
  {
56
56
  name: 'audience',
57
57
  type: "'public' | 'internal'",
58
- description: "Bundle audience. Defaults to 'public'.",
58
+ description:
59
+ "Reserved: bundle audience. Nothing reads it yet: a namespace that sets 'internal' still shows in `astryx docs`.",
59
60
  default: "'public'",
60
61
  },
61
62
  {
@@ -67,7 +68,7 @@ export const doc = {
67
68
  name: 'slots',
68
69
  type: 'Record<string, NamespaceSlot>',
69
70
  description:
70
- 'Named placement and collection targets. Each slot declares a title and accepted doc kinds; configured providers require an explicit extension slot.',
71
+ "Named placement and collection targets. Each slot declares a title and the doc kinds it accepts. `accepts.providers` is not read yet: only docs of the namespace's own package can be placed in a slot.",
71
72
  required: true,
72
73
  },
73
74
  {
@@ -80,7 +81,7 @@ export const doc = {
80
81
  name: 'blocks',
81
82
  type: '(ReferenceContentBlock | GraphContentBlock)[]',
82
83
  description:
83
- 'Ordered layout content for the namespace page. Graph-only workflow, collection, and reference blocks are available here without widening the stable ReferenceContentBlock union used by existing topic renderers. Not rendered yet: `astryx docs <route>` lists every slot and its children in order.',
84
+ 'Ordered layout content for the namespace page. Graph-only workflow, collection, and reference blocks are available here without widening the stable ReferenceContentBlock union used by existing topic renderers. `astryx docs <route>` prints the prose, heading, code, table, and list blocks above the slots, and `--json` returns every block with its links resolved. A collection block is not rendered yet, and `astryx doctor` warns on one.',
84
85
  },
85
86
  ],
86
87
  examples: [
@@ -100,7 +101,7 @@ export const docs = {
100
101
  },
101
102
  },
102
103
  adopts: [{
103
- source: {group: 'cli-commands', kinds: ['command']},
104
+ source: {group: 'cli/commands', kinds: ['command']},
104
105
  into: 'reference',
105
106
  }],
106
107
  };`,
@@ -109,11 +110,11 @@ export const docs = {
109
110
  notes: [
110
111
  {
111
112
  type: 'prose',
112
- text: "The docs tree reads namespace docs from the CLI and from every configured integration. An integration's namespace doc is a top-level level of the tree, and its guides name it with `placement`; a doc can be placed only in a namespace of its own package. When two packages claim one route, the CLI's own docs win, then integrations in configured order, and `astryx doctor` names the loser.",
113
+ text: "The docs tree reads namespace docs from the CLI and from every configured integration. An integration's namespace doc without a `placement` is a top-level level of the tree, and its guides name it with `placement`; a doc can be placed only in a namespace of its own package. When two packages claim one route, the CLI's own docs win, then integrations in configured order, and `astryx doctor` names the loser.",
113
114
  },
114
115
  {
115
116
  type: 'prose',
116
- text: 'Child docs request one canonical home with placement. Collections store and render stable references to those docs; they never create a second identity or parent.',
117
+ text: 'Child docs request one canonical home with placement. A collection block refers to those docs by stable reference and never creates a second identity or parent. It is not rendered yet: `astryx doctor` warns on one.',
117
118
  },
118
119
  {
119
120
  type: 'list',
@@ -18,7 +18,8 @@ export const doc = {
18
18
  'accessibility, migration guides. Unlike ComponentDoc it is not tied to a component: ' +
19
19
  'drop a `.doc.mjs` in the docs directory and it shows up in `astryx docs`. Content is ' +
20
20
  'built from ordered sections of mixed content blocks.',
21
- appliesTo: 'assets/docs/<topic>.doc.mjs',
21
+ appliesTo:
22
+ "<topic>.doc.{ts,mjs,js} in the folder the integration manifest's `docs` names",
22
23
  fields: [
23
24
  {
24
25
  name: 'type',
@@ -69,7 +70,7 @@ export const doc = {
69
70
  name: 'extends',
70
71
  type: 'string',
71
72
  description:
72
- "Name of an existing topic this doc merges onto, section by section: a section whose title matches one in the base replaces it, a section the base does not have is appended. The topic keeps the base's title and description. For correcting or adding to a topic rather than owning it. Exclusive with `replaces`.",
73
+ "Name of an existing topic this doc merges onto, section by section. A section replaces the base section with the same `id`, or else the one with exactly its title when either of the two has no `id`. A key derived from a title counts only against an `id`: a section without an `id` also matches a base section whose `id` is the key its title derives, and a section with an `id` also matches a base section without one whose title derives that `id`. Two different `id`s never match, two sections without an `id` whose titles differ only in case or punctuation stay separate, and a section that matches none is appended. The topic keeps the base's title and description. For correcting or adding to a topic rather than owning it. Exclusive with `replaces`.",
73
74
  example: "'theme'",
74
75
  },
75
76
  {
@@ -83,7 +84,7 @@ export const doc = {
83
84
  name: 'sections[].id',
84
85
  type: 'string',
85
86
  description:
86
- 'Stable section anchor. New docs should set this instead of relying on a mutable title.',
87
+ 'Stable section anchor. New docs should set this instead of relying on a mutable title. Published @astryxdesign/cli 0.6.3 and earlier reject the field and hide every doc topic the package ships, so `astryx integration verify` fails an integration that sets one until it declares an `@astryxdesign/cli` peer of `>=0.6.4`.',
87
88
  },
88
89
  {
89
90
  name: 'sections[].title',
@@ -109,7 +110,7 @@ export const doc = {
109
110
  name: 'sections[].previewType',
110
111
  type: 'ReferenceTokenPreviewType',
111
112
  description:
112
- "Preview type for token tables in this section. When set, the docsite renders a visual preview column from the token's computed value. Omit for non-token sections.",
113
+ 'Preview type for token tables in this section. The CLI rejects a value not in the list below and returns the value in `astryx docs --json`, but draws no preview from it. Omit for non-token sections.',
113
114
  },
114
115
  ],
115
116
  },
@@ -117,17 +118,17 @@ export const doc = {
117
118
  name: 'tokenCategory',
118
119
  type: 'string',
119
120
  description:
120
- "Token category for foundational docs that map to a token section (e.g. 'color'). Lets the tokens overview link to this doc for detailed guidance.",
121
+ "Token category for foundational docs that map to a token section (e.g. 'color'). `astryx docs --json` returns it as authored; no tokens page links to the doc through it.",
121
122
  },
122
123
  ],
123
124
  examples: [
124
125
  {
125
126
  label: 'A reference doc with one section',
126
127
  code: `/** @type {import('@astryxdesign/cli/authoring').ReferenceDoc} */
127
- export const docs = {
128
+ export default {
128
129
  type: 'generic',
129
- name: 'spacing',
130
- title: 'Spacing',
130
+ name: 'acme-spacing',
131
+ title: 'Acme Spacing',
131
132
  description: 'Spacing tokens for gap, margin, and padding.',
132
133
  category: 'foundations',
133
134
  tokenCategory: 'spacing',
@@ -194,7 +195,7 @@ type ReferenceDocBlock = {
194
195
 
195
196
  type GraphContentBlock =
196
197
  | { type: 'workflow'; title?: string; steps: WorkflowStep[] }
197
- | { type: 'collection'; source: {slot: string}; presentation?: 'list' | 'cards' | 'compact'; whenEmpty?: 'show' | 'omit' }
198
+ | { type: 'collection'; title?: string; source: {slot: string}; presentation?: 'list' | 'cards' | 'compact'; whenEmpty?: 'show' | 'omit' }
198
199
  | ReferenceDocBlock;`,
199
200
  },
200
201
  {
@@ -203,7 +204,7 @@ type GraphContentBlock =
203
204
  },
204
205
  {
205
206
  type: 'prose',
206
- text: "A section may set `previewType` to render a visual preview column for token tables: one of 'swatch' | 'shadow-box' | 'radius-box' | 'spacing-bar' | 'size-bar' | 'border-line' | 'duration-bar' | 'easing-curve' | 'font-sample'.",
207
+ text: "A section may set `previewType`, a hint for previewing its token table, to one of 'swatch' | 'shadow-box' | 'radius-box' | 'spacing-bar' | 'size-bar' | 'border-line' | 'duration-bar' | 'easing-curve' | 'font-sample'; the CLI rejects any other value.",
207
208
  },
208
209
  ],
209
210
  };
@@ -55,7 +55,7 @@ export const doc = {
55
55
  name: 'aliases',
56
56
  type: 'string[]',
57
57
  description:
58
- 'Alternate slugs that also resolve to this doc (back-compat).',
58
+ 'Reserved: alternate slugs for this doc. Nothing reads it yet: `astryx docs` finds a schema doc by its `name` only.',
59
59
  },
60
60
  {
61
61
  name: 'appliesTo',
@@ -141,7 +141,7 @@ export const doc = {
141
141
  name: 'notes',
142
142
  type: 'ReferenceContentBlock[]',
143
143
  description:
144
- 'Freeform prose/notes rendered after the field table. Same block union as ReferenceDoc (prose, heading, code, table, list, token-ref).',
144
+ 'Freeform prose/notes rendered after the field table and examples. The stable ReferenceContentBlock union (prose, heading, code, table, list, token-ref), without the reference block a ReferenceDoc section also takes; a token-ref note is accepted but not rendered.',
145
145
  },
146
146
  ],
147
147
  examples: [
@@ -152,17 +152,17 @@ export const doc = {
152
152
  type: 'schema',
153
153
  name: 'integration',
154
154
  displayName: 'Astryx Integration',
155
- namespace: 'cli',
156
- description: 'The astryx.integration.* manifest that registers the components a package provides.',
155
+ namespace: 'authoring',
156
+ description: 'The astryx.integration.* manifest that points the CLI at what a package contributes.',
157
157
  appliesTo: 'astryx.integration.{ts,mjs,js}',
158
158
  fields: [
159
- {name: 'name', type: 'string', description: 'Package name.', required: true},
159
+ {name: 'docs', type: 'string', description: 'The folder that holds your doc topics, relative to package.json.'},
160
160
  {
161
- name: 'components',
162
- type: '{ dir: string }',
163
- description: 'Where component sources live.',
161
+ name: 'agentDocs',
162
+ type: '{ append?: readonly string[] }',
163
+ description: 'Guidance your package adds to the agent instructions the CLI manages.',
164
164
  fields: [
165
- {name: 'components.dir', type: 'string', description: 'Glob root for Acme*.tsx files.', required: true},
165
+ {name: 'agentDocs.append', type: 'readonly string[]', description: 'Lines added at the end, at most eight.'},
166
166
  ],
167
167
  },
168
168
  ],
@@ -0,0 +1,11 @@
1
+ // @generated by scripts/sync-api-types.mjs from the JSDoc in authoring/**/*.mjs.
2
+ // DO NOT EDIT — run `pnpm sync:api-types` to regenerate.
3
+
4
+ /**
5
+ * @file SchemaDoc for the `IntegrationTemplateDoc` doc-type — the template
6
+ * metadata an integration package ships: TemplateDoc, with the package's own
7
+ * `category`. Colocated with the type it describes (`type.ts`).
8
+ * @position packages/cli/authoring/doctypes/template — doc-type documentation
9
+ */
10
+ /** @type {import('@astryxdesign/cli/authoring').SchemaDoc} */
11
+ export const doc: import("@astryxdesign/cli/authoring").SchemaDoc;
@@ -0,0 +1,49 @@
1
+ // Copyright (c) Meta Platforms, Inc. and affiliates.
2
+
3
+ /**
4
+ * @file SchemaDoc for the `IntegrationTemplateDoc` doc-type — the template
5
+ * metadata an integration package ships: TemplateDoc, with the package's own
6
+ * `category`. Colocated with the type it describes (`type.ts`).
7
+ * @position packages/cli/authoring/doctypes/template — doc-type documentation
8
+ */
9
+
10
+ /** @type {import('@astryxdesign/cli/authoring').SchemaDoc} */
11
+ export const doc = {
12
+ type: 'schema',
13
+ name: 'integration-template-doc',
14
+ displayName: 'IntegrationTemplateDoc',
15
+ namespace: 'authoring',
16
+ description:
17
+ "The doc-type for an integration package's template metadata. It has every " +
18
+ "TemplateDoc field and rule, except that `category` is the package's own " +
19
+ 'string instead of a TemplateCategory value.',
20
+ appliesTo: '<Name>.doc.mjs',
21
+ fields: [
22
+ {
23
+ name: 'category',
24
+ type: 'string',
25
+ description:
26
+ "The package's own category. Bare `astryx template` groups the package's templates by it.",
27
+ },
28
+ ],
29
+ examples: [
30
+ {
31
+ label: 'Block template in an integration package',
32
+ code: `/** @type {import('@astryxdesign/cli/authoring').IntegrationTemplateDoc} */
33
+ export default {
34
+ type: 'block',
35
+ name: 'acme-pricing-table',
36
+ displayName: 'Pricing Table',
37
+ description: 'Plans side by side, with the chosen plan highlighted.',
38
+ aspectRatio: 16 / 9,
39
+ category: 'Acme - Commerce',
40
+ };`,
41
+ },
42
+ ],
43
+ notes: [
44
+ {
45
+ type: 'prose',
46
+ text: "Every other field, and the page and block variants, are TemplateDoc's. Core's own templates use TemplateDoc, whose `category` is a TemplateCategory value. `astryx doctor integration validate` checks an integration's template docs against IntegrationTemplateDoc.",
47
+ },
48
+ ],
49
+ };
@@ -18,7 +18,9 @@ export type BlockTemplateDoc = import("./type.js").BlockTemplateDoc;
18
18
  * Templates as they load. Integration templates already published omit
19
19
  * `displayName` and `aspectRatio` and group themselves under their own
20
20
  * `category`, so the loader accepts those (template discovery falls back to an
21
- * aspect ratio of 1). The published types keep asking authors for all three.
21
+ * aspect ratio of 1). The published `TemplateDoc` keeps asking authors for all
22
+ * three; `IntegrationTemplateDoc`, for an integration package's templates,
23
+ * takes the package's own `category`.
22
24
  */
23
25
  export type LoadedPageTemplateDoc = Omit<PageTemplateDoc, "displayName" | "category"> & {
24
26
  displayName?: string;
@@ -28,7 +30,9 @@ export type LoadedPageTemplateDoc = Omit<PageTemplateDoc, "displayName" | "categ
28
30
  * Templates as they load. Integration templates already published omit
29
31
  * `displayName` and `aspectRatio` and group themselves under their own
30
32
  * `category`, so the loader accepts those (template discovery falls back to an
31
- * aspect ratio of 1). The published types keep asking authors for all three.
33
+ * aspect ratio of 1). The published `TemplateDoc` keeps asking authors for all
34
+ * three; `IntegrationTemplateDoc`, for an integration package's templates,
35
+ * takes the package's own `category`.
32
36
  */
33
37
  export type LoadedBlockTemplateDoc = Omit<BlockTemplateDoc, "displayName" | "aspectRatio" | "category"> & {
34
38
  displayName?: string;
@@ -78,7 +78,9 @@ const blockTemplateSchema = z
78
78
  * Templates as they load. Integration templates already published omit
79
79
  * `displayName` and `aspectRatio` and group themselves under their own
80
80
  * `category`, so the loader accepts those (template discovery falls back to an
81
- * aspect ratio of 1). The published types keep asking authors for all three.
81
+ * aspect ratio of 1). The published `TemplateDoc` keeps asking authors for all
82
+ * three; `IntegrationTemplateDoc`, for an integration package's templates,
83
+ * takes the package's own `category`.
82
84
  *
83
85
  * @typedef {Omit<PageTemplateDoc, 'displayName' | 'category'>
84
86
  * & {displayName?: string, category?: string}} LoadedPageTemplateDoc
@@ -31,14 +31,14 @@ export const doc = {
31
31
  name: 'name',
32
32
  type: 'string',
33
33
  description:
34
- 'Stable identifier for block templates; change `displayName`, not `name`, to edit their visible label. For page templates it is a human-readable label, while the existing template-directory/CLI slug owns the default registry path.',
34
+ "Stable identifier for block templates; change `displayName`, not `name`, to edit their visible label in the gallery. For page templates it is a human-readable label, while the existing template-directory/CLI slug owns the default registry path. `astryx template --list` and `astryx search` print `name` as the label of both, and `astryx template <id>` finds a template by its id, never by `name`: an integration template's id is its path under the templates folder without the `.doc.*` suffix.",
35
35
  required: true,
36
36
  },
37
37
  {
38
38
  name: 'displayName',
39
39
  type: 'string',
40
40
  description:
41
- "Human-readable label for the gallery/CLI. Spaces out block names that mirror a PascalCase component ('ChatMessageMetadata' → 'Chat Message Metadata').",
41
+ "Human-readable label for the gallery. The CLI prints `name` instead; `astryx template --list --json` also returns an integration template's `displayName`. Spaces out block names that mirror a PascalCase component ('ChatMessageMetadata' → 'Chat Message Metadata').",
42
42
  required: true,
43
43
  },
44
44
  {
@@ -162,7 +162,7 @@ export default {
162
162
  notes: [
163
163
  {
164
164
  type: 'prose',
165
- text: 'When it loads, a template may leave out `displayName` and `aspectRatio` and use its own `category`, as integration templates already published do; a block with no `aspectRatio` previews at 1. Write to the type anyway; it is the contract.',
165
+ text: 'When it loads, a template may leave out `displayName` and `aspectRatio` and use its own `category`, as integration templates already published do; a block with no `aspectRatio` previews at 1. Write to the type anyway; it is the contract, and `astryx doctor integration validate` warns about an integration template that leaves out `displayName` or `aspectRatio`.',
166
166
  },
167
167
  {
168
168
  type: 'prose',
@@ -201,3 +201,25 @@ export type TemplateCategory =
201
201
  | 'Shell - Blank';
202
202
 
203
203
  export type TemplateDoc = PageTemplateDoc | BlockTemplateDoc;
204
+
205
+ /** A page template an integration package ships, with its own `category`. */
206
+ export interface IntegrationPageTemplateDoc extends Omit<
207
+ PageTemplateDoc,
208
+ 'category'
209
+ > {
210
+ category?: string;
211
+ }
212
+
213
+ /** A block template an integration package ships, with its own `category`. */
214
+ export interface IntegrationBlockTemplateDoc extends Omit<
215
+ BlockTemplateDoc,
216
+ 'category'
217
+ > {
218
+ category?: string;
219
+ }
220
+
221
+ /** The doc-type for an integration package's template metadata: TemplateDoc,
222
+ * with `category` the package's own string (bare `astryx template` groups
223
+ * the package's templates by it) instead of a TemplateCategory value. */
224
+ export type IntegrationTemplateDoc =
225
+ IntegrationPageTemplateDoc | IntegrationBlockTemplateDoc;
@@ -12,7 +12,7 @@ export const doc = {
12
12
  displayName: 'ThemeDoc',
13
13
  namespace: 'authoring',
14
14
  description:
15
- 'The strongly typed descriptor for one integration or CLI-bundled source theme.',
15
+ "The strongly typed descriptor for one source theme: bundled with the CLI, shipped by an integration, or kept in the project's src/themes, where `theme eject` writes one.",
16
16
  appliesTo: '<theme-source-stem>.doc.mjs',
17
17
  fields: [
18
18
  {
@@ -65,7 +65,7 @@ export default {
65
65
  notes: [
66
66
  {
67
67
  type: 'prose',
68
- text: 'ThemeDoc is static metadata. Default-export one object with literal string and boolean fields; discovery validates it without executing the descriptor or theme source.',
68
+ text: "ThemeDoc is static metadata. The descriptor holds one default-exported object of literal string and boolean fields, directly under a `/** @type {import('@astryxdesign/cli/authoring').ThemeDoc} */` comment, and nothing else: without that comment, or with any other statement, it fails to load. Discovery validates it without executing the descriptor or theme source.",
69
69
  },
70
70
  {
71
71
  type: 'prose',
@@ -15,7 +15,7 @@ export const doc = {
15
15
  displayName: 'GapReportHandler',
16
16
  namespace: 'authoring',
17
17
  description:
18
- 'A handler for `astryx gap-report`: a plain object with an `audience` and a `handle` function. Set it as `gapReport` in astryx.config, or export it as `gapReport` from an integration manifest. Every handler runs: the project handler first, then each integration handler in config order.',
18
+ "A handler for `astryx gap-report`: a plain object with an `audience` and a `handle` function. Set it as `gapReport` in astryx.config, or export it as `gapReport` from an integration manifest. Handlers add up rather than replace each other: the project handler first, then each loaded integration's in load order (the `integrations` list, then autolinked ones), whichever package the report is about.",
19
19
  appliesTo:
20
20
  '`gapReport` in astryx.config.*, or the `gapReport` named export of astryx.integration.*',
21
21
  fields: [
@@ -104,7 +104,7 @@ export const doc = {
104
104
  name: 'report.target.version',
105
105
  type: 'string',
106
106
  description:
107
- 'The installed version. Null when it is not known.',
107
+ "The integration's version from its package.json. Null for Core, and when the package.json has none.",
108
108
  required: true,
109
109
  },
110
110
  {
@@ -12,7 +12,7 @@ export const doc = {
12
12
  displayName: 'Provider and artifact identity',
13
13
  namespace: 'authoring',
14
14
  description:
15
- 'Separates stable provider/artifact identity from package instances and runtime lifecycle state. Provider identity names integration manifests and settles provider conflicts. Docs-tree nodes are identified by doc identity; the tree covers the CLI\'s own docs. Artifact, instance, and compiler-input identities are defined for every provider-owned artifact; no command reads them.',
15
+ "Separates stable provider/artifact identity from package instances and runtime lifecycle state. Provider identity names integration manifests and settles provider conflicts. Docs-tree nodes are identified by doc identity; the tree covers the CLI's docs and each integration's. Artifact IDs for kinds outside the docs tree, provider instances, and compiler-input entries are defined for every provider-owned artifact; no command builds them.",
16
16
  appliesTo:
17
17
  'Integration manifests, provider conflicts, and docs-tree node ids.',
18
18
  fields: [
@@ -41,14 +41,14 @@ export const doc = {
41
41
  name: 'ProviderInstance',
42
42
  type: '{ id; providerId; packageName; packageVersion; sourceDigest }',
43
43
  description:
44
- 'One immutable package version and source/content digest. Installed, configured, loaded, selected, and healthy state is a separate runtime overlay.',
44
+ 'One immutable package version and source/content digest. It carries no installed, configured, loaded, selected, or healthy state.',
45
45
  required: true,
46
46
  },
47
47
  {
48
48
  name: 'AuthoredDocEntry',
49
49
  type: '{ id; provider; kind; stableName; source; authored }',
50
50
  description:
51
- 'Normalized compiler input. Discovery supplies stableName independently from the authored display name, source paths remain package-relative, and provider provenance plus the authored snapshot are immutable.',
51
+ 'Normalized compiler input. `stableName`, the key in its doc ID, is given separately from the authored display name; source paths remain package-relative, and provider provenance plus the authored snapshot are immutable.',
52
52
  required: true,
53
53
  },
54
54
  ],
@@ -28,6 +28,7 @@ export type {HookDoc} from './doctypes/types.js'; // useToast.doc.mjs
28
28
  export type {FunctionDoc} from './doctypes/types.js'; // search.doc.mjs (hook | api)
29
29
  export type {ReferenceDoc} from './doctypes/types.js'; // theming.doc.mjs
30
30
  export type {TemplateDoc} from './doctypes/types.js'; // Foo.doc.mjs
31
+ export type {IntegrationTemplateDoc} from './doctypes/types.js'; // an integration's Foo.doc.mjs
31
32
  export type {SchemaDoc} from './doctypes/types.js'; // config.doc.mjs (object shape)
32
33
  export type {CommandDoc} from './doctypes/types.js'; // search.doc.mjs (CLI command)
33
34
  export type {EnumDoc} from './doctypes/types.js'; // error-codes.doc.mjs (vocabulary)
@@ -51,7 +51,7 @@ export const doc = {
51
51
  name: 'docs',
52
52
  type: 'string',
53
53
  description:
54
- 'The folder that holds your doc topics, relative to package.json. Every {topic}.doc.{ts,mjs,js} in it shows up in `astryx docs` next to the built-in topics; a topic can also set `replaces` or `extends` to take over a built-in topic or add to it.',
54
+ 'The folder that holds your doc topics, relative to package.json. Every {topic}.doc.{ts,mjs,js} under it shows up in `astryx docs`: a flat topic next to the built-in topics, where it can set `replaces` or `extends` to take over a built-in topic or add to it, and a guide with `placement` at its own route in the docs tree, under a namespace doc of the same package.',
55
55
  example: "'./docs'",
56
56
  },
57
57
  {
@@ -71,9 +71,17 @@ export const doc = {
71
71
  {
72
72
  name: 'issuesUrl',
73
73
  type: 'string',
74
- description: 'Where to file issues/feedback for this integration.',
74
+ description:
75
+ "Where people file issues for this package: an absolute URL, such as its GitHub issues page. A value that is not a URL fails the whole manifest; the scheme is not checked. Nothing warns when it is missing, but without it `astryx gap-report` about this package fails unless the project or a loaded integration has a gapReport handler, and `astryx swizzle` prints no feedback link for this package's components. When no handler is loaded, a github.com issues URL is filed with the GitHub CLI once the reporter passes `--confirm-public`; any other URL is returned for the reporter to open.",
75
76
  example: "'https://github.com/acme/widgets/issues'",
76
77
  },
78
+ {
79
+ name: 'docsiteUrl',
80
+ type: 'string',
81
+ description:
82
+ "Link to this integration's docs site, such as its home page. Catalogs that list the package may show it.",
83
+ example: "'https://widgets.acme.dev'",
84
+ },
77
85
  ],
78
86
  examples: [
79
87
  {
@@ -111,14 +119,14 @@ export const doc = {
111
119
  },
112
120
  {
113
121
  type: 'prose',
114
- text: 'A themes root is forward-compatible but version-gated: a CLI released before this field ignores it with a warning and continues loading every contribution kind it understands. That older CLI cannot list or add the contributed themes.',
122
+ text: 'A themes root is version-gated: an older CLI lists and adds none of its themes. Depending on its age, that CLI ignores `themes` with an `unknown_manifest_key` warning and loads every other contribution kind, reports the root as invalid because it expects the earlier `manifest.json` theme catalog, or, if it is old enough to treat an unknown field as an error, rejects the whole manifest, so the package contributes nothing there.',
115
123
  },
116
124
  {
117
125
  type: 'prose',
118
126
  text:
119
127
  'Validate the manifest with `astryx doctor integration validate`. At the ' +
120
128
  'load boundary, a known field of the wrong type is an error, issuesUrl ' +
121
- 'must be a valid URL, and unknown fields become warnings so an older CLI ' +
129
+ 'and docsiteUrl must be valid URLs, and unknown fields become warnings so an older CLI ' +
122
130
  'can still load the fields it understands. Before publishing, also run ' +
123
131
  '`templates`, `components`, and `docs` under the same `doctor integration` ' +
124
132
  'group. Those leaves compare authored identities with Core and explain ' +
@@ -87,6 +87,16 @@ describe('parseIntegration (load boundary)', () => {
87
87
  expect(reason({issuesUrl: 'nope'})).toContain('issuesUrl');
88
88
  });
89
89
 
90
+ it('accepts a docsiteUrl as a known key', () => {
91
+ const manifest = {docsiteUrl: 'https://widgets.example.com'};
92
+ expect(parseIntegration(manifest)).toEqual(manifest);
93
+ expect(unknownIntegrationKeys(manifest)).toEqual([]);
94
+ });
95
+
96
+ it('rejects a non-URL docsiteUrl', () => {
97
+ expect(reason({docsiteUrl: 'nope'})).toContain('docsiteUrl');
98
+ });
99
+
90
100
  it('rejects a noncanonical providerId', () => {
91
101
  expect(reason({providerId: 'Acme Widgets'})).toContain('providerId');
92
102
  });
@@ -39,6 +39,7 @@ export const integrationBaseSchema: z.ZodObject<{
39
39
  docs: z.ZodOptional<z.ZodString>;
40
40
  themes: z.ZodOptional<z.ZodString>;
41
41
  issuesUrl: z.ZodOptional<z.ZodString>;
42
+ docsiteUrl: z.ZodOptional<z.ZodString>;
42
43
  }, z.core.$strip>;
43
44
  export const integrationSchema: z.ZodObject<{
44
45
  providerId: z.ZodOptional<z.ZodString>;
@@ -48,6 +49,7 @@ export const integrationSchema: z.ZodObject<{
48
49
  docs: z.ZodOptional<z.ZodString>;
49
50
  themes: z.ZodOptional<z.ZodString>;
50
51
  issuesUrl: z.ZodOptional<z.ZodString>;
52
+ docsiteUrl: z.ZodOptional<z.ZodString>;
51
53
  agentDocs: z.ZodOptional<z.ZodObject<{
52
54
  append: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodString>>>;
53
55
  }, z.core.$strip>>;
@@ -78,6 +78,7 @@ export const integrationBaseSchema = z.object({
78
78
  docs: z.string().optional(),
79
79
  themes: z.string().optional(),
80
80
  issuesUrl: z.string().url().optional(),
81
+ docsiteUrl: z.string().url().optional(),
81
82
  });
82
83
 
83
84
  // Unknown top-level keys are stripped rather than rejected. `.strict()` made a key from a
@@ -44,6 +44,10 @@ export interface AstryxIntegration {
44
44
  };
45
45
  /** Where to file issues/feedback for this integration. */
46
46
  issuesUrl?: string;
47
+ /** Link to this integration's docs site, such as its home page. The CLI
48
+ * accepts it as a known field; catalogs that list the package may show
49
+ * it. */
50
+ docsiteUrl?: string;
47
51
  }
48
52
 
49
53
  /**
@@ -168,7 +168,9 @@ describe('theme build report', () => {
168
168
  }
169
169
  expect(count(out, 'Install in your app')).toBe(1);
170
170
  expect(count(out, 'Or with a <link> tag:')).toBe(1);
171
- expect(count(out, "import { Theme } from '@astryxdesign/core';")).toBe(2);
171
+ expect(
172
+ count(out, "import { Theme } from '@astryxdesign/core/theme';"),
173
+ ).toBe(2);
172
174
  expect(count(out, '[note]')).toBe(1);
173
175
  expect(count(out, 'note: Font')).toBe(0);
174
176
  expect(count(out, 'fonts.googleapis.com/css2')).toBe(1);
@@ -397,7 +397,7 @@ function printThemeApp(result) {
397
397
  emit(
398
398
  text('Wire the generated module once in the app root:'),
399
399
  code(
400
- "import {Theme} from '@astryxdesign/core';\n" +
400
+ "import {Theme} from '@astryxdesign/core/theme';\n" +
401
401
  `import {themes, defaultThemeSlug} from './${stem}';\n\n` +
402
402
  '<Theme theme={themes[defaultThemeSlug]}>\n <App />\n</Theme>',
403
403
  ),