@prauga/flexdoc-backend 2.9.0 → 2.9.9

package/dist/host-execution.d.ts

@@ -0,0 +1,168 @@
+import type { FlexDocHostExecutionCapability, FlexDocHostExecutionOptions, FlexDocHostExecutionPublicOptions } from './interfaces';
+type HeaderEntry = [string, string];
+type HostAuth = {
+    type?: 'none' | 'inherit';
+} | {
+    type: 'bearer';
+    token?: string;
+} | {
+    type: 'oauth2';
+    accessToken?: string;
+} | {
+    type: 'basic';
+    username?: string;
+    password?: string;
+} | {
+    type: 'apiKey';
+    key?: string;
+    value?: string;
+    in?: 'header' | 'query' | 'cookie';
+} | {
+    type: 'digest';
+    username?: string;
+    password?: string;
+} | {
+    type: 'hawk';
+    id?: string;
+    key?: string;
+    algorithm?: 'sha1' | 'sha256';
+    ext?: string;
+} | {
+    type: 'ntlm';
+    username?: string;
+    password?: string;
+    domain?: string;
+    workstation?: string;
+} | {
+    type: 'oauth1';
+    consumerKey?: string;
+    consumerSecret?: string;
+    token?: string;
+    tokenSecret?: string;
+    signatureMethod?: 'HMAC-SHA1' | 'HMAC-SHA256' | 'PLAINTEXT';
+    realm?: string;
+} | {
+    type: 'awsv4';
+    accessKey?: string;
+    secretKey?: string;
+    sessionToken?: string;
+    region?: string;
+    service?: string;
+};
+export interface HostExecutionRequestDraft {
+    method?: string;
+    url?: string;
+    query?: Array<{
+        key?: string;
+        value?: string;
+        enabled?: boolean;
+    }>;
+    headers?: Array<{
+        key?: string;
+        value?: string;
+        enabled?: boolean;
+    }>;
+    body?: string;
+    contentType?: string;
+    bodyMode?: 'none' | 'raw' | 'json' | 'urlencoded' | 'formdata' | 'binary' | 'graphql';
+    urlencoded?: Array<{
+        key?: string;
+        value?: string;
+        enabled?: boolean;
+    }>;
+    formData?: Array<{
+        key?: string;
+        value?: string;
+        enabled?: boolean;
+        type?: 'text' | 'file';
+        fileName?: string;
+        contentType?: string;
+    }>;
+    binary?: {
+        fileName?: string;
+        contentType?: string;
+    };
+    graphql?: {
+        query?: string;
+        variables?: string;
+    };
+    auth?: HostAuth;
+}
+export interface HostExecutionEnvelope {
+    request: HostExecutionRequestDraft;
+    certificateId?: string;
+    cookieJar?: 'session';
+    timeoutMs?: number;
+    bodyBase64?: string;
+}
+export interface HostExecutionUploadedFile {
+    name: string;
+    contentType?: string;
+    data: Buffer;
+}
+export interface ParsedHostExecutionEnvelope extends HostExecutionEnvelope {
+    formDataFiles?: Map<number, HostExecutionUploadedFile>;
+}
+export interface HostExecutionResponse {
+    status: number;
+    statusText: string;
+    headers: HeaderEntry[];
+    body: string;
+    responseTime: number;
+    cookies?: Array<{
+        name: string;
+        value: string;
+        domain?: string;
+        path?: string;
+        httpOnly?: boolean;
+    }>;
+    error?: string;
+}
+interface CookieRecord {
+    name: string;
+    value: string;
+    domain: string;
+    path: string;
+    hostOnly: boolean;
+    secure: boolean;
+    httpOnly: boolean;
+    expiresAt?: number;
+}
+export declare class HostExecutionForbiddenError extends Error {
+}
+export declare class HostExecutionUnsupportedError extends Error {
+}
+export declare class HostExecutionBadRequestError extends Error {
+}
+export interface HostExecutionState {
+    enabled: boolean;
+    options: FlexDocHostExecutionOptions;
+    capabilities: FlexDocHostExecutionCapability[];
+    certificates: Map<string, {
+        id: string;
+        name: string;
+        cert: string;
+        key: string;
+        passphrase?: string;
+    }>;
+    sessionSecret: Buffer;
+    jars: Map<string, CookieRecord[]>;
+}
+export declare function createHostExecutionState(value: boolean | FlexDocHostExecutionOptions | undefined): HostExecutionState;
+export declare function publicHostExecutionOptions(state: HostExecutionState, rendererBasePath: string): FlexDocHostExecutionPublicOptions | undefined;
+export declare function ensureHostExecutionSession(state: HostExecutionState, cookieHeader?: string): {
+    sessionId: string;
+    setCookie?: string;
+};
+export declare function isCookieDomainAllowed(responseHostname: string, candidateDomain: string): boolean;
+export declare function publicCookiesForSession(state: HostExecutionState, sessionId: string): HostExecutionResponse['cookies'];
+export declare function clearCookiesForSession(state: HostExecutionState, sessionId: string): void;
+export declare function allowedHostExecutionOrigins(state: HostExecutionState, spec: any, docsOrigin?: string): Set<string>;
+export declare function assertHostExecutionUrlAllowed(url: URL, allowedOrigins: Set<string>): void;
+export declare function assertHostExecutionResolvedAddressAllowed(address: string): void;
+export declare function executeHostRequest(state: HostExecutionState, envelope: ParsedHostExecutionEnvelope, context: {
+    spec: any;
+    sessionId: string;
+    docsOrigin?: string;
+}): Promise<HostExecutionResponse>;
+export {};