🚀 Chat features

Chat features are SDK composers, not Express middleware; chatService mounts the Chat features with the required stores and drivers.

Inventory

Feature	Composed schema(s)	Composed route(s)	Purpose
createChannelFeature	createChatChannelSchema	createChatChannelRoute	Create a channel.
getChannelFeature	getChatChannelSchema	getChatChannelRoute	Get one channel.
findChannelsFeature	findChatChannelsSchema	findChatChannelsRoute	List channels with pagination.
updateChannelFeature	updateChatChannelSchema	updateChatChannelRoute	Update a channel and optional icon.
deleteChannelFeature	deleteChatChannelSchema	deleteChatChannelRoute	Delete a channel and optional icon.
getChannelMessagesFeature	getChannelMessagesSchema	getChannelMessagesRoute	List a subscribed channel's messages.
getChannelIconUploadUrlFeature	getSignedImageUploadUrlSchema	getChatChannelIconUploadUrlRoute	Issue a signed channel-icon upload URL.
createChatMessageFeature	createChatMessageSchema	createChatMessageRoute	Create and normalize a message.
getChatMessageFeature	getChatMessageSchema	getChatMessageRoute	Get and normalize one message.
findChatMessagesFeature	findChatMessagesSchema	findChatMessagesRoute	List normalized messages with pagination.
updateChatMessageFeature	updateChatMessageSchema	updateChatMessageRoute	Update an owned message.
deleteChatMessageFeature	deleteChatMessageSchema	deleteChatMessageRoute	Delete a message.
streamChatMessagesFeature	streamChatMessagesSchema	streamChatMessagesRoute	Register the WebSocket message stream.
getChatMessageAttachmentUrlFeature	getSignedFileUploadUrlSchema	getChatMessageAttachmentUploadUrlRoute	Issue a signed attachment upload URL.
createChatMessageAttachmentFeature	createChatMessageAttachmentSchema	createChatMessageAttachmentRoute	Attach uploaded file metadata to a message.
deleteChatMessageAttachmentFeature	deleteChatMessageAttachmentSchema	deleteChatMessageAttachmentRoute	Delete attachment metadata and stored file.
createChatMessageTemplateFeature	createChatMessageTemplateSchema	createChatMessageTemplateRoute	Create a message template.
getChatMessageTemplateFeature	getChatMessageTemplateSchema	getChatMessageTemplateRoute	Get one message template.
updateChatMessageTemplateFeature	updateChatMessageTemplateSchema	updateChatMessageTemplateRoute	Update a message template.
deleteChatMessageTemplateFeature	deleteChatMessageTemplateSchema	deleteChatMessageTemplateRoute	Delete a message template.
findChatMessageTemplatesFeature	findChatMessageTemplatesSchema	findChatMessageTemplatesRoute	List all templates as a global admin.
findChatMessageTemplatesForOrganizationFeature	findChatMessageTemplatesForOrganizationSchema	findChatMessageTemplatesForOrganizationRoute	List templates for one organization.
upsertChatChannelReadStateFeature	upsertChatChannelReadStateSchema	upsertChatChannelReadStateRoute	Create or update a channel read state.
createChatSubscriptionFeature	createChatSubscriptionSchema	createChatSubscriptionRoute	Subscribe an identity to a channel.
getChatSubscriptionFeature	getChatSubscriptionSchema	getChatSubscriptionRoute	Get one subscription.
findChatSubscriptionsFeature	findChatSubscriptionsSchema	findChatSubscriptionsRoute	List subscriptions with pagination.
deleteChatSubscriptionFeature	deleteChatSubscriptionSchema	deleteChatSubscriptionRoute	Delete a subscription.

Details

Each feature is mounted by chatService. The source definitions below show the exact schema-to-route composition.

createChannelFeature

Implementation

This feature composes the schema and route linked in its inventory row; it is mounted by chatService or a compatible custom service context.

