@karhu/core - npm Package Compare versions

Comparing version 0.1.3-alpha.0 to 0.2.1

lib/index.d.ts

@@ -7,8 +7,8 @@ import { Command, UnregisteredCommand, EntryGraph } from './types';
     entryGraph: EntryGraph;
-    constructor();
+    constructor(entryGraph?: EntryGraph);
     reset(): void;
     addCommand(command: UnregisteredCommand): Command;
-    updateCommand(id: string): (command: Command) => Command;
     removeCommand(commandId: string): void;
     getCommands(): Command[];
+    getEntryGraph(): EntryGraph;
     findMatchingCommands(input?: string): Command[];
@@ -15,0 +15,0 @@ runCommand(id: string, input: string): EntryGraph;

lib/index.js

@@ -37,3 +37,3 @@ "use strict";
 var Karhu = (function () {
-    function Karhu() {
+    function Karhu(entryGraph) {
         this.commands = [];
@@ -43,2 +43,5 @@ this.contexts = ['default'];
         this.reset();
+        if (entryGraph) {
+            this.entryGraph = entryGraph;
+        }
     }
@@ -53,18 +56,15 @@ Karhu.prototype.reset = function () {
         var preparedCommand = this._prepareCommand(command);
-        this.commands.push(preparedCommand);
-        return preparedCommand;
-    };
-    Karhu.prototype.updateCommand = function (id) {
-        var _this = this;
-        return function (command) {
-            var merged = command;
-            _this.commands.map(function (c) {
-                if (c.id === id) {
-                    merged = __assign({}, c, command);
-                    return merged;
+        var idExists = this.commands.filter(function (c) { return c.id === preparedCommand.id; }).length > 0;
+        if (!idExists) {
+            this.commands.push(preparedCommand);
+        }
+        else {
+            this.commands = this.commands.map(function (c) {
+                if (c.id === preparedCommand.id) {
+                    return preparedCommand;
                 }
                 return c;
             });
-            return merged;
-        };
+        }
+        return preparedCommand;
     };
@@ -77,2 +77,5 @@ Karhu.prototype.removeCommand = function (commandId) {
     };
+    Karhu.prototype.getEntryGraph = function () {
+        return this.entryGraph;
+    };
     Karhu.prototype.findMatchingCommands = function (input) {
@@ -140,2 +143,2 @@ var _this = this;
 exports.default = Karhu;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiLi8iLCJzb3VyY2VzIjpbImluZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLGlDQVFpQjtBQUNqQixpQ0FBc0Y7QUFFdEY7SUFLRTtRQUhBLGFBQVEsR0FBYyxFQUFFLENBQUM7UUFDekIsYUFBUSxHQUFhLENBQUMsU0FBUyxDQUFDLENBQUM7UUFDakMsZUFBVSxHQUFlLEVBQUUsQ0FBQztRQUUxQixJQUFJLENBQUMsS0FBSyxFQUFFLENBQUM7SUFDZixDQUFDO0lBRUQscUJBQUssR0FBTDtRQUNFLEtBQUssQ0FBQyxTQUFTLEdBQUcsQ0FBQyxDQUFDO1FBQ3BCLElBQUksQ0FBQyxRQUFRLEdBQUcsRUFBRSxDQUFDO1FBQ25CLElBQUksQ0FBQyxRQUFRLEdBQUcsQ0FBQyxTQUFTLENBQUMsQ0FBQztRQUM1QixJQUFJLENBQUMsVUFBVSxHQUFHLEVBQUUsQ0FBQztJQUN2QixDQUFDO0lBRUQsMEJBQVUsR0FBVixVQUFXLE9BQTRCO1FBQ3JDLElBQU0sZUFBZSxHQUFZLElBQUksQ0FBQyxlQUFlLENBQUMsT0FBTyxDQUFDLENBQUM7UUFDL0QsSUFBSSxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUMsZUFBZSxDQUFDLENBQUM7UUFDcEMsT0FBTyxlQUFlLENBQUM7SUFDekIsQ0FBQztJQUNELDZCQUFhLEdBQWIsVUFBYyxFQUFVO1FBQXhCLGlCQVlDO1FBWEMsT0FBTyxVQUFDLE9BQWdCO1lBQ3RCLElBQUksTUFBTSxHQUFZLE9BQU8sQ0FBQztZQUM5QixLQUFJLENBQUMsUUFBUSxDQUFDLEdBQUcsQ0FBQyxVQUFBLENBQUM7Z0JBQ2pCLElBQUksQ0FBQyxDQUFDLEVBQUUsS0FBSyxFQUFFLEVBQUU7b0JBQ2YsTUFBTSxnQkFBUSxDQUFDLEVBQUssT0FBTyxDQUFFLENBQUM7b0JBQzlCLE9BQU8sTUFBTSxDQUFDO2lCQUNmO2dCQUNELE9BQU8sQ0FBQyxDQUFDO1lBQ1gsQ0FBQyxDQUFDLENBQUM7WUFDSCxPQUFPLE1BQU0sQ0FBQztRQUNoQixDQUFDLENBQUM7SUFDSixDQUFDO0lBQ0QsNkJBQWEsR0FBYixVQUFjLFNBQWlCO1FBQzdCLElBQUksQ0FBQyxRQUFRLEdBQUcsSUFBSSxDQUFDLFFBQVEsQ0FBQyxNQUFNLENBQUMsVUFBQSxDQUFDLElBQUksT0FBQSxDQUFDLENBQUMsRUFBRSxLQUFLLFNBQVMsRUFBbEIsQ0FBa0IsQ0FBQyxDQUFDO0lBQ2hFLENBQUM7SUFFRCwyQkFBVyxHQUFYO1FBQ0UsT0FBTyxJQUFJLENBQUMsUUFBUSxDQUFDO0lBQ3ZCLENBQUM7SUFFRCxvQ0FBb0IsR0FBcEIsVUFBcUIsS0FBYztRQUFuQyxpQkF1QkM7UUF0QkMsSUFBSSxDQUFDLEtBQUssRUFBRTtZQUNWLE9BQU8sRUFBRSxDQUFDO1NBQ1g7UUFDRCxJQUFJLGlCQUFpQixHQUFzQix1QkFBZSxDQUFDLElBQUksQ0FBQyxRQUFRLEVBQUUsS0FBSyxDQUFDLENBQUM7UUFFakYsaUJBQWlCLEdBQUcsaUJBQWlCLENBQUMsTUFBTSxDQUFDLFVBQUEsQ0FBQyxJQUFJLE9BQUEsQ0FBQyxDQUFDLEtBQUssS0FBSyxrQkFBVSxDQUFDLEVBQUUsRUFBekIsQ0FBeUIsQ0FBQyxDQUFDO1FBRTdFLElBQU0sZUFBZSxHQUFzQixnQ0FBd0IsQ0FBQyxJQUFJLENBQUMsVUFBVSxFQUFFLEtBQUssQ0FBQyxDQUFDO1FBQzVGLElBQUksZUFBZSxDQUFDLE1BQU0sRUFBRTtZQUMxQixpQkFBaUIsQ0FBQyxPQUFPLE9BQXpCLGlCQUFpQixXQUFZLGVBQWUsR0FBRTtTQUMvQztRQUVELGlCQUFpQixDQUFDLElBQUksQ0FBQyxVQUFDLENBQUMsRUFBRSxDQUFDLElBQUssT0FBQSxDQUFDLENBQUMsS0FBSyxHQUFHLENBQUMsQ0FBQyxLQUFLLEVBQWpCLENBQWlCLENBQUMsQ0FBQztRQUNwRCxJQUFJLFNBQVMsR0FBYSxpQkFBaUIsQ0FBQyxHQUFHLENBQUMsVUFBQSxDQUFDLElBQUksT0FBQSxDQUFDLENBQUMsRUFBRSxFQUFKLENBQUksQ0FBQyxDQUFDO1FBQzNELFNBQVMsR0FBRyxTQUFTLENBQUMsTUFBTSxDQUFDLFVBQUMsRUFBRSxFQUFFLENBQUMsSUFBSyxPQUFBLFNBQVMsQ0FBQyxPQUFPLENBQUMsRUFBRSxDQUFDLEtBQUssQ0FBQyxFQUEzQixDQUEyQixDQUFDLENBQUM7UUFDckUsSUFBTSxRQUFRLEdBQUcsU0FBUyxDQUFDLEdBQUcsQ0FBQyxVQUFBLEVBQUUsSUFBSSxPQUFBLEtBQUksQ0FBQyxRQUFRLENBQUMsTUFBTSxDQUFDLFVBQUEsQ0FBQyxJQUFJLE9BQUEsQ0FBQyxDQUFDLEVBQUUsS0FBSyxFQUFFLEVBQVgsQ0FBVyxDQUFDLENBQUMsQ0FBQyxDQUFDLEVBQXpDLENBQXlDLENBQUMsQ0FBQztRQUNoRixRQUFRLENBQUMsT0FBTyxDQUFDLFVBQUEsQ0FBQztZQUNoQixJQUFJLENBQUMsQ0FBQyxPQUFPLENBQUMsTUFBTSxFQUFFO2dCQUNwQixDQUFDLENBQUMsT0FBTyxDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUMsRUFBRSxDQUFDLENBQUM7YUFDeEI7UUFDSCxDQUFDLENBQUMsQ0FBQztRQUNILE9BQU8sUUFBUSxDQUFDO0lBQ2xCLENBQUM7SUFFRCwwQkFBVSxHQUFWLFVBQVcsRUFBVSxFQUFFLEtBQWE7UUFDbEMsSUFBTSxPQUFPLEdBQUcsSUFBSSxDQUFDLGVBQWUsQ0FBQyxFQUFFLENBQUMsQ0FBQztRQUN6QyxJQUFJLENBQUMsT0FBTyxFQUFFO1lBQ1osT0FBTyxJQUFJLENBQUMsVUFBVSxDQUFDO1NBQ3hCO1FBQ0QsSUFBSSxDQUFDLFVBQVUsR0FBRyx3QkFBZ0IsQ0FBQyxJQUFJLENBQUMsVUFBVSxFQUFFLEtBQUssRUFBRSxFQUFFLENBQUMsQ0FBQztRQUMvRCxVQUFVLENBQUMsY0FBTSxPQUFBLE9BQU8sQ0FBQyxPQUFPLENBQUMsTUFBTSxFQUFFLEVBQXhCLENBQXdCLEVBQUUsQ0FBQyxDQUFDLENBQUM7UUFDOUMsSUFBSSxDQUFDLGlCQUFpQixDQUFDLEVBQUUsQ0FBQyxDQUFDO1FBQzNCLE9BQU8sSUFBSSxDQUFDLFVBQVUsQ0FBQztJQUN6QixDQUFDO0lBRUQsK0JBQWUsR0FBZixVQUFnQixFQUFVO1FBQ3hCLE9BQU8sSUFBSSxDQUFDLFFBQVEsQ0FBQyxNQUFNLENBQUMsVUFBQSxDQUFDLElBQUksT0FBQSxDQUFDLENBQUMsRUFBRSxLQUFLLEVBQUUsRUFBWCxDQUFXLENBQUMsQ0FBQyxHQUFHLEVBQUUsQ0FBQztJQUN0RCxDQUFDO0lBRUQsaUNBQWlCLEdBQWpCLFVBQWtCLEVBQVU7UUFDMUIsS0FBSyxJQUFJLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQyxHQUFHLElBQUksQ0FBQyxRQUFRLENBQUMsTUFBTSxFQUFFLENBQUMsSUFBSSxDQUFDLEVBQUU7WUFDaEQsSUFBTSxHQUFHLEdBQVksSUFBSSxDQUFDLFFBQVEsQ0FBQyxDQUFDLENBQUMsQ0FBQztZQUN0QyxJQUFJLEdBQUcsQ0FBQyxFQUFFLEtBQUssRUFBRSxFQUFFO2dCQUNqQixHQUFHLENBQUMsSUFBSSxDQUFDLEtBQUssSUFBSSxDQUFDLENBQUM7Z0JBQ3BCLE1BQU07YUFDUDtTQUNGO0lBQ0gsQ0FBQztJQUVELCtCQUFlLEdBQWYsVUFBZ0IsT0FBNEI7UUFDMUMsSUFBTSxVQUFVLEdBQVksS0FBSyxDQUFDLGFBQWEsQ0FBQyxPQUFPLENBQUMsQ0FBQztRQUN6RCxPQUFPLFVBQVUsQ0FBQztJQUNwQixDQUFDO0lBOUZNLGVBQVMsR0FBVyxDQUFDLENBQUM7SUFnR3RCLG1CQUFhLEdBQUcsVUFBQyxPQUE0QjtRQUNsRCxJQUFJLENBQUMsT0FBTyxDQUFDLEVBQUUsRUFBRTtZQUNmLEtBQUssQ0FBQyxTQUFTLElBQUksQ0FBQyxDQUFDO1NBQ3RCO1FBQ0QsSUFBTSxFQUFFLEdBQVcsT0FBTyxDQUFDLEVBQUUsQ0FBQyxDQUFDLENBQUMsT0FBTyxDQUFDLEVBQUUsQ0FBQyxDQUFDLENBQUMsYUFBVyxLQUFLLENBQUMsU0FBVyxDQUFDO1FBQzFFLElBQU0sSUFBSSxHQUFvQjtZQUM1QixLQUFLLEVBQUUsQ0FBQztTQUNULENBQUM7UUFDRixrQkFDRSxFQUFFLElBQUEsSUFDQyxPQUFPLElBQ1YsSUFBSSxNQUFBLElBQ0o7SUFDSixDQUFDLENBQUM7SUFDSixZQUFDO0NBQUEsQUEvR0QsSUErR0M7a0JBL0dvQixLQUFLIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiLi8iLCJzb3VyY2VzIjpbImluZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLGlDQVFpQjtBQUNqQixpQ0FBc0Y7QUFFdEY7SUFLRSxlQUFZLFVBQXVCO1FBSG5DLGFBQVEsR0FBYyxFQUFFLENBQUM7UUFDekIsYUFBUSxHQUFhLENBQUMsU0FBUyxDQUFDLENBQUM7UUFDakMsZUFBVSxHQUFlLEVBQUUsQ0FBQztRQUUxQixJQUFJLENBQUMsS0FBSyxFQUFFLENBQUM7UUFDYixJQUFJLFVBQVUsRUFBRTtZQUNkLElBQUksQ0FBQyxVQUFVLEdBQUcsVUFBVSxDQUFDO1NBQzlCO0lBQ0gsQ0FBQztJQUVELHFCQUFLLEdBQUw7UUFDRSxLQUFLLENBQUMsU0FBUyxHQUFHLENBQUMsQ0FBQztRQUNwQixJQUFJLENBQUMsUUFBUSxHQUFHLEVBQUUsQ0FBQztRQUNuQixJQUFJLENBQUMsUUFBUSxHQUFHLENBQUMsU0FBUyxDQUFDLENBQUM7UUFDNUIsSUFBSSxDQUFDLFVBQVUsR0FBRyxFQUFFLENBQUM7SUFDdkIsQ0FBQztJQUVELDBCQUFVLEdBQVYsVUFBVyxPQUE0QjtRQUNyQyxJQUFNLGVBQWUsR0FBWSxJQUFJLENBQUMsZUFBZSxDQUFDLE9BQU8sQ0FBQyxDQUFDO1FBQy9ELElBQU0sUUFBUSxHQUFZLElBQUksQ0FBQyxRQUFRLENBQUMsTUFBTSxDQUFDLFVBQUEsQ0FBQyxJQUFJLE9BQUEsQ0FBQyxDQUFDLEVBQUUsS0FBSyxlQUFlLENBQUMsRUFBRSxFQUEzQixDQUEyQixDQUFDLENBQUMsTUFBTSxHQUFHLENBQUMsQ0FBQztRQUM1RixJQUFJLENBQUMsUUFBUSxFQUFFO1lBQ2IsSUFBSSxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUMsZUFBZSxDQUFDLENBQUM7U0FDckM7YUFBTTtZQUNMLElBQUksQ0FBQyxRQUFRLEdBQUcsSUFBSSxDQUFDLFFBQVEsQ0FBQyxHQUFHLENBQUMsVUFBQSxDQUFDO2dCQUNqQyxJQUFJLENBQUMsQ0FBQyxFQUFFLEtBQUssZUFBZSxDQUFDLEVBQUUsRUFBRTtvQkFDL0IsT0FBTyxlQUFlLENBQUM7aUJBQ3hCO2dCQUNELE9BQU8sQ0FBQyxDQUFDO1lBQ1gsQ0FBQyxDQUFDLENBQUM7U0FDSjtRQUNELE9BQU8sZUFBZSxDQUFDO0lBQ3pCLENBQUM7SUFFRCw2QkFBYSxHQUFiLFVBQWMsU0FBaUI7UUFDN0IsSUFBSSxDQUFDLFFBQVEsR0FBRyxJQUFJLENBQUMsUUFBUSxDQUFDLE1BQU0sQ0FBQyxVQUFBLENBQUMsSUFBSSxPQUFBLENBQUMsQ0FBQyxFQUFFLEtBQUssU0FBUyxFQUFsQixDQUFrQixDQUFDLENBQUM7SUFDaEUsQ0FBQztJQUVELDJCQUFXLEdBQVg7UUFDRSxPQUFPLElBQUksQ0FBQyxRQUFRLENBQUM7SUFDdkIsQ0FBQztJQUVELDZCQUFhLEdBQWI7UUFDRSxPQUFPLElBQUksQ0FBQyxVQUFVLENBQUM7SUFDekIsQ0FBQztJQUVELG9DQUFvQixHQUFwQixVQUFxQixLQUFjO1FBQW5DLGlCQXVCQztRQXRCQyxJQUFJLENBQUMsS0FBSyxFQUFFO1lBQ1YsT0FBTyxFQUFFLENBQUM7U0FDWDtRQUNELElBQUksaUJBQWlCLEdBQXNCLHVCQUFlLENBQUMsSUFBSSxDQUFDLFFBQVEsRUFBRSxLQUFLLENBQUMsQ0FBQztRQUVqRixpQkFBaUIsR0FBRyxpQkFBaUIsQ0FBQyxNQUFNLENBQUMsVUFBQSxDQUFDLElBQUksT0FBQSxDQUFDLENBQUMsS0FBSyxLQUFLLGtCQUFVLENBQUMsRUFBRSxFQUF6QixDQUF5QixDQUFDLENBQUM7UUFFN0UsSUFBTSxlQUFlLEdBQXNCLGdDQUF3QixDQUFDLElBQUksQ0FBQyxVQUFVLEVBQUUsS0FBSyxDQUFDLENBQUM7UUFDNUYsSUFBSSxlQUFlLENBQUMsTUFBTSxFQUFFO1lBQzFCLGlCQUFpQixDQUFDLE9BQU8sT0FBekIsaUJBQWlCLFdBQVksZUFBZSxHQUFFO1NBQy9DO1FBRUQsaUJBQWlCLENBQUMsSUFBSSxDQUFDLFVBQUMsQ0FBQyxFQUFFLENBQUMsSUFBSyxPQUFBLENBQUMsQ0FBQyxLQUFLLEdBQUcsQ0FBQyxDQUFDLEtBQUssRUFBakIsQ0FBaUIsQ0FBQyxDQUFDO1FBQ3BELElBQUksU0FBUyxHQUFhLGlCQUFpQixDQUFDLEdBQUcsQ0FBQyxVQUFBLENBQUMsSUFBSSxPQUFBLENBQUMsQ0FBQyxFQUFFLEVBQUosQ0FBSSxDQUFDLENBQUM7UUFDM0QsU0FBUyxHQUFHLFNBQVMsQ0FBQyxNQUFNLENBQUMsVUFBQyxFQUFFLEVBQUUsQ0FBQyxJQUFLLE9BQUEsU0FBUyxDQUFDLE9BQU8sQ0FBQyxFQUFFLENBQUMsS0FBSyxDQUFDLEVBQTNCLENBQTJCLENBQUMsQ0FBQztRQUNyRSxJQUFNLFFBQVEsR0FBRyxTQUFTLENBQUMsR0FBRyxDQUFDLFVBQUEsRUFBRSxJQUFJLE9BQUEsS0FBSSxDQUFDLFFBQVEsQ0FBQyxNQUFNLENBQUMsVUFBQSxDQUFDLElBQUksT0FBQSxDQUFDLENBQUMsRUFBRSxLQUFLLEVBQUUsRUFBWCxDQUFXLENBQUMsQ0FBQyxDQUFDLENBQUMsRUFBekMsQ0FBeUMsQ0FBQyxDQUFDO1FBQ2hGLFFBQVEsQ0FBQyxPQUFPLENBQUMsVUFBQSxDQUFDO1lBQ2hCLElBQUksQ0FBQyxDQUFDLE9BQU8sQ0FBQyxNQUFNLEVBQUU7Z0JBQ3BCLENBQUMsQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUMsQ0FBQzthQUN4QjtRQUNILENBQUMsQ0FBQyxDQUFDO1FBQ0gsT0FBTyxRQUFRLENBQUM7SUFDbEIsQ0FBQztJQUVELDBCQUFVLEdBQVYsVUFBVyxFQUFVLEVBQUUsS0FBYTtRQUNsQyxJQUFNLE9BQU8sR0FBRyxJQUFJLENBQUMsZUFBZSxDQUFDLEVBQUUsQ0FBQyxDQUFDO1FBQ3pDLElBQUksQ0FBQyxPQUFPLEVBQUU7WUFDWixPQUFPLElBQUksQ0FBQyxVQUFVLENBQUM7U0FDeEI7UUFDRCxJQUFJLENBQUMsVUFBVSxHQUFHLHdCQUFnQixDQUFDLElBQUksQ0FBQyxVQUFVLEVBQUUsS0FBSyxFQUFFLEVBQUUsQ0FBQyxDQUFDO1FBQy9ELFVBQVUsQ0FBQyxjQUFNLE9BQUEsT0FBTyxDQUFDLE9BQU8sQ0FBQyxNQUFNLEVBQUUsRUFBeEIsQ0FBd0IsRUFBRSxDQUFDLENBQUMsQ0FBQztRQUM5QyxJQUFJLENBQUMsaUJBQWlCLENBQUMsRUFBRSxDQUFDLENBQUM7UUFDM0IsT0FBTyxJQUFJLENBQUMsVUFBVSxDQUFDO0lBQ3pCLENBQUM7SUFFRCwrQkFBZSxHQUFmLFVBQWdCLEVBQVU7UUFDeEIsT0FBTyxJQUFJLENBQUMsUUFBUSxDQUFDLE1BQU0sQ0FBQyxVQUFBLENBQUMsSUFBSSxPQUFBLENBQUMsQ0FBQyxFQUFFLEtBQUssRUFBRSxFQUFYLENBQVcsQ0FBQyxDQUFDLEdBQUcsRUFBRSxDQUFDO0lBQ3RELENBQUM7SUFFRCxpQ0FBaUIsR0FBakIsVUFBa0IsRUFBVTtRQUMxQixLQUFLLElBQUksQ0FBQyxHQUFHLENBQUMsRUFBRSxDQUFDLEdBQUcsSUFBSSxDQUFDLFFBQVEsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxJQUFJLENBQUMsRUFBRTtZQUNoRCxJQUFNLEdBQUcsR0FBWSxJQUFJLENBQUMsUUFBUSxDQUFDLENBQUMsQ0FBQyxDQUFDO1lBQ3RDLElBQUksR0FBRyxDQUFDLEVBQUUsS0FBSyxFQUFFLEVBQUU7Z0JBQ2pCLEdBQUcsQ0FBQyxJQUFJLENBQUMsS0FBSyxJQUFJLENBQUMsQ0FBQztnQkFDcEIsTUFBTTthQUNQO1NBQ0Y7SUFDSCxDQUFDO0lBRUQsK0JBQWUsR0FBZixVQUFnQixPQUE0QjtRQUMxQyxJQUFNLFVBQVUsR0FBWSxLQUFLLENBQUMsYUFBYSxDQUFDLE9BQU8sQ0FBQyxDQUFDO1FBQ3pELE9BQU8sVUFBVSxDQUFDO0lBQ3BCLENBQUM7SUFuR00sZUFBUyxHQUFXLENBQUMsQ0FBQztJQXFHdEIsbUJBQWEsR0FBRyxVQUFDLE9BQTRCO1FBQ2xELElBQUksQ0FBQyxPQUFPLENBQUMsRUFBRSxFQUFFO1lBQ2YsS0FBSyxDQUFDLFNBQVMsSUFBSSxDQUFDLENBQUM7U0FDdEI7UUFDRCxJQUFNLEVBQUUsR0FBVyxPQUFPLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQyxPQUFPLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQyxhQUFXLEtBQUssQ0FBQyxTQUFXLENBQUM7UUFDMUUsSUFBTSxJQUFJLEdBQW9CO1lBQzVCLEtBQUssRUFBRSxDQUFDO1NBQ1QsQ0FBQztRQUNGLGtCQUNFLEVBQUUsSUFBQSxJQUNDLE9BQU8sSUFDVixJQUFJLE1BQUEsSUFDSjtJQUNKLENBQUMsQ0FBQztJQUNKLFlBQUM7Q0FBQSxBQXBIRCxJQW9IQztrQkFwSG9CLEtBQUsifQ==

lib/types.d.ts

 /// <reference types="react" />
-export declare type UnregisteredCommand = {
+export interface UnregisteredCommand {
     id?: string;
@@ -9,6 +9,6 @@ name: string;
     render: (c: Command) => JSX.Element | string;
-};
-export declare type CommandMetadata = {
+}
+export interface CommandMetadata {
     calls: number;
-};
+}
 export interface Command extends UnregisteredCommand {
@@ -26,15 +26,15 @@ id: string;
 }
-export declare type ClassifiedMatch = {
+export interface ClassifiedMatch {
     id: string;
     score: MatchClass;
-};
+}
 export declare type ClassifiedMatches = ClassifiedMatch[];
 export declare type EntryGraph = any;
-export declare type EntryGraphRecord = {
+export interface EntryGraphRecord {
     id: string;
     calls: number;
-};
-export declare type ActionsObject = {
+}
+export interface ActionsObject {
     onExec: () => void;
     onShow?: (id: string) => void;
-};
+}

package.json

 {
   "name": "@karhu/core",
-  "version": "0.1.3-alpha.0",
-  "description": "> TODO: description",
+  "version": "0.2.1",
+  "description": "Core package for Karhu, the lib for powering web app productivity tools",
   "author": "Oskar Hane <[e-mail]>",
@@ -22,3 +22,3 @@ "scripts": {
   },
-  "gitHead": "182442cb67ae1502ab27f4616a494596454198b9"
+  "gitHead": "07e2e0cf3fbb9cc1e9903f150beef8345cbdf563"
 }

README.md

@@ -1,11 +0,85 @@
-# `karhu`
+# `@karhu/core`
 
-> TODO: description
+Karhu is a productivity tool for web applications. This package has the core functionality
+as the command register and entry graph to adapt command listing to users habits and learn over time.
 
+## Install
+
+```bash
+npm install @karhu/core
+```
+
 ## Usage
 
+```js
+import Karhu from '@karhu/core';
+
+const karhu = new Karhu();
 ```
-const karhu = require('karhu');
 
-// TODO: DEMONSTRATE API
+## API
+
+### `Karhu`
+
+#### `karhu.addCommand()`
+
+Adds a command to the current Karhu instance.
+
+```ts
+karhu.addCommand(command: UnregisteredCommand): Command
 ```
+
+### `karhu.removeCommand`
+
+Removes a command from teh current Karhu instance.
+
+```ts
+karhu.removeCommand(commandId: string): void
+```
+
+### `karhu.findMatchingCommands`
+
+Searches through the existing commands keywords and the current entry graph to
+find commands that matches the provided input, and returns them.
+
+```ts
+karhu.findMatchingCommands(input?: string): Command[]
+```
+
+### `karhu.runCommand`
+
+Call the command with the provided id's `.actions.onExec()` function.  
+Returns the updated entry graph.  
+The input is needed to better sort the commands next time `karhu.findMatchingCommands()` is called.
+
+**Note**: Even though this method is synchronous, the `.onExec()`
+function is **not** being called synchronously. It's bering called using `setTimeout(fn, 0)` to not block further executing.
+
+```ts
+karhu.runCommand(id: string, input: string): EntryGraph
+```
+
+### `karhu.getCommands`
+
+Returns a list of all registered commands for the Karhu instance.
+
+```ts
+karhu.getCommands(): Command[]
+```
+
+### `karhu.getEntryGraph`
+
+Returns the current Entry Graph for the Karhu instance.
+
+```ts
+karhu.getEntryGraph(): EntryGraph
+```
+
+### Static `Karhu.createCommand`
+
+Makes an `UnregisteredCommand` -> `Command`. Mostly used internally but can be useful in
+some situations.
+
+```ts
+Karhu.createCommand (command: UnregisteredCommand): Command
+```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

34677

increased by6.51%

Lines of code

324

increased by0.93%

Number of lines in readme file

86

increased by616.67%

No dependency changes