@messenger-box/platform-server 10.0.3-alpha.50 → 10.0.3-alpha.54

package/lib/templates/services/PostService.ts.template

@@ -1,44 +1,206 @@
+/**
+ * Post Service Interface
+ * ----------------------
+ * 
+ * This interface defines the business logic layer for post and message management
+ * within the messenger platform. It provides comprehensive operations for handling
+ * messages, file attachments, threading, and message state management across
+ * different channels and communication contexts.
+ * 
+ * Key capabilities:
+ * - Post lifecycle management (creation, updates, deletion)
+ * - File upload and attachment handling (single and batch operations)
+ * - Message threading and conversation management
+ * - Message delivery and read status tracking
+ * - File management and cleanup operations
+ * - Cross-channel message coordination
+ * - Post-thread relationship management
+ * - Message state synchronization
+ * 
+ * The service layer abstracts complex messaging operations and provides a
+ * cohesive API for post-related functionality throughout the messaging platform,
+ * handling file storage, threading logic, and message state consistency.
+ */
+
 import { IBaseService } from '@common-stack/store-mongo';
-import { IFileInfo, IMessageIdentifier, IPost, IPostThread, IThreadMessageInput, IUploadedFileInput } from 'common/server';
+import { 
+    IFileInfo, 
+    IMessageIdentifier, 
+    IPost, 
+    IPostModel,
+    IPostThread, 
+    IThreadMessageInput, 
+    IUploadedFileInput, 
+    Disposable, 
+    AsDomainType 
+} from 'common/server';
 