View complete source

export const createChannelFeature = compose(
  createChatChannelSchema,
  createChatChannelRoute
);

getChannelFeature

Implementation

This feature composes the schema and route linked in its inventory row; it is mounted by chatService or a compatible custom service context.

View complete source

export const getChannelFeature = compose(
  getChatChannelSchema,
  getChatChannelRoute
);

findChannelsFeature

Implementation

This feature composes the schema and route linked in its inventory row; it is mounted by chatService or a compatible custom service context.

View complete source

export const findChannelsFeature = compose(
  findChatChannelsSchema,
  findChatChannelsRoute
);

updateChannelFeature

Implementation

This feature composes the schema and route linked in its inventory row; it is mounted by chatService or a compatible custom service context.

View complete source

export const updateChannelFeature = compose(
  updateChatChannelSchema,
  updateChatChannelRoute
);

deleteChannelFeature

Implementation

This feature composes the schema and route linked in its inventory row; it is mounted by chatService or a compatible custom service context.

View complete source

export const deleteChannelFeature = compose(
  deleteChatChannelSchema,
  deleteChatChannelRoute
);

getChannelMessagesFeature

Implementation

This feature composes the schema and route linked in its inventory row; it is mounted by chatService or a compatible custom service context.

View complete source

export const getChannelMessagesFeature = compose(
  getChannelMessagesSchema,
  getChannelMessagesRoute
);

getChannelIconUploadUrlFeature

Implementation

This feature composes the schema and route linked in its inventory row; it is mounted by chatService or a compatible custom service context.

The route requires the optional fileStorageDriver supplied to chatService.

View complete source

export const getChannelIconUploadUrlFeature = compose(
  getSignedImageUploadUrlSchema,
  getChatChannelIconUploadUrlRoute
);

createChatMessageFeature

Implementation

This feature composes the schema and route linked in its inventory row; it is mounted by chatService or a compatible custom service context.

View complete source

export const createChatMessageFeature = compose(
  createChatMessageSchema,
  createChatMessageRoute
);

getChatMessageFeature

Implementation

This feature composes the schema and route linked in its inventory row; it is mounted by chatService or a compatible custom service context.

View complete source

export const getChatMessageFeature = compose(
  getChatMessageSchema,
  getChatMessageRoute
);

findChatMessagesFeature

Implementation

This feature composes the schema and route linked in its inventory row; it is mounted by chatService or a compatible custom service context.

View complete source

export const findChatMessagesFeature = compose(
  findChatMessagesSchema,
  findChatMessagesRoute
);

updateChatMessageFeature

Implementation

This feature composes the schema and route linked in its inventory row; it is mounted by chatService or a compatible custom service context.

View complete source

export const updateChatMessageFeature = compose(
  updateChatMessageSchema,
  updateChatMessageRoute
);

deleteChatMessageFeature

Implementation

This feature composes the schema and route linked in its inventory row; it is mounted by chatService or a compatible custom service context.

View complete source

export const deleteChatMessageFeature = compose(
  deleteChatMessageSchema,
  deleteChatMessageRoute
);

streamChatMessagesFeature

Implementation

This feature composes the schema and route linked in its inventory row; it is mounted by chatService or a compatible custom service context.

Requires webSocketServer in a custom composition; its route currently composes no active access validators.

View complete source

export const streamChatMessagesFeature = compose(
  streamChatMessagesSchema,
  streamChatMessagesRoute
);

getChatMessageAttachmentUrlFeature

Implementation

This feature composes the schema and route linked in its inventory row; it is mounted by chatService or a compatible custom service context.

The route requires the optional fileStorageDriver supplied to chatService.

View complete source

export const getChatMessageAttachmentUrlFeature = compose(
  getSignedFileUploadUrlSchema,
  getChatMessageAttachmentUploadUrlRoute
);

createChatMessageAttachmentFeature

Implementation

