@pixels-online/pixels-client-js-sdk 1.21.0 → 2.1.0

package/dist/types/player.d.ts

@@ -1,485 +0,0 @@
-import { Stringable } from '.';
-import { IBlockchainSyncStatus } from './blockchain/user_wallet';
-import { IUser, Restriction } from './user';
-export declare const DEFAULT_ENTITY_KIND = "_default";
-export type IClientPlayer = {
-    /** @deprecated use gameData instead */
-    snapshot: IClientPlayerSnapshot;
-    /** @deprecated use stackedData instead */
-    data?: IClientPlayerData | null;
-    gameData: IClientPlayerSnapshot;
-    stackedData: IClientStackedData;
-};
-export interface IPlayerSnapshot {
-    _id: string;
-    gameId: string;
-    playerId: string;
-    /** when this was last linked to a unified user */
-    unifiedUserLinkedAt?: number;
-    /** when this was last unlinked to a unified user */
-    unifiedUserUnlinkedAt?: number;
-    /** player that referred this player to this game */
-    referredById?: string;
-    username?: string;
-    snapshotLastUpdated: number;
-    offersLastChecked?: number;
-    daysInGame: number;
-    loginStreak: number;
-    daysInGameLastUpdated: number;
-    /** timestamp when player first signed up */
-    dateSignedUp?: number;
-    /** dynamic key value pairs that external apps can set to anything */
-    dynamic?: Record<string, string | number | boolean>;
-    /** staked tokens data for this player */
-    stakedTokens?: Record<
-    /** the key is the token name. Eg. PIXEL or RON */
-    string, {
-        balance?: number;
-        totalClaimed?: number;
-        totalStaked?: number;
-        lastStake?: number;
-        lastUnstake?: number;
-    }>;
-    currencies?: Record<string, {
-        balance?: number;
-        in?: number;
-        out?: number;
-        lastUpdated?: number;
-    }>;
-    levels?: Record<string, {
-        level?: number;
-        lastUpdated?: number;
-    }>;
-    quests?: Record<string, {
-        completions?: number;
-        lastUpdated?: number;
-    }>;
-    trustScore?: number;
-    trustLastUpdated?: number;
-    achievements?: Record<string, {
-        count?: number;
-        lastUpdated: number;
-    }>;
-    memberships?: Record<string, {
-        count?: number;
-        expiresAt?: number;
-        lastUpdated?: number;
-    }>;
-    /** auth identifiers. like social tiktok or email or sms or whatever */
-    identifiers?: Array<{
-        /** id */
-        identifier: string;
-        /** sms/email/tiktok etc */
-        platform: string;
-        lastUpdated: number;
-    }>;
-    cryptoWallets?: Array<{
-        address: string;
-        lastUpdated?: number;
-    }>;
-    tags?: Array<string>;
-    tagsLastUpdated?: number;
-    entityKind?: string;
-    /**
-     * Links to other entities (players, pets, guilds, etc.)
-     */
-    entityLinks?: Array<{
-        /** if undefined, it means same game */
-        gameId?: string;
-        playerId: string;
-        kind?: string;
-    }>;
-    /**
-     * collection of information about IP address player connected from
-     */
-    ip?: IPlayerIpInfo;
-}
-export type IClientStackedData = IClientUser & IConditionEvaluationData & {
-    apps: {
-        [gameId: string]: IClientPlayerData;
-    };
-};
-export type IClientUser = Pick<IUser, 'appConnections' | 'providers'>;
-export type IClientPlayerSnapshot = Omit<IPlayerSnapshot, 'tags' | 'tagsLastUpdated' | 'ip' | 'identifiers' | 'cryptoWallets'>;
-export type IClientPlayerData = Omit<IPlayerData, '_id' | 'restriction' | 'blockchainSync'>;
-export interface IConditionEvaluationData {
-    cryptoWallets?: Array<{
-        address: string;
-        balances: Record<string, number>;
-    }>;
-}
-export interface IPlayerDataCurrency {
-    /**
-     * balance held
-     */
-    balance: number;
-    /**
-     * total amount deposited
-     */
-    in?: number;
-    /**
-     * total amount withdrawn
-     */
-    out?: number;
-    /**
-     * last updated timestamp
-     * if not present, means never updated
-     */
-    lastUpdated?: number;
-}
-export interface IPlayerData {
-    _id?: Stringable;
-    gameId: string;
-    playerId: string;
-    currencies?: Record<string, IPlayerDataCurrency>;
-    blockchainSync?: Record<string, IBlockchainSyncStatus>;
-    restriction?: Restriction;
-}
-export interface IPlayerIpInfo {
-    lastUpdated: Date;
-    ipAddress: string;
-    vpn?: boolean;
-    proxy?: boolean;
-    tor?: boolean;
-    relay?: boolean;
-    timeZone: string;
-    regionCode?: string;
-    countryCode?: string;
-    continentCode?: string;
-}
-export interface IBaseCondition {
-    /** how many days worth of consecutive logins are required to surface? Or complete this? If checking completion conditions, we need to subtract
-     * this number from IPlayerOffer.completionTrackers.currentLoginStreak to see how many consecutive logins the player has had since surfacing this offer.
-     */
-    loginStreak?: number;
-    levels?: Record<string, {
-        /** public facing display name */
-        name: string;
-        /** min level required */
-        min?: number;
-        /** max level for offer */
-        max?: number;
-    }>;
-    stakedTokens?: Record<string, {
-        /** public facing display name */
-        name: string;
-        /** min amount of tokens that need to be staked? */
-        min?: number;
-    }>;
-    /** if the condition revolves around having a specific amount of currency or currencies. Key is the currencyId
-     * and the value is the min or max amount of that currency the player must have to be eligible for this offer
-     */
-    currencies?: Record<string, {
-        /** public facing display name */
-        name: string;
-        /** if the player has this currency, how much do they need to have? */
-        min?: number;
-        /** if the player has this currency, how much do they need to have? */
-        max?: number;
-        /** required deposits required for this currency */
-        in?: number;
-        /** required withdrawals required for this currency */
-        out?: number;
-    }>;
-    /** for high-rep kind, how much rep does a player need to qualify? */
-    minTrustScore?: number;
-    maxTrustScore?: number;
-    /** number of days that the player has logged in-game. Not the absolute amount of time playing the game. But number of days they have logged in for.
-     * Can obtain this on a DAILY join_room player metric if it is set up.
-     */
-    minDaysInGame?: number;
-    /** achievements that this player has */
-    achievements?: Record<string, {
-        name: string;
-        minCount?: number;
-    }>;
-    memberships?: Record<string, {
-        /** public facing display name */
-        name: string;
-        /** if the player has this currency, how much do they need to have? */
-        minCount?: number;
-        /** if the player has this currency, how much do they need to have? */
-        maxCount?: number;
-        /** how long does a player have to have this membership? */
-        minMs?: number;
-        /** max duration a player can have this membership for */
-        maxMs?: number;
-    }>;
-    /** player must have completed these quests for this offer to surface */
-    quests?: Record<string, {
-        /** public facing display name */
-        name: string;
-        /** if a min number of quest completions is required */
-        completions?: number;
-    }>;
-    /**
-     * For player snapshot entities that are linked to other player snap entities,
-     * what are the min and max number of links of a specific link kind?
-     * Keys are link kinds (e.g., "pet", "guild", "npc", etc.)
-     */
-    links?: Record<string, {
-        /** minimum number of links of this type required */
-        min?: number;
-        /** maximum number of links of this type allowed */
-        max?: number;
-        /** Template using {current}, {min}, {max}, {type} - e.g., "Own {min} pets ({current}/{min})" */
-        template?: string;
-    }>;
-    /** dynamic field conditions */
-    dynamic?: IDynamicGroup;
-    /** Auth platform identifiers condition */
-    identifiers?: {
-        /** List of auth platforms to check (e.g., 'tiktok', 'google', 'email') */
-        platforms: string[];
-        /** 'AND' = player must have ALL platforms, 'OR' = player must have ANY platform */
-        behaviour: 'AND' | 'OR';
-    };
-    /**
-     * On-chain token balance conditions - check wallet balances across specified contracts/networks.
-     * Balances are summed across all specified contracts and all player wallets.
-     */
-    tokenBalances?: Array<{
-        /** Display name for this condition (e.g., "PIXEL Token") */
-        name: string;
-        /** List of contract+network pairs to check. Balances summed across all pairs. */
-        contracts: Array<{
-            /** Token contract address (lowercase) */
-            contractAddress: string;
-            /** Network identifier (e.g., 'ronin-mainnet', 'ethereum-mainnet') */
-            network: string;
-        }>;
-        /** Minimum total balance required */
-        min?: number;
-        /** Maximum total balance allowed */
-        max?: number;
-    }>;
-}
-export interface ISurfacingCondition extends IBaseCondition {
-    /** number of days that the player has logged in-game. Not the absolute amount of time playing the game. But number of days they have logged in for.
-     * Can obtain this on a DAILY join_room player metric if it is set up.
-     */
-    maxDaysInGame?: number;
-    /** player must have all tags specified to be eligible */
-    andTags?: Array<string>;
-    /** player can have any of these tags to be eligible */
-    orTags?: Array<string>;
-    /** player cannot have any of these tags */
-    notTags?: Array<string>;
-    /** minimum signup date (timestamp) - player must have signed up after this date */
-    minDateSignedUp?: number;
-    /** maximum signup date (timestamp) - player must have signed up before this date */
-    maxDateSignedUp?: number;
-    /** player must have completed ALL of these offers (AND logic) - array of offer IDs */
-    completedOffers?: Array<string>;
-    /** surfacing contexts */
-    contexts?: Array<string>;
-    /** if true, offer can only be surfaced programmatically (e.g., via spawnLinkedOffer) - never through normal auto-surfacing */
-    programmatic?: boolean;
-    /** entity types that this offer can surface to - undefined or empty means only regular players. */
-    targetEntityTypes?: string[];
-    /** List of allowed country codes (whitelist mode) */
-    allowedCountries?: Array<string>;
-    /** List of restricted country codes (blacklist mode) - mutually exclusive with allowedCountries */
-    restrictedCountries?: Array<string>;
-    /** List of blocked network types - VPN/TOR/PROXY/RELAY */
-    networkRestrictions?: Array<'vpn' | 'tor' | 'proxy' | 'relay'>;
-    /** Check if any linked entity (by kind) has a specific offer in surfaced/viewed status. */
-    linkedEntityOffers?: {
-        /** The entityLink kind to filter (e.g., "parent", "guild", "pet") */
-        kind?: string;
-        /** The offer_id to check for on linked entities */
-        offer_id?: string;
-        conditions?: ISurfacingCondition;
-    };
-}
-/** conditions that must be met for an already surfaced offer to be claimable */
-export interface ICompletionCondition extends IBaseCondition {
-    /** itemId that must be bought to complete */
-    buyItem?: {
-        id: string;
-        name: string;
-        /** amount of item bought or currency spent/deposited to fufil condition */
-        amount?: number;
-    };
-    /** currencyId that must be spent to complete */
-    spendCurrency?: {
-        id: string;
-        name: string;
-        /** amount of item bought or currency spent/deposited to fufil condition */
-        amount?: number;
-    };
-    /** currencyId that must be deposited to complete */
-    depositCurrency?: {
-        id: string;
-        name: string;
-        /** amount of item bought or currency spent/deposited to fufil condition */
-        amount?: number;
-    };
-    /** social media content condition - player must attach content meeting requirements */
-    social?: {
-        /** 'attach' (default) = user attaches single content, 'accumulate' = auto-sum all matching content */
-        mode?: 'attach' | 'accumulate';
-        /** platforms accepted (OR logic) - e.g., ['tiktok', 'instagram', 'youtube'] */
-        platforms: string[];
-        /** words that must ALL appear in video title or description (case-insensitive). Hashtags must match exactly including # */
-        requiredWords: string[];
-        /** minimum view count required on the video (0 = no requirement) */
-        minViews: number;
-        /** minimum like count required on the video (0 = no requirement) */
-        minLikes: number;
-        /** minimum comment count required on the video (0 = no requirement) */
-        minComments: number;
-        /** content must be posted after this timestamp in milliseconds (defaults to time of offer creation) */
-        postedAfterMs: number;
-    };
-    login?: boolean;
-    /** for contexts that require completion conditions. We have a name field so that we can display a user-friendly name
-     * for the completion condition when it is rendered to the player. */
-    context?: {
-        id: string;
-        name: string;
-    };
-    /**
-     * Linked completions - wait for N linked entities to complete their offers
-     */
-    linkedCompletions?: {
-        /** Number of linked entity completions required */
-        min: number;
-        /** Template using {current}, {required} - e.g., "Complete {current}/{required} referrals" */
-        template?: string;
-    };
-    /**
-     * Dynamic field tracker - tracks changes to dynamic fields AFTER offer surfacing.
-     * Unlike the base `dynamic` condition which checks snapshot totals,
-     * this tracks per-offer values since surfacing.
-     */
-    dynamicTracker?: IDynamicGroup;
-    /**
-     * Contract interaction tracker - tracks blockchain events for currencies, NFTs, and custom events.
-     * Keyed by condition ID for multiple trackers.
-     */
-    contractInteractions?: Record<string, {
-        /** Template using {current}, {amount} - e.g., "Spend {amount} PIXEL ({current}/{amount})" */
-        template: string;
-        /**
-         * Event type to track:
-         * - 'spend': Currency transferred OUT (onchain_currency_tx kind=spend)
-         * - 'earn': Currency transferred IN (onchain_currency_tx kind=earn)
-         * - 'lose': NFT transferred OUT (onchain_item_tx kind=lose)
-         * - 'gain': NFT transferred IN (onchain_item_tx kind=gain)
-         * - 'onchain_X': Custom event (e.g., 'onchain_staked')
-         */
-        event: 'spend' | 'earn' | 'lose' | 'gain' | `onchain_${string}`;
-        /** List of contract+network pairs to track. Events from any of these count. */
-        contracts: Array<{
-            /** Contract address (lowercase) */
-            contractAddress: string;
-            /** Network identifier (e.g., 'ronin-mainnet', 'ethereum-mainnet') */
-            network: string;
-        }>;
-        /** Optional: Only count transfers TO these addresses (for spend/lose). Empty = all destinations. */
-        destinations?: string[];
-        /** Optional: Only count transfers FROM these addresses (for earn/gain). Empty = all sources. */
-        sources?: string[];
-        /**
-         * Target amount/count:
-         * - For currencies (spend/earn): token amount
-         * - For NFTs (gain/lose): NFT count
-         * - For custom events: event occurrence count
-         */
-        amount: number;
-    }>;
-}
-/**
- * TypeScript interface for dynamicGroupSchema
- */
-export type DynamicConditionOperator = '==' | '!=' | '>' | '>=' | '<' | '<=' | 'has' | 'not_has';
-export interface IDynamicCondition {
-    key: string;
-    compareTo: string | number | boolean;
-    operator: DynamicConditionOperator;
-    /** If you only want to update this tracker key every X hrs (like once per day), set here */
-    intervalHr?: number;
-}
-/**
- * links[i] is the link between conditions[i] and conditions[i+1]. Can be 'AND', 'OR', or 'AND NOT'.
- */
-export type DynamicConditionLink = 'AND' | 'OR' | 'AND NOT';
-export interface IDynamicGroup {
-    conditions: Array<IDynamicCondition>;
-    links?: Array<DynamicConditionLink>;
-    /** Display template using {keyName} syntax for referenced dynamic keys */
-    template?: string;
-}
-/** Social tracker for attach mode - user manually attaches a single piece of content */
-export interface ISocialTrackerAttach {
-    /** platform name - tiktok, instagram, or youtube */
-    platform: string;
-    /** video ID on the platform */
-    videoId: string;
-    /** platform specific user ID */
-    userId: string;
-    /** cached video title for display */
-    title?: string;
-    /** cached view count */
-    views: number;
-    /** cached like count */
-    likes?: number;
-    /** cached comment count */
-    comments?: number;
-    /** timestamp of last validation check (for 5-minute cache) */
-    lastChecked: Date;
-}
-/** Social tracker for accumulate mode - auto-sum all matching content */
-export interface ISocialTrackerAccumulate {
-    /** sum of view counts across all matching content */
-    views: number;
-    /** sum of like counts across all matching content */
-    likes?: number;
-    /** sum of comment counts across all matching content */
-    comments?: number;
-    /** timestamp of last validation check (for 5-minute cache) */
-    lastChecked: Date;
-    /** number of matching content items */
-    matchCount: number;
-}
-export interface ICompletionDynamicTracker {
-    value: string | number | boolean;
-    lastUpdated?: number;
-}
-/** tracking the player's status for completing the conditions to claim the offer, if
- * required.
- */
-export interface ICompletionTrackers {
-    /** how many counts of the required item has been bought. itemId and amount required defined in completionConditions */
-    buyItem?: number;
-    /** how many counts of the required currency has been spent. currencyId and amount required defined in completionConditions */
-    spendCurrency?: number;
-    /** how many counts of the required currency has been deposited. currencyId and amount required defined in completionConditions */
-    depositCurrency?: number;
-    /** the number of days that have been consecutively logged in at the time of surfacing this offer */
-    currentLoginStreak?: number;
-    /** tracks attached social media content and cached validation state */
-    social?: ISocialTrackerAttach | ISocialTrackerAccumulate;
-    /** completed context for this player */
-    context?: string;
-    /**
-     * Count of linked entities that have completed their offers.
-     * For example a referrer refers 5 other referees that have all
-     * completed the referral criteria. this would then be a value of 5.
-     */
-    linkedCompletions?: number;
-    /**
-     * Tracked dynamic field values per key.
-     * Key = dynamic field key, Value = tracked value since offer surfaced
-     */
-    dynamicTracker?: Record<string, ICompletionDynamicTracker>;
-    /**
-     * Tracked contract interaction values per condition ID.
-     * Key = condition ID, Value = accumulated amount/count since offer surfaced
-     * - For spend/earn: token amount
-     * - For gain/lose: NFT count
-     * - For custom onchain events: event occurrence count
-     */
-    contractInteractions?: Record<string, number>;
-}

