@polymorphism-tech/morph-spec 4.6.0 → 4.7.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.
Files changed (239) hide show
  1. package/README.md +414 -700
  2. package/docs/ARCHITECTURE.md +331 -0
  3. package/docs/CHEATSHEET.md +221 -0
  4. package/docs/COMMAND-FLOWS.md +368 -0
  5. package/docs/QUICKSTART.md +212 -0
  6. package/docs/examples/order-management/contracts.cs +84 -0
  7. package/docs/examples/order-management/proposal.md +24 -0
  8. package/docs/examples/order-management/spec.md +162 -0
  9. package/docs/plans/2026-02-23-ddd-architecture-refactor.md +1153 -0
  10. package/docs/plans/2026-02-23-ddd-nextsteps.md +682 -0
  11. package/docs/plans/2026-02-23-infra-architect-refactor.md +437 -0
  12. package/docs/plans/2026-02-23-nextjs-code-review-design.md +156 -0
  13. package/docs/plans/2026-02-23-nextjs-code-review-impl.md +1254 -0
  14. package/docs/plans/2026-02-23-nextjs-standards-design.md +149 -0
  15. package/docs/plans/2026-02-23-nextjs-standards-impl.md +1846 -0
  16. package/framework/agents/README.md +14 -14
  17. package/framework/agents/architecture/standards-architect.md +159 -159
  18. package/framework/agents/frontend/nextjs-expert.md +87 -127
  19. package/framework/agents/infrastructure/azure-architect.md +147 -147
  20. package/framework/agents/infrastructure/infra-architect.md +45 -0
  21. package/framework/agents.json +1145 -278
  22. package/framework/rules/frontend-standards.md +0 -3
  23. package/framework/rules/nextjs-standards.md +17 -0
  24. package/framework/skills/level-0-meta/code-review-nextjs/SKILL.md +147 -0
  25. package/framework/skills/level-0-meta/code-review-nextjs/references/review-example-nextjs.md +254 -0
  26. package/framework/skills/level-0-meta/tool-usage-guide/SKILL.md +3 -3
  27. package/framework/skills/level-1-workflows/phase-design/SKILL.md +45 -9
  28. package/framework/skills/level-1-workflows/phase-tasks/SKILL.md +38 -0
  29. package/framework/standards/STANDARDS.json +121 -0
  30. package/framework/standards/architecture/ddd/bounded-contexts.md +105 -0
  31. package/framework/standards/architecture/ddd/complexity-levels.md +108 -0
  32. package/framework/standards/architecture/ddd/ubiquitous-language.md +58 -0
  33. package/framework/standards/frontend/nextjs/app-router.md +123 -0
  34. package/framework/standards/frontend/nextjs/components.md +132 -0
  35. package/framework/standards/frontend/nextjs/data-fetching.md +126 -0
  36. package/framework/standards/frontend/nextjs/forms.md +128 -0
  37. package/framework/standards/frontend/nextjs/naming-conventions.md +67 -0
  38. package/framework/standards/frontend/nextjs/project-structure.md +102 -0
  39. package/framework/standards/frontend/nextjs/state-management.md +72 -0
  40. package/framework/standards/frontend/nextjs/testing.md +111 -0
  41. package/framework/templates/REGISTRY.json +538 -142
  42. package/framework/templates/code/dotnet/contracts/contracts-level1.cs +69 -0
  43. package/framework/templates/code/dotnet/contracts/contracts-level2.cs +86 -0
  44. package/framework/templates/code/dotnet/contracts/contracts-level3.cs +41 -0
  45. package/framework/templates/docs/spec.md +49 -0
  46. package/framework/templates/frontend/nextjs/Dockerfile.nextjs.hbs +43 -0
  47. package/framework/templates/frontend/nextjs/client-component.tsx.hbs +26 -0
  48. package/framework/templates/frontend/nextjs/env.mjs.hbs +32 -0
  49. package/framework/templates/frontend/nextjs/feature-form.tsx.hbs +56 -0
  50. package/framework/templates/frontend/nextjs/page.tsx.hbs +22 -0
  51. package/framework/templates/frontend/nextjs/tsconfig.json.hbs +26 -0
  52. package/framework/templates/frontend/nextjs/use-feature.ts.hbs +54 -0
  53. package/framework/templates/project-structure/dotnet-ddd.md +70 -0
  54. package/framework/workflows/docs/enforcement-pipeline.md +2 -1
  55. package/package.json +1 -1
  56. package/scripts/scan-nextjs.mjs +169 -0
  57. package/src/commands/project/doctor.js +52 -1
  58. package/src/commands/project/init.js +15 -1
  59. package/src/commands/project/update.js +6 -1
  60. package/src/lib/standards/standards-context-injector.js +5 -0
  61. package/src/lib/validators/nextjs/index.js +6 -0
  62. package/src/lib/validators/nextjs/next-component-validator.js +181 -0
  63. package/src/lib/validators/validation-runner.js +5 -0
  64. package/src/utils/agents-installer.js +14 -2
  65. package/.morph/.morphversion +0 -5
  66. package/.morph/analytics/threads-log.jsonl +0 -6
  67. package/.morph/config/config.json +0 -8
  68. package/.morph/framework/agents.json +0 -948
  69. package/.morph/framework/standards/STANDARDS.json +0 -812
  70. package/.morph/framework/standards/ai-agents/blazor-ui.md +0 -364
  71. package/.morph/framework/standards/ai-agents/production.md +0 -415
  72. package/.morph/framework/standards/ai-agents/setup.md +0 -418
  73. package/.morph/framework/standards/ai-agents/team-orchestration.md +0 -479
  74. package/.morph/framework/standards/ai-agents/workflows.md +0 -354
  75. package/.morph/framework/standards/architecture/ddd/aggregates.md +0 -120
  76. package/.morph/framework/standards/architecture/ddd/entities.md +0 -99
  77. package/.morph/framework/standards/architecture/ddd/value-objects.md +0 -124
  78. package/.morph/framework/standards/backend/api/minimal-api.md +0 -494
  79. package/.morph/framework/standards/backend/api/rest.md +0 -492
  80. package/.morph/framework/standards/backend/api/validation.md +0 -88
  81. package/.morph/framework/standards/backend/authentication/passkeys.md +0 -428
  82. package/.morph/framework/standards/backend/database/ef-core.md +0 -199
  83. package/.morph/framework/standards/backend/database/migrations.md +0 -393
  84. package/.morph/framework/standards/backend/database/postgresql/database.md +0 -352
  85. package/.morph/framework/standards/backend/database/repository-patterns.md +0 -528
  86. package/.morph/framework/standards/backend/database/vector-search-rag.md +0 -541
  87. package/.morph/framework/standards/backend/dotnet/async.md +0 -366
  88. package/.morph/framework/standards/backend/dotnet/core.md +0 -117
  89. package/.morph/framework/standards/backend/dotnet/di.md +0 -439
  90. package/.morph/framework/standards/backend/dotnet/program-cs-checklist.md +0 -92
  91. package/.morph/framework/standards/backend/integrations/asaas/asaas-api.md +0 -216
  92. package/.morph/framework/standards/backend/integrations/clerk/clerk-auth.md +0 -290
  93. package/.morph/framework/standards/backend/integrations/hangfire/hangfire-jobs.md +0 -350
  94. package/.morph/framework/standards/backend/integrations/resend/resend-email.md +0 -385
  95. package/.morph/framework/standards/context/analytics.md +0 -96
  96. package/.morph/framework/standards/context/bundles.md +0 -110
  97. package/.morph/framework/standards/context/priming.md +0 -78
  98. package/.morph/framework/standards/core/architecture.md +0 -185
  99. package/.morph/framework/standards/core/coding.md +0 -214
  100. package/.morph/framework/standards/core/git-branching-strategy.md +0 -403
  101. package/.morph/framework/standards/core/git.md +0 -185
  102. package/.morph/framework/standards/core/testing.md +0 -295
  103. package/.morph/framework/standards/data/nosql/blob-storage.md +0 -102
  104. package/.morph/framework/standards/data/nosql/cache/redis.md +0 -97
  105. package/.morph/framework/standards/data/nosql/cosmos-db.md +0 -118
  106. package/.morph/framework/standards/data/vector-search/azure-ai-search.md +0 -121
  107. package/.morph/framework/standards/data/vector-search/rag-chunking.md +0 -104
  108. package/.morph/framework/standards/frontend/blazor/design-checklist.md +0 -222
  109. package/.morph/framework/standards/frontend/blazor/fluent-ui-setup.md +0 -595
  110. package/.morph/framework/standards/frontend/blazor/fluent-ui.md +0 -137
  111. package/.morph/framework/standards/frontend/blazor/html-conversion.md +0 -184
  112. package/.morph/framework/standards/frontend/blazor/lifecycle.md +0 -195
  113. package/.morph/framework/standards/frontend/blazor/pitfalls.md +0 -198
  114. package/.morph/framework/standards/frontend/blazor/state.md +0 -191
  115. package/.morph/framework/standards/frontend/design-system/animations.md +0 -151
  116. package/.morph/framework/standards/frontend/design-system/naming.md +0 -64
  117. package/.morph/framework/standards/frontend/nextjs/nextjs-patterns.md +0 -215
  118. package/.morph/framework/standards/infrastructure/azure/azure.md +0 -624
  119. package/.morph/framework/standards/infrastructure/azure/bicep/bicep-patterns.md +0 -422
  120. package/.morph/framework/standards/infrastructure/azure/devops/azure-devops-setup.md +0 -516
  121. package/.morph/framework/standards/infrastructure/azure/devops/local-development.md +0 -520
  122. package/.morph/framework/standards/infrastructure/azure/services/functions.md +0 -486
  123. package/.morph/framework/standards/infrastructure/azure/services/service-bus.md +0 -459
  124. package/.morph/framework/standards/infrastructure/azure/services/storage.md +0 -407
  125. package/.morph/framework/standards/infrastructure/docker/easypanel-deploy.md +0 -196
  126. package/.morph/framework/standards/infrastructure/supabase/mcp-setup.md +0 -252
  127. package/.morph/framework/standards/infrastructure/supabase/supabase-auth.md +0 -176
  128. package/.morph/framework/standards/infrastructure/supabase/supabase-pgvector.md +0 -169
  129. package/.morph/framework/standards/infrastructure/supabase/supabase-rls.md +0 -184
  130. package/.morph/framework/standards/infrastructure/supabase/supabase-storage.md +0 -153
  131. package/.morph/framework/standards/integration/api/graphql.md +0 -91
  132. package/.morph/framework/standards/integration/api/grpc.md +0 -114
  133. package/.morph/framework/standards/integration/api/rest-design.md +0 -95
  134. package/.morph/framework/standards/integration/event-driven/cqrs.md +0 -101
  135. package/.morph/framework/standards/integration/event-driven/event-sourcing.md +0 -124
  136. package/.morph/framework/standards/integration/event-driven/service-bus.md +0 -95
  137. package/.morph/framework/standards/integration/mcp/mcp-tools.md +0 -384
  138. package/.morph/framework/standards/observability/logging.md +0 -131
  139. package/.morph/framework/standards/observability/metrics.md +0 -121
  140. package/.morph/framework/standards/observability/monitoring.md +0 -114
  141. package/.morph/framework/standards/observability/tracing.md +0 -132
  142. package/.morph/framework/standards/workflows/parallel-execution.md +0 -112
  143. package/.morph/framework/standards/workflows/thread-management.md +0 -113
  144. package/.morph/framework/templates/.idea/morph-templates.xml +0 -92
  145. package/.morph/framework/templates/.vscode/morph-templates.code-snippets +0 -186
  146. package/.morph/framework/templates/IDE-SNIPPETS.md +0 -266
  147. package/.morph/framework/templates/README.md +0 -814
  148. package/.morph/framework/templates/REGISTRY.json +0 -1492
  149. package/.morph/framework/templates/code/dotnet/backend/repository.cs +0 -141
  150. package/.morph/framework/templates/code/dotnet/backend/service.cs +0 -139
  151. package/.morph/framework/templates/code/dotnet/contracts/Commands.cs +0 -74
  152. package/.morph/framework/templates/code/dotnet/contracts/Entities.cs +0 -25
  153. package/.morph/framework/templates/code/dotnet/contracts/Queries.cs +0 -74
  154. package/.morph/framework/templates/code/dotnet/contracts/README.md +0 -74
  155. package/.morph/framework/templates/code/dotnet/contracts/api-contracts.cs +0 -173
  156. package/.morph/framework/templates/code/dotnet/contracts/contracts.cs +0 -217
  157. package/.morph/framework/templates/code/dotnet/contracts/contracts.cs.hbs +0 -172
  158. package/.morph/framework/templates/code/dotnet/database/migration.cs +0 -83
  159. package/.morph/framework/templates/code/dotnet/frontend/component.razor +0 -239
  160. package/.morph/framework/templates/code/dotnet/jobs/agent.cs +0 -163
  161. package/.morph/framework/templates/code/dotnet/jobs/job.cs +0 -171
  162. package/.morph/framework/templates/code/dotnet/test.cs +0 -239
  163. package/.morph/framework/templates/code/sql/rls-policy.sql +0 -57
  164. package/.morph/framework/templates/code/sql/supabase-migration.sql +0 -100
  165. package/.morph/framework/templates/code/sql/supabase-migration.template.sql +0 -113
  166. package/.morph/framework/templates/code/typescript/contracts.ts +0 -168
  167. package/.morph/framework/templates/context/CONTEXT-FEATURE.md +0 -276
  168. package/.morph/framework/templates/context/CONTEXT.md +0 -181
  169. package/.morph/framework/templates/docs/clarifications.md +0 -253
  170. package/.morph/framework/templates/docs/onboarding.md +0 -123
  171. package/.morph/framework/templates/docs/proposal.md +0 -182
  172. package/.morph/framework/templates/docs/schema-analysis.md +0 -119
  173. package/.morph/framework/templates/docs/spec.md +0 -149
  174. package/.morph/framework/templates/docs/ui-components.md +0 -124
  175. package/.morph/framework/templates/docs/ui-design-system.md +0 -76
  176. package/.morph/framework/templates/docs/ui-flows.md +0 -167
  177. package/.morph/framework/templates/docs/ui-mockups.md +0 -98
  178. package/.morph/framework/templates/docs/user-stories.md +0 -34
  179. package/.morph/framework/templates/examples/design-system-examples.md +0 -357
  180. package/.morph/framework/templates/examples/spec-examples.md +0 -90
  181. package/.morph/framework/templates/feature/decisions.md +0 -187
  182. package/.morph/framework/templates/feature/recap.md +0 -146
  183. package/.morph/framework/templates/feature/tasks.md +0 -199
  184. package/.morph/framework/templates/infrastructure/azure/Dockerfile.example +0 -82
  185. package/.morph/framework/templates/infrastructure/azure/README.md +0 -286
  186. package/.morph/framework/templates/infrastructure/azure/app-insights.bicep +0 -63
  187. package/.morph/framework/templates/infrastructure/azure/app-service.bicep +0 -164
  188. package/.morph/framework/templates/infrastructure/azure/container-app-env.bicep +0 -49
  189. package/.morph/framework/templates/infrastructure/azure/container-app.bicep +0 -156
  190. package/.morph/framework/templates/infrastructure/azure/deploy-checklist.md +0 -426
  191. package/.morph/framework/templates/infrastructure/azure/deploy.ps1 +0 -229
  192. package/.morph/framework/templates/infrastructure/azure/deploy.sh +0 -208
  193. package/.morph/framework/templates/infrastructure/azure/key-vault.bicep +0 -91
  194. package/.morph/framework/templates/infrastructure/azure/main.bicep +0 -189
  195. package/.morph/framework/templates/infrastructure/azure/parameters.dev.json +0 -29
  196. package/.morph/framework/templates/infrastructure/azure/parameters.prod.json +0 -29
  197. package/.morph/framework/templates/infrastructure/azure/parameters.staging.json +0 -29
  198. package/.morph/framework/templates/infrastructure/azure/sql-database.bicep +0 -103
  199. package/.morph/framework/templates/infrastructure/azure/storage.bicep +0 -106
  200. package/.morph/framework/templates/infrastructure/docker/Dockerfile.template +0 -58
  201. package/.morph/framework/templates/infrastructure/docker/docker-compose.template.yml +0 -67
  202. package/.morph/framework/templates/infrastructure/docker/dockerfile-api.dockerfile +0 -38
  203. package/.morph/framework/templates/infrastructure/docker/dockerfile-web.dockerfile +0 -48
  204. package/.morph/framework/templates/infrastructure/docker/easypanel.template.json +0 -54
  205. package/.morph/framework/templates/infrastructure/github/README.md +0 -593
  206. package/.morph/framework/templates/infrastructure/github/actions/azure-auth/action.yml.hbs +0 -22
  207. package/.morph/framework/templates/infrastructure/github/actions/docker-build-push/action.yml.hbs +0 -45
  208. package/.morph/framework/templates/infrastructure/github/actions/health-check/action.yml.hbs +0 -27
  209. package/.morph/framework/templates/infrastructure/github/workflows/deploy-azure-app-service.yml.hbs +0 -61
  210. package/.morph/framework/templates/infrastructure/github/workflows/deploy-easypanel.yml.hbs +0 -31
  211. package/.morph/framework/templates/infrastructure/github/workflows/docker-build-push.yml.hbs +0 -59
  212. package/.morph/framework/templates/infrastructure/github/workflows/dotnet-build.yml.hbs +0 -39
  213. package/.morph/framework/templates/integrations/asaas-client.cs +0 -387
  214. package/.morph/framework/templates/integrations/asaas-webhook.cs +0 -351
  215. package/.morph/framework/templates/integrations/azure-identity-config.cs +0 -288
  216. package/.morph/framework/templates/integrations/clerk-config.cs +0 -258
  217. package/.morph/framework/templates/meta-prompts/fusion/fusion-agent.md +0 -76
  218. package/.morph/framework/templates/meta-prompts/fusion/fusion-aggregator.md +0 -100
  219. package/.morph/framework/templates/meta-prompts/hops/hop-retry.md +0 -78
  220. package/.morph/framework/templates/meta-prompts/hops/hop-validation.md +0 -97
  221. package/.morph/framework/templates/meta-prompts/hops/hop-wrapper.md +0 -36
  222. package/.morph/framework/templates/meta-prompts/parallel-workers/parallel-coordinator.md +0 -113
  223. package/.morph/framework/templates/meta-prompts/parallel-workers/parallel-worker.md +0 -80
  224. package/.morph/framework/templates/meta-prompts/squad-leaders/backend-squad.md +0 -90
  225. package/.morph/framework/templates/meta-prompts/squad-leaders/frontend-squad.md +0 -126
  226. package/.morph/framework/templates/meta-prompts/squad-leaders/squad-leader.md +0 -43
  227. package/.morph/framework/templates/meta-prompts/validators/checkpoint-validator.md +0 -107
  228. package/.morph/framework/templates/meta-prompts/validators/pre-commit-validator.md +0 -95
  229. package/.morph/framework/templates/saas/subscription.cs +0 -347
  230. package/.morph/framework/templates/saas/tenant.cs +0 -338
  231. package/.morph/framework/templates/state.template.json +0 -17
  232. package/.morph/framework/templates/ui/FluentDesignTheme.cs +0 -149
  233. package/.morph/framework/templates/ui/MudTheme.cs +0 -281
  234. package/.morph/framework/templates/ui/design-system.css +0 -226
  235. package/.morph/logs/tool-failures.log +0 -7
  236. package/.morph/memory/pre-compact-2026-02-23T15-43-03-521Z.json +0 -16
  237. package/.morph/state.json +0 -48
  238. package/framework/templates/code/dotnet/contracts/contracts.cs +0 -217
  239. package/framework/templates/code/dotnet/contracts/contracts.cs.hbs +0 -172
