pacman-contribution-graph 1.0.2 → 1.0.3

package/github-action/package.json

@@ -0,0 +1,14 @@
+{
+	"name": "@pacman-contribution-graph/action",
+	"version": "1.0.0",
+	"scripts": {
+		"build": "ncc build src/index.js -o dist --external canvas"
+	},
+	"dependencies": {
+		"@actions/core": "1.10.1",
+		"pacman-contribution-graph": "^1.0.2"
+	},
+	"devDependencies": {
+		"@vercel/ncc": "^0.38.3"
+	}
+}

package/github-action/pnpm-lock.yaml

@@ -0,0 +1,146 @@
+lockfileVersion: '9.0'
+
+settings:
+  autoInstallPeers: true
+  excludeLinksFromLockfile: false
+
+importers:
+
+  .:
+    dependencies:
+      '@actions/core':
+        specifier: 1.10.1
+        version: 1.10.1
+      pacman-contribution-graph:
+        specifier: ^1.0.2
+        version: 1.0.2
+    devDependencies:
+      '@vercel/ncc':
+        specifier: ^0.38.3
+        version: 0.38.3
+
+packages:
+
+  '@actions/core@1.10.1':
+    resolution: {integrity: sha512-3lBR9EDAY+iYIpTnTIXmWcNbX3T2kCkAEQGIQx4NVQ0575nk2k3GRZDTPQG+vVtS2izSLmINlxXf0uLtnrTP+g==}
+
+  '@actions/http-client@2.2.3':
+    resolution: {integrity: sha512-mx8hyJi/hjFvbPokCg4uRd4ZX78t+YyRPtnKWwIl+RzNaVuFpQHfmlGVfsKEJN8LwTCvL+DfVgAM04XaHkm6bA==}
+
+  '@fastify/busboy@2.1.1':
+    resolution: {integrity: sha512-vBZP4NlzfOlerQTnba4aqZoMhE/a9HY7HRqoOPaETQcSQuWEIyZMHGfVu6w9wGtGK5fED5qRs2DteVCjOH60sA==}
+    engines: {node: '>=14'}
+
+  '@vercel/ncc@0.38.3':
+    resolution: {integrity: sha512-rnK6hJBS6mwc+Bkab+PGPs9OiS0i/3kdTO+CkI8V0/VrW3vmz7O2Pxjw/owOlmo6PKEIxRSeZKv/kuL9itnpYA==}
+    hasBin: true
+
+  clone-deep@4.0.1:
+    resolution: {integrity: sha512-neHB9xuzh/wk0dIHweyAXv2aPGZIVk3pLMe+/RNzINf17fe0OG96QroktYAUm7SM1PBnzTabaLboqqxDyMU+SQ==}
+    engines: {node: '>=6'}
+
+  flat@5.0.2:
+    resolution: {integrity: sha512-b6suED+5/3rTpUBdG1gupIl8MPFCAMA0QXwmljLhvCUKcUvdE4gWky9zpuGCcXHOsz4J9wPGNWq6OKpmIzz3hQ==}
+    hasBin: true
+
+  is-plain-object@2.0.4:
+    resolution: {integrity: sha512-h5PpgXkWitc38BBMYawTYMWJHFZJVnBquFE57xFpjB8pJFiF6gZ+bU+WyI/yqXiFR5mdLsgYNaPe8uao6Uv9Og==}
+    engines: {node: '>=0.10.0'}
+
+  isobject@3.0.1:
+    resolution: {integrity: sha512-WhB9zCku7EGTj/HQQRz5aUQEUeoQZH2bWcltRErOpymJ4boYE6wL9Tbr23krRPSZ+C5zqNSrSw+Cc7sZZ4b7vg==}
+    engines: {node: '>=0.10.0'}
+
+  kind-of@6.0.3:
+    resolution: {integrity: sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw==}
+    engines: {node: '>=0.10.0'}
+
+  pacman-contribution-graph@1.0.2:
+    resolution: {integrity: sha512-6PS9pYAEsUiNSXMZaRc0rYOpciGM4OJ8E45Q2cMA1fRbzkKxO8UChvfHJ0cDCT4SE3j/h5KMQWAS884OKY4a2w==}
+
+  prettier@3.4.2:
+    resolution: {integrity: sha512-e9MewbtFo+Fevyuxn/4rrcDAaq0IYxPGLvObpQjiZBMAzB9IGmzlnG9RZy3FFas+eBMu2vA0CszMeduow5dIuQ==}
+    engines: {node: '>=14'}
+    hasBin: true
+
+  shallow-clone@3.0.1:
+    resolution: {integrity: sha512-/6KqX+GVUdqPuPPd2LxDDxzX6CAbjJehAAOKlNpqqUpAqPM6HeL8f+o3a+JsyGjn2lv0WY8UsTgUJjU9Ok55NA==}
+    engines: {node: '>=8'}
+
+  tunnel@0.0.6:
+    resolution: {integrity: sha512-1h/Lnq9yajKY2PEbBadPXj3VxsDDu844OnaAo52UVmIzIvwwtBPIuNvkjuzBlTWpfJyUbG3ez0KSBibQkj4ojg==}
+    engines: {node: '>=0.6.11 <=0.7.0 || >=0.7.3'}
+
+  undici@5.28.5:
+    resolution: {integrity: sha512-zICwjrDrcrUE0pyyJc1I2QzBkLM8FINsgOrt6WjA+BgajVq9Nxu2PbFFXUrAggLfDXlZGZBVZYw7WNV5KiBiBA==}
+    engines: {node: '>=14.0'}
+
+  uuid@8.3.2:
+    resolution: {integrity: sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg==}
+    hasBin: true
+
+  webpack-merge@6.0.1:
+    resolution: {integrity: sha512-hXXvrjtx2PLYx4qruKl+kyRSLc52V+cCvMxRjmKwoA+CBbbF5GfIBtR6kCvl0fYGqTUPKB+1ktVmTHqMOzgCBg==}
+    engines: {node: '>=18.0.0'}
+
+  wildcard@2.0.1:
+    resolution: {integrity: sha512-CC1bOL87PIWSBhDcTrdeLo6eGT7mCFtrg0uIJtqJUFyK+eJnzl8A1niH56uu7KMa5XFrtiV+AQuHO3n7DsHnLQ==}
+
+snapshots:
+
+  '@actions/core@1.10.1':
+    dependencies:
+      '@actions/http-client': 2.2.3
+      uuid: 8.3.2
+
+  '@actions/http-client@2.2.3':
+    dependencies:
+      tunnel: 0.0.6
+      undici: 5.28.5
+
+  '@fastify/busboy@2.1.1': {}
+
+  '@vercel/ncc@0.38.3': {}
+
+  clone-deep@4.0.1:
+    dependencies:
+      is-plain-object: 2.0.4
+      kind-of: 6.0.3
+      shallow-clone: 3.0.1
+
+  flat@5.0.2: {}
+
+  is-plain-object@2.0.4:
+    dependencies:
+      isobject: 3.0.1
+
+  isobject@3.0.1: {}
+
+  kind-of@6.0.3: {}
+
+  pacman-contribution-graph@1.0.2:
+    dependencies:
+      prettier: 3.4.2
+      webpack-merge: 6.0.1
+
+  prettier@3.4.2: {}
+
+  shallow-clone@3.0.1:
+    dependencies:
+      kind-of: 6.0.3
+
+  tunnel@0.0.6: {}
+
+  undici@5.28.5:
+    dependencies:
+      '@fastify/busboy': 2.1.1
+
+  uuid@8.3.2: {}
+
+  webpack-merge@6.0.1:
+    dependencies:
+      clone-deep: 4.0.1
+      flat: 5.0.2
+      wildcard: 2.0.1
+
+  wildcard@2.0.1: {}

