chat 1.0.8 → 3.0.0

package/lib/typescript/classes/Message/index.d.ts

@@ -1,47 +0,0 @@
-import { MessageModel, RoomId, NewMessageModel, SendFromFeedRecipients } from './types';
-import { RoomMembers, RoomMember } from '../Room/types';
-import { ReactionOption } from '../Reaction/types';
-export default class {
-    private message;
-    constructor(message: MessageModel);
-    /**
-     * A function to send one message to many different existing rooms/group chats separately.
-     *
-     * @param recipients An array of rooms ids where this message will be sent to separately
-     * @returns Promise that returns a room ID if there is only one (or promise that resolves as null if the message object isn't valid)
-     */
-    sendToRooms(recipients: string[]): Promise<import("firebase").functions.HttpsCallableResult>;
-    /**
-     * A function to send one message to many different people individually.
-     * For each recipient, if a room for them doesn't exist, it will get created and the message will be added to it.
-     * If the room does exist, the message will be added to it.
-     *
-     * @param recipients An array of user ids whom this message will be sent to separately
-     * @returns Promise that returns a room ID (or promise that resolves as null if the message object isn't valid)
-     */
-    sendToPeople(recipients: string[]): Promise<import("firebase").functions.HttpsCallableResult>;
-    /**
-     * Sends message to a group. This is useful when you don't have a room id but do have a list of people you want to send a message to. If you want to send the message to them separately, try sendToPeople instead.
-     * This function will create a group chat with the specified users if one doesn't exist yet. If it does exist already, then it will add to that existing room.
-     * @param recipients Array of uids for people in the group this message should send to.
-     * @returns Promise that returns a room ID (or promise that resolves as null if the message object isn't valid)
-     */
-    sendToGroup(recipients: string[]): Promise<import("firebase").functions.HttpsCallableResult>;
-    /**
-     *  deprecated: fuck this function
-     */
-    sendFromFeed(to: SendFromFeedRecipients): Promise<any[]>;
-    /**
-     * Send message by adding it directly to the backend
-     * @param roomId The id of the room you want to send this to. Could also be an array of ids, if the same message should go to multiple rooms.
-     */
-    send(roomId: RoomId): void;
-    edit(roomId: string): Promise<void>;
-    formatForRender(): NewMessageModel[] | NewMessageModel | null;
-    formatForSend(): this;
-    addToFirebase(roomId: RoomId): Promise<void>;
-    updateOnFirebase(roomId: string): Promise<void>;
-    getUsersWhoReacted(reaction: ReactionOption, { roomMembers }: {
-        roomMembers: RoomMembers;
-    }): RoomMember[];
-}

package/lib/typescript/classes/Message/types.d.ts

@@ -1,66 +0,0 @@
-import { FieldValue } from '@firebase/firestore-types';
-import { ReactionOption } from '../Reaction/types';
-export interface Message {
-    id: string;
-}
-export interface NewMessageModel extends Omit<Message, 'roomId'> {
-    text: string;
-    createdAt: Date;
-    user: {
-        id: string;
-        name: string;
-        avatar: string;
-    };
-    system?: boolean;
-    media?: MessageMedia;
-    reactions?: {
-        [option in ReactionOption]: string[];
-    };
-}
-export interface MessageMediaWithUrl {
-    url: string;
-    uri?: string;
-    height: number;
-    width: number;
-    contentType: 'video' | 'image';
-}
-export interface MessageMediaWithUri {
-    url: string;
-    uri?: string;
-    height: number;
-    width: number;
-    contentType: 'video' | 'image';
-}
-export declare type MessageMedia = MessageMediaWithUrl | MessageMediaWithUri;
-export interface NewMessageFormattedForServer extends Omit<NewMessageModel, 'createdAt'> {
-    createdAt: FieldValue;
-}
-export declare function isNewMessageModel(message: MessageModel): message is NewMessageModel;
-export declare function isNewMessageFormattedForServer(message: MessageModel): message is NewMessageFormattedForServer;
-export interface EditMessageModel extends Message {
-    text?: string;
-}
-export declare type SendToRecipients = string[];
-export declare type RoomId = string | string[];
-export declare type MessageModel = Message | NewMessageModel[] | EditMessageModel | MessageModelDocument[] | NewMessageFormattedForServer[] | NewMessageFormattedForServer;
-export interface MessageModelDocument extends Omit<NewMessageModel, 'createdAt'> {
-    id: string;
-    createdAt: firebase.firestore.Timestamp;
-}
-export declare type SendFromFeedRecipient = {
-    id: string;
-} | SendFromFeedRecipientArray;
-export interface SendFromFeedRecipientArray {
-    recipients: {
-        id: string;
-        name: string;
-    }[];
-}
-export declare const recipientHasId: (recipient: SendFromFeedRecipient) => recipient is {
-    id: string;
-};
-export declare const recipientHasMembers: (recipient: SendFromFeedRecipient) => recipient is SendFromFeedRecipientArray;
-export declare type SendFromFeedRecipients = SendFromFeedRecipient[];
-export interface SendFromFeedModel extends Omit<NewMessageModel, 'id'> {
-    recipients: SendFromFeedRecipientArray['recipients'];
-}

