@brightchain/brightchain-api-lib 0.14.0 → 0.15.0

package/src/lib/controllers/api/channels.d.ts

@@ -0,0 +1,122 @@
+/**
+ * ChannelController — REST API for channel management.
+ *
+ * Routes:
+ *   POST   /                                         — Create a channel
+ *   GET    /                                         — List discoverable channels
+ *   GET    /:channelId                               — Get channel metadata
+ *   PUT    /:channelId                               — Update channel settings
+ *   DELETE /:channelId                               — Delete channel
+ *   POST   /:channelId/join                          — Join a channel
+ *   POST   /:channelId/leave                         — Leave a channel
+ *   POST   /:channelId/messages                      — Send message
+ *   GET    /:channelId/messages                      — Get message history
+ *   GET    /:channelId/messages/search               — Search messages
+ *   POST   /:channelId/invites                       — Generate invite token
+ *   POST   /:channelId/invites/:token/redeem         — Redeem invite token
+ *   PUT    /:channelId/roles/:memberId               — Assign role
+ *   POST   /:channelId/messages/:messageId/reactions  — Add reaction
+ *   DELETE /:channelId/messages/:messageId/reactions/:reactionId — Remove reaction
+ *   PUT    /:channelId/messages/:messageId            — Edit message
+ *   POST   /:channelId/messages/:messageId/pin        — Pin message
+ *   DELETE /:channelId/messages/:messageId/pin        — Unpin message
+ *   POST   /:channelId/mute/:memberId                — Mute a member
+ *   POST   /:channelId/kick/:memberId                — Kick a member
+ *
+ * Requirements: 4.1, 4.2, 4.3, 4.4, 4.5, 5.1, 5.2, 5.3, 5.4, 5.5
+ */
+import { IAddReactionResponse, IAssignRoleResponse, ICreateChannelResponse, ICreateInviteResponse, IDeleteChannelResponse, IEditMessageResponse, IGetChannelMessagesResponse, IGetChannelResponse, IJoinChannelResponse, IKickChannelMemberResponse, ILeaveChannelResponse, IListChannelsResponse, IMuteChannelMemberResponse, IPinMessageResponse, IRedeemInviteResponse, IRemoveReactionResponse, ISearchMessagesResponse, ISendChannelMessageResponse, IUnpinMessageResponse, IUpdateChannelResponse } from '@brightchain/brightchain-lib';
+import { ChannelService } from '@brightchain/brightchain-lib/lib/services/communication/channelService';
+import { PermissionService } from '@brightchain/brightchain-lib/lib/services/communication/permissionService';
+import { CoreLanguageCode } from '@digitaldefiance/i18n-lib';
+import { PlatformID } from '@digitaldefiance/node-ecies-lib';
+import { ApiErrorResponse, ApiRequestHandler, TypedHandlers } from '@digitaldefiance/node-express-suite';
+import { IBrightChainApplication } from '../../interfaces/application';
+import { DefaultBackendIdType } from '../../shared-types';
+import { BaseController } from '../base';
+type ChannelApiResponse = ICreateChannelResponse | IListChannelsResponse | IGetChannelResponse | IUpdateChannelResponse | IDeleteChannelResponse | IJoinChannelResponse | ILeaveChannelResponse | ISendChannelMessageResponse | IGetChannelMessagesResponse | ISearchMessagesResponse | ICreateInviteResponse | IRedeemInviteResponse | IAssignRoleResponse | IAddReactionResponse | IRemoveReactionResponse | IEditMessageResponse | IPinMessageResponse | IUnpinMessageResponse | IMuteChannelMemberResponse | IKickChannelMemberResponse | ApiErrorResponse;
+interface ChannelHandlers extends TypedHandlers {
+    createChannel: ApiRequestHandler<ICreateChannelResponse | ApiErrorResponse>;
+    listChannels: ApiRequestHandler<IListChannelsResponse | ApiErrorResponse>;
+    getChannel: ApiRequestHandler<IGetChannelResponse | ApiErrorResponse>;
+    updateChannel: ApiRequestHandler<IUpdateChannelResponse | ApiErrorResponse>;
+    deleteChannel: ApiRequestHandler<IDeleteChannelResponse | ApiErrorResponse>;
+    joinChannel: ApiRequestHandler<IJoinChannelResponse | ApiErrorResponse>;
+    leaveChannel: ApiRequestHandler<ILeaveChannelResponse | ApiErrorResponse>;
+    sendMessage: ApiRequestHandler<ISendChannelMessageResponse | ApiErrorResponse>;
+    getMessages: ApiRequestHandler<IGetChannelMessagesResponse | ApiErrorResponse>;
+    searchMessages: ApiRequestHandler<ISearchMessagesResponse | ApiErrorResponse>;
+    createInvite: ApiRequestHandler<ICreateInviteResponse | ApiErrorResponse>;
+    redeemInvite: ApiRequestHandler<IRedeemInviteResponse | ApiErrorResponse>;
+    assignRole: ApiRequestHandler<IAssignRoleResponse | ApiErrorResponse>;
+    addReaction: ApiRequestHandler<IAddReactionResponse | ApiErrorResponse>;
+    removeReaction: ApiRequestHandler<IRemoveReactionResponse | ApiErrorResponse>;
+    editMessage: ApiRequestHandler<IEditMessageResponse | ApiErrorResponse>;
+    pinMessage: ApiRequestHandler<IPinMessageResponse | ApiErrorResponse>;
+    unpinMessage: ApiRequestHandler<IUnpinMessageResponse | ApiErrorResponse>;
+    muteMember: ApiRequestHandler<IMuteChannelMemberResponse | ApiErrorResponse>;
+    kickMember: ApiRequestHandler<IKickChannelMemberResponse | ApiErrorResponse>;
+}
+/**
+ * Controller for channel operations.
+ *
+ * @requirements 4.1, 4.2, 4.3, 4.4, 4.5, 5.1, 5.2, 5.3, 5.4, 5.5
+ */
+export declare class ChannelController<TID extends PlatformID = DefaultBackendIdType> extends BaseController<TID, ChannelApiResponse, ChannelHandlers, CoreLanguageCode> {
+    private channelService;
+    private permissionService;
+    constructor(application: IBrightChainApplication<TID>);
+    setChannelService(service: ChannelService): void;
+    setPermissionService(service: PermissionService): void;
+    private getChannelService;
+    private getPermissionService;
+    /**
+     * Extract the authenticated member ID from the request.
+     * Falls back to body/query memberId for testing.
+     */
+    private getMemberId;
+    protected initRouteDefinitions(): void;
+    /** POST / — Create a channel. @requirements 4.1 */
+    private handleCreateChannel;
+    /** GET / — List discoverable channels. @requirements 4.3, 5.1 */
+    private handleListChannels;
+    /** GET /:channelId — Get channel metadata. */
+    private handleGetChannel;
+    /** PUT /:channelId — Update channel settings. @requirements 5.2 */
+    private handleUpdateChannel;
+    /** DELETE /:channelId — Delete channel. */
+    private handleDeleteChannel;
+    /** POST /:channelId/join — Join a channel. @requirements 4.4, 4.5 */
+    private handleJoinChannel;
+    /** POST /:channelId/leave — Leave a channel. */
+    private handleLeaveChannel;
+    /** POST /:channelId/messages — Send message. @requirements 4.2 */
+    private handleSendMessage;
+    /** GET /:channelId/messages — Get message history. */
+    private handleGetMessages;
+    /** GET /:channelId/messages/search — Search messages. */
+    private handleSearchMessages;
+    /** POST /:channelId/invites — Generate invite token. @requirements 5.3 */
+    private handleCreateInvite;
+    /** POST /:channelId/invites/:token/redeem — Redeem invite. @requirements 5.4, 5.5 */
+    private handleRedeemInvite;
+    /** PUT /:channelId/roles/:memberId — Assign role. */
+    private handleAssignRole;
+    /** POST /:channelId/messages/:messageId/reactions — Add reaction. */
+    private handleAddReaction;
+    /** DELETE /:channelId/messages/:messageId/reactions/:reactionId — Remove reaction. */
+    private handleRemoveReaction;
+    /** PUT /:channelId/messages/:messageId — Edit message. */
+    private handleEditMessage;
+    /** POST /:channelId/messages/:messageId/pin — Pin message. */
+    private handlePinMessage;
+    /** DELETE /:channelId/messages/:messageId/pin — Unpin message. */
+    private handleUnpinMessage;
+    /** POST /:channelId/mute/:memberId — Mute a member. */
+    private handleMuteMember;
+    /** POST /:channelId/kick/:memberId — Kick a member. */
+    private handleKickMember;
+    private mapServiceError;
+}
+export {};
+//# sourceMappingURL=channels.d.ts.map

