@koine/browser 2.0.0-beta.21 → 2.0.0-beta.211

package/README.md

@@ -0,0 +1 @@
+# @koine/i18n

package/createStorage.cjs.default.js

@@ -0,0 +1 @@
+exports._default = require('./createStorage.cjs.js').default;

package/createStorage.cjs.js

@@ -0,0 +1,12 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var utils = require('@koine/utils');
+var dom = require('@koine/dom');
+var storage = require('./storage.cjs.js');
+
+let createStorage=(a,n)=>{let c=n?storage.storage.s:storage.storage.l,m=Object.keys(a).reduce((e,o)=>({...e,[o]:utils.encode(o)}),{});return {get:(t,o)=>c.get(m[t],utils.decode,o),getAll(e){if(!utils.isBrowser)return "development"===process.env.NODE_ENV&&console.log("[@koine/utils:createStorage] attempt to use 'getAll' outside of browser."),{};let t={};for(let o in m){let s=this.get(o),l=e?.[o];utils.isNullOrUndefined(s)?l&&(t[o]=l):t[o]=s;}return t},set(e,o){c.set(m[e],o,utils.encode);},setMany(e){if("development"!==process.env.NODE_ENV||utils.isBrowser||console.log("[@koine/utils:createStorage] attempt to use 'setMany' outside of browser."),utils.isBrowser)for(let t in e){let o=e[t];utils.isNullOrUndefined(o)?this.remove(t):this.set(t,o);}},has:e=>c.has(m[e]),remove(e){c.remove(m[e]);},clear(){if("development"!==process.env.NODE_ENV||utils.isBrowser||console.log("[@koine/utils:createStorage] attempt to use 'clear' outside of browser."),utils.isBrowser)for(let e in m)c.remove(m[e]);},watch:(e,t,r)=>utils.isBrowser?dom.on(window,"storage",o=>{let{key:s,oldValue:l,newValue:i}=o;s===m[e]&&(l&&!i?t?.():!l&&i&&r?.());}):("development"===process.env.NODE_ENV&&console.log("[@koine/utils:createStorage] attempt to use 'watch' outside of browser."),utils.noop)}};
+
+exports.createStorage = createStorage;
+exports.default = createStorage;

package/createStorage.cjs.mjs

@@ -0,0 +1,2 @@
+export * from './createStorage.cjs.js';
+export { _default as default } from './createStorage.cjs.default.js';

package/createStorage.d.ts

@@ -1,12 +1,59 @@
+/**
+ * @category storage
+ */
 export type CreateStorageConfig = Record<string, any>;
