mcp-adr-analysis-server 2.1.11 → 2.1.19

package/dist/src/utils/validated-pattern-definitions.d.ts

@@ -0,0 +1,219 @@
+/**
+ * Validated Pattern Definitions
+ *
+ * This module defines validated deployment patterns for different platforms
+ * based on industry best practices from OpenShift, Kubernetes, Docker, Node.js,
+ * Python, MCP, and A2A ecosystems.
+ *
+ * Each pattern follows a consistent structure inspired by OpenShift Validated Patterns:
+ * - Pattern identification and versioning
+ * - Bill of materials (dependencies, tools, configurations)
+ * - Deployment steps with validation
+ * - Environment-specific overrides
+ * - Testing and validation strategies
+ */
+/**
+ * Base pattern interface that all patterns must implement
+ */
+export interface ValidatedPattern {
+    id: string;
+    name: string;
+    version: string;
+    platformType: PlatformType;
+    description: string;
+    billOfMaterials: {
+        dependencies: Dependency[];
+        configurations: Configuration[];
+        secrets: SecretRequirement[];
+        infrastructure: InfrastructureRequirement[];
+    };
+    deploymentPhases: DeploymentPhase[];
+    validationChecks: ValidationCheck[];
+    healthChecks: HealthCheck[];
+    environmentOverrides: EnvironmentOverride[];
+    metadata: {
+        source: string;
+        lastUpdated: string;
+        maintainer: string;
+        tags: string[];
+        references: string[];
+    };
+    baseCodeRepository: {
+        url: string;
+        purpose: string;
+        integrationInstructions: string;
+        requiredFiles: string[];
+        scriptEntrypoint?: string;
+    };
+    authoritativeSources: PatternSource[];
+}
+/**
+ * Authoritative source for pattern information
+ * LLMs should query these sources to get the latest pattern details
+ */
+export interface PatternSource {
+    type: 'documentation' | 'repository' | 'specification' | 'examples' | 'community';
+    url: string;
+    purpose: string;
+    priority: number;
+    queryInstructions: string;
+    requiredForDeployment: boolean;
+}
+/**
+ * Supported platform types
+ */
+export type PlatformType = 'openshift' | 'kubernetes' | 'docker' | 'nodejs' | 'python' | 'mcp' | 'a2a' | 'hybrid';
+/**
+ * Dependency in the bill of materials
+ */
+export interface Dependency {
+    name: string;
+    type: 'runtime' | 'buildtime' | 'development';
+    version?: string;
+    required: boolean;
+    installCommand?: string;
+    verificationCommand?: string;
+    alternativeOptions?: string[];
+}
+/**
+ * Configuration file requirement
+ */
+export interface Configuration {
+    path: string;
+    purpose: string;
+    template?: string;
+    required: boolean;
+    canAutoGenerate: boolean;
+    validationSchema?: any;
+}
+/**
+ * Secret or credential requirement
+ */
+export interface SecretRequirement {
+    name: string;
+    purpose: string;
+    environmentVariable?: string;
+    vaultPath?: string;
+    required: boolean;
+    defaultForDev?: string;
+}
+/**
+ * Infrastructure requirement
+ */
+export interface InfrastructureRequirement {
+    component: string;
+    purpose: string;
+    minimumVersion?: string;
+    alternatives?: string[];
+    required: boolean;
+    setupCommands?: string[];
+    healthCheckCommand?: string;
+}
+/**
+ * Deployment phase in the lifecycle
+ */
+export interface DeploymentPhase {
+    order: number;
+    name: string;
+    description: string;
+    commands: Command[];
+    rollbackCommands?: Command[];
+    prerequisites: string[];
+    estimatedDuration: string;
+    canParallelize: boolean;
+}
+/**
+ * Command to execute
+ */
+export interface Command {
+    description: string;
+    command: string;
+    workingDirectory?: string;
+    environmentVariables?: Record<string, string>;
+    expectedExitCode: number;
+    retryPolicy?: {
+        maxAttempts: number;
+        backoffMs: number;
+    };
+    timeout?: number;
+}
+/**
+ * Validation check
+ */
+export interface ValidationCheck {
+    id: string;
+    name: string;
+    description: string;
+    command: string;
+    expectedOutput?: string;
+    expectedExitCode: number;
+    severity: 'critical' | 'error' | 'warning' | 'info';
+    failureMessage: string;
+    remediationSteps: string[];
+}
+/**
+ * Health check for ongoing monitoring
+ */
+export interface HealthCheck {
+    name: string;
+    endpoint?: string;
+    command?: string;
+    interval: number;
+    timeout: number;
+    healthyThreshold: number;
+    unhealthyThreshold: number;
+}
+/**
+ * Environment-specific override
+ */
+export interface EnvironmentOverride {
+    environment: 'development' | 'staging' | 'production' | 'test';
+    overrides: {
+        configurations?: Partial<Configuration>[];
+        deploymentPhases?: Partial<DeploymentPhase>[];
+        validationChecks?: Partial<ValidationCheck>[];
+    };
+}
+/**
+ * OpenShift Validated Pattern
+ * Based on https://play.validatedpatterns.io/vp-workshop/main/5_validatedpatterns/creatingPatterns.html
+ */
+export declare const OPENSHIFT_PATTERN: ValidatedPattern;
+/**
+ * Kubernetes Deployment Pattern
+ * Based on 2025 best practices
+ */
+export declare const KUBERNETES_PATTERN: ValidatedPattern;
+/**
+ * Docker Containerization Pattern
+ */
+export declare const DOCKER_PATTERN: ValidatedPattern;
+/**
+ * Node.js Application Pattern
+ */
+export declare const NODEJS_PATTERN: ValidatedPattern;
+/**
+ * Python Application Pattern
+ */
+export declare const PYTHON_PATTERN: ValidatedPattern;
+/**
+ * MCP (Model Context Protocol) Server Pattern
+ */
+export declare const MCP_PATTERN: ValidatedPattern;
+/**
+ * A2A (Agent-to-Agent) Protocol Pattern
+ */
+export declare const A2A_PATTERN: ValidatedPattern;
+/**
+ * Pattern registry containing all validated patterns
+ */
+export declare const VALIDATED_PATTERNS: Record<PlatformType, ValidatedPattern | null>;
+/**
+ * Get pattern by platform type
+ */
+export declare function getPattern(platformType: PlatformType): ValidatedPattern | null;
+/**
+ * List all available patterns
+ */
+export declare function listAllPatterns(): ValidatedPattern[];
+//# sourceMappingURL=validated-pattern-definitions.d.ts.map

