Refactor gson-query to typescript

Author: Sascha Goldhofer

.eslintrc

@@ -1,17 +1,27 @@
 {
+    "extends": [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/eslint-recommended",
+        "plugin:@typescript-eslint/recommended"
+    ],
     "parser": "@typescript-eslint/parser",
     "plugins": [
-        "@typescript-eslint"
+        "@typescript-eslint",
+        "array-func",
+        "node",
+        "optimize-regex",
+        "promise"
     ],
 
     "parserOptions": {
-        "ecmaVersion": 6,
+        "ecmaVersion": 2018,
         "sourceType": "module"
     },
 
     "env": {
         "es6": true,
-        "node": true
+        "node": true,
+        "mocha": true
     },
 
     "settings": {
@@ -24,10 +34,10 @@
         }
     },
 
-    "extends": "eslint:recommended",
     "rules": {
-        "semi": ["error", "always"],
-        "prefer-const": "error",
-        "no-var": "error"
+        "@typescript-eslint/explicit-function-return-type": "off",
+        "@typescript-eslint/explicit-module-boundary-types": "off",
+        "@typescript-eslint/ban-ts-ignore": "off",
+        "@typescript-eslint/no-explicit-any": "off"
     }
 }

.gitignore

@@ -1,8 +1,7 @@
-node_modules
-status.png
-build
-bower_components
-*.sublime-workspace
 *.sublime-project
-/.nyc_output
+*.sublime-workspace
 .DS_Store
+/.nyc_output
+/dev
+/node_modules
+/types

dist/gson-query.js

