@astryxdesign/cli 0.6.3-canary.f839b67 → 0.6.4-canary.06c8fa3

package/api/discover/list/list.d.mts

@@ -2,14 +2,28 @@
 // DO NOT EDIT — run `pnpm sync:api-types` to regenerate.
 
 /**
- * Build the discover.list response. An empty `packages` set produces the empty
- * envelope carrying `meta.configured`, so callers can distinguish "nothing
- * configured" from "configured but nothing discovered".
+ * Build the discover.list response. `data` lists installed integrations. An
+ * empty `data` carries `meta.configured`, so callers can distinguish "nothing
+ * configured" from "configured but nothing discovered". With discover sources,
+ * `meta.available` lists what the project could add and `meta.sources` reports
+ * what each source did.
  *
- * @param {import('../_package-scanner.mjs').ScannedPackage[]} packages
- * @param {{configured: boolean}} meta
+ * @param {Array<import('../_adapter.mjs').InstalledPackage & {latest?: string}>} packages
+ * @param {{
+ *   configured: boolean,
+ *   available?: Array<Record<string, unknown>>,
+ *   sources?: import('../_adapter.mjs').SourceState[],
+ *   type?: import('../../../authoring/discover/type').DiscoverKind,
+ *   only?: 'installed' | 'available',
+ * }} options
  * @returns {import('../discover.type.mjs').DiscoverListResponse}
  */
-export function list(packages: import("../_package-scanner.mjs").ScannedPackage[], { configured }: {
+export function list(packages: Array<import("../_adapter.mjs").InstalledPackage & {
+    latest?: string;
+}>, { configured, available, sources, type, only }: {
     configured: boolean;
+    available?: Array<Record<string, unknown>>;
+    sources?: import("../_adapter.mjs").SourceState[];
+    type?: import("../../../authoring/discover/type").DiscoverKind;
+    only?: "installed" | "available";
 }): import("../discover.type.mjs").DiscoverListResponse;

package/api/discover/list/list.mjs

@@ -1,26 +1,59 @@
 // Copyright (c) Meta Platforms, Inc. and affiliates.
 
 /**
- * @file discover.list leaf — list the discovered external packages.
+ * @file discover.list leaf — the integrations the project has, and, when it has
+ * discover sources, the ones it could add.
  *
- * @position api/discover/list — pure projection of the packages resolved by
- *   ../_adapter into the discover.list envelope.
+ * @position api/discover/list — pure projection of the packages and catalog
+ *   resolved by ../_adapter into the discover.list envelope.
  */
 
 import {toEntry} from '../_adapter.mjs';
+import {hasKind} from '../_catalog-view.mjs';
 
 /**
- * Build the discover.list response. An empty `packages` set produces the empty
- * envelope carrying `meta.configured`, so callers can distinguish "nothing
- * configured" from "configured but nothing discovered".
+ * Build the discover.list response. `data` lists installed integrations. An
+ * empty `data` carries `meta.configured`, so callers can distinguish "nothing
+ * configured" from "configured but nothing discovered". With discover sources,
+ * `meta.available` lists what the project could add and `meta.sources` reports
+ * what each source did.
  *
- * @param {import('../_package-scanner.mjs').ScannedPackage[]} packages
- * @param {{configured: boolean}} meta
+ * @param {Array<import('../_adapter.mjs').InstalledPackage & {latest?: string}>} packages
+ * @param {{
+ *   configured: boolean,
+ *   available?: Array<Record<string, unknown>>,
+ *   sources?: import('../_adapter.mjs').SourceState[],
+ *   type?: import('../../../authoring/discover/type').DiscoverKind,
+ *   only?: 'installed' | 'available',
+ * }} options
  * @returns {import('../discover.type.mjs').DiscoverListResponse}
  */
-export function list(packages, {configured}) {
-  if (packages.length === 0) {
-    return {type: 'discover.list', data: [], meta: {configured}};
+export function list(packages, {configured, available, sources, type, only}) {
+  const keep = (/** @type {Record<string, unknown>} */ entry) =>
+    type == null || hasKind(entry, type);
+  const data =
+    only === 'available'
+      ? []
+      : packages
+          .map(toEntry)
+          .filter(entry =>
+            keep(/** @type {Record<string, unknown>} */ (entry)),
+          );
+
+  /** @type {Record<string, unknown>} */
+  const meta = {};
+  if (data.length === 0) meta.configured = configured;
+  if (sources !== undefined) {
+    meta.available = only === 'installed' ? [] : (available ?? []).filter(keep);
+    meta.sources = sources;
   }
-  return {type: 'discover.list', data: packages.map(toEntry)};
+  return Object.keys(meta).length > 0
+    ? {
+        type: 'discover.list',
+        data,
+        meta: /** @type {import('../discover.type.mjs').DiscoverListMeta} */ (
+          meta
+        ),
+      }
+    : {type: 'discover.list', data};
 }

package/api/discover/list/list.test.mjs

@@ -57,3 +57,49 @@ describe('discover.list leaf', () => {
     });
   });
 });
