@amityco/ts-sdk 7.2.0 → 7.2.1-3663404.0

package/dist/notificationTray/api/index.d.ts

@@ -0,0 +1,3 @@
+export * from './markItemsSeen';
+export * from './markTraySeen';
+//# sourceMappingURL=index.d.ts.map

package/dist/notificationTray/api/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/notificationTray/api/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC"}

package/dist/notificationTray/api/markItemsSeen.d.ts

@@ -0,0 +1,16 @@
+/**
+ * ```js
+ * import { notificationTray } from '@amityco/ts-sdk'
+ * const updated = await notificationTray.markItemsSeen()
+ * ```
+ *
+ * Updates an {@link Amity.NotificationItemSeen}
+ *
+ * @param trayItems[] that include id and lastTraySeenAt, The ID of the {@link Amity.NotificationItemSeen} to edit
+ * @returns the updated {@link Amity.NotificationItemSeen} object
+ *
+ * @category NotificationItemSeen API
+ * @async
+ */
+export declare const markItemsSeen: (trayItems: Amity.QueryNotificationItemSeen[]) => Promise<void>;
+//# sourceMappingURL=markItemsSeen.d.ts.map

package/dist/notificationTray/api/markItemsSeen.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"markItemsSeen.d.ts","sourceRoot":"","sources":["../../../src/notificationTray/api/markItemsSeen.ts"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,aAAa,cAAqB,MAAM,yBAAyB,EAAE,kBAuC/E,CAAC"}

package/dist/notificationTray/api/markTraySeen.d.ts

@@ -0,0 +1,19 @@
+/**
+ * ```js
+ * import { notificationTray } from '@amityco/ts-sdk'
+ * const updated = await notificationTray.markTraySeen({
+ *   lastSeenAt: Amity.timestamp,
+ * })
+ * ```
+ *
+ * Updates an {@link Amity.NotificationTraySeen}
+ *
+ * @param userId The ID of the {@link Amity.NotificationTraySeen} to edit
+ * @param lastSeenAt The patch data to apply
+ * @returns the updated {@link Amity.NotificationTraySeen} object
+ *
+ * @category Post API
+ * @async
+ */
+export declare const markTraySeen: (lastSeenAt: Amity.timestamp) => Promise<Amity.Cached<Amity.NotificationTraySeenUpdatedPayload>>;
+//# sourceMappingURL=markTraySeen.d.ts.map

package/dist/notificationTray/api/markTraySeen.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"markTraySeen.d.ts","sourceRoot":"","sources":["../../../src/notificationTray/api/markTraySeen.ts"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,YAAY,eACX,MAAM,SAAS,KAC1B,QAAQ,MAAM,MAAM,CAAC,MAAM,kCAAkC,CAAC,CAqChE,CAAC"}

package/dist/notificationTray/events/index.d.ts

@@ -0,0 +1,2 @@
+export * from './onNotificationTraySeenUpdated';
+//# sourceMappingURL=index.d.ts.map

package/dist/notificationTray/events/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/notificationTray/events/index.ts"],"names":[],"mappings":"AAAA,cAAc,iCAAiC,CAAC"}

package/dist/notificationTray/events/onNotificationTraySeenUpdated.d.ts

@@ -0,0 +1,17 @@
+/**
+ * ```js
+ * import { onNotificationTraySeenUpdated } from '@amityco/ts-sdk'
+ * const dispose = onNotificationTraySeenUpdated(data => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when an {@link Amity.NotificationTraySeen} has been updated
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category NotificationTraySeen Events
+ */
+export declare const onNotificationTraySeenUpdated: (callback: Amity.Listener<Amity.InternalNotificationTraySeen>) => Amity.Unsubscriber;
+//# sourceMappingURL=onNotificationTraySeenUpdated.d.ts.map

package/dist/notificationTray/events/onNotificationTraySeenUpdated.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"onNotificationTraySeenUpdated.d.ts","sourceRoot":"","sources":["../../../src/notificationTray/events/onNotificationTraySeenUpdated.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,6BAA6B,aAC9B,MAAM,QAAQ,CAAC,MAAM,4BAA4B,CAAC,KAC3D,MAAM,YAeR,CAAC"}

package/dist/notificationTray/index.d.ts

@@ -0,0 +1,4 @@
+export * from './observers';
+export * from './api';
+export * from './events';
+//# sourceMappingURL=index.d.ts.map

package/dist/notificationTray/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/notificationTray/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,OAAO,CAAC;AACtB,cAAc,UAAU,CAAC"}

package/dist/notificationTray/internalApi/getNotificationTraySeen.d.ts

@@ -0,0 +1,30 @@
+/**
+ * ```js
+ * import { notificationTray } from '@amityco/ts-sdk'
+ * const notificationTraySeen = await notificationTray.getNotificationTraySeen()
+ * ```
+ *
+ *
+ * @returns A page of {@link Amity.NotificationTraySeen} objects
+ *
+ * @category NotificationTray API
+ * @async
+ * */
+export declare const getNotificationTraySeen: {
+    (): Promise<Amity.Cached<Amity.InternalNotificationTraySeen>>;
+    /**
+     * ```js
+     * import { notificationTray } from '@amityco/ts-sdk'
+     * const notificationTraySeen = await notificationTray.getNotificationTraySeen.locally()
+     * ```
+     *
+     * Queries a paginable list of {@link Amity.NotificationTraySeen} objects from cache
+     *
+     * @returns A page of {@link Amity.NotificationTraySeen} objects
+     *
+     * @category NotificationTray API
+     * @async
+     * */
+    locally(): Amity.Cached<Amity.InternalNotificationTraySeen> | undefined;
+};
+//# sourceMappingURL=getNotificationTraySeen.d.ts.map

package/dist/notificationTray/internalApi/getNotificationTraySeen.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getNotificationTraySeen.d.ts","sourceRoot":"","sources":["../../../src/notificationTray/internalApi/getNotificationTraySeen.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;KAWK;AACL,eAAO,MAAM,uBAAuB;QAAa,QAC/C,MAAM,MAAM,CAAC,MAAM,4BAA4B,CAAC,CACjD;IA+BD;;;;;;;;;;;;SAYK;eAED,MAAM,MAAM,CAAC,MAAM,4BAA4B,CAAC,GAChD,SAAS;CAlBZ,CAAC"}

package/dist/notificationTray/observers/getNotificationTrayItems/NotificationTrayItemsLiveCollectionController.d.ts

@@ -0,0 +1,13 @@
+import { NotificationTrayItemsPaginationController } from './NotificationTrayItemsPaginationController';
+import { LiveCollectionController } from '~/core/liveCollection/LiveCollectionController';
+export declare class NotificationTrayItemsLiveCollectionController extends LiveCollectionController<'notificationTrayItem', Amity.NotificationTrayItemLiveCollection, Amity.NotificationTrayItem, NotificationTrayItemsPaginationController> {
+    private queryStreamController;
+    private query;
+    constructor(query: Amity.NotificationTrayItemLiveCollection, callback: Amity.LiveCollectionCallback<Amity.NotificationTrayItem>);
+    protected setup(): void;
+    protected persistModel(queryPayload: Amity.NotificationTrayPayload & Amity.Pagination): Promise<void>;
+    protected persistQueryStream({ response, direction, refresh, }: Amity.LiveCollectionPersistQueryStreamParams<'notificationTrayItem'>): void;
+    startSubscription(): Amity.Unsubscriber[];
+    notifyChange({ origin, loading, error }: Amity.LiveCollectionNotifyParams): void;
+}
+//# sourceMappingURL=NotificationTrayItemsLiveCollectionController.d.ts.map

package/dist/notificationTray/observers/getNotificationTrayItems/NotificationTrayItemsLiveCollectionController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NotificationTrayItemsLiveCollectionController.d.ts","sourceRoot":"","sources":["../../../../src/notificationTray/observers/getNotificationTrayItems/NotificationTrayItemsLiveCollectionController.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,yCAAyC,EAAE,MAAM,6CAA6C,CAAC;AAExG,OAAO,EAAE,wBAAwB,EAAE,MAAM,gDAAgD,CAAC;AAK1F,qBAAa,6CAA8C,SAAQ,wBAAwB,CACzF,sBAAsB,EACtB,KAAK,CAAC,kCAAkC,EACxC,KAAK,CAAC,oBAAoB,EAC1B,yCAAyC,CAC1C;IACC,OAAO,CAAC,qBAAqB,CAA6C;IAE1E,OAAO,CAAC,KAAK,CAA2C;gBAGtD,KAAK,EAAE,KAAK,CAAC,kCAAkC,EAC/C,QAAQ,EAAE,KAAK,CAAC,sBAAsB,CAAC,KAAK,CAAC,oBAAoB,CAAC;IAoBpE,SAAS,CAAC,KAAK;cAYC,YAAY,CAAC,YAAY,EAAE,KAAK,CAAC,uBAAuB,GAAG,KAAK,CAAC,UAAU;IAI3F,SAAS,CAAC,kBAAkB,CAAC,EAC3B,QAAQ,EACR,SAAS,EACT,OAAO,GACR,EAAE,KAAK,CAAC,sCAAsC,CAAC,sBAAsB,CAAC;IAKvE,iBAAiB;IAIjB,YAAY,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,KAAK,CAAC,0BAA0B;CAyB1E"}

package/dist/notificationTray/observers/getNotificationTrayItems/NotificationTrayItemsPaginationController.d.ts

@@ -0,0 +1,9 @@
+import { PaginationController } from '~/core/liveCollection/PaginationController';
+/**
+ * TODO: handle cache receive cache option, and cache policy
+ * TODO: check if querybyIds is supported
+ */
+export declare class NotificationTrayItemsPaginationController extends PaginationController<'notificationTrayItem', Amity.NotificationTrayItemLiveCollection> {
+    getRequest(queryParams: Amity.NotificationTrayItemLiveCollection, token: string | undefined): Promise<Amity.NotificationTrayPayload & Amity.Pagination>;
+}
+//# sourceMappingURL=NotificationTrayItemsPaginationController.d.ts.map

package/dist/notificationTray/observers/getNotificationTrayItems/NotificationTrayItemsPaginationController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NotificationTrayItemsPaginationController.d.ts","sourceRoot":"","sources":["../../../../src/notificationTray/observers/getNotificationTrayItems/NotificationTrayItemsPaginationController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,4CAA4C,CAAC;AAGlF;;;GAGG;AACH,qBAAa,yCAA0C,SAAQ,oBAAoB,CACjF,sBAAsB,EACtB,KAAK,CAAC,kCAAkC,CACzC;IACO,UAAU,CACd,WAAW,EAAE,KAAK,CAAC,kCAAkC,EACrD,KAAK,EAAE,MAAM,GAAG,SAAS;CAiB5B"}

package/dist/notificationTray/observers/getNotificationTrayItems/NotificationTrayItemsQuerystreamController.d.ts

@@ -0,0 +1,9 @@
+import { QueryStreamController } from '~/core/liveCollection/QueryStreamController';
+export declare class NotificationTrayItemsQuerystreamController extends QueryStreamController<Amity.NotificationTrayPayload, Amity.NotificationTrayItemLiveCollection> {
+    private notifyChange;
+    private preparePayload;
+    constructor(query: Amity.NotificationTrayItemLiveCollection, cacheKey: string[], notifyChange: (params: Amity.LiveCollectionNotifyParams) => void, preparePayload: (response: Amity.NotificationTrayPayload) => Amity.ProcessedNotificationTrayPayload);
+    saveToMainDB(response: Amity.NotificationTrayPayload): Promise<void>;
+    appendToQueryStream(response: Amity.NotificationTrayPayload & Partial<Amity.Pagination>, direction: Amity.LiveCollectionPageDirection, refresh?: boolean): void;
+}
+//# sourceMappingURL=NotificationTrayItemsQuerystreamController.d.ts.map

package/dist/notificationTray/observers/getNotificationTrayItems/NotificationTrayItemsQuerystreamController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NotificationTrayItemsQuerystreamController.d.ts","sourceRoot":"","sources":["../../../../src/notificationTray/observers/getNotificationTrayItems/NotificationTrayItemsQuerystreamController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,6CAA6C,CAAC;AAMpF,qBAAa,0CAA2C,SAAQ,qBAAqB,CACnF,KAAK,CAAC,uBAAuB,EAC7B,KAAK,CAAC,kCAAkC,CACzC;IACC,OAAO,CAAC,YAAY,CAAqD;IAEzE,OAAO,CAAC,cAAc,CAEsB;gBAG1C,KAAK,EAAE,KAAK,CAAC,kCAAkC,EAC/C,QAAQ,EAAE,MAAM,EAAE,EAClB,YAAY,EAAE,CAAC,MAAM,EAAE,KAAK,CAAC,0BAA0B,KAAK,IAAI,EAChE,cAAc,EAAE,CACd,QAAQ,EAAE,KAAK,CAAC,uBAAuB,KACpC,KAAK,CAAC,gCAAgC;IAOvC,YAAY,CAAC,QAAQ,EAAE,KAAK,CAAC,uBAAuB;IAW1D,mBAAmB,CACjB,QAAQ,EAAE,KAAK,CAAC,uBAAuB,GAAG,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,EACnE,SAAS,EAAE,KAAK,CAAC,2BAA2B,EAC5C,OAAO,UAAQ;CAwBlB"}

package/dist/notificationTray/observers/getNotificationTrayItems.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Get notification tray items for a notification tray page
+ *
+ * @param params the limit query parameters
+ * @param callback the callback to be called when the notification tray items are updated
+ * @returns items in the notification tray
+ *
+ * @category Notification tray items Live Collection
+ *
+ */
+export declare const getNotificationTrayItems: (params: Amity.LiveCollectionParams<Amity.NotificationTrayItemLiveCollection>, callback: Amity.LiveCollectionCallback<Amity.NotificationTrayItem>, config?: Amity.LiveCollectionConfig) => () => void;
+//# sourceMappingURL=getNotificationTrayItems.d.ts.map

package/dist/notificationTray/observers/getNotificationTrayItems.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getNotificationTrayItems.d.ts","sourceRoot":"","sources":["../../../src/notificationTray/observers/getNotificationTrayItems.ts"],"names":[],"mappings":"AAKA;;;;;;;;;GASG;AACH,eAAO,MAAM,wBAAwB,WAC3B,MAAM,oBAAoB,CAAC,MAAM,kCAAkC,CAAC,YAClE,MAAM,sBAAsB,CAAC,MAAM,oBAAoB,CAAC,WACzD,MAAM,oBAAoB,eAyBpC,CAAC"}

package/dist/notificationTray/observers/getNotificationTraySeen.d.ts

@@ -0,0 +1,20 @@
+/**
+ * ```js
+ * import { notificationTray } from '@amityco/ts-sdk';
+ *
+ * let notificationTraySeen;
+ *
+ * const unsubscribe = getNotificationTraySeen(response => {
+ *   notificationTraySeen = response.data;
+ * });
+ * ```
+ *
+ * Observe all mutation on a given {@link Amity.NotificationTraySeen}
+ *
+ * @param callback the function to call when new data are available
+ * @returns An {@link Amity.Unsubscriber} function to run when willing to stop observing the message
+ *
+ * @category NotificationTraySeen Live Object
+ */
+export declare const getNotificationTraySeen: (callback: Amity.LiveObjectCallback<Amity.NotificationTraySeen>) => Amity.Unsubscriber;
+//# sourceMappingURL=getNotificationTraySeen.d.ts.map

package/dist/notificationTray/observers/getNotificationTraySeen.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getNotificationTraySeen.d.ts","sourceRoot":"","sources":["../../../src/notificationTray/observers/getNotificationTraySeen.ts"],"names":[],"mappings":"AASA;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,uBAAuB,aACxB,MAAM,kBAAkB,CAAC,MAAM,oBAAoB,CAAC,KAC7D,MAAM,YA6BR,CAAC"}

package/dist/notificationTray/observers/index.d.ts

@@ -0,0 +1,3 @@
+export * from './getNotificationTraySeen';
+export * from './getNotificationTrayItems';
+//# sourceMappingURL=index.d.ts.map

package/dist/notificationTray/observers/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/notificationTray/observers/index.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAC;AAC1C,cAAc,4BAA4B,CAAC"}

package/dist/notificationTray/utils/prepareNotificationTrayItemsPayload.d.ts

@@ -0,0 +1,2 @@
+export declare const prepareNotificationTrayItemsPayload: (rawPayload: Amity.NotificationTrayPayload) => Amity.ProcessedNotificationTrayPayload;
+//# sourceMappingURL=prepareNotificationTrayItemsPayload.d.ts.map

package/dist/notificationTray/utils/prepareNotificationTrayItemsPayload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prepareNotificationTrayItemsPayload.d.ts","sourceRoot":"","sources":["../../../src/notificationTray/utils/prepareNotificationTrayItemsPayload.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,mCAAmC,eAClC,MAAM,uBAAuB,KACxC,MAAM,gCAOR,CAAC"}

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

@@ -11,5 +11,6 @@ export declare const LinkedObject: {
     reactor: (reactor: Amity.InternalReactor) => Amity.Reactor;
     channel: (channel: Amity.InternalChannel<any>) => Amity.Channel<any>;
     pinnedPost: (pinnedPost: Amity.RawPin) => Amity.PinnedPost;
+    notificationTray: (noti: Amity.RawNotificationTrayItem) => Amity.NotificationTrayItem;
 };
 //# sourceMappingURL=index.d.ts.map

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":"AAaA,eAAO,MAAM,YAAY;;;;;;;;;;;;;CAaxB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/linkedObject/index.ts"],"names":[],"mappings":"AAcA,eAAO,MAAM,YAAY;;;;;;;;;;;;;;CAcxB,CAAC"}

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

@@ -0,0 +1,2 @@
+export declare const notificationTrayLinkedObject: (noti: Amity.InternalNotificationTrayItem) => Amity.NotificationTrayItem;
+//# sourceMappingURL=notificationTrayLinkedObject.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"notificationTrayLinkedObject.d.ts","sourceRoot":"","sources":["../../../src/utils/linkedObject/notificationTrayLinkedObject.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,4BAA4B,SACjC,MAAM,4BAA4B,KACvC,MAAM,oBAWR,CAAC"}

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

@@ -1 +1 @@
-{"version":3,"file":"postLinkedObject.d.ts","sourceRoot":"","sources":["../../../src/utils/linkedObject/postLinkedObject.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,gBAAgB,SAAU,MAAM,YAAY,KAAG,MAAM,IAiCjE,CAAC"}
+{"version":3,"file":"postLinkedObject.d.ts","sourceRoot":"","sources":["../../../src/utils/linkedObject/postLinkedObject.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,gBAAgB,SAAU,MAAM,YAAY,KAAG,MAAM,IA6DjE,CAAC"}

package/dist/utils/postTypePredicate.d.ts

@@ -0,0 +1,4 @@
+export declare function isAmityImagePost(post: Amity.InternalPost): post is Amity.Post<'image'>;
+export declare function isAmityFilePost(post: Amity.InternalPost): post is Amity.Post<'file'>;
+export declare function isAmityVideoPost(post: Amity.InternalPost): post is Amity.Post<'video'>;
+//# sourceMappingURL=postTypePredicate.d.ts.map

package/dist/utils/postTypePredicate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"postTypePredicate.d.ts","sourceRoot":"","sources":["../../src/utils/postTypePredicate.ts"],"names":[],"mappings":"AAAA,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAOtF;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAOpF;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAQtF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amityco/ts-sdk",
-  "version": "7.2.0",
+  "version": "7.2.1-03663404.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/events.ts

@@ -256,6 +256,11 @@ declare global {
       'local.story.error': Amity.StoryPayload;
       'local.story.reload': { referenceIds: Amity.Story['referenceId'][] };
 
+      'local.notificationTraySeen.updated': Amity.InternalNotificationTraySeen;
+      'local.notificationTrayItem.updated': {
+        notificationTrayItems: Amity.InternalNotificationTrayItem[];
+      };
+
       sessionStateChange: Amity.SessionStates;
       // used by accessTokenExpiryWatcher
       tokenExpired: Amity.SessionStates.TOKEN_EXPIRED;

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

@@ -57,6 +57,9 @@ declare global {
 
       pinTarget: Amity.InternalPinTarget;
       pin: Amity.InternalPin;
+
+      notificationTrayItem: Amity.InternalNotificationTrayItem;
+      notificationTraySeen: Amity.InternalNotificationTraySeen;
     };
 
     type Model = ValueOf<Models>;
@@ -118,6 +121,9 @@ declare global {
 
       pinTarget: Pick<Amity.InternalPinTarget, 'targetId'>;
       pin: Pick<Amity.InternalPin, 'placement' | 'referenceId'>;
+
+      notificationTrayItem: Pick<Amity.InternalNotificationTrayItem, '_id'>;
+      notificationTraySeen: Pick<Amity.InternalNotificationTraySeen, 'userId'>;
     };
   }
 }

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

@@ -26,6 +26,7 @@ declare global {
       blockUser: Amity.BlockedUserPayload;
       semanticSearchPost: Amity.SemanticSearchPostPayload;
       semanticSearchCommunity: Amity.SemanticSearchCommunityPayload;
+      notificationTrayItem: Amity.NotificationTrayPayload;
     };
 
     type UserPayload = {
@@ -54,7 +55,29 @@ declare global {
 
     // 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>;
+
+    type VideoFileExtraPayload = {
+      feedType: Amity.ContentFeedType;
+      status: Amity.VideoTranscodingStatus;
+      videoUrl?: { [name in Amity.VideoResolution]?: string } | null;
+    };
+
+    type FilePayload<T extends Amity.FileType = any> = {
+      fileId: string;
+      type: T;
+      altText?: string;
+      fileUrl: string;
+      attributes: {
+        name: string;
+        extension: string;
+        size: string;
+        mimeType: string;
+        metadata: Amity.MetadataFor<T>;
+      };
+      accessType: Amity.FileAccessType;
+    } & (T extends 'video' ? Amity.VideoFileExtraPayload : unknown) &
+      Amity.Timestamps &
+      Amity.SoftDelete;
 
     type RolePayload = {
       roles: Amity.Role[];
@@ -378,6 +401,34 @@ declare global {
       reactions: Amity.InternalReactor[];
     } & Amity.StoryPayload;
 
+    type NotificationTrayPayload = {
+      notificationTrayItems: Amity.RawNotificationTrayItem[];
+      users: Amity.RawUser[];
+      files?: Amity.File[];
+    };
+
+    type ProcessedNotificationTrayPayload = Omit<
+      NotificationTrayPayload,
+      'notificationTrayItems' | 'users'
+    > & {
+      notificationTrayItems: Amity.InternalNotificationTrayItem[];
+      users: Amity.InternalUser[];
+      files?: Amity.File[];
+    };
+
+    type NotificationTraySeenPayload = {
+      lastTraySeenAt: Amity.timestamp;
+      lastTrayOccurredAt: Amity.timestamp;
+    };
+
+    type NotificationTraySeenUpdatedPayload = {
+      lastSeenAt: Amity.timestamp;
+    };
+
+    type NotificationItemSeenPayload = {
+      trayItems: { id: string; lastSeenAt: Amity.timestamp }[];
+    };
+
     /**
      * Items that extend from `Amity.PostPayload`
      * - communities: `Amity.RawCommunity` -> `Amity.Community` (Added Marker Service related props)

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

@@ -63,26 +63,6 @@ declare global {
       ? VideoMetadata
       : never;
 
-    type VideoFileExtraPayload = {
-      feedType: Amity.ContentFeedType;
-      status: VideoTranscodingStatus;
-      videoUrl?: { [name in VideoResolution]?: string } | null;
-    };
-
-    type File<T extends FileType = any> = {
-      fileId: string;
-      type: T;
-      fileUrl: string;
-      attributes: {
-        name: string;
-        extension: string;
-        size: string;
-        mimeType: string;
-        metadata: MetadataFor<T>;
-      };
-      accessType: FileAccessType;
-    } & (T extends 'video' ? VideoFileExtraPayload : unknown) &
-      Amity.Timestamps &
-      Amity.SoftDelete;
+    type File<T extends FileType = any> = Amity.FilePayload<T>;
   }
 }

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

@@ -0,0 +1,94 @@
+export {};
+
+declare global {
+  namespace Amity {
+    const enum TrayItemCategoryType {
+      POST_MENTION = 'mention_in_post',
+      COMMENT_MENTION = 'mention_in_comment',
+      REPLY_MENTION = 'mention_in_reply',
+      POLL_MENTION = 'mention_in_poll',
+      POST_REACT = 'reaction_on_post',
+      COMMENT_REACT = 'reaction_on_comment',
+      REPLY_REACT = 'reaction_on_reply',
+    }
+
+    const enum TrayAction {
+      POST = 'post',
+      POLL = 'poll',
+      COMMENT = 'comment',
+      REACTION = 'reaction',
+      MENTION = 'mention',
+      REPLY = 'reply',
+    }
+
+    type RawNotificationTrayItem = {
+      _id: string;
+      lastSeenAt: Amity.timestamp;
+      lastOccurredAt: Amity.timestamp;
+      actors: {
+        _id: string;
+        publicId: string;
+        lastActedAt: Amity.timestamp;
+      }[];
+      actorsCount: number;
+      trayItemCategory?: TrayItemCategoryType;
+      targetId: string;
+      targetType: string;
+      referenceId?: string;
+      referenceType?: string;
+      actionType: TrayAction;
+      actionReferenceId?: string;
+      parentId?: string;
+      text: string;
+      templatedText: string;
+      daySegment: Amity.timestamp;
+    };
+
+    type InternalNotificationTrayItem = RawNotificationTrayItem;
+
+    type QueryNotificationTrayItem = {
+      token?: Amity.Token;
+      limit?: Amity.PageLimit['limit'];
+    };
+
+    type NotificationTrayItemLiveCollection = Amity.LiveCollectionParams<
+      Omit<QueryNotificationTrayItem, 'limit'>
+    >;
+
+    type NotificationTrayItemLiveCollectionCache = Amity.LiveCollectionCache<
+      Amity.InternalNotificationTrayItem['_id'],
+      Pick<QueryNotificationTrayItem, 'limit'>
+    >;
+
+    type NotificationTrayItem = Amity.InternalNotificationTrayItem & {
+      isSeen: boolean;
+      isRecent: boolean;
+      users: Amity.User[];
+    };
+
+    type RawNotificationTraySeen = {
+      lastTraySeenAt: Amity.timestamp;
+      lastTrayOccurredAt: Amity.timestamp;
+    };
+
+    type RawNotificationTraySeenUpdated = {
+      lastTraySeenAt: Amity.timestamp;
+    };
+
+    type InternalNotificationTraySeen = RawNotificationTraySeen & {
+      userId: string;
+      isSeen: boolean;
+    };
+
+    type NotificationTraySeen = RawNotificationTraySeen & { isSeen: boolean };
+
+    type RawNotificationItemSeen = {
+      lastSeenAt: Amity.timestamp;
+    };
+
+    type QueryNotificationItemSeen = {
+      id: string;
+      lastSeenAt: Amity.timestamp;
+    };
+  }
+}

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

@@ -61,6 +61,10 @@ declare global {
       analytics: {
         markAsViewed: () => void;
       };
+      getImageInfo: () => Amity.File<'image'> | undefined;
+      getVideoInfo: () => Amity.File<'video'> | undefined;
+      getVideoThumbnailInfo: () => Amity.File<'image'> | undefined;
+      getFileInfo: () => Amity.File<'file'> | undefined;
     };
 
     type Post<T extends PostContentType = any> = Amity.InternalPost<T> & Amity.PostLinkObject;

package/src/@types/index.ts

@@ -37,3 +37,4 @@ export * from './domains/message';
 export * from './domains/post';
 export * from './domains/story';
 export * from './domains/ad';
+export * from './domains/notification';

package/src/core/model/idResolvers.ts

@@ -61,6 +61,9 @@ const idResolvers: Resolvers = {
 
   pin: ({ placement, referenceId }) => `${placement}#${referenceId}`,
   pinTarget: ({ targetId }) => targetId,
+
+  notificationTrayItem: ({ _id }) => _id,
+  notificationTraySeen: ({ userId }) => userId,
 };
 
 /**

package/src/core/model/index.ts

@@ -52,6 +52,8 @@ export const PAYLOAD2MODEL: Record<string, Amity.Domain> = {
 
   pinTargets: 'pinTarget',
   pins: 'pin',
+
+  notificationTrayItems: 'notificationTrayItem',
 };
 
 /** hidden */

package/src/fileRepository/api/index.ts

@@ -4,3 +4,4 @@ export * from './deleteFile';
 export * from './fileUrlWithSize';
 export * from './uploadVideo';
 export * from './uploadImage';
+export * from './updateAltText';

package/src/fileRepository/api/updateAltText.ts

@@ -0,0 +1,39 @@
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { getActiveClient } from '~/client';
+
+/* begin_public_function
+  id: file.update.altText
+*/
+/**
+ * ```js
+ * import { FileRepository } from '@amityco/ts-sdk'
+ * const updated = await FileRepository.updateAltText(fileId, altText)
+ * ```
+ *
+ * Updates an {@link Amity.File<'image'>['altText']}.
+ *
+ * @param fileId The ID of the {@link Amity.File<'image'>} to edit
+ * @param altText The new alt text for the {@link Amity.File<'image'>}
+ * @returns the updated {@link Amity.File<'image'>} object
+ *
+ * @category File API
+ * @async
+ */
+export const updateAltText = async (
+  fileId: Amity.File['fileId'],
+  altText: string,
+): Promise<boolean> => {
+  const client = getActiveClient();
+  client.log('file/updateAltText', altText);
+
+  const { data } = await client.http.put<Amity.FilePayload<'image'>>(`/api/v3/files/${fileId}`, {
+    altText,
+  });
+
+  const cachedAt = client.cache && Date.now();
+
+  if (client.cache) ingestInCache({ files: [data] }, { cachedAt });
+
+  return true;
+};
+/* end_public_function */