@@ -1,5 +1,6 @@
-const { parse } = require("./parser");
-const { run, VALUE_INDEX, POINTER_INDEX } = require("./interpreter");
+import { parse } from "./parser";
+import { run, VALUE_INDEX, POINTER_INDEX } from "./interpreter";
+import { Input } from "./types";
 
 
 const returnTypes = {
@@ -15,7 +16,14 @@ const returnTypes = {
 
 Object.keys(returnTypes).forEach(prop => (get[prop.toUpperCase()] = prop));
 
-function get(data, queryString, returnType = "value") {
+export enum ReturnType {
+    POINTER = "pointer",
+    VALUE = "value",
+    ALL = "all",
+    MAP = "map"
+}
+
+export default function get(data: Input, queryString: string, returnType: ReturnType|Function = ReturnType.VALUE) {
     if (queryString == null) {
         return [];
     }
@@ -34,14 +42,11 @@ function get(data, queryString, returnType = "value") {
     }
 
     const result = run(data, ast);
-    if (returnTypes[returnType]) {
-        return returnTypes[returnType](result);
-    } else if (typeof returnType === "function") {
+    if (typeof returnType === "function") {
         return result.map(r => returnType(...r));
+    } else if (returnTypes[returnType]) {
+        return returnTypes[returnType](result);
     }
 
     return result;
 }
-
-
-module.exports = get;

dist/gson-query.js.LICENSE.txt

@@ -0,0 +1,4 @@
+export { default as get } from "./get";
+export { default as set } from "./set";
+export { default as split } from "./split";
+export { default as remove } from "./remove";

lib/get.d.ts

@@ -1,5 +1,5 @@
-const { expand, select, cache } = require("./nodes");
-const { VALUE_INDEX, KEY_INDEX, PARENT_INDEX, POINTER_INDEX } = require("./keys");
+import { expand, select, cache } from "./nodes";
+import { VALUE_INDEX, KEY_INDEX, PARENT_INDEX, POINTER_INDEX } from "./keys";
 
 
 function collect(func, input, node, pointer) {
@@ -92,7 +92,7 @@ function skip(data, ast, pointer) {
 }
 
 
-function runNode(data, ast, pointer) {
+function runNode(data, ast, pointer?) {
     let result;
     if (ast.type === "query") {
         result = query(data, ast, pointer);
@@ -108,14 +108,10 @@ function runNode(data, ast, pointer) {
 }
 
 
-module.exports = {
-    VALUE_INDEX,
-    KEY_INDEX,
-    PARENT_INDEX,
-    POINTER_INDEX,
-    run(data, ast) {
-        cache.reset();
-        cache.mem.push(data);
-        return runNode([[data, null, null, "#"]], ast);
-    }
-};
+export default function run(data, ast) {
+    cache.reset();
+    cache.mem.push(data);
+    return runNode([[data, null, null, "#"]], ast);
+}
+
+export { run, VALUE_INDEX, KEY_INDEX, PARENT_INDEX, POINTER_INDEX };

lib/get.js renamed to lib/get.ts

@@ -0,0 +1,4 @@
+export const VALUE_INDEX = 0;
+export const KEY_INDEX = 1;
+export const PARENT_INDEX = 2;
+export const POINTER_INDEX = 3;

lib/index.d.ts

@@ -1,6 +1,6 @@
-const o = require("gson-conform");
+import o from "gson-conform";
 const join = (a, b) => `${a}/${b}`;
-const { VALUE_INDEX, POINTER_INDEX } = require("./keys");
+import { VALUE_INDEX, POINTER_INDEX } from "./keys";
 
 const toString = Object.prototype.toString;
 const rContainer = /Object|Array/;
@@ -138,8 +138,4 @@ function expressionMatches(value, cmp, test) {
 }
 
 
-module.exports = {
-    expand,
-    select,
-    cache
-};
+export { expand, select, cache };

lib/index.js

@@ -1,9 +1,9 @@
-const propertyRegex = "[^?/{}*,()#]+";
+export const propertyRegex = "[^?/{}*,()#]+";
 
 // W3C ENBF grammar
 // https://github.com/lys-lang/node-ebnf/blob/master/test/W3CEBNF.spec.ts
 // https://www.w3.org/TR/xml/#sec-notation
-const enbf = `
+export default `
 root ::= ("#" recursion | recursion | (query | pattern) recursion* | "#" SEP? | SEP)
 recursion ::= (SEP query | pattern)*
 
@@ -32,9 +32,3 @@ orPattern ::= S? "," S?
 
 S ::= [ ]*
 `;
-
-
-module.exports = {
-    enbf,
-    propertyRegex
-};

lib/index.ts

@@ -1,5 +1,5 @@
-const { default: EBNF } = require("ebnf/dist/Grammars/W3CEBNF");
-const { enbf } = require("./grammar");
+import { default as EBNF } from "ebnf/dist/Grammars/W3CEBNF";
+import enbf from "./grammar";
 
 const valid = /(children|text|type|start|end|rest|errors|fullText|\d+)/;
 const subset = /(children|text|type|\d+)/;
@@ -9,8 +9,6 @@ const toSmallJSON = (ast) => JSON.stringify(ast, (key, value) => (key === "" ||
 const parser = new EBNF.Parser(enbf);
 
 
-module.exports = {
-    parse: (query) => parser.getAST(query),
-    reduce: (ast) => JSON.parse(toSmallJSON(ast)),
-    toJSON
-};
+export const parse = (query) => parser.getAST(query);
+export const reduce = (ast) => JSON.parse(toSmallJSON(ast));
+export { toJSON };

lib/interpreter/index.js renamed to lib/interpreter/index.ts

@@ -0,0 +1,20 @@
+import pointerDelete from "gson-pointer/lib/delete";
+import removeUndefinedItems from "gson-pointer/lib/removeUndefinedItems";
+import get, { ReturnType } from "./get";
+import { PARENT_INDEX, POINTER_INDEX } from "./interpreter/keys";
+
+
+export default function queryRemove(input, jsonPointer, returnRemoved = false) {
+    const removed = [];
+    const matches = get(input, jsonPointer, ReturnType.ALL);
+    matches.forEach(function (match) {
+        removed.push(match[0]);
+        pointerDelete(input, match[POINTER_INDEX], true);
+    });
+    matches.forEach(function (match) {
+        if (Array.isArray(match[PARENT_INDEX])) {
+            removeUndefinedItems(match[PARENT_INDEX]);
+        }
+    });
+    return returnRemoved ? removed : input;
+}