@plotday/twister 0.37.0 → 0.39.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.
Files changed (158) hide show
  1. package/README.md +22 -16
  2. package/bin/commands/create.js +4 -4
  3. package/bin/commands/create.js.map +1 -1
  4. package/bin/index.js +1 -1
  5. package/bin/index.js.map +1 -1
  6. package/bin/templates/AGENTS.template.md +32 -0
  7. package/bin/templates/README.template.md +2 -2
  8. package/bin/utils/bundle.js +1 -1
  9. package/bin/utils/bundle.js.map +1 -1
  10. package/cli/templates/AGENTS.template.md +32 -0
  11. package/cli/templates/README.template.md +2 -2
  12. package/dist/{source.d.ts → connector.d.ts} +50 -23
  13. package/dist/connector.d.ts.map +1 -0
  14. package/dist/{source.js → connector.js} +51 -21
  15. package/dist/connector.js.map +1 -0
  16. package/dist/docs/assets/hierarchy.js +1 -1
  17. package/dist/docs/assets/navigation.js +1 -1
  18. package/dist/docs/assets/search.js +1 -1
  19. package/dist/docs/classes/{index.Source.html → index.Connector.html} +40 -24
  20. package/dist/docs/classes/index.Options.html +1 -1
  21. package/dist/docs/classes/tools_ai.AI.html +8 -4
  22. package/dist/docs/classes/tools_callbacks.Callbacks.html +1 -1
  23. package/dist/docs/classes/tools_integrations.Integrations.html +18 -11
  24. package/dist/docs/classes/tools_network.Network.html +1 -1
  25. package/dist/docs/classes/tools_plot.Plot.html +31 -22
  26. package/dist/docs/classes/tools_store.Store.html +1 -1
  27. package/dist/docs/classes/tools_tasks.Tasks.html +1 -1
  28. package/dist/docs/classes/tools_twists.Twists.html +4 -4
  29. package/dist/docs/classes/twist.Twist.html +1 -1
  30. package/dist/docs/documents/Building_Connectors.html +137 -0
  31. package/dist/docs/documents/Built-in_Tools.html +3 -3
  32. package/dist/docs/documents/Core_Concepts.html +5 -5
  33. package/dist/docs/documents/Getting_Started.html +1 -1
  34. package/dist/docs/enums/plot.ActionType.html +3 -1
  35. package/dist/docs/enums/plot.ActorType.html +4 -4
  36. package/dist/docs/enums/plot.ConferencingProvider.html +6 -6
  37. package/dist/docs/enums/tools_ai.AIModel.html +2 -2
  38. package/dist/docs/enums/tools_integrations.AuthProvider.html +11 -11
  39. package/dist/docs/hierarchy.html +1 -1
  40. package/dist/docs/index.html +3 -3
  41. package/dist/docs/interfaces/tools_ai.AIRequest.html +11 -11
  42. package/dist/docs/interfaces/tools_ai.AIResponse.html +9 -9
  43. package/dist/docs/interfaces/tools_ai.FilePart.html +5 -5
  44. package/dist/docs/interfaces/tools_ai.ImagePart.html +4 -4
  45. package/dist/docs/interfaces/tools_ai.ReasoningPart.html +4 -4
  46. package/dist/docs/interfaces/tools_ai.RedactedReasoningPart.html +3 -3
  47. package/dist/docs/interfaces/tools_ai.TextPart.html +3 -3
  48. package/dist/docs/interfaces/tools_ai.ToolCallPart.html +5 -5
  49. package/dist/docs/interfaces/tools_ai.ToolExecutionOptions.html +4 -4
  50. package/dist/docs/interfaces/tools_ai.ToolResultPart.html +5 -5
  51. package/dist/docs/media/AGENTS.md +82 -65
  52. package/dist/docs/media/MULTI_USER_AUTH.md +1 -1
  53. package/dist/docs/media/SYNC_STRATEGIES.md +9 -9
  54. package/dist/docs/modules/index.html +1 -1
  55. package/dist/docs/modules/tools_ai.html +1 -1
  56. package/dist/docs/modules/tools_plot.html +1 -1
  57. package/dist/docs/modules.html +1 -1
  58. package/dist/docs/types/plot.Action.html +4 -2
  59. package/dist/docs/types/plot.Actor.html +5 -5
  60. package/dist/docs/types/plot.ContentType.html +1 -1
  61. package/dist/docs/types/plot.Link.html +15 -15
  62. package/dist/docs/types/plot.NewActor.html +1 -1
  63. package/dist/docs/types/plot.NewContact.html +5 -5
  64. package/dist/docs/types/plot.NewLink.html +1 -1
  65. package/dist/docs/types/plot.NewLinkWithNotes.html +1 -1
  66. package/dist/docs/types/plot.NewNote.html +1 -1
  67. package/dist/docs/types/plot.NewTags.html +1 -1
  68. package/dist/docs/types/plot.NewThread.html +1 -1
  69. package/dist/docs/types/plot.NewThreadWithNotes.html +1 -1
  70. package/dist/docs/types/plot.Note.html +1 -1
  71. package/dist/docs/types/plot.NoteUpdate.html +1 -1
  72. package/dist/docs/types/plot.PickPriorityConfig.html +2 -2
  73. package/dist/docs/types/plot.Tags.html +1 -1
  74. package/dist/docs/types/plot.Thread.html +1 -1
  75. package/dist/docs/types/plot.ThreadCommon.html +7 -7
  76. package/dist/docs/types/plot.ThreadFilter.html +2 -2
  77. package/dist/docs/types/plot.ThreadMeta.html +1 -1
  78. package/dist/docs/types/plot.ThreadUpdate.html +1 -1
  79. package/dist/docs/types/plot.ThreadWithNotes.html +1 -1
  80. package/dist/docs/types/tools_ai.AIAssistantMessage.html +2 -2
  81. package/dist/docs/types/tools_ai.AICapabilities.html +6 -0
  82. package/dist/docs/types/tools_ai.AIMessage.html +1 -1
  83. package/dist/docs/types/tools_ai.AIOptions.html +4 -0
  84. package/dist/docs/types/tools_ai.AISource.html +1 -1
  85. package/dist/docs/types/tools_ai.AISystemMessage.html +2 -2
  86. package/dist/docs/types/tools_ai.AITool.html +1 -1
  87. package/dist/docs/types/tools_ai.AIToolMessage.html +2 -2
  88. package/dist/docs/types/tools_ai.AIToolSet.html +1 -1
  89. package/dist/docs/types/tools_ai.AIUsage.html +5 -5
  90. package/dist/docs/types/tools_ai.AIUserMessage.html +2 -2
  91. package/dist/docs/types/tools_ai.DataContent.html +1 -1
  92. package/dist/docs/types/tools_ai.ModelPreferences.html +4 -4
  93. package/dist/docs/types/tools_integrations.ArchiveLinkFilter.html +5 -5
  94. package/dist/docs/types/tools_integrations.AuthToken.html +4 -4
  95. package/dist/docs/types/tools_integrations.Authorization.html +4 -4
  96. package/dist/docs/types/tools_integrations.LinkTypeConfig.html +1 -1
  97. package/dist/docs/types/tools_plot.LinkSearchResult.html +1 -0
  98. package/dist/docs/types/tools_plot.NoteSearchResult.html +1 -0
  99. package/dist/docs/types/tools_plot.SearchOptions.html +7 -0
  100. package/dist/docs/types/tools_plot.SearchResult.html +1 -0
  101. package/dist/docs/variables/tools_plot.SEARCH_DEFAULT_LIMIT.html +2 -0
  102. package/dist/docs/variables/tools_plot.SEARCH_MAX_LIMIT.html +2 -0
  103. package/dist/index.d.ts +1 -1
  104. package/dist/index.d.ts.map +1 -1
  105. package/dist/index.js +1 -1
  106. package/dist/index.js.map +1 -1
  107. package/dist/llm-docs/connector.d.ts +9 -0
  108. package/dist/llm-docs/connector.d.ts.map +1 -0
  109. package/dist/llm-docs/connector.js +8 -0
  110. package/dist/llm-docs/connector.js.map +1 -0
  111. package/dist/llm-docs/index.js +2 -2
  112. package/dist/llm-docs/index.js.map +1 -1
  113. package/dist/llm-docs/plot.d.ts +1 -1
  114. package/dist/llm-docs/plot.d.ts.map +1 -1
  115. package/dist/llm-docs/plot.js +1 -1
  116. package/dist/llm-docs/plot.js.map +1 -1
  117. package/dist/llm-docs/tools/ai.d.ts +1 -1
  118. package/dist/llm-docs/tools/ai.d.ts.map +1 -1
  119. package/dist/llm-docs/tools/ai.js +1 -1
  120. package/dist/llm-docs/tools/ai.js.map +1 -1
  121. package/dist/llm-docs/tools/integrations.d.ts +1 -1
  122. package/dist/llm-docs/tools/integrations.d.ts.map +1 -1
  123. package/dist/llm-docs/tools/integrations.js +1 -1
  124. package/dist/llm-docs/tools/integrations.js.map +1 -1
  125. package/dist/llm-docs/tools/plot.d.ts +1 -1
  126. package/dist/llm-docs/tools/plot.d.ts.map +1 -1
  127. package/dist/llm-docs/tools/plot.js +1 -1
  128. package/dist/llm-docs/tools/plot.js.map +1 -1
  129. package/dist/llm-docs/twist-guide-template.d.ts +1 -1
  130. package/dist/llm-docs/twist-guide-template.d.ts.map +1 -1
  131. package/dist/llm-docs/twist-guide-template.js +1 -1
  132. package/dist/llm-docs/twist-guide-template.js.map +1 -1
  133. package/dist/plot.d.ts +10 -1
  134. package/dist/plot.d.ts.map +1 -1
  135. package/dist/plot.js +2 -0
  136. package/dist/plot.js.map +1 -1
  137. package/dist/tools/ai.d.ts +18 -0
  138. package/dist/tools/ai.d.ts.map +1 -1
  139. package/dist/tools/ai.js.map +1 -1
  140. package/dist/tools/integrations.d.ts +22 -10
  141. package/dist/tools/integrations.d.ts.map +1 -1
  142. package/dist/tools/integrations.js +3 -3
  143. package/dist/tools/integrations.js.map +1 -1
  144. package/dist/tools/plot.d.ts +53 -0
  145. package/dist/tools/plot.d.ts.map +1 -1
  146. package/dist/tools/plot.js +4 -0
  147. package/dist/tools/plot.js.map +1 -1
  148. package/dist/twist-guide.d.ts +1 -1
  149. package/dist/twist-guide.d.ts.map +1 -1
  150. package/package.json +38 -38
  151. package/tsconfig.base.json +1 -1
  152. package/dist/docs/documents/Building_Sources.html +0 -137
  153. package/dist/llm-docs/source.d.ts +0 -9
  154. package/dist/llm-docs/source.d.ts.map +0 -1
  155. package/dist/llm-docs/source.js +0 -8
  156. package/dist/llm-docs/source.js.map +0 -1
  157. package/dist/source.d.ts.map +0 -1
  158. package/dist/source.js.map +0 -1
