@astryxdesign/cli 0.6.3-canary.f22695a → 0.6.3

package/authoring/index.d.ts

@@ -23,18 +23,17 @@
 // ═══════════════════════════════════════════════════════════════════════
 // AUTHOR THESE — each is the default export of one authored file.
 // ═══════════════════════════════════════════════════════════════════════
-export type {ComponentDoc} from './doctypes/types.js'; //   Button.doc.{ts,mjs}
-export type {HookDoc} from './doctypes/types.js'; //         useToast.doc.{ts,mjs}
-export type {FunctionDoc} from './doctypes/types.js'; //     search.doc.mjs (hook | api)
-export type {ReferenceDoc} from './doctypes/types.js'; //    theming.doc.{ts,mjs}
-export type {TemplateDoc} from './doctypes/types.js'; //     Foo.template.{ts,mjs}
-export type {SchemaDoc} from './doctypes/types.js'; //       config.doc.mjs (object shape)
-export type {CommandDoc} from './doctypes/types.js'; //      search.doc.mjs (CLI command)
-export type {EnumDoc} from './doctypes/types.js'; //         error-codes.doc.mjs (vocabulary)
-export type {NamespaceDoc} from './doctypes/types.js'; //    cli.doc.mjs (hierarchy)
-export type {AstryxConfig} from './config/type.js'; //       astryx.config.{ts,mjs}
-export type {DebugEvent} from './debug/type.js'; //          one recorded CLI run
-export type {AstryxIntegration} from './integration/type.js'; // astryx.integration.{ts,mjs}
+export type {ComponentDoc} from './doctypes/types'; //   Button.doc.{ts,mjs}
+export type {HookDoc} from './doctypes/types'; //         useToast.doc.{ts,mjs}
+export type {FunctionDoc} from './doctypes/types'; //     search.doc.mjs (hook | api)
+export type {ReferenceDoc} from './doctypes/types'; //    theming.doc.{ts,mjs}
+export type {TemplateDoc} from './doctypes/types'; //     Foo.template.{ts,mjs}
+export type {SchemaDoc} from './doctypes/types'; //       config.doc.mjs (object shape)
+export type {CommandDoc} from './doctypes/types'; //      search.doc.mjs (CLI command)
+export type {EnumDoc} from './doctypes/types'; //         error-codes.doc.mjs (vocabulary)
+export type {AstryxConfig} from './config/type'; //       astryx.config.{ts,mjs}
+export type {DebugEvent} from './debug/type'; //          one recorded CLI run
+export type {AstryxIntegration} from './integration/type'; // astryx.integration.{ts,mjs}
 export type {
   GapReportHandler,
   GapReportHandlerContext,
@@ -42,8 +41,8 @@ export type {
   GapReportCategory,
   GapReportTarget,
   GapReportHandlerReceipt,
-} from './gap-report/type.js'; // gap-report handler contract
-export type {AstryxCodemod, AstryxConfigCodemod} from './codemod/type.js'; // codemods/*
+} from './gap-report/type'; // gap-report handler contract
+export type {AstryxCodemod, AstryxConfigCodemod} from './codemod/type'; // codemods/*
 
 // ═══════════════════════════════════════════════════════════════════════
 // PARSERS — the CLI's load boundary (types come from each parser's JSDoc).
@@ -57,7 +56,6 @@ export {parseTemplate} from './doctypes/template/parse.mjs';
 export {parseSchema} from './doctypes/schema/parse.mjs';
 export {parseCommand} from './doctypes/command/parse.mjs';
 export {parseEnum} from './doctypes/enum/parse.mjs';
-export {parseNamespace} from './doctypes/namespace/parse.mjs';
 export {parseLegacyDoc} from './doctypes/legacy.mjs';
 export {parseConfig} from './config/parse.mjs';
 export {parseIntegration} from './integration/parse.mjs';
