js-fundamentals 1.0.2 → 1.0.3

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * fundamentals
+ * Main entry point for the library
+ */
+import Queue from "./queue/index.js";
+import PriorityQueue from "./priorityqueue/index.js";
+export { Queue, PriorityQueue };

package/{src → dist}/index.js

@@ -2,8 +2,6 @@
  * fundamentals
  * Main entry point for the library
  */
-
-import Queue from "./queue";
-import PriorityQueue from "./priorityqueue";
-
+import Queue from "./queue/index.js";
+import PriorityQueue from "./priorityqueue/index.js";
 export { Queue, PriorityQueue };

package/dist/priorityqueue/index.d.ts

@@ -0,0 +1,16 @@
+interface PriorityQueueOptions {
+    descending?: boolean;
+}
+declare class PriorityQueue<T> {
+    private items;
+    private descending;
+    constructor(options?: PriorityQueueOptions);
+    enqueue(item: T, priority: number): void;
+    dequeue(): T | undefined;
+    peek(): T | undefined;
+    isEmpty(): boolean;
+    size(): number;
+    toArray(): T[];
+    changePriority(item: T, newPriority: number): void;
+}
+export default PriorityQueue;

package/dist/priorityqueue/index.js

@@ -0,0 +1,47 @@
+class PriorityQueue {
+    constructor(options = {}) {
+        this.items = [];
+        const { descending = false } = options;
+        this.descending = descending;
+    }
+    enqueue(item, priority) {
+        this.items.push({ item, priority });
+        this.items.sort((a, b) => this.descending ? b.priority - a.priority : a.priority - b.priority);
+    }
+    dequeue() {
+        const entry = this.items.shift();
+        return entry?.item;
+    }
+    peek() {
+        return this.items[0]?.item;
+    }
+    isEmpty() {
+        return this.items.length === 0;
+    }
+    size() {
+        return this.items.length;
+    }
+    toArray() {
+        return this.items.map((entry) => entry.item);
+    }
+    changePriority(item, newPriority) {
+        const index = this.items.findIndex((i) => {
+            if (i.item === item) {
+                return true;
+            }
+            if (typeof i.item === "object" &&
+                typeof item === "object" &&
+                i.item !== null &&
+                item !== null) {
+                return JSON.stringify(i.item) === JSON.stringify(item);
+            }
+            return false;
+        });
+        if (index === -1) {
+            throw new Error("Item not found");
+        }
+        this.items[index].priority = newPriority;
+        this.items.sort((a, b) => this.descending ? b.priority - a.priority : a.priority - b.priority);
+    }
+}
+export default PriorityQueue;

package/dist/queue/index.d.ts

@@ -0,0 +1,11 @@
+declare class Queue<T> {
+    protected items: T[];
+    constructor();
+    enqueue(item: T): void;
+    dequeue(): T | undefined;
+    peek(): T | undefined;
+    isEmpty(): boolean;
+    size(): number;
+    toArray(): T[];
+}
+export default Queue;

package/dist/queue/index.js

@@ -0,0 +1,24 @@
+class Queue {
+    constructor() {
+        this.items = [];
+    }
+    enqueue(item) {
+        this.items.push(item);
+    }
+    dequeue() {
+        return this.items.shift();
+    }
+    peek() {
+        return this.items[0];
+    }
+    isEmpty() {
+        return this.items.length === 0;
+    }
+    size() {
+        return this.items.length;
+    }
+    toArray() {
+        return this.items;
+    }
+}
+export default Queue;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "js-fundamentals",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "",
   "homepage": "https://github.com/eetujukka1/fundamentals#readme",
   "bugs": {
@@ -13,8 +13,19 @@
   "license": "ISC",
   "author": "",
   "type": "module",
-  "main": "index.js",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
   "scripts": {
+    "build": "tsc",
     "test": "NODE_OPTIONS=--experimental-vm-modules jest",
     "lint": "eslint",
     "format": "npx prettier --write .",
@@ -22,9 +33,13 @@
   },
   "devDependencies": {
     "@eslint/js": "^9.39.2",
+    "@types/jest": "^30.0.0",
     "eslint": "^9.39.2",
     "globals": "^17.0.0",
     "jest": "^30.2.0",
-    "prettier": "^3.8.0"
+    "prettier": "^3.8.0",
+    "ts-jest": "^29.4.6",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.54.0"
   }
 }

