@astryxdesign/cli 0.7.2 → 0.7.3-canary.02f5fe4

package/foundation/integrations/validate-contributions.d.mts

@@ -5,6 +5,29 @@
 export function issueError(code: string, message: string): Issue;
 /** @param {string} code @param {string} message @returns {Issue} */
 export function issueWarning(code: string, message: string): Issue;
+/**
+ * A layout finding added after the last minor release: validate lists it, in
+ * its `layout` report, but it is never an issue, so nothing counts it and
+ * `integration check --strict` does not fail on it. A new failing finding
+ * joins only in a minor release (architecture:cli-surface INV35).
+ * @param {string} code
+ * @param {string} message
+ * @returns {Issue}
+ */
+export function issueListed(code: string, message: string): Issue;
+/**
+ * Whether `issueListed` made this issue.
+ * @param {Issue} issue
+ */
+export function isListedIssue(issue: Issue): boolean;
+/**
+ * The known manifest key `key` is a near miss of: a different letter case, or
+ * at most two letters added, dropped or changed (`component`, `doc`,
+ * `tempaltes`). Null when no known key is that close, or two are.
+ * @param {string} key
+ * @returns {string | null}
+ */
+export function nearestKnownKey(key: string): string | null;
 /**
  * Why a declared root cannot be read as a folder, or null when it can.
  * A missing root keeps its own issue; a root that is a file or that the
@@ -21,6 +44,79 @@ export function rootProblem(root: string): {
     kind: "unreadable";
     code: string;
 } | null;
+/**
+ * The first folder on the way from the package to `root` (the root itself
+ * included) that is a symlink, with where it points, or null.
+ * @param {string} root absolute
+ * @param {string} packageDir absolute
+ * @returns {{path: string, target: string} | null}
+ */
+export function symlinkedFolder(root: string, packageDir: string): {
+    path: string;
+    target: string;
+} | null;
+/**
+ * The block component names this check could not judge, shaped like the
+ * doc type report so `integration check` counts them as not compared: each
+ * name a template gives in `exampleFor` or `componentsUsed` that neither the
+ * package nor Core has, when the template reaches components through
+ * anything but named imports and re-exports from the package, Core, or
+ * helpers read in full (see importedNames), or when Core is not installed to
+ * look it up in; its findings are always empty. A name judged unknown is an
+ * `unknown_block_component` note, with its fix in the message: validate
+ * lists notes beside its issues, and nothing counts them, so `--strict` does
+ * not fail on it until the next minor release (architecture:cli-surface
+ * INV35).
+ * @param {LoadedIntegration} integration
+ * @returns {Promise<{report: {status: 'checked', findings: [], unchecked: Array<{file: string, name: string, reason: string}>}, notes: Note[]}>}
+ */
+export function blockComponentsCheck(integration: LoadedIntegration): Promise<{
+    report: {
+        status: "checked";
+        findings: [];
+        unchecked: Array<{
+            file: string;
+            name: string;
+            reason: string;
+        }>;
+    };
+    notes: Note[];
+}>;
+/**
+ * The component doc names the check could not judge, shaped like the doc type
+ * report so `integration check` counts them as not compared: each doc whose
+ * `name` differs from the name it is listed under and whose source's exports
+ * cannot all be read without running it; its findings are always empty. A
+ * name the module its printed import names provably lacks is a
+ * `doc_name_mismatch` note, with its fix in the message: validate lists
+ * notes beside its issues, and nothing counts them, so `--strict` does not
+ * fail on it until the next minor release (architecture:cli-surface INV35).
+ * @param {LoadedIntegration} integration
+ * @returns {Promise<{report: {status: 'checked', findings: [], unchecked: Array<{file: string, name: string, reason: string}>}, notes: Note[]}>}
+ */
+export function componentDocNamesCheck(integration: LoadedIntegration): Promise<{
+    report: {
+        status: "checked";
+        findings: [];
+        unchecked: Array<{
+            file: string;
+            name: string;
+            reason: string;
+        }>;
+    };
+    notes: Note[];
+}>;
+/**
+ * The `name` a theme source passes to defineTheme for its exported theme,
+ * when the file says it as a string literal: `export const oceanTheme =
+ * defineTheme({name: 'ocean', ...})`. Null whenever only running the module
+ * could tell (a variable, a factory, a spread after the name, `extends`
+ * alone), so nothing is judged that a build would decide.
+ * @param {string} file
+ * @param {string} exportName
+ * @returns {string | null}
+ */
+export function literalThemeName(file: string, exportName: string): string | null;
 /**
  * Validate an already-LOADED integration (as produced by `loadIntegrations` —
  * absolute contribution roots plus identity) and return its issues. This is the
@@ -32,6 +128,17 @@ export function rootProblem(root: string): {
  * @returns {Promise<Issue[]>}
  */
 export function validateLoadedIntegration(loaded: LoadedIntegration): Promise<Issue[]>;
+/**
+ * Every contribution check, split: `issues` as validateLoadedIntegration
+ * returns them, and `listed`, the layout findings validate lists in its
+ * `layout` report without counting them.
+ * @param {LoadedIntegration} loaded
+ * @returns {Promise<{issues: Issue[], listed: Issue[]}>}
+ */
+export function validateLoadedIntegrationListed(loaded: LoadedIntegration): Promise<{
+    issues: Issue[];
+    listed: Issue[];
+}>;
 /**
  * @typedef {import('./issue').AstryxIntegrationIssue} Issue
  * @typedef {import('./integrations.mjs').LoadedIntegration} LoadedIntegration
@@ -42,5 +149,13 @@ export const INVALID_AGENT_DOCS: "invalid_agent_docs";
 export const INVALID_CLI_COMMAND: "invalid_cli_command";
 /** Stable issue code for a package whose provider ID is already claimed. */
 export const DUPLICATE_PROVIDER: "duplicate_provider";
+/**
+ * A note: information beside validate's issues that fails nothing, with the
+ * fix in its message.
+ */
+export type Note = {
+    code: string;
+    message: string;
+};
 export type Issue = import("./issue").AstryxIntegrationIssue;
 export type LoadedIntegration = import("./integrations.mjs").LoadedIntegration;