@messenger-box/platform-server 10.0.3-alpha.6 → 10.0.3-alpha.62

package/lib/services/proxy-services/post-microservice.d.ts

@@ -1,21 +1,195 @@
 import { ServiceBroker } from 'moleculer';
-import { IFileInfo, IMessageIdentifier, MoleculerTopics as MoleculerTopics, IPost, IPostThread, IUploadedFileInput, IPostService, IPostServiceInput, CreatePostThreadOptions } from 'common';
+import { IFileInfo, IMessageIdentifier, MoleculerTopics as MoleculerTopics, IPostModel, IPostThread, IUploadedFileInput, IPostService, IPostServiceInput, CreatePostThreadOptions, AsDomainType } from 'common/server';
 import { BaseProxyService } from '@common-stack/store-mongo';
 import { CdmLogger } from '@cdm-logger/core';
-export declare class PostProxyService extends BaseProxyService<IPost, IPostServiceInput, Partial<IPost>> implements IPostService {
+import { Disposable, DisposableCollection } from '@adminide-stack/core';
+/**
+ * Post Microservice Implementation
+ *
+ * This microservice handles comprehensive post management within the messenger platform,
+ * providing operations for creating, updating, managing posts and their associated
+ * content including file attachments, notifications, threading, and real-time
+ * message delivery across channels and organizations through service broker delegation.
+ *
+ * Key capabilities:
+ * - Post lifecycle management (creation, updates, deletion)
+ * - File attachment handling and upload management
+ * - Real-time message delivery and notifications
+ * - Post threading and conversation management
+ * - Message status tracking (read, delivered)
+ * - Channel integration and message counting
+ * - Expo push notification integration
+ * - File upload link generation and management
+ */
+export declare class PostProxyService extends BaseProxyService<IPostModel, IPostServiceInput, Partial<IPostModel>> implements IPostService, Disposable {
     protected readonly logger: CdmLogger.ILogger;
+    protected readonly toDispose: DisposableCollection;
     topic: MoleculerTopics;
     constructor(broker: ServiceBroker, logger: CdmLogger.ILogger);
-    attachUploadedFile(postId: string, file: IUploadedFileInput, createdBy: string): Promise<IFileInfo>;
-    createFileUploadLink(postId: string, filename: string, userId: string): Promise<string>;
-    attachUploadedFiles(postId: string, files: IUploadedFileInput[], createdBy: string): Promise<IFileInfo[]>;
-    createFilesUploadLink(postId: string, filenames: string[], userId: string): Promise<string[]>;
-    deleteFile(url: string): Promise<boolean>;
-    readMessage(messageId: IMessageIdentifier, user: string): Promise<boolean>;
-    deliverMessage(messageId: IMessageIdentifier, user: string): Promise<boolean>;
-    createWithoutSubscription(data: IPostServiceInput): Promise<IPost>;
+    /**
+     * Disposes of resources used by the service
+     */
+    dispose(): void;
+    /**
+     * Creates a file upload link for a post
+     *
+     * @description Generates a secure upload URL for attaching files to posts
+     *
+     * @param {string} postId - The post identifier
+     * @param {string} filename - The name of the file to upload
+     * @param {string} userId - The user performing the upload
+     * @returns {Promise<string | Error>} - Upload URL or error
+     */
+    createFileUploadLink(postId: string, filename: string, userId: string): Promise<string | Error>;
+    /**
+     * Attaches an uploaded file to a post
+     *
+     * @description Processes and attaches a completed file upload to a post
+     *
+     * @param {string} postId - The post identifier
+     * @param {IUploadedFileInput} file - The uploaded file information
+     * @param {string} createdBy - The user who uploaded the file
+     * @returns {Promise<IFileInfo | Error>} - File information or error
+     */
+    attachUploadedFile(postId: string, file: IUploadedFileInput, createdBy: string): Promise<IFileInfo | Error>;
+    /**
+     * Creates upload links for multiple files
+     *
+     * @description Generates secure upload URLs for multiple files to be attached to a post
+     *
+     * @param {string} postId - The post identifier
+     * @param {string[]} filenames - Array of file names
+     * @param {string} userId - The user performing the uploads
+     * @returns {Promise<string[] | Error>} - Array of upload URLs or error
+     */
+    createFilesUploadLink(postId: string, filenames: string[], userId: string): Promise<string[] | Error>;
+    /**
+     * Attaches multiple uploaded files to a post
+     *
+     * @description Processes and attaches multiple completed file uploads to a post
+     *
+     * @param {string} postId - The post identifier
+     * @param {IUploadedFileInput[]} files - Array of uploaded file information
+     * @param {string} createdBy - The user who uploaded the files
+     * @returns {Promise<IFileInfo[] | Error>} - Array of file information or error
+     */
+    attachUploadedFiles(postId: string, files: IUploadedFileInput[], createdBy: string): Promise<IFileInfo[] | Error>;
+    /**
+     * Creates a new post with full integration
+     *
+     * @description Creates a post with channel updates, notifications, and real-time publishing
+     *
+     * @param {IPostServiceInput} data - Post creation data
+     * @returns {Promise<AsDomainType<IPostModel> | Error>} - Created post or error
+     */
+    create(data: IPostServiceInput): Promise<AsDomainType<IPostModel> | Error>;
+    /**
+     * Creates a post without real-time subscription
+     *
+     * @description Creates a post with channel updates but without real-time publishing
+     *
+     * @param {IPostServiceInput} data - Post creation data
+     * @returns {Promise<AsDomainType<IPostModel> | Error>} - Created post or error
+     */
+    createWithoutSubscription(data: IPostServiceInput): Promise<AsDomainType<IPostModel> | Error>;
+    /**
+     * Deletes a file by URL
+     *
+     * @description Removes a file from storage using its URL
+     *
+     * @param {string} url - The file URL to delete
+     * @returns {Promise<boolean | Error>} - Success status or error
+     */
+    deleteFile(url: string): Promise<boolean | Error>;
+    /**
+     * Marks a message as read by a user
+     *
+     * @description Updates message status to indicate it has been read by a specific user
+     *
+     * @param {IMessageIdentifier} messageId - Message identifier
+     * @param {string} user - User ID who read the message
+     * @returns {Promise<boolean | Error>} - Success status or error
+     */
+    readMessage(messageId: IMessageIdentifier, user: string): Promise<boolean | Error>;
+    /**
+     * Marks a message as delivered to a user
+     *
+     * @description Updates message status to indicate it has been delivered to a specific user
+     *
+     * @param {IMessageIdentifier} messageId - Message identifier
+     * @param {string} user - User ID who received the message
+     * @returns {Promise<boolean | Error>} - Success status or error
+     */
+    deliverMessage(messageId: IMessageIdentifier, user: string): Promise<boolean | Error>;
+    /**
+     * Creates a post with associated post thread
+     *
+     * @description Creates both a post and its associated thread for threaded conversations
+     *
+     * @param {CreatePostThreadOptions} data - Post and thread creation options
+     * @returns {Promise<{post: AsDomainType<IPostModel>; postThread: IPostThread} | Error>} - Created post and thread or error
+     */
     createPostWithPostThread(data: CreatePostThreadOptions): Promise<{
-        post: IPost;
+        post: AsDomainType<IPostModel>;
         postThread: IPostThread;
-    }>;
+    } | Error>;
+    /**
+     * Retrieves the last message in a channel
+     *
+     * @description Gets the most recent post/message from a specific channel
+     *
+     * @param {string} channelId - The channel identifier
+     * @returns {Promise<AsDomainType<IPostModel> | Error>} - Last message or error
+     */
+    getLastMessage(channelId: string): Promise<AsDomainType<IPostModel> | Error>;
+    /**
+     * Gets posts by channel with pagination
+     *
+     * @description Retrieves posts from a channel with pagination support
+     *
+     * @param {string} channelId - The channel identifier
+     * @param {number} limit - Maximum number of posts to return
+     * @param {number} offset - Number of posts to skip
+     * @returns {Promise<Array<AsDomainType<IPostModel>> | Error>} - Array of posts or error
+     */
+    getPostsByChannel(channelId: string, limit?: number, offset?: number): Promise<Array<AsDomainType<IPostModel>> | Error>;
+    /**
+     * Updates a post
+     *
+     * @description Updates post content and metadata
+     *
+     * @param {string} postId - The post identifier
+     * @param {Partial<IPostServiceInput>} updates - Update data
+     * @returns {Promise<AsDomainType<IPostModel> | Error>} - Updated post or error
+     */
+    updatePost(postId: string, updates: Partial<IPostServiceInput>): Promise<AsDomainType<IPostModel> | Error>;
+    /**
+     * Deletes a post
+     *
+     * @description Soft deletes a post and its associated data
+     *
+     * @param {string} postId - The post identifier
+     * @returns {Promise<boolean | Error>} - Success status or error
+     */
+    deletePost(postId: string): Promise<boolean | Error>;
+    /**
+     * Validates post data for creation or updates
+     *
+     * @description Helper method to validate post data before processing
+     *
+     * @param {IPostServiceInput} data - Data to validate
+     * @returns {Promise<boolean | Error>} - Validation result or error
+     */
+    validatePostData(data: IPostServiceInput): Promise<boolean | Error>;
+    /**
+     * Gets posts by author with pagination
+     *
+     * @description Convenience method to get posts created by a specific author
+     *
+     * @param {string} authorId - The author identifier
+     * @param {number} limit - Maximum number of posts to return
+     * @param {number} offset - Number of posts to skip
+     * @returns {Promise<Array<AsDomainType<IPostModel>> | Error>} - Array of posts or error
+     */
+    getPostsByAuthor(authorId: string, limit?: number, offset?: number): Promise<Array<AsDomainType<IPostModel>> | Error>;
 }