package/.github/workflows/pipeline.yml

@@ -1,24 +0,0 @@
-name: Pipeline
-
-on:
-  push:
-    branches:
-      - main
-  pull_request:
-    branches: [main]
-    types: [opened, synchronize]
-
-jobs:
-  simple_deployment_pipeline:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: "20"
-      - name: Install dependencies
-        run: npm install
-      - name: Check style
-        run: npm run lint
-      - name: Check format
-        run: npm run checkformat

package/eslint.config.js

@@ -1,12 +0,0 @@
-import js from "@eslint/js";
-import globals from "globals";
-import { defineConfig } from "eslint/config";
-
-export default defineConfig([
-  {
-    files: ["**/*.{js,mjs,cjs}"],
-    plugins: { js },
-    extends: ["js/recommended"],
-    languageOptions: { globals: globals.browser },
-  },
-]);

package/index.js

@@ -1,6 +0,0 @@
-/**
- * fundamentals
- * Main entry point - exports from src/
- */
-
-export * from "./src";

package/jest.config.js

@@ -1,7 +0,0 @@
-export default {
-  testEnvironment: "node",
-  transform: {},
-  moduleNameMapper: {
-    "^(\\.{1,2}/.*)\\.js$": "$1",
-  },
-};

package/src/priorityqueue/index.js

@@ -1,63 +0,0 @@
-import Queue from "../queue";
-
-class PriorityQueue extends Queue {
-  constructor(options = {}) {
-    super();
-    const { descending = false } = options;
-    this.descending = descending;
-  }
-
-  enqueue(item, priority) {
-    this.items.push({ item, priority });
-    this.items.sort((a, b) =>
-      this.descending ? b.priority - a.priority : a.priority - b.priority,
-    );
-  }
-
-  dequeue() {
-    return this.items.shift().item;
-  }
-
-  peek() {
-    return this.items[0].item;
-  }
-
-  isEmpty() {
-    return this.items.length === 0;
-  }
-
-  size() {
-    return this.items.length;
-  }
-
-  toArray() {
-    return this.items.map((item) => item.item);
-  }
-
-  changePriority(item, newPriority) {
-    const index = this.items.findIndex((i) => {
-      if (i.item === item) {
-        return true;
-      }
-
-      if (
-        typeof i.item === "object" &&
-        typeof item === "object" &&
-        i.item !== null &&
-        item !== null
-      ) {
-        return JSON.stringify(i.item) === JSON.stringify(item);
-      }
-      return false;
-    });
-    if (index === -1) {
-      throw new Error("Item not found");
-    }
-    this.items[index].priority = newPriority;
-    this.items.sort((a, b) =>
-      this.descending ? b.priority - a.priority : a.priority - b.priority,
-    );
-  }
-}
-
-export default PriorityQueue;

package/src/queue/index.js

@@ -1,31 +0,0 @@
-class Queue {
-  constructor() {
-    this.items = [];
-  }
-
-  enqueue(item) {
-    this.items.push(item);
-  }
-
-  dequeue() {
-    return this.items.shift();
-  }
-
-  peek() {
-    return this.items[0];
-  }
-
-  isEmpty() {
-    return this.items.length === 0;
-  }
-
-  size() {
-    return this.items.length;
-  }
-
-  toArray() {
-    return this.items;
-  }
-}
-
-export default Queue;

package/tests/priorityqueue.test.js

