@astryxdesign/cli 0.6.3 → 0.6.4-canary.06c8fa3
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/CHANGELOG.md +194 -0
- package/README.md +121 -85
- package/api/blog/blog.doc.mjs +1 -0
- package/api/build/_adapter.d.mts +50 -0
- package/api/build/_adapter.mjs +60 -0
- package/api/build/build.doc.mjs +16 -9
- package/api/build/build.test.mjs +197 -8
- package/api/build/build.type.d.mts +91 -2
- package/api/build/build.type.mjs +52 -8
- package/api/build/help/help.d.mts +12 -5
- package/api/build/help/help.mjs +69 -6
- package/api/build/kit/kit.d.mts +4 -1
- package/api/build/kit/kit.mjs +165 -49
- package/api/build/kit/rank.d.mts +44 -0
- package/api/build/kit/rank.mjs +432 -0
- package/api/build/kit/rank.test.mjs +196 -0
- package/api/component/_adapter.d.mts +31 -12
- package/api/component/_adapter.mjs +79 -15
- package/api/component/component.d.mts +6 -3
- package/api/component/component.doc.mjs +36 -13
- package/api/component/component.mjs +339 -22
- package/api/component/component.test.mjs +38 -0
- package/api/component/component.type.d.mts +47 -11
- package/api/component/component.type.mjs +76 -24
- package/api/component/detail/blocks/blocks.d.mts +2 -1
- package/api/component/detail/blocks/blocks.mjs +4 -3
- package/api/component/list/list.d.mts +0 -5
- package/api/component/list/list.mjs +40 -11
- package/api/discover/_adapter.d.mts +114 -6
- package/api/discover/_adapter.mjs +372 -17
- package/api/discover/_adapter.test.mjs +215 -0
- package/api/discover/_catalog-view.d.mts +115 -0
- package/api/discover/_catalog-view.mjs +203 -0
- package/api/discover/_catalog-view.test.mjs +128 -0
- package/api/discover/detail/detail.d.mts +18 -6
- package/api/discover/detail/detail.mjs +67 -13
- package/api/discover/detail/detail.test.mjs +85 -0
- package/api/discover/detail/item/item.d.mts +26 -0
- package/api/discover/detail/item/item.mjs +78 -0
- package/api/discover/detail/item/item.test.mjs +73 -0
- package/api/discover/discover.d.mts +3 -9
- package/api/discover/discover.doc.mjs +62 -18
- package/api/discover/discover.mjs +220 -36
- package/api/discover/discover.test.mjs +11 -2
- package/api/discover/discover.type.d.mts +150 -11
- package/api/discover/discover.type.mjs +107 -17
- package/api/discover/list/list.d.mts +20 -6
- package/api/discover/list/list.mjs +45 -12
- package/api/discover/list/list.test.mjs +46 -0
- package/api/discover/search/search.d.mts +18 -16
- package/api/discover/search/search.mjs +102 -56
- package/api/discover/search/search.test.mjs +144 -10
- package/api/docs/_adapter.d.mts +272 -41
- package/api/docs/_adapter.mjs +985 -108
- package/api/docs/compiled-topics.test.mjs +78 -0
- package/api/docs/detail/detail.mjs +22 -63
- package/api/docs/detail/section/section.d.mts +1 -1
- package/api/docs/detail/section/section.mjs +54 -19
- package/api/docs/detail/section/section.test.mjs +50 -0
- package/api/docs/docs.d.mts +10 -3
- package/api/docs/docs.doc.mjs +55 -16
- package/api/docs/docs.mjs +53 -10
- package/api/docs/docs.test.mjs +166 -4
- package/api/docs/docs.type.d.mts +221 -5
- package/api/docs/docs.type.mjs +153 -11
- package/api/docs/index/index.d.mts +18 -0
- package/api/docs/index/index.mjs +40 -0
- package/api/docs/index/index.test.mjs +62 -0
- package/api/docs/integration-tree.test.mjs +555 -0
- package/api/docs/integrationDocs.test.mjs +114 -8
- package/api/docs/list/list.mjs +28 -12
- package/api/docs/node/node.d.mts +43 -0
- package/api/docs/node/node.mjs +192 -0
- package/api/docs/reference-blocks.test.mjs +406 -0
- package/api/doctor/doctor.d.mts +104 -1
- package/api/doctor/doctor.doc.mjs +1 -0
- package/api/doctor/doctor.mjs +635 -7
- package/api/doctor/doctor.test.mjs +732 -11
- package/api/gap-report/gap-report.doc.mjs +8 -4
- package/api/hook/_adapter.mjs +19 -5
- package/api/hook/hook.doc.mjs +1 -0
- package/api/hook/hook.type.d.mts +3 -3
- package/api/hook/hook.type.mjs +11 -11
- package/api/hook/list/list.d.mts +2 -2
- package/api/hook/list/list.mjs +69 -17
- package/api/index.d.mts +2 -3
- package/api/index.mjs +5 -4
- package/api/init/init.doc.mjs +6 -1
- package/api/init/init.test.mjs +41 -1
- package/api/init/remove/remove.mjs +1 -1
- package/api/init/run/run.mjs +20 -10
- package/api/integration/add-contribution.component-names.test.mjs +120 -0
- package/api/integration/add-contribution.d.mts +2 -1
- package/api/integration/add-contribution.mjs +130 -15
- package/api/integration/add-contribution.test.mjs +258 -7
- package/api/integration/add-helpers.d.mts +5 -2
- package/api/integration/add-helpers.mjs +36 -9
- package/api/integration/add-theme.mjs +34 -64
- package/api/integration/add-theme.test.mjs +105 -21
- package/api/integration/authoring-checks.mjs +138 -28
- package/api/integration/authoring-checks.test.mjs +179 -7
- package/api/integration/authoring-checks.type.mjs +6 -1
- package/api/integration/integration-authoring.type.d.mts +3 -1
- package/api/integration/integration-authoring.type.mjs +2 -0
- package/api/integration/integration-block-exports.test.mjs +10 -6
- package/api/integration/integrationAdd.doc.mjs +14 -4
- package/api/integration/integrationAddAgentDoc.doc.mjs +1 -0
- package/api/integration/integrationAddCodemod.doc.mjs +1 -0
- package/api/integration/integrationAddComponent.doc.mjs +2 -1
- package/api/integration/integrationAddDoc.doc.mjs +8 -1
- package/api/integration/integrationAddTemplate.doc.mjs +1 -0
- package/api/integration/integrationAddTheme.doc.mjs +6 -5
- package/api/integration/integrationComponentConflicts.doc.mjs +1 -0
- package/api/integration/integrationDocConflicts.doc.mjs +2 -1
- package/api/integration/integrationPackCheck.doc.mjs +2 -1
- package/api/integration/integrationTemplateConflicts.doc.d.mts +3 -0
- package/api/integration/integrationTemplateConflicts.doc.mjs +4 -0
- package/api/integration/pack-check.lifecycle-output.test.mjs +105 -0
- package/api/integration/pack-check.mjs +111 -10
- package/api/integration/pack-check.test.mjs +387 -47
- package/api/integration/pack-check.type.d.mts +26 -2
- package/api/integration/pack-check.type.mjs +14 -1
- package/api/integration/summarizeIssues.doc.mjs +1 -0
- package/api/integration/template-conflict-compatibility.test.mjs +73 -0
- package/api/integration/validate-integration-fixes.test.mjs +1389 -0
- package/api/integration/validate-integration.mjs +52 -102
- package/api/integration/validate-integration.test.mjs +179 -26
- package/api/integration/validate-unread-theme-folders.test.mjs +110 -0
- package/api/integration/validateIntegration.doc.mjs +3 -2
- package/api/json/assertResponse.doc.mjs +1 -0
- package/api/json/envelope-types.test.mjs +76 -0
- package/api/json/index.ts +2 -1
- package/api/json/isError.doc.mjs +1 -0
- package/api/json/parseResponse.doc.mjs +3 -2
- package/api/search/search-return-type.test.mjs +54 -0
- package/api/search/search.d.mts +62 -11
- package/api/search/search.doc.mjs +8 -2
- package/api/search/search.mjs +471 -83
- package/api/search/search.test.mjs +142 -1
- package/api/search/search.type.d.mts +15 -3
- package/api/search/search.type.mjs +5 -2
- package/api/swizzle/copy/copy.mjs +28 -11
- package/api/swizzle/swizzle.doc.mjs +2 -1
- package/api/swizzle/swizzle.type.d.mts +2 -2
- package/api/swizzle/swizzle.type.mjs +2 -2
- package/api/template/copy/copy.mjs +17 -23
- package/api/template/copy/copy.test.mjs +17 -0
- package/api/template/list/list.mjs +1 -0
- package/api/template/table-floating-bulk-actions.test.mjs +66 -0
- package/api/template/template-integration.test.mjs +1008 -3
- package/api/template/template-suffix.test.mjs +41 -21
- package/api/template/template.d.mts +1 -1
- package/api/template/template.doc.mjs +30 -8
- package/api/template/template.mjs +46 -9
- package/api/template/template.type.d.mts +12 -14
- package/api/template/template.type.mjs +15 -14
- package/api/theme/_adapter.d.mts +2 -3
- package/api/theme/_adapter.mjs +4 -5
- package/api/theme/add/add.binary.test.mjs +84 -0
- package/api/theme/add/add.mjs +31 -22
- package/api/theme/add/add.rollback.test.mjs +158 -0
- package/api/theme/add/add.staging.test.mjs +83 -0
- package/api/theme/add/add.test.mjs +14 -1
- package/api/theme/build/build.family.test.mjs +7 -12
- package/api/theme/build/build.mjs +140 -59
- package/api/theme/build/build.public-component-vars.test.mjs +1 -1
- package/api/theme/build/build.receipt-doc.test.mjs +111 -0
- package/api/theme/build/build.rollback.test.mjs +148 -0
- package/api/theme/build/build.test.mjs +127 -0
- package/api/theme/build/font-warning.mjs +3 -3
- package/api/theme/build/font-warning.test.mjs +5 -2
- package/api/theme/generateTonalPalette.doc.mjs +1 -0
- package/api/theme/integration-themes.test.mjs +39 -28
- package/api/theme/list/list.test.mjs +19 -20
- package/api/theme/listThemes.doc.mjs +6 -5
- package/api/theme/palette/generate/generate.mjs +8 -3
- package/api/theme/palette/generate/generate.test.mjs +96 -0
- package/api/theme/palette/generate/generator.d.mts +10 -13
- package/api/theme/palette/generate/generator.mjs +15 -4
- package/api/theme/palette/generate/generator.test.mjs +10 -0
- package/api/theme/template/template.mjs +11 -2
- package/api/theme/template/template.test.mjs +20 -0
- package/api/theme/theme.type.d.mts +170 -11
- package/api/theme/theme.type.mjs +94 -27
- package/api/theme/themeAdd.doc.mjs +4 -3
- package/api/theme/themeBuild.doc.mjs +8 -4
- package/api/theme/themeList.doc.mjs +6 -3
- package/api/theme/themeListAvailable.doc.mjs +5 -3
- package/api/theme/themePaletteGenerate.doc.mjs +1 -0
- package/api/theme/themeTargets.doc.mjs +1 -0
- package/api/theme/themeTemplate.doc.mjs +6 -2
- package/api/upgrade/_adapter.d.mts +32 -5
- package/api/upgrade/_adapter.mjs +139 -22
- package/api/upgrade/list/list.mjs +2 -1
- package/api/upgrade/list/list.test.mjs +73 -0
- package/api/upgrade/project-context.test.mjs +272 -0
- package/api/upgrade/provider-agreement.test.mjs +152 -0
- package/api/upgrade/run/files-changed.test.mjs +111 -0
- package/api/upgrade/run/run.mjs +359 -60
- package/api/upgrade/status/status.mjs +2 -2
- package/api/upgrade/upgrade.doc.mjs +12 -5
- package/api/upgrade/upgrade.type.d.mts +43 -5
- package/api/upgrade/upgrade.type.mjs +29 -13
- package/assets/codemods/__tests__/registry.test.mjs +1 -0
- package/assets/codemods/__tests__/runner.test.mjs +332 -8
- package/assets/codemods/file-count.test.mjs +163 -0
- package/assets/codemods/integration-discovery.mjs +48 -4
- package/assets/codemods/integration-discovery.test.mjs +73 -0
- package/assets/codemods/integration-runner.mjs +59 -7
- package/assets/codemods/integration-runner.protection.test.mjs +153 -0
- package/assets/codemods/registry.mjs +1 -0
- package/assets/codemods/run-codemod.mjs +177 -34
- package/assets/codemods/runner.mjs +353 -104
- package/assets/codemods/term-log.mjs +32 -8
- package/assets/codemods/term-log.test.mjs +19 -1
- package/assets/codemods/transform-prop.mjs +109 -0
- package/assets/codemods/transform-prop.test.mjs +95 -0
- package/assets/codemods/transforms/v0.0.14/__tests__/rename-status-variants.test.mjs +86 -165
- package/assets/codemods/transforms/v0.0.14/rename-status-variants.mjs +72 -210
- package/assets/codemods/transforms/v0.1.8/__tests__/rename-avatar-size-scale.test.mjs +83 -115
- package/assets/codemods/transforms/v0.1.8/rename-avatar-size-scale.mjs +57 -186
- package/assets/codemods/transforms/v0.3.0/__tests__/unwrap-authoring-factories.test.mjs +27 -5
- package/assets/codemods/transforms/v0.3.0/unwrap-authoring-factories.mjs +20 -5
- package/assets/codemods/transforms/v0.6.0/__tests__/next-codemods.test.mjs +47 -0
- package/assets/codemods/transforms/v0.6.0/rename-resizable-pixel-bounds.mjs +57 -10
- package/assets/codemods/transforms/v0.6.4/__tests__/migrate-native-picker-to-presentation.test.mjs +63 -0
- package/assets/codemods/transforms/v0.6.4/__tests__/migrate-theme-catalog-to-descriptors.test.mjs +220 -0
- package/assets/codemods/transforms/v0.6.4/index.mjs +31 -0
- package/assets/codemods/transforms/v0.6.4/migrate-native-picker-to-presentation.mjs +148 -0
- package/assets/codemods/transforms/v0.6.4/migrate-theme-catalog-to-descriptors.mjs +141 -0
- package/assets/docs/README.md +9 -0
- package/assets/docs/authoring.doc.mjs +14 -0
- package/assets/docs/getting-started.doc.mjs +2 -2
- package/assets/docs/internationalization.doc.mjs +7 -5
- package/assets/docs/layout.doc.dense.mjs +2 -2
- package/assets/docs/layout.doc.mjs +1 -1
- package/assets/docs/principles.doc.mjs +6 -6
- package/assets/docs/styling-libraries.doc.mjs +4 -4
- package/assets/docs/styling.doc.mjs +4 -4
- package/assets/docs/theme.doc.mjs +5 -5
- package/assets/docs/tokens.doc.mjs +1 -1
- package/assets/docs/tree/api.doc.mjs +30 -0
- package/assets/docs/tree/cli.doc.mjs +23 -0
- package/assets/docs/tree/commands.doc.mjs +25 -0
- package/assets/docs/tree/component-lookups.doc.mjs +149 -0
- package/assets/docs/{cli-integrations.doc.mjs → tree/integrations.doc.mjs} +144 -26
- package/assets/docs/tree/integrations.test.mjs +62 -0
- package/assets/docs/tree/writing-docs.doc.mjs +286 -0
- package/assets/docs/working-with-ai.doc.mjs +4 -4
- package/assets/templates/blocks/components/CheckboxList/CheckboxListSelectAllPattern.doc.mjs +1 -1
- package/assets/templates/blocks/components/CheckboxList/CheckboxListSelectAllPattern.tsx +1 -3
- package/assets/templates/blocks/components/DateInput/DateInputDateRange.tsx +1 -1
- package/assets/templates/blocks/components/InternationalizationProvider/InternationalizationProvider01ShippedLocale.tsx +1 -1
- package/assets/templates/blocks/components/Item/ItemDocumentTabs.doc.mjs +14 -0
- package/assets/templates/blocks/components/Item/ItemDocumentTabs.tsx +100 -0
- package/assets/templates/blocks/components/ScrollableArea/ScrollableAreaInlineRail.doc.mjs +14 -0
- package/assets/templates/blocks/components/ScrollableArea/ScrollableAreaInlineRail.tsx +61 -0
- package/assets/templates/blocks/components/ScrollableArea/ScrollableAreaOverscrollChaining.doc.mjs +14 -0
- package/assets/templates/blocks/components/ScrollableArea/ScrollableAreaOverscrollChaining.tsx +126 -0
- package/assets/templates/blocks/components/ScrollableArea/ScrollableAreaShowcase.doc.mjs +15 -0
- package/assets/templates/blocks/components/ScrollableArea/ScrollableAreaShowcase.tsx +86 -0
- package/assets/templates/blocks/components/ScrollableArea/ScrollableAreaStickyGroupHeaders.doc.mjs +14 -0
- package/assets/templates/blocks/components/ScrollableArea/ScrollableAreaStickyGroupHeaders.tsx +99 -0
- package/assets/templates/blocks/components/ScrollableArea/ScrollableAreaStickyPassthrough.doc.mjs +14 -0
- package/assets/templates/blocks/components/ScrollableArea/ScrollableAreaStickyPassthrough.tsx +122 -0
- package/assets/templates/blocks/components/ScrollableArea/ScrollableAreaTwoAxisBoard.doc.mjs +14 -0
- package/assets/templates/blocks/components/ScrollableArea/ScrollableAreaTwoAxisBoard.tsx +95 -0
- package/assets/templates/blocks/components/Table/TableBulkActionsTable.doc.mjs +14 -0
- package/assets/templates/blocks/components/Table/TableBulkActionsTable.tsx +71 -0
- package/assets/templates/blocks/components/Table/TableFloatingBulkActionsTable.doc.mjs +19 -0
- package/assets/templates/blocks/components/Table/TableFloatingBulkActionsTable.tsx +139 -0
- package/assets/templates/blocks/components/TimeInput/TimeInputConstrained.tsx +1 -0
- package/assets/templates/blocks/components/Timer/TimerFormats.doc.mjs +14 -0
- package/assets/templates/blocks/components/Timer/TimerFormats.tsx +34 -0
- package/assets/templates/blocks/components/Timer/TimerInline.doc.mjs +14 -0
- package/assets/templates/blocks/components/Timer/TimerInline.tsx +14 -0
- package/assets/templates/blocks/components/Timer/TimerShowcase.doc.mjs +13 -0
- package/assets/templates/blocks/components/Timer/TimerShowcase.tsx +47 -0
- package/assets/templates/blocks/components/Timer/TimerTypography.doc.mjs +14 -0
- package/assets/templates/blocks/components/Timer/TimerTypography.tsx +31 -0
- package/assets/templates/blocks/components/Toolbar/ToolbarTableFilter.doc.mjs +19 -3
- package/assets/templates/blocks/components/Toolbar/ToolbarTableFilter.tsx +383 -65
- package/assets/templates/pages/table-tree/page.tsx +1704 -0
- package/assets/templates/pages/table-tree/template.doc.mjs +12 -0
- package/assets/templates/themes/butter/butterTheme.doc.mjs +11 -0
- package/assets/templates/themes/chocolate/chocolateTheme.doc.mjs +11 -0
- package/assets/templates/themes/gothic/gothicTheme.doc.mjs +11 -0
- package/assets/templates/themes/matcha/matchaTheme.doc.mjs +11 -0
- package/assets/templates/themes/neutral/neutralTheme.doc.mjs +11 -0
- package/assets/templates/themes/stone/stoneTheme.doc.mjs +11 -0
- package/assets/templates/themes/y2k/y2kTheme.doc.mjs +11 -0
- package/authoring/_shared/contract.ts +22 -0
- package/authoring/codemod/codemod.doc.mjs +7 -2
- package/authoring/codemod/parse.d.mts +8 -8
- package/authoring/codemod/parse.mjs +8 -6
- package/authoring/codemod/type.ts +12 -0
- package/authoring/config/config.doc.mjs +11 -3
- package/authoring/config/debug-composition.test.mjs +92 -0
- package/authoring/config/parse.d.mts +15 -13
- package/authoring/config/parse.mjs +27 -8
- package/authoring/config/parse.test.mjs +8 -0
- package/authoring/config/type.ts +31 -8
- package/authoring/debug/debug.doc.d.mts +11 -0
- package/authoring/debug/debug.doc.mjs +182 -0
- package/authoring/debug/parse.d.mts +8 -8
- package/authoring/debug/parse.mjs +3 -3
- package/authoring/discover/discover.doc.d.mts +13 -0
- package/authoring/discover/discover.doc.mjs +138 -0
- package/authoring/discover/parse.d.mts +24 -0
- package/authoring/discover/parse.mjs +128 -0
- package/authoring/discover/parse.test.mjs +124 -0
- package/authoring/discover/type.ts +87 -0
- package/authoring/doctypes/_schema.d.mts +790 -23
- package/authoring/doctypes/_schema.mjs +543 -39
- package/authoring/doctypes/base/graph-fields.doc.d.mts +9 -0
- package/authoring/doctypes/base/graph-fields.doc.mjs +64 -0
- package/authoring/doctypes/base/type.ts +41 -0
- package/authoring/doctypes/command/command.doc.mjs +5 -4
- package/authoring/doctypes/command/parse.d.mts +2 -2
- package/authoring/doctypes/command/parse.mjs +1 -1
- package/authoring/doctypes/command/type.ts +6 -5
- package/authoring/doctypes/component/component.doc.mjs +6 -3
- package/authoring/doctypes/component/parse.d.mts +2 -2
- package/authoring/doctypes/component/parse.mjs +1 -1
- package/authoring/doctypes/component/type.ts +6 -5
- package/authoring/doctypes/doctypes-new.test.mjs +48 -6
- package/authoring/doctypes/enum/enum.doc.mjs +1 -1
- package/authoring/doctypes/enum/parse.d.mts +2 -2
- package/authoring/doctypes/enum/parse.mjs +1 -1
- package/authoring/doctypes/enum/type.ts +4 -2
- package/authoring/doctypes/function/function.doc.mjs +7 -2
- package/authoring/doctypes/function/parse.d.mts +2 -2
- package/authoring/doctypes/function/parse.mjs +1 -1
- package/authoring/doctypes/function/type.ts +9 -4
- package/authoring/doctypes/hook/hook.doc.mjs +4 -0
- package/authoring/doctypes/hook/parse.d.mts +2 -2
- package/authoring/doctypes/hook/parse.mjs +1 -1
- package/authoring/doctypes/hook/type.ts +5 -4
- package/authoring/doctypes/legacy.d.mts +8 -6
- package/authoring/doctypes/legacy.mjs +5 -4
- package/authoring/doctypes/load-contract.test.mjs +233 -0
- package/authoring/doctypes/namespace/namespace.doc.d.mts +9 -0
- package/authoring/doctypes/namespace/namespace.doc.mjs +128 -0
- package/authoring/doctypes/namespace/parse.d.mts +12 -0
- package/authoring/doctypes/namespace/parse.mjs +25 -0
- package/authoring/doctypes/namespace/parse.test.mjs +163 -0
- package/authoring/doctypes/namespace/type.ts +74 -0
- package/authoring/doctypes/parse.d.mts +22 -18
- package/authoring/doctypes/parse.mjs +22 -11
- package/authoring/doctypes/parse.test.mjs +77 -3
- package/authoring/doctypes/reference/parse.d.mts +2 -2
- package/authoring/doctypes/reference/parse.mjs +8 -5
- package/authoring/doctypes/reference/reference.doc.mjs +48 -6
- package/authoring/doctypes/reference/type.ts +70 -7
- package/authoring/doctypes/schema/parse.d.mts +2 -2
- package/authoring/doctypes/schema/parse.mjs +1 -1
- package/authoring/doctypes/schema/schema.doc.mjs +1 -1
- package/authoring/doctypes/schema/type.ts +4 -4
- package/authoring/doctypes/template/parse.d.mts +94 -1
- package/authoring/doctypes/template/parse.mjs +40 -2
- package/authoring/doctypes/template/parse.test.mjs +26 -2
- package/authoring/doctypes/template/template.doc.mjs +13 -3
- package/authoring/doctypes/template/type.ts +13 -2
- package/authoring/doctypes/theme/parse.d.mts +35 -0
- package/authoring/doctypes/theme/parse.mjs +76 -0
- package/authoring/doctypes/theme/theme.doc.d.mts +9 -0
- package/authoring/doctypes/theme/theme.doc.mjs +79 -0
- package/authoring/doctypes/theme/type.ts +42 -0
- package/authoring/doctypes/types.ts +12 -10
- package/authoring/gap-report/gap-report.doc.d.mts +12 -0
- package/authoring/gap-report/gap-report.doc.mjs +183 -0
- package/authoring/gap-report/parse.d.mts +10 -10
- package/authoring/gap-report/parse.mjs +6 -6
- package/authoring/gap-report/type.ts +1 -1
- package/authoring/identity/identity.doc.d.mts +9 -0
- package/authoring/identity/identity.doc.mjs +61 -0
- package/authoring/identity/type.ts +132 -0
- package/authoring/index.d.mts +3 -0
- package/authoring/index.d.ts +62 -17
- package/authoring/index.mjs +4 -1
- package/authoring/integration/integration.doc.mjs +15 -8
- package/authoring/integration/parse.d.mts +2 -2
- package/authoring/integration/parse.mjs +1 -1
- package/authoring/integration/parse.test.mjs +10 -1
- package/authoring/integration/schema.d.mts +6 -4
- package/authoring/integration/schema.mjs +9 -3
- package/authoring/integration/type.ts +19 -8
- package/authoring/shadcn/receipt.d.mts +6 -6
- package/clients/cli/__tests__/cliManifest.test.ts +27 -29
- package/clients/cli/command-load-failure.test.mjs +83 -0
- package/clients/cli/command-result-coverage.test.mjs +7 -7
- package/clients/cli/commands/blog.doc.mjs +1 -1
- package/clients/cli/commands/blog.mjs +23 -8
- package/clients/cli/commands/blog.test.mjs +42 -1
- package/clients/cli/commands/build-theme.adaptations.test.mjs +100 -1
- package/clients/cli/commands/build-theme.ascii-output.test.mjs +161 -0
- package/clients/cli/commands/build-theme.flag-docs.test.mjs +110 -0
- package/clients/cli/commands/build-theme.mjs +16 -50
- package/clients/cli/commands/build-theme.path-safety.test.mjs +86 -1
- package/clients/cli/commands/build-theme.variants.test.mjs +76 -0
- package/clients/cli/commands/build.doc.mjs +16 -8
- package/clients/cli/commands/build.exit-codes-doc.test.mjs +50 -0
- package/clients/cli/commands/build.mjs +137 -114
- package/clients/cli/commands/build.playbook.test.mjs +75 -0
- package/clients/cli/commands/build.text-fields.test.mjs +81 -0
- package/clients/cli/commands/component/index.mjs +153 -61
- package/clients/cli/commands/component-batch.test.mjs +341 -0
- package/clients/cli/commands/component-ownership.test.mjs +92 -3
- package/clients/cli/commands/component-package.test.mjs +46 -0
- package/clients/cli/commands/component-resolution.test.mjs +21 -0
- package/clients/cli/commands/component.doc.mjs +24 -7
- package/clients/cli/commands/component.test.mjs +19 -0
- package/clients/cli/commands/debug-result-summary.test.mjs +2 -2
- package/clients/cli/commands/detail-levels.test.mjs +2 -2
- package/clients/cli/commands/discover.broken-integration.test.mjs +52 -5
- package/clients/cli/commands/discover.components-flag.test.mjs +97 -0
- package/clients/cli/commands/discover.doc.mjs +55 -9
- package/clients/cli/commands/discover.mjs +393 -118
- package/clients/cli/commands/discover.sources.test.mjs +267 -0
- package/clients/cli/commands/discover.text-projection.test.mjs +103 -0
- package/clients/cli/commands/docs.doc.mjs +28 -6
- package/clients/cli/commands/docs.mjs +240 -26
- package/clients/cli/commands/docs.test.mjs +222 -1
- package/clients/cli/commands/doctor-integration-components.doc.mjs +1 -1
- package/clients/cli/commands/doctor-integration-docs.doc.mjs +3 -3
- package/clients/cli/commands/doctor-integration-templates.doc.mjs +15 -8
- package/clients/cli/commands/doctor-integration-validate.doc.mjs +1 -1
- package/clients/cli/commands/doctor-integration.doc.mjs +1 -1
- package/clients/cli/commands/doctor-integration.package-json.test.mjs +53 -0
- package/clients/cli/commands/doctor-integration.test.mjs +90 -8
- package/clients/cli/commands/doctor.doc.mjs +1 -1
- package/clients/cli/commands/doctor.mjs +59 -32
- package/clients/cli/commands/doctor.test.mjs +42 -0
- package/clients/cli/commands/gap-report.doc.mjs +17 -6
- package/clients/cli/commands/gap-report.test.mjs +72 -0
- package/clients/cli/commands/hook/index.mjs +7 -17
- package/clients/cli/commands/hook.doc.mjs +1 -1
- package/clients/cli/commands/hook.text-projection.test.mjs +45 -0
- package/clients/cli/commands/init.doc.mjs +20 -9
- package/clients/cli/commands/init.flag-help.test.mjs +153 -0
- package/clients/cli/commands/integration-add.controls.test.mjs +132 -0
- package/clients/cli/commands/integration-add.doc.mjs +32 -6
- package/clients/cli/commands/integration-authoring.test.mjs +13 -9
- package/clients/cli/commands/integration-pack.doc.mjs +1 -1
- package/clients/cli/commands/integration-real-world.test.mjs +3 -9
- package/clients/cli/commands/integration.doc.mjs +1 -1
- package/clients/cli/commands/integration.mjs +1 -0
- package/clients/cli/commands/interactive-guard.test.mjs +101 -24
- package/clients/cli/commands/json-contract.test.mjs +33 -0
- package/clients/cli/commands/manifest.doc.mjs +1 -1
- package/clients/cli/commands/no-prompt-wording.test.mjs +94 -0
- package/clients/cli/commands/search.doc.mjs +7 -4
- package/clients/cli/commands/search.mjs +28 -9
- package/clients/cli/commands/search.test.mjs +75 -0
- package/clients/cli/commands/setup-nudge.test.mjs +6 -0
- package/clients/cli/commands/swizzle.doc.mjs +3 -2
- package/clients/cli/commands/swizzle.path-safety.test.mjs +42 -0
- package/clients/cli/commands/template.doc.mjs +52 -13
- package/clients/cli/commands/template.flag-help.test.mjs +117 -0
- package/clients/cli/commands/template.mjs +4 -91
- package/clients/cli/commands/template.path-help.test.mjs +40 -0
- package/clients/cli/commands/text-json-parity.test.mjs +702 -0
- package/clients/cli/commands/theme-add.doc.mjs +4 -3
- package/clients/cli/commands/theme-build.doc.mjs +8 -7
- package/clients/cli/commands/theme-list.doc.mjs +2 -2
- package/clients/cli/commands/theme-palette-generate.doc.mjs +9 -5
- package/clients/cli/commands/theme-palette-generate.test.mjs +19 -0
- package/clients/cli/commands/theme-palette.doc.mjs +1 -1
- package/clients/cli/commands/theme-targets.behavior.test.mjs +4 -3
- package/clients/cli/commands/theme-targets.doc.mjs +1 -1
- package/clients/cli/commands/theme-template.behavior.test.mjs +12 -0
- package/clients/cli/commands/theme-template.doc.mjs +2 -2
- package/clients/cli/commands/theme.doc.mjs +1 -1
- package/clients/cli/commands/upgrade.ascii-output.test.mjs +87 -0
- package/clients/cli/commands/upgrade.doc.mjs +22 -10
- package/clients/cli/commands/upgrade.file-protection.test.mjs +228 -0
- package/clients/cli/commands/upgrade.flag-help.test.mjs +188 -0
- package/clients/cli/commands/upgrade.hook-output.test.mjs +88 -0
- package/clients/cli/commands/upgrade.mjs +29 -7
- package/clients/cli/formatters/index.mjs +164 -1
- package/clients/cli/formatters/index.test.mjs +97 -0
- package/clients/cli/index.mjs +21 -34
- package/clients/cli/latest-version-env.test.mjs +50 -0
- package/clients/cli/lib/cli-error.test.mjs +7 -0
- package/clients/cli/lib/component-format.mjs +9 -9
- package/clients/cli/lib/component-format.test.mjs +1 -1
- package/clients/cli/lib/define-command.mjs +32 -6
- package/clients/cli/lib/doc-text-ascii.test.mjs +82 -0
- package/clients/cli/lib/exit-codes.test.mjs +90 -0
- package/clients/cli/lib/hook-format.mjs +19 -10
- package/clients/cli/lib/json-shim.mjs +62 -16
- package/clients/cli/lib/json-shim.test.mjs +69 -0
- package/clients/cli/lib/manifest.d.ts +2 -0
- package/clients/cli/lib/manifest.mjs +39 -10
- package/clients/cli/lib/manifest.test.mjs +22 -2
- package/clients/cli/lib/parse-error-format.test.mjs +81 -0
- package/foundation/agent-docs/agent-docs.d.mts +7 -2
- package/foundation/agent-docs/agent-docs.mjs +82 -12
- package/foundation/agent-docs/agent-docs.path-safety.test.mjs +266 -4
- package/foundation/agent-docs/agent-docs.test.mjs +19 -1
- package/foundation/config/integration-debug.test.mjs +28 -3
- package/foundation/config/project-themes.test.mjs +11 -19
- package/foundation/config/project.d.mts +20 -11
- package/foundation/config/project.mjs +263 -91
- package/foundation/config/project.test.mjs +270 -21
- package/foundation/discovery/authoring-self-docs.d.mts +87 -0
- package/foundation/discovery/authoring-self-docs.mjs +237 -0
- package/foundation/discovery/authoring-self-docs.test.mjs +170 -0
- package/foundation/discovery/authoring-surface.d.mts +74 -0
- package/foundation/discovery/authoring-surface.mjs +525 -0
- package/foundation/discovery/authoring-surface.test.mjs +392 -0
- package/foundation/discovery/cli-self-docs.d.mts +119 -0
- package/foundation/discovery/cli-self-docs.mjs +490 -0
- package/foundation/discovery/cli-self-docs.test.mjs +375 -0
- package/foundation/discovery/component-discovery.d.mts +39 -1
- package/foundation/discovery/component-discovery.mjs +50 -1
- package/foundation/discovery/component-loader.d.mts +35 -38
- package/foundation/discovery/component-loader.mjs +53 -222
- package/foundation/discovery/docs-discovery.d.mts +119 -11
- package/foundation/discovery/docs-discovery.mjs +423 -108
- package/foundation/discovery/docs-discovery.test.mjs +365 -20
- package/foundation/discovery/docs-output-budget.d.mts +28 -0
- package/foundation/discovery/docs-output-budget.mjs +50 -0
- package/foundation/discovery/docs-section-key.d.mts +116 -0
- package/foundation/discovery/docs-section-key.mjs +322 -0
- package/foundation/discovery/docs-section-key.test.mjs +246 -0
- package/foundation/discovery/template-adapter.d.mts +113 -11
- package/foundation/discovery/template-adapter.fixture-refs.test.mjs +248 -0
- package/foundation/discovery/template-adapter.integration-isolation.test.mjs +94 -0
- package/foundation/discovery/template-adapter.mjs +775 -84
- package/foundation/discovery/template-adapter.test.mjs +57 -0
- package/foundation/discovery/template-conflict-release.d.mts +13 -0
- package/foundation/discovery/template-conflict-release.mjs +40 -0
- package/foundation/discovery/template-conflict-release.test.mjs +40 -0
- package/foundation/discovery/theme-discovery.d.mts +67 -7
- package/foundation/discovery/theme-discovery.mjs +916 -186
- package/foundation/discovery/theme-discovery.test.mjs +613 -219
- package/foundation/discovery/theming-targets.test.mjs +4 -0
- package/foundation/doc-compiler/bundle.d.mts +47 -0
- package/foundation/doc-compiler/bundle.mjs +278 -0
- package/foundation/doc-compiler/bundle.test.mjs +266 -0
- package/foundation/doc-compiler/compile.d.mts +343 -0
- package/foundation/doc-compiler/compile.mjs +558 -0
- package/foundation/doc-compiler/diagnostics.d.mts +126 -0
- package/foundation/doc-compiler/diagnostics.mjs +305 -0
- package/foundation/doc-compiler/doc-compiler.test.mjs +714 -0
- package/foundation/doc-compiler/doc-loads.test.mjs +1630 -0
- package/foundation/doc-compiler/import.d.mts +24 -0
- package/foundation/doc-compiler/import.mjs +59 -0
- package/foundation/doc-compiler/inputs.d.mts +102 -0
- package/foundation/doc-compiler/inputs.mjs +291 -0
- package/foundation/doc-compiler/inputs.test.mjs +299 -0
- package/foundation/doc-compiler/ir.d.mts +22 -0
- package/foundation/doc-compiler/ir.mjs +471 -0
- package/foundation/doc-compiler/lenses.d.mts +36 -0
- package/foundation/doc-compiler/lenses.mjs +173 -0
- package/foundation/doc-compiler/links.d.mts +162 -0
- package/foundation/doc-compiler/links.mjs +294 -0
- package/foundation/doc-compiler/links.test.mjs +192 -0
- package/foundation/doc-compiler/lower-doc.test.mjs +495 -0
- package/foundation/doc-compiler/overlays.d.mts +37 -0
- package/foundation/doc-compiler/overlays.mjs +206 -0
- package/foundation/doc-compiler/parse-readable.d.mts +9 -0
- package/foundation/doc-compiler/parse-readable.mjs +29 -0
- package/foundation/doc-compiler/read.d.mts +127 -0
- package/foundation/doc-compiler/read.mjs +325 -0
- package/foundation/doc-compiler/read.test.mjs +313 -0
- package/foundation/doc-compiler/source.d.mts +33 -0
- package/foundation/doc-compiler/source.mjs +128 -0
- package/foundation/doc-compiler/tree.d.mts +288 -0
- package/foundation/doc-compiler/tree.mjs +876 -0
- package/foundation/doc-compiler/tree.test.mjs +606 -0
- package/foundation/fs/file-protection.d.mts +33 -0
- package/foundation/fs/file-protection.mjs +825 -0
- package/foundation/fs/file-protection.test.mjs +250 -0
- package/foundation/fs/module-loader.d.mts +1 -0
- package/foundation/fs/module-loader.mjs +50 -1
- package/foundation/fs/module-loader.stdout.test.mjs +332 -0
- package/foundation/fs/path-safety.d.mts +3 -2
- package/foundation/fs/path-safety.mjs +49 -19
- package/foundation/fs/path-safety.test.mjs +50 -0
- package/foundation/fs/publish-file-hardlink-unavailable.test.mjs +129 -94
- package/foundation/identity/provider-identity.d.mts +90 -0
- package/foundation/identity/provider-identity.mjs +320 -0
- package/foundation/identity/provider-identity.test.mjs +254 -0
- package/foundation/identity/providers.d.mts +7 -0
- package/foundation/identity/providers.mjs +16 -0
- package/foundation/integrations/autolink.d.mts +58 -1
- package/foundation/integrations/autolink.mjs +143 -45
- package/foundation/integrations/autolink.test.mjs +1 -1
- package/foundation/integrations/cli-requirement.d.mts +45 -0
- package/foundation/integrations/cli-requirement.mjs +154 -0
- package/foundation/integrations/cli-requirement.test.mjs +84 -0
- package/foundation/integrations/contribution-fixes.d.mts +145 -0
- package/foundation/integrations/contribution-fixes.mjs +1284 -0
- package/foundation/integrations/contribution-inventory.d.mts +3 -2
- package/foundation/integrations/contribution-inventory.mjs +27 -24
- package/foundation/integrations/contribution-inventory.test.mjs +86 -27
- package/foundation/integrations/integration-warnings.d.mts +9 -2
- package/foundation/integrations/integration-warnings.mjs +52 -21
- package/foundation/integrations/integration-warnings.test.mjs +74 -1
- package/foundation/integrations/integrations.d.mts +63 -3
- package/foundation/integrations/integrations.mjs +122 -9
- package/foundation/integrations/integrations.test.mjs +415 -1
- package/foundation/integrations/provider-conflicts.test.mjs +125 -0
- package/foundation/integrations/provider-ledger.test.mjs +275 -0
- package/foundation/integrations/provider-resolution.d.mts +152 -0
- package/foundation/integrations/provider-resolution.mjs +576 -0
- package/foundation/integrations/provider-resolution.test.mjs +369 -0
- package/foundation/integrations/theme-descriptor.d.mts +8 -0
- package/foundation/integrations/theme-descriptor.mjs +44 -0
- package/foundation/integrations/validate-contributions.d.mts +2 -0
- package/foundation/integrations/validate-contributions.mjs +131 -29
- package/foundation/response/base.d.ts +8 -4
- package/foundation/response/batch.type.d.mts +33 -0
- package/foundation/response/batch.type.mjs +34 -0
- package/foundation/response/error-codes.d.mts +3 -1
- package/foundation/response/error-codes.d.ts +2 -0
- package/foundation/response/error-codes.doc.mjs +13 -4
- package/foundation/response/error-codes.mjs +8 -2
- package/foundation/response/error-codes.test.mjs +137 -10
- package/foundation/response/json-contract.test.mjs +57 -17
- package/foundation/response/json.d.mts +4 -2
- package/foundation/response/json.mjs +8 -10
- package/foundation/response/response-types.doc.d.mts +5 -1
- package/foundation/response/response-types.doc.mjs +46 -38
- package/foundation/response/response-types.doc.test.mjs +181 -0
- package/foundation/response/response.doc.mjs +1 -1
- package/foundation/text/string-utils.d.mts +8 -0
- package/foundation/text/string-utils.mjs +40 -10
- package/foundation/xle/browser.d.mts +3 -3
- package/foundation/xle/browser.mjs +3 -3
- package/foundation/xle/expand.d.mts +2 -0
- package/foundation/xle/expand.mjs +6 -5
- package/foundation/xle/expand.test.mjs +54 -0
- package/foundation/xle/parse.mjs +1 -1
- package/foundation/xle/print.mjs +2 -2
- package/foundation/xle/splice.mjs +1 -1
- package/foundation/xle/xle.test.mjs +13 -0
- package/package.json +10 -11
- package/api/layout/_adapter.d.mts +0 -34
- package/api/layout/_adapter.mjs +0 -133
- package/api/layout/check/check.d.mts +0 -16
- package/api/layout/check/check.mjs +0 -40
- package/api/layout/expand/expand.d.mts +0 -22
- package/api/layout/expand/expand.mjs +0 -153
- package/api/layout/grammar/grammar.d.mts +0 -13
- package/api/layout/grammar/grammar.mjs +0 -86
- package/api/layout/layout.d.mts +0 -6
- package/api/layout/layout.mjs +0 -17
- package/api/layout/layout.test.mjs +0 -297
- package/api/layout/layout.type.d.mts +0 -89
- package/api/layout/layout.type.mjs +0 -103
- package/api/layout/layoutCheck.doc.d.mts +0 -11
- package/api/layout/layoutCheck.doc.mjs +0 -84
- package/api/layout/layoutExpand.doc.d.mts +0 -11
- package/api/layout/layoutExpand.doc.mjs +0 -106
- package/api/layout/layoutGrammar.doc.d.mts +0 -11
- package/api/layout/layoutGrammar.doc.mjs +0 -56
- package/assets/templates/themes/manifest.json +0 -95
- package/clients/cli/commands/layout-check.doc.mjs +0 -54
- package/clients/cli/commands/layout-expand.doc.mjs +0 -66
- package/clients/cli/commands/layout-grammar.doc.mjs +0 -30
- package/clients/cli/commands/layout.doc.mjs +0 -34
- package/clients/cli/commands/layout.error-codes.test.mjs +0 -66
- package/clients/cli/commands/layout.exit-parity.test.mjs +0 -41
- package/clients/cli/commands/layout.mjs +0 -263
- package/clients/cli/lib/update-check.mjs +0 -83
- package/clients/cli/lib/update-check.test.mjs +0 -137
- package/clients/cli/update-hint-commands.test.mjs +0 -54
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
// @generated by scripts/sync-api-types.mjs from the JSDoc in api/**/*.mjs.
|
|
2
|
+
// DO NOT EDIT — run `pnpm sync:api-types` to regenerate.
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* Find one item of a package: an installed package's own templates, docs,
|
|
6
|
+
* themes, and codemods first, then what a discover source lists for the
|
|
7
|
+
* package. Returns null when neither has it, so the caller can report the
|
|
8
|
+
* component lookup's own error.
|
|
9
|
+
*
|
|
10
|
+
* @param {import('../../_adapter.mjs').InstalledPackage[]} packages
|
|
11
|
+
* @param {string} packageName
|
|
12
|
+
* @param {string} itemName
|
|
13
|
+
* @param {{
|
|
14
|
+
* catalog?: import('../../_catalog-view.mjs').CatalogPackage,
|
|
15
|
+
* version?: string,
|
|
16
|
+
* add?: (name: string, version?: string) => string,
|
|
17
|
+
* installedAs?: string,
|
|
18
|
+
* }} [options]
|
|
19
|
+
* @returns {import('../../discover.type.mjs').DiscoverItemResponse | null}
|
|
20
|
+
*/
|
|
21
|
+
export function item(packages: import("../../_adapter.mjs").InstalledPackage[], packageName: string, itemName: string, options?: {
|
|
22
|
+
catalog?: import("../../_catalog-view.mjs").CatalogPackage;
|
|
23
|
+
version?: string;
|
|
24
|
+
add?: (name: string, version?: string) => string;
|
|
25
|
+
installedAs?: string;
|
|
26
|
+
}): import("../../discover.type.mjs").DiscoverItemResponse | null;
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
// Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* @file discover.item leaf — one item a package adds, when it is not an
|
|
5
|
+
* installed component (those keep resolving to their full doc through
|
|
6
|
+
* ../doc).
|
|
7
|
+
*
|
|
8
|
+
* @position api/discover/detail/item — pure projection over the packages and
|
|
9
|
+
* catalog entry resolved by ../../_adapter.
|
|
10
|
+
*/
|
|
11
|
+
|
|
12
|
+
import {KIND_FIELDS} from '../../_adapter.mjs';
|
|
13
|
+
import {defaultVersion} from '../../_catalog-view.mjs';
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* Find one item of a package: an installed package's own templates, docs,
|
|
17
|
+
* themes, and codemods first, then what a discover source lists for the
|
|
18
|
+
* package. Returns null when neither has it, so the caller can report the
|
|
19
|
+
* component lookup's own error.
|
|
20
|
+
*
|
|
21
|
+
* @param {import('../../_adapter.mjs').InstalledPackage[]} packages
|
|
22
|
+
* @param {string} packageName
|
|
23
|
+
* @param {string} itemName
|
|
24
|
+
* @param {{
|
|
25
|
+
* catalog?: import('../../_catalog-view.mjs').CatalogPackage,
|
|
26
|
+
* version?: string,
|
|
27
|
+
* add?: (name: string, version?: string) => string,
|
|
28
|
+
* installedAs?: string,
|
|
29
|
+
* }} [options]
|
|
30
|
+
* @returns {import('../../discover.type.mjs').DiscoverItemResponse | null}
|
|
31
|
+
*/
|
|
32
|
+
export function item(packages, packageName, itemName, options = {}) {
|
|
33
|
+
const {catalog, version, add, installedAs} = options;
|
|
34
|
+
const pkg = packages.find(p => p.name === packageName);
|
|
35
|
+
if (pkg && (!version || version === pkg.version)) {
|
|
36
|
+
for (const [kind, field] of KIND_FIELDS) {
|
|
37
|
+
if (kind === 'component') continue;
|
|
38
|
+
const names = /** @type {Record<string, unknown>} */ (pkg)[field];
|
|
39
|
+
if (Array.isArray(names) && names.includes(itemName)) {
|
|
40
|
+
return {
|
|
41
|
+
type: 'discover.item',
|
|
42
|
+
data: {
|
|
43
|
+
package: packageName,
|
|
44
|
+
...(pkg.version ? {version: pkg.version} : {}),
|
|
45
|
+
kind,
|
|
46
|
+
name: itemName,
|
|
47
|
+
installed: true,
|
|
48
|
+
},
|
|
49
|
+
};
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
const lower = itemName.toLowerCase();
|
|
55
|
+
const found =
|
|
56
|
+
catalog?.contributions.find(c => c.name === itemName) ??
|
|
57
|
+
catalog?.contributions.find(c => c.name.toLowerCase() === lower);
|
|
58
|
+
if (!catalog || !found) return null;
|
|
59
|
+
const shown = version ?? defaultVersion(catalog);
|
|
60
|
+
return {
|
|
61
|
+
type: 'discover.item',
|
|
62
|
+
data: {
|
|
63
|
+
package: packageName,
|
|
64
|
+
...(shown ? {version: shown} : {}),
|
|
65
|
+
kind: found.kind,
|
|
66
|
+
name: found.name,
|
|
67
|
+
...(found.title ? {title: found.title} : {}),
|
|
68
|
+
...(found.summary ? {summary: found.summary} : {}),
|
|
69
|
+
...(found.keywords ? {keywords: found.keywords} : {}),
|
|
70
|
+
installed: pkg != null,
|
|
71
|
+
...(pkg == null && installedAs ? {installedAs} : {}),
|
|
72
|
+
...(pkg == null && !installedAs && add
|
|
73
|
+
? {install: add(packageName, version)}
|
|
74
|
+
: {}),
|
|
75
|
+
source: catalog.source,
|
|
76
|
+
},
|
|
77
|
+
};
|
|
78
|
+
}
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
// Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* @file Tests for the discover.item leaf, a pure projection over installed
|
|
5
|
+
* packages and a source's catalog entry.
|
|
6
|
+
*/
|
|
7
|
+
|
|
8
|
+
import {describe, expect, it} from 'vitest';
|
|
9
|
+
import {item} from './item.mjs';
|
|
10
|
+
|
|
11
|
+
/** @type {any[]} */
|
|
12
|
+
const PACKAGES = [
|
|
13
|
+
{
|
|
14
|
+
name: '@acme/widgets',
|
|
15
|
+
category: '@acme/widgets',
|
|
16
|
+
version: '1.2.3',
|
|
17
|
+
components: ['Alpha'],
|
|
18
|
+
templates: ['pages/Home'],
|
|
19
|
+
docs: ['guide'],
|
|
20
|
+
},
|
|
21
|
+
];
|
|
22
|
+
|
|
23
|
+
/** @type {any} */
|
|
24
|
+
const CATALOG = {
|
|
25
|
+
package: '@acme/charts',
|
|
26
|
+
integration: 'acme-charts',
|
|
27
|
+
aliases: [],
|
|
28
|
+
latest: '2.0.0',
|
|
29
|
+
source: 'Acme',
|
|
30
|
+
versions: [],
|
|
31
|
+
contributions: [{kind: 'template', name: 'pages/Report', title: 'Report page'}],
|
|
32
|
+
};
|
|
33
|
+
|
|
34
|
+
/** @param {string} name @param {string} [version] */
|
|
35
|
+
const add = (name, version) => `pnpm add ${version ? `${name}@${version}` : name}`;
|
|
36
|
+
|
|
37
|
+
describe('discover.item leaf', () => {
|
|
38
|
+
it("finds an installed package's own template, doc, theme, or codemod", () => {
|
|
39
|
+
expect(item(PACKAGES, '@acme/widgets', 'pages/Home')).toEqual({
|
|
40
|
+
type: 'discover.item',
|
|
41
|
+
data: {
|
|
42
|
+
package: '@acme/widgets',
|
|
43
|
+
version: '1.2.3',
|
|
44
|
+
kind: 'template',
|
|
45
|
+
name: 'pages/Home',
|
|
46
|
+
installed: true,
|
|
47
|
+
},
|
|
48
|
+
});
|
|
49
|
+
});
|
|
50
|
+
|
|
51
|
+
it('finds an item a source lists, with the command that adds its package', () => {
|
|
52
|
+
expect(
|
|
53
|
+
item(PACKAGES, '@acme/charts', 'pages/report', {catalog: CATALOG, add}),
|
|
54
|
+
).toEqual({
|
|
55
|
+
type: 'discover.item',
|
|
56
|
+
data: {
|
|
57
|
+
package: '@acme/charts',
|
|
58
|
+
version: '2.0.0',
|
|
59
|
+
kind: 'template',
|
|
60
|
+
name: 'pages/Report',
|
|
61
|
+
title: 'Report page',
|
|
62
|
+
installed: false,
|
|
63
|
+
install: 'pnpm add @acme/charts',
|
|
64
|
+
source: 'Acme',
|
|
65
|
+
},
|
|
66
|
+
});
|
|
67
|
+
});
|
|
68
|
+
|
|
69
|
+
it('returns null when neither the project nor a source has it', () => {
|
|
70
|
+
expect(item(PACKAGES, '@acme/widgets', 'Nope')).toBeNull();
|
|
71
|
+
expect(item(PACKAGES, '@acme/charts', 'Nope', {catalog: CATALOG})).toBeNull();
|
|
72
|
+
});
|
|
73
|
+
});
|
|
@@ -3,19 +3,13 @@
|
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
5
|
* @param {string} [query]
|
|
6
|
-
* @param {
|
|
7
|
-
* @param {boolean} [options.components]
|
|
8
|
-
* @param {string} [options.lang]
|
|
9
|
-
* @param {boolean} [options.zh]
|
|
6
|
+
* @param {import('./discover.type.mjs').DiscoverOptions} [options]
|
|
10
7
|
* @returns {Promise<
|
|
11
8
|
* import('./discover.type.mjs').DiscoverListResponse |
|
|
12
9
|
* import('./discover.type.mjs').DiscoverDetailResponse |
|
|
13
10
|
* import('./discover.type.mjs').DiscoverDetailDocResponse |
|
|
11
|
+
* import('./discover.type.mjs').DiscoverItemResponse |
|
|
14
12
|
* import('./discover.type.mjs').DiscoverSearchResponse
|
|
15
13
|
* >}
|
|
16
14
|
*/
|
|
17
|
-
export function discover(query?: string, options?:
|
|
18
|
-
components?: boolean | undefined;
|
|
19
|
-
lang?: string | undefined;
|
|
20
|
-
zh?: boolean | undefined;
|
|
21
|
-
}): Promise<import("./discover.type.mjs").DiscoverListResponse | import("./discover.type.mjs").DiscoverDetailResponse | import("./discover.type.mjs").DiscoverDetailDocResponse | import("./discover.type.mjs").DiscoverSearchResponse>;
|
|
15
|
+
export function discover(query?: string, options?: import("./discover.type.mjs").DiscoverOptions): Promise<import("./discover.type.mjs").DiscoverListResponse | import("./discover.type.mjs").DiscoverDetailResponse | import("./discover.type.mjs").DiscoverDetailDocResponse | import("./discover.type.mjs").DiscoverItemResponse | import("./discover.type.mjs").DiscoverSearchResponse>;
|
|
@@ -11,23 +11,27 @@ export const doc = {
|
|
|
11
11
|
type: 'function',
|
|
12
12
|
kind: 'api',
|
|
13
13
|
name: 'discover',
|
|
14
|
+
namespace: 'cli/api',
|
|
14
15
|
displayName: 'discover()',
|
|
15
|
-
summary:
|
|
16
|
+
summary:
|
|
17
|
+
'Browse and search integrations: the ones a project has and, through discover sources, the ones it could add.',
|
|
16
18
|
description:
|
|
17
|
-
'
|
|
18
|
-
'the
|
|
19
|
-
'
|
|
20
|
-
"
|
|
21
|
-
'
|
|
19
|
+
'Lists the integrations a project loads and, when the project or an integration provides a discover source, ' +
|
|
20
|
+
'the packages it could add, with what each one adds per kind. An @scope/name query shows one package with every ' +
|
|
21
|
+
'version its source knows; @scope/name@version shows one version; @scope/name/Component returns an installed ' +
|
|
22
|
+
"component's validated doc, and any other item path returns that item. A free-text term searches every item and " +
|
|
23
|
+
'package. Discover only reads: it prints the command that adds a package and never runs it.',
|
|
22
24
|
importPath: '@astryxdesign/cli/api',
|
|
23
25
|
signature:
|
|
24
|
-
'discover(query?: string, options?: DiscoverOptions): Promise<DiscoverListResponse | DiscoverDetailResponse | DiscoverDetailDocResponse | DiscoverSearchResponse>',
|
|
26
|
+
'discover(query?: string, options?: DiscoverOptions): Promise<DiscoverListResponse | DiscoverDetailResponse | DiscoverDetailDocResponse | DiscoverItemResponse | DiscoverSearchResponse>',
|
|
25
27
|
keywords: [
|
|
26
28
|
'discover',
|
|
27
29
|
'packages',
|
|
28
30
|
'integrations',
|
|
29
31
|
'external',
|
|
30
32
|
'components',
|
|
33
|
+
'catalog',
|
|
34
|
+
'versions',
|
|
31
35
|
'search',
|
|
32
36
|
],
|
|
33
37
|
params: [
|
|
@@ -35,13 +39,39 @@ export const doc = {
|
|
|
35
39
|
name: 'query',
|
|
36
40
|
type: 'string',
|
|
37
41
|
description:
|
|
38
|
-
'
|
|
42
|
+
'A package (@scope/name, optionally @version), an item path (@scope/name/<item>), or a free-text term. Omit to list packages.',
|
|
39
43
|
},
|
|
40
44
|
{
|
|
41
45
|
name: 'options.components',
|
|
42
46
|
type: 'boolean',
|
|
43
47
|
description:
|
|
44
|
-
'
|
|
48
|
+
'In the CLI package list, print every component, and every other item, of each package instead of the first 10. A display flag for the CLI renderer; the programmatic response is unchanged.',
|
|
49
|
+
},
|
|
50
|
+
{
|
|
51
|
+
name: 'options.type',
|
|
52
|
+
type: "'component' | 'template' | 'doc' | 'theme' | 'codemod' | 'agent-doc'",
|
|
53
|
+
description:
|
|
54
|
+
'Only one kind: in the list, packages that add it; in a search, items of that kind.',
|
|
55
|
+
},
|
|
56
|
+
{
|
|
57
|
+
name: 'options.installed',
|
|
58
|
+
type: 'boolean',
|
|
59
|
+
description:
|
|
60
|
+
'Only what the project has. Cannot be set with options.available.',
|
|
61
|
+
default: 'false',
|
|
62
|
+
},
|
|
63
|
+
{
|
|
64
|
+
name: 'options.available',
|
|
65
|
+
type: 'boolean',
|
|
66
|
+
description:
|
|
67
|
+
'Only what the project could add. Cannot be set with options.installed.',
|
|
68
|
+
default: 'false',
|
|
69
|
+
},
|
|
70
|
+
{
|
|
71
|
+
name: 'options.limit',
|
|
72
|
+
type: 'number',
|
|
73
|
+
description: 'Max number of search results, a positive integer.',
|
|
74
|
+
default: '20',
|
|
45
75
|
},
|
|
46
76
|
{
|
|
47
77
|
name: 'options.lang',
|
|
@@ -59,21 +89,27 @@ export const doc = {
|
|
|
59
89
|
{
|
|
60
90
|
type: 'discover.list',
|
|
61
91
|
description:
|
|
62
|
-
'The
|
|
92
|
+
'The installed integrations (name, category, components, version, and a list per other kind they add). With a discover source, meta.available lists what the project could add and meta.sources reports each source. When the list is empty it carries meta.configured.',
|
|
63
93
|
},
|
|
64
94
|
{
|
|
65
95
|
type: 'discover.detail',
|
|
66
|
-
description:
|
|
96
|
+
description:
|
|
97
|
+
'One package: what the shown version adds, whether the project has it, its versions and latest release when a source knows them, and the command that adds it when the project does not have it.',
|
|
67
98
|
},
|
|
68
99
|
{
|
|
69
100
|
type: 'discover.detail.doc',
|
|
70
101
|
description:
|
|
71
|
-
'The validated ComponentDoc for one
|
|
102
|
+
'The validated ComponentDoc for one installed component, for an @scope/name/Component query.',
|
|
103
|
+
},
|
|
104
|
+
{
|
|
105
|
+
type: 'discover.item',
|
|
106
|
+
description:
|
|
107
|
+
'One item that is not an installed component: its kind, name, the package and version that add it, and whether the project has the package.',
|
|
72
108
|
},
|
|
73
109
|
{
|
|
74
110
|
type: 'discover.search',
|
|
75
111
|
description:
|
|
76
|
-
'The query echoed back plus
|
|
112
|
+
'The query echoed back plus every matching item and package, each with its kind and whether the project has it, even when one name matches exactly or only one item matches; total is set when the limit cut the list.',
|
|
77
113
|
},
|
|
78
114
|
],
|
|
79
115
|
throws: [
|
|
@@ -81,17 +117,21 @@ export const doc = {
|
|
|
81
117
|
code: 'ERR_INVALID_ARGUMENT',
|
|
82
118
|
when: 'the query is a non-string value, or a free-text search is run with an empty query',
|
|
83
119
|
},
|
|
120
|
+
{
|
|
121
|
+
code: 'ERR_INVALID_OPTION',
|
|
122
|
+
when: 'options.type is not a known kind, options.limit is not a positive integer, or options.installed and options.available are both set',
|
|
123
|
+
},
|
|
84
124
|
{
|
|
85
125
|
code: 'ERR_UNKNOWN_PACKAGE',
|
|
86
|
-
when: 'the
|
|
126
|
+
when: 'neither the project nor any discover source has the package',
|
|
87
127
|
},
|
|
88
128
|
{
|
|
89
129
|
code: 'ERR_UNKNOWN_COMPONENT',
|
|
90
|
-
when: 'the
|
|
130
|
+
when: 'the item is not in the named package',
|
|
91
131
|
},
|
|
92
132
|
{
|
|
93
133
|
code: 'ERR_NOT_FOUND',
|
|
94
|
-
when: 'a free-text term matches
|
|
134
|
+
when: 'a free-text term matches nothing, or the requested version is not published',
|
|
95
135
|
},
|
|
96
136
|
{
|
|
97
137
|
code: 'ERR_INVALID_DOC',
|
|
@@ -99,10 +139,14 @@ export const doc = {
|
|
|
99
139
|
},
|
|
100
140
|
],
|
|
101
141
|
examples: [
|
|
102
|
-
{label: 'List packages', code: 'const {data} = await discover();'},
|
|
142
|
+
{label: 'List packages', code: 'const {data, meta} = await discover();'},
|
|
103
143
|
{label: 'Browse a package', code: "await discover('@acme/ui');"},
|
|
144
|
+
{label: 'One version', code: "await discover('@acme/ui@2.1.0');"},
|
|
104
145
|
{label: 'Show a component doc', code: "await discover('@acme/ui/Button');"},
|
|
105
|
-
{
|
|
146
|
+
{
|
|
147
|
+
label: 'Search templates to add',
|
|
148
|
+
code: "await discover('dashboard', {type: 'template', available: true});",
|
|
149
|
+
},
|
|
106
150
|
],
|
|
107
151
|
command: 'discover',
|
|
108
152
|
related: ['component', 'search', 'template'],
|
|
@@ -3,55 +3,193 @@
|
|
|
3
3
|
/**
|
|
4
4
|
* @file Programmatic API for the discover command — dispatcher + barrel.
|
|
5
5
|
*
|
|
6
|
-
* `discover()`
|
|
7
|
-
*
|
|
8
|
-
*
|
|
9
|
-
* owns each response shape:
|
|
6
|
+
* `discover()` browses the integrations a project has and, through discover
|
|
7
|
+
* sources, the ones it could add. It only reads: the package manager installs.
|
|
8
|
+
* Its job is to resolve the project and its sources (via ./_adapter) and route
|
|
9
|
+
* to the leaf that owns each response shape:
|
|
10
10
|
*
|
|
11
|
-
* discover
|
|
12
|
-
* discover
|
|
13
|
-
* discover
|
|
14
|
-
* discover
|
|
11
|
+
* discover -> ./list/list.mjs discover.list
|
|
12
|
+
* discover <package>[@<version>] -> ./detail/detail.mjs discover.detail
|
|
13
|
+
* discover <package>/<Component> -> ./detail/doc/doc.mjs discover.detail.doc
|
|
14
|
+
* discover <package>/<item> -> ./detail/item/item.mjs discover.item
|
|
15
|
+
* discover <words> -> ./search/search.mjs discover.search (always a list)
|
|
15
16
|
*
|
|
16
|
-
*
|
|
17
|
+
* Source results are additive: they ride in `meta.available`/`meta.sources`,
|
|
18
|
+
* in extra fields, or as extra search matches, so every existing field keeps
|
|
19
|
+
* its meaning.
|
|
20
|
+
*
|
|
21
|
+
* @position api/discover — thin router over ./_adapter, ./_catalog-view, and
|
|
22
|
+
* the discover leaves.
|
|
17
23
|
*/
|
|
18
24
|
|
|
19
|
-
import {
|
|
25
|
+
import {
|
|
26
|
+
addCommand,
|
|
27
|
+
callSources,
|
|
28
|
+
declaredDependencies,
|
|
29
|
+
describeInstalled,
|
|
30
|
+
discoverPackages,
|
|
31
|
+
findComponent,
|
|
32
|
+
hasSources,
|
|
33
|
+
} from './_adapter.mjs';
|
|
34
|
+
import {
|
|
35
|
+
availableEntries,
|
|
36
|
+
catalogState,
|
|
37
|
+
searchItems,
|
|
38
|
+
withLatest,
|
|
39
|
+
} from './_catalog-view.mjs';
|
|
20
40
|
import {list} from './list/list.mjs';
|
|
21
41
|
import {detail} from './detail/detail.mjs';
|
|
22
|
-
import {doc} from './detail/doc/doc.mjs';
|
|
42
|
+
import {doc, docFromResult} from './detail/doc/doc.mjs';
|
|
43
|
+
import {item} from './detail/item/item.mjs';
|
|
23
44
|
import {search} from './search/search.mjs';
|
|
24
45
|
import {AstryxError} from '../error.mjs';
|
|
25
46
|
import {ERROR_CODES} from '../../foundation/response/error-codes.mjs';
|
|
47
|
+
import {levenshteinDistance} from '../../foundation/text/string-utils.mjs';
|
|
48
|
+
import {DISCOVER_KINDS} from '../../authoring/discover/parse.mjs';
|
|
49
|
+
|
|
50
|
+
const DEFAULT_LIMIT = 20;
|
|
51
|
+
|
|
52
|
+
/** @type {import('./_adapter.mjs').CatalogResult} */
|
|
53
|
+
const NO_CATALOG = {sources: [], packages: []};
|
|
54
|
+
|
|
55
|
+
/**
|
|
56
|
+
* Split a package-shaped query: `name`, `name@version`, or `name/item`, with an
|
|
57
|
+
* optional `@scope/` prefix on the name.
|
|
58
|
+
* @param {string} query
|
|
59
|
+
* @returns {{scoped: boolean, name: string, version?: string, item?: string}}
|
|
60
|
+
*/
|
|
61
|
+
function splitTarget(query) {
|
|
62
|
+
const scoped = query.startsWith('@');
|
|
63
|
+
const firstSlash = query.indexOf('/');
|
|
64
|
+
let head = query;
|
|
65
|
+
/** @type {string | undefined} */
|
|
66
|
+
let rest;
|
|
67
|
+
const split = scoped
|
|
68
|
+
? firstSlash < 0
|
|
69
|
+
? -1
|
|
70
|
+
: query.indexOf('/', firstSlash + 1)
|
|
71
|
+
: firstSlash;
|
|
72
|
+
if (split > 0) {
|
|
73
|
+
head = query.slice(0, split);
|
|
74
|
+
rest = query.slice(split + 1) || undefined;
|
|
75
|
+
}
|
|
76
|
+
const at = head.indexOf('@', 1);
|
|
77
|
+
return {
|
|
78
|
+
scoped,
|
|
79
|
+
name: at > 0 ? head.slice(0, at) : head,
|
|
80
|
+
...(at > 0 && head.slice(at + 1) ? {version: head.slice(at + 1)} : {}),
|
|
81
|
+
...(rest ? {item: rest} : {}),
|
|
82
|
+
};
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
/**
|
|
86
|
+
* @param {{type?: unknown, installed?: boolean, available?: boolean, limit?: unknown}} options
|
|
87
|
+
*/
|
|
88
|
+
function checkOptions({type, installed, available, limit}) {
|
|
89
|
+
if (
|
|
90
|
+
type != null &&
|
|
91
|
+
!(/** @type {readonly unknown[]} */ (DISCOVER_KINDS).includes(type))
|
|
92
|
+
) {
|
|
93
|
+
throw new AstryxError(
|
|
94
|
+
`Unknown --type "${String(type)}"`,
|
|
95
|
+
DISCOVER_KINDS.map(kind => ({name: kind, reason: 'item kind'})),
|
|
96
|
+
ERROR_CODES.ERR_INVALID_OPTION,
|
|
97
|
+
);
|
|
98
|
+
}
|
|
99
|
+
if (installed && available) {
|
|
100
|
+
throw new AstryxError(
|
|
101
|
+
'--installed and --available cannot be used together',
|
|
102
|
+
undefined,
|
|
103
|
+
ERROR_CODES.ERR_INVALID_OPTION,
|
|
104
|
+
);
|
|
105
|
+
}
|
|
106
|
+
if (
|
|
107
|
+
limit != null &&
|
|
108
|
+
!(typeof limit === 'number' && Number.isInteger(limit) && limit > 0)
|
|
109
|
+
) {
|
|
110
|
+
throw new AstryxError(
|
|
111
|
+
`--limit must be a positive integer, not "${String(limit)}"`,
|
|
112
|
+
undefined,
|
|
113
|
+
ERROR_CODES.ERR_INVALID_OPTION,
|
|
114
|
+
);
|
|
115
|
+
}
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
/**
|
|
119
|
+
* Items a source lists for a package that look like the one asked for: names
|
|
120
|
+
* that contain it, else the closest few by spelling.
|
|
121
|
+
* @param {import('../../authoring/discover/type.js').DiscoverPackage} entry
|
|
122
|
+
* @param {string} wanted
|
|
123
|
+
* @returns {Array<{name: string, reason: string}>}
|
|
124
|
+
*/
|
|
125
|
+
function similarItems(entry, wanted) {
|
|
126
|
+
const lower = wanted.toLowerCase();
|
|
127
|
+
const names = [...new Set(entry.contributions.map(c => c.name))];
|
|
128
|
+
const hits = names.filter(name => name.toLowerCase().includes(lower));
|
|
129
|
+
const picked =
|
|
130
|
+
hits.length > 0
|
|
131
|
+
? hits.slice(0, 5)
|
|
132
|
+
: names
|
|
133
|
+
.map(name => ({
|
|
134
|
+
name,
|
|
135
|
+
distance: levenshteinDistance(lower, name.toLowerCase()),
|
|
136
|
+
}))
|
|
137
|
+
.filter(m => m.distance <= 3)
|
|
138
|
+
.sort((a, b) => a.distance - b.distance)
|
|
139
|
+
.slice(0, 5)
|
|
140
|
+
.map(m => m.name);
|
|
141
|
+
return picked.map(name => ({
|
|
142
|
+
name: `${entry.package}/${name}`,
|
|
143
|
+
reason: 'similar name',
|
|
144
|
+
}));
|
|
145
|
+
}
|
|
26
146
|
|
|
27
147
|
/**
|
|
28
148
|
* @param {string} [query]
|
|
29
|
-
* @param {
|
|
30
|
-
* @param {boolean} [options.components]
|
|
31
|
-
* @param {string} [options.lang]
|
|
32
|
-
* @param {boolean} [options.zh]
|
|
149
|
+
* @param {import('./discover.type.mjs').DiscoverOptions} [options]
|
|
33
150
|
* @returns {Promise<
|
|
34
151
|
* import('./discover.type.mjs').DiscoverListResponse |
|
|
35
152
|
* import('./discover.type.mjs').DiscoverDetailResponse |
|
|
36
153
|
* import('./discover.type.mjs').DiscoverDetailDocResponse |
|
|
154
|
+
* import('./discover.type.mjs').DiscoverItemResponse |
|
|
37
155
|
* import('./discover.type.mjs').DiscoverSearchResponse
|
|
38
156
|
* >}
|
|
39
157
|
*/
|
|
40
158
|
export async function discover(query, options = {}) {
|
|
41
|
-
const {lang = null, zh = false} = options;
|
|
42
|
-
|
|
159
|
+
const {lang = null, zh = false, type, limit} = options;
|
|
160
|
+
checkOptions(options);
|
|
161
|
+
const only = options.installed
|
|
162
|
+
? /** @type {const} */ ('installed')
|
|
163
|
+
: options.available
|
|
164
|
+
? /** @type {const} */ ('available')
|
|
165
|
+
: undefined;
|
|
166
|
+
|
|
167
|
+
const {packages: scanned, configured, project} = await discoverPackages();
|
|
168
|
+
const withSources = hasSources(project);
|
|
169
|
+
const packages = await describeInstalled(project, scanned);
|
|
170
|
+
const declared = declaredDependencies(project);
|
|
171
|
+
const add = addCommand(project);
|
|
43
172
|
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
if (packages.length === 0) return list(packages, {configured});
|
|
173
|
+
/** @param {{package?: string, version?: string}} [request] */
|
|
174
|
+
const catalogFor = async request =>
|
|
175
|
+
withSources ? await callSources(project, request) : NO_CATALOG;
|
|
48
176
|
|
|
49
|
-
// No query: the
|
|
50
|
-
if (!query
|
|
177
|
+
// No query, or nothing to look through: the list.
|
|
178
|
+
if (!query || (packages.length === 0 && !withSources)) {
|
|
179
|
+
if (!withSources) return list(packages, {configured, type, only});
|
|
180
|
+
const catalog = await catalogFor();
|
|
181
|
+
return list(withLatest(packages, catalog), {
|
|
182
|
+
configured,
|
|
183
|
+
type,
|
|
184
|
+
only,
|
|
185
|
+
available: availableEntries(catalog, packages, declared),
|
|
186
|
+
sources: catalog.sources,
|
|
187
|
+
});
|
|
188
|
+
}
|
|
51
189
|
|
|
52
|
-
// A non-string (truthy) query would crash
|
|
53
|
-
//
|
|
54
|
-
//
|
|
190
|
+
// A non-string (truthy) query would crash the parsing below with a raw
|
|
191
|
+
// TypeError (no ERR_* code → downgrades to ERR_UNKNOWN). The CLI only ever
|
|
192
|
+
// passes a string, but the public API must fail with a code.
|
|
55
193
|
if (typeof query !== 'string') {
|
|
56
194
|
throw new AstryxError(
|
|
57
195
|
`Invalid query "${String(query)}"`,
|
|
@@ -60,17 +198,63 @@ export async function discover(query, options = {}) {
|
|
|
60
198
|
);
|
|
61
199
|
}
|
|
62
200
|
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
201
|
+
const target = splitTarget(query);
|
|
202
|
+
const installedNames = new Set(packages.map(p => p.name));
|
|
203
|
+
|
|
204
|
+
/**
|
|
205
|
+
* One package, one version, or one item, once `target.name` is known to be
|
|
206
|
+
* a package the project or a source has.
|
|
207
|
+
* @param {import('./_adapter.mjs').CatalogResult} catalog
|
|
208
|
+
*/
|
|
209
|
+
const packageView = async catalog => {
|
|
210
|
+
const entry = catalog.packages.find(p => p.package === target.name);
|
|
211
|
+
const installedAs = entry
|
|
212
|
+
? catalogState(entry, installedNames, declared).installedAs
|
|
213
|
+
: undefined;
|
|
214
|
+
const context = {catalog: entry, version: target.version, add, installedAs};
|
|
215
|
+
if (!target.item) return detail(packages, target.name, context);
|
|
216
|
+
const found = item(packages, target.name, target.item, context);
|
|
217
|
+
if (found) return found;
|
|
218
|
+
// Only an installed package has docs to fall back to. For one that is
|
|
219
|
+
// only in a source, the item is what is unknown, not the package.
|
|
220
|
+
if (entry && !packages.some(p => p.name === target.name)) {
|
|
221
|
+
throw new AstryxError(
|
|
222
|
+
`"${target.item}" not found in ${target.name}`,
|
|
223
|
+
similarItems(entry, target.item),
|
|
224
|
+
ERROR_CODES.ERR_UNKNOWN_COMPONENT,
|
|
225
|
+
);
|
|
70
226
|
}
|
|
71
|
-
return
|
|
227
|
+
return await doc(packages, target.name, target.item, {lang, zh});
|
|
228
|
+
};
|
|
229
|
+
|
|
230
|
+
// An installed component keeps resolving to its full doc, before any source
|
|
231
|
+
// is asked anything.
|
|
232
|
+
const installedPkg = packages.find(p => p.name === target.name);
|
|
233
|
+
if (installedPkg && target.item && !target.version) {
|
|
234
|
+
const resolved = findComponent([installedPkg], target.item);
|
|
235
|
+
if (resolved) return await docFromResult(resolved, {lang, zh});
|
|
236
|
+
}
|
|
237
|
+
|
|
238
|
+
if (target.scoped) {
|
|
239
|
+
return await packageView(
|
|
240
|
+
await catalogFor({package: target.name, version: target.version}),
|
|
241
|
+
);
|
|
242
|
+
}
|
|
243
|
+
|
|
244
|
+
const listing = await catalogFor();
|
|
245
|
+
const isPackage =
|
|
246
|
+
installedPkg != null ||
|
|
247
|
+
listing.packages.some(p => p.package === target.name);
|
|
248
|
+
if (isPackage && (target.version || target.item || target.name === query)) {
|
|
249
|
+
return await packageView(
|
|
250
|
+
await catalogFor({package: target.name, version: target.version}),
|
|
251
|
+
);
|
|
72
252
|
}
|
|
73
253
|
|
|
74
|
-
|
|
75
|
-
|
|
254
|
+
return await search(packages, query, {
|
|
255
|
+
items: searchItems(packages, listing, declared),
|
|
256
|
+
type,
|
|
257
|
+
only,
|
|
258
|
+
limit: limit ?? DEFAULT_LIMIT,
|
|
259
|
+
});
|
|
76
260
|
}
|