@loopstack/accessing-tool-results-example-workflow 0.18.0 → 0.19.0-rc.0

package/README.md

@@ -19,73 +19,39 @@ This example is useful for developers learning to build data-driven workflows th
 
 ## Installation
 
-### Prerequisites
+You can add this module using the `loopstack` cli or via `npm`.
 
-Create a new Loopstack project if you haven't already:
+### a) Add Sources via `loopstack add` (recommended)
 
 ```bash
-npx create-loopstack-app my-project
-cd my-project
+loopstack add @loopstack/accessing-tool-results-example-workflow
 ```
 
-Start Environment
+This command copies the source files into your `src` directory.
 
-```bash
-cd my-project
-docker compose up -d
-```
+- It is a great way to explore the code to learn new concepts or add own customizations
+- It will set up the module for you, so you do not need to manually update your application
 
-### Add the Module
+### b) Install via `npm install`
 
 ```bash
-loopstack add @loopstack/accessing-tool-results-example-workflow
+npm install --save @loopstack/accessing-tool-results-example-workflow
 ```
 
-This copies the source files into your `src` directory.
+Use npm install if you want to use and maintain the module as node dependency.
 
-> Using the `loopstack add` command is a great way to explore the code to learn new concepts or add own customizations.
+- Use this, if you do not need to make changes to the code or want to review the source code.
 
 ## Setup
 
-### 1. Import the Module
+### 1. Manual setup (optional)
 
-Add `AccessingToolResultsExampleModule` to your `default.module.ts` (included in the skeleton app) or to your own module:
+> This step is automatically done for you when using the `loopstack add` command.
 
-```typescript
-import { Module } from '@nestjs/common';
-import { LoopCoreModule } from '@loopstack/core';
-import { CoreUiModule } from '@loopstack/core-ui-module';
-import { AccessingToolResultsExampleModule } from './accessing-tool-results-example-workflow';
-import { DefaultWorkspace } from './default.workspace';
-
-@Module({
-  imports: [LoopCoreModule, CoreUiModule, AccessingToolResultsExampleModule],
-  providers: [DefaultWorkspace],
-})
-export class DefaultModule {}
-```
+- Add `AccessingToolResultsExampleModule` to the imports of `default.module.ts` or any other custom module.
+- Inject the `WorkflowToolResultsWorkflow` workflow to your workspace class using the `@InjectWorkflow()` decorator.
 
