xpt-shared-types 1.7.0 → 1.9.0

package/dist/generated/inputs.d.ts

@@ -23,12 +23,14 @@ export interface FaqInput {
 export interface FeaturedGameInput {
     featuredHeading?: string;
     featuredSubheading?: string;
+    isActive?: boolean;
     game?: RelationInput;
 }
 /** Write payload for `featured-tournament`. */
 export interface FeaturedTournamentInput {
     featuredHeading?: string;
     featuredSubheading?: string;
+    isActive?: boolean;
     tournament?: RelationInput;
 }
 /** Write payload for `friendship`. */
@@ -136,6 +138,8 @@ export interface MatchInput {
     endedAt?: string;
     resultType?: MatchResultType;
     resultNote?: string;
+    homeReportedAt?: string;
+    awayReportedAt?: string;
     disputeReason?: MatchDisputeReason;
     disputeNote?: string;
     disputedBy?: RelationInput;

package/dist/generated/models.d.ts

@@ -23,12 +23,14 @@ export interface Faq extends StrapiDocument {
 export interface FeaturedGame extends StrapiDocument {
     featuredHeading?: string | null;
     featuredSubheading?: string | null;
+    isActive?: boolean | null;
     game?: Game | null;
 }
 /** `featured-tournament` */
 export interface FeaturedTournament extends StrapiDocument {
     featuredHeading?: string | null;
     featuredSubheading?: string | null;
+    isActive?: boolean | null;
     tournament?: Tournament | null;
 }
 /** `friendship` */
@@ -136,6 +138,8 @@ export interface Match extends StrapiDocument {
     endedAt?: string | null;
     resultType?: MatchResultType | null;
     resultNote?: string | null;
+    homeReportedAt?: string | null;
+    awayReportedAt?: string | null;
     disputeReason?: MatchDisputeReason | null;
     disputeNote?: string | null;
     disputedBy?: User | null;

package/dist/manual/index.d.ts

@@ -2,3 +2,5 @@
  * Hand-written types that are not derived from a Strapi content type.
  */
 export * from './country';
+export * from './lobby';
+export * from './tournamentEntry';

package/dist/manual/index.js

@@ -18,3 +18,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * Hand-written types that are not derived from a Strapi content type.
  */
 __exportStar(require("./country"), exports);
+__exportStar(require("./lobby"), exports);
+__exportStar(require("./tournamentEntry"), exports);

package/dist/manual/lobby.d.ts

@@ -0,0 +1,39 @@
+/**
+ * The match lobby as the client renders it.
+ *
+ * None of these are Strapi content types. The lobby is a view over a match
+ * row plus what `GET /matches/:id/lobby` derives for the viewer, and these
+ * name the parts of that view both apps have to agree on.
+ */
+import type { MatchDisputeReason, MatchRound } from '../generated/enums';
+/**
+ * Where a lobby is in its life, from the viewer's side. Derived on the client
+ * from `lobbyStatus`, `startedAt`/`endedAt` and whether the viewer's own side
+ * has reported; `disputed` and `completed` come straight from `lobbyStatus`.
+ */
+export type LobbyPhase = 'waiting' | 'live' | 'reported' | 'disputed' | 'completed';
+/**
+ * What the viewer may do in the lobby. A captain (or a solo player) acts for
+ * a side; a roster member only talks; the host and staff watch and rule from
+ * the manage page.
+ */
+export type LobbyViewerRole = 'captain' | 'teamMember' | 'hostOrSpectator';
+/** The match the winner goes on to — enough to say "Round 2 — Match #2". */
+export interface LobbyNextMatch {
+    documentId: string;
+    round: MatchRound | null;
+    matchNumber: number | null;
+}
+/** The reasons a player may send; a score mismatch is found by the server. */
+export type PlayerDisputeReason = Exclude<MatchDisputeReason, 'scoreMismatch'>;
+/** Body of `POST /matches/:id/dispute`, inside `data`. */
+export interface MatchDisputeInput {
+    reason: PlayerDisputeReason;
+    /** Optional, trimmed, at most `DISPUTE_NOTE_MAX_LENGTH` characters. */
+    note?: string;
+}
+export declare const DISPUTE_NOTE_MAX_LENGTH = 500;
+/** Body of `POST /matches/:id/ready`, inside `data`. Omitted means ready. */
+export interface MatchReadyInput {
+    ready?: boolean;
+}

package/dist/manual/lobby.js

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * The match lobby as the client renders it.
+ *
+ * None of these are Strapi content types. The lobby is a view over a match
+ * row plus what `GET /matches/:id/lobby` derives for the viewer, and these
+ * name the parts of that view both apps have to agree on.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DISPUTE_NOTE_MAX_LENGTH = void 0;
+exports.DISPUTE_NOTE_MAX_LENGTH = 500;

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.7.0",
+  "version": "1.9.0",
   "description": "Shared types and data for XPT projects",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/generated/inputs.ts

@@ -62,6 +62,7 @@ export interface FaqInput {
 export interface FeaturedGameInput {
   featuredHeading?: string;
   featuredSubheading?: string;
+  isActive?: boolean;
   game?: RelationInput;
 }
 
@@ -69,6 +70,7 @@ export interface FeaturedGameInput {
 export interface FeaturedTournamentInput {
   featuredHeading?: string;
   featuredSubheading?: string;
+  isActive?: boolean;
   tournament?: RelationInput;
 }
 
@@ -184,6 +186,8 @@ export interface MatchInput {
   endedAt?: string;
   resultType?: MatchResultType;
   resultNote?: string;
+  homeReportedAt?: string;
+  awayReportedAt?: string;
   disputeReason?: MatchDisputeReason;
   disputeNote?: string;
   disputedBy?: RelationInput;

package/src/generated/models.ts

@@ -63,6 +63,7 @@ export interface Faq extends StrapiDocument {
 export interface FeaturedGame extends StrapiDocument {
   featuredHeading?: string | null;
   featuredSubheading?: string | null;
+  isActive?: boolean | null;
   game?: Game | null;
 }
 
@@ -70,6 +71,7 @@ export interface FeaturedGame extends StrapiDocument {
 export interface FeaturedTournament extends StrapiDocument {
   featuredHeading?: string | null;
   featuredSubheading?: string | null;
+  isActive?: boolean | null;
   tournament?: Tournament | null;
 }
 
@@ -185,6 +187,8 @@ export interface Match extends StrapiDocument {
   endedAt?: string | null;
   resultType?: MatchResultType | null;
   resultNote?: string | null;
+  homeReportedAt?: string | null;
+  awayReportedAt?: string | null;
   disputeReason?: MatchDisputeReason | null;
   disputeNote?: string | null;
   disputedBy?: User | null;

package/src/manual/index.ts

@@ -2,3 +2,5 @@
  * Hand-written types that are not derived from a Strapi content type.
  */
 export * from './country';
+export * from './lobby';
+export * from './tournamentEntry';

package/src/manual/lobby.ts

@@ -0,0 +1,52 @@
+/**
+ * The match lobby as the client renders it.
+ *
+ * None of these are Strapi content types. The lobby is a view over a match
+ * row plus what `GET /matches/:id/lobby` derives for the viewer, and these
+ * name the parts of that view both apps have to agree on.
+ */
+
+import type { MatchDisputeReason, MatchRound } from '../generated/enums';
+
+/**
+ * Where a lobby is in its life, from the viewer's side. Derived on the client
+ * from `lobbyStatus`, `startedAt`/`endedAt` and whether the viewer's own side
+ * has reported; `disputed` and `completed` come straight from `lobbyStatus`.
+ */
+export type LobbyPhase =
+  | 'waiting'
+  | 'live'
+  | 'reported'
+  | 'disputed'
+  | 'completed';
+
+/**
+ * What the viewer may do in the lobby. A captain (or a solo player) acts for
+ * a side; a roster member only talks; the host and staff watch and rule from
+ * the manage page.
+ */
+export type LobbyViewerRole = 'captain' | 'teamMember' | 'hostOrSpectator';
+
+/** The match the winner goes on to — enough to say "Round 2 — Match #2". */
+export interface LobbyNextMatch {
+  documentId: string;
+  round: MatchRound | null;
+  matchNumber: number | null;
+}
+
+/** The reasons a player may send; a score mismatch is found by the server. */
+export type PlayerDisputeReason = Exclude<MatchDisputeReason, 'scoreMismatch'>;
+
+/** Body of `POST /matches/:id/dispute`, inside `data`. */
+export interface MatchDisputeInput {
+  reason: PlayerDisputeReason;
+  /** Optional, trimmed, at most `DISPUTE_NOTE_MAX_LENGTH` characters. */
+  note?: string;
+}
+
+export const DISPUTE_NOTE_MAX_LENGTH = 500;
+
+/** Body of `POST /matches/:id/ready`, inside `data`. Omitted means ready. */
+export interface MatchReadyInput {
+  ready?: boolean;
+}

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';