@smartico/public-api 0.0.8 → 0.0.9

package/src/Tournaments/GetTournamentInfoResponse.ts

@@ -0,0 +1,25 @@
+import {Tournament} from "./Tournament";
+import {TournamentPlayer} from "./TournamentPlayer";
+import { ProtocolResponse } from "../Base/ProtocolResponse";
+import { TournamentPrize } from "./TournamentPrize";
+
+export interface GetTournamentInfoResponse extends ProtocolResponse {
+
+    /** tournament info */
+    tournamentInfo: {
+        /** id of label, not in use */
+        labelId: number;
+        tournamentLobbyInfo: Tournament;
+        /** list of registered users */
+        players: TournamentPlayer[];
+    },
+    /** information about current user position */
+    userPosition: TournamentPlayer,
+    /** prizes structure */
+    prizeStructure?: {
+        prizes: TournamentPrize[],
+    }
+}
+
+
+

package/src/Tournaments/GetTournamentsRequest.ts

@@ -0,0 +1,5 @@
+import { ProtocolMessage } from "../Base/ProtocolMessage";
+
+export interface GetTournamentsRequest extends ProtocolMessage {
+
+}

package/src/Tournaments/GetTournamentsResponse.ts

@@ -0,0 +1,8 @@
+import { ProtocolResponse } from "../Base/ProtocolResponse";
+import {Tournament} from "./Tournament";
+
+export interface GetTournamentsResponse extends ProtocolResponse {
+
+    /** array of the tournaments */
+    tournaments?: Tournament[];
+}

package/src/Tournaments/Tournament.ts

@@ -0,0 +1,47 @@
+import {TournamentRegistrationType} from "./TournamentRegistrationType";
+import {TournamentInstanceStatus} from "./TournamentInstanceStatus";
+import { TournamentRegistrationStatus } from "./TournamentRegistrationStatus";
+import { TournamentType } from "./TournamentType";
+import { TournamentPublicMeta } from "./TournamentPublicMeta";
+
+export interface Tournament {
+
+    /** ID of tournament template */
+    tournamentId?: number;
+    /** ID of tournament instance. Generated every time when tournament based on specific template is scheduled for run */
+    tournamentInstanceId?: number;
+    /** Type of the tournament. For now only SCHEDULED is support */
+    tournamentType?: TournamentType;
+    /** Meta information about tournament that should be used to build UI */
+    publicMeta?: TournamentPublicMeta;
+    /** Cost of registration in the tournament in gamification points */
+    buyInAmount?: number;
+    /** Not in use */
+    prizePool?: number;
+    /** The time when tournament is going to start */
+    startTime?: string;
+    /** The time when tournament is going to finish */
+    endTime?: string;
+    /** Number of users registered in the tournament */
+    registrationCount?: number;
+    /** Not in use */
+    totalCount?: number;
+    /** Type of registration in the tournament */
+    registrationType?: TournamentRegistrationType;
+    /** Status of registration in the tournament for current user */
+    tournamentRegistrationStatus?: TournamentRegistrationStatus;
+    /** Status of tournament instance */
+    tournamentInstanceStatus?: TournamentInstanceStatus;
+    /** flag indicating if current user is registered in the tournament */
+    isUserRegistered?: boolean;
+    /** Indicator if tournament allows later registration, when tournament is already started */
+    allowLateRegistration?: boolean;
+    /** Minimum number of participant for this tournament. If tournament doesnt have enough registrations, it will not start */
+    playersMinCount?: number;
+    /** Maximum number of participant for this tournament. When reached, new users won't be able to register */
+    playersMaxCount?: number;
+    /** Tournament duration in millisecnnds */
+    durationMs?: number;
+}
+
+

package/src/Tournaments/TournamentInstanceStatus.ts

