@bryan-thompson/inspector-assessment-client 1.31.0 → 1.32.0

package/lib/services/assessment/registry/types.d.ts

@@ -0,0 +1,180 @@
+/**
+ * Registry Types for AssessorRegistry
+ *
+ * Defines interfaces and enums for the registry pattern implementation.
+ * These types enable declarative assessor definitions and phase-based execution.
+ *
+ * @module assessment/registry/types
+ * @see GitHub Issue #91
+ */
+import type { AssessmentConfiguration } from "../../../lib/assessment/configTypes.js";
+import type { MCPDirectoryAssessment } from "../../../lib/assessment/resultTypes.js";
+import type { BaseAssessor } from "../modules/BaseAssessor.js";
+import type { AssessmentContext } from "../AssessmentOrchestrator.js";
+import type { Logger } from "../lib/logger.js";
+import type { ClaudeCodeBridge } from "../lib/claudeCodeBridge.js";
+/**
+ * Execution phases - determines order of assessment execution.
+ * Phase 0 ALWAYS runs first and sequentially to capture clean baselines.
+ */
+export declare enum AssessmentPhase {
+    /** Temporal assessment - must run first for baseline capture before other tools trigger */
+    PRE = 0,
+    /** Core assessments: Functionality, Security, Documentation, ErrorHandling, Usability */
+    CORE = 1,
+    /** Protocol compliance assessment */
+    PROTOCOL = 2,
+    /** MCP Directory compliance: AUP, Annotations, Libraries, Manifest, Portability, APIs, Auth */
+    COMPLIANCE = 3,
+    /** Capability assessments: Resources, Prompts, CrossCapability */
+    CAPABILITY = 4,
+    /** Code quality: FileModularization, Conformance */
+    QUALITY = 5
+}
+/**
+ * Config flags that control whether an assessor is enabled.
+ * Supports OR logic for backward-compatible deprecated flags.
+ */
+export interface AssessorConfigFlags {
+    /**
+     * Primary flag in assessmentCategories.
+     * This is the canonical flag name to use.
+     */
+    primary: keyof NonNullable<AssessmentConfiguration["assessmentCategories"]>;
+    /**
+     * Deprecated flags that also enable this assessor (OR logic for BC).
+     * If ANY of these flags is true, the assessor is enabled.
+     * Used for backward compatibility during deprecation periods.
+     */
+    deprecated?: Array<keyof NonNullable<AssessmentConfiguration["assessmentCategories"]>>;
+    /**
+     * Default enablement behavior:
+     * - true (default): Enabled unless explicitly set to false (`!== false`)
+     * - false: Disabled unless explicitly set to true (`=== true`)
+     *
+     * Core assessors (functionality, security, etc.) use defaultEnabled: true
+     * Extended assessors use defaultEnabled: false (opt-in)
+     */
+    defaultEnabled?: boolean;
+}
+/**
+ * Assessor class constructor type.
+ * All assessors must accept AssessmentConfiguration in constructor.
+ */
+export type AssessorConstructor<T extends BaseAssessor = BaseAssessor> = new (config: AssessmentConfiguration) => T;
+/**
+ * Custom setup function for assessors that need additional initialization.
+ * Called after construction but before Claude bridge wiring.
+ *
+ * Examples:
+ * - ToolAnnotationAssessor needs pattern config loaded and compiled
+ * - SecurityAssessor may need custom payload configuration
+ */
+export type AssessorSetupFn<T extends BaseAssessor = BaseAssessor> = (assessor: T, config: AssessmentConfiguration, logger: Logger) => void;
+/**
+ * Test count estimator function.
+ * Returns the estimated number of tests this assessor will run.
+ * Used for progress event emission (emitModuleStartedEvent).
+ */
+export type TestEstimatorFn = (context: AssessmentContext, config: AssessmentConfiguration) => number;
+/**
+ * Metadata for each assessor definition.
+ * Enables declarative configuration instead of imperative code.
+ * Single source of truth for all assessor registration.
+ */
+export interface AssessorDefinition<T extends BaseAssessor = BaseAssessor> {
+    /**
+     * Unique identifier matching the assessor purpose.
+     * Used for registry lookup and property getter names.
+     * Convention: camelCase matching the assessmentCategories key.
+     * Examples: 'security', 'functionality', 'protocolCompliance'
+     */
+    id: string;
+    /**
+     * Human-readable display name for progress events and logging.
+     * Used in emitModuleStartedEvent and emitModuleProgress.
+     * Examples: 'Security', 'Protocol Compliance', 'AUP Compliance'
+     */
+    displayName: string;
+    /**
+     * Assessor class constructor.
+     * All assessors extend BaseAssessor<T>.
+     */
+    assessorClass: AssessorConstructor<T>;
+    /**
+     * Field name in MCPDirectoryAssessment for storing the result.
+     * Must match an optional field on MCPDirectoryAssessment.
+     */
+    resultField: keyof MCPDirectoryAssessment;
+    /**
+     * Execution phase (controls ordering).
+     * Phase 0 (PRE) always runs first and sequentially.
+     */
+    phase: AssessmentPhase;
+    /**
+     * Config flags that enable this assessor.
+     * Supports primary flag and deprecated alternatives for BC.
+     */
+    configFlags: AssessorConfigFlags;
+    /**
+     * Whether this assessor requires enableExtendedAssessment = true.
+     * Core assessors (Phase 1) set this to false.
+     * Extended assessors (Phases 2-5) set this to true.
+     */
+    requiresExtended: boolean;
+    /**
+     * Whether this assessor supports Claude bridge integration.
+     * If true, setClaudeBridge() will be called when bridge is enabled.
+     * Currently: SecurityAssessor, AUPComplianceAssessor, ToolAnnotationAssessor
+     */
+    supportsClaudeBridge: boolean;
+    /**
+     * Estimate test count from context (for progress events).
+     * Called before execution to populate emitModuleStartedEvent.
+     */
+    estimateTests: TestEstimatorFn;
+    /**
+     * Optional: Custom setup function for special initialization.
+     * Called after construction but before Claude bridge wiring.
+     * Examples: Load pattern config for ToolAnnotationAssessor
+     */
+    customSetup?: AssessorSetupFn<T>;
+}
+/**
+ * Registered assessor instance with metadata.
+ * Created by AssessorRegistry.registerAll() for enabled assessors.
+ */
+export interface RegisteredAssessor<T extends BaseAssessor = BaseAssessor> {
+    /** The original definition */
+    definition: AssessorDefinition<T>;
+    /** Instantiated assessor */
+    instance: T;
+    /** Whether this assessor is enabled based on config */
+    enabled: boolean;
+}
+/**
+ * Result of a single assessor execution.
+ * Used internally by AssessorRegistry.executePhase().
+ */
+export interface AssessorExecutionResult {
+    /** Assessor ID for result mapping */
+    id: string;
+    /** Result field name in MCPDirectoryAssessment */
+    resultField: keyof MCPDirectoryAssessment;
+    /** The assessment result (type varies by assessor) */
+    result: unknown;
+    /** Execution time in milliseconds */
+    executionTime: number;
+}
+/**
+ * Type guard for assessors that support Claude bridge.
+ * Used to safely call setClaudeBridge() method.
+ */
+export interface ClaudeBridgeCapable {
+    setClaudeBridge(bridge: ClaudeCodeBridge): void;
+}
+/**
+ * Check if an assessor supports Claude bridge integration.
+ */
+export declare function supportsClaudeBridge(assessor: BaseAssessor): assessor is BaseAssessor & ClaudeBridgeCapable;
+//# sourceMappingURL=types.d.ts.map

