@funnelsgrove/runtime 0.1.56 → 0.1.59

package/dist/validation/fixtures/valid-v2-project.d.ts

@@ -0,0 +1,419 @@
+export declare const validV2ProjectManifest: {
+    readonly templateArchitectureVersion: 1;
+    readonly stepContractVersion: 2;
+    readonly meta: {
+        readonly title: "Contract fixture";
+        readonly description: "A valid version 2 funnel contract fixture.";
+    };
+    readonly viewport: {
+        readonly width: 390;
+        readonly height: 844;
+    };
+    readonly assets: {};
+    readonly steps: readonly [{
+        readonly id: "step-1";
+        readonly name: "step-one";
+        readonly path: "/step-1";
+        readonly filePath: "src/steps/step-01.tsx";
+        readonly componentKey: "stepOne";
+        readonly type: "intro_hero";
+        readonly title: "Introduction";
+    }, {
+        readonly id: "step-2";
+        readonly name: "device-choice";
+        readonly path: "/step-2";
+        readonly filePath: "src/steps/step-02.tsx";
+        readonly componentKey: "stepTwo";
+        readonly type: "multi_select_choice";
+        readonly choice: {
+            readonly answerKey: "selectedDevices";
+            readonly allowEmpty: true;
+        };
+        readonly title: "Choose devices";
+    }, {
+        readonly id: "email-capture";
+        readonly name: "email-capture";
+        readonly path: "/email-capture";
+        readonly filePath: "src/steps/step-31-email-capture.tsx";
+        readonly componentKey: "stepEmailCapture";
+        readonly type: "form_input";
+        readonly title: "Email capture";
+    }, {
+        readonly id: "paywall";
+        readonly name: "paywall";
+        readonly path: "/paywall";
+        readonly filePath: "src/steps/step-32-paywall.tsx";
+        readonly componentKey: "stepPaywall";
+        readonly type: "paywall_offer";
+        readonly kind: "paywall";
+        readonly title: "Paywall";
+    }, {
+        readonly id: "paywall-b";
+        readonly name: "paywall-b";
+        readonly path: "/paywall-b";
+        readonly filePath: "src/steps/step-32b-paywall-b.tsx";
+        readonly componentKey: "stepPaywallB";
+        readonly type: "paywall_offer";
+        readonly kind: "paywall";
+        readonly title: "Paywall B";
+    }, {
+        readonly id: "subscription-started";
+        readonly name: "subscription-started";
+        readonly path: "/subscription-started";
+        readonly filePath: "src/steps/step-33-subscription-started.tsx";
+        readonly componentKey: "stepSubscriptionStarted";
+        readonly type: "complete_registration";
+        readonly kind: "subscription-handoff";
+        readonly title: "Subscription started";
+    }, {
+        readonly id: "manage-subscription";
+        readonly name: "manage-subscription";
+        readonly path: "/manage-subscription";
+        readonly filePath: "src/steps/step-35-manage-subscription.tsx";
+        readonly componentKey: "stepManageSubscription";
+        readonly type: "subscription_management";
+        readonly kind: "manage-subscription";
+        readonly title: "Manage subscription";
+    }];
+    readonly entryPoints: readonly [{
+        readonly id: "default";
+        readonly stepId: "step-1";
+        readonly isDefault: true;
+    }, {
+        readonly id: "manage-subscription";
+        readonly stepId: "manage-subscription";
+    }];
+    readonly edgesByStepId: {
+        readonly 'step-1': readonly [{
+            readonly toStepId: "step-2";
+        }];
+        readonly 'step-2': readonly [{
+            readonly toStepId: "email-capture";
+        }];
+        readonly 'email-capture': readonly [{
+            readonly toStepId: "paywall";
+        }];
+        readonly paywall: readonly [{
+            readonly toStepId: "subscription-started";
+        }];
+        readonly 'paywall-b': readonly [{
+            readonly toStepId: "subscription-started";
+        }];
+    };
+    readonly branches: readonly [{
+        readonly id: "device-owners";
+        readonly name: "Device owners";
+        readonly sourceStepId: "step-2";
+        readonly stepIds: readonly ["email-capture", "paywall"];
+    }];
+    readonly experiments: readonly [{
+        readonly experimentId: "paywall-offer";
+        readonly stepId: "paywall";
+        readonly variants: readonly [{
+            readonly variantKey: "control";
+            readonly routeToStepId: "paywall";
+        }, {
+            readonly variantKey: "variant-b";
+            readonly routeToStepId: "paywall-b";
+        }];
+    }];
+};
+export declare const validV2ProjectComponentMetaByKey: {
+    readonly stepOne: {
+        readonly id: "step-1";
+        readonly name: "step-one";
+        readonly type: "intro_hero";
+        readonly figmaNodeId: "fixture:step-1";
+        readonly title: "Introduction";
+        readonly description: "Introduce the funnel.";
+    };
+    readonly stepTwo: {
+        readonly id: "step-2";
+        readonly name: "device-choice";
+        readonly type: "multi_select_choice";
+        readonly choice: {
+            readonly answerKey: "selectedDevices";
+            readonly allowEmpty: true;
+        };
+        readonly figmaNodeId: "fixture:step-2";
+        readonly title: "Choose devices";
+        readonly description: "Choose every device that applies.";
+    };
+    readonly stepEmailCapture: {
+        readonly id: "email-capture";
+        readonly name: "email-capture";
+        readonly type: "form_input";
+        readonly figmaNodeId: "fixture:email-capture";
+        readonly title: "Email capture";
+        readonly description: "Capture an email address.";
+    };
+    readonly stepPaywall: {
+        readonly id: "paywall";
+        readonly name: "paywall";
+        readonly type: "paywall_offer";
+        readonly kind: "paywall";
+        readonly figmaNodeId: "fixture:paywall";
+        readonly title: "Paywall";
+        readonly description: "Present the primary offer.";
+    };
+    readonly stepPaywallB: {
+        readonly id: "paywall-b";
+        readonly name: "paywall-b";
+        readonly type: "paywall_offer";
+        readonly kind: "paywall";
+        readonly figmaNodeId: "fixture:paywall-b";
+        readonly title: "Paywall B";
+        readonly description: "Present the alternate offer.";
+    };
+    readonly stepSubscriptionStarted: {
+        readonly id: "subscription-started";
+        readonly name: "subscription-started";
+        readonly type: "complete_registration";
+        readonly kind: "subscription-handoff";
+        readonly figmaNodeId: "fixture:subscription-started";
+        readonly title: "Subscription started";
+        readonly description: "Complete the funnel after subscription handoff.";
+    };
+    readonly stepManageSubscription: {
+        readonly id: "manage-subscription";
+        readonly name: "manage-subscription";
+        readonly type: "subscription_management";
+        readonly kind: "manage-subscription";
+        readonly figmaNodeId: "fixture:manage-subscription";
+        readonly title: "Manage subscription";
+        readonly description: "Manage the active subscription.";
+    };
+};
+export declare const validV2ProjectSnapshot: {
+    readonly manifest: {
+        readonly templateArchitectureVersion: 1;
+        readonly stepContractVersion: 2;
+        readonly meta: {
+            readonly title: "Contract fixture";
+            readonly description: "A valid version 2 funnel contract fixture.";
+        };
+        readonly viewport: {
+            readonly width: 390;
+            readonly height: 844;
+        };
+        readonly assets: {};
+        readonly steps: readonly [{
+            readonly id: "step-1";
+            readonly name: "step-one";
+            readonly path: "/step-1";
+            readonly filePath: "src/steps/step-01.tsx";
+            readonly componentKey: "stepOne";
+            readonly type: "intro_hero";
+            readonly title: "Introduction";
+        }, {
+            readonly id: "step-2";
+            readonly name: "device-choice";
+            readonly path: "/step-2";
+            readonly filePath: "src/steps/step-02.tsx";
+            readonly componentKey: "stepTwo";
+            readonly type: "multi_select_choice";
+            readonly choice: {
+                readonly answerKey: "selectedDevices";
+                readonly allowEmpty: true;
+            };
+            readonly title: "Choose devices";
+        }, {
+            readonly id: "email-capture";
+            readonly name: "email-capture";
+            readonly path: "/email-capture";
+            readonly filePath: "src/steps/step-31-email-capture.tsx";
+            readonly componentKey: "stepEmailCapture";
+            readonly type: "form_input";
+            readonly title: "Email capture";
+        }, {
+            readonly id: "paywall";
+            readonly name: "paywall";
+            readonly path: "/paywall";
+            readonly filePath: "src/steps/step-32-paywall.tsx";
+            readonly componentKey: "stepPaywall";
+            readonly type: "paywall_offer";
+            readonly kind: "paywall";
+            readonly title: "Paywall";
+        }, {
+            readonly id: "paywall-b";
+            readonly name: "paywall-b";
+            readonly path: "/paywall-b";
+            readonly filePath: "src/steps/step-32b-paywall-b.tsx";
+            readonly componentKey: "stepPaywallB";
+            readonly type: "paywall_offer";
+            readonly kind: "paywall";
+            readonly title: "Paywall B";
+        }, {
+            readonly id: "subscription-started";
+            readonly name: "subscription-started";
+            readonly path: "/subscription-started";
+            readonly filePath: "src/steps/step-33-subscription-started.tsx";
+            readonly componentKey: "stepSubscriptionStarted";
+            readonly type: "complete_registration";
+            readonly kind: "subscription-handoff";
+            readonly title: "Subscription started";
+        }, {
+            readonly id: "manage-subscription";
+            readonly name: "manage-subscription";
+            readonly path: "/manage-subscription";
+            readonly filePath: "src/steps/step-35-manage-subscription.tsx";
+            readonly componentKey: "stepManageSubscription";
+            readonly type: "subscription_management";
+            readonly kind: "manage-subscription";
+            readonly title: "Manage subscription";
+        }];
+        readonly entryPoints: readonly [{
+            readonly id: "default";
+            readonly stepId: "step-1";
+            readonly isDefault: true;
+        }, {
+            readonly id: "manage-subscription";
+            readonly stepId: "manage-subscription";
+        }];
+        readonly edgesByStepId: {
+            readonly 'step-1': readonly [{
+                readonly toStepId: "step-2";
+            }];
+            readonly 'step-2': readonly [{
+                readonly toStepId: "email-capture";
+            }];
+            readonly 'email-capture': readonly [{
+                readonly toStepId: "paywall";
+            }];
+            readonly paywall: readonly [{
+                readonly toStepId: "subscription-started";
+            }];
+            readonly 'paywall-b': readonly [{
+                readonly toStepId: "subscription-started";
+            }];
+        };
+        readonly branches: readonly [{
+            readonly id: "device-owners";
+            readonly name: "Device owners";
+            readonly sourceStepId: "step-2";
+            readonly stepIds: readonly ["email-capture", "paywall"];
+        }];
+        readonly experiments: readonly [{
+            readonly experimentId: "paywall-offer";
+            readonly stepId: "paywall";
+            readonly variants: readonly [{
+                readonly variantKey: "control";
+                readonly routeToStepId: "paywall";
+            }, {
+                readonly variantKey: "variant-b";
+                readonly routeToStepId: "paywall-b";
+            }];
+        }];
+    };
+    readonly componentMetaByKey: {
+        readonly stepOne: {
+            readonly id: "step-1";
+            readonly name: "step-one";
+            readonly type: "intro_hero";
+            readonly figmaNodeId: "fixture:step-1";
+            readonly title: "Introduction";
+            readonly description: "Introduce the funnel.";
+        };
+        readonly stepTwo: {
+            readonly id: "step-2";
+            readonly name: "device-choice";
+            readonly type: "multi_select_choice";
+            readonly choice: {
+                readonly answerKey: "selectedDevices";
+                readonly allowEmpty: true;
+            };
+            readonly figmaNodeId: "fixture:step-2";
+            readonly title: "Choose devices";
+            readonly description: "Choose every device that applies.";
+        };
+        readonly stepEmailCapture: {
+            readonly id: "email-capture";
+            readonly name: "email-capture";
+            readonly type: "form_input";
+            readonly figmaNodeId: "fixture:email-capture";
+            readonly title: "Email capture";
+            readonly description: "Capture an email address.";
+        };
+        readonly stepPaywall: {
+            readonly id: "paywall";
+            readonly name: "paywall";
+            readonly type: "paywall_offer";
+            readonly kind: "paywall";
+            readonly figmaNodeId: "fixture:paywall";
+            readonly title: "Paywall";
+            readonly description: "Present the primary offer.";
+        };
+        readonly stepPaywallB: {
+            readonly id: "paywall-b";
+            readonly name: "paywall-b";
+            readonly type: "paywall_offer";
+            readonly kind: "paywall";
+            readonly figmaNodeId: "fixture:paywall-b";
+            readonly title: "Paywall B";
+            readonly description: "Present the alternate offer.";
+        };
+        readonly stepSubscriptionStarted: {
+            readonly id: "subscription-started";
+            readonly name: "subscription-started";
+            readonly type: "complete_registration";
+            readonly kind: "subscription-handoff";
+            readonly figmaNodeId: "fixture:subscription-started";
+            readonly title: "Subscription started";
+            readonly description: "Complete the funnel after subscription handoff.";
+        };
+        readonly stepManageSubscription: {
+            readonly id: "manage-subscription";
+            readonly name: "manage-subscription";
+            readonly type: "subscription_management";
+            readonly kind: "manage-subscription";
+            readonly figmaNodeId: "fixture:manage-subscription";
+            readonly title: "Manage subscription";
+            readonly description: "Manage the active subscription.";
+        };
+    };
+    readonly registeredComponentKeys: readonly ["stepOne", "stepTwo", "stepEmailCapture", "stepPaywall", "stepPaywallB", "stepSubscriptionStarted", "stepManageSubscription"];
+    readonly contentOptionsByStepId: {
+        readonly 'step-2': readonly [{
+            readonly id: "phone";
+            readonly label: "Phone";
+            readonly imageSrc: "/images/phone.png";
+        }];
+    };
+    readonly edgesByStepId: {
+        readonly 'step-1': readonly [{
+            readonly toStepId: "step-2";
+        }];
+        readonly 'step-2': readonly [{
+            readonly toStepId: "email-capture";
+        }];
+        readonly 'email-capture': readonly [{
+            readonly toStepId: "paywall";
+        }];
+        readonly paywall: readonly [{
+            readonly toStepId: "subscription-started";
+        }];
+        readonly 'paywall-b': readonly [{
+            readonly toStepId: "subscription-started";
+        }];
+    };
+    readonly experiments: readonly [{
+        readonly experimentId: "paywall-offer";
+        readonly stepId: "paywall";
+        readonly variants: readonly [{
+            readonly variantKey: "control";
+            readonly routeToStepId: "paywall";
+        }, {
+            readonly variantKey: "variant-b";
+            readonly routeToStepId: "paywall-b";
+        }];
+    }];
+    readonly docs: {
+        readonly schemaVersion: 1;
+        readonly bundleVersion: "2.0.0";
+        readonly stepContractVersion: 2;
+        readonly contractHash: "d761e91d5ac6ff9e72c6d49c5bcd014270912473a66f99c49d726c65998085cf";
+        readonly missing: readonly [];
+        readonly changed: readonly [];
+        readonly conflicts: readonly [];
+    };
+};

