@stackedapp/types 1.9.16 → 1.9.18

package/dist/index.js

@@ -20,4 +20,7 @@ __exportStar(require("./stacked_reward"), exports);
 __exportStar(require("./stacked_snapshot"), exports);
 __exportStar(require("./stacked_user"), exports);
 __exportStar(require("./stacked_response"), exports);
+__exportStar(require("./stacked_content"), exports);
+__exportStar(require("./stacked_app"), exports);
+__exportStar(require("./stacked_currency"), exports);
 //# sourceMappingURL=index.js.map

package/dist/stacked-types.d.ts

@@ -896,7 +896,496 @@ interface StackedCampaignsServerResponse extends StackedCampaignsBaseResponse {
     /** @deprecated use player.stackedData instead */
     playerData?: StackedEntityData;
 }
+type GetOneTimeAuthTokenResponse = {
+    token: string;
+};
+type ExchangeOneTimeTokenForSessionTokenResponse = {
+    playerId: string;
+    gameId: string;
+    token: string;
+    player: {
+        snapshot?: StackedSnapshot;
+        data?: StackedEntityData;
+    };
+};
+type GenerateStackedLinkTokenResponse = {
+    token: string;
+};
+type ExchangeStackedLinkTokenResponse = {
+    linked: boolean;
+    alreadyLinked: boolean;
+};
+type InitializeUnifiedUserResponse = StackedUserComplete;
+type LinkExternalGameToUnifiedAccountResponse = {
+    user?: StackedBaseUser;
+};
+type UnlinkExternalGameFromUnifiedAccountResponse = LinkExternalGameToUnifiedAccountResponse;
+type StartOneTimeAuthResponse = {
+    message: string;
+    sessionId: string;
+    method_id: string;
+};
+type CompleteOneTimeAuthResponse = {
+    success: boolean;
+    user: StackedUserComplete;
+    session_token: string;
+};
+type StartCryptoAuthResponse = {
+    challenge: string;
+};
+type CompleteCryptoAuthResponse = {
+    success: boolean;
+    user: StackedUserComplete;
+    session_token: string;
+};
+type DeleteAccountResponse = {
+    success: boolean;
+};
+type RemoveAuthMethodResponse = {
+    success: boolean;
+};
+type StartOAuthResponse = {
+    url: string;
+};
+type StartOAuthAttachResponse = {
+    url: string;
+};
+type CompleteOAuthResponse = {
+    success: boolean;
+    user: StackedUserComplete;
+    session_token: string;
+};
+type RemoveOAuthProviderResponse = {
+    success: boolean;
+    message?: string;
+};
+type SignOutUnifiedUserResponse = {
+    success: boolean;
+    message?: string;
+};
+
+interface ContentItem {
+    id: string;
+    title: string;
+    description?: string;
+    thumbnail?: string;
+    platform: string;
+    platformId: string;
+    views?: number;
+    likes?: number;
+    comments?: number;
+    shares?: number;
+    duration?: number;
+    createdAt: string;
+    url?: string;
+    embedHtml?: string;
+    coverImageUrl?: string;
+    musicTitle?: string;
+    musicAuthor?: string;
+    attachedOfferId?: string;
+}
+interface ContentResponse {
+    items: ContentItem[];
+    cursor?: string | number;
+    hasMore: boolean;
+    totalCount?: number;
+}
+interface ContentStats {
+    totalViews: number;
+    totalLikes: number;
+    totalComments: number;
+    totalShares: number;
+    totalContent: number;
+    avgEngagementRate: number;
+    topContent?: ContentItem[];
+}
+
+type StackedContentItem = ContentItem;
+type StackedContentResponse = ContentResponse;
+type StackedContentStats = ContentStats;
+
+/**
+ * doc that defines a third party app
+ */
+interface IThirdPartyApp {
+    /** the organization_id from stytch for b2b auth */
+    stytchId?: string;
+    /** fireblocks vault id */
+    vaultId?: string;
+    /** growthbook project id */
+    growthbookProjectId?: string;
+    /** should we show advanced offer fields and settings? */
+    advancedOffers?: boolean;
+    /** If ture, the stacked app should show this
+     * org as a connection even if it hasn't been linked
+     * or tunneled into yet
+     */
+    showLinkable?: string;
+    /** url of this game. must exist with showLinkable
+     * if it is to be shown in the app always
+     */
+    url?: string;
+    /**
+     * third party app id
+     */
+    id: string;
+    /**
+     * third party app display name
+     */
+    displayName: string;
+    /**
+     * third party app image
+     */
+    image?: string;
+    /**
+     * third party app client id - this is public
+     */
+    clientId: string;
+    /**
+     * third party app api key
+     */
+    apiKey: string;
+    /** a list of sdk events and when this specific organization received events last from sdk */
+    sdkEvents?: Record<string, {
+        lastReceived: number;
+        data?: any;
+    }>;
+    /** Short tagline for the game (e.g., "Farm, explore & earn in a pixel world") */
+    tagline?: string;
+    /** Longer description of the game */
+    description?: string;
+    /** Game genres/categories (e.g., ['RPG', 'Farming', 'Web3']) */
+    genres?: string[];
+    /** YouTube or video trailer URL */
+    trailerUrl?: string;
+    /** Game thumbnail image URL */
+    gameThumbnail?: string;
+    /** Game logo URL */
+    logo?: string;
+    /** Square logo variant URL */
+    squareLogo?: string;
+    /** Header/banner image URL */
+    headerImage?: string;
+    /** Featured square screenshot URL */
+    squareScreenshot?: string;
+    /** Array of screenshot URLs for the game */
+    screenshots?: string[];
+    /** iOS App Store URL */
+    appStoreUrl?: string;
+    /** Google Play Store URL */
+    playStoreUrl?: string;
+    /** Browser game URL (if different from main url) */
+    webUrl?: string;
+    /** Marketing landing page URL */
+    landingPageUrl?: string;
+    /** App Store rating (e.g., 4.8) */
+    appStoreRating?: number;
+    /** Number of ratings on App Store */
+    appStoreRatingCount?: number;
+    /** Play Store rating (e.g., 4.5) */
+    playStoreRating?: number;
+    /** Number of ratings on Play Store */
+    playStoreRatingCount?: number;
+    /** Offer presets - named configurations for offer targeting (countries, network restrictions) */
+    offerPresets?: Array<{
+        name: string;
+        /** Whitelist mode - only these countries can see offers using this preset */
+        allowedCountries?: string[];
+        /** Blacklist mode - these countries cannot see offers using this preset */
+        restrictedCountries?: string[];
+        /** Network types to block */
+        networkRestrictions?: ('vpn' | 'tor' | 'proxy' | 'relay')[];
+    }>;
+    /** Name of the default offer preset to use for new offers */
+    offerPresetDefault?: string;
+}
+
+/**
+ * Represents an active listener config from blockchain_server.
+ * Data comes from POST /api/listener-configs/active endpoint.
+ */
+interface IActiveListener {
+    /** Listener config ID */
+    _id: string;
+    /** Listener name (e.g., "Ronin $PIXEL Transfer") */
+    name: string;
+    /** Populated contract reference */
+    contract_id: {
+        _id: string;
+        contract_address: string;
+        name: string;
+        symbol: string;
+    };
+    /** Populated RPC provider reference */
+    rpc_provider_config_id: {
+        _id: string;
+        name: string;
+        network: string;
+    };
+    /** Events being tracked by this listener */
+    events_to_track: string[];
+    /** Whether this listener is active */
+    is_active: boolean;
+    /** Post-processing configuration for balance fetching */
+    post_processing?: {
+        enabled: boolean;
+        fetch_native_balances: string[];
+        fetch_erc20_balances: string[];
+        fetch_erc721_balances: string[];
+        fetch_erc1155_balances: Array<{
+            contract_id: string;
+            token_ids: string[];
+        }>;
+    };
+    /** Schedule for when this listener runs */
+    schedule?: {
+        start_datetime: string;
+        end_datetime: string;
+    };
+    createdAt: string;
+    updatedAt: string;
+}
+
+interface IAppState {
+    /**
+     * our app config. Just pixels using db for now, but
+     * could have config for pixels_data, too, and maybe
+     * 'pets' in future, or 'retool'...
+     * ('blockchain' app now has separate config)
+     */
+    appName: string;
+    /**
+     * overrides for environment variables. Gets put into keys of serverConfig
+     */
+    environment?: Record<string, string>;
+    /** threshold for adding wallet after it's deleted */
+    deleteWalletThresholdDays?: number;
+    /**
+     * feature flags for the app. These are used to enable/disable
+     */
+    featureFlags?: Record<string, boolean>;
+    /**
+     * List of event names we don't want to track.
+     */
+    disabledEventNames?: string[];
+    tokens?: Array<{
+        symbol: string;
+    }>;
+    /** getting deprecated */
+    segments?: Array<{
+        name: string;
+        /** specific orgIds that can see and use this specific segment */
+        orgIds?: Array<string>;
+    }>;
+    /** key is the segment GROUP. segmentation tags are mutually exclusive within a group */
+    segmentGroups: Record<string, {
+        tags: Array<string>;
+    }>;
+    restrictedCountryCodes?: {
+        withdraw: Array<string>;
+        deposit: Array<string>;
+        rewardBadges: Array<string>;
+    };
+    currencyPrices: {
+        /** how often refresh curr prices */
+        refreshMs: number;
+        /** convert targets. eth and usd default */
+        convertTo: Array<string>;
+    };
+    /** if undefined, the infinite */
+    maxOfferSlots?: number;
+    maxCryptoWallets?: number;
+    defaultRakePercentage?: number;
+    adminOrgIds?: string[];
+    /** number of days before a player snapshot can be UNLINKED and then RELINKED to a new account  */
+    unifiedUserLinkCooldown?: number;
+    notifications?: {
+        /** how long does the offer need to have been created and still in active status for us to send a targetted notif? */
+        offerCreatedMsRequired?: number;
+        pushCooldown?: number;
+        lastLoggedInCooldown?: number;
+        batchSize?: number;
+    };
+    /** Maximum number of active offers a player can have at once. Defaults to 25 */
+    maxActiveOffersPerPlayer?: number;
+    activeListeners?: Record<string, IActiveListener[]>;
+}
+
+type StackedThirdPartyApp = Pick<IThirdPartyApp, 'id' | 'displayName' | 'image' | 'showLinkable' | 'url' | 'tagline' | 'description' | 'genres' | 'trailerUrl' | 'gameThumbnail' | 'logo' | 'squareLogo' | 'headerImage' | 'squareScreenshot' | 'screenshots' | 'appStoreUrl' | 'playStoreUrl' | 'webUrl' | 'landingPageUrl' | 'appStoreRating' | 'appStoreRatingCount' | 'playStoreRating' | 'playStoreRatingCount'>;
+type StackedAppState = Pick<IAppState, 'featureFlags' | 'maxCryptoWallets' | 'maxOfferSlots' | 'restrictedCountryCodes' | 'deleteWalletThresholdDays'>;
+
+type SupportedNetwork = 'ethereum' | 'sepolia' | 'matic' | 'amoy' | 'bsc' | 'bsctestnet' | 'base' | 'basesepoliatestnet' | 'ronin' | 'saigon';
+interface ICurrency {
+    _id: Stringable;
+    /** if true, then this currency can be used as a reward currency from offerwall/neo */
+    rewardable?: boolean;
+    /**
+     * id of the currency: cur_pixel, cur_berry, cur_gold, etc.
+     */
+    id: string;
+    /**
+     * true if this currency no longer used. do not send
+     * the currency info to client.
+     */
+    archived?: boolean;
+    /**
+     * Display Name of the currency: $PIXEL, $BERRY, $GOLD, etc.
+     */
+    name?: string;
+    /**
+     * VIP points earned per unit of currency spent
+     */
+    vipPoints?: number;
+    /**
+     * currency (ERC-20) contract address. This is used for deposit and withdraw
+     * and for burning.
+     * for a compound currency, this is the ERC20 that will be burned.
+     */
+    contractAddress?: string;
+    /**
+     * contract network for this currency
+     */
+    network?: SupportedNetwork;
+    /** default network for this currency? */
+    default?: boolean;
+    /**
+     * a list of wallets to send (withdraw) from
+     */
+    operators?: Array<string>;
+    /**
+     * list of wallets to receive deposits
+     */
+    depositors?: Array<string>;
+    /**
+     * list of retired wallets we still might need to work with. Accept deposits or continue
+     * withdrawals initiated on these wallets, but do not use them for new transactions.
+     */
+    additional?: Array<string>;
+    /**
+     * for image/size of the currency symbol
+     */
+    image: string;
+    /**
+     * abi of the currency contract
+     */
+    abi?: any;
+    /**
+     * reset timestamp. If a player most recently saved before this date, we
+     * clear this currency from their wallet. Only used on temporary currencies.
+     * For safety, we do not reset if a currency has a crypto contract or for
+     * cur_coins
+     */
+    resetAt?: number;
+    /**
+     * tenants to use this currency on. empty for all.
+     */
+    tenants: Array<string>;
+    /**
+     * round decimal places when saving, depositing, withdrawing.
+     */
+    roundDecimalPlaces?: number;
+    /**
+     * a composite currency composed the balance as a SUM of the balances
+     * of the components. The currencies are spent in array order (first one first)
+     */
+    composite?: string[];
+    /**
+     * if set, when this currency is increased for a player, it will use this
+     * component currencyId (must be in composite array). by default, it will
+     * use the first entry in composite array
+     */
+    rewardComponent?: string;
+    /**
+     * internal and not persisted to db, this tracks which currencies are
+     * components of other currencies, so that in the event they get changed,
+     * the composite can be updated as well.
+     */
+    componentOf?: string;
+    withdraw?: {
+        /** if undefined, then withdraw to any currency. This only matters if Currency.rewardable is true. */
+        to?: Array<{
+            currencyId: string;
+            disabled?: boolean;
+        }>;
+        disabled: boolean;
+        min?: number;
+        max?: number;
+        maxPerDay?: number;
+        monthlyLimit?: number;
+        surcharge?: {
+            fixed: number;
+            percentage: number;
+        };
+        surcharges?: Array<{
+            reputation: number;
+            fixed: number;
+            percentage: number;
+        }>;
+        emergencyShutoff?: {
+            amount: number;
+            hours: number;
+        };
+        limits?: Array<{
+            maxTrust: number;
+            hours: number;
+            max: number;
+        }>;
+        autoApprovals?: Array<{
+            upTo: number;
+            hours: number;
+            minTrust?: number;
+        }>;
+    };
+    deposit?: {
+        disabled: boolean;
+        min?: number;
+        max?: number;
+        maxPerDay?: number;
+        needApproval?: boolean;
+        surcharge?: {
+            fixed: number;
+            percentage: number;
+        };
+        surcharges?: Array<{
+            reputation: number;
+            fixed: number;
+            percentage: number;
+        }>;
+        conversion?: {
+            toCurrency: string;
+            rate: number;
+        };
+    };
+}
+
+type CurrencyUnit = 'ETH' | 'USD';
+interface ILibraryCurrencyPrice {
+    id: string;
+    name: string;
+    symbol: string;
+    usdPrice: number;
+    default?: boolean;
+}
+
+type StackedSupportedNetwork = SupportedNetwork;
+type StackedCurrency = Pick<ICurrency, 'id' | 'name' | 'image' | 'contractAddress' | 'network' | 'default' | 'rewardable' | 'archived' | 'roundDecimalPlaces' | 'composite' | 'rewardComponent'> & {
+    withdraw?: {
+        to?: Array<{
+            currencyId: string;
+            disabled?: boolean;
+        }>;
+        disabled: boolean;
+        min?: number;
+        max?: number;
+    };
+    deposit?: {
+        disabled: boolean;
+        min?: number;
+        max?: number;
+    };
+};
+type StackedCurrencyPrice = ILibraryCurrencyPrice;
 
 type StackedEnv = IEnv;
 
