Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 | 6x 6x 7x 7x 7x 6x 6x 6x 185x 1x 7x 7x 7x 1x 1x 14x 14x 14x 12x 2x 2x 2x 2x 2x 1x 11x 11x 11x 1x 10x 3x 3x 2x 2x 2x 14x 14x 14x 14x 14x 14x 14x 14x 14x 12x 10x 10x 10x 10x 8x 8x 10x 4x 4x 14x 14x 5x 5x 9x 9x 14x 14x 14x 14x 14x 14x 22x 22x 29x 29x 457x 44x 13x 13x 13x 13x 13x 13x 1x 1x 1x 2x 10x 10x 10x 10x 15x 15x 1x 3x 3x 3x 2x 1x 4x 2x 4x 3x 1x 1x 1x | import { useSyncExternalStore } from "react";
export const EXTERNAL_EXAMPLES_STORAGE_KEY = "unoExternalExamplesSelection";
export const EXTERNAL_EXAMPLES_CHANGE_EVENT = "externalExamplesSelectionChange";
export interface ExternalExamplesSelection {
schemaVersion: 1;
repository: string;
ref: string;
}
export interface ExternalExamplesSource {
selection: "default" | "browser-override";
mode: "builtin" | "repository-ref";
repository: string | null;
ref: string | null;
revision: string | null;
status: "builtin" | "remote" | "cache";
stale: boolean;
tutor?: { status: "absent" | "valid" | "invalid"; reason?: string };
}
export interface ExternalExampleCatalogItem {
id: string;
title: string;
category: string;
description?: string;
main: string;
source: "builtin" | "external";
files: Array<{ name: string; path: string }>;
}
export interface ExternalExamplesCatalog {
schemaVersion: 1;
source: ExternalExamplesSource;
examples: ExternalExampleCatalogItem[];
}
export interface ActiveCourseContentContext {
repository: string;
ref: string;
revision: string;
exampleId: string;
}
export interface ExternalExamplesValidationResponse {
schemaVersion: 1;
valid: true;
source: ExternalExamplesSource & {
mode: "repository-ref";
repository: string;
ref: string;
revision: string;
};
}
export type ExternalExamplesErrorCode =
| "INVALID_SELECTION"
| "INVALID_REF"
| "INVALID_REVISION"
| "INVALID_SNAPSHOT"
| "SOURCE_UNAVAILABLE"
| "RATE_LIMITED"
| "LOAD_CAPACITY_EXCEEDED";
export class ExternalExamplesError extends Error {
constructor(
readonly code: ExternalExamplesErrorCode | "NETWORK" | "UNKNOWN",
message: string,
) {
super(message);
this.name = "ExternalExamplesError";
}
}
interface ExternalExamplesState {
override: ExternalExamplesSelection | null;
catalog: ExternalExamplesCatalog | null;
activeCourseContent: ActiveCourseContentContext | null;
}
const listeners = new Set<() => void>();
let state: ExternalExamplesState = {
override: readStoredSelection(),
catalog: null,
activeCourseContent: null,
};
let requestGeneration = 0;
let activeController: AbortController | undefined;
export function useExternalExamples() {
return useSyncExternalStore(subscribe, getState, getState);
}
export function getExternalExamplesState(): ExternalExamplesState {
return state;
}
export function readStoredSelection(): ExternalExamplesSelection | null {
try {
const raw = globalThis.localStorage.getItem(EXTERNAL_EXAMPLES_STORAGE_KEY);
if (!raw) return null;
const parsed: unknown = JSON.parse(raw);
return isSelection(parsed) ? parsed : null;
} catch {
return null;
}
}
export function normalizeRepositoryInput(value: string): string | null {
const trimmed = value.trim();
Iif (!trimmed) return null;
if (!trimmed.includes("://"))
return canonicalRepository(trimmed.replace(/\.git\/?$/i, ""));
try {
const url = new URL(trimmed);
Iif (
url.protocol !== "https:" ||
url.hostname.toLowerCase() !== "github.com" ||
url.username ||
url.password ||
url.search ||
url.hash
)
return null;
const segments = url.pathname.split("/").filter(Boolean);
if (segments.length !== 2) return null;
return canonicalRepository(
`${segments[0]}/${segments[1].replace(/\.git$/i, "")}`,
);
} catch {
return null;
}
}
export function normalizeSelection(
repository: string,
ref: string,
): ExternalExamplesSelection {
const normalizedRepository = normalizeRepositoryInput(repository);
Iif (!normalizedRepository)
throw new ExternalExamplesError(
"INVALID_SELECTION",
"Enter a valid public GitHub repository.",
);
if (!/^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$/.test(ref)) {
throw new ExternalExamplesError(
"INVALID_REF",
"Enter a valid ref (1–128 safe characters, without '/').",
);
}
return { schemaVersion: 1, repository: normalizedRepository, ref };
}
export async function validateExternalExamplesSelection(
selection: ExternalExamplesSelection,
signal?: AbortSignal,
): Promise<ExternalExamplesValidationResponse["source"]> {
const response = await fetch("/api/examples/validate", {
method: "POST",
headers: { "content-type": "application/json" },
body: JSON.stringify({
schemaVersion: 1,
selection: { repository: selection.repository, ref: selection.ref },
}),
signal,
});
if (!response.ok) throw await parseApiError(response);
const payload = await parseJson(response);
Iif (payload?.valid !== true || !isExternalSource(payload?.source)) {
throw new ExternalExamplesError(
"UNKNOWN",
"The server returned an invalid validation response.",
);
}
return payload.source;
}
export async function refreshExternalExamplesCatalog(
signal?: AbortSignal,
): Promise<ExternalExamplesCatalog> {
const generation = ++requestGeneration;
activeController?.abort();
const controller = new AbortController();
activeController = controller;
Iif (signal) {
if (signal.aborted) controller.abort(signal.reason);
else
signal.addEventListener("abort", () => controller.abort(signal.reason), {
once: true,
});
}
const selection = state.override;
const query = selection
? `?repository=${encodeURIComponent(selection.repository)}&ref=${encodeURIComponent(selection.ref)}`
: "";
try {
const response = await fetch(`/api/examples${query}`, {
signal: controller.signal,
});
if (!response.ok) throw await parseApiError(response);
const payload = await parseJson(response);
Iif (!isCatalog(payload))
throw new ExternalExamplesError(
"UNKNOWN",
"The server returned an invalid examples catalog.",
);
if (generation === requestGeneration) {
state = { ...state, catalog: payload };
emit();
}
return payload;
} catch (error) {
Iif (isAbortError(error)) throw error;
throw toExternalExamplesError(error);
} finally {
if (activeController === controller) activeController = undefined;
}
}
export function setExternalExamplesOverride(
selection: ExternalExamplesSelection | null,
): void {
if (selection) {
try {
globalThis.localStorage.setItem(
EXTERNAL_EXAMPLES_STORAGE_KEY,
JSON.stringify(selection),
);
} catch {}
} else {
try {
globalThis.localStorage.removeItem(EXTERNAL_EXAMPLES_STORAGE_KEY);
} catch {}
}
state = { ...state, override: selection, catalog: null, activeCourseContent: null };
requestGeneration++;
activeController?.abort();
emit();
try {
globalThis.dispatchEvent(new CustomEvent(EXTERNAL_EXAMPLES_CHANGE_EVENT));
} catch {}
}
export function setActiveExternalExampleContext(context: ActiveCourseContentContext | null): void {
state = { ...state, activeCourseContent: context };
emit();
}
function subscribe(listener: () => void): () => void {
listeners.add(listener);
return () => listeners.delete(listener);
}
function getState(): ExternalExamplesState {
return state;
}
function emit(): void {
listeners.forEach((listener) => listener());
}
function canonicalRepository(value: string): string | null {
const candidate = value.toLowerCase();
const [owner, repository] = candidate.split("/");
Iif (
!owner ||
!repository ||
owner.length > 39 ||
repository.length > 100 ||
candidate.length > 140
)
return null;
Iif (!/^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$/.test(owner) || owner.includes("--"))
return null;
Iif (
!/^[a-z0-9](?:[a-z0-9._-]*[a-z0-9])?$/.test(repository) ||
repository === "." ||
repository === ".."
)
return null;
return `${owner}/${repository}`;
}
function isSelection(value: unknown): value is ExternalExamplesSelection {
Iif (!value || typeof value !== "object" || Array.isArray(value)) return false;
const candidate = value as Record<string, unknown>;
return (
Object.keys(candidate).length === 3 &&
candidate.schemaVersion === 1 &&
typeof candidate.repository === "string" &&
typeof candidate.ref === "string" &&
normalizeRepositoryInput(candidate.repository) === candidate.repository &&
/^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$/.test(candidate.ref)
);
}
function isExternalSource(
value: unknown,
): value is ExternalExamplesValidationResponse["source"] {
return Boolean(
value &&
typeof value === "object" &&
(value as Record<string, unknown>).mode === "repository-ref" &&
typeof (value as Record<string, unknown>).repository === "string" &&
typeof (value as Record<string, unknown>).ref === "string" &&
typeof (value as Record<string, unknown>).revision === "string",
);
}
function isCatalog(value: unknown): value is ExternalExamplesCatalog {
Iif (!value || typeof value !== "object") return false;
const candidate = value as Record<string, unknown>;
return (
candidate.schemaVersion === 1 &&
isSource(candidate.source) &&
Array.isArray(candidate.examples)
);
}
function isSource(value: unknown): value is ExternalExamplesSource {
return Boolean(
value &&
typeof value === "object" &&
["default", "browser-override"].includes(
String((value as Record<string, unknown>).selection),
) &&
["builtin", "repository-ref"].includes(
String((value as Record<string, unknown>).mode),
) &&
typeof (value as Record<string, unknown>).stale === "boolean",
);
}
async function parseJson(response: Response): Promise<any> {
try {
return await response.json();
} catch {
throw new ExternalExamplesError(
"UNKNOWN",
"The server returned invalid JSON.",
);
}
}
async function parseApiError(
response: Response,
): Promise<ExternalExamplesError> {
const payload = (await parseJson(response).catch(() => undefined)) as
| { error?: { code?: string } }
| undefined;
const code = payload?.error?.code;
if (
code === "INVALID_SELECTION" ||
code === "INVALID_REF" ||
code === "INVALID_REVISION" ||
code === "INVALID_SNAPSHOT" ||
code === "SOURCE_UNAVAILABLE" ||
code === "RATE_LIMITED" ||
code === "LOAD_CAPACITY_EXCEEDED"
) {
return new ExternalExamplesError(code, userMessageFor(code));
}
return new ExternalExamplesError(
response.status >= 500 ? "NETWORK" : "UNKNOWN",
userMessageFor(code),
);
}
function toExternalExamplesError(error: unknown): ExternalExamplesError {
if (error instanceof ExternalExamplesError) return error;
return new ExternalExamplesError(
"NETWORK",
"The examples service is currently unavailable.",
);
}
function isAbortError(error: unknown): error is DOMException {
return error instanceof DOMException && error.name === "AbortError";
}
function userMessageFor(code: string | undefined): string {
switch (code) {
case "INVALID_SELECTION":
return "The repository selection is invalid.";
case "INVALID_REF":
return "The ref is invalid.";
case "SOURCE_UNAVAILABLE":
return "The selected public repository is currently unavailable.";
case "RATE_LIMITED":
return "Too many requests. Please try again shortly.";
case "LOAD_CAPACITY_EXCEEDED":
return "The examples service is busy. Please try again shortly.";
case "INVALID_SNAPSHOT":
return "The selected examples snapshot is invalid.";
default:
return "Could not load the examples right now.";
}
}
|