@b4moss/hyogen-md 0.10.1 → 0.12.0

package/dist/index.d.ts

@@ -6,6 +6,7 @@ export declare type BuildOptions = RenderOptions & {
     includeUnderscoreEntries?: boolean;
     context?: HyogenContext;
     serverContext?: HyogenContext;
+    dataSources?: DataSourcesMap;
 };
 
 export declare type BuildResult = {
@@ -19,6 +20,8 @@ export declare type BuildResult = {
 declare type ClientRenderOptions = RenderOptions & {
     /** Rejected on client — use renderServer/build instead */
     serverContext?: HyogenContext;
+    /** Rejected on client — use renderServer/build instead */
+    dataSources?: DataSourcesMap;
 };
 
 export declare function createFsLoader(options?: FsLoaderOptions): Loader;
@@ -32,6 +35,8 @@ export declare function createHyogenError(options: {
 
 export declare function createNodeLoader(options?: NodeLoaderOptions): Loader;
 
+export declare type DataSourcesMap = Record<string, string>;
+
 /**
  * Formats a diagnostic as multi-line log text (api.md).
  * Does not write to console — callers decide how to output.
@@ -62,6 +67,13 @@ export declare type HyogenWarning = HyogenDiagnostic;
 /** Returns true when path is an http(s) URL. */
 export declare function isRemotePath(path: string): boolean;
 
+export declare function loadDataSources(sources: DataSourcesMap, options?: LoadDataSourcesOptions): Promise<HyogenContext>;
+
+declare type LoadDataSourcesOptions = {
+    root?: string;
+    loader?: Loader;
+};
+
 export declare type Loader = (path: string) => Promise<string>;
 
 declare type NodeLoaderOptions = FsLoaderOptions;
@@ -94,6 +106,8 @@ export declare function renderServer(input: string | {
 
 export declare type ServerRenderOptions = RenderOptions & {
     serverContext?: HyogenContext;
+    /** Variable name → root-relative data file path (YAML / JSON / CSV). */
+    dataSources?: DataSourcesMap;
 };
 
 export { }