API 문서

declare function GM_log(message: string, level?: GMTypes.LoggerLevel): void;

declare namespace GMTypes {
  type LoggerLevel = "debug" | "info" | "warn" | "error";
}

// 데이터 추가 — 데이터는 bool/string/number/object 중 하나만 될 수 있습니다. 클래스 인스턴스는 저장할 수 없습니다
declare function GM_setValue(name: string, value: any): void;
// 데이터 가져오기
declare function GM_getValue(name: string, defaultValue?: any): any | undefined;
// 데이터 삭제, 다시 가져오면 undefined 또는 defaultValue 반환
declare function GM_deleteValue(name: string): void;

declare function GM_listValues(): string[];

// 여러 값을 설정합니다. values는 키가 값 이름이고 값이 값 내용인 객체입니다
declare function GM_setValues(values: { [key: string]: any }): void;
// 여러 값을 가져옵니다. keysOrDefaults가 객체이면 그 값이 기본값으로 사용됩니다
declare function GM_getValues(keysOrDefaults: { [key: string]: any } | string[] | null | undefined): { [key: string]: any };
// 여러 값을 삭제합니다. names는 문자열 배열입니다
declare function GM_deleteValues(names: string[]): void;

// tabid는 백그라운드 스크립트에서 수신할 때만 존재합니다
type ValueChangeListener = (
  name: string,
  oldValue: any,
  newValue: any,
  remote: boolean,
  tabid?: number
) => any;

declare function GM_addValueChangeListener(
  name: string,
  listener: GMTypes.ValueChangeListener
): number;

declare function GM_removeValueChangeListener(listenerId: number): void;

// GM_getResourceText는 리소스의 텍스트 데이터를 가져옵니다. 이미지 같은 바이트 유형 데이터는 빈 문자열을 반환합니다 — 그런 경우 GM_getResourceURL을 사용하세요
declare function GM_getResourceText(name: string): string | undefined;
// GM_getResourceURL은 base64 인코딩 데이터를 가져옵니다. 두 번째 매개변수로 blob URL도 얻을 수 있습니다
declare function GM_getResourceURL(name: string, isBlobUrl?: boolean): string | undefined;

declare function GM_addElement(tag: string, attributes: any): HTMLElement;
declare function GM_addElement(parentNode: Element, tag: string, attrs: any): HTMLElement;

declare function GM_addStyle(css: string): HTMLElement;

declare function GM_openInTab(url: string, options: GMTypes.OpenTabOptions): GMTypes.Tab;
declare function GM_openInTab(url: string, loadInBackground: boolean): GMTypes.Tab;
declare function GM_openInTab(url: string): GMTypes.Tab;

declare namespace GMTypes {
  interface OpenTabOptions {
    /**
     * 새 탭이 열릴 때 초점을 받는지 여부를 결정합니다.
     *
     * - `true` → 새 탭이 즉시 전경으로 전환됩니다.
     * - `false` → 새 탭이 백그라운드에서 열리며 현재 페이지에서 초점을 빼앗지 않습니다.
     *
     * 기본값: true
     */
    active?: boolean;

    /**
     * 새 탭이 삽입되는 위치를 결정합니다.
     *
     * - `boolean`이면:
     *   - `true` → 현재 탭 바로 뒤에 삽입됩니다.
     *   - `false` → 창 끝에 삽입됩니다.
     * - `number`이면:
     *   - `0` → 현재 탭보다 한 위치 앞에 삽입됩니다.
     *   - `1` → 현재 탭보다 한 위치 뒤에 삽입됩니다.
     *
     * 기본값: true
     */
    insert?: boolean | number;

    /**
     * 부모 탭(즉 `openerTabId`)이 설정되는지 여부를 결정합니다.
     *
     * - `true` → 브라우저가 자식 탭을 연 탭을 추적할 수 있으며,
     *   이는 일부 확장 프로그램(탭 트리 관리자 등)이 부모/자식 관계를 식별하는 데 도움이 됩니다.
     *
     * 기본값: true
     */
    setParent?: boolean;

    /**
     * 시크릿(incognito) 창에서 탭을 열지 여부.
     *
     * 참고: ScriptCat의 manifest.json은 `"incognito": "split"`으로 설정하므로
     * 일반 창에서 실행할 때 tabId/windowId를 사용할 수 없으며
     * "새 탭 열기" 작업만 수행할 수 있습니다.
     *
     * 기본값: false
     */
    incognito?: boolean;

