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

package/src/api/economy/bundle.ts

@@ -1,69 +1,69 @@
-/**
- * Economy shapes: a player's per-game holdings and the bundles that move
- * goods. Items are opaque, app-defined {@link Key}s; the hub only counts them.
- */
-import { z } from 'zod';
-import { Key } from '../../common';
-
-/**
- * The default largest quantity (or coin amount) one bundle entry may carry.
- * The hub's limit is `HUB_MAX_ITEM_QTY`, which defaults to this.
- */
-export const MAX_ITEM_QTY = 1_000_000;
-
-/**
- * The default most distinct item keys one bundle may name. The hub's limit
- * is `HUB_MAX_BUNDLE_ITEMS`, which defaults to this.
- */
-export const MAX_BUNDLE_ITEMS = 50;
-
-/** A player's holdings in one game: items with a positive count, and coins. */
-export const Inventory = z.object({
-  /** Sorted by key. */
-  items: z.array(z.object({ key: Key, qty: z.number().int().positive() })),
-  coins: z.number().int().nonnegative(),
-});
-
-/** A player's holdings in one game. */
-export type Inventory = z.infer<typeof Inventory>;
-
-/**
- * A bundle quantity, read like the hub's `Number(x)` (numeric strings pass).
- * A value that is not a number reads as `NaN` here rather than failing, so
- * the hub's own range check, which knows its configured limits, answers with
- * its message (e.g. `grant.coins must be an integer in [0, 1000000].`).
- * Clients should send a JSON integer.
- */
-const BundleQuantity = z.coerce.number<number>().catch(Number.NaN);
-
-/**
- * Goods to grant, spend or trade, as a request sends them, for the request
- * field named `label` (`grant`, `take`, `give`, `want`), which the error
- * messages name. Both parts are optional (`null` or missing means none).
- * Item keys must be {@link Key}s, at most `HUB_MAX_BUNDLE_ITEMS` of them,
- * each with a quantity from 1 to `HUB_MAX_ITEM_QTY`; coins run from 0 to
- * `HUB_MAX_ITEM_QTY`. The hub checks those limits and the keys itself.
- */
-export function bundleInput(label: string) {
-  return z.object({
-    /** 0 to `HUB_MAX_ITEM_QTY`. */
-    coins: BundleQuantity.nullish(),
-    /** Item key to quantity (1 to `HUB_MAX_ITEM_QTY`). */
-    items: z.record(z.string(), BundleQuantity, { error: `${label}.items must be an object of key→quantity.` }).nullish(),
-  }, { error: `${label} must be an object.` });
-}
-
-/** A request bundle, for documentation and clients. */
-export const BundleInput = bundleInput('bundle');
-
-/** A request bundle. */
-export type BundleInput = z.infer<typeof BundleInput>;
-
-/** A bundle as the hub stores and returns it on a trade offer: both parts always present. */
-export const Bundle = z.object({
-  items: z.record(Key, z.number().int().positive()),
-  coins: z.number().int().nonnegative(),
-});
-
-/** A stored bundle. */
-export type Bundle = z.infer<typeof Bundle>;
+/**
+ * Economy shapes: a player's per-game holdings and the bundles that move
+ * goods. Items are opaque, app-defined {@link Key}s; the hub only counts them.
+ */
+import { z } from 'zod';
+import { Key } from '../../common';
+
+/**
+ * The default largest quantity (or coin amount) one bundle entry may carry.
+ * The hub's limit is `HUB_MAX_ITEM_QTY`, which defaults to this.
+ */
+export const MAX_ITEM_QTY = 1_000_000;
+
+/**
+ * The default most distinct item keys one bundle may name. The hub's limit
+ * is `HUB_MAX_BUNDLE_ITEMS`, which defaults to this.
+ */
+export const MAX_BUNDLE_ITEMS = 50;
+
+/** A player's holdings in one game: items with a positive count, and coins. */
+export const Inventory = z.object({
+  /** Sorted by key. */
+  items: z.array(z.object({ key: Key, qty: z.number().int().positive() })),
+  coins: z.number().int().nonnegative(),
+});
+
+/** A player's holdings in one game. */
+export type Inventory = z.infer<typeof Inventory>;
+
+/**
+ * A bundle quantity, read like the hub's `Number(x)` (numeric strings pass).
+ * A value that is not a number reads as `NaN` here rather than failing, so
+ * the hub's own range check, which knows its configured limits, answers with
+ * its message (e.g. `grant.coins must be an integer in [0, 1000000].`).
+ * Clients should send a JSON integer.
+ */
+const BundleQuantity = z.coerce.number<number>().catch(Number.NaN);
+
+/**
+ * Goods to grant, spend or trade, as a request sends them, for the request
+ * field named `label` (`grant`, `take`, `give`, `want`), which the error
+ * messages name. Both parts are optional (`null` or missing means none).
+ * Item keys must be {@link Key}s, at most `HUB_MAX_BUNDLE_ITEMS` of them,
+ * each with a quantity from 1 to `HUB_MAX_ITEM_QTY`; coins run from 0 to
+ * `HUB_MAX_ITEM_QTY`. The hub checks those limits and the keys itself.
+ */
+export function bundleInput(label: string) {
+  return z.object({
+    /** 0 to `HUB_MAX_ITEM_QTY`. */
+    coins: BundleQuantity.nullish(),
+    /** Item key to quantity (1 to `HUB_MAX_ITEM_QTY`). */
+    items: z.record(z.string(), BundleQuantity, { error: `${label}.items must be an object of key→quantity.` }).nullish(),
+  }, { error: `${label} must be an object.` });
+}
+
+/** A request bundle, for documentation and clients. */
+export const BundleInput = bundleInput('bundle');
+
+/** A request bundle. */
+export type BundleInput = z.infer<typeof BundleInput>;
+
+/** A bundle as the hub stores and returns it on a trade offer: both parts always present. */
+export const Bundle = z.object({
+  items: z.record(Key, z.number().int().positive()),
+  coins: z.number().int().nonnegative(),
+});
+
+/** A stored bundle. */
+export type Bundle = z.infer<typeof Bundle>;

