fix: v0.1.0

Author: divanc

.eslintrc.js

@@ -0,0 +1,32 @@
+module.exports = {
+  parser: "@typescript-eslint/parser",
+  plugins: ["@typescript-eslint"],
+  extends: ["plugin:@typescript-eslint/recommended"],
+  parserOptions: {
+    ecmaFeatures: { jsx: true },
+    ecmaVersion: 2018,
+    sourceType: "module",
+  },
+  rules: {
+    "max-len": [
+      "error",
+      86,
+      4,
+      {
+        ignoreComments: true,
+        ignoreUrls: true,
+        ignoreStrings: true,
+        ignoreTemplateLiterals: true,
+        ignoreRegExpLiterals: true,
+      },
+    ],
+    "@typescript-eslint/ban-ts-comment": "off",
+    "@typescript-eslint/no-empty-function": "off",
+    "@typescript-eslint/no-explicit-any": "off",
+    "padding-line-between-statements": [
+      "error",
+      { blankLine: "always", prev: "*", next: "return" },
+      { blankLine: "always", prev: "*", next: "function" },
+    ],
+  },
+};

.gitignore

@@ -1,2 +1,3 @@
 node_modules
-dist
+dist
+tsconfig.tsbuildinfo

README.MD

@@ -1,28 +1,32 @@
 ## @lfg/query-coder
