projscan 4.7.0 → 4.9.1

package/dist/core/startUnderstandRouteCriteria.js

@@ -0,0 +1,97 @@
+const UNDERSTAND_VIEW_CRITERIA = {
+    flow: [
+        'Runtime entrypoints, flow paths, and side-effect evidence are reviewed before changing request or execution paths.',
+        'The developer knows which files sit on the relevant runtime path.',
+    ],
+    verify: [
+        'Verification tiers, direct-test gaps, and likely proof commands are reviewed before pushing or asking for review.',
+        'The developer has the smallest rerunnable command plus the fallback full gate for the intended change.',
+    ],
+    change: [
+        'Change-readiness risks, blast radius, and verification tiers are reviewed before editing starts.',
+        'The developer knows which follow-up impact, test, or preflight command gates the change.',
+    ],
+    map: [
+        'Read-first files, entrypoints, boundaries, risks, and unknowns are reviewed before editing starts.',
+        'The developer has a cited repo map and knows which files to inspect next.',
+    ],
+};
+export function understandSuccessCriteria(primaryAction, route) {
+    const view = primaryAction?.args && 'view' in primaryAction.args ? String(primaryAction.args.view) : 'map';
+    if (view === 'contracts')
+        return contractUnderstandSuccessCriteria(new Set(route?.matchedKeywords ?? []));
+    return UNDERSTAND_VIEW_CRITERIA[view] ?? UNDERSTAND_VIEW_CRITERIA.map;
+}
+function contractUnderstandSuccessCriteria(matched) {
+    if (contractLocalServiceSetupCriteriaMatches(matched)) {
+        return [
+            'Local service startup scripts, container commands, and required config are reviewed before running dev services.',
+            'The developer knows the safest command to start local services plus any env, port, or dependency preconditions.',
+        ];
+    }
+    if (contractScriptDiscoveryCriteriaMatches(matched)) {
+        return [
+            'Package scripts, test commands, and config contracts are reviewed before running local commands.',
+            'The developer knows the package-manager command for the requested script plus any required env or setup preconditions.',
+        ];
+    }
+    if (contractDatabaseSetupCriteriaMatches(matched)) {
+        return [
+            'Package scripts and config contracts identify the seed, reset, or migration command before shell commands are guessed.',
+            'The developer knows database setup preconditions, required env vars, and the safest local command to run.',
+        ];
+    }
+    if (contractEnvCriteriaMatches(matched)) {
+        return [
+            'Required environment variables and config contracts are identified before setup or runtime troubleshooting continues.',
+            'The developer knows which env names, defaults, or config files need local values before running the app.',
+        ];
+    }
+    return [
+        'Public exports, config contracts, and likely breaking-change risks are reviewed before touching API surfaces.',
+        'The developer knows which exported files or symbols need compatibility checks.',
+    ];
+}
+function contractScriptDiscoveryCriteriaMatches(matched) {
+    return [
+        'npm',
+        'script',
+        'scripts',
+        'e2e',
+        'unit',
+        'integration',
+        'storybook',
+        'cypress',
+        'playwright',
+        'eslint',
+        'prettier',
+        'format',
+        'lint',
+        'typecheck',
+        'typechecking',
+    ].some((keyword) => matched.has(keyword));
+}
+function contractLocalServiceSetupCriteriaMatches(matched) {
+    const action = ['run', 'runs', 'start', 'command', 'commands', 'setup'].some((keyword) => matched.has(keyword));
+    const localServices = ['local', 'locally', 'dev'].some((keyword) => matched.has(keyword)) &&
+        ['service', 'services', 'server', 'app'].some((keyword) => matched.has(keyword));
+    const dockerCompose = matched.has('docker') && matched.has('compose');
+    return action && (localServices || dockerCompose);
+}
+function contractDatabaseSetupCriteriaMatches(matched) {
+    return (['database', 'db', 'migration', 'migrations'].some((keyword) => matched.has(keyword)) &&
+        ['seed', 'seeds', 'reset', 'resets', 'migrate', 'migrates', 'run', 'runs', 'command'].some((keyword) => matched.has(keyword)));
+}
+function contractEnvCriteriaMatches(matched) {
+    return [
+        'env',
+        'environment',
+        'environments',
+        'vars',
+        'variable',
+        'variables',
+        'missing',
+        'required',
+    ].some((keyword) => matched.has(keyword));
+}
+//# sourceMappingURL=startUnderstandRouteCriteria.js.map

