Skip to content

Commit f7d42b7

Browse files
committed
Update CHANGELOG.md and README.md
1 parent 9b7c191 commit f7d42b7

File tree

2 files changed

+26
-7
lines changed

2 files changed

+26
-7
lines changed

CHANGELOG.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,24 @@
33

44
---
55

6+
### [v1.17.0 (12-23-2021)](https://github.com/RTippin/messenger/compare/v1.16.0...v1.17.0)
7+
8+
#### Added
9+
- `getDTO` static method on both `BotActionHandler` and `PackagedBot`.
10+
- `testResolve` static method on `BotActionHandler` for aid in testing.
11+
- `testInstalls` static method on `PackagedBot` for aid in testing.
12+
- `authorizeHandler` and `authorizePackagedBot` methods on `MessengerBots`.
13+
- `shouldAuthorize` method on `MessengerBots`, allowing you to disable handler / bot package authorization for a single request cycle.
14+
- Singular methods `getHandler` and `getPackagedBot` on `MessengerBots` for single resource fetches.
15+
16+
#### Changed
17+
- `Uuids` trait now sets the `incrementing` and `keyType` properties for models that use it.
18+
- Moved the namespace for the base `MessengerCollection`.
19+
- Consolidated bot handler / packaged bot authorization handling methods.
20+
- `GhostUser` primary ID is now static/unchanging.
21+
22+
---
23+
624
### [v1.16.0 (12-16-2021)](https://github.com/RTippin/messenger/compare/v1.15.0...v1.16.0)
725

826
#### Changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,34 +15,33 @@
1515
### Prerequisites
1616
- PHP `^7.4 | ^8.0 | ^8.1`
1717
- Laravel `^8.42`
18-
- `SubstituteBindings::class` route model binding enabled in your API / WEB middleware groups.
19-
- Configure your laravel applications broadcast driver and set up your websocket implementation to utilize the real-time broadcast emitted.
18+
- Route model binding enabled in your API / WEB middleware groups.
2019

2120
### Features
22-
- Realtime messaging between multiple models, such as a User, Admin, and a Teacher model.
21+
- Realtime messaging between multiple models.
2322
- RESTful API, allowing you to create your own UI or connect to your mobile app.
2423
- Private and group threads.
2524
- Message reactions, replies, edits, and deletion.
2625
- Send image, document, audio, and video messages.
2726
- Group thread chat-bots. [Ready-made bots][link-messenger-bots]
2827
- Customize and create your own chat-bot handlers and bot packages. See the [Chat Bots][link-chat-bots] documentation.
29-
- Private thread approval when the two participants are not friends.
3028
- Add participants in a group thread from your friends list.
3129
- Permissions per participant within a group thread.
3230
- Friends, Search, and Online status systems.
31+
- Private thread approval when the two participants are not friends.
3332
- Provider avatars, group thread avatars, and bot avatars.
3433
- Underlying calling system you can extend. See the [Calling][link-calling] documentation.
3534
- Group thread invitation links (like discord).
36-
- All actions are protected behind policies.
35+
- All endpoints are protected behind policies.
3736
- Scheduled commands for automated cleanup and checks.
3837
- Queued jobs fired from our event subscribers.
3938
- Most features can be toggled at runtime using our `Messenger` facade.
40-
- `MessengerComposer` facade allows you to have easy access to our core actions anywhere within your own app, such as sending messages, images, reactions, and more.
39+
- `MessengerComposer` facade allows you to have easy access to the core actions anywhere within your own app, such as sending messages, images, reactions, and more.
4140
- You can implement or extend your own `BroadcastDriver`, `VideoDriver`, and `FriendDriver`, simply by binding your classes into the container.
4241
- Support for morph maps on your provider models. See: [Morph Maps][link-morph-maps]
4342
- Optional extra payload when sending messages to allow custom json to be stored with the message.
4443
- Owner relationships returns a `Ghost Profile` when not found (null-object pattern).
45-
- Private threads auto-lock when the recipient is not found (deleted).
44+
- Private threads auto-lock when the recipient is not found / deleted.
4645

4746
### Upcoming for v2
4847
- Temporary Ephemeral conversations.
@@ -56,9 +55,11 @@
5655
- Chat-bots able to trigger off of an event.
5756

5857
### Notes
58+
- This is a `Laravel` package and must be installed in a `laravel` application to run.
5959
- Read through the [`messenger.php`][link-config] config file before migrating!
6060
- This is a pure backend driven package providing an API to interact with, thus no web UI or websocket implementation will be setup for you.
6161
- Calling is disabled by default. You are responsible for implementing your own media server or connecting to a 3rd party provider.
62+
- Configure your laravel applications broadcast driver and set up your websocket implementation to utilize the real-time broadcast emitted.
6263

6364
---
6465

0 commit comments

Comments
 (0)