@amityco/ts-sdk-react-native 6.25.1 → 6.25.2-343f6e2.0

package/dist/utils/linkedObject/adLinkedObject.d.ts

@@ -0,0 +1,2 @@
+export declare const adLinkedObject: (ad: Amity.RawAd) => Amity.Ad;
+//# sourceMappingURL=adLinkedObject.d.ts.map

package/dist/utils/linkedObject/adLinkedObject.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"adLinkedObject.d.ts","sourceRoot":"","sources":["../../../src/utils/linkedObject/adLinkedObject.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,cAAc,OAAQ,MAAM,KAAK,KAAG,MAAM,EA8CtD,CAAC"}

package/dist/utils/linkedObject/index.d.ts

@@ -1,4 +1,5 @@
 export declare const LinkedObject: {
+    ad: (ad: Amity.RawAd) => Amity.Ad;
     comment: (comment: Amity.InternalComment<any>) => Amity.Comment<any>;
     post: (post: Amity.InternalPost<any>) => Amity.Post<any>;
     user: (user: Amity.InternalUser) => Amity.User;

package/dist/utils/linkedObject/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/linkedObject/index.ts"],"names":[],"mappings":"AAWA,eAAO,MAAM,YAAY;;;;;;;;;;;CAWxB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/linkedObject/index.ts"],"names":[],"mappings":"AAYA,eAAO,MAAM,YAAY;;;;;;;;;;;;CAYxB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amityco/ts-sdk-react-native",
-  "version": "6.25.1",
+  "version": "6.25.2-343f6e2.0",
   "license": "CC-BY-ND-4.0",
   "author": "amity.co <developers@amity.co> (https://amity.co)",
   "description": "Amity Social Cloud Typescript SDK",

package/src/@types/core/model.ts

@@ -49,6 +49,9 @@ declare global {
       followCount: Amity.FollowCount;
 
       feed: Amity.Feed;
+
+      ad: Pick<Amity.Ad, 'adId'>;
+      advertiser: Pick<Amity.AdvertiserItem, 'advertiserId'>;
     };
 
     type Model = ValueOf<Models>;
@@ -102,6 +105,9 @@ declare global {
       followCount: Pick<Amity.FollowInfo, 'userId' | 'followerCount'>;
 
       feed: Pick<Amity.Feed, 'targetId' | 'feedId'>;
+
+      ad: Pick<Amity.Ad, 'adId'>;
+      advertiser: Pick<Amity.AdvertiserItem, 'advertiserId'>;
     };
   }
 }

package/src/@types/core/payload.ts

@@ -34,6 +34,13 @@ declare global {
       }[];
     };
 
+    type AdPayload = {
+      ads: Amity.RawAd[];
+      advertisers: Amity.RawAdvertiser[];
+      files: Amity.File[];
+      settings: Amity.AdsSettings;
+    };
+
     // API-FIX: backend should return a payload like { files: Amity.File<T>[] }
     type CreateFilePayload<T extends Amity.FileType = any> = Amity.File<T>[];
     type FilePayload<T extends Amity.FileType = any> = Amity.File<T>;

package/src/@types/domains/ad.ts