package/src/lib/controllers/api/channels.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"channels.d.ts","sourceRoot":"","sources":["../../../../../../brightchain-api-lib/src/lib/controllers/api/channels.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,OAAO,EAGL,oBAAoB,EACpB,mBAAmB,EACnB,sBAAsB,EACtB,qBAAqB,EACrB,sBAAsB,EACtB,oBAAoB,EACpB,2BAA2B,EAC3B,mBAAmB,EACnB,oBAAoB,EACpB,0BAA0B,EAC1B,qBAAqB,EACrB,qBAAqB,EACrB,0BAA0B,EAC1B,mBAAmB,EACnB,qBAAqB,EACrB,uBAAuB,EACvB,uBAAuB,EACvB,2BAA2B,EAC3B,qBAAqB,EACrB,sBAAsB,EACvB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAQL,cAAc,EAMf,MAAM,wEAAwE,CAAC;AAChF,OAAO,EAAE,iBAAiB,EAAE,MAAM,2EAA2E,CAAC;AAC9G,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAC7D,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,aAAa,EAEd,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AA4B1D,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAEzC,KAAK,kBAAkB,GACnB,sBAAsB,GACtB,qBAAqB,GACrB,mBAAmB,GACnB,sBAAsB,GACtB,sBAAsB,GACtB,oBAAoB,GACpB,qBAAqB,GACrB,2BAA2B,GAC3B,2BAA2B,GAC3B,uBAAuB,GACvB,qBAAqB,GACrB,qBAAqB,GACrB,mBAAmB,GACnB,oBAAoB,GACpB,uBAAuB,GACvB,oBAAoB,GACpB,mBAAmB,GACnB,qBAAqB,GACrB,0BAA0B,GAC1B,0BAA0B,GAC1B,gBAAgB,CAAC;AAErB,UAAU,eAAgB,SAAQ,aAAa;IAC7C,aAAa,EAAE,iBAAiB,CAAC,sBAAsB,GAAG,gBAAgB,CAAC,CAAC;IAC5E,YAAY,EAAE,iBAAiB,CAAC,qBAAqB,GAAG,gBAAgB,CAAC,CAAC;IAC1E,UAAU,EAAE,iBAAiB,CAAC,mBAAmB,GAAG,gBAAgB,CAAC,CAAC;IACtE,aAAa,EAAE,iBAAiB,CAAC,sBAAsB,GAAG,gBAAgB,CAAC,CAAC;IAC5E,aAAa,EAAE,iBAAiB,CAAC,sBAAsB,GAAG,gBAAgB,CAAC,CAAC;IAC5E,WAAW,EAAE,iBAAiB,CAAC,oBAAoB,GAAG,gBAAgB,CAAC,CAAC;IACxE,YAAY,EAAE,iBAAiB,CAAC,qBAAqB,GAAG,gBAAgB,CAAC,CAAC;IAC1E,WAAW,EAAE,iBAAiB,CAC5B,2BAA2B,GAAG,gBAAgB,CAC/C,CAAC;IACF,WAAW,EAAE,iBAAiB,CAC5B,2BAA2B,GAAG,gBAAgB,CAC/C,CAAC;IACF,cAAc,EAAE,iBAAiB,CAAC,uBAAuB,GAAG,gBAAgB,CAAC,CAAC;IAC9E,YAAY,EAAE,iBAAiB,CAAC,qBAAqB,GAAG,gBAAgB,CAAC,CAAC;IAC1E,YAAY,EAAE,iBAAiB,CAAC,qBAAqB,GAAG,gBAAgB,CAAC,CAAC;IAC1E,UAAU,EAAE,iBAAiB,CAAC,mBAAmB,GAAG,gBAAgB,CAAC,CAAC;IACtE,WAAW,EAAE,iBAAiB,CAAC,oBAAoB,GAAG,gBAAgB,CAAC,CAAC;IACxE,cAAc,EAAE,iBAAiB,CAAC,uBAAuB,GAAG,gBAAgB,CAAC,CAAC;IAC9E,WAAW,EAAE,iBAAiB,CAAC,oBAAoB,GAAG,gBAAgB,CAAC,CAAC;IACxE,UAAU,EAAE,iBAAiB,CAAC,mBAAmB,GAAG,gBAAgB,CAAC,CAAC;IACtE,YAAY,EAAE,iBAAiB,CAAC,qBAAqB,GAAG,gBAAgB,CAAC,CAAC;IAC1E,UAAU,EAAE,iBAAiB,CAAC,0BAA0B,GAAG,gBAAgB,CAAC,CAAC;IAC7E,UAAU,EAAE,iBAAiB,CAAC,0BAA0B,GAAG,gBAAgB,CAAC,CAAC;CAC9E;AA8GD;;;;GAIG;AACH,qBAAa,iBAAiB,CAC5B,GAAG,SAAS,UAAU,GAAG,oBAAoB,CAC7C,SAAQ,cAAc,CACtB,GAAG,EACH,kBAAkB,EAClB,eAAe,EACf,gBAAgB,CACjB;IACC,OAAO,CAAC,cAAc,CAA+B;IACrD,OAAO,CAAC,iBAAiB,CAAkC;gBAE/C,WAAW,EAAE,uBAAuB,CAAC,GAAG,CAAC;IAI9C,iBAAiB,CAAC,OAAO,EAAE,cAAc,GAAG,IAAI;IAIhD,oBAAoB,CAAC,OAAO,EAAE,iBAAiB,GAAG,IAAI;IAI7D,OAAO,CAAC,iBAAiB;IAOzB,OAAO,CAAC,oBAAoB;IAO5B;;;OAGG;IACH,OAAO,CAAC,WAAW;IAenB,SAAS,CAAC,oBAAoB,IAAI,IAAI;IA2ItC,mDAAmD;YACrC,mBAAmB;IA6BjC,iEAAiE;YACnD,kBAAkB;IAyBhC,8CAA8C;YAChC,gBAAgB;IAwB9B,mEAAmE;YACrD,mBAAmB;IA4BjC,2CAA2C;YAC7B,mBAAmB;IAqBjC,qEAAqE;YACvD,iBAAiB;IAqB/B,gDAAgD;YAClC,kBAAkB;IAqBhC,kEAAkE;YACpD,iBAAiB;IA6B/B,sDAAsD;YACxC,iBAAiB;IA2B/B,yDAAyD;YAC3C,oBAAoB;IA+BlC,0EAA0E;YAC5D,kBAAkB;IA2BhC,qFAAqF;YACvE,kBAAkB;IAqBhC,qDAAqD;YACvC,gBAAgB;IAmC9B,qEAAqE;YACvD,iBAAiB;IA8B/B,sFAAsF;YACxE,oBAAoB;IA2BlC,0DAA0D;YAC5C,iBAAiB;IA8B/B,8DAA8D;YAChD,gBAAgB;IAqB9B,kEAAkE;YACpD,kBAAkB;IAyBhC,uDAAuD;YACzC,gBAAgB;IAiC9B,uDAAuD;YACzC,gBAAgB;IA2B9B,OAAO,CAAC,eAAe;CAqExB"}