UNPKG

1.81 kBTypeScriptView Raw
1export interface ApolloServerPluginLandingPageDefaultBaseOptions {
2 version?: string;
3 footer?: boolean;
4 document?: string;
5 variables?: Record<string, any>;
6 headers?: Record<string, string>;
7 includeCookies?: boolean;
8 __internal_apolloStudioEnv__?: 'staging' | 'prod';
9}
10export interface ApolloServerPluginNonEmbeddedLandingPageLocalDefaultOptions extends ApolloServerPluginLandingPageDefaultBaseOptions {
11 embed?: false;
12}
13export interface ApolloServerPluginNonEmbeddedLandingPageProductionDefaultOptions extends ApolloServerPluginLandingPageDefaultBaseOptions {
14 graphRef?: string;
15 embed?: false;
16}
17export interface ApolloServerPluginEmbeddedLandingPageLocalDefaultOptions extends ApolloServerPluginLandingPageDefaultBaseOptions {
18 embed: true;
19}
20export interface ApolloServerPluginEmbeddedLandingPageProductionDefaultOptions extends ApolloServerPluginLandingPageDefaultBaseOptions {
21 graphRef: string;
22 embed: true | EmbeddableExplorerOptions;
23}
24declare type EmbeddableExplorerOptions = {
25 displayOptions?: {
26 showHeadersAndEnvVars: boolean;
27 docsPanelState: 'open' | 'closed';
28 theme: 'light' | 'dark';
29 };
30 persistExplorerState: boolean;
31};
32export declare type ApolloServerPluginLandingPageLocalDefaultOptions = ApolloServerPluginEmbeddedLandingPageLocalDefaultOptions | ApolloServerPluginNonEmbeddedLandingPageLocalDefaultOptions;
33export declare type ApolloServerPluginLandingPageProductionDefaultOptions = ApolloServerPluginEmbeddedLandingPageProductionDefaultOptions | ApolloServerPluginNonEmbeddedLandingPageProductionDefaultOptions;
34export declare type LandingPageConfig = ApolloServerPluginLandingPageLocalDefaultOptions | ApolloServerPluginLandingPageProductionDefaultOptions;
35export {};
36//# sourceMappingURL=types.d.ts.map
\No newline at end of file