package/dist/core/startUnderstandRouteCriteria.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"startUnderstandRouteCriteria.js","sourceRoot":"","sources":["../../src/core/startUnderstandRouteCriteria.ts"],"names":[],"mappings":"AAGA,MAAM,wBAAwB,GAA6B;IACzD,IAAI,EAAE;QACJ,oHAAoH;QACpH,mEAAmE;KACpE;IACD,MAAM,EAAE;QACN,mHAAmH;QACnH,wGAAwG;KACzG;IACD,MAAM,EAAE;QACN,kGAAkG;QAClG,0FAA0F;KAC3F;IACD,GAAG,EAAE;QACH,oGAAoG;QACpG,2EAA2E;KAC5E;CACF,CAAC;AAEF,MAAM,UAAU,yBAAyB,CACvC,aAAmD,EACnD,KAAyB;IAEzB,MAAM,IAAI,GACR,aAAa,EAAE,IAAI,IAAI,MAAM,IAAI,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAChG,IAAI,IAAI,KAAK,WAAW;QACtB,OAAO,iCAAiC,CAAC,IAAI,GAAG,CAAC,KAAK,EAAE,eAAe,IAAI,EAAE,CAAC,CAAC,CAAC;IAClF,OAAO,wBAAwB,CAAC,IAAI,CAAC,IAAI,wBAAwB,CAAC,GAAG,CAAC;AACxE,CAAC;AAED,SAAS,iCAAiC,CAAC,OAAoB;IAC7D,IAAI,wCAAwC,CAAC,OAAO,CAAC,EAAE,CAAC;QACtD,OAAO;YACL,kHAAkH;YAClH,iHAAiH;SAClH,CAAC;IACJ,CAAC;IACD,IAAI,sCAAsC,CAAC,OAAO,CAAC,EAAE,CAAC;QACpD,OAAO;YACL,kGAAkG;YAClG,wHAAwH;SACzH,CAAC;IACJ,CAAC;IACD,IAAI,oCAAoC,CAAC,OAAO,CAAC,EAAE,CAAC;QAClD,OAAO;YACL,wHAAwH;YACxH,2GAA2G;SAC5G,CAAC;IACJ,CAAC;IACD,IAAI,0BAA0B,CAAC,OAAO,CAAC,EAAE,CAAC;QACxC,OAAO;YACL,uHAAuH;YACvH,0GAA0G;SAC3G,CAAC;IACJ,CAAC;IACD,OAAO;QACL,+GAA+G;QAC/G,gFAAgF;KACjF,CAAC;AACJ,CAAC;AAED,SAAS,sCAAsC,CAAC,OAAoB;IAClE,OAAO;QACL,KAAK;QACL,QAAQ;QACR,SAAS;QACT,KAAK;QACL,MAAM;QACN,aAAa;QACb,WAAW;QACX,SAAS;QACT,YAAY;QACZ,QAAQ;QACR,UAAU;QACV,QAAQ;QACR,MAAM;QACN,WAAW;QACX,cAAc;KACf,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;AAC5C,CAAC;AAED,SAAS,wCAAwC,CAAC,OAAoB;IACpE,MAAM,MAAM,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CACvF,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CACrB,CAAC;IACF,MAAM,aAAa,GACjB,CAAC,OAAO,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACnE,CAAC,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;IACnF,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACtE,OAAO,MAAM,IAAI,CAAC,aAAa,IAAI,aAAa,CAAC,CAAC;AACpD,CAAC;AAED,SAAS,oCAAoC,CAAC,OAAoB;IAChE,OAAO,CACL,CAAC,UAAU,EAAE,IAAI,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACrF,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC,IAAI,CACxF,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAClC,CACF,CAAC;AACJ,CAAC;AAED,SAAS,0BAA0B,CAAC,OAAoB;IACtD,OAAO;QACL,KAAK;QACL,aAAa;QACb,cAAc;QACd,MAAM;QACN,UAAU;QACV,WAAW;QACX,SAAS;QACT,UAAU;KACX,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;AAC5C,CAAC"}

package/dist/core/telemetry.d.ts

@@ -1,15 +1,13 @@
-export declare const DEFAULT_TELEMETRY_ENDPOINT = "https://www.baseframelabs.com/api/projscan/telemetry";
-export declare const TELEMETRY_HOME_ENV = "PROJSCAN_TELEMETRY_HOME";
-export declare const TELEMETRY_ENDPOINT_ENV = "PROJSCAN_TELEMETRY_ENDPOINT";
+import { DEFAULT_TELEMETRY_ENDPOINT, TELEMETRY_COLLECTED, TELEMETRY_ENDPOINT_ENV, TELEMETRY_HOME_ENV, TELEMETRY_NEVER_COLLECTED, type TelemetryStatus } from './telemetryConfig.js';
+import { type CommandTelemetryInput, type CountBucket, type DurationBucket, type MinutesSavedBucket, type TelemetryCommandCategory, type TelemetryEvent, type TelemetryEventStatus, type TelemetryFeedbackInput, type TelemetryFeedbackSummary } from './telemetryEvents.js';
+import { type RecordTelemetryResult, type TelemetryOptions } from './telemetryRecording.js';
+export { DEFAULT_TELEMETRY_ENDPOINT, TELEMETRY_COLLECTED, TELEMETRY_ENDPOINT_ENV, TELEMETRY_HOME_ENV, TELEMETRY_NEVER_COLLECTED, };
+export { buildFeedbackTelemetry } from './telemetryEvents.js';
+export type { TelemetrySender } from './telemetrySender.js';
+export type { CommandTelemetryInput, CountBucket, DurationBucket, MinutesSavedBucket, TelemetryCommandCategory, TelemetryEvent, TelemetryEventStatus, TelemetryFeedbackInput, TelemetryFeedbackSummary, };
+export type { TelemetryStatus };
 export declare const TELEMETRY_DISABLED_ENV = "PROJSCAN_TELEMETRY_DISABLED";
 export declare const TELEMETRY_NO_NETWORK_ENV = "PROJSCAN_TELEMETRY_NO_NETWORK";
