@stackedapp/types 1.0.0 → 1.0.2

package/dist/stacked-types.d.ts

@@ -728,8 +728,14 @@ 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! */
+/** Currencies for this entity that is populated with name and image information */
+type StackedEntityCurrencies = Record<string, IPlayerDataCurrency & {
+    name: string;
+    image?: string;
+}>;
+/** represents a stacked entity's snapshot's data within a specific app/game. This is scoped to the app/game!
+ * Has information about stacked currencies of this entity earned through this specific app/game
+ */
 type StackedEntityData = Pick<IPlayerData, 'gameId' | 'playerId'> & {
     currencies?: StackedEntityCurrencies;
 };
@@ -789,10 +795,17 @@ interface StackedBaseUserExtra {
         balances?: Record<string, number>;
     }>;
 }
+/** Base stacked user that includes their id, app connections connected to their stacked account, crypto wallets
+ * information
+ */
 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 = {
+    /** this is the Stacked platforms' copy of a user/entity's snapshot for the current app/game */
     snapshot: StackedSnapshot;
+    /** represents a stacked entity's snapshot's data within a specific app/game. This is scoped to the app/game!
+     * Has information about stacked currencies of this entity earned through this specific app/game
+     */
     stackedData: StackedEntityData;
 };
 /** Returned alongside offers when fetching a specific user/player's offers */
@@ -803,7 +816,7 @@ type StackedUserResponse = {
 } & 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 */
+/** Stacked mobile/web app's initialize user response */
 interface StackedUserComplete {
     user: StackedUser;
     apps: {
@@ -834,21 +847,27 @@ interface StackedUserComplete {
 interface StackedCampaignsBaseResponse extends StackedUserResponse {
     /** List of offers/campaigns for the player */
     offers: StackedOffer[];
-    /** Player's currency balances */
+    /**
+     * @deprecated
+     * look at stackedData.currencies instead.
+     * Currencies with name and image and balance information */
     currencies?: StackedEntityCurrencies;
 }
-/** Client-side campaigns response (from JWT-authenticated endpoints) */
+/** Client-side campaigns response (from JWT-authenticated endpoints). Returns a list of offers plus
+ * user snapshot and stacked user-specific data.
+ */
 type StackedCampaignsResponse = StackedCampaignsBaseResponse;
-/** Server-side campaigns response (from API key authenticated endpoints) */
+/** Server-side campaigns response (from API key authenticated endpoints). Returns a list of offers plus
+ * user snapshot and stacked user-specific data. */
 interface StackedCampaignsServerResponse extends StackedCampaignsBaseResponse {
     /** @deprecated iframe session token for subsequent client calls */
-    token: string;
+    token?: string;
     /** Game/app ID */
     gameId: string;
     /** @deprecated use player.snapshot instead */
-    playerSnapshot: StackedSnapshot;
+    playerSnapshot?: StackedSnapshot;
     /** @deprecated use player.stackedData instead */
-    playerData: StackedEntityData;
+    playerData?: StackedEntityData;
 }
 
 type StackedEnv = IEnv;

package/package.json

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