package/src/api/index.ts

@@ -1,85 +1,85 @@
-/**
- * The public REST API: every endpoint a game, the menu or the social runtime
- * calls, as one ayepi spec. Paths are relative to `/_api`. One file per area.
- */
-import { spec } from '@ayepi/core';
-import { analyticsEndpoints } from './analytics';
-import { authEndpoints } from './auth';
-import { catalogEndpoints } from './catalog';
-import { dailyEndpoints } from './daily';
-import { economyEndpoints } from './economy';
-import { leaderboardsEndpoints } from './leaderboards';
-import { messagesEndpoints } from './messages';
-import { mpEndpoints } from './mp';
-import { notifyEndpoints } from './notify';
-import { progressEndpoints } from './progress';
-import { raceEndpoints } from './race';
-import { reportsEndpoints } from './reports';
-import { socialEndpoints } from './social';
-import { versionEndpoints } from './version';
-
-// Every area's shapes (request, response and entity schemas), for clients and tests.
-export * from './analytics';
-export * from './auth';
-export * from './catalog';
-export * from './daily';
-export * from './economy';
-export * from './leaderboards';
-export * from './messages';
-export * from './mp';
-export * from './notify';
-export * from './progress';
-export * from './race';
-export * from './reports';
-export * from './social';
-export * from './version';
-
-/**
- * Every public endpoint, by name. Typed as an intersection of the areas so the
- * published .d.ts refers to each area instead of repeating every endpoint.
- */
-export type PublicEndpoints =
-  typeof authEndpoints
-  & typeof catalogEndpoints
-  & typeof progressEndpoints
-  & typeof leaderboardsEndpoints
-  & typeof dailyEndpoints
-  & typeof economyEndpoints
-  & typeof analyticsEndpoints
-  & typeof socialEndpoints
-  & typeof messagesEndpoints
-  & typeof notifyEndpoints
-  & typeof reportsEndpoints
-  & typeof mpEndpoints
-  & typeof raceEndpoints
-  & typeof versionEndpoints;
-
-/** Every public endpoint, by name. */
-export const publicEndpoints: PublicEndpoints = {
-  ...authEndpoints,
-  ...catalogEndpoints,
-  ...progressEndpoints,
-  ...leaderboardsEndpoints,
-  ...dailyEndpoints,
-  ...economyEndpoints,
-  ...analyticsEndpoints,
-  ...socialEndpoints,
-  ...messagesEndpoints,
-  ...notifyEndpoints,
-  ...reportsEndpoints,
-  ...mpEndpoints,
-  ...raceEndpoints,
-  ...versionEndpoints,
-};
-
-/**
- * The public API spec's type. Declared (not inferred) so the published
- * `.d.ts` refers to `publicEndpoints` instead of repeating every endpoint.
- */
-export interface PublicApi {
-  /** Every public endpoint, by name. */
-  readonly endpoints: PublicEndpoints;
-}
-
-/** The public API spec (paths relative to `/_api`). */
-export const publicApi: PublicApi = spec({ endpoints: publicEndpoints });
+/**
+ * The public REST API: every endpoint a game, the menu or the social runtime
+ * calls, as one ayepi spec. Paths are relative to `/_api`. One file per area.
+ */
+import { spec } from '@ayepi/core';
+import { analyticsEndpoints } from './analytics';
+import { authEndpoints } from './auth';
+import { catalogEndpoints } from './catalog';
+import { dailyEndpoints } from './daily';
+import { economyEndpoints } from './economy';
+import { leaderboardsEndpoints } from './leaderboards';
+import { messagesEndpoints } from './messages';
+import { mpEndpoints } from './mp';
+import { notifyEndpoints } from './notify';
+import { progressEndpoints } from './progress';
+import { raceEndpoints } from './race';
+import { reportsEndpoints } from './reports';
+import { socialEndpoints } from './social';
+import { versionEndpoints } from './version';
+
+// Every area's shapes (request, response and entity schemas), for clients and tests.
+export * from './analytics';
+export * from './auth';
+export * from './catalog';
+export * from './daily';
+export * from './economy';
+export * from './leaderboards';
+export * from './messages';
+export * from './mp';
+export * from './notify';
+export * from './progress';
+export * from './race';
+export * from './reports';
+export * from './social';
+export * from './version';
+
+/**
+ * Every public endpoint, by name. Typed as an intersection of the areas so the
+ * published .d.ts refers to each area instead of repeating every endpoint.
+ */
+export type PublicEndpoints =
+  typeof authEndpoints
+  & typeof catalogEndpoints
+  & typeof progressEndpoints
+  & typeof leaderboardsEndpoints
+  & typeof dailyEndpoints
+  & typeof economyEndpoints
+  & typeof analyticsEndpoints
+  & typeof socialEndpoints
+  & typeof messagesEndpoints
+  & typeof notifyEndpoints
+  & typeof reportsEndpoints
+  & typeof mpEndpoints
+  & typeof raceEndpoints
+  & typeof versionEndpoints;
+
+/** Every public endpoint, by name. */
+export const publicEndpoints: PublicEndpoints = {
+  ...authEndpoints,
+  ...catalogEndpoints,
+  ...progressEndpoints,
+  ...leaderboardsEndpoints,
+  ...dailyEndpoints,
+  ...economyEndpoints,
+  ...analyticsEndpoints,
+  ...socialEndpoints,
+  ...messagesEndpoints,
+  ...notifyEndpoints,
+  ...reportsEndpoints,
+  ...mpEndpoints,
+  ...raceEndpoints,
+  ...versionEndpoints,
+};
+
+/**
+ * The public API spec's type. Declared (not inferred) so the published
+ * `.d.ts` refers to `publicEndpoints` instead of repeating every endpoint.
+ */
+export interface PublicApi {
+  /** Every public endpoint, by name. */
+  readonly endpoints: PublicEndpoints;
+}
+
+/** The public API spec (paths relative to `/_api`). */
+export const publicApi: PublicApi = spec({ endpoints: publicEndpoints });

