@sdods/contracts 0.2.0

package/dist/types.d.ts

@@ -0,0 +1,440 @@
+/** DTOs shared by runtime, ingest, server and web. Keep these plain (JSON-serialisable). */
+import type { BrowserName, Layer } from './schemas/project.js';
+export type SuiteStatus = 'passed' | 'failed' | 'skipped' | 'timedOut' | 'interrupted' | 'unknown';
+export type RunStatus = 'queued' | 'running' | 'passed' | 'failed' | 'cancelled' | 'error';
+export type RunTrigger = 'cli' | 'ui' | 'ci' | 'agent' | 'mcp' | 'schedule';
+export interface RunManifest {
+    runId: string;
+    projectSlug: string;
+    env: string;
+    tagsExpr?: string;
+    layers: Layer[];
+    browsers: BrowserName[];
+    suiteTag?: string;
+    trigger: RunTrigger;
+    git?: {
+        sha?: string;
+        branch?: string;
+        dirty?: boolean;
+    };
+    ci?: {
+        provider?: string;
+        runId?: string;
+        url?: string;
+    };
+    startedAt: string;
+    finishedAt?: string;
+    command: string;
+    shardIndex?: number;
+    shardTotal?: number;
+    process?: string;
+    modules?: string[];
+    sdodsVersion: string;
+    playwrightVersion?: string;
+    exitCode?: number;
+    ingestedAt?: string;
+}
+export interface RunTotals {
+    total: number;
+    passed: number;
+    failed: number;
+    skipped: number;
+    timedOut: number;
+    flaky: number;
+    healed: number;
+    durationMs: number;
+}
+export interface RunRecord {
+    id: string;
+    projectSlug: string;
+    env: string;
+    trigger: RunTrigger;
+    status: RunStatus;
+    suiteTag?: string;
+    tagsExpr?: string;
+    layers: Layer[];
+    browsers: BrowserName[];
+    gitSha?: string;
+    gitBranch?: string;
+    ciProvider?: string;
+    ciRunId?: string;
+    ciUrl?: string;
+    startedAt?: string;
+    finishedAt?: string;
+    durationMs?: number;
+    totals?: RunTotals;
+    artifactsDir?: string;
+    exitCode?: number;
+    errorText?: string;
+}
+export interface ScenarioMeta {
+    runId: string;
+    fingerprint: string;
+    testId: string;
+    project: string;
+    layer: Layer;
+    browser?: BrowserName;
+    runnerProject: string;
+    featureUri: string;
+    featureName: string;
+    scenarioName: string;
+    pickleLine?: number;
+    exampleIndex?: number | null;
+    tags: string[];
+    module?: string;
+    process?: string;
+    retry: number;
+    workerIndex: number;
+    parallelIndex: number;
+    status?: SuiteStatus;
+    startedAt: string;
+    finishedAt?: string;
+    durationMs?: number;
+    errorMessage?: string;
+    apiCalls?: number;
+    heals?: number;
+    dir: string;
+}
+export interface ScenarioResult {
+    id: string;
+    runId: string;
+    fingerprint: string;
+    naturalKey: string;
+    source: 'gherkin' | 'runner-json';
+    featureUri: string;
+    featureName: string;
+    scenarioName: string;
+    exampleIndex?: number | null;
+    runnerProject: string;
+    layer: Layer;
+    browser?: BrowserName;
+    suiteTag?: string;
+    tags: string[];
+    jiraKeys: string[];
+    status: SuiteStatus;
+    attemptsCount: number;
+    flaky: boolean;
+    durationMs?: number;
+    errorMessage?: string;
+    errorStack?: string;
+    startedAt?: string;
+    finishedAt?: string;
+}
+export interface StepResult {
+    id: string;
+    attemptId: string;
+    scenarioId: string;
+    runId: string;
+    stepIndex: number;
+    kind: 'step' | 'hook';
+    hookType?: 'before' | 'after';
+    keyword?: string;
+    text: string;
+    argument?: unknown;
+    status: SuiteStatus;
+    durationMs?: number;
+    errorMessage?: string;
+    errorStack?: string;
+    definitionLocation?: string;
+    layerHint?: 'ui' | 'api';
+    apiSnapshot?: ApiSnapshot;
+    perf?: PerformanceMetrics;
+    startedAt?: string;
+    finishedAt?: string;
+}
+export type ArtifactKind = 'screenshot' | 'trace' | 'video' | 'har' | 'log' | 'report' | 'visual' | 'diff' | 'attachment';
+export type ArtifactPhase = 'before' | 'after' | 'scenario-start' | 'scenario-end' | 'failure' | 'expected' | 'actual' | 'diff';
+export interface ScreenshotArtifact {
+    id: string;
+    runId: string;
+    scenarioId?: string;
+    attemptId?: string;
+    stepId?: string;
+    stepIndex?: number | null;
+    kind: ArtifactKind;
+    phase?: ArtifactPhase | null;
+    mediaType: string;
+    fileName: string;
+    relPath: string;
+    sizeBytes: number;
+    sha256?: string;
+    width?: number | null;
+    height?: number | null;
+    meta?: Record<string, unknown>;
+}
+export interface ApiSnapshot {
+    request: {
+        method: string;
+        url: string;
+        headers: Record<string, string>;
+        body?: unknown;
+        query?: Record<string, string>;
+    };
+    response: {
+        status: number;
+        statusText: string;
+        headers: Record<string, string>;
+        body: unknown;
+        rawBody?: string;
+        responseTime: number;
+    };
+    startedAt: string;
+    replayedFromHar?: boolean;
+}
+export interface HealCandidate {
+    strategy: string;
+    selector: string;
+    score: number;
+    count?: number;
+    visible?: boolean;
+    enabled?: boolean;
+    ms?: number;
+}
+export interface HealEvent {
+    fingerprint: string;
+    runId: string;
+    stepIndex: number;
+    action: 'click' | 'fill' | 'select' | 'assert' | 'hover' | 'check';
+    description: string;
+    pageUrl: string;
+    originalSelector: string;
+    context: Record<string, unknown>;
+    strategyUsed: string | null;
+    healedSelector: string | null;
+    candidates: HealCandidate[];
+    succeeded: boolean;
+    durationMs: number;
+    at: string;
+}
+export interface PerformanceMetrics {
+    url: string;
+    timestamp: string;
+    domContentLoaded: number;
+    pageLoadTime: number;
+    timeToFirstByte: number;
+    totalResources: number;
+    totalResourceSizeKB: number;
+    firstContentfulPaint: number | null;
+    largestContentfulPaint: number | null;
+}
+export interface StepDef {
+    keyword: 'Given' | 'When' | 'Then' | 'Unknown';
+    pattern: string;
+    file?: string;
+    line?: number;
+    source?: 'core' | 'project';
+}
+export interface LintFinding {
+    severity: 'error' | 'warning';
+    rule: string;
+    message: string;
+    file: string;
+    line?: number;
+    column?: number;
+    fix?: {
+        description: string;
+        insertTag?: string;
+    };
+}
+export interface LintResult {
+    errors: LintFinding[];
+    warnings: LintFinding[];
+    filesChecked: number;
+}
+export interface RunSummary {
+    runId: string;
+    status: RunStatus;
+    totals: RunTotals;
+    byProject: Record<string, RunTotals>;
+    failed: Array<{
+        fingerprint: string;
+        title: string;
+        runnerProject: string;
+        error?: string;
+    }>;
+    flaky: Array<{
+        fingerprint: string;
+        title: string;
+        runnerProject: string;
+    }>;
+    reportPaths: {
+        html?: string;
+        dashboard?: string;
+        messages?: string;
+        junit?: string;
+    };
+}
+export interface Evidence {
+    file: string;
+    line?: number;
+    snippet?: string;
+}
+export type FrameworkKind = 'frontend' | 'backend' | 'fullstack' | 'mobile';
+export interface DetectedFramework {
+    name: string;
+    kind: FrameworkKind;
+    version?: string;
+    confidence: number;
+    evidence: Evidence[];
+}
+export interface DetectedRoute {
+    path: string;
+    kind: 'page' | 'api';
+    method?: string;
+    source: string;
+    file: string;
+    line?: number;
+    params: string[];
+}
+export interface DetectedOpenApi {
+    file: string;
+    version?: string;
+    title?: string;
+    endpoints: Array<{
+        method: string;
+        path: string;
+        tag?: string;
+        operationId?: string;
+    }>;
+}
+export interface DetectedTests {
+    framework: 'playwright' | 'cypress' | 'cucumber' | 'jest' | 'vitest' | 'other';
+    files: number;
+    sampleFiles: string[];
+    locators: {
+        css: number;
+        xpath: number;
+        role: number;
+        testId: number;
+        text: number;
+    };
+}
+export interface ChecklistItem {
+    id: string;
+    severity: 'info' | 'warning' | 'error';
+    title: string;
+    detail: string;
+    fix?: string;
+}
+export interface AnalysisReport {
+    appPath: string;
+    analyzedAt: string;
+    filesScanned: number;
+    packageManager: {
+        name: 'npm' | 'pnpm' | 'yarn' | 'bun' | 'pip' | 'maven' | 'gradle' | 'unknown';
+        monorepo: boolean;
+        workspaces: string[];
+        evidence: Evidence[];
+    };
+    frameworks: DetectedFramework[];
+    routes: DetectedRoute[];
+    openapi: DetectedOpenApi[];
+    testIds: {
+        attribute: string | null;
+        counts: Record<string, number>;
+        confidence: number;
+    };
+    existingTests: DetectedTests[];
+    auth: {
+        pages: string[];
+        libraries: string[];
+        strategyGuess: 'none' | 'form' | 'token' | 'sso' | 'oauth-client-credentials';
+        confidence: number;
+        evidence: Evidence[];
+    };
+    envs: Array<{
+        name: string;
+        file: string;
+        uiBaseUrl?: string;
+        apiBaseUrl?: string;
+        vars: string[];
+    }>;
+    baseUrls: {
+        ui?: string;
+        api?: string;
+        evidence: Evidence[];
+    };
+    ci: {
+        provider: 'github' | 'gitlab' | 'circleci' | 'azure' | 'jenkins' | 'bitbucket' | 'none';
+        files: string[];
+    };
+    i18n: {
+        libraries: string[];
+        locales: string[];
+    };
+    a11y: {
+        tooling: string[];
+    };
+    checklist: ChecklistItem[];
+}
+export interface CoverageScenarioRef {
+    feature: string;
+    scenario: string;
+    suite?: string;
+    tags: string[];
+}
+export interface CoverageRow {
+    kind: 'route' | 'endpoint' | 'role';
+    name: string;
+    target: string;
+    module?: string;
+    covered: boolean;
+    scenarios: CoverageScenarioRef[];
+    bySuite: Record<string, number>;
+}
+export interface CoverageReport {
+    project: string;
+    generatedAt: string;
+    suites: string[];
+    routes: CoverageRow[];
+    endpoints: CoverageRow[];
+    roles: CoverageRow[];
+    summary: {
+        routes: {
+            covered: number;
+            total: number;
+        };
+        endpoints: {
+            covered: number;
+            total: number;
+        };
+        roles: {
+            covered: number;
+            total: number;
+        };
+        scenarios: number;
+        bySuite: Record<string, number>;
+        uncoveredModules: string[];
+    };
+}
+export interface ProjectProposal {
+    slug: string;
+    name: string;
+    projectYaml: string;
+    envYamls: Record<string, string>;
+    starterFeatures: Record<string, string>;
+    files: Record<string, string>;
+    coverageMap: Array<{
+        kind: 'route' | 'endpoint';
+        target: string;
+        module: string;
+        starterFeature?: string;
+    }>;
+    checklist: ChecklistItem[];
+    notes: string[];
+    /** How each module was decided: which signal won, and how confident it was. */
+    detectedModules?: Array<{
+        name: string;
+        confidence: number;
+        signals: string[];
+        routes: number;
+        endpoints: number;
+        evidence: Evidence[];
+    }>;
+    /** Routes deliberately not turned into modules, with the reason. */
+    ignoredTargets?: Array<{
+        target: string;
+        reason: string;
+    }>;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@sdods/contracts",
+  "version": "0.2.0",
+  "description": "Shared schemas, identifiers and DTO types for SDODS.",
+  "license": "Apache-2.0",
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.js",
+    "./ids": "./dist/ids.js",
+    "./names": "./dist/names.js",
+    "./scopes": "./dist/scopes.js",
+    "./schemas": "./dist/schemas/index.js",
+    "./types": "./dist/types.js"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=22"
+  },
+  "dependencies": {
+    "zod": "^4.5.4"
+  },
+  "author": "SDODS <admin@sdods.com>",
+  "homepage": "https://sdods.com",
+  "bugs": {
+    "url": "https://github.com/siri1410/SDODS/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/siri1410/SDODS.git",
+    "directory": "packages/contracts"
+  },
+  "keywords": [
+    "sdods",
+    "automation",
+    "orchestration",
+    "testing",
+    "bdd",
+    "ai-agents",
+    "mcp"
+  ]
+}