@wfgraph/plugins 0.0.1 → 0.1.0
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 +40 -0
- package/dist/index.d.ts +12 -12
- package/package.json +6 -3
package/README.md
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# @wfgraph/plugins
|
|
2
|
+
|
|
3
|
+
The six built-in integrations for
|
|
4
|
+
[Workflow Graph](https://github.com/alandotcom/wfgraph): Acuity, Clerk, Linear, Resend, Slack,
|
|
5
|
+
and Twilio.
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @wfgraph/plugins
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Nothing registers on import. The line that turns the built-ins on is a line in your own code,
|
|
12
|
+
and dropping it is what turns them off.
|
|
13
|
+
|
|
14
|
+
```ts
|
|
15
|
+
import { createWfGraphApp } from "@wfgraph/core";
|
|
16
|
+
import { builtInIntegrations } from "@wfgraph/plugins";
|
|
17
|
+
|
|
18
|
+
const wfgraph = await createWfGraphApp({
|
|
19
|
+
extensions: { integrations: builtInIntegrations /* ...events and actions */ },
|
|
20
|
+
// ...the rest
|
|
21
|
+
});
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Each integration is also exported by name, for a host that wants some of the six rather than
|
|
25
|
+
all of them. That narrows what reaches `createWfGraphApp` rather than what the process loads,
|
|
26
|
+
since this entry imports all six as values.
|
|
27
|
+
|
|
28
|
+
`@wfgraph/core` is a peer dependency: an integration is built against it and handed back to it,
|
|
29
|
+
so the two must resolve to one copy. They are released together and always share a version.
|
|
30
|
+
|
|
31
|
+
The `@wfgraph/plugins/ui` entry is a separate export holding the icons and output renderers the
|
|
32
|
+
editor draws these integrations with. It is React and browser-only, which is why a server
|
|
33
|
+
importing the root entry never pulls React in.
|
|
34
|
+
|
|
35
|
+
## Docs
|
|
36
|
+
|
|
37
|
+
- [Integrations](https://github.com/alandotcom/wfgraph/blob/main/docs/integrations.md), which
|
|
38
|
+
covers `defineIntegration`, handlers, schemas, and testing your own
|
|
39
|
+
|
|
40
|
+
Apache-2.0.
|
package/dist/index.d.ts
CHANGED
|
@@ -452,18 +452,6 @@ declare const twilio: import("@wfgraph/core/plugin").Integration<{
|
|
|
452
452
|
//#endregion
|
|
453
453
|
//#region src/index.d.ts
|
|
454
454
|
declare const builtInIntegrations: (import("@wfgraph/core/plugin").Integration<{
|
|
455
|
-
"send-message": {
|
|
456
|
-
readonly slackChannel: string;
|
|
457
|
-
readonly slackMessage: string;
|
|
458
|
-
readonly testBehavior?: string | undefined;
|
|
459
|
-
};
|
|
460
|
-
}, {
|
|
461
|
-
"send-message": {
|
|
462
|
-
readonly ts: string;
|
|
463
|
-
readonly channel: string;
|
|
464
|
-
readonly reasonCode?: string | null | undefined;
|
|
465
|
-
};
|
|
466
|
-
}> | import("@wfgraph/core/plugin").Integration<{
|
|
467
455
|
"list-appointment-types": {};
|
|
468
456
|
"list-appointments": {
|
|
469
457
|
readonly appointmentTypeId?: string | undefined;
|
|
@@ -759,6 +747,18 @@ declare const builtInIntegrations: (import("@wfgraph/core/plugin").Integration<{
|
|
|
759
747
|
readonly id: number;
|
|
760
748
|
readonly canceled?: boolean | undefined;
|
|
761
749
|
};
|
|
750
|
+
}> | import("@wfgraph/core/plugin").Integration<{
|
|
751
|
+
"send-message": {
|
|
752
|
+
readonly slackChannel: string;
|
|
753
|
+
readonly slackMessage: string;
|
|
754
|
+
readonly testBehavior?: string | undefined;
|
|
755
|
+
};
|
|
756
|
+
}, {
|
|
757
|
+
"send-message": {
|
|
758
|
+
readonly ts: string;
|
|
759
|
+
readonly channel: string;
|
|
760
|
+
readonly reasonCode?: string | null | undefined;
|
|
761
|
+
};
|
|
762
762
|
}> | import("@wfgraph/core/plugin").Integration<{
|
|
763
763
|
"get-user": {
|
|
764
764
|
readonly userId: string;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wfgraph/plugins",
|
|
3
|
-
"version": "0.0
|
|
3
|
+
"version": "0.1.0",
|
|
4
4
|
"description": "The six built-in Workflow Graph integrations, plus the icons and output renderers the editor draws them with",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"automation",
|
|
@@ -45,12 +45,15 @@
|
|
|
45
45
|
"devDependencies": {
|
|
46
46
|
"@types/react": "^19.2.18",
|
|
47
47
|
"react": "19.2.8",
|
|
48
|
-
"@wfgraph/core": "0.0
|
|
49
|
-
"@wfgraph/shared": "0.0
|
|
48
|
+
"@wfgraph/core": "0.1.0",
|
|
49
|
+
"@wfgraph/shared": "0.1.0"
|
|
50
50
|
},
|
|
51
51
|
"peerDependencies": {
|
|
52
52
|
"@wfgraph/core": "*"
|
|
53
53
|
},
|
|
54
|
+
"engines": {
|
|
55
|
+
"node": ">=24"
|
|
56
|
+
},
|
|
54
57
|
"scripts": {
|
|
55
58
|
"build": "tsdown"
|
|
56
59
|
}
|