package/lib/typescript/classes/Reaction/index.d.ts

@@ -1,17 +0,0 @@
-import { ReactionConfig } from './types';
-import { LastMessageServer } from '../Room/types';
-export default class {
-    private config;
-    constructor(config: ReactionConfig);
-    get path(): string;
-    verb(): {
-        add: string;
-        remove: string;
-    };
-    add(): Promise<void>;
-    remove(): Promise<void>;
-    makeReactionDescriptionText(remove?: boolean): string;
-    makeLastMessage(options: {
-        remove?: boolean;
-    }): LastMessageServer;
-}

package/lib/typescript/classes/Reaction/types.d.ts

@@ -1,33 +0,0 @@
-export interface ReactionConfig {
-    myName?: string;
-    messageId: string;
-    roomId: string;
-    text: string;
-    reaction: ReactionOption;
-    /**
-     * An **optional** string or pure function to override the default description text.
-     * The description text is used to create the last message that shows up in the inbox.
-     *
-     * By default, this will look something like: <name> <reaction>d "<message text>". For instance: Fernando liked "I want a pair of PATOS Shoes."
-     *
-     * If `null`, text will be an empty string.
-     *
-     * A verb for like will be 'liked', and if it's a removal, then it's 'unlike'. This pattern follows for other reactions too.
-     *
-     * @example
-     * ```js
-     * const reaction = new Reaction({
-     * descriptionText: ({ reaction, name, text, verb, remove }) => remove ? \`${name} happily ${verb} ${text}\` : \`${name} sadly ${verb} ${text}\`,
-     * text: message.text, roomId: room.id, messageId: message.id, text: message.text
-     * })
-     * ```
-     */
-    descriptionText?: null | string | ((info: {
-        reaction: ReactionOption;
-        name: string;
-        text: string;
-        verb: string;
-        remove: boolean;
-    }) => string);
-}
-export declare type ReactionOption = 'like' | 'love';

package/lib/typescript/classes/Room/index.d.ts

@@ -1,42 +0,0 @@
-import { RoomModel, RoomMembers } from './types';
-export default class {
-    private room;
-    constructor(room: RoomModel);
-    get path(): string;
-    get messagesPath(): string;
-    getUnreadCount(): number;
-    /**
-     * Views message function for a room.
-     *
-     * To use this in a react component out-of-the-box, I recommend using the [[useViewMessage]] hook. It will handle all this for you.
-     *
-     * @param messageId ID of the message you're viewing
-     * @param messageCreatedAt Timestamp of the message which you're viewing, found in message.createdAt
-     *
-     * @remarks
-     * If you aren't using the useViewMessage hook:
-     * This function should be used with care. You don't want to send 500 writes if someone views 500 messages.
-     * You only want to send a read for the most recent message being viewed, assuming it's someone else's message.
-     * Also, you should be memoizing the last message you sent that you viewed to avoid repeats. Again, this is all handled by useViewMessages.
-     *
-     * @returns Promise that only resolves while you're online.
-     */
-    viewMessage(messageId: string, messageCreatedAt: Date): Promise<void>;
-    getArrayOfMembersOtherThanMe(): import("./types").RoomMember[];
-    getName(): string;
-    getInitials(maxNumberOfInitials?: number): string;
-    /**
-     * @returns
-     * A promise.all array of responses. The first array is for adding a system message; the second is for updating the room object.
-     */
-    leave(): Promise<void | null>;
-    join(): Promise<void> | null;
-    addMembers(members: RoomMembers): Promise<void>;
-    removeMembers(members: RoomMembers): Promise<void>;
-    create(): Promise<void | null>;
-    createViaCallable(): Promise<firebase.functions.HttpsCallableResult>;
-    edit(): Promise<void> | null;
-    getUsersTyping(): import("./types").RoomMember[];
-    updateOnFirebase(): Promise<void>;
-    addToFirebase(): Promise<void>;
-}