This feature composes the schema and route linked in its inventory row; it is mounted by chatService or a compatible custom service context.

View complete source

export const createChatMessageAttachmentFeature = compose(
  createChatMessageAttachmentSchema,
  createChatMessageAttachmentRoute
);

deleteChatMessageAttachmentFeature

Implementation

This feature composes the schema and route linked in its inventory row; it is mounted by chatService or a compatible custom service context.

View complete source

export const deleteChatMessageAttachmentFeature = compose(
  deleteChatMessageAttachmentSchema,
  deleteChatMessageAttachmentRoute
);

createChatMessageTemplateFeature

Implementation

This feature composes the schema and route linked in its inventory row; it is mounted by chatService or a compatible custom service context.

View complete source

export const createChatMessageTemplateFeature = compose(
  createChatMessageTemplateSchema,
  createChatMessageTemplateRoute
);

getChatMessageTemplateFeature

Implementation

This feature composes the schema and route linked in its inventory row; it is mounted by chatService or a compatible custom service context.

View complete source

export const getChatMessageTemplateFeature = compose(
  getChatMessageTemplateSchema,
  getChatMessageTemplateRoute
);

updateChatMessageTemplateFeature

Implementation

This feature composes the schema and route linked in its inventory row; it is mounted by chatService or a compatible custom service context.

View complete source

export const updateChatMessageTemplateFeature = compose(
  updateChatMessageTemplateSchema,
  updateChatMessageTemplateRoute
);

deleteChatMessageTemplateFeature

Implementation

This feature composes the schema and route linked in its inventory row; it is mounted by chatService or a compatible custom service context.

View complete source

export const deleteChatMessageTemplateFeature = compose(
  deleteChatMessageTemplateSchema,
  deleteChatMessageTemplateRoute
);

findChatMessageTemplatesFeature

Implementation

This feature composes the schema and route linked in its inventory row; it is mounted by chatService or a compatible custom service context.

View complete source

export const findChatMessageTemplatesFeature = compose(
  findChatMessageTemplatesSchema,
  findChatMessageTemplatesRoute
);

findChatMessageTemplatesForOrganizationFeature

Implementation

This feature composes the schema and route linked in its inventory row; it is mounted by chatService or a compatible custom service context.

View complete source

export const findChatMessageTemplatesForOrganizationFeature = compose(
  findChatMessageTemplatesForOrganizationSchema,
  findChatMessageTemplatesForOrganizationRoute
);

upsertChatChannelReadStateFeature

Implementation

This feature composes the schema and route linked in its inventory row; it is mounted by chatService or a compatible custom service context.

View complete source

export const upsertChatChannelReadStateFeature = compose(
  upsertChatChannelReadStateSchema,
  upsertChatChannelReadStateRoute
);

createChatSubscriptionFeature

Implementation

This feature composes the schema and route linked in its inventory row; it is mounted by chatService or a compatible custom service context.

View complete source

export const createChatSubscriptionFeature = compose(
  createChatSubscriptionSchema,
  createChatSubscriptionRoute
);

getChatSubscriptionFeature

Implementation

This feature composes the schema and route linked in its inventory row; it is mounted by chatService or a compatible custom service context.

View complete source

export const getChatSubscriptionFeature = compose(
  getChatSubscriptionSchema,
  getChatSubscriptionRoute
);

findChatSubscriptionsFeature

Implementation

This feature composes the schema and route linked in its inventory row; it is mounted by chatService or a compatible custom service context.

View complete source

export const findChatSubscriptionsFeature = compose(
  findChatSubscriptionsSchema,
  findChatSubscriptionsRoute
);

deleteChatSubscriptionFeature

Implementation

This feature composes the schema and route linked in its inventory row; it is mounted by chatService or a compatible custom service context.

View complete source

export const deleteChatSubscriptionFeature = compose(
  deleteChatSubscriptionSchema,
  deleteChatSubscriptionRoute
);