@appland/scanner 1.82.1 → 1.83.1

package/built/rules/lib/analyzeDataFlow.d.ts

@@ -0,0 +1,23 @@
+import { Event, ValueBase } from '@appland/models';
+/**
+ * Value tracked with data flow analysis, along with the information about
+ * its originating event and a list of any other such values that might have
+ * been used in its generation.
+ */
+export declare type TrackedValue = {
+    value: ValueBase;
+    origin: Event;
+    parents: ReadonlyArray<TrackedValue>;
+};
+/**
+ * Tracks flow of data across the execution trace, identifying all function
+ * calls which have a tracked object as its receiver or one of the parameters.
+ * Any value such a function returns will also then become tracked.
+ * The origin chain of all values is recorded, so full provenience up to
+ * the starting set can be reconstructed.
+ * @param trackedData Initial data to track.
+ * @param startEvent The root event of the analysis.
+ * @returns Events which have a tracked piece of data as an input, each
+ * associated with the list of such inputs.
+ */
+export default function analyzeDataFlow(trackedData: ReadonlyArray<ValueBase>, startEvent: Event): Map<Event, ReadonlyArray<TrackedValue>>;

package/built/rules/lib/hasParameterOrReceiver.d.ts

@@ -0,0 +1,3 @@
+import { Event } from '@appland/models';
+declare const _default: (objectId: number) => (event: Event) => boolean;
+export default _default;

package/built/rules/lib/isCommand.d.ts

@@ -0,0 +1,2 @@
+import { Event } from '@appland/models';
+export default function isCommand(event: Event): string | undefined;

package/built/rules/lib/matchEvent.d.ts

@@ -0,0 +1,4 @@
+import MatchEventConfig from '../../configuration/types/matchEventConfig';
+import { EventFilter } from '../../types';
+export declare function buildFilter(pattern: MatchEventConfig): EventFilter;
+export declare function buildFilters(patterns: MatchEventConfig[]): EventFilter[];

package/built/rules/lib/matchPattern.d.ts

@@ -0,0 +1,4 @@
+import MatchPatternConfig from '../../configuration/types/matchPatternConfig';
+import { StringFilter } from '../../types';
+export declare function buildFilter(pattern: MatchPatternConfig): StringFilter;
+export declare function buildFilters(patterns: MatchPatternConfig[]): StringFilter[];

package/built/rules/lib/metadata.d.ts

@@ -0,0 +1,9 @@
+import { ImpactDomain, ScopeName } from '../../index';
+export declare type Metadata = {
+    title: string;
+    impactDomain: ImpactDomain;
+    references: Record<string, string>;
+    labels?: string[];
+    scope?: ScopeName;
+    enumerateScope?: boolean;
+};

package/built/rules/lib/openapiProvider.d.ts

@@ -0,0 +1,3 @@
+import { OpenAPIV3 } from 'openapi-types';
+declare const lookup: (host: string, openapiSchemata: Record<string, string>) => Promise<OpenAPIV3.Document>;
+export default lookup;

package/built/rules/lib/parseRuleDescription.d.ts

@@ -0,0 +1 @@
+export default function parseRuleDescription(id: string): string;

package/built/rules/lib/precedingEvents.d.ts

@@ -0,0 +1,2 @@
+import { Event, EventNavigator } from '@appland/models';
+export default function precedingEvents(rootEvent: Event, target: Event): Generator<EventNavigator>;

package/built/rules/lib/rpcWithoutProtection.d.ts

@@ -0,0 +1,6 @@
+import { Event, Label } from '@appland/models';
+import { RuleLogic } from '../../types';
+export interface RPCWithoutProtectionOptions {
+    get expectedLabel(): Label;
+}
+export declare function rpcWithoutProtection(candidateGenerator: (httpClientRequest: Event) => Generator<Event>, options: RPCWithoutProtectionOptions): RuleLogic;

package/built/rules/lib/sanitizesData.d.ts

@@ -0,0 +1,2 @@
+import { Event } from '@appland/models';
+export default function sanitizesData(event: Event, objectId: number, label: string): boolean;

package/built/rules/lib/util.d.ts

