@gringow/gringow 0.0.7 → 0.0.8

package/dist/{default-config.d.mts → constants/default-config.d.mts}

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { configSchema } from './schemas/config.shcema.mjs';
+import { configSchema } from '../schemas/config.shcema.mjs';
 
 type GringowConfig = z.infer<typeof configSchema>;
 declare const defaultConfig: GringowConfig;

package/dist/{default-config.mjs → constants/default-config.mjs}

@@ -1,4 +1,4 @@
-// src/default-config.ts
+// src/constants/default-config.ts
 var defaultConfig = {
   debug: false,
   log: {

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

@@ -1,6 +1,6 @@
 export { checkCache } from '../index.mjs';
 import '../config.mjs';
-import '../default-config.mjs';
+import '../constants/default-config.mjs';
 import 'zod';
 import '../schemas/config.shcema.mjs';
 import './clear-cache.mjs';

package/dist/data/check-cache.mjs

@@ -7,7 +7,7 @@ import { mkdir, stat, statSync, mkdirSync } from 'fs';
 
 // src/data/get-cache.ts
 
-// src/default-config.ts
+// src/constants/default-config.ts
 var defaultConfig = {
   debug: false,
   log: {
@@ -398,22 +398,44 @@ async function getOrCreateCache() {
 }
 
 // src/logger.ts
-var levels = {
-  error: 0,
-  warn: 1,
-  info: 2,
-  debug: 3,
-  trace: 4
+var Dim = "\x1B[2m";
+var FgGreen = "\x1B[32m";
+var FgYellow = "\x1B[33m";
+var FgCyan = "\x1B[36m";
+var FgWhite = "\x1B[37m";
+var BgRed = "\x1B[41m";
+var Clear = "\x1B[0m";
+var Colors = {
+  debug: `${Dim}${FgGreen}`,
+  trace: `${Dim}${FgCyan}`,
+  info: `${FgCyan}`,
+  error: `${BgRed}${FgWhite}`,
+  warn: `${FgYellow}`,
+  verbose: `${FgWhite}`
 };
-var currentLevel = "info";
-var maxLevel = levels[currentLevel];
-var noop = () => void 0;
+var isProd = process.env.NODE_ENV === "production";
+function log(level, ...params) {
+  console.log(`${!isProd ? Colors[level] : ""}${String(level).toUpperCase()}	`, ...params, `${!isProd ? Clear : ""}`);
+}
 var logger = {
-  error: maxLevel >= levels.error ? console.error : noop,
-  warn: maxLevel >= levels.warn ? console.warn : noop,
-  info: maxLevel >= levels.info ? console.info : noop,
-  debug: maxLevel >= levels.debug ? console.debug : noop,
-  trace: maxLevel >= levels.trace ? console.trace : noop
+  debug(...params) {
+    return log("debug", ...params);
+  },
+  trace(...params) {
+    return log("trace", ...params);
+  },
+  info(...params) {
+    return log("info", ...params);
+  },
+  warn(...params) {
+    return log("warn", ...params);
+  },
+  error(...params) {
+    return log("error", ...params);
+  },
+  verbose(...params) {
+    return log("verbose", ...params);
+  }
 };
 var logger_default = logger;
 

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

@@ -1,3 +1,12 @@
+/**
+ * Clears all translation cache by saving an empty object
+ *
+ * @returns Promise that resolves when cache is cleared
+ *
+ * @example
+ * await clearCache()
+ * // Cache is now empty
+ */
 declare function clearCache(): Promise<void>;
 
 export { clearCache };

package/dist/data/clear-cache.mjs

@@ -7,7 +7,7 @@ import { mkdir, stat, statSync, mkdirSync } from 'fs';
 
 // src/data/save-cache.ts
 
-// src/default-config.ts
+// src/constants/default-config.ts
 var defaultConfig = {
   debug: false,
   log: {

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

@@ -211,7 +211,7 @@ var mkdirp = Object.assign(async (path, opts) => {
   useNativeSync
 });
 
-// src/default-config.ts
+// src/constants/default-config.ts
 var defaultConfig = {
   debug: false,
   log: {

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

@@ -1,6 +1,6 @@
 export { deleteCacheItem } from '../index.mjs';
 import '../config.mjs';
-import '../default-config.mjs';
+import '../constants/default-config.mjs';
 import 'zod';
 import '../schemas/config.shcema.mjs';
 import './clear-cache.mjs';

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

@@ -7,7 +7,7 @@ import { mkdir, stat, statSync, mkdirSync } from 'fs';
 
 // src/data/get-cache.ts
 
-// src/default-config.ts
+// src/constants/default-config.ts
 var defaultConfig = {
   debug: false,
   log: {

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

@@ -1,3 +1,13 @@
+/**
+ * Retrieves the raw cache content from the filesystem
+ *
+ * @returns Promise that resolves to the raw cache content as a string
+ * @throws {GringowError} If there is an error reading the cache file
+ *
+ * @example
+ * const rawCache = await getCache()
+ * const cache = JSON.parse(rawCache)
+ */
 declare function getCache(): Promise<string>;
 
 export { getCache };

package/dist/data/get-cache.mjs

@@ -7,7 +7,7 @@ import { mkdir, stat, statSync, mkdirSync } from 'fs';
 
 // src/data/get-cache.ts
 
-// src/default-config.ts
+// src/constants/default-config.ts
 var defaultConfig = {
   debug: false,
   log: {

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

@@ -1,6 +1,6 @@
 export { getOrCreateCache } from '../index.mjs';
 import '../config.mjs';
-import '../default-config.mjs';
+import '../constants/default-config.mjs';
 import 'zod';
 import '../schemas/config.shcema.mjs';
 import './clear-cache.mjs';

package/dist/data/get-or-create-cache.mjs

@@ -7,7 +7,7 @@ import { mkdir, stat, statSync, mkdirSync } from 'fs';
 
 // src/data/get-cache.ts
 
-// src/default-config.ts
+// src/constants/default-config.ts
 var defaultConfig = {
   debug: false,
   log: {

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

@@ -1,6 +1,6 @@
 import { GringowCache } from '../index.mjs';
 import '../config.mjs';
-import '../default-config.mjs';
+import '../constants/default-config.mjs';
 import 'zod';
 import '../schemas/config.shcema.mjs';
 import './clear-cache.mjs';
@@ -8,6 +8,12 @@ import './create-cache-id.mjs';
 import './get-cache.mjs';
 import '../flat-template-string.mjs';
 
+/**
+ * Saves the cache to disk.
+ *
+ * @param cache - The cache to save.
+ * @returns The cache.
+ */
 declare function saveCache(cache: GringowCache): Promise<void>;
 
 export { saveCache };

package/dist/data/save-cache.mjs

@@ -7,7 +7,7 @@ import { mkdir, stat, statSync, mkdirSync } from 'fs';
 
 // src/data/save-cache.ts
 
-// src/default-config.ts
+// src/constants/default-config.ts
 var defaultConfig = {
   debug: false,
   log: {

package/dist/data/write-cache-to-disk.d.mts

@@ -1,6 +1,6 @@
 export { writeCacheToDisk } from '../index.mjs';
 import '../config.mjs';
-import '../default-config.mjs';
+import '../constants/default-config.mjs';
 import 'zod';
 import '../schemas/config.shcema.mjs';
 import './clear-cache.mjs';

package/dist/data/write-cache-to-disk.mjs

@@ -7,7 +7,7 @@ import { mkdir, stat, statSync, mkdirSync } from 'fs';
 
 // src/data/get-cache.ts
 
-// src/default-config.ts
+// src/constants/default-config.ts
 var defaultConfig = {
   debug: false,
   log: {

package/dist/flat-template-string.test.mjs

@@ -18141,7 +18141,7 @@ describe("flatTemplateString", () => {
       null,
       void 0
     ]);
-    globalExpect(result).toBe("Value: null, null: null, undefined: undefined");
+    globalExpect(result).toBe("Value: , null: , undefined: ");
   });
   it("should convert numbers to string", () => {
     const result = flatTemplateString(createTemplateStringsArray(["Number: ", ""]), [42]);

package/dist/gringow.d.mts

@@ -1,6 +1,6 @@
 export { default as Gringow } from './index.mjs';
 import './config.mjs';
-import './default-config.mjs';
+import './constants/default-config.mjs';
 import 'zod';
 import './schemas/config.shcema.mjs';
 import './data/clear-cache.mjs';

package/dist/gringow.mjs

@@ -11,7 +11,7 @@ import { env, pipeline } from '@huggingface/transformers';
 
 // src/config.ts
 
-// src/default-config.ts
+// src/constants/default-config.ts
 var defaultConfig = {
   debug: false,
   log: {
@@ -402,22 +402,44 @@ async function getOrCreateCache() {
 }
 
 // src/logger.ts
-var levels = {
-  error: 0,
-  warn: 1,
-  info: 2,
-  debug: 3,
-  trace: 4
+var Dim = "\x1B[2m";
+var FgGreen = "\x1B[32m";
+var FgYellow = "\x1B[33m";
+var FgCyan = "\x1B[36m";
+var FgWhite = "\x1B[37m";
+var BgRed = "\x1B[41m";
+var Clear = "\x1B[0m";
+var Colors = {
+  debug: `${Dim}${FgGreen}`,
+  trace: `${Dim}${FgCyan}`,
+  info: `${FgCyan}`,
+  error: `${BgRed}${FgWhite}`,
+  warn: `${FgYellow}`,
+  verbose: `${FgWhite}`
 };
-var currentLevel = "info";
-var maxLevel = levels[currentLevel];
-var noop = () => void 0;
+var isProd = process.env.NODE_ENV === "production";
+function log(level, ...params) {
+  console.log(`${!isProd ? Colors[level] : ""}${String(level).toUpperCase()}	`, ...params, `${!isProd ? Clear : ""}`);
+}
 var logger = {
-  error: maxLevel >= levels.error ? console.error : noop,
-  warn: maxLevel >= levels.warn ? console.warn : noop,
-  info: maxLevel >= levels.info ? console.info : noop,
-  debug: maxLevel >= levels.debug ? console.debug : noop,
-  trace: maxLevel >= levels.trace ? console.trace : noop
+  debug(...params) {
+    return log("debug", ...params);
+  },
+  trace(...params) {
+    return log("trace", ...params);
+  },
+  info(...params) {
+    return log("info", ...params);
+  },
+  warn(...params) {
+    return log("warn", ...params);
+  },
+  error(...params) {
+    return log("error", ...params);
+  },
+  verbose(...params) {
+    return log("verbose", ...params);
+  }
 };
 var logger_default = logger;
 
@@ -864,10 +886,10 @@ var llmChoices = {
     parse: parseHuggingface
   }
 };
-async function processChoice(choice, prompt) {
-  const response = await choice.ask(prompt);
-  const unparsed = choice.commitResponse(response);
-  const parsed = choice.parse(unparsed);
+async function processLLMChoice(llmChoice, prompt) {
+  const response = await llmChoice.ask(prompt);
+  const unparsed = llmChoice.commitResponse(response);
+  const parsed = llmChoice.parse(unparsed);
   return parsed;
 }
 async function askLLM(prompt) {
@@ -877,7 +899,7 @@ async function askLLM(prompt) {
   if (!llmChoice) {
     throw new Error("LLMChoice not found");
   }
-  return processChoice(llmChoice, prompt);
+  return processLLMChoice(llmChoice, prompt);
 }
 
 // src/gringow.ts

package/dist/index.d.mts

@@ -3,10 +3,22 @@ export { clearCache } from './data/clear-cache.mjs';
 export { createCacheId } from './data/create-cache-id.mjs';
 export { getCache } from './data/get-cache.mjs';
 export { flatTemplateString } from './flat-template-string.mjs';
-export { GringowConfig } from './default-config.mjs';
+export { GringowConfig } from './constants/default-config.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>;
 
 /**
@@ -17,14 +29,24 @@ declare function checkCache(cacheId: string): Promise<GringowCacheItem | undefin
  */
 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 function.
- * @returns The cache ID.
+ * @param cached - The cached item.
+ * @returns The cached item.
  */
 declare function writeCacheToDisk(cacheId: string, cached: GringowCacheItem): Promise<GringowCacheItem>;
 

package/dist/index.mjs

@@ -11,7 +11,7 @@ import { env, pipeline } from '@huggingface/transformers';
 
 // src/config.ts
 
-// src/default-config.ts
+// src/constants/default-config.ts
 var defaultConfig = {
   debug: false,
   log: {
@@ -408,22 +408,44 @@ async function getOrCreateCache() {
 }
 
 // src/logger.ts
-var levels = {
-  error: 0,
-  warn: 1,
-  info: 2,
-  debug: 3,
-  trace: 4
+var Dim = "\x1B[2m";
+var FgGreen = "\x1B[32m";
+var FgYellow = "\x1B[33m";
+var FgCyan = "\x1B[36m";
+var FgWhite = "\x1B[37m";
+var BgRed = "\x1B[41m";
+var Clear = "\x1B[0m";
+var Colors = {
+  debug: `${Dim}${FgGreen}`,
+  trace: `${Dim}${FgCyan}`,
+  info: `${FgCyan}`,
+  error: `${BgRed}${FgWhite}`,
+  warn: `${FgYellow}`,
+  verbose: `${FgWhite}`
 };
-var currentLevel = "info";
-var maxLevel = levels[currentLevel];
-var noop = () => void 0;
+var isProd = process.env.NODE_ENV === "production";
+function log(level, ...params) {
+  console.log(`${!isProd ? Colors[level] : ""}${String(level).toUpperCase()}	`, ...params, `${!isProd ? Clear : ""}`);
+}
 var logger = {
-  error: maxLevel >= levels.error ? console.error : noop,
-  warn: maxLevel >= levels.warn ? console.warn : noop,
-  info: maxLevel >= levels.info ? console.info : noop,
-  debug: maxLevel >= levels.debug ? console.debug : noop,
-  trace: maxLevel >= levels.trace ? console.trace : noop
+  debug(...params) {
+    return log("debug", ...params);
+  },
+  trace(...params) {
+    return log("trace", ...params);
+  },
+  info(...params) {
+    return log("info", ...params);
+  },
+  warn(...params) {
+    return log("warn", ...params);
+  },
+  error(...params) {
+    return log("error", ...params);
+  },
+  verbose(...params) {
+    return log("verbose", ...params);
+  }
 };
 var logger_default = logger;
 
@@ -886,10 +908,10 @@ var llmChoices = {
     parse: parseHuggingface
   }
 };
-async function processChoice(choice, prompt) {
-  const response = await choice.ask(prompt);
-  const unparsed = choice.commitResponse(response);
-  const parsed = choice.parse(unparsed);
+async function processLLMChoice(llmChoice, prompt) {
+  const response = await llmChoice.ask(prompt);
+  const unparsed = llmChoice.commitResponse(response);
+  const parsed = llmChoice.parse(unparsed);
   return parsed;
 }
 async function askLLM(prompt) {
@@ -899,7 +921,7 @@ async function askLLM(prompt) {
   if (!llmChoice) {
     throw new Error("LLMChoice not found");
   }
-  return processChoice(llmChoice, prompt);
+  return processLLMChoice(llmChoice, prompt);
 }
 
 // src/gringow.ts

package/dist/io/anthropic/ask.d.mts

@@ -1,5 +1,11 @@
 import Anthropic from '@anthropic-ai/sdk';
 
+/**
+ * Asks the Anthropic model for a response.
+ *
+ * @param message - The message to ask the model.
+ * @returns The response from the model.
+ */
 declare function askAnthropic(message: string): Promise<Anthropic.Messages.Message>;
 
 export { askAnthropic };

package/dist/io/anthropic/ask.mjs

@@ -5,7 +5,7 @@ import { z } from 'zod';
 
 // src/io/anthropic/ask.ts
 
-// src/default-config.ts
+// src/constants/default-config.ts
 var defaultConfig = {
   debug: false,
   log: {

package/dist/io/anthropic/commit-response.d.mts

@@ -3,13 +3,19 @@ import { CommitResponse } from '../../types/index.mjs';
 import 'zod';
 import '../../index.mjs';
 import '../../config.mjs';
-import '../../default-config.mjs';
+import '../../constants/default-config.mjs';
 import '../../schemas/config.shcema.mjs';
 import '../../data/clear-cache.mjs';
 import '../../data/create-cache-id.mjs';
 import '../../data/get-cache.mjs';
 import '../../flat-template-string.mjs';
 
+/**
+ * Commits the response from the Anthropic model.
+ *
+ * @param response - The response from the model.
+ * @returns The committed response.
+ */
 declare function commitResponseAnthropic(response: Anthropic.Messages.Message): CommitResponse;
 
 export { commitResponseAnthropic };

package/dist/io/anthropic/index.d.mts

@@ -6,7 +6,7 @@ import '../../types/index.mjs';
 import 'zod';
 import '../../index.mjs';
 import '../../config.mjs';
-import '../../default-config.mjs';
+import '../../constants/default-config.mjs';
 import '../../schemas/config.shcema.mjs';
 import '../../data/clear-cache.mjs';
 import '../../data/create-cache-id.mjs';

package/dist/io/anthropic/index.mjs

@@ -5,7 +5,7 @@ import { z } from 'zod';
 
 // src/io/anthropic/ask.ts
 
-// src/default-config.ts
+// src/constants/default-config.ts
 var defaultConfig = {
   debug: false,
   log: {

package/dist/io/anthropic/parse.d.mts

@@ -1,7 +1,7 @@
 import { GringowCacheItem } from '../../index.mjs';
 import { CommitResponse } from '../../types/index.mjs';
 import '../../config.mjs';
-import '../../default-config.mjs';
+import '../../constants/default-config.mjs';
 import 'zod';
 import '../../schemas/config.shcema.mjs';
 import '../../data/clear-cache.mjs';
@@ -9,6 +9,12 @@ import '../../data/create-cache-id.mjs';
 import '../../data/get-cache.mjs';
 import '../../flat-template-string.mjs';
 
+/**
+ * Parses the response from the Anthropic model.
+ *
+ * @param unparsed - The unparsed response from the model.
+ * @returns The parsed response.
+ */
 declare function parseAnthropic(unparsed: CommitResponse): GringowCacheItem;
 
 export { parseAnthropic };

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

@@ -1,6 +1,6 @@
 import { GringowCacheItem } from '../index.mjs';
 import '../config.mjs';
-import '../default-config.mjs';
+import '../constants/default-config.mjs';
 import 'zod';
 import '../schemas/config.shcema.mjs';
 import '../data/clear-cache.mjs';
@@ -8,6 +8,12 @@ import '../data/create-cache-id.mjs';
 import '../data/get-cache.mjs';
 import '../flat-template-string.mjs';
 
+/**
+ * Asks an LLM for a response.
+ *
+ * @param prompt - The prompt to ask the model.
+ * @returns The parsed response.
+ */
 declare function askLLM(prompt: string): Promise<GringowCacheItem>;
 
 export { askLLM };

package/dist/io/ask-llm.mjs

@@ -8,7 +8,7 @@ import 'fs';
 
 // src/config.ts
 
-// src/default-config.ts
+// src/constants/default-config.ts
 var defaultConfig = {
   debug: false,
   log: {
@@ -554,10 +554,10 @@ var llmChoices = {
     parse: parseHuggingface
   }
 };
-async function processChoice(choice, prompt) {
-  const response = await choice.ask(prompt);
-  const unparsed = choice.commitResponse(response);
-  const parsed = choice.parse(unparsed);
+async function processLLMChoice(llmChoice, prompt) {
+  const response = await llmChoice.ask(prompt);
+  const unparsed = llmChoice.commitResponse(response);
+  const parsed = llmChoice.parse(unparsed);
   return parsed;
 }
 async function askLLM(prompt) {
@@ -567,7 +567,7 @@ async function askLLM(prompt) {
   if (!llmChoice) {
     throw new Error("LLMChoice not found");
   }
-  return processChoice(llmChoice, prompt);
+  return processLLMChoice(llmChoice, prompt);
 }
 
 export { askLLM };

package/dist/io/gemini/ask.d.mts

@@ -1,5 +1,11 @@
 import { GenerateContentResult } from '@google/generative-ai';
 
+/**
+ * Asks the Gemini model for a response.
+ *
+ * @param message - The message to ask the model.
+ * @returns The response from the model.
+ */
 declare function askGemini(message: string): Promise<GenerateContentResult>;
 
 export { askGemini };

package/dist/io/gemini/ask.mjs

@@ -5,7 +5,7 @@ import { z } from 'zod';
 
 // src/io/gemini/ask.ts
 
-// src/default-config.ts
+// src/constants/default-config.ts
 var defaultConfig = {
   debug: false,
   log: {