scrabble-solver 2.18.9 → 2.18.10-alpha.1

package/packages/logger/scripts/readEvents.ts

@@ -1,34 +0,0 @@
-import fs from 'node:fs';
-import readline from 'node:readline';
-
-import { EVENT_FIELDS, EVENTS_FILEPATH, type LoggedEvent } from '../src';
-
-export async function* readEvents(): AsyncGenerator<LoggedEvent | undefined> {
-  if (!fs.existsSync(EVENTS_FILEPATH)) {
-    throw new Error(`No events file at ${EVENTS_FILEPATH}`);
-  }
-
-  const lines = readline.createInterface({ input: fs.createReadStream(EVENTS_FILEPATH), crlfDelay: Infinity });
-
-  for await (const line of lines) {
-    yield parseEvent(line);
-  }
-}
-
-function parseEvent(line: string): LoggedEvent | undefined {
-  try {
-    const value: unknown = JSON.parse(line);
-    return isLoggedEvent(value) ? value : undefined;
-  } catch {
-    return undefined;
-  }
-}
-
-function isLoggedEvent(value: unknown): value is LoggedEvent {
-  if (typeof value !== 'object' || value === null) {
-    return false;
-  }
-
-  const { timestamp, type } = value as Partial<Record<'timestamp' | 'type', unknown>>;
-  return typeof timestamp === 'string' && typeof type === 'string' && Object.hasOwn(EVENT_FIELDS, type);
-}

package/packages/logger/scripts/tsconfig.json

@@ -1,10 +0,0 @@
-{
-  "extends": "../../../tsconfig.json",
-
-  "compilerOptions": {
-    "module": "preserve",
-    "moduleResolution": "bundler",
-    "noEmit": true
-  },
-  "include": ["./**/*.ts"]
-}

package/packages/logger/src/constants.ts

@@ -1,13 +0,0 @@
-import os from 'os';
-import path from 'path';
-
-// bun test exposes the Jest globals to every module, so their presence marks a test run even under an inherited NODE_ENV
-declare const describe: unknown;
-
-export const OUTPUT_DIRECTORY = path.resolve(os.homedir(), '.scrabble-solver', 'logs');
-
-export const EVENTS_FILEPATH = path.resolve(OUTPUT_DIRECTORY, 'events.txt');
-
-export const CSV_DIRECTORY = path.resolve(os.homedir(), '.scrabble-solver', 'csv');
-
-export const IS_TEST_RUN = process.env.NODE_ENV === 'test' || typeof describe === 'function';

package/packages/logger/src/describeError.test.ts

@@ -1,44 +0,0 @@
-import { describeError } from './describeError';
-
-describe('describeError', () => {
-  it('prefixes the message with the error name and keeps the stack', () => {
-    const { message, stack } = describeError(new Error('boom'));
-
-    expect(message).toBe('Error: boom');
-    expect(stack).toStartWith('Error: boom\n');
-  });
-
-  it('includes the error code', () => {
-    const error = Object.assign(new Error('connect ECONNREFUSED 127.0.0.1:443'), { code: 'ECONNREFUSED' });
-
-    expect(describeError(error).message).toBe('Error [ECONNREFUSED]: connect ECONNREFUSED 127.0.0.1:443');
-  });
-
-  it('lists the errors behind an AggregateError with an empty message', () => {
-    const error = Object.assign(
-      new AggregateError(
-        [
-          Object.assign(new Error('connect ECONNREFUSED ::1:443'), { code: 'ECONNREFUSED' }),
-          Object.assign(new Error('connect ECONNREFUSED 127.0.0.1:443'), { code: 'ECONNREFUSED' }),
-        ],
-        '',
-      ),
-      { code: 'ECONNREFUSED' },
-    );
-
-    expect(describeError(error).message).toBe(
-      'AggregateError [ECONNREFUSED]: (Error [ECONNREFUSED]: connect ECONNREFUSED ::1:443; Error [ECONNREFUSED]: connect ECONNREFUSED 127.0.0.1:443)',
-    );
-  });
-
-  it('includes the cause', () => {
-    const error = new Error('Could not download word list', { cause: new TypeError('fetch failed') });
-
-    expect(describeError(error).message).toBe('Error: Could not download word list (TypeError: fetch failed)');
-  });
-
-  it('stringifies values that are not errors without a stack', () => {
-    expect(describeError('boom')).toEqual({ message: 'boom', stack: undefined });
-    expect(describeError(undefined)).toEqual({ message: 'undefined', stack: undefined });
-  });
-});

