Add types to library

dist/classes/HeuristicValue.d.ts

@@ -0,0 +1,6 @@
+export default class HeuristicValue {
+    g: number;
+    h: number;
+    f: number;
+    constructor(g: number, h: number, f: number);
+}

dist/classes/Node.d.ts

@@ -0,0 +1,11 @@
+import { State } from "../utils/state";
+import { operations } from "../utils/operations";
+import HeuristicValue from "./HeuristicValue";
+declare class NodeInfo {
+    evaluationFunctionValue: HeuristicValue;
+    operation: operations;
+    state: State;
+    previousNode?: NodeInfo;
+    constructor(efValue: HeuristicValue, op: operations, s: State, prev?: NodeInfo);
+}
+export { NodeInfo };

dist/classes/Result.d.ts

@@ -0,0 +1,10 @@
+import { NodeInfo } from "./Node";
+import SolutionItem from "./Solution";
+export default class Result {
+    pathCost: number;
+    iterations: number;
+    expandedNodes: number;
+    finalNode: NodeInfo;
+    solution?: SolutionItem[];
+    constructor(pathCost: number, iterations: number, expandedNodes: number, finalNode: NodeInfo, solution?: SolutionItem[]);
+}

dist/classes/Solution.d.ts

@@ -0,0 +1,7 @@
+import { operations } from './../utils/operations';
+import { StateAsList } from "../utils/state";
+export default class SolutionItem {
+    state: StateAsList;
+    operation: operations;
+    constructor(s: StateAsList, op: operations);
+}

dist/classes/StateItemPosition.d.ts

@@ -0,0 +1,5 @@
+export default class StateItemPosition {
+    line: number;
+    col: number;
+    constructor(l: number, c: number);
+}

dist/functions/AStar.d.ts

@@ -0,0 +1,5 @@
+import { State } from "../utils/state";
+import { NodeInfo } from "../classes/Node";
+import Result from "../classes/Result";
+declare function runAStarLoop(goalState: State, frontier: NodeInfo[], expandedStates: State[]): Result | undefined;
+export { runAStarLoop as run };

dist/functions/heuristic.d.ts

@@ -0,0 +1,5 @@
+import { State, StateItem } from "../utils/state";
+import StateItemPosition from "../classes/StateItemPosition";
+declare function calcHValue(actualState: State, goalState: State): number;
+declare function calcDistanceOfItem(item: StateItem, itemPosition: StateItemPosition, goalState: State): number;
+export { calcHValue, calcDistanceOfItem };

dist/functions/node.d.ts

@@ -0,0 +1,6 @@
+import { operations } from './../utils/operations';
+import { NodeInfo } from "../classes/Node";
+import { State } from '../utils/state';
+declare function generateNodeList(node: NodeInfo, goalState: State): NodeInfo[];
+declare function generateNode(state: State, op: operations, goalState: State, gValue: number, previousNode?: NodeInfo): NodeInfo;
+export { generateNodeList, generateNode };

dist/functions/operations.d.ts

@@ -0,0 +1,10 @@
+import { State } from "../utils/state";
+import { operations } from "../utils/operations";
+import StateItemPosition from "../classes/StateItemPosition";
+declare function applyOperation(state: State, op: operations): State | null | undefined;
+declare function moveUpOperation(state: State): State | null;
+declare function moveRightOperation(state: State): State | null;
+declare function moveDownOperation(state: State): State | null;
+declare function moveLeftOperation(state: State): State | null;
+declare function getPositionOfBlankItem(state: State): StateItemPosition;
+export { applyOperation, moveUpOperation, moveRightOperation, moveDownOperation, moveLeftOperation, getPositionOfBlankItem };

dist/functions/solution.d.ts

@@ -0,0 +1,4 @@
+import { NodeInfo } from "../classes/Node";
+import SolutionItem from "../classes/Solution";
+declare function getSolutionFromNode(node: NodeInfo, list: SolutionItem[]): SolutionItem[];
+export { getSolutionFromNode };

dist/functions/state.d.ts

@@ -0,0 +1,7 @@
+import { State, StateAsList } from "../utils/state";
+declare function areEqual(state1: State, state2: State): boolean;
+declare function includes(state: State, list: State[]): boolean;
+declare function isSolvable(state: State): boolean;
+declare function convertStateInArray(state: State): StateAsList;
+declare function convertArrayInState(stateList: StateAsList): State;
+export { areEqual, includes, isSolvable, convertArrayInState, convertStateInArray };

dist/index.d.ts

@@ -0,0 +1,4 @@
+import { State, StateAsList } from "./utils/state";
+import { isSolvable, convertArrayInState, convertStateInArray } from './functions/state';
+declare function index(state: StateAsList, finalState?: State): import("./classes/Result").default;
+export { index as solvePuzzle, convertArrayInState, convertStateInArray, isSolvable };

dist/utils/frontier.d.ts

@@ -0,0 +1,2 @@
+import { NodeInfo } from "../classes/Node";
+export declare type Frontier = NodeInfo[];

dist/utils/operations.d.ts

@@ -0,0 +1,7 @@
+export declare enum operations {
+    up = "UP_OPERATION",
+    right = "RIGHT_OPERATION",
+    down = "DOWN_OPERATION",
+    left = "LEFT_OPERATION",
+    none = "NONE"
+}

dist/utils/state.d.ts

@@ -0,0 +1,4 @@
+declare type StateItem = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 0;
+declare type State = [[StateItem, StateItem, StateItem], [StateItem, StateItem, StateItem], [StateItem, StateItem, StateItem]];
+declare type StateAsList = StateItem[];
+export { State, StateItem, StateAsList };

package.json

@@ -3,6 +3,7 @@
   "version": "2.0.1",
   "description": "A* search algorithm in TypeScript that solves puzzle game problem",
   "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "dependencies": {},
   "devDependencies": {
     "@types/chai": "^4.2.11",

tsconfig.json

@@ -9,6 +9,7 @@
     "skipLibCheck": true,                     /* Skip type checking of declaration files. */
     "forceConsistentCasingInFileNames": true,  /* Disallow inconsistently-cased references to the same file. */
     "sourceMap": true,
+    "declaration": true
   },
   "include":[
     "src/**/*.ts"