@autobe/agent 0.27.0 → 0.28.1
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.
- package/lib/constants/AutoBeSystemPromptConstant.d.ts +1 -1
- package/lib/context/assertSchemaModel.d.ts +1 -1
- package/lib/context/assertSchemaModel.js +4 -7
- package/lib/context/assertSchemaModel.js.map +1 -1
- package/lib/index.mjs +18186 -7689
- package/lib/index.mjs.map +1 -1
- package/lib/orchestrate/analyze/histories/transformAnalyzeScenarioHistories.js +1 -1
- package/lib/orchestrate/analyze/histories/transformAnalyzeScenarioHistories.js.map +1 -1
- package/lib/orchestrate/analyze/orchestrateAnalyzeReview.js +164 -86
- package/lib/orchestrate/analyze/orchestrateAnalyzeReview.js.map +1 -1
- package/lib/orchestrate/analyze/orchestrateAnalyzeScenario.js +656 -335
- package/lib/orchestrate/analyze/orchestrateAnalyzeScenario.js.map +1 -1
- package/lib/orchestrate/analyze/orchestrateAnalyzeWrite.js +143 -74
- package/lib/orchestrate/analyze/orchestrateAnalyzeWrite.js.map +1 -1
- package/lib/orchestrate/analyze/structures/IAutoBeAnalyzeReviewApplication.d.ts +17 -52
- package/lib/orchestrate/analyze/structures/IAutoBeAnalyzeScenarioApplication.d.ts +25 -22
- package/lib/orchestrate/analyze/structures/IAutoBeAnalyzeWriteApplication.d.ts +7 -23
- package/lib/orchestrate/common/orchestrateCommonCorrectCasting.js +165 -2
- package/lib/orchestrate/common/orchestrateCommonCorrectCasting.js.map +1 -1
- package/lib/orchestrate/facade/createAutoBeFacadeController.js +773 -403
- package/lib/orchestrate/facade/createAutoBeFacadeController.js.map +1 -1
- package/lib/orchestrate/interface/orchestrateInterfaceAuthorizations.js +749 -2
- package/lib/orchestrate/interface/orchestrateInterfaceAuthorizations.js.map +1 -1
- package/lib/orchestrate/interface/orchestrateInterfaceComplement.js +1637 -9
- package/lib/orchestrate/interface/orchestrateInterfaceComplement.js.map +1 -1
- package/lib/orchestrate/interface/orchestrateInterfaceEndpoints.js +252 -133
- package/lib/orchestrate/interface/orchestrateInterfaceEndpoints.js.map +1 -1
- package/lib/orchestrate/interface/orchestrateInterfaceEndpointsReview.js +258 -135
- package/lib/orchestrate/interface/orchestrateInterfaceEndpointsReview.js.map +1 -1
- package/lib/orchestrate/interface/orchestrateInterfaceGroups.js +342 -226
- package/lib/orchestrate/interface/orchestrateInterfaceGroups.js.map +1 -1
- package/lib/orchestrate/interface/orchestrateInterfaceOperations.js +633 -1
- package/lib/orchestrate/interface/orchestrateInterfaceOperations.js.map +1 -1
- package/lib/orchestrate/interface/orchestrateInterfaceOperationsReview.js +785 -3
- package/lib/orchestrate/interface/orchestrateInterfaceOperationsReview.js.map +1 -1
- package/lib/orchestrate/interface/orchestrateInterfacePrerequisites.js +206 -3
- package/lib/orchestrate/interface/orchestrateInterfacePrerequisites.js.map +1 -1
- package/lib/orchestrate/interface/orchestrateInterfaceSchemaRename.js +107 -1
- package/lib/orchestrate/interface/orchestrateInterfaceSchemaRename.js.map +1 -1
- package/lib/orchestrate/interface/orchestrateInterfaceSchemaReview.js +1676 -9
- package/lib/orchestrate/interface/orchestrateInterfaceSchemaReview.js.map +1 -1
- package/lib/orchestrate/interface/orchestrateInterfaceSchemas.js +1637 -9
- package/lib/orchestrate/interface/orchestrateInterfaceSchemas.js.map +1 -1
- package/lib/orchestrate/prisma/orchestratePrismaComponent.js +397 -201
- package/lib/orchestrate/prisma/orchestratePrismaComponent.js.map +1 -1
- package/lib/orchestrate/prisma/orchestratePrismaCorrect.js +1184 -599
- package/lib/orchestrate/prisma/orchestratePrismaCorrect.js.map +1 -1
- package/lib/orchestrate/prisma/orchestratePrismaReview.js +1202 -608
- package/lib/orchestrate/prisma/orchestratePrismaReview.js.map +1 -1
- package/lib/orchestrate/prisma/orchestratePrismaSchemas.js +4 -2
- package/lib/orchestrate/prisma/orchestratePrismaSchemas.js.map +1 -1
- package/lib/orchestrate/realize/orchestrateRealizeAuthorization.js +369 -185
- package/lib/orchestrate/realize/orchestrateRealizeAuthorization.js.map +1 -1
- package/lib/orchestrate/realize/orchestrateRealizeAuthorizationCorrect.js +405 -203
- package/lib/orchestrate/realize/orchestrateRealizeAuthorizationCorrect.js.map +1 -1
- package/lib/orchestrate/realize/orchestrateRealizeCorrect.js +130 -2
- package/lib/orchestrate/realize/orchestrateRealizeCorrect.js.map +1 -1
- package/lib/orchestrate/realize/orchestrateRealizeCorrectCasting.js +165 -2
- package/lib/orchestrate/realize/orchestrateRealizeCorrectCasting.js.map +1 -1
- package/lib/orchestrate/realize/orchestrateRealizeWrite.js +130 -2
- package/lib/orchestrate/realize/orchestrateRealizeWrite.js.map +1 -1
- package/lib/orchestrate/test/histories/transformTestWriteHistories.js.map +1 -1
- package/lib/orchestrate/test/orchestrateTestCorrect.js +131 -2
- package/lib/orchestrate/test/orchestrateTestCorrect.js.map +1 -1
- package/lib/orchestrate/test/orchestrateTestCorrectInvalidRequest.js +166 -2
- package/lib/orchestrate/test/orchestrateTestCorrectInvalidRequest.js.map +1 -1
- package/lib/orchestrate/test/orchestrateTestScenario.js +257 -3
- package/lib/orchestrate/test/orchestrateTestScenario.js.map +1 -1
- package/lib/orchestrate/test/orchestrateTestScenarioReview.js +283 -3
- package/lib/orchestrate/test/orchestrateTestScenarioReview.js.map +1 -1
- package/lib/orchestrate/test/orchestrateTestWrite.js +139 -2
- package/lib/orchestrate/test/orchestrateTestWrite.js.map +1 -1
- package/package.json +9 -9
- package/src/constants/AutoBeSystemPromptConstant.ts +1 -1
- package/src/context/assertSchemaModel.ts +5 -8
- package/src/orchestrate/analyze/orchestrateAnalyzeReview.ts +7 -9
- package/src/orchestrate/analyze/orchestrateAnalyzeScenario.ts +13 -9
- package/src/orchestrate/analyze/orchestrateAnalyzeWrite.ts +7 -9
- package/src/orchestrate/analyze/structures/IAutoBeAnalyzeReviewApplication.ts +19 -54
- package/src/orchestrate/analyze/structures/IAutoBeAnalyzeScenarioApplication.ts +25 -22
- package/src/orchestrate/analyze/structures/IAutoBeAnalyzeWriteApplication.ts +8 -24
- package/src/orchestrate/common/orchestrateCommonCorrectCasting.ts +15 -1
- package/src/orchestrate/facade/createAutoBeFacadeController.ts +7 -6
- package/src/orchestrate/interface/orchestrateInterfaceAuthorizations.ts +11 -1
- package/src/orchestrate/interface/orchestrateInterfaceComplement.ts +11 -1
- package/src/orchestrate/interface/orchestrateInterfaceEndpoints.ts +13 -9
- package/src/orchestrate/interface/orchestrateInterfaceEndpointsReview.ts +13 -9
- package/src/orchestrate/interface/orchestrateInterfaceGroups.ts +17 -14
- package/src/orchestrate/interface/orchestrateInterfaceOperations.ts +11 -1
- package/src/orchestrate/interface/orchestrateInterfaceOperationsReview.ts +14 -1
- package/src/orchestrate/interface/orchestrateInterfacePrerequisites.ts +11 -1
- package/src/orchestrate/interface/orchestrateInterfaceSchemaRename.ts +9 -1
- package/src/orchestrate/interface/orchestrateInterfaceSchemaReview.ts +14 -1
- package/src/orchestrate/interface/orchestrateInterfaceSchemas.ts +11 -1
- package/src/orchestrate/prisma/orchestratePrismaComponent.ts +13 -9
- package/src/orchestrate/prisma/orchestratePrismaCorrect.ts +7 -9
- package/src/orchestrate/prisma/orchestratePrismaReview.ts +7 -10
- package/src/orchestrate/realize/orchestrateRealizeAuthorization.ts +13 -9
- package/src/orchestrate/realize/orchestrateRealizeAuthorizationCorrect.ts +13 -9
- package/src/orchestrate/realize/orchestrateRealizeCorrect.ts +11 -1
- package/src/orchestrate/realize/orchestrateRealizeCorrectCasting.ts +15 -1
- package/src/orchestrate/realize/orchestrateRealizeWrite.ts +11 -1
- package/src/orchestrate/test/experimental/orchestrateTestWrite.ast +5 -1
- package/src/orchestrate/test/histories/transformTestWriteHistories.ts +1 -1
- package/src/orchestrate/test/orchestrateTestCorrect.ts +11 -1
- package/src/orchestrate/test/orchestrateTestCorrectInvalidRequest.ts +18 -1
- package/src/orchestrate/test/orchestrateTestScenario.ts +11 -1
- package/src/orchestrate/test/orchestrateTestScenarioReview.ts +11 -1
- package/src/orchestrate/test/orchestrateTestWrite.ts +11 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"orchestrateAnalyzeScenario.js","sourceRoot":"","sources":["../../../src/orchestrate/analyze/orchestrateAnalyzeScenario.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAQA,yCAA2C;AAG3C,kDAA0B;AAC1B,+BAA0B;AAG1B,uEAAoE;AACpE,qGAA6F;AAGtF,MAAM,0BAA0B,GAAG,CAGxC,GAAyB,EAC4C,EAAE;;IACvE,MAAM,KAAK,GAAS,IAAI,IAAI,EAAE,CAAC;IAC/B,MAAM,OAAO,GAA8D;QACzE,KAAK,EAAE,IAAI;KACZ,CAAC;IACF,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,CAAC,UAAU,CAAC;QAC7D,MAAM,EAAE,iBAAiB;QACzB,UAAU,EAAE,gBAAgB,CAAQ;YAClC,KAAK,EAAE,GAAG,CAAC,KAAK;YAChB,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,GAAG,KAAK,CAAC;SAC1C,CAAC;QACF,SAAS,EAAE,IAAA,gEAA4B,EAAC,GAAG,CAAC;QAC5C,mBAAmB,EAAE,KAAK;QAC1B,OAAO,EAAE,kBAAU,CAAC,IAAI,CAAA;;;;0CAIc,GAAG,CAAC,MAAM;KAC/C;KACF,CAAC,CAAC;IACH,IAAI,CAAA,MAAA,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,0CAAE,IAAI,MAAK,kBAAkB;QAC/C,OAAO,gCACD,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,CAAsC,KACzD,UAAU,EAAE,KAAK,CAAC,WAAW,EAAE,EAC/B,YAAY,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EACtC,EAAE,EAAE,IAAA,SAAE,GAAE,GAC+B,CAAC;SACvC,IAAI,OAAO,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC;QAChC,cAAc;QACd,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;IACzD,CAAC;IACD,OAAO;QACL,IAAI,EAAE,iBAAiB;QACvB,EAAE,EAAE,IAAA,SAAE,GAAE;QACR,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,MAAM;QAC5B,QAAQ,EAAE,OAAO,CAAC,KAAK,CAAC,QAAQ;QAChC,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,MAAM;QAC5B,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,KAAK;QAC1B,MAAM;QACN,UAAU;QACV,IAAI,EAAE,CAAC,MAAA,MAAA,GAAG,CAAC,KAAK,EAAE,CAAC,OAAO,0CAAE,IAAI,mCAAI,CAAC,CAAC,CAAC,GAAG,CAAC;QAC3C,UAAU,EAAE,KAAK,CAAC,WAAW,EAAE;KAChC,CAAC;AACJ,CAAC,CAAA,CAAC;AA/CW,QAAA,0BAA0B,8BA+CrC;AAEF,SAAS,gBAAgB,CAAiC,KAGzD;IACC,IAAA,qCAAiB,EAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC/B,MAAM,WAAW,GAA2B,UAAU,CACpD,KAAK,CAAC,KAAK,
|
|
1
|
+
{"version":3,"file":"orchestrateAnalyzeScenario.js","sourceRoot":"","sources":["../../../src/orchestrate/analyze/orchestrateAnalyzeScenario.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAQA,yCAA2C;AAG3C,kDAA0B;AAC1B,+BAA0B;AAG1B,uEAAoE;AACpE,qGAA6F;AAGtF,MAAM,0BAA0B,GAAG,CAGxC,GAAyB,EAC4C,EAAE;;IACvE,MAAM,KAAK,GAAS,IAAI,IAAI,EAAE,CAAC;IAC/B,MAAM,OAAO,GAA8D;QACzE,KAAK,EAAE,IAAI;KACZ,CAAC;IACF,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,CAAC,UAAU,CAAC;QAC7D,MAAM,EAAE,iBAAiB;QACzB,UAAU,EAAE,gBAAgB,CAAQ;YAClC,KAAK,EAAE,GAAG,CAAC,KAAK;YAChB,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,GAAG,KAAK,CAAC;SAC1C,CAAC;QACF,SAAS,EAAE,IAAA,gEAA4B,EAAC,GAAG,CAAC;QAC5C,mBAAmB,EAAE,KAAK;QAC1B,OAAO,EAAE,kBAAU,CAAC,IAAI,CAAA;;;;0CAIc,GAAG,CAAC,MAAM;KAC/C;KACF,CAAC,CAAC;IACH,IAAI,CAAA,MAAA,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,0CAAE,IAAI,MAAK,kBAAkB;QAC/C,OAAO,gCACD,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,CAAsC,KACzD,UAAU,EAAE,KAAK,CAAC,WAAW,EAAE,EAC/B,YAAY,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EACtC,EAAE,EAAE,IAAA,SAAE,GAAE,GAC+B,CAAC;SACvC,IAAI,OAAO,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC;QAChC,cAAc;QACd,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;IACzD,CAAC;IACD,OAAO;QACL,IAAI,EAAE,iBAAiB;QACvB,EAAE,EAAE,IAAA,SAAE,GAAE;QACR,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,MAAM;QAC5B,QAAQ,EAAE,OAAO,CAAC,KAAK,CAAC,QAAQ;QAChC,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,MAAM;QAC5B,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,KAAK;QAC1B,MAAM;QACN,UAAU;QACV,IAAI,EAAE,CAAC,MAAA,MAAA,GAAG,CAAC,KAAK,EAAE,CAAC,OAAO,0CAAE,IAAI,mCAAI,CAAC,CAAC,CAAC,GAAG,CAAC;QAC3C,UAAU,EAAE,KAAK,CAAC,WAAW,EAAE;KAChC,CAAC;AACJ,CAAC,CAAA,CAAC;AA/CW,QAAA,0BAA0B,8BA+CrC;AAEF,SAAS,gBAAgB,CAAiC,KAGzD;IACC,IAAA,qCAAiB,EAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC/B,MAAM,WAAW,GAA2B,UAAU,CACpD,KAAK,CAAC,KAAK,KAAK,SAAS;QACvB,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,KAAK,CAAC,KAAK,KAAK,QAAQ;YACxB,CAAC,CAAC,QAAQ;YACV,CAAC,CAAC,QAAQ,CACqD,CAAC;IACtE,OAAO;QACL,QAAQ,EAAE,OAAO;QACjB,IAAI,EAAE,SAAS;QACf,WAAW;QACX,OAAO,EAAE;YACP,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;gBACjB,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACrB,CAAC;SAC0C;KAC9C,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,GAAG;IACjB,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAGJ;IACH,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAGH;IACH,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAGH;CACJ,CAAC"}
|
|
@@ -87,7 +87,11 @@ const orchestrateAnalyzeWrite = (ctx, props) => __awaiter(void 0, void 0, void 0
|
|
|
87
87
|
exports.orchestrateAnalyzeWrite = orchestrateAnalyzeWrite;
|
|
88
88
|
function createController(props) {
|
|
89
89
|
(0, assertSchemaModel_1.assertSchemaModel)(props.model);
|
|
90
|
-
const application = collection[props.model
|
|
90
|
+
const application = collection[props.model === "chatgpt"
|
|
91
|
+
? "chatgpt"
|
|
92
|
+
: props.model === "gemini"
|
|
93
|
+
? "gemini"
|
|
94
|
+
: "claude"];
|
|
91
95
|
return {
|
|
92
96
|
protocol: "class",
|
|
93
97
|
name: "Planning",
|
|
@@ -99,81 +103,150 @@ function createController(props) {
|
|
|
99
103
|
},
|
|
100
104
|
};
|
|
101
105
|
}
|
|
102
|
-
const
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
106
|
+
const collection = {
|
|
107
|
+
chatgpt: {
|
|
108
|
+
model: "chatgpt",
|
|
109
|
+
options: {
|
|
110
|
+
reference: true,
|
|
111
|
+
strict: false,
|
|
112
|
+
separate: null
|
|
113
|
+
},
|
|
114
|
+
functions: [
|
|
115
|
+
{
|
|
116
|
+
name: "write",
|
|
117
|
+
parameters: {
|
|
118
|
+
description: " - The properties containing the document plan and initial\ncontent\n\n------------------------------\n\nCurrent Type: {@link IAutoBeAnalyzeWriteApplication.IProps}",
|
|
119
|
+
type: "object",
|
|
120
|
+
properties: {
|
|
121
|
+
plan: {
|
|
122
|
+
description: "Step 1 (CoT: Plan Phase) - Document Planning Structure\n\nThe document planning structure that outlines what needs to be written.\n\nThis includes:\n\n- Document title and purpose\n- Table of contents structure\n- Key sections to be covered\n- Relationships with other documents\n- Target audience (backend developers)\n\nThe plan serves as a roadmap for the AI agent to ensure all necessary\ntopics are covered in the documentation process.\n\nExample plan structure:\n\n- Service overview with business model\n- User actors and authentication requirements\n- Functional requirements with EARS format\n- Non-functional requirements\n- Business requirements in natural language\n- User scenarios and use cases",
|
|
123
|
+
type: "string"
|
|
124
|
+
},
|
|
125
|
+
content: {
|
|
126
|
+
description: "Step 2 (CoT: Write Phase) - Complete Document Content\n\nThe complete, production-ready markdown document content to be saved.\n\nRequirements:\n\n- Minimum 5,000 characters for technical documents\n- Uses EARS format for all applicable requirements\n- Includes proper Mermaid diagram syntax (double quotes for labels)\n- Focuses on business requirements in natural language\n- PROHIBITED: Database schemas, ERD, API specifications",
|
|
127
|
+
type: "string"
|
|
128
|
+
}
|
|
118
129
|
},
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
130
|
+
required: [
|
|
131
|
+
"plan",
|
|
132
|
+
"content"
|
|
133
|
+
],
|
|
134
|
+
additionalProperties: false,
|
|
135
|
+
$defs: {}
|
|
123
136
|
},
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
137
|
+
description: "Creates or updates planning documentation based on the provided plan and\ncontent structure.\n\nThis function is called by the AI agent to write detailed planning\ndocuments that will be used by backend developers to understand what needs\nto be built, why it's being built, and how it should function.",
|
|
138
|
+
validate: (() => { const _io0 = input => "string" === typeof input.plan && "string" === typeof input.content; const _vo0 = (input, _path, _exceptionable = true) => ["string" === typeof input.plan || _report(_exceptionable, {
|
|
139
|
+
path: _path + ".plan",
|
|
140
|
+
expected: "string",
|
|
141
|
+
value: input.plan
|
|
142
|
+
}), "string" === typeof input.content || _report(_exceptionable, {
|
|
143
|
+
path: _path + ".content",
|
|
144
|
+
expected: "string",
|
|
145
|
+
value: input.content
|
|
146
|
+
})].every(flag => flag); const __is = input => "object" === typeof input && null !== input && _io0(input); let errors; let _report; return input => {
|
|
147
|
+
if (false === __is(input)) {
|
|
148
|
+
errors = [];
|
|
149
|
+
_report = __typia_transform__validateReport._validateReport(errors);
|
|
150
|
+
((input, _path, _exceptionable = true) => ("object" === typeof input && null !== input || _report(true, {
|
|
151
|
+
path: _path + "",
|
|
152
|
+
expected: "IAutoBeAnalyzeWriteApplication.IProps",
|
|
153
|
+
value: input
|
|
154
|
+
})) && _vo0(input, _path + "", true) || _report(true, {
|
|
155
|
+
path: _path + "",
|
|
156
|
+
expected: "IAutoBeAnalyzeWriteApplication.IProps",
|
|
157
|
+
value: input
|
|
158
|
+
}))(input, "$input", true);
|
|
159
|
+
const success = 0 === errors.length;
|
|
160
|
+
return success ? {
|
|
161
|
+
success,
|
|
162
|
+
data: input
|
|
163
|
+
} : {
|
|
164
|
+
success,
|
|
165
|
+
errors,
|
|
166
|
+
data: input
|
|
167
|
+
};
|
|
168
|
+
}
|
|
169
|
+
return {
|
|
170
|
+
success: true,
|
|
156
171
|
data: input
|
|
157
|
-
}
|
|
158
|
-
|
|
159
|
-
|
|
172
|
+
};
|
|
173
|
+
}; })()
|
|
174
|
+
}
|
|
175
|
+
]
|
|
176
|
+
},
|
|
177
|
+
claude: {
|
|
178
|
+
model: "claude",
|
|
179
|
+
options: {
|
|
180
|
+
reference: true,
|
|
181
|
+
separate: null
|
|
182
|
+
},
|
|
183
|
+
functions: [
|
|
184
|
+
{
|
|
185
|
+
name: "write",
|
|
186
|
+
parameters: {
|
|
187
|
+
description: " - The properties containing the document plan and initial\ncontent\n\n------------------------------\n\nCurrent Type: {@link IAutoBeAnalyzeWriteApplication.IProps}",
|
|
188
|
+
type: "object",
|
|
189
|
+
properties: {
|
|
190
|
+
plan: {
|
|
191
|
+
description: "Step 1 (CoT: Plan Phase) - Document Planning Structure\n\nThe document planning structure that outlines what needs to be written.\n\nThis includes:\n\n- Document title and purpose\n- Table of contents structure\n- Key sections to be covered\n- Relationships with other documents\n- Target audience (backend developers)\n\nThe plan serves as a roadmap for the AI agent to ensure all necessary\ntopics are covered in the documentation process.\n\nExample plan structure:\n\n- Service overview with business model\n- User actors and authentication requirements\n- Functional requirements with EARS format\n- Non-functional requirements\n- Business requirements in natural language\n- User scenarios and use cases",
|
|
192
|
+
type: "string"
|
|
193
|
+
},
|
|
194
|
+
content: {
|
|
195
|
+
description: "Step 2 (CoT: Write Phase) - Complete Document Content\n\nThe complete, production-ready markdown document content to be saved.\n\nRequirements:\n\n- Minimum 5,000 characters for technical documents\n- Uses EARS format for all applicable requirements\n- Includes proper Mermaid diagram syntax (double quotes for labels)\n- Focuses on business requirements in natural language\n- PROHIBITED: Database schemas, ERD, API specifications",
|
|
196
|
+
type: "string"
|
|
197
|
+
}
|
|
198
|
+
},
|
|
199
|
+
required: [
|
|
200
|
+
"plan",
|
|
201
|
+
"content"
|
|
202
|
+
],
|
|
203
|
+
additionalProperties: false,
|
|
204
|
+
$defs: {}
|
|
205
|
+
},
|
|
206
|
+
description: "Creates or updates planning documentation based on the provided plan and\ncontent structure.\n\nThis function is called by the AI agent to write detailed planning\ndocuments that will be used by backend developers to understand what needs\nto be built, why it's being built, and how it should function.",
|
|
207
|
+
validate: (() => { const _io0 = input => "string" === typeof input.plan && "string" === typeof input.content; const _vo0 = (input, _path, _exceptionable = true) => ["string" === typeof input.plan || _report(_exceptionable, {
|
|
208
|
+
path: _path + ".plan",
|
|
209
|
+
expected: "string",
|
|
210
|
+
value: input.plan
|
|
211
|
+
}), "string" === typeof input.content || _report(_exceptionable, {
|
|
212
|
+
path: _path + ".content",
|
|
213
|
+
expected: "string",
|
|
214
|
+
value: input.content
|
|
215
|
+
})].every(flag => flag); const __is = input => "object" === typeof input && null !== input && _io0(input); let errors; let _report; return input => {
|
|
216
|
+
if (false === __is(input)) {
|
|
217
|
+
errors = [];
|
|
218
|
+
_report = __typia_transform__validateReport._validateReport(errors);
|
|
219
|
+
((input, _path, _exceptionable = true) => ("object" === typeof input && null !== input || _report(true, {
|
|
220
|
+
path: _path + "",
|
|
221
|
+
expected: "IAutoBeAnalyzeWriteApplication.IProps",
|
|
222
|
+
value: input
|
|
223
|
+
})) && _vo0(input, _path + "", true) || _report(true, {
|
|
224
|
+
path: _path + "",
|
|
225
|
+
expected: "IAutoBeAnalyzeWriteApplication.IProps",
|
|
226
|
+
value: input
|
|
227
|
+
}))(input, "$input", true);
|
|
228
|
+
const success = 0 === errors.length;
|
|
229
|
+
return success ? {
|
|
230
|
+
success,
|
|
231
|
+
data: input
|
|
232
|
+
} : {
|
|
233
|
+
success,
|
|
234
|
+
errors,
|
|
235
|
+
data: input
|
|
236
|
+
};
|
|
237
|
+
}
|
|
238
|
+
return {
|
|
239
|
+
success: true,
|
|
160
240
|
data: input
|
|
161
241
|
};
|
|
162
|
-
}
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
}
|
|
169
|
-
]
|
|
170
|
-
};
|
|
171
|
-
const collection = {
|
|
172
|
-
chatgpt: {
|
|
173
|
-
model: "chatgpt",
|
|
242
|
+
}; })()
|
|
243
|
+
}
|
|
244
|
+
]
|
|
245
|
+
},
|
|
246
|
+
gemini: {
|
|
247
|
+
model: "gemini",
|
|
174
248
|
options: {
|
|
175
249
|
reference: true,
|
|
176
|
-
strict: false,
|
|
177
250
|
separate: null
|
|
178
251
|
},
|
|
179
252
|
functions: [
|
|
@@ -188,7 +261,7 @@ const collection = {
|
|
|
188
261
|
type: "string"
|
|
189
262
|
},
|
|
190
263
|
content: {
|
|
191
|
-
description: "Step 2 (CoT: Write Phase) - Document Content
|
|
264
|
+
description: "Step 2 (CoT: Write Phase) - Complete Document Content\n\nThe complete, production-ready markdown document content to be saved.\n\nRequirements:\n\n- Minimum 5,000 characters for technical documents\n- Uses EARS format for all applicable requirements\n- Includes proper Mermaid diagram syntax (double quotes for labels)\n- Focuses on business requirements in natural language\n- PROHIBITED: Database schemas, ERD, API specifications",
|
|
192
265
|
type: "string"
|
|
193
266
|
}
|
|
194
267
|
},
|
|
@@ -239,9 +312,5 @@ const collection = {
|
|
|
239
312
|
}
|
|
240
313
|
]
|
|
241
314
|
},
|
|
242
|
-
claude,
|
|
243
|
-
llama: claude,
|
|
244
|
-
deepseek: claude,
|
|
245
|
-
"3.1": claude,
|
|
246
315
|
};
|
|
247
316
|
//# sourceMappingURL=orchestrateAnalyzeWrite.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"orchestrateAnalyzeWrite.js","sourceRoot":"","sources":["../../../src/orchestrate/analyze/orchestrateAnalyzeWrite.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AASA,kDAA0B;AAC1B,+BAA0B;AAG1B,uEAAoE;AACpE,+FAA4F;AAGrF,MAAM,uBAAuB,GAAG,CACrC,GAAyB,EACzB,KAKC,EACiC,EAAE;;IACpC,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,cAAc,EAAE,GAAG,KAAK,CAAC;IACjD,MAAM,OAAO,GAA2D;QACtE,KAAK,EAAE,IAAI;KACZ,CAAC;IACF,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,GAAG,CAAC,UAAU,CAAC;QAClD,MAAM,EAAE,cAAc;QACtB,UAAU,EAAE,gBAAgB,CAAQ;YAClC,KAAK,EAAE,GAAG,CAAC,KAAK;YAChB,OAAO;SACR,CAAC;QACF,SAAS,EAAE,IAAA,+DAA8B,EAAC,GAAG,EAAE,KAAK,CAAC;QACrD,mBAAmB,EAAE,IAAI;QACzB,cAAc;QACd,OAAO,EAAE,oCAAoC;KAC9C,CAAC,CAAC;IACH,IAAI,OAAO,CAAC,KAAK,KAAK,IAAI;QACxB,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;IAEtE,MAAM,KAAK,GAA4B;QACrC,IAAI,EAAE,cAAc;QACpB,EAAE,EAAE,IAAA,SAAE,GAAE;QACR,IAAI,kCACC,IAAI,KACP,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,OAAO,GAC/B;QACD,UAAU;QACV,MAAM;QACN,IAAI,EAAE,CAAC,MAAA,MAAA,GAAG,CAAC,KAAK,EAAE,CAAC,OAAO,0CAAE,IAAI,mCAAI,CAAC,CAAC,CAAC,GAAG,CAAC;QAC3C,KAAK,EAAE,QAAQ,CAAC,KAAK;QACrB,SAAS,EAAE,EAAE,QAAQ,CAAC,SAAS;QAC/B,UAAU,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;KACrC,CAAC;IACF,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACpB,OAAO,KAAK,CAAC;AACf,CAAC,CAAA,CAAC;AA3CW,QAAA,uBAAuB,2BA2ClC;AAEF,SAAS,gBAAgB,CAAiC,KAGzD;IACC,IAAA,qCAAiB,EAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC/B,MAAM,WAAW,GAA2B,UAAU,CACpD,KAAK,CAAC,KAAK,
|
|
1
|
+
{"version":3,"file":"orchestrateAnalyzeWrite.js","sourceRoot":"","sources":["../../../src/orchestrate/analyze/orchestrateAnalyzeWrite.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AASA,kDAA0B;AAC1B,+BAA0B;AAG1B,uEAAoE;AACpE,+FAA4F;AAGrF,MAAM,uBAAuB,GAAG,CACrC,GAAyB,EACzB,KAKC,EACiC,EAAE;;IACpC,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,cAAc,EAAE,GAAG,KAAK,CAAC;IACjD,MAAM,OAAO,GAA2D;QACtE,KAAK,EAAE,IAAI;KACZ,CAAC;IACF,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,GAAG,CAAC,UAAU,CAAC;QAClD,MAAM,EAAE,cAAc;QACtB,UAAU,EAAE,gBAAgB,CAAQ;YAClC,KAAK,EAAE,GAAG,CAAC,KAAK;YAChB,OAAO;SACR,CAAC;QACF,SAAS,EAAE,IAAA,+DAA8B,EAAC,GAAG,EAAE,KAAK,CAAC;QACrD,mBAAmB,EAAE,IAAI;QACzB,cAAc;QACd,OAAO,EAAE,oCAAoC;KAC9C,CAAC,CAAC;IACH,IAAI,OAAO,CAAC,KAAK,KAAK,IAAI;QACxB,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;IAEtE,MAAM,KAAK,GAA4B;QACrC,IAAI,EAAE,cAAc;QACpB,EAAE,EAAE,IAAA,SAAE,GAAE;QACR,IAAI,kCACC,IAAI,KACP,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,OAAO,GAC/B;QACD,UAAU;QACV,MAAM;QACN,IAAI,EAAE,CAAC,MAAA,MAAA,GAAG,CAAC,KAAK,EAAE,CAAC,OAAO,0CAAE,IAAI,mCAAI,CAAC,CAAC,CAAC,GAAG,CAAC;QAC3C,KAAK,EAAE,QAAQ,CAAC,KAAK;QACrB,SAAS,EAAE,EAAE,QAAQ,CAAC,SAAS;QAC/B,UAAU,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;KACrC,CAAC;IACF,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACpB,OAAO,KAAK,CAAC;AACf,CAAC,CAAA,CAAC;AA3CW,QAAA,uBAAuB,2BA2ClC;AAEF,SAAS,gBAAgB,CAAiC,KAGzD;IACC,IAAA,qCAAiB,EAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC/B,MAAM,WAAW,GAA2B,UAAU,CACpD,KAAK,CAAC,KAAK,KAAK,SAAS;QACvB,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,KAAK,CAAC,KAAK,KAAK,QAAQ;YACxB,CAAC,CAAC,QAAQ;YACV,CAAC,CAAC,QAAQ,CACqD,CAAC;IACtE,OAAO;QACL,QAAQ,EAAE,OAAO;QACjB,IAAI,EAAE,UAAU;QAChB,WAAW;QACX,OAAO,EAAE;YACP,KAAK,EAAE,CAAO,KAAK,EAAE,EAAE;gBACrB,KAAK,CAAC,OAAO,CAAC,KAAK,GAAG,KAAK,CAAC;YAC9B,CAAC,CAAA;SACuC;KAC3C,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,GAAG;IACjB,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAAoE;IAC3E,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAAmE;IACzE,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAAmE;CAC1E,CAAC"}
|
|
@@ -1,24 +1,11 @@
|
|
|
1
1
|
export interface IAutoBeAnalyzeReviewApplication {
|
|
2
2
|
/**
|
|
3
|
-
* Enhances planning documentation
|
|
3
|
+
* Enhances and finalizes planning documentation.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
6
|
-
*
|
|
5
|
+
* Receives a draft document and outputs the improved version. The output is
|
|
6
|
+
* the enhanced document itself, not review comments.
|
|
7
7
|
*
|
|
8
|
-
*
|
|
9
|
-
* - Expanding sections that are too brief
|
|
10
|
-
* - Converting vague statements to specific EARS format requirements
|
|
11
|
-
* - Fixing Mermaid diagram syntax errors
|
|
12
|
-
* - Adding missing business processes and workflows
|
|
13
|
-
* - Ensuring proper document structure and completeness
|
|
14
|
-
*
|
|
15
|
-
* DO: Output the actual document content that will be saved.
|
|
16
|
-
* DO NOT: Output review comments or analysis of the document.
|
|
17
|
-
*
|
|
18
|
-
* Note: Any text output becomes part of the final document.
|
|
19
|
-
*
|
|
20
|
-
* @param props - The properties containing the document to enhance along with
|
|
21
|
-
* plan and review criteria for guidance
|
|
8
|
+
* @param props - Document content, plan, and review criteria
|
|
22
9
|
*/
|
|
23
10
|
review(props: IAutoBeAnalyzeReviewApplication.IProps): void;
|
|
24
11
|
}
|
|
@@ -47,8 +34,10 @@ export declare namespace IAutoBeAnalyzeReviewApplication {
|
|
|
47
34
|
* - DO NOT: Use spaces between brackets and quotes in Mermaid
|
|
48
35
|
* - DO: Make requirements specific and measurable in natural language
|
|
49
36
|
* - DO: Focus on business requirements and user scenarios
|
|
50
|
-
* - DO NOT: Accept documents containing database schemas or API
|
|
51
|
-
*
|
|
37
|
+
* - DO NOT: Accept documents containing database schemas or API
|
|
38
|
+
* specifications
|
|
39
|
+
* - DO: Describe business model and authentication requirements in natural
|
|
40
|
+
* language
|
|
52
41
|
*/
|
|
53
42
|
review: string;
|
|
54
43
|
/**
|
|
@@ -68,43 +57,19 @@ export declare namespace IAutoBeAnalyzeReviewApplication {
|
|
|
68
57
|
*/
|
|
69
58
|
plan: string;
|
|
70
59
|
/**
|
|
71
|
-
* Step 3 (CoT: Content Phase) -
|
|
72
|
-
*
|
|
73
|
-
* The actual markdown document content that incorporates review feedback.
|
|
74
|
-
*
|
|
75
|
-
* This field contains a COMPLETE MARKDOWN DOCUMENT that has already
|
|
76
|
-
* incorporated the review criteria and plan requirements.
|
|
77
|
-
*
|
|
78
|
-
* DO: Treat this as the final, production-ready document.
|
|
79
|
-
* DO NOT: Treat this as raw input to be reviewed.
|
|
80
|
-
*
|
|
81
|
-
* This content represents:
|
|
82
|
-
* - A fully-formed markdown document (.md file)
|
|
83
|
-
* - The result of applying review criteria to the original plan
|
|
84
|
-
* - A production-ready document for immediate deployment
|
|
85
|
-
* - Complete business requirements ready for developers
|
|
86
|
-
*
|
|
87
|
-
* The enhancer should treat this as the actual document content:
|
|
60
|
+
* Step 3 (CoT: Content Phase) - Document Content (INPUT → OUTPUT)
|
|
88
61
|
*
|
|
89
|
-
*
|
|
90
|
-
*
|
|
91
|
-
* - All sections from the plan are fully written
|
|
92
|
-
* - No vague or abstract statements
|
|
93
|
-
* - Proper use of EARS format for requirements
|
|
94
|
-
* - Correct Mermaid diagram syntax (double quotes mandatory)
|
|
95
|
-
* - Appropriate level of detail for backend implementation
|
|
96
|
-
* - Proper document linking (descriptive text, not raw filenames)
|
|
62
|
+
* INPUT: The document written by Write Agent (may have issues) OUTPUT: The
|
|
63
|
+
* enhanced, complete markdown document to be saved
|
|
97
64
|
*
|
|
98
|
-
*
|
|
65
|
+
* Enhancement requirements:
|
|
99
66
|
*
|
|
100
|
-
* -
|
|
101
|
-
* -
|
|
102
|
-
* -
|
|
103
|
-
* -
|
|
67
|
+
* - Fix Mermaid syntax errors (add quotes, fix arrows)
|
|
68
|
+
* - Convert vague statements to EARS format
|
|
69
|
+
* - Expand sections that are too brief
|
|
70
|
+
* - Add missing business processes
|
|
104
71
|
*
|
|
105
|
-
*
|
|
106
|
-
* "# Service Overview\n## Vision\nThe service provides..." (actual document)
|
|
107
|
-
* NOT: "This document should cover service overview..." (review comment)
|
|
72
|
+
* Output must be the actual document content (not review comments).
|
|
108
73
|
*/
|
|
109
74
|
content: string;
|
|
110
75
|
}
|
|
@@ -3,18 +3,12 @@ import { AutoBeAnalyzeFile } from "@autobe/interface/src/histories/contents/Auto
|
|
|
3
3
|
import { tags } from "typia";
|
|
4
4
|
export interface IAutoBeAnalyzeScenarioApplication {
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
6
|
+
* Composes project structure with actors and documentation files.
|
|
7
7
|
*
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
* define the documentation structure. These are managed separately. If you
|
|
11
|
-
* determine from the conversation that the user's requirements have not been
|
|
12
|
-
* fully gathered, you must stop the analysis and continue collecting the
|
|
13
|
-
* remaining requirements. In this case, you do not need to generate any files
|
|
14
|
-
* or actors. Simply pass an empty array to `input.files` and `input.actors`.
|
|
8
|
+
* Determines the list of user actors and documents to generate based on
|
|
9
|
+
* requirements. If requirements are incomplete, returns empty arrays.
|
|
15
10
|
*
|
|
16
|
-
* @param input
|
|
17
|
-
* @returns
|
|
11
|
+
* @param input - Project prefix, actors, and file list
|
|
18
12
|
*/
|
|
19
13
|
compose(input: IAutoBeAnalyzeScenarioApplication.IProps): void;
|
|
20
14
|
}
|
|
@@ -29,7 +23,15 @@ export declare namespace IAutoBeAnalyzeScenarioApplication {
|
|
|
29
23
|
* DO: Use camelCase naming convention.
|
|
30
24
|
*/
|
|
31
25
|
prefix: string & CamelCasePattern;
|
|
32
|
-
/**
|
|
26
|
+
/**
|
|
27
|
+
* Actors to be assigned for the project.
|
|
28
|
+
*
|
|
29
|
+
* Each actor has:
|
|
30
|
+
*
|
|
31
|
+
* - `name`: Actor identifier (camelCase)
|
|
32
|
+
* - `kind`: "guest" | "member" | "admin"
|
|
33
|
+
* - `description`: Actor's permissions and capabilities
|
|
34
|
+
*/
|
|
33
35
|
actors: AutoBeAnalyzeActor[];
|
|
34
36
|
/**
|
|
35
37
|
* Language for document content. When specified by the user, this takes
|
|
@@ -46,12 +48,14 @@ export declare namespace IAutoBeAnalyzeScenarioApplication {
|
|
|
46
48
|
*/
|
|
47
49
|
page: number;
|
|
48
50
|
/**
|
|
49
|
-
*
|
|
50
|
-
*
|
|
51
|
-
* File name must be English and it must contain the numbering and prefix.
|
|
51
|
+
* Array of document metadata objects defining files to be generated.
|
|
52
52
|
*
|
|
53
|
-
*
|
|
53
|
+
* Each array element is an AutoBeAnalyzeFile.Scenario object containing:
|
|
54
|
+
* - filename: The output file name (e.g., "01-service-overview.md")
|
|
55
|
+
* - reason: Why this document is being created
|
|
56
|
+
* - documentType, outline, constraints, etc.: Metadata guiding content generation
|
|
54
57
|
*
|
|
58
|
+
* These documents represent business-focused planning documentation:
|
|
55
59
|
* - Business requirements and functional specifications in natural language
|
|
56
60
|
* - User journey mapping and use case scenarios
|
|
57
61
|
* - Business rules and workflow definitions
|
|
@@ -61,17 +65,16 @@ export declare namespace IAutoBeAnalyzeScenarioApplication {
|
|
|
61
65
|
* - DO NOT: Include database schemas, ERD, or API specifications
|
|
62
66
|
* - DO: Write all requirements in natural language for clarity
|
|
63
67
|
*
|
|
64
|
-
* Generate
|
|
68
|
+
* Generate metadata objects based on actual requirements gathered from conversation.
|
|
65
69
|
* Do not create unnecessary documentation - only generate what is needed to
|
|
66
70
|
* properly define the business requirements and system specifications.
|
|
67
71
|
*
|
|
68
|
-
* #
|
|
72
|
+
* # Array Length Rules
|
|
69
73
|
*
|
|
70
|
-
* The
|
|
71
|
-
*
|
|
72
|
-
*
|
|
73
|
-
*
|
|
74
|
-
* to adequately support the service.
|
|
74
|
+
* The array length must match the user's requested page count plus one for ToC.
|
|
75
|
+
* For example: user requests 3 pages → generate 4 objects (1 ToC + 3 content).
|
|
76
|
+
* If user does not specify a number, generate sufficient objects to adequately
|
|
77
|
+
* document the service (typically 11+ objects including ToC).
|
|
75
78
|
*/
|
|
76
79
|
files: Array<AutoBeAnalyzeFile.Scenario> & tags.MinItems<1>;
|
|
77
80
|
}
|
|
@@ -41,33 +41,17 @@ export declare namespace IAutoBeAnalyzeWriteApplication {
|
|
|
41
41
|
*/
|
|
42
42
|
plan: string;
|
|
43
43
|
/**
|
|
44
|
-
* Step 2 (CoT: Write Phase) - Document Content
|
|
44
|
+
* Step 2 (CoT: Write Phase) - Complete Document Content
|
|
45
45
|
*
|
|
46
|
-
* The
|
|
46
|
+
* The complete, production-ready markdown document content to be saved.
|
|
47
47
|
*
|
|
48
|
-
*
|
|
48
|
+
* Requirements:
|
|
49
49
|
*
|
|
50
|
-
* -
|
|
51
|
-
* - Existing documentation to build upon
|
|
52
|
-
* - Specific scenarios or use cases to document
|
|
53
|
-
* - Technical constraints or preferences
|
|
54
|
-
* - Related documents for reference
|
|
55
|
-
*
|
|
56
|
-
* The content provides the raw material that the AI agent will transform
|
|
57
|
-
* into structured, developer-ready documentation following the planning
|
|
58
|
-
* guidelines.
|
|
59
|
-
*
|
|
60
|
-
* The AI agent will expand this content into comprehensive documentation
|
|
61
|
-
* that:
|
|
62
|
-
*
|
|
63
|
-
* - Removes all ambiguity for backend developers
|
|
64
|
-
* - Provides specific, measurable requirements in natural language
|
|
65
|
-
* - Focuses on business logic and requirements, NOT technical implementation
|
|
66
|
-
* - STRICTLY PROHIBITED: Do NOT write database schemas, ERD, or API
|
|
67
|
-
* specifications
|
|
50
|
+
* - Minimum 5,000 characters for technical documents
|
|
68
51
|
* - Uses EARS format for all applicable requirements
|
|
69
|
-
* -
|
|
70
|
-
* -
|
|
52
|
+
* - Includes proper Mermaid diagram syntax (double quotes for labels)
|
|
53
|
+
* - Focuses on business requirements in natural language
|
|
54
|
+
* - PROHIBITED: Database schemas, ERD, API specifications
|
|
71
55
|
*/
|
|
72
56
|
content: string;
|
|
73
57
|
}
|