diff --git a/src/api.ts b/src/api.ts
index 3977602..09730c4 100644
--- a/src/api.ts
+++ b/src/api.ts
@@ -3,11 +3,11 @@ import fetch from 'node-fetch';
class Traffic {
/**
- * @param user - The User of Repo
+ * @param user - The User of "repo"
* @param repo - The name of the Repo
* @param repo - The Username with Push Access to "repo"
* @param password - The Access Token of "username"
- * @returns Clones as JSON Object
+ * @returns the total number of clones and breakdown per day for the last 14 days as JSON object
*/
clones(user: string, repo: string, username: string, password: string): Promise {
return fetch(`https://api.github.com/repos/${user}/${repo}/traffic/clones`, {
@@ -18,13 +18,13 @@ class Traffic {
.catch((err) => Error(err));
}
/**
- * @param user - The User of Repo
+ * @param user - The User of "repo"
* @param repo - The name of the Repo
* @param repo - The Username with Push Access to "repo"
* @param password - The Access Token of "username"
- * @returns Popular Paths as JSON Object
+ * @returns top 10 popular contents over the last 14 days as JSON object
*/
- popularpaths(
+ popularPaths(
user: string,
repo: string,
username: string,
@@ -38,13 +38,13 @@ class Traffic {
.catch((err) => Error(err));
}
/**
- * @param user - The User of Repo
+ * @param user - The User of "repo"
* @param repo - The name of the Repo
* @param repo - The Username with Push Access to "repo"
* @param password - The Access Token of "username"
- * @returns Popular Referrers as JSON Object
+ * @returns the top 10 referrers over the last 14 days as JSON object
*/
- popularreferrers(
+ popularReferrers(
user: string,
repo: string,
username: string,
@@ -58,11 +58,11 @@ class Traffic {
.catch((err) => Error(err));
}
/**
- * @param user - The User of Repo
+ * @param user - The User of "repo"
* @param repo - The name of the Repo
* @param repo - The Username with Push Access to "repo"
* @param password - The Access Token of "username"
- * @returns Views as JSON Object
+ * @returns total number of views and breakdown per day for the last 14 days as JSON object
*/
views(user: string, repo: string, username: string, password: string): Promise {
return fetch(`https://api.github.com/repos/${user}/${repo}/traffic/views`, {
@@ -75,7 +75,7 @@ class Traffic {
}
/**
* @param user - The User
- * @returns Repos as JSON Object
+ * @returns public repositories for the specified user as JSON object
*/
async function Repos(user: string): Promise {
return fetch(`https://api.github.com/users/${user}/repos?page=1&type=all&per_page=100`)
@@ -83,7 +83,29 @@ async function Repos(user: string): Promise {
.catch((err) => Error(err));
}
-export { Traffic, Repos };
+/**
+ * @param user - The User of "repo"
+ * @param repo - The name of the Repo
+ * @returns the last year of commit activity grouped by week as JSON object
+ */
+async function CommitActivity(user: string, repo: string): Promise {
+ return fetch(`https://api.github.com/repos/${user}/${repo}/stats/commit_activity`)
+ .then((value) => value.json())
+ .catch((err) => Error(err));
+}
+
+/**
+ * @param user - The User of "repo"
+ * @param repo - The name of the Repo
+ * @returns the hourly commit count for each day as JSON object
+ */
+async function PunchCard(user: string, repo: string): Promise {
+ return fetch(`https://api.github.com/repos/${user}/${repo}/stats/punch_card`)
+ .then((value) => value.json())
+ .catch((err) => Error(err));
+}
+
+export { Traffic, Repos, CommitActivity, PunchCard };
export interface ClonesType {
count: number;
@@ -164,6 +186,7 @@ export interface ReposType {
clone_url: string;
svn_url: string;
homepage?: string | null;
+ /** size in kb */
size: number;
stargazers_count: number;
watchers_count: number;
@@ -222,3 +245,19 @@ export interface ViewsEntity {
count: number;
uniques: number;
}
+
+export interface CommitActivityType {
+ total: number;
+ week: number;
+ /** days array is a group of commits per day, starting on Sunday */
+ days: number[];
+}
+
+interface PunchCardType {
+ /** 0-6: Sunday - Saturday */
+ 0: number;
+ /** 0-23: Hour of day */
+ 1: number;
+ /** Number of commits */
+ 2: number;
+}
diff --git a/src/index.ts b/src/index.ts
index 5b23958..e4cd821 100644
--- a/src/index.ts
+++ b/src/index.ts
@@ -1,7 +1,13 @@
-import { Repos, Traffic } from './api';
+import { CommitActivity, PunchCard, Repos, Traffic } from './api';
+import { EpochToDate } from './utils';
+/** Api */
const repos = Repos;
-
const traffic = new Traffic();
+const commitActivity = CommitActivity;
+const punchCard = PunchCard;
+
+/** Utils */
+const epochToDate = EpochToDate;
-export { repos, traffic };
+export { repos, traffic, commitActivity, punchCard, epochToDate };
diff --git a/src/utils.ts b/src/utils.ts
index 1ddf097..09ea5b0 100644
--- a/src/utils.ts
+++ b/src/utils.ts
@@ -1,3 +1,6 @@
+/**
+ * @param epoch Unix Timestamp
+ */
function EpochToDate(epoch: number): Date {
const date = new Date(epoch * 1000);
return date;
diff --git a/typedoc.json b/typedoc.json
index cb3da0f..d065049 100644
--- a/typedoc.json
+++ b/typedoc.json
@@ -1,4 +1,4 @@
{
- "entryPoints": ["./src/api.ts"],
+ "entryPoints": ["./src/api.ts", "./src/utils.ts"],
"out": "docs"
}
\ No newline at end of file
The User of Repo
+The User of "repo"