@cognior/iap-sdk 0.0.2

package/dist/index.d.ts

@@ -0,0 +1,113 @@
+/**
+ * User interface - follows DAP standard user model
+ */
+interface DapUser {
+    id: string;
+    role?: string;
+    email?: string;
+    attributes?: Record<string, string>;
+}
+
+/** Logical operators for composite triggers */
+type LogicalOperator = "And" | "Or";
+/** Rule operators for condition evaluation */
+type RuleOperator = "Equals" | "NotEquals" | "Contains" | "NotContains" | "StartsWith" | "EndsWith" | "GreaterThan" | "LessThan" | "GreaterThanOrEqual" | "LessThanOrEqual" | "In" | "NotIn" | "Regex" | "Empty";
+/** Trigger types */
+type TriggerType = "Single" | "Composite";
+/** Trigger condition kinds */
+type TriggerConditionKind = "Dom" | "Lifecycle" | "Input" | "Time" | "Media" | "System";
+/** Flow execution modes */
+type FlowExecutionMode = "Linear" | "AnyOrder";
+/** Individual trigger condition */
+interface TriggerCondition {
+    kind: TriggerConditionKind;
+    event: string;
+    selector?: string;
+    operator?: RuleOperator;
+    value?: any;
+    debounceMs?: number;
+}
+/** Step-level trigger definition */
+interface TriggerDefinition {
+    type: TriggerType;
+    operator: LogicalOperator;
+    once: boolean;
+    conditions: TriggerCondition[];
+}
+
+/**
+ * Enhanced step interface with trigger support
+ */
+interface EnhancedStepData {
+    stepId: string;
+    stepOrder: number;
+    stepType: string;
+    trigger?: TriggerDefinition;
+    uxExperience?: {
+        uxExperienceType: string;
+        elementSelector?: string;
+        elementTrigger?: string;
+        elementLocation?: string;
+        position?: {
+            x: string;
+            y: string;
+        };
+        content: any;
+        modalContent?: any;
+    };
+    conditionRuleBlocks?: any[];
+    userInputSelector?: string | null;
+}
+
+interface FlowData {
+    flowId: string;
+    flowName: string;
+    steps: EnhancedStepData[];
+    execution?: {
+        mode?: FlowExecutionMode;
+        multiPage?: boolean;
+        frequency?: {
+            type: 'OneTime' | 'Daily' | 'Weekly' | 'Monthly';
+            maxRuns: number;
+        };
+        frequencyType?: string;
+    };
+}
+
+/**
+ * Initialize DAP SDK with optional user context
+ */
+declare function init(opts: {
+    configUrl: string;
+    debug?: boolean;
+    screenId?: string;
+    user?: DapUser;
+}): Promise<void>;
+/**
+ * Set user context and trigger flow re-evaluation
+ */
+declare function setUser(user: DapUser): void;
+/**
+ * Update existing user context
+ */
+declare function updateUser(partialUser: Partial<DapUser>): void;
+/**
+ * Get current user context
+ */
+declare function getUser(): DapUser | null;
+/**
+ * Clear user context
+ */
+declare function clearUser(): void;
+declare function runModalSequence(): void;
+declare function executeFlow(flow: any): Promise<void>;
+/**
+ * Register a flow for later execution by ID
+ */
+declare function registerFlow(flowData: FlowData): void;
+/**
+ * Start a flow by ID (from registered flows or backend)
+ */
+declare function startFlow(flowId: string): Promise<void>;
+
+export { type DapUser, clearUser, executeFlow, getUser, init, registerFlow, runModalSequence, setUser, startFlow, updateUser };