@astryxdesign/cli 0.6.3-canary.db4e378 → 0.6.3-canary.db52d98

package/api/search/search.test.mjs

@@ -84,7 +84,8 @@ describe('search leaf — per-domain result fields', () => {
         expect(res.import).toMatch(/\S/);
       } else if (res.domain === 'doc') {
         expect(res.title).toMatch(/\S/);
-        expect(res.command).toBe(`astryx docs ${res.name}`);
+        const read = `astryx docs ${res.name}`;
+        expect([read, `${read} --index`, `${read} ${res.section}`]).toContain(res.command);
       } else {
         expect(res.displayName).toMatch(/\S/);
         expect(['page', 'block']).toContain(res.kind);
@@ -93,6 +94,88 @@ describe('search leaf — per-domain result fields', () => {
   }, SLOW);
 });
 
+describe('search leaf — docs at the grain a reader reads them', () => {
+  it(
+    'finds one section of a guide, and a docs-tree leaf by its own name',
+    async () => {
+      const guide = await search('codemod protected files', {cwd, type: 'doc'});
+      expect(guide.data.results.slice(0, 3)).toContainEqual(
+        expect.objectContaining({
+          domain: 'doc',
+          name: 'cli/integrations',
+          section: 'codemods',
+          title: 'Astryx CLI › CLI Integrations › Codemods',
+          parent: 'astryx docs cli/integrations --index',
+          command: 'astryx docs cli/integrations codemods',
+        }),
+      );
+      const block = await search('token-ref', {cwd});
+      expect(block.data.results[0]).toMatchObject({
+        name: 'authoring',
+        section: 'reference-doc',
+        command: 'astryx docs authoring reference-doc',
+      });
+      const fn = await search('assertResponse', {cwd, type: 'doc'});
+      expect(fn.data.results[0]).toMatchObject({
+        name: 'cli/api/functions/assert-response',
+        title: 'Astryx CLI › API › Functions › assertResponse()',
+        parent: 'astryx docs cli/api/functions',
+        command: 'astryx docs cli/api/functions/assert-response',
+      });
+      expect(fn.data.results[0]).not.toHaveProperty('section');
+    },
+    SLOW,
+  );
+
+  it(
+    'gives a top-level namespace hit the topic list as its parent',
+    async () => {
+      for (const [query, route] of [['unorganized', 'unorganized'], ['Astryx CLI', 'cli']]) {
+        const r = await search(query, {cwd, type: 'doc'});
+        expect(r.data.results).toContainEqual(
+          expect.objectContaining({
+            name: route,
+            command: `astryx docs ${route}`,
+            parent: 'astryx docs',
+          }),
+        );
+      }
+    },
+    SLOW,
+  );
+
+  it(
+    'points a topic hit at its index, never a whole-topic read',
+    async () => {
+      const r = await search('cli/integrations', {cwd, type: 'doc'});
+      expect(r.data.results[0]).toMatchObject({
+        name: 'cli/integrations',
+        command: 'astryx docs cli/integrations --index',
+      });
+      expect(r.data.results[0]).not.toHaveProperty('section');
+    },
+    SLOW,
+  );
+
+  it(
+    'searches docs where @astryxdesign/core is not installed',
+    async () => {
+      const bare = fs.mkdtempSync(
+        path.join(os.tmpdir(), 'astryx-search-bare-'),
+      );
+      try {
+        const r = await search('assertResponse', {cwd: bare, type: 'doc'});
+        expect(r.data.results[0].name).toBe(
+          'cli/api/functions/assert-response',
+        );
+      } finally {
+        fs.rmSync(bare, {recursive: true, force: true});
+      }
+    },
+    SLOW,
+  );
+});
+
 describe('search leaf — matchCount is the total, not the cap', () => {
   it('reports every match while `results` stays bounded by the limit', async () => {
     // The regression: `matchCount` used to be `results.length`, so a query
@@ -247,12 +330,18 @@ describe('search leaf — integration components', () => {
     );
     fs.writeFileSync(
       path.join(widgetsDir, 'components', 'FancyGizmo.doc.mjs'),
-      `export const docs = {
+      `export default {
+        type: 'component',
         name: 'FancyGizmo',
         keywords: ['gizmo', 'widget'],
         usage: {description: 'A fancy gizmo widget.'},
+        props: [],
       };\n`,
     );
+    fs.writeFileSync(
+      path.join(widgetsDir, 'components', 'FancyGizmo.tsx'),
+      `export function FancyGizmo() { return null; }\n`,
+    );
 
     return dir;
   }

package/api/search/search.type.d.mts

@@ -14,7 +14,7 @@ export type SearchResultEntry = {
      */
     domain: SearchDomain;
     /**
-     * - Primary identifier (component/hook name, doc topic, template dir).
+     * - Primary identifier (component/hook name, doc topic or docs-tree route, template dir).
      */
     name: string;
     /**
@@ -41,6 +41,18 @@ export type SearchResultEntry = {
      * - Doc title — present for doc results.
      */
     title?: string | undefined;
+    /**
+     * - Section key — present when a doc result is one section of a topic; `command` reads only that section.
+     */
+    section?: string | undefined;
+    /**
+     * - The npm package that authored a doc result; for a section, the package whose file the section came from.
+     */
+    package?: string | undefined;
+    /**
+     * - Command that opens the level above a doc result — its topic's section list for a section, the docs-tree namespace it sits in for a tree node — so a reader can see the siblings and open another.
+     */
+    parent?: string | undefined;
     /**
      * - Friendly display name — present for template results.
      */

package/api/search/search.type.mjs

@@ -16,13 +16,16 @@
  * A single ranked search result, tagged with its domain.
  * @typedef {object} SearchResultEntry
  * @property {SearchDomain} domain - Which content domain this result came from.
- * @property {string} name - Primary identifier (component/hook name, doc topic, template dir).
+ * @property {string} name - Primary identifier (component/hook name, doc topic or docs-tree route, template dir).
  * @property {number} score - Relevance score (higher is better).
  * @property {string} reason - Human-readable reason the candidate matched (e.g. `keyword "button"`).
  * @property {string} description - One-line description, when available.
  * @property {string} command - Follow-up command to act on this result (e.g. `astryx component Button`).
  * @property {string} [import] - Import path — present for component and hook results.
  * @property {string} [title] - Doc title — present for doc results.
+ * @property {string} [section] - Section key — present when a doc result is one section of a topic; `command` reads only that section.
+ * @property {string} [package] - The npm package that authored a doc result; for a section, the package whose file the section came from.
+ * @property {string} [parent] - Command that opens the level above a doc result — its topic's section list for a section, the docs-tree namespace it sits in for a tree node — so a reader can see the siblings and open another.
  * @property {string} [displayName] - Friendly display name — present for template results.
  * @property {'page' | 'block'} [kind] - Template kind (`page` | `block`) — present for template results.
  */

package/api/swizzle/swizzle.doc.mjs

@@ -11,6 +11,7 @@ export const doc = {
   type: 'function',
   kind: 'api',
   name: 'swizzle',
+  namespace: 'cli/api',
   displayName: 'swizzle()',
   summary: "Eject a component's source into your project for customization.",
   description:

package/api/template/list/list.mjs

@@ -32,6 +32,7 @@ export function templateList(templates, options = {}) {
       description: t.description,
       type: t.type,
       package: pkgOf(t),
+      replaces: t.replaces,
       category: t.category || undefined,
       componentsUsed: t.componentsUsed ?? undefined,
       aspectRatio: t.aspectRatio,

package/api/template/table-floating-bulk-actions.test.mjs

@@ -0,0 +1,66 @@
+// Copyright (c) Meta Platforms, Inc. and affiliates.
+
+/**
+ * @file Regression coverage for the floating bulk-actions Table block.
+ * @input The shipped TableFloatingBulkActionsTable source.
+ * @output Assertions for width, logical scrolling, local stacking, and shared toolbar geometry.
+ * @position Template contract test for the website example layout.
+ */
+
+import fs from 'node:fs';
+import path from 'node:path';
+import {fileURLToPath} from 'node:url';
+import {describe, expect, it} from 'vitest';
+
+const sourcePath = path.resolve(
+  path.dirname(fileURLToPath(import.meta.url)),
+  '../../assets/templates/blocks/components/Table/TableFloatingBulkActionsTable.tsx',
+);
+const source = fs.readFileSync(sourcePath, 'utf8');
+const pageStyles = source.match(/page:\s*\{([\s\S]*?)\n\s{2}\},/)?.[1];
+const tableRegionStyles = source.match(
+  /tableRegion:\s*\{([\s\S]*?)\n\s{2}\},/,
+)?.[1];
+const toolbarStyles = source.match(/toolbar:\s*\{([\s\S]*?)\n\s{2}\},/)?.[1];
+const columns = source.match(
+  /const columns:[\s\S]*?=\s*\[([\s\S]*?)\n\];/,
+)?.[1];
+
+describe('Table floating bulk-actions template', () => {
+  it('caps the demo height without capping its width', () => {
+    expect(pageStyles).toContain('maxBlockSize: 640');
+    expect(pageStyles).not.toContain('maxWidth');
+    expect(pageStyles).not.toContain('marginInline');
+  });
+
+  it('uses the shared logical-axis scroll behavior', () => {
+    expect(source).toContain(
+      "import {ScrollableArea} from '@astryxdesign/core/ScrollableArea'",
+    );
+    expect(source).toMatch(
+      /<ScrollableArea[\s\S]*?axis="block"[\s\S]*?label="Bulk actions example"[\s\S]*?overscroll="contain"/,
+    );
+    expect(source).not.toContain('role="region"');
+    expect(source).not.toContain('tabIndex={0}');
+    expect(source).not.toContain('aria-label="Metrics"');
+    expect(pageStyles).not.toContain('overflowY');
+    expect(pageStyles).not.toContain('overscrollBehavior');
+  });
+
+  it('keeps the floating toolbar inside an isolated local stacking context', () => {
+    expect(pageStyles).toContain("isolation: 'isolate'");
+    expect(toolbarStyles).toContain('zIndex: 1');
+    expect(toolbarStyles).not.toContain('zIndex: 20');
+  });
+
+  it('shares one reserved-space variable across the placement geometry', () => {
+    expect(tableRegionStyles).toContain("'--table-bulk-actions-space'");
+    expect(source.match(/var\(--table-bulk-actions-space\)/g)).toHaveLength(4);
+  });
+
+  it('keeps the email column compact enough to avoid horizontal overflow', () => {
+    expect(columns).toContain(
+      "{key: 'email', header: 'Email', width: proportional(1)}",
+    );
+  });
+});