@memberjunction/query-gen 6.1.4 → 6.2.0-edge.1

package/src/core/QuestionGenerator.ts

@@ -9,9 +9,9 @@ import { AIEngine } from '@memberjunction/aiengine';
 import { MJAIPromptEntityExtended } from '@memberjunction/ai-core-plus';
 import { UserInfo, LogStatus } from '@memberjunction/core';
 import { QueryGenConfig } from '../cli/config';
-import { extractErrorMessage } from '../utils/error-handlers';
-import { formatEntityGroupForPrompt } from '../utils/entity-helpers';
-import { executePromptWithOverrides } from '../utils/prompt-helpers';
+import { ExtractErrorMessage } from '../utils/error-handlers';
+import { FormatEntityGroupForPrompt } from '../utils/entity-helpers';
+import { ExecutePromptWithOverrides } from '../utils/prompt-helpers';
 import { EntityGroup, BusinessQuestion } from '../data/schema';
 import { PROMPT_BUSINESS_QUESTION_GENERATOR } from '../prompts/PromptNames';
 
@@ -39,7 +39,7 @@ export class QuestionGenerator {
    * @param entityGroup - Entity group to generate questions for
    * @returns Array of validated business questions
    */
-  async generateQuestions(entityGroup: EntityGroup): Promise<BusinessQuestion[]> {
+  async GenerateQuestions(entityGroup: EntityGroup): Promise<BusinessQuestion[]> {
     try {
       // Ensure AIEngine is configured
       const aiEngine = AIEngine.Instance;
@@ -49,7 +49,7 @@ export class QuestionGenerator {
       const prompt = this.findPromptByName(aiEngine, PROMPT_BUSINESS_QUESTION_GENERATOR);
 
       // Format entity group for prompt
-      const entityMetadata = formatEntityGroupForPrompt(entityGroup);
+      const entityMetadata = FormatEntityGroupForPrompt(entityGroup);
 
       // Execute AI prompt
       const result = await this.executePrompt(prompt, entityMetadata);
@@ -75,11 +75,16 @@ export class QuestionGenerator {
       return validQuestions;
     } catch (error: unknown) {
       throw new Error(
-        extractErrorMessage(error, 'QuestionGenerator.generateQuestions')
+        ExtractErrorMessage(error, 'QuestionGenerator.generateQuestions')
       );
     }
   }
 
+  /** @deprecated Use {@link GenerateQuestions}. */
+  async generateQuestions(entityGroup: EntityGroup): Promise<BusinessQuestion[]> {
+    return this.GenerateQuestions(entityGroup);
+  }
+
   /**
    * Find prompt by name in AIEngine cache
    * Throws if prompt not found
@@ -103,7 +108,7 @@ export class QuestionGenerator {
     prompt: MJAIPromptEntityExtended,
     entityMetadata: unknown
   ): Promise<QuestionGeneratorResult> {
-    const result = await executePromptWithOverrides<QuestionGeneratorResult>(
+    const result = await ExecutePromptWithOverrides<QuestionGeneratorResult>(
       prompt,
       { entityGroupMetadata: entityMetadata },
       this.contextUser,

package/src/index.ts

@@ -28,21 +28,21 @@ export * from './data/schema';
 export * from './prompts/PromptNames';
 
 // Export configuration
-export { QueryGenConfig, loadConfig } from './cli/config';
+export { QueryGenConfig, LoadConfig, loadConfig } from './cli/config';
 
 // Export CLI commands
-export { generateCommand } from './cli/commands/generate';
-export { validateCommand } from './cli/commands/validate';
-export { exportCommand } from './cli/commands/export';
+export { GenerateCommand, generateCommand } from './cli/commands/generate';
+export { ValidateCommand, validateCommand } from './cli/commands/validate';
+export { ExportCommand, exportCommand } from './cli/commands/export';
 
 // Export utilities
-export { extractErrorMessage, requireValue, getPropertyOrDefault } from './utils/error-handlers';
+export { ExtractErrorMessage, extractErrorMessage, RequireValue, requireValue, GetPropertyOrDefault, getPropertyOrDefault } from './utils/error-handlers';
 export {
-  formatEntityMetadataForPrompt,
-  formatEntityGroupForPrompt,
-  findEntityById,
-  getPrimaryKeyFields,
-  getForeignKeyFields,
-  hasRelationships,
-  getRelationshipCount
+  FormatEntityMetadataForPrompt, formatEntityMetadataForPrompt,
+  FormatEntityGroupForPrompt, formatEntityGroupForPrompt,
+  FindEntityById, findEntityById,
+  GetPrimaryKeyFields, getPrimaryKeyFields,
+  GetForeignKeyFields, getForeignKeyFields,
+  HasRelationships, hasRelationships,
+  GetRelationshipCount, getRelationshipCount
 } from './utils/entity-helpers';

package/src/utils/category-builder.ts

@@ -15,7 +15,7 @@ import { QueryGenConfig } from '../cli/config';
  * @param entityGroup - Entity group for the query
  * @returns QueryCategoryInfo with full category details
  */
-export function buildQueryCategory(
+export function BuildQueryCategory(
   config: QueryGenConfig,
   entityGroup: EntityGroup
 ): QueryCategoryInfo {
@@ -52,6 +52,14 @@ export function buildQueryCategory(
   }
 }
 
+/** @deprecated Use {@link BuildQueryCategory}. */
+export function buildQueryCategory(
+  config: QueryGenConfig,
+  entityGroup: EntityGroup
+): QueryCategoryInfo {
+  return BuildQueryCategory(config, entityGroup);
+}
+
 /**
  * Extract all unique categories from validated queries
  * Returns categories in hierarchical order (root first, then children)
@@ -62,7 +70,7 @@ export function buildQueryCategory(
  * @param categories - Array of QueryCategoryInfo from validated queries
  * @returns Unique categories sorted hierarchically (includes auto-generated parents)
  */
-export function extractUniqueCategories(categories: QueryCategoryInfo[]): QueryCategoryInfo[] {
+export function ExtractUniqueCategories(categories: QueryCategoryInfo[]): QueryCategoryInfo[] {
   const uniqueMap = new Map<string, QueryCategoryInfo>();
 
   // Collect all unique categories (by path)
@@ -95,3 +103,8 @@ export function extractUniqueCategories(categories: QueryCategoryInfo[]): QueryC
 
   return result;
 }
+
+/** @deprecated Use {@link ExtractUniqueCategories}. */
+export function extractUniqueCategories(categories: QueryCategoryInfo[]): QueryCategoryInfo[] {
+  return ExtractUniqueCategories(categories);
+}

package/src/utils/entity-helpers.ts

@@ -23,7 +23,7 @@ import {
  * @param allEntities - All available entities for relationship lookups
  * @returns Formatted entity metadata ready for AI prompts
  */
-export function formatEntityMetadataForPrompt(entity: EntityInfo, allEntities: EntityInfo[]): EntityMetadataForPrompt {
+export function FormatEntityMetadataForPrompt(entity: EntityInfo, allEntities: EntityInfo[]): EntityMetadataForPrompt {
   return {
     entityName: entity.Name,
     description: entity.Description || '',
@@ -35,6 +35,11 @@ export function formatEntityMetadataForPrompt(entity: EntityInfo, allEntities: E
   };
 }
 
+/** @deprecated Use {@link FormatEntityMetadataForPrompt}. */
+export function formatEntityMetadataForPrompt(entity: EntityInfo, allEntities: EntityInfo[]): EntityMetadataForPrompt {
+  return FormatEntityMetadataForPrompt(entity, allEntities);
+}
+
 /**
  * Format entity fields for AI prompt
  * Includes field metadata with types, descriptions, and relationship info
@@ -91,7 +96,7 @@ function formatEntityRelationships(entity: EntityInfo, allEntities: EntityInfo[]
   return entity.RelatedEntities
     .filter(rel => entityNamesInGroup.has(rel.RelatedEntity))  // Only include relationships within the group
     .map(rel => {
-      const relatedEntity = findEntityById(rel.RelatedEntityID, allEntities);
+      const relatedEntity = FindEntityById(rel.RelatedEntityID, allEntities);
 
       // Determine the foreign key field based on relationship type and available fields
       let foreignKeyField: string;
@@ -156,40 +161,65 @@ function findEntityByName(name: string, entities: EntityInfo[]): EntityInfo | un
 /**
  * Find entity by ID in array
  */
-export function findEntityById(id: string, entities: EntityInfo[]): EntityInfo | undefined {
+export function FindEntityById(id: string, entities: EntityInfo[]): EntityInfo | undefined {
   return entities.find((e) => UUIDsEqual(e.ID, id));
 }
 
+/** @deprecated Use {@link FindEntityById}. */
+export function findEntityById(id: string, entities: EntityInfo[]): EntityInfo | undefined {
+  return FindEntityById(id, entities);
+}
+
 /**
  * Get primary key field(s) for an entity
  */
-export function getPrimaryKeyFields(entity: EntityInfo): EntityFieldInfo[] {
+export function GetPrimaryKeyFields(entity: EntityInfo): EntityFieldInfo[] {
   return entity.Fields.filter((f) => f.IsPrimaryKey);
 }
 
+/** @deprecated Use {@link GetPrimaryKeyFields}. */
+export function getPrimaryKeyFields(entity: EntityInfo): EntityFieldInfo[] {
+  return GetPrimaryKeyFields(entity);
+}
+
 /**
  * Get foreign key fields for an entity
  */
-export function getForeignKeyFields(entity: EntityInfo): EntityFieldInfo[] {
+export function GetForeignKeyFields(entity: EntityInfo): EntityFieldInfo[] {
   return entity.Fields.filter((f) => isForeignKeyField(f));
 }
 
+/** @deprecated Use {@link GetForeignKeyFields}. */
+export function getForeignKeyFields(entity: EntityInfo): EntityFieldInfo[] {
+  return GetForeignKeyFields(entity);
+}
+
 /**
  * Check if an entity has any relationships
  * Uses EntityInfo.RelatedEntities getter
  */
-export function hasRelationships(entity: EntityInfo, allEntities: EntityInfo[]): boolean {
+export function HasRelationships(entity: EntityInfo, allEntities: EntityInfo[]): boolean {
   return entity.RelatedEntities.length > 0;
 }
 
+/** @deprecated Use {@link HasRelationships}. */
+export function hasRelationships(entity: EntityInfo, allEntities: EntityInfo[]): boolean {
+  return HasRelationships(entity, allEntities);
+}
+
 /**
  * Get count of relationships for an entity
  * Uses EntityInfo.RelatedEntities getter
  */
-export function getRelationshipCount(entity: EntityInfo, allEntities: EntityInfo[]): number {
+export function GetRelationshipCount(entity: EntityInfo, allEntities: EntityInfo[]): number {
   return entity.RelatedEntities.length;
 }
 
+/** @deprecated Use {@link GetRelationshipCount}. */
+export function getRelationshipCount(entity: EntityInfo, allEntities: EntityInfo[]): number {
+  return GetRelationshipCount(entity, allEntities);
+}
+
 /**
  * Format an entire entity group for AI prompt consumption
  * Converts all entities in the group to structured metadata
@@ -197,8 +227,13 @@ export function getRelationshipCount(entity: EntityInfo, allEntities: EntityInfo
  * @param entityGroup - Entity group to format
  * @returns Array of formatted entity metadata for Nunjucks template
  */
-export function formatEntityGroupForPrompt(entityGroup: EntityGroup): EntityMetadataForPrompt[] {
+export function FormatEntityGroupForPrompt(entityGroup: EntityGroup): EntityMetadataForPrompt[] {
   return entityGroup.entities.map((entity) =>
-    formatEntityMetadataForPrompt(entity, entityGroup.entities)
+    FormatEntityMetadataForPrompt(entity, entityGroup.entities)
   );
 }
+
+/** @deprecated Use {@link FormatEntityGroupForPrompt}. */
+export function formatEntityGroupForPrompt(entityGroup: EntityGroup): EntityMetadataForPrompt[] {
+  return FormatEntityGroupForPrompt(entityGroup);
+}

package/src/utils/error-handlers.ts

@@ -8,7 +8,7 @@
  * Extract error message from unknown error type
  * Uses MJ's extractErrorMessage pattern
  */
-export function extractErrorMessage(error: unknown, context: string): string {
+export function ExtractErrorMessage(error: unknown, context: string): string {
   if (error instanceof Error) {
     return `${context}: ${error.message}`;
   }
@@ -18,20 +18,30 @@ export function extractErrorMessage(error: unknown, context: string): string {
   return `${context}: Unknown error occurred`;
 }
 
+/** @deprecated Use {@link ExtractErrorMessage}. */
+export function extractErrorMessage(error: unknown, context: string): string {
+  return ExtractErrorMessage(error, context);
+}
+
 /**
  * Validate required value is not null/undefined
  */
-export function requireValue<T>(value: T | null | undefined, fieldName: string): T {
+export function RequireValue<T>(value: T | null | undefined, fieldName: string): T {
   if (value === null || value === undefined) {
     throw new Error(`Required value '${fieldName}' is missing`);
   }
   return value;
 }
 
+/** @deprecated Use {@link RequireValue}. */
+export function requireValue<T>(value: T | null | undefined, fieldName: string): T {
+  return RequireValue(value, fieldName);
+}
+
 /**
  * Get property with fallback value
  */
-export function getPropertyOrDefault<T>(
+export function GetPropertyOrDefault<T>(
   obj: Record<string, unknown>,
   key: string,
   defaultValue: T
@@ -39,3 +49,12 @@ export function getPropertyOrDefault<T>(
   const value = obj[key];
   return value !== undefined ? (value as T) : defaultValue;
 }
+
+/** @deprecated Use {@link GetPropertyOrDefault}. */
+export function getPropertyOrDefault<T>(
+  obj: Record<string, unknown>,
+  key: string,
+  defaultValue: T
+): T {
+  return GetPropertyOrDefault(obj, key, defaultValue);
+}

package/src/utils/graph-helpers.ts

@@ -25,7 +25,7 @@ export interface EntityMetadataForPrompt {
  * Products: → OrderDetails, → Categories
  * ```
  */
-export function generateRelationshipGraph(entities: EntityInfo[]): string {
+export function GenerateRelationshipGraph(entities: EntityInfo[]): string {
   const lines: string[] = [];
 
   for (const entity of entities) {
@@ -44,6 +44,11 @@ export function generateRelationshipGraph(entities: EntityInfo[]): string {
   return lines.join('\n');
 }
 
+/** @deprecated Use {@link GenerateRelationshipGraph}. */
+export function generateRelationshipGraph(entities: EntityInfo[]): string {
+  return GenerateRelationshipGraph(entities);
+}
+
 /**
  * Generates a Mermaid diagram for richer visualization
  *
@@ -55,7 +60,7 @@ export function generateRelationshipGraph(entities: EntityInfo[]): string {
  *   Orders[Orders] --> OrderDetails[OrderDetails]
  * ```
  */
-export function generateMermaidDiagram(entities: EntityInfo[]): string {
+export function GenerateMermaidDiagram(entities: EntityInfo[]): string {
   const lines = ['graph LR'];
   const processedPairs = new Set<string>();
 
@@ -76,6 +81,11 @@ export function generateMermaidDiagram(entities: EntityInfo[]): string {
   return lines.join('\n');
 }
 
+/** @deprecated Use {@link GenerateMermaidDiagram}. */
+export function generateMermaidDiagram(entities: EntityInfo[]): string {
+  return GenerateMermaidDiagram(entities);
+}
+
 /**
  * Formats entity metadata for LLM prompt (concise version with key info)
  *
@@ -85,7 +95,7 @@ export function generateMermaidDiagram(entities: EntityInfo[]): string {
  * - Field count (as a proxy for data richness)
  * - Related entities with relationship types
  */
-export function formatEntitiesForPrompt(entities: EntityInfo[]): EntityMetadataForPrompt[] {
+export function FormatEntitiesForPrompt(entities: EntityInfo[]): EntityMetadataForPrompt[] {
   return entities.map(entity => ({
     Name: entity.Name,
     Description: entity.Description || 'No description available',
@@ -97,3 +107,8 @@ export function formatEntitiesForPrompt(entities: EntityInfo[]): EntityMetadataF
     }))
   }));
 }
+
+/** @deprecated Use {@link FormatEntitiesForPrompt}. */
+export function formatEntitiesForPrompt(entities: EntityInfo[]): EntityMetadataForPrompt[] {
+  return FormatEntitiesForPrompt(entities);
+}

package/src/utils/prompt-helpers.ts

@@ -22,7 +22,7 @@ import { QueryGenConfig } from '../cli/config';
  * @param config - QueryGen configuration (for model/vendor overrides)
  * @returns Promise resolving to the prompt result
  */
-export async function executePromptWithOverrides<T>(
+export async function ExecutePromptWithOverrides<T>(
   prompt: MJAIPromptEntityExtended,
   data: Record<string, unknown>,
   contextUser: UserInfo,
@@ -46,6 +46,16 @@ export async function executePromptWithOverrides<T>(
   return await runner.ExecutePrompt<T>(promptParams);
 }
 
+/** @deprecated Use {@link ExecutePromptWithOverrides}. */
+export async function executePromptWithOverrides<T>(
+  prompt: MJAIPromptEntityExtended,
+  data: Record<string, unknown>,
+  contextUser: UserInfo,
+  config: QueryGenConfig
+): Promise<{ success: boolean; result?: T; errorMessage?: string }> {
+  return ExecutePromptWithOverrides(prompt, data, contextUser, config);
+}
+
 /**
  * Resolve model/vendor names to IDs for AIPromptParams.override
  *

package/src/utils/user-helpers.ts

@@ -14,7 +14,7 @@ import { UserCache } from '@memberjunction/generic-database-provider';
  * @returns The System UserInfo object from the cache
  * @throws Error if System user is not found in cache or doesn't have Developer role
  */
-export function getSystemUser(): UserInfo {
+export function GetSystemUser(): UserInfo {
   const sysUser = UserCache.Instance.UserByName("System", false);
   if (!sysUser) {
     throw new Error(
@@ -37,3 +37,8 @@ export function getSystemUser(): UserInfo {
 
   return sysUser;
 }
+
+/** @deprecated Use {@link GetSystemUser}. */
+export function getSystemUser(): UserInfo {
+  return GetSystemUser();
+}

package/src/vectors/EmbeddingService.ts

@@ -34,7 +34,7 @@ export class EmbeddingService {
    * @param query - Query to embed (partial structure with text fields)
    * @returns Embeddings for all fields
    */
-  async embedQuery(query: {
+  async EmbedQuery(query: {
     userQuestion: string;
     description: string;
     technicalDescription: string;
@@ -55,6 +55,15 @@ export class EmbeddingService {
     };
   }
 
+  /** @deprecated Use {@link EmbedQuery}. */
+  async embedQuery(query: {
+    userQuestion: string;
+    description: string;
+    technicalDescription: string;
+  }): Promise<QueryEmbeddings> {
+    return this.EmbedQuery(query);
+  }
+
   /**
    * Embed all golden queries for few-shot learning
    *
@@ -65,11 +74,11 @@ export class EmbeddingService {
    * @param goldenQueries - Array of golden queries to embed
    * @returns Array of golden queries with their embeddings
    */
-  async embedGoldenQueries(goldenQueries: GoldenQuery[]): Promise<EmbeddedGoldenQuery[]> {
+  async EmbedGoldenQueries(goldenQueries: GoldenQuery[]): Promise<EmbeddedGoldenQuery[]> {
     const embedded: EmbeddedGoldenQuery[] = [];
 
     for (const query of goldenQueries) {
-      const embeddings = await this.embedQuery({
+      const embeddings = await this.EmbedQuery({
         userQuestion: query.userQuestion,
         description: query.description,
         technicalDescription: query.technicalDescription,
@@ -84,13 +93,18 @@ export class EmbeddingService {
     return embedded;
   }
 
+  /** @deprecated Use {@link EmbedGoldenQueries}. */
+  async embedGoldenQueries(goldenQueries: GoldenQuery[]): Promise<EmbeddedGoldenQuery[]> {
+    return this.EmbedGoldenQueries(goldenQueries);
+  }
+
   /**
    * Embed multiple queries in batch
    *
    * @param queries - Array of queries to embed
    * @returns Array of embeddings corresponding to input queries
    */
-  async embedQueries(
+  async EmbedQueries(
     queries: Array<{
       userQuestion: string;
       description: string;
@@ -100,10 +114,21 @@ export class EmbeddingService {
     const embeddings: QueryEmbeddings[] = [];
 
     for (const query of queries) {
-      const embedding = await this.embedQuery(query);
+      const embedding = await this.EmbedQuery(query);
       embeddings.push(embedding);
     }
 
     return embeddings;
   }
+
+  /** @deprecated Use {@link EmbedQueries}. */
+  async embedQueries(
+    queries: Array<{
+      userQuestion: string;
+      description: string;
+      technicalDescription: string;
+    }>
+  ): Promise<QueryEmbeddings[]> {
+    return this.EmbedQueries(queries);
+  }
 }

package/src/vectors/SimilaritySearch.ts

@@ -49,7 +49,7 @@ export class SimilaritySearch extends SimpleVectorService {
    * @param topK - Number of most similar queries to return (default: 5)
    * @returns Array of top-K most similar golden queries with scores
    */
-  async findSimilarQueries(
+  async FindSimilarQueries(
     queryEmbeddings: QueryEmbeddings,
     goldenEmbeddings: EmbeddedGoldenQuery[],
     topK: number = 5
@@ -70,6 +70,15 @@ export class SimilaritySearch extends SimpleVectorService {
     return this.selectTopK(similarities, topK);
   }
 
+  /** @deprecated Use {@link FindSimilarQueries}. */
+  async findSimilarQueries(
+    queryEmbeddings: QueryEmbeddings,
+    goldenEmbeddings: EmbeddedGoldenQuery[],
+    topK: number = 5
+  ): Promise<SimilarQuery[]> {
+    return this.FindSimilarQueries(queryEmbeddings, goldenEmbeddings, topK);
+  }
+
   /**
    * Calculate cosine similarity for each field separately
    * Note: name field excluded as queries don't have names during generation