@ethora/chat-component 26.2.20 → 26.2.22
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -1
- package/dist/config.d.ts +8 -5
- package/dist/firebase-messaging-sw.js +351 -386
- package/dist/helpers/constants/PLATFORM_CONSTANTS.d.ts +3 -3
- package/dist/helpers/historyPreloadScheduler.d.ts +1 -0
- package/dist/hooks/useLoaderDebug.d.ts +1 -0
- package/dist/hooks/usePushNotifications.d.ts +4 -0
- package/dist/main.js +10880 -10651
- package/dist/main.js.map +1 -1
- package/dist/networking/xmppClient.d.ts +6 -0
- package/dist/types/models/config.model.d.ts +10 -0
- package/dist/types/models/xmpp.model.d.ts +7 -0
- package/dist/utils/firebasePushNotifications.d.ts +2 -0
- package/dist/version.d.ts +1 -1
- package/package.json +2 -1
- package/public/firebase-messaging-sw.js +351 -386
- package/scripts/init-push.js +0 -0
package/README.md
CHANGED
|
@@ -121,6 +121,8 @@ export default function App() {
|
|
|
121
121
|
enabled: true,
|
|
122
122
|
softAsk: false,
|
|
123
123
|
vapidPublicKey: 'PLACEHOLDER_VAPID_PUBLIC_KEY',
|
|
124
|
+
iconPath: '/icons/push-icon-192.png',
|
|
125
|
+
badgePath: '/icons/push-badge-72.png',
|
|
124
126
|
firebaseConfig: {
|
|
125
127
|
apiKey: 'PLACEHOLDER_API_KEY',
|
|
126
128
|
authDomain: 'PLACEHOLDER_AUTH_DOMAIN',
|
|
@@ -356,6 +358,7 @@ Below is a grouped reference for all `config` options.
|
|
|
356
358
|
| `colors` | `{ primary: string; secondary: string }` | Theme colors for component UI. |
|
|
357
359
|
| `roomListStyles` | `React.CSSProperties` | Styles for room list pane. |
|
|
358
360
|
| `chatRoomStyles` | `React.CSSProperties` | Styles for chat pane. |
|
|
361
|
+
| `noMessagesPlaceholder` | `React.ComponentType` | Replace empty-chat placeholder component (same render position as default placeholder). |
|
|
359
362
|
| `backgroundChat` | `{ color?: string; image?: string \| File }` | Chat background customization. |
|
|
360
363
|
| `bubleMessage` | `MessageBubble` | Bubble-level style overrides (as defined in types). |
|
|
361
364
|
| `setRoomJidInPath` | `boolean` | Sync room JID to URL path. |
|
|
@@ -419,6 +422,8 @@ Below is a grouped reference for all `config` options.
|
|
|
419
422
|
| `pushNotifications.firebaseConfig` | `FBConfig` | Firebase app config for push messaging. |
|
|
420
423
|
| `pushNotifications.serviceWorkerPath` | `string` | Service worker path, default `/firebase-messaging-sw.js`. |
|
|
421
424
|
| `pushNotifications.serviceWorkerScope` | `string` | Service worker scope, default `/`. |
|
|
425
|
+
| `pushNotifications.iconPath` | `string` | Custom icon URL/path for OS push notifications. |
|
|
426
|
+
| `pushNotifications.badgePath` | `string` | Custom badge URL/path for OS push notifications. Falls back to `iconPath`. |
|
|
422
427
|
| `pushNotifications.softAsk` | `boolean` | Do not immediately trigger browser permission prompt. |
|
|
423
428
|
| `pushNotifications.onClick` | `(params) => void \| Promise<void>` | Callback invoked when the user clicks an OS push notification (including cold start via URL marker). |
|
|
424
429
|
|
|
@@ -505,6 +510,8 @@ npx @ethora/chat-component ethora-chat
|
|
|
505
510
|
},
|
|
506
511
|
serviceWorkerPath: '/firebase-messaging-sw.js',
|
|
507
512
|
serviceWorkerScope: '/',
|
|
513
|
+
iconPath: '/icons/push-icon-192.png',
|
|
514
|
+
badgePath: '/icons/push-badge-72.png',
|
|
508
515
|
softAsk: false,
|
|
509
516
|
onClick: async ({ roomJID, messageId, url, data }) => {
|
|
510
517
|
// Your app-level routing/analytics can live here.
|
|
@@ -531,6 +538,8 @@ function PushPermissionButton() {
|
|
|
531
538
|
}
|
|
532
539
|
```
|
|
533
540
|
|
|
541
|
+
`iconPath` and `badgePath` should point to public, reachable assets (for example, files from your app `public/` directory).
|
|
542
|
+
|
|
534
543
|
## Auth Strategies
|
|
535
544
|
|
|
536
545
|
| Strategy | Config shape | Best for |
|
|
@@ -695,4 +704,4 @@ This is a practical planning snapshot for cross-platform consumers. It is not a
|
|
|
695
704
|
|
|
696
705
|
## License
|
|
697
706
|
|
|
698
|
-
AGPL. See [LICENSE.txt](./LICENSE.txt).
|
|
707
|
+
AGPL. See [LICENSE.txt](./LICENSE.txt).
|
package/dist/config.d.ts
CHANGED
|
@@ -1,6 +1,9 @@
|
|
|
1
|
-
export declare const VITE_APP_API_URL
|
|
1
|
+
export declare const VITE_APP_API_URL: string;
|
|
2
2
|
export declare const VITE_APP_DISABLE_STRICT = "true";
|
|
3
|
-
export declare const VITE_APP_DOMAIN_NAME
|
|
4
|
-
export declare const
|
|
5
|
-
export declare const
|
|
6
|
-
export declare const
|
|
3
|
+
export declare const VITE_APP_DOMAIN_NAME: string;
|
|
4
|
+
export declare const VITE_APP_WEB_DOMAIN: string;
|
|
5
|
+
export declare const VITE_APP_WEB_URL: string;
|
|
6
|
+
export declare const VITE_APP_XMPP_BASEDOMAIN_OLD: string;
|
|
7
|
+
export declare const VITE_APP_XMPP_BASEDOMAIN: string;
|
|
8
|
+
export declare const VITE_APP_XMPP_CONFERENCE: string;
|
|
9
|
+
export declare const SERVICE: string;
|