@lovelaces-io/storyteller 0.3.0 → 0.3.1

package/dist/index.d.cts

@@ -254,22 +254,26 @@ type NoteEmission = StoryNote & {
     origin?: StoryOrigin;
 };
 type Emission = NoteEmission | StoryEvent;
-type AudienceMember = {
+/** The emission type an audience receives, given the kinds it hears */
+type EmissionOf<Kind extends EmissionKind> = Kind extends "note" ? NoteEmission : StoryEvent;
+/**
+ * An audience, typed by what it hears.
+ *
+ * With no `hears`, it hears stories only and `accepts`/`hear` receive a
+ * `StoryEvent` — so an audience written before live narration existed compiles
+ * unchanged, including one that hands the event to a helper typed for
+ * `StoryEvent`. `hears: ["note"]` gives `NoteEmission`; `["note", "story"]`
+ * gives the union, and the code narrows on `kind`.
+ */
+type AudienceMember<Kind extends EmissionKind = "story"> = {
     name: string;
-    /**
-     * Which emission kinds this audience wants. Defaults to `["story"]`, so an
-     * audience written before live narration existed keeps hearing only stories.
-     */
-    hears?: EmissionKind[];
-    /**
-     * Declared with method syntax deliberately. TypeScript checks method parameters
-     * bivariantly, so an audience written as `hear: (event: StoryEvent) => void`
-     * still compiles. That would be unsound if such an audience could receive a note
-     * emission — it cannot, because `hears` defaults to stories only.
-     */
-    accepts?(emission: Emission): boolean;
-    hear(emission: Emission): void | Promise<void>;
+    /** Which emission kinds this audience wants. Defaults to `["story"]`. */
+    hears?: Kind[];
+    accepts?(emission: EmissionOf<Kind>): boolean;
+    hear(emission: EmissionOf<Kind>): void | Promise<void>;
 };
+/** Any audience, whatever it hears — the shape the registry stores */
+type AnyAudienceMember = AudienceMember<EmissionKind>;
 /**
  * How a storyteller narrates.
  *
@@ -314,7 +318,7 @@ type ChapterOptions = {
 };
 type StorytellerOptions = {
     origin?: StoryOriginInput;
-    audiences?: AudienceMember[];
+    audiences?: AnyAudienceMember[];
     /** Defaults to `STORYTELLER_NARRATION`, then `collected` */
     narration?: NarrationInput;
     /**
@@ -349,18 +353,18 @@ type StorytellerOptions = {
     maxInFlight?: number;
 };
 /** Called when an audience member throws or rejects while hearing an emission */
-type AudienceErrorHandler = (error: unknown, member: AudienceMember, emission: Emission) => void;
+type AudienceErrorHandler = (error: unknown, member: AnyAudienceMember, emission: Emission) => void;
 /** Manages the set of audience members that receive story events */
 declare class AudienceRegistry {
     private members;
     /** Register an audience member, replacing any existing member with the same name */
-    add(member: AudienceMember): this;
+    add<Kind extends EmissionKind = "story">(member: AudienceMember<Kind>): this;
     /** Remove an audience member by name */
     remove(name: string): this;
     /** Return all registered audience members */
-    getAll(): AudienceMember[];
+    getAll(): AnyAudienceMember[];
     /** Return only the audience members matching the given names */
-    getOnly(names: string[]): AudienceMember[];
+    getOnly(names: string[]): AnyAudienceMember[];
     /** Check if an audience member is registered by name */
     has(name: string): boolean;
     /** List the names of all registered audience members */
@@ -570,7 +574,7 @@ type ConsoleAudienceOptions = {
  * story.audience.add(consoleAudience());
  * ```
  */
-declare function consoleAudience(options?: ConsoleAudienceOptions): AudienceMember;
+declare function consoleAudience(options?: ConsoleAudienceOptions): AudienceMember<EmissionKind>;
 
 /**
  * Create an audience that stores warn and oops stories via your insert function.
@@ -623,7 +627,7 @@ type NdjsonAudienceOptions = {
  * story.audience.add(ndjsonAudience({ stream: process.stderr }));
  * ```
  */
-declare function ndjsonAudience(options?: NdjsonAudienceOptions): AudienceMember;
+declare function ndjsonAudience(options?: NdjsonAudienceOptions): AudienceMember<EmissionKind>;
 
 type StoryReportOptions = {
     timezone?: string;
@@ -664,4 +668,4 @@ declare function summarizeContext(note: {
     error?: StoryError;
 }): string | undefined;
 
-export { ANSI, type AudienceErrorHandler, type AudienceMember, AudienceRegistry, type ChapterOptions, type ConsoleAudienceOptions, DEFAULT_REDACT_KEYS, type Emission, type EmissionKind, type FinishOptions, type FormattedReport, type JsonValue, type LevelInput, type LineWriter, type Narration, type NarrationInput, type NdjsonAudienceOptions, type NormalizeOptions, type NoteData, type NoteEmission, type OutputFormat, type PreviewOptions, REDACTED, type ReportNote, type ReportOptions, type StoryContextInput, type StoryContextValue, type StoryEmission, type StoryError, type StoryEvent, type StoryEventBase, type StoryLevel, type StoryNote, type StoryOrigin, type StoryOriginInput, type StoryPreviewOptions, type StoryReport, type StoryReportOptions, type StorySummary, type StorySummaryData, type StorySummaryNote, type StorySummaryOptions, Storyteller, type StorytellerOptions, consoleAudience, dbAudience, formatDuration, formatOrigin, formatStory, getLevelColor, meetsLevel, ndjsonAudience, normalizeError, normalizeValue, readEnvironmentValue, resolveColors, resolveMinimumLevel, resolveOutputFormat, summarizeContext, summarizeStory, toStoryLevel, useStoryteller, writeStoryReport };
+export { ANSI, type AnyAudienceMember, type AudienceErrorHandler, type AudienceMember, AudienceRegistry, type ChapterOptions, type ConsoleAudienceOptions, DEFAULT_REDACT_KEYS, type Emission, type EmissionKind, type EmissionOf, type FinishOptions, type FormattedReport, type JsonValue, type LevelInput, type LineWriter, type Narration, type NarrationInput, type NdjsonAudienceOptions, type NormalizeOptions, type NoteData, type NoteEmission, type OutputFormat, type PreviewOptions, REDACTED, type ReportNote, type ReportOptions, type StoryContextInput, type StoryContextValue, type StoryEmission, type StoryError, type StoryEvent, type StoryEventBase, type StoryLevel, type StoryNote, type StoryOrigin, type StoryOriginInput, type StoryPreviewOptions, type StoryReport, type StoryReportOptions, type StorySummary, type StorySummaryData, type StorySummaryNote, type StorySummaryOptions, Storyteller, type StorytellerOptions, consoleAudience, dbAudience, formatDuration, formatOrigin, formatStory, getLevelColor, meetsLevel, ndjsonAudience, normalizeError, normalizeValue, readEnvironmentValue, resolveColors, resolveMinimumLevel, resolveOutputFormat, summarizeContext, summarizeStory, toStoryLevel, useStoryteller, writeStoryReport };

package/dist/index.d.ts

@@ -254,22 +254,26 @@ type NoteEmission = StoryNote & {
     origin?: StoryOrigin;
 };
 type Emission = NoteEmission | StoryEvent;
-type AudienceMember = {
+/** The emission type an audience receives, given the kinds it hears */
+type EmissionOf<Kind extends EmissionKind> = Kind extends "note" ? NoteEmission : StoryEvent;
+/**
+ * An audience, typed by what it hears.
+ *
+ * With no `hears`, it hears stories only and `accepts`/`hear` receive a
+ * `StoryEvent` — so an audience written before live narration existed compiles
+ * unchanged, including one that hands the event to a helper typed for
+ * `StoryEvent`. `hears: ["note"]` gives `NoteEmission`; `["note", "story"]`
+ * gives the union, and the code narrows on `kind`.
+ */
+type AudienceMember<Kind extends EmissionKind = "story"> = {
     name: string;
-    /**
-     * Which emission kinds this audience wants. Defaults to `["story"]`, so an
-     * audience written before live narration existed keeps hearing only stories.
-     */
-    hears?: EmissionKind[];
-    /**
-     * Declared with method syntax deliberately. TypeScript checks method parameters
-     * bivariantly, so an audience written as `hear: (event: StoryEvent) => void`
-     * still compiles. That would be unsound if such an audience could receive a note
-     * emission — it cannot, because `hears` defaults to stories only.
-     */
-    accepts?(emission: Emission): boolean;
-    hear(emission: Emission): void | Promise<void>;
+    /** Which emission kinds this audience wants. Defaults to `["story"]`. */
+    hears?: Kind[];
+    accepts?(emission: EmissionOf<Kind>): boolean;
+    hear(emission: EmissionOf<Kind>): void | Promise<void>;
 };
+/** Any audience, whatever it hears — the shape the registry stores */
+type AnyAudienceMember = AudienceMember<EmissionKind>;
 /**
  * How a storyteller narrates.
  *
@@ -314,7 +318,7 @@ type ChapterOptions = {
 };
 type StorytellerOptions = {
     origin?: StoryOriginInput;
-    audiences?: AudienceMember[];
+    audiences?: AnyAudienceMember[];
     /** Defaults to `STORYTELLER_NARRATION`, then `collected` */
     narration?: NarrationInput;
     /**
@@ -349,18 +353,18 @@ type StorytellerOptions = {
     maxInFlight?: number;
 };
 /** Called when an audience member throws or rejects while hearing an emission */
-type AudienceErrorHandler = (error: unknown, member: AudienceMember, emission: Emission) => void;
+type AudienceErrorHandler = (error: unknown, member: AnyAudienceMember, emission: Emission) => void;
 /** Manages the set of audience members that receive story events */
 declare class AudienceRegistry {
     private members;
     /** Register an audience member, replacing any existing member with the same name */
-    add(member: AudienceMember): this;
+    add<Kind extends EmissionKind = "story">(member: AudienceMember<Kind>): this;
     /** Remove an audience member by name */
     remove(name: string): this;
     /** Return all registered audience members */
-    getAll(): AudienceMember[];
+    getAll(): AnyAudienceMember[];
     /** Return only the audience members matching the given names */
-    getOnly(names: string[]): AudienceMember[];
+    getOnly(names: string[]): AnyAudienceMember[];
     /** Check if an audience member is registered by name */
     has(name: string): boolean;
     /** List the names of all registered audience members */
@@ -570,7 +574,7 @@ type ConsoleAudienceOptions = {
  * story.audience.add(consoleAudience());
  * ```
  */
-declare function consoleAudience(options?: ConsoleAudienceOptions): AudienceMember;
+declare function consoleAudience(options?: ConsoleAudienceOptions): AudienceMember<EmissionKind>;
 
 /**
  * Create an audience that stores warn and oops stories via your insert function.
@@ -623,7 +627,7 @@ type NdjsonAudienceOptions = {
  * story.audience.add(ndjsonAudience({ stream: process.stderr }));
  * ```
  */
-declare function ndjsonAudience(options?: NdjsonAudienceOptions): AudienceMember;
+declare function ndjsonAudience(options?: NdjsonAudienceOptions): AudienceMember<EmissionKind>;
 
 type StoryReportOptions = {
     timezone?: string;
@@ -664,4 +668,4 @@ declare function summarizeContext(note: {
     error?: StoryError;
 }): string | undefined;
 
-export { ANSI, type AudienceErrorHandler, type AudienceMember, AudienceRegistry, type ChapterOptions, type ConsoleAudienceOptions, DEFAULT_REDACT_KEYS, type Emission, type EmissionKind, type FinishOptions, type FormattedReport, type JsonValue, type LevelInput, type LineWriter, type Narration, type NarrationInput, type NdjsonAudienceOptions, type NormalizeOptions, type NoteData, type NoteEmission, type OutputFormat, type PreviewOptions, REDACTED, type ReportNote, type ReportOptions, type StoryContextInput, type StoryContextValue, type StoryEmission, type StoryError, type StoryEvent, type StoryEventBase, type StoryLevel, type StoryNote, type StoryOrigin, type StoryOriginInput, type StoryPreviewOptions, type StoryReport, type StoryReportOptions, type StorySummary, type StorySummaryData, type StorySummaryNote, type StorySummaryOptions, Storyteller, type StorytellerOptions, consoleAudience, dbAudience, formatDuration, formatOrigin, formatStory, getLevelColor, meetsLevel, ndjsonAudience, normalizeError, normalizeValue, readEnvironmentValue, resolveColors, resolveMinimumLevel, resolveOutputFormat, summarizeContext, summarizeStory, toStoryLevel, useStoryteller, writeStoryReport };
+export { ANSI, type AnyAudienceMember, type AudienceErrorHandler, type AudienceMember, AudienceRegistry, type ChapterOptions, type ConsoleAudienceOptions, DEFAULT_REDACT_KEYS, type Emission, type EmissionKind, type EmissionOf, type FinishOptions, type FormattedReport, type JsonValue, type LevelInput, type LineWriter, type Narration, type NarrationInput, type NdjsonAudienceOptions, type NormalizeOptions, type NoteData, type NoteEmission, type OutputFormat, type PreviewOptions, REDACTED, type ReportNote, type ReportOptions, type StoryContextInput, type StoryContextValue, type StoryEmission, type StoryError, type StoryEvent, type StoryEventBase, type StoryLevel, type StoryNote, type StoryOrigin, type StoryOriginInput, type StoryPreviewOptions, type StoryReport, type StoryReportOptions, type StorySummary, type StorySummaryData, type StorySummaryNote, type StorySummaryOptions, Storyteller, type StorytellerOptions, consoleAudience, dbAudience, formatDuration, formatOrigin, formatStory, getLevelColor, meetsLevel, ndjsonAudience, normalizeError, normalizeValue, readEnvironmentValue, resolveColors, resolveMinimumLevel, resolveOutputFormat, summarizeContext, summarizeStory, toStoryLevel, useStoryteller, writeStoryReport };

package/dist/index.js

@@ -1160,10 +1160,9 @@ function dbAudience(insert) {
   return {
     name: "db",
     hears: ["story"],
-    accepts: (emission) => emission.kind === "story" && (emission.level === "Warning" || emission.level === "Error"),
-    hear: async (emission) => {
-      if (emission.kind !== "story") return;
-      await insert(emission);
+    accepts: (event) => event.level === "Warning" || event.level === "Error",
+    hear: async (event) => {
+      await insert(event);
     }
   };
 }