@nwire/scan 0.12.0 → 0.13.0

package/dist/ast-extract.d.ts

@@ -0,0 +1,71 @@
+/**
+ * Static AST discovery (Phase 0) — extract `defineEvent` + `defineAction`
+ * declarations from source WITHOUT booting the app. "Scan the graph, not the
+ * runtime." Uses the TypeScript compiler API (already a `@nwire/scan` dep) to
+ * parse each file; reads name, `.public()`, `emits`, literal metadata, and
+ * source location straight off the AST node positions.
+ *
+ * Runs ALONGSIDE the jiti scanner — the equivalence harness diffs the two
+ * manifests. Anything not statically analyzable (computed name, dynamic
+ * `emits`) is recorded in `unanalyzable`, never silently dropped (plan §2,
+ * Law 2). Covers events, actions, actors, projections, queries, and
+ * workflows (including the workflow closure edge-walk and the projection /
+ * workflow event-graph edges).
+ */
+import type { ActionEntry, ActorEntry, CommandEntry, CronEntry, ErrorEntry, EventEntry, EventGraphEdge, ExternalCallEntry, InboundWebhookEntry, InboxEntry, OutboxEntry, ProjectionEntry, QueryEntry, ResourceEntry, SourceLocationEntry, WorkflowEntry } from "./scan.js";
+/** A `config/*.ts` module — its file and the top-level config field names it exposes. */
+export interface ConfigModuleEntry {
+    readonly file: string;
+    readonly keys: readonly string[];
+}
+/** A `defineSchema` declaration — the actor's data/key/states shape. */
+export interface SchemaEntry {
+    readonly name: string;
+    readonly app: string;
+    readonly key?: string;
+    readonly states: readonly string[];
+    readonly source?: SourceLocationEntry;
+}
+export interface UnanalyzableEntry {
+    readonly kind: "event" | "action" | "actor" | "projection" | "query" | "workflow" | "command" | "cron" | "externalCall" | "inboundWebhook" | "outbox" | "inbox" | "resource" | "error" | "schema";
+    readonly reason: string;
+    readonly source: SourceLocationEntry;
+}
+export interface AstExtract {
+    readonly events: EventEntry[];
+    readonly actions: ActionEntry[];
+    readonly actors: ActorEntry[];
+    readonly projections: ProjectionEntry[];
+    readonly queries: QueryEntry[];
+    readonly workflows: WorkflowEntry[];
+    readonly commands: CommandEntry[];
+    readonly crons: CronEntry[];
+    readonly externalCalls: ExternalCallEntry[];
+    readonly inboundWebhooks: InboundWebhookEntry[];
+    readonly outboxes: OutboxEntry[];
+    readonly inboxes: InboxEntry[];
+    readonly resources: ResourceEntry[];
+    readonly errors: ErrorEntry[];
+    readonly schemas: SchemaEntry[];
+    /** Environment variable names the app's source reads (sorted, de-duped). */
+    readonly env: string[];
+    /** Config modules discovered under a `config/` directory (file + top-level keys). */
+    readonly config: ConfigModuleEntry[];
+    readonly unanalyzable: UnanalyzableEntry[];
+    /** Event-graph edges (`folds` / `subscribes` / `dispatches`), mirroring the jiti scanner. */
+    readonly graph: {
+        readonly events: EventGraphEdge[];
+    };
+}
+/**
+ * Extract `defineEvent` + `defineAction` from a set of source files. Two
+ * passes: events first (so `emits` identifiers can resolve to event names),
+ * then actions.
+ */
+export declare function extractFromFiles(files: readonly string[], app?: string): AstExtract;
+/**
+ * Discover config modules: any parsed file living in a `config/` directory.
+ * Captures each module's top-level config field names (best-effort), sorted by
+ * file so the output is stable.
+ */
+export declare function collectConfigModules(files: readonly string[]): ConfigModuleEntry[];