    /**
     * 레거시 호환 필드, Tampermonkey만 지원합니다.
     * 의미는 `active`의 **반대**입니다:
     *
     * - `true` → `active = false`와 동일 (백그라운드에서 로드).
     * - `false` → `active = true`와 동일 (전경에서 로드).
     *
     * ⚠️ 권장하지 않음: `active`와 겹치고 혼동하기 쉽습니다.
     *
     * 기본값: false
     * @deprecated 대신 `active`를 사용하세요
     */
    loadInBackground?: boolean;

    /**
     * 새 탭을 브라우저 탭 모음의 왼쪽에 고정할지 여부.
     *
     * - `true` → 새 탭이 고정됩니다.
     * - `false` → 일반 탭.
     *
     * 기본값: false
     */
    pinned?: boolean;

    /**
     * `chrome.tabs.create` 대신 `window.open`을 사용하여 새 탭을 엽니다.
     * `vscode://`, `m3u8dl://` 같은 특수 프로토콜이 있는 링크를 열 때 유용합니다.
     * 이 열기 방법을 사용하면 다른 매개변수는 효과가 없습니다.
     *
     * 관련: Issue #178 #1043
     * 기본값: false
     */
    useOpen?: boolean;
  }

  interface Tab {
    close(): void;
    onclose?: () => void;
    closed?: boolean;
    name?: string;
  }
}

declare function GM_closeInTab(tabId: string): void;

// 탭 데이터 가져오기
declare function GM_getTab(callback: (obj: object) => void): void;
// 탭 데이터 저장
declare function GM_saveTab(obj: object): void;
// 모든 탭의 데이터 가져오기
declare function GM_getTabs(callback: (objs: { [key: number]: object }) => void): void;

function GM_registerMenuCommand(
  name: string,
  listener?: (inputValue?: any) => void,
  options_or_accessKey?:
    | {
        id?: number | string;
        accessKey?: string;
        autoClose?: boolean; // ScriptCat 전용 옵션, 기본값 true이며 false는 클릭 후 팝업 메뉴 페이지를 열어 둡니다
        nested?: boolean; // ScriptCat 전용 옵션, 기본값 true이며 false는 브라우저의 오른쪽 클릭 메뉴 항목을 3단계에서 2단계 메뉴로 올립니다
        individual?: boolean; // ScriptCat 전용 옵션, 기본값 false이며 true는 동일한 메뉴 항목이 병합되지 않음을 의미합니다
      }
    | string
): number;

declare function GM_unregisterMenuCommand(id: number): void;

declare function GM_notification(
  details: GMTypes.NotificationDetails,
  ondone?: GMTypes.NotificationOnDone
): void;
declare function GM_notification(
  text: string,
  title: string,
  image: string,
  onclick: GMTypes.NotificationOnClick
): void;
declare function GM_closeNotification(id: string): void;
declare function GM_updateNotification(id: string, details: GMTypes.NotificationDetails): void;

declare namespace GMTypes {
  interface NotificationDetails {
    text?: string;
    title?: string;
    tag?: string;
    image?: string;
    highlight?: boolean;
    silent?: boolean;
    timeout?: number;
    url?: string;
    onclick?: NotificationOnClick;
    ondone?: NotificationOnDone;
    progress?: number;
    oncreate?: NotificationOnClick;
    // 최대 2개 존재할 수 있습니다
    buttons?: NotificationButton[];
  }

  interface NotificationThis extends NotificationDetails {
    id: string;
  }

  type NotificationOnClickEvent = {
    event: "click" | "buttonClick";
    id: string;
    isButtonClick: boolean;
    buttonClickIndex: number | undefined;
    byUser: boolean | undefined;
    preventDefault: () => void;
    highlight: NotificationDetails["highlight"];
    image: NotificationDetails["image"];
    silent: NotificationDetails["silent"];
    tag: NotificationDetails["tag"];
    text: NotificationDetails["tag"];
    timeout: NotificationDetails["timeout"];
    title: NotificationDetails["title"];
    url: NotificationDetails["url"];
  };
  type NotificationOnClick = (this: NotificationThis, event: NotificationOnClickEvent) => unknown;
  type NotificationOnDone = (this: NotificationThis, user?: boolean) => unknown;

  interface NotificationButton {
    title: string;
    iconUrl?: string;
  }

}

