fraim-framework 2.0.35 → 2.0.37

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 (159) hide show
  1. package/dist/registry/scripts/cleanup-branch.js +62 -33
  2. package/dist/registry/scripts/generate-engagement-emails.js +119 -44
  3. package/dist/registry/scripts/newsletter-helpers.js +208 -268
  4. package/dist/registry/scripts/profile-server.js +387 -0
  5. package/dist/scripts/build-stub-registry.js +108 -0
  6. package/dist/src/cli/commands/doctor.js +5 -5
  7. package/dist/src/cli/commands/sync.js +33 -19
  8. package/dist/tests/test-client-scripts-validation.js +133 -0
  9. package/dist/tests/test-package-size.js +88 -0
  10. package/dist/tests/test-script-location-independence.js +76 -28
  11. package/dist/tests/test-stub-registry.js +120 -0
  12. package/dist/tests/test-sync-stubs.js +143 -0
  13. package/package.json +7 -9
  14. package/registry/scripts/cleanup-branch.ts +341 -0
  15. package/registry/scripts/generate-engagement-emails.ts +830 -0
  16. package/registry/scripts/markdown-to-pdf.js +7 -3
  17. package/registry/scripts/newsletter-helpers.ts +777 -0
  18. package/registry/scripts/profile-server.ts +424 -0
  19. package/registry/scripts/run-thank-you-workflow.ts +122 -0
  20. package/registry/scripts/send-newsletter-simple.ts +102 -0
  21. package/registry/scripts/send-thank-you-emails.ts +57 -0
  22. package/registry/stubs/workflows/bootstrap/create-architecture.md +11 -0
  23. package/registry/stubs/workflows/bootstrap/detect-broken-windows.md +11 -0
  24. package/registry/stubs/workflows/bootstrap/evaluate-code-quality.md +11 -0
  25. package/registry/stubs/workflows/bootstrap/verify-test-coverage.md +11 -0
  26. package/registry/stubs/workflows/business-development/create-business-plan.md +11 -0
  27. package/registry/stubs/workflows/business-development/ideate-business-opportunity.md +11 -0
  28. package/registry/stubs/workflows/business-development/price-product.md +18 -0
  29. package/registry/stubs/workflows/convert-to-pdf.md +11 -0
  30. package/registry/stubs/workflows/customer-development/insight-analysis.md +11 -0
  31. package/registry/stubs/workflows/customer-development/insight-triage.md +11 -0
  32. package/registry/stubs/workflows/customer-development/interview-preparation.md +11 -0
  33. package/registry/stubs/workflows/customer-development/linkedin-outreach.md +11 -0
  34. package/registry/stubs/workflows/customer-development/strategic-brainstorming.md +11 -0
  35. package/registry/stubs/workflows/customer-development/thank-customers.md +11 -0
  36. package/registry/stubs/workflows/customer-development/weekly-newsletter.md +11 -0
  37. package/registry/stubs/workflows/deploy/cloud-deployment.md +11 -0
  38. package/registry/stubs/workflows/improve-fraim/contribute.md +11 -0
  39. package/registry/stubs/workflows/improve-fraim/file-issue.md +11 -0
  40. package/registry/stubs/workflows/marketing/content-creation.md +11 -0
  41. package/registry/stubs/workflows/marketing/hbr-article.md +11 -0
  42. package/registry/stubs/workflows/marketing/launch-checklist.md +11 -0
  43. package/registry/stubs/workflows/marketing/marketing-strategy.md +11 -0
  44. package/registry/stubs/workflows/marketing/storytelling.md +11 -0
  45. package/registry/stubs/workflows/performance/analyze-performance.md +11 -0
  46. package/registry/stubs/workflows/product-building/design.md +11 -0
  47. package/registry/stubs/workflows/product-building/implement.md +12 -0
  48. package/registry/stubs/workflows/product-building/iterate-on-pr-comments.md +11 -0
  49. package/registry/stubs/workflows/product-building/prep-issue.md +11 -0
  50. package/registry/stubs/workflows/product-building/prototype.md +11 -0
  51. package/registry/stubs/workflows/product-building/resolve.md +11 -0
  52. package/registry/stubs/workflows/product-building/retrospect.md +11 -0
  53. package/registry/stubs/workflows/product-building/spec.md +11 -0
  54. package/registry/stubs/workflows/product-building/test.md +11 -0
  55. package/registry/stubs/workflows/quality-assurance/browser-validation.md +11 -0
  56. package/registry/stubs/workflows/quality-assurance/iterative-improvement-cycle.md +11 -0
  57. package/registry/stubs/workflows/replicate/replicate-discovery.md +11 -0
  58. package/registry/stubs/workflows/replicate/replicate-to-issues.md +11 -0
  59. package/registry/stubs/workflows/reviewer/review-implementation-vs-design-spec.md +11 -0
  60. package/registry/stubs/workflows/reviewer/review-implementation-vs-feature-spec.md +11 -0
  61. package/registry/stubs/workflows/startup-credits/aws-activate-application.md +11 -0
  62. package/registry/stubs/workflows/startup-credits/google-cloud-application.md +11 -0
  63. package/registry/stubs/workflows/startup-credits/microsoft-azure-application.md +11 -0
  64. package/.github/workflows/ci.yml +0 -65
  65. package/.github/workflows/deploy-fraim.yml +0 -87
  66. package/.github/workflows/phase-change.yml +0 -251
  67. package/.github/workflows/status-change.yml +0 -68
  68. package/.github/workflows/sync-on-pr-review.yml +0 -66
  69. package/examples/simple-webapp/TESTING.md +0 -62
  70. package/examples/simple-webapp/example-test.ts +0 -186
  71. package/registry/github/workflows/ci.yml +0 -51
  72. package/registry/github/workflows/phase-change.yml +0 -251
  73. package/registry/github/workflows/status-change.yml +0 -68
  74. package/registry/github/workflows/sync-on-pr-review.yml +0 -66
  75. package/registry/mcp-template.jsonc +0 -29
  76. package/registry/rules/agent-success-criteria.md +0 -52
  77. package/registry/rules/agent-testing-guidelines.md +0 -502
  78. package/registry/rules/architecture.md +0 -52
  79. package/registry/rules/communication.md +0 -122
  80. package/registry/rules/continuous-learning.md +0 -55
  81. package/registry/rules/debugging-multitenancy-issues.md +0 -85
  82. package/registry/rules/ephemeral-execution.md +0 -57
  83. package/registry/rules/git-safe-commands.md +0 -34
  84. package/registry/rules/hitl-ppe-record-analysis.md +0 -302
  85. package/registry/rules/integrity-and-test-ethics.md +0 -275
  86. package/registry/rules/local-development.md +0 -254
  87. package/registry/rules/merge-requirements.md +0 -231
  88. package/registry/rules/simplicity.md +0 -118
  89. package/registry/rules/software-development-lifecycle.md +0 -105
  90. package/registry/rules/spike-first-development.md +0 -205
  91. package/registry/rules/successful-debugging-patterns.md +0 -491
  92. package/registry/rules/telemetry.md +0 -67
  93. package/registry/templates/bootstrap/ARCHITECTURE-TEMPLATE.md +0 -53
  94. package/registry/templates/bootstrap/CODE-QUALITY-REPORT-TEMPLATE.md +0 -37
  95. package/registry/templates/bootstrap/TEST-COVERAGE-REPORT-TEMPLATE.md +0 -35
  96. package/registry/templates/business-development/IDEATION-REPORT-TEMPLATE.md +0 -29
  97. package/registry/templates/business-development/PRICING-STRATEGY-TEMPLATE.md +0 -126
  98. package/registry/templates/customer-development/customer-interview-template.md +0 -99
  99. package/registry/templates/customer-development/follow-up-email-templates.md +0 -132
  100. package/registry/templates/customer-development/insight-analysis-template.md +0 -74
  101. package/registry/templates/customer-development/strategic-recommendations-template.md +0 -53
  102. package/registry/templates/customer-development/thank-you-email-template.html +0 -124
  103. package/registry/templates/customer-development/thank-you-note-template.md +0 -16
  104. package/registry/templates/customer-development/triage-log-template.md +0 -278
  105. package/registry/templates/customer-development/weekly-newsletter-template.html +0 -204
  106. package/registry/templates/evidence/Design-Evidence.md +0 -30
  107. package/registry/templates/evidence/Implementation-BugEvidence.md +0 -86
  108. package/registry/templates/evidence/Implementation-FeatureEvidence.md +0 -121
  109. package/registry/templates/evidence/Spec-Evidence.md +0 -19
  110. package/registry/templates/help/HelpNeeded.md +0 -14
  111. package/registry/templates/marketing/HBR-ARTICLE-TEMPLATE.md +0 -66
  112. package/registry/templates/marketing/STORYTELLING-TEMPLATE.md +0 -130
  113. package/registry/templates/replicate/implementation-checklist.md +0 -39
  114. package/registry/templates/replicate/use-cases-template.md +0 -88
  115. package/registry/templates/retrospective/RETROSPECTIVE-TEMPLATE.md +0 -55
  116. package/registry/templates/specs/BUGSPEC-TEMPLATE.md +0 -37
  117. package/registry/templates/specs/FEATURESPEC-TEMPLATE.md +0 -29
  118. package/registry/templates/specs/TECHSPEC-TEMPLATE.md +0 -39
  119. package/registry/workflows/bootstrap/create-architecture.md +0 -38
  120. package/registry/workflows/bootstrap/evaluate-code-quality.md +0 -36
  121. package/registry/workflows/bootstrap/verify-test-coverage.md +0 -37
  122. package/registry/workflows/business-development/create-business-plan.md +0 -737
  123. package/registry/workflows/business-development/ideate-business-opportunity.md +0 -55
  124. package/registry/workflows/business-development/price-product.md +0 -325
  125. package/registry/workflows/convert-to-pdf.md +0 -235
  126. package/registry/workflows/customer-development/insight-analysis.md +0 -156
  127. package/registry/workflows/customer-development/insight-triage.md +0 -933
  128. package/registry/workflows/customer-development/interview-preparation.md +0 -421
  129. package/registry/workflows/customer-development/linkedin-outreach.md +0 -593
  130. package/registry/workflows/customer-development/strategic-brainstorming.md +0 -146
  131. package/registry/workflows/customer-development/thank-customers.md +0 -203
  132. package/registry/workflows/customer-development/weekly-newsletter.md +0 -366
  133. package/registry/workflows/deploy/cloud-deployment.md +0 -310
  134. package/registry/workflows/improve-fraim/contribute.md +0 -32
  135. package/registry/workflows/improve-fraim/file-issue.md +0 -32
  136. package/registry/workflows/marketing/content-creation.md +0 -37
  137. package/registry/workflows/marketing/hbr-article.md +0 -73
  138. package/registry/workflows/marketing/launch-checklist.md +0 -37
  139. package/registry/workflows/marketing/marketing-strategy.md +0 -45
  140. package/registry/workflows/marketing/storytelling.md +0 -65
  141. package/registry/workflows/performance/analyze-performance.md +0 -65
  142. package/registry/workflows/product-building/design.md +0 -130
  143. package/registry/workflows/product-building/implement.md +0 -315
  144. package/registry/workflows/product-building/iterate-on-pr-comments.md +0 -70
  145. package/registry/workflows/product-building/prep-issue.md +0 -43
  146. package/registry/workflows/product-building/prototype.md +0 -60
  147. package/registry/workflows/product-building/resolve.md +0 -164
  148. package/registry/workflows/product-building/retrospect.md +0 -86
  149. package/registry/workflows/product-building/spec.md +0 -117
  150. package/registry/workflows/product-building/test.md +0 -120
  151. package/registry/workflows/quality-assurance/browser-validation.md +0 -221
  152. package/registry/workflows/quality-assurance/iterative-improvement-cycle.md +0 -562
  153. package/registry/workflows/replicate/replicate-discovery.md +0 -336
  154. package/registry/workflows/replicate/replicate-to-issues.md +0 -319
  155. package/registry/workflows/reviewer/review-implementation-vs-design-spec.md +0 -632
  156. package/registry/workflows/reviewer/review-implementation-vs-feature-spec.md +0 -669
  157. package/registry/workflows/startup-credits/aws-activate-application.md +0 -535
  158. package/registry/workflows/startup-credits/google-cloud-application.md +0 -647
  159. package/registry/workflows/startup-credits/microsoft-azure-application.md +0 -538
