@stackedapp/types 1.9.3 → 1.9.11

package/dist/index.js

@@ -16,8 +16,8 @@ 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);
+__exportStar(require("./stacked_response"), exports);
 //# sourceMappingURL=index.js.map

package/dist/stacked-types.d.ts

@@ -728,13 +728,26 @@ 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'>>;
+/** Currencies for this entity that is populated with name and image information */
 type StackedEntityCurrencies = Record<string, IPlayerDataCurrency>;
-/** represents a stacked snapshot's data within a specific app/game. This is scoped to the app/game! */
+/** 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;
 };
 
+type StackedBaseConditions = IBaseCondition;
 type StackedCompletionConditions = ICompletionCondition;
+type StackedDynamicCondition = IDynamicCondition;
+type StackedCompletionDynamicTracker = ICompletionDynamicTracker;
+type StackedCompletionTrackers = ICompletionTrackers;
+type StackedOfferTrackers = IPlayerOfferTrackers;
+type StackedSocialTrackerAccumulate = ISocialTrackerAccumulate;
+type StackedSocialTrackerAttach = ISocialTrackerAttach;
+type StackedDynamicGroup = IDynamicGroup;
+type StackedClaimableConditions = IOffer['claimableConditions'];
+type StackedClaimableTrackers = IPlayerOffer['claimableTrackers'];
 /** Stripped sibling offer data for client rendering */
 interface StackedSnapshotProgress {
     status: UserOfferStatus;
@@ -766,6 +779,11 @@ 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 */
@@ -774,54 +792,95 @@ 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 */
 type StackedUserResponse = {
-    /** @deprecated use stackedData instead */
+    /** @deprecated use stackedData instead for stacked-scoped data (like currencies) */
     data?: IClientPlayerData | null;
     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 {
+/** Stacked mobile/web app's initialize user response */
+interface StackedUserComplete {
     user: StackedUser;
     apps: {
         [appId: string]: StackedAppConnection;
     };
+    authMethods: {
+        wallets: Array<{
+            address: string;
+            type: number;
+        }>;
+        emails: Array<{
+            email: string;
+        }>;
+        phones: Array<{
+            phone: string;
+        }>;
+        providers: Array<{
+            type: string;
+            profilePic?: string;
+            username?: string;
+            displayName?: string;
+            providerUserId?: string;
+        }>;
+    };
+}
+
+/** Relevant assets like currencies with name image information so that the client
+ * can render name/image
+ */
+interface StackedAssets {
+    currencies: Record<string, {
+        name: string;
+        image: string;
+    }>;
 }
 
 /** 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 */
+    /**
+     * @deprecated
+     * look at assets for currencies asset information name/image. The actually currencies on
+     * the player is in stackedUser.currencies */
     currencies?: StackedEntityCurrencies;
+    /** Relevant assets like currencies with name image information so that the client
+     * can render name/image
+     */
+    assets: StackedAssets;
 }
-/** 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;
-}
-
-type StackedRewardKind = RewardKind;
-interface StackedReward extends IReward {
-    image?: string;
+    playerData?: StackedEntityData;
 }
 
 type StackedEnv = IEnv;
 
-export type { IClientPlayerData, StackedAppConnection, StackedBaseOffer, StackedBaseUser, StackedBaseUserExtra, StackedCampaignsResponse, StackedCampaignsServerResponse, StackedCompletionConditions, StackedEntityCurrencies, StackedEntityData, StackedEnv, StackedOffer, StackedReward, StackedRewardKind, StackedSnapshot, StackedSnapshotProgress, StackedUser, StackedUserOffer, StackedUserResponse, StackedUserWithAppConnections, UserOfferStatus };
+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, UserOfferStatus };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stackedapp/types",
-  "version": "1.9.3",
+  "version": "1.9.11",
   "description": "Public types for Stacked platform SDK",
   "main": "dist/index.js",
   "types": "dist/stacked-types.d.ts",
@@ -20,7 +20,7 @@
     "@semantic-release/gitlab": "^13.2.9",
     "@semantic-release/npm": "^13.1.3",
     "@semantic-release/release-notes-generator": "^14.1.0",
-    "@stackedplatform/types-internal": "*",
+    "@stackedplatform/types": "*",
     "conventional-changelog-conventionalcommits": "^9.1.0"
   },
   "publishConfig": {