@gringow/gringow 0.6.0 → 0.6.2

package/dist/index.d.mts

@@ -1,87 +1,15 @@
 export { awaitedConfig, getConfigSource, isLocalConfigFound } from './config.mjs';
 export { createCacheId } from './create-cache-id.mjs';
+export { checkCache } from './data/check-cache.mjs';
 export { clearCache } from './data/clear-cache.mjs';
+export { deleteCacheItem } from './data/delete-cache-item.mjs';
 export { getCache } from './data/get-cache.mjs';
+export { getOrCreateCache } from './data/get-or-create-cache.mjs';
+export { writeCacheToDisk } from './data/write-cache-to-disk.mjs';
+export { Gringow as default, rebuild } from './gringow.mjs';
 export { interpolateTemplate } from './interpolate-template.mjs';
 export { stripComments } from './strip-comments.mjs';
 export { GringowConfig } from './constants/default-config.mjs';
+export { GringowCache, GringowCacheItem, GringowError, GringowResponse, GringowTranslation } from './types/index.mjs';
 import 'zod';
 import './schemas/config.shcema.mjs';
-
-/**
- * Checks if a cache item exists for the given ID
- *
- * @param cacheId - The cache ID to check
- * @returns Promise that resolves to the cached item if found, or undefined otherwise
- *
- * @example
- * const item = await checkCache("gid_123abc")
- * if (item) {
- *   console.log("Found in cache:", item.translation)
- * }
- */
-declare function checkCache(cacheId: string): Promise<GringowCacheItem | undefined>;
-
-/**
- * Deletes a cache item.
- *
- * @param cacheId - The cache ID.
- * @returns The cache ID.
- */
-declare function deleteCacheItem(cacheId: string): Promise<GringowCache>;
-
-/**
- * Gets the existing cache or creates a new empty one if it doesn't exist
- *
- * @returns Promise that resolves to the cache object
- * @throws {GringowError} If there is an error reading/writing the cache file
- *
- * @example
- * const cache = await getOrCreateCache()
- * // Returns existing cache or creates new empty cache: {}
- */
-declare function getOrCreateCache(): Promise<GringowCache>;
-
-/**
- * Writes the cache to disk.
- *
- * @param cacheId - The cache ID.
- * @param cached - The cached item.
- * @returns The cached item.
- */
-declare function writeCacheToDisk(cacheId: string, cached: GringowCacheItem): Promise<GringowCacheItem>;
-
-type GringowTranslation = {
-    [key: string]: string;
-};
-type GringowCacheItem = {
-    original: string;
-    translation: GringowTranslation;
-    append?: string;
-    prepend?: string;
-    rebuild?: boolean;
-};
-type GringowCache = {
-    [key: string]: GringowCacheItem;
-};
-type GringowResponse = {
-    cacheId: string;
-    translation: GringowCacheItem;
-};
-type GringowError = Error & {
-    code?: string;
-    cause?: Error;
-};
-
-declare function rebuild(cacheId: string): Promise<GringowResponse>;
-/**
- * Gringow is a function that translates a string or a template string into a
- * translated string.
- *
- * @param text - The string or template string to translate.
- * @param values - The values to interpolate into the string.
- * @returns The translated string.
- */
-declare function Gringow(text: string, ...values: Array<unknown>): Promise<GringowResponse>;
-
-export { type GringowCache, type GringowCacheItem, type GringowError, type GringowResponse, type GringowTranslation, checkCache, Gringow as default, deleteCacheItem, getOrCreateCache, rebuild, writeCacheToDisk };

package/dist/index.mjs

@@ -1,5 +1,5 @@
 import { cosmiconfig } from 'cosmiconfig';
-import merge from 'lodash.merge';
+import mergeWith from 'lodash.mergewith';
 import { z } from 'zod';
 import fs from 'fs/promises';
 import { dirname, resolve, parse } from 'path';
