@candriajs/git-neko-kit 1.0.0 → 1.1.1

package/dist/index.d.ts

@@ -25,9 +25,7 @@ declare enum ProxyProtocol {
     /** HTTPS */
     HTTPS = "https",
     /** SOCKS */
-    SOCKS = "socks",
-    /** SOCKS5 */
-    SOCKS5 = "socks5"
+    SOCKS = "socks"
 }
 /**
  * 基本代理配置
@@ -38,7 +36,7 @@ interface BaseProxyType<T extends ProxyType | ProxyProtocol> {
     address: ProxyUrlType;
 }
 /** 代理配置参数类型 */
-type ProxyParamsType = BaseProxyType<ProxyProtocol.HTTP> | BaseProxyType<ProxyProtocol.HTTPS> | BaseProxyType<ProxyProtocol.SOCKS> | BaseProxyType<ProxyProtocol.SOCKS5> | BaseProxyType<ProxyType.Common> | BaseProxyType<ProxyType.Reverse>;
+type ProxyParamsType = BaseProxyType<ProxyProtocol.HTTP> | BaseProxyType<ProxyProtocol.HTTPS> | BaseProxyType<ProxyProtocol.SOCKS> | BaseProxyType<ProxyType.Common> | BaseProxyType<ProxyType.Reverse>;
 
 /** 本地Git仓库信息 */
 interface GitRepoInfoType {
@@ -1099,7 +1097,7 @@ interface MilestoneType {
 type IssueInfoParamType = RepoBaseParamType & IssueNumberParamType;
 /** 议题详情响应类型 */
 interface IssueInfoResponseType {
-    /** 议题ID */
+    /** 问题id */
     id: IssueNumberParamType['issue_number'];
     /** 议题HTML页面URL */
     html_url: string;
@@ -1135,7 +1133,7 @@ interface IssueInfoResponseType {
     updated_at: string;
 }
 /** 议题列表参数类型 */
-type RepoIssueListParamType = RepoBaseParamType & {
+interface RepoIssueListParamType extends RepoBaseParamType {
     /**
      * 里程碑筛选
      * @default *
@@ -1208,7 +1206,7 @@ type RepoIssueListParamType = RepoBaseParamType & {
      * @default 1
      */
     page?: number;
-};
+}
 /** 议题列表响应类型 */
 type IssueListResponseType = IssueInfoResponseType[];
 /** 创建议题参数类型 */
@@ -1227,9 +1225,7 @@ type CreteIssueParamType = RepoBaseParamType & {
 /** 创建议题响应类型 */
 type CreateIssueResponseType = IssueInfoResponseType;
 /** 更新议题参数类型 */
-interface UpdateIssueParamType extends Omit<CreteIssueParamType, 'title' | 'type'> {
-    /** 问题ID */
-    issue_number: IssueNumberParamType['issue_number'];
+interface UpdateIssueParamType extends Omit<CreteIssueParamType, 'title' | 'type'>, IssueNumberParamType {
     /** 问题的名称 */
     title?: string | null;
     /** 问题的内容 */
@@ -1248,9 +1244,7 @@ type CloseIssueParamType = OpenIssueParamType;
 /** 关闭议题响应类型 */
 type CloseIssueResponseType = IssueInfoResponseType;
 /** 锁定议题参数类型 */
-interface LockIssueParamType extends RepoBaseParamType {
-    /** 议题ID */
-    issue_number: IssueNumberParamType['issue_number'];
+interface LockIssueParamType extends RepoBaseParamType, IssueNumberParamType {
     /**
      * 锁定原因
      * 可以是以下之一：
@@ -1278,10 +1272,7 @@ interface UnLockIssueResponseType {
     message: LockIssueResponseType['message'];
 }
 /** 议题评论信息参数类型 */
-interface IssueCommentInfoParamType extends RepoBaseParamType {
-    /** 评论id,评论唯一标识符 */
-    comment_id: string | number;
-}
+type IssueCommentInfoParamType = RepoBaseParamType & CommentIdParamType;
 /** 议题评论信息响应类型 */
 interface IssueCommentInfoResponseType {
     /** 评论ID */
@@ -1343,7 +1334,7 @@ type RepoCommentsListResponseType = IssueCommentInfoResponseType[];
 /** 议题评论列表参数类型 */
 interface IssueCommentsListParamType extends RepoBaseParamType {
     /** 议题ID */
-    issue_number: number;
+    issue_number: IssueNumberParamType['issue_number'];
     /**
      * 筛选此时间之后更新的评论
      * 仅显示在指定时间之后更新的结果
@@ -2071,6 +2062,38 @@ declare function get_local_repo_default_branch(local_path: string): Promise<stri
  */
 declare function get_remote_repo_default_branch(remote_url: string): Promise<string>;
 
+/**
+ * 渲染 markdown 内容为 HTML
+ * @description 使用配置好的 markdown-it 实例渲染 markdown 内容
+ * @param md - 要渲染的 markdown 字符串
+ * @returns 渲染后的 HTML 字符串
+ * @example
+ * ```ts
+ * const html = await render_markdown(`# 标题
+ * - 无序列表项1
+ * - 无序列表项2
+ *   - 子列表项
+ *
+ * 1. 有序列表项1
+ * 2. 有序列表项2
+ * `);
+ *
+ * -> <h1>标题</h1>
+ *  <ul style="list-style: none;">
+ *    <li>无序列表项1</li>
+ *    <li>无序列表项2</li>
+ *    <ul style="list-style: none;">
+ *      <li>子列表项</li>
+ *    </ul>
+ *  </ul>
+ *  <ol style="list-style: none;">
+ *    <li>有序列表项1</li>
+ *    <li>有序列表项2</li>
+ * </ol>
+ * ```
+ */
+declare function render_markdown(md: string): Promise<string>;
+
 /**
  * 获取本地 NPM 包信息
  * @description 获取本地 NPM 包信息
@@ -2132,15 +2155,24 @@ declare function format_date(dateString: string, locale?: string, format?: strin
 /**
  * 获取相对时间
  * @param dateString - 日期字符串
- * @param locale - 语言环境，默认为 'zh-cn'
- * @returns 相对时间
+ * @param options - 可选参数对象
+ * @param options.locale - 语言环境，默认为 'zh-cn'
+ * @param options.useAbsoluteIfOver30Days - 是否在超过30天时返回绝对时间
+ * @returns 相对时间或绝对时间
  * @example
- * ```ta
+ * ```ts
  * console.log(await get_relative_time('2023-04-01 12:00:00'))
- * ->  1 小时前
+ * -> "1 小时前"
+ *
+ * // 如果当前时间距离该日期已超过30天，则返回绝对时间
+ * console.log(await get_relative_time('2023-01-01 12:00:00', { useAbsoluteIfOver30Days: true }))
+ * -> "2025-07-01 13:00:00"
  * ```
  */
-declare function get_relative_time(dateString: string, locale?: string): Promise<string>;
+declare function get_relative_time(dateString: string, options?: {
+    locale?: string;
+    useAbsoluteIfOver30Days?: boolean;
+}): Promise<string>;
 /**
  * 根据语言名称获取对应的颜色值
  * @param language - 语言名称
@@ -4130,4 +4162,4 @@ declare class Client {
     constructor(options: ClientType);
 }
 
-export { type AccessCodeType, type AccessTokenClentTYpe, type AccessTokenPermissionsType, type AccessTokenType, type AddCollaboratorResponseType, type AddMemberParamType, type AddMemberResponseType, type ApiResponseType, type AppClientType, type AppInfoParamType, type AppInfoResponseType, type AppPermissions, type AppRepoInfoResponseType, type AppUser, type BaseProxyType, type CheckTokenResponseType, Client, type ClientType, type CloseIssueParamType, type CloseIssueResponseType, type CollaboratorInfoResponseType, type CollaboratorParamType, type CollaboratorPermissionType, type CommentIdParamType, type Commit$1 as Commit, type CommitInfoCommonParamType, type CommitInfoParamType, type CommitInfoResponseType, type CommitListParamType, type CommitListResponseType, type CommitStats, type ContributionData, type ContributionResult, type CreateAccessTokenForAppParamType, type CreateAccessTokenForAppResponseType, type CreateIssueResponseType, type CreatePullRequestCommentParamType, type CreatePullRequestCommentResponseType, type CreatePullRequestParamType, type CreatePullRequestResponseType, type CreateReleaseParamType, type CreateReleaseResponseType, type CreateSubIssueParamType, type CreateSubIssueResponseType, type CreteIssueCommentParamType, type CreteIssueCommentResponseType, type CreteIssueParamType, type DeletePullRequestCommentParamType, type DeletePullRequestCommentResponseType, type DeleteReleaseParamType, type DeleteReleaseResponseType, type DiffEntry, type DisEnableRepoWorkflowParamType, type DisEnableRepoWorkflowResponseType, type EnableRepoWorkflowParamType, type EnableRepoWorkflowResponseType, type GetAppInfoByOrgParamType, type GetAppInfoByOrgResponseType, type GetAppInfoByRepoParamType, type GetAppInfoByRepoResponseType, type GetAppInfoByUserParamType, type GetAppInfoByUserResponseType, type GetCollaboratorListParamType, type GetCollaboratorListResponseType, type GetOrgMemberInfoParamType, type GetOrgMemberInfoResponseType, type GetOrgMemberListParamType, type GetOrgMemberListResponseType, type GetOrgMemberListType, type GetPullRequestCommentInfoParamType, type GetPullRequestCommentInfoResponseType, type GetPullRequestCommentsListParamType, type GetPullRequestCommentsListResponseType, type GetPullRequestFilesListParamType, type GetPullRequestFilesListResponseType, type GetRepoDefaultBranchParamType, type GetRepoDefaultBranchResponseType, type GetRepoMainLanguageParamType, type GetRepoMainLanguageResponseType, type GetRepoVisibilityParamType, type GetRepoVisibilityResponseType, type GetRepoWorkflowsList, type GetRepoWorkflowsListResponseType, type GitHubBaseClient, GitHubClient, type GitHubClientType, type GitInfoListType, type GitRepoInfoListOptionsType, type GitRepoInfoType, type GitRepoType, type GitType, type GitUser, type IssueCommentInfoParamType, type IssueCommentInfoResponseType, type IssueCommentsListParamType, type IssueCommentsListResponseType, type IssueInfoParamType, type IssueInfoResponseType, type IssueLabelType, type IssueListResponseType, type IssueNumberParamType, type IssueUser, type LanguageInfo, type LockIssueParamType, type LockIssueResponseType, type MergeMethodType, type MergePullRequestParamType, type MergePullRequestResponseType, type MilestoneType, type NpmPackageInfoListOptionsType, type NpmPackageInfoListType, type NpmPackageInfoType, type OpenIssueParamType, type OpenIssueResponseType, type OrgInfoParamType, type OrgInfoResponseType, type OrgNameParamType, type OrgRepoCreateParamType, type OrgRepoCreateResponseType, type OrgRepoListParmType, type OrgRepoListResponseType, type OrgUser, type ParentCommit, type PkgInfoType, type PrRepo, type PrUser, type ProxyParamsType, ProxyProtocol, ProxyType, type ProxyUrlType, type PullRequestFilesListType, type PullRequestInfoParamType, type PullRequestInfoResponseType, type PullRequestListParamType, type PullRequestListResponseType, type PullRequestNumberParamType, type ReRunRepoWorkflowParamType, type ReRunRepoWorkflowResponseType, type ReactionInfoType, type RefreshTokenResponseType, type RefreshTokenType, type ReleaseAssetsType, type ReleaseInfoByTagParamType, type ReleaseInfoByTagResponseType, type ReleaseInfoParamType, type ReleaseInfoResponseType, type ReleaseLatestParamTypeType, type ReleaseLatestResponseType, type ReleaseListParamType, type ReleaseListResponseType, type ReleaseUser, type RemoveCollaboratorParamType, type RemoveCollaboratorResponseType, type RemoveIssueCommentParamType, type RemoveIssueCommentResponseType, type RemoveOrgMemberParamType, type RemoveOrgMemberResponseType, type RemoveSubIssueParamType, type RemoveSubIssueResponseType, type RepoBaseParamType, type RepoCommentsListParamType, type RepoCommentsListResponseType, type RepoInfoParamType, type RepoInfoResponseType, type RepoIssueListParamType, type RepoLanguagesListParamType, type RepoLanguagesListResponseType, type RepoListBaseParamType, type RepoNameParamType, type RepoOwnerParamType, type RepoParamType, type RepoUrlParamType, type RepoUser, type ReprioritizeSubIssueParamType, type ReprioritizeSubIssueResponseType, type RequestConfigType, type RequestTokenType, type ResponseHeadersType, type ResponseMsgType, type ResponseStatusCodeType, type ResponseSuccessType, type ResponseType, type RevokeAccessTokenResponseType, type RoleNameType, type RunRepoWorkflow, type RunRepoWorkflowResponseType, type SearchRepo, type SearchReposParamType, type SearchReposResponseType, type SearchUser, type SearchUsersParamType, type SearchUsersResponseType, type ShaParamType, type SubIssueListParamType, type SubIssueListResponseType, type TokenResponseType, type UnLockIssueParamType, type UnLockIssueResponseType, type UpdateIssueCommentParamType, type UpdateIssueCommentResponseType, type UpdateIssueParamType, type UpdateIssueResponseType, type UpdatePullRequestCommentParamType, type UpdatePullRequestCommentResponseType, type UpdatePullRequestParamType, type UpdatePullRequestResponseType, type UpdateReleaseParamType, type UpdateReleaseResponseType, type UserByTokenRepoListParamType, type UserIdParamType, type UserInfoByIdParamType, type UserInfoParamType, type UserInfoResponseType, type UserNameParamType, type UserRepoCreateParamType, type UserRepoCreateResponseType, type UserRepoListParamType, type UserRepoListType, type WebHookSignatureParamType, type WebHookSignatureResponseType, type WorkflowInfoParamType, type WorkflowInfoResponseType, WorkflowState, create_state_id, Client as default, type formatParamType, format_date, get_langage_color, get_local_git_repo_info, get_local_git_repos_list, get_local_npm_package_info, get_local_npm_packages_list, get_local_repo_default_branch, get_relative_time, get_remote_repo_default_branch, index as github, type isAppInstalledInRepo, type workflowIdParamType };
+export { type AccessCodeType, type AccessTokenClentTYpe, type AccessTokenPermissionsType, type AccessTokenType, type AddCollaboratorResponseType, type AddMemberParamType, type AddMemberResponseType, type ApiResponseType, type AppClientType, type AppInfoParamType, type AppInfoResponseType, type AppPermissions, type AppRepoInfoResponseType, type AppUser, type BaseProxyType, type CheckTokenResponseType, Client, type ClientType, type CloseIssueParamType, type CloseIssueResponseType, type CollaboratorInfoResponseType, type CollaboratorParamType, type CollaboratorPermissionType, type CommentIdParamType, type Commit$1 as Commit, type CommitInfoCommonParamType, type CommitInfoParamType, type CommitInfoResponseType, type CommitListParamType, type CommitListResponseType, type CommitStats, type ContributionData, type ContributionResult, type CreateAccessTokenForAppParamType, type CreateAccessTokenForAppResponseType, type CreateIssueResponseType, type CreatePullRequestCommentParamType, type CreatePullRequestCommentResponseType, type CreatePullRequestParamType, type CreatePullRequestResponseType, type CreateReleaseParamType, type CreateReleaseResponseType, type CreateSubIssueParamType, type CreateSubIssueResponseType, type CreteIssueCommentParamType, type CreteIssueCommentResponseType, type CreteIssueParamType, type DeletePullRequestCommentParamType, type DeletePullRequestCommentResponseType, type DeleteReleaseParamType, type DeleteReleaseResponseType, type DiffEntry, type DisEnableRepoWorkflowParamType, type DisEnableRepoWorkflowResponseType, type EnableRepoWorkflowParamType, type EnableRepoWorkflowResponseType, type GetAppInfoByOrgParamType, type GetAppInfoByOrgResponseType, type GetAppInfoByRepoParamType, type GetAppInfoByRepoResponseType, type GetAppInfoByUserParamType, type GetAppInfoByUserResponseType, type GetCollaboratorListParamType, type GetCollaboratorListResponseType, type GetOrgMemberInfoParamType, type GetOrgMemberInfoResponseType, type GetOrgMemberListParamType, type GetOrgMemberListResponseType, type GetOrgMemberListType, type GetPullRequestCommentInfoParamType, type GetPullRequestCommentInfoResponseType, type GetPullRequestCommentsListParamType, type GetPullRequestCommentsListResponseType, type GetPullRequestFilesListParamType, type GetPullRequestFilesListResponseType, type GetRepoDefaultBranchParamType, type GetRepoDefaultBranchResponseType, type GetRepoMainLanguageParamType, type GetRepoMainLanguageResponseType, type GetRepoVisibilityParamType, type GetRepoVisibilityResponseType, type GetRepoWorkflowsList, type GetRepoWorkflowsListResponseType, type GitHubBaseClient, GitHubClient, type GitHubClientType, type GitInfoListType, type GitRepoInfoListOptionsType, type GitRepoInfoType, type GitRepoType, type GitType, type GitUser, type IssueCommentInfoParamType, type IssueCommentInfoResponseType, type IssueCommentsListParamType, type IssueCommentsListResponseType, type IssueInfoParamType, type IssueInfoResponseType, type IssueLabelType, type IssueListResponseType, type IssueNumberParamType, type IssueUser, type LanguageInfo, type LockIssueParamType, type LockIssueResponseType, type MergeMethodType, type MergePullRequestParamType, type MergePullRequestResponseType, type MilestoneType, type NpmPackageInfoListOptionsType, type NpmPackageInfoListType, type NpmPackageInfoType, type OpenIssueParamType, type OpenIssueResponseType, type OrgInfoParamType, type OrgInfoResponseType, type OrgNameParamType, type OrgRepoCreateParamType, type OrgRepoCreateResponseType, type OrgRepoListParmType, type OrgRepoListResponseType, type OrgUser, type ParentCommit, type PkgInfoType, type PrRepo, type PrUser, type ProxyParamsType, ProxyProtocol, ProxyType, type ProxyUrlType, type PullRequestFilesListType, type PullRequestInfoParamType, type PullRequestInfoResponseType, type PullRequestListParamType, type PullRequestListResponseType, type PullRequestNumberParamType, type ReRunRepoWorkflowParamType, type ReRunRepoWorkflowResponseType, type ReactionInfoType, type RefreshTokenResponseType, type RefreshTokenType, type ReleaseAssetsType, type ReleaseInfoByTagParamType, type ReleaseInfoByTagResponseType, type ReleaseInfoParamType, type ReleaseInfoResponseType, type ReleaseLatestParamTypeType, type ReleaseLatestResponseType, type ReleaseListParamType, type ReleaseListResponseType, type ReleaseUser, type RemoveCollaboratorParamType, type RemoveCollaboratorResponseType, type RemoveIssueCommentParamType, type RemoveIssueCommentResponseType, type RemoveOrgMemberParamType, type RemoveOrgMemberResponseType, type RemoveSubIssueParamType, type RemoveSubIssueResponseType, type RepoBaseParamType, type RepoCommentsListParamType, type RepoCommentsListResponseType, type RepoInfoParamType, type RepoInfoResponseType, type RepoIssueListParamType, type RepoLanguagesListParamType, type RepoLanguagesListResponseType, type RepoListBaseParamType, type RepoNameParamType, type RepoOwnerParamType, type RepoParamType, type RepoUrlParamType, type RepoUser, type ReprioritizeSubIssueParamType, type ReprioritizeSubIssueResponseType, type RequestConfigType, type RequestTokenType, type ResponseHeadersType, type ResponseMsgType, type ResponseStatusCodeType, type ResponseSuccessType, type ResponseType, type RevokeAccessTokenResponseType, type RoleNameType, type RunRepoWorkflow, type RunRepoWorkflowResponseType, type SearchRepo, type SearchReposParamType, type SearchReposResponseType, type SearchUser, type SearchUsersParamType, type SearchUsersResponseType, type ShaParamType, type SubIssueListParamType, type SubIssueListResponseType, type TokenResponseType, type UnLockIssueParamType, type UnLockIssueResponseType, type UpdateIssueCommentParamType, type UpdateIssueCommentResponseType, type UpdateIssueParamType, type UpdateIssueResponseType, type UpdatePullRequestCommentParamType, type UpdatePullRequestCommentResponseType, type UpdatePullRequestParamType, type UpdatePullRequestResponseType, type UpdateReleaseParamType, type UpdateReleaseResponseType, type UserByTokenRepoListParamType, type UserIdParamType, type UserInfoByIdParamType, type UserInfoParamType, type UserInfoResponseType, type UserNameParamType, type UserRepoCreateParamType, type UserRepoCreateResponseType, type UserRepoListParamType, type UserRepoListType, type WebHookSignatureParamType, type WebHookSignatureResponseType, type WorkflowInfoParamType, type WorkflowInfoResponseType, WorkflowState, create_state_id, Client as default, type formatParamType, format_date, get_langage_color, get_local_git_repo_info, get_local_git_repos_list, get_local_npm_package_info, get_local_npm_packages_list, get_local_repo_default_branch, get_relative_time, get_remote_repo_default_branch, index as github, type isAppInstalledInRepo, render_markdown, type workflowIdParamType };