Class CodeGenReporter

Singleton reporter for CodeGen runs. Holds state for a single run at a time; call startRun() to begin, endRun() to emit and reset.

Hierarchy (View Summary)

BaseSingleton<CodeGenReporter>
- CodeGenReporter

Index

Constructors

`Protected`constructor

new CodeGenReporter(): CodeGenReporter
Returns CodeGenReporter
Overrides BaseSingleton.constructor
- Defined in CodeGenLib/src/Misc/codegen-reporter.ts:155

Accessors

GlobalKey

get GlobalKey(): string
Returns string
Inherited from BaseSingleton.GlobalKey
- Defined in MJGlobal/dist/BaseSingleton.d.ts:9

IsActive

get IsActive(): boolean
True if a run is currently in progress.

Returns boolean
- Defined in CodeGenLib/src/Misc/codegen-reporter.ts:180

`Static`Instance

get Instance(): CodeGenReporter
Returns CodeGenReporter
- Defined in CodeGenLib/src/Misc/codegen-reporter.ts:159

Methods

counter

counter(name: string, delta?: number): void
Increment a named counter (default 1). Unknown counter names are allowed.
Parameters
- name: string
- delta: number = 1
Returns void
- Defined in CodeGenLib/src/Misc/codegen-reporter.ts:301

endRun

endRun(
success: boolean,
): Promise<{ filePath: string | null; report: RunReport | null }>
Finalize the run, write the JSON report to disk, and reset state. Returns the written file path (or null) and the report object.

Safe to call even if startRun() wasn't called (becomes a no-op).
Parameters
- success: boolean
Returns Promise<{ filePath: string | null; report: RunReport | null }>
- Defined in CodeGenLib/src/Misc/codegen-reporter.ts:348

entityPhase

entityPhase<T>(
    entityName: string,
    phaseName: string,
    fn: () => Promise<T>,
): Promise<T>
Wrap per-entity work. Accumulates total time and sub-phase time on the entity record. Also sets the "current entity" so LLM calls recorded inside this block get attributed correctly.
Type Parameters
- T
Parameters
- entityName: string
- phaseName: string
- fn: () => Promise<T>
Returns Promise<T>
- Defined in CodeGenLib/src/Misc/codegen-reporter.ts:243

flagEntity

flagEntity(
    entityName: string,
    flag: "new" | "modified" | "regenerated",
    value?: boolean,
): void
Flag an entity's change status. Used for attribution in the report.
Parameters
- entityName: string
- flag: "new" | "modified" | "regenerated"
- value: boolean = true
Returns void
- Defined in CodeGenLib/src/Misc/codegen-reporter.ts:326

GetGlobalObjectStore

GetGlobalObjectStore(): GlobalObjectStore | null
The Global Object Store is a place to store global objects that need to be shared across the application. Depending on the execution environment, this could be the window object in a browser, or the global object in a node environment, or something else in other contexts. The key here is that in some cases static variables are not truly shared because it is possible that a given class might have copies of its code in multiple paths in a deployed application. This approach ensures that no matter how many code copies might exist, there is only one instance of the object in question by using the Global Object Store.

Returns GlobalObjectStore | null
Inherited from BaseSingleton.GetGlobalObjectStore
- Defined in MJGlobal/dist/BaseSingleton.d.ts:26

mark

mark(key: string, value: unknown): void
Set a one-time context value (platform, mjVersion, etc.).
Parameters
- key: string
- value: unknown
Returns void
- Defined in CodeGenLib/src/Misc/codegen-reporter.ts:320

note

note(message: string): void
Append a free-form note (warnings, unexpected conditions, etc.).
Parameters
- message: string
Returns void
- Defined in CodeGenLib/src/Misc/codegen-reporter.ts:333

phase

phase<T>(name: string, fn: () => Promise<T>): Promise<T>
Wrap an async block as a named phase. Phases nest automatically: any phases started while another is open are recorded as its children.

If no run is active this becomes a pass-through — safe to call unconditionally.
Type Parameters
- T
Parameters
- name: string
- fn: () => Promise<T>
Returns Promise<T>
- Defined in CodeGenLib/src/Misc/codegen-reporter.ts:210

recordLLMCall