package/dist/types/reward.d.ts

@@ -1,39 +0,0 @@
-export interface IReward {
-    /** reward kind */
-    kind: RewardKind;
-    /** if the trigger is type daily-login, which day is this reward for? */
-    /** reward id for rewards of kind item, coins, exp or loyalty currency */
-    rewardId?: string;
-    /** amount of reward to give. If kind is discount, then this refers to the discount amount, as a fraction */
-    amount: number;
-    /** public facing name for this reward */
-    name: string;
-    /** unique image url for this reward */
-    image?: string;
-}
-export type RewardKind = (typeof rewardKinds)[number];
-/** for client side sdk */
-export interface IResolvedReward extends IReward {
-    image?: string;
-}
-export declare const rewardKinds: readonly ["item", "coins", "exp", "trust_points", "loyalty_currency", "discount"];
-export declare const rewardSchema: {
-    _id: boolean;
-    kind: {
-        type: StringConstructor;
-        enum: readonly ["item", "coins", "exp", "trust_points", "loyalty_currency", "discount"];
-    };
-    rewardId: {
-        type: StringConstructor;
-        validate: {
-            validator: (this: IReward, value: string | undefined) => boolean;
-            message: string;
-        };
-    };
-    skillId: StringConstructor;
-    currencyId: StringConstructor;
-    itemId: StringConstructor;
-    amount: NumberConstructor;
-    name: StringConstructor;
-    image: StringConstructor;
-};

