@diffenderfer-games/hub-contract 2.0.0-next.0 → 2.0.0-next.1

package/src/errors/codes/multiplayer.ts

@@ -1,43 +1,43 @@
-/** Error codes from invites, parties, hub rooms, races and the socket envelope. */
-export const MULTIPLAYER_CODES = [
-  // Socket envelope.
-  'unknown_op',
-  'hello_required',
-  // Games and modes.
-  'not_multiplayer',
-  'not_supported',
-  'bad_mode',
-  // Invites, parties, launches, joins.
-  'bad_target',
-  'cannot_invite',
-  'already_member',
-  'party_full',
-  'invite_gone',
-  'party_gone',
-  'not_leader',
-  'bad_info',
-  'launch_invalid',
-  'not_joinable',
-  // Group chat.
-  'bad_quick',
-  // Hub rooms.
-  'room_not_found',
-  'not_in_room',
-  'not_host',
-  'too_many_rooms',
-  'banned',
-  'in_progress',
-  'room_full',
-  'not_ready',
-  'ended',
-  'bad_patch',
-  'race_room',
-  // Races.
-  'not_race',
-  'not_in_race',
-  'not_started',
-  'race_over',
-  'too_fast',
-  'bad_stats',
-  'bad_param',
-] as const;
+/** Error codes from invites, parties, hub rooms, races and the socket envelope. */
+export const MULTIPLAYER_CODES = [
+  // Socket envelope.
+  'unknown_op',
+  'hello_required',
+  // Games and modes.
+  'not_multiplayer',
+  'not_supported',
+  'bad_mode',
+  // Invites, parties, launches, joins.
+  'bad_target',
+  'cannot_invite',
+  'already_member',
+  'party_full',
+  'invite_gone',
+  'party_gone',
+  'not_leader',
+  'bad_info',
+  'launch_invalid',
+  'not_joinable',
+  // Group chat.
+  'bad_quick',
+  // Hub rooms.
+  'room_not_found',
+  'not_in_room',
+  'not_host',
+  'too_many_rooms',
+  'banned',
+  'in_progress',
+  'room_full',
+  'not_ready',
+  'ended',
+  'bad_patch',
+  'race_room',
+  // Races.
+  'not_race',
+  'not_in_race',
+  'not_started',
+  'race_over',
+  'too_fast',
+  'bad_stats',
+  'bad_param',
+] as const;

package/src/errors/codes/play.ts

@@ -1,5 +1,5 @@
-/** Error codes from accounts and the single-player API (saves, stats, boards, daily, economy, trades). */
-export const PLAY_CODES = [
-  /** A score was sent to a board only the game's own server may update (`source: "server"`). */
-  'server_board',
-] as const;
+/** Error codes from accounts and the single-player API (saves, stats, boards, daily, economy, trades). */
+export const PLAY_CODES = [
+  /** A score was sent to a board only the game's own server may update (`source: "server"`). */
+  'server_board',
+] as const;

package/src/errors/codes/social.ts

@@ -1,31 +1,31 @@
-/** Error codes from friends, messages, notifications, reports and suggestions. */
-export const SOCIAL_CODES = [
-  /** No such player, or one who blocked you or is suspended (they look the same). */
-  'no_player',
-  /** Not one of the preset avatars. */
-  'bad_avatar',
-  /** The chat-lock password was wrong. */
-  'bad_password',
-  /** An admin turned new friend requests off. */
-  'friend_requests_off',
-  /** You can't do that to yourself (friend, block; also invites, joins and room targets). */
-  'bad_target',
-  /** The other player is a guest and must create an account first. */
-  'guest_target',
-  /** You blocked them: unblock first. */
-  'blocked',
-  /** You or they have the most friends allowed. */
-  'friends_limit',
-  /** Too many outgoing friend requests waiting. */
-  'pending_limit',
-  /** The friend request is gone. */
-  'no_request',
-  /** You're not friends (messages, friend bells). */
-  'not_friends',
-  /** You've blocked the most players allowed. */
-  'blocks_limit',
-  /** The player isn't taking messages. */
-  'dms_closed',
-  /** Too many of your suggestions are waiting for review. */
-  'too_many_pending',
-] as const;
+/** Error codes from friends, messages, notifications, reports and suggestions. */
+export const SOCIAL_CODES = [
+  /** No such player, or one who blocked you or is suspended (they look the same). */
+  'no_player',
+  /** Not one of the preset avatars. */
+  'bad_avatar',
+  /** The chat-lock password was wrong. */
+  'bad_password',
+  /** An admin turned new friend requests off. */
+  'friend_requests_off',
+  /** You can't do that to yourself (friend, block; also invites, joins and room targets). */
+  'bad_target',
+  /** The other player is a guest and must create an account first. */
+  'guest_target',
+  /** You blocked them: unblock first. */
+  'blocked',
+  /** You or they have the most friends allowed. */
+  'friends_limit',
+  /** Too many outgoing friend requests waiting. */
+  'pending_limit',
+  /** The friend request is gone. */
+  'no_request',
+  /** You're not friends (messages, friend bells). */
+  'not_friends',
+  /** You've blocked the most players allowed. */
+  'blocks_limit',
+  /** The player isn't taking messages. */
+  'dms_closed',
+  /** Too many of your suggestions are waiting for review. */
+  'too_many_pending',
+] as const;

