@searchspring/snap-url-manager 0.20.0

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

@@ -0,0 +1,260 @@
+import { RangeValueProperties } from '../../types';
+import Immutable from 'seamless-immutable';
+export class QueryStringTranslator {
+    constructor(config = {}) {
+        this.config = Immutable({
+            urlRoot: typeof config.urlRoot == 'string' ? config.urlRoot.replace(/\/$/, '') : '',
+            queryParameter: typeof config.queryParameter == 'string' ? config.queryParameter : 'q',
+            ...config,
+        });
+    }
+    bindExternalEvents(update) {
+        window.addEventListener('popstate', update);
+    }
+    getCurrentUrl() {
+        return location.search || '';
+    }
+    getConfig() {
+        return this.config.asMutable();
+    }
+    parseQueryString(queryString) {
+        const justQueryString = queryString.split('?').pop() || '';
+        return justQueryString
+            .split('&')
+            .filter((v) => v)
+            .map((kvPair) => {
+            const [key, value] = kvPair.split('=').map((v) => decodeURIComponent(v.replace(/\+/g, ' ')));
+            return { key: key.split('.'), value };
+        });
+    }
+    generateQueryString(params) {
+        const paramString = params.length
+            ? '?' +
+                params
+                    .map((param) => {
+                    return encodeURIComponent(param.key.join('.')) + '=' + encodeURIComponent(param.value);
+                })
+                    .join('&')
+            : this.config.urlRoot
+                ? ''
+                : location.pathname;
+        return `${this.config.urlRoot}${paramString}`;
+    }
+    parsePage(queryParams) {
+        const pageParam = queryParams.find((param) => param.key.length == 1 && param.key[0] == 'page');
+        if (!pageParam) {
+            return {};
+        }
+        const page = Number(pageParam.value);
+        return !isNaN(page) && page > 1 ? { page } : {};
+    }
+    parseSort(queryParams) {
+        const sortParams = queryParams.filter((param) => param.key.length == 2 && param.key[0] == 'sort');
+        if (!sortParams.length) {
+            return {};
+        }
+        return {
+            sort: sortParams.map((param) => ({
+                field: param.key[1],
+                direction: param.value,
+            })),
+        };
+    }
+    parseOther(queryParams, except = []) {
+        const state = {};
+        queryParams
+            .filter((param) => except.indexOf(param.key[0]) == -1)
+            .forEach((param) => {
+            const path = param.key;
+            const value = param.value;
+            // eslint-disable-next-line prefer-const
+            let node = state;
+            path.forEach((key, i) => {
+                const 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;
+    }
+    parseQuery(queryParams) {
+        const qParamKey = this.getConfig().queryParameter;
+        const qParam = queryParams.find((param) => param.key.length == 1 && param.key[0] == qParamKey);
+        return qParam ? { query: qParam.value } : {};
+    }
+    parseFilter(queryParams) {
+        const valueFilterParams = queryParams.filter((p) => p.key.length == 2 && p.key[0] == 'filter');
+        const rangeFilterParams = queryParams.filter((p) => p.key.length == 3 && p.key[0] == 'filter');
+        const valueFilters = valueFilterParams.reduce((state, param) => {
+            const currentValue = (state.filter || {})[param.key[1]] || [];
+            return {
+                filter: {
+                    ...state.filter,
+                    [param.key[1]]: [...(Array.isArray(currentValue) ? currentValue : [currentValue]), param.value],
+                },
+            };
+        }, {});
+        const rangeFilters = rangeFilterParams.reduce((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)
+            let newState = state;
+            const nextRangeParam = rangeFilterParams[index + 1];
+            if (index % 2 == 0 &&
+                nextRangeParam &&
+                nextRangeParam.key[1] == param.key[1] &&
+                param.key[2] == RangeValueProperties.LOW &&
+                nextRangeParam.key[2] == RangeValueProperties.HIGH) {
+                const currentValue = (state.filter || {})[param.key[1]] || [];
+                newState = {
+                    filter: {
+                        ...state.filter,
+                        [param.key[1]]: [
+                            ...(Array.isArray(currentValue) ? currentValue : [currentValue]),
+                            {
+                                [RangeValueProperties.LOW]: +param.value || null,
+                                [RangeValueProperties.HIGH]: +nextRangeParam.value || null,
+                            },
+                        ],
+                    },
+                };
+            }
+            return newState;
+        }, {});
+        return {
+            ...(valueFilters.filter || rangeFilters.filter
+                ? {
+                    filter: {
+                        ...valueFilters.filter,
+                        ...rangeFilters.filter,
+                    },
+                }
+                : {}),
+        };
+    }
+    encodePage(state) {
+        if (!state.page || state.page === 1) {
+            return [];
+        }
+        return [{ key: ['page'], value: '' + state.page }];
+    }
+    encodeOther(state, except = []) {
+        let params = [];
+        const addRecursive = (obj, currentPath) => {
+            Object.keys(obj).forEach((key) => {
+                if (currentPath.length == 0 && except.indexOf(key) != -1) {
+                    return;
+                }
+                const value = obj[key];
+                if (value instanceof Array) {
+                    params = params.concat(value.map((v) => {
+                        return { key: [...currentPath, key], value: v };
+                    }));
+                }
+                else if (typeof value == 'object') {
+                    addRecursive(value, [...currentPath, key]);
+                }
+                else {
+                    params = params.concat([{ key: [...currentPath, key], value }]);
+                }
+            });
+        };
+        addRecursive(state, []);
+        return params;
+    }
+    encodeQuery(state) {
+        if (!state.query) {
+            return [];
+        }
+        return [
+            {
+                key: [this.getConfig().queryParameter],
+                value: state.query,
+            },
+        ];
+    }
+    encodeSort(state) {
+        if (!state.sort) {
+            return [];
+        }
+        return (state.sort instanceof Array ? state.sort : [state.sort]).map((sort) => {
+            return {
+                key: ['sort', sort.field],
+                value: sort.direction,
+            };
+        });
+    }
+    encodeFilter(state) {
+        if (!state.filter) {
+            return [];
+        }
+        return Object.keys(state.filter).flatMap((key) => {
+            if (!state.filter || !state.filter[key]) {
+                return [];
+            }
+            const filter = state.filter[key];
+            return (filter instanceof Array ? filter : [filter]).flatMap((value) => {
+                if (typeof value == 'string' || typeof value == 'number' || typeof value == 'boolean') {
+                    return [
+                        {
+                            key: ['filter', key],
+                            value: '' + value,
+                        },
+                    ];
+                }
+                else if (typeof value == 'object' &&
+                    typeof value[RangeValueProperties.LOW] != 'undefined' &&
+                    typeof value[RangeValueProperties.HIGH] != 'undefined') {
+                    return [
+                        {
+                            key: ['filter', key, RangeValueProperties.LOW],
+                            value: '' + (value[RangeValueProperties.LOW] ?? '*'),
+                        },
+                        {
+                            key: ['filter', key, RangeValueProperties.HIGH],
+                            value: '' + (value[RangeValueProperties.HIGH] ?? '*'),
+                        },
+                    ];
+                }
+                return [];
+            });
+        });
+    }
+    queryParamsToState(queryParams) {
+        // Todo: Special stage storage for sorts
+        return {
+            ...this.parseQuery(queryParams),
+            ...this.parsePage(queryParams),
+            ...this.parseFilter(queryParams),
+            ...this.parseSort(queryParams),
+            ...this.parseOther(queryParams, ['page', this.getConfig().queryParameter, 'filter', 'sort']),
+        };
+    }
+    stateToQueryParams(state = {}) {
+        return [
+            ...this.encodeQuery(state),
+            ...this.encodePage(state),
+            ...this.encodeFilter(state),
+            ...this.encodeSort(state),
+            ...this.encodeOther(state, ['page', 'query', 'filter', 'sort', this.getConfig().queryParameter]),
+        ];
+    }
+    serialize(state) {
+        const queryParams = this.stateToQueryParams(state);
+        return this.generateQueryString(queryParams);
+    }
+    deserialize(url) {
+        const queryString = url.includes('?') ? (url.split('?').pop() || '').split('#').shift() || '' : '';
+        const queryParams = this.parseQueryString(queryString);
+        return this.queryParamsToState(queryParams);
+    }
+    go(url) {
+        history.pushState(null, '', url);
+    }
+}

package/dist/esm/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/esm/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"}