package/dist/types/user.d.ts

@@ -1,62 +0,0 @@
-import { Stringable } from '.';
-export interface AppConnection {
-    gameId: string;
-    playerId: string;
-    linkedAt: Date;
-}
-export type Restriction = {
-    kind?: 'block' | 'restrict';
-    start?: number;
-    until?: number;
-    eventCount: number;
-    message?: string;
-};
-export interface IUser {
-    _id: Stringable;
-    deleted?: boolean;
-    authId: string;
-    appConnections?: Array<AppConnection>;
-    cryptoWallets?: Array<{
-        address: string;
-        createdAt: number;
-    }>;
-    rewardWallets?: Array<{
-        address: string;
-        createdAt: number;
-        networks: Array<string>;
-    }>;
-    providers?: Array<{
-        provider: string;
-        accessToken: string;
-        refreshToken?: string;
-        expiresAt?: Date;
-        refreshTokenExpiresAt?: Date;
-        scope?: string;
-        tokenType?: string;
-        providerUserId?: string;
-        updatedAt: Date;
-        displayName?: string;
-        username?: string;
-    }>;
-    restriction?: Restriction;
-}
-export interface IAuthProvider {
-    type: string;
-    providerUserId?: string;
-    profilePic: string;
-    username?: string;
-    displayName?: string;
-}
-export interface AuthMethods {
-    wallets?: Array<{
-        address: string;
-        type: string;
-    }>;
-    emails?: Array<{
-        email: string;
-    }>;
-    phones?: Array<{
-        phone: string;
-    }>;
-    providers?: Array<IAuthProvider>;
-}