package/src/errors/index.ts

@@ -1,88 +1,88 @@
-/**
- * The error model (plan §5.3). Every failed REST call and every failed socket
- * ack carries an {@link ErrorBody}. `error` is always safe to show a player.
- * Public codes are listed per area in `codes/`; admin-only codes live in the
- * server-only internal contract.
- *
- * Each schema here also has a named `…Schema` interface. Endpoints reference
- * these schemas hundreds of times; naming their types lets the published
- * `.d.ts` refer to them instead of printing every code at every use.
- */
-import { z } from 'zod';
-import { Millis } from '../common';
-import { CORE_CODES } from './codes/core';
-import { MULTIPLAYER_CODES } from './codes/multiplayer';
-import { PLAY_CODES } from './codes/play';
-import { SOCIAL_CODES } from './codes/social';
-
-const errorCode = z.enum([...CORE_CODES, ...PLAY_CODES, ...SOCIAL_CODES, ...MULTIPLAYER_CODES]);
-
-/** The type of the {@link ErrorCode} schema. */
-export interface ErrorCodeSchema extends Readonly<typeof errorCode> {}
-
-/** Every public error code. */
-export const ErrorCode: ErrorCodeSchema = errorCode;
-
-/** A public error code. */
-export type ErrorCode = z.infer<ErrorCodeSchema>;
-
-const rejectReason = z.enum([
-  'link', 'personal_info', 'contact', 'language', 'slur', 'sexual', 'grown_up', 'unkind',
-  'threat', 'drugs', 'spam', 'shouting', 'too_long', 'empty', 'chars', 'reserved',
-  'rate_limited', 'muted', 'check_unavailable', 'chat_off', 'not_friends', 'suspended',
-  'quick_only', 'dms_closed', 'other',
-]);
-
-/** The type of the {@link RejectReason} schema. */
-export interface RejectReasonSchema extends Readonly<typeof rejectReason> {}
-
-/**
- * Why text was rejected or a chat action was refused. Coarse on purpose: a
- * reason names a category, never the word or list that matched.
- */
-export const RejectReason: RejectReasonSchema = rejectReason;
-
-/** A content-reject reason. */
-export type RejectReason = z.infer<RejectReasonSchema>;
-
-const errorBody = z.object({
-  /** A sentence that is always safe to show the player. */
-  error: z.string(),
-  /** What went wrong, for code to branch on. */
-  code: ErrorCode.optional(),
-  /** Content rejects and suspensions: the category. */
-  reason: RejectReason.optional(),
-  /** A kid-friendly suggestion, e.g. "try saying it another way". */
-  hint: z.string().optional(),
-  /** Rate limits: how long to wait, in ms (0 when not limited). */
-  retryAfterMs: z.number().int().nonnegative().optional(),
-  /** Suspensions and mutes: when they end (epoch ms). */
-  until: Millis.optional(),
-});
-
-/** The type of the {@link ErrorBody} schema. */
-export interface ErrorBodySchema extends Readonly<typeof errorBody> {}
-
-/** The body of every error response and failed socket ack. */
-export const ErrorBody: ErrorBodySchema = errorBody;
-
-/** An error body. */
-export type ErrorBody = z.infer<ErrorBodySchema>;
-
-const contentRejected = errorBody.extend({
-  code: z.literal('content_rejected'),
-  reason: RejectReason,
-  hint: z.string(),
-});
-
-/** The type of the {@link ContentRejected} schema. */
-export interface ContentRejectedSchema extends Readonly<typeof contentRejected> {}
-
-/**
- * The 422 content-rejected body (multiplayer.md §4.6), shared by DMs, room
- * chat, suggestions, names and trade notes.
- */
-export const ContentRejected: ContentRejectedSchema = contentRejected;
-
-/** A content-rejected body. */
-export type ContentRejected = z.infer<ContentRejectedSchema>;
+/**
+ * The error model (plan §5.3). Every failed REST call and every failed socket
+ * ack carries an {@link ErrorBody}. `error` is always safe to show a player.
+ * Public codes are listed per area in `codes/`; admin-only codes live in the
+ * server-only internal contract.
+ *
+ * Each schema here also has a named `…Schema` interface. Endpoints reference
+ * these schemas hundreds of times; naming their types lets the published
+ * `.d.ts` refer to them instead of printing every code at every use.
+ */
+import { z } from 'zod';
+import { Millis } from '../common';
+import { CORE_CODES } from './codes/core';
+import { MULTIPLAYER_CODES } from './codes/multiplayer';
+import { PLAY_CODES } from './codes/play';
+import { SOCIAL_CODES } from './codes/social';
+
+const errorCode = z.enum([...CORE_CODES, ...PLAY_CODES, ...SOCIAL_CODES, ...MULTIPLAYER_CODES]);
+
+/** The type of the {@link ErrorCode} schema. */
+export interface ErrorCodeSchema extends Readonly<typeof errorCode> {}
+
+/** Every public error code. */
+export const ErrorCode: ErrorCodeSchema = errorCode;
+
+/** A public error code. */
+export type ErrorCode = z.infer<ErrorCodeSchema>;
+
+const rejectReason = z.enum([
+  'link', 'personal_info', 'contact', 'language', 'slur', 'sexual', 'grown_up', 'unkind',
+  'threat', 'drugs', 'spam', 'shouting', 'too_long', 'empty', 'chars', 'reserved',
+  'rate_limited', 'muted', 'check_unavailable', 'chat_off', 'not_friends', 'suspended',
+  'quick_only', 'dms_closed', 'other',
+]);
+
+/** The type of the {@link RejectReason} schema. */
+export interface RejectReasonSchema extends Readonly<typeof rejectReason> {}
+
+/**
+ * Why text was rejected or a chat action was refused. Coarse on purpose: a
+ * reason names a category, never the word or list that matched.
+ */
+export const RejectReason: RejectReasonSchema = rejectReason;
+
+/** A content-reject reason. */
+export type RejectReason = z.infer<RejectReasonSchema>;
+
+const errorBody = z.object({
+  /** A sentence that is always safe to show the player. */
+  error: z.string(),
+  /** What went wrong, for code to branch on. */
+  code: ErrorCode.optional(),
+  /** Content rejects and suspensions: the category. */
+  reason: RejectReason.optional(),
+  /** A kid-friendly suggestion, e.g. "try saying it another way". */
+  hint: z.string().optional(),
+  /** Rate limits: how long to wait, in ms (0 when not limited). */
+  retryAfterMs: z.number().int().nonnegative().optional(),
+  /** Suspensions and mutes: when they end (epoch ms). */
+  until: Millis.optional(),
+});
+
+/** The type of the {@link ErrorBody} schema. */
+export interface ErrorBodySchema extends Readonly<typeof errorBody> {}
+
+/** The body of every error response and failed socket ack. */
+export const ErrorBody: ErrorBodySchema = errorBody;
+
+/** An error body. */
+export type ErrorBody = z.infer<ErrorBodySchema>;
+
+const contentRejected = errorBody.extend({
+  code: z.literal('content_rejected'),
+  reason: RejectReason,
+  hint: z.string(),
+});
+
+/** The type of the {@link ContentRejected} schema. */
+export interface ContentRejectedSchema extends Readonly<typeof contentRejected> {}
+
+/**
+ * The 422 content-rejected body (multiplayer.md §4.6), shared by DMs, room
+ * chat, suggestions, names and trade notes.
+ */
+export const ContentRejected: ContentRejectedSchema = contentRejected;
+
+/** A content-rejected body. */
+export type ContentRejected = z.infer<ContentRejectedSchema>;