package/github-action/src/index.js

@@ -0,0 +1,45 @@
+import * as core from '@actions/core';
+import * as fs from 'fs';
+import { PacmanRenderer } from 'pacman-contribution-graph';
+import * as path from 'path';
+
+const generateSvg = async (userName, githubToken,) => {
+	return new Promise((resolve, reject) => {
+		const conf = {
+			platform: "github",
+			username: userName,
+			outputFormat: "svg",
+			gameSpeed: 1,
+			gameTheme: theme,
+			githubSettings: {
+				accessToken: githubToken
+			},
+			svgCallback: (animatedSVG) => {
+				resolve(animatedSVG);
+			}
+		}
+
+		const pr = new PacmanRenderer(conf)
+		pr.start()
+	});
+}
+
+(async () => {
+	try {
+		let svgContent = ''
+		const userName = core.getInput('github_user_name');
+		const githubToken = core.getInput('github_token');
+
+		svgContent = await generateSvg(userName, githubToken, "github")
+		console.log(`💾 writing to dist/pacman-contribution-graph.svg`);
+		fs.mkdirSync(path.dirname('dist/pacman-contribution-graph.svg'), { recursive: true });
+		fs.writeFileSync('dist/pacman-contribution-graph.svg', svgContent);
+
+		svgContent = await generateSvg(userName, githubToken, "github-dark")
+		console.log(`💾 writing to dist/pacman-contribution-graph-dark.svg`);
+		fs.mkdirSync(path.dirname('dist/pacman-contribution-graph-dark.svg'), { recursive: true });
+		fs.writeFileSync('dist/pacman-contribution-graph-dark.svg', svgContent);
+	} catch (e) {
+		core.setFailed(`Action failed with "${e.message}"`);
+	}
+})();

