altair-graphql-core/build/script/types.d.ts

Several of the core logic for altair graphql client

import { IDictionary } from '../types/shared';
import { IEnvironment } from '../types/state/environments.interfaces';
import { HeaderState } from '../types/state/header.interfaces';
import { LogLine } from '../types/state/query.interfaces';
export interface SendRequestResponse {
    ok: boolean;
    body: string;
    headers: Record<string, string>;
    status: number;
    statusText: string;
    url: string;
    requestStartTime: number;
    requestEndTime: number;
    responseTime: number;
}
export declare enum RequestType {
    INTROSPECTION = "introspection",
    QUERY = "query",
    SUBSCRIPTION = "subscription"
}
export interface ScriptContextHelpers {
    getEnvironment: (key: string) => any;
    setEnvironment: (key: string, value: any) => void;
    getCookie: (key: string) => string;
    setCookie: (key: string, value: string) => void;
    request: (arg1: any, arg2: any, arg3: any) => Promise<ArrayBuffer | null>;
}
export interface ScriptContextStorage {
    get: (key: string) => Promise<unknown>;
    set: (key: string, value: unknown) => Promise<void>;
}
export interface ScriptContextData {
    headers: HeaderState;
    variables: string;
    operationName: string;
    query: string;
    environment: IDictionary;
    url: string;
    requestExtensions?: string;
    requestScriptLogs?: LogLine[];
    response?: SendRequestResponse;
    requestType?: RequestType;
    __toSetActiveEnvironment?: IDictionary;
    __cookieJar?: IDictionary;
}
export interface ScriptContextResponse {
    requestType: RequestType;
    responseTime: number;
    statusCode: number;
    body: unknown;
    headers: IDictionary;
}
export interface GlobalHelperContext {
    data: ScriptContextData;
    helpers: ScriptContextHelpers;
    storage: ScriptContextStorage;
    importModule: (moduleName: string) => any;
    log: (d: unknown) => void;
    response?: ScriptContextResponse;
}
export interface ScriptTranformResult {
    requestScriptLogs: LogLine[];
    additionalHeaders: HeaderState;
    environment?: IEnvironment;
}
export type SameSite = 'Lax' | 'None' | 'Strict';
export interface CookieOptions {
    expires?: number | Date;
    path?: string;
    domain?: string;
    secure?: boolean;
    sameSite?: SameSite;
}
export interface GlobalContextBuilderHandlers {
    setCookie: ScriptEventHandlers['setCookie'];
    request: ScriptEventHandlers['request'];
    getStorageItem: ScriptEventHandlers['getStorageItem'];
    setStorageItem: ScriptEventHandlers['setStorageItem'];
}
export interface ModuleImportsMap {
    [name: string]: {
        exec: () => Promise<any>;
    };
}
export interface ScriptEventHandlers {
    alert: (msg: string) => Promise<void>;
    log: (d: unknown) => Promise<void>;
    request: (arg1: any, arg2: any, arg3: any) => Promise<any>;
    setCookie: (key: string, value: string, options?: CookieOptions) => Promise<void>;
    getStorageItem: (key: string) => Promise<unknown>;
    setStorageItem: (key: string, value: unknown) => Promise<void>;
    updateActiveEnvironment: (environmentData: Record<string, unknown>) => Promise<void>;
}
export interface AllScriptEventHandlers extends ScriptEventHandlers {
    executeComplete: (data: ScriptContextData) => void;
    scriptError: (err: Error) => void;
}
export type ScriptEvent = keyof AllScriptEventHandlers;
export type ScriptResponseEvent<T extends string> = `${T}_response`;
export type ScriptEventParameters<T extends ScriptEvent> = Parameters<AllScriptEventHandlers[T]>;
export interface ScriptEventDataPayload<T extends ScriptEvent> {
    id: string;
    args: ScriptEventParameters<T>;
}
export interface ScriptEventResponsePayload {
    id: string;
    response: any;
}
export interface ScriptEventErrorPayload {
    id: string;
    error: string;
}
export type ScriptEventData<T extends ScriptEvent> = T extends ScriptEvent ? {
    type: T;
    payload: ScriptEventDataPayload<T>;
} : never;
export interface ScriptWorkerMessageData {
    type: string;
    payload: any;
}
export interface ScriptEvaluatorClientFactory {
    create: () => Promise<ScriptEvaluatorClient>;
}
export declare abstract class ScriptEvaluatorClient {
    abstract subscribe<T extends ScriptEvent>(type: T, handler: (type: T, e: ScriptEventData<T>) => void): void;
    abstract send(type: string, payload: any): void;
    abstract onError(handler: (err: any) => void): void;
    abstract destroy(): void;
    sendResponse<T extends ScriptEvent>(type: T, payload: ScriptEventResponsePayload): void;
    sendError<T extends ScriptEvent>(type: T, payload: ScriptEventErrorPayload): void;
}
export declare abstract class ScriptEvaluatorWorker {
    abstract onMessage(handler: (e: ScriptWorkerMessageData) => void): void;
    abstract send(type: string, payload: any): void;
    abstract onError(handler: (err: any) => void): void;
}
//# sourceMappingURL=types.d.ts.map