@bleedingdev/modern-js-runtime-utils 3.2.0-ultramodern.0

package/dist/esm-node/universal/cache.mjs

@@ -0,0 +1,327 @@
+import "node:module";
+import { LRUCache } from "lru-cache";
+import { getAsyncLocalStorage } from "./async_storage.mjs";
+const CacheSize = {
+    KB: 1024,
+    MB: 1048576,
+    GB: 1073741824
+};
+const CacheTime = {
+    SECOND: 1000,
+    MINUTE: 60000,
+    HOUR: 3600000,
+    DAY: 86400000,
+    WEEK: 604800000,
+    MONTH: 2592000000
+};
+function estimateObjectSize(data) {
+    const type = typeof data;
+    if ('number' === type) return 8;
+    if ('boolean' === type) return 4;
+    if ('string' === type) return Math.max(2 * data.length, 1);
+    if (null == data) return 1;
+    if (ArrayBuffer.isView(data)) return Math.max(data.byteLength, 1);
+    if (Array.isArray(data)) return Math.max(data.reduce((acc, item)=>acc + estimateObjectSize(item), 0), 1);
+    if (data instanceof Map || data instanceof Set) return 1024;
+    if (data instanceof Date) return 8;
+    if ('object' === type) return Math.max(Object.entries(data).reduce((acc, [key, value])=>acc + 2 * key.length + estimateObjectSize(value), 0), 1);
+    return 1;
+}
+class MemoryContainer {
+    async get(key) {
+        return this.lru.get(key);
+    }
+    async set(key, value, options) {
+        if (options?.ttl) this.lru.set(key, value, {
+            ttl: 1000 * options.ttl
+        });
+        else this.lru.set(key, value);
+    }
+    async has(key) {
+        return this.lru.has(key);
+    }
+    async delete(key) {
+        return this.lru.delete(key);
+    }
+    async clear() {
+        this.lru.clear();
+    }
+    constructor(options){
+        this.lru = new LRUCache({
+            maxSize: options?.maxSize ?? CacheSize.GB,
+            sizeCalculation: estimateObjectSize,
+            updateAgeOnGet: true,
+            updateAgeOnHas: true
+        });
+    }
+}
+const isServer = "u" < typeof window;
+const requestCacheMap = new WeakMap();
+const TAG_PREFIX = 'tag:';
+const CACHE_PREFIX = 'modernjs_cache:';
+const ongoingRevalidations = new Map();
+let cache_storage;
+let cacheConfig = {
+    maxSize: CacheSize.GB
+};
+function getStorage() {
+    if (cache_storage) return cache_storage;
+    cache_storage = cacheConfig.container ? cacheConfig.container : new MemoryContainer({
+        maxSize: cacheConfig.maxSize
+    });
+    return cache_storage;
+}
+function configureCache(config) {
+    cacheConfig = {
+        ...cacheConfig,
+        ...config
+    };
+    cache_storage = void 0;
+}
+function generateKey(args) {
+    return JSON.stringify(args, (_, value)=>{
+        if (value && 'object' == typeof value && !Array.isArray(value)) return Object.keys(value).sort().reduce((result, key)=>{
+            result[key] = value[key];
+            return result;
+        }, {});
+        return value;
+    });
+}
+function generateStableFunctionId(fn) {
+    const fnString = fn.toString();
+    let hash = 0;
+    for(let i = 0; i < fnString.length; i++){
+        const char = fnString.charCodeAt(i);
+        hash = (hash << 5) - hash + char;
+        hash &= hash;
+    }
+    return `fn_${fn.name || 'anonymous'}_${Math.abs(hash).toString(36)}`;
+}
+function cache(fn, options) {
+    return async (...args)=>{
+        if (isServer && void 0 === options) {
+            const storage = await getAsyncLocalStorage();
+            const request = storage?.useContext()?.request;
+            if (request) {
+                let shouldDisableCaching = false;
+                if (cacheConfig.unstable_shouldDisable) shouldDisableCaching = await cacheConfig.unstable_shouldDisable({
+                    request
+                });
+                if (shouldDisableCaching) return fn(...args);
+                let requestCache = requestCacheMap.get(request);
+                if (!requestCache) {
+                    requestCache = new Map();
+                    requestCacheMap.set(request, requestCache);
+                }
+                let fnCache = requestCache.get(fn);
+                if (!fnCache) {
+                    fnCache = new Map();
+                    requestCache.set(fn, fnCache);
+                }
+                const key = generateKey(args);
+                if (fnCache.has(key)) return fnCache.get(key);
+                const promise = fn(...args);
+                fnCache.set(key, promise);
+                try {
+                    const data = await promise;
+                    return data;
+                } catch (error) {
+                    fnCache.delete(key);
+                    throw error;
+                }
+            }
+        } else if (void 0 !== options) try {
+            const { tag, maxAge = 5 * CacheTime.MINUTE, revalidate = 0, customKey, onCache, getKey, unstable_shouldCache } = options;
+            let missReason;
+            const currentStorage = getStorage();
+            const now = Date.now();
+            const tags = tag ? Array.isArray(tag) ? tag : [
+                tag
+            ] : [];
+            const genKey = getKey ? getKey(...args) : generateKey(args);
+            let finalKey;
+            if (customKey) finalKey = customKey({
+                params: args,
+                fn,
+                generatedKey: genKey
+            });
+            else {
+                const functionId = generateStableFunctionId(fn);
+                finalKey = `${functionId}:${genKey}`;
+            }
+            const storageKey = `${CACHE_PREFIX}${finalKey}`;
+            let shouldDisableCaching = false;
+            if (isServer && cacheConfig.unstable_shouldDisable) {
+                const asyncStorage = await getAsyncLocalStorage();
+                const request = asyncStorage?.useContext()?.request;
+                if (request) shouldDisableCaching = await cacheConfig.unstable_shouldDisable({
+                    request
+                });
+            }
+            if (shouldDisableCaching) missReason = 1;
+            else {
+                const cached = await currentStorage.get(storageKey);
+                if (cached) try {
+                    const cacheItem = cached;
+                    const age = now - cacheItem.timestamp;
+                    if (age < maxAge) {
+                        onCache?.({
+                            status: 'hit',
+                            key: finalKey,
+                            params: args,
+                            result: cacheItem.data
+                        });
+                        return cacheItem.data;
+                    }
+                    if (revalidate > 0 && age < maxAge + revalidate) {
+                        onCache?.({
+                            status: 'stale',
+                            key: finalKey,
+                            params: args,
+                            result: cacheItem.data
+                        });
+                        if (!ongoingRevalidations.has(storageKey)) {
+                            const revalidationPromise = (async ()=>{
+                                try {
+                                    const newData = await fn(...args);
+                                    let shouldCache = true;
+                                    if (unstable_shouldCache) shouldCache = await unstable_shouldCache({
+                                        params: args,
+                                        result: newData
+                                    });
+                                    if (shouldCache) await setCacheItem(currentStorage, storageKey, newData, tags, maxAge, revalidate);
+                                } catch (error) {
+                                    if (isServer) {
+                                        const asyncStorage = await getAsyncLocalStorage();
+                                        asyncStorage?.useContext()?.monitors?.error(error.message);
+                                    } else console.error('Background revalidation failed:', error);
+                                } finally{
+                                    ongoingRevalidations.delete(storageKey);
+                                }
+                            })();
+                            ongoingRevalidations.set(storageKey, revalidationPromise);
+                        }
+                        return cacheItem.data;
+                    }
+                    missReason = 3;
+                } catch (error) {
+                    console.warn('Failed to parse cached data:', error);
+                    missReason = 4;
+                }
+                else missReason = 2;
+            }
+            const data = await fn(...args);
+            if (!shouldDisableCaching) {
+                let shouldCache = true;
+                if (unstable_shouldCache) shouldCache = await unstable_shouldCache({
+                    params: args,
+                    result: data
+                });
+                if (shouldCache) await setCacheItem(currentStorage, storageKey, data, tags, maxAge, revalidate);
+            }
+            onCache?.({
+                status: 'miss',
+                key: finalKey,
+                params: args,
+                result: data,
+                reason: missReason
+            });
+            return data;
+        } catch (error) {
+            console.warn('Cache operation failed, falling back to direct execution:', error);
+            const data = await fn(...args);
+            const { onCache } = options;
+            try {
+                onCache?.({
+                    status: 'miss',
+                    key: 'cache_failed',
+                    params: args,
+                    result: data,
+                    reason: 5
+                });
+            } catch (callbackError) {
+                console.warn('Failed to call onCache callback:', callbackError);
+            }
+            return data;
+        }
+        else {
+            console.warn('The cache function will not work because it runs on the browser and there are no options are provided.');
+            return fn(...args);
+        }
+    };
+}
+async function setCacheItem(storage, storageKey, data, tags, maxAge, revalidate) {
+    const newItem = {
+        data,
+        timestamp: Date.now(),
+        tags: tags.length > 0 ? tags : void 0
+    };
+    const ttl = (maxAge + revalidate) / 1000;
+    await storage.set(storageKey, newItem, {
+        ttl: ttl > 0 ? ttl : void 0
+    });
+    await updateTagRelationships(storage, storageKey, tags);
+}
+async function updateTagRelationships(storage, storageKey, tags) {
+    for (const tag of tags){
+        const tagStoreKey = `${TAG_PREFIX}${tag}`;
+        const keyList = await storage.get(tagStoreKey);
+        const keyArray = keyList || [];
+        if (!keyArray.includes(storageKey)) keyArray.push(storageKey);
+        await storage.set(tagStoreKey, keyArray);
+    }
+}
+async function removeKeyFromTags(storage, storageKey, tags) {
+    for (const tag of tags){
+        const tagStoreKey = `${TAG_PREFIX}${tag}`;
+        const keyList = await storage.get(tagStoreKey);
+        if (keyList) try {
+            const keyArray = Array.isArray(keyList) ? keyList : [];
+            const updatedKeyList = keyArray.filter((key)=>key !== storageKey);
+            if (updatedKeyList.length > 0) await storage.set(tagStoreKey, updatedKeyList);
+            else await storage.delete(tagStoreKey);
+        } catch (error) {
+            console.warn(`Failed to process tag key list for tag ${tag}:`, error);
+        }
+    }
+}
+function withRequestCache(handler) {
+    if (!isServer) return handler;
+    return async (req, ...args)=>{
+        const storage = await getAsyncLocalStorage();
+        return storage.run({
+            request: req
+        }, ()=>handler(req, ...args));
+    };
+}
+async function revalidateTag(tag) {
+    const currentStorage = getStorage();
+    const tagStoreKey = `${TAG_PREFIX}${tag}`;
+    const keyList = await currentStorage.get(tagStoreKey);
+    if (keyList) try {
+        const keyArray = Array.isArray(keyList) ? keyList : [];
+        for (const cacheKey of keyArray){
+            const cached = await currentStorage.get(cacheKey);
+            if (cached) try {
+                const cacheItem = cached;
+                if (cacheItem.tags) {
+                    const otherTags = cacheItem.tags.filter((t)=>t !== tag);
+                    await removeKeyFromTags(currentStorage, cacheKey, otherTags);
+                }
+            } catch (error) {
+                console.warn('Failed to parse cached data while revalidating:', error);
+            }
+            await currentStorage.delete(cacheKey);
+        }
+        await currentStorage.delete(tagStoreKey);
+    } catch (error) {
+        console.warn('Failed to process tag key list:', error);
+    }
+}
+async function clearStore() {
+    const currentStorage = getStorage();
+    await currentStorage.clear();
+    cache_storage = void 0;
+    ongoingRevalidations.clear();
+}
+export { CacheSize, CacheTime, cache, clearStore, configureCache, generateKey, revalidateTag, withRequestCache };

