@shahmarasy/prodo 0.1.4 → 0.1.6

package/src/providers/mock-provider.ts

@@ -1,199 +1,200 @@
-import type { BriefContractItem } from "../normalized-brief";
-import type { LLMProvider, ProviderSchemaHint } from "../types";
-
-function asStringArray(value: unknown): string[] {
-  if (!Array.isArray(value)) return [];
-  return value.filter((item): item is string => typeof item === "string");
-}
-
-function asContracts(value: unknown): BriefContractItem[] {
-  if (!Array.isArray(value)) return [];
-  return value
-    .map((item) => {
-      if (!item || typeof item !== "object") return null;
-      const record = item as Record<string, unknown>;
-      if (typeof record.id !== "string" || typeof record.text !== "string") return null;
-      return { id: record.id, text: record.text };
-    })
-    .filter((item): item is BriefContractItem => item !== null);
-}
-
-function extractValue(markdown: string, heading: string): string[] {
-  const aliases = heading.split("|").map((item) => item.trim().toLowerCase());
-  const lines = markdown.split(/\r?\n/);
-  let collect = false;
-  const out: string[] = [];
-  for (const raw of lines) {
-    const headingMatch = raw.match(/^#{1,6}\s+(.+?)\s*$/);
-    if (headingMatch) {
-      const current = headingMatch[1].trim().toLowerCase();
-      if (collect && !aliases.includes(current)) break;
-      collect = aliases.includes(current);
-      continue;
-    }
-    if (!collect) continue;
-    const cleaned = raw.replace(/^\s*[-*]\s*/, "").trim();
-    if (cleaned.length > 0) out.push(cleaned);
-  }
-  return out;
-}
-
-function normalizeWithMock(inputContext: Record<string, unknown>): string {
-  const brief = typeof inputContext.briefMarkdown === "string" ? inputContext.briefMarkdown : "";
-  const product = extractValue(brief, "Product Name|Name")[0] ?? "";
-  const problem = extractValue(brief, "Problem|Problem Statement").join(" ");
-  const audience = extractValue(brief, "Audience|Users|Persona");
-  const goals = extractValue(brief, "Goals|Objectives");
-  const features = extractValue(brief, "Core Features|Features|Capabilities");
-  const constraints = extractValue(brief, "Constraints|Limitations|Restrictions");
-  const assumptions = extractValue(brief, "Assumptions|Open Questions");
-
-  const contracts = {
-    goals: goals.map((text, index) => ({ id: `G${index + 1}`, text })),
-    core_features: features.map((text, index) => ({ id: `F${index + 1}`, text })),
-    constraints: constraints.map((text, index) => ({ id: `C${index + 1}`, text }))
-  };
-
-  const confidence = {
-    product_name: product ? 0.95 : 0.25,
-    problem: problem ? 0.95 : 0.25,
-    audience: audience.length > 0 ? 0.95 : 0.25,
-    goals: goals.length > 0 ? 0.95 : 0.25,
-    core_features: features.length > 0 ? 0.95 : 0.25
-  };
-
-  return JSON.stringify(
-    {
-      schema_version: "1.0",
-      product_name: product,
-      problem,
-      audience,
-      goals,
-      core_features: features,
-      constraints,
-      assumptions,
-      contracts,
-      confidence
-    },
-    null,
-    2
-  );
-}
-
-function normalizeSectionItems(inputContext: Record<string, unknown>): string[] {
-  const normalizedBrief = (inputContext.normalizedBrief ?? {}) as Record<string, unknown>;
-  const goals = asStringArray(normalizedBrief.goals);
-  const features = asStringArray(normalizedBrief.core_features);
-  const constraints = asStringArray(normalizedBrief.constraints);
-  return [...goals, ...features, ...constraints];
-}
-
-function coverageItems(
-  schemaHint: ProviderSchemaHint,
-  inputContext: Record<string, unknown>
-): Array<{ id: string; text: string }> {
-  const catalog = (inputContext.contractCatalog ?? {}) as Record<string, unknown>;
-  const values: Array<{ id: string; text: string }> = [];
-  if (schemaHint.requiredContracts.includes("goals")) values.push(...asContracts(catalog.goals));
-  if (schemaHint.requiredContracts.includes("core_features")) values.push(...asContracts(catalog.core_features));
-  if (schemaHint.requiredContracts.includes("constraints")) values.push(...asContracts(catalog.constraints));
-  return values;
-}
-
-function headingBlock(
-  heading: string,
-  items: string[],
-  fallbackText: string,
-  coverage: Array<{ id: string; text: string }>
-): string {
-  const selected = items.slice(0, 2);
-  const contractBullets = coverage.map((item) => `- [${item.id}] ${item.text}`);
-  const bullets = [...contractBullets, ...selected.map((item) => `- ${item}`)];
-  const finalBullets = bullets.length > 0 ? bullets.join("\n") : `- ${fallbackText}`;
-  return `${heading}\n${finalBullets}\n`;
-}
-
-function buildArtifactBody(schemaHint: ProviderSchemaHint, inputContext: Record<string, unknown>): string {
-  const normalizedBrief = (inputContext.normalizedBrief ?? {}) as Record<string, unknown>;
-  const productName =
-    typeof normalizedBrief.product_name === "string" ? normalizedBrief.product_name : "Product";
-  const lang = typeof inputContext.outputLanguage === "string" ? inputContext.outputLanguage.toLowerCase() : "en";
-  const items = normalizeSectionItems(inputContext);
-  const coverage = coverageItems(schemaHint, inputContext);
-  const localizedItems =
-    lang === "tr" ? items.map((_, index) => `Gereksinim maddesi ${index + 1}`) : items;
-  const localizedCoverage =
-    lang === "tr"
-      ? coverage.map((item, index) => ({
-          id: item.id,
-          text: `Kontrat kapsami ${index + 1}`
-        }))
-      : coverage;
-  const fallback = lang === "tr" ? "Detay daha sonra netlestirilecek." : "To be refined.";
-  const sections = schemaHint.requiredHeadings.map((heading) =>
-    headingBlock(heading, localizedItems, fallback, localizedCoverage)
-  );
-  const title =
-    lang === "tr"
-      ? `# ${productName} icin ${schemaHint.artifactType.toUpperCase()}`
-      : `# ${schemaHint.artifactType.toUpperCase()} for ${productName}`;
-  if (schemaHint.artifactType === "workflow") {
-    return `${title}\n\n${sections.join("\n")}\n\n\`\`\`mermaid
-flowchart TD
-  A[Start] --> B[[F1] User Action]
-  B --> C[System Step]
-  C --> D[Done]
-\`\`\``.trim();
-  }
-  return `${title}\n\n${sections.join("\n")}\n\n${lang === "tr" ? "Not" : "Note"}: ${fallback}`.trim();
-}
-
-function semanticIssuesWithMock(inputContext: Record<string, unknown>): string {
-  const pair = inputContext.pair as Record<string, unknown>;
-  const leftBody = typeof pair?.left_body === "string" ? pair.left_body : "";
-  const rightBody = typeof pair?.right_body === "string" ? pair.right_body : "";
-  const leftFile = typeof pair?.left_file === "string" ? pair.left_file : "";
-  const rightFile = typeof pair?.right_file === "string" ? pair.right_file : "";
-  const issues: Array<Record<string, unknown>> = [];
-
-  const contradiction =
-    /guest checkout/i.test(leftBody) && /(auth required|requires auth|must login)/i.test(rightBody);
-  if (contradiction) {
-    issues.push({
-      level: "error",
-      code: "semantic_contradiction",
-      check: "semantic_consistency",
-      contract_id: "F1",
-      file: rightFile || leftFile,
-      message: "Workflow allows guest checkout but paired artifact requires authentication.",
-      suggestion: "Align auth behavior across both artifacts."
-    });
-  }
-
-  return JSON.stringify({ issues }, null, 2);
-}
-
-function contractRelevanceWithMock(inputContext: Record<string, unknown>): string {
-  const contractText = typeof inputContext.contract_text === "string" ? inputContext.contract_text.toLowerCase() : "";
-  const contextText = typeof inputContext.context_text === "string" ? inputContext.context_text.toLowerCase() : "";
-  const terms = contractText
-    .split(/\W+/)
-    .map((term) => term.trim())
-    .filter((term) => term.length > 3);
-  const overlap = terms.filter((term) => contextText.includes(term)).length;
-  const relevant = terms.length === 0 ? true : overlap / terms.length >= 0.25;
-  return JSON.stringify({ relevant, score: terms.length === 0 ? 1 : overlap / terms.length }, null, 2);
-}
-
-export class MockProvider implements LLMProvider {
-  async generate(
-    _prompt: string,
-    inputContext: Record<string, unknown>,
-    schemaHint: ProviderSchemaHint
-  ): Promise<{ body: string; frontmatter?: Record<string, unknown> }> {
-    if (schemaHint.artifactType === "normalize") return { body: normalizeWithMock(inputContext) };
-    if (schemaHint.artifactType === "semantic_consistency") return { body: semanticIssuesWithMock(inputContext) };
-    if (schemaHint.artifactType === "contract_relevance") return { body: contractRelevanceWithMock(inputContext) };
-    return { body: buildArtifactBody(schemaHint, inputContext) };
-  }
-}
+import type { BriefContractItem } from "../core/normalized-brief";
+import type { LLMProvider, ProviderSchemaHint } from "../core/types";
+import { t } from "../i18n";
+
+function asStringArray(value: unknown): string[] {
+  if (!Array.isArray(value)) return [];
+  return value.filter((item): item is string => typeof item === "string");
+}
+
+function asContracts(value: unknown): BriefContractItem[] {
+  if (!Array.isArray(value)) return [];
+  return value
+    .map((item) => {
+      if (!item || typeof item !== "object") return null;
+      const record = item as Record<string, unknown>;
+      if (typeof record.id !== "string" || typeof record.text !== "string") return null;
+      return { id: record.id, text: record.text };
+    })
+    .filter((item): item is BriefContractItem => item !== null);
+}
+
+function extractValue(markdown: string, heading: string): string[] {
+  const aliases = heading.split("|").map((item) => item.trim().toLowerCase());
+  const lines = markdown.split(/\r?\n/);
+  let collect = false;
+  const out: string[] = [];
+  for (const raw of lines) {
+    const headingMatch = raw.match(/^#{1,6}\s+(.+?)\s*$/);
+    if (headingMatch) {
+      const current = headingMatch[1].trim().toLowerCase();
+      if (collect && !aliases.includes(current)) break;
+      collect = aliases.includes(current);
+      continue;
+    }
+    if (!collect) continue;
+    const cleaned = raw.replace(/^\s*[-*]\s*/, "").trim();
+    if (cleaned.length > 0) out.push(cleaned);
+  }
+  return out;
+}
+
+function normalizeWithMock(inputContext: Record<string, unknown>): string {
+  const brief = typeof inputContext.briefMarkdown === "string" ? inputContext.briefMarkdown : "";
+  const product = extractValue(brief, "Product Name|Name")[0] ?? "";
+  const problem = extractValue(brief, "Problem|Problem Statement").join(" ");
+  const audience = extractValue(brief, "Audience|Users|Persona");
+  const goals = extractValue(brief, "Goals|Objectives");
+  const features = extractValue(brief, "Core Features|Features|Capabilities");
+  const constraints = extractValue(brief, "Constraints|Limitations|Restrictions");
+  const assumptions = extractValue(brief, "Assumptions|Open Questions");
+
+  const contracts = {
+    goals: goals.map((text, index) => ({ id: `G${index + 1}`, text })),
+    core_features: features.map((text, index) => ({ id: `F${index + 1}`, text })),
+    constraints: constraints.map((text, index) => ({ id: `C${index + 1}`, text }))
+  };
+
+  const confidence = {
+    product_name: product ? 0.95 : 0.25,
+    problem: problem ? 0.95 : 0.25,
+    audience: audience.length > 0 ? 0.95 : 0.25,
+    goals: goals.length > 0 ? 0.95 : 0.25,
+    core_features: features.length > 0 ? 0.95 : 0.25
+  };
+
+  return JSON.stringify(
+    {
+      schema_version: "1.0",
+      product_name: product,
+      problem,
+      audience,
+      goals,
+      core_features: features,
+      constraints,
+      assumptions,
+      contracts,
+      confidence
+    },
+    null,
+    2
+  );
+}
+
+function normalizeSectionItems(inputContext: Record<string, unknown>): string[] {
+  const normalizedBrief = (inputContext.normalizedBrief ?? {}) as Record<string, unknown>;
+  const goals = asStringArray(normalizedBrief.goals);
+  const features = asStringArray(normalizedBrief.core_features);
+  const constraints = asStringArray(normalizedBrief.constraints);
+  return [...goals, ...features, ...constraints];
+}
+
+function coverageItems(
+  schemaHint: ProviderSchemaHint,
+  inputContext: Record<string, unknown>
+): Array<{ id: string; text: string }> {
+  const catalog = (inputContext.contractCatalog ?? {}) as Record<string, unknown>;
+  const values: Array<{ id: string; text: string }> = [];
+  if (schemaHint.requiredContracts.includes("goals")) values.push(...asContracts(catalog.goals));
+  if (schemaHint.requiredContracts.includes("core_features")) values.push(...asContracts(catalog.core_features));
+  if (schemaHint.requiredContracts.includes("constraints")) values.push(...asContracts(catalog.constraints));
+  return values;
+}
+
+function headingBlock(
+  heading: string,
+  items: string[],
+  fallbackText: string,
+  coverage: Array<{ id: string; text: string }>
+): string {
+  const selected = items.slice(0, 2);
+  const contractBullets = coverage.map((item) => `- [${item.id}] ${item.text}`);
+  const bullets = [...contractBullets, ...selected.map((item) => `- ${item}`)];
+  const finalBullets = bullets.length > 0 ? bullets.join("\n") : `- ${fallbackText}`;
+  return `${heading}\n${finalBullets}\n`;
+}
+
+function buildArtifactBody(schemaHint: ProviderSchemaHint, inputContext: Record<string, unknown>): string {
+  const normalizedBrief = (inputContext.normalizedBrief ?? {}) as Record<string, unknown>;
+  const productName =
+    typeof normalizedBrief.product_name === "string" ? normalizedBrief.product_name : "Product";
+  const lang = typeof inputContext.outputLanguage === "string" ? inputContext.outputLanguage.toLowerCase() : "en";
+  const items = normalizeSectionItems(inputContext);
+  const coverage = coverageItems(schemaHint, inputContext);
+  const localizedItems =
+    lang === "tr" ? items.map((_, index) => `${t("requirement_item", lang)} ${index + 1}`) : items;
+  const localizedCoverage =
+    lang === "tr"
+      ? coverage.map((item, index) => ({
+          id: item.id,
+          text: `${t("contract_coverage", lang)} ${index + 1}`
+        }))
+      : coverage;
+  const fallback = t("to_be_refined", lang);
+  const sections = schemaHint.requiredHeadings.map((heading) =>
+    headingBlock(heading, localizedItems, fallback, localizedCoverage)
+  );
+  const title =
+    lang === "tr"
+      ? `# ${productName} ${t("for_artifact", lang)} ${schemaHint.artifactType.toUpperCase()}`
+      : `# ${schemaHint.artifactType.toUpperCase()} ${t("for_artifact", lang)} ${productName}`;
+  if (schemaHint.artifactType === "workflow") {
+    return `${title}\n\n${sections.join("\n")}\n\n\`\`\`mermaid
+flowchart TD
+  A[Start] --> B[[F1] User Action]
+  B --> C[System Step]
+  C --> D[Done]
+\`\`\``.trim();
+  }
+  return `${title}\n\n${sections.join("\n")}\n\n${t("note", lang)}: ${fallback}`.trim();
+}
+
+function semanticIssuesWithMock(inputContext: Record<string, unknown>): string {
+  const pair = inputContext.pair as Record<string, unknown>;
+  const leftBody = typeof pair?.left_body === "string" ? pair.left_body : "";
+  const rightBody = typeof pair?.right_body === "string" ? pair.right_body : "";
+  const leftFile = typeof pair?.left_file === "string" ? pair.left_file : "";
+  const rightFile = typeof pair?.right_file === "string" ? pair.right_file : "";
+  const issues: Array<Record<string, unknown>> = [];
+
+  const contradiction =
+    /guest checkout/i.test(leftBody) && /(auth required|requires auth|must login)/i.test(rightBody);
+  if (contradiction) {
+    issues.push({
+      level: "error",
+      code: "semantic_contradiction",
+      check: "semantic_consistency",
+      contract_id: "F1",
+      file: rightFile || leftFile,
+      message: "Workflow allows guest checkout but paired artifact requires authentication.",
+      suggestion: "Align auth behavior across both artifacts."
+    });
+  }
+
+  return JSON.stringify({ issues }, null, 2);
+}
+
+function contractRelevanceWithMock(inputContext: Record<string, unknown>): string {
+  const contractText = typeof inputContext.contract_text === "string" ? inputContext.contract_text.toLowerCase() : "";
+  const contextText = typeof inputContext.context_text === "string" ? inputContext.context_text.toLowerCase() : "";
+  const terms = contractText
+    .split(/\W+/)
+    .map((term) => term.trim())
+    .filter((term) => term.length > 3);
+  const overlap = terms.filter((term) => contextText.includes(term)).length;
+  const relevant = terms.length === 0 ? true : overlap / terms.length >= 0.25;
+  return JSON.stringify({ relevant, score: terms.length === 0 ? 1 : overlap / terms.length }, null, 2);
+}
+
+export class MockProvider implements LLMProvider {
+  async generate(
+    _prompt: string,
+    inputContext: Record<string, unknown>,
+    schemaHint: ProviderSchemaHint
+  ): Promise<{ body: string; frontmatter?: Record<string, unknown> }> {
+    if (schemaHint.artifactType === "normalize") return { body: normalizeWithMock(inputContext) };
+    if (schemaHint.artifactType === "semantic_consistency") return { body: semanticIssuesWithMock(inputContext) };
+    if (schemaHint.artifactType === "contract_relevance") return { body: contractRelevanceWithMock(inputContext) };
+    return { body: buildArtifactBody(schemaHint, inputContext) };
+  }
+}

package/src/providers/openai-provider.ts

@@ -1,88 +1,88 @@
-import type { LLMProvider, ProviderSchemaHint } from "../types";
-import { UserError } from "../errors";
-
-type ChatResponse = {
-  choices?: Array<{
-    message?: {
-      content?: string;
-    };
-  }>;
-};
-
-export class OpenAIProvider implements LLMProvider {
-  private readonly apiKey: string;
-  private readonly model: string;
-  private readonly baseUrl: string;
-
-  constructor() {
-    const key = process.env.OPENAI_API_KEY;
-    if (!key) {
-      throw new UserError("OPENAI_API_KEY missing. Set it or use PRODO_LLM_PROVIDER=mock.");
-    }
-    this.apiKey = key;
-    this.model = process.env.PRODO_OPENAI_MODEL ?? "gpt-4o-mini";
-    this.baseUrl = process.env.PRODO_OPENAI_BASE_URL ?? "https://api.openai.com/v1";
-  }
-
-  async generate(
-    prompt: string,
-    inputContext: Record<string, unknown>,
-    schemaHint: ProviderSchemaHint
-  ): Promise<{ body: string; frontmatter?: Record<string, unknown> }> {
-    const outputLanguage =
-      typeof inputContext.outputLanguage === "string" && inputContext.outputLanguage.trim()
-        ? inputContext.outputLanguage.trim()
-        : "en";
-    const mode = schemaHint.artifactType;
-    const system =
-      mode === "normalize"
-        ? `You normalize messy human product briefs into strict JSON.
-Return valid JSON only, no markdown. Include confidence scores (0..1) for critical fields.
-Preserve source language and Unicode characters exactly; never transliterate Turkish letters to ASCII.`
-        : mode === "semantic_consistency"
-          ? `You detect semantic inconsistencies between paired artifacts.
-Return valid JSON only: { "issues": [{level, code, check, contract_id, file, message, suggestion}] }.`
-          : mode === "contract_relevance"
-            ? `You verify whether tagged content actually matches the referenced contract text.
-Return valid JSON only: { "relevant": boolean, "score": number, "reason": string }.`
-            : `You are a product-document generator.
-Return only Markdown body content.
-Headings required:
-${schemaHint.requiredHeadings.join("\n")}
-Required contract tags:
-${schemaHint.requiredContracts.join(", ")}
-Use tags like [G1], [F2], [C1] where relevant.
-Output language: ${outputLanguage}
-Do not translate required headings.`;
-    const user = `${prompt}\n\nContext JSON:\n${JSON.stringify(inputContext, null, 2)}`;
-
-    const response = await fetch(`${this.baseUrl}/chat/completions`, {
-      method: "POST",
-      headers: {
-        "Content-Type": "application/json",
-        Authorization: `Bearer ${this.apiKey}`
-      },
-      body: JSON.stringify({
-        model: this.model,
-        messages: [
-          { role: "system", content: system },
-          { role: "user", content: user }
-        ],
-        temperature: 0.2
-      })
-    });
-
-    if (!response.ok) {
-      const text = await response.text();
-      throw new UserError(`OpenAI request failed (${response.status}): ${text}`);
-    }
-
-    const payload = (await response.json()) as ChatResponse;
-    const content = payload.choices?.[0]?.message?.content?.trim();
-    if (!content) {
-      throw new UserError("OpenAI provider returned an empty response.");
-    }
-
-    return { body: content };
-  }
-}
+import type { LLMProvider, ProviderSchemaHint } from "../core/types";
+import { UserError } from "../core/errors";
+
+type ChatResponse = {
+  choices?: Array<{
+    message?: {
+      content?: string;
+    };
+  }>;
+};
+
+export class OpenAIProvider implements LLMProvider {
+  private readonly apiKey: string;
+  private readonly model: string;
+  private readonly baseUrl: string;
+
+  constructor() {
+    const key = process.env.OPENAI_API_KEY;
+    if (!key) {
+      throw new UserError("OPENAI_API_KEY missing. Set it or use PRODO_LLM_PROVIDER=mock.");
+    }
+    this.apiKey = key;
+    this.model = process.env.PRODO_OPENAI_MODEL ?? "gpt-4o-mini";
+    this.baseUrl = process.env.PRODO_OPENAI_BASE_URL ?? "https://api.openai.com/v1";
+  }
+
+  async generate(
+    prompt: string,
+    inputContext: Record<string, unknown>,
+    schemaHint: ProviderSchemaHint
+  ): Promise<{ body: string; frontmatter?: Record<string, unknown> }> {
+    const outputLanguage =
+      typeof inputContext.outputLanguage === "string" && inputContext.outputLanguage.trim()
+        ? inputContext.outputLanguage.trim()
+        : "en";
+    const mode = schemaHint.artifactType;
+    const system =
+      mode === "normalize"
+        ? `You normalize messy human product briefs into strict JSON.
+Return valid JSON only, no markdown. Include confidence scores (0..1) for critical fields.
+Preserve source language and Unicode characters exactly; never transliterate Turkish letters to ASCII.`
+        : mode === "semantic_consistency"
+          ? `You detect semantic inconsistencies between paired artifacts.
+Return valid JSON only: { "issues": [{level, code, check, contract_id, file, message, suggestion}] }.`
+          : mode === "contract_relevance"
+            ? `You verify whether tagged content actually matches the referenced contract text.
+Return valid JSON only: { "relevant": boolean, "score": number, "reason": string }.`
+            : `You are a product-document generator.
+Return only Markdown body content.
+Headings required:
+${schemaHint.requiredHeadings.join("\n")}
+Required contract tags:
+${schemaHint.requiredContracts.join(", ")}
+Use tags like [G1], [F2], [C1] where relevant.
+Output language: ${outputLanguage}
+Do not translate required headings.`;
+    const user = `${prompt}\n\nContext JSON:\n${JSON.stringify(inputContext, null, 2)}`;
+
+    const response = await fetch(`${this.baseUrl}/chat/completions`, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+        Authorization: `Bearer ${this.apiKey}`
+      },
+      body: JSON.stringify({
+        model: this.model,
+        messages: [
+          { role: "system", content: system },
+          { role: "user", content: user }
+        ],
+        temperature: 0.2
+      })
+    });
+
+    if (!response.ok) {
+      const text = await response.text();
+      throw new UserError(`OpenAI request failed (${response.status}): ${text}`);
+    }
+
+    const payload = (await response.json()) as ChatResponse;
+    const content = payload.choices?.[0]?.message?.content?.trim();
+    if (!content) {
+      throw new UserError("OpenAI provider returned an empty response.");
+    }
+
+    return { body: content };
+  }
+}