package/dist/docs/classes/tools_network.Network.html CHANGED
@@ -27,7 +27,7 @@ all outbound HTTP requests (fetch, etc.) will be blocked.</p>
27
27
  </div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-1">Example<a href="#example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="typescript"><span class="hl-4">class</span><span class="hl-1"> </span><span class="hl-5">CalendarTool</span><span class="hl-1"> </span><span class="hl-4">extends</span><span class="hl-1"> </span><span class="hl-5">Tool</span><span class="hl-1">&lt;</span><span class="hl-5">CalendarTool</span><span class="hl-1">&gt; {</span><br/><span class="hl-1"> </span><span class="hl-6">build</span><span class="hl-1">(</span><span class="hl-2">build</span><span class="hl-1">: </span><span class="hl-5">ToolBuilder</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">return</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">network:</span><span class="hl-1"> </span><span class="hl-6">build</span><span class="hl-1">(</span><span class="hl-2">Network</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-2">urls:</span><span class="hl-1"> [</span><span class="hl-3">&#39;https://www.googleapis.com/calendar/*&#39;</span><span class="hl-1">]</span><br/><span class="hl-1"> })</span><br/><span class="hl-1"> };</span><br/><span class="hl-1"> }</span><br/><br/><span class="hl-1"> </span><span class="hl-4">async</span><span class="hl-1"> </span><span class="hl-6">setupCalendarWebhook</span><span class="hl-1">(</span><span class="hl-2">calendarId</span><span class="hl-1">: </span><span class="hl-5">string</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-7">// Create webhook URL that will call onCalendarEvent</span><br/><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-8">webhookUrl</span><span class="hl-1"> = </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-4">this</span><span class="hl-1">.</span><span class="hl-2">tools</span><span class="hl-1">.</span><span class="hl-2">network</span><span class="hl-1">.</span><span class="hl-6">createWebhook</span><span class="hl-1">(</span><br/><span class="hl-1"> {},</span><br/><span class="hl-1"> </span><span class="hl-4">this</span><span class="hl-1">.</span><span class="hl-2">onCalendarEvent</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">calendarId</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-3">&quot;google&quot;</span><br/><span class="hl-1"> );</span><br/><br/><span class="hl-1"> </span><span class="hl-7">// Register webhook with Google Calendar API</span><br/><span class="hl-1"> </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-4">this</span><span class="hl-1">.</span><span class="hl-6">registerWithGoogleCalendar</span><span class="hl-1">(</span><span class="hl-2">calendarId</span><span class="hl-1">, </span><span class="hl-2">webhookUrl</span><span class="hl-1">);</span><br/><br/><span class="hl-1"> </span><span class="hl-0">return</span><span class="hl-1"> </span><span class="hl-2">webhookUrl</span><span class="hl-1">;</span><br/><span class="hl-1"> }</span><br/><br/><span class="hl-1"> </span><span class="hl-4">async</span><span class="hl-1"> </span><span class="hl-6">onCalendarEvent</span><span class="hl-1">(</span><span class="hl-2">request</span><span class="hl-1">: </span><span class="hl-5">WebhookRequest</span><span class="hl-1">, </span><span class="hl-2">calendarId</span><span class="hl-1">: </span><span class="hl-5">string</span><span class="hl-1">, </span><span class="hl-2">provider</span><span class="hl-1">: </span><span class="hl-5">string</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-6">log</span><span class="hl-1">(</span><span class="hl-3">&quot;Calendar event received:&quot;</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-2">method:</span><span class="hl-1"> </span><span class="hl-2">request</span><span class="hl-1">.</span><span class="hl-2">method</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">calendarId</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">provider</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">body:</span><span class="hl-1"> </span><span class="hl-2">request</span><span class="hl-1">.</span><span class="hl-2">body</span><br/><span class="hl-1"> });</span><br/><br/><span class="hl-1"> </span><span class="hl-7">// Process the calendar event change</span><br/><span class="hl-1"> </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-4">this</span><span class="hl-1">.</span><span class="hl-6">processCalendarChange</span><span class="hl-1">(</span><span class="hl-2">request</span><span class="hl-1">.</span><span class="hl-2">body</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><br/><span class="hl-1"> </span><span class="hl-4">async</span><span class="hl-1"> </span><span class="hl-6">cleanup</span><span class="hl-1">(</span><span class="hl-2">webhookUrl</span><span class="hl-1">: </span><span class="hl-5">string</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-4">this</span><span class="hl-1">.</span><span class="hl-2">tools</span><span class="hl-1">.</span><span class="hl-2">network</span><span class="hl-1">.</span><span class="hl-6">deleteWebhook</span><span class="hl-1">(</span><span class="hl-2">webhookUrl</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
28
28
  </code><button type="button">Copy</button></pre>
29
29
 
30
- </div></div></section><section class="tsd-panel tsd-hierarchy" data-refl="832"><h4>Hierarchy (<a href="../hierarchy.html#tools/network.Network">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="tool.ITool.html" class="tsd-signature-type tsd-kind-class">ITool</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">Network</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/plotday/plot/blob/main/twist/twister/src/tools/network.ts#L119">tools/network.ts:119</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
30
+ </div></div></section><section class="tsd-panel tsd-hierarchy" data-refl="853"><h4>Hierarchy (<a href="../hierarchy.html#tools/network.Network">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="tool.ITool.html" class="tsd-signature-type tsd-kind-class">ITool</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">Network</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/plotday/plot/blob/main/twist/twister/src/tools/network.ts#L119">tools/network.ts:119</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
31
31
  </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#createwebhook" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Webhook</span></a>
32
32
  <a href="#deletewebhook" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Webhook</span></a>
33
33
  </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#options" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Options</span></a>