chore: Improve types (#428)

Author: offirgolan

packages/@pollyjs/adapter-fetch/types.d.ts

@@ -1,3 +1,5 @@
 import Adapter from '@pollyjs/adapter';
 
-export default class FetchAdapter extends Adapter {}
+export default class FetchAdapter extends Adapter<{
+  context?: any;
+}> {}

packages/@pollyjs/adapter-puppeteer/types.d.ts

@@ -1,3 +1,6 @@
 import Adapter from '@pollyjs/adapter';
 
-export default class PuppeteerAdapter extends Adapter {}
+export default class PuppeteerAdapter extends Adapter<{
+  page: any;
+  requestResourceTypes?: string[];
+}> {}

packages/@pollyjs/adapter-xhr/types.d.ts

@@ -1,3 +1,5 @@
 import Adapter from '@pollyjs/adapter';
 
-export default class XHRAdapter extends Adapter {}
+export default class XHRAdapter extends Adapter<{
+  context?: any;
+}> {}

packages/@pollyjs/adapter/types.d.ts

@@ -1,14 +1,46 @@
-import { Headers, Request } from '@pollyjs/core';
+import { Polly, Headers, Request, Interceptor } from '@pollyjs/core';
 
-export default class Adapter {
+export default class Adapter<
+  TOptions extends {} = {},
+  TRequestArguments = any
+> {
   static readonly id: string;
   static readonly type: string;
-  readonly options: { [key: string]: any };
-  connect(): void;
-  disconnect(): void;
+  polly: Polly;
+  isConnected: boolean;
+  readonly defaultOptions: TOptions;
+  readonly options: TOptions;
+  persister: Polly['persister'];
+  connect: () => void;
+  onConnect: () => void;
+  disconnect: () => void;
+  onDisconnect: () => void;
+  timeout: (request: Request, options: { time: number }) => Promise<void>;
+  handleRequest: (request: {
+    url: string;
+    method: string;
+    headers: Headers;
+    body: string;
+    requestArguments?: TRequestArguments;
+  }) => Promise<Request>;
+  passthrough: (request: Request) => Promise<void>;
+  onIntercept: (request: Request, interceptor: Interceptor) => Promise<void>;
+  intercept: (request: Request, interceptor: Interceptor) => Promise<void>;
+  onRecord: (request: Request) => Promise<void>;
+  record: (request: Request) => Promise<void>;
+  onReplay: (request: Request) => Promise<void>;
+  replay: (request: Request) => Promise<void>;
+  assert: (message: string, condition?: boolean) => void;
+  onPassthrough: (request: Request) => Promise<void>;
   passthroughRequest(pollyRequest: Request): Promise<{
     statusCode: number;
     headers: Headers;
     body: string;
+    encoding?: string;
   }>;
+  respondToRequest: (request: Request, error?: Error) => Promise<void>;
+  onIdentifyRequest: (request: Request) => Promise<void>;
+  onRequest: (request: Request) => Promise<void>;
+  onRequestFinished: (request: Request) => Promise<void>;
+  onRequestFailed: (request: Request) => Promise<void>;
 }

packages/@pollyjs/core/types.d.ts

@@ -1,6 +1,6 @@
 import Adapter from '@pollyjs/adapter';
 import Persister from '@pollyjs/persister';
-import { LogLevelDesc } from 'loglevel';
+import { Logger, LogLevelDesc } from 'loglevel';
 
 export type MODE = 'record' | 'replay' | 'passthrough' | 'stopped';
 export type ACTION = 'record' | 'replay' | 'intercept' | 'passthrough';
@@ -98,6 +98,8 @@ export interface HTTPBase {
   jsonBody(): any;
 }
 
+export type RequestEvent = 'identify';
+
 export interface Request extends HTTPBase {
   method: string;
   url: string;
@@ -109,29 +111,35 @@ export interface Request extends HTTPBase {
   hash: string;
   query: { [key: string]: string | string[] };
   readonly params: { [key: string]: string };
+  readonly log: Logger;
+  readonly requestArguments: any;
   recordingName: string;
+  recordingId: string;
   responseTime?: number | undefined;
   timestamp?: string | undefined;
   didRespond: boolean;
   id?: string | undefined;
   order?: number | undefined;
   action: ACTION | null;
+  aborted: boolean;
+  promise: Promise<void>;
+  configure(config: Partial<PollyConfig>): void;
+  overrideRecordingName(recordingName: string): void;
+  on(event: RequestEvent, listener: RequestEventListener): this;
+  once(event: RequestEvent, listener: RequestEventListener): this;
+  off(event: RequestEvent, listener?: RequestEventListener): this;
 }
 export interface Response extends HTTPBase {
   statusCode: number;
-  isBinary: boolean;
+  encoding: string | undefined;
   readonly statusText: string;
   readonly ok: boolean;
 
   status(status: number): this;
   sendStatus(status: number): this;
   end(): Readonly<this>;
 }
-export interface Interceptor {
-  abort(): void;
-  passthrough(): void;
-  stopPropagation(): void;
-}
+
 export type RequestRouteEvent = 'request';
 export type RecordingRouteEvent = 'beforeReplay' | 'beforePersist';
 export type ResponseRouteEvent = 'beforeResponse' | 'response';
@@ -142,6 +150,10 @@ export interface ListenerEvent {
   readonly type: string;
   stopPropagation: () => void;
 }
+export interface Interceptor extends ListenerEvent {
+  abort(): void;
+  passthrough(): void;
+}
 export type ErrorEventListener = (
   req: Request,
   error: any,
@@ -205,7 +217,7 @@ export class RouteHandler {
   passthrough(value?: boolean): RouteHandler;
   intercept(fn: InterceptHandler): RouteHandler;
   recordingName(recordingName?: string): RouteHandler;
-  configure(config: PollyConfig): RouteHandler;
+  configure(config: Partial<PollyConfig>): RouteHandler;
   times(n?: number): RouteHandler;
 }
 export class PollyServer {
@@ -222,6 +234,15 @@ export class PollyServer {
   host(host: string, callback: () => void): void;
   namespace(path: string, callback: () => void): void;
 }
+export class PollyLogger {
+  polly: Polly;
+  log: Logger;
+  connect: () => void;
+  disconnect: () => void;
+  logRequest: (request: Request) => void;
+  logRequestResponse: (request: Request) => void;
+  logRequestError: (request: Request, error: Error) => void;
+}
 export type PollyEvent = 'create' | 'stop' | 'register';
 export type PollyEventListener = (poll: Polly) => void;
 export class Polly {
@@ -241,6 +262,9 @@ export class Polly {
   persister: Persister | null;
   adapters: Map<string, Adapter>;
   config: PollyConfig;
+  logger: PollyLogger;
+
+  private _requests: Request[];
 
   pause(): void;
   play(): void;
@@ -249,7 +273,7 @@ export class Polly {
   passthrough(): void;
   stop(): Promise<void>;
   flush(): Promise<void>;
-  configure(config: PollyConfig): void;
+  configure(config: Partial<PollyConfig>): void;
   connectTo(name: string | typeof Adapter): void;
   disconnectFrom(name: string | typeof Adapter): void;
   disconnect(): void;

packages/@pollyjs/persister-fs/types.d.ts

@@ -1,3 +1,5 @@
 import Persister from '@pollyjs/persister';
 
-export default class FSPersister extends Persister {}
+export default class FSPersister extends Persister<{
+  recordingsDir?: string;
+}> {}

packages/@pollyjs/persister-local-storage/types.d.ts

@@ -1,3 +1,6 @@
 import Persister from '@pollyjs/persister';
 
-export default class LocalStoragePersister extends Persister {}
+export default class LocalStoragePersister extends Persister<{
+  context?: any;
+  key?: string;
+}> {}

packages/@pollyjs/persister-rest/types.d.ts

@@ -1,3 +1,6 @@
 import Persister from '@pollyjs/persister';
 
-export default class RESTPersister extends Persister {}
+export default class RESTPersister extends Persister<{
+  host?: string;
+  apiNamespace?: string;
+}> {}

packages/@pollyjs/persister/types.d.ts

@@ -1,6 +1,90 @@
-export default class Persister {
+import { Polly, Request } from '@pollyjs/core';
+import { Cookie } from 'set-cookie-parser';
+
+type NVObject = { name: string; value: string };
+
+export interface HarRequest {
+  httpVersion: string;
+  url: string;
+  method: string;
+  headers: NVObject[];
+  headersSize: number;
+  queryString: NVObject[];
+  cookies: Cookie[];
+  postData?: {
+    mimeType: string;
+    params: [];
+    text?: string;
+  };
+  bodySize?: number;
+}
+
+export interface HarResponse {
+  httpVersion: string;
+  status: number;
+  statusText: string;
+  headers: NVObject[];
+  headersSize: number;
+  cookies: Cookie[];
+  content: {
+    mimeType: string;
+    text?: string;
+    encoding?: string;
+    size?: number;
+  };
+  bodySize?: number;
+}
+
+export interface HarEntry {
+  _id: string;
+  _order: number;
+  startedDateTime: string;
+  requests: HarRequest;
+  response: HarResponse;
+  cache: {};
+  timings: {
+    blocked: number;
+    dns: number;
+    connect: number;
+    send: number;
+    wait: number;
+    receive: number;
+    ssl: number;
+  };
+  time: number;
+}
+
+export interface HarLog {
+  version: string;
+  browser: string;
+  entries: HarEntry[];
+  pages: [];
+  addEntries: (entries: HarEntry[]) => void;
+  sortEntries: () => void;
+}
+
+export interface Har {
+  log: HarLog;
+}
+
+export default class Persister<TOptions extends {} = {}> {
   static readonly id: string;
   static readonly type: string;
-  readonly options: { [key: string]: any };
-  persist(): Promise<void>;
+  readonly defaultOptions: TOptions;
+  readonly options: TOptions;
+  private pending: Map<string, { name: string; recordings: Request[] }>;
+  private _cache: Map<string, Har>;
+  polly: Polly;
+  hasPending: boolean;
+  persist: () => Promise<void>;
+  recordRequest: (request: Request) => void;
+  find: (recordingId: string) => Promise<Har | null>;
+  save: (recordingId: string, har: Har) => Promise<void>;
+  delete: (recordingId: string) => Promise<void>;
+  findEntry: (request: Request) => Promise<HarEntry | null>;
+  stringify: (value: any) => string;
+  assert: (message: string, condition?: boolean) => void;
+  findRecording: (recordingId: string) => Promise<Har | null>;
+  saveRecording: (recordingId: string, har: Har) => Promise<void>;
+  deleteRecording: (recordingId: string) => Promise<void>;
 }