package/src/index.ts

@@ -1,16 +1,16 @@
-/**
- * The diffenderfer.games hub wire contract: zod schemas and types for the
- * public REST API, the `/_ws` socket envelope, ops and events, error bodies
- * and the `game.*` manifest.
- *
- * @packageDocumentation
- */
-export * from './common';
-export * from './entities';
-export * from './errors';
-export * from './middleware';
-export * from './api';
-export * from './realtime';
-export * from './manifest';
-export * from './limits';
-export * from './logic';
+/**
+ * The diffenderfer.games hub wire contract: zod schemas and types for the
+ * public REST API, the `/_ws` socket envelope, ops and events, error bodies
+ * and the `game.*` manifest.
+ *
+ * @packageDocumentation
+ */
+export * from './common';
+export * from './entities';
+export * from './errors';
+export * from './middleware';
+export * from './api';
+export * from './realtime';
+export * from './manifest';
+export * from './limits';
+export * from './logic';

package/src/limits.ts

@@ -1,100 +1,100 @@
-/**
- * Limits a UI has to know about: text lengths, name rules, seat counts and
- * the rules for a game's `package.json` `game.*` block. Each number is
- * defined once here; the schemas and the server import it.
- *
- * Rate thresholds, caps and timers are server-only and not part of this package.
- */
-import { z } from 'zod';
-
-/** Account name and password rules (sign-up, claim, rename). */
-export const ACCOUNT_LIMITS = {
-  /** Shortest username, after trimming. */
-  usernameMin: 2,
-  /** Longest username, after trimming. */
-  usernameMax: 24,
-  /** Shortest password. */
-  passwordMin: 6,
-  /** How many built-in avatars there are (`a0` … `a23`). */
-  avatarCount: 24,
-} as const;
-
-/** The characters a username may use: letters, digits, `_`, `-` and spaces. */
-export const USERNAME_PATTERN = /^[A-Za-z0-9_\- ]+$/;
-
-/**
- * The text limits every social UI renders from. The hub sends the live values
- * in `GET /social/config` and the socket `hello` (`limits`); the server can
- * change them (`HUB_LIMITS_JSON`), so a UI should prefer the sent values.
- */
-export const UiLimits = z.object({
-  /** Longest direct message, in characters. */
-  dmMaxChars: z.number().int().positive(),
-  /** Longest room or party chat line, in characters. */
-  roomChatMaxChars: z.number().int().positive(),
-  /** Longest suggestion title, in characters. */
-  suggestionTitleMax: z.number().int().positive(),
-  /** Longest suggestion body, in characters. */
-  suggestionBodyMax: z.number().int().positive(),
-});
-
-/** The text limits every social UI renders from. */
-export type UiLimits = z.infer<typeof UiLimits>;
-
-/** Today's default {@link UiLimits}, used until the hub sends its own. */
-export const UI_LIMIT_DEFAULTS = {
-  dmMaxChars: 200,
-  roomChatMaxChars: 120,
-  suggestionTitleMax: 60,
-  suggestionBodyMax: 500,
-} as const satisfies UiLimits;
-
-/** Seats in hub rooms and parties. */
-export const SEAT_LIMITS = {
-  /** Most players in one hub room, and the top of any `players` range. */
-  maxSeats: 8,
-  /** Most members in one party. */
-  partyMax: 8,
-} as const;
-
-/** What a racer's live stats (`hub.race.status(stats)`) may hold. */
-export const RACE_STATS_LIMITS = {
-  /** Most stat keys in one update. */
-  maxKeys: 12,
-  /** Largest update, in bytes of JSON. */
-  maxBytes: 600,
-} as const;
-
-/** Limits on the `package.json` `game.*` block (see the manifest schemas). */
-export const MANIFEST_LIMITS = {
-  /** Most `game.changes` entries the hub reads. */
-  changesMax: 200,
-  /** Longest `game.changes` entry, in characters. */
-  changeTextMax: 280,
-  /** Longest leaderboard title, in characters. */
-  leaderboardTitleMax: 80,
-  /** Furthest the menu button may be pushed from its corner, in px. */
-  menuOffsetMax: 600,
-  /** Longest lobby URL suffix, in characters. */
-  lobbyMax: 200,
-  /** Most `game.multiplayer.modes`. */
-  modesMax: 16,
-  /** Longest mode title, in characters. */
-  modeTitleMax: 40,
-  /** Most `game.multiplayer.quickChat` phrases. */
-  quickChatMax: 24,
-  /** Longest quick-chat phrase, in characters. */
-  quickChatTextMax: 40,
-  /** Most `game.multiplayer.chatAllow` words. */
-  chatAllowMax: 20,
-  /** Most `game.race.params`. */
-  raceParamsMax: 6,
-  /** Most options in one race param. */
-  raceOptionsMax: 12,
-  /** Most `game.race.stats` (the live HUD shows the first 3). */
-  raceStatsMax: 8,
-  /** Longest race param, option or stat title, in characters. */
-  raceTitleMax: 24,
-  /** Largest `game.race.minMs`, in ms (10 minutes). */
-  raceMinMsMax: 600_000,
-} as const;
+/**
+ * Limits a UI has to know about: text lengths, name rules, seat counts and
+ * the rules for a game's `package.json` `game.*` block. Each number is
+ * defined once here; the schemas and the server import it.
+ *
+ * Rate thresholds, caps and timers are server-only and not part of this package.
+ */
+import { z } from 'zod';
+
+/** Account name and password rules (sign-up, claim, rename). */
+export const ACCOUNT_LIMITS = {
+  /** Shortest username, after trimming. */
+  usernameMin: 2,
+  /** Longest username, after trimming. */
+  usernameMax: 24,
+  /** Shortest password. */
+  passwordMin: 6,
+  /** How many built-in avatars there are (`a0` … `a23`). */
+  avatarCount: 24,
+} as const;
+
+/** The characters a username may use: letters, digits, `_`, `-` and spaces. */
+export const USERNAME_PATTERN = /^[A-Za-z0-9_\- ]+$/;
+
+/**
+ * The text limits every social UI renders from. The hub sends the live values
+ * in `GET /social/config` and the socket `hello` (`limits`); the server can
+ * change them (`HUB_LIMITS_JSON`), so a UI should prefer the sent values.
+ */
+export const UiLimits = z.object({
+  /** Longest direct message, in characters. */
+  dmMaxChars: z.number().int().positive(),
+  /** Longest room or party chat line, in characters. */
+  roomChatMaxChars: z.number().int().positive(),
+  /** Longest suggestion title, in characters. */
+  suggestionTitleMax: z.number().int().positive(),
+  /** Longest suggestion body, in characters. */
+  suggestionBodyMax: z.number().int().positive(),
+});
+
+/** The text limits every social UI renders from. */
+export type UiLimits = z.infer<typeof UiLimits>;
+
+/** Today's default {@link UiLimits}, used until the hub sends its own. */
+export const UI_LIMIT_DEFAULTS = {
+  dmMaxChars: 200,
+  roomChatMaxChars: 120,
+  suggestionTitleMax: 60,
+  suggestionBodyMax: 500,
+} as const satisfies UiLimits;
+
+/** Seats in hub rooms and parties. */
+export const SEAT_LIMITS = {
+  /** Most players in one hub room, and the top of any `players` range. */
+  maxSeats: 8,
+  /** Most members in one party. */
+  partyMax: 8,
+} as const;
+
+/** What a racer's live stats (`hub.race.status(stats)`) may hold. */
+export const RACE_STATS_LIMITS = {
+  /** Most stat keys in one update. */
+  maxKeys: 12,
+  /** Largest update, in bytes of JSON. */
+  maxBytes: 600,
+} as const;
+
+/** Limits on the `package.json` `game.*` block (see the manifest schemas). */
+export const MANIFEST_LIMITS = {
+  /** Most `game.changes` entries the hub reads. */
+  changesMax: 200,
+  /** Longest `game.changes` entry, in characters. */
+  changeTextMax: 280,
+  /** Longest leaderboard title, in characters. */
+  leaderboardTitleMax: 80,
+  /** Furthest the menu button may be pushed from its corner, in px. */
+  menuOffsetMax: 600,
+  /** Longest lobby URL suffix, in characters. */
+  lobbyMax: 200,
+  /** Most `game.multiplayer.modes`. */
+  modesMax: 16,
+  /** Longest mode title, in characters. */
+  modeTitleMax: 40,
+  /** Most `game.multiplayer.quickChat` phrases. */
+  quickChatMax: 24,
+  /** Longest quick-chat phrase, in characters. */
+  quickChatTextMax: 40,
+  /** Most `game.multiplayer.chatAllow` words. */
+  chatAllowMax: 20,
+  /** Most `game.race.params`. */
+  raceParamsMax: 6,
+  /** Most options in one race param. */
+  raceOptionsMax: 12,
+  /** Most `game.race.stats` (the live HUD shows the first 3). */
+  raceStatsMax: 8,
+  /** Longest race param, option or stat title, in characters. */
+  raceTitleMax: 24,
+  /** Largest `game.race.minMs`, in ms (10 minutes). */
+  raceMinMsMax: 600_000,
+} as const;