@planningcenter/chat-react-native 3.0.0 → 3.1.0-rc.1

package/src/types/jolt_events/index.ts

@@ -0,0 +1,28 @@
+import type {
+  ConversationCreatedEvent,
+  ConversationDeletedEvent,
+  ConversationUpdatedEvent,
+  ConversationReadEvent,
+} from './conversation_events'
+import type {
+  MessageCreatedEvent,
+  MessageDeletedEvent,
+  MessageUpdatedEvent,
+} from './message_events'
+import type { ReactionCreatedEvent, ReactionDeletedEvent } from './reaction_events'
+import type { TypingBroadcastEvent } from './typing_events'
+
+export type JoltConversationEvent =
+  | ConversationCreatedEvent
+  | ConversationUpdatedEvent
+  | ConversationDeletedEvent
+  | ConversationReadEvent
+export type JoltMessageEvent = MessageCreatedEvent | MessageUpdatedEvent | MessageDeletedEvent
+export type JoltReactionEvent = ReactionCreatedEvent | ReactionDeletedEvent
+export type JoltTypingEvent = TypingBroadcastEvent
+
+export type CustomJoltEvent =
+  | JoltConversationEvent
+  | JoltMessageEvent
+  | JoltReactionEvent
+  | JoltTypingEvent

package/src/types/jolt_events/message_events.ts

@@ -0,0 +1,34 @@
+import type { CustomMessage } from '@planningcenter/jolt-client/dist/types/JoltConnection'
+import { DenormalizedAttachmentResource } from '../resources/denormalized_attachment_resource'
+
+interface BaseMessageEventData extends Record<string, unknown> {
+  data: {
+    author_avatar: string
+    author_id: number
+    author_name: string
+    conversation_id: number
+    created_at: string
+    deleted_at: string | null
+    organization_id: number | null
+    sort_key: string
+    text: string
+    text_edited_at: string | null
+    html: string
+    attachments: DenormalizedAttachmentResource[]
+  }
+}
+
+export interface MessageCreatedEvent extends CustomMessage {
+  event: 'message.created'
+  data: BaseMessageEventData
+}
+
+export interface MessageUpdatedEvent extends CustomMessage {
+  event: 'message.updated'
+  data: BaseMessageEventData
+}
+
+export interface MessageDeletedEvent extends CustomMessage {
+  event: 'message.destroyed'
+  data: BaseMessageEventData
+}

package/src/types/jolt_events/reaction_events.ts

@@ -0,0 +1,26 @@
+import type { CustomMessage } from '@planningcenter/jolt-client/dist/types/JoltConnection'
+import { ReactionCountResource } from '../resources/reaction'
+
+interface BaseReactionEventData extends Record<string, unknown> {
+  data: {
+    author_id: number
+    conversation_id: number
+    message_sort_key: string
+    created_at: string
+    organization_id: number
+    value: ReactionCountResource['value']
+    author_name?: string
+    author_avatar?: string
+    count: number
+  }
+}
+
+export interface ReactionCreatedEvent extends CustomMessage {
+  event: 'reaction.created'
+  data: BaseReactionEventData
+}
+
+export interface ReactionDeletedEvent extends CustomMessage {
+  event: 'reaction.destroyed'
+  data: BaseReactionEventData
+}

package/src/types/jolt_events/typing_events.ts

@@ -0,0 +1,16 @@
+import type { CustomMessage } from '@planningcenter/jolt-client/dist/types/JoltConnection'
+
+interface TypingBroadcastData extends Record<string, unknown> {
+  data: TypingBroadcastDataAttributes
+}
+
+export interface TypingBroadcastEvent extends CustomMessage {
+  event: 'typing.broadcast'
+  data: TypingBroadcastData
+}
+
+export interface TypingBroadcastDataAttributes {
+  author_id: number
+  author_name: string
+  id: string
+}

package/src/types/resources/denormalized_attachment_resource.ts

