@gringow/gringow 0.0.6 → 0.0.8

package/dist/index.d.mts

@@ -0,0 +1,82 @@
+export { awaitedConfig, getConfigSource, isLocalConfigFound } from './config.mjs';
+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 './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>;
+
+/**
+ * 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;
+};
+type GringowCache = {
+    [key: string]: GringowCacheItem;
+};
+type GringowResponse = {
+    cacheId: string;
+    translation: GringowCacheItem;
+};
+type GringowError = Error & {
+    code?: string;
+    cause?: Error;
+};
+
+/**
+ * Gringow is a function that translates a string or a template string into a
+ * translated string.
+ *
+ * @param strings - The string or template string to translate.
+ * @param values - The values to interpolate into the string.
+ * @returns The translated string.
+ */
+declare function Gringow(strings: TemplateStringsArray | string, ...values: Array<unknown>): Promise<GringowResponse>;
+
+export { type GringowCache, type GringowCacheItem, type GringowError, type GringowResponse, type GringowTranslation, checkCache, Gringow as default, deleteCacheItem, getOrCreateCache, writeCacheToDisk };