@mikedown/core 0.3.0 → 0.4.0

package/dist/schema-DVfssxQX.d.ts

@@ -0,0 +1,100 @@
+import { f as AiFeatureSettings, a6 as AiGhostTextOptions, i as AiEngineKind, A as AiSettings, _ as AiDocBase, m as AiDocsOptions, a2 as AiDocsSettings } from './types-DO8UBybZ.js';
+
+/**
+ * `mikedown.ai.*` settings: parse (validate, fill defaults, keep unknown
+ * keys) and serialize back to a settings patch.
+ *
+ * `parseAiSettings` never throws. Malformed entries (an engine that is not
+ * an object or has no base URL, a model with no id, a route without both
+ * ids) are dropped with a warning; everything it does not recognize is kept
+ * as is, on every object, so a newer version's settings survive a save.
+ * Engines without an id get one, once: the id is written back by
+ * `serializeAiSettings`, so it is stable from then on.
+ */
+
+interface ParseAiSettingsOptions {
+    /** Id for an engine that has none. Default: a slug of its name plus random characters. */
+    generateId?: (name: string) => string;
+    /** Called once per dropped or repaired entry. Default `console.warn`. */
+    onWarning?: (message: string) => void;
+}
+/** The top-level keys, without the `ai.` prefix. */
+declare const AI_SETTINGS_KEYS: readonly ["enabled", "allowCloud", "engines", "routing", "features", "localNetworks", "showToolbarButton", "activityPanel", "docBases", "docs"];
+
+declare function isKnownEngineKind(kind: string): kind is AiEngineKind;
+/** A kind only one host runs, with no address or key (`vscode-lm`); see `AI_HOST_ENGINE_KINDS`. */
+declare function isHostEngineKind(kind: string): boolean;
+/** A new engine id: `omlx-mac-studio-k3f9a2`. Never shown, only has to be unique and stable. */
+declare function generateAiId(name?: string): string;
+/**
+ * Read `raw` as AI settings. Accepts the nested object VS Code returns for
+ * `getConfiguration('mikedown.ai')` (`{ enabled, engines, ... }`) or a flat
+ * store with `ai.`-prefixed keys (Desktop, a settings patch). Anything else,
+ * including undefined, gives the defaults.
+ */
+declare function parseAiSettings(raw: unknown, opts?: ParseAiSettingsOptions): AiSettings;
+/** Defaults and ranges for `features.ghostText` (decision D12). */
+declare const GHOST_DELAY_MS_DEFAULT = 400;
+declare const GHOST_DELAY_MS_MIN = 100;
+declare const GHOST_DELAY_MS_MAX = 5000;
+declare const GHOST_MAX_TOKENS_DEFAULT = 48;
+declare const GHOST_MAX_TOKENS_MIN = 8;
+declare const GHOST_MAX_TOKENS_MAX = 256;
+/**
+ * The Inline suggestions knobs: defaults (400 ms, 48 tokens, `auto`, local
+ * engines only) for anything absent or of the wrong type, numbers rounded and
+ * clamped (delay 100 to 5000 ms, tokens 8 to 256).
+ */
+declare function ghostTextOptions(features: AiFeatureSettings | undefined): AiGhostTextOptions;
+/** The settings patch keys, `ai.`-prefixed: what the editor sends to `host.saveSettings`. */
+type AiSettingsPatch = Record<`ai.${string}`, unknown>;
+/**
+ * Settings to a `saveSettings` patch: one `ai.<key>` per top-level key,
+ * including unknown ones, as plain JSON (deep copies). VS Code writes each as
+ * `mikedown.ai.<key>`; Desktop stores the flat keys. Secrets are never here.
+ */
+declare function serializeAiSettings(settings: AiSettings): AiSettingsPatch;
+/** What `checkDocRoot` says about one folder path. */
+type DocRootCheck = {
+    ok: true;
+    path: string;
+    windows: boolean;
+} | {
+    ok: false;
+    reason: string;
+};
+/**
+ * Is `raw` an acceptable base root (decision 2)? Absolute, normalized
+ * (separators collapsed, `.` and `..` resolved, no trailing separator), no
+ * `${...}` token, not a filesystem root, and not a markdown file where the
+ * name says so. Pure string work: a host still checks the folder on disk.
+ * POSIX (`/a/b`), drive (`C:\a\b`, `C:/a/b`) and UNC (`\\server\share\a`)
+ * paths are accepted; the result keeps the style it came in (a drive letter
+ * is upper-cased, a Windows path uses `\`).
+ */
+declare function checkDocRoot(raw: unknown): DocRootCheck;
+/** The key two roots are compared by: case-insensitive for Windows paths only. */
+declare function docRootKey(path: string): string;
+/**
+ * A base's home override: a markdown file name, or a relative path under the
+ * root, with `/` separators. No absolute path, no `..`, no `${...}`. Null
+ * when `raw` is not one.
+ */
+declare function normalizeDocHomeFile(raw: unknown): string | null;
+/**
+ * Read `ai.docBases`. Drops, each with a warning that says why: an entry that
+ * is not an object, one with no valid root, a root that fails `checkDocRoot`
+ * or repeats another root (in this base or any earlier one; case-insensitive
+ * for Windows paths). A bad `homeFile` is dropped and the base kept. A base
+ * with no id gets one, once (written back by `serializeAiSettings`).
+ * `allowCloud` is false unless exactly `true`; `enabled` is true unless
+ * exactly `false`. Unknown keys survive.
+ */
+declare function parseDocBases(raw: unknown, genId: (name: string) => string, warn: (m: string) => void): AiDocBase[];
+/** Read `ai.docs`: hops clamped to 1 to 5, share to 30 to 80, `navigateBy` to `section` or `page`. Unknown keys survive. */
+declare function parseDocsOptions(raw: unknown, warn: (m: string) => void): AiDocsOptions;
+/** What the navigation loop runs with: the advanced options plus the bases. */
+declare function resolveDocsSettings(settings: Pick<AiSettings, 'docBases' | 'docs'>): AiDocsSettings;
+
+export { GHOST_DELAY_MS_DEFAULT as G, AI_SETTINGS_KEYS as a, GHOST_DELAY_MS_MAX as b, GHOST_DELAY_MS_MIN as c, GHOST_MAX_TOKENS_DEFAULT as d, GHOST_MAX_TOKENS_MAX as e, GHOST_MAX_TOKENS_MIN as f, checkDocRoot as g, docRootKey as h, generateAiId as i, ghostTextOptions as j, isHostEngineKind as k, isKnownEngineKind as l, parseDocBases as m, normalizeDocHomeFile as n, parseDocsOptions as o, parseAiSettings as p, resolveDocsSettings as r, serializeAiSettings as s };
+export type { AiSettingsPatch as A, DocRootCheck as D, ParseAiSettingsOptions as P };