@epic-web/workshop-utils 0.0.0-semantically-released

package/dist/esm/cache.server.d.ts

@@ -0,0 +1,940 @@
+import * as C from '@epic-web/cachified';
+import { type Timings } from './timing.server.js';
+export declare const solutionAppCache: {
+    name: string;
+    set: (key: string, value: C.CacheEntry<{
+        title: string;
+        type: "solution";
+        name: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        fullPath: string;
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            initialRoute: string;
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        dirName: string;
+        relativePath: string;
+        stackBlitzUrl: string | null;
+        exerciseNumber: number;
+        stepNumber: number;
+        problemName: string | null;
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    }>) => C.CacheEntry<{
+        title: string;
+        type: "solution";
+        name: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        fullPath: string;
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            initialRoute: string;
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        dirName: string;
+        relativePath: string;
+        stackBlitzUrl: string | null;
+        exerciseNumber: number;
+        stepNumber: number;
+        problemName: string | null;
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    }>;
+    get: (key: string) => C.CacheEntry<{
+        title: string;
+        type: "solution";
+        name: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        fullPath: string;
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            initialRoute: string;
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        dirName: string;
+        relativePath: string;
+        stackBlitzUrl: string | null;
+        exerciseNumber: number;
+        stepNumber: number;
+        problemName: string | null;
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    }> | undefined;
+    delete: (key: string) => boolean;
+};
+export declare const problemAppCache: {
+    name: string;
+    set: (key: string, value: C.CacheEntry<{
+        title: string;
+        type: "problem";
+        name: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        fullPath: string;
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            initialRoute: string;
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        dirName: string;
+        relativePath: string;
+        stackBlitzUrl: string | null;
+        exerciseNumber: number;
+        stepNumber: number;
+        solutionName: string | null;
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    }>) => C.CacheEntry<{
+        title: string;
+        type: "problem";
+        name: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        fullPath: string;
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            initialRoute: string;
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        dirName: string;
+        relativePath: string;
+        stackBlitzUrl: string | null;
+        exerciseNumber: number;
+        stepNumber: number;
+        solutionName: string | null;
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    }>;
+    get: (key: string) => C.CacheEntry<{
+        title: string;
+        type: "problem";
+        name: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        fullPath: string;
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            initialRoute: string;
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        dirName: string;
+        relativePath: string;
+        stackBlitzUrl: string | null;
+        exerciseNumber: number;
+        stepNumber: number;
+        solutionName: string | null;
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    }> | undefined;
+    delete: (key: string) => boolean;
+};
+export declare const exampleAppCache: {
+    name: string;
+    set: (key: string, value: C.CacheEntry<{
+        title: string;
+        type: "example";
+        name: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        fullPath: string;
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            initialRoute: string;
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        dirName: string;
+        relativePath: string;
+        stackBlitzUrl: string | null;
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    }>) => C.CacheEntry<{
+        title: string;
+        type: "example";
+        name: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        fullPath: string;
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            initialRoute: string;
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        dirName: string;
+        relativePath: string;
+        stackBlitzUrl: string | null;
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    }>;
+    get: (key: string) => C.CacheEntry<{
+        title: string;
+        type: "example";
+        name: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        fullPath: string;
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            initialRoute: string;
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        dirName: string;
+        relativePath: string;
+        stackBlitzUrl: string | null;
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    }> | undefined;
+    delete: (key: string) => boolean;
+};
+export declare const playgroundAppCache: {
+    name: string;
+    set: (key: string, value: C.CacheEntry<{
+        title: string;
+        type: "playground";
+        name: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        fullPath: string;
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            initialRoute: string;
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        dirName: string;
+        relativePath: string;
+        stackBlitzUrl: string | null;
+        appName: string;
+        isUpToDate: boolean;
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    }>) => C.CacheEntry<{
+        title: string;
+        type: "playground";
+        name: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        fullPath: string;
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            initialRoute: string;
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        dirName: string;
+        relativePath: string;
+        stackBlitzUrl: string | null;
+        appName: string;
+        isUpToDate: boolean;
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    }>;
+    get: (key: string) => C.CacheEntry<{
+        title: string;
+        type: "playground";
+        name: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        fullPath: string;
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            initialRoute: string;
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        dirName: string;
+        relativePath: string;
+        stackBlitzUrl: string | null;
+        appName: string;
+        isUpToDate: boolean;
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    }> | undefined;
+    delete: (key: string) => boolean;
+};
+export declare const appsCache: {
+    name: string;
+    set: (key: string, value: C.CacheEntry<{
+        title: string;
+        type: "solution";
+        name: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        fullPath: string;
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            initialRoute: string;
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        dirName: string;
+        relativePath: string;
+        stackBlitzUrl: string | null;
+        exerciseNumber: number;
+        stepNumber: number;
+        problemName: string | null;
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    } | {
+        title: string;
+        type: "problem";
+        name: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        fullPath: string;
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            initialRoute: string;
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        dirName: string;
+        relativePath: string;
+        stackBlitzUrl: string | null;
+        exerciseNumber: number;
+        stepNumber: number;
+        solutionName: string | null;
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    } | {
+        title: string;
+        type: "example";
+        name: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        fullPath: string;
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            initialRoute: string;
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        dirName: string;
+        relativePath: string;
+        stackBlitzUrl: string | null;
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    } | {
+        title: string;
+        type: "playground";
+        name: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        fullPath: string;
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            initialRoute: string;
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        dirName: string;
+        relativePath: string;
+        stackBlitzUrl: string | null;
+        appName: string;
+        isUpToDate: boolean;
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    }>) => C.CacheEntry<{
+        title: string;
+        type: "solution";
+        name: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        fullPath: string;
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            initialRoute: string;
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        dirName: string;
+        relativePath: string;
+        stackBlitzUrl: string | null;
+        exerciseNumber: number;
+        stepNumber: number;
+        problemName: string | null;
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    } | {
+        title: string;
+        type: "problem";
+        name: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        fullPath: string;
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            initialRoute: string;
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        dirName: string;
+        relativePath: string;
+        stackBlitzUrl: string | null;
+        exerciseNumber: number;
+        stepNumber: number;
+        solutionName: string | null;
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    } | {
+        title: string;
+        type: "example";
+        name: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        fullPath: string;
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            initialRoute: string;
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        dirName: string;
+        relativePath: string;
+        stackBlitzUrl: string | null;
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    } | {
+        title: string;
+        type: "playground";
+        name: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        fullPath: string;
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            initialRoute: string;
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        dirName: string;
+        relativePath: string;
+        stackBlitzUrl: string | null;
+        appName: string;
+        isUpToDate: boolean;
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    }>;
+    get: (key: string) => C.CacheEntry<{
+        title: string;
+        type: "solution";
+        name: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        fullPath: string;
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            initialRoute: string;
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        dirName: string;
+        relativePath: string;
+        stackBlitzUrl: string | null;
+        exerciseNumber: number;
+        stepNumber: number;
+        problemName: string | null;
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    } | {
+        title: string;
+        type: "problem";
+        name: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        fullPath: string;
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            initialRoute: string;
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        dirName: string;
+        relativePath: string;
+        stackBlitzUrl: string | null;
+        exerciseNumber: number;
+        stepNumber: number;
+        solutionName: string | null;
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    } | {
+        title: string;
+        type: "example";
+        name: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        fullPath: string;
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            initialRoute: string;
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        dirName: string;
+        relativePath: string;
+        stackBlitzUrl: string | null;
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    } | {
+        title: string;
+        type: "playground";
+        name: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        fullPath: string;
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            initialRoute: string;
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        dirName: string;
+        relativePath: string;
+        stackBlitzUrl: string | null;
+        appName: string;
+        isUpToDate: boolean;
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    }> | undefined;
+    delete: (key: string) => boolean;
+};
+export declare const diffCodeCache: {
+    name: string;
+    set: (key: string, value: C.CacheEntry<string>) => C.CacheEntry<string>;
+    get: (key: string) => C.CacheEntry<string> | undefined;
+    delete: (key: string) => boolean;
+};
+export declare const diffFilesCache: {
+    name: string;
+    set: (key: string, value: C.CacheEntry<string>) => C.CacheEntry<string>;
+    get: (key: string) => C.CacheEntry<string> | undefined;
+    delete: (key: string) => boolean;
+};
+export declare const compiledMarkdownCache: {
+    name: string;
+    set: (key: string, value: C.CacheEntry<string>) => C.CacheEntry<string>;
+    get: (key: string) => C.CacheEntry<string> | undefined;
+    delete: (key: string) => boolean;
+};
+export declare const compiledCodeCache: {
+    name: string;
+    set: (key: string, value: C.CacheEntry<string>) => C.CacheEntry<string>;
+    get: (key: string) => C.CacheEntry<string> | undefined;
+    delete: (key: string) => boolean;
+};
+export declare const ogCache: {
+    name: string;
+    set: (key: string, value: C.CacheEntry<string>) => C.CacheEntry<string>;
+    get: (key: string) => C.CacheEntry<string> | undefined;
+    delete: (key: string) => boolean;
+};
+export declare const compiledInstructionMarkdownCache: C.Cache<{
+    code: string;
+    title: string | null;
+    epicVideoEmbeds: Array<string>;
+}>;
+export declare const dirModifiedTimeCache: {
+    name: string;
+    set: (key: string, value: C.CacheEntry<number>) => C.CacheEntry<number>;
+    get: (key: string) => C.CacheEntry<number> | undefined;
+    delete: (key: string) => boolean;
+};
+export declare const connectionCache: {
+    name: string;
+    set: (key: string, value: C.CacheEntry<boolean>) => C.CacheEntry<boolean>;
+    get: (key: string) => C.CacheEntry<boolean> | undefined;
+    delete: (key: string) => boolean;
+};
+export declare const checkForUpdatesCache: {
+    name: string;
+    set: (key: string, value: C.CacheEntry<{
+        updatesAvailable: boolean;
+        localCommit: string;
+        remoteCommit: string;
+        diffLink: string | null;
+    }>) => C.CacheEntry<{
+        updatesAvailable: boolean;
+        localCommit: string;
+        remoteCommit: string;
+        diffLink: string | null;
+    }>;
+    get: (key: string) => C.CacheEntry<{
+        updatesAvailable: boolean;
+        localCommit: string;
+        remoteCommit: string;
+        diffLink: string | null;
+    }> | undefined;
+    delete: (key: string) => boolean;
+};
+export declare const notificationsCache: {
+    name: string;
+    set: (key: string, value: C.CacheEntry<{
+        title: string;
+        message: string;
+        type: "info" | "warning" | "danger";
+        id: string;
+        expiresAt: Date | null;
+        link?: string | undefined;
+        products?: {
+            host: string;
+            slug?: string | undefined;
+        }[] | undefined;
+    }[]>) => C.CacheEntry<{
+        title: string;
+        message: string;
+        type: "info" | "warning" | "danger";
+        id: string;
+        expiresAt: Date | null;
+        link?: string | undefined;
+        products?: {
+            host: string;
+            slug?: string | undefined;
+        }[] | undefined;
+    }[]>;
+    get: (key: string) => C.CacheEntry<{
+        title: string;
+        message: string;
+        type: "info" | "warning" | "danger";
+        id: string;
+        expiresAt: Date | null;
+        link?: string | undefined;
+        products?: {
+            host: string;
+            slug?: string | undefined;
+        }[] | undefined;
+    }[]> | undefined;
+    delete: (key: string) => boolean;
+};
+export declare const fsCache: C.Cache<unknown>;
+export declare function getAllFileCacheEntries(): Promise<Record<string, any>>;
+export declare function deleteCache(): Promise<null | undefined>;
+export declare function makeSingletonCache<CacheEntryType>(name: string): {
+    name: string;
+    set: (key: string, value: C.CacheEntry<CacheEntryType>) => C.CacheEntry<CacheEntryType>;
+    get: (key: string) => C.CacheEntry<CacheEntryType> | undefined;
+    delete: (key: string) => boolean;
+};
+export declare function makeSingletonFsCache<CacheEntryType>(name: string): C.Cache<CacheEntryType>;
+/**
+ * This wraps @epic-web/cachified to add a few handy features:
+ *
+ * 1. Automatic timing for timing headers
+ * 2. Automatic force refresh based on the request and enhancement of forceFresh
+ * to support comma-separated keys to force
+ * 3. Offline fallback support. If a fallback is given and we are detected to be
+ * offline, then the cached value is used regardless of whether it's expired and
+ * if one is not present then the given fallback will be used.
+ */
+export declare function cachified<Value>({ request, timings, key, timingKey, offlineFallbackValue, ...options }: Omit<C.CachifiedOptions<Value>, 'forceFresh'> & {
+    request?: Request;
+    timings?: Timings;
+    forceFresh?: boolean | string;
+    timingKey?: string;
+    offlineFallbackValue?: Value;
+}): Promise<Value>;
+export declare function shouldForceFresh({ forceFresh, request, key, }: {
+    forceFresh?: boolean | string;
+    request?: Request;
+    key?: string;
+}): Promise<boolean>;
+//# sourceMappingURL=cache.server.d.ts.map