@loopstack/meeting-notes-example-workflow 0.21.0 → 0.21.2

package/README.md

@@ -2,7 +2,7 @@
 
 > A module for the [Loopstack AI](https://loopstack.ai) automation framework.
 
-This module provides an example workflow demonstrating how to build human-in-the-loop AI workflows with manual triggers and interactive documents.
+This module provides an example workflow demonstrating how to build human-in-the-loop AI workflows with interactive documents and review steps.
 
 ## Overview
 
@@ -10,13 +10,13 @@ The Meeting Notes Example Workflow shows how to create workflows that pause for
 
 By using this workflow as a reference, you'll learn how to:
 
-- Use manual triggers to pause workflows for user input
+- Use `wait: true` transitions to pause workflows for user input
 - Create interactive documents with action buttons
-- Handle transition payloads from user interactions via `runtime.transition.payload`
-- Transform unstructured text into structured data with AI
+- Handle transition payloads from user interactions
+- Transform unstructured text into structured data with AI using `ClaudeGenerateDocument`
 - Build review-and-confirm patterns for AI outputs
-- Use `@State` to manage workflow state with schemas
-- Use `@Input` to define workflow arguments and document content schemas
+- Define workflow input schemas via the `@Workflow` decorator
+- Use the document repository to save and update documents
 
 This example is essential for developers building workflows that require human oversight or approval steps.
 
@@ -30,54 +30,48 @@ See [SETUP.md](./SETUP.md) for installation and setup instructions.
 
 1. **Start** - User provides unstructured meeting notes via the input form
 2. **Wait for Input** - User can edit the notes, then clicks "Optimize Notes"
-3. **AI Processing** - LLM extracts structured information into a formatted document
+3. **AI Processing** - Claude extracts structured information into a formatted document
 4. **Review** - User reviews and can edit the structured output
 5. **Confirm** - User clicks "Confirm" to finalize
 
 ### Key Concepts
 
-#### 1. Workflow Input and State
+#### 1. Workflow Input Schema
 
-Define input parameters with `@Input` and workflow state with `@State`:
+Define input parameters directly in the `@Workflow` decorator with a Zod schema:
 
 ```typescript
-@Input({
+@Workflow({
+  uiConfig: __dirname + '/meeting-notes.ui.yaml',
   schema: z.object({
     inputText: z
       .string()
       .default(
-        '- meeting 1.1.2025\n- budget: need 2 cut costs sarah said\n...',
+        '- meeting 1.1.2025\n- budget: need 2 cut costs sarah said\n- hire new person?? --> marketing\n- vendor pricing - follow up needed by anna',
       ),
   }),
 })
-args: {
-  inputText: string;
-};
+export class MeetingNotesWorkflow extends BaseWorkflow<{ inputText: string }> {
+  @InjectTool() claudeGenerateDocument: ClaudeGenerateDocument;
 
-@State({
-  schema: z.object({
-    meetingNotes: MeetingNotesDocumentSchema.optional(),
-    optimizedNotes: OptimizedMeetingNotesDocumentSchema.optional(),
-  }),
-})
-state: {
   meetingNotes?: z.infer<typeof MeetingNotesDocumentSchema>;
   optimizedNotes?: z.infer<typeof OptimizedMeetingNotesDocumentSchema>;
-};
+}
 ```
 
-#### 2. Manual Triggers
+#### 2. Waiting Transitions
 
-Use `trigger: manual` to pause the workflow and wait for user interaction:
+Use `wait: true` with a `schema` to pause the workflow and wait for user interaction. The schema validates the payload submitted by the user:
 
-```yaml
-- id: user_response
-  from: waiting_for_response
-  to: response_received
-  trigger: manual
+```typescript
+@Transition({ from: 'waiting_for_response', to: 'response_received', wait: true, schema: MeetingNotesDocumentSchema })
+async userResponse(payload: z.infer<typeof MeetingNotesDocumentSchema>) {
+  const result = await this.repository.save(MeetingNotesDocument, payload, { id: 'input' });
+  this.meetingNotes = result.content as z.infer<typeof MeetingNotesDocumentSchema>;
+}
 ```
 
-The workflow pauses at `waiting_for_response` until the user triggers the transition.
+The workflow pauses at `waiting_for_response` until the user submits data via the document button.
 
 #### 3. Document Actions with Buttons
 
@@ -96,38 +90,15 @@ ui:
             widget: textarea
         actions:
           - type: button
-            transition: user_response
+            transition: userResponse
             label: 'Optimize Notes'
 ```
 
-When clicked, the button triggers the `user_response` transition with the current document content.
+When clicked, the button triggers the `userResponse` transition with the current document content as the payload.
 
-#### 4. Transition Payloads
+#### 4. Custom Document Schemas
 
-Access user input from the transition payload using `runtime.transition.payload`:
-
-```yaml
-- id: user_response
-  from: waiting_for_response
-  to: response_received
-  trigger: manual
-  call:
-    - id: create_response
-      tool: createDocument
-      args:
-        id: input
-        document: meetingNotesDocument
-        update:
-          content: ${{ runtime.transition.payload }}
-      assign:
-        meetingNotes: ${{ result.data.content }}
-```
-
-The `runtime.transition.payload` contains the document content when the user clicked the button. The result is saved to workflow state via `assign`.
-
-#### 5. Custom Document Schemas
-
-Define document content schemas using `@Input` on the `content` property:
+Define document content schemas using the `@Document` decorator with a Zod schema:
 
 ```typescript
 export const MeetingNotesDocumentSchema = z.object({
@@ -135,19 +106,15 @@ export const MeetingNotesDocumentSchema = z.object({
 });
 
 @Document({
+  schema: MeetingNotesDocumentSchema,
   uiConfig: __dirname + '/meeting-notes-document.yaml',
 })
-export class MeetingNotesDocument implements DocumentInterface {
-  @Input({
-    schema: MeetingNotesDocumentSchema,
-  })
-  content: {
-    text: string;
-  };
+export class MeetingNotesDocument {
+  text: string;
 }
 ```
 
-#### 6. Structured Output Documents
+#### 5. Structured Output Documents
 
 Define complex document schemas for structured AI output:
 
@@ -159,6 +126,18 @@ export const OptimizedMeetingNotesDocumentSchema = z.object({
   decisions: z.array(z.string()),
   actionItems: z.array(z.string()),
 });
+
+@Document({
+  schema: OptimizedMeetingNotesDocumentSchema,
+  uiConfig: __dirname + '/optimized-notes-document.yaml',
+})
+export class OptimizedNotesDocument {
+  date: string;
+  summary: string;
+  participants: string[];
+  decisions: string[];
+  actionItems: string[];
+}
 ```
 
 Configure the document UI with ordering, collapsible arrays, and confirm button:
@@ -170,67 +149,52 @@ ui:
   widgets:
     - widget: form
       options:
-        order:
-          - date
-          - summary
-          - participants
-          - decisions
-          - actionItems
+        order: [date, summary, participants, decisions, actionItems]
         properties:
-          date:
-            title: Date
-          summary:
-            title: Summary
-            widget: textarea
-          participants:
-            title: Participants
-            collapsed: true
-            items:
-              title: Participant
-          actionItems:
-            title: Action Items
-            collapsed: true
-            items:
-              title: Action Item
+          date: { title: Date }
+          summary: { title: Summary, widget: textarea }
+          participants: { title: Participants, collapsed: true, items: { title: Participant } }
+          decisions: { title: Decisions, collapsed: true, items: { title: Decision } }
+          actionItems: { title: Action Items, collapsed: true, items: { title: Action Item } }
         actions:
           - type: button
             transition: confirm
             label: 'Confirm'
 ```
 
-#### 7. AI Document Generation
+#### 6. AI Document Generation
 
-Use `aiGenerateDocument` to populate a structured document. Reference state values with `state.<name>`:
+Use `ClaudeGenerateDocument` to populate a structured document. Reference workflow properties for dynamic content:
 
-```yaml
-- id: optimize_notes
-  from: response_received
-  to: notes_optimized
-  call:
-    - id: prompt
-      tool: aiGenerateDocument
-      args:
-        llm:
-          provider: openai
-          model: gpt-4o
-        response:
-          id: final
-          document: optimizedNotesDocument
-        prompt: |
-          Extract all information from the provided meeting notes into the structured document.
-
-          <Meeting Notes>
-          {{ state.meetingNotes.text }}
-          </Meeting Notes>
+```typescript
+@Transition({ from: 'response_received', to: 'notes_optimized' })
+async optimizeNotes() {
+  await this.claudeGenerateDocument.call({
+    claude: { model: 'claude-sonnet-4-6' },
+    response: { id: 'final', document: OptimizedNotesDocument },
+    prompt: `Extract all information from the provided meeting notes into the structured document.\n\n<Meeting Notes>\n${this.meetingNotes?.text}\n</Meeting Notes>`,
+  });
+}
+```
+
+#### 7. Final Confirmation with Wait
+
+Use `@Final` with `wait: true` to create a review step before the workflow ends:
+
+```typescript
+@Final({ from: 'notes_optimized', wait: true, schema: OptimizedMeetingNotesDocumentSchema })
+async confirm(payload: z.infer<typeof OptimizedMeetingNotesDocumentSchema>) {
+  const result = await this.repository.save(OptimizedNotesDocument, payload, { id: 'final' });
+  this.optimizedNotes = result.content as z.infer<typeof OptimizedMeetingNotesDocumentSchema>;
+}
 ```
 
 ## Dependencies
 
 This workflow uses the following Loopstack modules:
 
-- `@loopstack/core` - Core framework functionality
-- `@loopstack/core` - Provides `CreateDocument` tool
-- `@loopstack/ai-module` - Provides `AiGenerateDocument` tool
+- `@loopstack/common` - Core framework decorators (`BaseWorkflow`, `@Workflow`, `@Initial`, `@Transition`, `@Final`, `@InjectTool`, `Document`)
+- `@loopstack/claude-module` - Provides `ClaudeGenerateDocument` tool for AI-powered document generation
 
 ## About
 

package/package.json

@@ -9,7 +9,7 @@
     "summary",
     "workflow"
   ],
-  "version": "0.21.0",
+  "version": "0.21.2",
   "license": "Apache-2.0",
   "author": {
     "name": "Jakob Klippel",
@@ -30,10 +30,10 @@
     "watch": "nest build --watch"
   },
   "dependencies": {
-    "@loopstack/claude-module": "^0.22.0",
-    "@loopstack/common": "^0.25.0",
-    "@loopstack/core": "^0.25.0",
-    "@nestjs/common": "^11.1.14",
+    "@loopstack/claude-module": "^0.22.1",
+    "@loopstack/common": "^0.25.1",
+    "@loopstack/core": "^0.25.1",
+    "@nestjs/common": "^11.1.19",
     "zod": "^4.3.6"
   },
   "files": [
@@ -45,7 +45,12 @@
     "rootDir": "src",
     "testRegex": ".*\\.spec\\.ts$",
     "transform": {
-      "^.+\\.ts$": "ts-jest"
+      "^.+\\.ts$": [
+        "ts-jest",
+        {
+          "tsconfig": "tsconfig.spec.json"
+        }
+      ]
     },
     "testTimeout": 10000,
     "forceExit": true,