@corsair-dev/ably 0.1.0 → 0.1.1
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 +56 -0
- package/package.json +9 -3
package/README.md
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# @corsair-dev/ably
|
|
2
|
+
|
|
3
|
+
Ably plugin for Corsair.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
pnpm add @corsair-dev/ably
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Endpoints
|
|
12
|
+
|
|
13
|
+
| Operation | Operation ID | Risk | Description |
|
|
14
|
+
|-----------|--------------|------|-------------|
|
|
15
|
+
| `application.getServiceTime` | `ably.api.application.getServiceTime` | `read` | Get the current Ably service time. |
|
|
16
|
+
| `application.getStats` | `ably.api.application.getStats` | `read` | Retrieve application usage statistics. |
|
|
17
|
+
| `application.requestAccessToken` | `ably.api.application.requestAccessToken` | `write` | Request an Ably access token. |
|
|
18
|
+
| `channels.batchPresence` | `ably.api.channels.batchPresence` | `read` | Retrieve presence information for multiple channels. |
|
|
19
|
+
| `channels.batchPresenceHistory` | `ably.api.channels.batchPresenceHistory` | `read` | Retrieve presence history for multiple channels. |
|
|
20
|
+
| `channels.getChannelDetails` | `ably.api.channels.getChannelDetails` | `read` | Retrieve details for an active channel. |
|
|
21
|
+
| `channels.getChannelHistory` | `ably.api.channels.getChannelHistory` | `read` | Retrieve message history for a channel. |
|
|
22
|
+
| `channels.getChannelPresence` | `ably.api.channels.getChannelPresence` | `read` | Retrieve current channel presence members. |
|
|
23
|
+
| `channels.getMessageVersions` | `ably.api.channels.getMessageVersions` | `read` | Retrieve historical versions of a message. |
|
|
24
|
+
| `channels.getPresenceHistory` | `ably.api.channels.getPresenceHistory` | `read` | Retrieve presence history for a channel. |
|
|
25
|
+
| `channels.listChannels` | `ably.api.channels.listChannels` | `read` | List active Ably channels. |
|
|
26
|
+
| `channels.publishBatchMessages` | `ably.api.channels.publishBatchMessages` | `write` | Publish messages to multiple Ably channels. |
|
|
27
|
+
| `channels.publishMessageToChannel` | `ably.api.channels.publishMessageToChannel` | `write` | Publish a message to an Ably channel. |
|
|
28
|
+
| `push.createPushChannelSubscription` | `ably.api.push.createPushChannelSubscription` | `write` | Subscribe a device or client to a push channel. |
|
|
29
|
+
| `push.deleteChannelSubscription` | `ably.api.push.deleteChannelSubscription` | `destructive` | Delete matching push channel subscriptions. |
|
|
30
|
+
| `push.getPushDevice` | `ably.api.push.getPushDevice` | `read` | Retrieve a push device registration. |
|
|
31
|
+
| `push.listPushChannels` | `ably.api.push.listPushChannels` | `read` | List channels with push subscribers. |
|
|
32
|
+
| `push.listPushChannelSubscriptions` | `ably.api.push.listPushChannelSubscriptions` | `read` | List push channel subscriptions. |
|
|
33
|
+
| `push.listRegisteredPushDevices` | `ably.api.push.listRegisteredPushDevices` | `read` | List registered push notification devices. |
|
|
34
|
+
| `push.patchPushDeviceRegistration` | `ably.api.push.patchPushDeviceRegistration` | `write` | Partially update a push device registration. |
|
|
35
|
+
| `push.publishPushNotification` | `ably.api.push.publishPushNotification` | `write` | Publish a push notification. |
|
|
36
|
+
| `push.publishPushNotificationsBatch` | `ably.api.push.publishPushNotificationsBatch` | `write` | Publish a batch of push notifications. |
|
|
37
|
+
| `push.registerPushDevice` | `ably.api.push.registerPushDevice` | `write` | Register a device for push notifications. |
|
|
38
|
+
| `push.unregisterAllPushDevices` | `ably.api.push.unregisterAllPushDevices` | `destructive` | Delete matching push device registrations. |
|
|
39
|
+
| `push.unregisterPushDevice` | `ably.api.push.unregisterPushDevice` | `destructive` | Delete a push device registration. |
|
|
40
|
+
| `push.updatePushDevice` | `ably.api.push.updatePushDevice` | `write` | Create or replace a push device registration. |
|
|
41
|
+
|
|
42
|
+
## Auth
|
|
43
|
+
|
|
44
|
+
Auth: API key. Corsair prompts your tenant for credentials on first use.
|
|
45
|
+
|
|
46
|
+
## Webhooks
|
|
47
|
+
|
|
48
|
+
No webhooks.
|
|
49
|
+
|
|
50
|
+
## Reference
|
|
51
|
+
|
|
52
|
+
Full docs, types, and examples: https://docs.corsair.dev/plugins/ably
|
|
53
|
+
|
|
54
|
+
## License
|
|
55
|
+
|
|
56
|
+
Apache-2.0
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@corsair-dev/ably",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "Ably plugin for Corsair",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -24,18 +24,24 @@
|
|
|
24
24
|
"tsup": "^8.0.1",
|
|
25
25
|
"typescript": "^5.9.3",
|
|
26
26
|
"zod": "^4.1.13",
|
|
27
|
-
"corsair": "0.1.
|
|
27
|
+
"corsair": "0.1.129"
|
|
28
28
|
},
|
|
29
29
|
"keywords": [
|
|
30
30
|
"corsair",
|
|
31
31
|
"ably",
|
|
32
32
|
"plugin"
|
|
33
33
|
],
|
|
34
|
-
"author": "",
|
|
34
|
+
"author": "Corsair (https://corsair.dev)",
|
|
35
35
|
"license": "Apache-2.0",
|
|
36
36
|
"files": [
|
|
37
37
|
"dist"
|
|
38
38
|
],
|
|
39
|
+
"repository": {
|
|
40
|
+
"type": "git",
|
|
41
|
+
"url": "git+https://github.com/corsairdev/corsair.git",
|
|
42
|
+
"directory": "packages/ably"
|
|
43
|
+
},
|
|
44
|
+
"homepage": "https://docs.corsair.dev/plugins/ably",
|
|
39
45
|
"scripts": {
|
|
40
46
|
"build": "rm -rf dist && tsc --build --force && tsup",
|
|
41
47
|
"typecheck": "tsc --noEmit",
|