@funnelsgrove/cli 0.1.20 → 0.1.26

package/dist/experimentCreate.d.ts

@@ -0,0 +1,100 @@
+import { readSyncManifest, type SyncManifest } from './localSync.js';
+export declare const EXPERIMENT_GENERATED_PATHS: readonly ["src/config/experiments.generated.ts", "src/config/experiments.ts"];
+declare const EXPERIMENT_GENERATED_CONTENT_TYPE = "text/typescript";
+declare const EXPERIMENT_METRICS: readonly ["step_completion", "next_step_reached", "checkout_opened", "funnel_completed", "paying_customer"];
+export type ExperimentMetric = (typeof EXPERIMENT_METRICS)[number];
+export type AgentExperimentVariant = {
+    variantKey: string;
+    label: string;
+    routeToStepId: string;
+    trafficPercent: number;
+    isControl: boolean;
+};
+export type AgentPricingExperimentVariant = AgentExperimentVariant & {
+    offerSetKey: string;
+};
+type SharedAgentExperimentSpec = {
+    id: string;
+    name: string;
+    stepId: string;
+    primaryMetric: ExperimentMetric;
+    trackedMetrics: ExperimentMetric[];
+};
+export type AgentExperimentSpec = SharedAgentExperimentSpec & ({
+    type: 'step' | 'paywall';
+    variants: AgentExperimentVariant[];
+} | {
+    type: 'pricing';
+    variants: AgentPricingExperimentVariant[];
+});
+export type GeneratedExperimentFile = {
+    path: (typeof EXPERIMENT_GENERATED_PATHS)[number];
+    content: string;
+    contentType: typeof EXPERIMENT_GENERATED_CONTENT_TYPE;
+};
+export type ExperimentCreateResponse = {
+    experiment: Record<string, unknown> & {
+        id: string;
+        posthog_flag_key: string;
+    };
+    variants: Array<Record<string, unknown> & {
+        id: string;
+        experiment_id: string;
+        variant_key: string;
+        label: string;
+        route_to_step_id: string;
+        traffic_percent: number;
+        is_control: boolean;
+    }>;
+    draftVersionId: string;
+    generatedFiles: [GeneratedExperimentFile, GeneratedExperimentFile];
+    githubConnected: boolean;
+};
+export declare class ExperimentCreateContractError extends Error {
+    constructor(fieldPath: string, reason: string);
+}
+export declare function parseAgentExperimentSpec(value: unknown): AgentExperimentSpec;
+export declare function readAgentExperimentSpec(filePath: string): Promise<AgentExperimentSpec>;
+export declare function parseExperimentCreateResponse(value: unknown, requestedSpec: AgentExperimentSpec, expectedFunnelIdValue: string): ExperimentCreateResponse;
+export declare function assertGeneratedExperimentFilesUnchanged(root: string, manifestValue: SyncManifest): Promise<void>;
+export declare function buildExperimentCreateManifest(manifestValue: SyncManifest, draftVersionIdValue: string, filesValue: unknown): SyncManifest;
+export type ExperimentCreateInstallPhase = 'prepared' | 'ready' | `generated:${GeneratedExperimentFile['path']}` | 'before-manifest' | 'manifest';
+type ExperimentCreateInstallHooks = {
+    afterPhase?: (phase: ExperimentCreateInstallPhase) => void | Promise<void>;
+};
+export declare function recoverExperimentCreateTransaction(root: string): Promise<boolean>;
+export declare function installExperimentCreateTransaction(root: string, input: {
+    generatedFiles: unknown;
+    manifest: SyncManifest;
+}, hooks?: ExperimentCreateInstallHooks): Promise<void>;
+export type ExecuteExperimentCreateInput = {
+    sourceDir: string;
+    specPath: string;
+    createFromSpec: (input: {
+        workspaceId: string;
+        funnelId: string;
+        expectedDraftVersionId: string;
+        spec: AgentExperimentSpec;
+    }) => Promise<unknown>;
+};
+export type ExperimentCreateSuccess = {
+    experimentId: string;
+    experimentKey: string;
+    draftVersionId: string;
+    writtenPaths: [...typeof EXPERIMENT_GENERATED_PATHS];
+    githubConnected: boolean;
+};
+type ExecuteExperimentCreateDependencies = {
+    recover: typeof recoverExperimentCreateTransaction;
+    readManifest: typeof readSyncManifest;
+    readSpec: typeof readAgentExperimentSpec;
+    assertGeneratedFilesUnchanged: typeof assertGeneratedExperimentFilesUnchanged;
+    parseResponse: typeof parseExperimentCreateResponse;
+    install: (sourceDir: string, input: {
+        generatedFiles: unknown;
+        manifest: SyncManifest;
+    }) => Promise<void>;
+};
+export declare function executeExperimentCreate(input: ExecuteExperimentCreateInput, dependencyOverrides?: Partial<ExecuteExperimentCreateDependencies>): Promise<ExperimentCreateSuccess>;
+export declare function formatExperimentCreateSuccess(result: ExperimentCreateSuccess, json: boolean): string;
+export {};