@@ -74,26 +72,6 @@ export {parseDebugEvent} from './debug/parse.mjs';
 // need them to author. Names carry the doc kind they belong to.
 // ═══════════════════════════════════════════════════════════════════════
 export type {
-  ProviderId,
-  ArtifactId,
-  DocId,
-  ProviderInstanceId,
-  ContentDigest,
-  ContributionKind,
-  ArtifactIdentity,
-  ProviderInstance,
-  AuthoredDoc,
-  AuthoredDocKindOf,
-  AuthoredDocSnapshot,
-  AuthoredDocSource,
-  AuthoredDocEntry,
-} from './identity/type.js';
-export type {
-  // shared graph
-  AuthoredDocKind,
-  DocAudience,
-  DocPlacement,
-  AuthoredDocGraphFields,
   // component
   SingleComponentDoc,
   MultiComponentDoc,
@@ -131,16 +109,6 @@ export type {
   ReferenceContentBlock,
   ReferenceTokenPreviewType,
   ReferenceTranslationDoc,
-  WorkflowStep,
-  WorkflowDocBlock,
-  CollectionDocBlock,
-  ReferenceDocBlock,
-  // namespace
-  NamespaceProviderScope,
-  NamespaceSlotAcceptance,
-  NamespaceSlot,
-  NamespaceAdoptionSource,
-  NamespaceAdoptionRule,
   // template
   TemplateCategory,
   // schema
@@ -151,8 +119,8 @@ export type {
   CommandExampleDoc,
   // enum
   EnumMemberDoc,
-} from './doctypes/types.js';
-export type {PostCodemodHook, DebugConfig} from './config/type.js';
+} from './doctypes/types';
+export type {PostCodemodHook, DebugConfig} from './config/type';
 export type {
   // debug
   DebugSchemaVersion,
@@ -165,11 +133,11 @@ export type {
   DebugEventEnv,
   DebugEventProject,
   DebugEventHandler,
-} from './debug/type.js';
+} from './debug/type';
 export type {
   AstryxCodemodDef,
   AstryxConfigCodemodDef,
   AstryxCodemodFile,
   AstryxCodemodApi,
   AstryxCodemodTransform,
-} from './codemod/type.js';
+} from './codemod/type';

package/authoring/index.mjs

@@ -31,5 +31,4 @@ export {parseTemplate} from './doctypes/template/parse.mjs';
 export {parseSchema} from './doctypes/schema/parse.mjs';
 export {parseCommand} from './doctypes/command/parse.mjs';
 export {parseEnum} from './doctypes/enum/parse.mjs';
-export {parseNamespace} from './doctypes/namespace/parse.mjs';
 export {parseLegacyDoc} from './doctypes/legacy.mjs';

package/authoring/integration/integration.doc.mjs