@@ -0,0 +1,20 @@
+import { Event, ReturnValueObject } from '@appland/models';
+export declare function collectAppMapFiles(appmapFile?: string | string[], appmapDir?: string): Promise<string[]>;
+declare function verbose(v?: boolean): boolean;
+declare function capitalize(str: string): string;
+declare function emptyValue(value: string): boolean;
+declare function responseContentType(event: Event): string | undefined;
+declare function appMapDir(appMapFileName: string): string;
+declare function isFalsey(valueObj?: ReturnValueObject): boolean;
+declare function parseValue(valueObj: ReturnValueObject): string[];
+declare const isTruthy: (valueObj?: ReturnValueObject | undefined) => boolean;
+declare function providesAuthentication(event: Event, label: string): boolean;
+declare function ideLink(filePath: string, ide: string, eventId: number): string;
+declare const toRegExp: (value: string | RegExp) => RegExp;
+declare const toRegExpArray: (value: string[] | RegExp[]) => RegExp[];
+declare const isRoot: (event: Event | undefined) => boolean;
+declare function dasherize(str: string): string;
+declare function camelize(text: string): string;
+declare function pluralize(word: string, count: number): string;
+declare function fileExists(file: string): Promise<boolean>;
+export { appMapDir, capitalize, emptyValue, fileExists, isFalsey, isTruthy, ideLink, isRoot, parseValue, camelize, dasherize, pluralize, providesAuthentication, toRegExp, responseContentType, toRegExpArray, verbose, };

package/built/rules/logoutWithoutSessionReset.d.ts

@@ -0,0 +1,3 @@
+import RuleInstance from '../ruleInstance';
+declare const RULE: RuleInstance;
+export default RULE;

package/built/rules/missingAuthentication.d.ts

@@ -0,0 +1,3 @@
+import RuleInstance from '../ruleInstance';
+declare const RULE: RuleInstance;
+export default RULE;

package/built/rules/missingContentType.d.ts

@@ -0,0 +1,3 @@
+import RuleInstance from '../ruleInstance';
+declare const RULE: RuleInstance;
+export default RULE;

package/built/rules/nPlusOneQuery.d.ts

@@ -0,0 +1,3 @@
+import RuleInstance from '../ruleInstance';
+declare const RULE: RuleInstance;
+export default RULE;

package/built/rules/queryFromInvalidPackage.d.ts

@@ -0,0 +1,3 @@
+import RuleInstance from '../ruleInstance';
+declare const RULE: RuleInstance;
+export default RULE;

package/built/rules/queryFromView.d.ts

@@ -0,0 +1,3 @@
+import RuleInstance from '../ruleInstance';
+declare const RULE: RuleInstance;
+export default RULE;

package/built/rules/rpcWithoutCircuitBreaker.d.ts

@@ -0,0 +1,3 @@
+import RuleInstance from '../ruleInstance';
+declare const RULE: RuleInstance;
+export default RULE;

package/built/rules/saveWithoutValidation.d.ts

@@ -0,0 +1,3 @@
+import RuleInstance from '../ruleInstance';
+declare const RULE: RuleInstance;
+export default RULE;

package/built/rules/secretInLog.d.ts

@@ -0,0 +1,3 @@
+import RuleInstance from '../ruleInstance';
+declare const RULE: RuleInstance;
+export default RULE;

package/built/rules/slowFunctionCall.d.ts

@@ -0,0 +1,3 @@
+import RuleInstance from '../ruleInstance';
+declare const RULE: RuleInstance;
+export default RULE;

package/built/rules/slowHttpServerRequest.d.ts

@@ -0,0 +1,3 @@
+import RuleInstance from '../ruleInstance';
+declare const RULE: RuleInstance;
+export default RULE;

package/built/rules/slowQuery.d.ts

@@ -0,0 +1,3 @@
+import RuleInstance from '../ruleInstance';
+declare const RULE: RuleInstance;
+export default RULE;

package/built/rules/too-many-joins/metadata.d.ts

@@ -0,0 +1,3 @@
+import { Metadata } from '../lib/metadata';
+declare const _default: Metadata;
+export default _default;

package/built/rules/too-many-joins/options.d.ts

@@ -0,0 +1,6 @@
+import MatchPatternConfig from '../../configuration/types/matchPatternConfig';
+import { TooManyJoins } from '../types';
+export default class Options implements TooManyJoins.Options {
+    warningLimit: number;
+    excludeTables: MatchPatternConfig[];
+}

package/built/rules/too-many-joins/rule.d.ts

@@ -0,0 +1,7 @@
+import { SQLCount } from '../../database';
+import { RuleLogic } from '../../types';
+import Options from './options';
+export interface JoinCount extends SQLCount {
+    joins: number;
+}
+export default function rule(options: Options): RuleLogic;

