@soleil-se/app-util 5.1.0 → 5.2.0

package/CHANGELOG.md

@@ -5,7 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [5.1.0] - 2021-05-27
+## [5.2.0] - 2023-01-31
+
+### Changed
+
+- New function `parseParams` to parse query parameters from an URL, URI or query string.
+
+## [5.1.0] - 2022-05-27
 
 ### Changed
 
@@ -14,7 +20,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - All common constants and functions are now usable in hooks.
 - Deprecate `getViewUri` since it's not used in WebApps 2.
 
-## [5.0.0] - 2021-02-08
+## [5.0.0] - 2022-02-08
 
 ### Changed
 

package/README.md

@@ -29,12 +29,23 @@ Utility functions for WebApps.
   "type": "WebApp",
   "bundled": true
 }
-
 ```
 
 ## Install
 
-`yarn add @soleil-se/webapp-util`
+```sh
+> npm install @soleil-se/webapp-util
+> yarn add @soleil-se/webapp-util
+```
+
+:::details Integrity check failed
+If the following error occurs when installing with Yarn run `yarn install --update-checksums`.
+
+```
+Integrity check failed for "@soleil-se/webapp-util" (computed integrity doesn...
+```
+
+:::
 
 ## Migration
 
@@ -182,6 +193,23 @@ const queryString = stringifyParams({ foo: 'bar', num: 1 }, { addQueryPrefix: tr
 // ?foo=bar&num=1
 ```
 
+### parseParams(url) ⇒ `Object`
+
+Parse an URL, URI or query string to an object containing its query parameters.
+
+**Returns**: `Object` - Parsed parameters.
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| url | `String` | | URL, URI or query string to be parsed, must start with or contain "?" |
+
+```js
+import { parseParams } from '@soleil-se/webapp-util';
+
+const params = parseParams('?foo=bar&arr[]=1&arr[]=2');
+// { foo: 'bar', arr: [1, 2] }
+```
+
 ## Rendering
 
 * [Svelte](./docs/1.svelte.md)

package/common/index.js

@@ -79,6 +79,37 @@ export function stringifyParams(params = {}, { addQueryPrefix = false } = {}) {
   return addQueryPrefix ? `?${qs}` : qs;
 }
 
+/**
+ * Parse an URL or URI to an object containing its query parameters.
+ * @param {String} url URL or URI to be parsed, must start with or contain "?".
+ * @returns Object with parsed parameters.
+ */
+export default function parseParams(url = '') {
+  const hasQuestion = url.indexOf('?') > -1;
+  if (!hasQuestion) return {};
+
+  let query = url.split('?')[1];
+  const hasHash = url.indexOf('#') > -1;
+  query = hasHash ? url.split('#')[0] : query;
+
+  return query.split('&').reduce((params, part) => {
+    let [key, value] = part.split('+').join(' ').split('=');
+    key = decodeURIComponent(key);
+    value = decodeURIComponent(value);
+
+    const isArray = key.endsWith('[]');
+    if (isArray) {
+      key = key.replace('[]', '');
+      value = params[key] ? [...params[key], value] : [value];
+    }
+
+    return {
+      ...params,
+      [key]: value,
+    };
+  }, {});
+}
+
 /**
  * Get URI for a route, same as `getStandaloneUrl` in Sitevision router.
  * @param {string} route A route.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@soleil-se/app-util",
-  "version": "5.1.0",
+  "version": "5.2.0",
   "description": "Utility and rendering functions for WebApps.",
   "main": "./common/index.js",
   "author": "Soleil AB",
@@ -14,6 +14,6 @@
   "peerDependencies": {
     "@sitevision/api": "^1.0.10"
   },
-  "gitHead": "3ea46889cfbe3193420d079413e20793cb183252",
+  "gitHead": "903884ec52e502707ab62483d5f01b739a8f33c9",
   "dependencies": {}
 }