package/dist/esm-node/universal/request.mjs

@@ -0,0 +1,41 @@
+import "node:module";
+function parseQuery(req) {
+    const query = {};
+    const { url } = req;
+    const q = url.split('?')[1];
+    if (q) {
+        const search = new URLSearchParams(q);
+        search.forEach((v, k)=>{
+            query[k] = v;
+        });
+    }
+    return query;
+}
+function parseHeaders(request) {
+    const headersData = {};
+    request.headers.forEach((value, key)=>{
+        headersData[key] = value;
+    });
+    return headersData;
+}
+function getPathname(request) {
+    const match = request.url.match(/^https?:\/\/[^/]+(\/[^?]*)/);
+    return match ? match[1] : '/';
+}
+function getHost(request) {
+    const { headers } = request;
+    let host = headers.get('X-Forwarded-Host');
+    if (!host) host = headers.get('Host');
+    host = host?.split(/\s*,\s*/, 1)[0] || 'undefined';
+    return host;
+}
+function parseCookie(req) {
+    const _cookie = req.headers.get('Cookie');
+    const cookie = {};
+    _cookie?.trim().split(';').forEach((item)=>{
+        const [k, v] = item.trim().split('=');
+        if (k) cookie[k] = v;
+    });
+    return cookie;
+}
+export { getHost, getPathname, parseCookie, parseHeaders, parseQuery };

