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

package/dist/types/offer.d.ts

@@ -1,274 +0,0 @@
-import { Stringable } from '.';
-import { ICompletionCondition, ICompletionTrackers, IPlayerSnapshot, ISurfacingCondition } from './player';
-import { IReward } from './reward';
-/** Referral configuration setup if we want to reward players from referring other players */
-export interface IOfferReferrals {
-    /** min count of successful referrals to get this reward */
-    minCount?: number;
-    /** max count of successful referrals to get this reward */
-    maxCount?: number;
-    /** conditions that each referred player must meet in order to qualify for the referral.
-     * don't allow tags to be used as conditions since players can't really control their tags direclty */
-    conditions: Omit<ISurfacingCondition, 'andTags' | 'orTags' | 'notTags'>;
-}
-/** onSurface and onComplete hooks for offers. Should support:
- * - Spawning linked offers for referral/referee type offers
- * - Creating cross-game offers
- * - Surfacing offers to other linked player snapshots
- *
- * When an offer is SURFACED to a player, we are able to:
- * - surface a linked offer in same game to self
- * - surface a linked offer in same game to other players
- * - surface a linked offer in different game to other players
- *
- * When an offer is COMPLETED by a player, we are able to:
- * - increment linked tracker of any player offer
- * - surface a linked offer in same game to self
- * - surface a linked offer in same game to other players
- * - surface a linked offer in different game to other players
- */
-export interface IOfferHookEvent {
-    _id?: undefined | false | null;
-    kind: 'spawn_linked_offer' | 'increment_linked_tracker' | 'increment_completed_siblings';
-    /** player snapshot entity kind that we are spawning the linked offer for */
-    target?: 'self' | string;
-}
-export declare const offerListenerEvents: readonly ["claim_offer"];
-export type OfferListenerEvent = (typeof offerListenerEvents)[number];
-export interface IOfferListener extends IOfferHookEvent {
-    event: OfferListenerEvent;
-}
-export interface IOffer {
-    _id: Stringable;
-    /** for grouping offers together if they are assocaited with each othert for easy rendering in front-end */
-    groupId?: string;
-    name: string;
-    /** how high of a priority is this offer in comparison to other offers? 1 is highest priority */
-    priority?: number;
-    description: string;
-    createdAt?: Date;
-    /** notes about this offer */
-    notes?: string;
-    /** if this offer is tied to other offers for a/b testing, this is the ID that ties
-     * all of the offers together
-     */
-    campaign?: string;
-    image?: string;
-    /** game that this offer corresponds to */
-    gameId: string;
-    /** start date of surfacing this offer to players */
-    startDate?: Date;
-    /** end date of surfacing this offer to players */
-    endDate?: Date;
-    /** if fully archived, the offer will be deleted from memory and not be surfaced anymore to ANYONE. Current players with the offer will no longer see it */
-    archived?: boolean;
-    /** is this offer disabled right now? */
-    disabled?: boolean;
-    /** labels for UI stuff */
-    labels?: Array<string>;
-    /** how long after completing this offer can a player get the same offer again? If undefined, this offer only shows up once EVER for the player */
-    cooldownMs?: number;
-    /** how long after a player receives this offer is it available for, before expiring? */
-    expiryMs?: number;
-    /** @description DO NOT USE! */
-    surfacingContexts?: string[];
-    /** conditions that all must be fulfilled if this offer is to be surfaced to a player */
-    surfacingConditions: ISurfacingCondition;
-    /** triggers that allow this offer to be claimable. Leave empty if merely surfacing the offer should allow claiming. */
-    completionConditions?: ICompletionCondition;
-    /**
-     * Conditions for transitioning from 'completed' to 'claimable' status.
-     * If absent, offers go directly to claimable when completionConditions are met.
-     */
-    claimableConditions?: {
-        /** number of sibling offers that must be completed to make this offer claimable (-1 means all siblings) */
-        siblingCompletions?: number;
-    };
-    /** what does completing this offer reward the player? */
-    rewards: Array<IReward>;
-    /** if you can claim rewards multiple times, what is the max claim count you can claim? */
-    maxClaimCount?: number;
-    /**
-     * Linked offer configuration - specifies which offer to spawn when this offer surfaces or completes
-     */
-    linkedOffer?: {
-        /** Specific offer _id to spawn */
-        _id?: Stringable;
-        /** OR use campaign for A/B test selection via GrowthBook.
-         *
-         * !!!THIS IS NOT SUPPORTED FOR CROSS-GAME OFFERS!!!
-         */
-        campaign?: string;
-    };
-    /**
-     * Actions to perform when this offer is surfaced to a player/entity
-     */
-    onSurface?: Array<IOfferHookEvent>;
-    /**
-     * Actions to perform when ANY instance of this offer is completed
-     * Gets copied to PlayerOffer and populated with specific IDs
-     */
-    onComplete?: Array<IOfferHookEvent>;
-    /**  */
-    eventListeners?: Array<IOfferListener>;
-    invitedGameId?: string;
-}
-export declare const PlayerOfferStatuses: readonly ["surfaced", "viewed", "completed", "claimable", "claimed", "expired"];
-export type PlayerOfferStatus = (typeof PlayerOfferStatuses)[number];
-export interface IPlayerOfferTrackers {
-    /********************** These are not really completion trackers, but just regular trackers **********************/
-    /** player snapshot _id of the person who surfaced this offer */
-    surfacer_id?: Stringable;
-    /** playerId of the person who surfaced this player offer */
-    surfacerPlayerId?: string;
-    /** gameId of the game who surfaced this player offer */
-    surfacerGameId?: string;
-    /** the referral code used to activate the .linkedOffer from the offer. */
-    referralCode?: string;
-    /** number of linked player offers spawned off this one. */
-    linkedCount?: number;
-    /** if this playerOffer was created due to someone else's offer hook event, what was their player offer _id? */
-    linkedByPlayerOffer_id?: Stringable;
-    /**
-     * IDs of sibling PlayerOffers created together (e.g., both parents from a pet offer).
-     * Used to check if all siblings completed before any can claim.
-     * If any sibling expires, all siblings should expire (strict co-op).
-     */
-    siblingPlayerOffer_ids?: Stringable[];
-    /**
-     * Tracks how many times a linked offer has been surfaced (for cross-game offers)
-     * Used to prevent duplicate surfacing when games are linked/unlinked/relinked
-     */
-    surfacedCount?: number;
-    claimedCount?: number;
-}
-export interface IPlayerOffer {
-    _id: Stringable;
-    /** starts at 1. multiples of the cooldown timeframe if there is a cooldown. there is a unique index on this and
-     * it ensures that we do not get multiple offers created for the same offer in the same cooldown timeframe if someone
-     * tries to abuse and slam the fetchPlayerOffers endpoint
-     */
-    cooldownTimeframeMultiple?: number;
-    /** offer id */
-    offer_id: Stringable | IOffer;
-    /** is this an offer that should be surfaced AND PUSHED in real-time to a player? */
-    realTime?: boolean;
-    claimedAt?: Date;
-    rewards: Array<IReward>;
-    /** when the player offer is created, we copy over all completion conditions to
-     * player offer so that if the original offer changes, the player still sees whatever
-     * the completion conditions were at the time of creation.
-     *
-     * If there are no completion conditions, then the offer should be claimable immediately
-     */
-    /** @deprecated in favour of IOffer.completionCondition. BUT ON CLIENT-SIDE WE USE THIS FIELD. but NOT on server!
-     * Server populates this field for client.
-     */
-    completionConditions?: ICompletionCondition;
-    /** tracking the player's status for completing the conditions to claim the offer, if
-     * required.
-     */
-    completionTrackers?: ICompletionTrackers;
-    trackers?: IPlayerOfferTrackers;
-    /**
-     * Trackers for claimableConditions (completed → claimable transition).
-     */
-    claimableTrackers?: {
-        /** Counter incremented when a sibling offer completes */
-        siblingCompletions?: number;
-    };
-    /** status of the offer
-     * - surfaced: offer is now surfaced to the player, but not viewed by the player yet.
-     * - viewed: offer has been viewed by the player, but not yet completed. The expiration time only starts when the player views the offer
-     * - completed: individual completionConditions met, waiting for claimableConditions (e.g., all siblings must complete)
-     * - claimable: offer has been completed and is now claimable by the player
-     * - claimed: offer has been completed and the player has claimed the rewards.
-     * - expired: offer has expired and is no longer available to the player
-     */
-    status: PlayerOfferStatus;
-    /** player _id */
-    playerId: string;
-    /** game _id */
-    gameId: string;
-    /** created at date */
-    createdAt: Date;
-    /** expiry date */
-    expiresAt?: Date;
-    /**
-     * Actions to perform when this PlayerOffer is completed
-     */
-    onComplete?: Array<IOfferHookEvent>;
-}
-declare const keysToTake: readonly ["playerId", "username", "daysInGame", "loginStreak", "levels", "quests", "currencies", "achievements", "memberships", "stakedTokens", "dynamic", "trustScore", "entityKind", "snapshotLastUpdated"];
-type StripLastUpdated<T> = T extends Record<string, infer U> ? U extends {
-    lastUpdated?: any;
-} ? Record<string, Omit<U, 'lastUpdated'>> : T : T;
-export type IStrippedSnapshot = {
-    [K in (typeof keysToTake)[number]]?: StripLastUpdated<IPlayerSnapshot[K]>;
-};
-/** Stripped sibling offer data for client rendering */
-export interface IClientEntityProgress {
-    status: PlayerOfferStatus;
-    completionTrackers?: ICompletionTrackers;
-    completionConditions?: ICompletionCondition;
-    snapshot?: IStrippedSnapshot;
-}
-export interface IClientOffer {
-    /** offer id */
-    offerId: string;
-    instanceId: string;
-    /** player _id */
-    playerId: string;
-    /** game that this offer corresponds to */
-    gameId: string;
-    /** optional group identifier for related offers (e.g., streak progression) */
-    groupId?: string;
-    name: string;
-    description: string;
-    image?: string;
-    /** when the player offer is created, we copy over all completion conditions to
-     * player offer so that if the original offer changes, the player still sees whatever
-     * the completion conditions were at the time of creation.
-     *
-     * If there are no completion conditions, then the offer should be claimable immediately
-     */
-    completionConditions?: ICompletionCondition;
-    /** tracking the player's status for completing the conditions to claim the offer, if
-     * required.
-     */
-    completionTrackers?: ICompletionTrackers;
-    claimableTrackers?: IPlayerOffer['claimableTrackers'];
-    trackers?: IPlayerOfferTrackers;
-    /** claimable conditions for the offer */
-    claimableConditions?: IOffer['claimableConditions'];
-    /** Labels for offer categorization and rendering
-     * Contains:
-     * - IOffer.labels (manual: 'featured', 'verified', 'quest')
-     * - Server-injected labels: 'daily', 'weekly', 'avgTimeToComplete:X', 'usdValue:X'
-     */
-    labels?: Array<string>;
-    /** what does completing this offer reward the player? */
-    rewards: Array<IReward>;
-    /** status of the offer
-     * - surfaced: offer is now surfaced to the player, but not viewed by the player yet.
-     * - viewed: offer has been viewed by the player, but not yet completed. The expiration time only starts when the player views the offer
-     * - completed: individual completionConditions met, waiting for claimableConditions (e.g., all siblings must complete)
-     * - claimable: offer has been completed and is now claimable by the player
-     * - claimed: offer has been completed and the player has claimed the rewards.
-     * - expired: offer has expired and is no longer available to the player
-     */
-    status: PlayerOfferStatus;
-    /** created at date */
-    createdAt: Date;
-    /** expiry date */
-    expiresAt?: Date;
-    /** Number of times the player has claimed this offer (for multi-claim offers) */
-    claimedCount?: number;
-    /** Maximum number of times this offer can be claimed (-1 for infinite, undefined for single claim) */
-    maxClaimCount?: number;
-    /** Siblings */
-    siblings?: IClientEntityProgress[];
-    /** Progress data for linked entity's offer (e.g., pet's progress on their task) */
-    linked?: IClientEntityProgress[];
-}
-export {};