declare function GM_setClipboard(
  data: string,
  info?: string | { type?: string; mimetype?: string }
): void;

declare function GM_xmlhttpRequest(details: GMTypes.XHRDetails): GMTypes.AbortHandle<void>;

declare namespace GMTypes {
  interface XHRResponse {
    finalUrl?: string;
    readyState?: 0 | 1 | 2 | 3 | 4;
    responseHeaders?: string;
    status?: number;
    statusText?: string;
    response?: any;
    responseText?: string;
    responseXML?: Document | null;
  }

  interface XHRProgress extends XHRResponse {
    done: number;
    lengthComputable: boolean;
    loaded: number;
    position: number;
    total: number;
    totalSize: number;
  }

  type Listener<OBJ> = (event: OBJ) => any;

  interface XHRDetails {
    method?: "GET" | "HEAD" | "POST" | "PUT" | "DELETE" | "PATCH" | "OPTIONS";
    url: string;
    headers?: { [key: string]: string };
    data?: string | FormData;
    cookie?: string;
    binary?: boolean;
    timeout?: number;
    responseType?: "text" | "arraybuffer" | "blob" | "json" | "document" | "stream"; // stream은 현재 버전에서 상당히 기본적인 구현입니다
    overrideMimeType?: string;
    anonymous?: boolean;
    fetch?: boolean;
    user?: string;
    password?: string;
    nocache?: boolean;
    redirect?: "follow" | "error" | "manual"; // Tampermonkey와 일관성을 유지하기 위해 maxRedirects는 v0.17.0 이후 redirect로 대체되어 사용 중단되었습니다. redirect는 fetch 모드를 강제합니다
    
    onload?: Listener<XHRResponse>;
    onloadstart?: Listener<XHRResponse>;
    onloadend?: Listener<XHRResponse>;
    onprogress?: Listener<XHRProgress>;
    onreadystatechange?: Listener<XHRResponse>;
    ontimeout?: () => void;
    onabort?: () => void;
    onerror?: (err: string) => void;
  }
}

declare function GM_download(details: GMTypes.DownloadDetails): GMTypes.AbortHandle<boolean>;
declare function GM_download(url: string, filename: string): GMTypes.AbortHandle<boolean>;

declare namespace GMTypes {
  interface DownloadError {
    error:
      | "not_enabled"
      | "not_whitelisted"
      | "not_permitted"
      | "not_supported"
      | "not_succeeded"
      | "unknown";
    details?: string;
  }

  interface DownloadDetails {
    method?: "GET" | "POST";
    downloadMode?: "native" | "browser";
    url: string;
    name: string;
    headers?: { [key: string]: string };
    saveAs?: boolean;
    timeout?: number;
    cookie?: string;
    anonymous?: boolean;

    onerror?: Listener<DownloadError>;
    ontimeout?: () => void;
    onload?: Listener<object>;
    onprogress?: Listener<XHRProgress>;
  }
}

// name과 domain이 동시에 비어 있을 수 없습니다
declare function GM_cookie(
  action: GMTypes.CookieAction,
  details: GMTypes.CookieDetails,
  ondone: (cookie: GMTypes.Cookie[], error: unknown | undefined) => void
): void;

declare namespace GMTypes {
  type CookieAction = "list" | "delete" | "set";
  interface CookieDetails {
    url?: string;
    name?: string;
    value?: string;
    domain?: string;
    path?: string;
    secure?: boolean;
    session?: boolean;
    httpOnly?: boolean;
    expirationDate?: number;
    partitionKey?: CookieDetailsPartitionKeyType;
  }
  interface Cookie {
    domain: string;
    name: string;
    value: string;
    session: boolean;
    hostOnly: boolean;
    expirationDate?: number;
    path: string;
    httpOnly: boolean;
    secure: boolean;
  }
}

// 콜백 형식
GM_cookie("list", { url: "https://example.com" }, (cookies) => {
  console.log(cookies);
  GM_cookie("set", {
    name: "foo",
    value: "bar",
    domain: "example.com"
  }, (result) => {
    console.log(result);
    GM_cookie("delete", { name: "foo", domain: "example.com" }, (result) => {
      console.log(result);
    });
  });
});

// Promise 형식
const cookies = await GM.cookie.list({ url: "https://example.com" });
await GM.cookie.set({ name: "foo", value: "bar", domain: "example.com" });
await GM.cookie.delete("foo", { domain: "example.com" });