package/dist/esm-node/url.mjs

@@ -0,0 +1,6 @@
+import "node:module";
+function normalizePathname(pathname) {
+    const normalized = '/' + pathname.replace(/^\/+|\/+$/g, '');
+    return normalized;
+}
+export { normalizePathname };

package/dist/types/browser/deferreds.d.ts

@@ -0,0 +1,31 @@
+export declare function invariant(value: boolean, message?: string): asserts value;
+export declare function invariant<T>(value: T | null | undefined, message?: string): asserts value is T;
+export declare class AbortedDeferredError extends Error {
+}
+export interface TrackedPromise extends Promise<any> {
+    _tracked?: boolean;
+    _data?: any;
+    _error?: any;
+}
+export declare class DeferredData {
+    private pendingKeysSet;
+    private controller;
+    private abortPromise;
+    private unlistenAbortSignal;
+    private subscribers;
+    __modern_deferred: boolean;
+    data: Record<string, unknown>;
+    init?: ResponseInit;
+    deferredKeys: string[];
+    constructor(data: Record<string, unknown>, responseInit?: ResponseInit);
+    private trackPromise;
+    private onSettle;
+    private emit;
+    subscribe(fn: (aborted: boolean, settledKey?: string) => void): () => boolean;
+    cancel(): void;
+    resolveData(signal: AbortSignal): Promise<boolean>;
+    get done(): boolean;
+    get unwrappedData(): {};
+    get pendingKeys(): string[];
+}
+export declare const activeDeferreds: Map<string, DeferredData>;