-export declare const createStorage: <T extends CreateStorageConfig>(config: Partial<T>, useSessionStorage?: boolean) => {
-    get<TKey extends Extract<keyof T, string>>(key: TKey, defaultValue?: T[TKey] | null | undefined): T[TKey] | null;
-    getAll(defaultValues?: Partial<T> | undefined): T;
-    set<TKey_1 extends Extract<keyof T, string>>(key: TKey_1, value?: T[TKey_1] | undefined): void;
+/**
+ * Utility to create a storage instance to interact with `localStorage` using
+ * encrypted (encoded) key/values.
+ *
+ * @category storage
+ */
+export declare let createStorage: <T extends CreateStorageConfig>(config: Partial<T>, useSessionStorage?: boolean) => {
+    /**
+     * Get all storage value (it uses `localStorage.get()`).
+     *
+     * Unparseable values with `JSON.parse()` return their value as it is.
+     * On ssr or if the given `key` argument is not found `defaultValue` is
+     * returned, otherwise `null`.
+     */
+    get<TKey extends Extract<keyof T, string>>(key: TKey, defaultValue?: null | T[TKey]): T[TKey] | null;
+    /**
+     * Get all storage values (it uses `localStorage.get()`).
+     *
+     * `undefined` and `null` values are not returned.
+     */
+    getAll(defaultValues?: Partial<T>): T;
+    /**
+     * Set a storage value (it uses `localStorage.set()`).
+     *
+     * Non-string values are stringified with `JSON.stringify()`
+     */
+    set<TKey extends Extract<keyof T, string>>(key: TKey, value?: T[TKey]): void;
+    /**
+     * Set all given storage values (it uses `localStorage.set()`).
+     *
+     * Non-string values are stringified with `JSON.stringify()`, `undefined`
+     * and `null` values are removed from the storage
+     */
     setMany(newValues: Partial<T>): void;
-    has<TKey_2 extends Extract<keyof T, string>>(key: TKey_2): any;
-    remove<TKey_3 extends Extract<keyof T, string>>(key: TKey_3): void;
+    /**
+     * Check if a storage value is _truthy_ (it uses `localStorage.get()`).
+     */
+    has<TKey extends Extract<keyof T, string>>(key: TKey): any;
+    /**
+     * Remove a storage value (it uses `localStorage.remove()`).
+     */
+    remove<TKey extends Extract<keyof T, string>>(key: TKey): void;
+    /**
+     * Clear all storage values (it uses `localStorage.remove()`).
+     */
     clear(): void;
-    watch: <TKey_4 extends keyof T>(keyToWatch: TKey_4, onRemoved?: () => void, onAdded?: () => void) => () => void | undefined;
+    /**
+     * Watch a storage value changes, this needs to be executed only in browser
+     * context (it uses `window.addEventListener("storage")`).
+     *
+     * Inspiration from [Multi Tab Logout in React — Redux](https://medium.com/front-end-weekly/multi-tab-logout-in-react-redux-4715f071c7fa)
+     */
+    watch: <TKey extends keyof T>(keyToWatch: TKey, onRemoved?: () => void, onAdded?: () => void) => () => void | undefined;
 };
 export default createStorage;

package/createStorage.esm.js

@@ -0,0 +1,7 @@
+import { encode, noop, isBrowser, isNullOrUndefined, decode } from '@koine/utils';
+import { on } from '@koine/dom';
+import { storage } from './storage.esm.js';
+
+let createStorage=(a,n)=>{let c=n?storage.s:storage.l,m=Object.keys(a).reduce((e,o)=>({...e,[o]:encode(o)}),{});return {get:(t,o)=>c.get(m[t],decode,o),getAll(e){if(!isBrowser)return "development"===process.env.NODE_ENV&&console.log("[@koine/utils:createStorage] attempt to use 'getAll' outside of browser."),{};let t={};for(let o in m){let s=this.get(o),l=e?.[o];isNullOrUndefined(s)?l&&(t[o]=l):t[o]=s;}return t},set(e,o){c.set(m[e],o,encode);},setMany(e){if("development"!==process.env.NODE_ENV||isBrowser||console.log("[@koine/utils:createStorage] attempt to use 'setMany' outside of browser."),isBrowser)for(let t in e){let o=e[t];isNullOrUndefined(o)?this.remove(t):this.set(t,o);}},has:e=>c.has(m[e]),remove(e){c.remove(m[e]);},clear(){if("development"!==process.env.NODE_ENV||isBrowser||console.log("[@koine/utils:createStorage] attempt to use 'clear' outside of browser."),isBrowser)for(let e in m)c.remove(m[e]);},watch:(e,t,r)=>isBrowser?on(window,"storage",o=>{let{key:s,oldValue:l,newValue:i}=o;s===m[e]&&(l&&!i?t?.():!l&&i&&r?.());}):("development"===process.env.NODE_ENV&&console.log("[@koine/utils:createStorage] attempt to use 'watch' outside of browser."),noop)}};
+
+export { createStorage, createStorage as default };

package/getZonedDate.cjs.default.js

@@ -0,0 +1 @@
+exports._default = require('./getZonedDate.cjs.js').default;

package/getZonedDate.cjs.js

@@ -0,0 +1,11 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var dateFnsTz = require('date-fns-tz');
+var utils = require('@koine/utils');
+
+let getZonedDate=(o="",n)=>{if(o.endsWith("Z")||(o+="Z"),!n&&utils.isBrowser)try{n=Intl.DateTimeFormat().resolvedOptions().timeZone;}catch(e){"development"===process.env.NODE_ENV&&console.warn("[@koine/browser:getZonedDate] failed reading timeZone, error",e);}return n?dateFnsTz.toZonedTime(new Date(o),n):new Date(o)};
+
+exports.default = getZonedDate;
+exports.getZonedDate = getZonedDate;

package/getZonedDate.cjs.mjs

@@ -0,0 +1,2 @@
+export * from './getZonedDate.cjs.js';
+export { _default as default } from './getZonedDate.cjs.default.js';

package/getZonedDate.d.ts

@@ -1,2 +1,16 @@
-export declare function getZonedDate(dateString?: string, timeZone?: string): Date;
+/**
+ * It returns a `Date` object from a date `string` adjusted on the user timeZone,
+ * if a timeZone is not provided we try getting it from the `Intl` browwser native
+ * API. It gracefully falls back returning a _non-timezone-based_ `Date`.
+ *
+ * @category date
+ *
+ * @resources
+ * - to get the timeZone client side see [this article](https://attacomsian.com/blog/javascript-current-timezone)
+ * - for converting the date based on the time zone [date-fns docs](https://date-fns.org/v2.27.0/docs/Time-Zones) and [date-fns-tz docs](https://github.com/marnusw/date-fns-tz)
+ *
+ * @param dateString A parseable date as string, `Z` is automatically suffixed if not present to correctly get time zone based time from a UTC date.
+ * @param timeZone Optionally pass a timeZone (e.g. from user preference or from the server), it falls back trying to read it from the `Intl` browwser native API.
+ */
+export declare let getZonedDate: (dateString?: string, timeZone?: string) => Date;
 export default getZonedDate;

package/getZonedDate.esm.js

@@ -0,0 +1,6 @@
+import { toZonedTime } from 'date-fns-tz';
+import { isBrowser } from '@koine/utils';
+
+let getZonedDate=(o="",n)=>{if(o.endsWith("Z")||(o+="Z"),!n&&isBrowser)try{n=Intl.DateTimeFormat().resolvedOptions().timeZone;}catch(e){"development"===process.env.NODE_ENV&&console.warn("[@koine/browser:getZonedDate] failed reading timeZone, error",e);}return n?toZonedTime(new Date(o),n):new Date(o)};
+
+export { getZonedDate as default, getZonedDate };

package/gtag.cjs.default.js

@@ -0,0 +1 @@
+exports._default = require('./gtag.cjs.js').default;

package/gtag.cjs.js

@@ -0,0 +1,10 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var utils = require('@koine/utils');
+
+let gtag=(...o)=>{utils.isUndefined(window)||utils.isUndefined(window.gtag)?utils.noop():window.gtag(...o);};
+
+exports.default = gtag;
+exports.gtag = gtag;

package/gtag.cjs.mjs

@@ -0,0 +1,2 @@
+export * from './gtag.cjs.js';
+export { _default as default } from './gtag.cjs.default.js';

package/gtag.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @category analytics-google
+ *
+ * If you like you could add to your globals `.d.ts` types:
+ *
+ * ```ts
+ * declare interface Window {
+ *   gtag: <T extends unknown[]>(...args: T) => void;
+ * }
+ * ```
+ */
+export declare let gtag: <T extends unknown[]>(...args: T) => void;
+export default gtag;

package/gtag.esm.js

@@ -0,0 +1,5 @@
+import { isUndefined, noop } from '@koine/utils';
+
+let gtag=(...o)=>{isUndefined(window)||isUndefined(window.gtag)?noop():window.gtag(...o);};
+
+export { gtag as default, gtag };

package/gtagPageview.cjs.default.js

@@ -0,0 +1 @@
+exports._default = require('./gtagPageview.cjs.js').default;

package/gtagPageview.cjs.js

@@ -0,0 +1,10 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var gtag = require('./gtag.cjs.js');
+
+let gtagPageview=(...t)=>gtag.gtag("event","page_view",{page_path:t[0]||location.pathname,page_title:t[1]||document.title,page_location:t[2]||location.href});
+
+exports.default = gtagPageview;
+exports.gtagPageview = gtagPageview;

package/gtagPageview.cjs.mjs

@@ -0,0 +1,2 @@
+export * from './gtagPageview.cjs.js';
+export { _default as default } from './gtagPageview.cjs.default.js';

package/gtagPageview.d.ts

@@ -3,5 +3,8 @@ export type GtmPageviewArgs = [
     page_title?: string,
     page_location?: string
 ];
-export declare const gtagPageview: (page_path?: string | undefined, page_title?: string | undefined, page_location?: string | undefined) => void;
+/**
+ * @category analytics-google
+ */
+export declare let gtagPageview: (...args: GtmPageviewArgs) => void;
 export default gtagPageview;

package/gtagPageview.esm.js

@@ -0,0 +1,5 @@
+import { gtag } from './gtag.esm.js';
+
+let gtagPageview=(...t)=>gtag("event","page_view",{page_path:t[0]||location.pathname,page_title:t[1]||document.title,page_location:t[2]||location.href});
+
+export { gtagPageview as default, gtagPageview };

package/index.cjs.default.js

@@ -0,0 +1 @@
+exports._default = require('./index.cjs.js').default;

package/index.cjs.js

@@ -0,0 +1,43 @@
+'use strict';
+
+var createStorage = require('./createStorage.cjs.js');
+var getZonedDate = require('./getZonedDate.cjs.js');
+var gtag = require('./gtag.cjs.js');
+var gtagPageview = require('./gtagPageview.cjs.js');
+var isIE = require('./isIE.cjs.js');
+var isMobile = require('./isMobile.cjs.js');
+var isWindowInsideIframe = require('./isWindowInsideIframe.cjs.js');
+var listenUrlSearch = require('./listenUrlSearch.cjs.js');
+var listenUrlSearchParams = require('./listenUrlSearchParams.cjs.js');
+var navigateToHash = require('./navigateToHash.cjs.js');
+var navigateToHashParams = require('./navigateToHashParams.cjs.js');
+var navigateToMergedHashParams = require('./navigateToMergedHashParams.cjs.js');
+var navigateToMergedParams = require('./navigateToMergedParams.cjs.js');
+var navigateToParams = require('./navigateToParams.cjs.js');
+var navigateToUrl = require('./navigateToUrl.cjs.js');
+var navigateWithoutUrlParam = require('./navigateWithoutUrlParam.cjs.js');
+var storage = require('./storage.cjs.js');
+var redirectTo = require('./redirectTo.cjs.js');
+var storageClient = require('./storageClient.cjs.js');
+
+
+
+exports.createStorage = createStorage.createStorage;
+exports.getZonedDate = getZonedDate.getZonedDate;
+exports.gtag = gtag.gtag;
+exports.gtagPageview = gtagPageview.gtagPageview;
+exports.isIE = isIE.isIE;
+exports.isMobile = isMobile.isMobile;
+exports.isWindowInsideIframe = isWindowInsideIframe.isWindowInsideIframe;
+exports.listenUrlSearch = listenUrlSearch.listenUrlSearch;
+exports.listenUrlSearchParams = listenUrlSearchParams.listenUrlSearchParams;
+exports.navigateToHash = navigateToHash.navigateToHash;
+exports.navigateToHashParams = navigateToHashParams.navigateToHashParams;
+exports.navigateToMergedHashParams = navigateToMergedHashParams.navigateToMergedHashParams;
+exports.navigateToMergedParams = navigateToMergedParams.navigateToMergedParams;
+exports.navigateToParams = navigateToParams.navigateToParams;
+exports.navigateToUrl = navigateToUrl.navigateToUrl;
+exports.navigateWithoutUrlParam = navigateWithoutUrlParam.navigateWithoutUrlParam;
+exports.storage = storage.storage;
+exports.redirectTo = redirectTo.redirectTo;
+exports.storageClient = storageClient.storageClient;

package/index.cjs.mjs

@@ -0,0 +1,2 @@
+export * from './index.cjs.js';
+export { _default as default } from './index.cjs.default.js';

package/index.d.ts

@@ -1,17 +1,19 @@
-export { createStorage, type CreateStorageConfig } from "./createStorage.js";
-export { getZonedDate } from "./getZonedDate.js";
-export { gtagPageview, type GtmPageviewArgs } from "./gtagPageview.js";
-export { isIE } from "./isIE.js";
-export { isMobile } from "./isMobile.js";
-export { listenUrlSearch } from "./listenUrlSearch.js";
-export { listenUrlSearchParams } from "./listenUrlSearchParams.js";
-export { navigateToHash } from "./navigateToHash.js";
-export { navigateToHashParams } from "./navigateToHashParams.js";
-export { navigateToMergedHashParams } from "./navigateToMergedHashParams.js";
-export { navigateToMergedParams } from "./navigateToMergedParams.js";
-export { navigateToParams } from "./navigateToParams.js";
-export { navigateToUrl } from "./navigateToUrl.js";
-export { navigateWithoutUrlParam } from "./navigateWithoutUrlParam.js";
-export { redirectTo } from "./redirectTo.js";
-export { storage } from "./storage.js";
-export { storageClient, type StorageClientConfig } from "./storageClient.js";
+export { createStorage, type CreateStorageConfig } from "./createStorage";
+export { getZonedDate } from "./getZonedDate";
+export { gtag } from "./gtag";
+export { gtagPageview, type GtmPageviewArgs } from "./gtagPageview";
+export { isIE } from "./isIE";
+export { isMobile } from "./isMobile";
+export { isWindowInsideIframe } from "./isWindowInsideIframe";
+export { listenUrlSearch } from "./listenUrlSearch";
+export { listenUrlSearchParams } from "./listenUrlSearchParams";
+export { navigateToHash } from "./navigateToHash";
+export { navigateToHashParams } from "./navigateToHashParams";
+export { navigateToMergedHashParams } from "./navigateToMergedHashParams";
+export { navigateToMergedParams } from "./navigateToMergedParams";
+export { navigateToParams } from "./navigateToParams";
+export { navigateToUrl } from "./navigateToUrl";
+export { navigateWithoutUrlParam } from "./navigateWithoutUrlParam";
+export { storage } from "./storage";
+export { redirectTo } from "./redirectTo";
+export { storageClient, type StorageClientConfig } from "./storageClient";

package/index.esm.js

@@ -0,0 +1,19 @@
+export { createStorage } from './createStorage.esm.js';
+export { getZonedDate } from './getZonedDate.esm.js';
+export { gtag } from './gtag.esm.js';
+export { gtagPageview } from './gtagPageview.esm.js';
+export { isIE } from './isIE.esm.js';
+export { isMobile } from './isMobile.esm.js';
+export { isWindowInsideIframe } from './isWindowInsideIframe.esm.js';
+export { listenUrlSearch } from './listenUrlSearch.esm.js';
+export { listenUrlSearchParams } from './listenUrlSearchParams.esm.js';
+export { navigateToHash } from './navigateToHash.esm.js';
+export { navigateToHashParams } from './navigateToHashParams.esm.js';
+export { navigateToMergedHashParams } from './navigateToMergedHashParams.esm.js';
+export { navigateToMergedParams } from './navigateToMergedParams.esm.js';
+export { navigateToParams } from './navigateToParams.esm.js';
+export { navigateToUrl } from './navigateToUrl.esm.js';
+export { navigateWithoutUrlParam } from './navigateWithoutUrlParam.esm.js';
+export { storage } from './storage.esm.js';
+export { redirectTo } from './redirectTo.esm.js';
+export { storageClient } from './storageClient.esm.js';

package/isIE.cjs.default.js

@@ -0,0 +1 @@
+exports._default = require('./isIE.cjs.js').default;

package/isIE.cjs.js

@@ -0,0 +1,10 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var utils = require('@koine/utils');
+
+let isIE=(t=true)=>{if(utils.isServer)return t;let i=window.navigator.userAgent;return !!(i.indexOf("MSIE ")>0||i.indexOf("Trident/")>0)};
+
+exports.default = isIE;
+exports.isIE = isIE;

package/isIE.cjs.mjs

@@ -0,0 +1,2 @@
+export * from './isIE.cjs.js';
+export { _default as default } from './isIE.cjs.default.js';

package/isIE.d.ts

@@ -1,2 +1,7 @@
-export declare function isIE(ssrValue?: boolean): boolean;
+/**
+ * @category detect
+ * @category is
+ * @see https://stackoverflow.com/a/21712356/12285349
+ */
+export declare let isIE: (ssrValue?: boolean) => boolean;
 export default isIE;

package/isIE.esm.js

@@ -0,0 +1,5 @@
+import { isServer } from '@koine/utils';
+
+let isIE=(t=true)=>{if(isServer)return t;let i=window.navigator.userAgent;return !!(i.indexOf("MSIE ")>0||i.indexOf("Trident/")>0)};
+
+export { isIE as default, isIE };

package/isMobile.cjs.default.js

@@ -0,0 +1 @@
+exports._default = require('./isMobile.cjs.js').default;

package/isMobile.cjs.js

@@ -0,0 +1,10 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var utils = require('@koine/utils');
+
+let isMobile=(e=true)=>utils.isServer?e:/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(window.navigator.userAgent);
+
+exports.default = isMobile;
+exports.isMobile = isMobile;

package/isMobile.cjs.mjs

@@ -0,0 +1,2 @@
+export * from './isMobile.cjs.js';
+export { _default as default } from './isMobile.cjs.default.js';

package/isMobile.d.ts

@@ -1,2 +1,7 @@
-export declare function isMobile(ssrValue?: boolean): boolean;
+/**
+ * @category detect
+ * @category is
+ * @see https://stackoverflow.com/a/3540295
+ */
+export declare let isMobile: (ssrValue?: boolean) => boolean;
 export default isMobile;

package/isMobile.esm.js

@@ -0,0 +1,5 @@
+import { isServer } from '@koine/utils';
+
+let isMobile=(e=true)=>isServer?e:/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(window.navigator.userAgent);
+
+export { isMobile as default, isMobile };

package/isWindowInsideIframe.cjs.default.js

@@ -0,0 +1 @@
+exports._default = require('./isWindowInsideIframe.cjs.js').default;

package/isWindowInsideIframe.cjs.js

@@ -0,0 +1,8 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const isWindowInsideIframe=()=>window.self!==window.top;
+
+exports.default = isWindowInsideIframe;
+exports.isWindowInsideIframe = isWindowInsideIframe;

package/isWindowInsideIframe.cjs.mjs

@@ -0,0 +1,2 @@
+export * from './isWindowInsideIframe.cjs.js';
+export { _default as default } from './isWindowInsideIframe.cjs.default.js';

package/isWindowInsideIframe.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @borrows [SO's asnwer](https://stackoverflow.com/a/326076)
+ */
+export declare const isWindowInsideIframe: () => boolean;
+export default isWindowInsideIframe;

package/isWindowInsideIframe.esm.js

@@ -0,0 +1,3 @@
+const isWindowInsideIframe=()=>window.self!==window.top;
+
+export { isWindowInsideIframe as default, isWindowInsideIframe };

package/listenUrlSearch.cjs.default.js

@@ -0,0 +1 @@
+exports._default = require('./listenUrlSearch.cjs.js').default;

package/listenUrlSearch.cjs.js

@@ -0,0 +1,11 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var utils = require('@koine/utils');
+var dom = require('@koine/dom');
+
+let r=(t,e,r)=>function(...o){let i=t.apply(this,o);return e(),i},o=utils.isBrowser?location.search:"",i=()=>{let t=location.search;if(t!==o)for(let e of history.__.h.values())e(o,t);o=t;};let listenUrlSearch=t=>(history.__||(history.pushState=r(history.pushState,i),history.replaceState=r(history.replaceState,i),dom.on(window,"popstate",i),history.__={h:new Set}),history.__.h.has(t)||history.__.h.add(t),()=>{history.__.h.delete(t);});
+
+exports.default = listenUrlSearch;
+exports.listenUrlSearch = listenUrlSearch;

package/listenUrlSearch.cjs.mjs

@@ -0,0 +1,2 @@
+export * from './listenUrlSearch.cjs.js';
+export { _default as default } from './listenUrlSearch.cjs.default.js';

package/listenUrlSearch.d.ts

@@ -1,3 +1,30 @@
+type Extension = {
+    /**
+     * Flag that tells if `history` methods have been replaced
+     */
+    r?: boolean;
+    h: Set<Handler>;
+};
+/**
+ * @param prevLocationSearch The previous URL search query e.g. `?myparam=mvalue`
+ * @param newLocationSearch The previous URL search query e.g. `?myparam=mvalue`
+ */
 type Handler = (prevLocationSearch: string, newLocationSearch: string) => void;
-export declare function listenUrlSearch(handler: Handler): () => void;
+export type HistoryExtended = History & {
+    __: Extension;
+};
+/**
+ * Here we extend and mutate the native `window.history` object so that multiple
+ * scripts can add url change handlers without interfering each other and using
+ * the same single listener.
+ *
+ * @borrows [SO answer](https://stackoverflow.com/a/42727249/1938970)
+ *
+ * @category location
+ * @category navigation
+ * @category events
+ *
+ * @returns A de-register function to remove the handler
+ */
+export declare let listenUrlSearch: (handler: Handler) => () => void;
 export default listenUrlSearch;

package/listenUrlSearch.esm.js

@@ -0,0 +1,6 @@
+import { isBrowser } from '@koine/utils';
+import { on } from '@koine/dom';
+
+let r=(t,e,r)=>function(...o){let i=t.apply(this,o);return e(),i},o=isBrowser?location.search:"",i=()=>{let t=location.search;if(t!==o)for(let e of history.__.h.values())e(o,t);o=t;};let listenUrlSearch=t=>(history.__||(history.pushState=r(history.pushState,i),history.replaceState=r(history.replaceState,i),on(window,"popstate",i),history.__={h:new Set}),history.__.h.has(t)||history.__.h.add(t),()=>{history.__.h.delete(t);});
+
+export { listenUrlSearch as default, listenUrlSearch };

package/listenUrlSearchParams.cjs.default.js

@@ -0,0 +1 @@
+exports._default = require('./listenUrlSearchParams.cjs.js').default;

package/listenUrlSearchParams.cjs.js

@@ -0,0 +1,10 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var listenUrlSearch = require('./listenUrlSearch.cjs.js');
+
+let listenUrlSearchParams=(r,a)=>listenUrlSearch.listenUrlSearch((e,t)=>{let l=new URLSearchParams(e),s=new URLSearchParams(t).get(r);l.get(r)!==s&&a(s);});
+
+exports.default = listenUrlSearchParams;
+exports.listenUrlSearchParams = listenUrlSearchParams;

package/listenUrlSearchParams.cjs.mjs

@@ -0,0 +1,2 @@
+export * from './listenUrlSearchParams.cjs.js';
+export { _default as default } from './listenUrlSearchParams.cjs.default.js';

package/listenUrlSearchParams.d.ts

@@ -1,2 +1,7 @@
-export declare const listenUrlSearchParams: (paramName: string, handler: (paramNewValue: string | null) => void) => () => void;
+/**
+ * @category events
+ * @category navigation
+ * @category events
+ */
+export declare let listenUrlSearchParams: (paramName: string, handler: (paramNewValue: string | null) => void) => () => void;
 export default listenUrlSearchParams;

package/listenUrlSearchParams.esm.js

@@ -0,0 +1,5 @@
+import { listenUrlSearch } from './listenUrlSearch.esm.js';
+
+let listenUrlSearchParams=(r,a)=>listenUrlSearch((e,t)=>{let l=new URLSearchParams(e),s=new URLSearchParams(t).get(r);l.get(r)!==s&&a(s);});
+
+export { listenUrlSearchParams as default, listenUrlSearchParams };

package/navigateToHash.cjs.default.js

@@ -0,0 +1 @@
+exports._default = require('./navigateToHash.cjs.js').default;

package/navigateToHash.cjs.js

@@ -0,0 +1,10 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var navigateToUrl = require('./navigateToUrl.cjs.js');
+
+let navigateToHash=(t="")=>{let{pathname:o,search:e}=location;navigateToUrl.navigateToUrl(o+(e?"?"+e:"")+(t?"#"+t:""),true);};
+
+exports.default = navigateToHash;
+exports.navigateToHash = navigateToHash;

package/navigateToHash.cjs.mjs

@@ -0,0 +1,2 @@
+export * from './navigateToHash.cjs.js';
+export { _default as default } from './navigateToHash.cjs.default.js';

package/navigateToHash.d.ts

@@ -1,2 +1,8 @@
-export declare function navigateToHash(hash?: string): void;
+/**
+ * It updates the browser's location hash by replacing the history state.
+ * The non-silent standard way would simply be `location.hash = "#new-hash"`
+ *
+ * @category location
+ */
+export declare let navigateToHash: (hash?: string) => void;
 export default navigateToHash;

package/navigateToHash.esm.js

@@ -0,0 +1,5 @@
+import { navigateToUrl } from './navigateToUrl.esm.js';
+
+let navigateToHash=(t="")=>{let{pathname:o,search:e}=location;navigateToUrl(o+(e?"?"+e:"")+(t?"#"+t:""),true);};
+
+export { navigateToHash as default, navigateToHash };

package/navigateToHashParams.cjs.default.js

@@ -0,0 +1 @@
+exports._default = require('./navigateToHashParams.cjs.js').default;

package/navigateToHashParams.cjs.js

@@ -0,0 +1,10 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var utils = require('@koine/utils');
+
+let navigateToHashParams=(o={},e="")=>{let r=!e,i="#/"+utils.getUrlHashPathname(e=e||location.hash)+("string"==typeof o?o:utils.buildUrlQueryString(o));return r&&(location.hash=i),i};
+
+exports.default = navigateToHashParams;
+exports.navigateToHashParams = navigateToHashParams;

package/navigateToHashParams.cjs.mjs

@@ -0,0 +1,2 @@
+export * from './navigateToHashParams.cjs.js';
+export { _default as default } from './navigateToHashParams.cjs.default.js';

package/navigateToHashParams.d.ts

@@ -1,3 +1,9 @@
 import { type AnyQueryParams } from "@koine/utils";
-export declare function navigateToHashParams(params?: string | AnyQueryParams, hash?: string): string;
+/**
+ * It updates the `location.hash` with the given query params, it uses `location.hash`
+ * if a second argument `hash` is not provded
+ *
+ * @category location
+ */
+export declare let navigateToHashParams: (params?: string | AnyQueryParams, hash?: string) => string;
 export default navigateToHashParams;

package/navigateToHashParams.esm.js

@@ -0,0 +1,5 @@
+import { getUrlHashPathname, buildUrlQueryString } from '@koine/utils';
+
+let navigateToHashParams=(o={},e="")=>{let r=!e,i="#/"+getUrlHashPathname(e=e||location.hash)+("string"==typeof o?o:buildUrlQueryString(o));return r&&(location.hash=i),i};
+
+export { navigateToHashParams as default, navigateToHashParams };