package/lib/services/assessment/registry/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/services/assessment/registry/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAC5E,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,8BAA8B,CAAC;AAC3E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AACnE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAEhE;;;GAGG;AACH,oBAAY,eAAe;IACzB,2FAA2F;IAC3F,GAAG,IAAI;IACP,yFAAyF;IACzF,IAAI,IAAI;IACR,qCAAqC;IACrC,QAAQ,IAAI;IACZ,+FAA+F;IAC/F,UAAU,IAAI;IACd,kEAAkE;IAClE,UAAU,IAAI;IACd,oDAAoD;IACpD,OAAO,IAAI;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,OAAO,EAAE,MAAM,WAAW,CAAC,uBAAuB,CAAC,sBAAsB,CAAC,CAAC,CAAC;IAE5E;;;;OAIG;IACH,UAAU,CAAC,EAAE,KAAK,CAChB,MAAM,WAAW,CAAC,uBAAuB,CAAC,sBAAsB,CAAC,CAAC,CACnE,CAAC;IAEF;;;;;;;OAOG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,YAAY,GAAG,YAAY,IAAI,KACvE,MAAM,EAAE,uBAAuB,KAC5B,CAAC,CAAC;AAEP;;;;;;;GAOG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,YAAY,GAAG,YAAY,IAAI,CACnE,QAAQ,EAAE,CAAC,EACX,MAAM,EAAE,uBAAuB,EAC/B,MAAM,EAAE,MAAM,KACX,IAAI,CAAC;AAEV;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,CAC5B,OAAO,EAAE,iBAAiB,EAC1B,MAAM,EAAE,uBAAuB,KAC5B,MAAM,CAAC;AAEZ;;;;GAIG;AACH,MAAM,WAAW,kBAAkB,CAAC,CAAC,SAAS,YAAY,GAAG,YAAY;IACvE;;;;;OAKG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,aAAa,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAAC;IAEtC;;;OAGG;IACH,WAAW,EAAE,MAAM,sBAAsB,CAAC;IAE1C;;;OAGG;IACH,KAAK,EAAE,eAAe,CAAC;IAEvB;;;OAGG;IACH,WAAW,EAAE,mBAAmB,CAAC;IAEjC;;;;OAIG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;;;OAIG;IACH,oBAAoB,EAAE,OAAO,CAAC;IAE9B;;;OAGG;IACH,aAAa,EAAE,eAAe,CAAC;IAE/B;;;;OAIG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC;CAClC;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB,CAAC,CAAC,SAAS,YAAY,GAAG,YAAY;IACvE,8BAA8B;IAC9B,UAAU,EAAE,kBAAkB,CAAC,CAAC,CAAC,CAAC;IAElC,4BAA4B;IAC5B,QAAQ,EAAE,CAAC,CAAC;IAEZ,uDAAuD;IACvD,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,qCAAqC;IACrC,EAAE,EAAE,MAAM,CAAC;IAEX,kDAAkD;IAClD,WAAW,EAAE,MAAM,sBAAsB,CAAC;IAE1C,sDAAsD;IACtD,MAAM,EAAE,OAAO,CAAC;IAEhB,qCAAqC;IACrC,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,eAAe,CAAC,MAAM,EAAE,gBAAgB,GAAG,IAAI,CAAC;CACjD;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAClC,QAAQ,EAAE,YAAY,GACrB,QAAQ,IAAI,YAAY,GAAG,mBAAmB,CAKhD"}

