@authing/guard-shim-react 4.5.51-eak.27 → 4.5.51-eak.29

package/dist/typings/shim-react16/index.d.ts

@@ -1,8 +1,9 @@
 import React, { ReactElement, CSSProperties, ReactNode, ForwardRefRenderFunction } from 'react';
+import { createPortal } from 'react-dom';
 export interface IRenderer {
     container: Element;
     element: ReactElement;
 }
 declare function render(renderer: IRenderer): void | Element | React.Component<any, any, any>;
 declare function unmount(container: Element): void;
-export { React, CSSProperties, ReactNode, render, unmount, ReactElement, ForwardRefRenderFunction };
+export { React, createPortal, CSSProperties, ReactNode, render, unmount, ReactElement, ForwardRefRenderFunction };

package/dist/typings/shim-react18/index.d.ts

@@ -1,8 +1,9 @@
 import React, { ReactNode, CSSProperties, ReactElement, ForwardRefRenderFunction } from 'react';
+import { createPortal } from 'react-dom';
 export interface IRenderer {
     container: Element;
     element: ReactNode;
 }
 declare function render(renderer: IRenderer): void;
 declare function unmount(container: Element): void;
-export { React, ReactNode, CSSProperties, render, unmount, ReactElement, ForwardRefRenderFunction };
+export { React, createPortal, ReactNode, CSSProperties, render, unmount, ReactElement, ForwardRefRenderFunction };

package/dist/typings/src/SendCode/turnstile.d.ts

@@ -0,0 +1,40 @@
+export declare const TURNSTILE_SCRIPT_URL = "https://challenges.cloudflare.com/turnstile/v0/api.js?render=explicit";
+export interface TurnstileConfig {
+    enabled: boolean;
+    siteKey: string;
+    action: 'send_code';
+    scriptUrl: string;
+}
+export interface TurnstileApi {
+    render: (container: HTMLElement, options: {
+        sitekey: string;
+        action: string;
+        theme: 'auto';
+        size: 'flexible' | 'compact';
+        appearance: 'always' | 'interaction-only';
+        language: string;
+        retry: 'never';
+        'refresh-expired': 'manual';
+        'refresh-timeout': 'manual';
+        'response-field': false;
+        callback: (token: string) => void;
+        'error-callback': (code?: string) => void;
+        'expired-callback': () => void;
+        'timeout-callback': () => void;
+    }) => string | undefined;
+    remove: (widgetId: string) => void;
+}
+export declare class TurnstileLoadError extends Error {
+    code: 'SCRIPT_LOAD_FAILED' | 'SCRIPT_LOAD_TIMEOUT' | 'API_UNAVAILABLE';
+    constructor(code: 'SCRIPT_LOAD_FAILED' | 'SCRIPT_LOAD_TIMEOUT' | 'API_UNAVAILABLE');
+}
+/** Share the script across widgets and Guard instances in the same document. */
+export declare const loadTurnstile: (document: Document) => Promise<TurnstileApi>;
+/** Never interpret a failed or malformed configuration request as disabled. */
+export declare const readTurnstileConfig: (response: {
+    code?: number;
+    data?: TurnstileConfig;
+}) => TurnstileConfig;
+export declare class TurnstileChallengeError extends Error {
+    constructor(message: string);
+}

package/dist/typings/src/SendCode/useTurnstile.d.ts

@@ -0,0 +1,27 @@
+import { React } from 'shim-react';
+import './style.less';
+/** Authentication forms share one widget until its raw token is submitted. */
+export declare const useTurnstile: (options?: {
+    mode?: 'inline' | 'modal';
+    placement?: 'inline' | 'send-code' | 'page';
+}) => {
+    turnstileView: null;
+    shared: boolean;
+    getTurnstileParams: () => Promise<Record<string, string>>;
+    sendDisabled: boolean;
+    submissionProtected: boolean;
+    mountVerification: (slot: HTMLElement) => () => void;
+} | {
+    shared: boolean;
+    getTurnstileParams: () => Promise<Record<string, string>>;
+    turnstileView: JSX.Element | null;
+    sendDisabled: boolean;
+    retryAfterFailure: (token: string) => void;
+};
+/** One native widget across normal login/register forms; other modules do not gate submission. */
+export declare const TurnstileProvider: React.FC<{
+    protectSubmission?: boolean;
+}>;
+/** Reserve the native widget's place above the active form's primary action. */
+export declare const TurnstileField: React.FC;
+export declare const useTurnstileSubmitDisabled: () => boolean;

package/dist/typings/src/_utils/context.d.ts

@@ -6,12 +6,14 @@ import { BackFillMultipleState, StoreInstance } from '../Guard/core/hooks/useMul
 import { ModuleState } from '../Guard/GuardModule/stateMachine';
 import { ApplicationConfig } from '../Type/application';
 import { GuardHttp } from './guardHttp';
+import { AuthenticationClient } from 'authing-js-sdk';
 import { MultipleTenant } from './tenant';
 export interface IGuardContext {
     finallyConfig: GuardLocalConfig;
     defaultMergedConfig: GuardLocalConfig;
     publicConfig: ApplicationConfig;
     httpClient: GuardHttp;
+    authClient?: AuthenticationClient;
     appId: string;
     tenantId?: string;
     initData: any;
@@ -78,6 +80,7 @@ export declare const useGuardButtonContext: () => {
 export declare const useGuardButtonState: () => IGuardContextProvider;
 export declare const useGuardPublicConfig: () => ApplicationConfig;
 export declare const useGuardHttpClient: () => GuardHttp;
+export declare const useGuardAuthenticationClient: () => AuthenticationClient | undefined;
 export declare const useIsSpecialBrowser: () => boolean;
 export declare const useGuardDefaultMergedConfig: () => GuardLocalConfig;
 export declare const useGuardAppId: () => string;

package/dist/typings/src/_utils/guardHttp.d.ts

@@ -1,6 +1,9 @@
 import { AuthingGuardResponse, AuthingResponse } from './http';
 import { CodeAction } from './responseManagement/interface';
 export declare class GuardHttp {
+    private turnstileProofReader?;
+    private turnstileFailureHandler?;
+    setTurnstileProofReader: (reader: () => Promise<Record<string, string>>, onFailure?: (token: string) => void) => () => void;
     private requestClient;
     private headers;
     private responseInterceptorMap;

package/dist/typings/src/_utils/turnstileRequest.d.ts

@@ -0,0 +1,6 @@
+/** Preserve a token already supplied by the caller or another transport. */
+export declare const hasTurnstileToken: (url: string, data?: any) => boolean;
+/** Business errors consume a raw token; MFA/next-step responses do not retry. */
+export declare const turnstileSubmissionFailed: (data: any) => boolean;
+/** Only normal registration/login submissions carry the raw human token. */
+export declare const needsTurnstileProof: (url: string, data?: any) => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@authing/guard-shim-react",
-  "version": "4.5.51-eak.27",
+  "version": "4.5.51-eak.29",
   "description": "Guard shim for react 16 / 17, only be used to internal",
   "types": "dist/typings/src/index.d.ts",
   "module": "dist/guard.min.js",