githublogen 0.1.0 → 0.1.3

package/dist/index.d.ts

@@ -1,4 +1,11 @@
 type SemverBumpType = 'major' | 'premajor' | 'minor' | 'preminor' | 'patch' | 'prepatch' | 'prerelease';
+type RepoProvider = 'github' | 'gitlab' | 'bitbucket';
+type RepoConfig = {
+    domain?: string;
+    repo?: string;
+    provider?: RepoProvider;
+    token?: string;
+};
 interface ChangelogConfig {
     cwd: string;
     types: Record<string, {
@@ -6,7 +13,8 @@ interface ChangelogConfig {
         semver?: SemverBumpType;
     }>;
     scopeMap: Record<string, string>;
-    github: string;
+    repo: RepoConfig;
+    tokens: Partial<Record<RepoProvider, string>>;
     from: string;
     to: string;
     newVersion?: string;
@@ -26,6 +34,18 @@ interface Reference {
     type: 'hash' | 'issue' | 'pull-request';
     value: string;
 }
+interface GithubOptions {
+    repo: string;
+    token: string;
+}
+interface GithubRelease {
+    id?: string;
+    tag_name: string;
+    name?: string;
+    body?: string;
+    draft?: boolean;
+    prerelease?: boolean;
+}
 interface GitCommit extends RawGitCommit {
     description: string;
     type: string;
@@ -34,10 +54,16 @@ interface GitCommit extends RawGitCommit {
     authors: GitCommitAuthor[];
     isBreaking: boolean;
 }
+interface AuthorInfo {
+    commits: string[];
+    login?: string;
+    email: string;
+    name: string;
+}
 interface Commit extends GitCommit {
     resolvedAuthors?: AuthorInfo[];
 }
-interface ChangelogOptions extends Partial<ChangelogConfig> {
+interface ChangelogOptions extends ChangelogConfig {
     /**
      * Dry run. Skip releasing to GitHub.
      */
@@ -60,10 +86,6 @@ interface ChangelogOptions extends Partial<ChangelogConfig> {
      * Mark the release as prerelease
      */
     prerelease?: boolean;
-    /**
-     * GitHub Token
-     */
-    token?: string;
     /**
      * Custom titles
      */
@@ -87,12 +109,6 @@ interface ChangelogOptions extends Partial<ChangelogConfig> {
     emoji?: boolean;
 }
 type ResolvedChangelogOptions = Required<ChangelogOptions>;
-interface AuthorInfo {
-    commits: string[];
-    login?: string;
-    email: string;
-    name: string;
-}
 
 declare function sendRelease(options: ChangelogOptions, content: string): Promise<void>;
 declare function resolveAuthorInfo(options: ChangelogOptions, info: AuthorInfo): Promise<AuthorInfo>;
@@ -107,19 +123,22 @@ declare function isRefGitTag(to: string): Promise<boolean>;
 declare function getFirstGitCommit(): Promise<string>;
 declare function isPrerelease(version: string): boolean;
 declare function getGitDiff(from: string | undefined, to?: string): Promise<RawGitCommit[]>;
+declare function getGitRemoteURL(cwd: string, remote?: string): Promise<string>;
+declare function getGitPushUrl(config: RepoConfig, token?: string): string | null;
 
 declare function generateMarkdown(commits: Commit[], options: ResolvedChangelogOptions): string;
+declare function generateChangelog(commits: Commit[], config: ResolvedChangelogOptions): Promise<string>;
 
-declare function generate(options: ChangelogOptions): Promise<{
+declare function generate(cwd: string, options: ChangelogOptions): Promise<{
     config: Required<ChangelogOptions>;
     md: string;
     commits: GitCommit[];
+    changelog: string;
 }>;
 
-declare function defineConfig(config: ChangelogOptions): ChangelogOptions;
-declare function resolveConfig(options: ChangelogOptions): Promise<Required<ChangelogOptions>>;
+declare function resolveConfig(cwd: string, options: ChangelogOptions): Promise<Required<ChangelogOptions>>;
 
 declare function parseGitCommit(commit: RawGitCommit, config: ChangelogConfig): GitCommit | null;
 declare function parseCommits(commits: RawGitCommit[], config: ChangelogConfig): GitCommit[];
 
-export { AuthorInfo, ChangelogConfig, ChangelogOptions, Commit, GitCommit, GitCommitAuthor, RawGitCommit, Reference, ResolvedChangelogOptions, SemverBumpType, defineConfig, generate, generateMarkdown, getCurrentGitBranch, getFirstGitCommit, getGitDiff, getGitHubRepo, getLastGitTag, hasTagOnGitHub, isPrerelease, isRefGitTag, isRepoShallow, parseCommits, parseGitCommit, resolveAuthorInfo, resolveAuthors, resolveConfig, sendRelease };
+export { AuthorInfo, ChangelogConfig, ChangelogOptions, Commit, GitCommit, GitCommitAuthor, GithubOptions, GithubRelease, RawGitCommit, Reference, RepoConfig, RepoProvider, ResolvedChangelogOptions, SemverBumpType, generate, generateChangelog, generateMarkdown, getCurrentGitBranch, getFirstGitCommit, getGitDiff, getGitHubRepo, getGitPushUrl, getGitRemoteURL, getLastGitTag, hasTagOnGitHub, isPrerelease, isRefGitTag, isRepoShallow, parseCommits, parseGitCommit, resolveAuthorInfo, resolveAuthors, resolveConfig, sendRelease };