@amityco/ts-sdk 7.26.1-db34ef5c.0 → 7.26.1-e618fbd1.0

package/dist/messagePreview/utils/getChannelMessagePreviewWithUser.d.ts

@@ -20,6 +20,7 @@ export declare const getChannelMessagePreviewWithUser: (channel: Amity.StaticInt
     messageCount: number;
     moderatorMemberCount?: number | undefined;
     messagePreviewId?: string | undefined;
+    pinnedMessage?: Amity.RawPinnedMessage<any> | null | undefined;
     isPublic?: boolean | undefined;
     lastActivity: string;
     attachedTo?: {

package/dist/messagePreview/utils/getChannelMessagePreviewWithUser.d.ts.map

@@ -1 +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"}
+{"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"}

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

@@ -3,6 +3,8 @@ export * from './updateMessage';
 export * from './editMessage';
 export * from './deleteMessage';
 export * from './softDeleteMessage';
+export * from './pinMessage';
+export * from './unpinMessage';
 export * from './markAsDelivered';
 export * from './getReadUsers';
 export * from './getDeliveredUsers';

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

@@ -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,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,qBAAqB,CAAC;AAEpC,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,wBAAwB,CAAC"}
+{"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,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAE/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,qBAAqB,CAAC;AAEpC,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,wBAAwB,CAAC"}

package/dist/messageRepository/api/pinMessage.d.ts

@@ -0,0 +1,29 @@
+/**
+ * ```js
+ * import { MessageRepository } from '@amityco/ts-sdk'
+ * const channel = await MessageRepository.pinMessage(messageId)
+ * console.log(channel.pinnedMessage)
+ * ```
+ *
+ * Pins a {@link Amity.Message} in its livestream (`live`) channel. A channel holds at
+ * most one pinned message: pinning a different message replaces the current pin in a
+ * single step — no unpin is needed first. Pinning the message that is already pinned is
+ * rejected by the server (400).
+ *
+ * The caller must hold the `PIN_MESSAGE` permission in the channel (or be an admin with
+ * `ModerateChannel`). The server also rejects pinning a deleted message, a message whose
+ * author is banned from the channel or globally banned, and pinning in any channel type
+ * other than `live`. On any error the pin state is left unchanged.
+ *
+ * The response is the affected channel; it is ingested into cache and fires
+ * `local.channel.updated`, so `ChannelRepository.getChannel` observers update without
+ * waiting for the `channel.messagePinned` realtime event.
+ *
+ * @param messageId the **internal** ID of the {@link Amity.Message} to pin
+ * @returns the updated {@link Amity.Channel}, with `pinnedMessage` set
+ *
+ * @category Message API
+ * @async
+ */
+export declare const pinMessage: (messageId: Amity.Message['messageId']) => Promise<Amity.Channel>;
+//# sourceMappingURL=pinMessage.d.ts.map

package/dist/messageRepository/api/pinMessage.d.ts.map

@@ -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"}

package/dist/messageRepository/api/tests/pinMessage.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=pinMessage.test.d.ts.map

package/dist/messageRepository/api/tests/pinMessage.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pinMessage.test.d.ts","sourceRoot":"","sources":["../../../../src/messageRepository/api/tests/pinMessage.test.ts"],"names":[],"mappings":""}

package/dist/messageRepository/api/tests/unpinMessage.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=unpinMessage.test.d.ts.map

package/dist/messageRepository/api/tests/unpinMessage.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"unpinMessage.test.d.ts","sourceRoot":"","sources":["../../../../src/messageRepository/api/tests/unpinMessage.test.ts"],"names":[],"mappings":""}

package/dist/messageRepository/api/unpinMessage.d.ts

@@ -0,0 +1,28 @@
+/**
+ * ```js
+ * import { MessageRepository } from '@amityco/ts-sdk'
+ * const channel = await MessageRepository.unpinMessage(messageId)
+ * console.log(channel.pinnedMessage) // null
+ * ```
+ *
+ * Removes the pin from a {@link Amity.Message}. `messageId` must be the message that is
+ * **currently** pinned in its channel; otherwise the server answers 400 — this is
+ * deliberate, so a stale client cannot clear a pin that someone else has since replaced.
+ * On that error, re-read the channel (or rely on the `channel.messagePinned` event) to
+ * get the current pin.
+ *
+ * The caller must hold the `PIN_MESSAGE` permission in the channel (or be an admin with
+ * `ModerateChannel`). Unpinning is allowed regardless of channel type and stream state.
+ *
+ * The response is the affected channel; it is ingested into cache and fires
+ * `local.channel.updated`, so `ChannelRepository.getChannel` observers update without
+ * waiting for the `channel.messageUnpinned` realtime event.
+ *
+ * @param messageId the **internal** ID of the currently pinned {@link Amity.Message}
+ * @returns the updated {@link Amity.Channel}, with `pinnedMessage` cleared
+ *
+ * @category Message API
+ * @async
+ */
+export declare const unpinMessage: (messageId: Amity.Message['messageId']) => Promise<Amity.Channel>;
+//# sourceMappingURL=unpinMessage.d.ts.map

package/dist/messageRepository/api/unpinMessage.d.ts.map

@@ -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"}

package/dist/messageRepository/utils/refreshChannelPermissionsForMessage.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Fire-and-forget refresh of `channelUsers[...].permissions` for the channel a
+ * message belongs to. Used by `pinMessage` / `unpinMessage` on `403` so the next
+ * `hasPermission(PIN_MESSAGE).channel(channelId)` reflects a revoked role
+ * ([`pinMessage` REQ-010](../../@types/../..) / [`unpinMessage` REQ-008](../../@types/../..)).
+ *
+ * The API only receives a `messageId`, so the channel is resolved through the
+ * local cache: first the message row, then any cached channel whose current pin
+ * is that message. When nothing matches the refresh is skipped — the next
+ * channel read picks up the fresh permissions anyway.
+ */
+export declare const refreshChannelPermissionsForMessage: (messageId: Amity.Message['messageId']) => void;
+//# sourceMappingURL=refreshChannelPermissionsForMessage.d.ts.map

package/dist/messageRepository/utils/refreshChannelPermissionsForMessage.d.ts.map

@@ -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"}

package/dist/utils/tests/dummy/index.d.ts

@@ -21,4 +21,5 @@ export * from './community';
 export * from './category';
 export * from './stream';
 export * from './feed';
+export * from './pinnedMessage';
 //# sourceMappingURL=index.d.ts.map

package/dist/utils/tests/dummy/index.d.ts.map

@@ -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"}
+{"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;AACvB,cAAc,iBAAiB,CAAC"}

package/dist/utils/tests/dummy/pinnedMessage.d.ts

@@ -0,0 +1,2 @@
+export declare function generateRawPinnedMessage(params?: Partial<Amity.RawPinnedMessage>): Amity.RawPinnedMessage;
+//# sourceMappingURL=pinnedMessage.d.ts.map

package/dist/utils/tests/dummy/pinnedMessage.d.ts.map

@@ -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"}

package/package.json

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