@hongmaple0820/scale-engine 0.15.0 → 0.16.0

package/dist/workflow/EngineeringStandards.d.ts

@@ -0,0 +1,212 @@
+export type EngineeringStandardCategory = 'logging' | 'security' | 'database' | 'architecture' | 'code-quality' | 'framework' | 'testing' | 'uiux';
+export type EngineeringStandardSeverity = 'info' | 'warn' | 'fail';
+export type EngineeringStandardsDebtScope = 'production' | 'test' | 'generated';
+export interface EngineeringStandardFinding {
+    severity: EngineeringStandardSeverity;
+    category: EngineeringStandardCategory;
+    ruleId: string;
+    path: string;
+    line?: number;
+    message: string;
+    evidence?: string;
+    fix?: string;
+}
+export interface EngineeringStandardsPolicyFile {
+    version?: number;
+    mode?: 'warn' | 'block';
+    sourceDirectories?: string[];
+    ignoredDirectories?: string[];
+    allowedConsoleDirectories?: string[];
+    allowedConsoleFiles?: string[];
+    maxFileLines?: number;
+    logging?: {
+        approvedLoggers?: string[];
+        sensitiveFields?: string[];
+    };
+    architecture?: {
+        enforceLayering?: boolean;
+    };
+    blockingRules?: string[];
+    allowedFindingPatterns?: Array<{
+        ruleId: string;
+        path?: string;
+        evidencePattern?: string;
+        messagePattern?: string;
+        reason?: string;
+    }>;
+    baselineFindings?: Array<{
+        ruleId: string;
+        path: string;
+        line?: number;
+        reason?: string;
+    }>;
+}
+export interface EngineeringStandardsBaselineFile {
+    version?: number;
+    findings?: Array<{
+        ruleId: string;
+        path: string;
+        line?: number;
+        reason?: string;
+    }>;
+}
+export interface ResolvedEngineeringStandardsPolicy {
+    version: number;
+    mode: 'warn' | 'block';
+    sourceDirectories: string[];
+    ignoredDirectories: string[];
+    allowedConsoleDirectories: string[];
+    allowedConsoleFiles: string[];
+    maxFileLines: number;
+    logging: {
+        approvedLoggers: string[];
+        sensitiveFields: string[];
+    };
+    architecture: {
+        enforceLayering: boolean;
+    };
+    blockingRules: string[];
+    allowedFindingPatterns: Array<{
+        ruleId: string;
+        path?: string;
+        evidencePattern?: string;
+        messagePattern?: string;
+        reason?: string;
+    }>;
+    baselineFindings: Array<{
+        ruleId: string;
+        path: string;
+        line?: number;
+        reason?: string;
+    }>;
+    warnings: string[];
+}
+export interface FrameworkImportRule {
+    source: string;
+    severity?: EngineeringStandardSeverity;
+    reason?: string;
+    replacement?: string;
+}
+export interface FrameworksCatalogWarning {
+    ruleId: 'frameworks-catalog-warning' | 'frameworks-catalog-stale';
+    message: string;
+}
+export interface FrameworksCatalogFile {
+    version?: number;
+    lastReviewedAt?: string;
+    reviewIntervalDays?: number;
+    bannedImports?: FrameworkImportRule[];
+}
+export interface ResolvedFrameworksCatalog {
+    version: number;
+    lastReviewedAt?: string;
+    reviewIntervalDays?: number;
+    bannedImports: FrameworkImportRule[];
+    warnings: FrameworksCatalogWarning[];
+}
+export interface EngineeringStandardsScanOptions {
+    projectDir?: string;
+    scaleDir?: string;
+    now?: Date;
+    changedFiles?: string[];
+    includeBaselineFindings?: boolean;
+}
+export interface EngineeringStandardsSummary {
+    filesScanned: number;
+    totalFindings: number;
+    blockingFindings: number;
+    bySeverity: Record<EngineeringStandardSeverity, number>;
+    byCategory: Record<EngineeringStandardCategory, number>;
+}
+export interface EngineeringStandardsScanReport {
+    projectDir: string;
+    policyPath: string;
+    baselinePath: string;
+    frameworksPath: string;
+    policy: ResolvedEngineeringStandardsPolicy;
+    frameworks: ResolvedFrameworksCatalog;
+    findings: EngineeringStandardFinding[];
+    summary: EngineeringStandardsSummary;
+    warnings: string[];
+}
+export interface EngineeringStandardsDoctorReport {
+    ok: boolean;
+    projectDir: string;
+    findings: EngineeringStandardFinding[];
+    scan: EngineeringStandardsScanReport;
+}
+export interface EngineeringStandardsSettleOptions extends EngineeringStandardsScanOptions {
+    taskId?: string;
+    artifactsDir?: string;
+}
+export interface EngineeringStandardsBaselineOptions extends EngineeringStandardsScanOptions {
+    taskId?: string;
+    artifactsDir?: string;
+    writeBaseline?: boolean;
+    reason?: string;
+    maxFindingsInReport?: number;
+}
+export interface EngineeringStandardsSettleReport {
+    ok: boolean;
+    taskId?: string;
+    standardsImpactPath?: string;
+    doctor: EngineeringStandardsDoctorReport;
+}
+export interface EngineeringStandardsBaselineEntry {
+    ruleId: string;
+    path: string;
+    line?: number;
+    reason: string;
+    severity: EngineeringStandardSeverity;
+    category: EngineeringStandardCategory;
+    message: string;
+}
+export interface EngineeringStandardsDebtGroup {
+    total: number;
+    blocking: number;
+    warn: number;
+    info: number;
+}
+export interface EngineeringStandardsDebtRuleGroup extends EngineeringStandardsDebtGroup {
+    category: EngineeringStandardCategory;
+}
+export interface EngineeringStandardsDebtFileGroup extends EngineeringStandardsDebtGroup {
+    path: string;
+}
+export interface EngineeringStandardsDebtSummary {
+    filesScanned: number;
+    totalFindings: number;
+    blockingFindings: number;
+    bySeverity: Record<EngineeringStandardSeverity, number>;
+    byScope: Record<EngineeringStandardsDebtScope, EngineeringStandardsDebtGroup>;
+    byCategory: Record<EngineeringStandardCategory, EngineeringStandardsDebtGroup>;
+    byRule: Record<string, EngineeringStandardsDebtRuleGroup>;
+    topFiles: EngineeringStandardsDebtFileGroup[];
+}
+export interface EngineeringStandardsBaselineReport {
+    ok: boolean;
+    projectDir: string;
+    baselinePath: string;
+    legacyDebtPath?: string;
+    wroteBaseline: boolean;
+    baselineEntries: EngineeringStandardsBaselineEntry[];
+    debt: EngineeringStandardsDebtSummary;
+    scan: EngineeringStandardsScanReport;
+    warnings: string[];
+}
+export declare function engineeringStandardsPolicyPath(projectDir?: string, scaleDir?: string): string;
+export declare function frameworksCatalogPath(projectDir?: string, scaleDir?: string): string;
+export declare function engineeringStandardsBaselinePath(projectDir?: string, scaleDir?: string): string;
+export declare function engineeringStandardsPolicyTemplate(): string;
+export declare function engineeringStandardsBaselineTemplate(): string;
+export declare function frameworksCatalogTemplate(): string;
+export declare function loadEngineeringStandardsPolicy(projectDir?: string, scaleDir?: string): ResolvedEngineeringStandardsPolicy;
+export declare function loadEngineeringStandardsBaseline(projectDir?: string, scaleDir?: string): {
+    findings: ResolvedEngineeringStandardsPolicy['baselineFindings'];
+    warnings: string[];
+};
+export declare function loadFrameworksCatalog(projectDir?: string, scaleDir?: string, now?: Date): ResolvedFrameworksCatalog;
+export declare function scanEngineeringStandards(options?: EngineeringStandardsScanOptions): EngineeringStandardsScanReport;
+export declare function doctorEngineeringStandards(options?: EngineeringStandardsScanOptions): EngineeringStandardsDoctorReport;
+export declare function settleEngineeringStandards(options?: EngineeringStandardsSettleOptions): EngineeringStandardsSettleReport;
+export declare function baselineEngineeringStandards(options?: EngineeringStandardsBaselineOptions): EngineeringStandardsBaselineReport;