package/packages/logger/src/describeError.ts

@@ -1,30 +0,0 @@
-export interface ErrorDescription {
-  message: string;
-  stack: string | undefined;
-}
-
-export function describeError(error: unknown): ErrorDescription {
-  return { message: formatError(error), stack: error instanceof Error ? error.stack : undefined };
-}
-
-function formatError(error: unknown): string {
-  if (!(error instanceof Error)) {
-    return String(error);
-  }
-
-  const heading = `${error.name}${formatCode(error)}: ${error.message}`.trimEnd();
-  const nested = getNestedErrors(error);
-  return nested.length === 0 ? heading : `${heading} (${nested.map(formatError).join('; ')})`;
-}
-
-function formatCode(error: Error): string {
-  return 'code' in error && typeof error.code === 'string' ? ` [${error.code}]` : '';
-}
-
-function getNestedErrors(error: Error): unknown[] {
-  if (error instanceof AggregateError) {
-    return error.errors;
-  }
-
-  return error.cause === undefined ? [] : [error.cause];
-}

package/packages/logger/src/events.ts

@@ -1,103 +0,0 @@
-export type Event = VisitEvent | SolveEvent | VerifyEvent | DownloadEvent | DefinitionEvent | BuildEvent | ErrorEvent;
-
-export type EventType = Event['type'];
-
-export type EventOf<T extends EventType> = Extract<Event, { type: T }>;
-
-export type EventValue = string | number | boolean | undefined;
-
-export type LoggedEvent = Event & { timestamp: string };
-
-export type Operation = 'visit' | 'solve' | 'verify' | 'download' | 'definition' | 'build' | 'cache';
-
-type VisitEvent = {
-  type: 'visit';
-  ip?: string;
-  ua?: string;
-  referrer?: string;
-  locale?: string;
-  game?: string;
-  url?: string;
-};
-
-type SolveEvent = {
-  type: 'solve';
-  ip?: string;
-  ms: number;
-  locale: string;
-  game: string;
-  tiles: number;
-  blanks: number;
-  rack: string;
-  results: number;
-};
-
-type VerifyEvent = {
-  type: 'verify';
-  ip?: string;
-  ms: number;
-  locale: string;
-  game: string;
-  tiles: number;
-  blanks: number;
-  valid: number;
-  invalid: number;
-};
-
-type DownloadEvent = {
-  type: 'download';
-  ip?: string;
-  ms: number;
-  locale: string;
-  status: number;
-  encoding: 'gzip' | 'identity';
-  bytes: number;
-};
-
-type DefinitionEvent = {
-  type: 'definition';
-  ip?: string;
-  ms: number;
-  locale: string;
-  words: string;
-  found: number;
-};
-
-type BuildEvent = {
-  type: 'build';
-  locale: string;
-  words: number;
-  download_ms: number;
-  build_ms: number;
-};
-
-type ErrorEvent = {
-  type: 'error';
-  level: 'error' | 'warn';
-  operation: Operation;
-  locale?: string;
-  ip?: string;
-  ua?: string;
-  message: string;
-  stack?: string;
-  input?: string;
-};
-
-type FieldsOf<T extends EventType> = Exclude<keyof EventOf<T>, 'type'>;
-
-// Field order is the column order of the exported CSV files - append only, never reorder.
-export const EVENT_FIELDS = {
-  visit: ['ip', 'ua', 'referrer', 'locale', 'game', 'url'],
-  solve: ['ip', 'ms', 'locale', 'game', 'tiles', 'blanks', 'rack', 'results'],
-  verify: ['ip', 'ms', 'locale', 'game', 'tiles', 'blanks', 'valid', 'invalid'],
-  download: ['ip', 'ms', 'locale', 'status', 'encoding', 'bytes'],
-  definition: ['ip', 'ms', 'locale', 'words', 'found'],
-  build: ['locale', 'words', 'download_ms', 'build_ms'],
-  error: ['level', 'operation', 'locale', 'ip', 'ua', 'message', 'stack', 'input'],
-} as const satisfies { [T in EventType]: readonly FieldsOf<T>[] };
-
-type UnlistedFields = { [T in EventType]: Exclude<FieldsOf<T>, (typeof EVENT_FIELDS)[T][number]> }[EventType];
-
-type Assert<T extends never> = T;
-
-export type EveryFieldIsListed = Assert<UnlistedFields>;