@@ -14,18 +14,11 @@ export const doc = {
   namespace: 'cli',
   description:
     'The astryx.integration.* manifest that sits beside an integration ' +
-    "package's package.json. It can preserve a stable provider identity across a package rename, " +
-    "and points the CLI at the package's components, templates, codemods, doc topics, " +
-    'source themes, managed agent guidance, and issue tracker. Every field is optional.',
+    "package's package.json. Points the CLI at the package's components, " +
+    'templates, codemods, doc topics, source themes, and managed agent guidance, ' +
+    'and where to file issues. Every field is optional.',
   appliesTo: 'astryx.integration.{ts,mjs,js}',
   fields: [
-    {
-      name: 'providerId',
-      type: 'string',
-      description:
-        'Stable logical provider ID. Omit to use package.json#name; set it to the prior package name only when an explicit rename must preserve artifact IDs. If two packages claim the same ID, the package being authored is used, otherwise the first-loaded one, and the CLI warns about the other.',
-      example: "'@acme/widgets'",
-    },
     {
       name: 'components',
       type: 'string',
@@ -94,9 +87,9 @@ export const doc = {
     {
       type: 'prose',
       text:
-        'Provider identity defaults to package.json#name. During an explicit ' +
-        'package rename, set `providerId` to the prior canonical package name so ' +
-        'existing artifact IDs remain stable. Package version always comes from package.json.',
+        "Identity, the integration's name and version, comes from the " +
+        "package's package.json, not from this manifest. The manifest only " +
+        'declares where the CLI finds each kind of artifact.',
     },
     {
       type: 'prose',

package/authoring/integration/parse.d.mts

@@ -1,7 +1,7 @@
 // @generated by scripts/sync-api-types.mjs from the JSDoc in authoring/**/*.mjs.
 // DO NOT EDIT — run `pnpm sync:api-types` to regenerate.
 
-/** @typedef {import('./type.js').AstryxIntegration} AstryxIntegration */
+/** @typedef {import('./type').AstryxIntegration} AstryxIntegration */
 /**
  * Validate an unknown value as an Astryx integration manifest, or throw.
  *
@@ -14,4 +14,4 @@
  * @returns {AstryxIntegration}
  */
 export function parseIntegration(input: unknown, label?: string): AstryxIntegration;
-export type AstryxIntegration = import("./type.js").AstryxIntegration;
+export type AstryxIntegration = import("./type").AstryxIntegration;

package/authoring/integration/parse.mjs

@@ -14,7 +14,7 @@
 import {formatZodError} from '../_shared/errors.mjs';
 import {integrationSchema} from './schema.mjs';
 
-/** @typedef {import('./type.js').AstryxIntegration} AstryxIntegration */
+/** @typedef {import('./type').AstryxIntegration} AstryxIntegration */
 
 /**
  * Validate an unknown value as an Astryx integration manifest, or throw.

package/authoring/integration/parse.test.mjs

@@ -28,9 +28,6 @@ describe('parseIntegration (load boundary)', () => {
       components: './src',
     });
     expect(parseIntegration({docs: './docs'})).toEqual({docs: './docs'});
-    expect(parseIntegration({providerId: '@acme/legacy-widgets'})).toEqual({
-      providerId: '@acme/legacy-widgets',
-    });
     expect(parseIntegration({themes: './themes'})).toEqual({
       themes: './themes',
     });
@@ -69,9 +66,7 @@ describe('parseIntegration (load boundary)', () => {
           ? 'https://example.com/issues'
           : key === 'agentDocs'
             ? {}
-            : key === 'providerId'
-              ? '@acme/widgets'
-              : './x',
+            : './x',
       ]),
     );
     expect(unknownIntegrationKeys(everyKnownKey)).toEqual([]);
@@ -87,10 +82,6 @@ describe('parseIntegration (load boundary)', () => {
     expect(reason({issuesUrl: 'nope'})).toContain('issuesUrl');
   });
 
-  it('rejects a noncanonical providerId', () => {
-    expect(reason({providerId: 'Acme Widgets'})).toContain('providerId');
-  });
-
   it('accepts an optional append array as manifest data', () => {
     expect(
       parseIntegration({

package/authoring/integration/schema.d.mts

@@ -32,7 +32,6 @@ export const agentDocsSchema: z.ZodObject<{
     append: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodString>>>;
 }, z.core.$strip>;
 export const integrationBaseSchema: z.ZodObject<{
-    providerId: z.ZodOptional<z.ZodString>;
     components: z.ZodOptional<z.ZodString>;
     templates: z.ZodOptional<z.ZodString>;
     codemods: z.ZodOptional<z.ZodString>;
@@ -41,7 +40,6 @@ export const integrationBaseSchema: z.ZodObject<{
     issuesUrl: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 export const integrationSchema: z.ZodObject<{
-    providerId: z.ZodOptional<z.ZodString>;
     components: z.ZodOptional<z.ZodString>;
     templates: z.ZodOptional<z.ZodString>;
     codemods: z.ZodOptional<z.ZodString>;
@@ -55,8 +53,8 @@ export const integrationSchema: z.ZodObject<{
 /**
  * Compile-time drift-lock: sealed schema must infer exactly {@link AstryxIntegration}.
  *
- * @typedef {import('../_shared/contract.js').Expect<
- *   import('../_shared/contract.js').Equal<z.infer<typeof integrationSchema>, AstryxIntegration>
+ * @typedef {import('../_shared/contract').Expect<
+ *   import('../_shared/contract').Equal<z.infer<typeof integrationSchema>, AstryxIntegration>
  * >} _IntegrationDriftLock
  */
 /**
@@ -69,9 +67,9 @@ export const integrationSchema: z.ZodObject<{
  * @type {string[]}
  */
 export const KNOWN_INTEGRATION_KEYS: string[];
-export type AstryxIntegration = import("./type.js").AstryxIntegration;
+export type AstryxIntegration = import("./type").AstryxIntegration;
 /**
  * Compile-time drift-lock: sealed schema must infer exactly {@link AstryxIntegration}.
  */
-export type _IntegrationDriftLock = import("../_shared/contract.js").Expect<import("../_shared/contract.js").Equal<z.infer<typeof integrationSchema>, AstryxIntegration>>;
+export type _IntegrationDriftLock = import("../_shared/contract").Expect<import("../_shared/contract").Equal<z.infer<typeof integrationSchema>, AstryxIntegration>>;
 import { z } from 'zod';

package/authoring/integration/schema.mjs

@@ -16,13 +16,11 @@
 import {z} from 'zod';
 import {formatZodError} from '../_shared/errors.mjs';
 
-/** @typedef {import('./type.js').AstryxIntegration} AstryxIntegration */
+/** @typedef {import('./type').AstryxIntegration} AstryxIntegration */
 
 const MAX_AGENT_DOC_LINES = 8;
 const MAX_AGENT_DOC_LINE_CODE_POINTS = 240;
 const MANAGED_MARKER_TEXT = /(?:ASTRYX|XDS):(START|END)/u;
-const PROVIDER_ID_RE =
-  /^(?:@[a-z0-9][a-z0-9._~!*'()-]*\/)?[a-z0-9][a-z0-9._~!*'()-]*$/u;
 
 /**
  * @param {string} value
@@ -68,10 +66,6 @@ export const agentDocsSchema = z.object({
 });
 
 export const integrationBaseSchema = z.object({
-  providerId: z
-    .string()
-    .regex(PROVIDER_ID_RE, 'providerId must be a canonical npm package name')
-    .optional(),
   components: z.string().optional(),
   templates: z.string().optional(),
   codemods: z.string().optional(),
@@ -121,8 +115,8 @@ export function parseAgentDocsField(input, label) {
 /**
  * Compile-time drift-lock: sealed schema must infer exactly {@link AstryxIntegration}.
  *
- * @typedef {import('../_shared/contract.js').Expect<
- *   import('../_shared/contract.js').Equal<z.infer<typeof integrationSchema>, AstryxIntegration>
+ * @typedef {import('../_shared/contract').Expect<
+ *   import('../_shared/contract').Equal<z.infer<typeof integrationSchema>, AstryxIntegration>
  * >} _IntegrationDriftLock
  */
 

package/authoring/integration/type.ts

@@ -3,10 +3,9 @@
 /**
  * Public type surface for an Astryx integration manifest
  * (`astryx.integration.{ts,mjs,js}`, sibling to the integration package's
- * package.json). Identity defaults to the package name, but `providerId` can keep
- * a stable logical identity across an explicit package rename. Authors write a
- * plain object against {@link AstryxIntegration}; the CLI validates it via
- * `parseIntegration` at the load boundary.
+ * package.json). Identity (name/version) comes from package.json, not the
+ * manifest. Authors write a plain object against {@link AstryxIntegration};
+ * the CLI validates it via `parseIntegration` at the load boundary.
  *
  * The manifest module may also carry `debug` and `gapReport` NAMED exports.
  * They are not fields here on purpose: a CLI released before a given manifest
@@ -14,20 +13,11 @@
  * named export is simply not read. See the `cli-integrations` doc topic.
  */
 export interface AstryxIntegration {
-  /** Stable logical provider ID. Omit to use package.json#name. Set this only
-   *  when a package rename must preserve existing artifact IDs. */
-  providerId?: string;
   /** Relative path to the components/docs root (resolved to absolute). */
   components?: string;
   /** Relative path to the templates root (resolved to absolute). */
   templates?: string;
-  /** Relative path to the codemods root (resolved to absolute).
-   *  The root uses a version-folder-first layout:
-   *  `<codemodsRoot>/<version>/<id>.<ext>`, where `<version>` is an exact
-   *  semver string (e.g. `0.2.0`, no `v` prefix) and `<id>` is a kebab-case
-   *  module basename. Each module default-exports a codemod envelope stamped
-   *  `type: 'code'` or `type: 'config'`. Codemod ids must be unique within
-   *  a package across all versions. */
+  /** Relative path to the codemods root (resolved to absolute). */
   codemods?: string;
   /** Relative path to the reference-docs (topics) root (resolved to
    *  absolute). Every `{topic}.doc.{ts,mjs,js}` under it is a topic the CLI
@@ -35,14 +25,7 @@ export interface AstryxIntegration {
    *  `replace` or `extend` a built-in topic; see the ReferenceDoc type. */
   docs?: string;
   /** Relative path to the source-theme catalog root (resolved to absolute).
-   *  The root contains `manifest.json` plus one directory per theme slug.
-   *  `manifest.json` is `{ "version": 1, "themes": [...] }` where each
-   *  entry requires `slug`, `displayName`, `description` (string),
-   *  `maintained` (boolean), `entry` (source file relative to `themes/<slug>/`),
-   *  `exportName` (a valid JS identifier naming the runtime export), and
-   *  `files` (non-empty array of filenames relative to `themes/<slug>/`).
-   *  Every file listed must exist on disk; the entry file must also appear
-   *  in `files`. */
+   *  The root contains `manifest.json` plus one directory per theme slug. */
   themes?: string;
   /** Static package guidance appended to the CLI-owned managed agent block. */
   agentDocs?: {
@@ -66,4 +49,4 @@ export type {
   GapReportCategory,
   GapReportTarget,
   GapReportHandlerReceipt,
-} from '../gap-report/type.js';
+} from '../gap-report/type';

package/authoring/shadcn/receipt.d.mts

@@ -63,7 +63,7 @@ export function createRegistryReceipt(input: {
         name: string;
         path: string;
         aliases: string[];
-        kind: "page" | "block" | "example" | "showcase";
+        kind: "block" | "page" | "example" | "showcase";
     };
     source: {
         package: "@astryxdesign/cli";
@@ -83,7 +83,7 @@ export function createRegistryReceipt(input: {
         name: string;
         path: string;
         aliases: string[];
-        kind: "page" | "block" | "example" | "showcase";
+        kind: "block" | "page" | "example" | "showcase";
     };
     source: {
         package: "@astryxdesign/cli";
@@ -112,7 +112,7 @@ export function parseRegistryReceipt(input: unknown): {
         name: string;
         path: string;
         aliases: string[];
-        kind: "page" | "block" | "example" | "showcase";
+        kind: "block" | "page" | "example" | "showcase";
     };
     source: {
         package: "@astryxdesign/cli";
@@ -132,7 +132,7 @@ export function parseRegistryReceipt(input: unknown): {
         name: string;
         path: string;
         aliases: string[];
-        kind: "page" | "block" | "example" | "showcase";
+        kind: "block" | "page" | "example" | "showcase";
     };
     source: {
         package: "@astryxdesign/cli";
@@ -165,8 +165,8 @@ export const registryReceiptSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
         path: z.ZodString;
         aliases: z.ZodArray<z.ZodString>;
         kind: z.ZodEnum<{
-            page: "page";
             block: "block";
+            page: "page";
             example: "example";
             showcase: "showcase";
         }>;
@@ -190,8 +190,8 @@ export const registryReceiptSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
         path: z.ZodString;
         aliases: z.ZodArray<z.ZodString>;
         kind: z.ZodEnum<{
-            page: "page";
             block: "block";
+            page: "page";
             example: "example";
             showcase: "showcase";
         }>;

package/clients/cli/commands/docs.doc.mjs

@@ -16,32 +16,22 @@ export const doc = {
   summary: 'Print reference docs',
   description:
     'Reads the reference docs: with no topic it lists every topic; a topic prints that ' +
-    'full doc; `--index` lists its sections instead, each with the key to read it by; a ' +
-    'topic plus a section prints that section (by key, exact title, or a unique part of ' +
-    'a title).',
+    'full doc; a topic plus a section returns the first section whose title contains the ' +
+    '(case-insensitive) query.',
   fn: 'docs',
   args: [
     {name: 'topic', param: 'topic', required: false},
     {name: 'section', param: 'section', required: false},
   ],
-  options: [
-    {
-      flag: '--index',
-      param: 'options.index',
-      description: "List the topic's sections and their keys instead of printing the whole topic",
-    },
-  ],
   examples: [
     {label: 'List topics', cli: 'astryx docs'},
     {label: 'One topic as JSON', cli: 'astryx docs spacing --json'},
-    {label: "A topic's sections", cli: 'astryx docs theme --index'},
-    {label: 'One section', cli: 'astryx docs theme quick-start'},
   ],
   exitCodes: [
     {code: 0, when: 'success'},
     {
       code: 1,
-      when: 'unknown topic, or a section that matches no section or more than one',
+      when: 'unknown topic, or a section that matches no title in the topic',
     },
   ],
   related: ['search', 'component', 'hook', 'template'],