@mishieck/graph-js 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 mishieck
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,15 @@
1
+ # graph-js
2
+
3
+ To install dependencies:
4
+
5
+ ```bash
6
+ bun install
7
+ ```
8
+
9
+ To run:
10
+
11
+ ```bash
12
+ bun run
13
+ ```
14
+
15
+ This project was created using `bun init` in bun v1.3.14. [Bun](https://bun.com) is a fast all-in-one JavaScript runtime.
package/dist/main.d.ts ADDED
@@ -0,0 +1,65 @@
1
+ // Generated by dts-bundle-generator v9.5.1
2
+
3
+ export declare enum GraphTraversal {
4
+ BreadthFirst = 0,
5
+ DepthFirst = 1
6
+ }
7
+ export type GraphNodeData<Data> = {
8
+ data: Data;
9
+ neighbors: Array<GraphNode<Data>>;
10
+ };
11
+ export declare class GraphNode<Data> {
12
+ data: Data;
13
+ neighbors: Array<GraphNode<Data>>;
14
+ constructor({ data, neighbors }: GraphNodeData<Data>);
15
+ setNeighbors(neighbors: Array<GraphNode<Data>>): void;
16
+ replaceNeighborAt(index: number, neighbor: GraphNode<Data>): void;
17
+ getNeighborAt(index: number): GraphNode<Data> | undefined;
18
+ get firstNeighbor(): GraphNode<Data> | null;
19
+ get lastNeighbor(): GraphNode<Data> | null;
20
+ traverse(traversal: GraphTraversal): IterableIterator<GraphNode<Data>>;
21
+ /**
22
+ * Traverses the graph using breadth-first search. It uses a queue to handle
23
+ * traversal.
24
+ */
25
+ traverseBreadthFirst(): IterableIterator<GraphNode<Data>>;
26
+ /**
27
+ * Traverses the graph using depth-first search. It uses a stack to handle
28
+ * traversal.
29
+ */
30
+ traverseDepthFirst(): IterableIterator<GraphNode<Data>>;
31
+ }
32
+ export type ChainNodeData<Data> = Pick<GraphNode<Data>, "data"> & {
33
+ data: Data;
34
+ previous: ChainNode<Data> | null;
35
+ next: ChainNode<Data> | null;
36
+ };
37
+ export declare class ChainNode<Data> extends GraphNode<Data> implements ChainNodeData<Data> {
38
+ constructor({ data, previous, next }: ChainNodeData<Data>);
39
+ get previous(): ChainNode<Data> | null;
40
+ set previous(previous: ChainNode<Data>);
41
+ get next(): ChainNode<Data> | null;
42
+ set next(next: ChainNode<Data>);
43
+ }
44
+ export type ListNodeData<Data> = Pick<GraphNode<Data>, "data"> & {
45
+ data: Data;
46
+ next: ListNode<Data> | null;
47
+ };
48
+ export declare class ListNode<Data> extends GraphNode<Data> implements ListNodeData<Data> {
49
+ constructor({ data, next }: ListNodeData<Data>);
50
+ get next(): ListNode<Data> | null;
51
+ set next(next: ListNode<Data>);
52
+ }
53
+ export type TreeNodeData<Data> = Pick<GraphNode<Data>, "data"> & {
54
+ parent: TreeNode<Data> | null;
55
+ children: Array<TreeNode<Data>>;
56
+ };
57
+ export declare class TreeNode<Data> extends GraphNode<Data> {
58
+ constructor({ data, parent, children }: TreeNodeData<Data>);
59
+ get parent(): TreeNode<Data> | null;
60
+ set parent(parent: TreeNode<Data>);
61
+ get children(): GraphNode<Data>[];
62
+ setChildren(children: Array<TreeNode<Data>>): void;
63
+ }
64
+
65
+ export {};
package/dist/main.js ADDED
@@ -0,0 +1,133 @@
1
+ // lib/graph.ts
2
+ var GraphTraversal;
3
+ ((GraphTraversal2) => {
4
+ GraphTraversal2[GraphTraversal2["BreadthFirst"] = 0] = "BreadthFirst";
5
+ GraphTraversal2[GraphTraversal2["DepthFirst"] = 1] = "DepthFirst";
6
+ })(GraphTraversal ||= {});
7
+
8
+ class GraphNode {
9
+ data;
10
+ neighbors;
11
+ constructor({ data, neighbors }) {
12
+ this.data = data;
13
+ this.neighbors = neighbors;
14
+ }
15
+ setNeighbors(neighbors) {
16
+ this.neighbors = neighbors;
17
+ }
18
+ replaceNeighborAt(index, neighbor) {
19
+ this.neighbors[index] = neighbor;
20
+ }
21
+ getNeighborAt(index) {
22
+ return this.neighbors.at(index);
23
+ }
24
+ get firstNeighbor() {
25
+ return this.getNeighborAt(0) ?? null;
26
+ }
27
+ get lastNeighbor() {
28
+ return this.getNeighborAt(-1) ?? null;
29
+ }
30
+ traverse(traversal) {
31
+ switch (traversal) {
32
+ case 0 /* BreadthFirst */:
33
+ return this.traverseBreadthFirst();
34
+ case 1 /* DepthFirst */:
35
+ return this.traverseDepthFirst();
36
+ }
37
+ }
38
+ traverseBreadthFirst() {
39
+ return function* ($this) {
40
+ const visited = new Set;
41
+ const nodes = [$this];
42
+ let node;
43
+ while (node = nodes.shift()) {
44
+ if (visited.has(node))
45
+ continue;
46
+ visited.add(node);
47
+ yield node;
48
+ nodes.push(...node.neighbors);
49
+ }
50
+ }(this);
51
+ }
52
+ traverseDepthFirst() {
53
+ return function* ($this) {
54
+ const neighborsAdded = new Set;
55
+ const visited = new Set;
56
+ const nodes = [$this];
57
+ let node;
58
+ while (node = nodes.at(-1)) {
59
+ const neighbors = [...node.neighbors];
60
+ if (!neighborsAdded.has(node) && neighbors.length) {
61
+ for (let i = neighbors.length - 1;i >= 0; i--) {
62
+ nodes.push(neighbors[i]);
63
+ }
64
+ neighborsAdded.add(node);
65
+ } else {
66
+ node = nodes.pop();
67
+ if (visited.has(node))
68
+ continue;
69
+ yield node;
70
+ }
71
+ }
72
+ }(this);
73
+ }
74
+ }
75
+
76
+ // lib/chain.ts
77
+ class ChainNode extends GraphNode {
78
+ constructor({ data, previous, next }) {
79
+ super({ data, neighbors: [] });
80
+ super.setNeighbors([previous ?? this, next ?? this]);
81
+ }
82
+ get previous() {
83
+ return this.firstNeighbor === this ? null : this.firstNeighbor;
84
+ }
85
+ set previous(previous) {
86
+ super.replaceNeighborAt(0, previous);
87
+ }
88
+ get next() {
89
+ return this.lastNeighbor === this ? null : this.lastNeighbor;
90
+ }
91
+ set next(next) {
92
+ super.replaceNeighborAt(1, next);
93
+ }
94
+ }
95
+ // lib/list.ts
96
+ class ListNode extends GraphNode {
97
+ constructor({ data, next }) {
98
+ super({ data, neighbors: [] });
99
+ super.setNeighbors([next ?? this]);
100
+ }
101
+ get next() {
102
+ return this.firstNeighbor === this ? null : this.firstNeighbor;
103
+ }
104
+ set next(next) {
105
+ super.replaceNeighborAt(0, next);
106
+ }
107
+ }
108
+ // lib/tree.ts
109
+ class TreeNode extends GraphNode {
110
+ constructor({ data, parent, children }) {
111
+ super({ data, neighbors: [] });
112
+ this.neighbors = [parent ?? this, ...children];
113
+ }
114
+ get parent() {
115
+ return this.firstNeighbor === this ? null : this.firstNeighbor;
116
+ }
117
+ set parent(parent) {
118
+ super.replaceNeighborAt(0, parent);
119
+ }
120
+ get children() {
121
+ return this.neighbors.slice(1);
122
+ }
123
+ setChildren(children) {
124
+ super.setNeighbors([super.firstNeighbor, ...children]);
125
+ }
126
+ }
127
+ export {
128
+ TreeNode,
129
+ ListNode,
130
+ GraphTraversal,
131
+ GraphNode,
132
+ ChainNode
133
+ };
package/package.json ADDED
@@ -0,0 +1,33 @@
1
+ {
2
+ "name": "@mishieck/graph-js",
3
+ "version": "0.2.0",
4
+ "author": {
5
+ "name": "Mishieck Mwale",
6
+ "email": "mishieckdev@gmail.com",
7
+ "url": "https://mishieck.vercel.app"
8
+ },
9
+ "repository": {
10
+ "url": "https://github.com/mishieck/graph-js"
11
+ },
12
+ "devDependencies": {
13
+ "@types/bun": "latest",
14
+ "bun-plugin-dts": "^0.4.0"
15
+ },
16
+ "peerDependencies": {
17
+ "typescript": "^5"
18
+ },
19
+ "exports": {
20
+ "default": "./dist/main.js",
21
+ "types": "./dist/main.d.ts"
22
+ },
23
+ "description": "A TypeScript library for graph data structures.",
24
+ "files": ["dist"],
25
+ "keywords": ["graph", "tree", "linked-list", "graph-node", "data-structures", "data-structures-and-algorithms"],
26
+ "license": "MIT",
27
+ "scripts": {
28
+ "build": "bun build.ts",
29
+ "build:prod": "export NODE_ENV=production; bun build.ts",
30
+ "publish": "bun publish --access=public"
31
+ },
32
+ "type": "module"
33
+ }