+
+describe('discover.list leaf with discover sources', () => {
+  const installed = [
+    pkg('@acme/widgets', ['Alpha'], {
+      version: '1.2.3',
+      latest: '1.3.0',
+      templates: ['pages/Home'],
+    }),
+  ];
+  const available = [
+    {name: '@acme/charts', version: '2.0.0', components: ['Chart'], source: 'Acme'},
+    {name: '@acme/themes', version: '1.0.0', components: [], themes: ['ocean'], source: 'Acme'},
+  ];
+  const sources = [{name: 'Acme', from: 'astryx.config', status: 'fresh'}];
+
+  it('lists what is installed in data and what could be added in meta', () => {
+    const res = list(installed, {configured: true, available, sources});
+    expect(res.data).toEqual([
+      {
+        name: '@acme/widgets',
+        category: '@acme/widgets',
+        components: ['Alpha'],
+        version: '1.2.3',
+        templates: ['pages/Home'],
+        latest: '1.3.0',
+      },
+    ]);
+    expect(res.meta).toEqual({available, sources});
+  });
+
+  it('keeps one side with only', () => {
+    expect(
+      list(installed, {configured: true, available, sources, only: 'installed'})
+        .meta?.available,
+    ).toEqual([]);
+    const res = list(installed, {configured: true, available, sources, only: 'available'});
+    expect(res.data).toEqual([]);
+    expect(res.meta).toEqual({configured: true, available, sources});
+  });
+
+  it('keeps only packages that add a kind with type', () => {
+    const res = list(installed, {configured: true, available, sources, type: 'theme'});
+    expect(res.data).toEqual([]);
+    expect(res.meta?.available?.map(e => e.name)).toEqual(['@acme/themes']);
+  });
+});

package/api/discover/search/search.d.mts

@@ -1,25 +1,27 @@
 // @generated by scripts/sync-api-types.mjs from the JSDoc in api/**/*.mjs.
 // DO NOT EDIT — run `pnpm sync:api-types` to regenerate.
 
-/**
- * @typedef {import('../_package-scanner.mjs').ScannedPackage} ScannedPackage
- */
 /**
  * Search all packages for `query` (a free-text term that never starts with
- * `@`). Resolves to a single component's docs when unambiguous, a search
- * response when several match, or throws AstryxError (ERR_NOT_FOUND) — with
- * fuzzy suggestions when any exist.
+ * `@`). Resolves to a search response when anything matches, even a single
+ * item or an exact component name, or throws AstryxError (ERR_NOT_FOUND) —
+ * with fuzzy suggestions when any exist.
  *
- * @param {ScannedPackage[]} packages
+ * @param {ScannedPackage[]} packages installed packages
  * @param {string} query
- * @param {{lang?: string | null, zh?: boolean}} opts
- * @returns {Promise<
- *   import('../discover.type.mjs').DiscoverDetailDocResponse |
- *   import('../discover.type.mjs').DiscoverSearchResponse
- * >}
+ * @param {{
+ *   items?: SearchItem[],
+ *   type?: import('../../../authoring/discover/type').DiscoverKind,
+ *   only?: 'installed' | 'available',
+ *   limit?: number,
+ * }} opts
+ * @returns {Promise<import('../discover.type.mjs').DiscoverSearchResponse>}
  */
-export function search(packages: ScannedPackage[], query: string, { lang, zh }: {
-    lang?: string | null;
-    zh?: boolean;
-}): Promise<import("../discover.type.mjs").DiscoverDetailDocResponse | import("../discover.type.mjs").DiscoverSearchResponse>;
+export function search(packages: ScannedPackage[], query: string, opts: {
+    items?: SearchItem[];
+    type?: import("../../../authoring/discover/type").DiscoverKind;
+    only?: "installed" | "available";
+    limit?: number;
+}): Promise<import("../discover.type.mjs").DiscoverSearchResponse>;
 export type ScannedPackage = import("../_package-scanner.mjs").ScannedPackage;
+export type SearchItem = import("../_catalog-view.mjs").SearchItem;

package/api/discover/search/search.mjs