@@ -1,146 +0,0 @@
1
- # Strategic Brainstorming Workflow
2
-
3
- ## INTENT
4
- To help Product Managers brainstorm and validate their customer development strategy through deep thinking, assumption challenging, and market research to identify the right customer segments and validation questions.
5
-
6
- ## PRINCIPLES
7
- - **Assumption Challenging**: Question PM's assumptions and explore alternatives
8
- - **Deep Research**: Use market research to validate/invalidate assumptions
9
- - **Strategic Thinking**: Help PM think through customer segments and priorities
10
- - **Actionable Output**: Provide clear recommendations for customer interviews
11
-
12
- ## WORKFLOW TRIGGER
13
- **PM explicitly starts this workflow**:
14
- - "Starting Strategic Brainstorming"
15
- - "I need to brainstorm our customer development strategy"
16
- - "Following the strategic brainstorming workflow"
17
-
18
- ## AI AGENT PROCESS
19
-
20
- ### Step 1: Deep Context Gathering
21
- **AI Agent First Actions**:
22
- 1. **Read Business Context**
23
- - Read through `docs/business/` folder for company vision, strategy, and market positioning
24
- - Review existing business documents and market analysis
25
- - Understand current product positioning and competitive landscape
26
-
27
- 2. **Read Customer Insights**
28
- - Review `docs/customer-insights/` folder for existing customer research
29
- - Analyze previous customer interviews and feedback
30
- - Identify patterns in customer pain points and needs
31
-
32
- 3. **Analyze Codebase Context**
33
- - Review current product features and capabilities
34
- - Understand technical architecture and constraints
35
- - Identify areas where customer feedback could inform development
36
-
37
- **PM provides unstructured input**:
38
- - Raw thoughts about current product state
39
- - Initial assumptions and hypotheses
40
- - Unstructured priorities and concerns
41
- - Any existing customer insights
42
- - Competitive concerns or opportunities
43
-
44
- **AI Agent Response**:
45
- - Acknowledge the brainstorming session with deep context understanding
46
- - Reference specific insights from business docs and customer research
47
- - Ask probing questions informed by existing knowledge
48
- - Identify key assumptions to explore based on current context
49
-
50
- ### Step 2: Assumption Challenging & Exploration
51
- **AI Agent Brainstorming Process**:
52
- 1. **Challenge Assumptions**
53
- - "What makes you think [assumption] is true?"
54
- - "Have you considered alternative perspectives?"
55
- - "What evidence do you have for this assumption?"
56
-
57
- 2. **Explore Alternatives**
58
- - Suggest different customer segments
59
- - Propose alternative problem definitions
60
- - Consider different solution approaches
61
-
62
- 3. **Identify Gaps**
63
- - What assumptions need validation?
64
- - What customer segments are missing?
65
- - What competitive threats exist?
66
-
67
- ### Step 3: Market Research & Validation
68
- **AI Agent Research Process**:
69
- 1. **Market Research**
70
- - Research industry trends and customer pain points
71
- - Analyze competitive landscape
72
- - Identify potential customer personas
73
-
74
- 2. **Assumption Validation**
75
- - Find evidence for/against assumptions
76
- - Identify similar companies and their approaches
77
- - Research customer segment characteristics
78
-
79
- 3. **Opportunity Analysis**
80
- - Identify market gaps
81
- - Assess segment attractiveness
82
- - Evaluate competitive positioning
83
-
84
- ### Step 4: Strategic Recommendations
85
- **AI Agent Output**:
86
- - **Customer Segment Prioritization**: Ranked list of segments to interview
87
- - **Assumption Validation Map**: Key assumptions mapped to validation questions
88
- - **Interview Sequence**: Recommended order and rationale
89
- - **Risk Mitigation**: Potential risks and mitigation strategies
90
-
91
- ### Step 5: Document Creation
92
- **AI Agent Final Action**:
93
- - Create strategic recommendations document in `docs/customer-insights/`
94
- - Use intuitive naming based on context (e.g., `ashley-market-niche-strategy.md`)
95
- - Include all research findings and recommendations
96
- - Provide actionable next steps for PM
97
- - Save document for future reference and team sharing
98
-
99
- ## OUTPUT TEMPLATE
100
-
101
- ### Strategic Recommendations Document
102
- **Template**: Retrieve via `get_fraim_file({ path: "templates/customer-development/strategic-recommendations-template.md" })`
103
- **File Location**: `docs/customer-development/[contextual-name].md` (e.g., `ashley-market-niche-strategy.md`)
104
-
105
- **Process**:
106
- 1. Use the strategic recommendations template
107
- 2. Fill in all sections with research findings and recommendations
108
- 3. Save with contextual naming based on strategic focus
109
- 4. Include specific customer names and companies when available
110
- 5. Reference existing business documents and customer insights
111
-
112
- ## EXAMPLES
113
-
114
- ### Good: Strategic Brainstorming Session
115
- ```
116
- PM: "Starting Strategic Brainstorming. We're building Ashley, an AI executive assistant. I think enterprise execs want AI to handle calendar conflicts automatically, but I'm not sure if that's right."
117
-
118
- AI Agent: "Perfect! I've reviewed your business docs and customer insights. I can see from your WhyAshley document that you're positioning Ashley as 'Your Agent for Time, Priorities, and Human Potential' and targeting enterprise executives. I also noticed from your existing customer interviews with Ronil, Sanjoy, and Olga that calendar conflict resolution came up as a key pain point across all three customers.
119
-
120
- However, I'm curious about your 'automatic' assumption. From your existing customer insights, I see that trust and delegation control were major themes - Ronil mentioned 'Don't have trust in tech to read email - need to have hands in it' and Sanjoy was concerned about 'Disturb during highly important meetings'. What makes you think they want it 'automatic' vs 'suggested'?"
121
-
122
- PM: "Good point. I guess I'm assuming automatic because that's what would save them the most time."
123
-
124
- AI Agent: "That's a reasonable assumption, but based on your existing customer feedback, there's a clear pattern of wanting control and oversight. Ronil mentioned wanting to 'observe for 2 weeks, then take action' and Olga talked about how good EAs 'enforce workback plans based on business priorities' rather than just doing what they're asked. What if we validated this by asking about their current delegation patterns and comfort levels with AI autonomy?"
125
-
126
- [Brainstorming continues with deep context...]
127
-
128
- AI Agent Output: Strategic recommendations document informed by existing business context and customer insights
129
- ```
130
-
131
- ### Bad: Surface-Level Brainstorming
132
- ```
133
- PM: "We're building Ashley, an AI executive assistant. Who should we interview?"
134
-
135
- AI Agent: "You should interview enterprise executives."
136
-
137
- PM: "Okay, thanks."
138
-
139
- Result: No deep thinking, no assumption validation, no strategic recommendations
140
- ```
141
-
142
- ## SUCCESS METRICS
143
- - **Assumption Validation**: 80% of key assumptions have clear validation questions
144
- - **Customer Segment Clarity**: Clear rationale for segment prioritization
145
- - **Interview Readiness**: PM has clear next steps for customer interviews
146
- - **Risk Awareness**: Potential risks identified and mitigated
@@ -1,203 +0,0 @@
1
- # Thank Customers Workflow
2
-
3
- ## INTENT
4
- To automatically generate and send personalized thank you emails to customers whose feedback has been implemented, strengthening customer relationships and encouraging continued engagement.
5
-
6
- ## PRINCIPLES
7
- - **Personal Touch**: Ashley's voice, grateful tone, "Thank you for making me better..."
8
- - **Voice & Pronouns**: Emails are written in first person from Ashley ("I", "me", "my"). When referring to Ashley in third person (outside the email body), use they/them pronouns. Avoid gendered pronouns for Ashley.
9
- - **Customer-Focused**: No technical jargon or issue numbers in customer emails
10
- - **Short and Sweet**: To the point, instructive, humble
11
- - **Encourage more feedback**: ChatGPT (https://ashley-chat.wellnessatwork.me) is the best way
12
-
13
- ## WORKFLOW TRIGGER
14
- **User triggers this workflow manually**:
15
- - When customer issues are resolved and deployed
16
- - User says: "Generate thank you emails for customers" or similar
17
-
18
- ## AI AGENT PROCESS
19
-
20
- ### Step 1: Issue Retrieval
21
- **AI Agent calls function**:
22
- ```typescript
23
- // Import helper functions directly from synced location
24
- const os = require('os');
25
- const path = require('path');
26
- const scriptsDir = path.join(os.homedir(), '.fraim', 'scripts');
27
- const scriptPath = path.join(scriptsDir, 'generate-engagement-emails.ts');
28
-
29
- import { getResolvedIssues, findExecutiveByEmail, getAshleyEmailForExecutive } from scriptPath;
30
-
31
- // Get issues resolved since last thank-you date (automatic) or user-specified date
32
- const resolvedIssues = await getResolvedIssues(); // Automatically uses latest thank-you date
33
- // OR with explicit date:
34
- const resolvedIssues = await getResolvedIssues('2025-10-29'); // Optional: user-specified date
35
- ```
36
-
37
- **Note**: The `getResolvedIssues()` function automatically:
38
- - Finds the most recent date from existing `thank-you-candidates-YYYY-MM-DD.json` files where emails were sent (status: "sent")
39
- - Uses that date as the starting point to only fetch issues resolved AFTER that date
40
- - If no thank-you files exist, falls back to last 14 days
41
- - This ensures we never send duplicate thank-you emails for the same resolved issues
42
-
43
- ### Step 2: Customer Information Extraction
44
- **AI Agent does intelligent extraction**:
45
- 1. **Go through each resolved issue**
46
- 2. **Extract customer email** from:
47
- - Issue title format: `email@domain.com: summary`
48
- - Issue body: look for email patterns
49
- - If no email found, extract customer name and use database lookup
50
- 3. **Extract customer name** from:
51
- - Issue title or body
52
- - Previous thank-you notes
53
- - Onboarding insights documents
54
-
55
- ### Step 3: Database Lookup
56
- **AI Agent calls function for each customer**:
57
- ```typescript
58
- // Look up executive by customer email
59
- const executive = await findExecutiveByEmail(customerEmail);
60
-
61
- // Get Ashley email address for this executive
62
- const ashleyEmail = await getAshleyEmailForExecutive(executive.id);
63
- ```
64
-
65
- ### Step 4: Collate Issues by Customer
66
- **AI Agent organizes data**:
67
- - Group all resolved issues by customer email
68
- - **Consolidate customers with multiple email addresses** by matching customer names (case-insensitive)
69
- - When a customer has multiple emails, use the primary email from the database lookup
70
- - Output customer list to console for verification
71
-
72
- ### Step 5: Generate Single Thank-You File
73
- **AI Agent creates ONE file**:
74
- - File: `docs/customer-development/thank-you-notes/thank-you-candidates-YYYY-MM-DD.json`
75
- - Format: Structured JSON (not markdown) for easy parsing by mail sending script
76
- - Contains ALL customers and their personalized emails
77
- - **AI Agent writes the email content** - be creative, personal, and contextual!
78
- - Follow principles: personal touch, customer-focused, short and sweet, encourage feedback
79
- - **NO TECHNICAL JARGON**: Do not mention issue numbers, BAML, internal systems, or technical details
80
- - **CUSTOMER EXPERIENCE FOCUS**: Describe what was broken from the user's perspective, what was fixed, and how they can verify it works
81
- - **First-person Email Body**: Use "I" for actions Ashley took (e.g., "I fixed", "I now", "I will"), not "Ashley" or "she". Sign off as Ashley.
82
- - Include `From:` field showing Ashley email from PPE (via `getAshleyEmailForExecutive()`)
83
-
84
- **File format** (JSON):
85
- ```json
86
- {
87
- "metadata": {
88
- "generatedOn": "2025-10-29T02:29:02.497Z",
89
- "issuesResolvedSince": "2025-10-28",
90
- "totalCustomers": 2,
91
- "totalIssues": 3
92
- },
93
- "candidates": [
94
- {
95
- "customer": {
96
- "name": "Olga Ivanova",
97
- "email": "olga.ivanova@gmail.com"
98
- },
99
- "executive": {
100
- "name": "Olga Ivanova",
101
- "id": "exec-..."
102
- },
103
- "status": "pending",
104
- "from": {
105
- "displayName": "Ashley - Olga Ivanova's AI Executive Assistant",
106
- "email": "ashley+olga@ashleycalendar.ai"
107
- },
108
- "to": "olga.ivanova@gmail.com",
109
- "subject": "Thank you for your feedback - your issues have been addressed!",
110
- "greeting": "Hi Olga,",
111
- "opening": "Thank you for making me better! I wanted to personally reach out because your feedback helped us catch and fix an important bug.",
112
- "improvements": [
113
- {
114
- "title": "Issue filing feature",
115
- "description": "The issue filing feature is now working properly - when you ask me to file a bug or feature request through voice, I'll handle it correctly.",
116
- "verification": "Try asking me to file a bug or feature request and it should work smoothly now."
117
- }
118
- ],
119
- "closing": "Your quick feedback saved you (and others) frustration down the line. That kind of real-time input makes all the difference as I'm learning."
120
- }
121
- ]
122
- }
123
- ```
124
-
125
- **Note**: The structured format allows the HTML template to format each section beautifully:
126
- - `greeting`: Personal greeting (e.g., "Hi Olga,")
127
- - `opening`: Opening paragraph - thanks and context
128
- - `improvements[]`: Array of improvements (title, description, optional verification step)
129
- - `closing`: Closing paragraph - encouraging more feedback
130
-
131
- The HTML template formats each section with appropriate styling.
132
-
133
- ### Step 6: User Review
134
- **AI Agent**:
135
- 1. **Points user to the generated file**: `docs/customer-development/thank-you-notes/thank-you-candidates-YYYY-MM-DD.json`
136
- 2. **Requests review** and any edits needed (user can edit JSON directly)
137
- 3. **Waits for user approval** before proceeding
138
-
139
- **Note**: Each email section includes a `From:` field showing the display name and email address that will be used when sending. The signature includes a humble note about ramping up, without displaying a generic email address.
140
-
141
- ### Step 7: Send Emails (Separate Command)
142
- **When user says "Send the emails" or similar**:
143
-
144
- **AI Agent calls function**:
145
- ```typescript
146
- // Import helper functions directly from synced location
147
- const os = require('os');
148
- const path = require('path');
149
- const scriptsDir = path.join(os.homedir(), '.fraim', 'scripts');
150
- const scriptPath = path.join(scriptsDir, 'generate-engagement-emails.ts');
151
-
152
- import { sendCustomerMail } from scriptPath;
153
-
154
- // Send emails from the candidates JSON file (all pending candidates)
155
- await sendCustomerMail('docs/customer-development/thank-you-notes/thank-you-candidates-YYYY-MM-DD.json');
156
-
157
- // OR send to a specific executive only (optional)
158
- await sendCustomerMail('docs/customer-development/thank-you-notes/thank-you-candidates-YYYY-MM-DD.json', 'exec-1761011032377-q36j91sdl');
159
- ```
160
-
161
- **Note**: The `sendCustomerMail` function parses JSON (not markdown) for easy, deterministic parsing.
162
-
163
- **Function parameters**:
164
- - `candidatesFilePath` (required): Path to the JSON candidates file
165
- - `executiveId` (optional): If provided, only sends emails for candidates matching this executive ID. If omitted, sends to all pending candidates.
166
-
167
- **This function will**:
168
- - Parse the JSON candidates file
169
- - If `executiveId` is provided, filter to only that executive's candidates
170
- - For each candidate with `status: "pending"`, send email
171
- - Use the `from` field (displayName and email) specified in JSON
172
- - Use the `to`, `subject`, and `body` fields from JSON
173
- - Update the JSON file after each send with status: `"sent"` or `"failed"`
174
- - Skip candidates that already have status `"sent"` or `"failed"`
175
-
176
- ## REQUIRED FUNCTIONS IN SCRIPT
177
-
178
- The script must provide these deterministic functions for AI agents to call:
179
-
180
- ```typescript
181
- // Get resolved issues since a date
182
- export async function getResolvedIssues(date: string): Promise<ResolvedIssue[]>
183
-
184
- // Find executive by email in PPE database
185
- export async function findExecutiveByEmail(email: string): Promise<Executive | null>
186
-
187
- // Get Ashley email for executive from PPE database
188
- export async function getAshleyEmailForExecutive(executiveId: string): Promise<string>
189
-
190
- // Send emails from candidates file
191
- // executiveId is optional - if provided, only sends to that executive; if omitted, sends to all pending
192
- export async function sendCustomerMail(candidatesFilePath: string, executiveId?: string): Promise<void>
193
- ```
194
-
195
- **Note**: The script provides ONLY data retrieval and sending. The AI agent does ALL intelligent work:
196
- - Extracts customer info from issues (intelligent parsing)
197
- - Writes personalized, creative email content (better than hardcoded templates!)
198
- - Organizes and formats the candidates file
199
-
200
- ## WORKFLOW COMPLETION
201
-
202
- **Generate workflow completes with**: Single candidates file ready for review
203
- **Send workflow completes with**: All emails sent and file updated with status