@botpress/cli 4.17.10 → 4.17.11
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/.turbo/turbo-build.log +11 -11
- package/package.json +2 -2
- package/templates/empty-bot/package.json +1 -1
- package/templates/empty-integration/hub.md +33 -1
- package/templates/empty-integration/package.json +1 -1
- package/templates/empty-plugin/hub.md +33 -0
- package/templates/empty-plugin/package.json +1 -1
- package/templates/hello-world/hub.md +42 -0
- package/templates/hello-world/package.json +1 -1
- package/templates/webhook-message/hub.md +50 -0
- package/templates/webhook-message/package.json +1 -1
package/.turbo/turbo-build.log
CHANGED
|
@@ -1,32 +1,32 @@
|
|
|
1
1
|
|
|
2
|
-
> @botpress/cli@4.17.
|
|
2
|
+
> @botpress/cli@4.17.11 build /home/runner/work/botpress/botpress/packages/cli
|
|
3
3
|
> pnpm run bundle && pnpm run template:gen
|
|
4
4
|
|
|
5
5
|
|
|
6
|
-
> @botpress/cli@4.17.
|
|
6
|
+
> @botpress/cli@4.17.11 bundle /home/runner/work/botpress/botpress/packages/cli
|
|
7
7
|
> ts-node -T build.ts
|
|
8
8
|
|
|
9
9
|
|
|
10
|
-
> @botpress/cli@4.17.
|
|
10
|
+
> @botpress/cli@4.17.11 template:gen /home/runner/work/botpress/botpress/packages/cli
|
|
11
11
|
> pnpm -r --stream -F @bp-templates/* exec bp gen
|
|
12
12
|
|
|
13
|
-
🤖 Botpress CLI v4.17.
|
|
14
|
-
🤖 Botpress CLI v4.17.
|
|
15
|
-
🤖 Botpress CLI v4.17.
|
|
16
|
-
🤖 Botpress CLI v4.17.
|
|
13
|
+
🤖 Botpress CLI v4.17.11
|
|
14
|
+
🤖 Botpress CLI v4.17.11
|
|
15
|
+
🤖 Botpress CLI v4.17.11
|
|
16
|
+
🤖 Botpress CLI v4.17.11
|
|
17
17
|
○ Generating typings for integration hello-world...
|
|
18
|
-
○ Generating typings for integration empty-integration...
|
|
19
18
|
✓ Typings available at .botpress
|
|
20
19
|
|
|
20
|
+
○ Generating typings for plugin empty-plugin...
|
|
21
21
|
✓ Typings available at .botpress
|
|
22
22
|
|
|
23
|
-
○ Generating typings for
|
|
24
|
-
○ Generating typings for bot...
|
|
23
|
+
○ Generating typings for integration empty-integration...
|
|
25
24
|
✓ Typings available at .botpress
|
|
26
25
|
|
|
26
|
+
○ Generating typings for bot...
|
|
27
27
|
✓ Typings available at .botpress
|
|
28
28
|
|
|
29
|
-
🤖 Botpress CLI v4.17.
|
|
29
|
+
🤖 Botpress CLI v4.17.11
|
|
30
30
|
○ Generating typings for integration webhook-message...
|
|
31
31
|
✓ Typings available at .botpress
|
|
32
32
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@botpress/cli",
|
|
3
|
-
"version": "4.17.
|
|
3
|
+
"version": "4.17.11",
|
|
4
4
|
"description": "Botpress CLI",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "pnpm run bundle && pnpm run template:gen",
|
|
@@ -22,7 +22,7 @@
|
|
|
22
22
|
"@apidevtools/json-schema-ref-parser": "^11.7.0",
|
|
23
23
|
"@botpress/chat": "0.5.1",
|
|
24
24
|
"@botpress/client": "1.24.2",
|
|
25
|
-
"@botpress/sdk": "4.15.
|
|
25
|
+
"@botpress/sdk": "4.15.8",
|
|
26
26
|
"@bpinternal/const": "^0.1.0",
|
|
27
27
|
"@bpinternal/tunnel": "^0.1.1",
|
|
28
28
|
"@bpinternal/yargs-extra": "^0.0.3",
|
|
@@ -1 +1,33 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Integration Title
|
|
2
|
+
|
|
3
|
+
> Describe the integration's purpose.
|
|
4
|
+
|
|
5
|
+
## Configuration
|
|
6
|
+
|
|
7
|
+
> Explain how to configure your integration and list prerequisites `ex: accounts, etc.`.
|
|
8
|
+
> You might also want to add configuration details for specific use cases.
|
|
9
|
+
|
|
10
|
+
## Usage
|
|
11
|
+
|
|
12
|
+
> Explain how to use your integration.
|
|
13
|
+
> You might also want to include an example if there is a specific use case.
|
|
14
|
+
|
|
15
|
+
## Limitations
|
|
16
|
+
|
|
17
|
+
> List the known bugs.
|
|
18
|
+
> List known limits `ex: rate-limiting, payload sizes, etc.`
|
|
19
|
+
> List unsupported use cases.
|
|
20
|
+
|
|
21
|
+
## Changelog
|
|
22
|
+
|
|
23
|
+
> If some versions of your integration introduce changes worth mentionning (breaking changes, bug fixes), describe them here. This will help users to know what to expect when updating the integration.
|
|
24
|
+
|
|
25
|
+
### Integration publication checklist
|
|
26
|
+
|
|
27
|
+
- [ ] The register handler is implemented and validates the configuration.
|
|
28
|
+
- [ ] Title and descriptions for all schemas are present in `integration.definition.ts`.
|
|
29
|
+
- [ ] Events store `conversationId`, `userId` and `messageId` when available.
|
|
30
|
+
- [ ] Implement events & actions that are related to `channels`, `entities`, `user`, `conversations` and `messages`.
|
|
31
|
+
- [ ] Events related to messages are implemented as messages.
|
|
32
|
+
- [ ] When an action is required by the bot developer, a `RuntimeError` is thrown with instructions to fix the problem.
|
|
33
|
+
- [ ] Bot name and bot avatar URL fields are available in the integration configuration.
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# Plugin Title
|
|
2
|
+
|
|
3
|
+
> Describe the plugin's purpose.
|
|
4
|
+
|
|
5
|
+
## Configuration
|
|
6
|
+
|
|
7
|
+
> Explain how to configure your plugin and list prerequisites `ex: accounts, etc.`.
|
|
8
|
+
> You might also want to add configuration details for specific use cases.
|
|
9
|
+
|
|
10
|
+
## Usage
|
|
11
|
+
|
|
12
|
+
> Explain how to use your plugin.
|
|
13
|
+
> You might also want to include an example if there is a specific use case.
|
|
14
|
+
|
|
15
|
+
## Limitations
|
|
16
|
+
|
|
17
|
+
> List the known bugs.
|
|
18
|
+
> List known limits `ex: rate-limiting, payload sizes, etc.`
|
|
19
|
+
> List unsupported use cases.
|
|
20
|
+
|
|
21
|
+
## Changelog
|
|
22
|
+
|
|
23
|
+
> If some versions of your plugin introduce changes worth mentionning (breaking changes, bug fixes), describe them here. This will help users to know what to expect when updating the plugin.
|
|
24
|
+
|
|
25
|
+
### Plugin publication checklist
|
|
26
|
+
|
|
27
|
+
- [ ] The register handler is implemented and validates the configuration.
|
|
28
|
+
- [ ] Title and descriptions for all schemas are present in `plugin.definition.ts`.
|
|
29
|
+
- [ ] Events store `conversationId`, `userId` and `messageId` when available.
|
|
30
|
+
- [ ] Implement events & actions that are related to `channels`, `entities`, `user`, `conversations` and `messages`.
|
|
31
|
+
- [ ] Events related to messages are implemented as messages.
|
|
32
|
+
- [ ] When an action is required by the bot developer, a `RuntimeError` is thrown with instructions to fix the problem.
|
|
33
|
+
- [ ] Bot name and bot avatar URL fields are available in the plugin configuration.
|
|
@@ -1 +1,43 @@
|
|
|
1
1
|
# Hello World
|
|
2
|
+
|
|
3
|
+
This integration is a template with a single action.
|
|
4
|
+
|
|
5
|
+
> Describe the integration's purpose.
|
|
6
|
+
|
|
7
|
+
## Configuration
|
|
8
|
+
|
|
9
|
+
This integration does not need a configuration.
|
|
10
|
+
|
|
11
|
+
> Explain how to configure your integration and list prerequisites `ex: accounts, etc.`.
|
|
12
|
+
> You might also want to add configuration details for specific use cases.
|
|
13
|
+
|
|
14
|
+
## Usage
|
|
15
|
+
|
|
16
|
+
To use, call the action `helloWorld`. This action will greet the user.
|
|
17
|
+
|
|
18
|
+
> Explain how to use your integration.
|
|
19
|
+
> You might also want to include an example if there is a specific use case.
|
|
20
|
+
|
|
21
|
+
## Limitations
|
|
22
|
+
|
|
23
|
+
The `helloWorld` action has a max name size limit of 2^28 - 16 characters (the max javascript string size).
|
|
24
|
+
|
|
25
|
+
> List the known bugs.
|
|
26
|
+
> List known limits `ex: rate-limiting, payload sizes, etc.`
|
|
27
|
+
> List unsupported use cases.
|
|
28
|
+
|
|
29
|
+
## Changelog
|
|
30
|
+
|
|
31
|
+
- 0.1.0: Implemented `helloWorld` action.
|
|
32
|
+
|
|
33
|
+
> If some versions of your integration introduce changes worth mentionning (breaking changes, bug fixes), describe them here. This will help users to know what to expect when updating the integration.
|
|
34
|
+
|
|
35
|
+
### Integration publication checklist
|
|
36
|
+
|
|
37
|
+
- [ ] The register handler is implemented and validates the configuration.
|
|
38
|
+
- [ ] Title and descriptions for all schemas are present in `integration.definition.ts`.
|
|
39
|
+
- [ ] Events store `conversationId`, `userId` and `messageId` when available.
|
|
40
|
+
- [ ] Implement events & actions that are related to `channels`, `entities`, `user`, `conversations` and `messages`.
|
|
41
|
+
- [ ] Events related to messages are implemented as messages.
|
|
42
|
+
- [ ] When an action is required by the bot developer, a `RuntimeError` is thrown with instructions to fix the problem.
|
|
43
|
+
- [ ] Bot name and bot avatar URL fields are available in the integration configuration.
|
|
@@ -1 +1,51 @@
|
|
|
1
1
|
# Webhook Message
|
|
2
|
+
|
|
3
|
+
This integration serves as a template for receiving events through a webhook and creating messages for them, as well as sending messages through an external API.
|
|
4
|
+
|
|
5
|
+
> Describe the integration's purpose.
|
|
6
|
+
|
|
7
|
+
## Configuration
|
|
8
|
+
|
|
9
|
+
To use this integration, you will need to manually subscribe your integration to an external service webhook.
|
|
10
|
+
You will also have to provide a webhookUrl configuration to send outgoing messages to.
|
|
11
|
+
|
|
12
|
+
> Explain how to configure your integration and list prerequisites `ex: accounts, etc.`.
|
|
13
|
+
> You might also want to add configuration details for specific use cases.
|
|
14
|
+
|
|
15
|
+
## Usage
|
|
16
|
+
|
|
17
|
+
Send messages through the `webhook` channel to send them through the external webhookUrl you configured.
|
|
18
|
+
Receive messages through the integration's incoming webhook handler. Received messages have to contain:
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
userId: string
|
|
22
|
+
conversationId: string
|
|
23
|
+
text: string
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
> Explain how to use your integration.
|
|
27
|
+
> You might also want to include an example if there is a specific use case.
|
|
28
|
+
|
|
29
|
+
## Limitations
|
|
30
|
+
|
|
31
|
+
Only text messages are supported for outgoing messages.
|
|
32
|
+
|
|
33
|
+
> List the known bugs.
|
|
34
|
+
> List known limits `ex: rate-limiting, payload sizes, etc.`
|
|
35
|
+
> List unsupported use cases.
|
|
36
|
+
|
|
37
|
+
## Changelog
|
|
38
|
+
|
|
39
|
+
- 0.1.0: Incoming webhook and outgoing channel.
|
|
40
|
+
|
|
41
|
+
> If some versions of your integration introduce changes worth mentionning (breaking changes, bug fixes), describe them here. This will help users to know what to expect when updating the integration.
|
|
42
|
+
|
|
43
|
+
### Integration publication checklist
|
|
44
|
+
|
|
45
|
+
- [ ] The register handler is implemented and validates the configuration.
|
|
46
|
+
- [ ] Title and descriptions for all schemas are present in `integration.definition.ts`.
|
|
47
|
+
- [ ] Events store `conversationId`, `userId` and `messageId` when available.
|
|
48
|
+
- [ ] Implement events & actions that are related to `channels`, `entities`, `user`, `conversations` and `messages`.
|
|
49
|
+
- [ ] Events related to messages are implemented as messages.
|
|
50
|
+
- [ ] When an action is required by the bot developer, a `RuntimeError` is thrown with instructions to fix the problem.
|
|
51
|
+
- [ ] Bot name and bot avatar URL fields are available in the integration configuration.
|