xpt-shared-types 1.8.0 → 1.9.0

package/dist/manual/index.d.ts

@@ -3,3 +3,4 @@
  */
 export * from './country';
 export * from './lobby';
+export * from './tournamentEntry';

package/dist/manual/index.js

@@ -19,3 +19,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
  */
 __exportStar(require("./country"), exports);
 __exportStar(require("./lobby"), exports);
+__exportStar(require("./tournamentEntry"), exports);

package/dist/manual/tournamentEntry.d.ts

@@ -0,0 +1,36 @@
+/**
+ * A tournament entry after registration — withdrawing it and changing its
+ * roster.
+ *
+ * Neither is a Strapi content type. An entry is a `tournament-participant`
+ * row; these name the window in which its registrant may still act on it and
+ * the bodies of the endpoints that do so, so the backend guards and the
+ * client's buttons agree on both.
+ */
+/**
+ * Statuses in which an entry can still be withdrawn or have its roster
+ * changed. Everything before is unpublished; everything after has a bracket
+ * that reads the entry, so the entry is frozen.
+ */
+export declare const ENTRY_EDITABLE_STATUSES: readonly ["open", "checkIn"];
+export type EntryEditableStatus = (typeof ENTRY_EDITABLE_STATUSES)[number];
+/** True when `status` still lets an entry be withdrawn or re-rostered. */
+export declare function isEntryEditable(status: string | null | undefined): status is EntryEditableStatus;
+/**
+ * Body of `PUT /tournaments/:id/entry/roster`. Flat, like `/join`, not inside
+ * `data`. The full new roster, not a diff — the server works out who was
+ * added and who was removed.
+ */
+export interface TournamentRosterUpdateInput {
+    selectedMemberIds: number[];
+}
+/** Body of `POST /tournaments/:id/join` for a team entry. Flat, like above. */
+export interface TournamentTeamJoinInput {
+    teamId: string;
+    selectedMemberIds: number[];
+}
+/**
+ * `error.details.name` values the entry endpoints raise that a client is
+ * expected to branch on. Anything else is a plain message.
+ */
+export type TournamentEntryErrorName = 'NotEntryLeader' | 'MembersMissingGameAccount' | 'InsufficientCoins' | 'GameAccountRequired' | 'TeamEntryRequired';

package/dist/manual/tournamentEntry.js

@@ -0,0 +1,23 @@
+"use strict";
+/**
+ * A tournament entry after registration — withdrawing it and changing its
+ * roster.
+ *
+ * Neither is a Strapi content type. An entry is a `tournament-participant`
+ * row; these name the window in which its registrant may still act on it and
+ * the bodies of the endpoints that do so, so the backend guards and the
+ * client's buttons agree on both.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ENTRY_EDITABLE_STATUSES = void 0;
+exports.isEntryEditable = isEntryEditable;
+/**
+ * Statuses in which an entry can still be withdrawn or have its roster
+ * changed. Everything before is unpublished; everything after has a bracket
+ * that reads the entry, so the entry is frozen.
+ */
+exports.ENTRY_EDITABLE_STATUSES = ['open', 'checkIn'];
+/** True when `status` still lets an entry be withdrawn or re-rostered. */
+function isEntryEditable(status) {
+    return exports.ENTRY_EDITABLE_STATUSES.includes(status !== null && status !== void 0 ? status : '');
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xpt-shared-types",
-  "version": "1.8.0",
+  "version": "1.9.0",
   "description": "Shared types and data for XPT projects",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/manual/index.ts

@@ -3,3 +3,4 @@
  */
 export * from './country';
 export * from './lobby';
+export * from './tournamentEntry';

package/src/manual/tournamentEntry.ts

@@ -0,0 +1,54 @@
+/**
+ * A tournament entry after registration — withdrawing it and changing its
+ * roster.
+ *
+ * Neither is a Strapi content type. An entry is a `tournament-participant`
+ * row; these name the window in which its registrant may still act on it and
+ * the bodies of the endpoints that do so, so the backend guards and the
+ * client's buttons agree on both.
+ */
+
+import type { TournamentCurrentStatus } from '../generated/enums';
+
+/**
+ * Statuses in which an entry can still be withdrawn or have its roster
+ * changed. Everything before is unpublished; everything after has a bracket
+ * that reads the entry, so the entry is frozen.
+ */
+export const ENTRY_EDITABLE_STATUSES = ['open', 'checkIn'] as const satisfies
+  readonly TournamentCurrentStatus[];
+
+export type EntryEditableStatus = (typeof ENTRY_EDITABLE_STATUSES)[number];
+
+/** True when `status` still lets an entry be withdrawn or re-rostered. */
+export function isEntryEditable(
+  status: string | null | undefined
+): status is EntryEditableStatus {
+  return (ENTRY_EDITABLE_STATUSES as readonly string[]).includes(status ?? '');
+}
+
+/**
+ * Body of `PUT /tournaments/:id/entry/roster`. Flat, like `/join`, not inside
+ * `data`. The full new roster, not a diff — the server works out who was
+ * added and who was removed.
+ */
+export interface TournamentRosterUpdateInput {
+  selectedMemberIds: number[];
+}
+
+/** Body of `POST /tournaments/:id/join` for a team entry. Flat, like above. */
+export interface TournamentTeamJoinInput {
+  teamId: string;
+  selectedMemberIds: number[];
+}
+
+/**
+ * `error.details.name` values the entry endpoints raise that a client is
+ * expected to branch on. Anything else is a plain message.
+ */
+export type TournamentEntryErrorName =
+  | 'NotEntryLeader'
+  | 'MembersMissingGameAccount'
+  | 'InsufficientCoins'
+  | 'GameAccountRequired'
+  | 'TeamEntryRequired';