Skip to content

Commit ecf2294

Browse files
phryneasjerelmiller
phryneas
authored and
jerelmiller
committed
chores
1 parent e62573c commit ecf2294

File tree

3 files changed

+304
-0
lines changed

3 files changed

+304
-0
lines changed

‎.api-reports/api-report-testing_internal.api.md‎

Lines changed: 279 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,279 @@
1+
## API Report File for "@apollo/client"
2+
3+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4+
5+
```ts
6+
7+
import type { ApolloClient } from '@apollo/client/core';
8+
import { ApolloLink } from '@apollo/client/core';
9+
import type { ApolloPayloadResult } from '@apollo/client/core';
10+
import { FetchResult } from '@apollo/client/core';
11+
import type { GraphQLFormattedError } from 'graphql-17-alpha2';
12+
import { GraphQLRequest } from '@apollo/client/core';
13+
import { HttpLink } from '@apollo/client/link/http';
14+
import type { InitialIncrementalExecutionResult } from 'graphql-17-alpha2';
15+
import type { MaskedDocumentNode } from '@apollo/client/masking';
16+
import type { MockedProviderProps } from '@apollo/client/testing/react';
17+
import type { MockedResponse } from '@apollo/client/testing/core';
18+
import type { Observable } from 'rxjs';
19+
import type { Queries } from '@testing-library/dom';
20+
import type { queries } from '@testing-library/dom';
21+
import * as React_2 from 'react';
22+
import type * as ReactDOMClient from 'react-dom/client';
23+
import type { RenderHookOptions } from '@testing-library/react';
24+
import type { RenderHookResult } from '@testing-library/react';
25+
import type { RenderOptions } from '@testing-library/react';
26+
import type { RenderResult } from '@testing-library/react';
27+
import { ResultFunction } from '@apollo/client/testing/core';
28+
import type { Subscribable } from 'rxjs';
29+
import type { SubsequentIncrementalExecutionResult } from 'graphql-17-alpha2';
30+
import type { TypedDocumentNode } from '@apollo/client/core';
31+
32+
// @public (undocumented)
33+
export function actAsync<T>(scope: () => T | Promise<T>): Promise<T>;
34+
35+
// @public (undocumented)
36+
export function addDelayToMocks<T extends MockedResponse<unknown>[]>(mocks: T, delay?: number, override?: boolean): {
37+
delay: number;
38+
request: GraphQLRequest<Record<string, any>>;
39+
maxUsageCount?: number;
40+
result?: FetchResult<unknown> | ResultFunction<FetchResult<unknown>, Record<string, any>> | undefined;
41+
error?: Error;
42+
variableMatcher?: ((arg: Record<string, any>) => boolean) | undefined;
43+
newData?: ResultFunction<FetchResult<unknown>, Record<string, any>> | undefined;
44+
}[];
45+
46+
// @public (undocumented)
47+
type ConsoleMethod = "log" | "info" | "warn" | "error" | "debug";
48+
49+
// @public (undocumented)
50+
export function createClientWrapper(client: ApolloClient, Wrapper?: React_2.JSXElementConstructor<{
51+
children: React_2.ReactNode;
52+
}>): React_2.JSXElementConstructor<{
53+
children: React_2.ReactNode;
54+
}>;
55+
56+
// @public (undocumented)
57+
export function createMockWrapper(renderOptions: MockedProviderProps, Wrapper?: React_2.JSXElementConstructor<{
58+
children: React_2.ReactNode;
59+
}>): React_2.JSXElementConstructor<{
60+
children: React_2.ReactNode;
61+
}>;
62+
63+
// @public (undocumented)
64+
export function enableFakeTimers(config?: FakeTimersConfig | LegacyFakeTimersConfig): Disposable;
65+
66+
// @public (undocumented)
67+
type HydrateableContainer = Parameters<(typeof ReactDOMClient)["hydrateRoot"]>[0];
68+
69+
// @public (undocumented)
70+
type HydrateableContainer_2 = Parameters<(typeof ReactDOMClient)["hydrateRoot"]>[0];
71+
72+
// @public (undocumented)
73+
interface Letter {
74+
// (undocumented)
75+
__typename: "Letter";
76+
// (undocumented)
77+
letter: string;
78+
// (undocumented)
79+
position: number;
80+
}
81+
82+
// @public (undocumented)
83+
export interface MaskedVariablesCaseData {
84+
// (undocumented)
85+
character: {
86+
__typename: "Character";
87+
id: string;
88+
} & {
89+
" $fragmentRefs"?: {
90+
MaskedVariablesCaseFragment: MaskedVariablesCaseFragment;
91+
};
92+
};
93+
}
94+
95+
// @public (undocumented)
96+
type MaskedVariablesCaseFragment = {
97+
__typename: "Character";
98+
name: string;
99+
} & {
100+
" $fragmentName"?: "MaskedVariablesCaseFragment";
101+
};
102+
103+
// @public (undocumented)
104+
export function mockDeferStream<TData = Record<string, unknown>, TExtensions = Record<string, unknown>>(): {
105+
httpLink: HttpLink;
106+
enqueueInitialChunk(chunk: InitialIncrementalExecutionResult<TData, TExtensions>): void;
107+
enqueueSubsequentChunk(chunk: SubsequentIncrementalExecutionResult<TData, TExtensions>): void;
108+
enqueueErrorChunk(errors: GraphQLFormattedError[]): void;
109+
};
110+
111+
// @public (undocumented)
112+
export function mockMultipartSubscriptionStream<TData = Record<string, unknown>, TExtensions = Record<string, unknown>>(): {
113+
httpLink: HttpLink;
114+
enqueueHeartbeat: () => void;
115+
enqueuePayloadResult(payload: ApolloPayloadResult<TData, TExtensions>["payload"], hasNext?: boolean): void;
116+
enqueueProtocolErrors(errors: ApolloPayloadResult["errors"]): void;
117+
};
118+
119+
// @public (undocumented)
120+
type ObservableEvent<T> = {
121+
type: "next";
122+
value: T;
123+
} | {
124+
type: "error";
125+
error: any;
126+
} | {
127+
type: "complete";
128+
};
129+
130+
// @public (undocumented)
131+
export class ObservableStream<T> {
132+
constructor(observable: Observable<T> | Subscribable<T>);
133+
// Warning: (ae-forgotten-export) The symbol "TakeOptions" needs to be exported by the entry point index.d.ts
134+
// Warning: (ae-forgotten-export) The symbol "ObservableEvent" needs to be exported by the entry point index.d.ts
135+
//
136+
// (undocumented)
137+
peek({ timeout }?: TakeOptions): Promise<ObservableEvent<T>>;
138+
// (undocumented)
139+
take({ timeout }?: TakeOptions): Promise<ObservableEvent<T>>;
140+
// (undocumented)
141+
takeComplete(options?: TakeOptions): Promise<void>;
142+
// (undocumented)
143+
takeError(options?: TakeOptions): Promise<any>;
144+
// (undocumented)
145+
takeNext(options?: TakeOptions): Promise<T>;
146+
// (undocumented)
147+
unsubscribe(): void;
148+
}
149+
150+
// @public (undocumented)
151+
export interface PaginatedCaseData {
152+
// Warning: (ae-forgotten-export) The symbol "Letter" needs to be exported by the entry point index.d.ts
153+
//
154+
// (undocumented)
155+
letters: Letter[];
156+
}
157+
158+
// @public (undocumented)
159+
export interface PaginatedCaseVariables {
160+
// (undocumented)
161+
limit?: number;
162+
// (undocumented)
163+
offset?: number;
164+
}
165+
166+
// Warning: (ae-forgotten-export) The symbol "RendererableContainer" needs to be exported by the entry point index.d.ts
167+
// Warning: (ae-forgotten-export) The symbol "HydrateableContainer" needs to be exported by the entry point index.d.ts
168+
//
169+
// @public (undocumented)
170+
export function renderAsync<Q extends Queries = typeof queries, Container extends RendererableContainer | HydrateableContainer = HTMLElement, BaseElement extends RendererableContainer | HydrateableContainer = Container>(ui: React.ReactNode, options: RenderOptions<Q, Container, BaseElement>): Promise<RenderResult<Q, Container, BaseElement>>;
171+
172+
// @public (undocumented)
173+
export function renderAsync(ui: React.ReactNode, options?: Omit<RenderOptions, "queries"> | undefined): Promise<RenderResult>;
174+
175+
// @public (undocumented)
176+
type RendererableContainer = ReactDOMClient.Container;
177+
178+
// @public (undocumented)
179+
type RendererableContainer_2 = ReactDOMClient.Container;
180+
181+
// Warning: (ae-forgotten-export) The symbol "RendererableContainer_2" needs to be exported by the entry point index.d.ts
182+
// Warning: (ae-forgotten-export) The symbol "HydrateableContainer_2" needs to be exported by the entry point index.d.ts
183+
//
184+
// @public (undocumented)
185+
export function renderHookAsync<Result, Props, Q extends Queries = typeof queries, Container extends RendererableContainer_2 | HydrateableContainer_2 = HTMLElement, BaseElement extends RendererableContainer_2 | HydrateableContainer_2 = Container>(renderCallback: (initialProps: Props) => Result, options?: RenderHookOptions<Props, Q, Container, BaseElement> | undefined): Promise<RenderHookResult<Result, Props>>;
186+
187+
// @public
188+
export function resetApolloContext(): void;
189+
190+
// @public (undocumented)
191+
export function setupMaskedVariablesCase(): {
192+
mocks: MockedResponse<MaskedVariablesCaseData, Record<string, any>>[];
193+
query: MaskedDocumentNode<MaskedVariablesCaseData, VariablesCaseVariables>;
194+
unmaskedQuery: TypedDocumentNode<MaskedVariablesCaseData, VariablesCaseVariables>;
195+
};
196+
197+
// @public (undocumented)
198+
export function setupPaginatedCase(): {
199+
query: TypedDocumentNode<PaginatedCaseData, PaginatedCaseVariables>;
200+
link: ApolloLink;
201+
data: {
202+
__typename: string;
203+
letter: string;
204+
position: number;
205+
}[];
206+
};
207+
208+
// @public (undocumented)
209+
export function setupSimpleCase(): {
210+
query: TypedDocumentNode<SimpleCaseData, Record<string, never>>;
211+
mocks: MockedResponse<SimpleCaseData, Record<string, any>>[];
212+
};
213+
214+
// @public (undocumented)
215+
export function setupVariablesCase(): {
216+
mocks: MockedResponse<VariablesCaseData, Record<string, any>>[];
217+
query: TypedDocumentNode<VariablesCaseData, VariablesCaseVariables>;
218+
};
219+
220+
// @public (undocumented)
221+
export interface SimpleCaseData {
222+
// (undocumented)
223+
greeting: string;
224+
}
225+
226+
// Warning: (ae-forgotten-export) The symbol "ConsoleMethod" needs to be exported by the entry point index.d.ts
227+
//
228+
// @public (undocumented)
229+
type Spies<Keys extends ConsoleMethod[]> = Record<Keys[number], jest.SpyInstance<void, any[], any>>;
230+
231+
// Warning: (ae-forgotten-export) The symbol "Spies" needs to be exported by the entry point index.d.ts
232+
// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "spyOnConsole" because one of its declarations is marked as @internal
233+
//
234+
// @internal (undocumented)
235+
export function spyOnConsole<Keys extends ConsoleMethod[]>(...spyOn: Keys): Spies<Keys> & Disposable;
236+
237+
// @public (undocumented)
238+
export namespace spyOnConsole {
239+
var // (undocumented)
240+
takeSnapshots: <Keys extends ConsoleMethod[]>(...spyOn: Keys) => Spies<Keys> & Disposable;
241+
}
242+
243+
// @public (undocumented)
244+
interface TakeOptions {
245+
// (undocumented)
246+
timeout?: number;
247+
}
248+
249+
// @public (undocumented)
250+
export interface VariablesCaseData {
251+
// (undocumented)
252+
character: {
253+
__typename: "Character";
254+
id: string;
255+
name: string;
256+
};
257+
}
258+
259+
// @public (undocumented)
260+
export interface VariablesCaseVariables {
261+
// (undocumented)
262+
id: string;
263+
}
264+
265+
// @internal (undocumented)
266+
export function withCleanup<T extends object>(item: T, cleanup: (item: T) => void): T & Disposable;
267+
268+
// @public (undocumented)
269+
export function withProdMode(): {
270+
prevDEV: boolean;
271+
} & Disposable;
272+
273+
// Warnings were encountered during analysis:
274+
//
275+
// src/testing/internal/scenarios/index.ts:80:7 - (ae-forgotten-export) The symbol "MaskedVariablesCaseFragment" needs to be exported by the entry point index.d.ts
276+
277+
// (No @packageDocumentation comment for this package)
278+
279+
```

