@getrheo/contracts 1.0.0

package/dist/externalSurfaces.d.ts

@@ -0,0 +1,177 @@
+import { z } from 'zod';
+import { FlowJumpTarget } from './decisions.js';
+
+declare const ExternalSurfaceNodeIdSchema: z.ZodString;
+type ExternalSurfaceNodeId = z.infer<typeof ExternalSurfaceNodeIdSchema>;
+declare const NORMALIZED_SURFACE_OUTCOMES: readonly ["purchase_completed", "purchase_cancelled", "dismissed", "failed", "restore_completed"];
+declare const NormalizedSurfaceOutcomeSchema: z.ZodEnum<["purchase_completed", "purchase_cancelled", "dismissed", "failed", "restore_completed"]>;
+type NormalizedSurfaceOutcome = z.infer<typeof NormalizedSurfaceOutcomeSchema>;
+declare const SurfaceProviderSchema: z.ZodEnum<["unspecified", "revenuecat"]>;
+type SurfaceProvider = z.infer<typeof SurfaceProviderSchema>;
+/** Authoring-only: integration not chosen yet in the flow editor. Resolves like a failed surface at runtime until changed. */
+declare const UnspecifiedExternalSurfaceConfigSchema: z.ZodObject<{
+    provider: z.ZodLiteral<"unspecified">;
+}, "strip", z.ZodTypeAny, {
+    provider: "unspecified";
+}, {
+    provider: "unspecified";
+}>;
+type UnspecifiedExternalSurfaceConfig = z.infer<typeof UnspecifiedExternalSurfaceConfigSchema>;
+declare const RevenueCatSurfacePresentationSchema: z.ZodEnum<["paywall", "paywall_if_needed"]>;
+type RevenueCatSurfacePresentation = z.infer<typeof RevenueCatSurfacePresentationSchema>;
+/**
+ * RevenueCat surface configuration. The builder stores these as free text;
+ * Rheo does not call RevenueCat's REST API to validate them.
+ */
+declare const RevenueCatSurfaceConfigSchema: z.ZodObject<{
+    provider: z.ZodLiteral<"revenuecat">;
+    offeringId: z.ZodOptional<z.ZodString>;
+    placementId: z.ZodOptional<z.ZodString>;
+    presentation: z.ZodOptional<z.ZodEnum<["paywall", "paywall_if_needed"]>>;
+}, "strip", z.ZodTypeAny, {
+    provider: "revenuecat";
+    offeringId?: string | undefined;
+    placementId?: string | undefined;
+    presentation?: "paywall" | "paywall_if_needed" | undefined;
+}, {
+    provider: "revenuecat";
+    offeringId?: string | undefined;
+    placementId?: string | undefined;
+    presentation?: "paywall" | "paywall_if_needed" | undefined;
+}>;
+type RevenueCatSurfaceConfig = z.infer<typeof RevenueCatSurfaceConfigSchema>;
+/** Future providers (Superwall, etc.) extend this discriminated union. */
+declare const ExternalSurfaceConfigSchema: z.ZodDiscriminatedUnion<"provider", [z.ZodObject<{
+    provider: z.ZodLiteral<"unspecified">;
+}, "strip", z.ZodTypeAny, {
+    provider: "unspecified";
+}, {
+    provider: "unspecified";
+}>, z.ZodObject<{
+    provider: z.ZodLiteral<"revenuecat">;
+    offeringId: z.ZodOptional<z.ZodString>;
+    placementId: z.ZodOptional<z.ZodString>;
+    presentation: z.ZodOptional<z.ZodEnum<["paywall", "paywall_if_needed"]>>;
+}, "strip", z.ZodTypeAny, {
+    provider: "revenuecat";
+    offeringId?: string | undefined;
+    placementId?: string | undefined;
+    presentation?: "paywall" | "paywall_if_needed" | undefined;
+}, {
+    provider: "revenuecat";
+    offeringId?: string | undefined;
+    placementId?: string | undefined;
+    presentation?: "paywall" | "paywall_if_needed" | undefined;
+}>]>;
+type ExternalSurfaceConfig = z.infer<typeof ExternalSurfaceConfigSchema>;
+declare const ExternalSurfaceOutcomesMapSchema: z.ZodObject<{
+    purchase_completed: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodString]>, z.ZodString]>, z.ZodLiteral<"__onb_surface_no_next__">]>>>;
+    purchase_cancelled: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodString]>, z.ZodString]>, z.ZodLiteral<"__onb_surface_no_next__">]>>>;
+    dismissed: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodString]>, z.ZodString]>, z.ZodLiteral<"__onb_surface_no_next__">]>>>;
+    failed: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodString]>, z.ZodString]>, z.ZodLiteral<"__onb_surface_no_next__">]>>>;
+    restore_completed: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodString]>, z.ZodString]>, z.ZodLiteral<"__onb_surface_no_next__">]>>>;
+}, "strict", z.ZodTypeAny, {
+    dismissed?: string | null | undefined;
+    purchase_completed?: string | null | undefined;
+    purchase_cancelled?: string | null | undefined;
+    failed?: string | null | undefined;
+    restore_completed?: string | null | undefined;
+}, {
+    dismissed?: string | null | undefined;
+    purchase_completed?: string | null | undefined;
+    purchase_cancelled?: string | null | undefined;
+    failed?: string | null | undefined;
+    restore_completed?: string | null | undefined;
+}>;
+type ExternalSurfaceOutcomesMap = z.infer<typeof ExternalSurfaceOutcomesMapSchema>;
+declare const ExternalSurfaceNodeSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodOptional<z.ZodString>;
+    config: z.ZodDiscriminatedUnion<"provider", [z.ZodObject<{
+        provider: z.ZodLiteral<"unspecified">;
+    }, "strip", z.ZodTypeAny, {
+        provider: "unspecified";
+    }, {
+        provider: "unspecified";
+    }>, z.ZodObject<{
+        provider: z.ZodLiteral<"revenuecat">;
+        offeringId: z.ZodOptional<z.ZodString>;
+        placementId: z.ZodOptional<z.ZodString>;
+        presentation: z.ZodOptional<z.ZodEnum<["paywall", "paywall_if_needed"]>>;
+    }, "strip", z.ZodTypeAny, {
+        provider: "revenuecat";
+        offeringId?: string | undefined;
+        placementId?: string | undefined;
+        presentation?: "paywall" | "paywall_if_needed" | undefined;
+    }, {
+        provider: "revenuecat";
+        offeringId?: string | undefined;
+        placementId?: string | undefined;
+        presentation?: "paywall" | "paywall_if_needed" | undefined;
+    }>]>;
+    /** Per-outcome jump targets. Outcomes not listed here fall through to `fallback`. */
+    outcomes: z.ZodObject<{
+        purchase_completed: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodString]>, z.ZodString]>, z.ZodLiteral<"__onb_surface_no_next__">]>>>;
+        purchase_cancelled: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodString]>, z.ZodString]>, z.ZodLiteral<"__onb_surface_no_next__">]>>>;
+        dismissed: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodString]>, z.ZodString]>, z.ZodLiteral<"__onb_surface_no_next__">]>>>;
+        failed: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodString]>, z.ZodString]>, z.ZodLiteral<"__onb_surface_no_next__">]>>>;
+        restore_completed: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodString]>, z.ZodString]>, z.ZodLiteral<"__onb_surface_no_next__">]>>>;
+    }, "strict", z.ZodTypeAny, {
+        dismissed?: string | null | undefined;
+        purchase_completed?: string | null | undefined;
+        purchase_cancelled?: string | null | undefined;
+        failed?: string | null | undefined;
+        restore_completed?: string | null | undefined;
+    }, {
+        dismissed?: string | null | undefined;
+        purchase_completed?: string | null | undefined;
+        purchase_cancelled?: string | null | undefined;
+        failed?: string | null | undefined;
+        restore_completed?: string | null | undefined;
+    }>;
+    /** Required: used for any outcome not in `outcomes` (e.g. provider quirks, unmapped events). */
+    fallback: z.ZodNullable<z.ZodUnion<[z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodString]>, z.ZodString]>, z.ZodLiteral<"__onb_surface_no_next__">]>>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    outcomes: {
+        dismissed?: string | null | undefined;
+        purchase_completed?: string | null | undefined;
+        purchase_cancelled?: string | null | undefined;
+        failed?: string | null | undefined;
+        restore_completed?: string | null | undefined;
+    };
+    config: {
+        provider: "unspecified";
+    } | {
+        provider: "revenuecat";
+        offeringId?: string | undefined;
+        placementId?: string | undefined;
+        presentation?: "paywall" | "paywall_if_needed" | undefined;
+    };
+    fallback: string | null;
+    name?: string | undefined;
+}, {
+    id: string;
+    outcomes: {
+        dismissed?: string | null | undefined;
+        purchase_completed?: string | null | undefined;
+        purchase_cancelled?: string | null | undefined;
+        failed?: string | null | undefined;
+        restore_completed?: string | null | undefined;
+    };
+    config: {
+        provider: "unspecified";
+    } | {
+        provider: "revenuecat";
+        offeringId?: string | undefined;
+        placementId?: string | undefined;
+        presentation?: "paywall" | "paywall_if_needed" | undefined;
+    };
+    fallback: string | null;
+    name?: string | undefined;
+}>;
+type ExternalSurfaceNode = z.infer<typeof ExternalSurfaceNodeSchema>;
+/** Pick the configured target for an outcome, falling back to the explicit fallback edge. */
+declare const resolveExternalSurfaceTarget: (node: ExternalSurfaceNode, outcome: NormalizedSurfaceOutcome) => FlowJumpTarget;
+
+export { type ExternalSurfaceConfig, ExternalSurfaceConfigSchema, type ExternalSurfaceNode, type ExternalSurfaceNodeId, ExternalSurfaceNodeIdSchema, ExternalSurfaceNodeSchema, type ExternalSurfaceOutcomesMap, ExternalSurfaceOutcomesMapSchema, NORMALIZED_SURFACE_OUTCOMES, type NormalizedSurfaceOutcome, NormalizedSurfaceOutcomeSchema, type RevenueCatSurfaceConfig, RevenueCatSurfaceConfigSchema, type RevenueCatSurfacePresentation, RevenueCatSurfacePresentationSchema, type SurfaceProvider, SurfaceProviderSchema, type UnspecifiedExternalSurfaceConfig, UnspecifiedExternalSurfaceConfigSchema, resolveExternalSurfaceTarget };