@@ -0,0 +1,101 @@
+/**
+ * This is the type of message attachment that is denormalized onto the message resource.
+ * It is what we receive from `MessageVertex#attachments`.
+ */
+
+export type DenormalizedAttachmentResource =
+  | DenormalizedMessageAttachmentResource
+  | DenormalizedGiphyAttachmentResource
+  | DenormalizedExpandedLinkAttachmentResource
+
+export type DenormalizedAttachmentResourceForCreate =
+  | DenormalizedMessageAttachmentResourceForCreate
+  | DenormalizedGiphyAttachmentResourceForCreate
+  | DenormalizedExpandedLinkAttachmentResource
+
+interface GenericAttachmentResource {
+  type: string
+  id?: string
+  [key: string]: unknown
+}
+
+export interface DenormalizedMessageAttachmentResource extends GenericAttachmentResource {
+  type: 'MessageAttachment'
+  id: string
+  attributes: {
+    filename: string
+    key: string
+    contentType: string
+    byteSize: number
+    checksum: string
+    metadata?: {
+      width?: number
+      height?: number
+      analyzed?: boolean
+      identified?: boolean
+    }
+    url: string
+    urlMedium?: string
+  }
+}
+
+export interface DenormalizedMessageAttachmentResourceForCreate extends GenericAttachmentResource {
+  type: 'MessageAttachment'
+  id: string
+}
+
+export interface DenormalizedGiphyAttachmentResource extends GenericAttachmentResource {
+  type: 'giphy'
+  id: string
+  title: string
+  originalGiphyTitle?: string
+  titleLink: string
+  thumbUrl: string
+  giphy: {
+    original: GiphyVariant
+    fixedHeight: GiphyVariant
+    fixedHeightStill: GiphyVariant
+    fixedHeightDownsampled: GiphyVariant
+    fixedWidth: GiphyVariant
+    fixedWidthStill: GiphyVariant
+    fixedWidthDownsampled: GiphyVariant
+  }
+}
+
+export interface DenormalizedGiphyAttachmentResourceForCreate extends GenericAttachmentResource {
+  type: 'giphy'
+  id: string
+  title: string
+  original_giphy_title: string
+  title_link: string
+  thumb_url: string
+  giphy: {
+    original: GiphyVariant
+    fixed_height: GiphyVariant
+    fixed_height_still: GiphyVariant
+    fixed_height_downsampled: GiphyVariant
+    fixed_width: GiphyVariant
+    fixed_width_still: GiphyVariant
+    fixed_width_downsampled: GiphyVariant
+  }
+}
+
+interface GiphyVariant {
+  url: string
+  width: number
+  height: number
+  size: string
+  frames: string
+}
+
+export interface DenormalizedExpandedLinkAttachmentResource extends GenericAttachmentResource {
+  type: 'ExpandedLink'
+  attributes: {
+    url: string
+    title?: string
+    description?: string
+    imageUrl?: string
+    imageHeight?: number
+    imageWidth?: number
+  }
+}

package/src/types/resources/message.ts

@@ -1,3 +1,4 @@
+import { DenormalizedAttachmentResource } from './denormalized_attachment_resource'
 import type { PersonResource } from './person'
 import type { ReactionCountResource } from './reaction'
 
@@ -5,10 +6,12 @@ export interface MessageResource {
   type: 'Message'
   id: string
   text: string
+  html: string
   createdAt: string
+  deletedAt: string | null
   textEditedAt: string | null
   mine: boolean
-  attachments: unknown[]
+  attachments: DenormalizedAttachmentResource[]
   author: PersonResource
   reactionCounts: ReactionCountResource[]
 

package/src/types/resources/person.ts

@@ -3,6 +3,9 @@ import { ResourceObject } from '../api_primitives'
 export interface PersonResource extends ResourceObject {
   name: string
   avatar: string
+}
+
+export interface CurrentPersonResource extends PersonResource {
   canChat: boolean
   unreadCount: number
   pcoChatEnabled: boolean

package/src/utils/deepCamelCaseKeys.ts

@@ -0,0 +1,15 @@
+import { camelCase, isArray, isObject, mapKeys, mapValues } from 'lodash'
+
+type ObjType = Record<string, unknown> | unknown[] | unknown
+
+export function deepCamelCaseKeys<T extends ObjType>(obj: T): T {
+  if (isArray(obj)) {
+    return (obj as T & any[]).map(deepCamelCaseKeys) as T
+  } else if (isObject(obj)) {
+    return mapValues(
+      mapKeys(obj, (_value, key) => camelCase(key)),
+      deepCamelCaseKeys
+    ) as T
+  }
+  return obj
+}

package/src/utils/jolt/transform_message_event_data_to_message_resource.ts

@@ -0,0 +1,31 @@
+import { MessageResource } from '../../types'
+import { MessageCreatedEvent } from '../../types/jolt_events/message_events'
+import { DenormalizedAttachmentResource } from '../../types/resources/denormalized_attachment_resource'
+import { deepCamelCaseKeys } from '../deepCamelCaseKeys'
+
+export function transformMessageEventDataToMessageResource({
+  data,
+  currentPersonId,
+}: {
+  data: MessageCreatedEvent['data']['data']
+  currentPersonId: string
+}): MessageResource {
+  return {
+    type: 'Message',
+    id: data.sort_key,
+    text: data.text,
+    html: data.html,
+    createdAt: data.created_at,
+    deletedAt: data.deleted_at,
+    textEditedAt: data.text_edited_at,
+    mine: data.author_id.toString() === currentPersonId.toString(),
+    attachments: deepCamelCaseKeys<DenormalizedAttachmentResource[]>(data.attachments) || [],
+    author: {
+      type: 'Person',
+      id: data.author_id.toString(),
+      name: data.author_name,
+      avatar: data.author_avatar,
+    },
+    reactionCounts: [],
+  }
+}