package/index.html

@@ -102,6 +102,8 @@
 								<option value="gitlab">GitLab</option>
 							</select>
 						</div>
+					</div>
+					<div class="col-md-6">
 						<div class="mb-3">
 							<label for="output" class="form-label">Output format</label>
 							<select id="output" class="form-select">
@@ -109,6 +111,10 @@
 								<option value="svg">SVG</option>
 							</select>
 						</div>
+					</div>
+				</div>
+				<div class="row">
+					<div class="col-md-6">
 						<div class="mb-3">
 							<label for="username" class="form-label">Username:</label>
 							<div class="input-group">
@@ -125,11 +131,6 @@
 						</div>
 					</div>
 					<div class="col-md-6">
-						<div class="mb-3">
-							<label for="gameSpeed" class="form-label">Game Speed:</label>
-							<input type="range" class="form-range" id="gameSpeed" min="1" max="10" value="1" />
-							<span id="gameSpeedValue">1</span>
-						</div>
 						<div class="mb-3">
 							<label for="theme" class="form-label">Theme:</label>
 							<select id="theme" class="form-select">
@@ -139,16 +140,50 @@
 								<option value="gitlab-dark">GitLab Dark</option>
 							</select>
 						</div>
-						<div class="mb-3">
-							<label for="enableSounds" class="form-label">Sounds:</label>
-							<select id="enableSounds" class="form-select">
-								<option value="disabled">Disabled</option>
-								<option value="enabled">Enabled</option>
-							</select>
+					</div>
+				</div>
+				<div class="mb-5">
+					<button class="btn btn-secondary mb-1" data-bs-toggle="collapse" data-bs-target="#additionalSettings">
+						Toggle Additional Settings
+					</button>
+					<div id="additionalSettings" class="collapse">
+						<div class="row">
+							<div class="col-md-6">
+								<div class="mb-3">
+									<label for="enableSounds" class="form-label">Sounds:</label>
+									<select id="enableSounds" class="form-select">
+										<option value="disabled">Disabled</option>
+										<option value="enabled">Enabled</option>
+									</select>
+								</div>
+							</div>
+							<div class="col-md-6">
+								<div class="mb-3">
+									<label for="gameSpeed" class="form-label">Game Speed:</label>
+									<input type="range" class="form-range" id="gameSpeed" min="1" max="10" value="1" />
+									<span id="gameSpeedValue">1</span>
+								</div>
+							</div>
+						</div>
+						<div class="row">
+							<div class="col-md-6">
+								<div class="mb-3">
+									<label for="githubAccessToken" class="form-label"
+										>Github Access Token(<a target="__blank" href="https://github.com/settings/tokens">Generate one</a
+										>):
+									</label>
+									<input
+										type="text"
+										id="githubAccessToken"
+										class="form-control"
+										placeholder="Enter Github Access Token"
+									/>
+								</div>
+							</div>
 						</div>
 					</div>
 				</div>
