@clerk/shared/dist/react/hooks/useOAuthDeviceVerification.types.d.ts

Internal package utils used by the Clerk SDKs

import { ClerkAPIResponseError } from "../../errors/clerkApiResponseError.js";
import { ClerkRuntimeError } from "../../errors/clerkRuntimeError.js";
import { LookupOAuthDeviceVerificationParams, OAuthDeviceVerificationInfo, OAuthDeviceVerificationResult, SubmitOAuthDeviceVerificationParams } from "../../types/oauthApplication.js";
//#region src/react/hooks/useOAuthDeviceVerification.types.d.ts
/**
 * @interface
 */
type UseOAuthDeviceVerificationReturn = {
  /**
   * Information about the device authorization returned by the latest successful lookup, or `undefined` if no lookup has succeeded.
   */
  data: OAuthDeviceVerificationInfo | undefined;
  /**
   * The result of the latest approval or denial, or `undefined` if no decision has succeeded.
   */
  result: OAuthDeviceVerificationResult | undefined;
  /**
   * The latest error recorded by a lookup or submission operation, or `null` if no error has been recorded since the state was last cleared. Preflight rejections (Clerk not loaded, or a conflicting request already in progress) reject the returned promise without setting this, so callers must also handle rejections from `lookup`, `approve`, and `deny`.
   */
  error: ClerkAPIResponseError | ClerkRuntimeError | null;
  /**
   * Whether a device authorization lookup is in progress.
   */
  isLoading: boolean;
  /**
   * Whether an approval or denial is in progress.
   */
  isSubmitting: boolean;
  /**
   * Looks up a device authorization by its user code.
   */
  lookup: (params: LookupOAuthDeviceVerificationParams) => Promise<OAuthDeviceVerificationInfo>;
  /**
   * Approves a device authorization.
   */
  approve: (params: Omit<SubmitOAuthDeviceVerificationParams, 'approved'>) => Promise<OAuthDeviceVerificationResult>;
  /**
   * Denies a device authorization.
   */
  deny: (params: LookupOAuthDeviceVerificationParams) => Promise<OAuthDeviceVerificationResult>;
  /**
   * Clears the current device authorization state.
   */
  reset: () => void;
};
//#endregion
export { UseOAuthDeviceVerificationReturn };
//# sourceMappingURL=useOAuthDeviceVerification.types.d.ts.map