@astryxdesign/cli 0.6.4 → 0.6.5-canary.031021b
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 +56 -0
- package/README.md +97 -90
- package/api/build/build.doc.mjs +6 -1
- package/api/build/build.test.mjs +22 -0
- package/api/build/kit/kit.mjs +44 -5
- package/api/component/_adapter.d.mts +25 -0
- package/api/component/_adapter.mjs +59 -5
- package/api/component/component.d.mts +6 -3
- package/api/component/component.doc.mjs +37 -17
- package/api/component/component.mjs +249 -9
- package/api/component/component.type.d.mts +25 -0
- package/api/component/component.type.mjs +44 -0
- 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 +61 -18
- package/api/discover/discover.mjs +220 -36
- package/api/discover/discover.test.mjs +11 -2
- package/api/discover/discover.type.d.mts +147 -8
- package/api/discover/discover.type.mjs +102 -12
- 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 +8 -3
- package/api/docs/_adapter.mjs +14 -6
- package/api/docs/docOverlays.test.mjs +27 -1
- package/api/docs/docs.doc.mjs +2 -2
- package/api/doctor/doctor.d.mts +8 -3
- package/api/doctor/doctor.doc.mjs +17 -8
- package/api/doctor/doctor.mjs +90 -9
- package/api/doctor/doctor.test.mjs +122 -10
- package/api/doctor/doctor.type.d.mts +1 -1
- package/api/doctor/doctor.type.mjs +1 -1
- package/api/gap-report/gap-report.doc.mjs +19 -10
- package/api/hook/hook.doc.mjs +6 -3
- package/api/index.d.mts +1 -0
- package/api/index.mjs +5 -3
- package/api/init/init.doc.mjs +17 -12
- package/api/integration/add-helpers.d.mts +5 -2
- package/api/integration/add-helpers.mjs +36 -9
- package/api/integration/add-theme.mjs +22 -1
- package/api/integration/add-theme.test.mjs +34 -0
- package/api/integration/authoring-checks.mjs +2 -2
- package/api/integration/integrationPackCheck.doc.mjs +3 -3
- package/api/integration/pack-check.lifecycle-output.test.mjs +107 -0
- package/api/integration/pack-check.mjs +82 -9
- package/api/integration/pack-check.test.mjs +90 -0
- package/api/integration/pack-check.type.mjs +1 -1
- package/api/json/assertResponse.doc.mjs +1 -1
- package/api/json/isError.doc.mjs +1 -1
- package/api/search/search.d.mts +27 -1
- package/api/search/search.doc.mjs +2 -2
- package/api/search/search.mjs +228 -16
- package/api/swizzle/swizzle.doc.mjs +7 -5
- package/api/template/copy/copy.mjs +1 -1
- package/api/template/copy/copy.test.mjs +9 -0
- package/api/template/template.doc.mjs +2 -1
- package/api/theme/add/add.mjs +17 -25
- package/api/theme/add/add.rollback.test.mjs +158 -0
- package/api/theme/add/add.staging.test.mjs +40 -23
- package/api/theme/build/build.family.test.mjs +7 -12
- package/api/theme/build/build.mjs +8 -18
- package/api/theme/build/build.rollback.test.mjs +148 -0
- package/api/theme/generateTonalPalette.doc.mjs +1 -2
- package/api/theme/listThemes.doc.mjs +1 -1
- package/api/theme/themeAdd.doc.mjs +9 -10
- package/api/theme/themeBuild.doc.mjs +13 -13
- package/api/theme/themeList.doc.mjs +1 -1
- package/api/theme/themeListAvailable.doc.mjs +2 -1
- package/api/theme/themePaletteGenerate.doc.mjs +15 -8
- package/api/theme/themeTargets.doc.mjs +3 -2
- package/api/theme/themeTemplate.doc.mjs +2 -1
- package/api/upgrade/run/files-changed.test.mjs +111 -0
- package/api/upgrade/run/run.mjs +5 -3
- package/api/upgrade/upgrade.doc.mjs +24 -22
- package/api/upgrade/upgrade.type.mjs +2 -2
- package/assets/codemods/__tests__/runner.test.mjs +3 -1
- package/assets/codemods/file-count.test.mjs +163 -0
- package/assets/codemods/integration-runner.mjs +3 -3
- package/assets/codemods/runner.mjs +5 -4
- package/assets/docs/README.md +4 -2
- package/assets/docs/browser-support.doc.mjs +11 -11
- package/assets/docs/color.doc.mjs +8 -2
- package/assets/docs/elevation.doc.mjs +6 -4
- package/assets/docs/getting-started.doc.mjs +5 -16
- package/assets/docs/icons.doc.mjs +2 -21
- package/assets/docs/illustrations.doc.mjs +7 -15
- package/assets/docs/internationalization.doc.mjs +7 -5
- package/assets/docs/layout.doc.dense.mjs +130 -82
- package/assets/docs/layout.doc.mjs +133 -77
- package/assets/docs/migration.doc.mjs +19 -21
- package/assets/docs/motion.doc.mjs +16 -3
- package/assets/docs/principles.doc.dense.mjs +5 -5
- package/assets/docs/principles.doc.mjs +8 -0
- package/assets/docs/principles.doc.zh.mjs +6 -6
- package/assets/docs/shape.doc.mjs +8 -3
- package/assets/docs/spacing.doc.mjs +7 -2
- package/assets/docs/styling-libraries.doc.mjs +6 -2
- package/assets/docs/styling.doc.mjs +19 -23
- package/assets/docs/theme.doc.dense.mjs +58 -18
- package/assets/docs/theme.doc.mjs +57 -47
- package/assets/docs/theme.doc.zh.mjs +9 -8
- package/assets/docs/tokens.doc.dense.mjs +2 -2
- package/assets/docs/tokens.doc.mjs +389 -8
- package/assets/docs/tokens.doc.zh.mjs +2 -2
- package/assets/docs/tree/add-a-component.doc.mjs +75 -0
- package/assets/docs/tree/add-a-theme.doc.mjs +85 -0
- package/assets/docs/tree/add-a-topic.doc.mjs +144 -0
- package/assets/docs/tree/agent-guidance.doc.mjs +138 -0
- package/assets/docs/tree/block-template.doc.mjs +130 -0
- package/assets/docs/tree/build-the-template.doc.mjs +28 -0
- package/assets/docs/tree/building-blocks.doc.mjs +46 -0
- package/assets/docs/tree/check-your-docs.doc.mjs +137 -0
- package/assets/docs/tree/checks.doc.mjs +119 -0
- package/assets/docs/tree/codemods.doc.mjs +147 -0
- package/assets/docs/tree/component-family.doc.mjs +113 -0
- package/assets/docs/tree/component-imports.doc.mjs +69 -0
- package/assets/docs/tree/component-lookups.doc.mjs +149 -0
- package/assets/docs/tree/components.doc.mjs +23 -0
- package/assets/docs/tree/configuration.doc.mjs +23 -0
- package/assets/docs/tree/debug-and-gap-reports.doc.mjs +182 -0
- package/assets/docs/tree/define-the-theme.doc.mjs +118 -0
- package/assets/docs/tree/describe-the-component.doc.mjs +57 -0
- package/assets/docs/tree/docs.doc.mjs +21 -0
- package/assets/docs/tree/document-the-template.doc.mjs +28 -0
- package/assets/docs/tree/document-the-theme.doc.mjs +68 -0
- package/assets/docs/tree/export-template-assets.doc.mjs +147 -0
- package/assets/docs/tree/extend-or-replace.doc.mjs +103 -0
- package/assets/docs/tree/fonts-and-assets.doc.mjs +106 -0
- package/assets/docs/tree/generate-a-palette.doc.mjs +66 -0
- package/assets/docs/tree/grade-template-with-agent.doc.mjs +105 -0
- package/assets/docs/tree/help.doc.mjs +16 -0
- package/assets/docs/tree/integrations.doc.mjs +25 -451
- package/assets/docs/tree/links.doc.mjs +98 -0
- package/assets/docs/tree/package-and-test.doc.mjs +32 -0
- package/assets/docs/tree/page-template.doc.mjs +71 -0
- package/assets/docs/tree/publishing.doc.mjs +111 -0
- package/assets/docs/tree/quick-start.doc.mjs +272 -0
- package/assets/docs/tree/replace-a-core-component.doc.mjs +104 -0
- package/assets/docs/tree/replace-a-core-template.doc.mjs +172 -0
- package/assets/docs/tree/sections-and-placement.doc.mjs +108 -0
- package/assets/docs/tree/see-it-in-an-app.doc.mjs +59 -0
- package/assets/docs/tree/ship.doc.mjs +16 -0
- package/assets/docs/tree/short-and-findable.doc.mjs +108 -0
- package/assets/docs/tree/single-component.doc.mjs +165 -0
- package/assets/docs/tree/start-a-template.doc.mjs +143 -0
- package/assets/docs/tree/subcomponent.doc.mjs +115 -0
- package/assets/docs/tree/template-assets.doc.mjs +64 -0
- package/assets/docs/tree/template-doc-overview.doc.mjs +109 -0
- package/assets/docs/tree/template-fonts.doc.mjs +102 -0
- package/assets/docs/tree/template-grading-rubric.doc.mjs +452 -0
- package/assets/docs/tree/template-icons.doc.mjs +97 -0
- package/assets/docs/tree/template-images-media.doc.mjs +127 -0
- package/assets/docs/tree/template-styles.doc.mjs +93 -0
- package/assets/docs/tree/templates.doc.mjs +34 -0
- package/assets/docs/tree/test-in-an-app.doc.mjs +115 -0
- package/assets/docs/tree/test-template-in-app.doc.mjs +128 -0
- package/assets/docs/tree/themes.doc.mjs +39 -0
- package/assets/docs/tree/troubleshooting.doc.mjs +149 -0
- package/assets/docs/tree/upgrading.doc.mjs +103 -0
- package/assets/docs/tree/use-a-theme-in-an-app.doc.mjs +51 -0
- package/assets/docs/tree/verify-packed-template.doc.mjs +77 -0
- package/assets/docs/tree/versioning.doc.mjs +161 -0
- package/assets/docs/tree/write-good-templates.doc.mjs +64 -0
- package/assets/docs/tree/write-the-template-file.doc.mjs +154 -0
- package/assets/docs/typography.doc.mjs +24 -4
- package/assets/docs/working-with-ai.doc.mjs +30 -22
- package/assets/templates/blocks/components/InternationalizationProvider/InternationalizationProvider01ShippedLocale.tsx +1 -1
- package/authoring/config/config.doc.mjs +9 -1
- package/authoring/config/parse.d.mts +2 -0
- package/authoring/config/parse.mjs +19 -0
- package/authoring/config/parse.test.mjs +8 -0
- package/authoring/config/type.ts +11 -0
- 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 +3 -2
- package/authoring/doctypes/_schema.mjs +6 -0
- package/authoring/doctypes/base/graph-fields.doc.mjs +3 -3
- package/authoring/doctypes/base/type.ts +4 -2
- package/authoring/doctypes/component/component.doc.mjs +6 -0
- package/authoring/doctypes/component/type.ts +8 -0
- package/authoring/doctypes/reference/reference.doc.mjs +7 -0
- package/authoring/doctypes/reference/type.ts +5 -0
- package/authoring/doctypes/schema/schema.doc.mjs +2 -2
- package/authoring/doctypes/template/template.doc.mjs +1 -1
- package/authoring/doctypes/template/type.ts +2 -2
- package/authoring/index.d.mts +1 -0
- package/authoring/index.d.ts +10 -0
- package/authoring/index.mjs +1 -0
- package/authoring/integration/integration.doc.mjs +12 -10
- package/clients/cli/commands/component/index.mjs +152 -55
- package/clients/cli/commands/component-batch.test.mjs +341 -0
- package/clients/cli/commands/component-ownership.test.mjs +89 -0
- package/clients/cli/commands/component.doc.mjs +27 -9
- package/clients/cli/commands/discover.doc.mjs +53 -9
- package/clients/cli/commands/discover.mjs +393 -118
- package/clients/cli/commands/discover.sources.test.mjs +267 -0
- package/clients/cli/commands/docs.doc.mjs +1 -1
- package/clients/cli/commands/docs.mjs +60 -17
- package/clients/cli/commands/doctor-integration-docs.doc.mjs +3 -2
- package/clients/cli/commands/doctor-integration.test.mjs +53 -0
- package/clients/cli/commands/doctor.doc.mjs +3 -1
- package/clients/cli/commands/doctor.mjs +49 -5
- package/clients/cli/commands/gap-report.doc.mjs +10 -9
- package/clients/cli/commands/init.doc.mjs +9 -6
- package/clients/cli/commands/integration-add.doc.mjs +9 -9
- package/clients/cli/commands/integration-authoring.test.mjs +61 -10
- package/clients/cli/commands/integration-pack.doc.mjs +5 -9
- package/clients/cli/commands/integration-real-world.test.mjs +1 -1
- package/clients/cli/commands/integration-verify.doc.mjs +22 -0
- package/clients/cli/commands/integration.doc.mjs +4 -4
- package/clients/cli/commands/integration.mjs +74 -43
- package/clients/cli/commands/manifest.doc.mjs +1 -1
- package/clients/cli/commands/search.doc.mjs +10 -3
- package/clients/cli/commands/search.mjs +21 -2
- package/clients/cli/commands/search.test.mjs +21 -4
- package/clients/cli/commands/swizzle.doc.mjs +1 -1
- package/clients/cli/commands/template.doc.mjs +1 -1
- package/clients/cli/commands/text-json-parity.test.mjs +7 -1
- package/clients/cli/commands/theme-add.doc.mjs +1 -1
- package/clients/cli/commands/theme-palette-generate.doc.mjs +3 -2
- package/clients/cli/commands/theme-palette.doc.mjs +1 -2
- package/clients/cli/commands/theme-targets.doc.mjs +2 -2
- package/clients/cli/commands/theme.doc.mjs +2 -1
- package/clients/cli/commands/upgrade.doc.mjs +62 -3
- package/clients/cli/index.mjs +28 -6
- package/clients/cli/lib/define-command.mjs +28 -4
- package/clients/cli/lib/define-command.test.mjs +54 -0
- package/clients/cli/lib/exit-codes.test.mjs +17 -1
- package/clients/cli/lib/json-shim.mjs +24 -14
- package/clients/cli/lib/manifest.mjs +18 -5
- package/clients/cli/lib/manifest.test.mjs +5 -2
- package/clients/cli/lib/parse-error-format.test.mjs +81 -0
- package/foundation/agent-docs/agent-docs.mjs +1 -1
- package/foundation/discovery/authoring-self-docs.mjs +1 -0
- package/foundation/discovery/authoring-self-docs.test.mjs +6 -2
- package/foundation/discovery/cli-self-docs.mjs +16 -2
- package/foundation/discovery/cli-self-docs.test.mjs +20 -0
- package/foundation/discovery/docs-discovery.mjs +5 -1
- package/foundation/discovery/docs-discovery.test.mjs +21 -0
- package/foundation/discovery/docs-section-key.d.mts +1 -1
- package/foundation/discovery/docs-section-key.mjs +1 -1
- package/foundation/doc-compiler/doc-loads.test.mjs +3 -2
- package/foundation/doc-compiler/inputs.test.mjs +0 -1
- package/foundation/doc-compiler/tree.d.mts +4 -0
- package/foundation/doc-compiler/tree.mjs +6 -1
- package/foundation/integrations/cli-requirement.d.mts +26 -6
- package/foundation/integrations/cli-requirement.mjs +46 -11
- package/foundation/integrations/cli-requirement.test.mjs +7 -2
- package/foundation/integrations/contribution-inventory.mjs +1 -1
- package/foundation/integrations/integrations.d.mts +14 -1
- package/foundation/integrations/integrations.mjs +41 -1
- package/foundation/integrations/integrations.test.mjs +31 -0
- package/foundation/response/batch.type.d.mts +33 -0
- package/foundation/response/batch.type.mjs +34 -0
- package/foundation/response/error-codes.doc.mjs +6 -8
- package/foundation/response/error-codes.test.mjs +30 -5
- package/foundation/response/response-types.doc.d.mts +4 -3
- package/foundation/response/response-types.doc.mjs +40 -10
- package/foundation/response/response-types.doc.test.mjs +23 -0
- package/foundation/response/response.doc.mjs +11 -10
- package/package.json +9 -9
- package/api/docs/docs.test.mjs +0 -243
- package/api/docs/integration-tree.test.mjs +0 -555
- package/api/docs/integrationDocs.test.mjs +0 -314
- package/api/search/search.test.mjs +0 -512
- package/assets/docs/tree/integrations.test.mjs +0 -62
- package/assets/docs/tree/writing-docs.doc.mjs +0 -286
- package/clients/cli/commands/docs.test.mjs +0 -294
- package/foundation/agent-docs/agent-docs.test.mjs +0 -1159
- package/foundation/doc-compiler/tree.test.mjs +0 -598
|
@@ -0,0 +1,115 @@
|
|
|
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
|
+
* @typedef {import('./_adapter.mjs').InstalledPackage} InstalledPackage
|
|
6
|
+
* @typedef {import('./_adapter.mjs').CatalogResult} CatalogResult
|
|
7
|
+
* @typedef {CatalogResult['packages'][number]} CatalogPackage
|
|
8
|
+
* @typedef {import('../../authoring/discover/type').DiscoverKind} DiscoverKind
|
|
9
|
+
*/
|
|
10
|
+
/**
|
|
11
|
+
* An item search looks through. `kind: 'package'` is a package itself.
|
|
12
|
+
* @typedef {object} SearchItem
|
|
13
|
+
* @property {string} package
|
|
14
|
+
* @property {DiscoverKind | 'package'} kind
|
|
15
|
+
* @property {string} name
|
|
16
|
+
* @property {boolean} installed
|
|
17
|
+
* @property {string} [title]
|
|
18
|
+
* @property {string} [summary]
|
|
19
|
+
* @property {string[]} [keywords]
|
|
20
|
+
* @property {string} [description]
|
|
21
|
+
*/
|
|
22
|
+
/**
|
|
23
|
+
* Group a version's contributions into the entry fields, one list per kind.
|
|
24
|
+
* `components` is always present, like on an installed entry.
|
|
25
|
+
* @param {CatalogPackage['contributions']} contributions
|
|
26
|
+
* @returns {Record<string, string[]>}
|
|
27
|
+
*/
|
|
28
|
+
export function kindLists(contributions: CatalogPackage["contributions"]): Record<string, string[]>;
|
|
29
|
+
/**
|
|
30
|
+
* Whether an entry adds at least one item of `kind`.
|
|
31
|
+
* @param {Record<string, unknown>} entry
|
|
32
|
+
* @param {DiscoverKind} kind
|
|
33
|
+
* @returns {boolean}
|
|
34
|
+
*/
|
|
35
|
+
export function hasKind(entry: Record<string, unknown>, kind: DiscoverKind): boolean;
|
|
36
|
+
/**
|
|
37
|
+
* Where a catalog package stands against the project.
|
|
38
|
+
* @param {CatalogPackage} pkg
|
|
39
|
+
* @param {Set<string>} installedNames
|
|
40
|
+
* @param {Set<string>} declared
|
|
41
|
+
* @returns {{state: 'installed' | 'declared' | 'alias' | 'available', installedAs?: string}}
|
|
42
|
+
*/
|
|
43
|
+
export function catalogState(pkg: CatalogPackage, installedNames: Set<string>, declared: Set<string>): {
|
|
44
|
+
state: "installed" | "declared" | "alias" | "available";
|
|
45
|
+
installedAs?: string;
|
|
46
|
+
};
|
|
47
|
+
/**
|
|
48
|
+
* The version a catalog package shows by default.
|
|
49
|
+
* @param {CatalogPackage} pkg
|
|
50
|
+
* @returns {string | undefined}
|
|
51
|
+
*/
|
|
52
|
+
export function defaultVersion(pkg: CatalogPackage): string | undefined;
|
|
53
|
+
/**
|
|
54
|
+
* Project a catalog package into the entry shape installed packages use.
|
|
55
|
+
* @param {CatalogPackage} pkg
|
|
56
|
+
* @param {string | undefined} version
|
|
57
|
+
*/
|
|
58
|
+
export function catalogEntry(pkg: CatalogPackage, version: string | undefined): {
|
|
59
|
+
description?: string | undefined;
|
|
60
|
+
version?: string | undefined;
|
|
61
|
+
name: string;
|
|
62
|
+
category: string;
|
|
63
|
+
components: string[];
|
|
64
|
+
};
|
|
65
|
+
/**
|
|
66
|
+
* What the project could add: every catalog package it does not have, once per
|
|
67
|
+
* integration (the first name a source lists), never an alias of one it has.
|
|
68
|
+
* @param {CatalogResult} catalog
|
|
69
|
+
* @param {InstalledPackage[]} installed
|
|
70
|
+
* @param {Set<string>} declared
|
|
71
|
+
*/
|
|
72
|
+
export function availableEntries(catalog: CatalogResult, installed: InstalledPackage[], declared: Set<string>): {
|
|
73
|
+
source: string;
|
|
74
|
+
aliases?: string[] | undefined;
|
|
75
|
+
description?: string | undefined;
|
|
76
|
+
version?: string | undefined;
|
|
77
|
+
name: string;
|
|
78
|
+
components: string[];
|
|
79
|
+
}[];
|
|
80
|
+
/**
|
|
81
|
+
* Installed packages with the latest release a source knows for each.
|
|
82
|
+
* @param {InstalledPackage[]} installed
|
|
83
|
+
* @param {CatalogResult} catalog
|
|
84
|
+
* @returns {Array<InstalledPackage & {latest?: string}>}
|
|
85
|
+
*/
|
|
86
|
+
export function withLatest(installed: InstalledPackage[], catalog: CatalogResult): Array<InstalledPackage & {
|
|
87
|
+
latest?: string;
|
|
88
|
+
}>;
|
|
89
|
+
/**
|
|
90
|
+
* Everything search looks through besides installed components (which the
|
|
91
|
+
* search leaf keeps resolving the way it always has): installed packages and
|
|
92
|
+
* their other items, and every package the project could add with its items.
|
|
93
|
+
* @param {InstalledPackage[]} installed
|
|
94
|
+
* @param {CatalogResult} catalog
|
|
95
|
+
* @param {Set<string>} declared
|
|
96
|
+
* @returns {SearchItem[]}
|
|
97
|
+
*/
|
|
98
|
+
export function searchItems(installed: InstalledPackage[], catalog: CatalogResult, declared: Set<string>): SearchItem[];
|
|
99
|
+
export type InstalledPackage = import("./_adapter.mjs").InstalledPackage;
|
|
100
|
+
export type CatalogResult = import("./_adapter.mjs").CatalogResult;
|
|
101
|
+
export type CatalogPackage = CatalogResult["packages"][number];
|
|
102
|
+
export type DiscoverKind = import("../../authoring/discover/type").DiscoverKind;
|
|
103
|
+
/**
|
|
104
|
+
* An item search looks through. `kind: 'package'` is a package itself.
|
|
105
|
+
*/
|
|
106
|
+
export type SearchItem = {
|
|
107
|
+
package: string;
|
|
108
|
+
kind: DiscoverKind | "package";
|
|
109
|
+
name: string;
|
|
110
|
+
installed: boolean;
|
|
111
|
+
title?: string | undefined;
|
|
112
|
+
summary?: string | undefined;
|
|
113
|
+
keywords?: string[] | undefined;
|
|
114
|
+
description?: string | undefined;
|
|
115
|
+
};
|
|
@@ -0,0 +1,203 @@
|
|
|
1
|
+
// Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* @file Pure views over discover sources' catalogs: which catalog packages the
|
|
5
|
+
* project already has, what it could add, and the items search looks through.
|
|
6
|
+
* No I/O; the adapter supplies every input.
|
|
7
|
+
*
|
|
8
|
+
* @position api/discover — shared by the list, detail, item, and search leaves.
|
|
9
|
+
*/
|
|
10
|
+
|
|
11
|
+
import {KIND_FIELDS} from './_adapter.mjs';
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* @typedef {import('./_adapter.mjs').InstalledPackage} InstalledPackage
|
|
15
|
+
* @typedef {import('./_adapter.mjs').CatalogResult} CatalogResult
|
|
16
|
+
* @typedef {CatalogResult['packages'][number]} CatalogPackage
|
|
17
|
+
* @typedef {import('../../authoring/discover/type').DiscoverKind} DiscoverKind
|
|
18
|
+
*/
|
|
19
|
+
|
|
20
|
+
/**
|
|
21
|
+
* An item search looks through. `kind: 'package'` is a package itself.
|
|
22
|
+
* @typedef {object} SearchItem
|
|
23
|
+
* @property {string} package
|
|
24
|
+
* @property {DiscoverKind | 'package'} kind
|
|
25
|
+
* @property {string} name
|
|
26
|
+
* @property {boolean} installed
|
|
27
|
+
* @property {string} [title]
|
|
28
|
+
* @property {string} [summary]
|
|
29
|
+
* @property {string[]} [keywords]
|
|
30
|
+
* @property {string} [description]
|
|
31
|
+
*/
|
|
32
|
+
|
|
33
|
+
/**
|
|
34
|
+
* Group a version's contributions into the entry fields, one list per kind.
|
|
35
|
+
* `components` is always present, like on an installed entry.
|
|
36
|
+
* @param {CatalogPackage['contributions']} contributions
|
|
37
|
+
* @returns {Record<string, string[]>}
|
|
38
|
+
*/
|
|
39
|
+
export function kindLists(contributions) {
|
|
40
|
+
/** @type {Record<string, string[]>} */
|
|
41
|
+
const lists = {components: []};
|
|
42
|
+
for (const [kind, field] of KIND_FIELDS) {
|
|
43
|
+
const names = contributions.filter(c => c.kind === kind).map(c => c.name);
|
|
44
|
+
if (names.length > 0 || field === 'components') lists[field] = names;
|
|
45
|
+
}
|
|
46
|
+
return lists;
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
/**
|
|
50
|
+
* Whether an entry adds at least one item of `kind`.
|
|
51
|
+
* @param {Record<string, unknown>} entry
|
|
52
|
+
* @param {DiscoverKind} kind
|
|
53
|
+
* @returns {boolean}
|
|
54
|
+
*/
|
|
55
|
+
export function hasKind(entry, kind) {
|
|
56
|
+
const field = KIND_FIELDS.find(([k]) => k === kind)?.[1];
|
|
57
|
+
const values = field == null ? undefined : entry[field];
|
|
58
|
+
return Array.isArray(values) && values.length > 0;
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
/**
|
|
62
|
+
* Where a catalog package stands against the project.
|
|
63
|
+
* @param {CatalogPackage} pkg
|
|
64
|
+
* @param {Set<string>} installedNames
|
|
65
|
+
* @param {Set<string>} declared
|
|
66
|
+
* @returns {{state: 'installed' | 'declared' | 'alias' | 'available', installedAs?: string}}
|
|
67
|
+
*/
|
|
68
|
+
export function catalogState(pkg, installedNames, declared) {
|
|
69
|
+
if (installedNames.has(pkg.package)) return {state: 'installed'};
|
|
70
|
+
if (declared.has(pkg.package)) return {state: 'declared'};
|
|
71
|
+
const installedAs = pkg.aliases.find(
|
|
72
|
+
name => installedNames.has(name) || declared.has(name),
|
|
73
|
+
);
|
|
74
|
+
if (installedAs != null) return {state: 'alias', installedAs};
|
|
75
|
+
return {state: 'available'};
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
/**
|
|
79
|
+
* The version a catalog package shows by default.
|
|
80
|
+
* @param {CatalogPackage} pkg
|
|
81
|
+
* @returns {string | undefined}
|
|
82
|
+
*/
|
|
83
|
+
export function defaultVersion(pkg) {
|
|
84
|
+
return pkg.latest ?? pkg.versions[0]?.version;
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
/**
|
|
88
|
+
* Project a catalog package into the entry shape installed packages use.
|
|
89
|
+
* @param {CatalogPackage} pkg
|
|
90
|
+
* @param {string | undefined} version
|
|
91
|
+
*/
|
|
92
|
+
export function catalogEntry(pkg, version) {
|
|
93
|
+
const {components, ...others} = kindLists(pkg.contributions);
|
|
94
|
+
return {
|
|
95
|
+
name: pkg.package,
|
|
96
|
+
category: pkg.package,
|
|
97
|
+
components,
|
|
98
|
+
...(version ? {version} : {}),
|
|
99
|
+
...(pkg.description ? {description: pkg.description} : {}),
|
|
100
|
+
...others,
|
|
101
|
+
};
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
/**
|
|
105
|
+
* What the project could add: every catalog package it does not have, once per
|
|
106
|
+
* integration (the first name a source lists), never an alias of one it has.
|
|
107
|
+
* @param {CatalogResult} catalog
|
|
108
|
+
* @param {InstalledPackage[]} installed
|
|
109
|
+
* @param {Set<string>} declared
|
|
110
|
+
*/
|
|
111
|
+
export function availableEntries(catalog, installed, declared) {
|
|
112
|
+
const installedNames = new Set(installed.map(p => p.name));
|
|
113
|
+
/** @type {Set<string>} */
|
|
114
|
+
const integrations = new Set();
|
|
115
|
+
const entries = [];
|
|
116
|
+
for (const pkg of catalog.packages) {
|
|
117
|
+
if (catalogState(pkg, installedNames, declared).state !== 'available')
|
|
118
|
+
continue;
|
|
119
|
+
if (integrations.has(pkg.integration)) continue;
|
|
120
|
+
integrations.add(pkg.integration);
|
|
121
|
+
const version = defaultVersion(pkg);
|
|
122
|
+
const {category: _category, ...entry} = catalogEntry(pkg, version);
|
|
123
|
+
entries.push({
|
|
124
|
+
...entry,
|
|
125
|
+
...(pkg.aliases.length > 0 ? {aliases: pkg.aliases} : {}),
|
|
126
|
+
source: pkg.source,
|
|
127
|
+
});
|
|
128
|
+
}
|
|
129
|
+
return entries;
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
/**
|
|
133
|
+
* Installed packages with the latest release a source knows for each.
|
|
134
|
+
* @param {InstalledPackage[]} installed
|
|
135
|
+
* @param {CatalogResult} catalog
|
|
136
|
+
* @returns {Array<InstalledPackage & {latest?: string}>}
|
|
137
|
+
*/
|
|
138
|
+
export function withLatest(installed, catalog) {
|
|
139
|
+
const byName = new Map(catalog.packages.map(p => [p.package, p]));
|
|
140
|
+
return installed.map(pkg => {
|
|
141
|
+
const latest = byName.get(pkg.name)?.latest;
|
|
142
|
+
return latest ? {...pkg, latest} : pkg;
|
|
143
|
+
});
|
|
144
|
+
}
|
|
145
|
+
|
|
146
|
+
/**
|
|
147
|
+
* Everything search looks through besides installed components (which the
|
|
148
|
+
* search leaf keeps resolving the way it always has): installed packages and
|
|
149
|
+
* their other items, and every package the project could add with its items.
|
|
150
|
+
* @param {InstalledPackage[]} installed
|
|
151
|
+
* @param {CatalogResult} catalog
|
|
152
|
+
* @param {Set<string>} declared
|
|
153
|
+
* @returns {SearchItem[]}
|
|
154
|
+
*/
|
|
155
|
+
export function searchItems(installed, catalog, declared) {
|
|
156
|
+
/** @type {SearchItem[]} */
|
|
157
|
+
const items = [];
|
|
158
|
+
for (const pkg of installed) {
|
|
159
|
+
items.push({
|
|
160
|
+
package: pkg.name,
|
|
161
|
+
kind: 'package',
|
|
162
|
+
name: pkg.name,
|
|
163
|
+
installed: true,
|
|
164
|
+
...(pkg.description ? {description: pkg.description} : {}),
|
|
165
|
+
});
|
|
166
|
+
for (const [kind, field] of KIND_FIELDS) {
|
|
167
|
+
if (kind === 'component') continue;
|
|
168
|
+
const names = /** @type {Record<string, unknown>} */ (pkg)[field];
|
|
169
|
+
if (!Array.isArray(names)) continue;
|
|
170
|
+
for (const name of names) {
|
|
171
|
+
items.push({package: pkg.name, kind, name, installed: true});
|
|
172
|
+
}
|
|
173
|
+
}
|
|
174
|
+
}
|
|
175
|
+
const installedNames = new Set(installed.map(p => p.name));
|
|
176
|
+
/** @type {Set<string>} */
|
|
177
|
+
const integrations = new Set();
|
|
178
|
+
for (const pkg of catalog.packages) {
|
|
179
|
+
if (catalogState(pkg, installedNames, declared).state !== 'available')
|
|
180
|
+
continue;
|
|
181
|
+
if (integrations.has(pkg.integration)) continue;
|
|
182
|
+
integrations.add(pkg.integration);
|
|
183
|
+
items.push({
|
|
184
|
+
package: pkg.package,
|
|
185
|
+
kind: 'package',
|
|
186
|
+
name: pkg.package,
|
|
187
|
+
installed: false,
|
|
188
|
+
...(pkg.description ? {description: pkg.description} : {}),
|
|
189
|
+
});
|
|
190
|
+
for (const c of pkg.contributions) {
|
|
191
|
+
items.push({
|
|
192
|
+
package: pkg.package,
|
|
193
|
+
kind: c.kind,
|
|
194
|
+
name: c.name,
|
|
195
|
+
installed: false,
|
|
196
|
+
...(c.title ? {title: c.title} : {}),
|
|
197
|
+
...(c.summary ? {summary: c.summary} : {}),
|
|
198
|
+
...(c.keywords ? {keywords: c.keywords} : {}),
|
|
199
|
+
});
|
|
200
|
+
}
|
|
201
|
+
}
|
|
202
|
+
return items;
|
|
203
|
+
}
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
// Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* @file Tests for the pure views over discover sources' catalogs.
|
|
5
|
+
*/
|
|
6
|
+
|
|
7
|
+
import {describe, expect, it} from 'vitest';
|
|
8
|
+
import {
|
|
9
|
+
availableEntries,
|
|
10
|
+
catalogState,
|
|
11
|
+
kindLists,
|
|
12
|
+
searchItems,
|
|
13
|
+
withLatest,
|
|
14
|
+
} from './_catalog-view.mjs';
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
* @param {string} name
|
|
18
|
+
* @param {string} integration
|
|
19
|
+
* @param {object} [extra]
|
|
20
|
+
* @returns {any}
|
|
21
|
+
*/
|
|
22
|
+
function entry(name, integration, extra = {}) {
|
|
23
|
+
return {
|
|
24
|
+
package: name,
|
|
25
|
+
integration,
|
|
26
|
+
aliases: [],
|
|
27
|
+
latest: '1.0.0',
|
|
28
|
+
versions: [],
|
|
29
|
+
contributions: [{kind: 'component', name: 'A'}],
|
|
30
|
+
source: 'S',
|
|
31
|
+
...extra,
|
|
32
|
+
};
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
const CATALOG = {
|
|
36
|
+
sources: [],
|
|
37
|
+
packages: [
|
|
38
|
+
entry('@acme/ui', 'acme-ui', {aliases: ['@acme/ui-classic']}),
|
|
39
|
+
entry('@acme/ui-classic', 'acme-ui', {aliases: ['@acme/ui']}),
|
|
40
|
+
entry('@acme/charts', 'charts', {
|
|
41
|
+
latest: '2.0.0',
|
|
42
|
+
contributions: [{kind: 'theme', name: 'ocean'}],
|
|
43
|
+
}),
|
|
44
|
+
],
|
|
45
|
+
};
|
|
46
|
+
|
|
47
|
+
/** @param {string} name @returns {any} */
|
|
48
|
+
const installed = name => ({name, category: name, components: []});
|
|
49
|
+
|
|
50
|
+
describe('availableEntries', () => {
|
|
51
|
+
it('offers each integration once, under the first name a source lists', () => {
|
|
52
|
+
expect(
|
|
53
|
+
availableEntries(CATALOG, [], new Set()).map(e => [e.name, e.aliases]),
|
|
54
|
+
).toEqual([
|
|
55
|
+
['@acme/ui', ['@acme/ui-classic']],
|
|
56
|
+
['@acme/charts', undefined],
|
|
57
|
+
]);
|
|
58
|
+
});
|
|
59
|
+
|
|
60
|
+
it('never offers an integration the project has under another name', () => {
|
|
61
|
+
expect(
|
|
62
|
+
availableEntries(CATALOG, [installed('@acme/ui-classic')], new Set()).map(
|
|
63
|
+
e => e.name,
|
|
64
|
+
),
|
|
65
|
+
).toEqual(['@acme/charts']);
|
|
66
|
+
});
|
|
67
|
+
|
|
68
|
+
it('does not offer a package the project declares, even when it did not load', () => {
|
|
69
|
+
expect(
|
|
70
|
+
availableEntries(CATALOG, [], new Set(['@acme/charts'])).map(e => e.name),
|
|
71
|
+
).toEqual(['@acme/ui']);
|
|
72
|
+
});
|
|
73
|
+
|
|
74
|
+
it('describes an entry the way an installed one is described', () => {
|
|
75
|
+
expect(availableEntries(CATALOG, [], new Set())[1]).toEqual({
|
|
76
|
+
name: '@acme/charts',
|
|
77
|
+
components: [],
|
|
78
|
+
version: '2.0.0',
|
|
79
|
+
themes: ['ocean'],
|
|
80
|
+
source: 'S',
|
|
81
|
+
});
|
|
82
|
+
});
|
|
83
|
+
});
|
|
84
|
+
|
|
85
|
+
describe('catalogState', () => {
|
|
86
|
+
it('names the package the project has instead', () => {
|
|
87
|
+
expect(
|
|
88
|
+
catalogState(CATALOG.packages[0], new Set(['@acme/ui-classic']), new Set()),
|
|
89
|
+
).toEqual({state: 'alias', installedAs: '@acme/ui-classic'});
|
|
90
|
+
});
|
|
91
|
+
});
|
|
92
|
+
|
|
93
|
+
describe('withLatest', () => {
|
|
94
|
+
it('adds the latest release a source knows to an installed package', () => {
|
|
95
|
+
expect(withLatest([installed('@acme/charts')], CATALOG)[0]).toMatchObject({
|
|
96
|
+
latest: '2.0.0',
|
|
97
|
+
});
|
|
98
|
+
});
|
|
99
|
+
});
|
|
100
|
+
|
|
101
|
+
describe('kindLists', () => {
|
|
102
|
+
it('groups items by kind, always with components', () => {
|
|
103
|
+
expect(
|
|
104
|
+
kindLists([
|
|
105
|
+
{kind: 'theme', name: 'ocean'},
|
|
106
|
+
{kind: 'component', name: 'A'},
|
|
107
|
+
]),
|
|
108
|
+
).toEqual({components: ['A'], themes: ['ocean']});
|
|
109
|
+
});
|
|
110
|
+
});
|
|
111
|
+
|
|
112
|
+
describe('searchItems', () => {
|
|
113
|
+
it('covers installed packages and their other items, then what could be added', () => {
|
|
114
|
+
const items = searchItems(
|
|
115
|
+
[{...installed('@acme/widgets'), templates: ['pages/Home']}],
|
|
116
|
+
CATALOG,
|
|
117
|
+
new Set(),
|
|
118
|
+
);
|
|
119
|
+
expect(items.map(i => [i.package, i.kind, i.name, i.installed])).toEqual([
|
|
120
|
+
['@acme/widgets', 'package', '@acme/widgets', true],
|
|
121
|
+
['@acme/widgets', 'template', 'pages/Home', true],
|
|
122
|
+
['@acme/ui', 'package', '@acme/ui', false],
|
|
123
|
+
['@acme/ui', 'component', 'A', false],
|
|
124
|
+
['@acme/charts', 'package', '@acme/charts', false],
|
|
125
|
+
['@acme/charts', 'theme', 'ocean', false],
|
|
126
|
+
]);
|
|
127
|
+
});
|
|
128
|
+
});
|
|
@@ -2,12 +2,24 @@
|
|
|
2
2
|
// DO NOT EDIT — run `pnpm sync:api-types` to regenerate.
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
|
-
* Build the discover.detail response for
|
|
6
|
-
*
|
|
7
|
-
*
|
|
5
|
+
* Build the discover.detail response for one package. The project's installed
|
|
6
|
+
* copy describes itself; any other version is described by its source. For a
|
|
7
|
+
* package the project does not have, `install` is the package-manager command
|
|
8
|
+
* that adds it — printed, never run.
|
|
8
9
|
*
|
|
9
|
-
* @param {import('../
|
|
10
|
-
* @param {string}
|
|
10
|
+
* @param {import('../_adapter.mjs').InstalledPackage[]} packages
|
|
11
|
+
* @param {string} name package name, e.g. `@scope/name`
|
|
12
|
+
* @param {{
|
|
13
|
+
* catalog?: import('../_catalog-view.mjs').CatalogPackage,
|
|
14
|
+
* version?: string,
|
|
15
|
+
* add?: (name: string, version?: string) => string,
|
|
16
|
+
* installedAs?: string,
|
|
17
|
+
* }} [options]
|
|
11
18
|
* @returns {import('../discover.type.mjs').DiscoverDetailResponse}
|
|
12
19
|
*/
|
|
13
|
-
export function detail(packages: import("../
|
|
20
|
+
export function detail(packages: import("../_adapter.mjs").InstalledPackage[], name: string, options?: {
|
|
21
|
+
catalog?: import("../_catalog-view.mjs").CatalogPackage;
|
|
22
|
+
version?: string;
|
|
23
|
+
add?: (name: string, version?: string) => string;
|
|
24
|
+
installedAs?: string;
|
|
25
|
+
}): import("../discover.type.mjs").DiscoverDetailResponse;
|
|
@@ -1,33 +1,87 @@
|
|
|
1
1
|
// Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
-
* @file discover.detail leaf —
|
|
4
|
+
* @file discover.detail leaf — one package: what it adds, and, when a discover
|
|
5
|
+
* source knows it, every version and the latest one.
|
|
5
6
|
*
|
|
6
|
-
* @position api/discover/detail — pure projection over the packages
|
|
7
|
-
* ../_adapter; throws AstryxError (ERR_UNKNOWN_PACKAGE) for
|
|
7
|
+
* @position api/discover/detail — pure projection over the packages and catalog
|
|
8
|
+
* entry resolved by ../_adapter; throws AstryxError (ERR_UNKNOWN_PACKAGE) for
|
|
9
|
+
* a package neither the project nor any source knows.
|
|
8
10
|
*/
|
|
9
11
|
|
|
10
12
|
import {toEntry} from '../_adapter.mjs';
|
|
13
|
+
import {catalogEntry, defaultVersion} from '../_catalog-view.mjs';
|
|
11
14
|
import {AstryxError} from '../../error.mjs';
|
|
12
15
|
import {ERROR_CODES} from '../../../foundation/response/error-codes.mjs';
|
|
13
16
|
|
|
14
17
|
/**
|
|
15
|
-
* Build the discover.detail response for
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
+
* Build the discover.detail response for one package. The project's installed
|
|
19
|
+
* copy describes itself; any other version is described by its source. For a
|
|
20
|
+
* package the project does not have, `install` is the package-manager command
|
|
21
|
+
* that adds it — printed, never run.
|
|
18
22
|
*
|
|
19
|
-
* @param {import('../
|
|
20
|
-
* @param {string}
|
|
23
|
+
* @param {import('../_adapter.mjs').InstalledPackage[]} packages
|
|
24
|
+
* @param {string} name package name, e.g. `@scope/name`
|
|
25
|
+
* @param {{
|
|
26
|
+
* catalog?: import('../_catalog-view.mjs').CatalogPackage,
|
|
27
|
+
* version?: string,
|
|
28
|
+
* add?: (name: string, version?: string) => string,
|
|
29
|
+
* installedAs?: string,
|
|
30
|
+
* }} [options]
|
|
21
31
|
* @returns {import('../discover.type.mjs').DiscoverDetailResponse}
|
|
22
32
|
*/
|
|
23
|
-
export function detail(packages,
|
|
24
|
-
const
|
|
25
|
-
|
|
33
|
+
export function detail(packages, name, options = {}) {
|
|
34
|
+
const {catalog, version, add, installedAs} = options;
|
|
35
|
+
const pkg = packages.find(p => p.name === name);
|
|
36
|
+
if (!pkg && !catalog) {
|
|
26
37
|
throw new AstryxError(
|
|
27
|
-
`Package "${
|
|
38
|
+
`Package "${name}" not found`,
|
|
28
39
|
packages.map(p => ({name: p.name, reason: 'available package'})),
|
|
29
40
|
ERROR_CODES.ERR_UNKNOWN_PACKAGE,
|
|
30
41
|
);
|
|
31
42
|
}
|
|
32
|
-
|
|
43
|
+
|
|
44
|
+
const known = new Set([
|
|
45
|
+
...(catalog?.versions.map(v => v.version) ?? []),
|
|
46
|
+
...(pkg?.version ? [pkg.version] : []),
|
|
47
|
+
]);
|
|
48
|
+
if (version && !known.has(version)) {
|
|
49
|
+
const releases = catalog?.versions.filter(v => !v.prerelease) ?? [];
|
|
50
|
+
throw new AstryxError(
|
|
51
|
+
`Version "${version}" of ${name} not found`,
|
|
52
|
+
(releases.length > 0 ? releases.map(v => v.version) : [...known])
|
|
53
|
+
.slice(0, 5)
|
|
54
|
+
.map(v => ({name: `${name}@${v}`, reason: 'published version'})),
|
|
55
|
+
ERROR_CODES.ERR_NOT_FOUND,
|
|
56
|
+
);
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
const local = pkg != null && (!version || version === pkg.version);
|
|
60
|
+
/** @type {Record<string, unknown>} */
|
|
61
|
+
const data = local
|
|
62
|
+
? {...toEntry(pkg), installed: true}
|
|
63
|
+
: {
|
|
64
|
+
...catalogEntry(
|
|
65
|
+
/** @type {NonNullable<typeof catalog>} */ (catalog),
|
|
66
|
+
version ?? defaultVersion(/** @type {NonNullable<typeof catalog>} */ (catalog)),
|
|
67
|
+
),
|
|
68
|
+
installed: pkg != null,
|
|
69
|
+
...(pkg?.version ? {installedVersion: pkg.version} : {}),
|
|
70
|
+
};
|
|
71
|
+
if (catalog) {
|
|
72
|
+
if (catalog.latest) data.latest = catalog.latest;
|
|
73
|
+
if (catalog.aliases.length > 0) data.aliases = catalog.aliases;
|
|
74
|
+
data.source = catalog.source;
|
|
75
|
+
}
|
|
76
|
+
if (!pkg) {
|
|
77
|
+
if (installedAs) data.installedAs = installedAs;
|
|
78
|
+
else if (add) data.install = add(name, version);
|
|
79
|
+
}
|
|
80
|
+
if (catalog) data.versions = catalog.versions;
|
|
81
|
+
return {
|
|
82
|
+
type: 'discover.detail',
|
|
83
|
+
data: /** @type {import('../discover.type.mjs').DiscoverDetailResponse['data']} */ (
|
|
84
|
+
data
|
|
85
|
+
),
|
|
86
|
+
};
|
|
33
87
|
}
|
|
@@ -36,6 +36,7 @@ describe('discover.detail leaf', () => {
|
|
|
36
36
|
category: '@acme/widgets',
|
|
37
37
|
components: ['Alpha', 'Beta'],
|
|
38
38
|
version: '1.2.3',
|
|
39
|
+
installed: true,
|
|
39
40
|
});
|
|
40
41
|
});
|
|
41
42
|
|
|
@@ -55,3 +56,87 @@ describe('discover.detail leaf', () => {
|
|
|
55
56
|
]);
|
|
56
57
|
});
|
|
57
58
|
});
|
|
59
|
+
|
|
60
|
+
describe('discover.detail leaf with a discover source', () => {
|
|
61
|
+
/** @type {any} */
|
|
62
|
+
const catalog = {
|
|
63
|
+
package: '@acme/charts',
|
|
64
|
+
integration: 'acme-charts',
|
|
65
|
+
aliases: ['@acme/charts-legacy'],
|
|
66
|
+
latest: '2.0.0',
|
|
67
|
+
source: 'Acme',
|
|
68
|
+
versions: [
|
|
69
|
+
{version: '2.1.0-beta.1', publishedAt: '2026-09-30T00:00:00.000Z', prerelease: true, status: 'ok'},
|
|
70
|
+
{version: '2.0.0', publishedAt: '2026-09-20T00:00:00.000Z', prerelease: false, status: 'ok'},
|
|
71
|
+
{version: '1.0.0', publishedAt: null, prerelease: false, status: 'manifest_load_error'},
|
|
72
|
+
],
|
|
73
|
+
contributions: [
|
|
74
|
+
{kind: 'component', name: 'Chart'},
|
|
75
|
+
{kind: 'template', name: 'pages/Report'},
|
|
76
|
+
],
|
|
77
|
+
};
|
|
78
|
+
/** @param {string} name @param {string} [version] */
|
|
79
|
+
const add = (name, version) => `pnpm add ${version ? `${name}@${version}` : name}`;
|
|
80
|
+
|
|
81
|
+
it('describes a package the project does not have, with the command that adds it', () => {
|
|
82
|
+
expect(detail(PACKAGES, '@acme/charts', {catalog, add}).data).toEqual({
|
|
83
|
+
name: '@acme/charts',
|
|
84
|
+
category: '@acme/charts',
|
|
85
|
+
components: ['Chart'],
|
|
86
|
+
version: '2.0.0',
|
|
87
|
+
templates: ['pages/Report'],
|
|
88
|
+
installed: false,
|
|
89
|
+
latest: '2.0.0',
|
|
90
|
+
aliases: ['@acme/charts-legacy'],
|
|
91
|
+
source: 'Acme',
|
|
92
|
+
install: 'pnpm add @acme/charts',
|
|
93
|
+
versions: catalog.versions,
|
|
94
|
+
});
|
|
95
|
+
});
|
|
96
|
+
|
|
97
|
+
it('describes any version, prereleases included', () => {
|
|
98
|
+
const {data} = detail(PACKAGES, '@acme/charts', {catalog, add, version: '2.1.0-beta.1'});
|
|
99
|
+
expect(data.version).toBe('2.1.0-beta.1');
|
|
100
|
+
expect(data.install).toBe('pnpm add @acme/charts@2.1.0-beta.1');
|
|
101
|
+
});
|
|
102
|
+
|
|
103
|
+
it('refuses a version that was never published, and suggests releases', () => {
|
|
104
|
+
let err;
|
|
105
|
+
try {
|
|
106
|
+
detail(PACKAGES, '@acme/charts', {catalog, add, version: '3.0.0'});
|
|
107
|
+
} catch (e) {
|
|
108
|
+
err = e;
|
|
109
|
+
}
|
|
110
|
+
expect(err).toBeInstanceOf(AstryxError);
|
|
111
|
+
expect(err.code).toBe('ERR_NOT_FOUND');
|
|
112
|
+
expect(err.suggestions.map(s => s.name)).toEqual([
|
|
113
|
+
'@acme/charts@2.0.0',
|
|
114
|
+
'@acme/charts@1.0.0',
|
|
115
|
+
]);
|
|
116
|
+
});
|
|
117
|
+
|
|
118
|
+
it('names the package the project has instead of offering an alias', () => {
|
|
119
|
+
const {data} = detail(PACKAGES, '@acme/charts', {
|
|
120
|
+
catalog,
|
|
121
|
+
add,
|
|
122
|
+
installedAs: '@acme/charts-legacy',
|
|
123
|
+
});
|
|
124
|
+
expect(data.installedAs).toBe('@acme/charts-legacy');
|
|
125
|
+
expect(data).not.toHaveProperty('install');
|
|
126
|
+
});
|
|
127
|
+
|
|
128
|
+
it("keeps describing the installed copy from the project, with the source's versions", () => {
|
|
129
|
+
const {data} = detail(PACKAGES, '@acme/widgets', {
|
|
130
|
+
catalog: {...catalog, package: '@acme/widgets', latest: '1.3.0'},
|
|
131
|
+
add,
|
|
132
|
+
});
|
|
133
|
+
expect(data).toMatchObject({
|
|
134
|
+
name: '@acme/widgets',
|
|
135
|
+
components: ['Alpha', 'Beta'],
|
|
136
|
+
version: '1.2.3',
|
|
137
|
+
installed: true,
|
|
138
|
+
latest: '1.3.0',
|
|
139
|
+
});
|
|
140
|
+
expect(data).not.toHaveProperty('install');
|
|
141
|
+
});
|
|
142
|
+
});
|