@@ -1,76 +0,0 @@
-import { PriorityQueue } from "../src/index";
-import { describe, it, expect } from "@jest/globals";
-
-describe("PriorityQueue", () => {
-  it("should create a priority queue", () => {
-    const queue = new PriorityQueue();
-    expect(queue).toBeDefined();
-  });
-
-  it("should enqueue an item", () => {
-    const queue = new PriorityQueue();
-    queue.enqueue(1, 1);
-    expect(queue.size()).toBe(1);
-    expect(queue.isEmpty()).toBe(false);
-  });
-
-  it("should dequeue an item", () => {
-    const queue = new PriorityQueue();
-    queue.enqueue(3, 3);
-    queue.enqueue(2, 2);
-    queue.enqueue(1, 1);
-    expect(queue.dequeue()).toBe(1);
-    expect(queue.isEmpty()).toBe(false);
-  });
-
-  it("should dequeue an item with descending priority", () => {
-    const queue = new PriorityQueue({ descending: true });
-    queue.enqueue(1, 1);
-    queue.enqueue(2, 2);
-    queue.enqueue(3, 3);
-    expect(queue.dequeue()).toBe(3);
-    expect(queue.isEmpty()).toBe(false);
-  });
-
-  it("should peek at the front item", () => {
-    const queue = new PriorityQueue();
-    queue.enqueue(3, 3);
-    queue.enqueue(2, 2);
-    queue.enqueue(1, 1);
-    expect(queue.peek()).toBe(1);
-  });
-
-  it("should check if queue is empty", () => {
-    const queue = new PriorityQueue();
-    expect(queue.isEmpty()).toBe(true);
-  });
-
-  it("should check if queue is not empty", () => {
-    const queue = new PriorityQueue();
-    queue.enqueue(1, 1);
-    expect(queue.isEmpty()).toBe(false);
-  });
-
-  it("should return the size of the queue", () => {
-    const queue = new PriorityQueue();
-    queue.enqueue(1, 1);
-    expect(queue.size()).toBe(1);
-  });
-
-  it("should return an array of items", () => {
-    const queue = new PriorityQueue();
-    queue.enqueue(3, 3);
-    queue.enqueue(2, 2);
-    queue.enqueue(1, 1);
-    expect(queue.toArray()).toEqual([1, 2, 3]);
-  });
-
-  it("should change the priority of an item", () => {
-    const queue = new PriorityQueue();
-    queue.enqueue({ id: 1 }, 1);
-    queue.enqueue({ id: 2 }, 2);
-    queue.enqueue({ id: 3 }, 3);
-    queue.changePriority({ id: 2 }, 4);
-    expect(queue.toArray()).toEqual([{ id: 1 }, { id: 3 }, { id: 2 }]);
-  });
-});

package/tests/queue.test.js

@@ -1,56 +0,0 @@
-import Queue from "../src/queue";
-import { describe, it, expect } from "@jest/globals";
-
-describe("Queue", () => {
-  it("should create a queue", () => {
-    const queue = new Queue();
-    expect(queue).toBeDefined();
-  });
-
-  it("should enqueue an item", () => {
-    const queue = new Queue();
-    queue.enqueue(1);
-    expect(queue.size()).toBe(1);
-    expect(queue.isEmpty()).toBe(false);
-  });
-
-  it("should dequeue an item", () => {
-    const queue = new Queue();
-    queue.enqueue(1);
-    expect(queue.dequeue()).toBe(1);
-    expect(queue.isEmpty()).toBe(true);
-  });
-
-  it("should peek at the front item", () => {
-    const queue = new Queue();
-    queue.enqueue(1);
-    queue.enqueue(2);
-    expect(queue.peek()).toBe(1);
-  });
-
-  it("should check if queue is empty", () => {
-    const queue = new Queue();
-    expect(queue.isEmpty()).toBe(true);
-  });
-
-  it("should check if queue is not empty", () => {
-    const queue = new Queue();
-    queue.enqueue(1);
-    expect(queue.isEmpty()).toBe(false);
-  });
-
-  it("should return the size of the queue", () => {
-    const queue = new Queue();
-    queue.enqueue(1);
-    queue.enqueue(2);
-    expect(queue.size()).toBe(2);
-  });
-
-  it("should return an array of items", () => {
-    const queue = new Queue();
-    queue.enqueue(1);
-    queue.enqueue(2);
-    queue.enqueue(3);
-    expect(queue.toArray()).toEqual([1, 2, 3]);
-  });
-});