globals.d.ts

/**
 * @fileoverview
 * Defines extra APIs that exist in real web browsers but that are missing from TypeScript's default types.
 */

interface Element {
  /**
   * requestFullscreen() but available in Safari.
   */
  webkitRequestFullscreen?(): unknown;
}

interface Document {
  /**
   * exitFullscreen() but available in Safari.
   */
  webkitExitFullscreen?(): unknown;
  /**
   * fullscreenElement but available in Safari.
   */
  webkitFullscreenElement?: Element;
}

/**
 * https://developer.mozilla.org/en-US/docs/Web/API/NDEFReader
 */
declare class NDEFReader extends EventTarget {
  constructor();
  scan(options?: { signal?: AbortSignal }): Promise<void>;
  onreading?(event: Event & { message: NDEFMessage }): void;
  onreadingerror?(event: Event): void;
}

type TypedArray =
  | Uint8Array
  | Int8Array
  | Uint16Array
  | Int16Array
  | Uint32Array
  | Int32Array
  | BigUint64Array
  | BigInt64Array;

/**
 * https://developer.mozilla.org/en-US/docs/Web/API/NDEFMessage/NDEFMessage
 */
declare class NDEFMessage {
  constructor(
    records: Array<{
      data?: string | ArrayBuffer | TypedArray | DataView | NDEFRecord[];
      encoding?: string;
      id?: string;
      lang?: string;
      mediaType?: string;
      recordType?: string;
    }>
  );
  readonly records: NDEFRecord[];
}

/**
 * https://developer.mozilla.org/en-US/docs/Web/API/NDEFRecord
 */
declare class NDEFRecord {
  constructor();
  readonly recordType: string;
  readonly mediaType: string;
  readonly id: string;
  readonly data: DataView;
  readonly encoding: string | null;
  readonly lang: string | null;
  toRecords(): NDEFRecord[];
}

interface NetworkInformation {
  downlink: number;
  downlinkMax: number;
  effectiveType: string;
  rtt: number;
  saveData: boolean;
  type:
    | "bluetooth"
    | "cellular"
    | "ethernet"
    | "none"
    | "wifi"
    | "wimax"
    | "other"
    | "unknown";
}

interface Navigator {
  connection?: NetworkInformation;
}

declare namespace Scratch.extensions {
  /**
   * Most extensions fail the type checking of @turbowarp/types-tw's default register().
   * That error generally isn't very useful - so for now we'll just add this overload so
   * that those errors don't appear.
   */
  function register(extensionObj: any): void;
}