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

package/foundation/integrations/public-imports.d.mts

@@ -0,0 +1,118 @@
+// @generated by scripts/sync-api-types.mjs from the JSDoc in foundation/**/*.mjs.
+// DO NOT EDIT — run `pnpm sync:api-types` to regenerate.
+
+/**
+ * Split a bare specifier into its package name and `./`-prefixed subpath.
+ * @param {string} specifier
+ * @returns {{pkg: string, subpath: string} | null}
+ */
+export function splitSpecifier(specifier: string): {
+    pkg: string;
+    subpath: string;
+} | null;
+/**
+ * Read the import statements of a module or a snippet: named, default,
+ * aliased, namespace and type-only. A snippet that does not parse (an example
+ * with elisions, say) falls back to reading `import … from '…'` lines.
+ * @param {string} text
+ * @returns {ImportStatement[]}
+ */
+export function readImports(text: string): ImportStatement[];
+/**
+ * Every name (runtime or type) a module exports, and whether the list is
+ * complete: an `export *` from another package, `export =`, or a module that
+ * does not parse leaves it incomplete, and then no name is judged missing.
+ * @param {string} file
+ * @param {ExportNameCache} [cache] export lists already read in this check
+ * @returns {{names: Set<string>, complete: boolean, types: Set<string>, typed: boolean}}
+ *   `types`: the names exported only as types (an interface, a type alias,
+ *   `export type`); `typed`: the list includes every type the module
+ *   exports (TypeScript source, or a JavaScript module whose declaration
+ *   file was read in full), so a name absent from it is absent as a type too
+ */
+export function moduleExportNames(file: string, cache?: ExportNameCache): {
+    names: Set<string>;
+    complete: boolean;
+    types: Set<string>;
+    typed: boolean;
+};
+/**
+ * Every public-import finding for one package, as notes, and the report of
+ * what could not be judged. It returns no issues: the notes are listed
+ * only, and fail `--strict` from the next minor release.
+ * @param {string} packageDir
+ * @param {any} integration the loaded integration record
+ * @returns {Promise<{issues: Issue[], notes: PublicImportNote[], report: PublicImportsReport}>}
+ *   `issues` is always empty: kept so validate's call site stays one shape
+ */
+export function publicImportIssues(packageDir: string, integration: any): Promise<{
+    issues: Issue[];
+    notes: PublicImportNote[];
+    report: PublicImportsReport;
+}>;
+export type SubpathDeclaration = import("./exports-subpaths.mjs").SubpathDeclaration;
+export type PublicImportUnchecked = import("../../api/integration/validate-integration.type.mjs").PublicImportUnchecked;
+export type PublicImportsReport = import("../../api/integration/validate-integration.type.mjs").PublicImportsReport;
+export type PublicImportNote = {
+    code: string;
+    message: string;
+};
+export type Issue = import("./issue").AstryxIntegrationIssue;
+export type ImportBinding = {
+    /**
+     * the exported name (`default` for a default import)
+     */
+    imported: string;
+    typeOnly: boolean;
+};
+export type ImportStatement = {
+    source: string;
+    names: ImportBinding[];
+    namespace: boolean;
+    /**
+     * the whole statement is `import type`
+     */
+    typeOnly?: boolean | undefined;
+};
+/**
+ * Export lists read during one public-import check, by file. Scoped to that
+ * check, so a later check in the same process rereads every module.
+ */
+export type ExportNameCache = Map<string, {
+    names: Set<string>;
+    complete: boolean;
+    types: Set<string>;
+    typed: boolean;
+}>;
+export type Context = {
+    packageDir: string;
+    /**
+     * the package name; null when package.json has
+     * none, and then no import of the package's own name is judged
+     */
+    name: string | null;
+    exportsField: unknown;
+    coreDir: string | null;
+    corePkg: any;
+    /**
+     * what could not be judged
+     */
+    unchecked: PublicImportUnchecked[];
+    /**
+     * export lists read in this check
+     */
+    exportNames: ExportNameCache;
+    /**
+     * why no name is judged missing
+     * (a module augmentation in the package); null when none, unset until read
+     */
+    augmentation?: string | null | undefined;
+    /**
+     * the package.json `files` entries, normalized
+     */
+    files: string[];
+    /**
+     * the integration's contribution roots, absolute
+     */
+    roots: string[];
+};