package/packages/logger/src/formatCsvRow.test.ts

@@ -1,41 +0,0 @@
-import { formatCsvRow } from './formatCsvRow';
-
-describe('formatCsvRow', () => {
-  it('joins values with commas and ends the line', () => {
-    expect(formatCsvRow(['a', 1, true])).toBe('a,1,true\n');
-  });
-
-  it('writes undefined as an empty field', () => {
-    expect(formatCsvRow(['a', undefined, 'b'])).toBe('a,,b\n');
-  });
-
-  it('quotes fields containing commas', () => {
-    expect(formatCsvRow(['x,y'])).toBe('"x,y"\n');
-  });
-
-  it('quotes fields containing quotes and doubles them', () => {
-    expect(formatCsvRow(['say "hi"'])).toBe('"say ""hi"""\n');
-  });
-
-  it('quotes fields containing line breaks', () => {
-    expect(formatCsvRow(['Error: boom\n    at solve'])).toBe('"Error: boom\n    at solve"\n');
-  });
-
-  it('quotes fields with leading or trailing whitespace', () => {
-    expect(formatCsvRow([' ab', 'cd '])).toBe('" ab","cd "\n');
-  });
-
-  it('leaves inner whitespace unquoted', () => {
-    expect(formatCsvRow(['pz cvmt'])).toBe('pz cvmt\n');
-  });
-
-  it('prefixes text a spreadsheet would evaluate as a formula with a quote', () => {
-    expect(formatCsvRow(['=HYPERLINK("http://evil","x")', '+1', '-1', '@x', '\tx'])).toBe(
-      `"'=HYPERLINK(""http://evil"",""x"")",'+1,'-1,'@x,'\tx\n`,
-    );
-  });
-
-  it('leaves negative numbers alone', () => {
-    expect(formatCsvRow([-1])).toBe('-1\n');
-  });
-});

package/packages/logger/src/formatCsvRow.ts