package/built/rules/tooManyUpdates.d.ts

@@ -0,0 +1,3 @@
+import RuleInstance from '../ruleInstance';
+declare const RULE: RuleInstance;
+export default RULE;

package/built/rules/unauthenticated-encryption/metadata.d.ts

@@ -0,0 +1,3 @@
+import { Metadata } from '../lib/metadata';
+declare const _default: Metadata;
+export default _default;

package/built/rules/unauthenticated-encryption/rule.d.ts

@@ -0,0 +1,2 @@
+import { RuleLogic } from '../../types';
+export default function rule(): RuleLogic;

package/built/rules/unbatchedMaterializedQuery.d.ts

@@ -0,0 +1,3 @@
+import RuleInstance from '../ruleInstance';
+declare const RULE: RuleInstance;
+export default RULE;

package/built/rules/updateInGetRequest.d.ts

@@ -0,0 +1,3 @@
+import RuleInstance from '../ruleInstance';
+declare const RULE: RuleInstance;
+export default RULE;

package/built/scan.d.ts

@@ -0,0 +1,5 @@
+import { ScanResults } from './index';
+/**
+ * Perform all configured checks on a single AppMap file.
+ */
+export default function scan(appmapFile: string, configurationFile: string): Promise<ScanResults>;

package/built/scope/commandScope.d.ts

@@ -0,0 +1,6 @@
+import { Event } from '@appland/models';
+import { Scope } from '../types';
+import ScopeIterator from './scopeIterator';
+export default class CommandScope extends ScopeIterator {
+    scopes(events: IterableIterator<Event>): Generator<Scope>;
+}

package/built/scope/httpClientRequestScope.d.ts

@@ -0,0 +1,6 @@
+import { Event } from '@appland/models';
+import { Scope } from '../types';
+import ScopeIterator from './scopeIterator';
+export default class HTTPClientRequestScope extends ScopeIterator {
+    scopes(events: Generator<Event>): Generator<Scope>;
+}

package/built/scope/httpServerRequestScope.d.ts

@@ -0,0 +1,6 @@
+import { Event } from '@appland/models';
+import { Scope } from '../types';
+import ScopeIterator from './scopeIterator';
+export default class HTTPServerRequestScope extends ScopeIterator {
+    scopes(events: Generator<Event>): Generator<Scope>;
+}

package/built/scope/rootScope.d.ts

@@ -0,0 +1,6 @@
+import { Event } from '@appland/models';
+import { Scope } from '../types';
+import ScopeIterator from './scopeIterator';
+export default class RootScope extends ScopeIterator {
+    scopes(events: IterableIterator<Event>): Generator<Scope>;
+}

package/built/scope/scopeImpl.d.ts

@@ -0,0 +1,8 @@
+import { Event, EventNavigator } from '@appland/models';
+import { Scope } from '../types';
+export default class ScopeImpl implements Scope {
+    scope: Event;
+    descendants: EventNavigator;
+    constructor(event: Event);
+    events(): Generator<Event>;
+}

package/built/scope/scopeIterator.d.ts

@@ -0,0 +1,6 @@
+import { Event } from '@appland/models';
+import { Scope } from '../types';
+export default abstract class ScopeIterator {
+    abstract scopes(events: Iterable<Event>): Generator<Scope>;
+    protected advanceToReturnEvent(scopeEvent: Event, events: Iterator<Event>): void;
+}

package/built/scope/sqlTransactionScope.d.ts

@@ -0,0 +1,13 @@
+import type { Event } from '@appland/models';
+import ScopeIterator from './scopeIterator';
+import type { Scope } from '../types';
+export interface TransactionDetails {
+    transaction: {
+        status: 'commit' | 'rollback';
+        events: Event[];
+    };
+}
+export declare function hasTransactionDetails(event: Event & Partial<TransactionDetails>): event is Event & TransactionDetails;
+export default class SQLTransactionScope extends ScopeIterator {
+    scopes(events: IterableIterator<Event>): Generator<Scope, void, void>;
+}

package/built/sqlWarning.d.ts

@@ -0,0 +1,2 @@
+import { ParseError } from '@appland/models';
+export default function sqlWarning(parseError: ParseError): void;

package/built/telemetry.d.ts