package/lib/typescript/classes/Room/types.d.ts

@@ -1,112 +0,0 @@
-import { FieldValue, Timestamp } from '@firebase/firestore-types';
-import * as firebase from 'firebase';
-export interface LastMessage {
-    createdAt: Date;
-    text: string;
-    name: string;
-    system: boolean;
-    id: string;
-}
-export interface LastMessageServer extends Omit<LastMessage, 'createdAt'> {
-    createdAt: FieldValue;
-}
-/**
- * Unread count schema in the members dictionary for each room
- */
-export interface UnreadCount {
-    count: number;
-    /**
-     * The timestamp of the last time you cleared messages.
-     */
-    lastCleared: Date;
-    /**
-     * Details of the last message you saw.
-     */
-    lastSeen: {
-        id: string;
-        createdAt: Date;
-    };
-}
-export interface UnreadCountDocument extends Omit<UnreadCount, 'lastCleared'> {
-    lastCleared: firebase.firestore.Timestamp;
-}
-export interface UnreadCountServer extends Omit<UnreadCount, 'lastCleared'> {
-    lastCleared: firebase.firestore.FieldValue;
-}
-export interface RoomPropertiesModel {
-    id: string;
-    avatar?: string;
-    members?: RoomMembers;
-    name?: string;
-}
-export interface Typing {
-    state: 'typing' | 'nothing';
-    lastChanged: typeof firebase.database.ServerValue.TIMESTAMP;
-}
-export interface RoomMember {
-    typing?: Typing;
-    exists: boolean;
-    name: string;
-    nickname?: string;
-    avatar?: string;
-    joinedAt: FieldValue;
-    unreadCount?: UnreadCount;
-}
-export interface ExistingRoomMember {
-    nickname?: string;
-    avatar?: string;
-}
-export interface NewRoomMember extends RoomMember {
-}
-/**
- * Dictionary of members in the room.
- */
-export interface RoomMembers {
-    [id: string]: RoomMember;
-}
-/**
- * Configuration for the room class. Members doesn't need to include me.
- *
- * @example
- * ```
- * const room = new Room(config: NewRoomModel)
- * await room.create()
- * ```
- */
-export interface NewRoomModel extends Omit<RoomPropertiesModel, 'id'> {
-    members: RoomMembers;
-}
-export interface CreateCallableRoomModel extends Partial<RoomPropertiesModel> {
-    recipients: string[];
-}
-export interface EditRoomModel extends Omit<RoomPropertiesModel, 'members'> {
-    members?: RoomMembers;
-    name?: string;
-    lastMessage?: LastMessage;
-}
-export interface ExistingRoomModel extends RoomPropertiesModel {
-    lastMessage: LastMessage;
-    members: RoomMembers;
-    unreadCount?: number;
-    createdAt: FieldValue;
-    lastEdited: FieldValue;
-    currentMembers: string[];
-}
-export interface CreateRoomModel extends Omit<Omit<ExistingRoomModel, 'id'>, 'lastMessage'> {
-    lastMessage: LastMessageServer;
-}
-export interface CreateRoomCallableModel extends Omit<RoomPropertiesModel, 'id'> {
-    members: RoomMembers;
-}
-interface LastMessageDocument extends Omit<LastMessage, 'createdAt'> {
-    createdAt: Timestamp;
-}
-export interface ExistingRoomDocument extends Omit<ExistingRoomModel, 'lastMessage'> {
-    lastMessage: LastMessageDocument;
-}
-export declare type RoomModel = RoomPropertiesModel | NewRoomModel | ExistingRoomModel | CreateCallableRoomModel;
-export declare function currentUserExists(user: firebase.User | null): user is firebase.User;
-export declare function roomIsEditModel(room: RoomModel): room is EditRoomModel;
-export declare function roomIsNewModel(room: RoomModel): room is NewRoomModel;
-export declare function roomIsCreateCallable(room: RoomModel): room is CreateCallableRoomModel;
-export {};

package/lib/typescript/classes/index.d.ts

@@ -1,4 +0,0 @@
-export { default as Reaction } from './Reaction';
-export { default as Message } from './Message';
-export { default as Room } from './Room';
-export { default as Chat } from './Chat';

