@hyperfrontend/project-scope 0.1.0

package/core/cache.d.ts

@@ -0,0 +1,157 @@
+/**
+ * Options for cache creation.
+ */
+export interface CacheOptions {
+    /**
+     * Time to live in milliseconds.
+     * Entries older than this will be considered expired.
+     */
+    ttl?: number;
+    /**
+     * Maximum number of entries in cache.
+     * When exceeded, oldest entries are evicted (FIFO).
+     */
+    maxSize?: number;
+}
+/**
+ * Cache interface for storing key-value pairs with optional TTL and size limits.
+ */
+export interface Cache<K, V> {
+    /**
+     * Get a value from the cache.
+     *
+     * @param key - Cache key
+     * @returns Cached value or undefined if not found or expired
+     */
+    get(key: K): V | undefined;
+    /**
+     * Set a value in the cache.
+     *
+     * @param key - Cache key
+     * @param value - Value to cache
+     */
+    set(key: K, value: V): void;
+    /**
+     * Check if a key exists in the cache (and is not expired).
+     *
+     * @param key - Cache key
+     * @returns True if key exists and is not expired
+     */
+    has(key: K): boolean;
+    /**
+     * Delete a key from the cache.
+     *
+     * @param key - Cache key
+     * @returns True if the key was deleted
+     */
+    delete(key: K): boolean;
+    /**
+     * Clear all entries from the cache.
+     */
+    clear(): void;
+    /**
+     * Get the current number of entries in the cache.
+     *
+     * @returns Number of entries
+     */
+    size(): number;
+    /**
+     * Get all keys in the cache.
+     *
+     * @returns Array of keys
+     */
+    keys(): K[];
+}
+/**
+ * Create a cache with optional TTL and size limits.
+ *
+ * The cache provides a simple key-value store with:
+ * - Optional TTL (time-to-live) for automatic expiration
+ * - Optional maxSize for limiting cache size with FIFO eviction
+ * - Lazy expiration (entries are checked on access)
+ *
+ * @param options - Cache configuration options
+ * @returns Cache instance
+ *
+ * @example
+ * ```typescript
+ * // Basic cache
+ * const cache = createCache<string, number>()
+ * cache.set('answer', 42)
+ * cache.get('answer') // 42
+ *
+ * // Cache with TTL (expires after 60 seconds)
+ * const ttlCache = createCache<string, object>({ ttl: 60000 })
+ *
+ * // Cache with max size (evicts oldest when full)
+ * const lruCache = createCache<string, object>({ maxSize: 100 })
+ *
+ * // Combined options
+ * const configCache = createCache<string, object>({
+ *   ttl: 30000,
+ *   maxSize: 50
+ * })
+ * ```
+ */
+export declare function createCache<K, V>(options?: CacheOptions): Cache<K, V>;
+/**
+ * Clear all registered caches.
+ *
+ * Useful for testing or when a global state reset is needed.
+ * This clears all caches created via `createCache()`.
+ *
+ * @example
+ * ```typescript
+ * // In tests
+ * afterEach(() => {
+ *   clearAllCaches()
+ * })
+ * ```
+ */
+export declare function clearAllCaches(): void;
+/**
+ * Get the number of registered caches.
+ *
+ * Primarily used for testing.
+ *
+ * @returns Number of registered caches
+ */
+export declare function getCacheCount(): number;
+/**
+ * Unregister a cache from the global registry.
+ *
+ * Useful for cleanup in tests or when a cache is no longer needed.
+ *
+ * @param cache - Cache to unregister
+ * @returns True if cache was unregistered
+ */
+export declare function unregisterCache<K, V>(cache: Cache<K, V>): boolean;
+/**
+ * Create a memoized version of a function with caching.
+ *
+ * The memoized function caches results based on the first argument (key).
+ * If additional arguments are needed, use the options.keyFn parameter.
+ *
+ * @param fn - Function to memoize
+ * @param options - Cache options for the underlying cache
+ * @returns Memoized function with cache control methods
+ *
+ * @example
+ * ```typescript
+ * // Memoize a detection function
+ * const detectTechStackMemo = memoize(
+ *   (path: string) => expensiveDetection(path),
+ *   { ttl: 60000 }
+ * )
+ *
+ * const result1 = detectTechStackMemo('/path/to/project')
+ * const result2 = detectTechStackMemo('/path/to/project') // Returns cached
+ *
+ * // Clear the cache
+ * detectTechStackMemo.cache.clear()
+ * ```
+ */
+export declare function memoize<K, V>(fn: (key: K) => V, options?: CacheOptions): ((key: K) => V) & {
+    cache: Cache<K, V>;
+};
+//# sourceMappingURL=cache.d.ts.map

package/core/cache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../../../../../../../libs/project-scope/src/core/cache.ts"],"names":[],"mappings":"AAcA;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,KAAK,CAAC,CAAC,EAAE,CAAC;IACzB;;;;;OAKG;IACH,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS,CAAA;IAE1B;;;;;OAKG;IACH,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,CAAA;IAE3B;;;;;OAKG;IACH,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO,CAAA;IAEpB;;;;;OAKG;IACH,MAAM,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO,CAAA;IAEvB;;OAEG;IACH,KAAK,IAAI,IAAI,CAAA;IAEb;;;;OAIG;IACH,IAAI,IAAI,MAAM,CAAA;IAEd;;;;OAIG;IACH,IAAI,IAAI,CAAC,EAAE,CAAA;CACZ;AAOD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CA2GrE;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,IAAI,IAAI,CAIrC;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,IAAI,MAAM,CAEtC;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,OAAO,CAEjE;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG;IAAE,KAAK,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;CAAE,CAsBjH"}

