@harness-engineering/types 0.1.0 → 0.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 (3) hide show
  1. package/dist/index.d.mts +57 -2
  2. package/dist/index.d.ts +57 -2
  3. package/package.json +2 -2
package/dist/index.d.mts CHANGED
@@ -81,7 +81,7 @@ type SkillError = {
81
81
  message: string;
82
82
  phase: string;
83
83
  };
84
- type CICheckName = 'validate' | 'deps' | 'docs' | 'entropy' | 'phase-gate';
84
+ type CICheckName = 'validate' | 'deps' | 'docs' | 'entropy' | 'security' | 'perf' | 'phase-gate';
85
85
  type CICheckStatus = 'pass' | 'fail' | 'warn' | 'skip';
86
86
  interface CICheckIssue {
87
87
  severity: 'error' | 'warning';
@@ -131,5 +131,60 @@ interface SkillLifecycleHooks {
131
131
  perTurn?: (context: TurnContext) => TurnContext | null;
132
132
  postExecution?: (context: SkillContext, result: SkillResult) => void;
133
133
  }
134
+ /**
135
+ * Valid statuses for a roadmap feature.
136
+ */
137
+ type FeatureStatus = 'backlog' | 'planned' | 'in-progress' | 'done' | 'blocked';
138
+ /**
139
+ * A feature entry in the project roadmap.
140
+ */
141
+ interface RoadmapFeature {
142
+ /** Feature name (from the H3 heading, without "Feature:" prefix) */
143
+ name: string;
144
+ /** Current status */
145
+ status: FeatureStatus;
146
+ /** Relative path to the spec file, or null if none */
147
+ spec: string | null;
148
+ /** Relative paths to plan files */
149
+ plans: string[];
150
+ /** Names of blocking features (textual references) */
151
+ blockedBy: string[];
152
+ /** One-line summary */
153
+ summary: string;
154
+ }
155
+ /**
156
+ * A milestone grouping in the roadmap. The special "Backlog" milestone
157
+ * has `isBacklog: true` and appears as `## Backlog` instead of `## Milestone: <name>`.
158
+ */
159
+ interface RoadmapMilestone {
160
+ /** Milestone name (e.g., "MVP Release") or "Backlog" */
161
+ name: string;
162
+ /** True for the special Backlog section */
163
+ isBacklog: boolean;
164
+ /** Features in this milestone, in document order */
165
+ features: RoadmapFeature[];
166
+ }
167
+ /**
168
+ * YAML frontmatter of the roadmap file.
169
+ */
170
+ interface RoadmapFrontmatter {
171
+ /** Project name */
172
+ project: string;
173
+ /** Schema version (currently 1) */
174
+ version: number;
175
+ /** ISO timestamp of last automated sync */
176
+ lastSynced: string;
177
+ /** ISO timestamp of last manual edit */
178
+ lastManualEdit: string;
179
+ }
180
+ /**
181
+ * Parsed roadmap document.
182
+ */
183
+ interface Roadmap {
184
+ /** Parsed frontmatter */
185
+ frontmatter: RoadmapFrontmatter;
186
+ /** Milestones in document order (including Backlog) */
187
+ milestones: RoadmapMilestone[];
188
+ }
134
189
 
135
- export { type CICheckIssue, type CICheckName, type CICheckOptions, type CICheckReport, type CICheckResult, type CICheckStatus, type CICheckSummary, type CIFailOnSeverity, type CIInitOptions, type CIPlatform, type CognitiveMode, Err, Ok, type Result, STANDARD_COGNITIVE_MODES, type SkillContext, type SkillError, type SkillLifecycleHooks, type SkillMetadata, type SkillResult, type StepOutcome, type TurnContext, type Workflow, type WorkflowResult, type WorkflowStep, type WorkflowStepResult, isErr, isOk };
190
+ export { type CICheckIssue, type CICheckName, type CICheckOptions, type CICheckReport, type CICheckResult, type CICheckStatus, type CICheckSummary, type CIFailOnSeverity, type CIInitOptions, type CIPlatform, type CognitiveMode, Err, type FeatureStatus, Ok, type Result, type Roadmap, type RoadmapFeature, type RoadmapFrontmatter, type RoadmapMilestone, STANDARD_COGNITIVE_MODES, type SkillContext, type SkillError, type SkillLifecycleHooks, type SkillMetadata, type SkillResult, type StepOutcome, type TurnContext, type Workflow, type WorkflowResult, type WorkflowStep, type WorkflowStepResult, isErr, isOk };
package/dist/index.d.ts CHANGED
@@ -81,7 +81,7 @@ type SkillError = {
81
81
  message: string;
82
82
  phase: string;
83
83
  };
84
- type CICheckName = 'validate' | 'deps' | 'docs' | 'entropy' | 'phase-gate';
84
+ type CICheckName = 'validate' | 'deps' | 'docs' | 'entropy' | 'security' | 'perf' | 'phase-gate';
85
85
  type CICheckStatus = 'pass' | 'fail' | 'warn' | 'skip';
86
86
  interface CICheckIssue {
87
87
  severity: 'error' | 'warning';
@@ -131,5 +131,60 @@ interface SkillLifecycleHooks {
131
131
  perTurn?: (context: TurnContext) => TurnContext | null;
132
132
  postExecution?: (context: SkillContext, result: SkillResult) => void;
133
133
  }
134
+ /**
135
+ * Valid statuses for a roadmap feature.
136
+ */
137
+ type FeatureStatus = 'backlog' | 'planned' | 'in-progress' | 'done' | 'blocked';
138
+ /**
139
+ * A feature entry in the project roadmap.
140
+ */
141
+ interface RoadmapFeature {
142
+ /** Feature name (from the H3 heading, without "Feature:" prefix) */
143
+ name: string;
144
+ /** Current status */
145
+ status: FeatureStatus;
146
+ /** Relative path to the spec file, or null if none */
147
+ spec: string | null;
148
+ /** Relative paths to plan files */
149
+ plans: string[];
150
+ /** Names of blocking features (textual references) */
151
+ blockedBy: string[];
152
+ /** One-line summary */
153
+ summary: string;
154
+ }
155
+ /**
156
+ * A milestone grouping in the roadmap. The special "Backlog" milestone
157
+ * has `isBacklog: true` and appears as `## Backlog` instead of `## Milestone: <name>`.
158
+ */
159
+ interface RoadmapMilestone {
160
+ /** Milestone name (e.g., "MVP Release") or "Backlog" */
161
+ name: string;
162
+ /** True for the special Backlog section */
163
+ isBacklog: boolean;
164
+ /** Features in this milestone, in document order */
165
+ features: RoadmapFeature[];
166
+ }
167
+ /**
168
+ * YAML frontmatter of the roadmap file.
169
+ */
170
+ interface RoadmapFrontmatter {
171
+ /** Project name */
172
+ project: string;
173
+ /** Schema version (currently 1) */
174
+ version: number;
175
+ /** ISO timestamp of last automated sync */
176
+ lastSynced: string;
177
+ /** ISO timestamp of last manual edit */
178
+ lastManualEdit: string;
179
+ }
180
+ /**
181
+ * Parsed roadmap document.
182
+ */
183
+ interface Roadmap {
184
+ /** Parsed frontmatter */
185
+ frontmatter: RoadmapFrontmatter;
186
+ /** Milestones in document order (including Backlog) */
187
+ milestones: RoadmapMilestone[];
188
+ }
134
189
 
135
- export { type CICheckIssue, type CICheckName, type CICheckOptions, type CICheckReport, type CICheckResult, type CICheckStatus, type CICheckSummary, type CIFailOnSeverity, type CIInitOptions, type CIPlatform, type CognitiveMode, Err, Ok, type Result, STANDARD_COGNITIVE_MODES, type SkillContext, type SkillError, type SkillLifecycleHooks, type SkillMetadata, type SkillResult, type StepOutcome, type TurnContext, type Workflow, type WorkflowResult, type WorkflowStep, type WorkflowStepResult, isErr, isOk };
190
+ export { type CICheckIssue, type CICheckName, type CICheckOptions, type CICheckReport, type CICheckResult, type CICheckStatus, type CICheckSummary, type CIFailOnSeverity, type CIInitOptions, type CIPlatform, type CognitiveMode, Err, type FeatureStatus, Ok, type Result, type Roadmap, type RoadmapFeature, type RoadmapFrontmatter, type RoadmapMilestone, STANDARD_COGNITIVE_MODES, type SkillContext, type SkillError, type SkillLifecycleHooks, type SkillMetadata, type SkillResult, type StepOutcome, type TurnContext, type Workflow, type WorkflowResult, type WorkflowStep, type WorkflowStepResult, isErr, isOk };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@harness-engineering/types",
3
- "version": "0.1.0",
3
+ "version": "0.2.0",
4
4
  "description": "TypeScript types and interfaces for Harness Engineering",
5
5
  "main": "./dist/index.js",
6
6
  "module": "./dist/index.mjs",
@@ -38,7 +38,7 @@
38
38
  "homepage": "https://github.com/Intense-Visions/harness-engineering/tree/main/packages/types#readme",
39
39
  "devDependencies": {
40
40
  "tsup": "^8.0.0",
41
- "vitest": "^2.0.0"
41
+ "vitest": "^4.0.18"
42
42
  },
43
43
  "scripts": {
44
44
  "build": "tsup src/index.ts --format cjs,esm --dts",