package/dist/validation/fixtures/valid-v2-project.js

@@ -0,0 +1,228 @@
+import { CURRENT_STEP_CONTRACT_HASH } from '../../generated/step-contract-hash.js';
+export const validV2ProjectManifest = {
+    templateArchitectureVersion: 1,
+    stepContractVersion: 2,
+    meta: {
+        title: 'Contract fixture',
+        description: 'A valid version 2 funnel contract fixture.',
+    },
+    viewport: {
+        width: 390,
+        height: 844,
+    },
+    assets: {},
+    steps: [
+        {
+            id: 'step-1',
+            name: 'step-one',
+            path: '/step-1',
+            filePath: 'src/steps/step-01.tsx',
+            componentKey: 'stepOne',
+            type: 'intro_hero',
+            title: 'Introduction',
+        },
+        {
+            id: 'step-2',
+            name: 'device-choice',
+            path: '/step-2',
+            filePath: 'src/steps/step-02.tsx',
+            componentKey: 'stepTwo',
+            type: 'multi_select_choice',
+            choice: {
+                answerKey: 'selectedDevices',
+                allowEmpty: true,
+            },
+            title: 'Choose devices',
+        },
+        {
+            id: 'email-capture',
+            name: 'email-capture',
+            path: '/email-capture',
+            filePath: 'src/steps/step-31-email-capture.tsx',
+            componentKey: 'stepEmailCapture',
+            type: 'form_input',
+            title: 'Email capture',
+        },
+        {
+            id: 'paywall',
+            name: 'paywall',
+            path: '/paywall',
+            filePath: 'src/steps/step-32-paywall.tsx',
+            componentKey: 'stepPaywall',
+            type: 'paywall_offer',
+            kind: 'paywall',
+            title: 'Paywall',
+        },
+        {
+            id: 'paywall-b',
+            name: 'paywall-b',
+            path: '/paywall-b',
+            filePath: 'src/steps/step-32b-paywall-b.tsx',
+            componentKey: 'stepPaywallB',
+            type: 'paywall_offer',
+            kind: 'paywall',
+            title: 'Paywall B',
+        },
+        {
+            id: 'subscription-started',
+            name: 'subscription-started',
+            path: '/subscription-started',
+            filePath: 'src/steps/step-33-subscription-started.tsx',
+            componentKey: 'stepSubscriptionStarted',
+            type: 'complete_registration',
+            kind: 'subscription-handoff',
+            title: 'Subscription started',
+        },
+        {
+            id: 'manage-subscription',
+            name: 'manage-subscription',
+            path: '/manage-subscription',
+            filePath: 'src/steps/step-35-manage-subscription.tsx',
+            componentKey: 'stepManageSubscription',
+            type: 'subscription_management',
+            kind: 'manage-subscription',
+            title: 'Manage subscription',
+        },
+    ],
+    entryPoints: [
+        {
+            id: 'default',
+            stepId: 'step-1',
+            isDefault: true,
+        },
+        {
+            id: 'manage-subscription',
+            stepId: 'manage-subscription',
+        },
+    ],
+    edgesByStepId: {
+        'step-1': [{ toStepId: 'step-2' }],
+        'step-2': [{ toStepId: 'email-capture' }],
+        'email-capture': [{ toStepId: 'paywall' }],
+        paywall: [{ toStepId: 'subscription-started' }],
+        'paywall-b': [{ toStepId: 'subscription-started' }],
+    },
+    branches: [
+        {
+            id: 'device-owners',
+            name: 'Device owners',
+            sourceStepId: 'step-2',
+            stepIds: ['email-capture', 'paywall'],
+        },
+    ],
+    experiments: [
+        {
+            experimentId: 'paywall-offer',
+            stepId: 'paywall',
+            variants: [
+                {
+                    variantKey: 'control',
+                    routeToStepId: 'paywall',
+                },
+                {
+                    variantKey: 'variant-b',
+                    routeToStepId: 'paywall-b',
+                },
+            ],
+        },
+    ],
+};
+export const validV2ProjectComponentMetaByKey = {
+    stepOne: {
+        id: 'step-1',
+        name: 'step-one',
+        type: 'intro_hero',
+        figmaNodeId: 'fixture:step-1',
+        title: 'Introduction',
+        description: 'Introduce the funnel.',
+    },
+    stepTwo: {
+        id: 'step-2',
+        name: 'device-choice',
+        type: 'multi_select_choice',
+        choice: {
+            answerKey: 'selectedDevices',
+            allowEmpty: true,
+        },
+        figmaNodeId: 'fixture:step-2',
+        title: 'Choose devices',
+        description: 'Choose every device that applies.',
+    },
+    stepEmailCapture: {
+        id: 'email-capture',
+        name: 'email-capture',
+        type: 'form_input',
+        figmaNodeId: 'fixture:email-capture',
+        title: 'Email capture',
+        description: 'Capture an email address.',
+    },
+    stepPaywall: {
+        id: 'paywall',
+        name: 'paywall',
+        type: 'paywall_offer',
+        kind: 'paywall',
+        figmaNodeId: 'fixture:paywall',
+        title: 'Paywall',
+        description: 'Present the primary offer.',
+    },
+    stepPaywallB: {
+        id: 'paywall-b',
+        name: 'paywall-b',
+        type: 'paywall_offer',
+        kind: 'paywall',
+        figmaNodeId: 'fixture:paywall-b',
+        title: 'Paywall B',
+        description: 'Present the alternate offer.',
+    },
+    stepSubscriptionStarted: {
+        id: 'subscription-started',
+        name: 'subscription-started',
+        type: 'complete_registration',
+        kind: 'subscription-handoff',
+        figmaNodeId: 'fixture:subscription-started',
+        title: 'Subscription started',
+        description: 'Complete the funnel after subscription handoff.',
+    },
+    stepManageSubscription: {
+        id: 'manage-subscription',
+        name: 'manage-subscription',
+        type: 'subscription_management',
+        kind: 'manage-subscription',
+        figmaNodeId: 'fixture:manage-subscription',
+        title: 'Manage subscription',
+        description: 'Manage the active subscription.',
+    },
+};
+export const validV2ProjectSnapshot = {
+    manifest: validV2ProjectManifest,
+    componentMetaByKey: validV2ProjectComponentMetaByKey,
+    registeredComponentKeys: [
+        'stepOne',
+        'stepTwo',
+        'stepEmailCapture',
+        'stepPaywall',
+        'stepPaywallB',
+        'stepSubscriptionStarted',
+        'stepManageSubscription',
+    ],
+    contentOptionsByStepId: {
+        'step-2': [
+            {
+                id: 'phone',
+                label: 'Phone',
+                imageSrc: '/images/phone.png',
+            },
+        ],
+    },
+    edgesByStepId: validV2ProjectManifest.edgesByStepId,
+    experiments: validV2ProjectManifest.experiments,
+    docs: {
+        schemaVersion: 1,
+        bundleVersion: '2.0.0',
+        stepContractVersion: 2,
+        contractHash: CURRENT_STEP_CONTRACT_HASH,
+        missing: [],
+        changed: [],
+        conflicts: [],
+    },
+};