@@ -1,24 +0,0 @@
-import { type EventValue } from './events';
-
-const FORMULA_PREFIX = /^[=+\-@\t\r]/;
-
-export function formatCsvRow(values: EventValue[]): string {
-  return `${values.map(formatCsvField).join(',')}\n`;
-}
-
-function formatCsvField(value: EventValue): string {
-  if (typeof value === 'undefined') {
-    return '';
-  }
-
-  const text = typeof value === 'string' ? escapeFormula(value) : String(value);
-  return needsQuoting(text) ? `"${text.replaceAll('"', '""')}"` : text;
-}
-
-function escapeFormula(text: string): string {
-  return FORMULA_PREFIX.test(text) ? `'${text}` : text;
-}
-
-function needsQuoting(text: string): boolean {
-  return /[",\n\r]/.test(text) || text !== text.trim();
-}

package/packages/logger/src/index.ts

@@ -1,13 +0,0 @@
-export { CSV_DIRECTORY, EVENTS_FILEPATH, OUTPUT_DIRECTORY } from './constants';
-export {
-  EVENT_FIELDS,
-  type Event,
-  type EventOf,
-  type EventType,
-  type EventValue,
-  type LoggedEvent,
-  type Operation,
-} from './events';
-export { formatCsvRow } from './formatCsvRow';
-export { logError } from './logError';
-export { logEvent } from './logEvent';

package/packages/logger/src/logError.ts

@@ -1,24 +0,0 @@
-import { IS_TEST_RUN } from './constants';
-import { describeError, type ErrorDescription } from './describeError';
-import { type EventOf, type Operation } from './events';
-import { logEvent } from './logEvent';
-
-type ErrorContext = Partial<Pick<EventOf<'error'>, 'level' | 'input' | 'ip' | 'locale' | 'ua'>>;
-
-export function logError(
-  operation: Operation,
-  error: unknown,
-  { level = 'error', ...context }: ErrorContext = {},
-): void {
-  const description = describeError(error);
-  logEvent({ type: 'error', level, operation, ...description, ...context });
-
-  if (level === 'error' && !IS_TEST_RUN) {
-    process.stderr.write(formatStderrEntry(operation, description));
-  }
-}
-
-function formatStderrEntry(operation: Operation, { message, stack }: ErrorDescription): string {
-  const frames = stack?.split('\n').filter((line) => line.startsWith('    at ')) ?? [];
-  return `${[`${operation}: ${message}`, ...frames].join('\n')}\n`;
-}

package/packages/logger/src/logEvent.test.ts

@@ -1,59 +0,0 @@
-import { formatEventLine } from './logEvent';
-
-const NOW = new Date('2026-08-23T02:09:02.123Z');
-
-describe('formatEventLine', () => {
-  it('orders keys as timestamp, type, then the declared fields', () => {
-    const line = formatEventLine(
-      {
-        type: 'solve',
-        results: 312,
-        rack: 'p,z, ,c,v,m,t',
-        blanks: 4,
-        tiles: 61,
-        game: 'scrabble',
-        locale: 'en-US',
-        ms: 14,
-        ip: '203.0.113.7',
-      },
-      NOW,
-    );
-
-    expect(Object.keys(JSON.parse(line) as Record<string, unknown>)).toEqual([
-      'timestamp',
-      'type',
-      'ip',
-      'ms',
-      'locale',
-      'game',
-      'tiles',
-      'blanks',
-      'rack',
-      'results',
-    ]);
-  });
-
-  it('formats the timestamp in UTC with seconds precision', () => {
-    const line = formatEventLine({ type: 'build', locale: 'pl-PL', words: 3, download_ms: 1, build_ms: 2 }, NOW);
-
-    expect(line).toBe(
-      '{"timestamp":"2026-08-23T02:09:02Z","type":"build","locale":"pl-PL","words":3,"download_ms":1,"build_ms":2}\n',
-    );
-  });
-
-  it('omits undefined fields', () => {
-    const line = formatEventLine({ type: 'visit', ip: '::1', referrer: undefined }, NOW);
-
-    expect(line).toBe('{"timestamp":"2026-08-23T02:09:02Z","type":"visit","ip":"::1"}\n');
-  });
-
-  it('keeps multi-line values on a single line', () => {
-    const line = formatEventLine(
-      { type: 'error', level: 'error', operation: 'solve', message: 'Error: boom', stack: 'Error: boom\n    at solve' },
-      NOW,
-    );
-
-    expect(line.endsWith('\n')).toBe(true);
-    expect(line.slice(0, -1)).not.toContain('\n');
-  });
-});

package/packages/logger/src/logEvent.ts

@@ -1,26 +0,0 @@
-import fs from 'fs';
-
-import { EVENTS_FILEPATH, IS_TEST_RUN, OUTPUT_DIRECTORY } from './constants';
-import { EVENT_FIELDS, type Event } from './events';
-
-export function logEvent(event: Event): void {
-  if (IS_TEST_RUN) {
-    return;
-  }
-
-  try {
-    fs.mkdirSync(OUTPUT_DIRECTORY, { recursive: true });
-    fs.appendFileSync(EVENTS_FILEPATH, formatEventLine(event, new Date()));
-  } catch (error) {
-    process.stderr.write(`Could not append to ${EVENTS_FILEPATH}: ${String(error)}\n`);
-  }
-}
-
-export function formatEventLine(event: Event, now: Date): string {
-  const line = { timestamp: formatTimestamp(now), ...event };
-  return `${JSON.stringify(line, ['timestamp', 'type', ...EVENT_FIELDS[event.type]])}\n`;
-}
-
-function formatTimestamp(date: Date): string {
-  return `${date.toISOString().slice(0, 19)}Z`;
-}

package/packages/logger/tsconfig.json

@@ -1,10 +0,0 @@
-{
-  "extends": "../../tsconfig.json",
-
-  "compilerOptions": {
-    "outDir": "./build",
-    "rootDir": "./src"
-  },
-  "exclude": ["node_modules", "**/*.test.ts"],
-  "include": ["./src", "index.ts"]
-}

package/packages/scrabble-solver/.env

@@ -1 +0,0 @@
-NEXT_TELEMETRY_DISABLED=1

package/packages/scrabble-solver/.next/BUILD_ID

@@ -1 +0,0 @@
-ZAXBgTNB3tlEK8seyFXPO

package/packages/scrabble-solver/.next/build-manifest.json

@@ -1,42 +0,0 @@
-{
-  "polyfillFiles": [
-    "static/chunks/polyfills-42372ed130431b0a.js"
-  ],
-  "devFiles": [],
-  "lowPriorityFiles": [
-    "static/ZAXBgTNB3tlEK8seyFXPO/_buildManifest.js",
-    "static/ZAXBgTNB3tlEK8seyFXPO/_ssgManifest.js"
-  ],
-  "rootMainFiles": [],
-  "rootMainFilesTree": {},
-  "pages": {
-    "/": [
-      "static/chunks/webpack-e8cd77eb7929e1f0.js",
-      "static/chunks/framework-86d3b250d278cea9.js",
-      "static/chunks/main-738e097cd313908f.js",
-      "static/chunks/744-5ad846426b8f4514.js",
-      "static/css/8b8087461767360a.css",
-      "static/chunks/pages/index-ebba11f9b00e2bb5.js"
-    ],
-    "/_app": [
-      "static/chunks/webpack-e8cd77eb7929e1f0.js",
-      "static/chunks/framework-86d3b250d278cea9.js",
-      "static/chunks/main-738e097cd313908f.js",
-      "static/css/4dbcacc1122ac6b9.css",
-      "static/chunks/pages/_app-649c89598d664fab.js"
-    ],
-    "/_error": [
-      "static/chunks/webpack-e8cd77eb7929e1f0.js",
-      "static/chunks/framework-86d3b250d278cea9.js",
-      "static/chunks/main-738e097cd313908f.js",
-      "static/chunks/pages/_error-f0290a98eb3ed0ec.js"
-    ],
-    "/not-found": [
-      "static/chunks/webpack-e8cd77eb7929e1f0.js",
-      "static/chunks/framework-86d3b250d278cea9.js",
-      "static/chunks/main-738e097cd313908f.js",
-      "static/css/dee878eb64099d92.css",
-      "static/chunks/pages/not-found-a59f9deeeff63d17.js"
-    ]
-  }
-}

package/packages/scrabble-solver/.next/cache/.previewinfo

@@ -1 +0,0 @@
-{"previewModeId":"bb63e296c5b33c4f28499acbbc6c3d4d","previewModeSigningKey":"f1d663a4ee38f9409c49f7503326b0bee068e036237da8e62af08c82005a1f7c","previewModeEncryptionKey":"7264b7e70d1b1221271c4c714dba240d95e0c3f811680e446fae639b42d24cbf","expireAt":1794418943245}

package/packages/scrabble-solver/.next/cache/.rscinfo

@@ -1 +0,0 @@
-{"encryption.key":"KqbCh+RNmCaW2iDbEzHi9PlsgS/nsDLJF7cP1sf+zW0=","encryption.expire_at":1794418943243}