package/dist/types/browser/index.d.ts

@@ -0,0 +1,2 @@
+export * from './deferreds';
+export * from './nestedRoutes';

package/dist/types/browser/nestedRoutes.d.ts

@@ -0,0 +1,12 @@
+import type { NestedRoute } from '@modern-js/types';
+import { type JSX } from 'react';
+export declare const transformNestedRoutes: (routes: NestedRoute[]) => import("react-router").RouteObject[];
+type DeferredDataComponentType = (props?: {
+    nonce?: string;
+}) => JSX.Element | null;
+export declare const renderNestedRoute: (nestedRoute: NestedRoute, options?: {
+    parent?: NestedRoute;
+    DeferredDataComponent?: DeferredDataComponentType;
+    props?: Record<string, any>;
+}) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/types/merge.d.ts

@@ -0,0 +1,6 @@
+type PlainObject = {
+    [key: string]: any;
+};
+type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
+export declare function merge<T extends PlainObject, U extends PlainObject[]>(target: T, ...sources: U): T & UnionToIntersection<U[number]>;
+export {};

package/dist/types/node/fileReader.d.ts

@@ -0,0 +1,19 @@
+import Fs from '@modern-js/utils/fs-extra';
+import type { Buffer } from 'buffer';
+import type { Storage } from './storer/storage';
+export declare class FileReader {
+    private storage;
+    private fs;
+    constructor(storage: Storage<Buffer | null>);
+    readFile(path: string, encoding?: 'utf-8'): Promise<string | null>;
+    readFile(path: string, encoding?: 'buffer'): Promise<Buffer | null>;
+    readFileFromSystem(path: string, encoding?: 'utf-8'): Promise<string | null>;
+    readFileFromSystem(path: string, encoding?: 'buffer'): Promise<Buffer | null>;
+    _readFileFactory(fs: typeof Fs): (path: string, encoding?: "utf-8" | "buffer") => Promise<string | Buffer | null>;
+    /**
+     * Clear the fileCache entriely.
+     */
+    reset(fs?: typeof Fs): Promise<void>;
+    private encodingContent;
+}
+export declare const fileReader: FileReader;

