@amityco/ts-sdk 7.26.1-ecb8825d.0 → 7.27.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/@types/core/events.d.ts +0 -4
- package/dist/@types/core/events.d.ts.map +1 -1
- package/dist/@types/core/payload.d.ts +0 -21
- package/dist/@types/core/payload.d.ts.map +1 -1
- package/dist/@types/core/permissions.d.ts +3 -8
- package/dist/@types/core/permissions.d.ts.map +1 -1
- package/dist/@types/domains/channel.d.ts +0 -5
- package/dist/@types/domains/channel.d.ts.map +1 -1
- package/dist/@types/domains/content.d.ts +6 -1
- package/dist/@types/domains/content.d.ts.map +1 -1
- package/dist/@types/index.d.ts +0 -1
- package/dist/@types/index.d.ts.map +1 -1
- package/dist/cache/utils/index.d.ts.map +1 -1
- package/dist/channelRepository/events/index.d.ts +0 -2
- package/dist/channelRepository/events/index.d.ts.map +1 -1
- package/dist/channelRepository/events/onChannelMemberRoleAdded.d.ts +0 -22
- package/dist/channelRepository/events/onChannelMemberRoleAdded.d.ts.map +1 -1
- package/dist/channelRepository/events/onChannelMemberRoleRemoved.d.ts +0 -22
- package/dist/channelRepository/events/onChannelMemberRoleRemoved.d.ts.map +1 -1
- package/dist/channelRepository/observers/getChannel.d.ts.map +1 -1
- package/dist/channelRepository/observers/getMyMembership.d.ts.map +1 -1
- package/dist/channelRepository/utils/index.d.ts +0 -2
- package/dist/channelRepository/utils/index.d.ts.map +1 -1
- package/dist/core/events.d.ts +3 -3
- package/dist/core/events.d.ts.map +1 -1
- package/dist/index.cjs.js +170 -564
- package/dist/index.esm.js +170 -564
- package/dist/index.umd.js +2 -2
- package/dist/messagePreview/utils/getChannelMessagePreviewWithUser.d.ts +0 -1
- package/dist/messagePreview/utils/getChannelMessagePreviewWithUser.d.ts.map +1 -1
- package/dist/messageRepository/api/index.d.ts +0 -2
- package/dist/messageRepository/api/index.d.ts.map +1 -1
- package/dist/utils/linkedObject/postLinkedObject.d.ts.map +1 -1
- package/dist/utils/tests/dummy/index.d.ts +0 -1
- package/dist/utils/tests/dummy/index.d.ts.map +1 -1
- package/package.json +1 -1
- package/dist/@types/domains/pinnedMessage.d.ts +0 -43
- package/dist/@types/domains/pinnedMessage.d.ts.map +0 -1
- package/dist/channelRepository/events/onChannelMessagePinned.d.ts +0 -24
- package/dist/channelRepository/events/onChannelMessagePinned.d.ts.map +0 -1
- package/dist/channelRepository/events/onChannelMessageUnpinned.d.ts +0 -21
- package/dist/channelRepository/events/onChannelMessageUnpinned.d.ts.map +0 -1
- package/dist/channelRepository/events/onChannelPinnedMessageDeleted.d.ts +0 -12
- package/dist/channelRepository/events/onChannelPinnedMessageDeleted.d.ts.map +0 -1
- package/dist/channelRepository/events/tests/onChannelMemberRoleAdded.test.d.ts +0 -2
- package/dist/channelRepository/events/tests/onChannelMemberRoleAdded.test.d.ts.map +0 -1
- package/dist/channelRepository/events/tests/onChannelMemberRoleRemoved.test.d.ts +0 -2
- package/dist/channelRepository/events/tests/onChannelMemberRoleRemoved.test.d.ts.map +0 -1
- package/dist/channelRepository/events/tests/onChannelMessagePinned.test.d.ts +0 -2
- package/dist/channelRepository/events/tests/onChannelMessagePinned.test.d.ts.map +0 -1
- package/dist/channelRepository/utils/applyChannelRolePayload.d.ts +0 -21
- package/dist/channelRepository/utils/applyChannelRolePayload.d.ts.map +0 -1
- package/dist/channelRepository/utils/tests/pinnedMessage.test.d.ts +0 -2
- package/dist/channelRepository/utils/tests/pinnedMessage.test.d.ts.map +0 -1
- package/dist/channelRepository/utils/updatePinnedMessageCache.d.ts +0 -24
- package/dist/channelRepository/utils/updatePinnedMessageCache.d.ts.map +0 -1
- package/dist/messageRepository/api/pinMessage.d.ts +0 -29
- package/dist/messageRepository/api/pinMessage.d.ts.map +0 -1
- package/dist/messageRepository/api/tests/pinMessage.test.d.ts +0 -2
- package/dist/messageRepository/api/tests/pinMessage.test.d.ts.map +0 -1
- package/dist/messageRepository/api/tests/unpinMessage.test.d.ts +0 -2
- package/dist/messageRepository/api/tests/unpinMessage.test.d.ts.map +0 -1
- package/dist/messageRepository/api/unpinMessage.d.ts +0 -28
- package/dist/messageRepository/api/unpinMessage.d.ts.map +0 -1
- package/dist/messageRepository/utils/refreshChannelPermissionsForMessage.d.ts +0 -13
- package/dist/messageRepository/utils/refreshChannelPermissionsForMessage.d.ts.map +0 -1
- package/dist/utils/tests/dummy/pinnedMessage.d.ts +0 -2
- package/dist/utils/tests/dummy/pinnedMessage.d.ts.map +0 -1
|
@@ -20,7 +20,6 @@ export declare const getChannelMessagePreviewWithUser: (channel: Amity.StaticInt
|
|
|
20
20
|
messageCount: number;
|
|
21
21
|
moderatorMemberCount?: number | undefined;
|
|
22
22
|
messagePreviewId?: string | undefined;
|
|
23
|
-
pinnedMessage?: Amity.RawPinnedMessage<any> | null | undefined;
|
|
24
23
|
isPublic?: boolean | undefined;
|
|
25
24
|
lastActivity: string;
|
|
26
25
|
attachedTo?: {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"getChannelMessagePreviewWithUser.d.ts","sourceRoot":"","sources":["../../../src/messagePreview/utils/getChannelMessagePreviewWithUser.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,gCAAgC,YAClC,MAAM,qBAAqB
|
|
1
|
+
{"version":3,"file":"getChannelMessagePreviewWithUser.d.ts","sourceRoot":"","sources":["../../../src/messagePreview/utils/getChannelMessagePreviewWithUser.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,gCAAgC,YAClC,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oBAEpB,MAAM,cAAc,GAAG,IAAI;CAoB5C,CAAC"}
|
|
@@ -3,8 +3,6 @@ export * from './updateMessage';
|
|
|
3
3
|
export * from './editMessage';
|
|
4
4
|
export * from './deleteMessage';
|
|
5
5
|
export * from './softDeleteMessage';
|
|
6
|
-
export * from './pinMessage';
|
|
7
|
-
export * from './unpinMessage';
|
|
8
6
|
export * from './markAsDelivered';
|
|
9
7
|
export * from './getReadUsers';
|
|
10
8
|
export * from './getDeliveredUsers';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/messageRepository/api/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AAEpC,cAAc,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/messageRepository/api/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AAEpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,qBAAqB,CAAC;AAEpC,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,wBAAwB,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"postLinkedObject.d.ts","sourceRoot":"","sources":["../../../src/utils/linkedObject/postLinkedObject.ts"],"names":[],"mappings":"AAwBA,eAAO,MAAM,gBAAgB,SAAU,MAAM,YAAY,KAAG,MAAM,
|
|
1
|
+
{"version":3,"file":"postLinkedObject.d.ts","sourceRoot":"","sources":["../../../src/utils/linkedObject/postLinkedObject.ts"],"names":[],"mappings":"AAwBA,eAAO,MAAM,gBAAgB,SAAU,MAAM,YAAY,KAAG,MAAM,IAwMjE,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/utils/tests/dummy/index.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,IAAI,QAA2B,CAAC;AAC7C,eAAO,MAAM,mBAAmB;;;CAAiC,CAAC;AAElE,cAAc,QAAQ,CAAC;AACvB,cAAc,QAAQ,CAAC;AACvB,cAAc,QAAQ,CAAC;AAEvB,cAAc,QAAQ,CAAC;AACvB,cAAc,WAAW,CAAC;AAE1B,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAE3B,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AAEzB,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAE3B,cAAc,UAAU,CAAC;AAEzB,cAAc,QAAQ,CAAC
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/utils/tests/dummy/index.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,IAAI,QAA2B,CAAC;AAC7C,eAAO,MAAM,mBAAmB;;;CAAiC,CAAC;AAElE,cAAc,QAAQ,CAAC;AACvB,cAAc,QAAQ,CAAC;AACvB,cAAc,QAAQ,CAAC;AAEvB,cAAc,QAAQ,CAAC;AACvB,cAAc,WAAW,CAAC;AAE1B,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAE3B,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AAEzB,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAE3B,cAAc,UAAU,CAAC;AAEzB,cAAc,QAAQ,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,43 +0,0 @@
|
|
|
1
|
-
export {};
|
|
2
|
-
declare global {
|
|
3
|
-
namespace Amity {
|
|
4
|
-
/**
|
|
5
|
-
* The single pinned message of a livestream (`live`) channel, as serialized by the
|
|
6
|
-
* server on every channel payload (`channel.pinnedMessage`) and on the
|
|
7
|
-
* `channel.messagePinned` realtime event. Body fields match a message preview;
|
|
8
|
-
* `pinnedBy` / `pinnedAt` are the only additions.
|
|
9
|
-
*/
|
|
10
|
-
type RawPinnedMessage<T extends Amity.MessageContentType = any> = {
|
|
11
|
-
/** internal id of the pinned message (the id `MessageRepository.*` functions take) */
|
|
12
|
-
messageId: Amity.Message['messageId'];
|
|
13
|
-
/** set only when the pinned message is a reply */
|
|
14
|
-
parentId?: Amity.Message['messageId'] | null;
|
|
15
|
-
/** channel internal id */
|
|
16
|
-
channelId: Amity.Channel['channelInternalId'];
|
|
17
|
-
channelPublicId: Amity.Channel['channelId'];
|
|
18
|
-
messageFeedId: Amity.SubChannel['subChannelId'];
|
|
19
|
-
segment: number;
|
|
20
|
-
dataType: T;
|
|
21
|
-
data: Amity.ContentData<T>;
|
|
22
|
-
/** the message author */
|
|
23
|
-
creatorId: Amity.InternalUser['userId'];
|
|
24
|
-
creatorPublicId: Amity.User['userId'];
|
|
25
|
-
isDeleted: boolean;
|
|
26
|
-
/** the user who pinned the message */
|
|
27
|
-
pinnedBy: Amity.InternalUser['userId'];
|
|
28
|
-
pinnedAt: Amity.timestamp;
|
|
29
|
-
} & Amity.Timestamps;
|
|
30
|
-
type PinnedMessage<T extends Amity.MessageContentType = any> = RawPinnedMessage<T>;
|
|
31
|
-
/**
|
|
32
|
-
* `data` of the `channel.messagePinned` / `channel.messageUnpinned` realtime events.
|
|
33
|
-
* `channelId` is the channel **public** id. `pinnedMessage` and `users` are present on
|
|
34
|
-
* `messagePinned` only; `messageUnpinned` carries just the `channelId`.
|
|
35
|
-
*/
|
|
36
|
-
type ChannelPinnedMessagePayload = {
|
|
37
|
-
channelId: Amity.Channel['channelId'];
|
|
38
|
-
pinnedMessage?: Amity.RawPinnedMessage | null;
|
|
39
|
-
users?: Amity.RawUser[];
|
|
40
|
-
};
|
|
41
|
-
}
|
|
42
|
-
}
|
|
43
|
-
//# sourceMappingURL=pinnedMessage.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"pinnedMessage.d.ts","sourceRoot":"","sources":["../../../src/@types/domains/pinnedMessage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC;AAEV,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,KAAK,CAAC;QACd;;;;;WAKG;QACH,KAAK,gBAAgB,CAAC,CAAC,SAAS,KAAK,CAAC,kBAAkB,GAAG,GAAG,IAAI;YAChE,sFAAsF;YACtF,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YACtC,kDAAkD;YAClD,QAAQ,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;YAC7C,0BAA0B;YAC1B,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;YAC9C,eAAe,EAAE,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YAC5C,aAAa,EAAE,KAAK,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;YAChD,OAAO,EAAE,MAAM,CAAC;YAChB,QAAQ,EAAE,CAAC,CAAC;YACZ,IAAI,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;YAC3B,yBAAyB;YACzB,SAAS,EAAE,KAAK,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;YACxC,eAAe,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACtC,SAAS,EAAE,OAAO,CAAC;YACnB,sCAAsC;YACtC,QAAQ,EAAE,KAAK,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;YACvC,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;SAC3B,GAAG,KAAK,CAAC,UAAU,CAAC;QAErB,KAAK,aAAa,CAAC,CAAC,SAAS,KAAK,CAAC,kBAAkB,GAAG,GAAG,IAAI,gBAAgB,CAAC,CAAC,CAAC,CAAC;QAEnF;;;;WAIG;QACH,KAAK,2BAA2B,GAAG;YACjC,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YACtC,aAAa,CAAC,EAAE,KAAK,CAAC,gBAAgB,GAAG,IAAI,CAAC;YAC9C,KAAK,CAAC,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;KACH;CACF"}
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
declare type CallbackFn = Amity.Listener<Amity.StaticInternalChannel>;
|
|
2
|
-
/**
|
|
3
|
-
* ```js
|
|
4
|
-
* import { onChannelMessagePinned } from '@amityco/ts-sdk'
|
|
5
|
-
* const dispose = onChannelMessagePinned(channel => {
|
|
6
|
-
* // channel.pinnedMessage is the new pin
|
|
7
|
-
* })
|
|
8
|
-
* ```
|
|
9
|
-
*
|
|
10
|
-
* Fired when a message is pinned in a channel (the `channel.messagePinned` realtime
|
|
11
|
-
* event). Pinning a different message while one is already pinned emits a single
|
|
12
|
-
* `messagePinned` carrying the replacement — treat every payload as a full snapshot.
|
|
13
|
-
*
|
|
14
|
-
* The updated channel is written to cache before the callback runs, so
|
|
15
|
-
* `ChannelRepository.getChannel` observers see `channel.pinnedMessage` change.
|
|
16
|
-
*
|
|
17
|
-
* @param callback The function to call when the event was fired
|
|
18
|
-
* @returns an {@link Amity.Unsubscriber} function to run when willing to stop listening
|
|
19
|
-
*
|
|
20
|
-
* @category Channel Events
|
|
21
|
-
*/
|
|
22
|
-
export declare const onChannelMessagePinned: (callback: CallbackFn) => Amity.Unsubscriber;
|
|
23
|
-
export {};
|
|
24
|
-
//# sourceMappingURL=onChannelMessagePinned.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"onChannelMessagePinned.d.ts","sourceRoot":"","sources":["../../../src/channelRepository/events/onChannelMessagePinned.ts"],"names":[],"mappings":"AAQA,aAAK,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;AAiB9D;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,sBAAsB,aAAc,UAAU,KAAG,MAAM,YA2BnE,CAAC"}
|
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
declare type CallbackFn = Amity.Listener<Amity.StaticInternalChannel>;
|
|
2
|
-
/**
|
|
3
|
-
* ```js
|
|
4
|
-
* import { onChannelMessageUnpinned } from '@amityco/ts-sdk'
|
|
5
|
-
* const dispose = onChannelMessageUnpinned(channel => {
|
|
6
|
-
* // channel.pinnedMessage is now null
|
|
7
|
-
* })
|
|
8
|
-
* ```
|
|
9
|
-
*
|
|
10
|
-
* Fired when a channel's pinned message is removed (the `channel.messageUnpinned`
|
|
11
|
-
* realtime event) — either by an explicit unpin or automatically by the server when the
|
|
12
|
-
* pinned message is deleted or its author is banned from the channel / globally.
|
|
13
|
-
*
|
|
14
|
-
* @param callback The function to call when the event was fired
|
|
15
|
-
* @returns an {@link Amity.Unsubscriber} function to run when willing to stop listening
|
|
16
|
-
*
|
|
17
|
-
* @category Channel Events
|
|
18
|
-
*/
|
|
19
|
-
export declare const onChannelMessageUnpinned: (callback: CallbackFn) => Amity.Unsubscriber;
|
|
20
|
-
export {};
|
|
21
|
-
//# sourceMappingURL=onChannelMessageUnpinned.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"onChannelMessageUnpinned.d.ts","sourceRoot":"","sources":["../../../src/channelRepository/events/onChannelMessageUnpinned.ts"],"names":[],"mappings":"AAQA,aAAK,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;AAiB9D;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,wBAAwB,aAAc,UAAU,KAAG,MAAM,YAuBrE,CAAC"}
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Defensive clear of `channel.pinnedMessage` when the pinned message itself is deleted.
|
|
3
|
-
*
|
|
4
|
-
* The server also emits `channel.messageUnpinned` in this case, but realtime events are
|
|
5
|
-
* fire-and-forget and their order is not guaranteed. Clearing on `message.deleted`
|
|
6
|
-
* (MQTT or local) makes the banner disappear even if the unpin event is lost; the
|
|
7
|
-
* server's own `messageUnpinned` then becomes a no-op.
|
|
8
|
-
*
|
|
9
|
-
* Internal — wired into the `getChannel` live object; not exported publicly.
|
|
10
|
-
*/
|
|
11
|
-
export declare const onChannelPinnedMessageDeleted: (callback: Amity.Listener<Amity.StaticInternalChannel>) => Amity.Unsubscriber;
|
|
12
|
-
//# sourceMappingURL=onChannelPinnedMessageDeleted.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"onChannelPinnedMessageDeleted.d.ts","sourceRoot":"","sources":["../../../src/channelRepository/events/onChannelPinnedMessageDeleted.ts"],"names":[],"mappings":"AAOA;;;;;;;;;GASG;AACH,eAAO,MAAM,6BAA6B,aAC9B,MAAM,QAAQ,CAAC,MAAM,qBAAqB,CAAC,KACpD,MAAM,YAOL,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"onChannelMemberRoleAdded.test.d.ts","sourceRoot":"","sources":["../../../../src/channelRepository/events/tests/onChannelMemberRoleAdded.test.ts"],"names":[],"mappings":""}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"onChannelMemberRoleRemoved.test.d.ts","sourceRoot":"","sources":["../../../../src/channelRepository/events/tests/onChannelMemberRoleRemoved.test.ts"],"names":[],"mappings":""}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"onChannelMessagePinned.test.d.ts","sourceRoot":"","sources":["../../../../src/channelRepository/events/tests/onChannelMessagePinned.test.ts"],"names":[],"mappings":""}
|
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Applies a `channel.roleAdded` / `channel.roleRemoved` realtime payload to the cache.
|
|
3
|
-
*
|
|
4
|
-
* The event names every member the role request affected together with the
|
|
5
|
-
* roles and channel-scoped permissions each of them is left holding. That is a
|
|
6
|
-
* full state, not a delta, so it is written straight over the cached membership.
|
|
7
|
-
*
|
|
8
|
-
* Members the SDK has not fetched yet are skipped: the payload does not carry
|
|
9
|
-
* enough to build a full {@link Amity.Membership} and the live collections only
|
|
10
|
-
* emit rows that already exist in cache.
|
|
11
|
-
*
|
|
12
|
-
* @param payload the `data` of the realtime event
|
|
13
|
-
* @returns the refreshed channel (when resolvable) and the updated cached memberships
|
|
14
|
-
*
|
|
15
|
-
* @hidden
|
|
16
|
-
*/
|
|
17
|
-
export declare const applyChannelRolePayload: (payload: Amity.ChannelRolePayload) => {
|
|
18
|
-
channel?: Amity.StaticInternalChannel<any> | undefined;
|
|
19
|
-
members: Amity.Membership<'channel'>[];
|
|
20
|
-
};
|
|
21
|
-
//# sourceMappingURL=applyChannelRolePayload.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"applyChannelRolePayload.d.ts","sourceRoot":"","sources":["../../../src/channelRepository/utils/applyChannelRolePayload.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,uBAAuB,YACzB,MAAM,kBAAkB;;aACkB,MAAM,UAAU,CAAC,SAAS,CAAC,EAAE;CA+BjF,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"pinnedMessage.test.d.ts","sourceRoot":"","sources":["../../../../src/channelRepository/utils/tests/pinnedMessage.test.ts"],"names":[],"mappings":""}
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Find a cached channel by any of its ids (internal, public, or `channelId`).
|
|
3
|
-
*
|
|
4
|
-
* The channel cache is keyed by the channel internal id (see `idResolvers.channel`), but
|
|
5
|
-
* realtime payloads reference channels by different ids: pin events carry the **public**
|
|
6
|
-
* id, messages carry `channelId`. Try the cheap direct lookup first, then scan.
|
|
7
|
-
*/
|
|
8
|
-
export declare const findCachedChannelByAnyId: (id: string | undefined) => Amity.StaticInternalChannel | undefined;
|
|
9
|
-
/**
|
|
10
|
-
* Resolve the cached channel a `channel.messagePinned` / `channel.messageUnpinned` event
|
|
11
|
-
* refers to. `data.channelId` is the channel public id; a pinned message body (present on
|
|
12
|
-
* `messagePinned` only) also carries the internal id, which is the direct cache key.
|
|
13
|
-
*/
|
|
14
|
-
export declare const findCachedChannelForPin: (payload: Amity.ChannelPinnedMessagePayload) => Amity.StaticInternalChannel | undefined;
|
|
15
|
-
/**
|
|
16
|
-
* Write a new pin snapshot (or `null` to clear) on a cached channel and ingest any
|
|
17
|
-
* users delivered with it (the pin author and the message author), so the banner can
|
|
18
|
-
* render a byline without a second fetch.
|
|
19
|
-
*
|
|
20
|
-
* Every `messagePinned` payload is a full snapshot — "this is the pin now" — so the last
|
|
21
|
-
* one received always wins; there is no merging with the previous pin.
|
|
22
|
-
*/
|
|
23
|
-
export declare const updatePinnedMessageCache: (channel: Amity.StaticInternalChannel, pinnedMessage: Amity.RawPinnedMessage | null, users?: Amity.RawUser[]) => Amity.StaticInternalChannel;
|
|
24
|
-
//# sourceMappingURL=updatePinnedMessageCache.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"updatePinnedMessageCache.d.ts","sourceRoot":"","sources":["../../../src/channelRepository/utils/updatePinnedMessageCache.ts"],"names":[],"mappings":"AAWA;;;;;;GAMG;AACH,eAAO,MAAM,wBAAwB,OAC/B,MAAM,GAAG,SAAS,KACrB,MAAM,qBAAqB,GAAG,SAUhC,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,YACzB,MAAM,2BAA2B,KACzC,MAAM,qBAAqB,GAAG,SAEY,CAAC;AAE9C;;;;;;;GAOG;AACH,eAAO,MAAM,wBAAwB,YAC1B,MAAM,qBAAqB,iBACrB,MAAM,gBAAgB,GAAG,IAAI,UACpC,MAAM,OAAO,EAAE,KACtB,MAAM,qBASR,CAAC"}
|
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* ```js
|
|
3
|
-
* import { MessageRepository } from '@amityco/ts-sdk'
|
|
4
|
-
* const channel = await MessageRepository.pinMessage(messageId)
|
|
5
|
-
* console.log(channel.pinnedMessage)
|
|
6
|
-
* ```
|
|
7
|
-
*
|
|
8
|
-
* Pins a {@link Amity.Message} in its livestream (`live`) channel. A channel holds at
|
|
9
|
-
* most one pinned message: pinning a different message replaces the current pin in a
|
|
10
|
-
* single step — no unpin is needed first. Pinning the message that is already pinned is
|
|
11
|
-
* rejected by the server (400).
|
|
12
|
-
*
|
|
13
|
-
* The caller must hold the `PIN_MESSAGE` permission in the channel (or be an admin with
|
|
14
|
-
* `ModerateChannel`). The server also rejects pinning a deleted message, a message whose
|
|
15
|
-
* author is banned from the channel or globally banned, and pinning in any channel type
|
|
16
|
-
* other than `live`. On any error the pin state is left unchanged.
|
|
17
|
-
*
|
|
18
|
-
* The response is the affected channel; it is ingested into cache and fires
|
|
19
|
-
* `local.channel.updated`, so `ChannelRepository.getChannel` observers update without
|
|
20
|
-
* waiting for the `channel.messagePinned` realtime event.
|
|
21
|
-
*
|
|
22
|
-
* @param messageId the **internal** ID of the {@link Amity.Message} to pin
|
|
23
|
-
* @returns the updated {@link Amity.Channel}, with `pinnedMessage` set
|
|
24
|
-
*
|
|
25
|
-
* @category Message API
|
|
26
|
-
* @async
|
|
27
|
-
*/
|
|
28
|
-
export declare const pinMessage: (messageId: Amity.Message['messageId']) => Promise<Amity.Channel>;
|
|
29
|
-
//# sourceMappingURL=pinMessage.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"pinMessage.d.ts","sourceRoot":"","sources":["../../../src/messageRepository/api/pinMessage.ts"],"names":[],"mappings":"AAWA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,UAAU,cAAqB,MAAM,OAAO,CAAC,WAAW,CAAC,KAAG,QAAQ,MAAM,OAAO,CAuB7F,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"pinMessage.test.d.ts","sourceRoot":"","sources":["../../../../src/messageRepository/api/tests/pinMessage.test.ts"],"names":[],"mappings":""}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"unpinMessage.test.d.ts","sourceRoot":"","sources":["../../../../src/messageRepository/api/tests/unpinMessage.test.ts"],"names":[],"mappings":""}
|
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* ```js
|
|
3
|
-
* import { MessageRepository } from '@amityco/ts-sdk'
|
|
4
|
-
* const channel = await MessageRepository.unpinMessage(messageId)
|
|
5
|
-
* console.log(channel.pinnedMessage) // null
|
|
6
|
-
* ```
|
|
7
|
-
*
|
|
8
|
-
* Removes the pin from a {@link Amity.Message}. `messageId` must be the message that is
|
|
9
|
-
* **currently** pinned in its channel; otherwise the server answers 400 — this is
|
|
10
|
-
* deliberate, so a stale client cannot clear a pin that someone else has since replaced.
|
|
11
|
-
* On that error, re-read the channel (or rely on the `channel.messagePinned` event) to
|
|
12
|
-
* get the current pin.
|
|
13
|
-
*
|
|
14
|
-
* The caller must hold the `PIN_MESSAGE` permission in the channel (or be an admin with
|
|
15
|
-
* `ModerateChannel`). Unpinning is allowed regardless of channel type and stream state.
|
|
16
|
-
*
|
|
17
|
-
* The response is the affected channel; it is ingested into cache and fires
|
|
18
|
-
* `local.channel.updated`, so `ChannelRepository.getChannel` observers update without
|
|
19
|
-
* waiting for the `channel.messageUnpinned` realtime event.
|
|
20
|
-
*
|
|
21
|
-
* @param messageId the **internal** ID of the currently pinned {@link Amity.Message}
|
|
22
|
-
* @returns the updated {@link Amity.Channel}, with `pinnedMessage` cleared
|
|
23
|
-
*
|
|
24
|
-
* @category Message API
|
|
25
|
-
* @async
|
|
26
|
-
*/
|
|
27
|
-
export declare const unpinMessage: (messageId: Amity.Message['messageId']) => Promise<Amity.Channel>;
|
|
28
|
-
//# sourceMappingURL=unpinMessage.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"unpinMessage.d.ts","sourceRoot":"","sources":["../../../src/messageRepository/api/unpinMessage.ts"],"names":[],"mappings":"AAWA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,YAAY,cACZ,MAAM,OAAO,CAAC,WAAW,CAAC,KACpC,QAAQ,MAAM,OAAO,CAuBvB,CAAC"}
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Fire-and-forget refresh of `channelUsers[...].permissions` for the channel a
|
|
3
|
-
* message belongs to. Used by `pinMessage` / `unpinMessage` on `403` so the next
|
|
4
|
-
* `hasPermission(PIN_MESSAGE).channel(channelId)` reflects a revoked role
|
|
5
|
-
* ([`pinMessage` REQ-010](../../@types/../..) / [`unpinMessage` REQ-008](../../@types/../..)).
|
|
6
|
-
*
|
|
7
|
-
* The API only receives a `messageId`, so the channel is resolved through the
|
|
8
|
-
* local cache: first the message row, then any cached channel whose current pin
|
|
9
|
-
* is that message. When nothing matches the refresh is skipped — the next
|
|
10
|
-
* channel read picks up the fresh permissions anyway.
|
|
11
|
-
*/
|
|
12
|
-
export declare const refreshChannelPermissionsForMessage: (messageId: Amity.Message['messageId']) => void;
|
|
13
|
-
//# sourceMappingURL=refreshChannelPermissionsForMessage.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"refreshChannelPermissionsForMessage.d.ts","sourceRoot":"","sources":["../../../src/messageRepository/utils/refreshChannelPermissionsForMessage.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;GAUG;AACH,eAAO,MAAM,mCAAmC,cACnC,MAAM,OAAO,CAAC,WAAW,CAAC,KACpC,IAeF,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"pinnedMessage.d.ts","sourceRoot":"","sources":["../../../../src/utils/tests/dummy/pinnedMessage.ts"],"names":[],"mappings":"AAAA,wBAAgB,wBAAwB,CACtC,MAAM,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,gBAAgB,CAAC,GACvC,KAAK,CAAC,gBAAgB,CAoBxB"}
|