@@ -0,0 +1,50 @@
+/// <reference types="node" />
+import { TelemetryClient } from 'applicationinsights';
+import { PathLike } from 'fs';
+declare class Session {
+    id: string;
+    expiration: number;
+    constructor();
+    static beyondExpiration(expiration: number): boolean;
+    static expirationFromNow(): number;
+    static newSessionId(): string;
+    touch(): void;
+    get valid(): boolean;
+}
+export interface TelemetryData {
+    name: string;
+    properties?: Record<string, string | undefined>;
+    metrics?: Record<string, number | undefined>;
+}
+export interface TelemetryOptions {
+    includeEnvironment: boolean;
+}
+export default class Telemetry {
+    private static _session?;
+    private static _client?;
+    private static debug;
+    static readonly machineId: string;
+    static get enabled(): boolean;
+    static get session(): Session;
+    static get client(): TelemetryClient;
+    static sendEvent(data: TelemetryData, options?: TelemetryOptions): void;
+    static flush(exitCB: () => unknown): void;
+}
+export declare enum GitState {
+    NotInstalled = 0,
+    NoRepository = 1,
+    Ok = 2
+}
+export declare const GitRepositoryEnvKeys: readonly ["GITHUB_REPOSITORY", "CIRCLE_REPOSITORY_URL", "GIT_URL", "CI_REPOSITORY_URL"];
+export declare const GitBranchEnvKeys: readonly ["GITHUB_REF_NAME", "CIRCLE_BRANCH", "GIT_BRANCH", "TRAVIS_BRANCH", "CI_COMMIT_REF_NAME"];
+export declare const GitCommitEnvKeys: readonly ["GITHUB_SHA", "CIRCLE_SHA1", "GIT_COMMIT", "TRAVIS_COMMIT", "CI_COMMIT_SHA"];
+declare class GitProperties {
+    static contributors(sinceDaysAgo: number, cwd?: PathLike): Promise<Array<string>>;
+    static repository(cwd?: PathLike): Promise<string | undefined>;
+    static branch(cwd?: PathLike): Promise<string | undefined>;
+    static commit(cwd?: PathLike): Promise<string | undefined>;
+    static state(cwd?: PathLike): Promise<GitState>;
+    static clearCache(): void;
+}
+export declare const Git: typeof GitProperties;
+export {};

package/built/telemetry.js

@@ -35,7 +35,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Git = exports.GitState = void 0;
+exports.Git = exports.GitCommitEnvKeys = exports.GitBranchEnvKeys = exports.GitRepositoryEnvKeys = exports.GitState = void 0;
 const os_1 = require("os");
 const crypto_1 = require("crypto");
 const os = __importStar(require("os"));
@@ -238,6 +238,26 @@ var GitState;
     GitState[GitState["NoRepository"] = 1] = "NoRepository";
     GitState[GitState["Ok"] = 2] = "Ok";
 })(GitState = exports.GitState || (exports.GitState = {}));
+exports.GitRepositoryEnvKeys = [
+    'GITHUB_REPOSITORY',
+    'CIRCLE_REPOSITORY_URL',
+    'GIT_URL',
+    'CI_REPOSITORY_URL', // GitLab
+];
+exports.GitBranchEnvKeys = [
+    'GITHUB_REF_NAME',
+    'CIRCLE_BRANCH',
+    'GIT_BRANCH',
+    'TRAVIS_BRANCH',
+    'CI_COMMIT_REF_NAME', // GitLab
+];
+exports.GitCommitEnvKeys = [
+    'GITHUB_SHA',
+    'CIRCLE_SHA1',
+    'GIT_COMMIT',
+    'TRAVIS_COMMIT',
+    'CI_COMMIT_SHA', // GitLab
+];
 class GitProperties {
     static contributors(sinceDaysAgo, cwd) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -267,6 +287,54 @@ class GitProperties {
             }
         });
     }
