@connectycube/chat-widget 0.12.0 → 0.13.0

package/README.md

@@ -126,23 +126,33 @@ See chat widget code samples <https://github.com/ConnectyCube/connectycube-chat-
 
 ## Props
 
-| Prop Name            | Type                  | Description                                                   |
-| -------------------- | --------------------- | ------------------------------------------------------------- |
-| `appId`              | `number \| string`    | The ConnectyCube Application ID                               |
-| `authKey`            | `string`              | The ConnectyCube Authentication Key                           |
-| `config`             | `object`              | _(Optional)_ Configuration options for ConnectyCube SDK       |
-| `userId`             | `string`              | A User Id from your system                                    |
-| `userName`           | `string`              | User name. This is how other users will see your user name    |
-| `muted`              | `boolean` (`false`)   | _(Optional)_ Do not play sound on incoming message            |
-| `splitView`          | `boolean` (`false`)   | _(Optional)_ Displays the chats in split view or single view  |
-| `showOnlineUsersTab` | `boolean` (`false`)   | _(Optional)_ Displays users tab with the list of online users |
-| `buttonTitle`        | `string` ("Chat")     | _(Optional)_ The text displayed on the chat button            |
-| `buttonStyle`        | `React.CSSProperties` | _(Optional)_ Inline styles for the button                     |
-| `portalStyle`        | `React.CSSProperties` | _(Optional)_ Inline styles for the portal                     |
-| `badgeStyle`         | `React.CSSProperties` | _(Optional)_ Inline styles for the badge                      |
-| `buttonClassName`    | `string`              | _(Optional)_ CSS class or Tailwind CSS classes for the button |
-| `portalClassName`    | `string`              | _(Optional)_ CSS class or Tailwind CSS classes for the chat   |
-| `badgeClassName`     | `string`              | _(Optional)_ CSS class or Tailwind CSS classes for the badge  |
+| Prop Name            | Type                  | Description                                                                            | Default Value |
+| -------------------- | --------------------- | -------------------------------------------------------------------------------------- | ------------- |
+| `appId`              | `number \| string`    | The ConnectyCube Application ID                                                        |               |
+| `authKey`            | `string`              | The ConnectyCube Authentication Key                                                    |               |
+| `config`             | `object`              | _(Optional)_ Configuration options for ConnectyCube SDK                                |               |
+| `userId`             | `string`              | A User Id from your system                                                             |               |
+| `userName`           | `string`              | User name. This is how other users will see your user name                             |               |
+| `userAvatar`         | `string`              | _(Optional)_ User Avatar URL                                                           |               |
+| `muted`              | `boolean`             | _(Optional)_ Do not play sound on incoming message                                     | false         |
+| `splitView`          | `boolean`             | _(Optional)_ Displays the chats in split view or single view                           | false         |
+| `showOnlineUsersTab` | `boolean`             | _(Optional)_ Displays users tab with the list of online users                          | false         |
+| `buttonTitle`        | `string`              | _(Optional)_ The text displayed on the chat button                                     | "Chat"        |
+| `buttonStyle`        | `React.CSSProperties` | _(Optional)_ Inline styles for the button                                              |               |
+| `portalStyle`        | `React.CSSProperties` | _(Optional)_ Inline styles for the portal                                              |               |
+| `badgeStyle`         | `React.CSSProperties` | _(Optional)_ Inline styles for the badge                                               |               |
+| `buttonClassName`    | `string`              | _(Optional)_ CSS class or Tailwind CSS classes for the button                          |               |
+| `portalClassName`    | `string`              | _(Optional)_ CSS class or Tailwind CSS classes for the chat                            |               |
+| `badgeClassName`     | `string`              | _(Optional)_ CSS class or Tailwind CSS classes for the badge                           |               |
+| `quickActions`       | `object`              | _(Optional)_ Configuration for quick actions dialog. See [QuickActions](#quickactions) |               |
+
+## QuickActions
+
+| Prop Name     | Type       | Description                                      | Default Value |
+| ------------- | ---------- | ------------------------------------------------ | ------------- |
+| `title`       | `string`   | _(Optional)_ Title for the quick actions section |               |
+| `description` | `string`   | _(Optional)_ Description for the quick actions   |               |
+| `actions`     | `string[]` | List of action strings                           |               |
 
 ## Recipes
 
@@ -228,6 +238,10 @@ const props = {
 };
 ```
 
+## Changelog
+
+<https://github.com/ConnectyCube/connectycube-chat-widget-samples/blob/main/CHANGELOG.md>
+
 ## Community and support
 
 - [Blog](https://connectycube.com/blog)

package/dist/AppContainer.d.ts

@@ -1,13 +1,16 @@
 import { Config } from '../../../node_modules/connectycube/dist/types/types';
+import { QuickActions } from './redux/slices/quickActions';
 export type AppProps = {
     appId: Config.Credentials['appId'];
     authKey: Config.Credentials['authKey'];
     userId?: string;
     userName?: string;
+    userAvatar?: string;
     config?: Config.Options;
     muted?: boolean;
     splitView?: boolean;
     showOnlineUsersTab?: boolean;
+    quickActions?: QuickActions;
     buttonTitle?: string;
     buttonStyle?: React.CSSProperties;
     portalStyle?: React.CSSProperties;

package/dist/components/home/main/quick-actions.d.ts

@@ -0,0 +1,5 @@
+export interface QuickActionsProps {
+    sendMessage: (text: string) => void;
+}
+declare const QuickActions: React.FC<QuickActionsProps>;
+export default QuickActions;

package/dist/components/login.d.ts

@@ -1,6 +1,7 @@
 type LoginProps = {
     login?: string;
     name?: string;
+    avatar?: string;
 };
 declare const Login: React.FC<LoginProps>;
 export default Login;

package/dist/components/shared/avatar.d.ts

@@ -1,6 +1,6 @@
 import { default as React } from 'react';
 export interface AvatarProps {
-    imageUID?: string;
+    imageUIDOrUrl?: string;
     name: string;
     className?: string | undefined;
 }

package/dist/connectycube.d.ts

@@ -1,13 +1,13 @@
 import { Chat, Users, Auth } from '../../../node_modules/connectycube/dist/types/types';
 export declare const SESSION_KEY = "@connectycube/chat-widget:session";
-export declare const tryReuseSession: (userName?: string, userId?: string) => Promise<boolean>;
+export declare const tryReuseSession: (userName?: string, userId?: string, userAvatar?: string) => Promise<boolean>;
 export declare const tryRestoreSession: () => Promise<Auth.Session | null>;
 export declare const createUserSession: (login: string, password: string) => Promise<Auth.Session>;
-export declare const createSession: (userId?: string, userName?: string) => Promise<Auth.Session | null>;
+export declare const createSession: (userId?: string, userName?: string, userAvatar?: string) => Promise<Auth.Session | null>;
 export declare const destroyUserSession: () => Promise<void>;
-export declare const userSignup: (login: string, password: string, name?: string, externalId?: string) => Promise<Auth.Session>;
+export declare const userSignup: (login: string, password: string, name?: string, externalId?: string, userAvatar?: string) => Promise<Auth.Session>;
 export declare const chatCredentials: () => Chat.ConnectionParams | null;
-export declare const updateUserProfileIfNeeded: (session: Auth.Session, name?: string, externalId?: string) => Promise<void>;
+export declare const updateUserProfileIfNeeded: (session: Auth.Session, name?: string, externalId?: string, avatar?: string) => Promise<Auth.Session>;
 export declare const setSessionToLocalStorage: (session: Auth.Session) => void;
 export declare const getSessionFromLocalStorage: () => Auth.Session | null;
 export declare const clearSessionInLocalStorage: () => void;