xpt-shared-types 1.12.1 → 1.13.0

package/dist/generated/enums.d.ts

@@ -1,3 +1,5 @@
+/** `AdminAction.targetType` */
+export type AdminActionTargetType = "user" | "tournament" | "match" | "transaction";
 /** `Faq.category` */
 export type FaqCategory = "gettingStarted" | "tournamentsMatches" | "hosting" | "walletCoins" | "account";
 /** `Friendship.status` */

package/dist/generated/inputs.d.ts

@@ -1,5 +1,5 @@
 import type { BlocksContent, MediaInput, RelationInput } from '../contracts';
-import type { FaqCategory, FriendshipStatus, GameGenre, GameRequestCustomLobbies, GameRequestGenre, GameRequestTeamPlay, GameVisibility, MatchDisputeReason, MatchLobbyStatus, MatchResultType, MatchRound, MatchStreamPlatform, MatchWinnerSlot, PlatformCode, 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, GameGenre, GameRequestCustomLobbies, GameRequestGenre, GameRequestTeamPlay, GameVisibility, MatchDisputeReason, MatchLobbyStatus, MatchResultType, MatchRound, MatchStreamPlatform, MatchWinnerSlot, PlatformCode, ReferralStatus, TeamCurrentStatus, TeamInviteStatus, TeamInviteTeamRole, TeamPlayerTeamRole, TournamentAccess, TournamentCurrentStatus, TournamentInviteStatus, TournamentJoinRequestEntryType, TournamentJoinRequestStatus, TournamentParticipantEntryType, TournamentParticipantStatus, TournamentRoleRole, TournamentTeamSize, TournamentType, TournamentVisibility, UserTransactionStripeStatus, UserTransactionType } from './enums';
 /** Write payload for `about`. */
 export interface AboutInput {
     heroTitle?: string;
@@ -7,6 +7,20 @@ export interface AboutInput {
     aboutInfo?: unknown;
     gameIcons?: MediaInput[];
 }
+/** Write payload for `admin-action`. */
+export interface AdminActionInput {
+    action?: string;
+    adminId?: number;
+    adminUsername?: string;
+    targetType?: AdminActionTargetType;
+    targetId?: string;
+    targetLabel?: string;
+    contextId?: string;
+    reason?: string;
+    before?: unknown;
+    after?: unknown;
+    metadata?: unknown;
+}
 /** Write payload for `dm-message`. */
 export interface DmMessageInput {
     conversationId?: string;
@@ -383,6 +397,8 @@ export interface UserInput {
     countryCode?: string;
     dob?: string;
     notifyUpdates?: boolean;
+    blockedReason?: string;
+    blockedAt?: string;
     xptCoins?: number;
     user_transactions?: RelationInput | RelationInput[];
     dailyRewardStreak?: number;

package/dist/generated/models.d.ts

@@ -1,5 +1,5 @@
 import type { BlocksContent, StrapiDocument, StrapiMedia, UserRole } from '../contracts';
-import type { FaqCategory, FriendshipStatus, GameGenre, GameRequestCustomLobbies, GameRequestGenre, GameRequestTeamPlay, GameVisibility, MatchDisputeReason, MatchLobbyStatus, MatchResultType, MatchRound, MatchStreamPlatform, MatchWinnerSlot, PlatformCode, 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, GameGenre, GameRequestCustomLobbies, GameRequestGenre, GameRequestTeamPlay, GameVisibility, MatchDisputeReason, MatchLobbyStatus, MatchResultType, MatchRound, MatchStreamPlatform, MatchWinnerSlot, PlatformCode, ReferralStatus, TeamCurrentStatus, TeamInviteStatus, TeamInviteTeamRole, TeamPlayerTeamRole, TournamentAccess, TournamentCurrentStatus, TournamentInviteStatus, TournamentJoinRequestEntryType, TournamentJoinRequestStatus, TournamentParticipantEntryType, TournamentParticipantStatus, TournamentRoleRole, TournamentTeamSize, TournamentType, TournamentVisibility, UserTransactionStripeStatus, UserTransactionType } from './enums';
 /** `about` */
 export interface About extends StrapiDocument {
     heroTitle?: string | null;
@@ -7,6 +7,20 @@ export interface About extends StrapiDocument {
     aboutInfo?: unknown | null;
     gameIcons?: StrapiMedia[];
 }
+/** `admin-action` */
+export interface AdminAction extends StrapiDocument {
+    action?: string | null;
+    adminId?: number | null;
+    adminUsername?: string | null;
+    targetType?: AdminActionTargetType | null;
+    targetId?: string | null;
+    targetLabel?: string | null;
+    contextId?: string | null;
+    reason?: string | null;
+    before?: unknown | null;
+    after?: unknown | null;
+    metadata?: unknown | null;
+}
 /** `dm-message` */
 export interface DmMessage extends StrapiDocument {
     conversationId?: string | null;
@@ -383,6 +397,8 @@ export interface User extends StrapiDocument {
     countryCode?: string | null;
     dob?: string | null;
     notifyUpdates?: boolean | null;
+    blockedReason?: string | null;
+    blockedAt?: string | null;
     xptCoins?: number | null;
     user_transactions?: UserTransaction[];
     dailyRewardStreak?: number | null;

package/dist/manual/index.d.ts

@@ -3,6 +3,7 @@
  */
 export * from './country';
 export * from './lobby';
+export * from './notification';
 export * from './tournamentEntry';
 export * from './tournamentInvite';
 export * from './tournamentJoinRequest';

package/dist/manual/index.js

@@ -19,6 +19,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
  */
 __exportStar(require("./country"), exports);
 __exportStar(require("./lobby"), exports);
+__exportStar(require("./notification"), exports);
 __exportStar(require("./tournamentEntry"), exports);
 __exportStar(require("./tournamentInvite"), exports);
 __exportStar(require("./tournamentJoinRequest"), exports);

package/dist/manual/notification.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Notification types — the contract between the server's writers and the
+ * client's bell.
+ *
+ * The `notification` content type stores `type` as a plain string (there is no
+ * enum on the schema), so the generated `Notification.type` is `string`. This
+ * is the closed list both sides agree on: the server refuses to write a type
+ * that is not here, the client switches on it for icons, actions and routes,
+ * and the preference page groups toggles by `NOTIFICATION_TYPE_GROUP`.
+ *
+ * Adding a type means adding it here, giving it a group, and then a writer
+ * on the server and a glyph on the client — the `Record`s below fail to
+ * compile until the group is chosen.
+ */
+export declare const NOTIFICATION_TYPES: readonly ["match_ready", "match_result", "match_dispute", "tournament_registered", "tournament_status", "tournament_eliminated", "tournament_placement", "tournament_withdrawn", "tournament_roster", "tournament_join_request", "tournament_join_approved", "tournament_join_declined", "tournament_join_expired", "team_invite", "team_kicked", "team_captaincy", "team_joined", "friend_request", "friend_request_accepted", "xp_earned", "wallet_credit", "wallet_debit"];
+export type NotificationType = (typeof NOTIFICATION_TYPES)[number];
+/** The in-app toggles on the notification settings page, one per group. */
+export declare const NOTIFICATION_GROUPS: readonly ["matchAlerts", "tournamentUpdates", "teamSocial", "accountRewards"];
+export type NotificationGroup = (typeof NOTIFICATION_GROUPS)[number];
+/**
+ * Which toggle gates each type. Exhaustive: a new type must pick a group, or
+ * say `null` to mean it is always delivered.
+ */
+export declare const NOTIFICATION_TYPE_GROUP: Record<NotificationType, NotificationGroup | null>;
+/**
+ * The stored preference blob on a user. The four groups gate in-app delivery;
+ * `emailNotifications` is the single email opt-out; `marketing` is stored for
+ * a future channel and read by nothing yet.
+ */
+export interface NotificationPreferences {
+    matchAlerts: boolean;
+    tournamentUpdates: boolean;
+    teamSocial: boolean;
+    accountRewards: boolean;
+    marketing: boolean;
+    emailNotifications: boolean;
+}
+/** Applied when a user has never saved preferences. */
+export declare const DEFAULT_NOTIFICATION_PREFERENCES: NotificationPreferences;
+export declare const isNotificationType: (value: unknown) => value is NotificationType;

package/dist/manual/notification.js

@@ -0,0 +1,93 @@
+"use strict";
+/**
+ * Notification types — the contract between the server's writers and the
+ * client's bell.
+ *
+ * The `notification` content type stores `type` as a plain string (there is no
+ * enum on the schema), so the generated `Notification.type` is `string`. This
+ * is the closed list both sides agree on: the server refuses to write a type
+ * that is not here, the client switches on it for icons, actions and routes,
+ * and the preference page groups toggles by `NOTIFICATION_TYPE_GROUP`.
+ *
+ * Adding a type means adding it here, giving it a group, and then a writer
+ * on the server and a glyph on the client — the `Record`s below fail to
+ * compile until the group is chosen.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isNotificationType = exports.DEFAULT_NOTIFICATION_PREFERENCES = exports.NOTIFICATION_TYPE_GROUP = exports.NOTIFICATION_GROUPS = exports.NOTIFICATION_TYPES = void 0;
+exports.NOTIFICATION_TYPES = [
+    // matchAlerts
+    'match_ready',
+    'match_result',
+    'match_dispute',
+    // tournamentUpdates
+    'tournament_registered',
+    'tournament_status',
+    'tournament_eliminated',
+    'tournament_placement',
+    'tournament_withdrawn',
+    'tournament_roster',
+    'tournament_join_request',
+    'tournament_join_approved',
+    'tournament_join_declined',
+    'tournament_join_expired',
+    // teamSocial
+    'team_invite',
+    'team_kicked',
+    'team_captaincy',
+    'team_joined',
+    'friend_request',
+    'friend_request_accepted',
+    // accountRewards
+    'xp_earned',
+    'wallet_credit',
+    // ungated — coins leaving an account cannot be muted
+    'wallet_debit',
+];
+/** The in-app toggles on the notification settings page, one per group. */
+exports.NOTIFICATION_GROUPS = [
+    'matchAlerts',
+    'tournamentUpdates',
+    'teamSocial',
+    'accountRewards',
+];
+/**
+ * Which toggle gates each type. Exhaustive: a new type must pick a group, or
+ * say `null` to mean it is always delivered.
+ */
+exports.NOTIFICATION_TYPE_GROUP = {
+    match_ready: 'matchAlerts',
+    match_result: 'matchAlerts',
+    match_dispute: 'matchAlerts',
+    tournament_registered: 'tournamentUpdates',
+    tournament_status: 'tournamentUpdates',
+    tournament_eliminated: 'tournamentUpdates',
+    tournament_placement: 'tournamentUpdates',
+    tournament_withdrawn: 'tournamentUpdates',
+    tournament_roster: 'tournamentUpdates',
+    tournament_join_request: 'tournamentUpdates',
+    tournament_join_approved: 'tournamentUpdates',
+    tournament_join_declined: 'tournamentUpdates',
+    tournament_join_expired: 'tournamentUpdates',
+    team_invite: 'teamSocial',
+    team_kicked: 'teamSocial',
+    team_captaincy: 'teamSocial',
+    team_joined: 'teamSocial',
+    friend_request: 'teamSocial',
+    friend_request_accepted: 'teamSocial',
+    xp_earned: 'accountRewards',
+    wallet_credit: 'accountRewards',
+    wallet_debit: null,
+};
+/** Applied when a user has never saved preferences. */
+exports.DEFAULT_NOTIFICATION_PREFERENCES = {
+    matchAlerts: true,
+    tournamentUpdates: true,
+    teamSocial: true,
+    accountRewards: true,
+    marketing: false,
+    emailNotifications: true,
+};
+const isNotificationType = (value) => typeof value === 'string' &&
+    exports.NOTIFICATION_TYPES.includes(value);
+exports.isNotificationType = isNotificationType;

package/package.json

@@ -1,26 +1,26 @@
-{
-  "name": "xpt-shared-types",
-  "version": "1.12.1",
-  "description": "Shared types and data for XPT projects",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "files": [
-    "dist",
-    "src",
-    "scripts"
-  ],
-  "scripts": {
-    "sync": "node scripts/sync-from-strapi.js",
-    "build": "tsc",
-    "prepublishOnly": "yarn build"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/otemu/xpt-shared-types"
-  },
-  "author": "",
-  "license": "MIT",
-  "devDependencies": {
-    "typescript": "^5.0.0"
-  }
-}
+{
+  "name": "xpt-shared-types",
+  "version": "1.13.0",
+  "description": "Shared types and data for XPT projects",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "src",
+    "scripts"
+  ],
+  "scripts": {
+    "sync": "node scripts/sync-from-strapi.js",
+    "build": "tsc",
+    "prepublishOnly": "yarn build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/otemu/xpt-shared-types"
+  },
+  "author": "",
+  "license": "MIT",
+  "devDependencies": {
+    "typescript": "^5.0.0"
+  }
+}

package/src/generated/enums.ts

@@ -2,6 +2,13 @@
 // Source: xpt-strapi/src/**/content-types/**/schema.json
 // Regenerate with: yarn sync
 
+/** `AdminAction.targetType` */
+export type AdminActionTargetType =
+  | "user"
+  | "tournament"
+  | "match"
+  | "transaction";
+
 /** `Faq.category` */
 export type FaqCategory =
   | "gettingStarted"

package/src/generated/inputs.ts

@@ -8,6 +8,7 @@ import type {
   RelationInput,
 } from '../contracts';
 import type {
+  AdminActionTargetType,
   FaqCategory,
   FriendshipStatus,
   GameGenre,
@@ -50,6 +51,21 @@ export interface AboutInput {
   gameIcons?: MediaInput[];
 }
 
+/** Write payload for `admin-action`. */
+export interface AdminActionInput {
+  action?: string;
+  adminId?: number;
+  adminUsername?: string;
+  targetType?: AdminActionTargetType;
+  targetId?: string;
+  targetLabel?: string;
+  contextId?: string;
+  reason?: string;
+  before?: unknown;
+  after?: unknown;
+  metadata?: unknown;
+}
+
 /** Write payload for `dm-message`. */
 export interface DmMessageInput {
   conversationId?: string;
@@ -461,6 +477,8 @@ export interface UserInput {
   countryCode?: string;
   dob?: string;
   notifyUpdates?: boolean;
+  blockedReason?: string;
+  blockedAt?: string;
   xptCoins?: number;
   user_transactions?: RelationInput | RelationInput[];
   dailyRewardStreak?: number;

package/src/generated/models.ts

@@ -9,6 +9,7 @@ import type {
   UserRole,
 } from '../contracts';
 import type {
+  AdminActionTargetType,
   FaqCategory,
   FriendshipStatus,
   GameGenre,
@@ -51,6 +52,21 @@ export interface About extends StrapiDocument {
   gameIcons?: StrapiMedia[];
 }
 
+/** `admin-action` */
+export interface AdminAction extends StrapiDocument {
+  action?: string | null;
+  adminId?: number | null;
+  adminUsername?: string | null;
+  targetType?: AdminActionTargetType | null;
+  targetId?: string | null;
+  targetLabel?: string | null;
+  contextId?: string | null;
+  reason?: string | null;
+  before?: unknown | null;
+  after?: unknown | null;
+  metadata?: unknown | null;
+}
+
 /** `dm-message` */
 export interface DmMessage extends StrapiDocument {
   conversationId?: string | null;
@@ -462,6 +478,8 @@ export interface User extends StrapiDocument {
   countryCode?: string | null;
   dob?: string | null;
   notifyUpdates?: boolean | null;
+  blockedReason?: string | null;
+  blockedAt?: string | null;
   xptCoins?: number | null;
   user_transactions?: UserTransaction[];
   dailyRewardStreak?: number | null;

package/src/manual/index.ts

@@ -3,6 +3,7 @@
  */
 export * from './country';
 export * from './lobby';
+export * from './notification';
 export * from './tournamentEntry';
 export * from './tournamentInvite';
 export * from './tournamentJoinRequest';

package/src/manual/notification.ts

@@ -0,0 +1,117 @@
+/**
+ * Notification types — the contract between the server's writers and the
+ * client's bell.
+ *
+ * The `notification` content type stores `type` as a plain string (there is no
+ * enum on the schema), so the generated `Notification.type` is `string`. This
+ * is the closed list both sides agree on: the server refuses to write a type
+ * that is not here, the client switches on it for icons, actions and routes,
+ * and the preference page groups toggles by `NOTIFICATION_TYPE_GROUP`.
+ *
+ * Adding a type means adding it here, giving it a group, and then a writer
+ * on the server and a glyph on the client — the `Record`s below fail to
+ * compile until the group is chosen.
+ */
+
+export const NOTIFICATION_TYPES = [
+  // matchAlerts
+  'match_ready',
+  'match_result',
+  'match_dispute',
+  // tournamentUpdates
+  'tournament_registered',
+  'tournament_status',
+  'tournament_eliminated',
+  'tournament_placement',
+  'tournament_withdrawn',
+  'tournament_roster',
+  'tournament_join_request',
+  'tournament_join_approved',
+  'tournament_join_declined',
+  'tournament_join_expired',
+  // teamSocial
+  'team_invite',
+  'team_kicked',
+  'team_captaincy',
+  'team_joined',
+  'friend_request',
+  'friend_request_accepted',
+  // accountRewards
+  'xp_earned',
+  'wallet_credit',
+  // ungated — coins leaving an account cannot be muted
+  'wallet_debit',
+] as const;
+
+export type NotificationType = (typeof NOTIFICATION_TYPES)[number];
+
+/** The in-app toggles on the notification settings page, one per group. */
+export const NOTIFICATION_GROUPS = [
+  'matchAlerts',
+  'tournamentUpdates',
+  'teamSocial',
+  'accountRewards',
+] as const;
+
+export type NotificationGroup = (typeof NOTIFICATION_GROUPS)[number];
+
+/**
+ * Which toggle gates each type. Exhaustive: a new type must pick a group, or
+ * say `null` to mean it is always delivered.
+ */
+export const NOTIFICATION_TYPE_GROUP: Record<
+  NotificationType,
+  NotificationGroup | null
+> =
+  {
+    match_ready: 'matchAlerts',
+    match_result: 'matchAlerts',
+    match_dispute: 'matchAlerts',
+    tournament_registered: 'tournamentUpdates',
+    tournament_status: 'tournamentUpdates',
+    tournament_eliminated: 'tournamentUpdates',
+    tournament_placement: 'tournamentUpdates',
+    tournament_withdrawn: 'tournamentUpdates',
+    tournament_roster: 'tournamentUpdates',
+    tournament_join_request: 'tournamentUpdates',
+    tournament_join_approved: 'tournamentUpdates',
+    tournament_join_declined: 'tournamentUpdates',
+    tournament_join_expired: 'tournamentUpdates',
+    team_invite: 'teamSocial',
+    team_kicked: 'teamSocial',
+    team_captaincy: 'teamSocial',
+    team_joined: 'teamSocial',
+    friend_request: 'teamSocial',
+    friend_request_accepted: 'teamSocial',
+    xp_earned: 'accountRewards',
+    wallet_credit: 'accountRewards',
+    wallet_debit: null,
+  };
+
+/**
+ * The stored preference blob on a user. The four groups gate in-app delivery;
+ * `emailNotifications` is the single email opt-out; `marketing` is stored for
+ * a future channel and read by nothing yet.
+ */
+export interface NotificationPreferences {
+  matchAlerts: boolean;
+  tournamentUpdates: boolean;
+  teamSocial: boolean;
+  accountRewards: boolean;
+  marketing: boolean;
+  emailNotifications: boolean;
+}
+
+/** Applied when a user has never saved preferences. */
+export const DEFAULT_NOTIFICATION_PREFERENCES: NotificationPreferences = {
+  matchAlerts: true,
+  tournamentUpdates: true,
+  teamSocial: true,
+  accountRewards: true,
+  marketing: false,
+  emailNotifications: true,
+};
+
+export const isNotificationType = (value: unknown): value is NotificationType =>
+  typeof value === 'string' &&
+  (NOTIFICATION_TYPES as readonly string[]).includes(value);