gitalk-react 1.0.0 → 1.1.0

package/dist/gitalk.d.ts

@@ -1,623 +0,0 @@
-import { default as default_2 } from 'react';
-import { default as default_3 } from 'react-flip-move';
-import { Endpoints } from '@octokit/types';
-
-declare type Comment_2 = Pick<CommentDefine, "id" | "body" | "body_html" | "created_at" | "html_url"> & {
-    user: Pick<NonNullable<CommentDefine["user"]>, "avatar_url" | "login" | "html_url">;
-    reactions: Pick<NonNullable<CommentDefine["reactions"]>, "heart">;
-    reactionsHeart: {
-        totalCount: number;
-        viewerHasReacted: boolean;
-        nodes: {
-            databaseId: number;
-            user: {
-                login: string;
-            };
-        }[];
-    };
-};
-
-declare type CommentDefine = Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/comments"]["response"]["data"][number];
-
-export declare const DEFAULT_FLIP_MOVE_OPTIONS: NonNullable<GitalkProps["flipMoveOptions"]>;
-
-declare const Gitalk: default_2.FC<GitalkProps>;
-export default Gitalk;
-
-export declare interface GitalkProps extends Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "id" | "title"> {
-    /**
-     * GitHub Application Client ID.
-     */
-    clientID: string;
-    /**
-     * GitHub Application Client Secret.
-     */
-    clientSecret: string;
-    /**
-     * GitHub repository owner.
-     * Can be personal user or organization.
-     */
-    owner: string;
-    /**
-     * Name of Github repository.
-     */
-    repo: string;
-    /**
-     * GitHub repository owner and collaborators.
-     * (Users who having write access to this repository)
-     */
-    admin: string[];
-    /**
-     * The unique id of the page.
-     * Length must less than 50.
-     *
-     * @default location.host + location.pathname
-     */
-    id?: string;
-    /**
-     * The issue ID of the page.
-     * If the number attribute is not defined, issue will be located using id.
-     */
-    number?: number;
-    /**
-     * GitHub issue labels.
-     *
-     * @default ['Gitalk']
-     */
-    labels?: string[];
-    /**
-     * GitHub issue title.
-     *
-     * @default document.title
-     */
-    title?: string;
-    /**
-     * GitHub issue body.
-     *
-     * @default location.href + header.meta[description]
-     */
-    body?: string;
-    /**
-     * Localization language key.
-     *
-     * @default navigator.language
-     */
-    language?: Lang;
-    /**
-     * Pagination size, with maximum 100.
-     *
-     * @default 10
-     */
-    perPage?: number;
-    /**
-     * Comment sorting direction.
-     * Available values are `last` and `first`.
-     *
-     * @default "last"
-     */
-    pagerDirection?: "last" | "first";
-    /**
-     * By default, Gitalk will create a corresponding github issue for your every single page automatically when the logined user is belong to the admin users.
-     * You can create it manually by setting this option to true.
-     *
-     * @default false
-     */
-    createIssueManually?: boolean;
-    /**
-     * Enable hot key (cmd|ctrl + enter) submit comment.
-     *
-     * @default true
-     */
-    enableHotKey?: boolean;
-    /**
-     * Facebook-like distraction free mode.
-     *
-     * @default false
-     */
-    distractionFreeMode?: boolean;
-    /**
-     * Comment list animation.
-     *
-     * @default
-     * ```ts
-     * {
-     *   staggerDelayBy: 150,
-     *   appearAnimation: 'accordionVertical',
-     *   enterAnimation: 'accordionVertical',
-     *   leaveAnimation: 'accordionVertical',
-     * }
-     * ```
-     * @link https://github.com/joshwcomeau/react-flip-move/blob/master/documentation/enter_leave_animations.md
-     */
-    flipMoveOptions?: default_3.FlipMoveProps;
-    /**
-     * GitHub oauth request reverse proxy for CORS.
-     * [Why need this?](https://github.com/isaacs/github/issues/330)
-     *
-     * @default "https://cors-anywhere.azm.workers.dev/https://github.com/login/oauth/access_token"
-     */
-    proxy?: string;
-    /**
-     * Default user field if comments' author is not provided
-     *
-     * @default
-     * ```ts
-     * {
-     *   avatar_url: "//avatars1.githubusercontent.com/u/29697133?s=50",
-     *   login: "null",
-     *   html_url: ""
-     * }
-     */
-    defaultUser?: Comment_2["user"];
-    /**
-     * Default user field if comments' author is not provided
-     *
-     * @deprecated use `defaultUser`
-     */
-    defaultAuthor?: IssueCommentsQLResponse["repository"]["issue"]["comments"]["nodes"][number]["author"];
-    /**
-     * Default collapse the comment if meets the height (px)
-     */
-    collapsedHeight?: number;
-    /**
-     * Whether to highlight the comment created by admin users.
-     *
-     * @default true
-     */
-    highlightAdminComment?: boolean;
-    /**
-     * Callback method invoked when updating the number of comments.
-     *
-     * @param count comments number
-     */
-    updateCountCallback?: (count: number) => void;
-    /**
-     * Callback method invoked when a new issue is successfully created.
-     *
-     * @param issue created issue
-     */
-    onCreateIssue?: (issue: Issue) => void;
-    /**
-     * Callback method invoked when a new comment is successfully created.
-     *
-     * @param comment created comment
-     */
-    onCreateComment?: (comment: Comment_2) => void;
-}
-
-declare const i18nMap: {
-    en: {
-        init: string;
-        "no-found-related": string;
-        "please-contact": string;
-        "init-issue": string;
-        "leave-a-comment": string;
-        preview: string;
-        edit: string;
-        comment: string;
-        "support-markdown": string;
-        "login-with-github": string;
-        "first-comment-person": string;
-        commented: string;
-        "load-more": string;
-        counts: string;
-        "sort-asc": string;
-        "sort-desc": string;
-        logout: string;
-        anonymous: string;
-    };
-    zh: {
-        init: string;
-        "no-found-related": string;
-        "please-contact": string;
-        "init-issue": string;
-        "leave-a-comment": string;
-        preview: string;
-        edit: string;
-        comment: string;
-        "support-markdown": string;
-        "login-with-github": string;
-        "first-comment-person": string;
-        commented: string;
-        "load-more": string;
-        counts: string;
-        "sort-asc": string;
-        "sort-desc": string;
-        logout: string;
-        anonymous: string;
-    };
-    "zh-CN": {
-        init: string;
-        "no-found-related": string;
-        "please-contact": string;
-        "init-issue": string;
-        "leave-a-comment": string;
-        preview: string;
-        edit: string;
-        comment: string;
-        "support-markdown": string;
-        "login-with-github": string;
-        "first-comment-person": string;
-        commented: string;
-        "load-more": string;
-        counts: string;
-        "sort-asc": string;
-        "sort-desc": string;
-        logout: string;
-        anonymous: string;
-    };
-    "zh-SG": {
-        init: string;
-        "no-found-related": string;
-        "please-contact": string;
-        "init-issue": string;
-        "leave-a-comment": string;
-        preview: string;
-        edit: string;
-        comment: string;
-        "support-markdown": string;
-        "login-with-github": string;
-        "first-comment-person": string;
-        commented: string;
-        "load-more": string;
-        counts: string;
-        "sort-asc": string;
-        "sort-desc": string;
-        logout: string;
-        anonymous: string;
-    };
-    "zh-TW": {
-        init: string;
-        "no-found-related": string;
-        "please-contact": string;
-        "init-issue": string;
-        "leave-a-comment": string;
-        preview: string;
-        edit: string;
-        comment: string;
-        "support-markdown": string;
-        "login-with-github": string;
-        "first-comment-person": string;
-        commented: string;
-        "load-more": string;
-        counts: string;
-        "sort-asc": string;
-        "sort-desc": string;
-        logout: string;
-        anonymous: string;
-    };
-    "zh-HK": {
-        init: string;
-        "no-found-related": string;
-        "please-contact": string;
-        "init-issue": string;
-        "leave-a-comment": string;
-        preview: string;
-        edit: string;
-        comment: string;
-        "support-markdown": string;
-        "login-with-github": string;
-        "first-comment-person": string;
-        commented: string;
-        "load-more": string;
-        counts: string;
-        "sort-asc": string;
-        "sort-desc": string;
-        logout: string;
-        anonymous: string;
-    };
-    "zh-MO": {
-        init: string;
-        "no-found-related": string;
-        "please-contact": string;
-        "init-issue": string;
-        "leave-a-comment": string;
-        preview: string;
-        edit: string;
-        comment: string;
-        "support-markdown": string;
-        "login-with-github": string;
-        "first-comment-person": string;
-        commented: string;
-        "load-more": string;
-        counts: string;
-        "sort-asc": string;
-        "sort-desc": string;
-        logout: string;
-        anonymous: string;
-    };
-    hi: {
-        init: string;
-        "no-found-related": string;
-        "please-contact": string;
-        "init-issue": string;
-        "leave-a-comment": string;
-        preview: string;
-        edit: string;
-        comment: string;
-        "support-markdown": string;
-        "login-with-github": string;
-        "first-comment-person": string;
-        commented: string;
-        "load-more": string;
-        counts: string;
-        "sort-asc": string;
-        "sort-desc": string;
-        logout: string;
-        anonymous: string;
-    };
-    es: {
-        init: string;
-        "no-found-related": string;
-        "please-contact": string;
-        "init-issue": string;
-        "leave-a-comment": string;
-        preview: string;
-        edit: string;
-        comment: string;
-        "support-markdown": string;
-        "login-with-github": string;
-        "first-comment-person": string;
-        commented: string;
-        "load-more": string;
-        counts: string;
-        "sort-asc": string;
-        "sort-desc": string;
-        logout: string;
-        anonymous: string;
-    };
-    fr: {
-        init: string;
-        "no-found-related": string;
-        "please-contact": string;
-        "init-issue": string;
-        "leave-a-comment": string;
-        preview: string;
-        edit: string;
-        comment: string;
-        "support-markdown": string;
-        "login-with-github": string;
-        "first-comment-person": string;
-        commented: string;
-        "load-more": string;
-        counts: string;
-        "sort-asc": string;
-        "sort-desc": string;
-        logout: string;
-        anonymous: string;
-    };
-    ar: {
-        init: string;
-        "no-found-related": string;
-        "please-contact": string;
-        "init-issue": string;
-        "leave-a-comment": string;
-        preview: string;
-        edit: string;
-        comment: string;
-        "support-markdown": string;
-        "login-with-github": string;
-        "first-comment-person": string;
-        commented: string;
-        "load-more": string;
-        counts: string;
-        "sort-asc": string;
-        "sort-desc": string;
-        logout: string;
-        anonymous: string;
-    };
-    bn: {
-        init: string;
-        "no-found-related": string;
-        "please-contact": string;
-        "init-issue": string;
-        "leave-a-comment": string;
-        preview: string;
-        edit: string;
-        comment: string;
-        "support-markdown": string;
-        "login-with-github": string;
-        "first-comment-person": string;
-        commented: string;
-        "load-more": string;
-        counts: string;
-        "sort-asc": string;
-        "sort-desc": string;
-        logout: string;
-        anonymous: string;
-    };
-    ru: {
-        init: string;
-        "no-found-related": string;
-        "please-contact": string;
-        "init-issue": string;
-        "leave-a-comment": string;
-        preview: string;
-        edit: string;
-        comment: string;
-        "support-markdown": string;
-        "login-with-github": string;
-        "first-comment-person": string;
-        commented: string;
-        "load-more": string;
-        counts: string;
-        "sort-asc": string;
-        "sort-desc": string;
-        logout: string;
-        anonymous: string;
-    };
-    pt: {
-        init: string;
-        "no-found-related": string;
-        "please-contact": string;
-        "init-issue": string;
-        "leave-a-comment": string;
-        preview: string;
-        edit: string;
-        comment: string;
-        "support-markdown": string;
-        "login-with-github": string;
-        "first-comment-person": string;
-        commented: string;
-        "load-more": string;
-        counts: string;
-        "sort-asc": string;
-        "sort-desc": string;
-        logout: string;
-        anonymous: string;
-    };
-    ur: {
-        init: string;
-        "no-found-related": string;
-        "please-contact": string;
-        "init-issue": string;
-        "leave-a-comment": string;
-        preview: string;
-        edit: string;
-        comment: string;
-        "support-markdown": string;
-        "login-with-github": string;
-        "first-comment-person": string;
-        commented: string;
-        "load-more": string;
-        counts: string;
-        "sort-asc": string;
-        "sort-desc": string;
-        logout: string;
-        anonymous: string;
-    };
-    ko: {
-        init: string;
-        "no-found-related": string;
-        "please-contact": string;
-        "init-issue": string;
-        "leave-a-comment": string;
-        preview: string;
-        edit: string;
-        comment: string;
-        "support-markdown": string;
-        "login-with-github": string;
-        "first-comment-person": string;
-        commented: string;
-        "load-more": string;
-        counts: string;
-        "sort-asc": string;
-        "sort-desc": string;
-        logout: string;
-        anonymous: string;
-    };
-    ja: {
-        init: string;
-        "no-found-related": string;
-        "please-contact": string;
-        "init-issue": string;
-        "leave-a-comment": string;
-        preview: string;
-        edit: string;
-        comment: string;
-        "support-markdown": string;
-        "login-with-github": string;
-        "first-comment-person": string;
-        commented: string;
-        "load-more": string;
-        counts: string;
-        "sort-asc": string;
-        "sort-desc": string;
-        logout: string;
-        anonymous: string;
-    };
-    de: {
-        init: string;
-        "no-found-related": string;
-        "please-contact": string;
-        "init-issue": string;
-        "leave-a-comment": string;
-        preview: string;
-        edit: string;
-        comment: string;
-        "support-markdown": string;
-        "login-with-github": string;
-        "first-comment-person": string;
-        commented: string;
-        "load-more": string;
-        counts: string;
-        "sort-asc": string;
-        "sort-desc": string;
-        logout: string;
-        anonymous: string;
-    };
-    pl: {
-        init: string;
-        "no-found-related": string;
-        "please-contact": string;
-        "init-issue": string;
-        "leave-a-comment": string;
-        preview: string;
-        edit: string;
-        comment: string;
-        "support-markdown": string;
-        "login-with-github": string;
-        "first-comment-person": string;
-        commented: string;
-        "load-more": string;
-        counts: string;
-        "sort-asc": string;
-        "sort-desc": string;
-        logout: string;
-        anonymous: string;
-    };
-    fa: {
-        init: string;
-        "no-found-related": string;
-        "please-contact": string;
-        "init-issue": string;
-        "leave-a-comment": string;
-        preview: string;
-        edit: string;
-        comment: string;
-        "support-markdown": string;
-        "login-with-github": string;
-        "first-comment-person": string;
-        commented: string;
-        "load-more": string;
-        counts: string;
-        "sort-asc": string;
-        "sort-desc": string;
-        logout: string;
-        anonymous: string;
-    };
-};
-
-declare type Issue = Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}"]["response"]["data"];
-
-declare interface IssueCommentsQLResponse {
-    repository: {
-        issue: {
-            comments: {
-                totalCount: number;
-                pageInfo: {
-                    hasPreviousPage?: boolean;
-                    hasNextPage?: boolean;
-                    startCursor?: string;
-                    endCursor?: string;
-                };
-                nodes: (Pick<Comment_2, "body"> & {
-                    databaseId: Comment_2["id"];
-                    author: {
-                        avatarUrl: Comment_2["user"]["avatar_url"];
-                        login: Comment_2["user"]["login"];
-                        url: Comment_2["user"]["html_url"];
-                    };
-                    bodyHTML: Comment_2["body_html"];
-                    createdAt: Comment_2["created_at"];
-                    resourcePath: Comment_2["html_url"];
-                    reactions: Comment_2["reactionsHeart"];
-                })[];
-            };
-        };
-    };
-}
-
-declare type Lang = keyof typeof i18nMap;
-
-export { }