-### 2. Register in Your Workspace
-
-Add the workflow to your workspace class using the `@Workflow()` decorator:
-
-```typescript
-import { Injectable } from '@nestjs/common';
-import { BlockConfig, Workflow } from '@loopstack/common';
-import { WorkspaceBase } from '@loopstack/core';
-import { WorkflowToolResultsWorkflow } from './accessing-tool-results-example-workflow';
-
-@Injectable()
-@BlockConfig({
-  config: {
-    title: 'My Workspace',
-    description: 'A workspace with the tool results example workflow',
-  },
-})
-export class MyWorkspace extends WorkspaceBase {
-  @Workflow() workflowToolResults: WorkflowToolResultsWorkflow;
-}
-```
+See here for more information about working with [Modules](https://loopstack.ai/docs/building-with-loopstack/creating-a-module) and [Workspaces](https://loopstack.ai/docs/building-with-loopstack/creating-workspaces)
 
 ## How It Works
 
@@ -132,7 +98,7 @@ Tool results persist and can be accessed from subsequent transitions using the s
 Define custom helper functions in your workflow class for complex data extraction:
 
 ```typescript
-@Helper()
+@DefineHelper()
 extractMessage(metadata: WorkflowMetadataInterface): string {
   return metadata.tools.create_some_data.say_hello.data;
 }

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 export * from './workflow-tool-results.workflow';
 export * from './tool-results-example.module';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kCAAkC,CAAC;AACjD,cAAc,+BAA+B,CAAC"}

package/dist/tool-results-example.module.d.ts

@@ -1,2 +1,3 @@
 export declare class ToolResultsExampleModule {
 }
+//# sourceMappingURL=tool-results-example.module.d.ts.map

package/dist/tool-results-example.module.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tool-results-example.module.d.ts","sourceRoot":"","sources":["../src/tool-results-example.module.ts"],"names":[],"mappings":"AAMA,qBAKa,wBAAwB;CAAG"}

package/dist/tool-results-example.module.js

@@ -8,7 +8,6 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ToolResultsExampleModule = void 0;
 const common_1 = require("@nestjs/common");
-const core_1 = require("@loopstack/core");
 const core_ui_module_1 = require("@loopstack/core-ui-module");
 const create_chat_message_tool_1 = require("@loopstack/create-chat-message-tool");
 const create_value_tool_1 = require("@loopstack/create-value-tool");
@@ -18,7 +17,7 @@ let ToolResultsExampleModule = class ToolResultsExampleModule {
 exports.ToolResultsExampleModule = ToolResultsExampleModule;
 exports.ToolResultsExampleModule = ToolResultsExampleModule = __decorate([
     (0, common_1.Module)({
-        imports: [core_1.LoopCoreModule, core_ui_module_1.CoreUiModule, create_value_tool_1.CreateValueToolModule, create_chat_message_tool_1.CreateChatMessageToolModule],
+        imports: [core_ui_module_1.CoreUiModule, create_value_tool_1.CreateValueToolModule, create_chat_message_tool_1.CreateChatMessageToolModule],
         providers: [workflow_tool_results_workflow_1.WorkflowToolResultsWorkflow],
         exports: [workflow_tool_results_workflow_1.WorkflowToolResultsWorkflow],
     })

package/dist/tool-results-example.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"tool-results-example.module.js","sourceRoot":"","sources":["../src/tool-results-example.module.ts"],"names":[],"mappings":";;;;;;;;;AAeA,2CAAwC;AACxC,0CAAiD;AACjD,8DAAyD;AACzD,kFAAkF;AAClF,oEAAqE;AACrE,qFAA+E;AAOxE,IAAM,wBAAwB,GAA9B,MAAM,wBAAwB;CAAG,CAAA;AAA3B,4DAAwB;mCAAxB,wBAAwB;IALpC,IAAA,eAAM,EAAC;QACN,OAAO,EAAE,CAAC,qBAAc,EAAE,6BAAY,EAAE,yCAAqB,EAAE,sDAA2B,CAAC;QAC3F,SAAS,EAAE,CAAC,4DAA2B,CAAC;QACxC,OAAO,EAAE,CAAC,4DAA2B,CAAC;KACvC,CAAC;GACW,wBAAwB,CAAG"}
+{"version":3,"file":"tool-results-example.module.js","sourceRoot":"","sources":["../src/tool-results-example.module.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2CAAwC;AACxC,8DAAyD;AACzD,kFAAkF;AAClF,oEAAqE;AACrE,qFAA+E;AAOxE,IAAM,wBAAwB,GAA9B,MAAM,wBAAwB;CAAG,CAAA;AAA3B,4DAAwB;mCAAxB,wBAAwB;IALpC,IAAA,eAAM,EAAC;QACN,OAAO,EAAE,CAAC,6BAAY,EAAE,yCAAqB,EAAE,sDAA2B,CAAC;QAC3E,SAAS,EAAE,CAAC,4DAA2B,CAAC;QACxC,OAAO,EAAE,CAAC,4DAA2B,CAAC;KACvC,CAAC;GACW,wBAAwB,CAAG"}

package/dist/workflow-tool-results.workflow.d.ts

@@ -1,7 +1,7 @@
-import { WorkflowBase } from '@loopstack/core';
-import { WorkflowMetadataInterface } from '@loopstack/core/dist/workflow-processor/interfaces/workflow-metadata.interface';
-export declare class WorkflowToolResultsWorkflow extends WorkflowBase {
+import { WorkflowMetadataInterface } from '@loopstack/common';
+export declare class WorkflowToolResultsWorkflow {
     private createValue;
     private createChatMessage;
     extractMessage(metadata: WorkflowMetadataInterface): string;
 }
+//# sourceMappingURL=workflow-tool-results.workflow.d.ts.map

package/dist/workflow-tool-results.workflow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow-tool-results.workflow.d.ts","sourceRoot":"","sources":["../src/workflow-tool-results.workflow.ts"],"names":[],"mappings":"AACA,OAAO,EAAsC,yBAAyB,EAAE,MAAM,mBAAmB,CAAC;AAYlG,qBAIa,2BAA2B;IACxB,OAAO,CAAC,WAAW,CAAc;IACjC,OAAO,CAAC,iBAAiB,CAAoB;IAG3D,cAAc,CAAC,QAAQ,EAAE,yBAAyB,GAAG,MAAM;CAI5D"}

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

@@ -12,10 +12,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.WorkflowToolResultsWorkflow = void 0;
 const common_1 = require("@nestjs/common");
 const common_2 = require("@loopstack/common");
-const core_1 = require("@loopstack/core");
 const create_chat_message_tool_1 = require("@loopstack/create-chat-message-tool");
 const create_value_tool_1 = require("@loopstack/create-value-tool");
-let WorkflowToolResultsWorkflow = class WorkflowToolResultsWorkflow extends core_1.WorkflowBase {
+let WorkflowToolResultsWorkflow = class WorkflowToolResultsWorkflow {
     createValue;
     createChatMessage;
     extractMessage(metadata) {
@@ -25,22 +24,22 @@ let WorkflowToolResultsWorkflow = class WorkflowToolResultsWorkflow extends core
 };
 exports.WorkflowToolResultsWorkflow = WorkflowToolResultsWorkflow;
 __decorate([
-    (0, common_2.Tool)(),
+    (0, common_2.InjectTool)(),
     __metadata("design:type", create_value_tool_1.CreateValue)
 ], WorkflowToolResultsWorkflow.prototype, "createValue", void 0);
 __decorate([
-    (0, common_2.Tool)(),
+    (0, common_2.InjectTool)(),
     __metadata("design:type", create_chat_message_tool_1.CreateChatMessage)
 ], WorkflowToolResultsWorkflow.prototype, "createChatMessage", void 0);
 __decorate([
-    (0, common_2.Helper)(),
+    (0, common_2.DefineHelper)(),
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [Object]),
     __metadata("design:returntype", String)
 ], WorkflowToolResultsWorkflow.prototype, "extractMessage", null);
 exports.WorkflowToolResultsWorkflow = WorkflowToolResultsWorkflow = __decorate([
     (0, common_1.Injectable)(),
-    (0, common_2.BlockConfig)({
+    (0, common_2.Workflow)({
         configFile: __dirname + '/workflow-tool-results.workflow.yaml',
     })
 ], WorkflowToolResultsWorkflow);

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,2CAA4C;AAC5C,8CAA8D;AAC9D,0CAA+C;AAE/C,kFAAwE;AACxE,oEAA2D;AAcpD,IAAM,2BAA2B,GAAjC,MAAM,2BAA4B,SAAQ,mBAAY;IAC3C,WAAW,CAAc;IACzB,iBAAiB,CAAoB;IAGrD,cAAc,CAAC,QAAmC;QAChD,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAyC,CAAC;QACjE,OAAO,KAAK,CAAC,gBAAgB,CAAC,SAAS,CAAC,IAAI,CAAC;IAC/C,CAAC;CACF,CAAA;AATY,kEAA2B;AACtB;IAAf,IAAA,aAAI,GAAE;8BAAsB,+BAAW;gEAAC;AACzB;IAAf,IAAA,aAAI,GAAE;8BAA4B,4CAAiB;sEAAC;AAGrD;IADC,IAAA,eAAM,GAAE;;;;iEAIR;sCARU,2BAA2B;IAJvC,IAAA,mBAAU,GAAE;IACZ,IAAA,oBAAW,EAAC;QACX,UAAU,EAAE,SAAS,GAAG,sCAAsC;KAC/D,CAAC;GACW,2BAA2B,CASvC"}
+{"version":3,"file":"workflow-tool-results.workflow.js","sourceRoot":"","sources":["../src/workflow-tool-results.workflow.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA4C;AAC5C,8CAAkG;AAClG,kFAAwE;AACxE,oEAA2D;AAcpD,IAAM,2BAA2B,GAAjC,MAAM,2BAA2B;IAChB,WAAW,CAAc;IACzB,iBAAiB,CAAoB;IAG3D,cAAc,CAAC,QAAmC;QAChD,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAyC,CAAC;QACjE,OAAO,KAAK,CAAC,gBAAgB,CAAC,SAAS,CAAC,IAAI,CAAC;IAC/C,CAAC;CACF,CAAA;AATY,kEAA2B;AAChB;IAArB,IAAA,mBAAU,GAAE;8BAAsB,+BAAW;gEAAC;AACzB;IAArB,IAAA,mBAAU,GAAE;8BAA4B,4CAAiB;sEAAC;AAG3D;IADC,IAAA,qBAAY,GAAE;;;;iEAId;sCARU,2BAA2B;IAJvC,IAAA,mBAAU,GAAE;IACZ,IAAA,iBAAQ,EAAC;QACR,UAAU,EAAE,SAAS,GAAG,sCAAsC;KAC/D,CAAC;GACW,2BAA2B,CASvC"}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@loopstack/accessing-tool-results-example-workflow",
   "displayName": "Loopstack Tool Results Example",
   "description": "A simple workflow showing different methods of how to access tool results in a subsequent workflow step.",
-  "version": "0.18.0",
+  "version": "0.19.0-rc.0",
   "author": {
     "name": "Jakob Klippel",
     "url": "https://www.linkedin.com/in/jakob-klippel/"
@@ -31,11 +31,10 @@
     "watch": "nest build --watch"
   },
   "dependencies": {
-    "@loopstack/common": "^0.18.0",
-    "@loopstack/core": "^0.18.0",
-    "@loopstack/core-ui-module": "^0.18.0",
-    "@loopstack/create-chat-message-tool": "^0.18.0",
-    "@loopstack/create-value-tool": "^0.18.0",
+    "@loopstack/common": "^0.19.0-rc.0",
+    "@loopstack/core-ui-module": "^0.19.0-rc.0",
+    "@loopstack/create-chat-message-tool": "^0.19.0-rc.0",
+    "@loopstack/create-value-tool": "^0.19.0-rc.0",
     "@nestjs/common": "^11.1.12",
     "zod": "^4.3.5"
   },

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

@@ -1,5 +1,6 @@
 import { TestingModule } from '@nestjs/testing';
-import { BlockExecutionContextDto, LoopCoreModule, WorkflowProcessorService } from '@loopstack/core';
+import { BlockExecutionContextDto, getBlockHelpers } from '@loopstack/common';
+import { WorkflowProcessorService } from '@loopstack/core';
 import { CoreUiModule } from '@loopstack/core-ui-module';
 import { CreateChatMessage, CreateChatMessageToolModule } from '@loopstack/create-chat-message-tool';
 import { CreateValue, CreateValueToolModule } from '@loopstack/create-value-tool';
@@ -17,7 +18,7 @@ describe('WorkflowToolResultsWorkflow', () => {
   beforeEach(async () => {
     module = await createWorkflowTest()
       .forWorkflow(WorkflowToolResultsWorkflow)
-      .withImports(LoopCoreModule, CoreUiModule, CreateValueToolModule, CreateChatMessageToolModule)
+      .withImports(CoreUiModule, CreateValueToolModule, CreateChatMessageToolModule)
       .withToolOverride(CreateValue)
       .withToolOverride(CreateChatMessage)
       .compile();
@@ -38,7 +39,7 @@ describe('WorkflowToolResultsWorkflow', () => {
   });
 
   it('should have extractMessage helper', () => {
-    expect(workflow.helpers).toContain('extractMessage');
+    expect(getBlockHelpers(workflow)).toContain('extractMessage');
   });
 
   describe('tool result access', () => {
@@ -84,7 +85,7 @@ describe('WorkflowToolResultsWorkflow', () => {
       const result = await processor.process(workflow, {}, context);
 
       // Should complete both transitions
-      const history = result.state.caretaker.getHistory();
+      const history = result.state.getHistory();
       expect(history.some((h) => h.metadata.transition?.transition === 'create_some_data')).toBe(true);
       expect(history.some((h) => h.metadata.transition?.transition === 'access_data')).toBe(true);
 

package/src/tool-results-example.module.ts

@@ -1,27 +1,11 @@
-/*
-Copyright 2025 Jakob Klippel.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-*/
 import { Module } from '@nestjs/common';
-import { LoopCoreModule } from '@loopstack/core';
 import { CoreUiModule } from '@loopstack/core-ui-module';
 import { CreateChatMessageToolModule } from '@loopstack/create-chat-message-tool';
 import { CreateValueToolModule } from '@loopstack/create-value-tool';
 import { WorkflowToolResultsWorkflow } from './workflow-tool-results.workflow';
 
 @Module({
-  imports: [LoopCoreModule, CoreUiModule, CreateValueToolModule, CreateChatMessageToolModule],
+  imports: [CoreUiModule, CreateValueToolModule, CreateChatMessageToolModule],
   providers: [WorkflowToolResultsWorkflow],
   exports: [WorkflowToolResultsWorkflow],
 })

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

@@ -1,7 +1,5 @@
 import { Injectable } from '@nestjs/common';
-import { BlockConfig, Helper, Tool } from '@loopstack/common';
-import { WorkflowBase } from '@loopstack/core';
-import { WorkflowMetadataInterface } from '@loopstack/core/dist/workflow-processor/interfaces/workflow-metadata.interface';
+import { DefineHelper, InjectTool, Workflow, WorkflowMetadataInterface } from '@loopstack/common';
 import { CreateChatMessage } from '@loopstack/create-chat-message-tool';
 import { CreateValue } from '@loopstack/create-value-tool';
 
@@ -14,14 +12,14 @@ interface WorkflowToolsMetadata {
 }
 
 @Injectable()
-@BlockConfig({
+@Workflow({
   configFile: __dirname + '/workflow-tool-results.workflow.yaml',
 })
-export class WorkflowToolResultsWorkflow extends WorkflowBase {
-  @Tool() private createValue: CreateValue;
-  @Tool() private createChatMessage: CreateChatMessage;
+export class WorkflowToolResultsWorkflow {
+  @InjectTool() private createValue: CreateValue;
+  @InjectTool() private createChatMessage: CreateChatMessage;
 
-  @Helper()
+  @DefineHelper()
   extractMessage(metadata: WorkflowMetadataInterface): string {
     const tools = metadata.tools as unknown as WorkflowToolsMetadata;
     return tools.create_some_data.say_hello.data;