@stackedapp/types 0.26.0 → 1.0.1

package/dist/index.js

@@ -19,4 +19,5 @@ __exportStar(require("./stacked_offer"), 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

@@ -99,6 +99,8 @@ interface IBaseCondition {
         min?: number;
         /** maximum number of links of this type allowed */
         max?: number;
+        /** Display template for this link condition */
+        template?: string;
     }>;
     /** dynamic field conditions */
     dynamic?: IDynamicGroup;
@@ -183,6 +185,8 @@ interface ICompletionCondition extends IBaseCondition {
     linkedCompletions?: {
         /** Number of linked entity completions required */
         min: number;
+        /** Display template for this condition */
+        template?: string;
     };
     /**
      * Dynamic field tracker - tracks changes to dynamic fields AFTER offer surfacing.
@@ -195,8 +199,8 @@ interface ICompletionCondition extends IBaseCondition {
      * Keyed by condition ID for multiple trackers.
      */
     contractInteractions?: Record<string, {
-        /** Display name for this condition (e.g., "Spend PIXEL", "Earn NFT") */
-        name: string;
+        /** Display template for this condition (e.g., "Spend PIXEL", "Earn NFT") */
+        template: string;
         /**
          * Event type to track:
          * - 'spend': Currency transferred OUT (onchain_currency_tx kind=spend)
@@ -384,6 +388,8 @@ interface IOffer {
     /** for grouping offers together if they are assocaited with each othert for easy rendering in front-end */
     groupId?: string;
     name: string;
+    /** Custom tab name for grouped offers - displays instead of name when set */
+    tabName?: string;
     /** how high of a priority is this offer in comparison to other offers? 1 is highest priority */
     priority?: number;
     description: string;
@@ -391,7 +397,7 @@ interface IOffer {
     /** notes about this offer */
     notes?: string;
     /** if this should be an offer that gets surfaced in real time */
-    realTime?: string;
+    realTime?: boolean;
     /** if this offer is tied to other offers for a/b testing, this is the ID that ties
      * all of the offers together
      */
@@ -533,7 +539,7 @@ interface IPlayerOffer {
     onComplete?: Array<IOfferHookEvent>;
 }
 
-type CoinSyncStatusType = "pending" | "success" | "error" | "exclusive" | "synced" | null;
+type CoinSyncStatusType = 'pending' | 'success' | 'error' | 'exclusive' | 'synced' | null;
 interface IBlockchainSyncStatus {
     ts: number | null;
     status: CoinSyncStatusType;
@@ -553,6 +559,10 @@ type Restriction = {
     eventCount: number;
     message?: string;
 };
+type IUserCryptoWallet = {
+    address: string;
+    createdAt?: number;
+};
 interface IUser {
     _id: Stringable;
     deleted?: boolean;
@@ -567,10 +577,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;
@@ -716,12 +723,34 @@ interface IPlayerIpInfo {
     continentCode?: string;
 }
 
+type Nullable<T> = {
+    [K in keyof T]?: T[K] | null;
+};
 /** this is the Stacked platforms' copy of a user/entity's snapshot for the current app/game */
-type StackedSnapshot = Pick<IPlayerSnapshot, '_id' | 'gameId' | 'playerId' | 'unifiedUserLinkedAt' | 'unifiedUserUnlinkedAt' | 'referredById' | 'username' | 'snapshotLastUpdated' | 'offersLastChecked' | 'daysInGame' | 'loginStreak' | 'daysInGameLastUpdated' | 'dateSignedUp' | 'dynamic' | 'stakedTokens' | 'currencies' | 'levels' | 'quests' | 'trustScore' | 'trustLastUpdated' | 'achievements' | 'memberships' | '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 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 & {
+    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;
+};
 
+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;
@@ -759,30 +788,88 @@ 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;
-        balances: Record<string, number>;
+    cryptoWallets?: Array<IUserCryptoWallet & {
+        balances?: Record<string, number>;
     }>;
 }
-type StackedUser = StackedBaseUser & StackedBaseUserExtra & {
-    apps: {
-        [appId: string]: StackedSnapshotData;
-    };
+/** 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;
 };
-/** @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 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;
+        }>;
+    };
+}
+
+/** Base campaigns response - shared fields between client and server */
+interface StackedCampaignsBaseResponse extends StackedUserResponse {
+    /** List of offers/campaigns for the player */
+    offers: StackedOffer[];
+    /**
+     * @deprecated
+     * look at stackedData.currencies instead.
+     * Currencies with name and image and balance information */
+    currencies?: StackedEntityCurrencies;
+}
+/** 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). 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;
+    /** Game/app ID */
+    gameId: string;
+    /** @deprecated use player.snapshot instead */
+    playerSnapshot?: StackedSnapshot;
+    /** @deprecated use player.stackedData instead */
+    playerData?: StackedEntityData;
+}
 
 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, 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": "0.26.0",
+  "version": "1.0.1",
   "description": "Public types for Stacked platform SDK",
   "main": "dist/index.js",
   "types": "dist/stacked-types.d.ts",
@@ -16,9 +16,12 @@
     "clean": "rimraf dist"
   },
   "devDependencies": {
-    "@stackedplatform/types-internal": "*",
-    "@microsoft/api-extractor": "^7.55.2",
-    "typescript": "^5.8.2"
+    "@semantic-release/commit-analyzer": "^13.0.1",
+    "@semantic-release/gitlab": "^13.2.9",
+    "@semantic-release/npm": "^13.1.3",
+    "@semantic-release/release-notes-generator": "^14.1.0",
+    "@stackedplatform/types": "*",
+    "conventional-changelog-conventionalcommits": "^9.1.0"
   },
   "publishConfig": {
     "access": "public"