-export declare const TELEMETRY_COLLECTED: readonly ["command_category", "command_name", "success_or_failure", "duration_bucket", "projscan_version", "node_major", "platform", "ci_boolean", "setup_booleans", "repeat_use_buckets", "optional_feedback_buckets"];
-export declare const TELEMETRY_NEVER_COLLECTED: readonly ["source_code", "file_paths", "repo_names", "branch_names", "package_names", "usernames", "emails", "raw_findings", "secrets", "environment_variables"];
-export type TelemetryCommandCategory = 'doctor' | 'review' | 'preflight' | 'dogfood' | 'feedback' | 'trial' | 'init' | 'mcp' | 'evidence' | 'start' | 'other';
-export type TelemetryEventStatus = 'success' | 'failure';
-export type DurationBucket = '<1s' | '1-5s' | '5-30s' | '30s-2m' | '2m+';
-export type CountBucket = '0' | '1' | '2-5' | '6-20' | '21-100' | '100+';
-export type MinutesSavedBucket = '0' | '1-5' | '6-10' | '10-20' | '20+';
 export interface TelemetryPolicy {
     schemaVersion: 1;
     default: 'off';
@@ -20,84 +18,7 @@ export interface TelemetryPolicy {
     controls: string[];
     notes: string[];
 }
-export interface TelemetryStatus {
-    schemaVersion: 1;
-    enabled: boolean;
-    mode: 'enabled' | 'disabled';
-    anonymousId: string | null;
-    endpoint: string;
-    configPath: string;
-    queuePath: string;
-    queueLength: number;
-    collected: string[];
-    neverCollected: string[];
-    controls: string[];
-    nextCommands: string[];
-}
-export interface TelemetryFeedbackInput {
-    repo?: unknown;
-    pr?: unknown;
-    reviewer?: unknown;
-    useful?: boolean;
-    minutesSaved?: number;
-    preventedBadEdit?: boolean;
-    falsePositiveRules?: unknown[];
-    falsePositiveReported?: boolean;
-}
-export interface TelemetryFeedbackSummary {
-    useful?: boolean;
-    minutesSavedBucket?: MinutesSavedBucket;
-    preventedBadEdit?: boolean;
-    falsePositiveReported?: boolean;
-}
-export interface CommandTelemetryInput {
-    commandName: string;
-    status: TelemetryEventStatus;
-    durationMs: number;
-    rootPath?: string;
-    version?: string;
-    feedback?: TelemetryFeedbackSummary;
-}
-export interface TelemetryEvent {
-    schemaVersion: 1;
-    eventId: string;
-    eventType: 'command_run' | 'feedback_outcome';
-    anonymousId: string;
-    occurredAt: string;
-    commandCategory: TelemetryCommandCategory;
-    commandName: string;
-    status: TelemetryEventStatus;
-    durationBucket: DurationBucket;
-    version: string;
-    nodeMajor: number;
-    platform: NodeJS.Platform;
-    ci: boolean;
-    setup: {
-        githubActionConfigured: boolean;
-        mcpConfigured: boolean;
-        teamInitConfigured: boolean;
-    };
-    repeatUse: {
-        runCountBucket: CountBucket;
-        activeDaysBucket: CountBucket;
-    };
-    feedback?: TelemetryFeedbackSummary;
-}
-export type TelemetrySender = (batch: TelemetryEvent[], endpoint: string) => Promise<{
-    ok: boolean;
-    status: number;
-}>;
-export interface TelemetryOptions {
-    configDir?: string;
-    now?: Date;
-    sender?: TelemetrySender;
-    flush?: boolean;
-}
-export interface RecordTelemetryResult {
-    status: 'skipped' | 'queued' | 'sent' | 'failed';
-    reason?: string;
-    queued?: number;
-}
+export type { RecordTelemetryResult, TelemetryOptions };
 export declare function explainTelemetryPolicy(): TelemetryPolicy;
 export declare function getTelemetryOptInPrompt(): string;
 export declare function getTelemetryStatus(options?: TelemetryOptions): Promise<TelemetryStatus>;
@@ -105,7 +26,6 @@ export declare function enableTelemetry(options?: TelemetryOptions & {
     endpoint?: string;
 }): Promise<TelemetryStatus>;
 export declare function disableTelemetry(options?: TelemetryOptions): Promise<TelemetryStatus>;
-export declare function buildFeedbackTelemetry(input: TelemetryFeedbackInput): TelemetryFeedbackSummary;
 export declare function recordCommandTelemetry(input: CommandTelemetryInput, options?: TelemetryOptions): Promise<RecordTelemetryResult>;
 export declare function recordFeedbackTelemetry(input: TelemetryFeedbackInput, options?: TelemetryOptions & {
     rootPath?: string;