@syntrologie/adapt-overlays 2.4.0 → 2.5.1

package/dist/schema.d.ts

@@ -254,8 +254,8 @@ export declare const configSchema: z.ZodObject<{
         startStep: z.ZodOptional<z.ZodString>;
         autoStart: z.ZodOptional<z.ZodBoolean>;
     }, "strip", z.ZodTypeAny, {
-        summary: string;
         tourId: string;
+        summary: string;
         steps: {
             id: string;
             action: Record<string, unknown>;
@@ -265,8 +265,8 @@ export declare const configSchema: z.ZodObject<{
         startStep?: string | undefined;
         autoStart?: boolean | undefined;
     }, {
-        summary: string;
         tourId: string;
+        summary: string;
         steps: {
             id: string;
             action: Record<string, unknown>;
@@ -335,8 +335,8 @@ export declare const configSchema: z.ZodObject<{
         }[] | undefined;
     }[] | undefined;
     tours?: {
-        summary: string;
         tourId: string;
+        summary: string;
         steps: {
             id: string;
             action: Record<string, unknown>;
@@ -405,8 +405,8 @@ export declare const configSchema: z.ZodObject<{
         }[] | undefined;
     }[] | undefined;
     tours?: {
-        summary: string;
         tourId: string;
+        summary: string;
         steps: {
             id: string;
             action: Record<string, unknown>;
@@ -418,4 +418,684 @@ export declare const configSchema: z.ZodObject<{
     }[] | undefined;
 }>;
 export type OverlaysConfig = z.infer<typeof configSchema>;
+export declare const actionStepSchemas: {
+    defName: string;
+    schema: z.ZodObject<{
+        kind: z.ZodLiteral<"overlays:celebrate">;
+        effect: z.ZodString;
+        duration: z.ZodOptional<z.ZodNumber>;
+        intensity: z.ZodOptional<z.ZodEnum<["light", "medium", "heavy"]>>;
+        colors: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        label: z.ZodOptional<z.ZodString>;
+        triggerWhen: z.ZodOptional<z.ZodNullable<z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+            type: z.ZodLiteral<"rules">;
+            rules: z.ZodArray<z.ZodObject<{
+                conditions: z.ZodArray<z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+                    type: z.ZodLiteral<"page_url">;
+                    url: z.ZodString;
+                }, "strip", z.ZodTypeAny, {
+                    type: "page_url";
+                    url: string;
+                }, {
+                    type: "page_url";
+                    url: string;
+                }>, z.ZodObject<{
+                    type: z.ZodLiteral<"route">;
+                    routeId: z.ZodString;
+                }, "strip", z.ZodTypeAny, {
+                    type: "route";
+                    routeId: string;
+                }, {
+                    type: "route";
+                    routeId: string;
+                }>, z.ZodObject<{
+                    type: z.ZodLiteral<"anchor_visible">;
+                    anchorId: z.ZodString;
+                    state: z.ZodEnum<["visible", "present", "absent"]>;
+                }, "strip", z.ZodTypeAny, {
+                    type: "anchor_visible";
+                    anchorId: string;
+                    state: "visible" | "present" | "absent";
+                }, {
+                    type: "anchor_visible";
+                    anchorId: string;
+                    state: "visible" | "present" | "absent";
+                }>, z.ZodObject<{
+                    type: z.ZodLiteral<"event_occurred">;
+                    eventName: z.ZodString;
+                    withinMs: z.ZodOptional<z.ZodNumber>;
+                }, "strip", z.ZodTypeAny, {
+                    type: "event_occurred";
+                    eventName: string;
+                    withinMs?: number | undefined;
+                }, {
+                    type: "event_occurred";
+                    eventName: string;
+                    withinMs?: number | undefined;
+                }>, z.ZodObject<{
+                    type: z.ZodLiteral<"state_equals">;
+                    key: z.ZodString;
+                    value: z.ZodUnknown;
+                }, "strip", z.ZodTypeAny, {
+                    type: "state_equals";
+                    key: string;
+                    value?: unknown;
+                }, {
+                    type: "state_equals";
+                    key: string;
+                    value?: unknown;
+                }>, z.ZodObject<{
+                    type: z.ZodLiteral<"viewport">;
+                    minWidth: z.ZodOptional<z.ZodNumber>;
+                    maxWidth: z.ZodOptional<z.ZodNumber>;
+                    minHeight: z.ZodOptional<z.ZodNumber>;
+                    maxHeight: z.ZodOptional<z.ZodNumber>;
+                }, "strip", z.ZodTypeAny, {
+                    type: "viewport";
+                    minWidth?: number | undefined;
+                    maxWidth?: number | undefined;
+                    minHeight?: number | undefined;
+                    maxHeight?: number | undefined;
+                }, {
+                    type: "viewport";
+                    minWidth?: number | undefined;
+                    maxWidth?: number | undefined;
+                    minHeight?: number | undefined;
+                    maxHeight?: number | undefined;
+                }>, z.ZodObject<{
+                    type: z.ZodLiteral<"session_metric">;
+                    key: z.ZodString;
+                    operator: z.ZodEnum<["gte", "lte", "eq", "gt", "lt"]>;
+                    threshold: z.ZodNumber;
+                }, "strip", z.ZodTypeAny, {
+                    type: "session_metric";
+                    key: string;
+                    operator: "gte" | "lte" | "eq" | "gt" | "lt";
+                    threshold: number;
+                }, {
+                    type: "session_metric";
+                    key: string;
+                    operator: "gte" | "lte" | "eq" | "gt" | "lt";
+                    threshold: number;
+                }>, z.ZodObject<{
+                    type: z.ZodLiteral<"dismissed">;
+                    key: z.ZodString;
+                    inverted: z.ZodOptional<z.ZodBoolean>;
+                }, "strip", z.ZodTypeAny, {
+                    type: "dismissed";
+                    key: string;
+                    inverted?: boolean | undefined;
+                }, {
+                    type: "dismissed";
+                    key: string;
+                    inverted?: boolean | undefined;
+                }>, z.ZodObject<{
+                    type: z.ZodLiteral<"cooldown_active">;
+                    key: z.ZodString;
+                    inverted: z.ZodOptional<z.ZodBoolean>;
+                }, "strip", z.ZodTypeAny, {
+                    type: "cooldown_active";
+                    key: string;
+                    inverted?: boolean | undefined;
+                }, {
+                    type: "cooldown_active";
+                    key: string;
+                    inverted?: boolean | undefined;
+                }>, z.ZodObject<{
+                    type: z.ZodLiteral<"frequency_limit">;
+                    key: z.ZodString;
+                    limit: z.ZodNumber;
+                    inverted: z.ZodOptional<z.ZodBoolean>;
+                }, "strip", z.ZodTypeAny, {
+                    type: "frequency_limit";
+                    key: string;
+                    limit: number;
+                    inverted?: boolean | undefined;
+                }, {
+                    type: "frequency_limit";
+                    key: string;
+                    limit: number;
+                    inverted?: boolean | undefined;
+                }>, z.ZodObject<{
+                    type: z.ZodLiteral<"event_count">;
+                    key: z.ZodString;
+                    operator: z.ZodEnum<["gte", "lte", "eq", "gt", "lt"]>;
+                    count: z.ZodNumber;
+                    withinMs: z.ZodOptional<z.ZodNumber>;
+                    counter: z.ZodOptional<z.ZodObject<{
+                        events: z.ZodArray<z.ZodString, "many">;
+                        match: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+                            equals: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
+                            contains: z.ZodOptional<z.ZodString>;
+                        }, "strip", z.ZodTypeAny, {
+                            equals?: string | number | boolean | undefined;
+                            contains?: string | undefined;
+                        }, {
+                            equals?: string | number | boolean | undefined;
+                            contains?: string | undefined;
+                        }>>>;
+                    }, "strip", z.ZodTypeAny, {
+                        events: string[];
+                        match?: Record<string, {
+                            equals?: string | number | boolean | undefined;
+                            contains?: string | undefined;
+                        }> | undefined;
+                    }, {
+                        events: string[];
+                        match?: Record<string, {
+                            equals?: string | number | boolean | undefined;
+                            contains?: string | undefined;
+                        }> | undefined;
+                    }>>;
+                }, "strip", z.ZodTypeAny, {
+                    type: "event_count";
+                    key: string;
+                    operator: "gte" | "lte" | "eq" | "gt" | "lt";
+                    count: number;
+                    withinMs?: number | undefined;
+                    counter?: {
+                        events: string[];
+                        match?: Record<string, {
+                            equals?: string | number | boolean | undefined;
+                            contains?: string | undefined;
+                        }> | undefined;
+                    } | undefined;
+                }, {
+                    type: "event_count";
+                    key: string;
+                    operator: "gte" | "lte" | "eq" | "gt" | "lt";
+                    count: number;
+                    withinMs?: number | undefined;
+                    counter?: {
+                        events: string[];
+                        match?: Record<string, {
+                            equals?: string | number | boolean | undefined;
+                            contains?: string | undefined;
+                        }> | undefined;
+                    } | undefined;
+                }>]>, "many">;
+                value: z.ZodUnknown;
+            }, "strip", z.ZodTypeAny, {
+                conditions: ({
+                    type: "page_url";
+                    url: string;
+                } | {
+                    type: "route";
+                    routeId: string;
+                } | {
+                    type: "anchor_visible";
+                    anchorId: string;
+                    state: "visible" | "present" | "absent";
+                } | {
+                    type: "event_occurred";
+                    eventName: string;
+                    withinMs?: number | undefined;
+                } | {
+                    type: "state_equals";
+                    key: string;
+                    value?: unknown;
+                } | {
+                    type: "viewport";
+                    minWidth?: number | undefined;
+                    maxWidth?: number | undefined;
+                    minHeight?: number | undefined;
+                    maxHeight?: number | undefined;
+                } | {
+                    type: "session_metric";
+                    key: string;
+                    operator: "gte" | "lte" | "eq" | "gt" | "lt";
+                    threshold: number;
+                } | {
+                    type: "dismissed";
+                    key: string;
+                    inverted?: boolean | undefined;
+                } | {
+                    type: "cooldown_active";
+                    key: string;
+                    inverted?: boolean | undefined;
+                } | {
+                    type: "frequency_limit";
+                    key: string;
+                    limit: number;
+                    inverted?: boolean | undefined;
+                } | {
+                    type: "event_count";
+                    key: string;
+                    operator: "gte" | "lte" | "eq" | "gt" | "lt";
+                    count: number;
+                    withinMs?: number | undefined;
+                    counter?: {
+                        events: string[];
+                        match?: Record<string, {
+                            equals?: string | number | boolean | undefined;
+                            contains?: string | undefined;
+                        }> | undefined;
+                    } | undefined;
+                })[];
+                value?: unknown;
+            }, {
+                conditions: ({
+                    type: "page_url";
+                    url: string;
+                } | {
+                    type: "route";
+                    routeId: string;
+                } | {
+                    type: "anchor_visible";
+                    anchorId: string;
+                    state: "visible" | "present" | "absent";
+                } | {
+                    type: "event_occurred";
+                    eventName: string;
+                    withinMs?: number | undefined;
+                } | {
+                    type: "state_equals";
+                    key: string;
+                    value?: unknown;
+                } | {
+                    type: "viewport";
+                    minWidth?: number | undefined;
+                    maxWidth?: number | undefined;
+                    minHeight?: number | undefined;
+                    maxHeight?: number | undefined;
+                } | {
+                    type: "session_metric";
+                    key: string;
+                    operator: "gte" | "lte" | "eq" | "gt" | "lt";
+                    threshold: number;
+                } | {
+                    type: "dismissed";
+                    key: string;
+                    inverted?: boolean | undefined;
+                } | {
+                    type: "cooldown_active";
+                    key: string;
+                    inverted?: boolean | undefined;
+                } | {
+                    type: "frequency_limit";
+                    key: string;
+                    limit: number;
+                    inverted?: boolean | undefined;
+                } | {
+                    type: "event_count";
+                    key: string;
+                    operator: "gte" | "lte" | "eq" | "gt" | "lt";
+                    count: number;
+                    withinMs?: number | undefined;
+                    counter?: {
+                        events: string[];
+                        match?: Record<string, {
+                            equals?: string | number | boolean | undefined;
+                            contains?: string | undefined;
+                        }> | undefined;
+                    } | undefined;
+                })[];
+                value?: unknown;
+            }>, "many">;
+            default: z.ZodUnknown;
+        }, "strip", z.ZodTypeAny, {
+            type: "rules";
+            rules: {
+                conditions: ({
+                    type: "page_url";
+                    url: string;
+                } | {
+                    type: "route";
+                    routeId: string;
+                } | {
+                    type: "anchor_visible";
+                    anchorId: string;
+                    state: "visible" | "present" | "absent";
+                } | {
+                    type: "event_occurred";
+                    eventName: string;
+                    withinMs?: number | undefined;
+                } | {
+                    type: "state_equals";
+                    key: string;
+                    value?: unknown;
+                } | {
+                    type: "viewport";
+                    minWidth?: number | undefined;
+                    maxWidth?: number | undefined;
+                    minHeight?: number | undefined;
+                    maxHeight?: number | undefined;
+                } | {
+                    type: "session_metric";
+                    key: string;
+                    operator: "gte" | "lte" | "eq" | "gt" | "lt";
+                    threshold: number;
+                } | {
+                    type: "dismissed";
+                    key: string;
+                    inverted?: boolean | undefined;
+                } | {
+                    type: "cooldown_active";
+                    key: string;
+                    inverted?: boolean | undefined;
+                } | {
+                    type: "frequency_limit";
+                    key: string;
+                    limit: number;
+                    inverted?: boolean | undefined;
+                } | {
+                    type: "event_count";
+                    key: string;
+                    operator: "gte" | "lte" | "eq" | "gt" | "lt";
+                    count: number;
+                    withinMs?: number | undefined;
+                    counter?: {
+                        events: string[];
+                        match?: Record<string, {
+                            equals?: string | number | boolean | undefined;
+                            contains?: string | undefined;
+                        }> | undefined;
+                    } | undefined;
+                })[];
+                value?: unknown;
+            }[];
+            default?: unknown;
+        }, {
+            type: "rules";
+            rules: {
+                conditions: ({
+                    type: "page_url";
+                    url: string;
+                } | {
+                    type: "route";
+                    routeId: string;
+                } | {
+                    type: "anchor_visible";
+                    anchorId: string;
+                    state: "visible" | "present" | "absent";
+                } | {
+                    type: "event_occurred";
+                    eventName: string;
+                    withinMs?: number | undefined;
+                } | {
+                    type: "state_equals";
+                    key: string;
+                    value?: unknown;
+                } | {
+                    type: "viewport";
+                    minWidth?: number | undefined;
+                    maxWidth?: number | undefined;
+                    minHeight?: number | undefined;
+                    maxHeight?: number | undefined;
+                } | {
+                    type: "session_metric";
+                    key: string;
+                    operator: "gte" | "lte" | "eq" | "gt" | "lt";
+                    threshold: number;
+                } | {
+                    type: "dismissed";
+                    key: string;
+                    inverted?: boolean | undefined;
+                } | {
+                    type: "cooldown_active";
+                    key: string;
+                    inverted?: boolean | undefined;
+                } | {
+                    type: "frequency_limit";
+                    key: string;
+                    limit: number;
+                    inverted?: boolean | undefined;
+                } | {
+                    type: "event_count";
+                    key: string;
+                    operator: "gte" | "lte" | "eq" | "gt" | "lt";
+                    count: number;
+                    withinMs?: number | undefined;
+                    counter?: {
+                        events: string[];
+                        match?: Record<string, {
+                            equals?: string | number | boolean | undefined;
+                            contains?: string | undefined;
+                        }> | undefined;
+                    } | undefined;
+                })[];
+                value?: unknown;
+            }[];
+            default?: unknown;
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"score">;
+            field: z.ZodString;
+            threshold: z.ZodNumber;
+            above: z.ZodUnknown;
+            below: z.ZodUnknown;
+        }, "strip", z.ZodTypeAny, {
+            type: "score";
+            threshold: number;
+            field: string;
+            above?: unknown;
+            below?: unknown;
+        }, {
+            type: "score";
+            threshold: number;
+            field: string;
+            above?: unknown;
+            below?: unknown;
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"model">;
+            modelId: z.ZodString;
+            inputs: z.ZodArray<z.ZodString, "many">;
+            outputMapping: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+            default: z.ZodUnknown;
+        }, "strip", z.ZodTypeAny, {
+            type: "model";
+            modelId: string;
+            inputs: string[];
+            outputMapping: Record<string, unknown>;
+            default?: unknown;
+        }, {
+            type: "model";
+            modelId: string;
+            inputs: string[];
+            outputMapping: Record<string, unknown>;
+            default?: unknown;
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"external">;
+            endpoint: z.ZodString;
+            method: z.ZodOptional<z.ZodEnum<["GET", "POST"]>>;
+            default: z.ZodUnknown;
+            timeoutMs: z.ZodOptional<z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            type: "external";
+            endpoint: string;
+            default?: unknown;
+            method?: "GET" | "POST" | undefined;
+            timeoutMs?: number | undefined;
+        }, {
+            type: "external";
+            endpoint: string;
+            default?: unknown;
+            method?: "GET" | "POST" | undefined;
+            timeoutMs?: number | undefined;
+        }>]>>>;
+    }, "strict", z.ZodTypeAny, {
+        kind: "overlays:celebrate";
+        effect: string;
+        label?: string | undefined;
+        props?: Record<string, unknown> | undefined;
+        triggerWhen?: {
+            type: "rules";
+            rules: {
+                conditions: ({
+                    type: "page_url";
+                    url: string;
+                } | {
+                    type: "route";
+                    routeId: string;
+                } | {
+                    type: "anchor_visible";
+                    anchorId: string;
+                    state: "visible" | "present" | "absent";
+                } | {
+                    type: "event_occurred";
+                    eventName: string;
+                    withinMs?: number | undefined;
+                } | {
+                    type: "state_equals";
+                    key: string;
+                    value?: unknown;
+                } | {
+                    type: "viewport";
+                    minWidth?: number | undefined;
+                    maxWidth?: number | undefined;
+                    minHeight?: number | undefined;
+                    maxHeight?: number | undefined;
+                } | {
+                    type: "session_metric";
+                    key: string;
+                    operator: "gte" | "lte" | "eq" | "gt" | "lt";
+                    threshold: number;
+                } | {
+                    type: "dismissed";
+                    key: string;
+                    inverted?: boolean | undefined;
+                } | {
+                    type: "cooldown_active";
+                    key: string;
+                    inverted?: boolean | undefined;
+                } | {
+                    type: "frequency_limit";
+                    key: string;
+                    limit: number;
+                    inverted?: boolean | undefined;
+                } | {
+                    type: "event_count";
+                    key: string;
+                    operator: "gte" | "lte" | "eq" | "gt" | "lt";
+                    count: number;
+                    withinMs?: number | undefined;
+                    counter?: {
+                        events: string[];
+                        match?: Record<string, {
+                            equals?: string | number | boolean | undefined;
+                            contains?: string | undefined;
+                        }> | undefined;
+                    } | undefined;
+                })[];
+                value?: unknown;
+            }[];
+            default?: unknown;
+        } | {
+            type: "score";
+            threshold: number;
+            field: string;
+            above?: unknown;
+            below?: unknown;
+        } | {
+            type: "model";
+            modelId: string;
+            inputs: string[];
+            outputMapping: Record<string, unknown>;
+            default?: unknown;
+        } | {
+            type: "external";
+            endpoint: string;
+            default?: unknown;
+            method?: "GET" | "POST" | undefined;
+            timeoutMs?: number | undefined;
+        } | null | undefined;
+        duration?: number | undefined;
+        intensity?: "medium" | "light" | "heavy" | undefined;
+        colors?: string[] | undefined;
+    }, {
+        kind: "overlays:celebrate";
+        effect: string;
+        label?: string | undefined;
+        props?: Record<string, unknown> | undefined;
+        triggerWhen?: {
+            type: "rules";
+            rules: {
+                conditions: ({
+                    type: "page_url";
+                    url: string;
+                } | {
+                    type: "route";
+                    routeId: string;
+                } | {
+                    type: "anchor_visible";
+                    anchorId: string;
+                    state: "visible" | "present" | "absent";
+                } | {
+                    type: "event_occurred";
+                    eventName: string;
+                    withinMs?: number | undefined;
+                } | {
+                    type: "state_equals";
+                    key: string;
+                    value?: unknown;
+                } | {
+                    type: "viewport";
+                    minWidth?: number | undefined;
+                    maxWidth?: number | undefined;
+                    minHeight?: number | undefined;
+                    maxHeight?: number | undefined;
+                } | {
+                    type: "session_metric";
+                    key: string;
+                    operator: "gte" | "lte" | "eq" | "gt" | "lt";
+                    threshold: number;
+                } | {
+                    type: "dismissed";
+                    key: string;
+                    inverted?: boolean | undefined;
+                } | {
+                    type: "cooldown_active";
+                    key: string;
+                    inverted?: boolean | undefined;
+                } | {
+                    type: "frequency_limit";
+                    key: string;
+                    limit: number;
+                    inverted?: boolean | undefined;
+                } | {
+                    type: "event_count";
+                    key: string;
+                    operator: "gte" | "lte" | "eq" | "gt" | "lt";
+                    count: number;
+                    withinMs?: number | undefined;
+                    counter?: {
+                        events: string[];
+                        match?: Record<string, {
+                            equals?: string | number | boolean | undefined;
+                            contains?: string | undefined;
+                        }> | undefined;
+                    } | undefined;
+                })[];
+                value?: unknown;
+            }[];
+            default?: unknown;
+        } | {
+            type: "score";
+            threshold: number;
+            field: string;
+            above?: unknown;
+            below?: unknown;
+        } | {
+            type: "model";
+            modelId: string;
+            inputs: string[];
+            outputMapping: Record<string, unknown>;
+            default?: unknown;
+        } | {
+            type: "external";
+            endpoint: string;
+            default?: unknown;
+            method?: "GET" | "POST" | undefined;
+            timeoutMs?: number | undefined;
+        } | null | undefined;
+        duration?: number | undefined;
+        intensity?: "medium" | "light" | "heavy" | undefined;
+        colors?: string[] | undefined;
+    }>;
+}[];
+export declare const tileWidgets: {
+    widget: string;
+    defName: string;
+    propsSchema: z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>;
+}[];
 //# sourceMappingURL=schema.d.ts.map