@vroskus/library-history 1.0.0 → 1.0.2

package/.eslintrc

@@ -0,0 +1,77 @@
+{
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "requireConfigFile": false,
+    "project": ["tsconfig.json"]
+  },
+  "extends": [
+    "airbnb-base",
+    "airbnb-typescript",
+    "plugin:import/recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:sort/recommended"
+  ],
+  "plugins": [
+    "@typescript-eslint",
+    "import",
+    "import-newlines",
+    "react",
+    "sort"
+  ],
+  "rules": {
+    "complexity": ["error", 5],
+    "@typescript-eslint/ban-ts-comment": [1],
+    "@typescript-eslint/no-unused-vars": [2],
+    "curly": ["error", "all"],
+    "import/no-cycle": [0],
+    "no-await-in-loop": 0,
+    "no-console": "error",
+    "no-duplicate-imports": [0],
+    "no-loss-of-precision": [0],
+    "no-restricted-syntax": 0,
+    "no-unreachable-loop": [0],
+    "no-useless-backreference": [0],
+    "no-unused-private-class-members": [2],
+    "padding-line-between-statements": ["error", {
+      "blankLine": "always",
+      "prev": ["const", "let"],
+      "next": "*"
+    }, {
+      "blankLine": "any",
+      "prev": ["const", "let"],
+      "next": ["const", "let"]
+    }, {
+      "blankLine": "always",
+      "prev": ["if", "function", "for"],
+      "next": "*"
+    }, {
+      "blankLine": "always",
+      "prev": "*",
+      "next": "return"
+    }],
+    "object-curly-newline": ["error", {
+      "ObjectExpression": "always",
+      "ObjectPattern": "always",
+      "ImportDeclaration": "always",
+      "ExportDeclaration": "always"
+    }],
+    "function-call-argument-newline": ["error", "always"],
+    "object-property-newline": ["error", {
+      "allowMultiplePropertiesPerLine": false
+    }],
+    "import-newlines/enforce": ["error", {
+      "items": 1,
+      "forceSingleLine": false
+    }],
+    "sort/imports": [0],
+    "sort/exports": [0]
+  },
+  "env": {
+    "browser": true,
+    "node": true,
+    "jest": true,
+    "es6": true
+  }
+}

package/dist/index.d.ts

@@ -0,0 +1,17 @@
+import type { $Location } from '@vroskus/library-types';
+type $Listener = (location: $Location) => unknown;
+export type $RedirectParams = {
+    hash?: string;
+    pathname?: string;
+    search?: string;
+    state?: object;
+};
+export type $RedirectResponse = $RedirectParams;
+export type $HistoryService = {
+    readonly addListener: (listener: $Listener) => number;
+    readonly getCurrentPathname: () => string | null;
+    readonly redirect: (arg0: $RedirectParams) => $RedirectResponse;
+    readonly render: unknown;
+};
+declare const HistoryService: $HistoryService;
+export default HistoryService;

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAQA,6CAA+B;AAC/B,uDAE0B;AAO1B,IAAI,aAAa,GAAG,IAAI,CAAC;AACzB,MAAM,SAAS,GAAqB,EAAE,CAAC;AAEvC,MAAM,GAAI,SAAQ,KAAK,CAAC,SAAiB;IACvC,iBAAiB;QACf,IAAI,CAAC,kBAAkB,EAAE,CAAC;IAC5B,CAAC;IAED,kBAAkB;QAChB,IAAI,CAAC,kBAAkB,EAAE,CAAC;IAC5B,CAAC;IAED,kBAAkB;QAChB,MAAM,EACJ,OAAO,GACR,GAAG,IAAI,CAAC,KAAK,CAAC;QAEf,SAAS,CAAC,OAAO,CAAC,CAAC,QAAmB,EAAE,EAAE;YACxC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;QAEH,aAAa,GAAG,OAAO,CAAC;IAC1B,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAiBD,MAAM,cAAc,GAAoB;IACtC,WAAW,EAAE,CAAC,QAAmB,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC;IAC9D,kBAAkB,EAAE,GAAG,EAAE;QACvB,IAAI,MAAM,IAAI,MAAM,CAAC,QAAQ,EAAE;YAC7B,OAAO,MAAM,CAAC,QAAQ,CAAC,QAAQ,IAAI,IAAI,CAAC;SACzC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IACD,QAAQ,EAAE,CAAC,MAAuB,EAAqB,EAAE;QACvD,IAAI,aAAa,EAAE;YACjB,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SAC5B;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,MAAM,EAAE,IAAA,6BAAU,EAAC,GAAG,CAAY;CACnC,CAAC;AAEF,kBAAe,cAAc,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vroskus/library-history",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "History",
   "author": "Vilius Roškus <vilius@regattas.eu>",
   "license": "MIT",