package/dist/types/node/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * ssr helpers
+ */
+export { storage } from '../universal/async_storage.server';
+export * from './loaderContext';
+export * from './nestedRoutes';
+export { sanitizeSSRPayload } from './sanitize';
+export { serializeJson } from './serialize';

package/dist/types/node/loaderContext/createLoaderCtx.d.ts

@@ -0,0 +1,7 @@
+export declare class LoaderContext<T = unknown> {
+    symbol: symbol;
+    private defaultValue?;
+    constructor(defaultValue?: T);
+    getDefaultValue(): T;
+}
+export declare function createLoaderContext<T = unknown>(defaultValue?: T): LoaderContext<T>;

package/dist/types/node/loaderContext/createRequestCtx.d.ts

@@ -0,0 +1,16 @@
+import type { RequestPayload } from '@modern-js/types';
+import type { LoaderContext } from './createLoaderCtx';
+interface Get<P extends Record<string, unknown>> {
+    <Key extends keyof P>(key: Key): P[Key];
+    <T>(key: LoaderContext<T>): T;
+}
+interface Set<P extends Record<string, unknown>> {
+    <Key extends keyof P>(key: Key, value: P[Key]): void;
+    <T>(key: LoaderContext<T>, value: T): void;
+}
+export type RequestContext<P extends Record<string, unknown> = {}> = {
+    get: Get<P & RequestPayload>;
+    set: Set<P & RequestPayload>;
+};
+export declare function createRequestContext<P extends Record<string, unknown>>(context?: Map<string | symbol, unknown>): RequestContext<P>;
+export {};

package/dist/types/node/loaderContext/index.d.ts

@@ -0,0 +1,4 @@
+import type { Reporter } from '@modern-js/types';
+export type { LoaderContext } from './createLoaderCtx';
+export { createRequestContext, type RequestContext, } from './createRequestCtx';
+export declare const reporterCtx: import("./createLoaderCtx").LoaderContext<Reporter>;

package/dist/types/node/nestedRoutes.d.ts

@@ -0,0 +1 @@
+export * from '../server/nestedRoutes';

package/dist/types/node/sanitize.d.ts

@@ -0,0 +1,11 @@
+export declare const DEFAULT_UNSAFE_SSR_HEADERS: readonly ["authorization", "proxy-authorization", "cookie", "set-cookie", "x-api-key", "x-auth-token", "x-csrf-token", "x-xsrf-token", "x-forwarded-client-cert", "cf-access-jwt-assertion"];
+type SanitizeSSRPayloadOptions = {
+    unsafeHeaders?: string[];
+    treatRootAsHeaders?: boolean;
+};
+type SanitizeSSRPayloadResult<T> = {
+    payload: T;
+    removed: string[];
+};
+export declare const sanitizeSSRPayload: <T>(payload: T, options?: SanitizeSSRPayloadOptions) => SanitizeSSRPayloadResult<T>;
+export {};

package/dist/types/node/serialize.d.ts

@@ -0,0 +1 @@
+export declare const serializeJson: (data: any) => string;

package/dist/types/node/storer/container.d.ts

@@ -0,0 +1,27 @@
+import type { Container } from '@modern-js/types';
+interface MemoryContainerOptions {
+    /** The maximum size of the cache, unit(MB). The default of value is 256. */
+    max?: number;
+    maxAge?: number;
+}
+/**
+ * MemoryContainer, it use lur-cache as cahe layer.
+ * It has a Time to Live, by default as 1 hour.
+ */
+export declare class MemoryContainer<K extends string, V extends {}> implements Container<K, V> {
+    private static BYTE;
+    private static KB;
+    private static MB;
+    private static ms;
+    private static second;
+    private static minute;
+    private static hour;
+    private cache;
+    constructor({ max, maxAge }?: MemoryContainerOptions);
+    get(key: K): Promise<V | undefined>;
+    set(key: K, value: V): Promise<this>;
+    has(key: K): Promise<boolean>;
+    delete(key: K): Promise<boolean>;
+    forEach(callbackFn: (v: V, k: K, container: this) => void): void;
+}
+export {};

