ping-identity
    Preparing search index...

    Type Alias DaVinciClient

    DaVinci imperative client API contract.

    Obtain an instance via createDaVinciClient.

    const client = createDaVinciClient({ modules: { oidc: { ... } } });

    const firstNode = await client.start();
    // ... collect user input ...
    const nextNode = await client.next({ collectors: [{ key: 'username', value: 'alice' }] });

    if (nextNode.type === 'SuccessNode') {
      const session = await client.user();
      console.log('Access token:', session?.accessToken);
    }
    type DaVinciClient = {
        dispose: () => Promise<void>;
        getId: () => Promise<string>;
        logoutUser: () => Promise<void>;
        next: (input: DaVinciNextInput) => Promise<DaVinciNode>;
        pollStatus: (
            onStatus: (status: PollingStatus) => void,
            options?: DaVinciPollStatusOptions,
        ) => Promise<() => void>;
        refresh: () => Promise<DaVinciUserSession | null>;
        revoke: () => Promise<boolean>;
        start: () => Promise<DaVinciNode>;
        user: () => Promise<DaVinciUserSession | null>;
        userinfo: () => Promise<Record<string, unknown> | null>;
        validate: (
            collectorKey: string,
            value: unknown,
        ) => Promise<DaVinciFieldValidationError[]>;
    }
    Index

    Properties

    dispose getId logoutUser next pollStatus refresh revoke start user userinfo validate

    Properties

    dispose: () => Promise<void>

    Dispose the native DaVinci instance and release runtime state.

    Type Declaration

      • (): Promise<void>

      • Returns Promise<void>

        Promise resolved when disposal completes.

    When disposal fails.

    getId: () => Promise<string>

    Returns the native DaVinci instance identifier.

    Type Declaration

      • (): Promise<string>

      • Returns Promise<string>

        The internal DaVinci instance id.

    Used by cross-module integrations (e.g. @ping-identity/rn-external-idp) to target the correct native DaVinci instance without direct package coupling. Satisfies the DaVinciInstance contract from @ping-identity/rn-types.

    When configuration fails.

    logoutUser: () => Promise<void>

    Log out the active user and clear the session.

    Type Declaration

      • (): Promise<void>

      • Returns Promise<void>

        Promise resolved when logout completes.

    When logout fails.

    next: (input: DaVinciNextInput) => Promise<DaVinciNode>

    Advance the active DaVinci flow by applying collector values.

    Type Declaration

    When value application or progression fails.

    pollStatus: (
        onStatus: (status: PollingStatus) => void,
        options?: DaVinciPollStatusOptions,
    ) => Promise<() => void>

    Streams PollingStatus updates for the active PollingCollector on the current node.

    Type Declaration

      • (
            onStatus: (status: PollingStatus) => void,
            options?: DaVinciPollStatusOptions,
        ): Promise<() => void>

      • Parameters

        Returns Promise<() => void>

        An unsubscribe function that stops local event delivery. It does not stop the native poll, which cannot be cancelled.

    Does not auto-advance the flow — the consumer must call next() explicitly on any terminal status (complete, timedOut, expired, error) to progress past it. The returned unsubscribe function stops local event delivery only — neither native SDK exposes a primitive to cancel an in-flight poll, so the native poll keeps running to completion (bounded by pollRetries × pollInterval) even after unsubscribing.

    When no active PollingCollector is resolved.

    refresh: () => Promise<DaVinciUserSession | null>

    Refresh the active user session tokens.

    Type Declaration

    When refresh fails.

    revoke: () => Promise<boolean>

    Revoke the active user access/refresh tokens.

    Type Declaration

      • (): Promise<boolean>

      • Returns Promise<boolean>

        true when revocation completes.

    When revocation fails.

    start: () => Promise<DaVinciNode>

    Start the DaVinci flow.

    Type Declaration

    The flow entry point is determined by the discovery URL in config — no name is passed at runtime (unlike Journey). Each call starts a fresh flow.

    When start fails.

    user: () => Promise<DaVinciUserSession | null>

    Resolve the active user session.

    Type Declaration

    When session retrieval fails.

    userinfo: () => Promise<Record<string, unknown> | null>

    Resolve userinfo claims for the active session.

    Type Declaration

      • (): Promise<Record<string, unknown> | null>

      • Returns Promise<Record<string, unknown> | null>

        Userinfo payload, or null when no active session exists.

    When userinfo retrieval fails.

    validate: (
        collectorKey: string,
        value: unknown,
    ) => Promise<DaVinciFieldValidationError[]>

    Validate one active collector without advancing the flow.

    Type Declaration

      • (collectorKey: string, value: unknown): Promise<DaVinciFieldValidationError[]>

      • Parameters

        • collectorKey: string

          Collector key to update and validate.

        • value: unknown

          Candidate value to apply to the collector before validating.

        Returns Promise<DaVinciFieldValidationError[]>

        Validation errors for the collector, or an empty array when valid (or when the collector has no validator).

    This is a command-query operation, not a pure check: it writes value onto the live collector backing the in-progress submission, because neither native SDK exposes a primitive that validates a candidate value without first setting it on the collector. The value passed in will be part of what a subsequent next() submits, even if the caller only intended a speculative/preview check.

    An empty result array means either "no validation errors" or "this collector has no validator" — it is not a positive confirmation that the value was actually checked.

    When value application or validation fails.

    Settings

    Member Visibility

    On This Page

    Properties