‎src/__tests__/__snapshots__/exports.ts.snap‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -390,6 +390,29 @@ Array [
390390
]
391391
`;
392392

393+
exports[`exports of public entry points @apollo/client/testing/internal 1`] = `
394+
Array [
395+
"ObservableStream",
396+
"actAsync",
397+
"addDelayToMocks",
398+
"createClientWrapper",
399+
"createMockWrapper",
400+
"enableFakeTimers",
401+
"mockDeferStream",
402+
"mockMultipartSubscriptionStream",
403+
"renderAsync",
404+
"renderHookAsync",
405+
"resetApolloContext",
406+
"setupMaskedVariablesCase",
407+
"setupPaginatedCase",
408+
"setupSimpleCase",
409+
"setupVariablesCase",
410+
"spyOnConsole",
411+
"withCleanup",
412+
"withProdMode",
413+
]
414+
`;
415+
393416
exports[`exports of public entry points @apollo/client/testing/react 1`] = `
394417
Array [
395418
"MockedProvider",

‎src/__tests__/exports.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ import * as reactSSR from "@apollo/client/react/ssr";
3535
import * as testing from "@apollo/client/testing";
3636
import * as testingCore from "@apollo/client/testing/core";
3737
import * as testingExperimental from "@apollo/client/testing/experimental";
38+
import * as testingInternal from "@apollo/client/testing/internal";
3839
import * as testingReact from "@apollo/client/testing/react";
3940
import * as utilities from "@apollo/client/utilities";
4041
import * as utilitiesEnvironment from "@apollo/client/utilities/environment";
@@ -97,6 +98,7 @@ describe("exports of public entry points", () => {
9798
check("@apollo/client/testing", testing);
9899
check("@apollo/client/testing/core", testingCore);
99100
check("@apollo/client/testing/experimental", testingExperimental);
101+
check("@apollo/client/testing/internal", testingInternal);
100102
check("@apollo/client/testing/react", testingReact);
101103
check("@apollo/client/utilities", utilities);
102104
check("@apollo/client/utilities/internal", utilitiesInternal);

0 commit comments

Comments
 (0)