@fhiron/sdk 0.1.0

package/src/_linter/rules.d.ts

@@ -0,0 +1,105 @@
+// Type declarations for @fhiron/linter rules.
+// The runtime is pure JS (CommonJS) so it works unchanged in Node, the
+// dashboard's Web Worker, and the MCP connector.
+
+export type Severity = "error" | "warning" | "info";
+
+export interface QuickFix {
+  /** Human-readable title shown in the dashboard and returned to the IDE. */
+  title: string;
+  /** RFC 6901 pointer into the FHIR resource (e.g. /identifier/0/value). */
+  jsonPointer: string;
+  /** Replacement value for the target node. */
+  replacement: unknown;
+}
+
+export interface LintIssue {
+  /** Stable identifier — e.g. cl-run-01. The IA reads this, not the prose. */
+  code: string;
+  severity: Severity;
+  /** Dotted FHIR path (Patient.identifier[0].value). Empty string for root. */
+  path: string;
+  /** Message in Spanish, Sentence case, with profile reference. */
+  message: string;
+  /** Optional pedagogical context — explains POR QUÉ the issue is wrong. */
+  why?: string;
+  /** Optional canonical URL of the StructureDefinition / CodeSystem that fails. */
+  profileUrl?: string;
+  /** Optional human docs URL (docs.fhiron.cl/errores/{code}). */
+  docsUrl?: string;
+  /** Optional textual suggestion when no automatic quickFix is possible. */
+  suggestion?: string;
+  /** Optional small example (5–10 lines) of a correct shape. */
+  example?: unknown;
+  /** Optional automated correction. */
+  quickFix?: QuickFix;
+  /** Bundle context: when the issue belongs to a Bundle entry, the entry index. */
+  entryIndex?: number;
+}
+
+export declare const RUN_SYSTEMS: readonly string[];
+
+export interface LintOptions {
+  /** Si false, no agrega los campos pedagógicos (why, profileUrl, etc.). Default: true. */
+  enrich?: boolean;
+}
+
+export declare function lintResource(
+  input: object | string,
+  options?: LintOptions,
+): LintIssue[];
+
+export declare function applyQuickFix(
+  input: object | string,
+  fix: QuickFix,
+): string;
+
+export declare function stripRunDots(value: string): string;
+
+export interface RunDvResult {
+  valid: boolean;
+  expected?: string;
+  given?: string;
+  /** Present when valid:true — cuerpo-DV sin puntos. */
+  normalized?: string;
+  /** Present when valid:false and format was parseable — cuerpo-DV sin puntos. */
+  cleaned?: string;
+  /** Human-readable error message when valid:false. */
+  message?: string;
+}
+
+export declare function validateRunDv(raw: string): RunDvResult;
+
+export interface RunFormatResult {
+  valid: boolean;
+  message: string | null;
+  cleaned: string | null;
+}
+
+export declare function classifyRunFormat(raw: string): RunFormatResult;
+
+export declare function translateJsonParseError(err: unknown): string;
+
+/**
+ * Devuelve la entrada del catálogo (catalog.js) para un código, o null.
+ * Útil para `fhiron_explain_code` y para enriquecer issues servidor.
+ */
+export declare function lookupCode(code: string): {
+  why?: string;
+  profileUrl?: string;
+  docsUrl?: string;
+  suggestion?: string;
+  example?: unknown;
+} | null;
+
+/**
+ * Lista todos los códigos del catálogo. Útil para tests y para ofrecer
+ * sugerencias a la IA cuando el usuario pregunta "¿qué errores conoces?".
+ */
+export declare function listCodes(): string[];
+
+/**
+ * Aplica la información del catálogo a un issue (mutativo + return).
+ * Si el código no está en el catálogo, devuelve el issue intacto.
+ */
+export declare function enrichIssue(issue: LintIssue): LintIssue;