package/core/encoding/convert.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Convert content to UTF-8 string.
+ *
+ * @param content - Buffer or string content
+ * @param sourceEncoding - Source encoding (auto-detected if not provided)
+ * @returns UTF-8 string
+ */
+export declare function toUtf8(content: Buffer | string, sourceEncoding?: BufferEncoding): string;
+/**
+ * Convert buffer to string with encoding detection.
+ *
+ * @param content - Buffer to convert
+ * @param encoding - Optional encoding override (auto-detected if not provided)
+ * @returns Converted string
+ * @throws {Error} If content is binary and cannot be converted
+ */
+export declare function bufferToString(content: Buffer, encoding?: BufferEncoding): string;
+/**
+ * Strip BOM from start of string if present.
+ *
+ * @param content - String that may have BOM
+ * @returns String without BOM
+ */
+export declare function stripBom(content: string): string;
+/**
+ * Add UTF-8 BOM to string if not present.
+ *
+ * @param content - String to add BOM to
+ * @returns String with BOM
+ */
+export declare function addBom(content: string): string;
+//# sourceMappingURL=convert.d.ts.map

package/core/encoding/convert.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"convert.d.ts","sourceRoot":"","sources":["../../../../../../../../libs/project-scope/src/core/encoding/convert.ts"],"names":[],"mappings":"AAMA;;;;;;GAMG;AACH,wBAAgB,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,cAAc,GAAE,cAAwB,GAAG,MAAM,CAKjG;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc,GAAG,MAAM,CAsBjF;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAKhD;AAED;;;;;GAKG;AACH,wBAAgB,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAK9C"}

package/core/encoding/detect.d.ts

@@ -0,0 +1,86 @@
+/** UTF-8 BOM bytes */
+export declare const UTF8_BOM_BYTES: readonly [239, 187, 191];
+/** UTF-16 LE BOM bytes */
+export declare const UTF16_LE_BOM_BYTES: readonly [255, 254];
+/** UTF-16 BE BOM bytes */
+export declare const UTF16_BE_BOM_BYTES: readonly [254, 255];
+/** UTF-8 BOM string */
+export declare const UTF8_BOM = "\uFEFF";
+/**
+ * Common binary file signatures.
+ */
+export declare const BINARY_SIGNATURES: readonly [{
+    readonly signature: readonly [137, 80, 78, 71];
+    readonly description: "PNG";
+}, {
+    readonly signature: readonly [255, 216, 255];
+    readonly description: "JPEG";
+}, {
+    readonly signature: readonly [71, 73, 70, 56];
+    readonly description: "GIF";
+}, {
+    readonly signature: readonly [80, 75, 3, 4];
+    readonly description: "ZIP";
+}, {
+    readonly signature: readonly [31, 139];
+    readonly description: "GZIP";
+}, {
+    readonly signature: readonly [66, 90, 104];
+    readonly description: "BZIP2";
+}, {
+    readonly signature: readonly [127, 69, 76, 70];
+    readonly description: "ELF";
+}, {
+    readonly signature: readonly [77, 90];
+    readonly description: "EXE";
+}, {
+    readonly signature: readonly [37, 80, 68, 70];
+    readonly description: "PDF";
+}];
+/**
+ * Encoding detection result.
+ */
+export type EncodingInfo = {
+    type: 'text';
+    encoding: BufferEncoding;
+    hasBom: boolean;
+} | {
+    type: 'binary';
+    format?: string;
+};
+/**
+ * Detect if content is likely text or binary with encoding information.
+ *
+ * @param buffer - Buffer to analyze
+ * @returns Encoding information
+ */
+export declare function detectEncodingInfo(buffer: Buffer): EncodingInfo;
+/**
+ * Detect file encoding from BOM or content analysis.
+ *
+ * @param buffer - Buffer to analyze
+ * @returns Detected encoding, defaults to 'utf-8'
+ */
+export declare function detectEncoding(buffer: Buffer): BufferEncoding;
+/**
+ * Check if buffer starts with a BOM.
+ *
+ * @param buffer - Buffer to check
+ * @returns True if buffer has a BOM
+ */
+export declare function hasBom(buffer: Buffer): boolean;
+/**
+ * Check if buffer represents text content.
+ *
+ * @param buffer - Buffer to check
+ * @returns True if the buffer appears to be text
+ */
+export declare function isTextFile(buffer: Buffer): boolean;
+/**
+ * Check if buffer represents binary content.
+ *
+ * @param buffer - Buffer to check
+ * @returns True if the buffer appears to be binary
+ */
+export declare function isBinaryFile(buffer: Buffer): boolean;
+//# sourceMappingURL=detect.d.ts.map

package/core/encoding/detect.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"detect.d.ts","sourceRoot":"","sources":["../../../../../../../../libs/project-scope/src/core/encoding/detect.ts"],"names":[],"mappings":"AAKA,sBAAsB;AACtB,eAAO,MAAM,cAAc,0BAA4B,CAAA;AAEvD,0BAA0B;AAC1B,eAAO,MAAM,kBAAkB,qBAAsB,CAAA;AAErD,0BAA0B;AAC1B,eAAO,MAAM,kBAAkB,qBAAsB,CAAA;AAErD,uBAAuB;AACvB,eAAO,MAAM,QAAQ,WAAW,CAAA;AAEhC;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;EAU7B,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,cAAc,CAAC;IAAC,MAAM,EAAE,OAAO,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,CAAA;AAE5H;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY,CAmD/D;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,cAAc,CAsB7D;AAED;;;;;GAKG;AACH,wBAAgB,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAiB9C;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAElD;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEpD"}