business-as-code 2.1.3 → 2.3.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 (260) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/README.md +2 -0
  3. package/package.json +16 -13
  4. package/src/dollar.ts +5 -2
  5. package/src/entities/organization.ts +31 -18
  6. package/src/goals.ts +78 -12
  7. package/src/index.ts +48 -18
  8. package/src/kpis.ts +62 -8
  9. package/src/metrics.ts +92 -79
  10. package/src/okrs.ts +120 -20
  11. package/src/organization.ts +12 -15
  12. package/src/process.ts +11 -12
  13. package/src/product.ts +8 -9
  14. package/src/queries.ts +238 -75
  15. package/src/roles.ts +62 -61
  16. package/src/workflow.ts +22 -15
  17. package/test/business.test.ts +282 -0
  18. package/test/dollar.test.ts +270 -0
  19. package/test/entities.test.ts +628 -0
  20. package/test/financials.test.ts +539 -0
  21. package/test/goals.test.ts +451 -0
  22. package/{src → test}/index.test.ts +1 -1
  23. package/test/kpis.test.ts +440 -0
  24. package/test/metrics.test.ts +744 -0
  25. package/test/okrs.test.ts +741 -0
  26. package/test/organization.test.ts +548 -0
  27. package/test/process.test.ts +503 -0
  28. package/test/product.test.ts +430 -0
  29. package/test/queries.test.ts +556 -0
  30. package/test/roles.test.ts +546 -0
  31. package/test/service.test.ts +450 -0
  32. package/test/types.test.ts +1141 -0
  33. package/test/vision.test.ts +214 -0
  34. package/test/workflow.test.ts +501 -0
  35. package/vitest.config.ts +47 -0
  36. package/.turbo/turbo-build.log +0 -5
  37. package/LICENSE +0 -21
  38. package/dist/business.d.ts +0 -62
  39. package/dist/business.d.ts.map +0 -1
  40. package/dist/business.js +0 -109
  41. package/dist/business.js.map +0 -1
  42. package/dist/canvas/activities.d.ts +0 -19
  43. package/dist/canvas/activities.d.ts.map +0 -1
  44. package/dist/canvas/activities.js +0 -20
  45. package/dist/canvas/activities.js.map +0 -1
  46. package/dist/canvas/channels.d.ts +0 -20
  47. package/dist/canvas/channels.d.ts.map +0 -1
  48. package/dist/canvas/channels.js +0 -21
  49. package/dist/canvas/channels.js.map +0 -1
  50. package/dist/canvas/relationships.d.ts +0 -20
  51. package/dist/canvas/relationships.d.ts.map +0 -1
  52. package/dist/canvas/relationships.js +0 -21
  53. package/dist/canvas/relationships.js.map +0 -1
  54. package/dist/canvas/resources.d.ts +0 -20
  55. package/dist/canvas/resources.d.ts.map +0 -1
  56. package/dist/canvas/resources.js +0 -30
  57. package/dist/canvas/resources.js.map +0 -1
  58. package/dist/canvas/revenue.d.ts +0 -22
  59. package/dist/canvas/revenue.d.ts.map +0 -1
  60. package/dist/canvas/revenue.js +0 -30
  61. package/dist/canvas/revenue.js.map +0 -1
  62. package/dist/canvas/segments.d.ts +0 -20
  63. package/dist/canvas/segments.d.ts.map +0 -1
  64. package/dist/canvas/segments.js +0 -28
  65. package/dist/canvas/segments.js.map +0 -1
  66. package/dist/canvas/types.d.ts +0 -232
  67. package/dist/canvas/types.d.ts.map +0 -1
  68. package/dist/canvas/types.js +0 -8
  69. package/dist/canvas/types.js.map +0 -1
  70. package/dist/canvas/value.d.ts +0 -20
  71. package/dist/canvas/value.d.ts.map +0 -1
  72. package/dist/canvas/value.js +0 -21
  73. package/dist/canvas/value.js.map +0 -1
  74. package/dist/dollar.d.ts +0 -60
  75. package/dist/dollar.d.ts.map +0 -1
  76. package/dist/dollar.js +0 -107
  77. package/dist/dollar.js.map +0 -1
  78. package/dist/entities/assets.d.ts +0 -21
  79. package/dist/entities/assets.d.ts.map +0 -1
  80. package/dist/entities/assets.js +0 -323
  81. package/dist/entities/assets.js.map +0 -1
  82. package/dist/entities/business.d.ts +0 -36
  83. package/dist/entities/business.d.ts.map +0 -1
  84. package/dist/entities/business.js +0 -370
  85. package/dist/entities/business.js.map +0 -1
  86. package/dist/entities/communication.d.ts +0 -21
  87. package/dist/entities/communication.d.ts.map +0 -1
  88. package/dist/entities/communication.js +0 -255
  89. package/dist/entities/communication.js.map +0 -1
  90. package/dist/entities/customers.d.ts +0 -58
  91. package/dist/entities/customers.d.ts.map +0 -1
  92. package/dist/entities/customers.js +0 -989
  93. package/dist/entities/customers.js.map +0 -1
  94. package/dist/entities/financials.d.ts +0 -59
  95. package/dist/entities/financials.d.ts.map +0 -1
  96. package/dist/entities/financials.js +0 -932
  97. package/dist/entities/financials.js.map +0 -1
  98. package/dist/entities/goals.d.ts +0 -58
  99. package/dist/entities/goals.d.ts.map +0 -1
  100. package/dist/entities/goals.js +0 -800
  101. package/dist/entities/goals.js.map +0 -1
  102. package/dist/entities/index.d.ts +0 -299
  103. package/dist/entities/index.d.ts.map +0 -1
  104. package/dist/entities/index.js +0 -198
  105. package/dist/entities/index.js.map +0 -1
  106. package/dist/entities/legal.d.ts +0 -21
  107. package/dist/entities/legal.d.ts.map +0 -1
  108. package/dist/entities/legal.js +0 -301
  109. package/dist/entities/legal.js.map +0 -1
  110. package/dist/entities/market.d.ts +0 -21
  111. package/dist/entities/market.d.ts.map +0 -1
  112. package/dist/entities/market.js +0 -301
  113. package/dist/entities/market.js.map +0 -1
  114. package/dist/entities/marketing.d.ts +0 -67
  115. package/dist/entities/marketing.d.ts.map +0 -1
  116. package/dist/entities/marketing.js +0 -1157
  117. package/dist/entities/marketing.js.map +0 -1
  118. package/dist/entities/offerings.d.ts +0 -51
  119. package/dist/entities/offerings.d.ts.map +0 -1
  120. package/dist/entities/offerings.js +0 -727
  121. package/dist/entities/offerings.js.map +0 -1
  122. package/dist/entities/operations.d.ts +0 -58
  123. package/dist/entities/operations.d.ts.map +0 -1
  124. package/dist/entities/operations.js +0 -787
  125. package/dist/entities/operations.js.map +0 -1
  126. package/dist/entities/organization.d.ts +0 -57
  127. package/dist/entities/organization.d.ts.map +0 -1
  128. package/dist/entities/organization.js +0 -807
  129. package/dist/entities/organization.js.map +0 -1
  130. package/dist/entities/partnerships.d.ts +0 -21
  131. package/dist/entities/partnerships.d.ts.map +0 -1
  132. package/dist/entities/partnerships.js +0 -300
  133. package/dist/entities/partnerships.js.map +0 -1
  134. package/dist/entities/planning.d.ts +0 -0
  135. package/dist/entities/planning.d.ts.map +0 -1
  136. package/dist/entities/planning.js +0 -271
  137. package/dist/entities/planning.js.map +0 -1
  138. package/dist/entities/projects.d.ts +0 -25
  139. package/dist/entities/projects.d.ts.map +0 -1
  140. package/dist/entities/projects.js +0 -349
  141. package/dist/entities/projects.js.map +0 -1
  142. package/dist/entities/risk.d.ts +0 -21
  143. package/dist/entities/risk.d.ts.map +0 -1
  144. package/dist/entities/risk.js +0 -293
  145. package/dist/entities/risk.js.map +0 -1
  146. package/dist/entities/sales.d.ts +0 -72
  147. package/dist/entities/sales.d.ts.map +0 -1
  148. package/dist/entities/sales.js +0 -1248
  149. package/dist/entities/sales.js.map +0 -1
  150. package/dist/financials.d.ts +0 -130
  151. package/dist/financials.d.ts.map +0 -1
  152. package/dist/financials.js +0 -297
  153. package/dist/financials.js.map +0 -1
  154. package/dist/goals.d.ts +0 -87
  155. package/dist/goals.d.ts.map +0 -1
  156. package/dist/goals.js +0 -215
  157. package/dist/goals.js.map +0 -1
  158. package/dist/index.d.ts +0 -97
  159. package/dist/index.d.ts.map +0 -1
  160. package/dist/index.js +0 -132
  161. package/dist/index.js.map +0 -1
  162. package/dist/kpis.d.ts +0 -118
  163. package/dist/kpis.d.ts.map +0 -1
  164. package/dist/kpis.js +0 -232
  165. package/dist/kpis.js.map +0 -1
  166. package/dist/metrics.d.ts +0 -448
  167. package/dist/metrics.d.ts.map +0 -1
  168. package/dist/metrics.js +0 -325
  169. package/dist/metrics.js.map +0 -1
  170. package/dist/okrs.d.ts +0 -123
  171. package/dist/okrs.d.ts.map +0 -1
  172. package/dist/okrs.js +0 -269
  173. package/dist/okrs.js.map +0 -1
  174. package/dist/organization.d.ts +0 -585
  175. package/dist/organization.d.ts.map +0 -1
  176. package/dist/organization.js +0 -173
  177. package/dist/organization.js.map +0 -1
  178. package/dist/process.d.ts +0 -112
  179. package/dist/process.d.ts.map +0 -1
  180. package/dist/process.js +0 -241
  181. package/dist/process.js.map +0 -1
  182. package/dist/product.d.ts +0 -85
  183. package/dist/product.d.ts.map +0 -1
  184. package/dist/product.js +0 -145
  185. package/dist/product.js.map +0 -1
  186. package/dist/queries.d.ts +0 -304
  187. package/dist/queries.d.ts.map +0 -1
  188. package/dist/queries.js +0 -415
  189. package/dist/queries.js.map +0 -1
  190. package/dist/roles.d.ts +0 -340
  191. package/dist/roles.d.ts.map +0 -1
  192. package/dist/roles.js +0 -255
  193. package/dist/roles.js.map +0 -1
  194. package/dist/service.d.ts +0 -61
  195. package/dist/service.d.ts.map +0 -1
  196. package/dist/service.js +0 -140
  197. package/dist/service.js.map +0 -1
  198. package/dist/types.d.ts +0 -459
  199. package/dist/types.d.ts.map +0 -1
  200. package/dist/types.js +0 -5
  201. package/dist/types.js.map +0 -1
  202. package/dist/vision.d.ts +0 -38
  203. package/dist/vision.d.ts.map +0 -1
  204. package/dist/vision.js +0 -68
  205. package/dist/vision.js.map +0 -1
  206. package/dist/workflow.d.ts +0 -115
  207. package/dist/workflow.d.ts.map +0 -1
  208. package/dist/workflow.js +0 -247
  209. package/dist/workflow.js.map +0 -1
  210. package/src/business.js +0 -108
  211. package/src/canvas/activities.ts +0 -32
  212. package/src/canvas/canvas.ts +0 -482
  213. package/src/canvas/channels.ts +0 -34
  214. package/src/canvas/costs.ts +0 -43
  215. package/src/canvas/economics.ts +0 -99
  216. package/src/canvas/index.ts +0 -206
  217. package/src/canvas/partnerships.ts +0 -34
  218. package/src/canvas/projections.ts +0 -141
  219. package/src/canvas/relationships.ts +0 -34
  220. package/src/canvas/resources.ts +0 -43
  221. package/src/canvas/revenue.ts +0 -56
  222. package/src/canvas/segments.ts +0 -42
  223. package/src/canvas/types.ts +0 -363
  224. package/src/canvas/value.ts +0 -34
  225. package/src/dollar.js +0 -106
  226. package/src/entities/assets.js +0 -322
  227. package/src/entities/business.js +0 -369
  228. package/src/entities/communication.js +0 -254
  229. package/src/entities/customers.js +0 -988
  230. package/src/entities/financials.js +0 -931
  231. package/src/entities/goals.js +0 -799
  232. package/src/entities/index.js +0 -197
  233. package/src/entities/legal.js +0 -300
  234. package/src/entities/market.js +0 -300
  235. package/src/entities/marketing.js +0 -1156
  236. package/src/entities/offerings.js +0 -726
  237. package/src/entities/operations.js +0 -786
  238. package/src/entities/organization.js +0 -806
  239. package/src/entities/partnerships.js +0 -299
  240. package/src/entities/planning.js +0 -270
  241. package/src/entities/projects.js +0 -348
  242. package/src/entities/risk.js +0 -292
  243. package/src/entities/sales.js +0 -1247
  244. package/src/financials.js +0 -296
  245. package/src/goals.js +0 -214
  246. package/src/index.js +0 -131
  247. package/src/index.test.js +0 -274
  248. package/src/kpis.js +0 -231
  249. package/src/metrics.js +0 -324
  250. package/src/okrs.js +0 -268
  251. package/src/organization.js +0 -172
  252. package/src/process.js +0 -240
  253. package/src/product.js +0 -144
  254. package/src/queries.js +0 -414
  255. package/src/roles.js +0 -254
  256. package/src/service.js +0 -139
  257. package/src/types.js +0 -4
  258. package/src/vision.js +0 -67
  259. package/src/workflow.js +0 -246
  260. package/tests/canvas.test.ts +0 -842
