@stackedapp/types 1.5.10 → 1.6.0

package/dist/stacked-types.d.ts

@@ -557,6 +557,10 @@ type Restriction = {
     eventCount: number;
     message?: string;
 };
+type IUserCryptoWallet = {
+    address: string;
+    createdAt?: number;
+};
 interface IUser {
     _id: Stringable;
     deleted?: boolean;
@@ -571,10 +575,7 @@ interface IUser {
         /** last push generic notification to come back into the app */
         lastPushedGeneric?: number;
     };
-    cryptoWallets?: Array<{
-        address: string;
-        createdAt: number;
-    }>;
+    cryptoWallets?: Array<IUserCryptoWallet>;
     rewardWallets?: Array<{
         address: string;
         createdAt: number;
@@ -726,7 +727,7 @@ 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'>>;
 /** represents a stacked snapshot's data within a specific app/game. This is scoped to the app/game! */
-type StackedSnapshotData = Pick<IPlayerData, 'gameId' | 'playerId' | 'currencies'>;
+type StackedEntityData = Pick<IPlayerData, 'gameId' | 'playerId' | 'currencies'>;
 
 type StackedCompletionConditions = ICompletionCondition;
 /** Stripped sibling offer data for client rendering */
@@ -766,30 +767,35 @@ interface StackedReward extends IReward {
 }
 
 /** represents a stacked consumer from the web/mobile app */
-type StackedBaseUser = Pick<IUser, 'appConnections' | 'providers'>;
+type StackedBaseUser = Pick<IUser, '_id' | 'appConnections' | 'providers'>;
 /** extra data populated into a stacked web/mobile app user */
 interface StackedBaseUserExtra {
-    cryptoWallets?: Array<{
-        address: string;
+    cryptoWallets?: Array<IUserCryptoWallet & {
         balances: Record<string, number>;
     }>;
 }
-type StackedUser = StackedBaseUser & StackedBaseUserExtra & {
-    apps: {
-        [appId: string]: StackedSnapshotData;
-    };
+type StackedUser = StackedBaseUser & StackedBaseUserExtra;
+/** This user's app connection data which is a snapshot of their profile in your app, plus the stacked platform's data (like stacked points, etc) */
+type StackedAppConnection = {
+    snapshot: StackedSnapshot;
+    stackedData: StackedEntityData;
 };
-/** @deprecated - old way of getting a specific game player's currencies in stacked */
-type IClientPlayerData = StackedSnapshotData;
+/** Returned alongside offers when fetching a specific user/player's offers */
 type StackedUserResponse = {
-    /** @deprecated use stacked instead */
+    /** @deprecated use stackedData instead */
     data?: IClientPlayerData | null;
-    /** this is the current user's snapshot within this app/game */
-    snapshot: StackedSnapshot;
-    /** this current user's stacked web/mobile app profile */
+    user?: 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;
-};
+    apps: {
+        [appId: string]: StackedAppConnection;
+    };
+}
 
 type StackedEnv = IEnv;
 
-export type { IClientPlayerData, StackedBaseOffer, StackedBaseUser, StackedBaseUserExtra, StackedCompletionConditions, StackedEnv, StackedOffer, StackedReward, StackedRewardKind, StackedSnapshot, StackedSnapshotData, StackedSnapshotProgress, StackedUser, StackedUserOffer, StackedUserResponse, UserOfferStatus };
+export type { IClientPlayerData, StackedAppConnection, StackedBaseOffer, StackedBaseUser, StackedBaseUserExtra, StackedCompletionConditions, StackedEntityData, StackedEnv, StackedOffer, StackedReward, StackedRewardKind, StackedSnapshot, StackedSnapshotProgress, StackedUser, StackedUserOffer, StackedUserResponse, StackedUserWithAppConnections, UserOfferStatus };

package/package.json

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