@yiaany/ghostapi 0.1.7 → 0.1.8

package/dist/scenarios/scenarioBundle.d.ts

@@ -0,0 +1,75 @@
+export type ScenarioBundle = {
+    schemaVersion: 1;
+    kind: "ghostapi.scenario-bundle";
+    metadata: {
+        title: string;
+        recordedAt: string;
+        sandboxHosts: string[];
+    };
+    sanitization: ScenarioSanitizationSummary;
+    variables: Array<{
+        name: string;
+        value: string;
+    }>;
+    interactions: ScenarioBundleInteraction[];
+};
+export type ScenarioBundleInteraction = {
+    request: {
+        method: string;
+        path: string;
+        headers: Record<string, string>;
+        body: unknown;
+    };
+    response: {
+        status: number;
+        headers: Record<string, string>;
+        body: unknown;
+    };
+};
+export type ScenarioSanitizationSummary = {
+    categories: string[];
+    replacements: number;
+    requiresApproval: boolean;
+};
+export type ScenarioRecordingOptions = {
+    title?: string;
+    allowedSandboxHosts: string[];
+    pii?: Partial<ScenarioPiiRules>;
+    recordedAt?: string;
+};
+export type ScenarioPiiRules = {
+    emails: boolean;
+    phones: boolean;
+    addresses: boolean;
+};
+export type ScenarioReplayRequest = {
+    method: string;
+    path: string;
+    headers?: Record<string, string | string[]>;
+    body?: unknown;
+};
+export type ScenarioReplayResult = {
+    index: number;
+    status: number;
+    headers: Record<string, string>;
+    body: unknown;
+};
+export declare class ScenarioBundleError extends Error {
+    constructor(message: string);
+}
+export declare class ScenarioReplayer {
+    private readonly bundle;
+    private cursor;
+    private readonly bindings;
+    constructor(bundle: ScenarioBundle);
+    replay(request: ScenarioReplayRequest): ScenarioReplayResult;
+    get remaining(): number;
+}
+export declare function prepareScenarioRecording(input: unknown, options: ScenarioRecordingOptions): ScenarioBundle;
+export declare function prepareScenarioRecordingFromFile(path: string, options: ScenarioRecordingOptions, projectRoot?: string): Promise<ScenarioBundle>;
+export declare function writeScenarioBundle(bundle: ScenarioBundle, outPath?: string, projectRoot?: string): Promise<string>;
+export declare function loadScenarioBundle(path: string, projectRoot?: string): Promise<ScenarioBundle>;
+export declare function createScenarioReplayer(bundle: ScenarioBundle): ScenarioReplayer;
+export declare function formatScenarioSanitizationSummary(summary: ScenarioSanitizationSummary): string;
+export declare function validateScenarioBundle(input: unknown): ScenarioBundle;
+export declare function migrateScenarioBundle(input: unknown): unknown;