recordLLMCall(
    call: {
        costUSD?: number;
        entityName?: string | null;
        latencyMs: number;
        model?: string | null;
        promptName: string;
        tokensIn?: number;
        tokensOut?: number;
    },
): void
Record a single LLM call. Attribution falls back to the entity set by the most recent entityPhase() if the caller doesn't supply one.
Parameters
- call: {
      costUSD?: number;
      entityName?: string | null;
      latencyMs: number;
      model?: string | null;
      promptName: string;
      tokensIn?: number;
      tokensOut?: number;
  }
Returns void
- Defined in CodeGenLib/src/Misc/codegen-reporter.ts:267

snapshot

snapshot(): RunReport
Get the current in-memory report (snapshot). Mostly for tests.

Returns RunReport
- Defined in CodeGenLib/src/Misc/codegen-reporter.ts:389

spCallCounter

spCallCounter(spName: string, delta?: number): void
Increment a specific stored-procedure call count.
Parameters
- spName: string
- delta: number = 1
Returns void
- Defined in CodeGenLib/src/Misc/codegen-reporter.ts:313

startRun

startRun(): void
Begin capturing a new run. Resets all state from any prior run.

Returns void
- Defined in CodeGenLib/src/Misc/codegen-reporter.ts:185

`Protected` `Static`getInstance

getInstance<T extends BaseSingleton<unknown>>(
this: new () => T,
className?: string,
): T
Returns the singleton instance of the class. If the instance does not exist, it is created and stored in the Global Object Store. If className is provided it will be used as part of the key in the Global Object Store, otherwise the actual class name will be used. NOTE: the class name used by default is the lowest level of the object hierarchy, so if you have a class that extends another class, the lowest level class name will be used.
Type Parameters
- T extends BaseSingleton<unknown>
Parameters
- this: new () => T
- OptionalclassName: string
Returns T
Inherited from BaseSingleton.getInstance
- Defined in MJGlobal/dist/BaseSingleton.d.ts:20

`Static`listRuns

listRuns(limit?: number): Promise<RunSummary[]>
List recent runs, newest first, with compact summaries.
Parameters
- Optionallimit: number
Returns Promise<RunSummary[]>
- Defined in CodeGenLib/src/Misc/codegen-reporter.ts:502

`Static`loadRun

loadRun(runIdOrFile: string): Promise<RunReport | null>
Load a single run by file name OR run id. Returns null if not found.
Parameters
- runIdOrFile: string
Returns Promise<RunReport | null>
- Defined in CodeGenLib/src/Misc/codegen-reporter.ts:538

`Static`printSummary

printSummary(report: RunReport): void
Print a human-readable summary of the completed run to stdout. Call after endRun() — operates on the saved report.
Parameters
- report: RunReport
Returns void
- Defined in CodeGenLib/src/Misc/codegen-reporter.ts:415

`Static`pruneOldRuns

pruneOldRuns(): Promise<void>
Prune ~/.mj/codegen-state/ to the most recent MAX_RETAINED_RUNS files. Non-fatal on errors.

Returns Promise<void>
- Defined in CodeGenLib/src/Misc/codegen-reporter.ts:556

`Static`stateDir

stateDir(): string
The directory where run JSON files are stored.

Returns string
- Defined in CodeGenLib/src/Misc/codegen-reporter.ts:497

Class CodeGenReporter

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

Protectedconstructor

Returns CodeGenReporter

Accessors

GlobalKey

Returns string

IsActive

Returns boolean

StaticInstance

Returns CodeGenReporter

Methods

counter

Parameters

Returns void

endRun

Parameters

Returns Promise<{ filePath: string | null; report: RunReport | null }>

entityPhase

Type Parameters

Parameters

Returns Promise<T>

flagEntity

Parameters

Returns void

GetGlobalObjectStore

Returns GlobalObjectStore | null

mark

Parameters

Returns void

note

Parameters

Returns void

phase

Type Parameters

Parameters

Returns Promise<T>

recordLLMCall

Parameters

Returns void

snapshot

Returns RunReport

spCallCounter

Parameters

Returns void

startRun

Returns void

Protected StaticgetInstance

Type Parameters

Parameters

Returns T

StaticlistRuns

Parameters

Returns Promise<RunSummary[]>

StaticloadRun

Parameters

Returns Promise<RunReport | null>

StaticprintSummary

Parameters

Returns void

StaticpruneOldRuns

Returns Promise<void>

StaticstateDir

Returns string

Settings

On This Page

`Protected`constructor

`Static`Instance

`Protected` `Static`getInstance

`Static`listRuns

`Static`loadRun

`Static`printSummary

`Static`pruneOldRuns

`Static`stateDir