@@ -0,0 +1,88 @@
+export {};
+
+declare global {
+  namespace Amity {
+    const enum AdPlacement {
+      FEED = 'feed',
+      STORY = 'story',
+      COMMENT = 'comment',
+      CHATLIST = 'chatlist',
+      CHAT = 'chat',
+    }
+
+    const enum SettingDisplayType {
+      Fixed = 'fixed',
+      TimeWindow = 'time-window',
+    }
+
+    type AdTarget = {
+      communityIds: Amity.Community['communityId'][];
+    };
+
+    type RawAd = {
+      adId: string;
+      advertiserId: string;
+      name: string;
+      placements: AdPlacement[];
+      headline: string;
+      description: string;
+      body: string;
+      image1_1: string;
+      image9_16: string;
+      callToAction: string;
+      callToActionUrl: string;
+      targets: Amity.AdTarget;
+      startAt: Amity.timestamp;
+      endAt: Amity.timestamp;
+      createdAt: Amity.timestamp;
+      updatedAt: Amity.timestamp;
+    };
+
+    type RawAdvertiser = {
+      advertiserId: string;
+      name: string;
+      companyName: string;
+      avatarFileId: string;
+      adsCount: number;
+      createdAt: Amity.timestamp;
+      updatedAt: Amity.timestamp;
+    };
+
+    type AdFrequency = {
+      type: Amity.SettingDisplayType;
+      value: number;
+    };
+
+    type FrequencySettings = {
+      feed?: Amity.AdFrequency;
+      story?: Amity.AdFrequency;
+      comment?: Amity.AdFrequency;
+    };
+
+    type AdsSettings = {
+      enabled: boolean;
+      maxActiveAds: number;
+      frequency: Amity.FrequencySettings;
+      updatedAt: Amity.timestamp;
+    };
+
+    type Advertiser = RawAdvertiser & {
+      avatar?: Amity.File<'image'>;
+    };
+
+    type Ad = Omit<RawAd, 'image1_1' | 'image9_16'> & {
+      advertiser?: Amity.Advertiser;
+      image1_1?: Amity.File<'image'>;
+      image9_16?: Amity.File<'image'>;
+      // analytics: {
+      //   markAsSeen: (placement: Amity.AdPlacement) => void;
+      //   markLinkAsClicked: (placement: Amity.AdPlacement) => void;
+      // };
+    };
+
+    type NetworkAds = {
+      ads: Amity.Ad[];
+      settings: Amity.AdsSettings;
+    };
+  }
+}

package/src/@types/domains/analytics.ts

