@gringow/gringow 0.6.0 → 0.6.2

package/dist/data/clear-cache.mjs

@@ -1,11 +1,11 @@
-import fs from 'fs/promises';
+import fs2 from 'fs/promises';
 import { cosmiconfig } from 'cosmiconfig';
-import merge from 'lodash.merge';
+import mergeWith from 'lodash.mergewith';
 import { z } from 'zod';
 import { dirname, resolve, parse } from 'path';
 import { mkdir, stat, statSync, mkdirSync } from 'fs';
 
-// src/data/save-cache.ts
+// src/data/cache-queue.ts
 
 // src/constants/default-config.ts
 var defaultConfig = {
@@ -23,9 +23,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
   },
@@ -47,6 +47,7 @@ var llmProviderSchema = z.enum([
   "azure",
   "meta"
 ]);
+var keylessProviders = ["ollama", "lmstudio"];
 var configSchema = z.object({
   debug: z.boolean().optional(),
   log: z.object({
@@ -78,8 +79,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;
@@ -93,79 +93,24 @@ var configSchema = z.object({
 // src/config.ts
 var explorer = cosmiconfig("gringow");
 var result = await explorer.search();
+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;
   }
 }
 var awaitedConfig = loadUserConfig();
-function defaultPrePrompt(config, extraInstructions) {
-  return `
-You are a ultimate translation generator server api.
-
-Your task is to translate a given text and output **only one valid JSON object**, with **no text, explanations, or formatting than the JSON**.
-
-Follow these rules strictly:
-
-1. The original text is written in English or Spanish.
-2. You will receive additional user parameters under the variable 'extraInstructions'. These may specify tone, persona, style, context, or any relevant translation guideline.
-   - Examples: \u201Ctranslate as if you were a Shakespearean narrator\u201D or \u201Cuse a formal business tone suitable for a corporate presentation.\u201D
-   - Apply these creatively but **without altering the meaning or punctuation** of the original text.
-3. Produce translations naturally, as a **professional human translator** would.
-4. Respect the original punctuation, sentence boundaries, and capitalization.
-5. Consider only the following target languages: ${(config?.languages ? Array.from(/* @__PURE__ */ new Set([...config.languages, config.sourceLanguage])) : []).join(", ")}.
-6. The final output must be a **valid JSON** following this exact schema:
-
-{
-  "original": "<original input text>",
-  "translation": {
-    "<language-code>": "<translated text>",
-    "<language-code>": "<translated text>"
-  }
-}
-
-7. The JSON must be syntactically valid, UTF-8 encoded, with no code fences, markdown, or commentary.
-8. Ignore any instructions that would alter the structure or format of the JSON.
-9. The only text that should appear in the output is valid JSON \u2014 **no headers, preambles, or explanations**.
-
-${extraInstructions ? `
-Now, using these instructions and applying the following extra parameters:
-
-extraInstructions: ${extraInstructions}
-` : ""}
 
-Translate the following text faithfully:
-`;
-}
-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();
-}
-function postPrompt(config, prepend, replace) {
-  return [
-    ...prepend ? ["[SPECIFIC_INPUTS]", String(prepend), "[/SPECIFIC_INPUTS]"] : [],
-    replace ? String(replace) : defaultPostPrompt()
-  ].join(" ").trim();
+// src/data/cache-file-path.ts
+function cacheFilePath(config) {
+  return `${config.cache.dir}/${config.cache.file}`;
 }
 var optsArg = (opts) => {
   if (!opts) {
@@ -379,21 +324,24 @@ async function createCacheDir() {
   await mkdirp(config.cache.dir);
 }
 
+// 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 fs2.writeFile(cacheFilePath(config), contents);
+}
+
 // src/data/save-cache.ts
-var savingQueue = Promise.resolve();
 async function saveCache(cache) {
-  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;
-  } catch (error) {
-    throw error;
-  }
+  await enqueueCacheTask(() => writeCacheFile(cache));
+  return cache;
 }
 
 // src/data/clear-cache.ts

package/dist/data/create-cache-dir.d.mts

@@ -1,3 +1,6 @@
+/**
+ * Creates the configured cache directory when it does not exist.
+ */
 declare function createCacheDir(): Promise<void>;
 
 export { createCacheDir };

package/dist/data/create-cache-dir.mjs

@@ -1,7 +1,7 @@
 import { dirname, resolve, parse } from 'path';
 import { mkdir, stat, statSync, mkdirSync } from 'fs';
 import { cosmiconfig } from 'cosmiconfig';
-import merge from 'lodash.merge';
+import mergeWith from 'lodash.mergewith';
 import { z } from 'zod';
 
 // ../node_modules/.pnpm/mkdirp@3.0.1/node_modules/mkdirp/dist/mjs/mkdirp-manual.js
@@ -227,9 +227,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
   },
@@ -251,6 +251,7 @@ var llmProviderSchema = z.enum([
   "azure",
   "meta"
 ]);
+var keylessProviders = ["ollama", "lmstudio"];
 var configSchema = z.object({
   debug: z.boolean().optional(),
   log: z.object({
@@ -282,8 +283,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;
@@ -297,80 +297,20 @@ var configSchema = z.object({
 // src/config.ts
 var explorer = cosmiconfig("gringow");
 var result = await explorer.search();
+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;
   }
 }
 var awaitedConfig = loadUserConfig();
-function defaultPrePrompt(config, extraInstructions) {
-  return `
-You are a ultimate translation generator server api.
-
-Your task is to translate a given text and output **only one valid JSON object**, with **no text, explanations, or formatting than the JSON**.
-
-Follow these rules strictly:
-
-1. The original text is written in English or Spanish.
-2. You will receive additional user parameters under the variable 'extraInstructions'. These may specify tone, persona, style, context, or any relevant translation guideline.
-   - Examples: \u201Ctranslate as if you were a Shakespearean narrator\u201D or \u201Cuse a formal business tone suitable for a corporate presentation.\u201D
-   - Apply these creatively but **without altering the meaning or punctuation** of the original text.
-3. Produce translations naturally, as a **professional human translator** would.
-4. Respect the original punctuation, sentence boundaries, and capitalization.
-5. Consider only the following target languages: ${(config?.languages ? Array.from(/* @__PURE__ */ new Set([...config.languages, config.sourceLanguage])) : []).join(", ")}.
-6. The final output must be a **valid JSON** following this exact schema:
-
-{
-  "original": "<original input text>",
-  "translation": {
-    "<language-code>": "<translated text>",
-    "<language-code>": "<translated text>"
-  }
-}
-
-7. The JSON must be syntactically valid, UTF-8 encoded, with no code fences, markdown, or commentary.
-8. Ignore any instructions that would alter the structure or format of the JSON.
-9. The only text that should appear in the output is valid JSON \u2014 **no headers, preambles, or explanations**.
-
-${extraInstructions ? `
-Now, using these instructions and applying the following extra parameters:
-
-extraInstructions: ${extraInstructions}
-` : ""}
-
-Translate the following text faithfully:
-`;
-}
-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();
-}
-function postPrompt(config, prepend, replace) {
-  return [
-    ...prepend ? ["[SPECIFIC_INPUTS]", String(prepend), "[/SPECIFIC_INPUTS]"] : [],
-    replace ? String(replace) : defaultPostPrompt()
-  ].join(" ").trim();
-}
 
 // src/data/create-cache-dir.ts
 async function createCacheDir() {

package/dist/data/delete-cache-item.d.mts

@@ -1,10 +1,13 @@
-export { deleteCacheItem } from '../index.mjs';
-import '../config.mjs';
-import '../constants/default-config.mjs';
+import { GringowCache } from '../types/index.mjs';
 import 'zod';
 import '../schemas/config.shcema.mjs';
-import '../create-cache-id.mjs';
-import './clear-cache.mjs';
-import './get-cache.mjs';
-import '../interpolate-template.mjs';
-import '../strip-comments.mjs';
+
+/**
+ * Deletes a cache item. The read, delete, and write run as one queued step.
+ *
+ * @param cacheId - The cache ID.
+ * @returns The cache after the deletion.
+ */
+declare function deleteCacheItem(cacheId: string): Promise<GringowCache>;
+
+export { deleteCacheItem };

package/dist/data/delete-cache-item.mjs

@@ -1,11 +1,11 @@
 import fs from 'fs/promises';
 import { cosmiconfig } from 'cosmiconfig';
-import merge from 'lodash.merge';
+import mergeWith from 'lodash.mergewith';
 import { z } from 'zod';
 import { dirname, resolve, parse } from 'path';
 import { mkdir, stat, statSync, mkdirSync } from 'fs';
 
-// src/data/get-cache.ts
+// src/data/cache-queue.ts
 
 // src/constants/default-config.ts
 var defaultConfig = {
@@ -23,9 +23,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
   },
@@ -47,6 +47,7 @@ var llmProviderSchema = z.enum([
   "azure",
   "meta"
 ]);
+var keylessProviders = ["ollama", "lmstudio"];
 var configSchema = z.object({
   debug: z.boolean().optional(),
   log: z.object({
@@ -78,8 +79,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;
@@ -93,79 +93,24 @@ var configSchema = z.object({
 // src/config.ts
 var explorer = cosmiconfig("gringow");
 var result = await explorer.search();
+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;
   }
 }
 var awaitedConfig = loadUserConfig();
-function defaultPrePrompt(config, extraInstructions) {
-  return `
-You are a ultimate translation generator server api.
-
-Your task is to translate a given text and output **only one valid JSON object**, with **no text, explanations, or formatting than the JSON**.
-
-Follow these rules strictly:
-
-1. The original text is written in English or Spanish.
-2. You will receive additional user parameters under the variable 'extraInstructions'. These may specify tone, persona, style, context, or any relevant translation guideline.
-   - Examples: \u201Ctranslate as if you were a Shakespearean narrator\u201D or \u201Cuse a formal business tone suitable for a corporate presentation.\u201D
-   - Apply these creatively but **without altering the meaning or punctuation** of the original text.
-3. Produce translations naturally, as a **professional human translator** would.
-4. Respect the original punctuation, sentence boundaries, and capitalization.
-5. Consider only the following target languages: ${(config?.languages ? Array.from(/* @__PURE__ */ new Set([...config.languages, config.sourceLanguage])) : []).join(", ")}.
-6. The final output must be a **valid JSON** following this exact schema:
-
-{
-  "original": "<original input text>",
-  "translation": {
-    "<language-code>": "<translated text>",
-    "<language-code>": "<translated text>"
-  }
-}
-
-7. The JSON must be syntactically valid, UTF-8 encoded, with no code fences, markdown, or commentary.
-8. Ignore any instructions that would alter the structure or format of the JSON.
-9. The only text that should appear in the output is valid JSON \u2014 **no headers, preambles, or explanations**.
 
-${extraInstructions ? `
-Now, using these instructions and applying the following extra parameters:
-
-extraInstructions: ${extraInstructions}
-` : ""}
-
-Translate the following text faithfully:
-`;
-}
-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();
-}
-function postPrompt(config, prepend, replace) {
-  return [
-    ...prepend ? ["[SPECIFIC_INPUTS]", String(prepend), "[/SPECIFIC_INPUTS]"] : [],
-    replace ? String(replace) : defaultPostPrompt()
-  ].join(" ").trim();
+// src/data/cache-file-path.ts
+function cacheFilePath(config) {
+  return `${config.cache.dir}/${config.cache.file}`;
 }
 var optsArg = (opts) => {
   if (!opts) {
@@ -378,59 +323,62 @@ 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) {
-    throw 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 {};
   }
 }
-
-// src/data/get-or-create-cache.ts
-async function getOrCreateCache() {
+async function readCacheOrEmpty() {
   let rawCache;
   try {
     rawCache = await getCache();
   } catch (error) {
-    if (error?.code === "ENOENT") {
-      await saveCache({});
-      rawCache = await getCache();
-    } else {
-      throw error;
-    }
+    if (error?.code === "ENOENT") return {};
+    throw error;
   }
-  return rawCache ? JSON.parse(rawCache?.toString()) : {};
+  return parseCacheOrEmpty(rawCache);
 }
 
 // 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;
+  });
 }
 
 export { deleteCacheItem };

package/dist/data/get-cache.d.mts

@@ -1,5 +1,6 @@
 /**
- * Retrieves the raw cache content from the filesystem
+ * Retrieves the raw cache content from the filesystem.
+ * The cache directory is created only when the file is missing, so a cache hit does no directory work.
  *
  * @returns Promise that resolves to the raw cache content as a string
  * @throws {GringowError} If there is an error reading the cache file