@loopstack/accessing-tool-results-example-workflow 0.23.0 → 0.23.2

package/README.md

@@ -1,3 +1,8 @@
+---
+title: Accessing Tool Results Example
+description: Example workflow showing how to store and access data across workflow transitions using typed workflow state
+---
+
 # @loopstack/accessing-tool-results-example-workflow
 
 > A module for the [Loopstack AI](https://loopstack.ai) automation framework.
@@ -19,7 +24,28 @@ This example is useful for developers learning to build data-driven workflows th
 
 ## Installation
 
-See [SETUP.md](./SETUP.md) for installation and setup instructions.
+```bash
+npm install @loopstack/accessing-tool-results-example-workflow
+```
+
+Then register the module in your app:
+
+```typescript
+import {
+  ToolResultsExampleModule,
+  WorkflowToolResultsWorkflow,
+} from '@loopstack/accessing-tool-results-example-workflow';
+import { StudioApp } from '@loopstack/common';
+
+@StudioApp({
+  title: 'Tool Results Example',
+  workflows: [WorkflowToolResultsWorkflow],
+})
+@Module({
+  imports: [ToolResultsExampleModule],
+})
+export class MyAppModule {}
+```
 
 ## How It Works
 
@@ -57,7 +83,7 @@ async createSomeData(
 ): Promise<ToolResultsState> {
   await this.documentStore.save(MessageDocument, {
     role: 'assistant',
-    content: `Stored in initial transition: Hello World.`,
+    text: `Stored in initial transition: Hello World.`,
   });
   return { ...state, storedMessage: 'Hello World.' };
 }
@@ -74,7 +100,7 @@ In a subsequent transition, read values from the `state` parameter:
 async accessData(ctx: WorkflowContext, state: ToolResultsState): Promise<unknown> {
   await this.documentStore.save(MessageDocument, {
     role: 'assistant',
-    content: `Accessed from previous transition: ${state.storedMessage}`,
+    text: `Accessed from previous transition: ${state.storedMessage}`,
   });
   return {};
 }
@@ -107,7 +133,7 @@ export class WorkflowToolResultsWorkflow extends BaseWorkflow<Record<string, unk
   ): Promise<ToolResultsState> {
     await this.documentStore.save(MessageDocument, {
       role: 'assistant',
-      content: `Stored in initial transition: Hello World.`,
+      text: `Stored in initial transition: Hello World.`,
     });
     return { ...state, storedMessage: 'Hello World.' };
   }
@@ -116,7 +142,7 @@ export class WorkflowToolResultsWorkflow extends BaseWorkflow<Record<string, unk
   async accessData(ctx: WorkflowContext, state: ToolResultsState): Promise<unknown> {
     await this.documentStore.save(MessageDocument, {
       role: 'assistant',
-      content: `Accessed from previous transition: ${state.storedMessage}`,
+      text: `Accessed from previous transition: ${state.storedMessage}`,
     });
     return {};
   }

package/dist/workflow-tool-results.workflow.js

@@ -15,14 +15,14 @@ let WorkflowToolResultsWorkflow = class WorkflowToolResultsWorkflow extends comm
     async createSomeData(state) {
         await this.documentStore.save(common_1.MessageDocument, {
             role: 'assistant',
-            content: `Stored in initial transition: Hello World.`,
+            text: `Stored in initial transition: Hello World.`,
         });
         return { ...state, storedMessage: 'Hello World.' };
     }
     async accessData(state) {
         await this.documentStore.save(common_1.MessageDocument, {
             role: 'assistant',
-            content: `Accessed from previous transition: ${state.storedMessage}`,
+            text: `Accessed from previous transition: ${state.storedMessage}`,
         });
         return {};
     }

package/dist/workflow-tool-results.workflow.js.map

