@nan0web/release 3.3.0 → 3.4.0

package/types/architecture/ProjectManagementAsCode.d.ts

@@ -1,42 +1,18 @@
-/**
- * # Project Management as Code Architecture
- *
- * This architecture implements project management through automated testing,
- * where each task is represented as a test case that validates system behavior.
- *
- * ## Core Concepts
- *
- * 1. **Tasks as Tests**: Each project task becomes a test suite that validates
- *    implementation correctness
- * 2. **Status Tracking**: Task status moves automatically through CI/CD pipeline
- *    when tests pass/fail
- * 3. **Release Validation**: Releases are validated by running task tests as
- *    part of the release process
- *
- * ## Implementation Details
- */
-/**
- * Base TestSuite class for task management
- */
-declare class TestSuite {
-    name: string;
-    fn: Function;
-    /**
-     * @param {string} name - Suite name
-     * @param {Function} fn - Test function
-     */
-    constructor(name: string, fn: Function);
-    /**
-     * Run the test suite
-     * @returns {Promise<Object>}
-     */
-    run(): Promise<any>;
-}
 /**
  * Task management through node:test infrastructure
  * @class ProjectManagement
  */
-export declare class ProjectManagement {
+export class ProjectManagement {
+    /**
+     * Initialize project management system
+     * @param {Object} [config] - Configuration options
+     * @param {string} [config.projectPath] - Path to project root
+     * @param {boolean} [config.autoTrack] - Enable automatic status tracking
+     */
+    constructor(config?: {
+        projectPath?: string | undefined;
+        autoTrack?: boolean | undefined;
+    });
     /** @type {string} */
     projectPath: string;
     /** @type {boolean} */
@@ -46,16 +22,6 @@ export declare class ProjectManagement {
      * @type {Map<string, string>}
      */
     tasks: Map<string, string>;
-    /**
-     * Initialize project management system
-     * @param {Object} [config] - Configuration options
-     * @param {string} [config.projectPath] - Path to project root
-     * @param {boolean} [config.autoTrack] - Enable automatic status tracking
-     */
-    constructor(config?: {
-        projectPath?: string;
-        autoTrack?: boolean;
-    });
     /**
      * Register a task with its validation test
      * @param {string} taskId - Unique task identifier
@@ -84,16 +50,16 @@ export declare class ProjectManagement {
  * Release management system that coordinates task validation
  * @class ReleaseManager
  */
-export declare class ReleaseManager {
-    /**
-     * @type {ProjectManagement}
-     */
-    projectManager: ProjectManagement;
+export class ReleaseManager {
     /**
      * Initialize release manager
      * @param {ProjectManagement} projectManager - Project management instance
      */
     constructor(projectManager: ProjectManagement);
+    /**
+     * @type {ProjectManagement}
+     */
+    projectManager: ProjectManagement;
     /**
      * Execute release process with task validation
      * @param {string} type - Release type (patch, minor, major)
@@ -119,7 +85,14 @@ export declare class ReleaseManager {
  * Task test suite definition following node:test format
  * @extends TestSuite
  */
-export declare class TaskTestSuite extends TestSuite {
+export class TaskTestSuite extends TestSuite {
+    /**
+     * Initialize task test suite
+     * @param {string} taskId - Unique task identifier
+     * @param {string} description - Human-readable task description
+     * @param {Function} testFunction - Test implementation function
+     */
+    constructor(taskId: string, description: string, testFunction: Function);
     /**
      * Task ID this test suite validates
      * @type {string}
@@ -130,24 +103,12 @@ export declare class TaskTestSuite extends TestSuite {
      * @type {string}
      */
     description: string;
-    /**
-     * Initialize task test suite
-     * @param {string} taskId - Unique task identifier
-     * @param {string} description - Human-readable task description
-     * @param {Function} testFunction - Test implementation function
-     */
-    constructor(taskId: string, description: string, testFunction: Function);
-    /**
-     * Execute task validation test
-     * @returns {Promise<Object>} Test execution result
-     */
-    run(): Promise<any>;
 }
 /**
  * Changelog-based task management for LLM-assisted development
  * @class ChangelogTaskManager
  */
-export declare class ChangelogTaskManager {
+export class ChangelogTaskManager {
     /**
      * Parse changelog to extract tasks and their statuses
      * @param {string} changelogContent - Raw changelog markdown
@@ -161,4 +122,38 @@ export declare class ChangelogTaskManager {
      */
     generateTaskTests(tasks: Array<any>): Promise<void>;
 }
+/**
+ * # Project Management as Code Architecture
+ *
+ * This architecture implements project management through automated testing,
+ * where each task is represented as a test case that validates system behavior.
+ *
+ * ## Core Concepts
+ *
+ * 1. **Tasks as Tests**: Each project task becomes a test suite that validates
+ *    implementation correctness
+ * 2. **Status Tracking**: Task status moves automatically through CI/CD pipeline
+ *    when tests pass/fail
+ * 3. **Release Validation**: Releases are validated by running task tests as
+ *    part of the release process
+ *
+ * ## Implementation Details
+ */
+/**
+ * Base TestSuite class for task management
+ */
+declare class TestSuite {
+    /**
+     * @param {string} name - Suite name
+     * @param {Function} fn - Test function
+     */
+    constructor(name: string, fn: Function);
+    name: string;
+    fn: Function;
+    /**
+     * Run the test suite
+     * @returns {Promise<Object>}
+     */
+    run(): Promise<any>;
+}
 export {};

package/types/domain/App.d.ts

@@ -1,16 +1,33 @@
-import { ModelAsApp } from "@nan0web/ui";
-import CheckCommand from './CheckCommand.js';
-import StatusCommand from './StatusCommand.js';
-export declare class ReleaseApp extends ModelAsApp {
+export class ReleaseApp extends ModelAsApp {
+    static alias: string;
+    static UI: {
+        title: string;
+    };
     static command: {
         help: string;
-        options: (typeof CheckCommand | typeof StatusCommand)[];
+        options: (typeof CheckCommand | typeof CloseCommand | typeof DepsCommand | typeof PublishCommand | typeof StatusCommand | typeof WebCommand | typeof ListCommand | typeof ServeCommand)[];
         positional: boolean;
-        default: null;
+        default: typeof ViewCommand;
     };
     /**
      * @param {Partial<ReleaseApp>} [data]
      * @param {Partial<import('@nan0web/ui').ModelAsAppOptions>} [options]
      */
-    constructor(data?: Partial<ReleaseApp>, options?: Partial<import('@nan0web/ui').ModelAsAppOptions>);
+    constructor(data?: Partial<ReleaseApp>, options?: Partial<import("@nan0web/ui").ModelAsAppOptions>);
+    /**
+     * Run the main controller logic.
+     * @returns {AsyncGenerator<import('@nan0web/ui').Intent, any, any>}
+     */
+    run(): AsyncGenerator<import("@nan0web/ui").Intent, any, any>;
 }
+export default ReleaseApp;
+import { ModelAsApp } from "@nan0web/ui";
+import CheckCommand from './CheckCommand.js';
+import CloseCommand from './CloseCommand.js';
+import DepsCommand from './DepsCommand.js';
+import PublishCommand from './PublishCommand.js';
+import StatusCommand from './StatusCommand.js';
+import WebCommand from './WebCommand.js';
+import ListCommand from './ListCommand.js';
+import ServeCommand from './ServeCommand.js';
+import ViewCommand from './ViewCommand.js';

package/types/domain/BumpCommand.d.ts

@@ -1,6 +1,8 @@
-import { ModelAsApp } from '@nan0web/ui';
 /**
  * Command to bump the version of changed packages in the monorepo.
+ * @property {string} version Target version to set
+ * @property {string} since Git reference to diff against
+ * @property {boolean} dryRun Run the command without making any changes
  */
 export default class BumpCommand extends ModelAsApp {
     static version: {
@@ -32,9 +34,12 @@ export default class BumpCommand extends ModelAsApp {
      * @param {Partial<BumpCommand>} [data]
      * @param {Partial<import('@nan0web/ui').ModelAsAppOptions>} [options]
      */
-    constructor(data?: Partial<BumpCommand>, options?: Partial<import('@nan0web/ui').ModelAsAppOptions>);
-    /**
-     * @returns {AsyncGenerator<import('@nan0web/ui').Intent, import('@nan0web/ui').ResultIntent, any>}
-     */
-    run(): AsyncGenerator<import('@nan0web/ui').Intent, import('@nan0web/ui').ResultIntent, any>;
+    constructor(data?: Partial<BumpCommand>, options?: Partial<import("@nan0web/ui").ModelAsAppOptions>);
+    /** @type {string} Target version */
+    version: string;
+    /** @type {string} Git reference to diff against */
+    since: string;
+    /** @type {boolean} Run without making changes */
+    dryRun: boolean;
 }
+import { ModelAsApp } from '@nan0web/ui';

package/types/domain/CheckCommand.d.ts

@@ -1,24 +1,136 @@
-import { ModelAsApp } from '@nan0web/ui';
-export default class CheckCommand extends ModelAsApp {
+/**
+ * @typedef {Object} DiagnosticItem
+ * @property {'error' | 'warning' | 'info'} level
+ * @property {string} code
+ * @property {string} project
+ * @property {string} message
+ * @property {string} file
+ * @property {string} fix
+ */
+/**
+ * CheckCommand - PM-as-Code Release Structure & Compliance Validator.
+ */
+export class CheckCommand extends ModelAsApp {
+    static alias: string;
     static UI: {
+        errorDbRequired: string;
         title: string;
-        icon: string;
-        description: string;
+        header: string;
+        scanningCount: string;
+        projectHeader: string;
+        missingPackageJson: string;
+        packageJsonValid: string;
+        noReleasesDir: string;
+        releasesDirFound: string;
+        releaseHeader: string;
+        releaseDocCompleted: string;
+        missingReleaseDoc: string;
+        missingUserDoc: string;
+        incompleteUserMetrics: string;
+        userMetricsValid: string;
+        ambiguousContracts: string;
+        missingContract: string;
+        activeContractWip: string;
+        sealedRegressionClosed: string;
+        orphanFile: string;
+        recommendationsHeader: string;
+        recommendationItem: string;
+        summary: string;
+        Diagnostics: {
+            MISSING_PACKAGE_JSON: {
+                level: string;
+                code: string;
+                message: string;
+                fix: string;
+            };
+            MISSING_RELEASES_DIR: {
+                level: string;
+                code: string;
+                message: string;
+                fix: string;
+            };
+            MISSING_RELEASE_MD: {
+                level: string;
+                code: string;
+                message: string;
+                fix: string;
+            };
+            MISSING_USER_MD: {
+                level: string;
+                code: string;
+                message: string;
+                fix: string;
+            };
+            INCOMPLETE_USER_METRICS: {
+                level: string;
+                code: string;
+                message: string;
+                fix: string;
+            };
+            AMBIGUOUS_CONTRACTS: {
+                level: string;
+                code: string;
+                message: string;
+                fix: string;
+            };
+            MISSING_CONTRACT: {
+                level: string;
+                code: string;
+                message: string;
+                fix: string;
+            };
+            ORPHAN_RELEASE_FILE: {
+                level: string;
+                code: string;
+                message: string;
+                fix: string;
+            };
+        };
+    };
+    static target: {
+        help: string;
+        default: string;
+        type: string;
+        positional: boolean;
+    };
+    static registryFile: {
+        help: string;
+        default: string;
+        type: string;
+        alias: string;
+    };
+    static all: {
+        help: string;
+        default: boolean;
+        type: string;
+        alias: string;
     };
-    static name: string;
-    /**
-     * @returns {AsyncGenerator<any, any, any>}
-     */
-    run(): AsyncGenerator<any, any, any>;
     /**
-     * @param {string} absDir
-     * @returns {Promise<string[]>}
+     * @param {Partial<CheckCommand>} [data]
+     * @param {Partial<import('@nan0web/ui').ModelAsAppOptions>} [options]
      */
-    _scanLocal(absDir: string): Promise<string[]>;
+    constructor(data?: Partial<CheckCommand>, options?: Partial<import("@nan0web/ui").ModelAsAppOptions>);
+    /** @type {string} */ target: string;
+    /** @type {string} */ registryFile: string;
+    /** @type {boolean} */ all: boolean;
     /**
-     * @param {string} base
-     * @param {string} [dir]
-     * @returns {Promise<string[]>}
+     * Execute release structure check
+     * @returns {AsyncGenerator<import('@nan0web/ui').Intent, { success: boolean, diagnostics: DiagnosticItem[], checkedProjects: any[] }, any>}
      */
-    _scanDirRecursive(base: string, dir?: string): Promise<string[]>;
+    run(): AsyncGenerator<import("@nan0web/ui").Intent, {
+        success: boolean;
+        diagnostics: DiagnosticItem[];
+        checkedProjects: any[];
+    }, any>;
+    #private;
 }
+export default CheckCommand;
+export type DiagnosticItem = {
+    level: "error" | "warning" | "info";
+    code: string;
+    project: string;
+    message: string;
+    file: string;
+    fix: string;
+};
+import { ModelAsApp } from '@nan0web/ui';

package/types/domain/CheckCommand.story.d.ts

@@ -0,0 +1 @@
+export {};

package/types/domain/CloseCommand.d.ts

@@ -1,4 +1,3 @@
-import { ModelAsApp } from '@nan0web/ui';
 export default class CloseCommand extends ModelAsApp {
     static version: {
         help: string;
@@ -12,9 +11,8 @@ export default class CloseCommand extends ModelAsApp {
      * @param {Partial<CloseCommand>} [data]
      * @param {Partial<import('@nan0web/ui').ModelAsAppOptions>} [options]
      */
-    constructor(data?: Partial<CloseCommand>, options?: Partial<import('@nan0web/ui').ModelAsAppOptions>);
-    /**
-     * @returns {AsyncGenerator<import('@nan0web/ui').Intent, import('@nan0web/ui').ResultIntent, any>}
-     */
-    run(): AsyncGenerator<import('@nan0web/ui').Intent, import('@nan0web/ui').ResultIntent, any>;
+    constructor(data?: Partial<CloseCommand>, options?: Partial<import("@nan0web/ui").ModelAsAppOptions>);
+    /** @type {string} Release version */
+    version: string;
 }
+import { ModelAsApp } from '@nan0web/ui';

package/types/domain/Dashboard/Dashboard.story.d.ts

@@ -0,0 +1 @@
+export {};

package/types/domain/Dashboard/DashboardModel.d.ts

@@ -0,0 +1,273 @@
+/**
+ * @typedef {import('./ReleaseParser.js').TaskItem} TaskItem
+ * @typedef {Object} ProjectDashboardEntry
+ * @property {string} path - Relative project path
+ * @property {string} name - Project name
+ * @property {string} version - Current release version
+ * @property {number} hours - Development hours spent
+ * @property {number} iterations - Test runs / refactor iterations
+ * @property {number} rrs - Release Readiness Score
+ * @property {'wip' | 'closed' | 'unknown'} status - Release state
+ * @property {TaskItem[]} tasks - Parsed tasks from release.md
+ * @property {string} branch - Git branch name
+ * @property {'clean' | 'dirty'} gitStatus - Git workspace status
+ * @property {string} userContent - Raw user.md content
+ * @property {string} releaseContent - Raw release.md content
+ * @property {string} sourceDoc - Relative path to the parsed release document
+ * @property {string} sourceUserDoc - Relative path to user.md
+ * @property {string?} deadline - Project release deadline
+ * @property {number?} daysRemaining - Days remaining until deadline
+ * @property {string?} priority - Priority (0 | 1 | 2 | 3)
+ * @property {number} [releasesCount] - Number of releases found
+ * @property {number} [totalHours] - Total hours across all releases
+ * @property {number} [totalIterations] - Total iterations across all releases
+ * @property {Array<any>} [allReleases] - List of all releases for project
+ *
+ * @typedef {Object} DashboardSummary
+ * @property {number} totalProjects - Total tracked projects
+ * @property {number} totalHours - Sum of hours across projects
+ * @property {number} totalIterations - Sum of iterations
+ * @property {number} wipCount - Active WIP releases
+ * @property {number} closedCount - Closed releases
+ * @property {number} [totalReleases] - Total releases counted
+ */
+/**
+ * DashboardModel - Aggregates release telemetry, tasks and readiness across projects.
+ */
+export class DashboardModel extends ModelAsApp {
+    static registryFile: {
+        help: string;
+        default: string;
+        type: string;
+    };
+    static summary: {
+        help: string;
+        default: {
+            totalProjects: number;
+            totalHours: number;
+            totalIterations: number;
+            wipCount: number;
+            closedCount: number;
+        };
+        type: string;
+    };
+    static projects: {
+        help: string;
+        default: () => never[];
+        type: string;
+    };
+    static UI: {
+        aggregating: string;
+        done: string;
+    };
+    static parseUserMetrics: typeof parseUserMetrics;
+    static normalizePriority: typeof normalizePriority;
+    static sortTasks: typeof sortTasks;
+    static versionToPath: typeof versionToPath;
+    /**
+     * @param {Partial<DashboardModel>} [data={}]
+     * @param {Partial<import('@nan0web/ui').ModelAsAppOptions & { gitTelemetry?: any }>} [options={}]
+     */
+    constructor(data?: Partial<DashboardModel>, options?: Partial<import("@nan0web/ui").ModelAsAppOptions & {
+        gitTelemetry?: any;
+    }>);
+    /** @type {string} Path to releases.txt registry file */ registryFile: string;
+    /** @type {DashboardSummary} Aggregated metrics summary */ summary: DashboardSummary;
+    /** @type {ProjectDashboardEntry[]} List of projects with metrics */ projects: ProjectDashboardEntry[];
+    /** @type {any} Optional git telemetry adapter */
+    _gitTelemetry: any;
+    /**
+     * Canonical OLMUI Generator: Yields progress, show, and returns result.
+     * @returns {AsyncGenerator<import('@nan0web/ui').Intent, any, any>}
+     */
+    run(): AsyncGenerator<import("@nan0web/ui").Intent, any, any>;
+    /**
+     * Programmatic aggregation helper
+     * @param {Function} [onProgress]
+     * @returns {Promise<{ summary: DashboardSummary, projects: ProjectDashboardEntry[] }>}
+     */
+    aggregate(onProgress?: Function): Promise<{
+        summary: DashboardSummary;
+        projects: ProjectDashboardEntry[];
+    }>;
+    aggregateStream(): AsyncGenerator<{
+        current: number;
+        total: number;
+        project: string;
+    }, {
+        summary: DashboardSummary;
+        projects: ({
+            name: any;
+            version: any;
+            path: any;
+            status: string;
+            hours: number;
+            iterations: number;
+            rrs: number;
+            branch: any;
+            gitStatus: any;
+            tasks: never[];
+            deadline: null;
+            daysRemaining: null;
+            priority: string;
+            releasesCount: number;
+            totalHours: number;
+            totalIterations: number;
+            allReleases: never[];
+            sourceDoc: string;
+            sourceUserDoc: string;
+            userContent: string;
+            releaseContent: string;
+        } | {
+            path: string;
+            name: string;
+            version: string;
+            hours: number;
+            iterations: number;
+            totalHours: number;
+            totalIterations: number;
+            releasesCount: number;
+            allReleases: {
+                version: any;
+                path: any;
+                hours: number;
+                iterations: number;
+                rrs: number;
+                status: "wip" | "closed" | "unknown";
+                tasks: import("./ReleaseParser.js").TaskItem[];
+                sourceDoc: string;
+            }[];
+            rrs: number;
+            status: "wip" | "closed" | "unknown";
+            tasks: import("./ReleaseParser.js").TaskItem[];
+            branch: any;
+            gitStatus: any;
+            userContent: string;
+            releaseContent: string;
+            sourceDoc: string;
+            sourceUserDoc: string;
+            deadline: any;
+            daysRemaining: number | null;
+            priority: "0" | "1" | "2" | "3";
+        })[];
+    }, unknown>;
+    #private;
+}
+export type TaskItem = import("./ReleaseParser.js").TaskItem;
+export type ProjectDashboardEntry = {
+    /**
+     * - Relative project path
+     */
+    path: string;
+    /**
+     * - Project name
+     */
+    name: string;
+    /**
+     * - Current release version
+     */
+    version: string;
+    /**
+     * - Development hours spent
+     */
+    hours: number;
+    /**
+     * - Test runs / refactor iterations
+     */
+    iterations: number;
+    /**
+     * - Release Readiness Score
+     */
+    rrs: number;
+    /**
+     * - Release state
+     */
+    status: "wip" | "closed" | "unknown";
+    /**
+     * - Parsed tasks from release.md
+     */
+    tasks: TaskItem[];
+    /**
+     * - Git branch name
+     */
+    branch: string;
+    /**
+     * - Git workspace status
+     */
+    gitStatus: "clean" | "dirty";
+    /**
+     * - Raw user.md content
+     */
+    userContent: string;
+    /**
+     * - Raw release.md content
+     */
+    releaseContent: string;
+    /**
+     * - Relative path to the parsed release document
+     */
+    sourceDoc: string;
+    /**
+     * - Relative path to user.md
+     */
+    sourceUserDoc: string;
+    /**
+     * - Project release deadline
+     */
+    deadline: string | null;
+    /**
+     * - Days remaining until deadline
+     */
+    daysRemaining: number | null;
+    /**
+     * - Priority (0 | 1 | 2 | 3)
+     */
+    priority: string | null;
+    /**
+     * - Number of releases found
+     */
+    releasesCount?: number | undefined;
+    /**
+     * - Total hours across all releases
+     */
+    totalHours?: number | undefined;
+    /**
+     * - Total iterations across all releases
+     */
+    totalIterations?: number | undefined;
+    /**
+     * - List of all releases for project
+     */
+    allReleases?: any[] | undefined;
+};
+export type DashboardSummary = {
+    /**
+     * - Total tracked projects
+     */
+    totalProjects: number;
+    /**
+     * - Sum of hours across projects
+     */
+    totalHours: number;
+    /**
+     * - Sum of iterations
+     */
+    totalIterations: number;
+    /**
+     * - Active WIP releases
+     */
+    wipCount: number;
+    /**
+     * - Closed releases
+     */
+    closedCount: number;
+    /**
+     * - Total releases counted
+     */
+    totalReleases?: number | undefined;
+};
+import { ModelAsApp } from '@nan0web/ui';
+import { parseUserMetrics } from './ReleaseParser.js';
+import { normalizePriority } from './ReleaseParser.js';
+import { sortTasks } from './ReleaseParser.js';
+import { versionToPath } from './ReleaseDiscovery.js';