package/src/api/leaderboards.ts

@@ -1,151 +1,151 @@
-/**
- * Leaderboards: score submission, boards and standings. A board belongs to a
- * game and is keyed by an app-chosen {@link Key}; it keeps each player's best
- * score only (highest for `desc` boards, lowest for `asc`).
- */
-import { use } from '@ayepi/core';
-import { z } from 'zod';
-import { Json, Key, Slug, UserId } from '../common';
-import { ErrorBody } from '../errors';
-import { game, requireUser, session } from '../middleware';
-import { RowCount, Truthy } from '../coerce';
-
-/** A board key in a path, with the old hub's message when it is malformed. */
-const BoardKeyParams = z.object({
-  key: z.string().refine((key) => Key.safeParse(key).success, { error: 'board key must match /^[A-Za-z0-9_.:-]{1,64}$/ (1–64 chars).' }),
-});
-
-/**
- * A row count the hub reads like `Number(x) || default`: anything that is not
- * an integer falls back to the default instead of failing.
- */
-const LenientRowCount = RowCount.optional().catch(undefined);
-
-/** A board's sort direction: `desc` ranks high scores first, `asc` low scores (times) first. */
-export const SortDir = z.enum(['asc', 'desc']);
-
-/** A board's sort direction. */
-export type SortDir = z.infer<typeof SortDir>;
-
-/** A 1-based rank on a board. */
-export const Rank = z.number().int().positive();
-
-/** A leaderboard's identity, without entries. */
-export const Board = z.object({
-  key: Key,
-  /** Set by the first submitter or the game's `package.json`; defaults to the key. */
-  title: z.string(),
-  sortDir: SortDir,
-});
-
-/** A leaderboard's identity. */
-export type Board = z.infer<typeof Board>;
-
-/**
- * One ranked row of a board. Suspended players and (unless the board opts
- * in) zero scores are left out.
- */
-export const LeaderboardEntry = z.object({
-  rank: Rank,
-  userId: UserId,
-  username: z.string(),
-  score: z.number(),
-  /** The JSON the game stored with the score, or `null`. */
-  meta: Json,
-});
-
-/** A ranked board row. */
-export type LeaderboardEntry = z.infer<typeof LeaderboardEntry>;
-
-/** Every board of one game, each with its top entries (`GET /leaderboards`, the snapshot). */
-export const GameLeaderboards = z.object({
-  slug: Slug,
-  /** The game's title (the slug when the game is no longer listed). */
-  title: z.string(),
-  boards: z.array(Board.extend({ top: z.array(LeaderboardEntry) })),
-});
-
-/** One game's boards with their top entries. */
-export type GameLeaderboards = z.infer<typeof GameLeaderboards>;
-
-/**
- * The player's own standings in one game (`GET /me/records`, the snapshot):
- * their score and rank on each board they have an entry on.
- */
-export const GameRecords = z.object({
-  slug: Slug,
-  /** The game's title (the slug when the game is no longer listed). */
-  title: z.string(),
-  records: z.array(Board.extend({ score: z.number(), rank: Rank })),
-});
-
-/** The player's standings in one game. */
-export type GameRecords = z.infer<typeof GameRecords>;
-
-/**
- * `?top=` for the cross-game views (`GET /leaderboards`, `GET /me/snapshot`):
- * entries per board, 1 to 50 (clamped), default 5.
- */
-export const TopQuery = z.object({ top: LenientRowCount });
-
-/** The leaderboards endpoints. */
-export const leaderboardsEndpoints = {
-  ...session.group({
-    /** Every board of every game, grouped by game, each with its top entries. */
-    listTopOfEveryLeaderboard: {
-      method: 'GET', path: '/leaderboards', query: TopQuery,
-      response: z.object({ games: z.array(GameLeaderboards) }),
-      doc: { summary: 'Every board across every game, with top entries', tags: ['leaderboards'] },
-    },
-  }),
-  ...use(session, game).path('/games/:slug').group({
-    listGameLeaderboards: {
-      method: 'GET', path: '/leaderboards',
-      response: z.object({ boards: z.array(Board) }),
-      errors: { 404: ErrorBody },
-      doc: { summary: "The game's boards (no entries)", tags: ['leaderboards'] },
-    },
-    getLeaderboard: {
-      method: 'GET', path: '/leaderboards/:key',
-      params: BoardKeyParams,
-      /** `limit`: rows to return, 1 to 500 (clamped), default 50. */
-      query: z.object({ limit: LenientRowCount }),
-      response: z.object({ board: Board, entries: z.array(LeaderboardEntry) }),
-      errors: { 400: ErrorBody, 404: ErrorBody },
-      doc: { summary: "One board's ranked entries (404 if the board doesn't exist)", tags: ['leaderboards'] },
-    },
-  }),
-  ...use(requireUser, game).path('/games/:slug').group({
-    /**
-     * Submit a score. The first submission creates the board (with `title`,
-     * `sort` and `showZeros`; later values are ignored). Only an improvement
-     * replaces the player's entry. Boards a game declares with
-     * `source: "server"` refuse client scores (403 `server_board`).
-     */
-    submitScore: {
-      method: 'POST', path: '/leaderboards/:key/scores',
-      params: BoardKeyParams,
-      body: z.object({
-        /** A finite number (numeric strings pass, as for the old hub's `Number(x)`). */
-        score: z.coerce.number<number>({ error: 'score must be a finite number.' }),
-        /** Board title, used only when this call creates the board (non-text is ignored). */
-        title: z.string().optional().catch(undefined),
-        /** Sort direction, used only on creation. Anything but `asc` means `desc`. */
-        sort: SortDir.optional().catch(undefined),
-        /** Keep zero scores visible, used only on creation. */
-        showZeros: Truthy.optional(),
-        /** Any JSON stored with the entry (a character, a run seed). */
-        meta: Json.optional(),
-      }),
-      response: z.object({
-        board: Board,
-        /** The player's stored best after this submission. */
-        best: z.number().nullable(),
-        /** The player's rank on the board (`null` if they have no entry). */
-        rank: Rank.nullable(),
-      }),
-      errors: { 400: ErrorBody, 401: ErrorBody, 403: ErrorBody, 404: ErrorBody },
-      doc: { summary: 'Submit a score (best-only; creates the board on first use)', tags: ['leaderboards'] },
-    },
-  }),
-};
+/**
+ * Leaderboards: score submission, boards and standings. A board belongs to a
+ * game and is keyed by an app-chosen {@link Key}; it keeps each player's best
+ * score only (highest for `desc` boards, lowest for `asc`).
+ */
+import { use } from '@ayepi/core';
+import { z } from 'zod';
+import { Json, Key, Slug, UserId } from '../common';
+import { ErrorBody } from '../errors';
+import { game, requireUser, session } from '../middleware';
+import { RowCount, Truthy } from '../coerce';
+
+/** A board key in a path, with the old hub's message when it is malformed. */
+const BoardKeyParams = z.object({
+  key: z.string().refine((key) => Key.safeParse(key).success, { error: 'board key must match /^[A-Za-z0-9_.:-]{1,64}$/ (1–64 chars).' }),
+});
+
+/**
+ * A row count the hub reads like `Number(x) || default`: anything that is not
+ * an integer falls back to the default instead of failing.
+ */
+const LenientRowCount = RowCount.optional().catch(undefined);
+
+/** A board's sort direction: `desc` ranks high scores first, `asc` low scores (times) first. */
+export const SortDir = z.enum(['asc', 'desc']);
+
+/** A board's sort direction. */
+export type SortDir = z.infer<typeof SortDir>;
+
+/** A 1-based rank on a board. */
+export const Rank = z.number().int().positive();
+
+/** A leaderboard's identity, without entries. */
+export const Board = z.object({
+  key: Key,
+  /** Set by the first submitter or the game's `package.json`; defaults to the key. */
+  title: z.string(),
+  sortDir: SortDir,
+});
+
+/** A leaderboard's identity. */
+export type Board = z.infer<typeof Board>;
+
+/**
+ * One ranked row of a board. Suspended players and (unless the board opts
+ * in) zero scores are left out.
+ */
+export const LeaderboardEntry = z.object({
+  rank: Rank,
+  userId: UserId,
+  username: z.string(),
+  score: z.number(),
+  /** The JSON the game stored with the score, or `null`. */
+  meta: Json,
+});
+
+/** A ranked board row. */
+export type LeaderboardEntry = z.infer<typeof LeaderboardEntry>;
+
+/** Every board of one game, each with its top entries (`GET /leaderboards`, the snapshot). */
+export const GameLeaderboards = z.object({
+  slug: Slug,
+  /** The game's title (the slug when the game is no longer listed). */
+  title: z.string(),
+  boards: z.array(Board.extend({ top: z.array(LeaderboardEntry) })),
+});
+
+/** One game's boards with their top entries. */
+export type GameLeaderboards = z.infer<typeof GameLeaderboards>;
+
+/**
+ * The player's own standings in one game (`GET /me/records`, the snapshot):
+ * their score and rank on each board they have an entry on.
+ */
+export const GameRecords = z.object({
+  slug: Slug,
+  /** The game's title (the slug when the game is no longer listed). */
+  title: z.string(),
+  records: z.array(Board.extend({ score: z.number(), rank: Rank })),
+});
+
+/** The player's standings in one game. */
+export type GameRecords = z.infer<typeof GameRecords>;
+
+/**
+ * `?top=` for the cross-game views (`GET /leaderboards`, `GET /me/snapshot`):
+ * entries per board, 1 to 50 (clamped), default 5.
+ */
+export const TopQuery = z.object({ top: LenientRowCount });
+
+/** The leaderboards endpoints. */
+export const leaderboardsEndpoints = {
+  ...session.group({
+    /** Every board of every game, grouped by game, each with its top entries. */
+    listTopOfEveryLeaderboard: {
+      method: 'GET', path: '/leaderboards', query: TopQuery,
+      response: z.object({ games: z.array(GameLeaderboards) }),
+      doc: { summary: 'Every board across every game, with top entries', tags: ['leaderboards'] },
+    },
+  }),
+  ...use(session, game).path('/games/:slug').group({
+    listGameLeaderboards: {
+      method: 'GET', path: '/leaderboards',
+      response: z.object({ boards: z.array(Board) }),
+      errors: { 404: ErrorBody },
+      doc: { summary: "The game's boards (no entries)", tags: ['leaderboards'] },
+    },
+    getLeaderboard: {
+      method: 'GET', path: '/leaderboards/:key',
+      params: BoardKeyParams,
+      /** `limit`: rows to return, 1 to 500 (clamped), default 50. */
+      query: z.object({ limit: LenientRowCount }),
+      response: z.object({ board: Board, entries: z.array(LeaderboardEntry) }),
+      errors: { 400: ErrorBody, 404: ErrorBody },
+      doc: { summary: "One board's ranked entries (404 if the board doesn't exist)", tags: ['leaderboards'] },
+    },
+  }),
+  ...use(requireUser, game).path('/games/:slug').group({
+    /**
+     * Submit a score. The first submission creates the board (with `title`,
+     * `sort` and `showZeros`; later values are ignored). Only an improvement
+     * replaces the player's entry. Boards a game declares with
+     * `source: "server"` refuse client scores (403 `server_board`).
+     */
+    submitScore: {
+      method: 'POST', path: '/leaderboards/:key/scores',
+      params: BoardKeyParams,
+      body: z.object({
+        /** A finite number (numeric strings pass, as for the old hub's `Number(x)`). */
+        score: z.coerce.number<number>({ error: 'score must be a finite number.' }),
+        /** Board title, used only when this call creates the board (non-text is ignored). */
+        title: z.string().optional().catch(undefined),
+        /** Sort direction, used only on creation. Anything but `asc` means `desc`. */
+        sort: SortDir.optional().catch(undefined),
+        /** Keep zero scores visible, used only on creation. */
+        showZeros: Truthy.optional(),
+        /** Any JSON stored with the entry (a character, a run seed). */
+        meta: Json.optional(),
+      }),
+      response: z.object({
+        board: Board,
+        /** The player's stored best after this submission. */
+        best: z.number().nullable(),
+        /** The player's rank on the board (`null` if they have no entry). */
+        rank: Rank.nullable(),
+      }),
+      errors: { 400: ErrorBody, 401: ErrorBody, 403: ErrorBody, 404: ErrorBody },
+      doc: { summary: 'Submit a score (best-only; creates the board on first use)', tags: ['leaderboards'] },
+    },
+  }),
+};