@stackedapp/types 1.9.0 → 1.9.2

package/dist/index.js

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 // Re-export all public types
 __exportStar(require("./stacked_offer"), exports);
+__exportStar(require("./stacked_response"), exports);
 __exportStar(require("./stacked_reward"), exports);
 __exportStar(require("./stacked_snapshot"), exports);
 __exportStar(require("./stacked_user"), exports);

package/dist/stacked-types.d.ts

@@ -728,8 +728,11 @@ type Nullable<T> = {
 };
 /** this is the Stacked platforms' copy of a user/entity's snapshot for the current app/game */
 type StackedSnapshot = Nullable<Pick<IPlayerSnapshot, '_id' | 'gameId' | 'playerId' | 'unifiedUserLinkedAt' | 'unifiedUserUnlinkedAt' | 'referredById' | 'username' | 'snapshotLastUpdated' | 'offersLastChecked' | 'daysInGame' | 'loginStreak' | 'daysInGameLastUpdated' | 'dateSignedUp' | 'dynamic' | 'stakedTokens' | 'currencies' | 'levels' | 'quests' | 'trustScore' | 'trustLastUpdated' | 'achievements' | 'memberships' | 'cryptoWallets' | 'identifiers' | 'entityKind' | 'entityLinks'>>;
+type StackedEntityCurrencies = Record<string, IPlayerDataCurrency>;
 /** represents a stacked snapshot's data within a specific app/game. This is scoped to the app/game! */
-type StackedEntityData = Pick<IPlayerData, 'gameId' | 'playerId' | 'currencies'>;
+type StackedEntityData = Pick<IPlayerData, 'gameId' | 'playerId'> & {
+    currencies?: StackedEntityCurrencies;
+};
 
 type StackedCompletionConditions = ICompletionCondition;
 /** Stripped sibling offer data for client rendering */
@@ -763,11 +766,6 @@ type StackedOffer = StackedBaseOffer & StackedUserOffer & {
     instanceId: string;
 };
 
-type StackedRewardKind = RewardKind;
-interface StackedReward extends IReward {
-    image?: string;
-}
-
 /** represents a stacked consumer from the web/mobile app */
 type StackedBaseUser = Pick<IUser, '_id' | 'appConnections' | 'providers'>;
 /** extra data populated into a stacked web/mobile app user */
@@ -786,18 +784,44 @@ type StackedAppConnection = {
 type StackedUserResponse = {
     /** @deprecated use stackedData instead */
     data?: IClientPlayerData | null;
-    user?: StackedUser;
+    stackedUser?: StackedUser;
 } & StackedAppConnection;
 /** @deprecated - old way of getting a specific game player's currencies in stacked */
 type IClientPlayerData = StackedEntityData;
 /** Stacked mobile web app's initialize user response */
 interface StackedUserWithAppConnections {
-    user: StackedUser;
+    stackedUser: StackedUser;
     apps: {
         [appId: string]: StackedAppConnection;
     };
 }
 
+/** Base campaigns response - shared fields between client and server */
+interface StackedCampaignsBaseResponse extends StackedUserResponse {
+    /** List of offers/campaigns for the player */
+    offers: StackedOffer[];
+    /** Player's currency balances */
+    currencies?: StackedEntityCurrencies;
+}
+/** Client-side campaigns response (from JWT-authenticated endpoints) */
+type StackedCampaignsResponse = StackedCampaignsBaseResponse;
+/** Server-side campaigns response (from API key authenticated endpoints) */
+interface StackedCampaignsServerResponse extends StackedCampaignsBaseResponse {
+    /** @deprecated iframe session token for subsequent client calls */
+    token: string;
+    /** Game/app ID */
+    gameId: string;
+    /** @deprecated use player.snapshot instead */
+    playerSnapshot: StackedSnapshot;
+    /** @deprecated use player.stackedData instead */
+    playerData: StackedEntityData;
+}
+
+type StackedRewardKind = RewardKind;
+interface StackedReward extends IReward {
+    image?: string;
+}
+
 type StackedEnv = IEnv;
 
-export type { IClientPlayerData, StackedAppConnection, StackedBaseOffer, StackedBaseUser, StackedBaseUserExtra, StackedCompletionConditions, StackedEntityData, StackedEnv, StackedOffer, StackedReward, StackedRewardKind, StackedSnapshot, StackedSnapshotProgress, StackedUser, StackedUserOffer, StackedUserResponse, StackedUserWithAppConnections, UserOfferStatus };
+export type { IClientPlayerData, StackedAppConnection, StackedBaseOffer, StackedBaseUser, StackedBaseUserExtra, StackedCampaignsResponse, StackedCampaignsServerResponse, StackedCompletionConditions, StackedEntityCurrencies, StackedEntityData, StackedEnv, StackedOffer, StackedReward, StackedRewardKind, StackedSnapshot, StackedSnapshotProgress, StackedUser, StackedUserOffer, StackedUserResponse, StackedUserWithAppConnections, UserOfferStatus };

package/package.json

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