@plotday/twister 0.20.0 → 0.21.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 +5 -5
- package/bin/templates/AGENTS.template.md +5 -5
- package/bin/templates/README.template.md +1 -1
- package/cli/templates/AGENTS.template.md +5 -5
- package/cli/templates/README.template.md +1 -1
- package/dist/common/calendar.d.ts +1 -1
- package/dist/docs/assets/search.js +1 -1
- package/dist/docs/documents/Advanced.html +6 -6
- package/dist/docs/documents/Building_Custom_Tools.html +3 -3
- package/dist/docs/documents/Built-in_Tools.html +3 -3
- package/dist/docs/documents/Core_Concepts.html +3 -3
- package/dist/docs/documents/Getting_Started.html +1 -1
- package/dist/docs/documents/Runtime_Environment.html +2 -2
- package/dist/docs/enums/plot.ActivityType.html +3 -3
- package/dist/docs/interfaces/common_calendar.CalendarTool.html +1 -1
- package/dist/docs/types/plot.Activity.html +1 -1
- package/dist/docs/types/plot.NewActivity.html +1 -1
- package/dist/llm-docs/common/calendar.d.ts +1 -1
- package/dist/llm-docs/common/calendar.d.ts.map +1 -1
- package/dist/llm-docs/common/calendar.js +1 -1
- package/dist/llm-docs/common/calendar.js.map +1 -1
- package/dist/llm-docs/plot.d.ts +1 -1
- package/dist/llm-docs/plot.d.ts.map +1 -1
- package/dist/llm-docs/plot.js +1 -1
- package/dist/llm-docs/plot.js.map +1 -1
- package/dist/llm-docs/twist-guide-template.d.ts +1 -1
- package/dist/llm-docs/twist-guide-template.d.ts.map +1 -1
- package/dist/llm-docs/twist-guide-template.js +1 -1
- package/dist/llm-docs/twist-guide-template.js.map +1 -1
- package/dist/plot.d.ts +5 -5
- package/dist/plot.d.ts.map +1 -1
- package/dist/plot.js +1 -1
- package/dist/plot.js.map +1 -1
- package/dist/twist-guide.d.ts +1 -1
- package/dist/twist-guide.d.ts.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,10 +4,10 @@
|
|
|
4
4
|
</a>
|
|
5
5
|
</p>
|
|
6
6
|
<h1 align="center">
|
|
7
|
-
Plot Twist Creator
|
|
7
|
+
🌪️ Twister, the Plot Twist Creator
|
|
8
8
|
</h1>
|
|
9
9
|
<p align="center">
|
|
10
|
-
The official
|
|
10
|
+
The official package for building <a href="https://plot.day">Plot</a> Twists -<br/>
|
|
11
11
|
smart automations that connect, organize, and prioritize your work.
|
|
12
12
|
</p>
|
|
13
13
|
|
|
@@ -24,7 +24,7 @@ Choose your path:
|
|
|
24
24
|
|
|
25
25
|
### No-Code Quick Start
|
|
26
26
|
|
|
27
|
-
|
|
27
|
+
Describe your twist and Plot will do the rest.
|
|
28
28
|
|
|
29
29
|
**1. Create `plot-twist.md`:**
|
|
30
30
|
|
|
@@ -62,9 +62,9 @@ npx @plotday/twister create
|
|
|
62
62
|
```typescript
|
|
63
63
|
import {
|
|
64
64
|
ActivityType,
|
|
65
|
-
Twist,
|
|
66
65
|
type Priority,
|
|
67
66
|
type ToolBuilder,
|
|
67
|
+
Twist,
|
|
68
68
|
} from "@plotday/twister";
|
|
69
69
|
import { Plot } from "@plotday/twister/tools/plot";
|
|
70
70
|
|
|
@@ -130,7 +130,7 @@ The core data type representing tasks, events, and notes.
|
|
|
130
130
|
|
|
131
131
|
```typescript
|
|
132
132
|
await this.tools.plot.createActivity({
|
|
133
|
-
type: ActivityType.
|
|
133
|
+
type: ActivityType.Action,
|
|
134
134
|
title: "Review pull request",
|
|
135
135
|
links: [
|
|
136
136
|
{
|
|
@@ -28,7 +28,7 @@ import {
|
|
|
28
28
|
} from "@plotday/twister";
|
|
29
29
|
import { Plot } from "@plotday/twister/tools/plot";
|
|
30
30
|
|
|
31
|
-
export default class MyTwist extends
|
|
31
|
+
export default class MyTwist extends Twist<MyTwist> {
|
|
32
32
|
build(build: ToolBuilder) {
|
|
33
33
|
return {
|
|
34
34
|
plot: build(Plot),
|
|
@@ -118,7 +118,7 @@ async activate(_priority: Pick<Priority, "id">) {
|
|
|
118
118
|
);
|
|
119
119
|
|
|
120
120
|
await this.tools.plot.createActivity({
|
|
121
|
-
type: ActivityType.
|
|
121
|
+
type: ActivityType.Action,
|
|
122
122
|
title: "Connect your account",
|
|
123
123
|
links: [authLink],
|
|
124
124
|
});
|
|
@@ -129,7 +129,7 @@ async activate(_priority: Pick<Priority, "id">) {
|
|
|
129
129
|
|
|
130
130
|
```typescript
|
|
131
131
|
const activity = await this.tools.plot.createActivity({
|
|
132
|
-
type: ActivityType.
|
|
132
|
+
type: ActivityType.Action,
|
|
133
133
|
title: "Setup",
|
|
134
134
|
});
|
|
135
135
|
|
|
@@ -182,7 +182,7 @@ const callbackLink: ActivityLink = {
|
|
|
182
182
|
|
|
183
183
|
// Add to activity
|
|
184
184
|
await this.tools.plot.createActivity({
|
|
185
|
-
type: ActivityType.
|
|
185
|
+
type: ActivityType.Action,
|
|
186
186
|
title: "Task with links",
|
|
187
187
|
links: [urlLink, callbackLink],
|
|
188
188
|
});
|
|
@@ -202,7 +202,7 @@ async activate(_priority: Pick<Priority, "id">) {
|
|
|
202
202
|
|
|
203
203
|
// Create activity with auth link
|
|
204
204
|
const activity = await this.tools.plot.createActivity({
|
|
205
|
-
type: ActivityType.
|
|
205
|
+
type: ActivityType.Action,
|
|
206
206
|
title: "Connect Google account",
|
|
207
207
|
links: [authLink],
|
|
208
208
|
});
|
|
@@ -98,7 +98,7 @@ build(build: ToolBuilder) {
|
|
|
98
98
|
Plot supports three activity types:
|
|
99
99
|
|
|
100
100
|
- **ActivityType.Note**: Information without actionable requirements
|
|
101
|
-
- **ActivityType.
|
|
101
|
+
- **ActivityType.Action**: Actionable items that can be completed
|
|
102
102
|
- **ActivityType.Event**: Scheduled occurrences with start/end times
|
|
103
103
|
|
|
104
104
|
### State Management
|
|
@@ -28,7 +28,7 @@ import {
|
|
|
28
28
|
} from "@plotday/twister";
|
|
29
29
|
import { Plot } from "@plotday/twister/tools/plot";
|
|
30
30
|
|
|
31
|
-
export default class MyTwist extends
|
|
31
|
+
export default class MyTwist extends Twist<MyTwist> {
|
|
32
32
|
build(build: ToolBuilder) {
|
|
33
33
|
return {
|
|
34
34
|
plot: build(Plot),
|
|
@@ -118,7 +118,7 @@ async activate(_priority: Pick<Priority, "id">) {
|
|
|
118
118
|
);
|
|
119
119
|
|
|
120
120
|
await this.tools.plot.createActivity({
|
|
121
|
-
type: ActivityType.
|
|
121
|
+
type: ActivityType.Action,
|
|
122
122
|
title: "Connect your account",
|
|
123
123
|
links: [authLink],
|
|
124
124
|
});
|
|
@@ -129,7 +129,7 @@ async activate(_priority: Pick<Priority, "id">) {
|
|
|
129
129
|
|
|
130
130
|
```typescript
|
|
131
131
|
const activity = await this.tools.plot.createActivity({
|
|
132
|
-
type: ActivityType.
|
|
132
|
+
type: ActivityType.Action,
|
|
133
133
|
title: "Setup",
|
|
134
134
|
});
|
|
135
135
|
|
|
@@ -182,7 +182,7 @@ const callbackLink: ActivityLink = {
|
|
|
182
182
|
|
|
183
183
|
// Add to activity
|
|
184
184
|
await this.tools.plot.createActivity({
|
|
185
|
-
type: ActivityType.
|
|
185
|
+
type: ActivityType.Action,
|
|
186
186
|
title: "Task with links",
|
|
187
187
|
links: [urlLink, callbackLink],
|
|
188
188
|
});
|
|
@@ -202,7 +202,7 @@ async activate(_priority: Pick<Priority, "id">) {
|
|
|
202
202
|
|
|
203
203
|
// Create activity with auth link
|
|
204
204
|
const activity = await this.tools.plot.createActivity({
|
|
205
|
-
type: ActivityType.
|
|
205
|
+
type: ActivityType.Action,
|
|
206
206
|
title: "Connect Google account",
|
|
207
207
|
links: [authLink],
|
|
208
208
|
});
|
|
@@ -98,7 +98,7 @@ build(build: ToolBuilder) {
|
|
|
98
98
|
Plot supports three activity types:
|
|
99
99
|
|
|
100
100
|
- **ActivityType.Note**: Information without actionable requirements
|
|
101
|
-
- **ActivityType.
|
|
101
|
+
- **ActivityType.Action**: Actionable items that can be completed
|
|
102
102
|
- **ActivityType.Event**: Scheduled occurrences with start/end times
|
|
103
103
|
|
|
104
104
|
### State Management
|
|
@@ -64,7 +64,7 @@ export interface SyncOptions {
|
|
|
64
64
|
* // Step 1: Request authorization
|
|
65
65
|
* const authLink = await this.googleCalendar.requestAuth("onAuthComplete");
|
|
66
66
|
* await this.plot.createActivity({
|
|
67
|
-
* type: ActivityType.
|
|
67
|
+
* type: ActivityType.Action,
|
|
68
68
|
* title: "Connect Google Calendar",
|
|
69
69
|
* links: [authLink],
|
|
70
70
|
* });
|