@searchspring/snap-url-manager 0.20.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Searchspring
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,228 @@
+# Snap URL Manager
+
+
+The Snap URL manager is a service that provides customizable frontend URL management and a means to subscribe to the URL for changes. It's primary purpose is to provide a standard API to manage URL across Snap products.
+
+## Installation
+
+```sh
+npm install --save-dev @searchspring/url-manager
+```
+
+## Import
+
+```js
+import { UrlManager, UrlTranslator } from '@searchspring/url-manager';
+```
+
+## Instantiation
+
+The UrlManager class takes one parameter. This is the translator that manages your URL scheme, as well as rules for updating the URL. For now, we'll use the included translator that uses query strings and hash fragments and utilizes pushState to modify the URL in the browser.
+
+See [Translators](https://github.com/searchspring/snap/tree/main/packages/snap-url-manager/src/Translators) for more info.
+
+```js
+const urlManager = new UrlManager(new UrlTranslator());
+```
+
+Depending on the translator, the instantiated url manager will automatically start tracking from the browser URL.
+
+## Navigate to another location using transforms.
+
+Let's add a new parameter, `page=2`, to the browser's address bar.
+
+```js
+urlManager.merge({ page: 2 }).go();
+```
+
+In this example, we first created a new url manager with internal state that reflects `page=2` . Url managers are never directly modified, but when merging or setting parameters, a new url manager is created with a new state.
+
+We then updated the browser's address bar using `urlManager.go()` on the newly created url manager. Since the query string config translator is utilizing `location.pushState` behind the scenes,
+this is the mechanism behind which the browsers address bar is updated in this example.
+
+There are three functions to update one or more URL parameters: `set`, `merge` and `remove` . These functions are called transforms.
+
+When using `set`, other parameters will be clobbered and the URL will be set to exactly match the object passed in. All transforms can specify a path as the first parameter.
+
+Paths can be expressed in either of these formats:
+`'some.longer.path'` or `['some', 'longer', 'path']`
+
+Therefore, you can also accomplish this same transformation with the following:
+
+```js
+const newManager = urlManager.set('page', 2);
+```
+
+The page parameter can be removed with the following:
+
+```js
+const newManager = urlManager.remove('page');
+```
+
+Setting a value in a longer, nested path would look like this:
+
+```js
+const newManager = urlManager.set('facets.color', 'blue');
+```
+
+This will produce 1 value for `facets.color` and remove any others.
+
+For multiple values:
+
+```js
+const newManager = urlManager
+	.merge('facets.color', 'blue')
+	.merge('facets.color', 'red');
+```
+
+## `href` property
+
+You can access a url manager's href property at any time with
+
+```js
+urlManager.href;
+```
+
+## Many copies
+
+There may be cases where you want multiple URL states stored for various purposes. Since
+`set`, `merge`, and `remove` create modified copies, instances can be created and utilized from multiple sources. Snap `stores` already handle the process of attaching `UrlManager' instances where needed, for example for pagination, facets, sorting, etc... Here is an example of how creating them for a facet's individual values might look:
+
+```js
+const facetValuesWithUrls = (facet, facetValues) => {
+	return facetValues.map((facetValue) => {
+		return {
+			...facetValue,
+			url: urlManager.merge(['facet', facet.field], facetValue.value),
+		};
+	});
+};
+```
+
+Now, you can pass these as props to a Preact component:
+
+```js
+class FacetValue {
+	render({ facet, value }) {
+		return (
+			<li>
+				<a
+					href={ value.url.href }
+					onClick={(ev) => {
+						ev.preventDefault();
+
+						value.url.go();
+					}}
+				>
+					{value.label}
+				</a>
+			</li>
+		);
+	}
+}
+```
+
+Since the `UrlTranslator` is utilizing `pushState` it is important to prevent the default behavior as shown in the `onClick` above. Each translator can be instantiated with a `Linker` to make this even easier:
+
+```js
+import { UrlManager, UrlTranslator, reactLinker } from '@searchspring/snap-url-manager';
+const urlManager = new UrlManager(new UrlTranslator(), reactLinker);
+```
+
+```js
+class FacetValue {
+	render({ facet, value }) {
+		return (
+			<li>
+				<a {...value.url.link}>{value.label}</a>
+			</li>
+		);
+	}
+}
+```
+
+See [Linkers](https://github.com/searchspring/snap/tree/main/packages/snap-url-manager/src/linkers) for more info.
+
+## Subscribe to URL changes
+
+You can subscribe to URL changes like so:
+
+```js
+urlManager.subscribe((prev, next) => {
+	console.log(prev, next);
+});
+```
+
+This callback is executed any time one of the url manager's `go` function is called.
+
+The callback is passed two parameters: `prev` and `next`.
+
+`next` is the new state formed by a combination of the browsers URL, as well as any transformations done to the `urlManager` instance after it was either instantiated or copied using another urlManager's `copy` function.
+
+`prev` is the previous state from this urlManager instance.
+
+## Auto-synchronize with URL change
+
+Remember that url manager's internal state is never directly mutated, but instead, transforms return a fresh copy with a new
+state. However, the internal state is always a modification on the _current_ URL.
+
+Take the following example:
+
+```js
+const urlManager = new UrlManager(new UrlTranslator());
+
+const urlManagerWithColor = urlManager.merge('filter.color_family', 'blue');
+
+console.log(window.location.href); // https://try.searchspring.com?q=dress
+
+console.log(urlManager.href); // ?q=dress
+console.log(urlManagerWithColor.href); // ?q=dress#/filter:color_family:Blue
+```
+
+You can see that the href of `urlManager` matches the parameters of the page URL, while `urlManagerWithColor` has an additional parameter.
+
+Now let's navigate to a new URL using the `go` function and check the href's again:
+
+```js
+const urlManagerWithNewParam = urlManager.merge({ newParam: 'newValue' });
+
+urlManagerWithNewParam.go();
+console.log(window.location.href); // https://try.searchspring.com?q=dress#/newParam:newValue
+console.log(urlManager.href); // ?q=dress#/newParam:newValue
+console.log(urlManagerWithNewParam.href); // ?q=dress#/newParam:newValue
+
+console.log(urlManagerWithColor.href); // ?q=dress#/filter:color_family:Blue/newParam:newValue
+```
+
+As you can see, when calling `go()` all the URL managers were updated and know about the new URL parameter `newParam` while the internal
+state of `urlManagerWithColor` remains unmodified. This holds true for removals as well:
+
+```js
+const urlManagerWithColorButWithoutNewParam = urlManagerWithColor.remove('newParam');
+
+console.log(urlManager.href); // ?q=dress#/newParam:newValue
+console.log(urlManagerWithNewParam.href); // ?q=dress#/newParam:newValue
+
+console.log(urlManagerWithColor.href); // ?q=dress#/filter:color_family:Blue/newParam:newValuecolor=blue
+console.log(urlManagerWithColorButWithoutNewParam.href); // ?q=dress#/filter:color_family:Blue
+```
+
+**Note:** UrlManagers with different instantiations will not notify each other about URL updates. For example:
+
+```js
+const originalUrlManager = new UrlManager(new QueryStringTranslator());
+const secondaryUrlManager = originalUrlManager.set('foo', 'bar');
+
+const disconnectedUrlManager = new UrlManager(new QueryStringTranslator());
+
+originalUrlManager.set('example', '1').go();
+
+console.log(originalUrlManager.href); // ?example=1
+console.log(secondaryUrlManager.href); // ?example=1&foo=bar
+
+console.log(disconnectedUrlManager.href); // / (empty)
+```
+
+For performance reasons, the url managers do not contain watchers or otherwise poll for URL changes. Instead, they rely upon the copy mechanism behind the transform functions to notify each other of changes.
+
+Since a `UrlManager` internal state is immutable, you do not have to worry about unintended side effects. The only side effect is changes to the URL itself, which is intended!

package/dist/cjs/Translators/Noop/NoopTranslator.d.ts

@@ -0,0 +1,10 @@
+import { UrlState, Translator } from '../../types';
+export declare class NoopTranslator implements Translator {
+    private url;
+    getCurrentUrl(): string;
+    getConfig(): Record<string, unknown>;
+    serialize(state: UrlState): string;
+    deserialize(url: string): UrlState;
+    go(url: string): void;
+}
+//# sourceMappingURL=NoopTranslator.d.ts.map

package/dist/cjs/Translators/Noop/NoopTranslator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NoopTranslator.d.ts","sourceRoot":"","sources":["../../../../src/Translators/Noop/NoopTranslator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEnD,qBAAa,cAAe,YAAW,UAAU;IAChD,OAAO,CAAC,GAAG,CAAQ;IAEnB,aAAa,IAAI,MAAM;IAIvB,SAAS,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAIpC,SAAS,CAAC,KAAK,EAAE,QAAQ,GAAG,MAAM;IAIlC,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ;IAIlC,EAAE,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;CAGrB"}

package/dist/cjs/Translators/Noop/NoopTranslator.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NoopTranslator = void 0;
+var NoopTranslator = /** @class */ (function () {
+    function NoopTranslator() {
+        this.url = '{}';
+    }
+    NoopTranslator.prototype.getCurrentUrl = function () {
+        return this.url;
+    };
+    NoopTranslator.prototype.getConfig = function () {
+        return {};
+    };
+    NoopTranslator.prototype.serialize = function (state) {
+        return JSON.stringify(state);
+    };
+    NoopTranslator.prototype.deserialize = function (url) {
+        return JSON.parse(url);
+    };
+    NoopTranslator.prototype.go = function (url) {
+        this.url = url;
+    };
+    return NoopTranslator;
+}());
+exports.NoopTranslator = NoopTranslator;

package/dist/cjs/Translators/QueryString/QueryStringTranslator.d.ts

@@ -0,0 +1,35 @@
+import { UrlState, Translator, TranslatorConfig } from '../../types';
+declare type QueryParameter = {
+    key: Array<string>;
+    value: string;
+};
+declare type Config = {
+    queryParameter: string;
+    urlRoot: string;
+};
+export declare class QueryStringTranslator implements Translator {
+    private config;
+    constructor(config?: TranslatorConfig);
+    bindExternalEvents(update: () => void): void;
+    getCurrentUrl(): string;
+    getConfig(): Config;
+    protected parseQueryString(queryString: string): Array<QueryParameter>;
+    protected generateQueryString(params: Array<QueryParameter>): string;
+    protected parsePage(queryParams: Array<QueryParameter>): UrlState;
+    protected parseSort(queryParams: Array<QueryParameter>): UrlState;
+    protected parseOther(queryParams: Array<QueryParameter>, except?: Array<string>): UrlState;
+    protected parseQuery(queryParams: Array<QueryParameter>): UrlState;
+    protected parseFilter(queryParams: Array<QueryParameter>): UrlState;
+    protected encodePage(state: UrlState): Array<QueryParameter>;
+    protected encodeOther(state: UrlState, except?: Array<string>): Array<QueryParameter>;
+    protected encodeQuery(state: UrlState): Array<QueryParameter>;
+    protected encodeSort(state: UrlState): Array<QueryParameter>;
+    protected encodeFilter(state: UrlState): Array<QueryParameter>;
+    protected queryParamsToState(queryParams: Array<QueryParameter>): UrlState;
+    protected stateToQueryParams(state?: UrlState): Array<QueryParameter>;
+    serialize(state: UrlState): string;
+    deserialize(url: string): UrlState;
+    go(url: string): void;
+}
+export {};
+//# sourceMappingURL=QueryStringTranslator.d.ts.map

package/dist/cjs/Translators/QueryString/QueryStringTranslator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"QueryStringTranslator.d.ts","sourceRoot":"","sources":["../../../../src/Translators/QueryString/QueryStringTranslator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,gBAAgB,EAA4C,MAAM,aAAa,CAAC;AAK/G,aAAK,cAAc,GAAG;IACrB,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,aAAK,MAAM,GAAG;IACb,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,qBAAa,qBAAsB,YAAW,UAAU;IACvD,OAAO,CAAC,MAAM,CAA0B;gBAE5B,MAAM,GAAE,gBAAqB;IAQzC,kBAAkB,CAAC,MAAM,EAAE,MAAM,IAAI,GAAG,IAAI;IAI5C,aAAa,IAAI,MAAM;IAIvB,SAAS,IAAI,MAAM;IAInB,SAAS,CAAC,gBAAgB,CAAC,WAAW,EAAE,MAAM,GAAG,KAAK,CAAC,cAAc,CAAC;IAYtE,SAAS,CAAC,mBAAmB,CAAC,MAAM,EAAE,KAAK,CAAC,cAAc,CAAC,GAAG,MAAM;IAepE,SAAS,CAAC,SAAS,CAAC,WAAW,EAAE,KAAK,CAAC,cAAc,CAAC,GAAG,QAAQ;IAYjE,SAAS,CAAC,SAAS,CAAC,WAAW,EAAE,KAAK,CAAC,cAAc,CAAC,GAAG,QAAQ;IAejE,SAAS,CAAC,UAAU,CAAC,WAAW,EAAE,KAAK,CAAC,cAAc,CAAC,EAAE,MAAM,GAAE,KAAK,CAAC,MAAM,CAAM,GAAG,QAAQ;IA4B9F,SAAS,CAAC,UAAU,CAAC,WAAW,EAAE,KAAK,CAAC,cAAc,CAAC,GAAG,QAAQ;IAQlE,SAAS,CAAC,WAAW,CAAC,WAAW,EAAE,KAAK,CAAC,cAAc,CAAC,GAAG,QAAQ;IA2DnE,SAAS,CAAC,UAAU,CAAC,KAAK,EAAE,QAAQ,GAAG,KAAK,CAAC,cAAc,CAAC;IAQ5D,SAAS,CAAC,WAAW,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,GAAE,KAAK,CAAC,MAAM,CAAM,GAAG,KAAK,CAAC,cAAc,CAAC;IA6BzF,SAAS,CAAC,WAAW,CAAC,KAAK,EAAE,QAAQ,GAAG,KAAK,CAAC,cAAc,CAAC;IAa7D,SAAS,CAAC,UAAU,CAAC,KAAK,EAAE,QAAQ,GAAG,KAAK,CAAC,cAAc,CAAC;IAa5D,SAAS,CAAC,YAAY,CAAC,KAAK,EAAE,QAAQ,GAAG,KAAK,CAAC,cAAc,CAAC;IA0C9D,SAAS,CAAC,kBAAkB,CAAC,WAAW,EAAE,KAAK,CAAC,cAAc,CAAC,GAAG,QAAQ;IAW1E,SAAS,CAAC,kBAAkB,CAAC,KAAK,GAAE,QAAa,GAAG,KAAK,CAAC,cAAc,CAAC;IAUzE,SAAS,CAAC,KAAK,EAAE,QAAQ,GAAG,MAAM;IAMlC,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ;IAQlC,EAAE,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;CAGrB"}

package/dist/cjs/Translators/QueryString/QueryStringTranslator.js

@@ -0,0 +1,267 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QueryStringTranslator = void 0;
+var types_1 = require("../../types");
+var seamless_immutable_1 = __importDefault(require("seamless-immutable"));
+var QueryStringTranslator = /** @class */ (function () {
+    function QueryStringTranslator(config) {
+        if (config === void 0) { config = {}; }
+        this.config = (0, seamless_immutable_1.default)(__assign({ urlRoot: typeof config.urlRoot == 'string' ? config.urlRoot.replace(/\/$/, '') : '', queryParameter: typeof config.queryParameter == 'string' ? config.queryParameter : 'q' }, config));
+    }
+    QueryStringTranslator.prototype.bindExternalEvents = function (update) {
+        window.addEventListener('popstate', update);
+    };
+    QueryStringTranslator.prototype.getCurrentUrl = function () {
+        return location.search || '';
+    };
+    QueryStringTranslator.prototype.getConfig = function () {
+        return this.config.asMutable();
+    };
+    QueryStringTranslator.prototype.parseQueryString = function (queryString) {
+        var justQueryString = queryString.split('?').pop() || '';
+        return justQueryString
+            .split('&')
+            .filter(function (v) { return v; })
+            .map(function (kvPair) {
+            var _a = kvPair.split('=').map(function (v) { return decodeURIComponent(v.replace(/\+/g, ' ')); }), key = _a[0], value = _a[1];
+            return { key: key.split('.'), value: value };
+        });
+    };
+    QueryStringTranslator.prototype.generateQueryString = function (params) {
+        var paramString = params.length
+            ? '?' +
+                params
+                    .map(function (param) {
+                    return encodeURIComponent(param.key.join('.')) + '=' + encodeURIComponent(param.value);
+                })
+                    .join('&')
+            : this.config.urlRoot
+                ? ''
+                : location.pathname;
+        return "".concat(this.config.urlRoot).concat(paramString);
+    };
+    QueryStringTranslator.prototype.parsePage = function (queryParams) {
+        var pageParam = queryParams.find(function (param) { return param.key.length == 1 && param.key[0] == 'page'; });
+        if (!pageParam) {
+            return {};
+        }
+        var page = Number(pageParam.value);
+        return !isNaN(page) && page > 1 ? { page: page } : {};
+    };
+    QueryStringTranslator.prototype.parseSort = function (queryParams) {
+        var sortParams = queryParams.filter(function (param) { return param.key.length == 2 && param.key[0] == 'sort'; });
+        if (!sortParams.length) {
+            return {};
+        }
+        return {
+            sort: sortParams.map(function (param) { return ({
+                field: param.key[1],
+                direction: param.value,
+            }); }),
+        };
+    };
+    QueryStringTranslator.prototype.parseOther = function (queryParams, except) {
+        if (except === void 0) { except = []; }
+        var state = {};
+        queryParams
+            .filter(function (param) { return except.indexOf(param.key[0]) == -1; })
+            .forEach(function (param) {
+            var path = param.key;
+            var value = param.value;
+            // eslint-disable-next-line prefer-const
+            var node = state;
+            path.forEach(function (key, i) {
+                var isLast = i == path.length - 1;
+                if (isLast) {
+                    node[key] = node[key] || [];
+                    node[key].push(value);
+                }
+                else {
+                    node[key] = node[key] || {};
+                    node = node[key];
+                }
+            });
+        });
+        return state;
+    };
+    QueryStringTranslator.prototype.parseQuery = function (queryParams) {
+        var qParamKey = this.getConfig().queryParameter;
+        var qParam = queryParams.find(function (param) { return param.key.length == 1 && param.key[0] == qParamKey; });
+        return qParam ? { query: qParam.value } : {};
+    };
+    QueryStringTranslator.prototype.parseFilter = function (queryParams) {
+        var valueFilterParams = queryParams.filter(function (p) { return p.key.length == 2 && p.key[0] == 'filter'; });
+        var rangeFilterParams = queryParams.filter(function (p) { return p.key.length == 3 && p.key[0] == 'filter'; });
+        var valueFilters = valueFilterParams.reduce(function (state, param) {
+            var _a;
+            var currentValue = (state.filter || {})[param.key[1]] || [];
+            return {
+                filter: __assign(__assign({}, state.filter), (_a = {}, _a[param.key[1]] = __spreadArray(__spreadArray([], (Array.isArray(currentValue) ? currentValue : [currentValue]), true), [param.value], false), _a)),
+            };
+        }, {});
+        var rangeFilters = rangeFilterParams.reduce(function (state, param, index) {
+            // ranges should come in pairs!
+            // use index to build pairs, ignore non pairs
+            // build set as encountered - only return full sets (low + high)
+            var _a, _b;
+            var newState = state;
+            var nextRangeParam = rangeFilterParams[index + 1];
+            if (index % 2 == 0 &&
+                nextRangeParam &&
+                nextRangeParam.key[1] == param.key[1] &&
+                param.key[2] == types_1.RangeValueProperties.LOW &&
+                nextRangeParam.key[2] == types_1.RangeValueProperties.HIGH) {
+                var currentValue = (state.filter || {})[param.key[1]] || [];
+                newState = {
+                    filter: __assign(__assign({}, state.filter), (_a = {}, _a[param.key[1]] = __spreadArray(__spreadArray([], (Array.isArray(currentValue) ? currentValue : [currentValue]), true), [
+                        (_b = {},
+                            _b[types_1.RangeValueProperties.LOW] = +param.value || null,
+                            _b[types_1.RangeValueProperties.HIGH] = +nextRangeParam.value || null,
+                            _b),
+                    ], false), _a)),
+                };
+            }
+            return newState;
+        }, {});
+        return __assign({}, (valueFilters.filter || rangeFilters.filter
+            ? {
+                filter: __assign(__assign({}, valueFilters.filter), rangeFilters.filter),
+            }
+            : {}));
+    };
+    QueryStringTranslator.prototype.encodePage = function (state) {
+        if (!state.page || state.page === 1) {
+            return [];
+        }
+        return [{ key: ['page'], value: '' + state.page }];
+    };
+    QueryStringTranslator.prototype.encodeOther = function (state, except) {
+        if (except === void 0) { except = []; }
+        var params = [];
+        var addRecursive = function (obj, currentPath) {
+            Object.keys(obj).forEach(function (key) {
+                if (currentPath.length == 0 && except.indexOf(key) != -1) {
+                    return;
+                }
+                var value = obj[key];
+                if (value instanceof Array) {
+                    params = params.concat(value.map(function (v) {
+                        return { key: __spreadArray(__spreadArray([], currentPath, true), [key], false), value: v };
+                    }));
+                }
+                else if (typeof value == 'object') {
+                    addRecursive(value, __spreadArray(__spreadArray([], currentPath, true), [key], false));
+                }
+                else {
+                    params = params.concat([{ key: __spreadArray(__spreadArray([], currentPath, true), [key], false), value: value }]);
+                }
+            });
+        };
+        addRecursive(state, []);
+        return params;
+    };
+    QueryStringTranslator.prototype.encodeQuery = function (state) {
+        if (!state.query) {
+            return [];
+        }
+        return [
+            {
+                key: [this.getConfig().queryParameter],
+                value: state.query,
+            },
+        ];
+    };
+    QueryStringTranslator.prototype.encodeSort = function (state) {
+        if (!state.sort) {
+            return [];
+        }
+        return (state.sort instanceof Array ? state.sort : [state.sort]).map(function (sort) {
+            return {
+                key: ['sort', sort.field],
+                value: sort.direction,
+            };
+        });
+    };
+    QueryStringTranslator.prototype.encodeFilter = function (state) {
+        if (!state.filter) {
+            return [];
+        }
+        return Object.keys(state.filter).flatMap(function (key) {
+            if (!state.filter || !state.filter[key]) {
+                return [];
+            }
+            var filter = state.filter[key];
+            return (filter instanceof Array ? filter : [filter]).flatMap(function (value) {
+                var _a, _b;
+                if (typeof value == 'string' || typeof value == 'number' || typeof value == 'boolean') {
+                    return [
+                        {
+                            key: ['filter', key],
+                            value: '' + value,
+                        },
+                    ];
+                }
+                else if (typeof value == 'object' &&
+                    typeof value[types_1.RangeValueProperties.LOW] != 'undefined' &&
+                    typeof value[types_1.RangeValueProperties.HIGH] != 'undefined') {
+                    return [
+                        {
+                            key: ['filter', key, types_1.RangeValueProperties.LOW],
+                            value: '' + ((_a = value[types_1.RangeValueProperties.LOW]) !== null && _a !== void 0 ? _a : '*'),
+                        },
+                        {
+                            key: ['filter', key, types_1.RangeValueProperties.HIGH],
+                            value: '' + ((_b = value[types_1.RangeValueProperties.HIGH]) !== null && _b !== void 0 ? _b : '*'),
+                        },
+                    ];
+                }
+                return [];
+            });
+        });
+    };
+    QueryStringTranslator.prototype.queryParamsToState = function (queryParams) {
+        // Todo: Special stage storage for sorts
+        return __assign(__assign(__assign(__assign(__assign({}, this.parseQuery(queryParams)), this.parsePage(queryParams)), this.parseFilter(queryParams)), this.parseSort(queryParams)), this.parseOther(queryParams, ['page', this.getConfig().queryParameter, 'filter', 'sort']));
+    };
+    QueryStringTranslator.prototype.stateToQueryParams = function (state) {
+        if (state === void 0) { state = {}; }
+        return __spreadArray(__spreadArray(__spreadArray(__spreadArray(__spreadArray([], this.encodeQuery(state), true), this.encodePage(state), true), this.encodeFilter(state), true), this.encodeSort(state), true), this.encodeOther(state, ['page', 'query', 'filter', 'sort', this.getConfig().queryParameter]), true);
+    };
+    QueryStringTranslator.prototype.serialize = function (state) {
+        var queryParams = this.stateToQueryParams(state);
+        return this.generateQueryString(queryParams);
+    };
+    QueryStringTranslator.prototype.deserialize = function (url) {
+        var queryString = url.includes('?') ? (url.split('?').pop() || '').split('#').shift() || '' : '';
+        var queryParams = this.parseQueryString(queryString);
+        return this.queryParamsToState(queryParams);
+    };
+    QueryStringTranslator.prototype.go = function (url) {
+        history.pushState(null, '', url);
+    };
+    return QueryStringTranslator;
+}());
+exports.QueryStringTranslator = QueryStringTranslator;

package/dist/cjs/Translators/Url/UrlTranslator.d.ts

@@ -0,0 +1,67 @@
+import { UrlState, Translator, ParamLocationType } from '../../types';
+declare type UrlParameter = {
+    key: Array<string>;
+    value: string;
+    type: ParamLocationType;
+};
+declare type MapOptions = {
+    name?: string;
+    type?: ParamLocationType;
+};
+declare type CoreMap = {
+    query?: MapOptions;
+    oq?: MapOptions;
+    rq?: MapOptions;
+    tag?: MapOptions;
+    page?: MapOptions;
+    pageSize?: MapOptions;
+    sort?: MapOptions;
+    filter?: MapOptions;
+};
+declare type CustomMap = {
+    [param: string]: {
+        type?: ParamLocationType;
+    };
+};
+export declare type UrlTranslatorParametersConfig = {
+    core?: CoreMap;
+    custom?: CustomMap;
+};
+export declare type UrlTranslatorConfig = {
+    urlRoot?: string;
+    settings?: {
+        corePrefix?: string;
+        coreType?: ParamLocationType;
+        customType?: ParamLocationType;
+        rootParams?: boolean;
+    };
+    parameters?: UrlTranslatorParametersConfig;
+};
+export declare class UrlTranslator implements Translator {
+    private config;
+    private reverseMapping;
+    constructor(config?: UrlTranslatorConfig);
+    bindExternalEvents(update: () => void): void;
+    getCurrentUrl(): string;
+    getConfig(): UrlTranslatorConfig;
+    deserialize(url: string): UrlState;
+    protected parseUrlParams(url: string): Array<UrlParameter>;
+    protected parseQueryString(queryString: string): Array<UrlParameter>;
+    protected parseHashString(hashString: string): Array<UrlParameter>;
+    protected paramsToState(params: Array<UrlParameter>): UrlState;
+    protected parseCoreOther(otherParams: Array<UrlParameter>): UrlState;
+    protected parseCoreFilter(filterParams: Array<UrlParameter>): UrlState;
+    protected parseCoreSort(sortParams: Array<UrlParameter>): UrlState;
+    protected parseOther(otherParams: Array<UrlParameter>): UrlState;
+    serialize(state: UrlState): string;
+    protected stateToParams(state: UrlState): Array<UrlParameter>;
+    protected encodeCoreFilters(state: UrlState): Array<UrlParameter>;
+    protected encodeCoreSorts(state: UrlState): Array<UrlParameter>;
+    protected encodeCoreOther(state: UrlState, except: string[]): Array<UrlParameter>;
+    protected encodeOther(state: UrlState): Array<UrlParameter>;
+    go(url: string, config?: {
+        history: string;
+    }): void;
+}
+export {};
+//# sourceMappingURL=UrlTranslator.d.ts.map

package/dist/cjs/Translators/Url/UrlTranslator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UrlTranslator.d.ts","sourceRoot":"","sources":["../../../../src/Translators/Url/UrlTranslator.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,UAAU,EAA0D,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAE9H,aAAK,YAAY,GAAG;IACnB,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,iBAAiB,CAAC;CACxB,CAAC;AAEF,aAAK,UAAU,GAAG;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,iBAAiB,CAAC;CACzB,CAAC;AAEF,aAAK,OAAO,GAAG;IACd,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB,EAAE,CAAC,EAAE,UAAU,CAAC;IAChB,EAAE,CAAC,EAAE,UAAU,CAAC;IAChB,GAAG,CAAC,EAAE,UAAU,CAAC;IACjB,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,QAAQ,CAAC,EAAE,UAAU,CAAC;IACtB,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,MAAM,CAAC,EAAE,UAAU,CAAC;CACpB,CAAC;AAEF,aAAK,SAAS,GAAG;IAChB,CAAC,KAAK,EAAE,MAAM,GAAG;QAChB,IAAI,CAAC,EAAE,iBAAiB,CAAC;KACzB,CAAC;CACF,CAAC;AAEF,oBAAY,6BAA6B,GAAG;IAC3C,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,MAAM,CAAC,EAAE,SAAS,CAAC;CACnB,CAAC;AAEF,oBAAY,mBAAmB,GAAG;IACjC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE;QACV,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,QAAQ,CAAC,EAAE,iBAAiB,CAAC;QAC7B,UAAU,CAAC,EAAE,iBAAiB,CAAC;QAC/B,UAAU,CAAC,EAAE,OAAO,CAAC;KACrB,CAAC;IACF,UAAU,CAAC,EAAE,6BAA6B,CAAC;CAC3C,CAAC;AA0BF,qBAAa,aAAc,YAAW,UAAU;IAC/C,OAAO,CAAC,MAAM,CAAsB;IACpC,OAAO,CAAC,cAAc,CAA8B;gBAExC,MAAM,GAAE,mBAAwB;IA0B5C,kBAAkB,CAAC,MAAM,EAAE,MAAM,IAAI,GAAG,IAAI;IAI5C,aAAa,IAAI,MAAM;IAIvB,SAAS,IAAI,mBAAmB;IAIhC,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ;IAMlC,SAAS,CAAC,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,CAAC,YAAY,CAAC;IAO1D,SAAS,CAAC,gBAAgB,CAAC,WAAW,EAAE,MAAM,GAAG,KAAK,CAAC,YAAY,CAAC;IAiBpE,SAAS,CAAC,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,KAAK,CAAC,YAAY,CAAC;IAkClE,SAAS,CAAC,aAAa,CAAC,MAAM,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,QAAQ;IAgD9D,SAAS,CAAC,cAAc,CAAC,WAAW,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,QAAQ;IA0BpE,SAAS,CAAC,eAAe,CAAC,YAAY,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,QAAQ;IA2DtE,SAAS,CAAC,aAAa,CAAC,UAAU,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,QAAQ;IAalE,SAAS,CAAC,UAAU,CAAC,WAAW,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,QAAQ;IAsBhE,SAAS,CAAC,KAAK,EAAE,QAAQ,GAAG,MAAM;IA0ClC,SAAS,CAAC,aAAa,CAAC,KAAK,EAAE,QAAQ,GAAG,KAAK,CAAC,YAAY,CAAC;IAS7D,SAAS,CAAC,iBAAiB,CAAC,KAAK,EAAE,QAAQ,GAAG,KAAK,CAAC,YAAY,CAAC;IAyDjE,SAAS,CAAC,eAAe,CAAC,KAAK,EAAE,QAAQ,GAAG,KAAK,CAAC,YAAY,CAAC;IAgB/D,SAAS,CAAC,eAAe,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC,YAAY,CAAC;IAsBjF,SAAS,CAAC,WAAW,CAAC,KAAK,EAAE,QAAQ,GAAG,KAAK,CAAC,YAAY,CAAC;IAwC3D,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI;CAUnD"}