@garrix82/reactgenie-dsl 1.0.0 → 1.0.2

package/lib/nl/prompt-res.ts

@@ -1,207 +0,0 @@
-import { ExampleParse } from "./prompt-gen";
-
-export const pre_section_separator = "\n";
-export const post_section_separator = "\n\n\n";
-
-export const class_prequel = "// Here are all the functions";
-
-export const array_definition =
-  "extension Array<Type> {\n" +
-  "    // Find items with matching fields in an array\n" +
-  "    Array<Type> matching(field: Field, value: Type);\n" +
-  "\n" +
-  "    // Find items with field in an array that contains a specific value\n" +
-  "    Array<Type> contains(field: Field, value: Type);\n" +
-  "\n" +
-  "    // Find items with exact fields in an array\n" +
-  "    Array<Type> equals(field: Field, value: Type);\n" +
-  "\n" +
-  "    // Find items with the field above from (if provided) and below to (if provided).\n" +
-  "    Array<Type> between(field: Field, from?: Type, to?: Type);\n" +
-  "\n" +
-  "    // Sort an array based on a specific field in ascending or descending order\n" +
-  "    Array<Type> sort(field: Field, ascending: bool);\n" +
-  "\n" +
-  "    // Get length of an array\n" +
-  "    int length();\n" +
-  "}";
-
-export const class_separator = "\n\n";
-
-export const example_prequel = "// Here are all the examples that we have";
-
-export function example_pair(example: ExampleParse) {
-  return (
-    `user: ${example.user_utterance}\n` + `parsed: ${example.example_parsed}`
-  );
-}
-
-export const example_separator = "\n\n";
-
-export const accessor_parameter_rules =
-  "// Accessor parameter rules\n" +
-  "// For matching, contains, equals, between, and sort, the field parameter MUST be a dotted accessor, never a quoted string.\n" +
-  '// ✅ CORRECT:   Probe.getAllProbes().contains(field: .customerName, value: "Freshmarket")\n' +
-  '// ❌ WRONG:     Probe.getAllProbes().contains(field: "customerName", value: "Freshmarket")\n' +
-  "// Use nested dotted accessors for nested fields, for example .dateTime.day.\n";
-
-export function example_parses(examples: ExampleParse[]) {
-  return examples
-    .map((example) => example_pair(example))
-    .join(example_separator);
-}
-
-export const user_interaction_prequel = "// New user interaction";
-
-export function user_interaction_prompt(user_utterance: string) {
-  return `user: ${user_utterance}\n` + `parsed:`;
-}
-
-export function agent_response_prompt(
-  user_utterance: string,
-  parsed: string,
-  result: string
-) {
-  return (
-    `user: ${user_utterance}\n` +
-    `parsed: ${parsed}\n` +
-    `response_context: ${result}\n` +
-    `Generate STRICT JSON with keys: minimalText, fullText, type, shouldSpeak.\n` +
-    `Rules: minimalText MUST be exactly one or two words, easy to speak, and no DSL/code.\n` +
-    `Rules: minimalText should sound task/equipment-work professional (lab persona), low emotion, low cognitive load.\n` +
-    `Rules: minimalText examples: "Completed", "In progress", "Check sample", "Retry task".\n` +
-    `Rules: fullText should be informative but concise (<=240 chars).\n` +
-    `Rules: type must be one of info|error|success|warning.\n` +
-    `Rules: shouldSpeak must be true only when spoken feedback helps the user.\n` +
-    `agent_response_json:`
-  );
-}
-
-export const parse_issues = `
-// Here are the issues that need to be noticed
-// 1. Use "Array[index]" instead of index related functions. For example, "hotels[0]" instead of "hotels.first()"
-// 2. Use "setProperty(value) instead of "property = value". For example, "hotel.setName(123)" instead of "hotel.name = 123"
-// 3. Use ";" between multiple function calls. For example, "hotel.setName(123); hotel.setDesc(123)"`
-
-const exampleDeveloperClasses = `
-// Here are all the function that we have
-extension Array<Type> {
-    // find items with matching field in an array
-    Array<Type> matching(field: Field, value: Type);
-
-    // find items with field in an array that contains a specific value
-    Array<Type> contains(field: Field, value: Type);
-
-    // find items with exact field in an array
-    Array<Type> equals(field: Field, value: Type);
-
-    // find items with field between two values in an array
-    Array<Type> between(field: Field, from: Type, to: Type);
-
-    // sort an array based on a specific field in ascending or descending order
-    Array<Type> sort(field: Field, ascending: bool);
-}
-
-class Counter {
-    string name;
-    string type;
-    int count;
-    static float Version;
-    static Counter GetCounter(name: string);
-    void increment();
-    void decrement();
-    static Counter[] All();
-    static Counter Current();
-}
-
-
-// Here are all the examples that we have
-user: increment
-parsed: Counter.Current().increment()
-
-user: what is the count
-parsed: Counter.Current().count
-
-user: what is the count of potato
-parsed: Counter.GetCounter(name: "potato").count
-
-user: increment potato counter
-parsed: Counter.GetCounter(name: "potato").increment()
-
-user: show me all vegetables counters
-parsed: Counter.All().matching(field: .type, value: "vegetable")
-`
-
-export function parseCodePrompt(appBasicPrompt: string): string {
-    return `
-Below are the developer class definitions, methods, and their descriptions as the comments of an example app. 
-After that, code parses from another app using ReactGenieDSL will be given. 
-A code parse is a voice command the user gives to be parsed into code that completes the requested action.
-
-BEGIN
-\`
-${exampleDeveloperClasses}
-\`
-END
-
-Note that all function calls have to have explicit parameter names in ReactGenieDSL.
-
-For example:
-\`
-parsed: Counter.All().matching(.type, "vegetable")
-\`
-Is INCORRECT.
-
-This is correct:
-\`
-parsed: Counter.All().matching(field: .type, value: "vegetable")
-\`
-
-And here is the developer classes and (optionally) code parses for this app in ReactGenieDSL:\n
-BEGIN
-\`
-${appBasicPrompt}
-\`
-END
-
-For code translation using \`ReactGenieDSL\`, follow these guidelines:
-
-1. Formatting: Directly output code without code blocks. Use semicolons for separating multiple statements.
-2. Follow declarations: Only use existing functions, do not introduce new functions.
-3. Retrieval Over Answers: Translate user queries into code for information retrieval, not direct answers.
-4. Contextual 'Current': Use 'Current' for items the user is directly interacting with or viewing.
-5. Indexing: Use bracket notation for array indexing, supporting negative indices for last element.
-6. No Math Operations: Replace direct math operations with method calls (e.g., 1.plus(1)).
-7. Simplified Array Operations: Avoid map/lambda expressions; apply functions directly to array elements.
-8. No Default Constructors: Use 'Create' methods for object creation; otherwise, selection from existing options.
-9. Static vs. Non-Static Methods: Use static methods for direct class calls; retrieve instances for non-static methods.
-10. Optional Parameters: Optional parameters are noted by \`?\` after their type, they can be omitted in function calls.
-11. Use Setters: Avoid assignments; utilize function calls (set[Something]) for selections or changes.
-12. Property Access: When accessing nested properties, ensure to navigate through all necessary parent properties.
-
-**CRITICAL - Array Parameter Syntax:**
-13. When passing array values to function parameters, you MUST wrap them in square brackets [...] even if the expression already returns an array.
-    
-    ✅ CORRECT:   Order.current().addFoods(foods: [Order.all().matching(field: .restaurant, value: Restaurant.all()[0]).foods()])
-    ❌ WRONG:     Order.current().addFoods(foods: Order.all().matching(field: .restaurant, value: Restaurant.all()[0]).foods())
-    
-    ✅ CORRECT:   someFunction(items: [array.matching(field: .name, value: "test")])
-    ❌ WRONG:     someFunction(items: array.matching(field: .name, value: "test"))
-    
-    Even though the expression returns an array type, the DSL syntax requires explicit brackets for array parameters.
-
-**CRITICAL - Accessor Parameter Syntax:**
-14. For matching, contains, equals, between, and sort, the \`field\` parameter MUST be a dotted accessor, never a quoted string literal.
-
-    ✅ CORRECT:   Probe.getAllProbes().contains(field: .customerName, value: "Freshmarket")
-    ❌ WRONG:     Probe.getAllProbes().contains(field: "customerName", value: "Freshmarket")
-
-    ✅ CORRECT:   Probe.getAllProbes().sort(field: .receivedAt, ascending: false)
-    ❌ WRONG:     Probe.getAllProbes().sort(field: "receivedAt", ascending: false)
-
-    For nested fields, keep the full dotted path, for example \`.dateTime.day\`.
-
-New user interaction (think carefully)
-
-`;
-}

