xpt-shared-types 1.18.0 → 1.20.0

package/README.md

@@ -117,6 +117,13 @@ using npm trusted publishing, so no npm token or 2FA prompt is involved.
 2. `yarn version --patch` (or `--minor`), which commits and tags `vX.Y.Z`
 3. `git push --follow-tags`
 
+If the version was bumped by hand instead, commit it and tag with
+`git tag -a vX.Y.Z -m vX.Y.Z` before pushing: `--follow-tags` only sends
+annotated tags, so a plain `git tag vX.Y.Z` (or no tag at all) pushes nothing
+and prints "Everything up-to-date". `git push origin vX.Y.Z` also works.
+After the run succeeds the registry can lag a minute or two; confirm with
+`npm view xpt-shared-types dist-tags.latest` before installing.
+
 The workflow fires on the `v*` tag, refuses to run if the tag and
 `package.json` version disagree, then builds and publishes.
 

package/dist/generated/enums.d.ts

@@ -7,7 +7,7 @@ export type FriendshipStatus = "pending" | "accepted";
 /** `GameAccount.code` */
 export type GameAccountCode = "steam" | "psn" | "xbox" | "battlenet" | "riot" | "epic" | "ea" | "activision" | "ubisoft" | "nintendo" | "fightcade" | "apple" | "googleplay";
 /** `GameAccount.verification` */
-export type GameAccountVerification = "none" | "format";
+export type GameAccountVerification = "none" | "format" | "linked";
 /** `Game.genre` */
 export type GameGenre = "FPS" | "MOBA" | "Battle Royale" | "Fighting (FGC)" | "Sports" | "Strategy/RTS" | "Sim Racing" | "Card Game" | "Retro" | "Other";
 /** `GameRequest.customLobbies` */
@@ -66,6 +66,8 @@ export type TournamentTeamSize = "one" | "two" | "three" | "four" | "five";
 export type TournamentType = "Single Elimination" | "League" | "Double Elimination";
 /** `Tournament.visibility` */
 export type TournamentVisibility = "public" | "unlisted";
+/** `UserGameAccount.verificationMethod` */
+export type UserGameAccountVerificationMethod = "linked";
 /** `UserTransaction.stripeStatus` */
 export type UserTransactionStripeStatus = "pending" | "completed" | "failed" | "refunded" | "internal";
 /** `UserTransaction.type` */

package/dist/generated/inputs.d.ts

@@ -1,5 +1,5 @@
 import type { BlocksContent, MediaInput, RelationInput } from '../contracts';