-				<button id="generate" class="btn btn-primary">Generate</button>
+				<button id="generate" class="btn btn-primary">Generate</button> It might take a second or two
 			</div>
 
 			<div class="section">
@@ -191,7 +226,7 @@
 						<tr>
 							<td><code>svgCallback</code></td>
 							<td>A callback function that will get called when SVG picture is generated</td>
-							<td><code>(blonUrl: string) => void</code></td>
+							<td><code>(animatedSVG: string) => void</code></td>
 						</tr>
 						<tr>
 							<td><code>gameOverCallback</code></td>
@@ -241,7 +276,7 @@ pr.start();
 
 				<h3>Method 2: Script loading</h3>
 				<pre><code>&lt;script type="module"&gt;
-import { PacmanRenderer } from 'https://cdn.jsdelivr.net/gh/abozanona/pacman-contribution-graph@1.0.1/dist/pacman-contribution-graph.min.js';
+import { PacmanRenderer } from 'https://cdn.jsdelivr.net/npm/pacman-contribution-graph/dist/pacman-contribution-graph.min.js';
 const pr = new PacmanRenderer({
     platform: 'github',
     username: 'yourusername',
@@ -293,6 +328,7 @@ pr.start();
 			const userAvatar = document.getElementById('userAvatar');
 			const userNotFound = document.getElementById('userNotFound');
 			const points = document.getElementById('points');
+			const githubAccessToken = document.getElementById('githubAccessToken');
 
 			generateButton.disabled = true;
 
@@ -376,7 +412,10 @@ pr.start();
 					outputFormat: outputSelect.value,
 					gameSpeed: parseInt(gameSpeedInput.value),
 					gameTheme: themeSelect.value,
-					enableSounds: enableSounds.value === 'enabled'
+					enableSounds: enableSounds.value === 'enabled',
+					githubSettings: {
+						accessToken: githubAccessToken.value
+					}
 				};
 
 				if (config.outputFormat === 'canvas') {
@@ -391,7 +430,6 @@ pr.start();
 						canvas: canvas,
 						gameOverCallback: () => {
 							console.log('Game Over');
-							setTimeout(() => pr.start(), 3000);
 						},
 						pointsIncreasedCallback: (pointsSum) => {
 							points.innerText = pointsSum;
@@ -407,9 +445,13 @@ pr.start();
 					}
 					pr = new PacmanRenderer({
 						...config,
-						svgCallback: (blobUrl) => {
-							svgHolder.src = blobUrl;
-							currentSvgBlob = blobUrl;
+						svgCallback: (animatedSVG) => {
+							const svgBlob = new Blob([animatedSVG], {
+								type: 'image/svg+xml;charset=utf-8'
+							});
+							const svgUrl = URL.createObjectURL(svgBlob);
+							svgHolder.src = svgUrl;
+							currentSvgBlob = svgUrl;
 						},
 						gameOverCallback: () => {
 							console.log('Game Over');

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "pacman-contribution-graph",
-	"version": "1.0.2",
+	"version": "1.0.3",
 	"description": "Generates a pacman game from a github or gitlab user contributions grid",
 	"repository": "github:abozanona/pacman-contribution-graph",
 	"homepage": "https://abozanona.github.io/pacman-contribution-graph/",
@@ -8,7 +8,9 @@
 	"main": "dist/pacman-contribution-graph.min.js",
 	"scripts": {
 		"build": "webpack --config webpack.prod.js",
-		"dev": "webpack --progress --config webpack.dev.js"
+		"dev": "webpack --progress --config webpack.dev.js",
+		"prepublishOnly": "npm run build",
+		"build-action": "pnpm run --prefix ./github-action build"
 	},
 	"devDependencies": {
 		"terser": "^5.37.0",

package/src/game.ts

@@ -114,8 +114,11 @@ const startGame = async (store: StoreType) => {
 		await MusicPlayer.getInstance().play(Sound.BEGINNING);
 	}
 
-	placePacman(store);
-	placeGhosts(store);
+	const remainingCells = () => store.grid.some((row) => row.some((cell) => cell.intensity > 0));
+	if (remainingCells()) {
+		placePacman(store);
+		placeGhosts(store);
+	}
 
 	GHOSTS.blinky.img.src = GHOSTS.blinky.imgDate;
 	GHOSTS.clyde.img.src = GHOSTS.clyde.imgDate;
@@ -124,7 +127,6 @@ const startGame = async (store: StoreType) => {
 	GHOSTS.scared.img.src = GHOSTS.scared.imgDate;
 
 	if (store.config.outputFormat == 'svg') {
-		const remainingCells = () => store.grid.some((row) => row.some((cell) => cell.intensity > 0));
 		while (remainingCells()) {
 			await updateGame(store);
 		}
@@ -180,11 +182,7 @@ const updateGame = async (store: StoreType) => {
 
 		if (store.config.outputFormat == 'svg') {
 			const animatedSVG = SVG.generateAnimatedSVG(store);
-			const svgBlob = new Blob([animatedSVG], {
-				type: 'image/svg+xml;charset=utf-8'
-			});
-			const svgUrl = URL.createObjectURL(svgBlob);
-			store.config.svgCallback(svgUrl);
+			store.config.svgCallback(animatedSVG);
 		}
 
 		store.config.gameOverCallback();

package/src/index.ts

@@ -29,11 +29,11 @@ export class PacmanRenderer {
 
 		switch (this.conf.platform) {
 			case 'gitlab':
-				this.store.contributions = await Utils.getGitlabContribution(this.conf.username);
+				this.store.contributions = await Utils.getGitlabContribution(this.store);
 				break;
 
 			case 'github':
-				this.store.contributions = await Utils.getGithubContribution(this.conf.username);
+				this.store.contributions = await Utils.getGithubContribution(this.store);
 				break;
 		}
 

package/src/music-player.ts

@@ -1,8 +1,8 @@
 export enum Sound {
-	DEFAULT = 'https://cdn.jsdelivr.net/gh/abozanona/pacman-contribution-graph@1.0.2/src/assets/sounds/pacman_chomp.wav',
-	BEGINNING = 'https://cdn.jsdelivr.net/gh/abozanona/pacman-contribution-graph@1.0.2/src/assets/sounds/pacman_beginning.wav',
-	GAME_OVER = 'https://cdn.jsdelivr.net/gh/abozanona/pacman-contribution-graph@1.0.2/src/assets/sounds/pacman_death.wav',
-	EAT_GHOST = 'https://cdn.jsdelivr.net/gh/abozanona/pacman-contribution-graph@1.0.2/src/assets/sounds/pacman_eatghost.wav'
+	DEFAULT = 'https://cdn.jsdelivr.net/npm/pacman-contribution-graph/src/assets/sounds/pacman_chomp.wav',
+	BEGINNING = 'https://cdn.jsdelivr.net/npm/pacman-contribution-graph/src/assets/sounds/pacman_beginning.wav',
+	GAME_OVER = 'https://cdn.jsdelivr.net/npm/pacman-contribution-graph/src/assets/sounds/pacman_death.wav',
+	EAT_GHOST = 'https://cdn.jsdelivr.net/npm/pacman-contribution-graph/src/assets/sounds/pacman_eatghost.wav'
 }
 
 export class MusicPlayer {

package/src/svg.ts

@@ -6,6 +6,7 @@ const generateAnimatedSVG = (store: StoreType) => {
 	const svgWidth = GRID_WIDTH * (CELL_SIZE + GAP_SIZE);
 	const svgHeight = GRID_HEIGHT * (CELL_SIZE + GAP_SIZE) + 20;
 	let svg = `<svg width="${svgWidth}" height="${svgHeight}" xmlns="http://www.w3.org/2000/svg">`;
+	svg += `<desc>Generated with https://github.com/abozanona/pacman-contribution-graph</desc>`;
 	svg += `<rect width="100%" height="100%" fill="${Utils.getCurrentTheme(store).gridBackground}"/>`;
 
 	svg += generateGhostsPredefinition();

package/src/types.ts

@@ -51,6 +51,9 @@ export interface Config {
 	gameSpeed: number;
 	enableSounds: boolean;
 	pointsIncreasedCallback: (pointsSum: number) => void;
+	githubSettings?: {
+		accessToken: string;
+	};
 }
 
 export type ThemeKeys = 'github' | 'github-dark' | 'gitlab' | 'gitlab-dark';

package/src/utils.ts

@@ -1,10 +1,10 @@
 import { GAME_THEMES } from './constants';
 import type { Contribution, GameTheme, StoreType } from './types';
 
-const getGitlabContribution = async (username: string): Promise<Contribution[]> => {
+const getGitlabContribution = async (store: StoreType): Promise<Contribution[]> => {
 	// const response = await fetch(`https://gitlab.com/users/${username}/calendar.json`);
 	const response = await fetch(
-		`https://v0-new-project-q1hhrdodoye-abozanona-gmailcoms-projects.vercel.app/api/contributions?username=${username}`
+		`https://v0-new-project-q1hhrdodoye-abozanona-gmailcoms-projects.vercel.app/api/contributions?username=${store.config.username}`
 	);
 	const contributionsList = await response.json();
 	return Object.entries(contributionsList).map(([date, count]) => ({
@@ -13,13 +13,33 @@ const getGitlabContribution = async (username: string): Promise<Contribution[]>
 	}));
 };
 
-const getGithubContribution = async (username: string): Promise<Contribution[]> => {
-	const response = await fetch(
-		`https://api.github.com/search/commits?q=author:${username}&sort=author-date&order=desc&page=1&per_page=1000`
-	);
-	const contributionsList = await response.json();
+const getGithubContribution = async (store: StoreType): Promise<Contribution[]> => {
+	const commits = [];
+	let isComplete: boolean = false;
+	let page = 1;
+	// TODO: Consider using GraphQL endpoint when user has an access token?
+	do {
+		try {
+			const headers: HeadersInit = {};
+			if (store.config.githubSettings?.accessToken) {
+				headers['Authorization'] = 'Bearer ' + store.config.githubSettings.accessToken;
+			}
+			const response = await fetch(
+				`https://api.github.com/search/commits?q=author:${store.config.username}&sort=author-date&order=desc&page=${page}&per_page=1000`,
+				{
+					headers
+				}
+			);
+			const contributionsList = await response.json();
+			isComplete = contributionsList.items.length === 0;
+			commits.push(...contributionsList.items);
+			page++;
+		} catch (ex) {
+			isComplete = true;
+		}
+	} while (!isComplete);
 	return Array.from(
-		contributionsList.items
+		commits
 			.reduce((map: any, item: any) => {
 				const dateString = item.commit.committer.date.split('T')[0];
 				const date = new Date(dateString);