@@ -0,0 +1,22 @@
+export enum TournamentInstanceStatus {
+
+    PUBLISHED = 1,
+    REGISTER = 2,
+    STARTED = 3,
+    FINISHED = 4,
+    CANCELLED = 5,
+    FAILED = 6,
+    FINALIZING = 7,
+}
+
+export const TournamentInstanceStatusName = (s: TournamentInstanceStatus): string => {
+    return {
+        [TournamentInstanceStatus.PUBLISHED]: "PUBLISHED",
+        [TournamentInstanceStatus.REGISTER]: "REGISTER",
+        [TournamentInstanceStatus.STARTED]: "STARTED",
+        [TournamentInstanceStatus.FINISHED]: "FINISHED",
+        [TournamentInstanceStatus.CANCELLED]: "CANCELLED",
+        [TournamentInstanceStatus.FAILED]: "FAILED",
+        [TournamentInstanceStatus.FINALIZING]: "FINALIZING",
+    }[s];
+};

package/src/Tournaments/TournamentPlayer.ts

@@ -0,0 +1,11 @@
+export interface TournamentPlayer {
+
+    userAltName: string;
+    position: number;
+    scores: number;
+    isMe: boolean;
+    userId: number;
+    avatar_id: string;
+
+    avatar_url?: string;
+}

package/src/Tournaments/TournamentPrize.ts

@@ -0,0 +1,12 @@
+import { ActivityTypeLimited } from "../Core/ActivityTypeLimited";
+
+export interface TournamentPrize {
+
+    name: string;
+    description: string;
+    image_url: string;
+    place_from: number;
+    place_to: number;
+    type: ActivityTypeLimited;
+    points: number;
+}

package/src/Tournaments/TournamentPublicMeta.ts

@@ -0,0 +1,26 @@
+export interface TournamentPublicMeta {
+    /** Name of tournament */
+    name?: string;
+    /** 1st image */
+    image_url?: string;
+    /** 2nd image */
+    image_url2?: string;
+    /** Description, html capable */
+    description?: string;
+    /** Short explanation of prize pool */
+    prize_pool_short?: string;
+    /** Message to show when user is not matching to the segment allowed to register (error code 30005 in registration response) */
+    segment_dont_match_message?: string;
+    /** Short explanation of registration price */
+    custom_price_text?: string;
+    /** Indicator if the scores of other users should be shown in the leaderboard of tournament */
+    show_other_users_score?: boolean;
+
+    custom_section_id?: number;
+
+    only_in_custom_section?: boolean;
+
+    label_tag?: string;
+
+    featured?: boolean;
+}

package/src/Tournaments/TournamentRegisterRequest.ts

@@ -0,0 +1,6 @@
+import { ProtocolMessage } from "../Base/ProtocolMessage";
+
+export interface TournamentRegisterRequest extends ProtocolMessage {
+
+    tournamentInstanceId: number;
+}

package/src/Tournaments/TournamentRegisterResponse.ts

@@ -0,0 +1,10 @@
+import { ProtocolResponse } from "../Base/ProtocolResponse";
+import { TournamentRegistrationError } from "./TournamentRegistrationError";
+
+export interface TournamentRegisterResponse extends ProtocolResponse {
+
+    errCode?: TournamentRegistrationError;
+}
+
+
+

package/src/Tournaments/TournamentRegistrationError.ts

@@ -0,0 +1,11 @@
+export enum TournamentRegistrationError {
+    NO_ERROR = 0,
+    TOURNAMENT_INSTANCE_NOT_FOUND = 30001,
+    TOURNAMENT_REGISTRATION_NOT_ENOUGH_POINTS = 30002,
+    TOURNAMENT_INSTANCE_NOT_IN_STATE = 30003,
+    TOURNAMENT_ALREADY_REGISTERED = 30004,
+    TOURNAMENT_USER_DONT_MATCH_CONDITIONS = 30005,
+    TOURNAMENT_USER_NOT_REGISTERED = 30006,
+    TOURNAMENT_CANT_CHANGE_REGISTRATION_STATUS = 30007,
+    TOURNAMENT_MAX_REGISTRATIONS_REACHED = 30008,
+}

package/src/Tournaments/TournamentRegistrationStatus.ts

@@ -0,0 +1,11 @@
+export enum TournamentRegistrationStatus {
+
+    NOT_REGISTERED = 0,
+    REGISTERED = 1,
+    FINISHED = 2,
+    PENDING = 3,
+    CANCELLED = 4,
+    REGISTERED_PENDING_QUALIFICATION = 5,
+    QUALIFIED_PENDING_REGISTRATION = 6
+}
+