@@ -10,6 +10,7 @@ declare global {
     const enum AnalyticEventContentType {
       Post = 'post',
       Story = 'story',
+      Ad = 'ad',
     }
 
     type AnalyticEventModel = {
@@ -17,6 +18,7 @@ declare global {
       contentType: AnalyticEventContentType;
       activityType: AnalyticEventActivityType;
       timestamp: Amity.timestamp;
+      metadata?: Record<string, string>;
     };
 
     type AnalyticPostData = {

package/src/@types/index.ts

@@ -35,3 +35,5 @@ export * from './domains/content';
 export * from './domains/file';
 export * from './domains/message';
 export * from './domains/post';
+export * from './domains/story';
+export * from './domains/ad';

package/src/adRepository/api/getNetworkAds.ts

@@ -0,0 +1,24 @@
+import { getActiveClient } from '~/client';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { pushToCache } from '~/cache/api';
+import { LinkedObject } from '~/utils/linkedObject';
+
+const convertToNetworkAds = (data: Amity.AdPayload): Amity.NetworkAds => {
+  const { ads, settings } = data;
+
+  return {
+    ads: ads.map(LinkedObject.ad),
+    settings,
+  };
+};
+
+export const getNetworkAds = async (): Promise<Amity.NetworkAds> => {
+  const client = getActiveClient();
+
+  const { data } = await client.http.get<Amity.AdPayload>('/api/v1/ads/me');
+  const { settings, ...rest } = data;
+  ingestInCache(rest as Omit<Amity.AdPayload, 'settings'>);
+  pushToCache(['ad', 'setting'], settings);
+
+  return convertToNetworkAds(data);
+};

package/src/adRepository/api/index.ts

@@ -0,0 +1 @@
+export { getNetworkAds } from './getNetworkAds';

package/src/adRepository/index.ts

@@ -0,0 +1 @@
+export * from './api';

package/src/analytic/service/analytic/AnalyticsEngine.ts

@@ -33,6 +33,24 @@ class AnalyticsEngine {
     }
   }
 
+  markAdAsViewed(ad: Amity.RawAd, placement: Amity.AdPlacement) {
+    if (
+      this._client.sessionState === Amity.SessionStates.ESTABLISHED ||
+      this._client.sessionState === Amity.SessionStates.TOKEN_EXPIRED
+    ) {
+      this._eventCapturer.markAdAsViewed(ad, placement);
+    }
+  }
+
+  markAdAsClicked(ad: Amity.RawAd, placement: Amity.AdPlacement) {
+    if (
+      this._client.sessionState === Amity.SessionStates.ESTABLISHED ||
+      this._client.sessionState === Amity.SessionStates.TOKEN_EXPIRED
+    ) {
+      this._eventCapturer.markAdAsClicked(ad, placement);
+    }
+  }
+
   markStoryAsClicked(story: Amity.InternalStory) {
     if (
       this._client.sessionState === Amity.SessionStates.ESTABLISHED ||

package/src/analytic/service/analytic/AnalyticsEventCapturer.ts

@@ -48,8 +48,13 @@ export class AnalyticsEventCapturer {
     return true;
   }
 
-  markPostAsViewed(postId: Amity.InternalPost['postId']) {
-    if (!this.isAbleToEnqueue({ itemId: postId, expireTime: this._expireTime })) return;
+  markAs(
+    itemId: string,
+    contentType: Amity.AnalyticEventContentType,
+    activityType: Amity.AnalyticEventActivityType,
+    metadata: Record<string, string> | undefined = undefined,
+  ) {
+    if (!this.isAbleToEnqueue({ itemId, expireTime: this._expireTime })) return;
 
     const now = new Date();
 
@@ -66,15 +71,25 @@ export class AnalyticsEventCapturer {
       currentData.event.shift();
     }
 
-    currentData.event.push({
-      contentId: postId,
-      contentType: Amity.AnalyticEventContentType.Post,
-      activityType: Amity.AnalyticEventActivityType.View,
+    const analyticItem: Amity.AnalyticEventModel = {
+      contentId: itemId,
+      contentType,
+      activityType,
       timestamp: now.toISOString(),
-    });
+    };
+
+    if (metadata) {
+      analyticItem.metadata = metadata;
+    }
+
+    currentData.event.push(analyticItem);
 
     upsertInCache(ANALYTIC_CACHE_KEY, currentData);
-    this._recentViewed[postId] = now;
+    this._recentViewed[itemId] = now;
+  }
+
+  markPostAsViewed(postId: Amity.InternalPost['postId']) {
+    this.markAs(postId, Amity.AnalyticEventContentType.Post, Amity.AnalyticEventActivityType.View);
   }
 
   markStory(story: Amity.InternalStory, activityType: Amity.AnalyticEventActivityType) {
@@ -163,4 +178,30 @@ export class AnalyticsEventCapturer {
   markStoryAsClicked(story: Amity.InternalStory) {
     this.markStory(story, Amity.AnalyticEventActivityType.Click);
   }
+
+  markAdAsViewed(ad: Amity.RawAd, placement: Amity.AdPlacement) {
+    const metadata = {
+      placement,
+    };
+
+    this.markAs(
+      `${ad.adId}.${Amity.AnalyticEventActivityType.View}.${placement}`,
+      Amity.AnalyticEventContentType.Ad,
+      Amity.AnalyticEventActivityType.View,
+      metadata,
+    );
+  }
+
+  markAdAsClicked(ad: Amity.RawAd, placement: Amity.AdPlacement) {
+    const metadata = {
+      placement,
+    };
+
+    this.markAs(
+      `${ad.adId}.${Amity.AnalyticEventActivityType.View}.${placement}`,
+      Amity.AnalyticEventContentType.Ad,
+      Amity.AnalyticEventActivityType.Click,
+      metadata,
+    );
+  }
 }

package/src/client/api/getToken.ts

@@ -16,7 +16,7 @@ import { getDeviceInfo } from '~/core/device';
  */
 export const getToken = async (params: {
   userId: Amity.InternalUser['userId'];
-  displayName: Amity.InternalUser['displayName'];
+  displayName?: Amity.InternalUser['displayName'];
   authToken?: string;
   deviceId: Amity.Device['deviceId'];
 }) => {

package/src/client/api/login.ts

@@ -93,7 +93,7 @@ export const login = async (
   try {
     const { users } = await setClientToken({
       ...params,
-      displayName: params?.displayName || params.userId,
+      displayName: params?.displayName,
       deviceId: params?.deviceId || defaultDeviceId,
     });
 

package/src/client/api/registerPushNotification.ts

@@ -14,7 +14,7 @@ export const registerPushNotification = async (deviceToken: string): Promise<boo
     throw new ASCInvalidParameterError('Unsupported platform');
   }
 
-  const deviceId = getDeviceId();
+  const deviceId = await getDeviceId();
 
   const {
     data: { status, error },

package/src/core/model/idResolvers.ts

@@ -53,6 +53,9 @@ const idResolvers: Resolvers = {
   feed: ({ targetId, feedId }) => `${targetId}#${feedId}`,
   story: ({ referenceId }) => referenceId!,
   storyTarget: ({ targetId }) => targetId,
+
+  ad: ({ adId }) => adId,
+  advertiser: ({ advertiserId }) => advertiserId,
 };
 
 /**

package/src/core/model/index.ts

@@ -47,6 +47,8 @@ export const PAYLOAD2MODEL: Record<string, Amity.Domain> = {
   followCounts: 'followCount',
 
   feeds: 'feed',
+  ads: 'ad',
+  advertisers: 'advertiser',
 };
 
 /** hidden */

package/src/index.ts

@@ -44,5 +44,8 @@ export * as LiveStreamPlayer from './liveStreamPlayer';
 
 export * as StoryRepository from './storyRepository';
 
+// Premium Ads
+export * as AdRepository from './adRepository';
+
 // // external apis
 export * from './external/api';

package/src/utils/linkedObject/adLinkedObject.ts

@@ -0,0 +1,50 @@
+import { pullFromCache } from '~/cache/api';
+// import AnalyticsEngine from '~/analytic/service/analytic/AnalyticsEngine';
+
+export const adLinkedObject = (ad: Amity.RawAd): Amity.Ad => {
+  // const analyticsEngineInstance = AnalyticsEngine.getInstance();
+  const { image9_16: image916, image1_1: image11, ...restAds } = ad;
+  return {
+    ...restAds,
+    // analytics: {
+    //   markAsSeen: (placement: Amity.AdPlacement) => {
+    //     analyticsEngineInstance.markAdAsViewed(ad, placement);
+    //   },
+    //   markLinkAsClicked: (placement: Amity.AdPlacement) => {
+    //     analyticsEngineInstance.markAdAsClicked(ad, placement);
+    //   },
+    // },
+    get advertiser(): Amity.Advertiser | undefined {
+      const advertiserData = pullFromCache<Amity.RawAdvertiser>([
+        'advertiser',
+        'get',
+        ad.advertiserId,
+      ])?.data;
+
+      if (!advertiserData) return;
+
+      const avatarFile = pullFromCache<Amity.File<'image'>>([
+        'file',
+        'get',
+        advertiserData.avatarFileId,
+      ])?.data;
+
+      return {
+        ...advertiserData,
+        avatar: avatarFile,
+      };
+    },
+
+    get image1_1(): Amity.File<'image'> | undefined {
+      const cacheData = pullFromCache<Amity.File<'image'>>(['file', 'get', image11]);
+      if (!cacheData) return undefined;
+      return cacheData.data || undefined;
+    },
+
+    get image9_16(): Amity.File<'image'> | undefined {
+      const cacheData = pullFromCache<Amity.File<'image'>>(['file', 'get', image916]);
+      if (!cacheData) return undefined;
+      return cacheData.data || undefined;
+    },
+  };
+};

package/src/utils/linkedObject/index.ts

@@ -8,8 +8,10 @@ import { messageLinkedObject } from './messageLinkedObject';
 import { storyTargetLinkedObject } from './storyTargetLinkedObject';
 import { reactorLinkedObject } from './reactorLinkedObject';
 import { channelLinkedObject } from './channelLinkedObject';
+import { adLinkedObject } from './adLinkedObject';
 
 export const LinkedObject = {
+  ad: adLinkedObject,
   comment: commentLinkedObject,
   post: postLinkedObject,
   user: userLinkedObject,