package/lib/services/assessment/registry/types.js

@@ -0,0 +1,35 @@
+/**
+ * Registry Types for AssessorRegistry
+ *
+ * Defines interfaces and enums for the registry pattern implementation.
+ * These types enable declarative assessor definitions and phase-based execution.
+ *
+ * @module assessment/registry/types
+ * @see GitHub Issue #91
+ */
+/**
+ * Execution phases - determines order of assessment execution.
+ * Phase 0 ALWAYS runs first and sequentially to capture clean baselines.
+ */
+export var AssessmentPhase;
+(function (AssessmentPhase) {
+    /** Temporal assessment - must run first for baseline capture before other tools trigger */
+    AssessmentPhase[AssessmentPhase["PRE"] = 0] = "PRE";
+    /** Core assessments: Functionality, Security, Documentation, ErrorHandling, Usability */
+    AssessmentPhase[AssessmentPhase["CORE"] = 1] = "CORE";
+    /** Protocol compliance assessment */
+    AssessmentPhase[AssessmentPhase["PROTOCOL"] = 2] = "PROTOCOL";
+    /** MCP Directory compliance: AUP, Annotations, Libraries, Manifest, Portability, APIs, Auth */
+    AssessmentPhase[AssessmentPhase["COMPLIANCE"] = 3] = "COMPLIANCE";
+    /** Capability assessments: Resources, Prompts, CrossCapability */
+    AssessmentPhase[AssessmentPhase["CAPABILITY"] = 4] = "CAPABILITY";
+    /** Code quality: FileModularization, Conformance */
+    AssessmentPhase[AssessmentPhase["QUALITY"] = 5] = "QUALITY";
+})(AssessmentPhase || (AssessmentPhase = {}));
+/**
+ * Check if an assessor supports Claude bridge integration.
+ */
+export function supportsClaudeBridge(assessor) {
+    return (typeof assessor.setClaudeBridge ===
+        "function");
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bryan-thompson/inspector-assessment-client",
-  "version": "1.31.0",
+  "version": "1.32.0",
   "description": "Client-side application for the Enhanced MCP Inspector with assessment capabilities",
   "license": "MIT",
   "author": "Bryan Thompson <bryan@triepod.ai>",