@amityco/ts-sdk 7.11.1-c23e18e.0 → 7.11.1-cef76519.0

package/dist/index.esm.js

@@ -177,6 +177,24 @@ var FeedSourceEnum;
     FeedSourceEnum["User"] = "user";
 })(FeedSourceEnum || (FeedSourceEnum = {}));
 
+var AmityEventType;
+(function (AmityEventType) {
+    AmityEventType["Virtual"] = "virtual";
+    AmityEventType["InPerson"] = "in_person";
+})(AmityEventType || (AmityEventType = {}));
+var AmityEventOriginType;
+(function (AmityEventOriginType) {
+    AmityEventOriginType["Community"] = "community";
+    AmityEventOriginType["User"] = "user";
+})(AmityEventOriginType || (AmityEventOriginType = {}));
+var AmityEventStatus;
+(function (AmityEventStatus) {
+    AmityEventStatus["Scheduled"] = "scheduled";
+    AmityEventStatus["Live"] = "live";
+    AmityEventStatus["Ended"] = "ended";
+    AmityEventStatus["Cancelled"] = "cancelled";
+})(AmityEventStatus || (AmityEventStatus = {}));
+
 function getVersion() {
     try {
         // the string ''v7.11.0-esm'' should be replaced by actual value by @rollup/plugin-replace
@@ -26552,7 +26570,7 @@ const getUserUnread = (callback) => {
     };
 };
 
-var index$o = /*#__PURE__*/Object.freeze({
+var index$p = /*#__PURE__*/Object.freeze({
     __proto__: null,
     getActiveClient: getActiveClient,
     getActiveUser: getActiveUser,
@@ -27771,7 +27789,7 @@ const getMyFollowInfo = (callback) => {
 };
 /* end_public_function */
 
-var index$n = /*#__PURE__*/Object.freeze({
+var index$o = /*#__PURE__*/Object.freeze({
     __proto__: null,
     blockUser: blockUser,
     unBlockUser: unBlockUser,
@@ -29750,6 +29768,31 @@ const communityLinkedObject = (community) => {
         } });
 };
 
+const eventLinkedObject = (event) => {
+    return Object.assign(Object.assign({}, event), { get creator() {
+            const cacheData = pullFromCache(['user', 'get', event.userId]);
+            if (!(cacheData === null || cacheData === void 0 ? void 0 : cacheData.data))
+                return;
+            return userLinkedObject(cacheData.data);
+        },
+        get discussionCommunity() {
+            if (!event.communityId)
+                return;
+            const cacheData = pullFromCache(['community', 'get', event.communityId]);
+            if (!(cacheData === null || cacheData === void 0 ? void 0 : cacheData.data))
+                return;
+            return communityLinkedObject(cacheData.data);
+        },
+        get liveStream() {
+            if (!event.livestreamId)
+                return;
+            const cacheData = pullFromCache(['stream', 'get', event.livestreamId]);
+            if (!(cacheData === null || cacheData === void 0 ? void 0 : cacheData.data))
+                return;
+            return cacheData.data;
+        } });
+};
+
 const LinkedObject = {
     ad: adLinkedObject,
     comment: commentLinkedObject,
@@ -29768,6 +29811,7 @@ const LinkedObject = {
     invitation: invitationLinkedObject,
     joinRequest: joinRequestLinkedObject,
     channelMember: channelMemberLinkedObject,
+    event: eventLinkedObject,
 };
 
 /* begin_public_function
@@ -30758,9 +30802,9 @@ var AmityUserSearchMatchType;
     AmityUserSearchMatchType["PARTIAL"] = "partial";
 })(AmityUserSearchMatchType || (AmityUserSearchMatchType = {}));
 
-var index$m = /*#__PURE__*/Object.freeze({
+var index$n = /*#__PURE__*/Object.freeze({
     __proto__: null,
-    Relationship: index$n,
+    Relationship: index$o,
     getUserByIds: getUserByIds,
     updateUser: updateUser,
     flagUser: flagUser,
@@ -31163,7 +31207,7 @@ const uploadAudio = async (formData, onProgress) => {
 };
 /* end_public_function */
 
-var index$l = /*#__PURE__*/Object.freeze({
+var index$m = /*#__PURE__*/Object.freeze({
     __proto__: null,
     getFile: getFile,
     uploadFile: uploadFile,
@@ -32975,7 +33019,7 @@ const getReactions$1 = (params, callback, config) => {
 };
 /* end_public_function */
 
-var index$k = /*#__PURE__*/Object.freeze({
+var index$l = /*#__PURE__*/Object.freeze({
     __proto__: null,
     addReaction: addReaction,
     removeReaction: removeReaction,
@@ -34747,7 +34791,7 @@ const getMessages = (params, callback, config) => {
 };
 /* end_public_function */
 
-var index$j = /*#__PURE__*/Object.freeze({
+var index$k = /*#__PURE__*/Object.freeze({
     __proto__: null,
     createMessage: createMessage,
     updateMessage: updateMessage,
@@ -35273,7 +35317,7 @@ const stopMessageReceiptSync = (subChannelId) => {
 };
 /* end_public_function */
 
-var index$i = /*#__PURE__*/Object.freeze({
+var index$j = /*#__PURE__*/Object.freeze({
     __proto__: null,
     getSubChannelByIds: getSubChannels$1,
     createSubChannel: createSubChannel,
@@ -36600,7 +36644,7 @@ const searchMembers$1 = (params, callback, config) => {
 };
 /* end_public_function */
 
-var index$h = /*#__PURE__*/Object.freeze({
+var index$i = /*#__PURE__*/Object.freeze({
     __proto__: null,
     addMembers: addMembers$1,
     removeMembers: removeMembers$1,
@@ -36803,7 +36847,7 @@ const unmuteMembers = async (channelId, userIds) => {
 };
 /* end_public_function */
 
-var index$g = /*#__PURE__*/Object.freeze({
+var index$h = /*#__PURE__*/Object.freeze({
     __proto__: null,
     addRole: addRole,
     removeRole: removeRole,
@@ -36813,10 +36857,10 @@ var index$g = /*#__PURE__*/Object.freeze({
     unmuteMembers: unmuteMembers
 });
 
-var index$f = /*#__PURE__*/Object.freeze({
+var index$g = /*#__PURE__*/Object.freeze({
     __proto__: null,
-    Membership: index$h,
-    Moderation: index$g,
+    Membership: index$i,
+    Moderation: index$h,
     getChannelByIds: getChannelByIds$1,
     createChannel: createChannel,
     updateChannel: updateChannel,
@@ -38219,7 +38263,7 @@ const searchMembers = (params, callback, config) => {
 };
 /* end_public_function */
 
-var index$e = /*#__PURE__*/Object.freeze({
+var index$f = /*#__PURE__*/Object.freeze({
     __proto__: null,
     addMembers: addMembers,
     removeMembers: removeMembers,
@@ -39470,7 +39514,7 @@ const unbanMembers = async (communityId, userIds) => {
 };
 /* end_public_function */
 
-var index$d = /*#__PURE__*/Object.freeze({
+var index$e = /*#__PURE__*/Object.freeze({
     __proto__: null,
     addRoles: addRoles,
     removeRoles: removeRoles,
@@ -39478,10 +39522,10 @@ var index$d = /*#__PURE__*/Object.freeze({
     unbanMembers: unbanMembers
 });
 
-var index$c = /*#__PURE__*/Object.freeze({
+var index$d = /*#__PURE__*/Object.freeze({
     __proto__: null,
-    Moderation: index$d,
-    Membership: index$e,
+    Moderation: index$e,
+    Membership: index$f,
     getCommunityByIds: getCommunities$1,
     createCommunity: createCommunity,
     updateCommunity: updateCommunity,
@@ -39715,7 +39759,7 @@ const getCategories = (params, callback, config) => {
 };
 /* end_public_function */
 
-var index$b = /*#__PURE__*/Object.freeze({
+var index$c = /*#__PURE__*/Object.freeze({
     __proto__: null,
     getCategory: getCategory,
     getCategories: getCategories
@@ -40774,7 +40818,7 @@ const getComments = (params, callback, config) => {
 };
 /* end_public_function */
 
-var index$a = /*#__PURE__*/Object.freeze({
+var index$b = /*#__PURE__*/Object.freeze({
     __proto__: null,
     getCommentByIds: getCommentByIds,
     createComment: createComment,
@@ -41445,7 +41489,7 @@ const getUserFeed = (params, callback, config) => {
 };
 /* end_public_function */
 
-var index$9 = /*#__PURE__*/Object.freeze({
+var index$a = /*#__PURE__*/Object.freeze({
     __proto__: null,
     queryGlobalFeed: queryGlobalFeed,
     getCustomRankingGlobalFeed: getCustomRankingGlobalFeed,
@@ -43126,7 +43170,7 @@ const searchPostsByHashtag = (params, callback, config) => {
 };
 /* end_public_function */
 
-var index$8 = /*#__PURE__*/Object.freeze({
+var index$9 = /*#__PURE__*/Object.freeze({
     __proto__: null,
     getPostByIds: getPostByIds,
     createPost: createPost,
@@ -43734,7 +43778,7 @@ const getStreams = (params, callback, config) => {
     };
 };
 
-var index$7 = /*#__PURE__*/Object.freeze({
+var index$8 = /*#__PURE__*/Object.freeze({
     __proto__: null,
     createStream: createStream,
     updateStream: updateStream,
@@ -44052,7 +44096,7 @@ const getPoll = (pollId, callback) => {
 };
 /* end_public_function */
 
-var index$6 = /*#__PURE__*/Object.freeze({
+var index$7 = /*#__PURE__*/Object.freeze({
     __proto__: null,
     createPoll: createPoll,
     closePoll: closePoll,
@@ -44435,7 +44479,7 @@ const getPlayer = async (parameters) => {
     return video;
 };
 
-var index$5 = /*#__PURE__*/Object.freeze({
+var index$6 = /*#__PURE__*/Object.freeze({
     __proto__: null,
     getPlayer: getPlayer
 });
@@ -45608,7 +45652,7 @@ const getGlobalStoryTargets = (params, callback, config) => {
     };
 };
 
-var index$4 = /*#__PURE__*/Object.freeze({
+var index$5 = /*#__PURE__*/Object.freeze({
     __proto__: null,
     createImageStory: createImageStory,
     createVideoStory: createVideoStory,
@@ -45645,7 +45689,7 @@ const getNetworkAds = async () => {
     };
 };
 
-var index$3 = /*#__PURE__*/Object.freeze({
+var index$4 = /*#__PURE__*/Object.freeze({
     __proto__: null,
     getNetworkAds: getNetworkAds
 });
@@ -46036,7 +46080,7 @@ const markTraySeen = async (lastSeenAt) => {
 };
 /* end_public_function */
 
-var index$2 = /*#__PURE__*/Object.freeze({
+var index$3 = /*#__PURE__*/Object.freeze({
     __proto__: null,
     getNotificationTraySeen: getNotificationTraySeen,
     getNotificationTrayItems: getNotificationTrayItems,
@@ -46237,7 +46281,7 @@ const getMyCommunityInvitations = (params, callback, config) => {
     };
 };
 
-var index$1 = /*#__PURE__*/Object.freeze({
+var index$2 = /*#__PURE__*/Object.freeze({
     __proto__: null,
     onLocalInvitationCreated: onLocalInvitationCreated,
     onLocalInvitationUpdated: onLocalInvitationUpdated,
@@ -46378,11 +46422,250 @@ const getReactions = (postId, callback) => {
     };
 };
 
-var index = /*#__PURE__*/Object.freeze({
+var index$1 = /*#__PURE__*/Object.freeze({
     __proto__: null,
     createReaction: createReaction,
     onLiveReactionCreated: onLiveReactionCreated,
     getReactions: getReactions
 });
 
-export { API_REGIONS, index$3 as AdRepository, index$b as CategoryRepository, index$f as ChannelRepository, index$o as Client, index$a as CommentRepository, CommunityPostSettingMaps, CommunityPostSettings, index$c as CommunityRepository, ContentFeedType, ContentFlagReasonEnum, DefaultCommunityPostSetting, FeedDataTypeEnum, index$9 as FeedRepository, FeedSortByEnum, FeedSourceEnum, FileAccessTypeEnum, index$l as FileRepository, FileType, GET_WATCHER_URLS, index$1 as InvitationRepository, InvitationSortByEnum, InvitationStatusEnum, InvitationTypeEnum, JoinRequestStatusEnum, JoinResultStatusEnum, index as LiveReactionRepository, index$5 as LiveStreamPlayer, MembershipAcceptanceTypeEnum, MessageContentType, index$j as MessageRepository, index$6 as PollRepository, PostContentType, index$8 as PostRepository, PostStructureType, index$k as ReactionRepository, index$4 as StoryRepository, index$7 as StreamRepository, index$i as SubChannelRepository, SubscriptionLevels, index$m as UserRepository, UserTypeEnum, VERSION, VideoResolution, VideoSize, VideoTranscodingStatus, backupCache, createQuery, createReport, createUserToken, deleteReport, disableCache, dropFromCache, enableCache, filterByChannelMembership, filterByCommunityMembership, filterByFeedType, filterByPostDataTypes, filterByPropEquality, filterByPropInclusion, filterByPropIntersection, filterBySearchTerm, filterByStringComparePartially, getChannelTopic, getCommentTopic, getCommunityStoriesTopic, getCommunityTopic, getLiveReactionTopic, getLiveStreamTopic, getMarkedMessageTopic, getMarkerUserFeedTopic, getMessageTopic, getMyFollowersTopic, getMyFollowingsTopic, getNetworkTopic, getPostTopic, getRole, getSmartFeedChannelTopic, getSmartFeedMessageTopic, getSmartFeedSubChannelTopic, getStoryTopic, getSubChannelTopic, getUserTopic, isAfterBefore, isAfterBeforeRaw, isCachable, isFetcher, isFresh, isLocal, isMutator, isOffline, isPaged, isReportedByMe, isSkip, mergeInCache, index$2 as notificationTray, onChannelMarkerFetched, onFeedMarkerFetched, onFeedMarkerUpdated, onMessageMarked, onMessageMarkerFetched, onSubChannelMarkerFetched, onSubChannelMarkerUpdated, onUserMarkerFetched, onUserMarkerFetchedLegacy, pullFromCache, pushToCache, queryCache, queryOptions, queryRoles, restoreCache, runQuery, sortByChannelSegment, sortByDisplayName, sortByFirstCreated, sortByFirstUpdated, sortByLastActivity, sortByLastCreated, sortByLastUpdated, sortByLocalSortingDate, sortByName, sortBySegmentNumber, subscribeTopic, toPage, toPageRaw, toToken, upsertInCache, wipeCache };
+const prepareEventPayload = (rawPayload) => {
+    return Object.assign(Object.assign({}, rawPayload), { users: rawPayload.users.map(convertRawUserToInternalUser) });
+};
+
+const createEventEventSubscriber = (event, callback) => {
+    const client = getActiveClient();
+    const filter = (payload) => {
+        const unpackedPayload = prepareEventPayload(payload);
+        if (!client.cache) {
+            callback(unpackedPayload.events[0]);
+        }
+        else {
+            ingestInCache(unpackedPayload);
+            const event = pullFromCache([
+                'event',
+                'get',
+                unpackedPayload.events[0].eventId,
+            ]);
+            callback(event.data);
+        }
+    };
+    return createEventSubscriber(client, event, event, filter);
+};
+
+/* begin_public_function
+  id: event.create
+*/
+/**
+ * ```js
+ * import { EventRepository } from '@amityco/ts-sdk'
+ * const response = await EventRepository.createEvent(bundle)
+ * ```
+ *
+ * Creates an {@link Amity.Event}
+ *
+ * @param bundle The data necessary to create a new {@link Amity.Event}
+ * @returns The newly created {@link Amity.Event}
+ *
+ * @category Event API
+ * @async
+ */
+const createEvent = async (bundle) => {
+    const client = getActiveClient();
+    client.log('event/createEvent', bundle);
+    const { data: payload } = await client.http.post('/api/v1/events', bundle);
+    fireEvent('event.created', payload);
+    const preparedPayload = prepareEventPayload(payload);
+    const cachedAt = client.cache && Date.now();
+    if (client.cache)
+        ingestInCache(preparedPayload, { cachedAt });
+    return {
+        data: eventLinkedObject(preparedPayload.events[0]),
+        cachedAt,
+    };
+};
+/* end_public_function */
+
+/* begin_public_function
+  id: event.update
+*/
+/**
+ * ```js
+ * import { EventRepository } from '@amityco/ts-sdk'
+ * const response = await EventRepository.updateEvent(eventId, bundle)
+ * ```
+ *
+ * Updates an {@link Amity.Event}
+ *
+ * @param eventId The ID of the {@link Amity.Event} to edit
+ * @param bundle The data necessary to update an existing {@link Amity.Event}
+ * @returns the updated {@link Amity.Event}
+ *
+ * @category Event API
+ * @async
+ */
+const updateEvent = async (eventId, bundle) => {
+    const client = getActiveClient();
+    client.log('event/updateEvent', eventId, bundle);
+    const { data: payload } = await client.http.put(`/api/v1/events/${eventId}`, bundle);
+    fireEvent('event.updated', payload);
+    const preparedPayload = prepareEventPayload(payload);
+    const cachedAt = client.cache && Date.now();
+    if (client.cache)
+        ingestInCache(preparedPayload, { cachedAt });
+    return {
+        data: eventLinkedObject(preparedPayload.events.find(event => event.eventId === eventId)),
+        cachedAt,
+    };
+};
+/* end_public_function */
+
+/**
+ * ```js
+ * import { EventRepository } from '@amityco/ts-sdk'
+ * const dispose = EventRepository.onEventCreated(event => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a {@link Amity.Event} has been created
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category Event Events
+ */
+const onEventCreated = (callback) => createEventEventSubscriber('event.created', callback);
+
+/**
+ * ```js
+ * import { EventRepository } from '@amityco/ts-sdk'
+ * const dispose = EventRepository.onEventUpdated(event => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a {@link Amity.Event} has been updated
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category Event Events
+ */
+const onEventUpdated = (callback) => createEventEventSubscriber('event.updated', callback);
+
+/**
+ * ```js
+ * import { EventRepository } from '@amityco/ts-sdk'
+ * const dispose = EventRepository.onEventDeleted(event => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a {@link Amity.Event} has been deleted
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category Event Events
+ */
+const onEventDeleted = (callback) => createEventEventSubscriber('event.deleted', callback);
+
+/* begin_public_function
+  id: event.get
+*/
+/**
+ * ```js
+ * import { EventRepository } from '@amityco/ts-sdk'
+ * const event = await EventRepository.getEvent(eventId)
+ * ```
+ *
+ * Fetches a {@link Amity.Event} object
+ *
+ * @param eventId the ID of the {@link Amity.Event} to fetch
+ * @returns the associated {@link Amity.Event} object
+ *
+ * @category Event API
+ * @async
+ */
+const getEvent$1 = async (eventId) => {
+    const client = getActiveClient();
+    client.log('event/getEvent', eventId);
+    const { data: payload } = await client.http.get(`/api/v3/events/${eventId}`);
+    const data = prepareEventPayload(payload);
+    const cachedAt = client.cache && Date.now();
+    if (client.cache)
+        ingestInCache(data, { cachedAt });
+    return {
+        data: data.events.find(event => event.eventId === eventId),
+        cachedAt,
+    };
+};
+/* end_public_function */
+/**
+ * ```js
+ * import { EventRepository } from '@amityco/ts-sdk'
+ * const event = EventRepository.getEvent.locally(eventId)
+ * ```
+ *
+ * Fetches a {@link Amity.Event} object in cache
+ *
+ * @param eventId the ID of the {@link Amity.Event} to fetch
+ * @returns the associated {@link Amity.Event} object
+ *
+ * @category Event API
+ */
+getEvent$1.locally = (eventId) => {
+    const client = getActiveClient();
+    client.log('event/getEvent.locally', eventId);
+    if (!client.cache)
+        return;
+    const cache = pullFromCache(['event', 'get', eventId]);
+    if (!cache)
+        return;
+    return {
+        data: cache.data,
+        cachedAt: cache.cachedAt,
+    };
+};
+
+/* begin_public_function
+  id: event.get
+*/
+/**
+ * ```js
+ * import { EventRepository } from '@amityco/ts-sdk';
+ *
+ * let event;
+ *
+ * const unsubscribe = EventRepository.getEvent(eventId, response => {
+ *   event = response.data;
+ * });
+ * ```
+ *
+ * Observe all mutation on a given {@link Amity.Event}
+ *
+ * @param eventId the ID of the event to observe
+ * @param callback the function to call when new snapshot of event are available
+ * @returns An {@link Amity.Unsubscriber} function to run when willing to stop observing the event
+ *
+ * @category Event Live Object
+ */
+const getEvent = (eventId, callback) => {
+    return liveObject(eventId, callback, 'eventId', getEvent$1, [onEventCreated, onEventUpdated, onEventDeleted], {
+        callbackDataSelector: (data) => (data ? eventLinkedObject(data) : data),
+    });
+};
+/* end_public_function */
+
+var index = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    createEvent: createEvent,
+    updateEvent: updateEvent,
+    onEventCreated: onEventCreated,
+    onEventUpdated: onEventUpdated,
+    onEventDeleted: onEventDeleted,
+    getEvent: getEvent
+});
+
+export { API_REGIONS, index$4 as AdRepository, AmityEventOriginType, AmityEventStatus, AmityEventType, index$c as CategoryRepository, index$g as ChannelRepository, index$p as Client, index$b as CommentRepository, CommunityPostSettingMaps, CommunityPostSettings, index$d as CommunityRepository, ContentFeedType, ContentFlagReasonEnum, DefaultCommunityPostSetting, index as EventRepository, FeedDataTypeEnum, index$a as FeedRepository, FeedSortByEnum, FeedSourceEnum, FileAccessTypeEnum, index$m as FileRepository, FileType, GET_WATCHER_URLS, index$2 as InvitationRepository, InvitationSortByEnum, InvitationStatusEnum, InvitationTypeEnum, JoinRequestStatusEnum, JoinResultStatusEnum, index$1 as LiveReactionRepository, index$6 as LiveStreamPlayer, MembershipAcceptanceTypeEnum, MessageContentType, index$k as MessageRepository, index$7 as PollRepository, PostContentType, index$9 as PostRepository, PostStructureType, index$l as ReactionRepository, index$5 as StoryRepository, index$8 as StreamRepository, index$j as SubChannelRepository, SubscriptionLevels, index$n as UserRepository, UserTypeEnum, VERSION, VideoResolution, VideoSize, VideoTranscodingStatus, backupCache, createQuery, createReport, createUserToken, deleteReport, disableCache, dropFromCache, enableCache, filterByChannelMembership, filterByCommunityMembership, filterByFeedType, filterByPostDataTypes, filterByPropEquality, filterByPropInclusion, filterByPropIntersection, filterBySearchTerm, filterByStringComparePartially, getChannelTopic, getCommentTopic, getCommunityStoriesTopic, getCommunityTopic, getLiveReactionTopic, getLiveStreamTopic, getMarkedMessageTopic, getMarkerUserFeedTopic, getMessageTopic, getMyFollowersTopic, getMyFollowingsTopic, getNetworkTopic, getPostTopic, getRole, getSmartFeedChannelTopic, getSmartFeedMessageTopic, getSmartFeedSubChannelTopic, getStoryTopic, getSubChannelTopic, getUserTopic, isAfterBefore, isAfterBeforeRaw, isCachable, isFetcher, isFresh, isLocal, isMutator, isOffline, isPaged, isReportedByMe, isSkip, mergeInCache, index$3 as notificationTray, onChannelMarkerFetched, onFeedMarkerFetched, onFeedMarkerUpdated, onMessageMarked, onMessageMarkerFetched, onSubChannelMarkerFetched, onSubChannelMarkerUpdated, onUserMarkerFetched, onUserMarkerFetchedLegacy, pullFromCache, pushToCache, queryCache, queryOptions, queryRoles, restoreCache, runQuery, sortByChannelSegment, sortByDisplayName, sortByFirstCreated, sortByFirstUpdated, sortByLastActivity, sortByLastCreated, sortByLastUpdated, sortByLocalSortingDate, sortByName, sortBySegmentNumber, subscribeTopic, toPage, toPageRaw, toToken, upsertInCache, wipeCache };