@@ -1,348 +0,0 @@
1
- /**
2
- * Project Management Entities
3
- * Project, Task, Milestone, Sprint, Deliverable, Epic, Story, Resource
4
- */
5
- export const Project = {
6
- singular: 'project',
7
- plural: 'projects',
8
- description: 'A project with defined scope, timeline, and deliverables',
9
- properties: {
10
- name: { type: 'string', description: 'Project name' },
11
- description: { type: 'string', description: 'Project description' },
12
- type: { type: 'string', description: 'Type of project', examples: ['product', 'internal', 'client', 'research', 'infrastructure', 'migration', 'integration', 'transformation'] },
13
- status: { type: 'string', description: 'Project status', examples: ['proposed', 'planning', 'approved', 'active', 'on-hold', 'completed', 'cancelled', 'archived'] },
14
- phase: { type: 'string', description: 'Current phase', examples: ['initiation', 'planning', 'execution', 'monitoring', 'closure'] },
15
- priority: { type: 'string', description: 'Project priority', examples: ['critical', 'high', 'medium', 'low'] },
16
- methodology: { type: 'string', description: 'Project methodology', examples: ['agile', 'scrum', 'kanban', 'waterfall', 'hybrid', 'lean'] },
17
- code: { type: 'string', description: 'Project code or identifier' },
18
- objectives: { type: 'string[]', description: 'Project objectives' },
19
- scope: { type: 'string', description: 'Project scope' },
20
- outOfScope: { type: 'string[]', description: 'Out of scope items' },
21
- assumptions: { type: 'string[]', description: 'Project assumptions' },
22
- constraints: { type: 'string[]', description: 'Project constraints' },
23
- dependencies: { type: 'string[]', description: 'External dependencies' },
24
- startDate: { type: 'date', description: 'Planned start date' },
25
- endDate: { type: 'date', description: 'Planned end date' },
26
- actualStartDate: { type: 'date', description: 'Actual start date', optional: true },
27
- actualEndDate: { type: 'date', description: 'Actual end date', optional: true },
28
- deadline: { type: 'date', description: 'Hard deadline', optional: true },
29
- progress: { type: 'number', description: 'Progress percentage' },
30
- health: { type: 'string', description: 'Project health', examples: ['on-track', 'at-risk', 'off-track', 'blocked'] },
31
- budget: { type: 'number', description: 'Total budget' },
32
- spent: { type: 'number', description: 'Amount spent' },
33
- remaining: { type: 'number', description: 'Budget remaining' },
34
- forecast: { type: 'number', description: 'Forecasted total cost' },
35
- variance: { type: 'number', description: 'Budget variance' },
36
- currency: { type: 'string', description: 'Budget currency' },
37
- sponsor: { type: 'string', description: 'Executive sponsor' },
38
- owner: { type: 'string', description: 'Project owner' },
39
- manager: { type: 'string', description: 'Project manager' },
40
- teamLead: { type: 'string', description: 'Technical lead' },
41
- teamSize: { type: 'number', description: 'Team size' },
42
- stakeholders: { type: 'string[]', description: 'Key stakeholders' },
43
- businessUnit: { type: 'string', description: 'Business unit' },
44
- portfolio: { type: 'string', description: 'Portfolio or program' },
45
- category: { type: 'string', description: 'Project category' },
46
- tags: { type: 'string[]', description: 'Project tags' },
47
- notes: { type: 'string', description: 'Internal notes', optional: true },
48
- metadata: { type: 'object', description: 'Additional metadata', optional: true },
49
- },
50
- relationships: {
51
- tasks: { type: 'task[]', description: 'Project tasks', backref: 'project' },
52
- milestones: { type: 'milestone[]', description: 'Project milestones', backref: 'project' },
53
- deliverables: { type: 'deliverable[]', description: 'Project deliverables', backref: 'project' },
54
- sprints: { type: 'sprint[]', description: 'Project sprints', backref: 'project' },
55
- epics: { type: 'epic[]', description: 'Project epics', backref: 'project' },
56
- resources: { type: 'resource[]', description: 'Assigned resources', backref: 'projects' },
57
- risks: { type: 'risk[]', description: 'Project risks', backref: 'project' },
58
- team: { type: 'team', description: 'Project team', backref: 'projects' },
59
- parentProject: { type: 'project', description: 'Parent project', backref: 'subProjects' },
60
- subProjects: { type: 'project[]', description: 'Sub-projects', backref: 'parentProject' },
61
- },
62
- actions: ['create', 'update', 'plan', 'approve', 'start', 'pause', 'resume', 'complete', 'cancel', 'archive', 'replan', 'review'],
63
- events: ['created', 'updated', 'planned', 'approved', 'started', 'paused', 'resumed', 'completed', 'cancelled', 'archived', 'replanned', 'reviewed'],
64
- };
65
- export const Task = {
66
- singular: 'task',
67
- plural: 'tasks',
68
- description: 'A task or work item to be completed',
69
- properties: {
70
- name: { type: 'string', description: 'Task name' },
71
- description: { type: 'string', description: 'Task description' },
72
- type: { type: 'string', description: 'Type of task', examples: ['task', 'bug', 'feature', 'improvement', 'research', 'documentation', 'test', 'review', 'deployment'] },
73
- status: { type: 'string', description: 'Task status', examples: ['backlog', 'todo', 'in-progress', 'review', 'blocked', 'done', 'cancelled'] },
74
- priority: { type: 'string', description: 'Task priority', examples: ['critical', 'high', 'medium', 'low'] },
75
- resolution: { type: 'string', description: 'Resolution status', examples: ['unresolved', 'fixed', 'wont-fix', 'duplicate', 'cannot-reproduce', 'deferred'] },
76
- estimate: { type: 'number', description: 'Estimated hours/points' },
77
- timeSpent: { type: 'number', description: 'Time spent' },
78
- remaining: { type: 'number', description: 'Time remaining' },
79
- storyPoints: { type: 'number', description: 'Story points' },
80
- complexity: { type: 'string', description: 'Complexity level', examples: ['trivial', 'simple', 'medium', 'complex', 'unknown'] },
81
- startDate: { type: 'date', description: 'Start date' },
82
- dueDate: { type: 'date', description: 'Due date' },
83
- completedDate: { type: 'date', description: 'Completion date', optional: true },
84
- assignee: { type: 'string', description: 'Assigned person' },
85
- reporter: { type: 'string', description: 'Task reporter' },
86
- reviewer: { type: 'string', description: 'Task reviewer' },
87
- labels: { type: 'string[]', description: 'Task labels' },
88
- components: { type: 'string[]', description: 'Affected components' },
89
- acceptanceCriteria: { type: 'string[]', description: 'Acceptance criteria' },
90
- blockedReason: { type: 'string', description: 'Blocked reason', optional: true },
91
- pullRequest: { type: 'string', description: 'PR/MR link', optional: true },
92
- branch: { type: 'string', description: 'Git branch', optional: true },
93
- progress: { type: 'number', description: 'Progress percentage' },
94
- externalId: { type: 'string', description: 'External system ID', optional: true },
95
- notes: { type: 'string', description: 'Internal notes', optional: true },
96
- tags: { type: 'string[]', description: 'Task tags' },
97
- metadata: { type: 'object', description: 'Additional metadata', optional: true },
98
- },
99
- relationships: {
100
- project: { type: 'project', description: 'Parent project', backref: 'tasks' },
101
- epic: { type: 'epic', description: 'Parent epic', backref: 'tasks' },
102
- story: { type: 'story', description: 'Parent story', backref: 'tasks' },
103
- sprint: { type: 'sprint', description: 'Assigned sprint', backref: 'tasks' },
104
- milestone: { type: 'milestone', description: 'Target milestone', backref: 'tasks' },
105
- parentTask: { type: 'task', description: 'Parent task', backref: 'subtasks' },
106
- subtasks: { type: 'task[]', description: 'Subtasks', backref: 'parentTask' },
107
- blockedBy: { type: 'task[]', description: 'Blocked by tasks', backref: 'blocks' },
108
- blocks: { type: 'task[]', description: 'Tasks this blocks', backref: 'blockedBy' },
109
- relatedTasks: { type: 'task[]', description: 'Related tasks', backref: 'relatedTasks' },
110
- },
111
- actions: ['create', 'update', 'assign', 'start', 'pause', 'resume', 'complete', 'cancel', 'reopen', 'block', 'unblock', 'estimate', 'review'],
112
- events: ['created', 'updated', 'assigned', 'started', 'paused', 'resumed', 'completed', 'cancelled', 'reopened', 'blocked', 'unblocked', 'estimated', 'reviewed'],
113
- };
114
- export const Milestone = {
115
- singular: 'milestone',
116
- plural: 'milestones',
117
- description: 'A project milestone or checkpoint',
118
- properties: {
119
- name: { type: 'string', description: 'Milestone name' },
120
- description: { type: 'string', description: 'Milestone description' },
121
- type: { type: 'string', description: 'Type of milestone', examples: ['phase-gate', 'release', 'delivery', 'review', 'approval', 'launch', 'go-live'] },
122
- status: { type: 'string', description: 'Milestone status', examples: ['planned', 'in-progress', 'completed', 'delayed', 'at-risk', 'cancelled'] },
123
- targetDate: { type: 'date', description: 'Target date' },
124
- actualDate: { type: 'date', description: 'Actual completion date', optional: true },
125
- progress: { type: 'number', description: 'Progress percentage' },
126
- deliverables: { type: 'string[]', description: 'Expected deliverables' },
127
- criteria: { type: 'string[]', description: 'Completion criteria' },
128
- owner: { type: 'string', description: 'Milestone owner' },
129
- approver: { type: 'string', description: 'Milestone approver' },
130
- approved: { type: 'boolean', description: 'Has been approved' },
131
- approvalDate: { type: 'date', description: 'Approval date', optional: true },
132
- blockers: { type: 'string[]', description: 'Current blockers' },
133
- dependencies: { type: 'string[]', description: 'Dependencies' },
134
- notes: { type: 'string', description: 'Internal notes', optional: true },
135
- tags: { type: 'string[]', description: 'Milestone tags' },
136
- metadata: { type: 'object', description: 'Additional metadata', optional: true },
137
- },
138
- relationships: {
139
- project: { type: 'project', description: 'Parent project', backref: 'milestones', required: true },
140
- tasks: { type: 'task[]', description: 'Milestone tasks', backref: 'milestone' },
141
- deliverables: { type: 'deliverable[]', description: 'Milestone deliverables', backref: 'milestone' },
142
- previousMilestone: { type: 'milestone', description: 'Previous milestone', backref: 'nextMilestone' },
143
- nextMilestone: { type: 'milestone', description: 'Next milestone', backref: 'previousMilestone' },
144
- },
145
- actions: ['create', 'update', 'start', 'complete', 'delay', 'approve', 'cancel', 'review'],
146
- events: ['created', 'updated', 'started', 'completed', 'delayed', 'approved', 'cancelled', 'reviewed'],
147
- };
148
- export const Sprint = {
149
- singular: 'sprint',
150
- plural: 'sprints',
151
- description: 'A time-boxed iteration in agile development',
152
- properties: {
153
- name: { type: 'string', description: 'Sprint name' },
154
- number: { type: 'number', description: 'Sprint number' },
155
- goal: { type: 'string', description: 'Sprint goal' },
156
- status: { type: 'string', description: 'Sprint status', examples: ['planning', 'active', 'review', 'completed', 'cancelled'] },
157
- startDate: { type: 'date', description: 'Sprint start date' },
158
- endDate: { type: 'date', description: 'Sprint end date' },
159
- duration: { type: 'number', description: 'Duration in days' },
160
- capacity: { type: 'number', description: 'Team capacity (points/hours)' },
161
- commitment: { type: 'number', description: 'Committed points/hours' },
162
- completed: { type: 'number', description: 'Completed points/hours' },
163
- velocity: { type: 'number', description: 'Sprint velocity' },
164
- completionRate: { type: 'number', description: 'Completion rate percentage' },
165
- carryOver: { type: 'number', description: 'Points carried over' },
166
- addedScope: { type: 'number', description: 'Scope added during sprint' },
167
- removedScope: { type: 'number', description: 'Scope removed during sprint' },
168
- totalTasks: { type: 'number', description: 'Total tasks' },
169
- completedTasks: { type: 'number', description: 'Completed tasks' },
170
- inProgressTasks: { type: 'number', description: 'In-progress tasks' },
171
- blockedTasks: { type: 'number', description: 'Blocked tasks' },
172
- retroNotes: { type: 'string', description: 'Retrospective notes', optional: true },
173
- retroUrl: { type: 'string', description: 'Retrospective document URL', optional: true },
174
- reviewUrl: { type: 'string', description: 'Sprint review document URL', optional: true },
175
- notes: { type: 'string', description: 'Internal notes', optional: true },
176
- tags: { type: 'string[]', description: 'Sprint tags' },
177
- metadata: { type: 'object', description: 'Additional metadata', optional: true },
178
- },
179
- relationships: {
180
- project: { type: 'project', description: 'Parent project', backref: 'sprints', required: true },
181
- tasks: { type: 'task[]', description: 'Sprint tasks', backref: 'sprint' },
182
- stories: { type: 'story[]', description: 'Sprint stories', backref: 'sprint' },
183
- team: { type: 'team', description: 'Sprint team', backref: 'sprints' },
184
- previousSprint: { type: 'sprint', description: 'Previous sprint', backref: 'nextSprint' },
185
- nextSprint: { type: 'sprint', description: 'Next sprint', backref: 'previousSprint' },
186
- },
187
- actions: ['create', 'update', 'plan', 'start', 'complete', 'cancel', 'review', 'retrospect'],
188
- events: ['created', 'updated', 'planned', 'started', 'completed', 'cancelled', 'reviewed', 'retrospected'],
189
- };
190
- export const Deliverable = {
191
- singular: 'deliverable',
192
- plural: 'deliverables',
193
- description: 'A project deliverable or output',
194
- properties: {
195
- name: { type: 'string', description: 'Deliverable name' },
196
- description: { type: 'string', description: 'Deliverable description' },
197
- type: { type: 'string', description: 'Type of deliverable', examples: ['document', 'software', 'report', 'design', 'prototype', 'training', 'process', 'artifact'] },
198
- status: { type: 'string', description: 'Deliverable status', examples: ['planned', 'in-progress', 'review', 'approved', 'delivered', 'rejected'] },
199
- format: { type: 'string', description: 'Deliverable format' },
200
- version: { type: 'string', description: 'Current version' },
201
- dueDate: { type: 'date', description: 'Due date' },
202
- deliveredDate: { type: 'date', description: 'Delivery date', optional: true },
203
- owner: { type: 'string', description: 'Deliverable owner' },
204
- reviewer: { type: 'string', description: 'Deliverable reviewer' },
205
- acceptor: { type: 'string', description: 'Acceptance authority' },
206
- acceptanceCriteria: { type: 'string[]', description: 'Acceptance criteria' },
207
- accepted: { type: 'boolean', description: 'Has been accepted' },
208
- acceptanceDate: { type: 'date', description: 'Acceptance date', optional: true },
209
- comments: { type: 'string', description: 'Review comments', optional: true },
210
- url: { type: 'string', description: 'Deliverable URL' },
211
- progress: { type: 'number', description: 'Progress percentage' },
212
- notes: { type: 'string', description: 'Internal notes', optional: true },
213
- tags: { type: 'string[]', description: 'Deliverable tags' },
214
- metadata: { type: 'object', description: 'Additional metadata', optional: true },
215
- },
216
- relationships: {
217
- project: { type: 'project', description: 'Parent project', backref: 'deliverables', required: true },
218
- milestone: { type: 'milestone', description: 'Target milestone', backref: 'deliverables' },
219
- tasks: { type: 'task[]', description: 'Related tasks', backref: 'deliverable' },
220
- dependencies: { type: 'deliverable[]', description: 'Dependent deliverables', backref: 'dependents' },
221
- dependents: { type: 'deliverable[]', description: 'Deliverables that depend on this', backref: 'dependencies' },
222
- },
223
- actions: ['create', 'update', 'start', 'submit', 'review', 'approve', 'reject', 'revise', 'deliver', 'accept'],
224
- events: ['created', 'updated', 'started', 'submitted', 'reviewed', 'approved', 'rejected', 'revised', 'delivered', 'accepted'],
225
- };
226
- export const Epic = {
227
- singular: 'epic',
228
- plural: 'epics',
229
- description: 'A large body of work that can be broken into stories',
230
- properties: {
231
- name: { type: 'string', description: 'Epic name' },
232
- description: { type: 'string', description: 'Epic description' },
233
- status: { type: 'string', description: 'Epic status', examples: ['draft', 'ready', 'in-progress', 'done', 'cancelled'] },
234
- priority: { type: 'string', description: 'Epic priority', examples: ['critical', 'high', 'medium', 'low'] },
235
- theme: { type: 'string', description: 'Epic theme or initiative' },
236
- businessValue: { type: 'string', description: 'Business value statement' },
237
- hypothesis: { type: 'string', description: 'Business hypothesis', optional: true },
238
- successMetrics: { type: 'string[]', description: 'Success metrics' },
239
- acceptanceCriteria: { type: 'string[]', description: 'Acceptance criteria' },
240
- startDate: { type: 'date', description: 'Start date' },
241
- targetDate: { type: 'date', description: 'Target completion date' },
242
- completedDate: { type: 'date', description: 'Completion date', optional: true },
243
- estimate: { type: 'number', description: 'Estimated points' },
244
- completed: { type: 'number', description: 'Completed points' },
245
- progress: { type: 'number', description: 'Progress percentage' },
246
- owner: { type: 'string', description: 'Epic owner' },
247
- labels: { type: 'string[]', description: 'Epic labels' },
248
- notes: { type: 'string', description: 'Internal notes', optional: true },
249
- tags: { type: 'string[]', description: 'Epic tags' },
250
- metadata: { type: 'object', description: 'Additional metadata', optional: true },
251
- },
252
- relationships: {
253
- project: { type: 'project', description: 'Parent project', backref: 'epics', required: true },
254
- stories: { type: 'story[]', description: 'Epic stories', backref: 'epic' },
255
- tasks: { type: 'task[]', description: 'Epic tasks', backref: 'epic' },
256
- initiative: { type: 'initiative', description: 'Parent initiative', backref: 'epics' },
257
- dependencies: { type: 'epic[]', description: 'Dependent epics', backref: 'dependents' },
258
- },
259
- actions: ['create', 'update', 'refine', 'start', 'complete', 'cancel', 'split', 'prioritize'],
260
- events: ['created', 'updated', 'refined', 'started', 'completed', 'cancelled', 'split', 'prioritized'],
261
- };
262
- export const Story = {
263
- singular: 'story',
264
- plural: 'stories',
265
- description: 'A user story representing a feature from user perspective',
266
- properties: {
267
- name: { type: 'string', description: 'Story name' },
268
- description: { type: 'string', description: 'Story description' },
269
- userStory: { type: 'string', description: 'As a... I want... So that...' },
270
- status: { type: 'string', description: 'Story status', examples: ['draft', 'ready', 'in-progress', 'review', 'done', 'cancelled'] },
271
- priority: { type: 'string', description: 'Story priority', examples: ['critical', 'high', 'medium', 'low'] },
272
- storyPoints: { type: 'number', description: 'Story points estimate' },
273
- businessValue: { type: 'number', description: 'Business value score' },
274
- acceptanceCriteria: { type: 'string[]', description: 'Acceptance criteria' },
275
- definition: { type: 'string', description: 'Definition of done criteria' },
276
- persona: { type: 'string', description: 'Target user persona' },
277
- assignee: { type: 'string', description: 'Assigned person' },
278
- reporter: { type: 'string', description: 'Story reporter' },
279
- labels: { type: 'string[]', description: 'Story labels' },
280
- components: { type: 'string[]', description: 'Affected components' },
281
- startDate: { type: 'date', description: 'Start date' },
282
- dueDate: { type: 'date', description: 'Due date' },
283
- completedDate: { type: 'date', description: 'Completion date', optional: true },
284
- progress: { type: 'number', description: 'Progress percentage' },
285
- notes: { type: 'string', description: 'Internal notes', optional: true },
286
- tags: { type: 'string[]', description: 'Story tags' },
287
- metadata: { type: 'object', description: 'Additional metadata', optional: true },
288
- },
289
- relationships: {
290
- epic: { type: 'epic', description: 'Parent epic', backref: 'stories' },
291
- project: { type: 'project', description: 'Parent project', backref: 'stories' },
292
- sprint: { type: 'sprint', description: 'Assigned sprint', backref: 'stories' },
293
- tasks: { type: 'task[]', description: 'Story tasks', backref: 'story' },
294
- blockedBy: { type: 'story[]', description: 'Blocked by stories', backref: 'blocks' },
295
- blocks: { type: 'story[]', description: 'Stories this blocks', backref: 'blockedBy' },
296
- },
297
- actions: ['create', 'update', 'refine', 'estimate', 'assign', 'start', 'complete', 'reject', 'split'],
298
- events: ['created', 'updated', 'refined', 'estimated', 'assigned', 'started', 'completed', 'rejected', 'split'],
299
- };
300
- export const Resource = {
301
- singular: 'resource',
302
- plural: 'resources',
303
- description: 'A project resource (person, equipment, or material)',
304
- properties: {
305
- name: { type: 'string', description: 'Resource name' },
306
- type: { type: 'string', description: 'Type of resource', examples: ['person', 'equipment', 'material', 'facility', 'budget', 'software'] },
307
- status: { type: 'string', description: 'Resource status', examples: ['available', 'assigned', 'unavailable', 'on-leave', 'overallocated'] },
308
- role: { type: 'string', description: 'Resource role or function' },
309
- skills: { type: 'string[]', description: 'Skills or capabilities' },
310
- capacity: { type: 'number', description: 'Total capacity (hours/units)' },
311
- allocated: { type: 'number', description: 'Currently allocated' },
312
- available: { type: 'number', description: 'Available capacity' },
313
- utilizationTarget: { type: 'number', description: 'Target utilization percentage' },
314
- utilizationActual: { type: 'number', description: 'Actual utilization percentage' },
315
- costRate: { type: 'number', description: 'Cost rate per hour/unit' },
316
- billableRate: { type: 'number', description: 'Billable rate per hour/unit', optional: true },
317
- currency: { type: 'string', description: 'Rate currency' },
318
- location: { type: 'string', description: 'Resource location' },
319
- timezone: { type: 'string', description: 'Time zone' },
320
- startDate: { type: 'date', description: 'Availability start' },
321
- endDate: { type: 'date', description: 'Availability end', optional: true },
322
- manager: { type: 'string', description: 'Resource manager' },
323
- email: { type: 'string', description: 'Contact email', optional: true },
324
- notes: { type: 'string', description: 'Internal notes', optional: true },
325
- tags: { type: 'string[]', description: 'Resource tags' },
326
- metadata: { type: 'object', description: 'Additional metadata', optional: true },
327
- },
328
- relationships: {
329
- projects: { type: 'project[]', description: 'Assigned projects', backref: 'resources' },
330
- tasks: { type: 'task[]', description: 'Assigned tasks', backref: 'resource' },
331
- team: { type: 'team', description: 'Resource team', backref: 'resources' },
332
- worker: { type: 'worker', description: 'Worker profile', backref: 'resource' },
333
- },
334
- actions: ['create', 'update', 'allocate', 'deallocate', 'reassign', 'book', 'release'],
335
- events: ['created', 'updated', 'allocated', 'deallocated', 'reassigned', 'booked', 'released'],
336
- };
337
- // Export all project entities
338
- export const ProjectEntities = {
339
- Project,
340
- Task,
341
- Milestone,
342
- Sprint,
343
- Deliverable,
344
- Epic,
345
- Story,
346
- Resource,
347
- };
348
- export default ProjectEntities;