aios-core 4.1.0 → 4.2.0

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 (145) hide show
  1. package/.aios-core/.session/current-session.json +14 -0
  2. package/.aios-core/core/registry/registry-schema.json +166 -166
  3. package/.aios-core/core/registry/service-registry.json +6585 -6585
  4. package/.aios-core/data/entity-registry.yaml +208 -8
  5. package/.aios-core/data/registry-update-log.jsonl +165 -0
  6. package/.aios-core/development/scripts/approval-workflow.js +642 -642
  7. package/.aios-core/development/scripts/backup-manager.js +606 -606
  8. package/.aios-core/development/scripts/branch-manager.js +389 -389
  9. package/.aios-core/development/scripts/code-quality-improver.js +1311 -1311
  10. package/.aios-core/development/scripts/commit-message-generator.js +849 -849
  11. package/.aios-core/development/scripts/conflict-resolver.js +674 -674
  12. package/.aios-core/development/scripts/dependency-analyzer.js +637 -637
  13. package/.aios-core/development/scripts/diff-generator.js +351 -351
  14. package/.aios-core/development/scripts/elicitation-engine.js +384 -384
  15. package/.aios-core/development/scripts/elicitation-session-manager.js +299 -299
  16. package/.aios-core/development/scripts/git-wrapper.js +461 -461
  17. package/.aios-core/development/scripts/manifest-preview.js +244 -244
  18. package/.aios-core/development/scripts/metrics-tracker.js +775 -775
  19. package/.aios-core/development/scripts/modification-validator.js +554 -554
  20. package/.aios-core/development/scripts/pattern-learner.js +1224 -1224
  21. package/.aios-core/development/scripts/performance-analyzer.js +757 -757
  22. package/.aios-core/development/scripts/refactoring-suggester.js +1138 -1138
  23. package/.aios-core/development/scripts/rollback-handler.js +530 -530
  24. package/.aios-core/development/scripts/security-checker.js +358 -358
  25. package/.aios-core/development/scripts/template-engine.js +239 -239
  26. package/.aios-core/development/scripts/template-validator.js +278 -278
  27. package/.aios-core/development/scripts/test-generator.js +843 -843
  28. package/.aios-core/development/scripts/transaction-manager.js +589 -589
  29. package/.aios-core/development/scripts/usage-tracker.js +673 -673
  30. package/.aios-core/development/scripts/validate-filenames.js +226 -226
  31. package/.aios-core/development/scripts/version-tracker.js +526 -526
  32. package/.aios-core/development/scripts/yaml-validator.js +396 -396
  33. package/.aios-core/development/tasks/validate-next-story.md +99 -2
  34. package/.aios-core/development/templates/service-template/README.md.hbs +158 -158
  35. package/.aios-core/development/templates/service-template/__tests__/index.test.ts.hbs +237 -237
  36. package/.aios-core/development/templates/service-template/client.ts.hbs +403 -403
  37. package/.aios-core/development/templates/service-template/errors.ts.hbs +182 -182
  38. package/.aios-core/development/templates/service-template/index.ts.hbs +120 -120
  39. package/.aios-core/development/templates/service-template/package.json.hbs +87 -87
  40. package/.aios-core/development/templates/service-template/types.ts.hbs +145 -145
  41. package/.aios-core/development/templates/squad-template/LICENSE +21 -21
  42. package/.aios-core/docs/SHARD-TRANSLATION-GUIDE.md +335 -0
  43. package/.aios-core/docs/component-creation-guide.md +458 -0
  44. package/.aios-core/docs/session-update-pattern.md +307 -0
  45. package/.aios-core/docs/standards/AIOS-FRAMEWORK-MASTER.md +1963 -0
  46. package/.aios-core/docs/standards/AIOS-LIVRO-DE-OURO-V2.1-SUMMARY.md +1190 -0
  47. package/.aios-core/docs/standards/AIOS-LIVRO-DE-OURO-V2.1.md +439 -0
  48. package/.aios-core/docs/standards/AIOS-LIVRO-DE-OURO.md +5398 -0
  49. package/.aios-core/docs/standards/V3-ARCHITECTURAL-DECISIONS.md +523 -0
  50. package/.aios-core/docs/template-syntax.md +267 -0
  51. package/.aios-core/docs/troubleshooting-guide.md +625 -0
  52. package/.aios-core/infrastructure/templates/aios-sync.yaml.template +193 -193
  53. package/.aios-core/infrastructure/templates/coderabbit.yaml.template +279 -279
  54. package/.aios-core/infrastructure/templates/github-workflows/ci.yml.template +169 -169
  55. package/.aios-core/infrastructure/templates/github-workflows/pr-automation.yml.template +330 -330
  56. package/.aios-core/infrastructure/templates/github-workflows/release.yml.template +196 -196
  57. package/.aios-core/infrastructure/templates/gitignore/gitignore-aios-base.tmpl +63 -63
  58. package/.aios-core/infrastructure/templates/gitignore/gitignore-brownfield-merge.tmpl +18 -18
  59. package/.aios-core/infrastructure/templates/gitignore/gitignore-node.tmpl +85 -85
  60. package/.aios-core/infrastructure/templates/gitignore/gitignore-python.tmpl +145 -145
  61. package/.aios-core/infrastructure/tests/utilities-audit-results.json +501 -0
  62. package/.aios-core/install-manifest.yaml +101 -101
  63. package/.aios-core/local-config.yaml.template +70 -70
  64. package/.aios-core/manifests/agents.csv +29 -0
  65. package/.aios-core/manifests/schema/manifest-schema.json +190 -190
  66. package/.aios-core/manifests/tasks.csv +198 -0
  67. package/.aios-core/manifests/workers.csv +204 -0
  68. package/.aios-core/monitor/hooks/lib/__init__.py +1 -1
  69. package/.aios-core/monitor/hooks/lib/enrich.py +58 -58
  70. package/.aios-core/monitor/hooks/lib/send_event.py +47 -47
  71. package/.aios-core/monitor/hooks/notification.py +29 -29
  72. package/.aios-core/monitor/hooks/post_tool_use.py +45 -45
  73. package/.aios-core/monitor/hooks/pre_compact.py +29 -29
  74. package/.aios-core/monitor/hooks/pre_tool_use.py +40 -40
  75. package/.aios-core/monitor/hooks/stop.py +29 -29
  76. package/.aios-core/monitor/hooks/subagent_stop.py +29 -29
  77. package/.aios-core/monitor/hooks/user_prompt_submit.py +38 -38
  78. package/.aios-core/product/templates/adr.hbs +125 -125
  79. package/.aios-core/product/templates/component-react-tmpl.tsx +98 -98
  80. package/.aios-core/product/templates/dbdr.hbs +241 -241
  81. package/.aios-core/product/templates/engine/schemas/adr.schema.json +102 -102
  82. package/.aios-core/product/templates/engine/schemas/dbdr.schema.json +205 -205
  83. package/.aios-core/product/templates/engine/schemas/epic.schema.json +175 -175
  84. package/.aios-core/product/templates/engine/schemas/pmdr.schema.json +175 -175
  85. package/.aios-core/product/templates/engine/schemas/prd-v2.schema.json +300 -300
  86. package/.aios-core/product/templates/engine/schemas/prd.schema.json +152 -152
  87. package/.aios-core/product/templates/engine/schemas/story.schema.json +222 -222
  88. package/.aios-core/product/templates/engine/schemas/task.schema.json +154 -154
  89. package/.aios-core/product/templates/epic.hbs +212 -212
  90. package/.aios-core/product/templates/eslintrc-security.json +32 -32
  91. package/.aios-core/product/templates/github-actions-cd.yml +212 -212
  92. package/.aios-core/product/templates/github-actions-ci.yml +172 -172
  93. package/.aios-core/product/templates/pmdr.hbs +186 -186
  94. package/.aios-core/product/templates/prd-v2.0.hbs +216 -216
  95. package/.aios-core/product/templates/prd.hbs +201 -201
  96. package/.aios-core/product/templates/shock-report-tmpl.html +502 -502
  97. package/.aios-core/product/templates/story.hbs +263 -263
  98. package/.aios-core/product/templates/task.hbs +170 -170
  99. package/.aios-core/product/templates/tmpl-comment-on-examples.sql +158 -158
  100. package/.aios-core/product/templates/tmpl-migration-script.sql +91 -91
  101. package/.aios-core/product/templates/tmpl-rls-granular-policies.sql +104 -104
  102. package/.aios-core/product/templates/tmpl-rls-kiss-policy.sql +10 -10
  103. package/.aios-core/product/templates/tmpl-rls-roles.sql +135 -135
  104. package/.aios-core/product/templates/tmpl-rls-simple.sql +77 -77
  105. package/.aios-core/product/templates/tmpl-rls-tenant.sql +152 -152
  106. package/.aios-core/product/templates/tmpl-rollback-script.sql +77 -77
  107. package/.aios-core/product/templates/tmpl-seed-data.sql +140 -140
  108. package/.aios-core/product/templates/tmpl-smoke-test.sql +16 -16
  109. package/.aios-core/product/templates/tmpl-staging-copy-merge.sql +139 -139
  110. package/.aios-core/product/templates/tmpl-stored-proc.sql +140 -140
  111. package/.aios-core/product/templates/tmpl-trigger.sql +152 -152
  112. package/.aios-core/product/templates/tmpl-view-materialized.sql +133 -133
  113. package/.aios-core/product/templates/tmpl-view.sql +177 -177
  114. package/.aios-core/product/templates/token-exports-css-tmpl.css +240 -240
  115. package/.aios-core/quality/schemas/quality-metrics.schema.json +233 -233
  116. package/.aios-core/scripts/migrate-framework-docs.sh +300 -300
  117. package/.aios-core/scripts/pm.sh +0 -0
  118. package/.claude/hooks/enforce-architecture-first.py +196 -196
  119. package/.claude/hooks/mind-clone-governance.py +192 -192
  120. package/.claude/hooks/read-protection.py +151 -151
  121. package/.claude/hooks/slug-validation.py +176 -176
  122. package/.claude/hooks/sql-governance.py +182 -182
  123. package/.claude/hooks/write-path-validation.py +194 -194
  124. package/.claude/rules/agent-authority.md +105 -0
  125. package/.claude/rules/coderabbit-integration.md +93 -0
  126. package/.claude/rules/ids-principles.md +112 -0
  127. package/.claude/rules/story-lifecycle.md +139 -0
  128. package/.claude/rules/workflow-execution.md +150 -0
  129. package/LICENSE +48 -48
  130. package/bin/aios-minimal.js +0 -0
  131. package/bin/aios.js +0 -0
  132. package/package.json +1 -1
  133. package/packages/aios-install/bin/aios-install.js +0 -0
  134. package/packages/aios-install/bin/edmcp.js +0 -0
  135. package/packages/aios-pro-cli/bin/aios-pro.js +0 -0
  136. package/packages/installer/src/wizard/pro-setup.js +433 -49
  137. package/scripts/check-markdown-links.py +352 -352
  138. package/scripts/code-intel-health-check.js +343 -0
  139. package/scripts/dashboard-parallel-dev.sh +0 -0
  140. package/scripts/dashboard-parallel-phase3.sh +0 -0
  141. package/scripts/dashboard-parallel-phase4.sh +0 -0
  142. package/scripts/glue/README.md +355 -0
  143. package/scripts/glue/compose-agent-prompt.cjs +362 -0
  144. package/scripts/install-monitor-hooks.sh +0 -0
  145. package/.aios-core/lib/build.json +0 -1