+    // Returns the repository URL, first by checking the environment, then by
+    // shelling out to git.
+    static repository(cwd) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const envKey = exports.GitRepositoryEnvKeys.find((key) => process.env[key]);
+            if (envKey)
+                return process.env[envKey];
+            try {
+                const { stdout } = yield exec(['git', cwd && `-C ${cwd.toString()}`, 'config', '--get', 'remote.origin.url'].join(' '));
+                return stdout.trim();
+            }
+            catch (_a) {
+                return undefined;
+            }
+        });
+    }
+    // Returns the branch, first by checking the environment, then by
+    // shelling out to git.
+    static branch(cwd) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const envKey = exports.GitBranchEnvKeys.find((key) => process.env[key]);
+            if (envKey)
+                return process.env[envKey];
+            try {
+                const { stdout } = yield exec(['git', cwd && `-C ${cwd.toString()}`, 'rev-parse', '--abbrev-ref', 'HEAD'].join(' '));
+                return stdout.trim();
+            }
+            catch (_a) {
+                return undefined;
+            }
+        });
+    }
+    // Returns the commit SHA, first by checking the environment, then by
+    // shelling out to git.
+    static commit(cwd) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const envKey = exports.GitCommitEnvKeys.find((key) => process.env[key]);
+            if (envKey)
+                return process.env[envKey];
+            try {
+                const { stdout } = yield exec(['git', cwd && `-C ${cwd.toString()}`, 'rev-parse', 'HEAD'].join(' '));
+                return stdout.trim();
+            }
+            catch (_a) {
+                return undefined;
+            }
+        });
+    }
     static state(cwd) {
         return __awaiter(this, void 0, void 0, function* () {
             return new Promise((resolve) => {
@@ -295,6 +363,9 @@ class GitProperties {
             });
         });
     }
+    static clearCache() {
+        gitCache.clear();
+    }
 }
 const gitCache = new Map();
 // GitProperties is available externally as Git.

package/built/util/eventAggregator.d.ts

@@ -0,0 +1,20 @@
+/// <reference types="node" />
+import { EventEmitter } from 'events';
+export declare type PendingEvent<E> = {
+    emitter: EventEmitter;
+    event: string;
+    arg: E;
+};
+export declare const MaxMSBetween: number;
+export declare type CancelFn = () => void;
+export default class EventAggregator<E> {
+    private callback;
+    private maxMsBetween;
+    private pending;
+    private timeout?;
+    constructor(callback: (events: PendingEvent<E>[]) => void, maxMsBetween?: number);
+    private push;
+    private refresh;
+    private emitPending;
+    attach(emitter: EventEmitter, event: string): CancelFn;
+}

package/built/util/isAncestorPath.d.ts

@@ -0,0 +1 @@
+export default function isAncestorPath(ancestor: string, descendant: string): boolean;

package/built/wellKnownLabels.d.ts

@@ -0,0 +1,5 @@
+declare enum WellKnownLabels {
+    JobCreate = "job.create",
+    JobCancel = "job.cancel"
+}
+export default WellKnownLabels;

package/package.json