package/lib/nl-interpreter.ts

@@ -1,262 +0,0 @@
-import { PromptGen, SamplingParams } from "./nl";
-import { ClassDescriptor, GenieObject } from "./dsl-descriptor";
-import { NlParser, NlParserGroq } from "./nl";
-import { DslInterpreter } from "./dsl";
-import {
-  AgentResponsePayload,
-  ContextAwareDescriptorPromptGen,
-  ExampleParse,
-  PromptInteractionRecorder,
-  PromptRuntimeContextSetter,
-  RuntimeUiContext,
-} from "./nl/prompt-gen";
-
-export type NlParserProvider = "groq" | "openai";
-
-export interface NlInterpreterProviderSettings {
-  baseUrl?: string;
-  model?: string;
-  samplingParams?: SamplingParams;
-  statefulValidationRetry?: boolean;
-}
-
-export interface NlInterpreterParserConfig {
-  provider?: NlParserProvider;
-  groq?: NlInterpreterProviderSettings;
-  openai?: NlInterpreterProviderSettings;
-}
-
-export interface NlInterpreterMonitoringConfig {
-  langsmithApiKey?: string;
-  langsmithProject?: string;
-  langsmithEndpoint?: string;
-}
-
-export interface NlInterpreterOptions {
-  parser?: NlInterpreterParserConfig;
-  monitoring?: NlInterpreterMonitoringConfig;
-}
-
-const DEFAULT_GROQ_BASE_URL = "https://api.groq.com/openai/v1";
-const DEFAULT_OPENAI_BASE_URL = "https://api.openai.com/v1";
-const PROVIDER_ENV_KEY = "GENIE_PARSER_PROVIDER";
-
-function normalizeBaseUrl(baseUrl: string): string {
-  return baseUrl.trim().replace(/\/+$/, "");
-}
-
-function stripChatCompletionsSuffix(baseUrl: string): string {
-  if (!baseUrl.endsWith("/chat/completions")) {
-    return baseUrl;
-  }
-  return baseUrl.slice(0, -"/chat/completions".length);
-}
-
-function isDirectOpenAIBaseUrl(baseUrl: string): boolean {
-  try {
-    const url = new URL(baseUrl);
-    return url.hostname === "api.openai.com";
-  } catch {
-    return false;
-  }
-}
-
-function normalizeProviderBaseUrl(
-  provider: NlParserProvider,
-  baseUrl?: string
-): string {
-  const fallbackBaseUrl =
-    provider === "openai" ? DEFAULT_OPENAI_BASE_URL : DEFAULT_GROQ_BASE_URL;
-
-  if (!baseUrl || baseUrl.trim().length === 0) {
-    return fallbackBaseUrl;
-  }
-
-  const normalizedBaseUrl = stripChatCompletionsSuffix(normalizeBaseUrl(baseUrl));
-
-  if (
-    normalizedBaseUrl.endsWith("/openai/v1") ||
-    normalizedBaseUrl.endsWith("/v1")
-  ) {
-    return normalizedBaseUrl;
-  }
-
-  if (provider === "openai" && isDirectOpenAIBaseUrl(normalizedBaseUrl)) {
-    return `${normalizedBaseUrl}/v1`;
-  }
-
-  return `${normalizedBaseUrl}/openai/v1`;
-}
-
-function resolveParserProvider(
-  parserConfig?: NlInterpreterParserConfig
-): NlParserProvider {
-  if (parserConfig?.provider === "openai" || parserConfig?.provider === "groq") {
-    return parserConfig.provider;
-  }
-
-  const envProvider = process.env[PROVIDER_ENV_KEY]?.trim().toLowerCase();
-  if (envProvider === "openai" || envProvider === "groq") {
-    return envProvider;
-  }
-
-  return "groq";
-}
-
-function requireOpenAIModel(model?: string): string {
-  const trimmed = model?.trim();
-  if (!trimmed) {
-    throw new Error(
-      "OpenAI parser requires parser.openai.model / semanticModel / SEMANTIC_MODEL configuration."
-    );
-  }
-  return trimmed;
-}
-
-export class NlInterpreter {
-  public nlParser: NlParser | NlParserGroq;
-  public dslInterpreter: DslInterpreter;
-  private dslValidator: DslInterpreter;
-
-  constructor(
-    private descriptions: ClassDescriptor<GenieObject>[],
-    private apiKey: string,
-    private prompt?: PromptGen,
-    private examples?: ExampleParse[],
-    private extraPrompt?: string,
-    private options: NlInterpreterOptions = {}
-  ) {
-    if (this.prompt === undefined) {
-      console.assert(this.examples !== undefined);
-      this.prompt = new ContextAwareDescriptorPromptGen(
-        this.descriptions,
-        this.examples!,
-        extraPrompt
-      );
-    }
-
-    const parserConfig = this.options.parser;
-    const monitoringConfig = this.options.monitoring;
-    const provider = resolveParserProvider(parserConfig);
-
-    this.dslInterpreter = new DslInterpreter([...descriptions]);
-    this.dslValidator = new DslInterpreter([...descriptions], true);
-
-    const validateCommand = async (command: string) => {
-      await this.dslValidator.interpret(command);
-    };
-
-    if (provider === "openai") {
-      const openAIConfig = parserConfig?.openai;
-      this.nlParser = new NlParser(
-        this.prompt,
-        apiKey,
-        normalizeProviderBaseUrl("openai", openAIConfig?.baseUrl),
-        requireOpenAIModel(openAIConfig?.model),
-        openAIConfig?.samplingParams,
-        monitoringConfig?.langsmithApiKey,
-        monitoringConfig?.langsmithProject,
-        monitoringConfig?.langsmithEndpoint,
-        validateCommand,
-        {
-          statefulValidationRetry: !!openAIConfig?.statefulValidationRetry,
-        }
-      );
-    } else {
-      const groqConfig = parserConfig?.groq;
-      const resolvedGroqModel =
-        groqConfig?.model ||
-        process.env.SEMANTIC_MODEL ||
-        "llama-3.3-70b-versatile";
-      this.nlParser = new NlParserGroq(
-        this.prompt,
-        apiKey,
-        resolvedGroqModel,
-        groqConfig?.samplingParams,
-        normalizeProviderBaseUrl("groq", groqConfig?.baseUrl),
-        monitoringConfig?.langsmithApiKey,
-        monitoringConfig?.langsmithProject,
-        monitoringConfig?.langsmithEndpoint,
-        validateCommand
-      );
-    }
-  }
-
-  private recordInteraction(record: {
-    utterance: string;
-    parsed?: string | null;
-    success: boolean;
-    resultSummary?: string;
-  }) {
-    const recorder = this.prompt as unknown as PromptInteractionRecorder;
-    if (typeof recorder?.recordInteraction === "function") {
-      recorder.recordInteraction(record);
-    }
-  }
-
-  public recordTurn(record: {
-    utterance: string;
-    parsed?: string | null;
-    success: boolean;
-    resultSummary?: string;
-  }): void {
-    this.recordInteraction(record);
-  }
-
-  setRuntimeContext(context: RuntimeUiContext | null): void {
-    const runtimeContextSetter = this.prompt as unknown as PromptRuntimeContextSetter;
-    if (typeof runtimeContextSetter?.setRuntimeContext === "function") {
-      runtimeContextSetter.setRuntimeContext(context);
-    }
-  }
-
-  async interpret(nl: string): Promise<GenieObject | null> {
-    let command: string | null = null;
-    try {
-      command = await this.nlParser.parse(nl);
-    } catch (error) {
-      this.recordInteraction({
-        utterance: nl,
-        success: false,
-        resultSummary: `parse_error:${error instanceof Error ? error.message : String(error)}`,
-      });
-      throw error;
-    }
-
-    if (command === null) {
-      this.recordInteraction({
-        utterance: nl,
-        success: false,
-        resultSummary: "parse_empty",
-      });
-      return null;
-    }
-
-    try {
-      const result = await this.dslInterpreter.interpret(command);
-      this.recordInteraction({
-        utterance: nl,
-        parsed: command,
-        success: true,
-        resultSummary: "execute_ok",
-      });
-      return result;
-    } catch (error) {
-      this.recordInteraction({
-        utterance: nl,
-        parsed: command,
-        success: false,
-        resultSummary: `execute_error:${error instanceof Error ? error.message : String(error)}`,
-      });
-      throw error;
-    }
-  }
-
-  async respond(
-    nl: string,
-    parsed: string,
-    result: string
-  ): Promise<AgentResponsePayload | null> {
-    return await this.nlParser.respond(nl, parsed, result);
-  }
-}