refactor: move challenges to typescript and improve types (@fehmer)

backend/package.json

@@ -21,6 +21,7 @@
   },
   "dependencies": {
     "@date-fns/utc": "1.2.0",
+    "@monkeytype/challenges": "workspace:*",
     "@monkeytype/contracts": "workspace:*",
     "@monkeytype/funbox": "workspace:*",
     "@monkeytype/schemas": "workspace:*",

backend/src/constants/auto-roles.ts

@@ -1,38 +1,5 @@
-export default [
-  "oneHourWarrior",
-  "doubleDown",
-  "tripleTrouble",
-  "quad",
-  "trueSimp",
-  "bigramSalad",
-  "simp",
-  "antidiseWhat",
-  "whatsThisWebsiteCalledAgain",
-  "developd",
-  "slowAndSteady",
-  "speedSpacer",
-  "iveGotThePower",
-  "accuracyExpert",
-  "accuracyMaster",
-  "accuracyGod",
-  "jolly",
-  "gottaCatchEmAll",
-  "rapGod",
-  "navySeal",
-  "rollercoaster",
-  "oneHourMirror",
-  "chooChoo",
-  "earfquake",
-  "simonSez",
-  "accountant",
-  "hidden",
-  "iCanSeeTheFuture",
-  "whatAreWordsAtThisPoint",
-  "specials",
-  "aeiou",
-  "asciiWarrior",
-  "iKiNdAlIkEhOwInEfFiCiEnTqWeRtYiS",
-  "oneNauseousMonkey",
-  "69",
-  "englishMaster",
-];
+import { getChallenges } from "@monkeytype/challenges";
+
+export default getChallenges()
+  .filter((it) => it.settings?.autoRole)
+  .map((it) => it.name);

frontend/package.json

@@ -28,6 +28,7 @@
   "dependencies": {
     "@date-fns/utc": "1.2.0",
     "@leonabcd123/modern-caps-lock": "3.1.3",
+    "@monkeytype/challenges": "workspace:*",
     "@monkeytype/contracts": "workspace:*",
     "@monkeytype/funbox": "workspace:*",
     "@monkeytype/schemas": "workspace:*",

frontend/scripts/check-assets.ts

@@ -2,7 +2,6 @@
  * Example usage in root or frontend:
  * pnpm check-assets (npm run check-assets)
  * pnpm check-assets -- -- quotes others (npm run check-assets -- -- quotes others)
- * pnpm check-assets -- -- challenges sound -p (npm run check-assets -- -- challenges sound -p)
  */
 
 import * as fs from "fs";
@@ -18,7 +17,6 @@ import { KnownFontName } from "@monkeytype/schemas/fonts";
 import { Fonts } from "../src/ts/constants/fonts";
 import { themes, ThemeSchema, ThemesList } from "../src/ts/constants/themes";
 import { z } from "zod";
-import { ChallengeSchema, Challenge } from "@monkeytype/schemas/challenges";
 import { LayoutObject, LayoutObjectSchema } from "@monkeytype/schemas/layouts";
 import { QuoteDataSchema, QuoteData } from "@monkeytype/schemas/quotes";
 import { clickSoundConfig } from "../src/ts/constants/sounds";
@@ -99,24 +97,6 @@ function findDuplicates<T>(items: T[]): T[] {
   return Array.from(duplicates);
 }
 
-async function validateChallenges(): Promise<void> {
-  const problems = new Problems<"_list.json", never>("Challenges", {});
-
-  const challengesData = JSON.parse(
-    fs.readFileSync("./static/challenges/_list.json", {
-      encoding: "utf8",
-      flag: "r",
-    }),
-  ) as Challenge;
-  const validationResult = z.array(ChallengeSchema).safeParse(challengesData);
-  problems.addValidation("_list.json", validationResult);
-
-  console.log(problems.toString());
-  if (problems.hasError()) {
-    throw new Error("challenges with errors");
-  }
-}
-
 async function validateLayouts(): Promise<void> {
   const problems = new Problems<Layout, "_additional">("Layouts", {
     _additional:
@@ -496,17 +476,10 @@ async function main(): Promise<void> {
     quotes: [validateQuotes],
     languages: [validateLanguages],
     layouts: [validateLayouts],
-    challenges: [validateChallenges],
     fonts: [validateFonts],
     themes: [validateThemes],
     sounds: [validateSounds],
-    others: [
-      validateChallenges,
-      validateLayouts,
-      validateFonts,
-      validateThemes,
-      validateSounds,
-    ],
+    others: [validateLayouts, validateFonts, validateThemes, validateSounds],
   };
 
   // flags

frontend/src/ts/auth.tsx

@@ -1,4 +1,5 @@
 import { PasswordSchema } from "@monkeytype/schemas/users";
+import { typedKeys } from "@monkeytype/util/objects";
 import { tryCatch } from "@monkeytype/util/trycatch";
 import { FirebaseError } from "firebase/app";
 import {
@@ -41,7 +42,6 @@ import {
 } from "./states/notifications";
 import { isDevEnvironment } from "./utils/env";
 import { createErrorMessage } from "./utils/error";
-import { typedKeys } from "./utils/misc";
 import { SnapshotInitError } from "./utils/snapshot-init-error";
 import { OneOf } from "./utils/types";
 

frontend/src/ts/commandline/commandline-metadata.ts

@@ -13,8 +13,8 @@ import { getActivePage, isAuthenticated } from "../states/core";
 import { Fonts } from "../constants/fonts";
 import { KnownFontName } from "@monkeytype/schemas/fonts";
 import * as UI from "../ui";
-import { typedKeys } from "../utils/misc";
 import { Validation } from "../types/validation";
+import { typedKeys } from "@monkeytype/util/objects";
 
 //TODO: remove display property and instead use optionsMetadata from configMetadata
 // eventually this file should be fully merged into config metadata, probably under the 'commandline' property

frontend/src/ts/commandline/lists.ts

@@ -12,14 +12,10 @@ import CustomThemesListCommands from "./lists/custom-themes-list";
 import PresetsCommands from "./lists/presets";
 import FunboxCommands from "./lists/funbox";
 import ThemesCommands from "./lists/themes";
-import LoadChallengeCommands, {
-  update as updateLoadChallengeCommands,
-} from "./lists/load-challenge";
+import LoadChallengeCommands from "./lists/load-challenge";
 
 import { Config } from "../config/store";
 import { setConfig } from "../config/setters";
-import * as getErrorMessage from "../utils/error";
-import * as JSONData from "../utils/json-data";
 import { randomizeTheme } from "../controllers/theme-controller";
 import { showModal } from "../states/modals";
 import {
@@ -41,20 +37,6 @@ import {
 import { applyConfigFromJson } from "../config/lifecycle";
 import { lastEventLog } from "../test/test-state";
 
-const challengesPromise = JSONData.getChallengeList();
-challengesPromise
-  .then((challenges) => {
-    updateLoadChallengeCommands(challenges);
-  })
-  .catch((e: unknown) => {
-    console.error(
-      getErrorMessage.createErrorMessage(
-        e,
-        "Failed to update challenges commands",
-      ),
-    );
-  });
-
 const adsCommands = buildCommands("ads");
 
 export const commands: CommandsSubgroup = {
@@ -406,8 +388,6 @@ export function doesListExist(listName: string): boolean {
 export async function getList(
   listName: CommandlineListKey | ConfigKey,
 ): Promise<CommandsSubgroup> {
-  await Promise.allSettled([challengesPromise]);
-
   const subGroup = subgroupByConfigKey[listName];
   if (subGroup !== undefined) {
     return subGroup;
@@ -451,7 +431,6 @@ export function getTopOfStack(): CommandsSubgroup {
 
 let singleList: CommandsSubgroup | undefined;
 export async function getSingleSubgroup(): Promise<CommandsSubgroup> {
-  await Promise.allSettled([challengesPromise]);
   const singleCommands: Command[] = [];
   for (const command of commands.list) {
     const ret = buildSingleListCommands(command);

frontend/src/ts/commandline/lists/load-challenge.ts

@@ -1,13 +1,25 @@
-import { navigate } from "../../controllers/route-controller";
+import { getChallenges } from "@monkeytype/challenges";
 import * as ChallengeController from "../../controllers/challenge-controller";
+import { navigate } from "../../controllers/route-controller";
 import * as TestLogic from "../../test/test-logic";
 import { capitalizeFirstLetterOfEachWord } from "../../utils/strings";
 import { Command, CommandsSubgroup } from "../types";
-import { Challenge } from "@monkeytype/schemas/challenges";
 
 const subgroup: CommandsSubgroup = {
   title: "Load challenge...",
-  list: [],
+  list: getChallenges()
+    .filter((it) => it.settings !== undefined)
+    .map((challenge) => ({
+      id: `loadChallenge${capitalizeFirstLetterOfEachWord(challenge.name)}`,
+      display: challenge.display,
+      exec: async (): Promise<void> => {
+        await navigate("/");
+        await ChallengeController.setup(challenge.name);
+        TestLogic.restart({
+          nosave: true,
+        });
+      },
+    })),
 };
 
 const commands: Command[] = [
@@ -19,21 +31,4 @@ const commands: Command[] = [
   },
 ];
 
-function update(challenges: Challenge[]): void {
-  challenges.forEach((challenge) => {
-    subgroup.list.push({
-      id: `loadChallenge${capitalizeFirstLetterOfEachWord(challenge.name)}`,
-      display: challenge.display,
-      exec: async (): Promise<void> => {
-        await navigate("/");
-        await ChallengeController.setup(challenge.name);
-        TestLogic.restart({
-          nosave: true,
-        });
-      },
-    });
-  });
-}
-
 export default commands;
-export { update };

frontend/src/ts/components/common/AsyncContent.tsx

@@ -1,3 +1,4 @@
+import { typedKeys } from "@monkeytype/util/objects";
 import { UseQueryResult } from "@tanstack/solid-query";
 import {
   Accessor,
@@ -12,7 +13,6 @@ import {
 
 import { showErrorNotification } from "../../states/notifications";
 import { createErrorMessage } from "../../utils/error";
-import { typedKeys } from "../../utils/misc";
 import { LoadingCircle } from "./LoadingCircle";
 
 type AsyncEntry<T> = {

frontend/src/ts/components/modals/SimpleModal.tsx

@@ -1,3 +1,4 @@
+import { typedEntries } from "@monkeytype/util/objects";
 import { AnyFieldApi, createForm } from "@tanstack/solid-form";
 import {
   Accessor,
@@ -25,7 +26,6 @@ import {
   SimpleModalInput,
 } from "../../states/simple-modal";
 import { cn } from "../../utils/cn";
-import { typedEntries } from "../../utils/misc";
 import { getZodType, unwrapSchema } from "../../utils/zod";
 import { AnimatedModal } from "../common/AnimatedModal";
 import { Checkbox } from "../ui/form/Checkbox";

frontend/src/ts/components/pages/account/utils.ts

@@ -1,7 +1,8 @@
 import { ResultFilters, ResultFiltersSchema } from "@monkeytype/schemas/users";
-import { typedKeys } from "../../../utils/misc";
+
 import defaultResultFilters from "../../../constants/default-result-filters";
 import { sanitize } from "../../../utils/sanitize";
+import { typedKeys } from "@monkeytype/util/objects";
 
 export function mergeWithDefaultFilters(
   filters: Partial<ResultFilters>,

frontend/src/ts/config/lifecycle.ts

@@ -13,9 +13,10 @@ import { Config, setFullConfigStore } from "./store";
 import { getDefaultConfig } from "../constants/default-config";
 import { configEvent } from "../events/config";
 import { migrateConfig } from "./utils";
-import { promiseWithResolvers, typedKeys } from "../utils/misc";
+import { promiseWithResolvers } from "../utils/misc";
 import { setConfig } from "./setters";
 import { deleteConfig } from "../ape/config";
+import { typedKeys } from "@monkeytype/util/objects";
 
 export async function applyConfigFromJson(json: string): Promise<void> {
   try {

frontend/src/ts/config/setters.ts

@@ -10,10 +10,11 @@ import {
   canSetFunboxWithConfig,
 } from "./funbox-validation";
 import * as TestState from "../test/test-state";
-import { typedKeys, triggerResize, escapeHTML } from "../utils/misc";
+import { triggerResize, escapeHTML } from "../utils/misc";
 import { camelCaseToWords, capitalizeFirstLetter } from "../utils/strings";
 import { Config, setConfigStore } from "./store";
 import { FunboxName } from "@monkeytype/schemas/configs";
+import { typedKeys } from "@monkeytype/util/objects";
 
 export function setConfig<T extends keyof ConfigSchemas.Config>(
   key: T,

frontend/src/ts/config/utils.ts

@@ -4,11 +4,11 @@ import type {
   PartialConfig,
   FunboxName,
 } from "@monkeytype/schemas/configs";
-import { typedKeys } from "../utils/misc";
 import { sanitize } from "../utils/sanitize";
 import * as ConfigSchemas from "@monkeytype/schemas/configs";
 import { getDefaultConfig } from "../constants/default-config";
 import { Config } from "./store";
+import { typedKeys } from "@monkeytype/util/objects";
 /**
  * migrates possible outdated config and merges with the default config values
  * @param config partial or possible outdated config