altcha/dist/altcha.d.ts

Privacy-first CAPTCHA widget, compliant with global regulations (GDPR/HIPAA/CCPA/LGDP/DPDPA/PIPL) and WCAG accessible. No tracking, self-verifying.

export {};

declare module 'altcha';

declare global {
  var altchaCreateWorker: (url?: string) => Worker;
  var altchaPlugins: any[];
  var altchaI18n: {
    get: (language: string) => Record<string, string>;
    set: (language: string, translation: Record<string, string>) => void;
    store: {
      set(this: void, value: Record<string, Record<string, string>>): void;
      update(
        this: void,
        updater: (
          value: Record<string, Record<string, string>>
        ) => Record<string, Record<string, string>>
      ): void;
      subscribe(
        this: void,
        run: (value: Record<string, Record<string, string>>) => void,
        invalidate?: () => void
      ): () => void;
    };
  };

  type AltchaState =
    | 'error'
    | 'expired'
    | 'verified'
    | 'verifying'
    | 'unverified';

  interface AltchaStateChangeEvent
    extends CustomEvent<{
      payload?: string;
      state: AltchaState;
    }> {}

  interface AltchaVerifiedEvent
    extends CustomEvent<{
      payload: string;
    }> {}

  interface AltchaServerVerificationEvent
    extends CustomEvent<Record<string, unknown>> {}

  interface AltchaWidgetOptions {
    auto?: 'off' | 'onfocus' | 'onload' | 'onsubmit';
    /** @deprecated */
    blockspam?: boolean;
    challengeurl?: string;
    challengejson?: string;
    credentials?: 'omit' | 'same-origin' | 'include' | boolean | undefined;
    customfetch?:
      | string
      | ((url: string, init?: RequestInit) => Promise<Response>);
    debug?: boolean;
    delay?: number;
    disableautofocus?: boolean;
    disablerefetchonexpire?: boolean;
    expire?: number;
    floating?: 'auto' | 'top' | 'bottom' | 'false' | '' | boolean;
    floatinganchor?: string;
    floatingoffset?: number;
    floatingpersist?: 'focus' | boolean;
    hidefooter?: boolean;
    hidelogo?: boolean;
    id?: string;
    language?: string;
    maxnumber?: number;
    mockerror?: boolean;
    name?: string;
    obfuscated?: string;
    oncleartext?: (ev: CustomEvent) => void;
    onload?: (ev: CustomEvent) => void;
    onstatechange?: (ev: CustomEvent) => void;
    onverified?: (ev: CustomEvent) => void;
    onserververification?: (ev: CustomEvent) => void;
    onupload?: (ev: CustomEvent) => void;
    onuploadprogress?: (ev: CustomEvent) => void;
    overlay?: boolean;
    overlaycontent?: string;
    plugins?: string;
    /** @deprecated Use `disablerefetchonexpire` instead. */
    refetchonexpire?: boolean;
    /** @deprecated */
    spamfilter?: boolean | 'ipAddress';
    strings?: string;
    test?: boolean | number;
    verifyurl?: string;
    workers?: number;
    workerurl?: string;
  }

  interface AltchaWidgetMethods {
    configure: (options: AltchaWidgetOptions) => void;
    clarify: () => Promise<void>;
    getConfiguration: () => AltchaWidgetOptions;
    getFloatingAnchor: () => HTMLElement | null;
    getPlugin: <T = unknown>(name: string) => T;
    getState: () => AltchaState;
    hide: () => void;
    repositionFloating: (viewportOffset?: number) => void;
    reset: (newState?: AltchaState, err?: string | null) => void;
    setFloatingAnchor: (el: HTMLElement) => void;
    setState: (newState: AltchaState, err?: string | null) => void;
    show: () => void;
    verify: () => Promise<void>;
  }

  interface AltchaWidget extends AltchaWidgetOptions {}

  interface AltchaWidgetCSSProperties extends Partial<CSSStyleDeclaration> {
    '--altcha-border-width'?: string;
    '--altcha-border-radius'?: string;
    '--altcha-color-base'?: string;
    '--altcha-color-border'?: string;
    '--altcha-color-text'?: string;
    '--altcha-color-border-focus'?: string;
    '--altcha-color-error-text'?: string;
    '--altcha-color-footer-bg'?: string;
    '--altcha-max-width'?: string;
  }

  interface AltchaWidgetReactRefObject<T> {
    current: T | null;
  }

  interface AltchaWidgetReact extends AltchaWidget {
    children?: string | number | Node | DocumentFragment;
    ref?: AltchaWidgetReactRefObject<HTMLElement>;
    style?: AltchaWidgetCSSProperties;
  }

  namespace JSX {
    interface IntrinsicElements {
      'altcha-widget': AltchaWidgetReact;
    }
  }

  namespace React {
    namespace JSX {
      interface IntrinsicElements {
        'altcha-widget': AltchaWidgetReact;
      }
    }
  }

  namespace svelteHTML {
    interface IntrinsicElements {
      'altcha-widget': AltchaWidgetSvelte;
    }

    interface AltchaWidgetSvelte extends AltchaWidget {
      style?: string;
    }
  }
}

declare module 'react' {
  namespace JSX {
    interface IntrinsicElements {
      'altcha-widget': AltchaWidgetReact;
    }
  }
}

declare module 'react/jsx-runtime' {
  namespace JSX {
    interface IntrinsicElements {
      'altcha-widget': AltchaWidgetReact;
    }
  }
}

declare module 'react/jsx-dev-runtime' {
  namespace JSX {
    interface IntrinsicElements {
      'altcha-widget': AltchaWidgetReact;
    }
  }
}