-import type { AdminActionTargetType, FaqCategory, FriendshipStatus, GameAccountCode, GameAccountVerification, GameGenre, GameRequestCustomLobbies, GameRequestGenre, GameRequestTeamPlay, GameVisibility, MatchDisputeReason, MatchLobbyStatus, MatchResultType, MatchRound, MatchStreamPlatform, MatchWinnerSlot, PlatformCode, PlayerBanScope, ReferralStatus, TeamCurrentStatus, TeamInviteStatus, TeamInviteTeamRole, TeamPlayerTeamRole, TournamentAccess, TournamentCurrentStatus, TournamentInviteStatus, TournamentJoinRequestEntryType, TournamentJoinRequestStatus, TournamentParticipantEntryType, TournamentParticipantStatus, TournamentRoleRole, TournamentTeamSize, TournamentType, TournamentVisibility, UserTransactionStripeStatus, UserTransactionType } from './enums';
+import type { AdminActionTargetType, FaqCategory, FriendshipStatus, GameAccountCode, GameAccountVerification, GameGenre, GameRequestCustomLobbies, GameRequestGenre, GameRequestTeamPlay, GameVisibility, MatchDisputeReason, MatchLobbyStatus, MatchResultType, MatchRound, MatchStreamPlatform, MatchWinnerSlot, PlatformCode, PlayerBanScope, ReferralStatus, TeamCurrentStatus, TeamInviteStatus, TeamInviteTeamRole, TeamPlayerTeamRole, TournamentAccess, TournamentCurrentStatus, TournamentInviteStatus, TournamentJoinRequestEntryType, TournamentJoinRequestStatus, TournamentParticipantEntryType, TournamentParticipantStatus, TournamentRoleRole, TournamentTeamSize, TournamentType, TournamentVisibility, UserGameAccountVerificationMethod, UserTransactionStripeStatus, UserTransactionType } from './enums';
 /** Write payload for `about`. */
 export interface AboutInput {
     heroTitle?: string;
@@ -83,6 +83,14 @@ export interface GameAccountInput {
     games?: RelationInput | RelationInput[];
     platforms?: RelationInput | RelationInput[];
 }
+/** Write payload for `game-account-link`. */
+export interface GameAccountLinkInput {
+    token?: string;
+    users_permissions_user?: RelationInput;
+    game_account?: RelationInput;
+    expiresAt?: string;
+    returnTo?: string;
+}
 /** Write payload for `game-request`. */
 export interface GameRequestInput {
     gameTitle?: string;
@@ -328,6 +336,7 @@ export interface TournamentInput {
     rules?: string;
     hasThirdPlace?: boolean;
     hasMatchLobby?: boolean;
+    requireVerifiedAccounts?: boolean;
     visibility?: TournamentVisibility;
     access?: TournamentAccess;
     checkInTime?: number;
@@ -427,6 +436,9 @@ export interface UserInput {
 export interface UserGameAccountInput {
     accountId?: string;
     isPrivate?: boolean;
+    verifiedAt?: string;
+    verificationMethod?: UserGameAccountVerificationMethod;
+    providerAccountId?: string;
     users_permissions_user?: RelationInput;
     game_account?: RelationInput;
 }

package/dist/generated/models.d.ts

@@ -1,5 +1,5 @@
 import type { BlocksContent, StrapiDocument, StrapiMedia, UserRole } from '../contracts';
-import type { AdminActionTargetType, FaqCategory, FriendshipStatus, GameAccountCode, GameAccountVerification, GameGenre, GameRequestCustomLobbies, GameRequestGenre, GameRequestTeamPlay, GameVisibility, MatchDisputeReason, MatchLobbyStatus, MatchResultType, MatchRound, MatchStreamPlatform, MatchWinnerSlot, PlatformCode, PlayerBanScope, ReferralStatus, TeamCurrentStatus, TeamInviteStatus, TeamInviteTeamRole, TeamPlayerTeamRole, TournamentAccess, TournamentCurrentStatus, TournamentInviteStatus, TournamentJoinRequestEntryType, TournamentJoinRequestStatus, TournamentParticipantEntryType, TournamentParticipantStatus, TournamentRoleRole, TournamentTeamSize, TournamentType, TournamentVisibility, UserTransactionStripeStatus, UserTransactionType } from './enums';
+import type { AdminActionTargetType, FaqCategory, FriendshipStatus, GameAccountCode, GameAccountVerification, GameGenre, GameRequestCustomLobbies, GameRequestGenre, GameRequestTeamPlay, GameVisibility, MatchDisputeReason, MatchLobbyStatus, MatchResultType, MatchRound, MatchStreamPlatform, MatchWinnerSlot, PlatformCode, PlayerBanScope, ReferralStatus, TeamCurrentStatus, TeamInviteStatus, TeamInviteTeamRole, TeamPlayerTeamRole, TournamentAccess, TournamentCurrentStatus, TournamentInviteStatus, TournamentJoinRequestEntryType, TournamentJoinRequestStatus, TournamentParticipantEntryType, TournamentParticipantStatus, TournamentRoleRole, TournamentTeamSize, TournamentType, TournamentVisibility, UserGameAccountVerificationMethod, UserTransactionStripeStatus, UserTransactionType } from './enums';
 /** `about` */
 export interface About extends StrapiDocument {
     heroTitle?: string | null;
@@ -83,6 +83,14 @@ export interface GameAccount extends StrapiDocument {
     games?: Game[];
     platforms?: Platform[];
 }
+/** `game-account-link` */
+export interface GameAccountLink extends StrapiDocument {
+    token?: string | null;
+    users_permissions_user?: User | null;
+    game_account?: GameAccount | null;
+    expiresAt?: string | null;
+    returnTo?: string | null;
+}
 /** `game-request` */
 export interface GameRequest extends StrapiDocument {
     gameTitle?: string | null;
@@ -328,6 +336,7 @@ export interface Tournament extends StrapiDocument {
     rules?: string | null;
     hasThirdPlace?: boolean | null;
     hasMatchLobby?: boolean | null;
+    requireVerifiedAccounts?: boolean | null;
     visibility?: TournamentVisibility | null;
     access?: TournamentAccess | null;
     checkInTime?: number | null;
@@ -427,6 +436,9 @@ export interface User extends StrapiDocument {
 export interface UserGameAccount extends StrapiDocument {
     accountId?: string | null;
     isPrivate?: boolean | null;
+    verifiedAt?: string | null;
+    verificationMethod?: UserGameAccountVerificationMethod | null;
+    providerAccountId?: string | null;
     users_permissions_user?: User | null;
     game_account?: GameAccount | null;
 }

package/dist/manual/gameAccountHandle.d.ts

@@ -51,7 +51,44 @@ export type HandleCheck = {
     message: string;
 };
 /** `error.details.name` values the game-account write endpoints raise. */
-export type GameAccountErrorName = 'HandleInvalid' | 'HandleTaken';
+export type GameAccountErrorName = 'HandleInvalid' | 'HandleTaken'
+/** The row is verified by a link; unlink before changing the ID. */
+ | 'HandleLocked'
+/** No configured link provider for this network. */
+ | 'LinkUnavailable'
+/** The provider account is already linked to another XPT user. */
+ | 'LinkConflict';
+/**
+ * Networks whose handles can be verified by signing in to the network. The
+ * catalogue's `verification: 'linked'` is only valid for these; whether a
+ * provider is actually configured on a given environment is answered at
+ * runtime by `GET /user-game-accounts/link/providers`.
+ */
+export declare const LINK_PROVIDER_CODES: readonly ["steam", "battlenet"];
+export type LinkProviderCode = (typeof LINK_PROVIDER_CODES)[number];
+export declare function isLinkableCode(code: string | null | undefined): code is LinkProviderCode;
+/**
+ * Why a link attempt came back without a verified account — the `linkError`
+ * query value the callback redirects to the settings page with.
+ */
+export type AccountLinkError = 
+/** The attempt was unknown, already used, or older than its window. */
+'expired'
+/** The player cancelled at the provider. */
+ | 'denied'
+/** The provider's answer did not verify. */
+ | 'invalid'
+/** That provider account is already linked to another XPT user. */
+ | 'taken'
+/** The provider is not configured, or the network is not linkable. */
+ | 'unavailable'
+/** Accounts are frozen while the player is in a running tournament. */
+ | 'activeTournament';
+/** True when a row's handle was proved by signing in to the network. */
+export declare function isVerifiedAccount(row: {
+    verifiedAt?: string | Date | null;
+    verificationMethod?: string | null;
+} | null | undefined): boolean;
 /**
  * The rule every network gets when it has no stricter one. Also the backstop
  * the backend applies to every write regardless of network, so every rule
@@ -69,8 +106,9 @@ export declare const GENERIC_HANDLE_RULE: HandleRule;
 export declare const HANDLE_RULES: Partial<Record<GameAccountCode, HandleRule>>;
 /**
  * The rule a network's handles are checked against: its own when the
- * catalogue row asks for format checks and a rule exists for its code,
- * otherwise the generic one.
+ * catalogue row asks for format checks (or is linkable, which implies them
+ * for anything typed by hand) and a rule exists for its code, otherwise the
+ * generic one.
  */
 export declare function handleRuleFor(network: {
     code?: GameAccountCode | string | null;

package/dist/manual/gameAccountHandle.js

@@ -24,11 +24,27 @@
  * `tests/unit/utils/gameAccountHandle.test.ts`).
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.HANDLE_RULES = exports.GENERIC_HANDLE_RULE = void 0;
+exports.HANDLE_RULES = exports.GENERIC_HANDLE_RULE = exports.LINK_PROVIDER_CODES = void 0;
+exports.isLinkableCode = isLinkableCode;
+exports.isVerifiedAccount = isVerifiedAccount;
 exports.handleRuleFor = handleRuleFor;
 exports.hasHandleRule = hasHandleRule;
 exports.checkHandle = checkHandle;
 exports.normalizeHandleKey = normalizeHandleKey;
+/**
+ * Networks whose handles can be verified by signing in to the network. The
+ * catalogue's `verification: 'linked'` is only valid for these; whether a
+ * provider is actually configured on a given environment is answered at
+ * runtime by `GET /user-game-accounts/link/providers`.
+ */
+exports.LINK_PROVIDER_CODES = ['steam', 'battlenet'];
+function isLinkableCode(code) {
+    return exports.LINK_PROVIDER_CODES.includes(code !== null && code !== void 0 ? code : '');
+}
+/** True when a row's handle was proved by signing in to the network. */
+function isVerifiedAccount(row) {
+    return !!(row === null || row === void 0 ? void 0 : row.verifiedAt) && row.verificationMethod === 'linked';
+}
 /**
  * The rule every network gets when it has no stricter one. Also the backstop
  * the backend applies to every write regardless of network, so every rule
@@ -156,12 +172,14 @@ exports.HANDLE_RULES = {
 };
 /**
  * The rule a network's handles are checked against: its own when the
- * catalogue row asks for format checks and a rule exists for its code,
- * otherwise the generic one.
+ * catalogue row asks for format checks (or is linkable, which implies them
+ * for anything typed by hand) and a rule exists for its code, otherwise the
+ * generic one.
  */
 function handleRuleFor(network) {
     var _a;
-    if ((network === null || network === void 0 ? void 0 : network.verification) !== 'format' || !network.code) {
+    const checked = (network === null || network === void 0 ? void 0 : network.verification) === 'format' || (network === null || network === void 0 ? void 0 : network.verification) === 'linked';
+    if (!checked || !(network === null || network === void 0 ? void 0 : network.code)) {
         return exports.GENERIC_HANDLE_RULE;
     }
     return (_a = exports.HANDLE_RULES[network.code]) !== null && _a !== void 0 ? _a : exports.GENERIC_HANDLE_RULE;

package/dist/manual/tournamentEntry.d.ts

@@ -33,4 +33,8 @@ export interface TournamentTeamJoinInput {
  * `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';
+export type TournamentEntryErrorName = 'NotEntryLeader' | 'MembersMissingGameAccount' | 'InsufficientCoins' | 'GameAccountRequired' | 'TeamEntryRequired'
+/** The tournament admits only accounts verified by signing in; yours is typed. */
+ | 'GameAccountUnverified'
+/** Same, for the named players on a team roster. */
+ | 'MembersUnverifiedGameAccount';

package/package.json

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

package/src/generated/enums.ts

@@ -41,7 +41,8 @@ export type GameAccountCode =
 /** `GameAccount.verification` */
 export type GameAccountVerification =
   | "none"
-  | "format";
+  | "format"
+  | "linked";
 
 /** `Game.genre` */
 export type GameGenre =
@@ -254,6 +255,10 @@ export type TournamentVisibility =
   | "public"
   | "unlisted";
 
+/** `UserGameAccount.verificationMethod` */
+export type UserGameAccountVerificationMethod =
+  | "linked";
+
 /** `UserTransaction.stripeStatus` */
 export type UserTransactionStripeStatus =
   | "pending"

package/src/generated/inputs.ts

@@ -42,6 +42,7 @@ import type {
   TournamentTeamSize,
   TournamentType,
   TournamentVisibility,
+  UserGameAccountVerificationMethod,
   UserTransactionStripeStatus,
   UserTransactionType,
 } from './enums';
@@ -138,6 +139,15 @@ export interface GameAccountInput {
   platforms?: RelationInput | RelationInput[];
 }
 
+/** Write payload for `game-account-link`. */
+export interface GameAccountLinkInput {
+  token?: string;
+  users_permissions_user?: RelationInput;
+  game_account?: RelationInput;
+  expiresAt?: string;
+  returnTo?: string;
+}
+
 /** Write payload for `game-request`. */
 export interface GameRequestInput {
   gameTitle?: string;
@@ -406,6 +416,7 @@ export interface TournamentInput {
   rules?: string;
   hasThirdPlace?: boolean;
   hasMatchLobby?: boolean;
+  requireVerifiedAccounts?: boolean;
   visibility?: TournamentVisibility;
   access?: TournamentAccess;
   checkInTime?: number;
@@ -512,6 +523,9 @@ export interface UserInput {
 export interface UserGameAccountInput {
   accountId?: string;
   isPrivate?: boolean;
+  verifiedAt?: string;
+  verificationMethod?: UserGameAccountVerificationMethod;
+  providerAccountId?: string;
   users_permissions_user?: RelationInput;
   game_account?: RelationInput;
 }

package/src/generated/models.ts

@@ -43,6 +43,7 @@ import type {
   TournamentTeamSize,
   TournamentType,
   TournamentVisibility,
+  UserGameAccountVerificationMethod,
   UserTransactionStripeStatus,
   UserTransactionType,
 } from './enums';
@@ -139,6 +140,15 @@ export interface GameAccount extends StrapiDocument {
   platforms?: Platform[];
 }
 
+/** `game-account-link` */
+export interface GameAccountLink extends StrapiDocument {
+  token?: string | null;
+  users_permissions_user?: User | null;
+  game_account?: GameAccount | null;
+  expiresAt?: string | null;
+  returnTo?: string | null;
+}
+
 /** `game-request` */
 export interface GameRequest extends StrapiDocument {
   gameTitle?: string | null;
@@ -407,6 +417,7 @@ export interface Tournament extends StrapiDocument {
   rules?: string | null;
   hasThirdPlace?: boolean | null;
   hasMatchLobby?: boolean | null;
+  requireVerifiedAccounts?: boolean | null;
   visibility?: TournamentVisibility | null;
   access?: TournamentAccess | null;
   checkInTime?: number | null;
@@ -513,6 +524,9 @@ export interface User extends StrapiDocument {
 export interface UserGameAccount extends StrapiDocument {
   accountId?: string | null;
   isPrivate?: boolean | null;
+  verifiedAt?: string | null;
+  verificationMethod?: UserGameAccountVerificationMethod | null;
+  providerAccountId?: string | null;
   users_permissions_user?: User | null;
   game_account?: GameAccount | null;
 }

package/src/manual/gameAccountHandle.ts

@@ -54,7 +54,60 @@ export type HandleCheck =
   | { ok: false; message: string };
 
 /** `error.details.name` values the game-account write endpoints raise. */
-export type GameAccountErrorName = 'HandleInvalid' | 'HandleTaken';
+export type GameAccountErrorName =
+  | 'HandleInvalid'
+  | 'HandleTaken'
+  /** The row is verified by a link; unlink before changing the ID. */
+  | 'HandleLocked'
+  /** No configured link provider for this network. */
+  | 'LinkUnavailable'
+  /** The provider account is already linked to another XPT user. */
+  | 'LinkConflict';
+
+/**
+ * Networks whose handles can be verified by signing in to the network. The
+ * catalogue's `verification: 'linked'` is only valid for these; whether a
+ * provider is actually configured on a given environment is answered at
+ * runtime by `GET /user-game-accounts/link/providers`.
+ */
+export const LINK_PROVIDER_CODES = ['steam', 'battlenet'] as const satisfies
+  readonly GameAccountCode[];
+
+export type LinkProviderCode = (typeof LINK_PROVIDER_CODES)[number];
+
+export function isLinkableCode(
+  code: string | null | undefined
+): code is LinkProviderCode {
+  return (LINK_PROVIDER_CODES as readonly string[]).includes(code ?? '');
+}
+
+/**
+ * Why a link attempt came back without a verified account — the `linkError`
+ * query value the callback redirects to the settings page with.
+ */
+export type AccountLinkError =
+  /** The attempt was unknown, already used, or older than its window. */
+  | 'expired'
+  /** The player cancelled at the provider. */
+  | 'denied'
+  /** The provider's answer did not verify. */
+  | 'invalid'
+  /** That provider account is already linked to another XPT user. */
+  | 'taken'
+  /** The provider is not configured, or the network is not linkable. */
+  | 'unavailable'
+  /** Accounts are frozen while the player is in a running tournament. */
+  | 'activeTournament';
+
+/** True when a row's handle was proved by signing in to the network. */
+export function isVerifiedAccount(
+  row:
+    | { verifiedAt?: string | Date | null; verificationMethod?: string | null }
+    | null
+    | undefined
+): boolean {
+  return !!row?.verifiedAt && row.verificationMethod === 'linked';
+}
 
 /**
  * The rule every network gets when it has no stricter one. Also the backstop
@@ -187,8 +240,9 @@ export const HANDLE_RULES: Partial<Record<GameAccountCode, HandleRule>> = {
 
 /**
  * The rule a network's handles are checked against: its own when the
- * catalogue row asks for format checks and a rule exists for its code,
- * otherwise the generic one.
+ * catalogue row asks for format checks (or is linkable, which implies them
+ * for anything typed by hand) and a rule exists for its code, otherwise the
+ * generic one.
  */
 export function handleRuleFor(
   network:
@@ -199,7 +253,9 @@ export function handleRuleFor(
     | null
     | undefined
 ): HandleRule {
-  if (network?.verification !== 'format' || !network.code) {
+  const checked =
+    network?.verification === 'format' || network?.verification === 'linked';
+  if (!checked || !network?.code) {
     return GENERIC_HANDLE_RULE;
   }
   return HANDLE_RULES[network.code as GameAccountCode] ?? GENERIC_HANDLE_RULE;

package/src/manual/tournamentEntry.ts

@@ -51,4 +51,8 @@ export type TournamentEntryErrorName =
   | 'MembersMissingGameAccount'
   | 'InsufficientCoins'
   | 'GameAccountRequired'
-  | 'TeamEntryRequired';
+  | 'TeamEntryRequired'
+  /** The tournament admits only accounts verified by signing in; yours is typed. */
+  | 'GameAccountUnverified'
+  /** Same, for the named players on a team roster. */
+  | 'MembersUnverifiedGameAccount';