-export type { IClientPlayerData, StackedAppConnection, StackedBaseConditions, StackedBaseOffer, StackedBaseUser, StackedBaseUserExtra, StackedCampaignsResponse, StackedCampaignsServerResponse, StackedClaimableConditions, StackedClaimableTrackers, StackedCompletionConditions, StackedCompletionDynamicTracker, StackedCompletionTrackers, StackedDynamicCondition, StackedDynamicGroup, StackedEntityCurrencies, StackedEntityData, StackedEnv, StackedOffer, StackedOfferTrackers, StackedReward, StackedRewardKind, StackedSnapshot, StackedSnapshotProgress, StackedSocialTrackerAccumulate, StackedSocialTrackerAttach, StackedUser, StackedUserComplete, StackedUserOffer, StackedUserResponse, StackedUserWithApps, UserOfferStatus };
+export type { CompleteCryptoAuthResponse, CompleteOAuthResponse, CompleteOneTimeAuthResponse, CurrencyUnit, DeleteAccountResponse, ExchangeOneTimeTokenForSessionTokenResponse, ExchangeStackedLinkTokenResponse, GenerateStackedLinkTokenResponse, GetOneTimeAuthTokenResponse, IClientPlayerData, InitializeUnifiedUserResponse, LinkExternalGameToUnifiedAccountResponse, RemoveAuthMethodResponse, RemoveOAuthProviderResponse, SignOutUnifiedUserResponse, StackedAppConnection, StackedAppState, StackedBaseConditions, StackedBaseOffer, StackedBaseUser, StackedBaseUserExtra, StackedCampaignsResponse, StackedCampaignsServerResponse, StackedClaimableConditions, StackedClaimableTrackers, StackedCompletionConditions, StackedCompletionDynamicTracker, StackedCompletionTrackers, StackedContentItem, StackedContentResponse, StackedContentStats, StackedCurrency, StackedCurrencyPrice, StackedDynamicCondition, StackedDynamicGroup, StackedEntityCurrencies, StackedEntityData, StackedEnv, StackedOffer, StackedOfferTrackers, StackedReward, StackedRewardKind, StackedSnapshot, StackedSnapshotProgress, StackedSocialTrackerAccumulate, StackedSocialTrackerAttach, StackedSupportedNetwork, StackedThirdPartyApp, StackedUser, StackedUserComplete, StackedUserOffer, StackedUserResponse, StackedUserWithApps, StartCryptoAuthResponse, StartOAuthAttachResponse, StartOAuthResponse, StartOneTimeAuthResponse, UnlinkExternalGameFromUnifiedAccountResponse, UserOfferStatus };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stackedapp/types",
-  "version": "1.9.16",
+  "version": "1.9.18",
   "description": "Public types for Stacked platform SDK",
   "main": "dist/index.js",
   "types": "dist/stacked-types.d.ts",