@@ -24,9 +24,9 @@ var defaultConfig = {
   defaultLanguage: "pt-BR",
   languages: ["pt-BR", "fr-CA"],
   llm: {
-    provider: "openai",
+    provider: "ollama",
     apiKey: void 0,
-    model: "gpt-4o-mini",
+    model: "llama3.2",
     temperature: 1,
     sleep: 0
   },
@@ -48,6 +48,7 @@ var llmProviderSchema = z.enum([
   "azure",
   "meta"
 ]);
+var keylessProviders = ["ollama", "lmstudio"];
 var configSchema = z.object({
   debug: z.boolean().optional(),
   log: z.object({
@@ -79,8 +80,7 @@ var configSchema = z.object({
   globby: z.string().regex(/^\.\/.*/).optional()
 }).refine(
   (data) => {
-    const noApiKeyRequired = ["ollama", "lmstudio"];
-    if (noApiKeyRequired.includes(data.llm.provider)) {
+    if (keylessProviders.includes(data.llm.provider)) {
       return true;
     }
     return !!data.llm.apiKey;
@@ -100,21 +100,14 @@ function isLocalConfigFound() {
 function getConfigSource() {
   return result?.filepath || "default";
 }
+function replaceArrays(_destination, source) {
+  if (Array.isArray(source)) return [...source];
+  return void 0;
+}
 async function loadUserConfig() {
   try {
-    const mergedConfig = merge({}, defaultConfig, result?.config);
-    const parsedConfig = await configSchema.parseAsync(mergedConfig);
-    parsedConfig.llm.prePrompt = prePrompt(
-      parsedConfig,
-      parsedConfig.llm.prePromptAppend ?? "",
-      parsedConfig.llm.prePromptReplace ?? ""
-    );
-    parsedConfig.llm.postPrompt = postPrompt(
-      parsedConfig,
-      parsedConfig.llm.postPromptPrepend ?? "",
-      parsedConfig.llm.postPromptReplace ?? ""
-    );
-    return parsedConfig;
+    const mergedConfig = mergeWith({}, defaultConfig, result?.config, replaceArrays);
+    return await configSchema.parseAsync(mergedConfig);
   } catch (error) {
     console.warn(`${error?.message}, using default configuration`);
     return defaultConfig;
@@ -163,10 +156,7 @@ function defaultPostPrompt(_config) {
   return "";
 }
 function prePrompt(config, prepend, replace) {
-  return [
-    // ...(append ? ['[SPECIFIC_INPUTS]', String(append), '[/SPECIFIC_INPUTS]'] : []),
-    replace ? String(replace) : defaultPrePrompt(config, prepend)
-  ].join(" ").trim();
+  return [replace ? String(replace) : defaultPrePrompt(config, prepend)].join(" ").trim();
 }
 function postPrompt(config, prepend, replace) {
   return [
@@ -181,19 +171,19 @@ var MULTIPLIERS = [668265261, 374761393, 2654435769, 2496678331];
 var AVA_MULT1 = 2146121005;
 var AVA_MULT2 = 2221713035;
 function seedState(input) {
-  const state = [...INITIAL_STATE];
+  let [h1, h2, h3, h4] = INITIAL_STATE;
   for (const char of input) {
     const codePoint = char.codePointAt(0) ?? 0;
-    for (let i = 0; i < state.length; i++) {
-      state[i] = Math.imul(state[i] ^ codePoint, MULTIPLIERS[i]);
-      state[i] = rotateLeft(state[i], (i + 1) * 3);
-    }
-    state[0] ^= state[3] >>> 11;
-    state[1] ^= state[0] << 7;
-    state[2] ^= state[1] >>> 13;
-    state[3] ^= state[2] << 5;
+    h1 = rotateLeft(Math.imul(h1 ^ codePoint, MULTIPLIERS[0]), 3);
+    h2 = rotateLeft(Math.imul(h2 ^ codePoint, MULTIPLIERS[1]), 6);
+    h3 = rotateLeft(Math.imul(h3 ^ codePoint, MULTIPLIERS[2]), 9);
+    h4 = rotateLeft(Math.imul(h4 ^ codePoint, MULTIPLIERS[3]), 12);
+    h1 ^= h4 >>> 11;
+    h2 ^= h1 << 7;
+    h3 ^= h2 >>> 13;
+    h4 ^= h3 << 5;
   }
-  return state;
+  return [h1, h2, h3, h4];
 }
 function rotateLeft(value, shift) {
   return value << shift | value >>> 32 - shift;
@@ -222,23 +212,23 @@ function md5(input) {
 }
 
 // src/interpolate-template.ts
+function formatValue(value, index) {
+  return value === null || value === void 0 ? `\${${index}}` : String(value);
+}
 function ifArray(template, givenValues) {
-  const strings = [...template.raw];
-  const hasValues = givenValues !== void 0;
-  return strings.reduce((acc, item, index) => {
-    acc += String(item ?? "");
-    if (index < strings.length - 1) {
-      acc += hasValues ? String(givenValues[index] ?? "") : `\${${index}}`;
-    }
-    return acc;
-  }, "");
+  const strings = template.raw;
+  let output = String(strings[0] ?? "");
+  for (let index = 1; index < strings.length; index++) {
+    output += formatValue(givenValues?.[index - 1], index - 1);
+    output += String(strings[index] ?? "");
+  }
+  return output;
 }
 function ifString(template, givenValues) {
   if (template?.indexOf("${") === -1) return template;
   let valueIndex = 0;
   return template.replace(/\$\{[^}]*\}/g, () => {
-    const value = givenValues?.[valueIndex];
-    const output = value === null || value === void 0 ? `\${${valueIndex}}` : String(value);
+    const output = formatValue(givenValues?.[valueIndex], valueIndex);
     valueIndex++;
     return output;
   });
@@ -256,6 +246,11 @@ function createCacheId(text) {
   const cacheId = `gid_${hexHash}`;
   return cacheId;
 }
+
+// src/data/cache-file-path.ts
+function cacheFilePath(config) {
+  return `${config.cache.dir}/${config.cache.file}`;
+}
 var optsArg = (opts) => {
   if (!opts) {
     opts = { mode: 511 };
@@ -467,32 +462,50 @@ async function createCacheDir() {
   const config = await awaitedConfig;
   await mkdirp(config.cache.dir);
 }
-
-// src/data/get-cache.ts
 async function getCache() {
+  const config = await awaitedConfig;
   try {
-    const config = await awaitedConfig;
-    await createCacheDir();
-    const rawCache = await fs.readFile(`${config.cache.dir}/${config.cache.file}`);
+    const rawCache = await fs.readFile(cacheFilePath(config));
     return rawCache.toString();
   } catch (error) {
+    if (error?.code === "ENOENT") await createCacheDir();
     throw error;
   }
 }
-var savingQueue = Promise.resolve();
-async function saveCache(cache) {
+
+// src/data/cache-queue.ts
+var cacheQueue = Promise.resolve();
+function enqueueCacheTask(task) {
+  const run = cacheQueue.then(task);
+  cacheQueue = run.catch(() => void 0);
+  return run;
+}
+async function writeCacheFile(cache) {
+  const config = await awaitedConfig;
+  await createCacheDir();
+  const contents = JSON.stringify(cache, null, 2);
+  await fs.writeFile(cacheFilePath(config), contents);
+}
+async function parseCacheOrEmpty(rawCache) {
+  if (!rawCache) return {};
   try {
-    savingQueue = savingQueue.then(async () => {
-      const config = await awaitedConfig;
-      await createCacheDir();
-      const contents = JSON.stringify(cache, null, 2);
-      await fs.writeFile(`${config.cache.dir}/${config.cache.file}`, contents);
-    });
-    await savingQueue;
-    return cache;
+    return JSON.parse(rawCache);
   } catch (error) {
+    if (!(error instanceof SyntaxError)) throw error;
+    const config = await awaitedConfig;
+    console.warn(`Gringow cache ${cacheFilePath(config)} has invalid JSON (${error.message}), recreating it as {}`);
+    return {};
+  }
+}
+async function readCacheOrEmpty() {
+  let rawCache;
+  try {
+    rawCache = await getCache();
+  } catch (error) {
+    if (error?.code === "ENOENT") return {};
     throw error;
   }
+  return parseCacheOrEmpty(rawCache);
 }
 
 // src/data/get-or-create-cache.ts
@@ -502,13 +515,16 @@ async function getOrCreateCache() {
     rawCache = await getCache();
   } catch (error) {
     if (error?.code === "ENOENT") {
-      await saveCache({});
-      rawCache = await getCache();
+      return enqueueCacheTask(async () => {
+        const cache = await readCacheOrEmpty();
+        if (Object.keys(cache).length === 0) await writeCacheFile(cache);
+        return cache;
+      });
     } else {
       throw error;
     }
   }
-  return rawCache ? JSON.parse(rawCache?.toString()) : {};
+  return parseCacheOrEmpty(rawCache);
 }
 
 // src/data/check-cache.ts
@@ -522,6 +538,12 @@ async function checkCache(cacheId) {
   return void 0;
 }
 
+// src/data/save-cache.ts
+async function saveCache(cache) {
+  await enqueueCacheTask(() => writeCacheFile(cache));
+  return cache;
+}
+
 // src/data/clear-cache.ts
 async function clearCache() {
   await saveCache({});
@@ -529,21 +551,24 @@ async function clearCache() {
 
 // src/data/delete-cache-item.ts
 async function deleteCacheItem(cacheId) {
-  const rawCache = await getOrCreateCache();
-  const cache = rawCache;
-  if (cache[cacheId]) {
-    delete cache[cacheId];
-  }
-  await saveCache(cache);
-  return cache;
+  return enqueueCacheTask(async () => {
+    const cache = await readCacheOrEmpty();
+    if (cache[cacheId]) {
+      delete cache[cacheId];
+    }
+    await writeCacheFile(cache);
+    return cache;
+  });
 }
 
 // src/data/write-cache-to-disk.ts
 async function writeCacheToDisk(cacheId, cached) {
-  const cache = await getOrCreateCache();
-  cache[cacheId] = cached;
-  await saveCache(cache);
-  return cache[cacheId];
+  return enqueueCacheTask(async () => {
+    const cache = await readCacheOrEmpty();
+    cache[cacheId] = cached;
+    await writeCacheFile(cache);
+    return cache[cacheId];
+  });
 }
 var providerEngineMap = {
   anthropic: "anthropic",
@@ -560,9 +585,23 @@ var providerEngineMap = {
   azure: "azure",
   meta: "meta"
 };
+var cacheItemSchema = z.object({
+  original: z.string(),
+  translation: z.record(z.string(), z.string())
+});
 function parseResponse(responseText) {
-  const cleaned = responseText.replace(/```json/g, "").replace(/```/g, "").trim();
-  const parsed = JSON.parse(cleaned);
+  const fenced = responseText.trim().match(/^```(?:json)?\s*([\s\S]*?)\s*```$/);
+  const cleaned = fenced ? fenced[1] : responseText.trim();
+  let parsed;
+  try {
+    parsed = JSON.parse(cleaned);
+  } catch (error) {
+    throw new Error(`Invalid LLM response: not valid JSON (${error.message})`, { cause: error });
+  }
+  const result2 = cacheItemSchema.safeParse(parsed);
+  if (!result2.success) {
+    throw new Error(`Invalid LLM response: ${result2.error.message}`, { cause: result2.error });
+  }
   return parsed;
 }
 async function askLLM(prompt, prePrompt2, postPrompt2) {
@@ -572,7 +611,7 @@ async function askLLM(prompt, prePrompt2, postPrompt2) {
   if (!engineName) {
     throw new Error(`Unknown LLM provider: ${provider}`);
   }
-  if (!config.llm.apiKey) {
+  if (!config.llm.apiKey && !keylessProviders.includes(provider)) {
     throw new Error(`API key for ${provider} is not configured in llm.apiKey`);
   }
   if (config.llm.sleep && config.llm.sleep > 0) {
@@ -610,19 +649,20 @@ function getPrependAndAppend(config, cached) {
     cached?.prepend ?? config.llm.prePromptAppend ?? "",
     config.llm.prePromptReplace ?? ""
   );
-  const append = postPrompt(config, cached?.append ?? config.llm.postPrompt ?? "", config.llm.postPromptReplace ?? "");
+  const append = postPrompt(
+    config,
+    cached?.append ?? config.llm.postPromptPrepend ?? "",
+    config.llm.postPromptReplace ?? ""
+  );
   return { prepend, append };
 }
-async function rebuild(cacheId) {
-  const config = await awaitedConfig;
-  const cached = await checkCache(cacheId);
-  if (!cached) throw new Error("Cache item not found");
+async function translateAndStore(config, cacheId, text, cached, label) {
   const { prepend, append } = getPrependAndAppend(config, cached);
   if (config.debug) {
-    console.log(`rebuild::prepend ${cacheId}:`, { prepend });
-    console.log(`rebuild::append ${cacheId}:`, { append });
+    console.log(`${label}::prepend ${cacheId}:`, { prepend });
+    console.log(`${label}::append ${cacheId}:`, { append });
   }
-  const translation = await askLLM(cached.original, prepend, append);
+  const translation = await askLLM(text, prepend, append);
   const output = {
     ...translation,
     prepend: cached?.prepend ?? void 0,
@@ -633,6 +673,12 @@ async function rebuild(cacheId) {
   }
   return { cacheId, translation: output };
 }
+async function rebuild(cacheId) {
+  const config = await awaitedConfig;
+  const cached = await checkCache(cacheId);
+  if (!cached) throw new Error("Cache item not found");
+  return translateAndStore(config, cacheId, cached.original, cached, "rebuild");
+}
 async function Gringow(text, ...values) {
   const config = await awaitedConfig;
   const interpolated = interpolateTemplate(text.trim(), values);
@@ -641,21 +687,7 @@ async function Gringow(text, ...values) {
   if (cached !== void 0 && cached.original !== "undefined" && !cached.rebuild) {
     return { cacheId, translation: cached };
   }
-  const { prepend, append } = getPrependAndAppend(config, cached);
-  if (config.debug) {
-    console.log(`asking::prepend ${cacheId}:`, { prepend });
-    console.log(`asking::append ${cacheId}:`, { append });
-  }
-  const translation = await askLLM(interpolated, prepend, append);
-  const output = {
-    ...translation,
-    prepend: cached?.prepend ?? void 0,
-    append: cached?.append ?? void 0
-  };
-  if (config.cache.write) {
-    await writeCacheToDisk(cacheId, output);
-  }
-  return { cacheId, translation: output };
+  return translateAndStore(config, cacheId, interpolated, cached, "asking");
 }
 
 // src/strip-comments.ts
@@ -740,7 +772,6 @@ function stripComments(code) {
         top.braceDepth--;
         out += ch;
         i++;
-        if (top.braceDepth === 0) ;
         continue;
       }
     }

package/dist/interpolate-template.d.mts

@@ -1,3 +1,10 @@
+/**
+ * Flattens a template string or TemplateStringsArray with its values.
+ *
+ * @param template - The template to flatten.
+ * @param givenValues - The values to interpolate.
+ * @returns The flattened string.
+ */
 declare function interpolateTemplate(template: TemplateStringsArray | string, givenValues?: unknown[]): string;
 
 export { interpolateTemplate };

package/dist/interpolate-template.mjs

@@ -1,21 +1,21 @@
 // src/interpolate-template.ts
+function formatValue(value, index) {
+  return value === null || value === void 0 ? `\${${index}}` : String(value);
+}
 function ifArray(template, givenValues) {
-  const strings = [...template.raw];
-  const hasValues = givenValues !== void 0;
-  return strings.reduce((acc, item, index) => {
-    acc += String(item ?? "");
-    if (index < strings.length - 1) {
-      acc += hasValues ? String(givenValues[index] ?? "") : `\${${index}}`;
-    }
-    return acc;
-  }, "");
+  const strings = template.raw;
+  let output = String(strings[0] ?? "");
+  for (let index = 1; index < strings.length; index++) {
+    output += formatValue(givenValues?.[index - 1], index - 1);
+    output += String(strings[index] ?? "");
+  }
+  return output;
 }
 function ifString(template, givenValues) {
   if (template?.indexOf("${") === -1) return template;
   let valueIndex = 0;
   return template.replace(/\$\{[^}]*\}/g, () => {
-    const value = givenValues?.[valueIndex];
-    const output = value === null || value === void 0 ? `\${${valueIndex}}` : String(value);
+    const output = formatValue(givenValues?.[valueIndex], valueIndex);
     valueIndex++;
     return output;
   });

package/dist/io/ask-llm.d.mts

@@ -1,13 +1,6 @@
-import { GringowCacheItem } from '../index.mjs';
-import '../config.mjs';
-import '../constants/default-config.mjs';
+import { GringowCacheItem } from '../types/index.mjs';
 import 'zod';
 import '../schemas/config.shcema.mjs';
-import '../create-cache-id.mjs';
-import '../data/clear-cache.mjs';
-import '../data/get-cache.mjs';
-import '../interpolate-template.mjs';
-import '../strip-comments.mjs';
 
 /**
  * Asks an LLM for a response using multi-llm-ts.