@b4moss/hyogen-md 0.10.0

package/dist/index.d.ts

@@ -0,0 +1,99 @@
+export declare function build(options: BuildOptions): Promise<BuildResult>;
+
+export declare type BuildOptions = RenderOptions & {
+    input: string | string[];
+    outDir: string;
+    includeUnderscoreEntries?: boolean;
+    context?: HyogenContext;
+    serverContext?: HyogenContext;
+};
+
+export declare type BuildResult = {
+    files: {
+        path: string;
+        markdown: string;
+    }[];
+    warnings: HyogenWarning[];
+};
+
+declare type ClientRenderOptions = RenderOptions & {
+    /** Rejected on client — use renderServer/build instead */
+    serverContext?: HyogenContext;
+};
+
+export declare function createFsLoader(options?: FsLoaderOptions): Loader;
+
+export declare function createHyogenError(options: {
+    code: string;
+    message?: string;
+    path?: string;
+    details?: Record<string, unknown>;
+}): HyogenError;
+
+export declare function createNodeLoader(options?: NodeLoaderOptions): Loader;
+
+/**
+ * Formats a diagnostic as multi-line log text (api.md).
+ * Does not write to console — callers decide how to output.
+ */
+export declare function formatDiagnosticLog(kind: "error" | "warning", diagnostic: HyogenDiagnostic): string;
+
+/** Unknown codes resolve to empty string (implementation choice for v0.1). */
+export declare function formatMessage(code: string, details?: Record<string, unknown>): string;
+
+declare type FsLoaderOptions = {
+    from?: string;
+    via?: "include" | "component" | "extend";
+};
+
+export declare type HyogenContext = Record<string, unknown>;
+
+export declare type HyogenDiagnostic = {
+    code: string;
+    message: string;
+    path?: string;
+    details?: Record<string, unknown>;
+};
+
+export declare type HyogenError = Error & HyogenDiagnostic;
+
+export declare type HyogenWarning = HyogenDiagnostic;
+
+/** Returns true when path is an http(s) URL. */
+export declare function isRemotePath(path: string): boolean;
+
+export declare type Loader = (path: string) => Promise<string>;
+
+declare type NodeLoaderOptions = FsLoaderOptions;
+
+/**
+ * Client-side render entry. Requires an injected loader; never uses
+ * createNodeLoader / resolveRenderInput (no FS or network in the library).
+ */
+export declare function renderClient(input: string | {
+    path: string;
+}, context?: HyogenContext, options?: ClientRenderOptions): Promise<RenderResult>;
+
+export declare type RenderOptions = {
+    preserveFrontMatter?: boolean;
+    preserveHgComments?: boolean;
+    loader?: Loader;
+    root?: string;
+    path?: string;
+    constrainToRoot?: boolean;
+};
+
+export declare type RenderResult = {
+    markdown: string;
+    warnings: HyogenWarning[];
+};
+
+export declare function renderServer(input: string | {
+    path: string;
+}, context?: HyogenContext, options?: ServerRenderOptions): Promise<RenderResult>;
+
+export declare type ServerRenderOptions = RenderOptions & {
+    serverContext?: HyogenContext;
+};
+
+export { }