Merge pull request #7 from EGAMAGZ/development

Development
EGAMAGZ · May 22, 2024 · d0e6f67 · d0e6f67
2 parents a2403c2 + fad905b
commit d0e6f67
Show file tree

Hide file tree

Showing 7 changed files with 54 additions and 19 deletions.
diff --git a/example/package-lock.json b/example/package-lock.json
diff --git a/example/package.json b/example/package.json
@@ -13,7 +13,6 @@
     "@astrojs/check": "^0.5.10",
     "@astrojs/preact": "^3.2.0",
     "@astrojs/tailwind": "^5.1.0",
-    "@egamagz/paska-ovo": "npm:@jsr/egamagz__paska-ovo@^0.1.2",
     "@preact/signals": "^1.2.3",
     "@preact/signals-core": "^1.6.0",
     "@tabler/icons-preact": "^3.3.0",

diff --git a/example/src/components/EasterEgg.tsx b/example/src/components/EasterEgg.tsx
@@ -32,6 +32,13 @@ export default function EasterEgg() {
                 },
                 tag: "Konami"
             })
+            .addCode({
+                code: ["up", "up", "down", "down", "left", "right", "left", "right", "b", "a", "c"],
+                onFound: () => {
+                    alert("Nothing to show here... Sorry :(")
+                },
+                tag: "Konami+C"
+            })
             .addCode({
                 code: ["a", "w", "e", "s", "o", "m", "e"],
                 onFound: () => {

diff --git a/example/src/layouts/Layout.astro b/example/src/layouts/Layout.astro
@@ -1,7 +1,7 @@
 <html lang="en">
     <head>
         <meta charset="utf-8" />
-        <link rel="icon" type="image/svg+xml" href="/favicon.svg" />
+        <link rel="icon" type="image/svg+xml" href="paska-ovo/favicon.svg" />
         <meta name="viewport" content="width=device-width" />
         <meta name="generator" content={Astro.generator} />
         <meta

diff --git a/src/paska-ovo.ts b/src/paska-ovo.ts
@@ -112,19 +112,14 @@ export class PaskaOvo {
 	 * @param {EasterEgg[]} easterEggs - List of easter eggs to trigger.
 	 */
 	private handleKeyEvent(event: KeyboardEvent, easterEggs: EasterEgg[]) {
-		if (easterEggs.length === 0) {
-			return;
-		}
-
 		const { key } = event;
-
-		easterEggs.forEach((easterEgg) => {
+		for (const easterEgg of easterEggs) {
 			const actualCodePosition = this.easterEggState[easterEgg.tag] || 0;
 			const actualCode = easterEgg.code[actualCodePosition];
 
 			if (key !== actualCode) {
 				this.easterEggState[easterEgg.tag] = 0;
-				return;
+				continue;
 			}
 
 			const nextCodePosition = actualCodePosition + 1;
@@ -136,7 +131,7 @@ export class PaskaOvo {
 			} else {
 				this.easterEggState[easterEgg.tag] = nextCodePosition;
 			}
-		});
+		}
 	}
 
 	/**

diff --git a/src/types.ts b/src/types.ts
@@ -7,10 +7,52 @@
 /**
  * Type with the properties of an easter egg.
  * 
+ * @example
+ * A simple easter egg:
+ * ```typescript
+ * import { EasterEgg } from "@egamagz/paska-ovo";
+ * 
+ * const easterEgg: EasterEgg = {
+ *  code: ["up", "up", "down", "down", "left", "right", "left", "right", "b", "a"],
+ *  onFound: () => {
+ *    // Do something when the easter egg is found
+ *  },
+ *  tag: "Konami",
+ * }
+ * ```
+ * 
+ * @example 
+ * An easter egg with a duration:
+ * ```typescript
+ * const easterEgg: EasterEgg = {
+ *  code: ["up", "right", "down", "left"],
+ *  onFound: () => {
+ *      // Do something when the easter egg is found
+ *  },
+ *  onFinish() {
+ *      // Do something when the duration of the easter egg is over
+ *  },
+ *  duration: 1000,
+ *  tag: "Barrel Roll"
+ * }
+ * ```
  */
 export type EasterEgg = {
     /**
-     * Sequence of keys that will trigger the easter egg.
+     * Key sequence that will activate the easter egg. The code can contain 
+     * letters (which will only be detected as lowercase), numbers and navigation 
+     * and control keys. The navigation and control keys are indicated by the following nomenclature:
+     * * `up`: `ArrowUp`
+     * * `down`: `ArrowDown`
+     * * `left`: `ArrowLeft`
+     * * `right`: `ArrowRight`
+     * * `enter`: `Enter`
+     * * `space`: `Space`
+     * * `ctrl`: `Control`
+     * * `alt`: `Alt`
+     * * `tab`: `Tab`
+     * * `esc`: `Escape`
+     * * `slash`: `/`
      */
     code: string[],
     /**

diff --git a/src/util/constants.ts b/src/util/constants.ts
@@ -21,4 +21,3 @@ export const SPECIAL_KEYS: Record<string, string> = {
     "tab": "Tab",
     "esc": "Escape",
 } as const;
-
Original file line number	Diff line number	Diff line change
Expand Up		@@ -21,4 +21,3 @@ export const SPECIAL_KEYS: Record<string, string> = {
		"tab": "Tab",
		"esc": "Escape",
		} as const;