package/src/Tournaments/TournamentRegistrationType.ts

@@ -0,0 +1,9 @@
+export enum TournamentRegistrationType {
+
+    AUTO = 1,
+    OPT_IN = 2,
+    BUY_IN_POINTS = 3,
+    MANUAL_APPROVAL = 4,
+    REQUIRES_QUALIFICATION = 5
+    // BUY_IN_CASH = 5???,
+}

package/src/Tournaments/TournamentType.ts

@@ -0,0 +1,6 @@
+export enum TournamentType {
+
+    SCHEDULED = 1,
+    SNG = 2,
+    TEST = 3,
+}

package/src/Tournaments/index.ts

@@ -0,0 +1,33 @@
+import { GetTournamentInfoRequest } from "./GetTournamentInfoRequest";
+import { GetTournamentInfoResponse } from "./GetTournamentInfoResponse";
+import { GetTournamentsRequest } from "./GetTournamentsRequest";
+import { GetTournamentsResponse } from "./GetTournamentsResponse";
+import { Tournament } from "./Tournament";
+import { TournamentInstanceStatus } from "./TournamentInstanceStatus";
+import { TournamentPlayer } from "./TournamentPlayer";
+import { TournamentPrize } from "./TournamentPrize";
+import { TournamentPublicMeta } from "./TournamentPublicMeta";
+import { TournamentRegisterRequest } from "./TournamentRegisterRequest";
+import { TournamentRegisterResponse } from "./TournamentRegisterResponse";
+import { TournamentRegistrationError } from "./TournamentRegistrationError";
+import { TournamentRegistrationStatus } from "./TournamentRegistrationStatus";
+import { TournamentRegistrationType } from "./TournamentRegistrationType";
+import { TournamentType } from "./TournamentType";
+
+export {
+    GetTournamentInfoRequest,
+    GetTournamentInfoResponse,
+    GetTournamentsRequest,
+    GetTournamentsResponse,
+    Tournament,
+    TournamentInstanceStatus,
+    TournamentPlayer,
+    TournamentPrize,
+    TournamentPublicMeta,
+    TournamentRegisterRequest,
+    TournamentRegisterResponse,
+    TournamentRegistrationError,
+    TournamentRegistrationStatus,
+    TournamentRegistrationType,
+    TournamentType,
+}

package/src/index.ts

@@ -8,6 +8,7 @@ export * from './Leaderboard';
 export * from './MiniGames';
 export * from './Missions';
 export * from './Store';
+export * from './Tournaments';
 
 
 export {

package/src/Store/GetCategoriesShopResponse.ts

@@ -1,11 +0,0 @@
-import { ProtocolResponse } from "../Base/ProtocolResponse";
-import { ShopCategory } from "./ShopCategory";
-
-
-export interface GetCategoriesShopResponse extends ProtocolResponse {
-
-    categories: ShopCategory[];
-}
-
-
-

package/src/Store/GetShopItemsResponse.ts

@@ -1,7 +0,0 @@
-
-import { ProtocolResponse } from "../Base/ProtocolResponse";
-import { ShopItem } from "./ShopItem";
-
-export interface GetShopItemsResponse extends ProtocolResponse {
-    items: ShopItem[];
-}

package/src/Store/ShopCategory.ts

@@ -1,7 +0,0 @@
-import { ShopCategoryPublicMeta } from "./ShopCategoryPublicMeta";
-
-export interface ShopCategory {
-
-    id?: number;
-    publicMeta?: ShopCategoryPublicMeta;
-}

package/src/Store/ShopCategoryPublicMeta.ts

@@ -1,5 +0,0 @@
-export interface ShopCategoryPublicMeta {
-
-    name?: string;
-    order?: number;
-}

package/src/Store/ShopItem.ts

@@ -1,10 +0,0 @@
-import { ShopItemPublicMeta } from "./ShopItemPublicMeta";
-import { ShopItemType } from "./ShopItemType";
-
-export interface ShopItem {
-    id: number;
-    itemTypeId: ShopItemType;
-    itemPublicMeta: ShopItemPublicMeta;
-    categoryIds?: number[];
-    canBuy?: boolean;
-}