@@ -1,44 +1,76 @@
 // Copyright (c) Meta Platforms, Inc. and affiliates.
 
 /**
- * @file discover.search leaf — free-text search across external packages.
+ * @file discover.search leaf — free-text search across installed packages and,
+ * when the project has discover sources, everything it could add.
  *
- * Resolution order (matching the flat command exactly):
- *   1. exact component name  -> discover.detail.doc
- *   2. single substring hit  -> discover.detail.doc
- *   3. multiple substring hits -> discover.search
- *   4. fuzzy hits (distance <= 3) -> throw ERR_NOT_FOUND with suggestions
- *   5. otherwise             -> throw ERR_NOT_FOUND
+ * A free-text query always answers with a list, so its response type depends
+ * on the form of the query and never on what the project has:
+ *   1. any matches                -> discover.search
+ *   2. fuzzy hits (distance <= 3) -> throw ERR_NOT_FOUND with suggestions
+ *   3. otherwise                  -> throw ERR_NOT_FOUND
+ * Matches are installed components, the project's other installed items,
+ * packages, and every item a source lists for a package the project could add.
+ * A caller opens one item by its package path, which ../detail answers.
  *
- * @position api/discover/search — projection over ../_adapter's resolver;
- *   delegates the single-component cases to ../detail/doc.
+ * @position api/discover/search — pure ranking over the installed component
+ *   names and ../_catalog-view's search items.
  */
 
-import {findComponent} from '../_adapter.mjs';
-import {docFromResult} from '../detail/doc/doc.mjs';
 import {levenshteinDistance} from '../../../foundation/text/string-utils.mjs';
 import {AstryxError} from '../../error.mjs';
 import {ERROR_CODES} from '../../../foundation/response/error-codes.mjs';
+import {DISCOVER_KINDS} from '../../../authoring/discover/parse.mjs';
 
 /**
  * @typedef {import('../_package-scanner.mjs').ScannedPackage} ScannedPackage
+ * @typedef {import('../_catalog-view.mjs').SearchItem} SearchItem
  */
 
+const KIND_ORDER = ['package', ...DISCOVER_KINDS];
+
+/**
+ * How well an item matches: 0 exact name, 1 name prefix, 2 name substring,
+ * 3 title, summary, keyword, or description; null for no match.
+ * @param {SearchItem} item
+ * @param {string} lower
+ * @returns {number | null}
+ */
+function rank(item, lower) {
+  const name = item.name.toLowerCase();
+  if (name === lower) return 0;
+  if (name.startsWith(lower)) return 1;
+  if (name.includes(lower)) return 2;
+  const text = [
+    item.title,
+    item.summary,
+    item.description,
+    ...(item.keywords ?? []),
+  ]
+    .filter(Boolean)
+    .join('\n')
+    .toLowerCase();
+  return text.includes(lower) ? 3 : null;
+}
+
 /**
  * Search all packages for `query` (a free-text term that never starts with
- * `@`). Resolves to a single component's docs when unambiguous, a search
- * response when several match, or throws AstryxError (ERR_NOT_FOUND) — with
- * fuzzy suggestions when any exist.
+ * `@`). Resolves to a search response when anything matches, even a single
+ * item or an exact component name, or throws AstryxError (ERR_NOT_FOUND) —
+ * with fuzzy suggestions when any exist.
  *
- * @param {ScannedPackage[]} packages
+ * @param {ScannedPackage[]} packages installed packages
  * @param {string} query
- * @param {{lang?: string | null, zh?: boolean}} opts
- * @returns {Promise<
- *   import('../discover.type.mjs').DiscoverDetailDocResponse |
- *   import('../discover.type.mjs').DiscoverSearchResponse
- * >}
+ * @param {{
+ *   items?: SearchItem[],
+ *   type?: import('../../../authoring/discover/type').DiscoverKind,
+ *   only?: 'installed' | 'available',
+ *   limit?: number,
+ * }} opts
+ * @returns {Promise<import('../discover.type.mjs').DiscoverSearchResponse>}
  */