@@ -1,170 +1,170 @@
1
- ---
2
- template_id: task
3
- template_name: Task
4
- version: 1.0
5
- variables:
6
- - name: id
7
- type: string
8
- required: true
9
- prompt: "Task ID:"
10
- - name: name
11
- type: string
12
- required: true
13
- prompt: "Task name:"
14
- - name: description
15
- type: text
16
- required: true
17
- prompt: "Task description:"
18
- - name: status
19
- type: choice
20
- required: true
21
- choices: [Pending, In Progress, Completed, Blocked, Cancelled]
22
- default: Pending
23
- - name: type
24
- type: choice
25
- required: false
26
- choices: [Development, Design, Testing, Documentation, Research, Bugfix, Refactor]
27
- default: Development
28
- - name: priority
29
- type: choice
30
- required: false
31
- choices: [P0, P1, P2, P3]
32
- default: P1
33
- ---
34
-
35
- # Task: {{name}}
36
-
37
- **ID:** {{id}}
38
- **Status:** {{#ifEqual status "Pending"}}⏳{{/ifEqual}}{{#ifEqual status "In Progress"}}🔄{{/ifEqual}}{{#ifEqual status "Completed"}}✅{{/ifEqual}}{{#ifEqual status "Blocked"}}🚫{{/ifEqual}}{{#ifEqual status "Cancelled"}}❌{{/ifEqual}} {{status}}
39
- **Type:** {{default type "Development"}}
40
- **Priority:** {{default priority "P1"}}
41
- {{#if estimate}}**Estimate:** {{estimate}}{{/if}}
42
- {{#if assignee}}**Assignee:** {{assignee}}{{/if}}
43
- {{#if storyRef}}**Story:** {{storyRef}}{{/if}}
44
- **Created:** {{formatDate now "YYYY-MM-DD"}}
45
-
46
- ---
47
-
48
- ## Description
49
-
50
- {{description}}
51
-
52
- ---
53
-
54
- {{#if inputs}}
55
- ## Inputs
56
-
57
- {{#each inputs}}
58
- - {{this}}
59
- {{/each}}
60
- {{/if}}
61
-
62
- ---
63
-
64
- {{#if outputs}}
65
- ## Expected Outputs
66
-
67
- {{#each outputs}}
68
- - {{this}}
69
- {{/each}}
70
- {{/if}}
71
-
72
- ---
73
-
74
- ## Steps
75
-
76
- {{#if steps}}
77
- {{#each steps}}
78
- {{add @index 1}}. [{{#if this.completed}}x{{else}} {{/if}}] {{this.step}}
79
- {{#if this.notes}} _Note: {{this.notes}}_{{/if}}
80
- {{/each}}
81
- {{else}}
82
- _Steps to be defined._
83
- {{/if}}
84
-
85
- ---
86
-
87
- {{#if validation}}
88
- ## Validation
89
-
90
- ### Criteria
91
- {{#each validation.criteria}}
92
- - [ ] {{this}}
93
- {{/each}}
94
-
95
- {{#if validation.commands}}
96
- ### Commands
97
- ```bash
98
- {{#each validation.commands}}
99
- {{this}}
100
- {{/each}}
101
- ```
102
- {{/if}}
103
- {{/if}}
104
-
105
- ---
106
-
107
- {{#if dependencies}}
108
- ## Dependencies
109
-
110
- {{#each dependencies}}
111
- - {{this}}
112
- {{/each}}
113
- {{/if}}
114
-
115
- {{#if blockedBy}}
116
- ## Blocked By
117
-
118
- {{blockedBy}}
119
- {{/if}}
120
-
121
- ---
122
-
123
- {{#if files}}
124
- ## Files Affected
125
-
126
- | Path | Action |
127
- |------|--------|
128
- {{#each files}}
129
- | `{{this.path}}` | {{this.action}} |
130
- {{/each}}
131
- {{/if}}
132
-
133
- ---
134
-
135
- {{#if elicitation}}
136
- {{#if elicitation.enabled}}
137
- ## Elicitation
138
-
139
- {{#each elicitation.questions}}
140
- ### {{add @index 1}}. {{this.question}}
141
- {{#ifEqual this.type "choice"}}
142
- Options:
143
- {{#each this.options}}
144
- - {{this}}
145
- {{/each}}
146
- {{/ifEqual}}
147
- {{/each}}
148
- {{/if}}
149
- {{/if}}
150
-
151
- ---
152
-
153
- {{#if notes}}
154
- ## Notes
155
-
156
- {{notes}}
157
- {{/if}}
158
-
159
- ---
160
-
161
- {{#if completedAt}}
162
- ## Completion
163
-
164
- **Completed At:** {{completedAt}}
165
- {{/if}}
166
-
167
- ---
168
-
169
- **Generated by:** AIOS Template Engine v2.0
170
- **Template Version:** task-1.0
1
+ ---
2
+ template_id: task
3
+ template_name: Task
4
+ version: 1.0
5
+ variables:
6
+ - name: id
7
+ type: string
8
+ required: true
9
+ prompt: "Task ID:"
10
+ - name: name
11
+ type: string
12
+ required: true
13
+ prompt: "Task name:"
14
+ - name: description
15
+ type: text
16
+ required: true
17
+ prompt: "Task description:"
18
+ - name: status
19
+ type: choice
20
+ required: true
21
+ choices: [Pending, In Progress, Completed, Blocked, Cancelled]
22
+ default: Pending
23
+ - name: type
24
+ type: choice
25
+ required: false
26
+ choices: [Development, Design, Testing, Documentation, Research, Bugfix, Refactor]
27
+ default: Development
28
+ - name: priority
29
+ type: choice
30
+ required: false
31
+ choices: [P0, P1, P2, P3]
32
+ default: P1
33
+ ---
34
+
35
+ # Task: {{name}}
36
+
37
+ **ID:** {{id}}
38
+ **Status:** {{#ifEqual status "Pending"}}⏳{{/ifEqual}}{{#ifEqual status "In Progress"}}🔄{{/ifEqual}}{{#ifEqual status "Completed"}}✅{{/ifEqual}}{{#ifEqual status "Blocked"}}🚫{{/ifEqual}}{{#ifEqual status "Cancelled"}}❌{{/ifEqual}} {{status}}
39
+ **Type:** {{default type "Development"}}
40
+ **Priority:** {{default priority "P1"}}
41
+ {{#if estimate}}**Estimate:** {{estimate}}{{/if}}
42
+ {{#if assignee}}**Assignee:** {{assignee}}{{/if}}
43
+ {{#if storyRef}}**Story:** {{storyRef}}{{/if}}
44
+ **Created:** {{formatDate now "YYYY-MM-DD"}}
45
+
46
+ ---
47
+
48
+ ## Description
49
+
50
+ {{description}}
51
+
52
+ ---
53
+
54
+ {{#if inputs}}
55
+ ## Inputs
56
+
57
+ {{#each inputs}}
58
+ - {{this}}
59
+ {{/each}}
60
+ {{/if}}
61
+
62
+ ---
63
+
64
+ {{#if outputs}}
65
+ ## Expected Outputs
66
+
67
+ {{#each outputs}}
68
+ - {{this}}
69
+ {{/each}}
70
+ {{/if}}
71
+
72
+ ---
73
+
74
+ ## Steps
75
+
76
+ {{#if steps}}
77
+ {{#each steps}}
78
+ {{add @index 1}}. [{{#if this.completed}}x{{else}} {{/if}}] {{this.step}}
79
+ {{#if this.notes}} _Note: {{this.notes}}_{{/if}}
80
+ {{/each}}
81
+ {{else}}
82
+ _Steps to be defined._
83
+ {{/if}}
84
+
85
+ ---
86
+
87
+ {{#if validation}}
88
+ ## Validation
89
+
90
+ ### Criteria
91
+ {{#each validation.criteria}}
92
+ - [ ] {{this}}
93
+ {{/each}}
94
+
95
+ {{#if validation.commands}}
96
+ ### Commands
97
+ ```bash
98
+ {{#each validation.commands}}
99
+ {{this}}
100
+ {{/each}}
101
+ ```
102
+ {{/if}}
103
+ {{/if}}
104
+
105
+ ---
106
+
107
+ {{#if dependencies}}
108
+ ## Dependencies
109
+
110
+ {{#each dependencies}}
111
+ - {{this}}
112
+ {{/each}}
113
+ {{/if}}
114
+
115
+ {{#if blockedBy}}
116
+ ## Blocked By
117
+
118
+ {{blockedBy}}
119
+ {{/if}}
120
+
121
+ ---
122
+
123
+ {{#if files}}
124
+ ## Files Affected
125
+
126
+ | Path | Action |
127
+ |------|--------|
128
+ {{#each files}}
129
+ | `{{this.path}}` | {{this.action}} |
130
+ {{/each}}
131
+ {{/if}}
132
+
133
+ ---
134
+
135
+ {{#if elicitation}}
136
+ {{#if elicitation.enabled}}
137
+ ## Elicitation
138
+
139
+ {{#each elicitation.questions}}
140
+ ### {{add @index 1}}. {{this.question}}
141
+ {{#ifEqual this.type "choice"}}
142
+ Options:
143
+ {{#each this.options}}
144
+ - {{this}}
145
+ {{/each}}
146
+ {{/ifEqual}}
147
+ {{/each}}
148
+ {{/if}}
149
+ {{/if}}
150
+
151
+ ---
152
+
153
+ {{#if notes}}
154
+ ## Notes
155
+
156
+ {{notes}}
157
+ {{/if}}
158
+
159
+ ---
160
+
161
+ {{#if completedAt}}
162
+ ## Completion
163
+
164
+ **Completed At:** {{completedAt}}
165
+ {{/if}}
166
+
167
+ ---
168
+
169
+ **Generated by:** AIOS Template Engine v2.0
170
+ **Template Version:** task-1.0
@@ -1,158 +1,158 @@
1
- -- COMMENT ON Examples Template
2
- -- Purpose: Document database objects inline using PostgreSQL COMMENT ON
3
- -- Created: :created_date
4
- -- Author: :author
5
- --
6
- -- IMPORTANT: Comments are metadata that help future developers understand the schema
7
-
8
- -- =============================================================================
9
- -- TABLE COMMENTS
10
- -- =============================================================================
11
-
12
- -- Basic table comment
13
- COMMENT ON TABLE :table_name IS 'Description of what this table stores and its purpose';
14
-
15
- -- Detailed table comment with usage notes
16
- COMMENT ON TABLE users IS
17
- 'User accounts for the application.
18
- Primary user data is stored here, with profile details in user_profiles.
19
- RLS policies ensure users can only access their own data.
20
- Related tables: user_profiles, user_roles, user_sessions';
21
-
22
- -- =============================================================================
23
- -- COLUMN COMMENTS
24
- -- =============================================================================
25
-
26
- -- Standard audit columns
27
- COMMENT ON COLUMN :table_name.id IS 'Unique identifier (UUID v4)';
28
- COMMENT ON COLUMN :table_name.created_at IS 'Timestamp when record was created';
29
- COMMENT ON COLUMN :table_name.updated_at IS 'Timestamp of last modification';
30
- COMMENT ON COLUMN :table_name.deleted_at IS 'Soft delete timestamp (NULL if active)';
31
-
32
- -- Business columns with context
33
- COMMENT ON COLUMN users.email IS 'Primary email for login and notifications. Must be unique.';
34
- COMMENT ON COLUMN users.status IS 'Account status: active, pending, suspended, deleted';
35
-
36
- -- Columns with constraints explained
37
- COMMENT ON COLUMN orders.total_amount IS
38
- 'Order total in cents (not dollars). Calculated from line items.
39
- Constraint: Must be >= 0';
40
-
41
- -- Foreign key columns
42
- COMMENT ON COLUMN orders.user_id IS
43
- 'References users.id. Owner of this order.
44
- CASCADE on delete (user deletion removes orders).';
45
-
46
- -- JSONB columns with structure
47
- COMMENT ON COLUMN users.preferences IS
48
- 'User preferences as JSONB. Structure:
49
- {
50
- "theme": "dark" | "light",
51
- "notifications": { "email": boolean, "push": boolean },
52
- "language": "en" | "pt" | "es"
53
- }';
54
-
55
- -- =============================================================================
56
- -- INDEX COMMENTS
57
- -- =============================================================================
58
-
59
- COMMENT ON INDEX idx_users_email IS 'Unique index for email lookups and login';
60
- COMMENT ON INDEX idx_orders_user_id IS 'Foreign key index for user order queries';
61
- COMMENT ON INDEX idx_orders_created_at IS 'Date range queries on order creation';
62
-
63
- -- Composite index explanation
64
- COMMENT ON INDEX idx_orders_user_status IS
65
- 'Composite index for filtering user orders by status.
66
- Covers queries: WHERE user_id = ? AND status = ?';
67
-
68
- -- =============================================================================
69
- -- CONSTRAINT COMMENTS
70
- -- =============================================================================
71
-
72
- -- Check constraints
73
- COMMENT ON CONSTRAINT orders_total_positive ON orders IS
74
- 'Ensures total_amount is never negative';
75
-
76
- COMMENT ON CONSTRAINT users_email_format ON users IS
77
- 'Validates email format using regex pattern';
78
-
79
- -- Foreign key constraints
80
- COMMENT ON CONSTRAINT orders_user_id_fkey ON orders IS
81
- 'Links order to user. ON DELETE CASCADE removes orphan orders.';
82
-
83
- -- =============================================================================
84
- -- FUNCTION COMMENTS
85
- -- =============================================================================
86
-
87
- COMMENT ON FUNCTION update_updated_at_column() IS
88
- 'Trigger function to auto-update updated_at column.
89
- Used by: All tables with updated_at column.
90
- Trigger timing: BEFORE UPDATE FOR EACH ROW';
91
-
92
- COMMENT ON FUNCTION calculate_order_total(UUID) IS
93
- 'Calculates order total from line items.
94
- Parameters: order_id UUID
95
- Returns: NUMERIC(10,2) total in cents
96
- Usage: SELECT calculate_order_total(order_id) FROM orders';
97
-
98
- -- =============================================================================
99
- -- TRIGGER COMMENTS
100
- -- =============================================================================
101
-
102
- COMMENT ON TRIGGER trigger_orders_updated_at ON orders IS
103
- 'Auto-updates updated_at on row modification';
104
-
105
- COMMENT ON TRIGGER trigger_orders_audit ON orders IS
106
- 'Logs all changes to audit_log table';
107
-
108
- -- =============================================================================
109
- -- VIEW COMMENTS
110
- -- =============================================================================
111
-
112
- COMMENT ON VIEW user_dashboard IS
113
- 'Aggregated user data for dashboard display.
114
- Includes: user info, order counts, recent activity.
115
- Performance: Uses materialized subqueries for counts.
116
- Refresh: Live data (not materialized)';
117
-
118
- -- =============================================================================
119
- -- TYPE COMMENTS (for custom types)
120
- -- =============================================================================
121
-
122
- -- COMMENT ON TYPE order_status IS
123
- -- 'Enum for order lifecycle: pending, processing, shipped, delivered, cancelled';
124
-
125
- -- =============================================================================
126
- -- SCHEMA COMMENTS
127
- -- =============================================================================
128
-
129
- COMMENT ON SCHEMA public IS 'Main application schema with user-facing tables';
130
- -- COMMENT ON SCHEMA audit IS 'Audit logging and compliance tracking';
131
- -- COMMENT ON SCHEMA analytics IS 'Aggregated data for reporting';
132
-
133
- -- =============================================================================
134
- -- VIEWING COMMENTS
135
- -- =============================================================================
136
-
137
- -- View table comments
138
- SELECT
139
- t.table_name,
140
- pg_catalog.obj_description(
141
- (quote_ident(t.table_schema) || '.' || quote_ident(t.table_name))::regclass,
142
- 'pg_class'
143
- ) AS comment
144
- FROM information_schema.tables t
145
- WHERE t.table_schema = 'public'
146
- AND t.table_type = 'BASE TABLE';
147
-
148
- -- View column comments
149
- SELECT
150
- c.table_name,
151
- c.column_name,
152
- pg_catalog.col_description(
153
- (quote_ident(c.table_schema) || '.' || quote_ident(c.table_name))::regclass,
154
- c.ordinal_position
155
- ) AS comment
156
- FROM information_schema.columns c
157
- WHERE c.table_schema = 'public'
158
- ORDER BY c.table_name, c.ordinal_position;
1
+ -- COMMENT ON Examples Template
2
+ -- Purpose: Document database objects inline using PostgreSQL COMMENT ON
3
+ -- Created: :created_date
4
+ -- Author: :author
5
+ --
6
+ -- IMPORTANT: Comments are metadata that help future developers understand the schema
7
+
8
+ -- =============================================================================
9
+ -- TABLE COMMENTS
10
+ -- =============================================================================
11
+
12
+ -- Basic table comment
13
+ COMMENT ON TABLE :table_name IS 'Description of what this table stores and its purpose';
14
+
15
+ -- Detailed table comment with usage notes
16
+ COMMENT ON TABLE users IS
17
+ 'User accounts for the application.
18
+ Primary user data is stored here, with profile details in user_profiles.
19
+ RLS policies ensure users can only access their own data.
20
+ Related tables: user_profiles, user_roles, user_sessions';
21
+
22
+ -- =============================================================================
23
+ -- COLUMN COMMENTS
24
+ -- =============================================================================
25
+
26
+ -- Standard audit columns
27
+ COMMENT ON COLUMN :table_name.id IS 'Unique identifier (UUID v4)';
28
+ COMMENT ON COLUMN :table_name.created_at IS 'Timestamp when record was created';
29
+ COMMENT ON COLUMN :table_name.updated_at IS 'Timestamp of last modification';
30
+ COMMENT ON COLUMN :table_name.deleted_at IS 'Soft delete timestamp (NULL if active)';
31
+
32
+ -- Business columns with context
33
+ COMMENT ON COLUMN users.email IS 'Primary email for login and notifications. Must be unique.';
34
+ COMMENT ON COLUMN users.status IS 'Account status: active, pending, suspended, deleted';
35
+
36
+ -- Columns with constraints explained
37
+ COMMENT ON COLUMN orders.total_amount IS
38
+ 'Order total in cents (not dollars). Calculated from line items.
39
+ Constraint: Must be >= 0';
40
+
41
+ -- Foreign key columns
42
+ COMMENT ON COLUMN orders.user_id IS
43
+ 'References users.id. Owner of this order.
44
+ CASCADE on delete (user deletion removes orders).';
45
+
46
+ -- JSONB columns with structure
47
+ COMMENT ON COLUMN users.preferences IS
48
+ 'User preferences as JSONB. Structure:
49
+ {
50
+ "theme": "dark" | "light",
51
+ "notifications": { "email": boolean, "push": boolean },
52
+ "language": "en" | "pt" | "es"
53
+ }';
54
+
55
+ -- =============================================================================
56
+ -- INDEX COMMENTS
57
+ -- =============================================================================
58
+
59
+ COMMENT ON INDEX idx_users_email IS 'Unique index for email lookups and login';
60
+ COMMENT ON INDEX idx_orders_user_id IS 'Foreign key index for user order queries';
61
+ COMMENT ON INDEX idx_orders_created_at IS 'Date range queries on order creation';
62
+
63
+ -- Composite index explanation
64
+ COMMENT ON INDEX idx_orders_user_status IS
65
+ 'Composite index for filtering user orders by status.
66
+ Covers queries: WHERE user_id = ? AND status = ?';
67
+
68
+ -- =============================================================================
69
+ -- CONSTRAINT COMMENTS
70
+ -- =============================================================================
71
+
72
+ -- Check constraints
73
+ COMMENT ON CONSTRAINT orders_total_positive ON orders IS
74
+ 'Ensures total_amount is never negative';
75
+
76
+ COMMENT ON CONSTRAINT users_email_format ON users IS
77
+ 'Validates email format using regex pattern';
78
+
79
+ -- Foreign key constraints
80
+ COMMENT ON CONSTRAINT orders_user_id_fkey ON orders IS
81
+ 'Links order to user. ON DELETE CASCADE removes orphan orders.';
82
+
83
+ -- =============================================================================
84
+ -- FUNCTION COMMENTS
85
+ -- =============================================================================
86
+
87
+ COMMENT ON FUNCTION update_updated_at_column() IS
88
+ 'Trigger function to auto-update updated_at column.
89
+ Used by: All tables with updated_at column.
90
+ Trigger timing: BEFORE UPDATE FOR EACH ROW';
91
+
92
+ COMMENT ON FUNCTION calculate_order_total(UUID) IS
93
+ 'Calculates order total from line items.
94
+ Parameters: order_id UUID
95
+ Returns: NUMERIC(10,2) total in cents
96
+ Usage: SELECT calculate_order_total(order_id) FROM orders';
97
+
98
+ -- =============================================================================
99
+ -- TRIGGER COMMENTS
100
+ -- =============================================================================
101
+
102
+ COMMENT ON TRIGGER trigger_orders_updated_at ON orders IS
103
+ 'Auto-updates updated_at on row modification';
104
+
105
+ COMMENT ON TRIGGER trigger_orders_audit ON orders IS
106
+ 'Logs all changes to audit_log table';
107
+
108
+ -- =============================================================================
109
+ -- VIEW COMMENTS
110
+ -- =============================================================================
111
+
112
+ COMMENT ON VIEW user_dashboard IS
113
+ 'Aggregated user data for dashboard display.
114
+ Includes: user info, order counts, recent activity.
115
+ Performance: Uses materialized subqueries for counts.
116
+ Refresh: Live data (not materialized)';
117
+
118
+ -- =============================================================================
119
+ -- TYPE COMMENTS (for custom types)
120
+ -- =============================================================================
121
+
122
+ -- COMMENT ON TYPE order_status IS
123
+ -- 'Enum for order lifecycle: pending, processing, shipped, delivered, cancelled';
124
+
125
+ -- =============================================================================
126
+ -- SCHEMA COMMENTS
127
+ -- =============================================================================
128
+
129
+ COMMENT ON SCHEMA public IS 'Main application schema with user-facing tables';
130
+ -- COMMENT ON SCHEMA audit IS 'Audit logging and compliance tracking';
131
+ -- COMMENT ON SCHEMA analytics IS 'Aggregated data for reporting';
132
+
133
+ -- =============================================================================
134
+ -- VIEWING COMMENTS
135
+ -- =============================================================================
136
+
137
+ -- View table comments
138
+ SELECT
139
+ t.table_name,
140
+ pg_catalog.obj_description(
141
+ (quote_ident(t.table_schema) || '.' || quote_ident(t.table_name))::regclass,
142
+ 'pg_class'
143
+ ) AS comment
144
+ FROM information_schema.tables t
145
+ WHERE t.table_schema = 'public'
146
+ AND t.table_type = 'BASE TABLE';
147
+
148
+ -- View column comments
149
+ SELECT
150
+ c.table_name,
151
+ c.column_name,
152
+ pg_catalog.col_description(
153
+ (quote_ident(c.table_schema) || '.' || quote_ident(c.table_name))::regclass,
154
+ c.ordinal_position
155
+ ) AS comment
156
+ FROM information_schema.columns c
157
+ WHERE c.table_schema = 'public'
158
+ ORDER BY c.table_name, c.ordinal_position;