@@ -1,15 +1,14 @@
 {
   "name": "@appland/scanner",
-  "version": "1.82.1",
+  "version": "1.83.1",
   "description": "Analyze AppMaps for code flaws",
   "bin": "built/cli.js",
   "main": "built/index.js",
   "files": [
     "built",
-    "doc",
-    "src/types.d.ts"
+    "doc"
   ],
-  "types": "src/index.ts",
+  "types": "built/index.d.ts",
   "scripts": {
     "build": "node bin/preBuild.js && tsc -p tsconfig.build.json && yarn schema && yarn doc",
     "build-native": "yarn build && ./bin/build-native",
@@ -20,8 +19,8 @@
     "doc-up-to-date": "git diff --exit-code doc/",
     "lint": "eslint src --ext .ts",
     "ci": "yarn lint && yarn build && yarn schema-up-to-date && yarn doc-up-to-date && yarn test",
-    "test": "jest --filter=./test/testFilter.js",
-    "jest": "jest --filter=./test/testFilter.js",
+    "test": "jest --filter=./test/testFilter.js --detectOpenHandles",
+    "jest": "jest --filter=./test/testFilter.js --detectOpenHandles",
     "semantic-release": "semantic-release",
     "watch": "node bin/preBuild.js && tsc -p tsconfig.build.json --watch"
   },
@@ -65,7 +64,7 @@
   "dependencies": {
     "@appland/client": "^1.5.0",
     "@appland/models": "^2.6.3",
-    "@appland/openapi": "1.6.0",
+    "@appland/openapi": "1.6.1",
     "@appland/sql-parser": "^1.5.0",
     "@types/cli-progress": "^3.9.2",
     "ajv": "^8.8.2",
@@ -83,7 +82,7 @@
     "lru-cache": "^6.0.0",
     "minimatch": "^5.1.2",
     "octokit": "^2.0.19",
-    "openapi-diff": "^0.23.5",
+    "openapi-diff": "^0.23.6",
     "ora": "~5",
     "pretty-format": "^27.4.6",
     "read-pkg-up": "^7.0.1",

package/built/cli/scan/watchScanTelemetry.js

@@ -1,44 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WatchScanTelemetry = void 0;
-const eventAggregator_1 = __importDefault(require("../../util/eventAggregator"));
-const scanResults_1 = require("../../report/scanResults");
-class WatchScanTelemetry {
-    constructor(scanEvents, appmapDir) {
-        this.appmapDir = appmapDir;
-        this.cancelFn = new eventAggregator_1.default((events) => {
-            const scanEvents = events.map((e) => e.arg);
-            this.sendTelemetry(scanEvents);
-        }).attach(scanEvents, 'scan');
-    }
-    cancel() {
-        if (this.cancelFn)
-            this.cancelFn();
-        this.cancelFn = undefined;
-    }
-    static watch(scanEvents, appmapDir) {
-        const telemetry = new WatchScanTelemetry(scanEvents, appmapDir);
-        return () => telemetry.cancel();
-    }
-    sendTelemetry(scanEvents) {
-        const ruleIds = new Set();
-        let elapsed = 0;
-        const telemetryScanResults = new scanResults_1.ScanResults();
-        for (const scanEvent of scanEvents) {
-            telemetryScanResults.aggregate(scanEvent.scanResults);
-            elapsed += scanEvent.elapsed;
-        }
-        telemetryScanResults.summary.rules.forEach((rule) => ruleIds.add(rule));
-        (0, scanResults_1.sendScanResultsTelemetry)({
-            ruleIds: [...ruleIds],
-            numAppMaps: telemetryScanResults.summary.numAppMaps,
-            numFindings: telemetryScanResults.summary.numFindings,
-            elapsedMs: elapsed,
-            appmapDir: this.appmapDir,
-        });
-    }
-}
-exports.WatchScanTelemetry = WatchScanTelemetry;

package/src/types.d.ts

@@ -1,72 +0,0 @@
-import { AppMap, Event } from '@appland/models';
-import { SqliteParser } from '@appland/models/types/sqlite-parser';
-
-/**
- * Scope provides an Event at the root of the scope, and a Generator to iterate over its descendants.
- */
-interface Scope {
-  scope: Event;
-  events: () => Generator<Event>;
-}
-
-/**
- * Level indicates the priority of a finding.
- */
-export type Level = 'warning' | 'error';
-
-type StringFilter = (value: string) => boolean;
-
-/**
- * EventFilter is used by Rule to select Events that will be analyzed for findings.
- * The event filter is always applied to the Scope.scope event. If enumerateScope is true,
- * the filter is applied to all Scope.events as well.
- */
-type EventFilter = (e: Event, appMapIndex: AppMapIndex) => boolean;
-
-/**
- * MatchResult is created by a rule when it matches an Event.
- */
-export interface MatchResult {
-  level?: Level;
-  event: Event;
-  message: string;
-  participatingEvents?: Record<string, Event>;
-  groupMessage?: string;
-  occurranceCount?: number;
-  relatedEvents?: Event[];
-}
-
-type MatcherResult =
-  | Promise<boolean | string | MatchResult[]>
-  | boolean
-  | string
-  | MatchResult[]
-  | undefined;
-
-type EventType = 'http_server_request' | 'http_client_request' | 'sql_query' | 'function';
-
-export type QueryAST = SqliteParser.ListStatement | null;
-
-interface AppMapIndex {
-  appMap: AppMap;
-
-  sqlAST(event: Event): QueryAST | undefined;
-
-  sqlNormalized(event: Event): string;
-}
-
-/**
- * Matcher function is part of a rule. It's applied to an Event to determine whether there is a finding
- * on this event. If the Matcher returns true, a string, or a MatchResult[], then finding(s) are created.
- */
-type Matcher = (e: Event, appMapIndex: AppMapIndex, eventFilter: EventFilter) => MatcherResult;
-
-export interface RuleLogic {
-  // Tests an event in the scope see if it matches the rule conditions.
-  matcher: Matcher;
-  // When specified by the rule, only events which pass the where filter
-  // will be passed to the matcher.
-  where?: EventFilter;
-  // When specified by the rule, provides a detailed message for a finding on a specific event.
-  message?: (scope: Event, event: Event) => string;
-}