package/lib/typescript/components/Avatar/index.d.ts

@@ -1,4 +0,0 @@
-import React from 'react';
-import { AvatarProps } from '../Inbox/types';
-declare const _default: React.NamedExoticComponent<AvatarProps>;
-export default _default;

package/lib/typescript/components/Chat/Bubble/index.d.ts

@@ -1,4 +0,0 @@
-import React from 'react';
-import { BubbleProps } from '../types';
-declare const _default: React.NamedExoticComponent<BubbleProps>;
-export default _default;

package/lib/typescript/components/Chat/Composer/Input/index.d.ts

@@ -1,7 +0,0 @@
-import React from 'react';
-import { InputProps } from '../../types';
-declare const _default: React.MemoExoticComponent<{
-    (props: InputProps<import("../../../../classes/Message/types").NewMessageModel>): JSX.Element;
-    displayName: string;
-}>;
-export default _default;

package/lib/typescript/components/Chat/Composer/Send/index.d.ts

@@ -1,4 +0,0 @@
-import React from 'react';
-import { SendButtonProps } from '../../types';
-declare const _default: React.MemoExoticComponent<(props: SendButtonProps<import("../../../../classes/Message/types").NewMessageModel>) => JSX.Element | null>;
-export default _default;

package/lib/typescript/components/Chat/Composer/index.d.ts

@@ -1,8 +0,0 @@
-import React from 'react';
-import { ComposerProps } from '../types';
-import { NewMessageModel } from '../../../classes/Message/types';
-declare const _default: React.MemoExoticComponent<{
-    (props: ComposerProps<NewMessageModel>): JSX.Element;
-    displayName: string;
-}>;
-export default _default;

package/lib/typescript/components/Chat/Media/Image/index.d.ts

@@ -1,7 +0,0 @@
-import React from 'react';
-import { MessageMedia } from '../../../../classes/Message/types';
-declare const _default: React.MemoExoticComponent<{
-    (props: Pick<MessageMedia, "width" | "height" | "url" | "uri">): JSX.Element;
-    displayName: string;
-}>;
-export default _default;

package/lib/typescript/components/Chat/Media/index.d.ts

@@ -1,4 +0,0 @@
-import React from 'react';
-import { MessageMedia } from '../../../classes/Message/types';
-declare const _default: React.MemoExoticComponent<({ contentType, ...props }: MessageMedia) => JSX.Element | null>;
-export default _default;

package/lib/typescript/components/Chat/Message/Touchable/index.d.ts

@@ -1,4 +0,0 @@
-import { FunctionComponent } from 'react';
-import { TouchableProps } from '../../types';
-declare const Touchable: FunctionComponent<TouchableProps>;
-export default Touchable;

package/lib/typescript/components/Chat/Message/index.d.ts

@@ -1,8 +0,0 @@
-import React from 'react';
-import { MessageProps } from '../types';
-import { NewMessageModel } from '../../../classes/Message/types';
-declare const _default: React.MemoExoticComponent<{
-    <Model extends NewMessageModel = NewMessageModel>(props: MessageProps<Model>): JSX.Element;
-    displayName: string;
-}>;
-export default _default;

package/lib/typescript/components/Chat/SystemMessage/index.d.ts

@@ -1,4 +0,0 @@
-import React from 'react';
-import { SystemMessageProps } from '../types';
-declare const SystemMessage: React.MemoExoticComponent<(props: SystemMessageProps<import("../../../classes/Message/types").NewMessageModel>) => JSX.Element>;
-export default SystemMessage;

package/lib/typescript/components/Chat/TypingFooter/index.d.ts

@@ -1,4 +0,0 @@
-import React from 'react';
-import { TypingFooterProps } from '../types';
-declare const _default: React.MemoExoticComponent<({ typingText, containerStyle, numberOfUsersTyping, ...indicatorProps }: TypingFooterProps) => JSX.Element>;
-export default _default;

package/lib/typescript/components/Chat/index.d.ts

@@ -1,8 +0,0 @@
-/// <reference types="react" />
-import { NewMessageModel } from '../../classes/Message/types';
-import { ChatProps } from './types';
-declare function Chat<MessageModel extends NewMessageModel = NewMessageModel>(props: ChatProps<MessageModel>): JSX.Element;
-declare namespace Chat {
-    var append: <M>(state: M[], messages: M[]) => M[];
-}
-export default Chat;