package/dist/src/utils/validated-pattern-definitions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validated-pattern-definitions.d.ts","sourceRoot":"","sources":["../../../src/utils/validated-pattern-definitions.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAE/B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,YAAY,CAAC;IAC3B,WAAW,EAAE,MAAM,CAAC;IAGpB,eAAe,EAAE;QACf,YAAY,EAAE,UAAU,EAAE,CAAC;QAC3B,cAAc,EAAE,aAAa,EAAE,CAAC;QAChC,OAAO,EAAE,iBAAiB,EAAE,CAAC;QAC7B,cAAc,EAAE,yBAAyB,EAAE,CAAC;KAC7C,CAAC;IAGF,gBAAgB,EAAE,eAAe,EAAE,CAAC;IAGpC,gBAAgB,EAAE,eAAe,EAAE,CAAC;IACpC,YAAY,EAAE,WAAW,EAAE,CAAC;IAG5B,oBAAoB,EAAE,mBAAmB,EAAE,CAAC;IAG5C,QAAQ,EAAE;QACR,MAAM,EAAE,MAAM,CAAC;QACf,WAAW,EAAE,MAAM,CAAC;QACpB,UAAU,EAAE,MAAM,CAAC;QACnB,IAAI,EAAE,MAAM,EAAE,CAAC;QACf,UAAU,EAAE,MAAM,EAAE,CAAC;KACtB,CAAC;IAGF,kBAAkB,EAAE;QAClB,GAAG,EAAE,MAAM,CAAC;QACZ,OAAO,EAAE,MAAM,CAAC;QAChB,uBAAuB,EAAE,MAAM,CAAC;QAChC,aAAa,EAAE,MAAM,EAAE,CAAC;QACxB,gBAAgB,CAAC,EAAE,MAAM,CAAC;KAC3B,CAAC;IAGF,oBAAoB,EAAE,aAAa,EAAE,CAAC;CACvC;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,eAAe,GAAG,YAAY,GAAG,eAAe,GAAG,UAAU,GAAG,WAAW,CAAC;IAClF,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,qBAAqB,EAAE,OAAO,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GACpB,WAAW,GACX,YAAY,GACZ,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,KAAK,GACL,KAAK,GACL,QAAQ,CAAC;AAEb;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,SAAS,GAAG,WAAW,GAAG,aAAa,CAAC;IAC9C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;IAClB,eAAe,EAAE,OAAO,CAAC;IACzB,gBAAgB,CAAC,EAAE,GAAG,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,OAAO,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,QAAQ,EAAE,OAAO,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,gBAAgB,CAAC,EAAE,OAAO,EAAE,CAAC;IAC7B,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,cAAc,EAAE,OAAO,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC9C,gBAAgB,EAAE,MAAM,CAAC;IACzB,WAAW,CAAC,EAAE;QACZ,WAAW,EAAE,MAAM,CAAC;QACpB,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,gBAAgB,EAAE,MAAM,CAAC;IACzB,QAAQ,EAAE,UAAU,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC;IACpD,cAAc,EAAE,MAAM,CAAC;IACvB,gBAAgB,EAAE,MAAM,EAAE,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,gBAAgB,EAAE,MAAM,CAAC;IACzB,kBAAkB,EAAE,MAAM,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,WAAW,EAAE,aAAa,GAAG,SAAS,GAAG,YAAY,GAAG,MAAM,CAAC;IAC/D,SAAS,EAAE;QACT,cAAc,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;QAC1C,gBAAgB,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,EAAE,CAAC;QAC9C,gBAAgB,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,EAAE,CAAC;KAC/C,CAAC;CACH;AAED;;;GAGG;AACH,eAAO,MAAM,iBAAiB,EAAE,gBA0P/B,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,kBAAkB,EAAE,gBAiOhC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,cAAc,EAAE,gBAoO5B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,cAAc,EAAE,gBA2N5B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,cAAc,EAAE,gBAyN5B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,WAAW,EAAE,gBAiOzB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,WAAW,EAAE,gBAkNzB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,kBAAkB,EAAE,MAAM,CAAC,YAAY,EAAE,gBAAgB,GAAG,IAAI,CAS5E,CAAC;AAEF;;GAEG;AACH,wBAAgB,UAAU,CAAC,YAAY,EAAE,YAAY,GAAG,gBAAgB,GAAG,IAAI,CAE9E;AAED;;GAEG;AACH,wBAAgB,eAAe,IAAI,gBAAgB,EAAE,CAEpD"}