-URL query coder/decoder with configurable user pattern. It provides the most comfortable experience for encoding and decoding complex nested filter objects. [Check out example for more info](#example).
 
+URL query coder/decoder with configurable user pattern. It provides the most comfortable experience for encoding and decoding complex nested filter objects. [Check out example for more info](#example).
 
 ### Installation
+
 ```zsh
 yarn add @lfg/query-coder
 ```
 
 ### Basic Example
+
 Imaging having a such interface for your querying filters:
+
 ```ts
 type SearchGroupsFilter = {
-  gameId?: 'WorldOfWarcraft' | 'WildRift' | 'LostArk';
+  gameId?: "WorldOfWarcraft" | "WildRift" | "LostArk";
   gameMode?: GameMode;
   from?: Date;
   language?: Language;
-  
+
   lostArk?: LostArkFilterInput;
   wildRift?: WildRiftFilterInput;
   wow?: WowFilterInput;
 };
 ```
 
 Let's take 1 example of this:
+
 ```ts
 const filters: SearchGroupsFilter = {
   gameId: "WorldOfWarcraft",
@@ -35,22 +39,24 @@ const filters: SearchGroupsFilter = {
     region: WowRegion.Europe,
   },
 };
-
 ```
-Which should result in `const query = "game=wow&mode=mplus&language=en&faction=alliance&dungeon=mots&rating=1400&region=eu"`. 
-So we want to: 
-* flatten nested filter object in a query string  
-* rename certain keys (`gameMode` -> `mode`)
-* re-map certain values (`WorldOfWarcraft` -> `wow`)
+
+Which should result in `const query = "game=wow&mode=mplus&language=en&faction=alliance&dungeon=mots&rating=1400&region=eu"`.
+So we want to:
+
+- flatten nested filter object in a query string
+- rename certain keys (`gameMode` -> `mode`)
+- re-map certain values (`WorldOfWarcraft` -> `wow`)
 
 With this lib, you can init `QueryCoder` and that's it! 🎉
+
 ```ts
-import { QueryCoder, QueryHandler } from '@lfg/query-coder';
+import { QueryCoder, QueryHandler } from "@lfg/query-coder";
 
 // passing generic interface checks, whether node keys
 // are the same as in provided interface
 const query = new QueryCoder<SearchGroupsFilter>({
-  gameId: new QueryHandler({ 
+  gameId: new QueryHandler({
     query: "game",
     aliases: {
       WorldOfWarcraft: "wow",
@@ -61,7 +67,7 @@ const query = new QueryCoder<SearchGroupsFilter>({
   gameMode: new QueryHandler({ query: "mode" }),
   language: new QueryHandler({ query: "language" }),
   wow: {
-    faction: new QueryHandler({ 
+    faction: new QueryHandler({
       query: "faction",
       /**
        * decodeCondition is Partial of generic
@@ -82,7 +88,7 @@ const query = new QueryCoder<SearchGroupsFilter>({
        * You should provide a primitive type, which is different from string
        * Otherwise, url query "foo=313" can result in an unexpected result
        */
-      type: Type.Number,
+      decodeType: Type.Number,
     }),
     region: new QueryHandler({
       query: "region",

package.json

@@ -1,11 +1,20 @@
 {
   "name": "@lfg/query-coder",
-  "version": "1.0.0",
+  "version": "0.0.1",
   "description": "URL query coder-decoder",
   "main": "dist/index.js",
   "author": "Ivan Dorofeyev",
   "license": "MIT",
+  "scripts": {
+    "build": "tsc --build",
+    "prepublish": "build"
+  },
   "devDependencies": {
-    "typescript": "^4.6.2"
+    "typescript": "^4.6.2",
+    "prettier": "^2.6.0",
+    "eslint": "^8.11.0",
+    "@types/node": "^12.0.0",
+    "@typescript-eslint/eslint-plugin": "^5.15.0",
+    "@typescript-eslint/parser": "^5.15.0"
   }
 }

src/helpers.ts

@@ -0,0 +1,24 @@
+export function deepAssign<T extends Record<any, any>>(
+  obj: T,
+  path: string,
+  value: any
+): Record<any, any> {
+  const pathArray = path.split(".") as Array<keyof T>;
+  let copyObj = obj;
+
+  while (pathArray.length - 1) {
+    const accessibleNode = pathArray.shift();
+    if (!accessibleNode) {
+      return copyObj;
+    }
+
+    if (!(accessibleNode in copyObj)) {
+      copyObj[accessibleNode] = {} as any;
+    }
+    copyObj = copyObj[accessibleNode];
+  }
+
+  copyObj[pathArray[0]] = value;
+
+  return copyObj;
+}

src/index.ts

@@ -1,10 +1,14 @@
 import { QueryHandler } from "./queryHandler";
+import { deepAssign } from "./helpers";
 import {
   DeepQueryCoder,
   DeepQueryCoderWithParent,
   QueryHandlerMap,
+  Type,
 } from "./types";
 
+export { QueryHandler, Type };
+
 /**
  * QueryCoders
  */
@@ -42,7 +46,7 @@ export class QueryCoder<T> {
           acc[value.query] = [];
         }
         value.setPath([...path, keyStr]); // filter.wow.dungeon
-        acc[value.query].push(value);
+        acc[value.query].push(value as any);
 
         return acc;
       }
@@ -70,6 +74,7 @@ export class QueryCoder<T> {
   ): Record<string, string> {
     return Object.keys(data).reduce((acc, keyStr) => {
       const key = keyStr as keyof D;
+
       const value = data[key] as unknown;
       const shallowEncoder = encoder[key] as DeepQueryCoder<typeof value>;
 
@@ -97,7 +102,6 @@ export class QueryCoder<T> {
    */
   encode(data: T): string {
     const queryMap = this.deepEncode(data, this.queryEncoder);
-    console.log(queryMap);
     const urlQuery = new URLSearchParams(queryMap);
 
     return urlQuery.toString();
@@ -109,22 +113,22 @@ export class QueryCoder<T> {
    * @returns decoded object
    */
   decode(query: string): T {
-    "game=Wow&gameMode=WowMythicPlus&language=En&faction=Alliance&dungeon=MistsOfTirnaScithe&rating=1400&region=Europe";
     const searchParams = new URLSearchParams(query);
-    const params = Object.fromEntries([...(searchParams as any)]);
 
-    Object.keys(params).map((key) => {
-      const value = params[key];
+    const object = {};
+
+    for (const [key, value] of searchParams) {
       const handlers = this.queryHandlers[key];
       if (!handlers) {
-        return;
+        continue;
       }
+
       if (handlers.length === 1) {
         const handler = handlers[0];
         const parsedValue = handler.decode(value);
+        deepAssign(object, handler.path, parsedValue);
       }
-    });
-
-    return {} as T;
+    }
+    return object as T;
   }
 }

src/queryHandler.ts

@@ -52,12 +52,15 @@ export class QueryHandler<T, DC = undefined> {
   constructor(data: QueryHandlerParams<T, DC>) {
     this.query = data.query;
     this.decodeCondition = data.decodeCondition;
+    if (data.decodeType) {
+      this.type = data.decodeType;
+    }
 
     const strData = data as QueryHandlerTypedParams<string | number | symbol>;
-    if (strData?.convertMap) {
-      const convertMap = strData.convertMap as any;
-      this.aliases = convertMap;
-      this.reverseAliases = this.reverseMap(convertMap);
+    if (strData?.aliases) {
+      const aliases = strData.aliases as any;
+      this.aliases = aliases;
+      this.reverseAliases = this.reverseMap(aliases);
     }
   }
 
@@ -96,7 +99,7 @@ export class QueryHandler<T, DC = undefined> {
   }
 
   public setPath(path: string[]) {
-    return path.join(".");
+    this.path = path.join(".");
   }
 
   private isPrimitive(data: any): data is string | number | symbol {

src/types.d.ts renamed to src/types.ts

@@ -6,9 +6,9 @@ export type QueryHandlerParams<T, P = undefined> = {
   decodeType?: Type;
 } & QueryHandlerTypedParams<T>;
 
-type QueryHandlerTypedParams<T> = T extends number | string | symbol
+export type QueryHandlerTypedParams<T> = T extends number | string | symbol
   ? {
-      convertMap?: Record<T, string>;
+      aliases?: Record<T, string>;
     }
   : void;
 

tsconfig.json

@@ -3,20 +3,20 @@
   "compilerOptions": {
     "outDir": "dist",
     "rootDir": "src",
-    "baseUrl": "./src",
     "target": "ES5",
-    "lib": ["DOM", "DOM.Iterable", "ESNext"],
+    "downlevelIteration": true,
+    "lib": ["ESNext"],
     "skipLibCheck": true,
     "esModuleInterop": true,
     "allowSyntheticDefaultImports": true,
     "strict": true,
     "forceConsistentCasingInFileNames": true,
     "noFallthroughCasesInSwitch": true,
-    "module": "ESNext",
+    "module": "CommonJS",
     "moduleResolution": "node",
     "resolveJsonModule": true,
+    "declaration": true,
     "isolatedModules": true,
-    "noEmit": true,
     "allowJs": false,
     "incremental": true
   },