package/dist/types/node/storer/index.d.ts

@@ -0,0 +1,3 @@
+import { Storage } from './storage';
+export { Storage } from './storage';
+export declare function createMemoryStorage<V extends {} | null>(namespace: string): Storage<V>;

package/dist/types/node/storer/storage.d.ts

@@ -0,0 +1,26 @@
+import type { Container } from '@modern-js/types';
+export declare class Storage<V = unknown> {
+    private namespace;
+    private container;
+    constructor(namespace: string, container: Container<string, V>);
+    keys?(): Promise<string[]>;
+    values?(): Promise<V[]>;
+    /**
+     * Returns a specified element from the container. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Container.
+     * @returns Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.
+     */
+    get(key: string): Promise<V | undefined>;
+    /**
+     * Adds a new element with a specified key and value to the storage. If an element with the same key already exists, the element will be updated.
+     */
+    set(key: string, value: V): Promise<this>;
+    /**
+     * @returns boolean indicating whether an element with the specified key exists or not.
+     */
+    has(key: string): Promise<boolean>;
+    delete(key: string): Promise<boolean>;
+    clear?(): Promise<void>;
+    forEach?(fallbackFn: (v: V, k: string, storage: this) => void): void;
+    private computedUniqueKey;
+    private checkIsOwnkey;
+}

package/dist/types/parsed.d.ts

@@ -0,0 +1 @@
+export declare const parsedJSONFromElement: (id: string) => any;

package/dist/types/router.d.ts

@@ -0,0 +1,6 @@
+export * from 'react-router';
+export declare const DEFERRED_SYMBOL: unique symbol;
+/** @deprecated Please use Response.json instead. */
+export declare const json: (data: any, init?: number | ResponseInit) => Response;
+/** @deprecated defer is deprecated, You don't need to use it. */
+export declare const defer: (data: any, init?: number | ResponseInit) => any;

package/dist/types/rsc.d.ts

@@ -0,0 +1 @@
+export * from 'react-router';

package/dist/types/server/index.d.ts

@@ -0,0 +1 @@
+export * from './nestedRoutes';

package/dist/types/server/nestedRoutes.d.ts

@@ -0,0 +1,2 @@
+import type { ServerRoute } from '@modern-js/types';
+export declare const matchEntry: (pathname: string, entries: ServerRoute[]) => ServerRoute | undefined;

package/dist/types/time.d.ts

@@ -0,0 +1 @@
+export declare const time: () => () => number;

package/dist/types/universal/async_storage.d.ts

@@ -0,0 +1,2 @@
+import type { Storage } from './async_storage.server';
+export declare const getAsyncLocalStorage: () => Promise<Storage | null>;

package/dist/types/universal/async_storage.server.d.ts

@@ -0,0 +1,29 @@
+import type { Monitors } from '@modern-js/types';
+import type { IncomingHttpHeaders } from 'http';
+declare const storage: {
+    run: <O>(context: {
+        monitors?: Monitors;
+        headers?: IncomingHttpHeaders;
+        request?: Request;
+        responseProxy?: {
+            headers: Record<string, string>;
+            status: number;
+        };
+        activeDeferreds?: Map<string, unknown>;
+        serverPayload?: unknown;
+    }, cb: () => O | Promise<O>) => Promise<O>;
+    useContext: () => {
+        monitors?: Monitors;
+        headers?: IncomingHttpHeaders;
+        request?: Request;
+        responseProxy?: {
+            headers: Record<string, string>;
+            status: number;
+        };
+        activeDeferreds?: Map<string, unknown>;
+        serverPayload?: unknown;
+    };
+};
+type Storage = typeof storage;
+export { type Storage, storage };
+export declare const getAsyncLocalStorage: () => Promise<Storage>;