@expo/event-log 0.0.1-init

package/dist/event-log.d.ts

@@ -0,0 +1,142 @@
+type Prettify<T> =
+  T extends Record<string, unknown>
+    ? {
+        [K in keyof T]: T[K];
+      }
+    : T;
+type ReservedPayloadKeys = '_e' | '_t' | '_d' | '_w';
+type ValidPayload<Payload> =
+  Extract<keyof Payload, ReservedPayloadKeys> extends never ? Prettify<Payload> : never;
+interface EventRegistry {
+  'root:init': {
+    format: 'v0-jsonl' | (string & {});
+    formatVersion: number;
+    version: string;
+  };
+}
+type EventKeys = Extract<keyof EventRegistry, string>;
+type EventByKey<Key extends EventKeys> = Prettify<
+  {
+    key: Key;
+  } & EventRegistry[Key]
+>;
+type AllEvents = {
+  [K in EventKeys]: EventByKey<K>;
+}[EventKeys];
+type EventNamesFor<Category extends string> = EventKeys extends infer K
+  ? K extends `${Category}:${infer Name}`
+    ? Name
+    : never
+  : never;
+type EventPayload<
+  Category extends string,
+  Name extends string,
+> = `${Category}:${Name}` extends EventKeys
+  ? ValidPayload<EventRegistry[`${Category}:${Name}`]>
+  : never;
+interface SpanEnd<Category extends string> {
+  <Name extends EventNamesFor<Category>>(event: Name, data: EventPayload<Category, Name>): void;
+}
+interface EventLogger<Category extends string> {
+  <Name extends EventNamesFor<Category>>(event: Name, data: EventPayload<Category, Name>): void;
+  span<Name extends EventNamesFor<Category>>(
+    event: Name,
+    data: EventPayload<Category, Name>
+  ): SpanEnd<Category>;
+  path(target: string): string;
+  path(target: string | null | undefined): string | null;
+  readonly category: Category;
+}
+interface ParsedEvent {
+  _e: string;
+  _t: number;
+  _d?: number;
+  _w?: string;
+  [key: string]: unknown;
+}
+
+declare function events<const Category extends string>(category: Category): EventLogger<Category>;
+
+interface EventLoggerInfo {
+  destination: 'file' | 'stdout' | 'stderr' | 'fd' | 'session' | 'ipc';
+  isUserVisibleOutput: boolean;
+  file?: string;
+  fd?: number;
+  sessionDir?: string;
+}
+
+interface SessionOptions {
+  command?: string;
+  version?: string;
+  maxSegments?: number;
+  maxSegmentSize?: number;
+}
+interface SessionMeta {
+  pid: number;
+  formatVersion: number;
+  startedAt: number;
+  command: string;
+  cwd: string;
+  maxSegments: number;
+  version?: string;
+  socket: string;
+  ipcSocket: string;
+  origin: {
+    argv: string[];
+    execPath: string;
+    cwd: string;
+    ppid?: number;
+    env?: {
+      npmLifecycleEvent?: string;
+      npmExecPath?: string;
+      npmPackageName?: string;
+    };
+  };
+}
+interface InstallEventLoggerOptions extends SessionOptions {}
+declare function installEventLogger(
+  targetOrOptions?: string | number | InstallEventLoggerOptions
+): void;
+declare const isEventLoggerActive: () => EventLoggerInfo | null;
+
+interface ListedSession {
+  id: string;
+  pid: number;
+  formatVersion: number;
+  alive: boolean;
+  startedAt: number;
+  command: string;
+  cwd: string;
+  version?: string;
+  origin?: SessionMeta['origin'];
+  sessionDir: string;
+}
+interface ListSessionsOptions {
+  selector?: string;
+}
+interface TapOptions {
+  since?: number | string | Date;
+  follow?: boolean;
+  filter?: string | string[];
+  signal?: AbortSignal;
+  timeout?: number;
+  idleTimeout?: number;
+}
+declare function listSessions(options?: ListSessionsOptions): Promise<ListedSession[]>;
+declare function tap(sessionDir: string, options?: TapOptions): AsyncIterable<ParsedEvent>;
+
+export { events, installEventLogger, isEventLoggerActive, listSessions as list, tap };
+export type {
+  AllEvents,
+  EventByKey,
+  EventKeys,
+  EventLogger,
+  EventLoggerInfo,
+  EventRegistry,
+  InstallEventLoggerOptions,
+  ListSessionsOptions,
+  ListedSession,
+  ParsedEvent,
+  SpanEnd,
+  TapOptions,
+};