@@ -9,9 +9,6 @@
     "url": "git+https://github.com/vroskus/library-history.git"
   },
   "main": "dist/index.js",
-  "files": [
-    "dist/index.js"
-  ],
   "scripts": {
     "postinstall": "npm run build",
     "build": "tsc",
@@ -20,23 +17,23 @@
     "test:e2e": "echo 'No tests'"
   },
   "dependencies": {
-    "@vroskus/library-types": "1.0.1",
+    "@vroskus/library-types": "1.0.3",
     "react": "18.2.0",
     "react-router-dom": "5.3.0"
   },
   "devDependencies": {
     "@types/jest": "29.5.0",
     "@types/node": "18.15.11",
-    "@types/react": "18.0.33",
-    "@typescript-eslint/eslint-plugin": "5.53.0",
-    "@typescript-eslint/parser": "5.53.0",
-    "eslint": "8.34.0",
+    "@types/react": "18.0.34",
+    "@typescript-eslint/eslint-plugin": "5.58.0",
+    "@typescript-eslint/parser": "5.58.0",
+    "eslint": "8.38.0",
     "eslint-config-airbnb-base": "15.0.0",
     "eslint-config-airbnb-typescript": "17.0.0",
     "eslint-plugin-import": "2.27.5",
     "eslint-plugin-import-newlines": "1.3.1",
     "eslint-plugin-react": "7.32.2",
-    "eslint-plugin-sort": "2.4.0",
+    "eslint-plugin-sort": "2.7.1",
     "npm-check": "6.0.1",
     "typescript": "4.9.5"
   }

package/src/index.ts

@@ -0,0 +1,82 @@
+/* eslint-disable class-methods-use-this */
+// Global Types
+import type {
+  $Component,
+  $Location,
+  $WebRouter,
+} from '@vroskus/library-types';
+
+import * as React from 'react';
+import {
+  withRouter,
+} from 'react-router-dom';
+
+// Types
+type $Listener = (location: $Location) => unknown;
+
+type $Props = $WebRouter;
+
+let globalHistory = null;
+const listeners: Array<$Listener> = [];
+
+class Spy extends React.Component<$Props> {
+  componentDidMount(): void {
+    this.trackHistoryChange();
+  }
+
+  componentDidUpdate(): void {
+    this.trackHistoryChange();
+  }
+
+  trackHistoryChange(): void {
+    const {
+      history,
+    } = this.props;
+
+    listeners.forEach((listener: $Listener) => {
+      listener(history.location);
+    });
+
+    globalHistory = history;
+  }
+
+  render(): null {
+    return null;
+  }
+}
+
+export type $RedirectParams = {
+  hash?: string;
+  pathname?: string;
+  search?: string;
+  state?: object;
+};
+export type $RedirectResponse = $RedirectParams;
+
+export type $HistoryService = {
+  readonly addListener: (listener: $Listener) => number;
+  readonly getCurrentPathname: () => string | null;
+  readonly redirect: (arg0: $RedirectParams) => $RedirectResponse;
+  readonly render: unknown;
+};
+
+const HistoryService: $HistoryService = {
+  addListener: (listener: $Listener) => listeners.push(listener),
+  getCurrentPathname: () => {
+    if (window && window.location) {
+      return window.location.pathname || null;
+    }
+
+    return null;
+  },
+  redirect: (params: $RedirectParams): $RedirectResponse => {
+    if (globalHistory) {
+      globalHistory.push(params);
+    }
+
+    return params;
+  },
+  render: withRouter(Spy) as unknown,
+};
+
+export default HistoryService;

package/tsconfig.json

@@ -0,0 +1,28 @@
+{
+  "compilerOptions": {
+    "outDir": "./dist/",
+    "types": ["node", "jest"],
+    "module": "commonjs",
+    "esModuleInterop": true,
+    "declaration": true,
+    "noImplicitAny": false,
+    "removeComments": true,
+    "noLib": false,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "target": "es6",
+    "sourceMap": true,
+    "lib": [
+      "dom",
+      "es6"
+    ],
+    "jsx": "react"
+  },
+  "exclude": [
+    "node_modules",
+    "./dist/**/*"
+  ],
+   "include": [
+    "./src"
+  ]
+}