@@ -1 +1 @@
-{"version":3,"file":"workflow-tool-results.workflow.js","sourceRoot":"","sources":["../src/workflow-tool-results.workflow.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,8CAAwF;AASjF,IAAM,2BAA2B,GAAjC,MAAM,2BAA4B,SAAQ,qBAAuD;IAEhG,AAAN,KAAK,CAAC,cAAc,CAAC,KAAuB;QAC1C,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,wBAAe,EAAE;YAC7C,IAAI,EAAE,WAAW;YACjB,OAAO,EAAE,4CAA4C;SACtD,CAAC,CAAC;QACH,OAAO,EAAE,GAAG,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,CAAC;IACrD,CAAC;IAGK,AAAN,KAAK,CAAC,UAAU,CAAC,KAAuB;QACtC,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,wBAAe,EAAE;YAC7C,IAAI,EAAE,WAAW;YACjB,OAAO,EAAE,sCAAsC,KAAK,CAAC,aAAa,EAAE;SACrE,CAAC,CAAC;QACH,OAAO,EAAE,CAAC;IACZ,CAAC;CACF,CAAA;AAlBY,kEAA2B;AAEhC;IADL,IAAA,mBAAU,EAAC,EAAE,EAAE,EAAE,cAAc,EAAE,CAAC;;;;iEAOlC;AAGK;IADL,IAAA,mBAAU,EAAC,EAAE,IAAI,EAAE,cAAc,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC;;;;6DAO/C;sCAjBU,2BAA2B;IAHvC,IAAA,iBAAQ,EAAC;QACR,KAAK,EAAE,sBAAsB;KAC9B,CAAC;GACW,2BAA2B,CAkBvC"}
+{"version":3,"file":"workflow-tool-results.workflow.js","sourceRoot":"","sources":["../src/workflow-tool-results.workflow.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,8CAAwF;AASjF,IAAM,2BAA2B,GAAjC,MAAM,2BAA4B,SAAQ,qBAAuD;IAEhG,AAAN,KAAK,CAAC,cAAc,CAAC,KAAuB;QAC1C,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,wBAAe,EAAE;YAC7C,IAAI,EAAE,WAAW;YACjB,IAAI,EAAE,4CAA4C;SACnD,CAAC,CAAC;QACH,OAAO,EAAE,GAAG,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,CAAC;IACrD,CAAC;IAGK,AAAN,KAAK,CAAC,UAAU,CAAC,KAAuB;QACtC,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,wBAAe,EAAE;YAC7C,IAAI,EAAE,WAAW;YACjB,IAAI,EAAE,sCAAsC,KAAK,CAAC,aAAa,EAAE;SAClE,CAAC,CAAC;QACH,OAAO,EAAE,CAAC;IACZ,CAAC;CACF,CAAA;AAlBY,kEAA2B;AAEhC;IADL,IAAA,mBAAU,EAAC,EAAE,EAAE,EAAE,cAAc,EAAE,CAAC;;;;iEAOlC;AAGK;IADL,IAAA,mBAAU,EAAC,EAAE,IAAI,EAAE,cAAc,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC;;;;6DAO/C;sCAjBU,2BAA2B;IAHvC,IAAA,iBAAQ,EAAC;QACR,KAAK,EAAE,sBAAsB;KAC9B,CAAC;GACW,2BAA2B,CAkBvC"}

package/package.json

@@ -10,7 +10,7 @@
     "tool",
     "workflow"
   ],
-  "version": "0.23.0",
+  "version": "0.23.2",
   "license": "MIT",
   "author": {
     "name": "Jakob Klippel",
@@ -31,7 +31,7 @@
     "watch": "nest build --watch"
   },
   "dependencies": {
-    "@loopstack/common": "^0.32.0",
+    "@loopstack/common": "^0.34.0",
     "@nestjs/common": "^11.1.19",
     "zod": "^4.3.6"
   },

package/src/__tests__/workflow-tool-results.workflow.spec.ts

@@ -37,7 +37,7 @@ describe('WorkflowToolResultsWorkflow', () => {
             documentName: 'message',
             content: expect.objectContaining({
               role: 'assistant',
-              content: 'Stored in initial transition: Hello World.',
+              text: 'Stored in initial transition: Hello World.',
             }),
           }),
         ]),
@@ -56,7 +56,7 @@ describe('WorkflowToolResultsWorkflow', () => {
             documentName: 'message',
             content: expect.objectContaining({
               role: 'assistant',
-              content: 'Accessed from previous transition: Hello World.',
+              text: 'Accessed from previous transition: Hello World.',
             }),
           }),
         ]),

package/src/workflow-tool-results.workflow.ts

@@ -12,7 +12,7 @@ export class WorkflowToolResultsWorkflow extends BaseWorkflow<Record<string, unk
   async createSomeData(state: ToolResultsState): Promise<ToolResultsState> {
     await this.documentStore.save(MessageDocument, {
       role: 'assistant',
-      content: `Stored in initial transition: Hello World.`,
+      text: `Stored in initial transition: Hello World.`,
     });
     return { ...state, storedMessage: 'Hello World.' };
   }
@@ -21,7 +21,7 @@ export class WorkflowToolResultsWorkflow extends BaseWorkflow<Record<string, unk
   async accessData(state: ToolResultsState): Promise<unknown> {
     await this.documentStore.save(MessageDocument, {
       role: 'assistant',
-      content: `Accessed from previous transition: ${state.storedMessage}`,
+      text: `Accessed from previous transition: ${state.storedMessage}`,
     });
     return {};
   }