@corbado/observe 0.11.0 → 0.12.0-next.94-3fd9bb7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cdn/script.global.js +1 -1
- package/dist/index.d.mts +127 -35
- package/dist/index.d.ts +127 -35
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -24,6 +24,8 @@ declare enum AuthEventName {
|
|
|
24
24
|
SubflowError = "subflow_error",
|
|
25
25
|
SubflowStarted = "subflow_started",
|
|
26
26
|
SubflowFinished = "subflow_finished",
|
|
27
|
+
/** Client-side flow enrichment (the server accepts `session_enriched` as a legacy alias). */
|
|
28
|
+
FlowEnriched = "flow_enriched",
|
|
27
29
|
Conversion = "conversion"
|
|
28
30
|
}
|
|
29
31
|
interface BaseEvent {
|
|
@@ -51,7 +53,6 @@ interface BaseEvent {
|
|
|
51
53
|
type UserReference = {
|
|
52
54
|
userId?: string;
|
|
53
55
|
identifier?: string;
|
|
54
|
-
crossEnvironmentTransactionID?: string;
|
|
55
56
|
};
|
|
56
57
|
/**
|
|
57
58
|
* Serializable error shape produced by {@link normalizeError}.
|
|
@@ -105,7 +106,8 @@ type AuthMethodDecisionStarted = {
|
|
|
105
106
|
};
|
|
106
107
|
type AuthMethodDecisionFinished = {
|
|
107
108
|
decisionName: string;
|
|
108
|
-
|
|
109
|
+
/** Optional — when omitted, the backend completes the open decision of the same name using its declared options (classifier follow-up). */
|
|
110
|
+
options?: (AuthMethodType | (string & {}))[];
|
|
109
111
|
explicitDecisionValue?: string;
|
|
110
112
|
};
|
|
111
113
|
type ProvideIdentifierStart = {};
|
|
@@ -283,6 +285,16 @@ interface SdkRetryConfig {
|
|
|
283
285
|
/** Maximum backoff delay between attempts, in milliseconds. */
|
|
284
286
|
maxDelayMs: number;
|
|
285
287
|
}
|
|
288
|
+
/**
|
|
289
|
+
* Read-only view of the SDK configuration in force for one page load, as returned by
|
|
290
|
+
* `CorbadoTracker.getSdkConfig()`. Only the fields declared here are public; the delivery internals
|
|
291
|
+
* of {@link SdkReliabilityConfig} are deliberately not exposed and may change.
|
|
292
|
+
*/
|
|
293
|
+
type ObserveSdkConfigSnapshot = {
|
|
294
|
+
/** Server config version this load is running; empty string when running the built-in defaults. */
|
|
295
|
+
readonly version: string;
|
|
296
|
+
readonly aap: string;
|
|
297
|
+
};
|
|
286
298
|
/**
|
|
287
299
|
* SDK reliability configuration returned by the events endpoint (opt-in via the
|
|
288
300
|
* `X-Corbado-Observe-Config` header). Mirrors the server `observeEventCreateRes` schema.
|
|
@@ -377,6 +389,11 @@ interface SdkReliabilityConfig {
|
|
|
377
389
|
* run permanently.
|
|
378
390
|
*/
|
|
379
391
|
deviceInfoTiming: boolean;
|
|
392
|
+
/**
|
|
393
|
+
* How far autocapture may attach when another integration already holds the surface it
|
|
394
|
+
* instruments.
|
|
395
|
+
*/
|
|
396
|
+
aap: string;
|
|
380
397
|
/** Retry configuration for failed event flushes. */
|
|
381
398
|
retry: SdkRetryConfig;
|
|
382
399
|
}
|
|
@@ -460,6 +477,17 @@ declare class LowEventWindowTracker {
|
|
|
460
477
|
* picker dismiss animations land shortly after the WebAuthn promise resolves/rejects.
|
|
461
478
|
*/
|
|
462
479
|
declare const CEREMONY_LOW_EVENT_TAIL_MS = 1500;
|
|
480
|
+
/**
|
|
481
|
+
* Common constructor options shared by all operation helpers: every helper emits
|
|
482
|
+
* `subflow_started` from its constructor unless opted out.
|
|
483
|
+
*/
|
|
484
|
+
type OperationConfig = {
|
|
485
|
+
/**
|
|
486
|
+
* Emit `subflow_started` from the constructor (default `true`). Set to `false` to opt out and
|
|
487
|
+
* call {@link OperationFull.subflowStart} yourself.
|
|
488
|
+
*/
|
|
489
|
+
autoStart?: boolean;
|
|
490
|
+
};
|
|
463
491
|
type StepHelper<TStart = {}, TFinished = {}, TTypedError = never> = {
|
|
464
492
|
start: (data: TStart, options?: StepOptions) => void;
|
|
465
493
|
finished: (data: TFinished, options?: StepOptions) => void;
|
|
@@ -471,7 +499,11 @@ declare abstract class OperationFull {
|
|
|
471
499
|
private tracker;
|
|
472
500
|
private operationName;
|
|
473
501
|
constructor(tracker: CorbadoTracker, operationName: SubflowType);
|
|
502
|
+
/** Emit `subflow_started` for this operation. Only needed after opting out via `autoStart: false`. */
|
|
474
503
|
subflowStart(data: any, options?: StepOptions): void;
|
|
504
|
+
/**
|
|
505
|
+
* @deprecated `subflow_trigger` will be removed in the next major version.
|
|
506
|
+
*/
|
|
475
507
|
trigger(data: SubflowTrigger, options?: StepOptions): void;
|
|
476
508
|
customStep<TStart = {}, TFinished = {}>(stepName: string): StepHelper<TStart, TFinished>;
|
|
477
509
|
protected subflowStepStarted(stepName: string, data: any, options?: StepOptions, ignoreAsInteraction?: boolean): void;
|
|
@@ -525,12 +557,16 @@ type PasskeyLoginPostResponseStart = {
|
|
|
525
557
|
*/
|
|
526
558
|
assertionResponse?: string;
|
|
527
559
|
};
|
|
560
|
+
type PasskeyLoginOperationConfig = OperationConfig & {
|
|
561
|
+
/** The classifier drops the attempt if no spec type arrives on any of its events — supply it here or on a step's start data as soon as known. */
|
|
562
|
+
explicitSpecType?: PasskeyOperationLoginExplicitSpecType;
|
|
563
|
+
};
|
|
528
564
|
declare class PasskeyLoginOperationFull extends OperationFull {
|
|
529
565
|
readonly getOptions: StepHelper<PasskeyLoginGetOptionsStart, PasskeyLoginGetOptionsFinished>;
|
|
530
566
|
readonly ceremony: StepHelper<PasskeyLoginCeremonyStart, PasskeyLoginCeremonyFinished>;
|
|
531
567
|
readonly postResponse: StepHelper<PasskeyLoginPostResponseStart>;
|
|
532
568
|
private lowEventTracker;
|
|
533
|
-
constructor(tracker: CorbadoTracker);
|
|
569
|
+
constructor(tracker: CorbadoTracker, config?: PasskeyLoginOperationConfig);
|
|
534
570
|
/**
|
|
535
571
|
* @deprecated `subflow_trigger` is not supported for passkey-login and will be removed in the
|
|
536
572
|
* next major version.
|
|
@@ -546,7 +582,7 @@ type EmailOTPOperationSendOTPStart = {
|
|
|
546
582
|
type EmailOTPOperationPostResponseStart = {
|
|
547
583
|
explicitSpecType?: EmailOTPOperationSpecType;
|
|
548
584
|
};
|
|
549
|
-
type EmailOTPOperationConfig = {
|
|
585
|
+
type EmailOTPOperationConfig = OperationConfig & {
|
|
550
586
|
explicitSpecType?: EmailOTPOperationSpecType;
|
|
551
587
|
};
|
|
552
588
|
declare class EmailOtpOperationFull extends OperationFull {
|
|
@@ -560,7 +596,7 @@ type SmsOTPOperationSpecType = "sms-otp-login" | "sms-otp-enrollment";
|
|
|
560
596
|
type SmsOTPOperationPostResponseStart = {
|
|
561
597
|
explicitSpecType?: SmsOTPOperationSpecType;
|
|
562
598
|
};
|
|
563
|
-
type SmsOTPOperationConfig = {
|
|
599
|
+
type SmsOTPOperationConfig = OperationConfig & {
|
|
564
600
|
explicitSpecType?: SmsOTPOperationSpecType;
|
|
565
601
|
};
|
|
566
602
|
declare class SmsOtpOperationFull extends OperationFull {
|
|
@@ -576,11 +612,15 @@ type EmailLinkOperationSendStart = {
|
|
|
576
612
|
type EmailLinkOperationPostResponseStart = {
|
|
577
613
|
explicitSpecType?: EmailLinkOperationSpecType;
|
|
578
614
|
};
|
|
615
|
+
type EmailLinkOperationConfig = OperationConfig & {
|
|
616
|
+
/** The classifier drops the attempt if no spec type arrives on any of its events — supply it here or on a step's start data as soon as known. */
|
|
617
|
+
explicitSpecType?: EmailLinkOperationSpecType;
|
|
618
|
+
};
|
|
579
619
|
declare class EmailLinkOperationFull extends OperationFull {
|
|
580
620
|
readonly send: StepHelper<EmailLinkOperationSendStart>;
|
|
581
621
|
readonly postResponse: StepHelper<EmailLinkOperationPostResponseStart>;
|
|
582
622
|
readonly resend: StepHelper;
|
|
583
|
-
constructor(tracker: CorbadoTracker);
|
|
623
|
+
constructor(tracker: CorbadoTracker, config?: EmailLinkOperationConfig);
|
|
584
624
|
}
|
|
585
625
|
|
|
586
626
|
type PasskeyOperationEnrollmentExplicitSpecType = "conditional-auto-manual" | "auto-manual" | "manual";
|
|
@@ -610,8 +650,14 @@ type PasskeyEnrollmentPostResponseStart = {
|
|
|
610
650
|
*/
|
|
611
651
|
attestationResponse?: string;
|
|
612
652
|
};
|
|
613
|
-
type PasskeyEnrollmentOperationConfig = {
|
|
653
|
+
type PasskeyEnrollmentOperationConfig = OperationConfig & {
|
|
654
|
+
/** The classifier drops the attempt if no spec type arrives on any of its events — supply it here or on a step's start data as soon as known. */
|
|
614
655
|
explicitSpecType?: PasskeyOperationEnrollmentExplicitSpecType;
|
|
656
|
+
/**
|
|
657
|
+
* Timestamp (epoch ms) for the subflow-started event. Set it when the enrollment began before the
|
|
658
|
+
* operation could be constructed.
|
|
659
|
+
*/
|
|
660
|
+
explicitTimestamp?: number;
|
|
615
661
|
};
|
|
616
662
|
declare class PasskeyEnrollmentOperationFull extends OperationFull {
|
|
617
663
|
readonly getOptions: StepHelper<PasskeyEnrollmentGetOptionsStart, PasskeyEnrollmentGetOptionsFinished>;
|
|
@@ -647,14 +693,11 @@ type PasswordLoginCUIGetOptionsFinished = {
|
|
|
647
693
|
type PasswordLoginCUICeremonyStart = {
|
|
648
694
|
explicitSpecType?: PasswordLoginCUISpecType;
|
|
649
695
|
};
|
|
650
|
-
type
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
explicitSpecType: "password-with-identifier";
|
|
656
|
-
/** The password input field. */
|
|
657
|
-
inputHtmlField: HTMLInputElement;
|
|
696
|
+
type PasswordLoginExplicitSpecType = "password-known-identifier" | "password-with-identifier";
|
|
697
|
+
type PasswordLoginAutoTrackConfig = OperationConfig & {
|
|
698
|
+
explicitSpecType?: PasswordLoginExplicitSpecType;
|
|
699
|
+
/** The password input field. When set, low-event input tracking is attached to it. */
|
|
700
|
+
inputHtmlField?: HTMLInputElement;
|
|
658
701
|
/**
|
|
659
702
|
* The identifier (e.g. email) input field. Accepted but not tracked yet — low-event
|
|
660
703
|
* tracking for a second field lands together with per-field attribution.
|
|
@@ -689,8 +732,10 @@ type PasswordEnrollmentTypedError = {
|
|
|
689
732
|
};
|
|
690
733
|
type PasswordEnrollmentTypedErrorCode = "requirements_not_fulfilled";
|
|
691
734
|
type PasswordEnrollmentExplicitSpecType = "password-set" | "password-reset";
|
|
692
|
-
type PasswordEnrollmentAutoTrackConfig = {
|
|
735
|
+
type PasswordEnrollmentAutoTrackConfig = OperationConfig & {
|
|
736
|
+
/** The classifier drops the attempt if no spec type arrives on any of its events — supply it here or on a step's start data as soon as known. */
|
|
693
737
|
explicitSpecType?: PasswordEnrollmentExplicitSpecType;
|
|
738
|
+
/** The password input field. When set, low-event input tracking is attached to it. */
|
|
694
739
|
inputHtmlField?: HTMLInputElement;
|
|
695
740
|
};
|
|
696
741
|
declare class PasswordEnrollmentOperationFull extends OperationFull {
|
|
@@ -720,17 +765,16 @@ type PasskeyLoginCUIGetOptionsFinished = {
|
|
|
720
765
|
explicitSpecType?: ProvideIdentifierSpecType;
|
|
721
766
|
assertionOptions: string;
|
|
722
767
|
};
|
|
723
|
-
type OperationFullProvideIdentifierWithCUIConfig = {
|
|
768
|
+
type OperationFullProvideIdentifierWithCUIConfig = OperationConfig & {
|
|
769
|
+
/** When set, low event collection is enabled for the input field. */
|
|
724
770
|
inputHtmlField?: HTMLInputElement;
|
|
725
771
|
explicitSpecType?: ProvideIdentifierSpecType;
|
|
726
772
|
};
|
|
727
|
-
declare class OperationFullProvideIdentifierWithCUI {
|
|
728
|
-
private tracker;
|
|
773
|
+
declare class OperationFullProvideIdentifierWithCUI extends OperationFull {
|
|
729
774
|
private lowEventTracker?;
|
|
730
775
|
readonly cui: {
|
|
731
776
|
/**
|
|
732
|
-
* @deprecated `subflow_trigger`
|
|
733
|
-
* will be removed in the next major version.
|
|
777
|
+
* @deprecated `subflow_trigger` will be removed in the next major version.
|
|
734
778
|
*/
|
|
735
779
|
trigger: (data: SubflowTrigger, options?: StepOptions) => void;
|
|
736
780
|
getOptions: StepHelper<PasskeyLoginCUIGetOptionsStart, PasskeyLoginCUIGetOptionsFinished>;
|
|
@@ -739,32 +783,34 @@ declare class OperationFullProvideIdentifierWithCUI {
|
|
|
739
783
|
};
|
|
740
784
|
readonly provideIdentifier: {
|
|
741
785
|
/**
|
|
742
|
-
* @deprecated `subflow_trigger`
|
|
743
|
-
* in the next major version.
|
|
786
|
+
* @deprecated `subflow_trigger` will be removed in the next major version.
|
|
744
787
|
*/
|
|
745
788
|
trigger: (data: SubflowTrigger, options?: StepOptions) => void;
|
|
746
789
|
clientValidation: StepHelper;
|
|
747
790
|
postResponse: StepHelper<ProvideIdentifierPostResponseStart>;
|
|
748
791
|
};
|
|
749
792
|
constructor(tracker: CorbadoTracker, config?: OperationFullProvideIdentifierWithCUIConfig);
|
|
750
|
-
private createStep;
|
|
751
793
|
destroy(): void;
|
|
752
794
|
}
|
|
753
795
|
|
|
754
796
|
type SocialLoginSpecType = "pre-identifier" | "post-identifier";
|
|
755
797
|
type SocialLoginGetRedirectUrlStart = {
|
|
756
798
|
provider?: SocialLoginProviderType;
|
|
757
|
-
explicitSpecType
|
|
799
|
+
explicitSpecType?: SocialLoginSpecType;
|
|
758
800
|
};
|
|
759
801
|
type SocialLoginGetRedirectUrlFinished = {};
|
|
760
802
|
type SocialLoginExchangeCodeStart = {
|
|
761
803
|
provider?: SocialLoginProviderType;
|
|
762
804
|
};
|
|
763
805
|
type SocialLoginExchangeCodeFinished = {};
|
|
806
|
+
type SocialLoginOperationConfig = OperationConfig & {
|
|
807
|
+
/** The classifier drops the attempt if no spec type arrives on any of its events — supply it here or on a step's start data as soon as known. */
|
|
808
|
+
explicitSpecType?: SocialLoginSpecType;
|
|
809
|
+
};
|
|
764
810
|
declare class SocialLoginOperationFull extends OperationFull {
|
|
765
811
|
readonly getRedirectUrl: StepHelper<SocialLoginGetRedirectUrlStart, SocialLoginGetRedirectUrlFinished>;
|
|
766
812
|
readonly exchangeCode: StepHelper<SocialLoginExchangeCodeStart, SocialLoginExchangeCodeFinished>;
|
|
767
|
-
constructor(tracker: CorbadoTracker);
|
|
813
|
+
constructor(tracker: CorbadoTracker, config?: SocialLoginOperationConfig);
|
|
768
814
|
}
|
|
769
815
|
|
|
770
816
|
type AppConfirmationOperationSpecType = "qr-code";
|
|
@@ -776,11 +822,14 @@ type AppConfirmationOperationCeremonyTypedError = {
|
|
|
776
822
|
};
|
|
777
823
|
type AppConfirmationOperationCeremonyTypedErrorCode = "declined" | "expired";
|
|
778
824
|
type AppConfirmationOperationRetryReason = AppConfirmationOperationCeremonyTypedErrorCode | "technical-error" | "manual";
|
|
825
|
+
type AppConfirmationOperationConfig = OperationConfig & {
|
|
826
|
+
explicitSpecType?: AppConfirmationOperationSpecType;
|
|
827
|
+
};
|
|
779
828
|
declare class AppConfirmationOperationFull extends OperationFull {
|
|
780
829
|
readonly ceremony: StepHelper<{}, {}, AppConfirmationOperationCeremonyTypedError>;
|
|
781
830
|
readonly retry: StepHelper;
|
|
782
831
|
readonly postResponse: StepHelper;
|
|
783
|
-
constructor(tracker: CorbadoTracker,
|
|
832
|
+
constructor(tracker: CorbadoTracker, config?: AppConfirmationOperationConfig);
|
|
784
833
|
}
|
|
785
834
|
|
|
786
835
|
/**
|
|
@@ -789,7 +838,7 @@ declare class AppConfirmationOperationFull extends OperationFull {
|
|
|
789
838
|
* - `invisible`: a widget that never presents UI and always solves itself.
|
|
790
839
|
*/
|
|
791
840
|
type CaptchaOperationSpecType = "visible" | "invisible";
|
|
792
|
-
type CaptchaOperationConfig = {
|
|
841
|
+
type CaptchaOperationConfig = OperationConfig & {
|
|
793
842
|
explicitSpecType?: CaptchaOperationSpecType;
|
|
794
843
|
};
|
|
795
844
|
declare class CaptchaOperationFull extends OperationFull {
|
|
@@ -804,9 +853,10 @@ type ProvideDataOperationSpecType = "signup" | "login" | "recovery" | "enrollmen
|
|
|
804
853
|
type ProvideDataOperationStart = {
|
|
805
854
|
/** Stable name of the data field collected by this subflow, when known. */
|
|
806
855
|
fieldName?: string;
|
|
856
|
+
/** The classifier drops the attempt if no spec type arrives on any of its events — supply it here or on a step's start data as soon as known. */
|
|
807
857
|
explicitSpecType?: ProvideDataOperationSpecType;
|
|
808
858
|
};
|
|
809
|
-
type ProvideDataOperationConfig = ProvideDataOperationStart & {
|
|
859
|
+
type ProvideDataOperationConfig = ProvideDataOperationStart & OperationConfig & {
|
|
810
860
|
/** The input field whose low-level interaction signals should be collected. */
|
|
811
861
|
inputHtmlField?: HTMLInputElement;
|
|
812
862
|
};
|
|
@@ -853,6 +903,8 @@ interface TrackerOptions {
|
|
|
853
903
|
* It will be removed in a future release.
|
|
854
904
|
*/
|
|
855
905
|
flushInterval?: number;
|
|
906
|
+
/** Generates new Observe session ids; returned values must be UUID-compatible. Existing stored sessions are still reused. */
|
|
907
|
+
sessionIdGenerator?: () => string;
|
|
856
908
|
}
|
|
857
909
|
declare class CorbadoTracker {
|
|
858
910
|
private options;
|
|
@@ -929,6 +981,12 @@ declare class CorbadoTracker {
|
|
|
929
981
|
clearExperiments(): void;
|
|
930
982
|
/** Returns a copy of the currently active experiment assignments. */
|
|
931
983
|
getExperiments(): Record<string, string>;
|
|
984
|
+
/**
|
|
985
|
+
* Returns the public SDK configuration for this page load.
|
|
986
|
+
*
|
|
987
|
+
* @returns A frozen snapshot, created fresh on every call.
|
|
988
|
+
*/
|
|
989
|
+
getSdkConfig(): ObserveSdkConfigSnapshot;
|
|
932
990
|
private static isValidExperimentKey;
|
|
933
991
|
private static isValidExperimentVariant;
|
|
934
992
|
private loadPersistedExperiments;
|
|
@@ -939,6 +997,7 @@ declare class CorbadoTracker {
|
|
|
939
997
|
*/
|
|
940
998
|
private resolveExperiments;
|
|
941
999
|
private isTrackingBlocked;
|
|
1000
|
+
private createSessionId;
|
|
942
1001
|
private resolveSessionId;
|
|
943
1002
|
/**
|
|
944
1003
|
* Resolve the session id from localStorage so it survives reloads and is shared across tabs of the
|
|
@@ -987,7 +1046,11 @@ declare class CorbadoTracker {
|
|
|
987
1046
|
trackSubflowStepStarted(subflowType: SubflowType, stepName: string, data: Record<string, any>, options?: StepOptions, ignoreAsInteraction?: boolean): void;
|
|
988
1047
|
trackSubflowStepFinished(subflowType: SubflowType, stepName: string, data: Record<string, any>, options?: StepOptions): void;
|
|
989
1048
|
trackSubflowStepError(subflowType: SubflowType, stepName: string, data: Record<string, any>, options?: StepOptions): void;
|
|
990
|
-
|
|
1049
|
+
/**
|
|
1050
|
+
* @remarks
|
|
1051
|
+
* Records an additional error occurrence against the subflow. Carries no outcome semantics —
|
|
1052
|
+
* step errors are the intended channel; not part of a normal integration.
|
|
1053
|
+
*/
|
|
991
1054
|
trackSubflowError(subflowType: SubflowType, data: Record<string, any>, options?: StepOptions): void;
|
|
992
1055
|
/**
|
|
993
1056
|
* Error situations:
|
|
@@ -1115,6 +1178,22 @@ declare class CorbadoTracker {
|
|
|
1115
1178
|
* ```
|
|
1116
1179
|
*/
|
|
1117
1180
|
flowAutoFinished(data: FlowAutoFinished, tags?: Record<string, string>, experiments?: Record<string, string>): void;
|
|
1181
|
+
/**
|
|
1182
|
+
* Attach a cross-environment transaction id to the current flow.
|
|
1183
|
+
*
|
|
1184
|
+
* @remarks
|
|
1185
|
+
* Use this when the flow continues in another environment (for example a native app or another
|
|
1186
|
+
* device) and both sides report under the same transaction id. Emits a single `flow_enriched`
|
|
1187
|
+
* event carrying the id in its user reference; call it once, as soon as the id is known.
|
|
1188
|
+
*
|
|
1189
|
+
* @param id - The cross-environment transaction id.
|
|
1190
|
+
*
|
|
1191
|
+
* @example
|
|
1192
|
+
* ```typescript
|
|
1193
|
+
* tracker.setCrossEnvironmentTransactionId("cet_123");
|
|
1194
|
+
* ```
|
|
1195
|
+
*/
|
|
1196
|
+
setCrossEnvironmentTransactionId(id: string): void;
|
|
1118
1197
|
/**
|
|
1119
1198
|
* Track when you present authentication method choices to the user.
|
|
1120
1199
|
*
|
|
@@ -1139,7 +1218,15 @@ declare class CorbadoTracker {
|
|
|
1139
1218
|
*/
|
|
1140
1219
|
authMethodsDecisionStarted(data: AuthMethodDecisionStarted, tags?: Record<string, string>, experiments?: Record<string, string>, options?: Pick<StepOptions, "explicitTimestamp">): void;
|
|
1141
1220
|
authMethodsDecisionFinished(data: AuthMethodDecisionFinished, tags?: Record<string, string>, experiments?: Record<string, string>): void;
|
|
1221
|
+
/**
|
|
1222
|
+
* @deprecated Use {@link CorbadoTracker.authMethodsDecisionStarted} instead (its `options`
|
|
1223
|
+
* already accept free-form strings).
|
|
1224
|
+
*/
|
|
1142
1225
|
authDecisionStarted(data: AuthDecisionStarted, tags?: Record<string, string>, experiments?: Record<string, string>): void;
|
|
1226
|
+
/**
|
|
1227
|
+
* @deprecated Use {@link CorbadoTracker.authMethodsDecisionFinished} instead (its `options`
|
|
1228
|
+
* already accept free-form strings).
|
|
1229
|
+
*/
|
|
1143
1230
|
authDecisionFinished(data: AuthDecisionFinished, tags?: Record<string, string>, experiments?: Record<string, string>): void;
|
|
1144
1231
|
/**
|
|
1145
1232
|
* Enqueue a "low" event (granular DOM/window/visualviewport/PWM signal) for the current session.
|
|
@@ -1198,17 +1285,17 @@ declare class CorbadoTracker {
|
|
|
1198
1285
|
* @internal
|
|
1199
1286
|
*/
|
|
1200
1287
|
lowEventFlushKeepalive(): void;
|
|
1201
|
-
passkeyLoginFullOperation(): PasskeyLoginOperationFull;
|
|
1288
|
+
passkeyLoginFullOperation(config?: PasskeyLoginOperationConfig): PasskeyLoginOperationFull;
|
|
1202
1289
|
passkeyEnrollmentFullOperation(config?: PasskeyEnrollmentOperationConfig): PasskeyEnrollmentOperationFull;
|
|
1203
1290
|
passwordLoginFullOperation(autoTrackConfig?: PasswordLoginAutoTrackConfig): PasswordLoginOperationFull;
|
|
1204
1291
|
passwordEnrollmentFullOperation(autoTrackConfig?: PasswordEnrollmentAutoTrackConfig): PasswordEnrollmentOperationFull;
|
|
1205
|
-
emailLinkOperationFull(): EmailLinkOperationFull;
|
|
1292
|
+
emailLinkOperationFull(config?: EmailLinkOperationConfig): EmailLinkOperationFull;
|
|
1206
1293
|
emailOtpOperationFull(config?: EmailOTPOperationConfig): EmailOtpOperationFull;
|
|
1207
1294
|
smsOtpOperationFull(config?: SmsOTPOperationConfig): SmsOtpOperationFull;
|
|
1208
1295
|
provideIdentifierOperationFull(config?: OperationFullProvideIdentifierWithCUIConfig): OperationFullProvideIdentifierWithCUI;
|
|
1209
1296
|
provideDataOperationFull(config?: ProvideDataOperationConfig): ProvideDataOperationFull;
|
|
1210
|
-
socialLoginOperationFull(): SocialLoginOperationFull;
|
|
1211
|
-
appConfirmationOperationFull(
|
|
1297
|
+
socialLoginOperationFull(config?: SocialLoginOperationConfig): SocialLoginOperationFull;
|
|
1298
|
+
appConfirmationOperationFull(config?: AppConfirmationOperationConfig): AppConfirmationOperationFull;
|
|
1212
1299
|
captchaOperationFull(config?: CaptchaOperationConfig): CaptchaOperationFull;
|
|
1213
1300
|
/**
|
|
1214
1301
|
* Flush any pending events and release all resources (timers, event listeners).
|
|
@@ -1715,6 +1802,11 @@ declare function resetSession(): string | undefined;
|
|
|
1715
1802
|
* could be established. See {@link CorbadoTracker.getSessionId}.
|
|
1716
1803
|
*/
|
|
1717
1804
|
declare function getSessionId(): string | undefined;
|
|
1805
|
+
/**
|
|
1806
|
+
* Attach a cross-environment transaction id to the current flow of the global tracker. See
|
|
1807
|
+
* {@link CorbadoTracker.setCrossEnvironmentTransactionId}.
|
|
1808
|
+
*/
|
|
1809
|
+
declare function setCrossEnvironmentTransactionId(id: string): void;
|
|
1718
1810
|
declare function setExperiment(key: string, variant: string): void;
|
|
1719
1811
|
declare function setExperiments(assignments: Record<string, string>): void;
|
|
1720
1812
|
declare function clearExperiment(key: string): void;
|
|
@@ -1725,4 +1817,4 @@ declare function logInfo(message: string): void;
|
|
|
1725
1817
|
declare function logError(message: string): void;
|
|
1726
1818
|
declare function destroy(): Promise<void>;
|
|
1727
1819
|
|
|
1728
|
-
export { type AppConfirmationOperationCeremonyTypedError, AppConfirmationOperationFull, type AppConfirmationOperationRetryReason, type AppConfirmationOperationSpecType, type AppConfirmationOperationStart, type AuthDecisionFinished, type AuthDecisionStarted, AuthEventName, type AuthMethodDecisionFinished, type AuthMethodDecisionStarted, type AuthMethodType, type BaseEvent, CEREMONY_LOW_EVENT_TAIL_MS, CONFIG_BOUNDS, CONFIG_REQUEST_HEADER, CONFIG_STORAGE_KEY, type CaptchaOperationConfig, CaptchaOperationFull, type CaptchaOperationSpecType, type ClientCapabilities, type ClientEnvHandleMeta, type ClientEnvHandleMetaSource, type Conversion, CookieStorage, CorbadoTracker, type CreateLoggerOptions, type CustomEvent, DEFAULT_DEVICE_INFO_COLLECTOR_TIMEOUT_MS, DEFAULT_FLUSH_INTERVAL_MS, DEFAULT_MAX_ENTRIES, DEFAULT_MAX_SERIALIZED_LENGTH, DEFAULT_RELIABILITY_CONFIG, DEFAULT_SEQ_LOCK_TIMEOUT_MS, DEFAULT_SESSION_INACTIVITY_MS, type DeviceInfo, type DeviceInfoCollectionError, type DeviceInfoDataWeb, type DeviceType, EmailLinkOperationFull, type EmailLinkOperationPostResponseStart, type EmailLinkOperationSendStart, type EmailLinkOperationSpecType, type EmailOTPOperationConfig, type EmailOTPOperationPostResponseStart, type EmailOTPOperationSendOTPStart, type EmailOTPOperationSpecType, EmailOtpOperationFull, type Event, type EventBatch, type EventBatchMeta, type EventMeta, EventStore, type EventType, type FlowAutoFinished, type FlowDecided, type FlowFinished, type FlowReset, type FlowStarted, type FlowType, type FlushReason, type JavaScriptHighEntropy, LocalStorage, type Logger, type LowEvent, type MultiFlowReset, type MultiFlowStarted, type NormalizedError, OUTBOX_LOCK_NAME, OUTBOX_STORAGE_KEY, OperationFull, OperationFullProvideIdentifierWithCUI, type OperationFullProvideIdentifierWithCUIConfig, type OutboxEntry, type PasskeyEnrollmentCeremonyFinished, type PasskeyEnrollmentCeremonyStart, type PasskeyEnrollmentGetOptionsFinished, type PasskeyEnrollmentGetOptionsStart, type PasskeyEnrollmentOperationConfig, PasskeyEnrollmentOperationFull, type PasskeyEnrollmentPostResponseStart, type PasskeyLoginCUIGetOptionsFinished, type PasskeyLoginCUIGetOptionsStart, type PasskeyLoginCUISpecType, type PasskeyLoginCeremonyFinished, type PasskeyLoginCeremonyStart, type PasskeyLoginClientError, type PasskeyLoginFinish, type PasskeyLoginGetOptionsFinished, type PasskeyLoginGetOptionsStart, PasskeyLoginOperationFull, type PasskeyLoginPostResponseStart, type PasskeyLoginStartable, type PasskeyLoginSubmitted, type PasskeyOperationEnrollmentExplicitSpecType, type PasskeyOperationLoginExplicitSpecType, type PasswordEnrollmentAutoTrackConfig, PasswordEnrollmentOperationFull, type PasswordEnrollmentTypedError, type PasswordLoginAutoTrackConfig, type PasswordLoginCUICeremonyStart, type PasswordLoginCUIGetOptionsFinished, type PasswordLoginCUIGetOptionsStart, type PasswordLoginCUISpecType, type PasswordLoginCUITypedError, PasswordLoginOperationFull, type PasswordLoginTypedError, type PredefinedEvent, type ProvideDataOperationConfig, ProvideDataOperationFull, type ProvideDataOperationPostResponseStart, type ProvideDataOperationSpecType, type ProvideDataOperationStart, type ProvideIdentifierError, type ProvideIdentifierFinish, type ProvideIdentifierPostResponseStart, type ProvideIdentifierSpecType, type ProvideIdentifierStart, type QueueOptions, RequestQueue, SDK_NAME, SDK_VERSION, type SdkInfo, type SdkReliabilityConfig, type SdkRetryConfig, SessionStorage, type SmsOTPOperationConfig, type SmsOTPOperationPostResponseStart, type SmsOTPOperationSpecType, SmsOtpOperationFull, type SocialLoginExchangeCodeFinished, type SocialLoginExchangeCodeStart, type SocialLoginGetRedirectUrlFinished, type SocialLoginGetRedirectUrlStart, SocialLoginOperationFull, type SocialLoginProviderType, type SocialLoginSpecType, type StepHelper, type StepOptions, type StorageEngine, type SubflowTrigger, type SubflowType, type TelemetryEntry, type TelemetryLevel, type TelemetrySink, type TrackerOptions, type Transport, type TransportMakeRequestResponse, type TransportOptions, type UserReference, cacheConfig, clearExperiment, clearExperiments, createLogger, destroy, getExperiments, getSessionId, getTracker, init, loadCachedConfig, logError, logInfo, parseReliabilityConfig, resetSession, setExperiment, setExperiments, telemetry };
|
|
1820
|
+
export { type AppConfirmationOperationCeremonyTypedError, type AppConfirmationOperationConfig, AppConfirmationOperationFull, type AppConfirmationOperationRetryReason, type AppConfirmationOperationSpecType, type AppConfirmationOperationStart, type AuthDecisionFinished, type AuthDecisionStarted, AuthEventName, type AuthMethodDecisionFinished, type AuthMethodDecisionStarted, type AuthMethodType, type BaseEvent, CEREMONY_LOW_EVENT_TAIL_MS, CONFIG_BOUNDS, CONFIG_REQUEST_HEADER, CONFIG_STORAGE_KEY, type CaptchaOperationConfig, CaptchaOperationFull, type CaptchaOperationSpecType, type ClientCapabilities, type ClientEnvHandleMeta, type ClientEnvHandleMetaSource, type Conversion, CookieStorage, CorbadoTracker, type CreateLoggerOptions, type CustomEvent, DEFAULT_DEVICE_INFO_COLLECTOR_TIMEOUT_MS, DEFAULT_FLUSH_INTERVAL_MS, DEFAULT_MAX_ENTRIES, DEFAULT_MAX_SERIALIZED_LENGTH, DEFAULT_RELIABILITY_CONFIG, DEFAULT_SEQ_LOCK_TIMEOUT_MS, DEFAULT_SESSION_INACTIVITY_MS, type DeviceInfo, type DeviceInfoCollectionError, type DeviceInfoDataWeb, type DeviceType, type EmailLinkOperationConfig, EmailLinkOperationFull, type EmailLinkOperationPostResponseStart, type EmailLinkOperationSendStart, type EmailLinkOperationSpecType, type EmailOTPOperationConfig, type EmailOTPOperationPostResponseStart, type EmailOTPOperationSendOTPStart, type EmailOTPOperationSpecType, EmailOtpOperationFull, type Event, type EventBatch, type EventBatchMeta, type EventMeta, EventStore, type EventType, type FlowAutoFinished, type FlowDecided, type FlowFinished, type FlowReset, type FlowStarted, type FlowType, type FlushReason, type JavaScriptHighEntropy, LocalStorage, type Logger, type LowEvent, type MultiFlowReset, type MultiFlowStarted, type NormalizedError, OUTBOX_LOCK_NAME, OUTBOX_STORAGE_KEY, type ObserveSdkConfigSnapshot, type OperationConfig, OperationFull, OperationFullProvideIdentifierWithCUI, type OperationFullProvideIdentifierWithCUIConfig, type OutboxEntry, type PasskeyEnrollmentCeremonyFinished, type PasskeyEnrollmentCeremonyStart, type PasskeyEnrollmentGetOptionsFinished, type PasskeyEnrollmentGetOptionsStart, type PasskeyEnrollmentOperationConfig, PasskeyEnrollmentOperationFull, type PasskeyEnrollmentPostResponseStart, type PasskeyLoginCUIGetOptionsFinished, type PasskeyLoginCUIGetOptionsStart, type PasskeyLoginCUISpecType, type PasskeyLoginCeremonyFinished, type PasskeyLoginCeremonyStart, type PasskeyLoginClientError, type PasskeyLoginFinish, type PasskeyLoginGetOptionsFinished, type PasskeyLoginGetOptionsStart, type PasskeyLoginOperationConfig, PasskeyLoginOperationFull, type PasskeyLoginPostResponseStart, type PasskeyLoginStartable, type PasskeyLoginSubmitted, type PasskeyOperationEnrollmentExplicitSpecType, type PasskeyOperationLoginExplicitSpecType, type PasswordEnrollmentAutoTrackConfig, PasswordEnrollmentOperationFull, type PasswordEnrollmentTypedError, type PasswordLoginAutoTrackConfig, type PasswordLoginCUICeremonyStart, type PasswordLoginCUIGetOptionsFinished, type PasswordLoginCUIGetOptionsStart, type PasswordLoginCUISpecType, type PasswordLoginCUITypedError, type PasswordLoginExplicitSpecType, PasswordLoginOperationFull, type PasswordLoginTypedError, type PredefinedEvent, type ProvideDataOperationConfig, ProvideDataOperationFull, type ProvideDataOperationPostResponseStart, type ProvideDataOperationSpecType, type ProvideDataOperationStart, type ProvideIdentifierError, type ProvideIdentifierFinish, type ProvideIdentifierPostResponseStart, type ProvideIdentifierSpecType, type ProvideIdentifierStart, type QueueOptions, RequestQueue, SDK_NAME, SDK_VERSION, type SdkInfo, type SdkReliabilityConfig, type SdkRetryConfig, SessionStorage, type SmsOTPOperationConfig, type SmsOTPOperationPostResponseStart, type SmsOTPOperationSpecType, SmsOtpOperationFull, type SocialLoginExchangeCodeFinished, type SocialLoginExchangeCodeStart, type SocialLoginGetRedirectUrlFinished, type SocialLoginGetRedirectUrlStart, type SocialLoginOperationConfig, SocialLoginOperationFull, type SocialLoginProviderType, type SocialLoginSpecType, type StepHelper, type StepOptions, type StorageEngine, type SubflowTrigger, type SubflowType, type TelemetryEntry, type TelemetryLevel, type TelemetrySink, type TrackerOptions, type Transport, type TransportMakeRequestResponse, type TransportOptions, type UserReference, cacheConfig, clearExperiment, clearExperiments, createLogger, destroy, getExperiments, getSessionId, getTracker, init, loadCachedConfig, logError, logInfo, parseReliabilityConfig, resetSession, setCrossEnvironmentTransactionId, setExperiment, setExperiments, telemetry };
|