-export interface IPostServiceInput extends Omit<IPost, 'id' | 'files' | 'isRead' | 'isDelivered'> {
+/**
+ * Post Service Input Interface
+ * 
+ * @description Input parameters for post creation operations,
+ * excluding auto-generated and system-managed fields.
+ */
+export interface IPostServiceInput extends Omit<IPostModel, 'id' | 'files' | 'isRead' | 'isDelivered' | '_id'> {
+    /** Array of file identifiers to attach to the post */
     files: string[];
+    /** Optional MongoDB ObjectId for the post */
     _id?: any;
 }
 
+/**
+ * Post Thread Creation Options
+ * 
+ * @description Configuration parameters for creating posts with associated threads.
+ */
 export type CreatePostThreadOptions = {
+    /** Thread message input data */
     threadMessageInput: IThreadMessageInput;
+    /** Channel identifier where the post will be created */
     channelId: string;
+    /** Optional responder user identifier */
     responderId?: string;
+    /** Optional parent post identifier for threading */
     postParentId?: string;
+    /** Optional existing post identifier */
     postId?: string;
+    /** Account identifier of the post creator */
     accountId: string;
+    /** Optional organization identifier */
     orgId?: string;
+    /** Optional existing post thread identifier */
     postThreadId?: string;
 };
 
-export interface IPostService extends IBaseService<IPost, IPostServiceInput, Partial<IPost>> {
-    createFileUploadLink(postId: string, filename: string, userId: string): Promise<string>;
-    attachUploadedFile(postId: string, file: IUploadedFileInput, createdBy: string): Promise<IFileInfo>;
+/**
+ * Post Service Interface
+ * 
+ * @description Provides comprehensive post and message management capabilities
+ * including file handling, threading, and message state management.
+ */
+export interface IPostService extends IBaseService<IPostModel, IPostServiceInput, Partial<IPostModel>>, Disposable {
+    /**
+     * Creates a file upload link for a specific post
+     * 
+     * @description Generates a secure upload URL for attaching a single file
+     * to an existing post, handling authentication and storage permissions.
+     * 
+     * @param {string} postId - The unique identifier of the post
+     * @param {string} filename - The name of the file to upload
+     * @param {string} userId - The identifier of 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 Associates a successfully uploaded file with a post,
+     * updating the post's file attachments and metadata.
+     * 
+     * @param {string} postId - The unique identifier of the post
+     * @param {IUploadedFileInput} file - The uploaded file information
+     * @param {string} createdBy - The identifier of 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 multiple file upload links for a post
+     * 
+     * @description Generates secure upload URLs for attaching multiple files
+     * to an existing post in a single operation.
+     * 
+     * @param {string} postId - The unique identifier of the post
+     * @param {string[]} filenames - Array of file names to upload
+     * @param {string} userId - The identifier of the user performing the upload
+     * @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 Associates multiple successfully uploaded files with a post
+     * in a single batch operation, optimizing performance and consistency.
+     * 
+     * @param {string} postId - The unique identifier of the post
+     * @param {IUploadedFileInput[]} files - Array of uploaded file information
+     * @param {string} createdBy - The identifier of 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>;
+
+    /**
+     * Deletes a file from storage
+     * 
+     * @description Permanently removes a file from the storage system,
+     * typically used for cleanup or when files are no longer needed.
+     * 
+     * @param {string} url - The URL or identifier of the file to delete
+     * @returns {Promise<boolean | Error>} - Success status or error
+     */
+    deleteFile(url: string): Promise<boolean | Error>;
 
-    createFilesUploadLink(postId: string, filenames: string[], userId: string): Promise<string[]>;
-    attachUploadedFiles(postId: string, files: IUploadedFileInput[], createdBy: string): Promise<IFileInfo[]>;
+    /**
+     * Marks a message as read by a user
+     * 
+     * @description Updates the read status of a message for a specific user,
+     * affecting unread counts and notification states.
+     * 
+     * @param {IMessageIdentifier} messageId - The message identifier
+     * @param {string} user - The identifier of the user marking the message as read
+     * @returns {Promise<boolean | Error>} - Success status or error
+     */
+    readMessage(messageId: IMessageIdentifier, user: string): Promise<boolean | Error>;
 
-    deleteFile(url: string): Promise<boolean>;
+    /**
+     * Marks a message as delivered to a user
+     * 
+     * @description Updates the delivery status of a message, indicating
+     * successful delivery to the target user's device or client.
+     * 
+     * @param {IMessageIdentifier} messageId - The message identifier
+     * @param {string} user - The identifier of the user who received the message
+     * @returns {Promise<boolean | Error>} - Success status or error
+     */
+    deliverMessage(messageId: IMessageIdentifier, user: string): Promise<boolean | Error>;
 
-    readMessage(messageId: IMessageIdentifier, user: string): Promise<boolean>;
+    /**
+     * Creates a post without triggering subscriptions
+     * 
+     * @description Creates a new post while bypassing real-time subscription
+     * notifications, useful for bulk operations or system-generated content.
+     * 
+     * @param {IPostServiceInput} data - The post creation data
+     * @returns {Promise<AsDomainType<IPostModel> | Error>} - Created post or error
+     */
+    createWithoutSubscription(data: IPostServiceInput): Promise<AsDomainType<IPostModel> | Error>;
 
-    deliverMessage(messageId: IMessageIdentifier, user: string): Promise<boolean>;
-    createWithoutSubscription(data: IPostServiceInput): Promise<IPost>;
+    /**
+     * Creates a post with an associated thread
+     * 
+     * @description Creates both a post and its associated thread in a single
+     * transaction, ensuring data consistency and proper relationship setup.
+     * 
+     * @param {CreatePostThreadOptions} options - The post and thread creation options
+     * @returns {Promise<{ post: AsDomainType<IPostModel>; postThread: IPostThread } | Error>} - Created post and thread or error
+     */
+    createPostWithPostThread(options: CreatePostThreadOptions): Promise<{ post: AsDomainType<IPostModel>; postThread: IPostThread } | Error>;
 
-    createPostWithPostThread({
-        threadMessageInput,
-        channelId,
-        responderId,
-        postParentId,
-        postId,
-        accountId,
-    }: CreatePostThreadOptions): Promise<{ post: IPost; postThread: IPostThread }>;
+    /**
+     * Retrieves the most recent message from a channel
+     * 
+     * @description Fetches the latest post/message from a specific channel,
+     * useful for displaying channel previews and recent activity.
+     * 
+     * @param {string} channelId - The unique identifier of the channel
+     * @returns {Promise<AsDomainType<IPostModel> | Error>} - Latest message or error
+     */
+    getLastMessage(channelId: string): Promise<AsDomainType<IPostModel> | Error>;
 
-    getLastMessage(channelId: string): Promise<IPost>;
+    /**
+     * Disposes of resources used by the service
+     */
+    dispose(): void;
 }

package/lib/templates/services/PostThreadService.ts.template

@@ -1,11 +1,106 @@
-import { IPostThread } from 'common/server';
+/**
+ * Post Thread Service Interface
+ * -----------------------------
+ * 
+ * This interface defines the business logic layer for post thread management
+ * within the messenger platform. It provides comprehensive operations for handling
+ * threaded conversations, reply management, and discussion organization across
+ * different channels and messaging contexts.
+ * 
+ * Key capabilities:
+ * - Thread lifecycle management (creation, updates, deletion)
+ * - Reply and response tracking within threads
+ * - Thread participant management and notifications
+ * - Thread statistics and metrics collection
+ * - Nested conversation organization
+ * - Thread visibility and access control
+ * - Cross-channel thread coordination
+ * - Thread state synchronization
+ * 
+ * The service layer abstracts complex threading operations and provides a
+ * cohesive API for thread-related functionality throughout the messaging platform,
+ * handling conversation hierarchies, participant tracking, and thread state management.
+ */
+
+import { IPostThread, IPostThreadModel, Disposable, AsDomainType } from 'common/server';
 import { IBaseService } from '@common-stack/store-mongo';
 
-export interface IPostThreadServiceInput extends Omit<IPostThread, 'id'> {}
+/**
+ * Post Thread Service Input Interface
+ * 
+ * @description Input parameters for post thread creation operations,
+ * excluding auto-generated fields like ID.
+ */
+export interface IPostThreadServiceInput extends Omit<IPostThreadModel, 'id'> {}
 
 // export type IPostThreadService = IBaseService<IPostThread>;
 
-export interface IPostThreadService extends IBaseService<IPostThread> {
-    getPostThread(data: any): Promise<IPostThread>;
-    getPostThreadCount(data: any): Promise<Number>;
+/**
+ * Post Thread Service Interface
+ * 
+ * @description Provides comprehensive post thread management capabilities
+ * including thread creation, participant tracking, and conversation organization.
+ */
+export interface IPostThreadService extends IBaseService<IPostThreadModel, IPostThreadServiceInput, Partial<IPostThreadModel>>, Disposable {
+    /**
+     * Retrieves a specific post thread with its metadata
+     * 
+     * @description Fetches a complete post thread including all replies,
+     * participant information, and thread statistics for display and interaction.
+     * 
+     * @param {any} data - Thread query parameters and filters
+     * @returns {Promise<AsDomainType<IPostThreadModel> | Error>} - Post thread data or error
+     */
+    getPostThread(data: any): Promise<AsDomainType<IPostThreadModel> | Error>;
+
+    /**
+     * Retrieves the total count of posts within a thread
+     * 
+     * @description Calculates and returns the number of posts/replies
+     * within a specific thread for pagination and display purposes.
+     * 
+     * @param {any} data - Thread identification and counting parameters
+     * @returns {Promise<number | Error>} - Thread post count or error
+     */
+    getPostThreadCount(data: any): Promise<number | Error>;
+
+    /**
+     * Updates a post thread
+     */
+    updateThread(threadId: string, updates: Partial<IPostThreadServiceInput>): Promise<AsDomainType<IPostThreadModel> | Error>;
+
+    /**
+     * Deletes a post thread
+     */
+    deleteThread(threadId: string): Promise<boolean | Error>;
+
+    /**
+     * Gets threads by post ID
+     */
+    getThreadsByPost(postId: string): Promise<Array<AsDomainType<IPostThreadModel>> | Error>;
+
+    /**
+     * Gets threads by channel with pagination
+     */
+    getThreadsByChannel(channelId: string, limit?: number, offset?: number): Promise<Array<AsDomainType<IPostThreadModel>> | Error>;
+
+    /**
+     * Gets thread participants
+     */
+    getThreadParticipants(threadId: string): Promise<Array<string> | Error>;
+
+    /**
+     * Adds a participant to a thread
+     */
+    addParticipant(threadId: string, userId: string): Promise<boolean | Error>;
+
+    /**
+     * Removes a participant from a thread
+     */
+    removeParticipant(threadId: string, userId: string): Promise<boolean | Error>;
+
+    /**
+     * Disposes of resources used by the service
+     */
+    dispose(): void;
 }

package/lib/templates/services/ReactionService.ts.template

@@ -1,7 +1,134 @@
-import { IReaction, IReactionInput } from 'common/server';
+/**
+ * Reaction Service Interface
+ * --------------------------
+ * 
+ * This interface defines the business logic layer for reaction management
+ * within the messenger platform. It provides comprehensive operations for handling
+ * emoji reactions, sentiment tracking, and user engagement features across
+ * posts, messages, and other interactive content.
+ * 
+ * Key capabilities:
+ * - Reaction lifecycle management (addition, removal, updates)
+ * - Emoji and custom reaction support
+ * - User reaction tracking and analytics
+ * - Reaction aggregation and statistics
+ * - Cross-platform reaction synchronization
+ * - Reaction notification management
+ * - Bulk reaction operations
+ * - Reaction validation and moderation
+ * 
+ * The service layer abstracts reaction operations and provides a cohesive API
+ * for engagement-related functionality throughout the messaging platform,
+ * handling user interactions, emotion tracking, and social engagement metrics.
+ */
+
+import { IReaction, IReactionModel, IReactionInput, Disposable, AsDomainType } from 'common/server';
 import { IBaseService } from '@common-stack/store-mongo';
 
+/**
+ * Reaction Service Input Interface
+ * 
+ * @description Input parameters for reaction creation and management operations,
+ * including user context and reaction metadata.
+ */
 export interface IReactionServiceInput extends IReactionInput {
+    /** User identifier who is creating or managing the reaction */
     user: string;
 }
-export type IReactionService = IBaseService<IReaction, IReactionServiceInput, Partial<IReactionInput>>;
+
+/**
+ * Reaction Service Interface
+ * 
+ * @description Provides comprehensive reaction management capabilities
+ * including emoji reactions, user engagement tracking, and reaction analytics.
+ */
+export interface IReactionService extends IBaseService<IReactionModel, IReactionServiceInput, Partial<IReactionInput>>, Disposable {
+    /**
+     * Adds a reaction to a post or message
+     * 
+     * @description Creates a new reaction entry for a specific content item,
+     * handling duplicate detection and user validation.
+     * 
+     * @param {IReactionServiceInput} data - Reaction creation data including user and reaction type
+     * @returns {Promise<AsDomainType<IReactionModel> | Error>} - Created reaction or error
+     */
+    addReaction(data: IReactionServiceInput): Promise<AsDomainType<IReactionModel> | Error>;
+
+    /**
+     * Removes a reaction from a post or message
+     * 
+     * @description Deletes an existing reaction entry, ensuring proper user
+     * authorization and content validation.
+     * 
+     * @param {string} reactionId - The unique identifier of the reaction to remove
+     * @param {string} userId - The identifier of the user removing the reaction
+     * @returns {Promise<boolean | Error>} - Success status or error
+     */
+    removeReaction(reactionId: string, userId: string): Promise<boolean | Error>;
+
+    /**
+     * Retrieves all reactions for a specific content item
+     * 
+     * @description Fetches reaction data with aggregation and user information
+     * for display in the user interface.
+     * 
+     * @param {string} contentId - The identifier of the content (post, message, etc.)
+     * @param {string} contentType - The type of content being reacted to
+     * @returns {Promise<Array<AsDomainType<IReactionModel>> | Error>} - Array of reactions or error
+     */
+    getReactionsByContent(contentId: string, contentType: string): Promise<Array<AsDomainType<IReactionModel>> | Error>;
+
+    /**
+     * Retrieves reaction statistics for content
+     * 
+     * @description Provides aggregated reaction counts and statistics
+     * for analytics and display purposes.
+     * 
+     * @param {string} contentId - The identifier of the content
+     * @param {string} contentType - The type of content
+     * @returns {Promise<any | Error>} - Reaction statistics or error
+     */
+    getReactionStats(contentId: string, contentType: string): Promise<any | Error>;
+
+    /**
+     * Checks if a user has reacted to specific content
+     * 
+     * @description Determines whether a user has already reacted to
+     * a piece of content, useful for UI state management.
+     * 
+     * @param {string} contentId - The identifier of the content
+     * @param {string} userId - The identifier of the user
+     * @param {string} reactionType - The type of reaction to check
+     * @returns {Promise<boolean | Error>} - True if user has reacted, or error
+     */
+    hasUserReacted(contentId: string, userId: string, reactionType: string): Promise<boolean | Error>;
+
+    /**
+     * Updates an existing reaction
+     * 
+     * @description Modifies an existing reaction, typically changing
+     * the reaction type while maintaining the same user and content association.
+     * 
+     * @param {string} reactionId - The unique identifier of the reaction
+     * @param {Partial<IReactionInput>} updates - The reaction updates to apply
+     * @returns {Promise<AsDomainType<IReactionModel> | Error>} - Updated reaction or error
+     */
+    updateReaction(reactionId: string, updates: Partial<IReactionInput>): Promise<AsDomainType<IReactionModel> | Error>;
+
+    /**
+     * Removes all reactions from specific content
+     * 
+     * @description Bulk removes all reactions from a content item,
+     * typically used during content deletion or moderation.
+     * 
+     * @param {string} contentId - The identifier of the content
+     * @param {string} contentType - The type of content
+     * @returns {Promise<number | Error>} - Number of reactions removed or error
+     */
+    removeAllReactionsByContent(contentId: string, contentType: string): Promise<number | Error>;
+
+    /**
+     * Disposes of resources used by the service
+     */
+    dispose(): void;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@messenger-box/platform-server",
-    "version": "10.0.3-alpha.50",
+    "version": "10.0.3-alpha.54",
     "description": "Sample core for higher packages to depend on",
     "license": "ISC",
     "author": "CDMBase LLC",
@@ -20,7 +20,7 @@
     },
     "dependencies": {
         "@container-stack/mailing-api": "5.4.1-alpha.2",
-        "@messenger-box/core": "10.0.3-alpha.50",
+        "@messenger-box/core": "10.0.3-alpha.54",
         "@skoropletov/moleculer-cron-tasks": "~0.0.8",
         "date-fns": "^4.1.0"
     },
@@ -69,5 +69,5 @@
     "typescript": {
         "definition": "lib/index.d.ts"
     },
-    "gitHead": "04bd383c41b79ec5f5f2254d8886b8ab2761eaab"
+    "gitHead": "7b4c5e0acfbb4bfc3aefab287374d5739c40b4bc"
 }

package/lib/store/models/common-options.js

@@ -1,20 +0,0 @@
-const commonModeSchemaOptions = {
-  timestamps: true,
-  toJSON: {
-    virtuals: true
-  },
-  toObject: {
-    virtuals: true,
-    getters: true,
-    transform(doc, ret) {
-      delete ret.__v;
-      delete ret._id;
-    }
-  }
-};
-const addIdVirtualFields = schema => {
-  schema.set('toJSON', {
-    virtuals: true
-  });
-  return schema;
-};export{addIdVirtualFields,commonModeSchemaOptions};//# sourceMappingURL=common-options.js.map

package/lib/store/models/common-options.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"common-options.js","sources":["../../../src/store/models/common-options.ts"],"sourcesContent":[null],"names":[],"mappings":"AAGa,MAAA,uBAAuB,GAAG;AACnC,EAAA,UAAA,EAAU,IAAM;AAChB,EAAA,MAAA,EAAM;AACF,IAAA,QAAA,EAAA;AACH,GAAA;AACD,EAAA,QAAA,EAAQ;AACJ,IAAA,QAAA,EAAA,IAAU;AACV,IAAA,OAAA,EAAA,IAAS;aACA,CAAA,GAAA,EAAI,GAAA,EAAK;aACP,GAAA,CAAA,GAAA;aACA,GAAA,CAAA,GAAA;;AAEd;;AAGQ,MAAA,kBAAkB,GAAG,MAAC,IAAkB;AACjD,EAAA,MAAA,CAAA,GAAO,CAAA,QAAI,EAAQ;AACf,IAAA,QAAA,EAAA;AACH,GAAA,CAAA;AACD,EAAA,OAAA;AACJ"}