@@ -1,121 +0,0 @@
1
- # Data Standard: Azure AI Search (Vector Search)
2
-
3
- ## Overview
4
- Azure AI Search provides vector and hybrid search for RAG (Retrieval-Augmented Generation) patterns.
5
-
6
- ## Index Design
7
- ```csharp
8
- // Define index with vector field
9
- var index = new SearchIndex("documents-index")
10
- {
11
- Fields =
12
- [
13
- new SimpleField("id", SearchFieldDataType.String) { IsKey = true },
14
- new SearchableField("content") { AnalyzerName = "pt.microsoft" },
15
- new SearchableField("title") { AnalyzerName = "pt.microsoft" },
16
- new SimpleField("sourceUrl", SearchFieldDataType.String) { IsFilterable = true },
17
- new SimpleField("category", SearchFieldDataType.String) { IsFilterable = true, IsFacetable = true },
18
- new VectorSearchField("contentVector", dimensions: 1536, vectorSearchProfileName: "hnsw-profile")
19
- ],
20
- VectorSearch = new VectorSearch
21
- {
22
- Profiles = { new VectorSearchProfile("hnsw-profile", "hnsw-config") },
23
- Algorithms = { new HnswAlgorithmConfiguration("hnsw-config") }
24
- }
25
- };
26
- await indexClient.CreateOrUpdateIndexAsync(index);
27
- ```
28
-
29
- ## Embedding Generation
30
- ```csharp
31
- public class EmbeddingService : IEmbeddingService
32
- {
33
- private readonly OpenAIClient _client;
34
- private const string EmbeddingModel = "text-embedding-ada-002"; // 1536 dimensions
35
-
36
- public async Task<float[]> GenerateEmbeddingAsync(string text)
37
- {
38
- // Truncate to model limit
39
- var truncated = text.Length > 8192 ? text[..8192] : text;
40
-
41
- var response = await _client.GetEmbeddingsAsync(
42
- new EmbeddingsOptions(EmbeddingModel, [truncated]));
43
-
44
- return response.Value.Data[0].Embedding.ToArray();
45
- }
46
-
47
- public async Task<IReadOnlyList<float[]>> GenerateBatchEmbeddingsAsync(IReadOnlyList<string> texts)
48
- {
49
- var response = await _client.GetEmbeddingsAsync(
50
- new EmbeddingsOptions(EmbeddingModel, texts));
51
- return response.Value.Data.Select(d => d.Embedding.ToArray()).ToList();
52
- }
53
- }
54
- ```
55
-
56
- ## Document Indexing
57
- ```csharp
58
- public class DocumentIndexer
59
- {
60
- public async Task IndexDocumentAsync(Document doc)
61
- {
62
- var embedding = await _embeddingService.GenerateEmbeddingAsync(doc.Content);
63
-
64
- var searchDoc = new SearchDocument
65
- {
66
- ["id"] = doc.Id.ToString(),
67
- ["content"] = doc.Content,
68
- ["title"] = doc.Title,
69
- ["sourceUrl"] = doc.SourceUrl,
70
- ["category"] = doc.Category,
71
- ["contentVector"] = embedding
72
- };
73
-
74
- await _searchClient.MergeOrUploadDocumentsAsync([searchDoc]);
75
- }
76
- }
77
- ```
78
-
79
- ## Hybrid Search (Vector + Keyword)
80
- ```csharp
81
- public async Task<IReadOnlyList<SearchResult>> SearchAsync(string query, string? category = null)
82
- {
83
- var queryEmbedding = await _embeddingService.GenerateEmbeddingAsync(query);
84
-
85
- var options = new SearchOptions
86
- {
87
- Filter = category != null ? $"category eq '{category}'" : null,
88
- Size = 10,
89
- VectorSearch = new VectorSearchOptions
90
- {
91
- Queries =
92
- {
93
- new VectorizedQuery(queryEmbedding)
94
- {
95
- Fields = { "contentVector" },
96
- KNearestNeighborsCount = 50
97
- }
98
- }
99
- },
100
- QueryType = SearchQueryType.Semantic,
101
- SemanticSearch = new SemanticSearchOptions
102
- {
103
- SemanticConfigurationName = "my-semantic-config",
104
- QueryCaption = new QueryCaption(QueryCaptionType.Extractive)
105
- }
106
- };
107
-
108
- var response = await _searchClient.SearchAsync<SearchDocument>(query, options);
109
- return await response.Value.GetResultsAsync().Select(r => new SearchResult(
110
- r.Document["id"].ToString()!,
111
- r.Document["content"].ToString()!,
112
- r.Score ?? 0
113
- )).ToListAsync();
114
- }
115
- ```
116
-
117
- ## Cost Optimization
118
- - Index only necessary fields (cost per GB/month)
119
- - Use semantic ranking sparingly (higher cost per query)
120
- - Cache frequent query embeddings (embeddings are stable for same text)
121
- - Batch indexing for large document sets (avoid per-document API calls)
@@ -1,104 +0,0 @@
1
- # Data Standard: RAG Chunking Strategies
2
-
3
- ## Overview
4
- Chunking splits documents into segments for embedding. Chunk quality directly impacts RAG answer quality.
5
-
6
- ## Chunking Strategies
7
-
8
- ### 1. Fixed-Size (Baseline)
9
- ```csharp
10
- public IEnumerable<Chunk> FixedSizeChunk(string text, int size = 512, int overlap = 50)
11
- {
12
- for (int i = 0; i < text.Length; i += size - overlap)
13
- {
14
- yield return new Chunk
15
- {
16
- Content = text[i..Math.Min(i + size, text.Length)],
17
- StartIndex = i,
18
- EndIndex = Math.Min(i + size, text.Length)
19
- };
20
- }
21
- }
22
- ```
23
-
24
- ### 2. Sentence-Aware (Recommended for prose)
25
- ```csharp
26
- public IEnumerable<Chunk> SentenceChunk(string text, int maxTokens = 256)
27
- {
28
- var sentences = SplitSentences(text);
29
- var current = new StringBuilder();
30
- var tokenCount = 0;
31
-
32
- foreach (var sentence in sentences)
33
- {
34
- var sentenceTokens = EstimateTokens(sentence);
35
- if (tokenCount + sentenceTokens > maxTokens && current.Length > 0)
36
- {
37
- yield return new Chunk { Content = current.ToString().Trim() };
38
- current.Clear();
39
- tokenCount = 0;
40
- }
41
- current.Append(sentence).Append(' ');
42
- tokenCount += sentenceTokens;
43
- }
44
-
45
- if (current.Length > 0)
46
- yield return new Chunk { Content = current.ToString().Trim() };
47
- }
48
- ```
49
-
50
- ### 3. Semantic (Best quality, higher cost)
51
- Split at semantic boundaries (paragraphs, headers, sections) rather than character count.
52
-
53
- ```csharp
54
- public IEnumerable<Chunk> SemanticChunk(string markdown)
55
- {
56
- // Split at markdown headers
57
- var sections = Regex.Split(markdown, @"(?=^#{1,3} )", RegexOptions.Multiline);
58
- foreach (var section in sections.Where(s => s.Trim().Length > 0))
59
- yield return new Chunk { Content = section.Trim() };
60
- }
61
- ```
62
-
63
- ## Token Estimation
64
- ```csharp
65
- // Rough estimate: 1 token ≈ 4 characters (English), ≈ 3 characters (Portuguese)
66
- private static int EstimateTokens(string text) => text.Length / 4;
67
-
68
- // More accurate: use tiktoken (if available)
69
- // var encoder = TiktokenSharp.TikToken.EncodingForModel("gpt-4");
70
- // return encoder.Encode(text).Count;
71
- ```
72
-
73
- ## Chunk Metadata
74
- Always store metadata with chunks for filtering and citation:
75
- ```csharp
76
- public record Chunk
77
- {
78
- public string Content { get; init; } = "";
79
- public string DocumentId { get; init; } = "";
80
- public string DocumentTitle { get; init; } = "";
81
- public string SourceUrl { get; init; } = "";
82
- public int ChunkIndex { get; init; }
83
- public int StartCharIndex { get; init; }
84
- public string Section { get; init; } = ""; // H1/H2 header this belongs to
85
- public DateTime IndexedAt { get; init; } = DateTime.UtcNow;
86
- }
87
- ```
88
-
89
- ## Strategy Selection Guide
90
- | Document Type | Strategy | Chunk Size |
91
- |---------------|----------|------------|
92
- | Legal documents | Sentence-aware | 256 tokens |
93
- | Technical docs | Semantic (headers) | Variable |
94
- | Q&A pairs | Keep as-is | Whole Q+A |
95
- | Code files | Function-boundary | Whole function |
96
- | News articles | Paragraph | 512 tokens |
97
-
98
- ## Quality Checklist
99
- - [ ] Chunks overlap by 10-20% to avoid cutting context at boundaries
100
- - [ ] Minimum chunk size: 50 tokens (avoid noisy small chunks)
101
- - [ ] Maximum chunk size: 512 tokens for ada-002 (8192 token model limit)
102
- - [ ] Metadata preserved and searchable
103
- - [ ] Source URL included for citation
104
- - [ ] Re-index when document changes (detect via content hash)
@@ -1,222 +0,0 @@
1
- # Blazor Design Phase Checklist
2
-
3
- > **Scope:** blazor-azure
4
- > **Layer:** 2 (on keyword)
5
- > **Keywords:** blazor, design, checklist, phase, architecture
6
- > **Load When:** design phase for blazor features
7
-
8
- Use this checklist during FASE 2 (DESIGN) for features involving Blazor Server
9
-
10
- ---
11
-
12
- ## 1. State and Session Management
13
-
14
- ### State Persistence
15
-
16
- - [ ] **How will critical state be persisted?**
17
- - [ ] Database (recommended for important data)
18
- - [ ] Distributed cache (Redis, SQL Distributed Cache)
19
- - [ ] Cookie (only for identification, not data)
20
- - [ ] LocalStorage via JS Interop (only for non-critical preferences)
21
-
22
- - [ ] **SessionState has `LoadFrom(entity)` method?**
23
- - Allows reloading state from persisted source
24
- - See [state.md](./state.md)
25
-
26
- - [ ] **`IsLoaded` property exists to avoid unnecessary reloads?**
27
-
28
- - [ ] **SessionId middleware is configured?**
29
- - HttpOnly cookie with session identifier
30
- - Injected into HttpContext.Items for component access
31
-
32
- ### Page Validation
33
-
34
- - [ ] **All pages in flow reload state in `OnInitializedAsync`?**
35
- ```csharp
36
- if (!Session.IsLoaded)
37
- {
38
- var entity = await Repository.GetBySessionIdAsync(sessionId);
39
- Session.LoadFrom(entity);
40
- }
41
- ```
42
-
43
- - [ ] **What happens if user accesses middle page directly?**
44
- - Redirect to start?
45
- - Load partial state?
46
- - Show friendly error?
47
-
48
- ---
49
-
50
- ## 2. EF Core Concurrency
51
-
52
- ### Background Operations
53
-
54
- - [ ] **Will any service be called via `Task.Run`?**
55
- - If YES: Use `IDbContextFactory<T>`
56
- - See [ef-core.md](../../backend/database/ef-core.md)
57
-
58
- - [ ] **Will any service be called in background job (Hangfire, Timer)?**
59
- - If YES: Use `IDbContextFactory<T>` or Repository Factory pattern
60
-
61
- - [ ] **Will multiple operations happen concurrently in same component?**
62
- - If YES: Each operation needs isolated DbContext
63
-
64
- ---
65
-
66
- ## 3. File Upload
67
-
68
- - [ ] **Will feature handle file uploads?**
69
- - [ ] Max file size defined?
70
- - [ ] Allowed file types/extensions specified?
71
- - [ ] Files read once and bytes stored?
72
- - [ ] Upload progress indicator planned?
73
-
74
- - [ ] **Where will files be stored?**
75
- - [ ] Azure Blob Storage (recommended)
76
- - [ ] Local file system (not scalable)
77
- - [ ] Database as byte[] (only for small files < 1MB)
78
-
79
- ---
80
-
81
- ## 4. JavaScript Interop
82
-
83
- - [ ] **Will feature use JavaScript?**
84
- - [ ] JS calls in `OnAfterRenderAsync`, not `OnInitializedAsync`?
85
- - [ ] `firstRender` check to prevent duplicate calls?
86
- - [ ] JS file location planned (wwwroot/js/)?
87
-
88
- - [ ] **Will feature need external JS libraries?**
89
- - [ ] Library loaded via CDN or npm?
90
- - [ ] Initialization strategy planned?
91
-
92
- ---
93
-
94
- ## 5. Navigation and Routing
95
-
96
- - [ ] **How many pages in the feature?**
97
- - Single page?
98
- - Multi-page flow?
99
- - Modal/dialog-based?
100
-
101
- - [ ] **Will users need to navigate back/forward?**
102
- - [ ] State persisted before navigation?
103
- - [ ] Browser back button handled correctly?
104
-
105
- - [ ] **Are there deep links?**
106
- - [ ] Each page can load state from URL/DB?
107
- - [ ] Invalid state handled gracefully?
108
-
109
- ---
110
-
111
- ## 6. Real-time Updates
112
-
113
- - [ ] **Will feature need real-time updates?**
114
- - SignalR circuit is already available
115
- - Update strategy planned?
116
-
117
- - [ ] **Will updates come from background jobs?**
118
- - [ ] Notification mechanism planned?
119
- - [ ] UI refresh strategy defined?
120
-
121
- ---
122
-
123
- ## 7. Performance
124
-
125
- - [ ] **Expected data volume?**
126
- - Pagination needed for lists > 100 items?
127
- - Lazy loading for large datasets?
128
-
129
- - [ ] **Heavy computations planned?**
130
- - [ ] Run in background (Task.Run with factory)?
131
- - [ ] Cache results?
132
-
133
- - [ ] **Large components/forms?**
134
- - [ ] Split into smaller components?
135
- - [ ] Lazy rendering planned?
136
-
137
- ---
138
-
139
- ## 8. Error Handling
140
-
141
- - [ ] **What errors might occur?**
142
- - Database errors?
143
- - Network errors?
144
- - Validation errors?
145
- - Permission errors?
146
-
147
- - [ ] **Error display strategy?**
148
- - [ ] Toast notifications?
149
- - [ ] Inline validation messages?
150
- - [ ] Error page redirect?
151
-
152
- - [ ] **Retry strategy for transient errors?**
153
-
154
- ---
155
-
156
- ## 9. Security
157
-
158
- - [ ] **Authentication required?**
159
- - [ ] `[Authorize]` attribute on pages?
160
- - [ ] Login redirect configured?
161
-
162
- - [ ] **Authorization rules?**
163
- - Role-based?
164
- - Policy-based?
165
- - Resource-based?
166
-
167
- - [ ] **Input validation?**
168
- - [ ] Client-side (Blazor validation)?
169
- - [ ] Server-side (service layer)?
170
- - [ ] Both?
171
-
172
- - [ ] **Sensitive data?**
173
- - [ ] Not stored in SessionState?
174
- - [ ] Not logged?
175
- - [ ] Encrypted in database?
176
-
177
- ---
178
-
179
- ## 10. UI/UX
180
-
181
- - [ ] **Loading states?**
182
- - Spinners for async operations?
183
- - Skeleton loaders for data?
184
- - Disabled buttons during saves?
185
-
186
- - [ ] **Success feedback?**
187
- - Toast messages?
188
- - Inline success indicators?
189
- - Redirect to confirmation page?
190
-
191
- - [ ] **Responsive design?**
192
- - Mobile layout planned?
193
- - Breakpoints defined?
194
-
195
- ---
196
-
197
- ## Quick Design Decisions
198
-
199
- Before implementing, answer these:
200
-
201
- | Question | Answer Required |
202
- |----------|----------------|
203
- | **State:** Where is critical state stored? | Database / Cache / Cookie |
204
- | **Files:** Where are uploads stored? | Azure Blob / Database / FileSystem |
205
- | **Navigation:** Single page or multi-page? | Single / Multi / Modal |
206
- | **JS:** Is JavaScript needed? | Yes / No |
207
- | **Auth:** Authentication required? | Yes / No |
208
- | **Background:** Any background operations? | Yes (use factory) / No |
209
- | **Real-time:** Real-time updates needed? | Yes / No |
210
-
211
- ---
212
-
213
- ## Related Standards
214
-
215
- - [state.md](./state.md) - Session state patterns
216
- - [lifecycle.md](./lifecycle.md) - Component lifecycle
217
- - [pitfalls.md](./pitfalls.md) - Common mistakes
218
- - [ef-core.md](../../backend/database/ef-core.md) - DbContext concurrency
219
-
220
- ---
221
-
222
- *MORPH-SPEC by Polymorphism Tech*