@papernote/ui
Version:
A modern React component library with a paper notebook aesthetic - minimal, professional, and expressive
41 lines • 1.31 kB
TypeScript
/**
* SQL to Natural Language Translator
* Converts technical SQL queries into user-friendly descriptions
*/
export interface QueryDescription {
summary: string;
details: string[];
technical?: string;
}
/**
* Configuration for friendly names
* Maps technical database/field names to business-friendly terms
*/
export interface FriendlyNameConfig {
tables?: Record<string, string>;
fields?: Record<string, string>;
}
/**
* Converts a SQL query into natural language description
* @param sql - The SQL query to translate
* @param customNames - Optional custom friendly name mappings
* @param relatedData - Optional related data information with entity descriptions
* @param appliedFilters - Optional pre-processed filter information with display values
*/
export declare function translateSqlToNaturalLanguage(sql: string, customNames?: FriendlyNameConfig, relatedData?: Array<{
entity: string;
description: string;
type: 'join' | 'include' | 'lookup';
}>, appliedFilters?: Array<{
key: string;
label: string;
value: any;
displayValue?: string;
}>, calculations?: Array<{
field: string;
description: string;
formula?: string;
type: string;
example?: string;
}>): QueryDescription;
//# sourceMappingURL=sqlToNaturalLanguage.d.ts.map