@epic-web/workshop-utils 4.0.0

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

@@ -0,0 +1,798 @@
+import * as C from '@epic-web/cachified';
+import { type Cache as CachifiedCache } from '@epic-web/cachified';
+import { type Timings } from './timing.server.js';
+export declare const solutionAppCache: {
+    name: string;
+    set: (key: string, value: C.CacheEntry<{
+        type: "solution";
+        name: string;
+        title: string;
+        dirName: string;
+        fullPath: string;
+        relativePath: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        exerciseNumber: number;
+        stepNumber: number;
+        problemName: string | null;
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    }>) => C.CacheEntry<{
+        type: "solution";
+        name: string;
+        title: string;
+        dirName: string;
+        fullPath: string;
+        relativePath: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        exerciseNumber: number;
+        stepNumber: number;
+        problemName: string | null;
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    }>;
+    get: (key: string) => C.CacheEntry<{
+        type: "solution";
+        name: string;
+        title: string;
+        dirName: string;
+        fullPath: string;
+        relativePath: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        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<{
+        type: "problem";
+        name: string;
+        title: string;
+        dirName: string;
+        fullPath: string;
+        relativePath: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        exerciseNumber: number;
+        stepNumber: number;
+        solutionName: string | null;
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    }>) => C.CacheEntry<{
+        type: "problem";
+        name: string;
+        title: string;
+        dirName: string;
+        fullPath: string;
+        relativePath: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        exerciseNumber: number;
+        stepNumber: number;
+        solutionName: string | null;
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    }>;
+    get: (key: string) => C.CacheEntry<{
+        type: "problem";
+        name: string;
+        title: string;
+        dirName: string;
+        fullPath: string;
+        relativePath: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        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<{
+        type: "example";
+        name: string;
+        title: string;
+        dirName: string;
+        fullPath: string;
+        relativePath: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    }>) => C.CacheEntry<{
+        type: "example";
+        name: string;
+        title: string;
+        dirName: string;
+        fullPath: string;
+        relativePath: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    }>;
+    get: (key: string) => C.CacheEntry<{
+        type: "example";
+        name: string;
+        title: string;
+        dirName: string;
+        fullPath: string;
+        relativePath: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    }> | undefined;
+    delete: (key: string) => boolean;
+};
+export declare const playgroundAppCache: {
+    name: string;
+    set: (key: string, value: C.CacheEntry<{
+        type: "playground";
+        name: string;
+        title: string;
+        dirName: string;
+        fullPath: string;
+        relativePath: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        appName: string;
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    }>) => C.CacheEntry<{
+        type: "playground";
+        name: string;
+        title: string;
+        dirName: string;
+        fullPath: string;
+        relativePath: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        appName: string;
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    }>;
+    get: (key: string) => C.CacheEntry<{
+        type: "playground";
+        name: string;
+        title: string;
+        dirName: string;
+        fullPath: string;
+        relativePath: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        appName: string;
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    }> | undefined;
+    delete: (key: string) => boolean;
+};
+export declare const appsCache: {
+    name: string;
+    set: (key: string, value: C.CacheEntry<{
+        type: "solution";
+        name: string;
+        title: string;
+        dirName: string;
+        fullPath: string;
+        relativePath: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        exerciseNumber: number;
+        stepNumber: number;
+        problemName: string | null;
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    } | {
+        type: "problem";
+        name: string;
+        title: string;
+        dirName: string;
+        fullPath: string;
+        relativePath: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        exerciseNumber: number;
+        stepNumber: number;
+        solutionName: string | null;
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    } | {
+        type: "example";
+        name: string;
+        title: string;
+        dirName: string;
+        fullPath: string;
+        relativePath: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    } | {
+        type: "playground";
+        name: string;
+        title: string;
+        dirName: string;
+        fullPath: string;
+        relativePath: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        appName: string;
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    }>) => C.CacheEntry<{
+        type: "solution";
+        name: string;
+        title: string;
+        dirName: string;
+        fullPath: string;
+        relativePath: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        exerciseNumber: number;
+        stepNumber: number;
+        problemName: string | null;
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    } | {
+        type: "problem";
+        name: string;
+        title: string;
+        dirName: string;
+        fullPath: string;
+        relativePath: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        exerciseNumber: number;
+        stepNumber: number;
+        solutionName: string | null;
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    } | {
+        type: "example";
+        name: string;
+        title: string;
+        dirName: string;
+        fullPath: string;
+        relativePath: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    } | {
+        type: "playground";
+        name: string;
+        title: string;
+        dirName: string;
+        fullPath: string;
+        relativePath: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        appName: string;
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    }>;
+    get: (key: string) => C.CacheEntry<{
+        type: "solution";
+        name: string;
+        title: string;
+        dirName: string;
+        fullPath: string;
+        relativePath: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        exerciseNumber: number;
+        stepNumber: number;
+        problemName: string | null;
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    } | {
+        type: "problem";
+        name: string;
+        title: string;
+        dirName: string;
+        fullPath: string;
+        relativePath: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        exerciseNumber: number;
+        stepNumber: number;
+        solutionName: string | null;
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    } | {
+        type: "example";
+        name: string;
+        title: string;
+        dirName: string;
+        fullPath: string;
+        relativePath: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        instructionsCode?: string | undefined;
+        epicVideoEmbeds?: string[] | undefined;
+    } | {
+        type: "playground";
+        name: string;
+        title: string;
+        dirName: string;
+        fullPath: string;
+        relativePath: string;
+        test: {
+            type: "browser";
+            pathname: string;
+            testFiles: string[];
+        } | {
+            type: "script";
+            script: string;
+        } | {
+            type: "none";
+        };
+        dev: {
+            type: "browser";
+            pathname: string;
+        } | {
+            type: "script";
+            portNumber: number;
+        } | {
+            type: "none";
+        };
+        appName: string;
+        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 type CachedEmbeddedFilesList = Record<string, string[]>;
+export declare const embeddedFilesCache: {
+    name: string;
+    set: (key: string, value: C.CacheEntry<CachedEmbeddedFilesList | undefined>) => C.CacheEntry<CachedEmbeddedFilesList | undefined>;
+    get: (key: string) => C.CacheEntry<CachedEmbeddedFilesList | undefined> | 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 fsCache: CachifiedCache;
+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 cachified<Value>({ request, timings, key, timingKey, ...options }: Omit<C.CachifiedOptions<Value>, 'forceFresh'> & {
+    request?: Request;
+    timings?: Timings;
+    forceFresh?: boolean | string;
+    timingKey?: string;
+}): Promise<Value>;
+export declare function shouldForceFresh({ forceFresh, request, key, }: {
+    forceFresh?: boolean | string;
+    request?: Request;
+    key?: string;
+}): Promise<boolean>;
+//# sourceMappingURL=cache.server.d.ts.map