-export async function search(packages, query, {lang, zh}) {
+export async function search(packages, query, opts) {
+  const {items = [], type, only, limit} = opts;
   // An empty query must error, not match every component via `.includes('')`
   // (parity with the api/search leaf). The discover() dispatcher already routes
   // an empty query to list, but the leaf must be safe on its own.
@@ -51,50 +83,64 @@ export async function search(packages, query, {lang, zh}) {
   }
   const lower = query.toLowerCase();
 
-  const exact = findComponent(packages, query);
-  if (exact) return await docFromResult(exact, {lang, zh});
-
-  const substringMatches =
-    /** @type {Array<{pkg: ScannedPackage, comp: string}>} */ ([]);
-  for (const pkg of packages) {
-    for (const comp of pkg.components) {
-      if (comp.toLowerCase().includes(lower)) {
-        substringMatches.push({pkg, comp});
-      }
-    }
-  }
+  /** @type {SearchItem[]} */
+  const installedComponents = packages.flatMap(pkg =>
+    pkg.components.map(name => ({
+      package: pkg.name,
+      kind: /** @type {const} */ ('component'),
+      name,
+      installed: true,
+    })),
+  );
 
-  if (substringMatches.length === 1) {
-    const match = substringMatches[0];
-    const result = findComponent([match.pkg], match.comp);
-    if (result) return await docFromResult(result, {lang, zh});
-  }
+  const ranked = [...installedComponents, ...items]
+    .filter(item => (type == null ? true : item.kind === type))
+    .filter(item =>
+      only === 'installed'
+        ? item.installed
+        : only === 'available'
+          ? !item.installed
+          : true,
+    )
+    .map(item => ({item, score: rank(item, lower)}))
+    .filter(
+      /** @returns {m is {item: SearchItem, score: number}} */
+      m => m.score != null,
+    )
+    .sort(
+      (a, b) =>
+        a.score - b.score ||
+        Number(b.item.installed) - Number(a.item.installed) ||
+        KIND_ORDER.indexOf(a.item.kind) - KIND_ORDER.indexOf(b.item.kind) ||
+        a.item.package.localeCompare(b.item.package) ||
+        a.item.name.localeCompare(b.item.name),
+    );
 
-  if (substringMatches.length > 1) {
+  if (ranked.length > 0) {
+    const matches = ranked.map(({item}) => ({
+      package: item.package,
+      component: item.name,
+      kind: item.kind,
+      installed: item.installed,
+      ...(item.title ? {title: item.title} : {}),
+      ...(item.summary ? {summary: item.summary} : {}),
+    }));
+    const shown = limit == null ? matches : matches.slice(0, limit);
     return {
       type: 'discover.search',
       data: {
         query,
-        matches: substringMatches.map(m => ({
-          package: m.pkg.name,
-          component: m.comp,
-        })),
+        matches: shown,
+        ...(shown.length < matches.length ? {total: matches.length} : {}),
       },
     };
   }
 
-  // Fuzzy fallback
-  const allComponents =
-    /** @type {Array<{pkg: ScannedPackage, comp: string}>} */ ([]);
-  for (const pkg of packages) {
-    for (const comp of pkg.components) {
-      allComponents.push({pkg, comp});
-    }
-  }
-  const fuzzyMatches = allComponents
-    .map(item => ({
-      ...item,
-      distance: levenshteinDistance(lower, item.comp.toLowerCase()),
+  // Fuzzy fallback over installed components.
+  const fuzzyMatches = installedComponents
+    .map(entry => ({
+      ...entry,
+      distance: levenshteinDistance(lower, entry.name.toLowerCase()),
     }))
     .filter(m => m.distance <= 3)
     .sort((a, b) => a.distance - b.distance)
@@ -104,7 +150,7 @@ export async function search(packages, query, {lang, zh}) {
     throw new AstryxError(
       `"${query}" not found`,
       fuzzyMatches.map(m => ({
-        name: m.pkg.name + '/' + m.comp,
+        name: m.package + '/' + m.name,
         reason: 'similar name',
       })),
       ERROR_CODES.ERR_NOT_FOUND,

package/api/discover/search/search.test.mjs

@@ -1,8 +1,8 @@
 // Copyright (c) Meta Platforms, Inc. and affiliates.
 
 /**
- * @file Colocated tests for the discover.search leaf. Exact/single matches load
- * a real `.doc.mjs`, so these drive a small temp docs directory.
+ * @file Colocated tests for the discover.search leaf, over a small temp docs
+ * directory shaped like a scanned package.
  */
 
 import {describe, it, expect, beforeAll, afterAll} from 'vitest';
@@ -47,16 +47,31 @@ afterAll(() => {
 });
 
 describe('discover.search leaf', () => {
-  it('an exact component name resolves to its docs', async () => {
+  it('lists an exact component name first, with every other match', async () => {
     const res = await search(packages, 'Alpha', {});
-    expect(res.type).toBe('discover.detail.doc');
-    expect(res.data.name).toBe('Alpha');
+    expect(res.type).toBe('discover.search');
+    expect(res.data.matches.map(m => m.component)).toEqual([
+      'Alpha',
+      'AlphaCard',
+    ]);
   });
 
-  it('a single substring match resolves to its docs', async () => {
+  it('lists a single match too, so the response type never depends on the data', async () => {
     const res = await search(packages, 'card', {});
-    expect(res.type).toBe('discover.detail.doc');
-    expect(res.data.name).toBe('AlphaCard');
+    expect(res).toEqual({
+      type: 'discover.search',
+      data: {
+        query: 'card',
+        matches: [
+          {
+            package: '@acme/widgets',
+            component: 'AlphaCard',
+            kind: 'component',
+            installed: true,
+          },
+        ],
+      },
+    });
   });
 
   it('multiple substring matches return a search response', async () => {
@@ -66,8 +81,18 @@ describe('discover.search leaf', () => {
       data: {
         query: 'alph',
         matches: [
-          {package: '@acme/widgets', component: 'Alpha'},
-          {package: '@acme/widgets', component: 'AlphaCard'},
+          {
+            package: '@acme/widgets',
+            component: 'Alpha',
+            kind: 'component',
+            installed: true,
+          },
+          {
+            package: '@acme/widgets',
+            component: 'AlphaCard',
+            kind: 'component',
+            installed: true,
+          },
         ],
       },
     });
@@ -116,3 +141,112 @@ describe('discover.search leaf — empty query (parity with api/search)', () =>
     });
   });
 });
+
+describe('discover.search leaf across every kind and source', () => {
+  /** @type {any[]} */
+  const items = [
+    {
+      package: '@acme/widgets',
+      kind: 'template',
+      name: 'pages/AlphaHome',
+      installed: true,
+    },
+    {
+      package: '@acme/charts',
+      kind: 'package',
+      name: '@acme/charts',
+      installed: false,
+      description: 'Charts for alpha dashboards',
+    },
+    {
+      package: '@acme/charts',
+      kind: 'component',
+      name: 'AlphaChart',
+      installed: false,
+    },
+    {
+      package: '@acme/charts',
+      kind: 'doc',
+      name: 'guide',
+      installed: false,
+      summary: 'How to chart',
+    },
+  ];
+
+  it('ranks every match by how closely its name matches, installed first among equals', async () => {
+    const res = await search(packages, 'alph', {items});
+    expect(res.type).toBe('discover.search');
+    expect(
+      res.data.matches.map(m => [m.kind, m.component, m.installed]),
+    ).toEqual([
+      ['component', 'Alpha', true],
+      ['component', 'AlphaCard', true],
+      ['component', 'AlphaChart', false],
+      ['template', 'pages/AlphaHome', true],
+      ['package', '@acme/charts', false],
+    ]);
+  });
+
+  it('lists an exact installed component name with the matches from every source', async () => {
+    const res = await search(packages, 'Alpha', {items});
+    expect(res.type).toBe('discover.search');
+    expect(res.data.matches[0]).toEqual({
+      package: '@acme/widgets',
+      component: 'Alpha',
+      kind: 'component',
+      installed: true,
+    });
+    expect(res.data.matches.map(m => m.component)).toContain('AlphaChart');
+  });
+
+  it('lists a single partial component match when other items match too', async () => {
+    const res = await search(packages, 'card', {
+      items: [
+        ...items,
+        {
+          package: '@acme/charts',
+          kind: 'template',
+          name: 'pages/CardGrid',
+          installed: false,
+        },
+      ],
+    });
+    expect(res.type).toBe('discover.search');
+    expect(res.data.matches.map(m => m.component)).toEqual([
+      'AlphaCard',
+      'pages/CardGrid',
+    ]);
+  });
+
+  it('lists one installed component when nothing else matches', async () => {
+    const res = await search(packages, 'card', {items});
+    expect(res.type).toBe('discover.search');
+    expect(res.data.matches.map(m => m.component)).toEqual(['AlphaCard']);
+  });
+
+  it('keeps one kind with type, and one side with only', async () => {
+    const templates = await search(packages, 'alph', {items, type: 'template'});
+    expect(templates.data.matches.map(m => m.component)).toEqual([
+      'pages/AlphaHome',
+    ]);
+    const available = await search(packages, 'alph', {
+      items,
+      only: 'available',
+    });
+    expect(available.data.matches.map(m => m.component)).toEqual([
+      'AlphaChart',
+      '@acme/charts',
+    ]);
+  });
+
+  it('caps the list at limit and reports the total', async () => {
+    const res = await search(packages, 'alph', {items, limit: 2});
+    expect(res.data.matches).toHaveLength(2);
+    expect(res.data.total).toBe(5);
+  });
+
+  it('matches titles, summaries, keywords, and descriptions too', async () => {
+    const res = await search(packages, 'how to chart', {items});
+    expect(res.data.matches.map(m => m.component)).toEqual(['guide']);
+  });
+});