package/dist/types/user_wallet.d.ts

@@ -1,36 +0,0 @@
-export type ProviderType = 'coinbase' | 'okx' | 'metamask' | 'trust' | 'ronin' | 'walletConnect' | string;
-export interface ICryptoWallet {
-    /**
-     * wallet address
-     */
-    address: string;
-    added?: number;
-    wallet?: ProviderType;
-    providers?: Array<ProviderType>;
-}
-export interface ICryptoBalance {
-    /**
-     * balance held
-     */
-    balance: number;
-    /**
-     * total amount deposited
-     */
-    in?: number;
-    /**
-     * total amount withdrawn
-     */
-    out?: number;
-    /**
-     * last updated timestamp
-     * if not present, means never updated
-     */
-    lastUpdated?: number;
-}
-export type CoinSyncStatusType = 'pending' | 'success' | 'error' | 'exclusive' | 'synced' | null;
-export interface IBlockchainSyncStatus {
-    ts: number | null;
-    status: CoinSyncStatusType;
-    waiting?: boolean;
-    error?: string;
-}

package/dist/utils/blockchain_utils.d.ts

@@ -1,5 +0,0 @@
-export declare const addressNetworkId: (contractAddress: string, network: string) => string;
-export declare const deconstructAddressNetworkId: (addressNetwork: string) => {
-    address: string;
-    network: string;
-};